Isis::GroupedStatistics Class Reference

Grouped Statistics. More...

#include <GroupedStatistics.h>

Collaboration diagram for Isis::GroupedStatistics:

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

Private Attributes
QMap< QString, Statistics > *	groupedStats
	Map from statistic type to Statistics object. More...

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

History:

2009-09-14 Eric Hyer - Original Version

History:

2009-09-18 Eric Hyer - Fixed some comments / documentation

History:

2009-10-15 Eric Hyer - Added GetStatisticTypes method

Definition at line 41 of file GroupedStatistics.h.

Constructor & Destructor Documentation

GroupedStatistics() [1/2]

Isis::GroupedStatistics::GroupedStatistics

(

)

construct a GroupedStatistics object

Definition at line 17 of file GroupedStatistics.cpp.

References groupedStats.

GroupedStatistics() [2/2]

Isis::GroupedStatistics::GroupedStatistics

(

const GroupedStatistics &

other

)

copy construct a GroupedStatistics object

Parameters

other

The GroupedStatistics to copy

Definition at line 28 of file GroupedStatistics.cpp.

References groupedStats.

~GroupedStatistics()

Isis::GroupedStatistics::~GroupedStatistics

(

)

destroy a GroupedStatistics object

Definition at line 35 of file GroupedStatistics.cpp.

References groupedStats.

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

statType	Type of data (GoodnessOfFit for example)
newStat	New statistical data to be added

Definition at line 51 of file GroupedStatistics.cpp.

GetStatistics()

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

Definition at line 66 of file GroupedStatistics.cpp.

References groupedStats, 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

Definition at line 87 of file GroupedStatistics.cpp.

References groupedStats.

operator=()

GroupedStatistics & Isis::GroupedStatistics::operator=

(

const GroupedStatistics &

other

)

Assign a GroupedStatistics with another GroupedStatistics using =.

Parameters

other

The GroupedStatistics to copy

Definition at line 107 of file GroupedStatistics.cpp.

References groupedStats.

Member Data Documentation

groupedStats

QMap< QString, Statistics >* Isis::GroupedStatistics::groupedStats

private

Map from statistic type to Statistics object.

Definition at line 55 of file GroupedStatistics.h.

Referenced by GetStatistics(), GetStatisticTypes(), GroupedStatistics(), operator=(), and ~GroupedStatistics().

---

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

• src/base/objs/GroupedStatistics/GroupedStatistics.h
• src/base/objs/GroupedStatistics/GroupedStatistics.cpp