ICF 3.0.5.47
Technical documentation of ICF Libraries
isig::CSamplingParamsComp Class Reference

General implementation of sampling parameters. More...

#include <CSamplingParamsComp.h>

Inheritance diagram for isig::CSamplingParamsComp:
Collaboration diagram for isig::CSamplingParamsComp:

Public Types

typedef icomp::CComponentBase BaseClass
 
- Public Types inherited from isig::ISamplingParams
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

 CSamplingParamsComp ()
 
const ISamplingConstraintsGetSamplingConstraints () const override
 Get access to constraints information about possible value ranges.
 
double GetInterval () const override
 Get sampling interval in seconds.
 
void SetInterval (double value) override
 Set sampling interval in seconds.
 
int GetSamplingMode () const override
 Get mode of sampling.
 
bool SetSamplingMode (int mode) override
 Set mode of sampling.
 
bool Serialize (iser::IArchive &archive) override
 Load or store state of this object as a archive stream.
 
- Public Member Functions inherited from icomp::CComponentBase
 CComponentBase ()
 Create component and assign it to specific context.
 
 CComponentBase (const CComponentBase &)=delete
 
CComponentBaseoperator= (const CComponentBase &)=delete
 
virtual const ICompositeComponentGetParentComponent (bool ownerOnly=false) const
 Get parent of this component.
 
virtual void * GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
 Get access to specified component interface.
 
virtual const IComponentContextGetComponentContext () const
 Get access to component context describing all application-specified component information loaded from components registry.
 
virtual void SetComponentContext (const IComponentContext *contextPtr, const ICompositeComponent *parentPtr, bool isParentOwner)
 Set component context of this component.
 
- Public Member Functions inherited from icomp::IComponent
- Public Member Functions inherited from isig::ISamplingParams
- Public Member Functions inherited from iser::ISerializable
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.
 

Protected Member Functions

void OnComponentCreated () override
 
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active.
 
virtual void OnComponentDestroyed ()
 
virtual const IRealComponentStaticInfoGetComponentStaticInfo () const =0
 Get access to static info of this component.
 
- 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.
 

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.
 
- Static Protected Member Functions inherited from icomp::CComponentBase
static const IRealComponentStaticInfoInitStaticInfo (IComponent *componentPtr)
 
static QByteArray GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
 

Detailed Description

General implementation of sampling parameters.

In this implementation the boundaries are fix defined using component attributes.

Definition at line 25 of file CSamplingParamsComp.h.

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CSamplingParamsComp()

isig::CSamplingParamsComp::CSamplingParamsComp ( )

Member Function Documentation

◆ GetInterval()

double isig::CSamplingParamsComp::GetInterval ( ) const
overridevirtual

Get sampling interval in seconds.

Implements isig::ISamplingParams.

◆ GetSamplingConstraints()

const ISamplingConstraints * isig::CSamplingParamsComp::GetSamplingConstraints ( ) const
overridevirtual

Get access to constraints information about possible value ranges.

Implements isig::ISamplingParams.

◆ GetSamplingMode()

int isig::CSamplingParamsComp::GetSamplingMode ( ) const
overridevirtual

Get mode of sampling.

See also
SamplingMode.

Implements isig::ISamplingParams.

◆ OnComponentCreated()

void isig::CSamplingParamsComp::OnComponentCreated ( )
overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ Serialize()

bool isig::CSamplingParamsComp::Serialize ( iser::IArchive & archive)
overridevirtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See also
iser::IArchive

Implements iser::ISerializable.

◆ SetInterval()

void isig::CSamplingParamsComp::SetInterval ( double value)
overridevirtual

Set sampling interval in seconds.

Implements isig::ISamplingParams.

◆ SetSamplingMode()

bool isig::CSamplingParamsComp::SetSamplingMode ( int mode)
overridevirtual

Set mode of sampling.

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

Implements isig::ISamplingParams.


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

© Witold Gantzke and Kirill Lepskiy