Isis Developer Reference
Isis::GroupedStatistics Class Reference

Grouped Statistics. More...

#include <GroupedStatistics.h>

Collaboration diagram for Isis::GroupedStatistics:
Collaboration graph

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

◆ GroupedStatistics() [1/2]

Isis::GroupedStatistics::GroupedStatistics ( )

construct a GroupedStatistics object

◆ GroupedStatistics() [2/2]

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

copy construct a GroupedStatistics object

Parameters
otherThe GroupedStatistics to copy

◆ ~GroupedStatistics()

Isis::GroupedStatistics::~GroupedStatistics ( )

destroy a GroupedStatistics object

Member Function Documentation

◆ AddStatistic()

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

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

Parameters
statTypeType of data (GoodnessOfFit for example)
newStatNew statistical data to be added

◆ GetStatistics()

const Statistics & Isis::GroupedStatistics::GetStatistics ( const QString & statType) const

Get statistics for a given type of data.

Parameters
statTypeType of data
Returns
Statisticts for the given type of data
Exceptions
IExceptionWhen the given type of data does not exist

References _FILEINFO_, and Isis::IException::Programmer.

◆ GetStatisticTypes()

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

◆ operator=()

GroupedStatistics & Isis::GroupedStatistics::operator= ( const GroupedStatistics & other)

Assign a GroupedStatistics with another GroupedStatistics using =.

Parameters
otherThe GroupedStatistics to copy

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