ICF 3.0.5.47
Technical documentation of ICF Libraries
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:
Collaboration diagram for imeas::IDiscreteDataSequence:

Public Member Functions

virtual bool CreateDiscreteSequence (int samplesCount, istd::COptMemory &&data, int sampleDiff, int channelDiff, int sampleDepth, int channelsCount=1, std::unique_ptr< const IDataSequenceInfo > &&infoPtr=nullptr)=0
 Create container for sample sequence using external samples buffer.
 
virtual int GetSampleDepth () const =0
 Get number of bits used to represent single sample.
 
virtual quint32 GetDiscreteSample (int position, int channel=0) const =0
 Get discrete sample at specified position.
 
virtual bool SetDiscreteSample (int position, int channel, quint32 sample)=0
 Set discrete sample at specified position.
 
- Public Member Functions inherited from imeas::IDataSequence
virtual bool CreateSequence (int samplesCount, int channelsCount=1, std::unique_ptr< const IDataSequenceInfo > &&infoPtr=nullptr)=0
 Create container for sample sequence with specified number of samples, channels and sample depth.
 
virtual const IDataSequenceInfoGetSequenceInfo () const =0
 Get additional information about this sequence.
 
virtual bool IsEmpty () const =0
 Return true if this sequence has no sample.
 
virtual void ResetSequence ()=0
 Reset this sequence.
 
virtual int GetSamplesCount () const =0
 Get size of this raster sequence.
 
virtual int GetChannelsCount () const =0
 Get number of channels.
 
virtual double GetSample (int index, int channel=0) const =0
 Get sample value at specified index.
 
virtual void SetSample (int index, int channel, double value)=0
 Set sample value at specified index.
 
- Public Member Functions inherited from iser::ISerializable
virtual bool Serialize (IArchive &archive)=0
 Load or store state of this object as a archive stream.
 
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data.
 
- 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

- 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...
 
- 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

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

All samples has the same number of channels components.

Definition at line 23 of file IDiscreteDataSequence.h.

Member Function Documentation

◆ CreateDiscreteSequence()

virtual bool imeas::IDiscreteDataSequence::CreateDiscreteSequence ( int samplesCount,
istd::COptMemory && data,
int sampleDiff,
int channelDiff,
int sampleDepth,
int channelsCount = 1,
std::unique_ptr< const IDataSequenceInfo > && infoPtr = nullptr )
pure virtual

Create container for sample sequence using external samples buffer.

Parameters
samplesCountnumber of samples.
dataexternal buffer.
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.
infoPtrsequence info object.
Returns
true if sample sequence was created correctly.

Implemented in imeas::TDiscreteDataSequence< Element >.

◆ GetDiscreteSample()

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 >.

◆ GetSampleDepth()

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

Get number of bits used to represent single sample.

Implemented in imeas::TDiscreteDataSequence< Element >.

◆ SetDiscreteSample()

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:

© Witold Gantzke and Kirill Lepskiy