ICF 3.0.5.47
Technical documentation of ICF Libraries
ibase::CConsoleApplicationComp Class Reference

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

#include <CConsoleApplicationComp.h>

Inheritance diagram for ibase::CConsoleApplicationComp:
Collaboration diagram for ibase::CConsoleApplicationComp:

Public Types

typedef ilog::TLoggerCompWrap< CInstantiatorCompBaseClass
 
- Public Types inherited from ilog::TLoggerCompWrap< CInstantiatorComp >
enum  MessageId
 
typedef CInstantiatorComp BaseClass
 
typedef ilog::CLoggerBase BaseClass2
 

Public Member Functions

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 ilog::CLoggerBase
 CLoggerBase ()
 
const QByteArray & GetVerboseSenderId () const
 Get sender ID for verbose messages.
 
void SetVerboseSenderId (const QByteArray &id)
 Set sender ID for verbose messages.
 
void SetLogPtr (ilog::IMessageConsumer *logPtr) override
 Install log.
 
ilog::IMessageConsumerGetLogPtr () const override
 Get log.
 
- Public Member Functions inherited from ilog::ILoggable
- Public Member Functions inherited from ibase::IApplication

Protected Member Functions

virtual void OnApplicationShutdown ()
 Callback for the application's shutdown.
 
void OnComponentCreated () override
 
void OnComponentDestroyed () override
 
- Protected Member Functions inherited from ilog::TLoggerCompWrap< CInstantiatorComp >
virtual void DecorateMessage (istd::IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const override
 Decorate message parts before outputting.
 
void OnComponentCreated () override
 
void OnComponentDestroyed () override
 
- Protected Member Functions inherited from ilog::CLoggerBase
bool IsVerboseEnabled () const
 Check if verbose messages are enabled.
 
bool SendVerboseMessage (const QString &message, const QString &messageSource=QString()) const
 Send verbose message.
 
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.
 
bool IsLogConsumed (const istd::IInformationProvider::InformationCategory *categoryPtr=nullptr, const int *flagsPtr=nullptr) const override
 Check if any log message is consumed.
 
bool SendLogMessage (istd::IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const override
 Send any message to log.
 
- Protected Member Functions inherited from istd::ILogger

Additional Inherited Members

- Protected Attributes inherited from ilog::CLoggerBase
QSet< int > m_onceMessageIds
 

Detailed Description

Console (non-gui) application.

Definition at line 31 of file CConsoleApplicationComp.h.

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ Execute()

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

Start execution loop of the application.

Implements ibase::IApplication.

◆ GetApplicationArguments()

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

Get the command line arguments of this application.

Implements ibase::IApplication.

◆ GetHelpText()

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

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

Implements ibase::IApplication.

◆ InitializeApplication()

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.

◆ OnComponentCreated()

void ibase::CConsoleApplicationComp::OnComponentCreated ( )
overrideprotected

◆ OnComponentDestroyed()

void ibase::CConsoleApplicationComp::OnComponentDestroyed ( )
overrideprotected

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

© Witold Gantzke and Kirill Lepskiy