ICF 3.0.5.47
Technical documentation of ICF Libraries
isig::ISamplingParams Class Referenceabstract

Sampler parameters. More...

#include <ISamplingParams.h>

Inheritance diagram for isig::ISamplingParams:
Collaboration diagram for isig::ISamplingParams:

Public Types

enum  SamplingMode { SM_SINGLE , SM_PERIODIC , SM_SYNCHRONIZED , SM_LAST = SM_SYNCHRONIZED }
 
- 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 const ISamplingConstraintsGetSamplingConstraints () const =0
 Get access to constraints information about possible value ranges.
 
virtual double GetInterval () const =0
 Get sampling interval in seconds.
 
virtual void SetInterval (double value)=0
 Set sampling interval in seconds.
 
virtual int GetSamplingMode () const =0
 Get mode of sampling.
 
virtual bool SetSamplingMode (int mode)=0
 Set mode of sampling.
 
- 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

- 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

Sampler parameters.

Definition at line 26 of file ISamplingParams.h.

Member Enumeration Documentation

◆ SamplingMode

Enumerator
SM_SINGLE 
SM_PERIODIC 
SM_SYNCHRONIZED 
SM_LAST 

Definition at line 29 of file ISamplingParams.h.

Member Function Documentation

◆ GetInterval()

virtual double isig::ISamplingParams::GetInterval ( ) const
pure virtual

Get sampling interval in seconds.

Implemented in isig::CSamplingParamsComp.

◆ GetSamplingConstraints()

virtual const ISamplingConstraints * isig::ISamplingParams::GetSamplingConstraints ( ) const
pure virtual

Get access to constraints information about possible value ranges.

Implemented in isig::CSamplingParamsComp.

◆ GetSamplingMode()

virtual int isig::ISamplingParams::GetSamplingMode ( ) const
pure virtual

Get mode of sampling.

See also
SamplingMode.

Implemented in isig::CSamplingParamsComp.

◆ SetInterval()

virtual void isig::ISamplingParams::SetInterval ( double value)
pure virtual

Set sampling interval in seconds.

Implemented in isig::CSamplingParamsComp.

◆ SetSamplingMode()

virtual bool isig::ISamplingParams::SetSamplingMode ( int mode)
pure virtual

Set mode of sampling.

See also
SamplingMode.
Returns
true if this mode was supported and was set correctly.

Implemented in isig::CSamplingParamsComp.


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

© Witold Gantzke and Kirill Lepskiy