icomp::CComponentBase Class Reference

Base class for component implementation. More...

#include <CComponentBase.h>

Inheritance diagram for icomp::CComponentBase:

Public Member Functions
	CComponentBase ()
	Create component and assign it to specific context.
virtual const icomp::IComponent *	GetParentComponent (bool ownerOnly=false) const override
	Get parent of this component.
virtual void *	GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="") override
	Get access to specified component interface.
virtual IComponentContextSharedPtr	GetComponentContext () const override
	Get access to component context describing all application-specified component information loaded from components registry.
virtual void	SetComponentContext (const IComponentContextSharedPtr &contextPtr, const icomp::IComponent *parentPtr, bool isParentOwner) override
	Set component context of this component.
Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Protected Member Functions
bool	IsComponentActive () const
	Check if component is active.
virtual void	OnComponentCreated ()
virtual void	OnComponentDestroyed ()
virtual const icomp::IRealComponentStaticInfo &	GetComponentStaticInfo () const =0
	Get access to static info of this component.

Static Protected Member Functions
static const icomp::IRealComponentStaticInfo &	InitStaticInfo (IComponent *componentPtr)
static QByteArray	GetComponentId (const icomp::IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())

Detailed Description

Base class for component implementation.

This class is compatible with the macros defined in this file (CComponentBase.h).

Definition at line 37 of file CComponentBase.h.

Constructor & Destructor Documentation

CComponentBase()

icomp::CComponentBase::CComponentBase

(

)

Create component and assign it to specific context.

Member Function Documentation

GetComponentContext()

virtual IComponentContextSharedPtr icomp::CComponentBase::GetComponentContext ( ) const

overridevirtual

Get access to component context describing all application-specified component information loaded from components registry.

Implements icomp::IComponent.

GetComponentId()

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

staticprotected

GetComponentStaticInfo()

virtual const icomp::IRealComponentStaticInfo & icomp::CComponentBase::GetComponentStaticInfo ( ) const

protectedpure virtual

Get access to static info of this component.

GetInterface()

virtual void * icomp::CComponentBase::GetInterface ( const istd::CClassInfo &  interfaceType, const QByteArray &  subId = ""  )

overridevirtual

Get access to specified component interface.

Parameters

interfaceType	requested interface.
subId	some additional ID to identify subelement of this component.

Implements icomp::IComponent.

GetParentComponent()

virtual const icomp::IComponent * icomp::CComponentBase::GetParentComponent ( bool  ownerOnly = false ) const

overridevirtual

Get parent of this component.

Parent is component who created this component. Parent component can be also owner of this component. It means manages life time of this componenent.

Parameters

ownerOnly

indicate, that parent should be returned only if it owns this component.

Returns

pointer to parent component or NULL if parent is not accessible.

Implements icomp::IComponent.

InitStaticInfo()

static const icomp::IRealComponentStaticInfo & icomp::CComponentBase::InitStaticInfo ( IComponent *  componentPtr )

staticprotected

IsComponentActive()

bool icomp::CComponentBase::IsComponentActive ( ) const

inlineprotected

Check if component is active.

Component is active between OnComponentCreated and OnComponentDestroyed.

Definition at line 86 of file CComponentBase.h.

OnComponentCreated()

virtual void icomp::CComponentBase::OnComponentCreated ( )

protectedvirtual

Reimplemented in CAbComp, i2d::CAnnulusComp, i2d::CAnnulusSegmentComp, i2d::CArcComp, i2d::CCircleComp, i2d::CLine2dComp, i2d::COrientedCircleComp, i2d::CParallelogramComp, i2d::CPolygonComp, i2d::CPolylineComp, i2d::CPosition2dComp, i2d::CQuadrangleComp, i2d::CRectangleComp, i2d::CTubePolylineComp, i2d::TObject2dCompWrap< BaseObject2d >, i2d::TObject2dCompWrap< CAnnulus >, i2d::TObject2dCompWrap< CAnnulusSegment >, i2d::TObject2dCompWrap< CArc >, i2d::TObject2dCompWrap< CCircle >, i2d::TObject2dCompWrap< CLine2d >, i2d::TObject2dCompWrap< COrientedCircle >, i2d::TObject2dCompWrap< CPolygon >, i2d::TObject2dCompWrap< CPolyline >, i2d::TObject2dCompWrap< CPosition2d >, i2d::TObject2dCompWrap< CQuadrangle >, i2d::TObject2dCompWrap< CRectangle >, i2d::TObject2dCompWrap< CTubePolyline >, i2d::TObject2dCompWrap< i2d::CParallelogram >, ibase::CInstantiatorComp, ibase::CModelBinderComp, ibase::CObjectSynchronizerComp, ibase::CUuidComp, ibase::TComposedFactoryComp< Interface >, ibase::TModelObserverCompBaseWrap< icomp::TMakeComponentWrap< Base, void, void, void, void, void, void, void, void, void, void > >, idoc::CCompositeDocumentTemplateComp, idoc::CSelectedDocModelBinderComp, idoc::CSingleDocumentTemplateComp, idoc::CTextDocumentComp, ifile::CFileNameParamComp, ifile::CGeneratedFileNameParamComp, ifile::CRelativeFileNameParamComp, ifile::CSystemLocationComp, ifile::CTextFileLogComp, ifile::CTextFileLogStreamerComp, iimg::CComposedBitmapProviderComp, ilog::CLogComp, ilog::CLogRouterComp, ilog::CStandardStreamBridgeComp, ilog::CTracingConfigurationComp, ilog::TLoggerCompWrap< ifile::CRelativeFileNameParamComp >, iloggui::CMessageBoxComp, iprm::CComposedParamsSetComp, iprm::CDelegatedEnableableParamComp, iprm::CEnableableParamComp, iprm::CFilteredOptionsListComp, iprm::CIdParamComp, iprm::CManagerParamsSetShadowerComp, iprm::CMultiParamsManagerComp, iprm::CNameParamComp, iprm::COptionsManagerComp, iprm::CParamsManagerComp, iprm::CParamsManagerCompBase, iprm::CParamsSetDelegatorComp, iprm::CSelectableParamsSetComp, iprm::CSelectionParamComp, iprm::CTextParamComp, iqt::CApplicationSettingsProviderComp, iqt::CIniSettingsProviderComp, iqt2d::CSceneBinderComp, iqtdoc::CDocumentImportExportCommandComp, iqtdoc::CSingletonDocApplicationComp, iqtgui::CApplicationCompBase, iqtgui::CCommandBasedSelectionControllerComp, iqtgui::CCommandsBinderComp, iqtgui::CCommandsMultiplexerComp, iqtgui::CFreeWidgetGuiComp, iqtgui::CModelEditorGuiComp, and iview::CColorSchemaComp.

OnComponentDestroyed()

virtual void icomp::CComponentBase::OnComponentDestroyed ( )

protectedvirtual

Reimplemented in ibase::CModelBinderComp, ibase::CMultiObserverBinderComp, ibase::CObjectQueueComp, ibase::CObjectSynchronizerComp, ibase::TModelObserverCompBaseWrap< icomp::TMakeComponentWrap< Base, void, void, void, void, void, void, void, void, void, void > >, idoc::CCompositeDocumentTemplateComp, idoc::CSelectedDocModelBinderComp, idoc::CSerializedUndoManagerComp, ifile::CGeneratedFileNameParamComp, ifile::CRelativeFileNameParamComp, ifile::CTextFileLogComp, ifile::CTextFileLogStreamerComp, iimg::CComposedBitmapProviderComp, ilog::CLogRouterComp, ilog::CStandardStreamBridgeComp, ilog::CStreamLogCompBase, ilog::TLoggerCompWrap< ifile::CRelativeFileNameParamComp >, iloggui::CMessageBoxComp, iprm::CDelegatedEnableableParamComp, iprm::CManagerParamsSetShadowerComp, iprm::CMultiParamsManagerComp, iprm::COptionsManagerComp, iprm::CParamsManagerComp, iprm::CParamsSetDelegatorComp, iprm::CSelectableParamsSetComp, iqt2d::CSceneBinderComp, iqtdoc::CDocumentImportExportCommandComp, iqtdoc::CSingletonDocApplicationComp, iqtgui::CCommandBasedSelectionControllerComp, iqtgui::CCommandsMultiplexerComp, iqtgui::CFreeWidgetGuiComp, iqtgui::CGuiApplicationComp, and iqtgui::CModelEditorGuiComp.

SetComponentContext()

virtual void icomp::CComponentBase::SetComponentContext ( const IComponentContextSharedPtr &  contextPtr, const icomp::IComponent *  parentPtr, bool  isParentOwner  )

overridevirtual

Set component context of this component.

Parameters

contextPtr	new value of component context. It can be also NULL. Please avoid to use this method, it is designed for internal use only.
parentPtr	pointer to parent component, or NULL if this component has no parent.
isParentOwner	indicate, that life cycle of this component is controller by its parent.

Implements icomp::IComponent.

---

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

• Acf/Include/icomp/CComponentBase.h