USGS

Isis 3.0 Developer's Reference (API)

Home

Isis::GroupedStatistics Class Reference
[Statistics]

Grouped Statistics. More...

#include <GroupedStatistics.h>

List of all members.

Public Member Functions

 GroupedStatistics ()
 construct a GroupedStatistics object
 GroupedStatistics (const GroupedStatistics &other)
 copy construct a GroupedStatistics object
 ~GroupedStatistics ()
 destroy a GroupedStatistics object
void AddStatistic (const QString &statType, const double &newStat)
 Add a new data entry for a given type of data.
const StatisticsGetStatistics (const QString &statType) const
 Get statistics for a given type of data.
const QVector< QString > GetStatisticTypes () const
 Return a list of all the different statistic tyes that this GroupedStatistics has.
GroupedStatisticsoperator= (const GroupedStatistics &other)
 Assign a GroupedStatistics with another GroupedStatistics using =.

Detailed Description

Grouped Statistics.

This class is used to store statistics on a group of related items.

This class is include safe meaning that includers of this class will only get this class.

Author:
2009-09-14 Eric Hyer
See also:
Statistics

Constructor & Destructor Documentation

Isis::GroupedStatistics::GroupedStatistics (  ) 

construct a GroupedStatistics object

Isis::GroupedStatistics::GroupedStatistics ( const GroupedStatistics other  ) 

copy construct a GroupedStatistics object

Parameters:
other The GroupedStatistics to copy
Isis::GroupedStatistics::~GroupedStatistics (  ) 

destroy a GroupedStatistics object


Member Function Documentation

void Isis::GroupedStatistics::AddStatistic ( const QString &  statType,
const double &  newStat 
)

Add a new data entry for a given type of data.

Parameters:
statType Type of data (GoodnessOfFit for example)
newStat New statistical data to be added
const Statistics & Isis::GroupedStatistics::GetStatistics ( const QString &  statType  )  const

Get statistics for a given type of data.

Parameters:
statType Type of data
Returns:
Statisticts for the given type of data
Exceptions:
iException When the given type of data does not exist
const QVector< QString > Isis::GroupedStatistics::GetStatisticTypes (  )  const

Return a list of all the different statistic tyes that this GroupedStatistics has.

Returns:
A list of statistic types that this GroupedStatistics has
GroupedStatistics & Isis::GroupedStatistics::operator= ( const GroupedStatistics other  ) 

Assign a GroupedStatistics with another GroupedStatistics using =.

Parameters:
other The GroupedStatistics to copy

The documentation for this class was generated from the following files: