ICF 3.0.5.47
Technical documentation of ICF Libraries
iipr::CRingPatternGeneratorParamsComp Class Reference

#include <CRingPatternGeneratorParamsComp.h>

Inheritance diagram for iipr::CRingPatternGeneratorParamsComp:
Collaboration diagram for iipr::CRingPatternGeneratorParamsComp:

Public Types

typedef icomp::CComponentBase BaseClass
 
- Public Types inherited from iipr::IRingPatternGeneratorParams
enum  PatternType { PT_FIXED_WAVELENGTH , PT_DYNAMIC_WAVELENGTH }
 
- 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

 CRingPatternGeneratorParamsComp ()
 
int GetPatternMode () const override
 Get used pattern generation mode.
 
void SetPatternMode (int patternMode) override
 Set pattern generation mode.
 
double GetWaveLength () const override
 Get used pattern wavelength.
 
void SetWaveLength (double waveLength) override
 Set pattern wavelength.
 
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 iipr::IRingPatternGeneratorParams
- 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

Definition at line 19 of file CRingPatternGeneratorParamsComp.h.

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CRingPatternGeneratorParamsComp()

iipr::CRingPatternGeneratorParamsComp::CRingPatternGeneratorParamsComp ( )

Member Function Documentation

◆ GetPatternMode()

int iipr::CRingPatternGeneratorParamsComp::GetPatternMode ( ) const
overridevirtual

Get used pattern generation mode.

See also
PatternType

Implements iipr::IRingPatternGeneratorParams.

◆ GetWaveLength()

double iipr::CRingPatternGeneratorParamsComp::GetWaveLength ( ) const
overridevirtual

Get used pattern wavelength.

Implements iipr::IRingPatternGeneratorParams.

◆ OnComponentCreated()

void iipr::CRingPatternGeneratorParamsComp::OnComponentCreated ( )
overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ Serialize()

bool iipr::CRingPatternGeneratorParamsComp::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.

◆ SetPatternMode()

void iipr::CRingPatternGeneratorParamsComp::SetPatternMode ( int patternMode)
overridevirtual

Set pattern generation mode.

See also
PatternType

Implements iipr::IRingPatternGeneratorParams.

◆ SetWaveLength()

void iipr::CRingPatternGeneratorParamsComp::SetWaveLength ( double waveLength)
overridevirtual

Set pattern wavelength.

Implements iipr::IRingPatternGeneratorParams.


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

© Witold Gantzke and Kirill Lepskiy