Nebula
Loading...
Searching...
No Matches
App::ConsoleApplication Class Reference

#include <consoleapplication.h>

Detailed Description

Base class for Nebula console applications.

Will provide a typicel execution environment for console apps.

Inherits App::Application.

Public Member Functions

 ConsoleApplication ()
 constructor
 
virtual ~ConsoleApplication ()
 destructor
 
virtual bool Open ()
 open the application
 
virtual void Close ()
 close the application
 
- Public Member Functions inherited from App::Application
 Application ()
 constructor
 
virtual ~Application ()
 destructor
 
void SetCompanyName (const Util::String &n)
 set company name
 
const Util::StringGetCompanyName () const
 get company name
 
void SetAppTitle (const Util::String &n)
 set application name
 
const Util::StringGetAppTitle () const
 get application name
 
void SetAppID (const Util::String &n)
 set application id
 
const Util::StringGetAppID () const
 get application id
 
void SetAppVersion (const Util::String &n)
 set application version
 
const Util::StringGetAppVersion () const
 get application version
 
void SetCmdLineArgs (const Util::CommandLineArgs &a)
 set command line args
 
const Util::CommandLineArgsGetCmdLineArgs () const
 get command line args
 
virtual void Exit ()
 exit the application, call right before leaving main()
 
virtual void Run ()
 run the application, return when user wants to exit
 
bool IsOpen () const
 return true if app is open
 
int GetReturnCode () const
 get the return code
 

Protected Attributes

Ptr< Core::CoreServercoreServer
 
Ptr< IO::IoServerioServer
 
- Protected Attributes inherited from App::Application
Util::String companyName
 
Util::String appName
 
Util::String appID
 
Util::String appVersion
 
Util::CommandLineArgs args
 
bool isOpen
 
int returnCode
 

Additional Inherited Members

- Protected Member Functions inherited from App::Application
void SetReturnCode (int c)
 set return code
 

Constructor & Destructor Documentation

◆ ConsoleApplication()

App::ConsoleApplication::ConsoleApplication ( )

constructor

◆ ~ConsoleApplication()

App::ConsoleApplication::~ConsoleApplication ( )
virtual

destructor

Member Function Documentation

◆ Close()

void App::ConsoleApplication::Close ( )
virtual

close the application

Reimplemented from App::Application.

◆ Open()

bool App::ConsoleApplication::Open ( )
virtual

open the application

Reimplemented from App::Application.

Member Data Documentation

◆ coreServer

Ptr<Core::CoreServer> App::ConsoleApplication::coreServer
protected

◆ ioServer

Ptr<IO::IoServer> App::ConsoleApplication::ioServer
protected

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