ICF 3.0.5.47
Technical documentation of ICF Libraries
idocgui::CSingletonDocApplicationComp Class Reference

Singleton application component. More...

#include <CSingletonDocApplicationComp.h>

Inheritance diagram for idocgui::CSingletonDocApplicationComp:
Collaboration diagram for idocgui::CSingletonDocApplicationComp:

Public Types

typedef icomp::CComponentBase BaseClass
 
typedef imod::TSingleModelObserverBase< ibase::IRuntimeStatusProviderBaseClass2
 

Public Member Functions

 CSingletonDocApplicationComp ()
 
bool InitializeApplication (int argc, char **argv) override
 Initialize the application object.
 
int Execute (int argc, char **argv) override
 Start execution loop of the application.
 
QString GetHelpText () const override
 Get information about the possible command line arguments of this application.
 
QStringList GetApplicationArguments () const override
 Get the command line arguments of this application.
 
- 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 ibase::IApplication

Protected Member Functions

void OnUpdate (const istd::IChangeable::ChangeSet &changeSet) override
 Called on update of observed model.
 
void OnComponentCreated () override
 
void OnComponentDestroyed () override
 
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active.
 
virtual const IRealComponentStaticInfoGetComponentStaticInfo () const =0
 Get access to static info of this component.
 
- Protected Member Functions inherited from imod::TSingleModelObserverBase< ibase::IRuntimeStatusProvider >
virtual ibase::IRuntimeStatusProviderCastFromModel (imod::IModel *modelPtr) const
 
 TSingleModelObserverBase ()
 
ibase::IRuntimeStatusProviderGetObservedObject () const
 Get instance of observed object.
 
ibase::IRuntimeStatusProviderGetObjectPtr () const
 Get instance of observed object.
 
bool AttachOrSetObject (ibase::IRuntimeStatusProvider *objectPtr)
 Attach to model of object or set object pointer, if no connection is possible.
 
bool OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
 This call back function will be called, if an observable object is about to be attached.
 
bool OnModelDetached (imod::IModel *modelPtr) override
 This call back function will be called, if an observable object is about to be detached.
 
- Protected Member Functions inherited from imod::CSingleModelObserverBase
void SetModelPtr (imod::IModel *modelPtr)
 Set internal model pointer to specified value.
 
 CSingleModelObserverBase ()
 
virtual ~CSingleModelObserverBase ()
 
imod::IModelGetObservedModel () const
 Get access to observed model.
 
imod::IModelGetModelPtr () const
 Get access to observed model.
 
void EnsureModelDetached ()
 Make sure this observer is detached.
 
void SetObservedIds (const istd::IChangeable::ChangeSet &changeMask)
 Set list of ID's beeing observed.
 
bool IsModelAttached (const imod::IModel *modelPtr=nullptr) const override
 Check if specified model is attached.
 
void BeforeModelChange (imod::IModel *modelPtr) override
 This function will be called before update of the observer contents occures.
 
void AfterModelChange (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
 This function will be called after update of the observer contents occures.
 
- Protected Member Functions inherited from imod::IObserver
- Protected Member Functions inherited from ibase::IApplication

Additional Inherited Members

- Protected Types inherited from imod::TSingleModelObserverBase< ibase::IRuntimeStatusProvider >
typedef CSingleModelObserverBase BaseClass
 
typedef ibase::IRuntimeStatusProvider ModelType
 
- Protected Types inherited from imod::CSingleModelObserverBase
typedef imod::IModel ModelType
 
- 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

Singleton application component.

This component wraps a "real" application component implementation and allows only a single execution of the application instance.

Definition at line 33 of file CSingletonDocApplicationComp.h.

Member Typedef Documentation

◆ BaseClass

◆ BaseClass2

Constructor & Destructor Documentation

◆ CSingletonDocApplicationComp()

idocgui::CSingletonDocApplicationComp::CSingletonDocApplicationComp ( )

Member Function Documentation

◆ Execute()

int idocgui::CSingletonDocApplicationComp::Execute ( int argc,
char ** argv )
overridevirtual

Start execution loop of the application.

Implements ibase::IApplication.

◆ GetApplicationArguments()

QStringList idocgui::CSingletonDocApplicationComp::GetApplicationArguments ( ) const
overridevirtual

Get the command line arguments of this application.

Implements ibase::IApplication.

◆ GetHelpText()

QString idocgui::CSingletonDocApplicationComp::GetHelpText ( ) const
overridevirtual

Get information about the possible command line arguments of this application.

Implements ibase::IApplication.

◆ InitializeApplication()

bool idocgui::CSingletonDocApplicationComp::InitializeApplication ( int argc,
char ** argv )
overridevirtual

Initialize the application object.

Implements ibase::IApplication.

◆ OnComponentCreated()

void idocgui::CSingletonDocApplicationComp::OnComponentCreated ( )
overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ OnComponentDestroyed()

void idocgui::CSingletonDocApplicationComp::OnComponentDestroyed ( )
overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ OnUpdate()

void idocgui::CSingletonDocApplicationComp::OnUpdate ( const istd::IChangeable::ChangeSet & changeSet)
overrideprotectedvirtual

Called on update of observed model.

This method is designed to be overload by derrived classes.

Reimplemented from imod::CSingleModelObserverBase.


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

© Witold Gantzke and Kirill Lepskiy