ICF 3.0.5.47
Technical documentation of ICF Libraries
icmpstr::CVisualRegistryElement Class Reference

#include <CVisualRegistryElement.h>

Inheritance diagram for icmpstr::CVisualRegistryElement:
Collaboration diagram for icmpstr::CVisualRegistryElement:

Public Types

typedef icomp::CRegistryElement BaseClass
 
- Public Types inherited from icomp::IRegistryElement
enum  ChangeFlags { CF_ATTRIBUTE_CHANGED = 0x29734ba , CF_FLAGS_CHANGED }
 
enum  ElementFlags { EF_AUTO_INSTANCE = 0x0001 , EF_IS_DETACHED = 0x0002 }
 
typedef std::unique_ptr< iser::IObjectAttributePtr
 
- Public Types inherited from iattr::IAttributesProvider
enum  ChangeFlags { CF_RESET = 0xb812936 , CF_ATTR_REMOVED , CF_ATTR_ADDED }
 Data model change notification flags. More...
 
typedef QSet< QByteArray > AttributeIds
 
- 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 Types inherited from i2d::IObject2d
enum  ChangeFlags { CF_OBJECT_POSITION = 0x6ba340 }
 

Public Member Functions

 CVisualRegistryElement ()
 
const icomp::IRegistryGetRegistry () const
 
const icomp::CComponentAddressGetAddress () const
 
const QByteArray & GetName () const
 
void SetName (const QByteArray &name)
 
const QString & GetNote () const
 
void SetNote (const QString &note)
 
void Initialize (const icomp::IRegistry *parentPtr, const icomp::CComponentAddress &address)
 
virtual i2d::CVector2d GetCenter () const
 Returns center of this 2D-object.
 
virtual void MoveCenterTo (const i2d::CVector2d &position)
 Move object to position position.
 
virtual i2d::CRectangle GetBoundingBox () const
 Get bounding box of this shape.
 
virtual bool Transform (const i2d::ITransformation2d &transformation, i2d::ITransformation2d::ExactnessMode mode=i2d::ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr)
 Transform this object using some transformation.
 
virtual bool InvTransform (const i2d::ITransformation2d &transformation, i2d::ITransformation2d::ExactnessMode mode=i2d::ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr)
 Do inverse transformation of this object.
 
virtual bool GetTransformed (const i2d::ITransformation2d &transformation, i2d::IObject2d &result, i2d::ITransformation2d::ExactnessMode mode=i2d::ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) const
 Calulate transformation of the object into second one.
 
virtual bool GetInvTransformed (const i2d::ITransformation2d &transformation, i2d::IObject2d &result, i2d::ITransformation2d::ExactnessMode mode=i2d::ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) const
 Calulate inverse transformation of the object into second one.
 
- Public Member Functions inherited from icomp::CRegistryElement
 CRegistryElement ()
 
virtual AttributeInfoGetAttributeInfo (const QByteArray &attributeId)
 
virtual quint32 GetElementFlags () const
 Get flags of this registry element.
 
virtual void SetElementFlags (quint32 flags)
 Set flags of this registry element.
 
virtual AttributeInfoInsertAttributeInfo (const QByteArray &attributeId, const QByteArray &attributeType)
 Insert new attribute info object to collection of attributes.
 
virtual std::unique_ptr< iser::IObjectCreateAttribute (const QByteArray &attributeType) const
 Create attribute object for specified ID.
 
virtual const AttributeInfoGetAttributeInfo (const QByteArray &attributeId) const
 Get access to stored attribute info structure.
 
virtual bool RemoveAttribute (const QByteArray &attributeId)
 Removes attribute info structure from this collection.
 
virtual AttributeIds GetAttributeIds () const
 Get list of all attribute IDs.
 
virtual iser::IObjectGetAttribute (const QByteArray &attributeId) const
 Get attribute for the given ID.
 
virtual bool Serialize (iser::IArchive &archive)
 Load or store state of this object as a archive stream.
 
- Public Member Functions inherited from icomp::IRegistryElement
- Public Member Functions inherited from iattr::IAttributesProvider
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations.
 
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 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.
 
- 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 i2d::CObject2dBase
 CObject2dBase ()
 
 CObject2dBase (const CObject2dBase &object2d)
 
 CObject2dBase (CObject2dBase &&object2d)
 
const ICalibration2dGetCalibration () const override
 Get access to transformation object, which transforms a local logical coordinate system to global one.
 
void SetCalibration (istd::TOptDelPtr< const ICalibration2d > &&calibrationPtr) override
 Set calibration of this object.
 
bool CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
 Copy this object from another one.
 
bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS) override
 Reset data to its default state.
 
CObject2dBaseoperator= (const CObject2dBase &object2d)
 
CObject2dBaseoperator= (CObject2dBase &&object2d)
 
- Public Member Functions inherited from i2d::IObject2d
- Public Member Functions inherited from iser::IObject
virtual QByteArray GetFactoryId () const
 
- Public Member Functions inherited from i2d::ICalibration2dProvider

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::CRegistryElement
std::unique_ptr< iser::IObjectCreateAttributeIntern (const QByteArray &attributeType) const
 
- 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 Attributes inherited from i2d::CObject2dBase
static const ChangeSet s_objectMovedChange
 
static const ChangeSet s_objectModifiedChange
 

Detailed Description

Definition at line 27 of file CVisualRegistryElement.h.

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CVisualRegistryElement()

icmpstr::CVisualRegistryElement::CVisualRegistryElement ( )

Member Function Documentation

◆ GetAddress()

const icomp::CComponentAddress & icmpstr::CVisualRegistryElement::GetAddress ( ) const
inline

Definition at line 86 of file CVisualRegistryElement.h.

◆ GetBoundingBox()

virtual i2d::CRectangle icmpstr::CVisualRegistryElement::GetBoundingBox ( ) const
virtual

Get bounding box of this shape.

Please note, this bounding box is in logical units, the calibration will not be considered.

Implements i2d::IObject2d.

◆ GetCenter()

virtual i2d::CVector2d icmpstr::CVisualRegistryElement::GetCenter ( ) const
virtual

Returns center of this 2D-object.

Implements i2d::IObject2d.

◆ GetInvTransformed()

virtual bool icmpstr::CVisualRegistryElement::GetInvTransformed ( const i2d::ITransformation2d & transformation,
i2d::IObject2d & result,
i2d::ITransformation2d::ExactnessMode mode = i2d::ITransformation2d::EM_NONE,
double * errorFactorPtr = nullptr ) const
virtual

Calulate inverse transformation of the object into second one.

Please note, that this operation transforms logical coordinates, it means that the calibration will be ignored.

Parameters
modecontrols needed transformation exactness.
errorFactorPtroptional output where approximated length of transformation error vector will be stored. Value 0 means that transformation is exactly done.
resultresult object.
Returns
true, if transformation was done correctly.

Reimplemented from i2d::CObject2dBase.

◆ GetName()

const QByteArray & icmpstr::CVisualRegistryElement::GetName ( ) const
inline

Definition at line 92 of file CVisualRegistryElement.h.

◆ GetNote()

const QString & icmpstr::CVisualRegistryElement::GetNote ( ) const

◆ GetRegistry()

const icomp::IRegistry * icmpstr::CVisualRegistryElement::GetRegistry ( ) const
inline

Definition at line 80 of file CVisualRegistryElement.h.

◆ GetTransformed()

virtual bool icmpstr::CVisualRegistryElement::GetTransformed ( const i2d::ITransformation2d & transformation,
i2d::IObject2d & result,
i2d::ITransformation2d::ExactnessMode mode = i2d::ITransformation2d::EM_NONE,
double * errorFactorPtr = nullptr ) const
virtual

Calulate transformation of the object into second one.

Please note, that this operation transforms logical coordinates, it means that the calibration will be ignored.

Parameters
modecontrols needed transformation exactness.
errorFactorPtroptional output where approximated length of transformation error vector will be stored. Value 0 means that transformation is exactly done.
resultresult object.
Returns
true, if transformation was done correctly.

Reimplemented from i2d::CObject2dBase.

◆ Initialize()

void icmpstr::CVisualRegistryElement::Initialize ( const icomp::IRegistry * parentPtr,
const icomp::CComponentAddress & address )

◆ InvTransform()

virtual bool icmpstr::CVisualRegistryElement::InvTransform ( const i2d::ITransformation2d & transformation,
i2d::ITransformation2d::ExactnessMode mode = i2d::ITransformation2d::EM_NONE,
double * errorFactorPtr = nullptr )
virtual

Do inverse transformation of this object.

Please note, that this operation transforms logical coordinates, it means that the calibration will be ignored.

Parameters
modecontrols needed transformation exactness.
errorFactorPtroptional output where approximated length of transformation error vector will be stored. Value 0 means that transformation is exactly done.
Returns
true, if transformation was done correctly.

Reimplemented from i2d::CObject2dBase.

◆ MoveCenterTo()

virtual void icmpstr::CVisualRegistryElement::MoveCenterTo ( const i2d::CVector2d & position)
virtual

Move object to position position.

Implements i2d::IObject2d.

◆ SetName()

void icmpstr::CVisualRegistryElement::SetName ( const QByteArray & name)

◆ SetNote()

void icmpstr::CVisualRegistryElement::SetNote ( const QString & note)

◆ Transform()

virtual bool icmpstr::CVisualRegistryElement::Transform ( const i2d::ITransformation2d & transformation,
i2d::ITransformation2d::ExactnessMode mode = i2d::ITransformation2d::EM_NONE,
double * errorFactorPtr = nullptr )
virtual

Transform this object using some transformation.

Please note, that this operation transforms logical coordinates, it means that the calibration will be ignored.

Parameters
modecontrols needed transformation exactness.
errorFactorPtroptional output where approximated length of transformation error vector will be stored. Value 0 means that transformation is exactly done.
Returns
true, if transformation was done correctly.

Reimplemented from i2d::CObject2dBase.


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

© Witold Gantzke and Kirill Lepskiy