Public Member Functions | Protected Member Functions | List of all members
imeas::CSamplesInfo Class Reference

Stores additional data sequence data used to interpret samples value correctly. More...

#include <CSamplesInfo.h>

Inheritance diagram for imeas::CSamplesInfo:
imeas::IDataSequenceInfo iprm::IOptionsList imeas::INumericConstraints iser::ISerializable istd::IChangeable istd::IChangeable istd::IChangeable istd::IPolymorphic istd::IPolymorphic istd::IPolymorphic

Public Member Functions

 CSamplesInfo (const istd::CRange &logicalSamplesRange=istd::CRange::GetInvalid(), const QDateTime &samplingStartTime=QDateTime())
 
const istd::CRangeGetLogicalSamplesRange () const
 Get logical position range (time axis) of this data sequence. More...
 
void SetLogicalSamplesRange (const istd::CRange &range)
 Set logical position range (time axis) of this data sequence. More...
 
QDateTime GetSamplingStartTime () const
 Get the absolute start time of the sampling. More...
 
void SetSamplingStartTime (const QDateTime &samplingStartTime)
 Set absolute time of sample acquisition. More...
 
virtual int GetSequenceInfoFlags () const
 Get flags for this data sequence. More...
 
virtual int GetDefaultSamplesCount () const
 Get default number of samples. More...
 
virtual int GetDefaultChannelsCount () const
 Get default number of channels. More...
 
virtual int GetWeightMode () const
 Get weight mode for this sequence. More...
 
virtual const iprm::IOptionsListGetValueListInfo () const
 Get general information about the "content" of the numeric value. More...
 
virtual const imath::IUnitInfoGetNumericValueUnitInfo (int index) const
 Get range of possible numeric values for specified list index. More...
 
virtual bool Serialize (iser::IArchive &archive)
 

Protected Member Functions

virtual int GetOptionsFlags () const
 
virtual int GetOptionsCount () const
 
virtual QString GetOptionName (int index) const
 
virtual QString GetOptionDescription (int index) const
 
virtual QByteArray GetOptionId (int index) const
 
virtual bool IsOptionEnabled (int index) const
 

Additional Inherited Members

- Public Types inherited from imeas::IDataSequenceInfo
enum  SequenceInfoFlags { SIF_SAMPLES_COUNT_FIXED = 1 << 1, SIF_CHANNELS_COUNT_FIXED = 1 << 2 }
 
enum  WeightMode { WM_NONE, WM_LAST, WM_INTERLEAVED, WM_UNKNOWN }
 Describe mode of weight information. More...
 

Detailed Description

Stores additional data sequence data used to interpret samples value correctly.

Definition at line 19 of file CSamplesInfo.h.

Constructor & Destructor Documentation

imeas::CSamplesInfo::CSamplesInfo ( const istd::CRange logicalSamplesRange = istd::CRange::GetInvalid(),
const QDateTime &  samplingStartTime = QDateTime() 
)

Member Function Documentation

virtual int imeas::CSamplesInfo::GetDefaultChannelsCount ( ) const
virtual

Get default number of channels.

If negative, the default number of channels is undefined.

Implements imeas::IDataSequenceInfo.

virtual int imeas::CSamplesInfo::GetDefaultSamplesCount ( ) const
virtual

Get default number of samples.

If negative, the default number of samples is undefined.

Implements imeas::IDataSequenceInfo.

const istd::CRange& imeas::CSamplesInfo::GetLogicalSamplesRange ( ) const

Get logical position range (time axis) of this data sequence.

For example, if you sample sound from second 1 to 5 it will be represented as range [1.0, 5.0]. If this range is invalid, no logical range is provided.

virtual const imath::IUnitInfo* imeas::CSamplesInfo::GetNumericValueUnitInfo ( int  index) const
virtual

Get range of possible numeric values for specified list index.

Parameters
indexindex of numeric value.

Implements imeas::INumericConstraints.

virtual QString imeas::CSamplesInfo::GetOptionDescription ( int  index) const
protectedvirtual
virtual QByteArray imeas::CSamplesInfo::GetOptionId ( int  index) const
protectedvirtual
virtual QString imeas::CSamplesInfo::GetOptionName ( int  index) const
protectedvirtual
virtual int imeas::CSamplesInfo::GetOptionsCount ( ) const
protectedvirtual
virtual int imeas::CSamplesInfo::GetOptionsFlags ( ) const
protectedvirtual
QDateTime imeas::CSamplesInfo::GetSamplingStartTime ( ) const

Get the absolute start time of the sampling.

If the time object is invalid the

virtual int imeas::CSamplesInfo::GetSequenceInfoFlags ( ) const
virtual

Get flags for this data sequence.

Implements imeas::IDataSequenceInfo.

virtual const iprm::IOptionsList& imeas::CSamplesInfo::GetValueListInfo ( ) const
virtual

Get general information about the "content" of the numeric value.

Implements imeas::INumericConstraints.

virtual int imeas::CSamplesInfo::GetWeightMode ( ) const
virtual

Get weight mode for this sequence.

See Also
WeightMode

Implements imeas::IDataSequenceInfo.

virtual bool imeas::CSamplesInfo::IsOptionEnabled ( int  index) const
protectedvirtual
virtual bool imeas::CSamplesInfo::Serialize ( iser::IArchive archive)
virtual
void imeas::CSamplesInfo::SetLogicalSamplesRange ( const istd::CRange range)

Set logical position range (time axis) of this data sequence.

See Also
GetLogicalRange
void imeas::CSamplesInfo::SetSamplingStartTime ( const QDateTime &  samplingStartTime)

Set absolute time of sample acquisition.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy