Implementation of an annulus as a component. More...

#include <CAnnulusComp.h>

Inheritance diagram for i2d::CAnnulusComp:

Collaboration diagram for i2d::CAnnulusComp:

Public Types
typedef TObject2dCompWrap< CAnnulus >	BaseClass

typedef CAnnulusComp	CurrentComponentType

Public Types inherited from i2d::TObject2dCompWrap< CAnnulus >
typedef icomp::CComponentBase	BaseClass

typedef CAnnulus	BaseClass2

Public Types inherited from i2d::CAnnulus
typedef i2d::CPosition2d	BaseClass

Public Types inherited from i2d::IObject2d
enum	ChangeFlags { CF_OBJECT_POSITION = 0x6ba340 }

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 icomp::IRealComponentStaticInfo &	GetComponentStaticInfo () const override
	Get access to static info of this component.

Public Member Functions inherited from icomp::CComponentBase
	CComponentBase ()
	Create component and assign it to specific context.

	CComponentBase (const CComponentBase &)=delete

CComponentBase &	operator= (const CComponentBase &)=delete

virtual const ICompositeComponent *	GetParentComponent (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 IComponentContext *	GetComponentContext () 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 i2d::CAnnulus
	CAnnulus ()
	Construct an empty annulus object.

	CAnnulus (const i2d::CVector2d &center, double innerRadius, double outerRadius)
	Construct an annulus object by the given position, inner and outer radius.

bool	IsAnnulusValid () const
	Check, if the annulus is valid.

double	GetInnerRadius () const
	Get the inner radius of the annulus.

void	SetInnerRadius (double innerRadius)
	Set the inner radius of the annulus.

double	GetOuterRadius () const
	Get the outer radius of the annulus.

void	SetOuterRadius (double outerRadius)
	Set the outer radius of the annulus.

void	SetInnerOuterRadius (double radius1, double radius2)
	Set the inner and outer radius of the annulus.

CCircle	GetInnerCircle () const
	Set the inner circle of the annulus object.

CCircle	GetOuterCircle () const
	Set the outer circle of the annulus object.

bool	operator== (const CAnnulus &annulus) const
	Compare with another annulus.

bool	operator!= (const CAnnulus &annulus) const
	Compare with another annulus.

bool	ConvertToPolygon (i2d::CPolygon &result, int segmentsCount=0) const
	Performs conversion of the annulus splitting it to segmentsCount segments to the polygon result.

CRectangle	GetBoundingBox () const override
	Get bounding box of this shape.

bool	Transform (const ITransformation2d &transformation, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) override
	Transform this object using some transformation.

bool	InvTransform (const ITransformation2d &transformation, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) override
	Do inverse transformation of this object.

bool	GetTransformed (const ITransformation2d &transformation, IObject2d &result, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) const override
	Calulate transformation of the object into second one.

bool	GetInvTransformed (const ITransformation2d &transformation, IObject2d &result, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) const override
	Calulate inverse transformation of the object into second one.

int	GetSupportedOperations () const override
	Get set of flags for supported operations.

bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override

std::unique_ptr< istd::IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const override
	Make a copy of this object.

bool	Serialize (iser::IArchive &archive) override
	Load or store state of this object as a archive stream.

Public Member Functions inherited from i2d::CPosition2d
	CPosition2d ()

	CPosition2d (const CVector2d &center)

const CVector2d &	GetPosition () const

void	SetPosition (const CVector2d &position)

void	Translate (const i2d::CVector2d &vector)

CPosition2d	GetTranslated (const i2d::CVector2d &vector) const

CVector2d	GetCenter () const override
	Returns center of this 2D-object.

void	MoveCenterTo (const CVector2d &position) override
	Move object to position `position`.

CRectangle	GetBoundingBox () const override
	Get bounding box of this shape.

bool	Transform (const ITransformation2d &transformation, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) override
	Transform this object using some transformation.

bool	InvTransform (const ITransformation2d &transformation, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) override
	Do inverse transformation of this object.

bool	GetTransformed (const ITransformation2d &transformation, IObject2d &result, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) const override
	Calulate transformation of the object into second one.

bool	GetInvTransformed (const ITransformation2d &transformation, IObject2d &result, ITransformation2d::ExactnessMode mode=ITransformation2d::EM_NONE, double *errorFactorPtr=nullptr) const override
	Calulate inverse transformation of the object into second one.

QByteArray	GetFactoryId () const override

bool	Serialize (iser::IArchive &archive) override
	Load or store state of this object as a archive stream.

int	GetSupportedOperations () const override
	Get set of flags for supported operations.

bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override

bool	IsEqual (const istd::IChangeable &object) const override
	Compare this object with another object.

std::unique_ptr< istd::IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const override
	Make a copy of this object.

Public Member Functions inherited from i2d::CObject2dBase
	CObject2dBase ()

	CObject2dBase (const CObject2dBase &object2d)

	CObject2dBase (CObject2dBase &&object2d)

const ICalibration2d *	GetCalibration () 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.

CObject2dBase &	operator= (const CObject2dBase &object2d)

CObject2dBase &	operator= (CObject2dBase &&object2d)

Public Member Functions inherited from i2d::IObject2d
Public Member Functions inherited from iser::IObject
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 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 i2d::ICalibration2dProvider

Static Public Member Functions
static const icomp::IRealComponentStaticInfo &	InitStaticInfo (CAnnulusComp *componentPtr)

Static Public Member Functions inherited from i2d::CPosition2d
static QByteArray	GetTypeName ()

Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

Protected Member Functions
void	OnComponentCreated () override

bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS) override
	Reset data to its default state.

Protected Member Functions inherited from i2d::TObject2dCompWrap< CAnnulus >
void	OnComponentCreated () override

Protected Member Functions inherited from icomp::CComponentBase
bool	IsComponentActive () const
	Check if component is active.

virtual void	OnComponentDestroyed ()

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 Protected Member Functions inherited from icomp::CComponentBase
static const IRealComponentStaticInfo &	InitStaticInfo (IComponent *componentPtr)

static QByteArray	GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())

Protected Attributes inherited from i2d::CAnnulus
istd::CRange	m_radiusRange

Protected Attributes inherited from i2d::CPosition2d
CVector2d	m_position

Static Protected Attributes inherited from i2d::CObject2dBase
static const ChangeSet	s_objectMovedChange

static const ChangeSet	s_objectModifiedChange

Detailed Description

Implementation of an annulus as a component.

It gives the possibility to define the annulus model via component attributes.

Definition at line 22 of file CAnnulusComp.h.

Member Typedef Documentation

◆ BaseClass

TObject2dCompWrap<CAnnulus> i2d::CAnnulusComp::BaseClass

Definition at line 25 of file CAnnulusComp.h.

◆ CurrentComponentType

CAnnulusComp i2d::CAnnulusComp::CurrentComponentType

Definition at line 27 of file CAnnulusComp.h.

Member Function Documentation

◆ GetComponentStaticInfo()

virtual const icomp::IRealComponentStaticInfo & i2d::CAnnulusComp::GetComponentStaticInfo ( ) const

inlineoverridevirtual

Get access to static info of this component.

Implements icomp::CComponentBase.

Definition at line 34 of file CAnnulusComp.h.

◆ InitStaticInfo()

static const icomp::IRealComponentStaticInfo & i2d::CAnnulusComp::InitStaticInfo ( CAnnulusComp * componentPtr )

inlinestatic

Definition at line 27 of file CAnnulusComp.h.

◆ OnComponentCreated()

void i2d::CAnnulusComp::OnComponentCreated ( )

overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ ResetData()

bool i2d::CAnnulusComp::ResetData ( CompatibilityMode mode = CM_WITHOUT_REFS )

overrideprotectedvirtual

Reset data to its default state.

Default implementation in istd::IChangeable does nothing. You may check, if this functionality is supported over GetSupportedOperations().

Returns: true if the operation was successful, and false otherwise.

Reimplemented from istd::IChangeable.

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

i2d/CAnnulusComp.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members