Public Member Functions | Protected Member Functions | Protected Attributes

zeus::TAbstractFrameLoader Class Reference

#include <AbstractFrameLoader.h>

Inheritance diagram for zeus::TAbstractFrameLoader:
zeus::TZObject zeus::IZUnknown

List of all members.

Public Member Functions

 TAbstractFrameLoader (const TString &strBaseName)
 TAbstractFrameLoader (const TString &strBaseName, int iArgc, char *apArgs[])
 TAbstractFrameLoader (const TString &strBaseName, int iArgc, wchar_t *awcArgs[])
virtual void initialize ()
virtual bool canStartup ()
virtual Retval startup ()
virtual Retval shutdown ()
virtual Int run ()=0
Retval getRootObject (IXObject *&rpRoot)

Protected Member Functions

virtual ~TAbstractFrameLoader ()
virtual Retval buildXObjectTree (TString strFileName=L"")
void registerClasses ()
virtual Retval initProperties ()
virtual Retval initSecurity ()
virtual Retval initSystemLibraries ()
virtual void initSystem ()
virtual void onInitPropertiesFailed ()
virtual void onInitSecurityFailed ()
virtual void onInitSystemLibrariesFailed ()

Protected Attributes

TDirectory m_WorkingDir
 Working directory.
TAutoPtr< TDirectorym_ptrBaseDirectory
TFile m_ModuleFile
 Module file of the application.
TAutoPtr< IXObjectm_ptrRootObject
 Root object of the Framework.
TAutoPtr< TPropertyFilem_ptrSystemSettings
 Loaded property file.
TString m_strPropertyFileName
 Property file name.
TString m_strConfigFileName
 Configuration file of the XML MOM structure.
TArgumentParserm_rArgumentParser
 Parses the arguments of the execution.
Uint m_uiSecurityHandle
 Security handle.

Detailed Description

The directory class implements methods to access the system directory


Constructor & Destructor Documentation

TAbstractFrameLoader::TAbstractFrameLoader ( const TString strBaseName )

Creates a FrameLoader

Parameters:
strBaseName: Name of the application base
TAbstractFrameLoader::TAbstractFrameLoader ( const TString strBaseName,
int  iArgc,
char *  apArgs[] 
)

Creates a FrameLoader

Parameters:
strBaseName: Name of the application base
iArgc: number of arguments
apArgs,:List of arguments
TAbstractFrameLoader::TAbstractFrameLoader ( const TString strBaseName,
int  iArgc,
wchar_t *  awcArgs[] 
)

Creates a FrameLoader

Parameters:
strBaseName: Name of the application base
iArgc: number of arguments
awcArgs,:List of arguments
TAbstractFrameLoader::~TAbstractFrameLoader (  ) [protected, virtual]

Destroys the FrameLoader


Member Function Documentation

Retval TAbstractFrameLoader::buildXObjectTree ( TString  strFilename = L"" ) [protected, virtual]

Creates a XObject tree out of a file

bool zeus::TAbstractFrameLoader::canStartup (  ) [inline, virtual]

Checks if the framewaork should be started or not

Retval TAbstractFrameLoader::getRootObject ( IXObject *&  rpRoot )

Returns the root object of the framework

Parameters:
rpRoot: return parameter of the Root
Return values:
RET_NOERROR: Root returned
RET_INVALID_PARAMETER: Invalid parameter received
RET_REQUEST_FAILED: No root available
void TAbstractFrameLoader::initialize (  ) [virtual]

Initializes the frameloader

Retval TAbstractFrameLoader::initProperties (  ) [protected, virtual]

Load the property file and initializes the settings manager. All arguments given to the application will be loaded to the settings manager at this time.

Returns:
Error code of TPropertyFile::load()
Retval TAbstractFrameLoader::initSecurity (  ) [protected, virtual]

Initialises the security of the framework. This method can be overwritten, so that customized code may be added for security extendsions. The security data base can be set in the property file using the [BASE].SecurityManager.FileName=[securityfilename] property. If none is set the file [./security.db] is the standard value.

void TAbstractFrameLoader::initSystem (  ) [protected, virtual]

This method initializes the system

Retval TAbstractFrameLoader::initSystemLibraries (  ) [protected, virtual]

Initializes the System Libraries.

Return values:
RET_NOERROR: System libs initialized
RET_REQUEST_FAILED: No system libs initialized
virtual void zeus::TAbstractFrameLoader::onInitPropertiesFailed (  ) [inline, protected, virtual]
virtual void zeus::TAbstractFrameLoader::onInitSecurityFailed (  ) [inline, protected, virtual]
virtual void zeus::TAbstractFrameLoader::onInitSystemLibrariesFailed (  ) [inline, protected, virtual]
void TAbstractFrameLoader::registerClasses (  ) [protected]

Register all classes of the Framework

virtual Int zeus::TAbstractFrameLoader::run (  ) [pure virtual]
Retval TAbstractFrameLoader::shutdown (  ) [virtual]

Closes the Frame

Retval TAbstractFrameLoader::startup (  ) [virtual]

Starts the Frame


Member Data Documentation

Module file of the application.

Root object of the Framework.

Loaded property file.

Parses the arguments of the execution.

Configuration file of the XML MOM structure.

Property file name.

Security handle.

Working directory.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Sun Jan 22 2012 15:28:23