ICF 3.0.5.47
Technical documentation of ICF Libraries
imeas::IDataStatistics Class Referenceabstract

Common interace for simple data statistics. More...

#include <IDataStatistics.h>

Inheritance diagram for imeas::IDataStatistics:
Collaboration diagram for imeas::IDataStatistics:

Public Types

enum  SupportedStatFeatures { SSF_BOUNDARIES = 1 << 0 , SSF_STD_DEVIATION = 1 << 1 , SSF_AVERAGE = 1 << 2 , SSF_MEDIAN = 1 << 3 }
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ICF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING ,
  CF_DELEGATED , CF_NO_UNDO
}
 Data model change notification flags. More...
 
enum  SupportedOperations {
  SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 ,
  SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 , SO_CHANGE_LOCK = 1 << 5
}
 Flags for supported operations. More...
 
enum  CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
 Control how relationship betweeen objects are interpreted. More...
 

Public Member Functions

virtual int GetSupportedStatFeatures () const =0
 Get set of supported statistical features.
 
virtual istd::CRange GetDataBoundaries () const =0
 Get the range of values in the data sequence.
 
virtual double GetStandardDeviation () const =0
 Get data variance.
 
virtual double GetAverage () const =0
 Get data average.
 
virtual double GetMedian () const =0
 Get data median.
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations.
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one.
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object.
 
virtual std::unique_ptr< IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object.
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state.
 
virtual QMutex * GetChangesLock () const
 Get mutex beeing locked during changes, if available.
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction.
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction.
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes.
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes.
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set.
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event.
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event.
 

Detailed Description

Common interace for simple data statistics.

\TODO: think about moving it to imath.

Definition at line 23 of file IDataStatistics.h.

Member Enumeration Documentation

◆ SupportedStatFeatures

Enumerator
SSF_BOUNDARIES 
SSF_STD_DEVIATION 
SSF_AVERAGE 
SSF_MEDIAN 

Definition at line 26 of file IDataStatistics.h.

Member Function Documentation

◆ GetAverage()

virtual double imeas::IDataStatistics::GetAverage ( ) const
pure virtual

Get data average.

Implemented in imeas::CSimpleDataStatistics.

◆ GetDataBoundaries()

virtual istd::CRange imeas::IDataStatistics::GetDataBoundaries ( ) const
pure virtual

Get the range of values in the data sequence.

Implemented in imeas::CSimpleDataStatistics.

◆ GetMedian()

virtual double imeas::IDataStatistics::GetMedian ( ) const
pure virtual

Get data median.

Implemented in imeas::CSimpleDataStatistics.

◆ GetStandardDeviation()

virtual double imeas::IDataStatistics::GetStandardDeviation ( ) const
pure virtual

Get data variance.

Implemented in imeas::CSimpleDataStatistics.

◆ GetSupportedStatFeatures()

virtual int imeas::IDataStatistics::GetSupportedStatFeatures ( ) const
pure virtual

Get set of supported statistical features.

Implemented in imeas::CSimpleDataStatistics.


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

© Witold Gantzke and Kirill Lepskiy