icomp::CComponentBase Class Reference

Base class for component implementation. More...

#include <CComponentBase.h>

Inherits icomp::IComponent.

Inherited by i2d::TObject2dCompWrap< CAnnulus >, i2d::TObject2dCompWrap< CAnnulusSegment >, i2d::TObject2dCompWrap< CArc >, i2d::TObject2dCompWrap< CCircle >, i2d::TObject2dCompWrap< CLine2d >, i2d::TObject2dCompWrap< COrientedCircle >, i2d::TObject2dCompWrap< i2d::CParallelogram >, i2d::TObject2dCompWrap< CPolygon >, i2d::TObject2dCompWrap< CPolyline >, i2d::TObject2dCompWrap< CPosition2d >, i2d::TObject2dCompWrap< CQuadrangle >, i2d::TObject2dCompWrap< CRectangle >, i2d::TObject2dCompWrap< CTubePolyline >, ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >, icomp::TMakeComponentWrap< Base, void, void, void, void, void, void, void, void, void, void >, icomp::TMakeComponentWrap< Base, iview::CShapeBase, iview::IShape, imod::IObserver, iview::IVisualizable, iview::ITouchable >, iinspgui::TResultShapeCreatorWrap< icomp::CComponentBase >, ilog::TMessageDelegatorComp< icomp::CComponentBase >, i2d::TObject2dCompWrap< BaseObject2d >, i2dgui::CSceneBinderComp, i2dgui::CSelectableSceneExtenderComp, iauth::CRightsBasedEnablerComp, iauth::CStaticRightsProviderComp, iauth::CUserLoginComp, iauth::CUsersManagerComp, ibase::CApplicationInfoComp, ibase::CApplicationSettingsProviderComp, ibase::CIniSettingsProviderComp, ibase::CInstantiatorComp, ibase::CModelBinderComp, ibase::CMultiObserverBinderComp, ibase::CUuidComp, icalib::CAffineCalibration2dComp, icalib::CCalibration2dProxyComp, icalib::CComposedAffineCalibrationComp, icalib::CPerspectiveCalibration2dComp, icalib::CSimpleLensCorrectionComp, icalib::CStaticCalibrationProviderComp, icam::CAcquisitionConstraintsComp, icam::CCameraMultiplexerComp, icam::CExposureParamsComp, icam::CMemoryAcquisitionComp, icmpstr::CComponentHelpFileProviderComp, icmpstr::CConvertComponentCommandComp, icmpstr::CRegistryConsistInfoComp, icomp::TMakeComponentWrap< Base, Interface1, Interface2, Interface3, Interface4, Interface5, Interface6, Interface7, Interface8, Interface9, Interface10 >, idoc::CCompositeDocumentTemplateComp, idoc::CSelectedDocModelBinderComp, idoc::CSerializedUndoManagerComp, idoc::CSingleDocumentTemplateComp, idoc::CTextDocumentComp, idoc::CTextFilePersistenceComp, idocgui::CDocumentImportExportCommandComp, idocgui::CDoxygenHelpFileProviderComp, idocgui::CHtmlHelpViewerComp, idocgui::CSingletonDocApplicationComp, idocgui::CStaticHelpFileProviderComp, idocgui::CUndoManagerCommandsProviderComp, idocproc::CRenderedDocumentPreviewGeneratorComp, ifile::CComposedFilePersistenceComp, ifile::CFileNameParamComp, ifile::CFileTypeInfoComp, ifile::CSystemLocationComp, ifileproc::CFileNamingParamsComp, iimg::CComposedBitmapProviderComp, iimg::CMultiPageBitmapComp, iimg::CMultiPageBitmapSequenceComp, iinsp::CComposedInformationProviderComp, iinsp::CIdProviderCacheComp, iinsp::CInformationProviderCacheComp, iinsp::CSupplierActivationProxyComp, iipr::CBitmapProviderCacheComp, iipr::CBlobFilterParamsComp, iipr::CCaliperFinderParamsComp, iipr::CCaliperParamsComp, iipr::CConvolutionKernel2dComp, iipr::CEdgeDistanceProcessorComp, iipr::CExtremumCaliperProcessorComp, iipr::CFeatureToImageMapperProcessorComp, iipr::CImageInterpolationParamsComp, iipr::CMultiBitmapCacheComp, iipr::CRectDerivativeProcessorComp, iipr::CRenderedObjectFileLoaderComp, iipr::CRingPatternGeneratorParamsComp, iipr::CSearchConstraintsComp, iipr::CSearchParamsComp, iloggui::CMessageBoxComp, imeas::CLinearAdjustParamsComp, imeas::CNumericConstraintsComp, imeas::CNumericParamsComp, imeas::CRelativeUnitSelectorComp, imeas::CWavSamplesSaverComp, iprm::CComposedParamsSetComp, iprm::CEnableableParamComp, iprm::CFilteredOptionsListComp, iprm::CIdParamComp, iprm::CManagerParamsSetShadowerComp, iprm::CNameParamComp, iprm::COptionsManagerComp, iprm::CParamsManagerCompBaseAttr, iprm::CParamsSetDelegatorComp, iprm::CSelectableParamsSetComp, iprm::CSelectionConstraintsComp, iprm::CSelectionParamComp, iprm::CTextParamComp, iprm::CVariableParamComp, iproc::CCascadedProcessorComp, iproc::TMemCachedProducerComp< Key, CacheObject >, iprocgui::CProcessorCommandComp, isig::CPulseParamsComp, isig::CSamplingParamsComp, isig::CTriggerParamsComp, istdgui::CCommandsBinderComp, istdgui::CCommandsMultiplexerComp, istdgui::CDialogGuiComp, istdgui::CFreeWidgetGuiComp, istdgui::CIconProviderComp, istdgui::CModelEditorGuiComp, istdgui::CStatusBarWidgetComp, iview::CColorSchemaPenAttr, iview::CShapeStatusInfoComp, and iview::CSimpleShapeFactoryComp.

Collaboration diagram for icomp::CComponentBase:

Public Member Functions
	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

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

Static Protected Member Functions
static const IRealComponentStaticInfo &	InitStaticInfo (IComponent *componentPtr)
static QByteArray	GetComponentId (const 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 39 of file CComponentBase.h.

Constructor & Destructor Documentation

CComponentBase() [1/2]

icomp::CComponentBase::CComponentBase

(

)

Create component and assign it to specific context.

CComponentBase() [2/2]

icomp::CComponentBase::CComponentBase ( const CComponentBase & )

delete

Member Function Documentation

GetComponentContext()

virtual const IComponentContext * icomp::CComponentBase::GetComponentContext ( ) const

virtual

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 IComponentContext * componentContextPtr, const QByteArray & contextId = QByteArray() )

staticprotected

GetComponentStaticInfo()

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

protectedpure virtual

Get access to static info of this component.

Implemented in i2d::CAnnulusComp, i2d::CAnnulusSegmentComp, i2d::CArcComp, i2d::CCircleComp, i2d::CLine2dComp, i2d::COrientedCircleComp, i2d::CParallelogramComp, i2d::CPolygonComp, and i2d::CPosition2dComp.

GetInterface()

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

virtual

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 ICompositeComponent * icomp::CComponentBase::GetParentComponent ( bool ownerOnly = false ) const

virtual

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 nullptr if parent is not accessible.

Implements icomp::IComponent.

InitStaticInfo()

static const 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 87 of file CComponentBase.h.

OnComponentCreated()

virtual void icomp::CComponentBase::OnComponentCreated ( )

protectedvirtual

Reimplemented in 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 >, i2dgui::CSceneBinderComp, i2dgui::CSceneConnectorGuiComp, iauth::CRightsBasedEnablerComp, iauth::CStaticRightsProviderComp, iauth::CUserLoginComp, iauth::CUsersManagerComp, ibase::CApplicationSettingsProviderComp, ibase::CIniSettingsProviderComp, ibase::CInstantiatorComp, ibase::CModelBinderComp, ibase::CUuidComp, ibase::TModelObserverCompBaseWrap< icomp::TMakeComponentWrap< Base, iview::CShapeBase, iview::IShape, imod::IObserver, iview::IVisualizable, iview::ITouchable > >, ibase::TModelObserverCompBaseWrap< icomp::TMakeComponentWrap< Base, void, void, void, void, void, void, void, void, void, void > >, ibase::TModelObserverCompBaseWrap< istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< iinsp::ISupplier > > >, ibase::TModelObserverCompBaseWrap< istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< Model > > >, icalib::CAffineCalibration2dComp, icalib::CCalibration2dProxyComp, icalib::CComposedAffineCalibrationComp, icalib::CPerspectiveCalibration2dComp, icalib::CSimpleLensCorrectionComp, icalib::CStaticCalibrationProviderComp, icam::CExposureParamsComp, icamgui::CBitmapSupplierGuiComp, icamgui::CSnapImageParamsEditorComp, icmpstr::CRegistryTreeViewComp, icmpstr::CSceneProviderGuiComp, icmpstr::CVisualRegistryEditorComp, idoc::CCompositeDocumentTemplateComp, idoc::CSelectedDocModelBinderComp, idoc::CSingleDocumentTemplateComp, idoc::CTextDocumentComp, idocgui::CDocPreviewGuiComp, idocgui::CDocumentImportExportCommandComp, idocgui::CMainWindowGuiComp, idocgui::CMultiDocumentWorkspaceGuiComp, idocgui::CSingleDocumentWorkspaceGuiComp, idocgui::CSingletonDocApplicationComp, idocgui::CUndoManagerCommandsProviderComp, ifile::CFileNameParamComp, ifile::CGeneratedFileNameParamComp, ifile::CRelativeFileNameParamComp, ifile::CSystemLocationComp, ifile::CTextFileLogComp, ifilegui::CFilePreviewGuiComp, ifilegui::CFileTreeViewGuiComp, ifileproc::CFileNamingParamsComp, iimg::CComposedBitmapProviderComp, iinsp::CComposedInformationProviderComp, iinsp::CSupplierActivationProxyComp, iinspgui::CMessageBasedViewExtenderComp, iipr::CBlobFilterParamsComp, iipr::CCaliperFinderParamsComp, iipr::CCaliperParamsComp, iipr::CConvolutionKernel2dComp, iipr::CImageInterpolationParamsComp, iipr::CMultiBitmapCacheComp, iipr::CRectDerivativeProcessorComp, iipr::CRenderedObjectFileLoaderComp, iipr::CRingPatternGeneratorParamsComp, iipr::CSearchConstraintsComp, iipr::CSearchParamsComp, ilog::TLoggerCompWrap< ifile::CRelativeFileNameParamComp >, iloggui::CLogGuiComp, iloggui::CMessageBoxComp, imeas::CLinearAdjustParamsComp, imeas::CNumericConstraintsComp, imeas::CNumericParamsComp, imeas::CRelativeUnitSelectorComp, iprm::CComposedParamsSetComp, 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, iproc::CCascadedProcessorComp, iprocgui::CProcessorCommandComp, iprocgui::CProcessorControlGuiComp, isig::CPulseParamsComp, isig::CSamplingParamsComp, isig::CTriggerParamsComp, isiggui::CSampleAcquisitionGuiComp, istdgui::CCommandBasedSelectionControllerComp, istdgui::CCommandsBinderComp, istdgui::CCommandsMultiplexerComp, istdgui::CDialogGuiComp, istdgui::CFreeWidgetGuiComp, istdgui::CGuiApplicationCompBase, istdgui::CGuiComponentBase, istdgui::CModelEditorGuiComp, istdgui::CMultiPageGuiCompBase, istdgui::TDesignerGuiObserverCompBase< UI, Model, WidgetType >, istdgui::TDesignerGuiObserverCompBase< UI, iinsp::ISupplier >, iview::CColorSchemaComp, and iview::TShapeCompWrap< Base >.

OnComponentDestroyed()

virtual void icomp::CComponentBase::OnComponentDestroyed ( )

protectedvirtual

Reimplemented in i2dgui::CMultiBitmapViewComp, i2dgui::CSceneBinderComp, i2dgui::CSceneConnectorGuiComp, iauth::CRightsBasedEnablerComp, ibase::CModelBinderComp, ibase::CMultiObserverBinderComp, ibase::TModelObserverCompBaseWrap< icomp::TMakeComponentWrap< Base, iview::CShapeBase, iview::IShape, imod::IObserver, iview::IVisualizable, iview::ITouchable > >, ibase::TModelObserverCompBaseWrap< icomp::TMakeComponentWrap< Base, void, void, void, void, void, void, void, void, void, void > >, ibase::TModelObserverCompBaseWrap< istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< iinsp::ISupplier > > >, ibase::TModelObserverCompBaseWrap< istdgui::TGuiObserverWrap< istdgui::TDesignerGuiCompBase< UI, QWidget >, imod::TSingleModelObserverBase< Model > > >, icalib::CAffineCalibration2dComp, icalib::CCalibration2dProxyComp, icalib::CComposedAffineCalibrationComp, icalib::CPerspectiveCalibration2dComp, icalib::CStaticCalibrationProviderComp, icmpstr::CRegistryTreeViewComp, icmpstr::CSceneProviderGuiComp, icmpstr::CVisualRegistryEditorComp, idoc::CCompositeDocumentTemplateComp, idoc::CSelectedDocModelBinderComp, idoc::CSerializedUndoManagerComp, idocgui::CDocPreviewGuiComp, idocgui::CDocumentImportExportCommandComp, idocgui::CMainWindowGuiComp, idocgui::CSingletonDocApplicationComp, idocgui::CUndoManagerCommandsProviderComp, ifile::CGeneratedFileNameParamComp, ifile::CRelativeFileNameParamComp, ifile::CTextFileLogComp, ifilegui::CFileTreeViewGuiComp, iimg::CComposedBitmapProviderComp, iinsp::CComposedInformationProviderComp, iinsp::CSupplierActivationProxyComp, iinspgui::CMessageBasedViewExtenderComp, iiprgui::CSearchBasedFeaturesSupplierGuiComp, iiprgui::CValueSupplierGuiComp, ilog::CStreamLogCompBase, ilog::TLoggerCompWrap< ifile::CRelativeFileNameParamComp >, imeas::CNumericParamsComp, iprm::CComposedParamsSetComp, iprm::CManagerParamsSetShadowerComp, iprm::CMultiParamsManagerComp, iprm::COptionsManagerComp, iprm::CParamsManagerComp, iprm::CParamsSetDelegatorComp, iprm::CSelectableParamsSetComp, istdgui::CCommandBasedSelectionControllerComp, istdgui::CCommandsMultiplexerComp, istdgui::CFreeWidgetGuiComp, istdgui::CGuiApplicationComp, istdgui::CGuiComponentBase, istdgui::CModelEditorGuiComp, and istdgui::CMultiPageGuiCompBase.

operator=()

CComponentBase & icomp::CComponentBase::operator= ( const CComponentBase & )

delete

SetComponentContext()

virtual void icomp::CComponentBase::SetComponentContext ( const IComponentContext * contextPtr, const ICompositeComponent * parentPtr, bool isParentOwner )

virtual

Set component context of this component.

Parameters

contextPtr	new value of component context. It can be also nullptr. Please avoid to use this method, it is designed for internal use only.
parentPtr	pointer to parent component, or nullptr 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:

• icomp/CComponentBase.h