ICF 3.0.5.47
Technical documentation of ICF Libraries
iprm::CVariableParamComp Class Reference

#include <CVariableParamComp.h>

Inheritance diagram for iprm::CVariableParamComp:
Collaboration diagram for iprm::CVariableParamComp:

Public Types

typedef icomp::CComponentBase BaseClass
 
- Public Types inherited from iprm::IVariableParam
typedef QSet< QByteArray > TypeIds
 
- 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

 CVariableParamComp ()
 
TypeIds GetKnownTypeIds () const override
 Get lilst of all known type ID's.
 
QByteArray GetParameterTypeId () const override
 Get type ID of current stored parameter.
 
iser::ISerializableGetParameter () const override
 Get current parameter.
 
bool AssignTypeId (const QByteArray &typeId) override
 Assign type ID to this object.
 
bool Serialize (iser::IArchive &archive) override
 Load or store state of this object as a archive stream.
 
quint32 GetMinimalVersion (int versionId) const override
 Get minimal needed version to correct storing of this data.
 
- 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 iprm::IVariableParam
- Public Member Functions inherited from iser::ISerializable
- 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 icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active.
 
virtual void OnComponentCreated ()
 
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.
 
- 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

Definition at line 20 of file CVariableParamComp.h.

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CVariableParamComp()

iprm::CVariableParamComp::CVariableParamComp ( )

Member Function Documentation

◆ AssignTypeId()

bool iprm::CVariableParamComp::AssignTypeId ( const QByteArray & typeId)
overridevirtual

Assign type ID to this object.

Assigning of type ID creates internal instance of parameter object.

Implements iprm::IVariableParam.

◆ GetKnownTypeIds()

TypeIds iprm::CVariableParamComp::GetKnownTypeIds ( ) const
overridevirtual

Get lilst of all known type ID's.

Implements iprm::IVariableParam.

◆ GetMinimalVersion()

quint32 iprm::CVariableParamComp::GetMinimalVersion ( int versionId) const
overridevirtual

Get minimal needed version to correct storing of this data.

In implementation shold be calculated maximum version of this and composed component.

Reimplemented from iser::ISerializable.

◆ GetParameter()

iser::ISerializable * iprm::CVariableParamComp::GetParameter ( ) const
overridevirtual

Get current parameter.

Returns
current stored parameter or nullptr if no type is assigned.

Implements iprm::IVariableParam.

◆ GetParameterTypeId()

QByteArray iprm::CVariableParamComp::GetParameterTypeId ( ) const
overridevirtual

Get type ID of current stored parameter.

Returns
type ID of current stored parameter or empty string if no type is assigned.

Implements iprm::IVariableParam.

◆ Serialize()

bool iprm::CVariableParamComp::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.


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

© Witold Gantzke and Kirill Lepskiy