ibase::CConsoleApplicationComp Class Reference

Console (non-gui) application. More...

#include <CConsoleApplicationComp.h>

Inheritance diagram for ibase::CConsoleApplicationComp:

Public Types
typedef ilog::CLoggerComponentBase	BaseClass
Public Types inherited from ilog::TLoggerCompWrap< Base >
typedef Base	BaseClass
	Base class typedef for component functionality.
typedef ilog::CLoggerBase	BaseClass2
	Base class typedef for logger functionality.

Signals
void	EmitEventLoopStarted ()

Public Member Functions
virtual bool	InitializeApplication (int argc, char **argv) override
	Initialize the application object.
virtual int	Execute (int argc, char **argv) override
	Start execution loop of the application.
virtual QString	GetHelpText () const override
	Get information about the possible command line arguments of this application.
virtual QStringList	GetApplicationArguments () const override
	Get the command line arguments of this application.
Public Member Functions inherited from ilog::CLoggerBase
	CLoggerBase ()
	Default constructor.
virtual void	SetLogPtr (ilog::IMessageConsumer *logPtr) override
	Attach a message consumer for logging.
virtual ilog::IMessageConsumer *	GetLogPtr () const override
	Get the currently attached message consumer.
Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Protected Member Functions
virtual void	OnApplicationShutdown ()
	Callback for the application's shutdown.
virtual void	OnComponentDestroyed () override
	Called when component is destroyed.
Protected Member Functions inherited from ilog::TLoggerCompWrap< Base >
bool	IsVerboseEnabled (int tracingLevel=0) const
	Check if verbose messages are enabled for a given tracing level.
void	SendVerboseMessage (const QString &message, const QString &messageSource=QString(), int tracingLevel=0) const
	Send a verbose message if enabled.
virtual void	DecorateMessage (istd::IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const override
	Decorate message before sending.
virtual void	OnComponentCreated () override
	Called when component is created.
Protected Member Functions inherited from ilog::CLoggerBase
bool	SendInfoMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send info message to log.
bool	SendWarningMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send warning message to log.
bool	SendErrorMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send error message to log.
bool	SendCriticalMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send critical message to log.
bool	SendInfoMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once info message to log.
bool	SendWarningMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once warning message to log.
bool	SendErrorMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once error message to log.
bool	SendCriticalMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once critical message to log.
bool	SendUserMessage (const istd::IInformationProvider *messagePtr) const
	Send message with user object.
bool	AllowMessageOnceAgain (int id)
	Reset message lock.
virtual bool	IsLogConsumed (const istd::IInformationProvider::InformationCategory *categoryPtr=NULL, const int *flagsPtr=NULL) const override
	Check if any log message is consumed.
virtual bool	SendLogMessage (istd::IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const override
	Send any message to log.

Additional Inherited Members
Protected Attributes inherited from ilog::CLoggerBase
QSet< int >	m_onceMessageIds

Detailed Description

Console (non-gui) application.

Definition at line 26 of file CConsoleApplicationComp.h.

Member Typedef Documentation

BaseClass

typedef ilog::CLoggerComponentBase ibase::CConsoleApplicationComp::BaseClass

Definition at line 34 of file CConsoleApplicationComp.h.

Member Function Documentation

EmitEventLoopStarted

void ibase::CConsoleApplicationComp::EmitEventLoopStarted ( )

signal

Execute()

virtual int ibase::CConsoleApplicationComp::Execute ( int  argc, char **  argv  )

overridevirtual

Start execution loop of the application.

Implements ibase::IApplication.

GetApplicationArguments()

virtual QStringList ibase::CConsoleApplicationComp::GetApplicationArguments ( ) const

overridevirtual

Get the command line arguments of this application.

Implements ibase::IApplication.

GetHelpText()

virtual QString ibase::CConsoleApplicationComp::GetHelpText ( ) const

overridevirtual

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

Implements ibase::IApplication.

InitializeApplication()

virtual bool ibase::CConsoleApplicationComp::InitializeApplication ( int  argc, char **  argv  )

overridevirtual

Initialize the application object.

Implements ibase::IApplication.

OnApplicationShutdown()

virtual void ibase::CConsoleApplicationComp::OnApplicationShutdown ( )

protectedvirtual

Callback for the application's shutdown.

Default implementation does nothing.

OnComponentDestroyed()

virtual void ibase::CConsoleApplicationComp::OnComponentDestroyed ( )

overrideprotectedvirtual

Called when component is destroyed.

Automatically disconnects the log consumer for cleanup.

Note

Override to add cleanup, but always call base class:

virtual void OnComponentDestroyed() override {
    // Custom cleanup
    BaseClass::OnComponentDestroyed();
}

Reimplemented from ilog::TLoggerCompWrap< Base >.

---

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

• Acf/Include/ibase/CConsoleApplicationComp.h