Public Member Functions | List of all members
imeas::IDiscreteDataSequence Class Referenceabstract

General definition of sequence contains discrete sample values in regular time grid. More...

#include <IDiscreteDataSequence.h>

Inheritance diagram for imeas::IDiscreteDataSequence:
imeas::IDataSequence iser::ISerializable istd::IChangeable istd::IPolymorphic imeas::TDiscreteDataSequence< Element >

Public Member Functions

virtual bool CreateDiscreteSequence (int samplesCount, void *dataPtr, bool releaseFlag, int sampleDiff, int channelDiff, int sampleDepth, int channelsCount=1)=0
 Create container for sample sequence using external samples buffer. More...
 
virtual bool CreateDiscreteSequenceWithInfo (const istd::TTransPtr< const IDataSequenceInfo > &infoPtr, int samplesCount, void *dataPtr, bool releaseFlag, int sampleDiff, int channelDiff, int sampleDepth, int channelsCount=1)=0
 Create container for sample sequence with additional sequence info using external samples buffer. More...
 
virtual int GetSampleDepth () const =0
 Get number of bits used to represent single sample. More...
 
virtual quint32 GetDiscreteSample (int position, int channel=0) const =0
 Get discrete sample at specified position. More...
 
virtual bool SetDiscreteSample (int position, int channel, quint32 sample)=0
 Set discrete sample at specified position. More...
 
- Public Member Functions inherited from imeas::IDataSequence
virtual bool CreateSequence (int samplesCount, int channelsCount=1)=0
 Create container for sample sequence with specified number of samples, channels and sample depth. More...
 
virtual bool CreateSequenceWithInfo (const istd::TTransPtr< const IDataSequenceInfo > &infoPtr, int samplesCount=-1, int channelsCount=-1)=0
 Create sequence and set the info object. More...
 
virtual const IDataSequenceInfoGetSequenceInfo () const =0
 Get additional information about this sequence. More...
 
virtual bool IsEmpty () const =0
 Return true if this sequence has no sample. More...
 
virtual void ResetSequence ()=0
 Reset this sequence. More...
 
virtual int GetSamplesCount () const =0
 Get size of this raster sequence. More...
 
virtual int GetChannelsCount () const =0
 Get number of channels. More...
 
virtual double GetSample (int index, int channel=0) const =0
 Get sample value at specified index. More...
 
virtual void SetSample (int index, int channel, double value)=0
 Set sample value at specified index. More...
 

Detailed Description

General definition of sequence contains discrete sample values in regular time grid.

All samples has the same number of channels components.

Definition at line 16 of file IDiscreteDataSequence.h.

Member Function Documentation

virtual bool imeas::IDiscreteDataSequence::CreateDiscreteSequence ( int  samplesCount,
void *  dataPtr,
bool  releaseFlag,
int  sampleDiff,
int  channelDiff,
int  sampleDepth,
int  channelsCount = 1 
)
pure virtual

Create container for sample sequence using external samples buffer.

Parameters
samplesCountnumber of samples.
dataPtrpointer to external buffer.
releaseFlagif its true, external buffer will be managed (removed) by this object.
sampleDiffaddress difference between next and previos sample. If it equals 0, the value will be taken from number of samples, number of channels and channelDiff.
channelDiffaddress difference between next and previos sample. If it equals 0, the value will be calculated from number of bits per single sample.
sampleDepthnumber of bits used for representation of a single sample.
channelsCountnumber of channels.
Returns
true if sample sequence was created correctly.

Implemented in imeas::TDiscreteDataSequence< Element >.

virtual bool imeas::IDiscreteDataSequence::CreateDiscreteSequenceWithInfo ( const istd::TTransPtr< const IDataSequenceInfo > &  infoPtr,
int  samplesCount,
void *  dataPtr,
bool  releaseFlag,
int  sampleDiff,
int  channelDiff,
int  sampleDepth,
int  channelsCount = 1 
)
pure virtual

Create container for sample sequence with additional sequence info using external samples buffer.

Parameters
infoPtrsequence info object.
samplesCountnumber of samples.
dataPtrpointer to external buffer.
releaseFlagif its true, external buffer will be managed (removed) by this object.
sampleDiffaddress difference between next and previos sample. If it equals 0, the value will be taken from number of samples, number of channels and channelDiff.
channelDiffaddress difference between next and previos sample. If it equals 0, the value will be calculated from number of bits per single sample.
sampleDepthnumber of bits used for representation of a single sample.
channelsCountnumber of channels.
Returns
true if sample sequence was created correctly.

Implemented in imeas::TDiscreteDataSequence< Element >.

virtual quint32 imeas::IDiscreteDataSequence::GetDiscreteSample ( int  position,
int  channel = 0 
) const
pure virtual

Get discrete sample at specified position.

Parameters
positionposition, must be inside of returned size.

Implemented in imeas::TDiscreteDataSequence< Element >.

virtual int imeas::IDiscreteDataSequence::GetSampleDepth ( ) const
pure virtual

Get number of bits used to represent single sample.

Implemented in imeas::TDiscreteDataSequence< Element >.

virtual bool imeas::IDiscreteDataSequence::SetDiscreteSample ( int  position,
int  channel,
quint32  sample 
)
pure virtual

Set discrete sample at specified position.

Parameters
positionposition, must be inside of returned size.
channelsample channel.
samplesample value will be set.
Returns
true, if sample was changed.

Implemented in imeas::TDiscreteDataSequence< Element >.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy