zeus::TAbstractFrameLoader Class Reference

#include <AbstractFrameLoader.h>

Inheritance diagram for zeus::TAbstractFrameLoader:

List of all members.

Public Member Functions
	TAbstractFrameLoader (const TString &strBaseName, int iArgc, char *apArgs[])
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< TDirectory >	m_ptrBaseDirectory
TFile	m_ModuleFile
	Module file of the application.
TAutoPtr< IXObject >	m_ptrRootObject
	Root object of the Framework.
TAutoPtr< TPropertyFile >	m_ptrSystemSettings
	Loaded property file.
TString	m_strPropertyFileName
	Property file name.
TString	m_strConfigFileName
	Configuration file of the XML MOM structure.
TArgumentParser &	m_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,
		int	iArgc,
		char *	apArgs[]
	)

Creates a FrameLoader

Parameters:

	strBaseName	: Name of the application base
	iArgc	: number of arguments
	apArgs,:	List of arguments

TAbstractFrameLoader::~TAbstractFrameLoader

(

)

[protected, virtual]

Destroys the FrameLoader

---

Member Function Documentation

void TAbstractFrameLoader::initialize

(

)

[virtual]

Initializes the frameloader

bool zeus::TAbstractFrameLoader::canStartup

(

)

[inline, virtual]

Checks if the framewaork should be started or not

Retval TAbstractFrameLoader::startup

(

)

[virtual]

Starts the Frame

Retval TAbstractFrameLoader::shutdown

(

)

[virtual]

Closes the Frame

virtual Int zeus::TAbstractFrameLoader::run

(

)

[pure virtual]

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

Retval TAbstractFrameLoader::buildXObjectTree

(

TString

strFilename = L""

)

[protected, virtual]

Creates a XObject tree out of a file

void TAbstractFrameLoader::registerClasses

(

)

[protected]

Register all classes of the Framework

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.

Retval TAbstractFrameLoader::initSystemLibraries

(

)

[protected, virtual]

Initializes the System Libraries.

Return values:

	RET_NOERROR	: System libs initialized
	RET_REQUEST_FAILED	: No system libs initialized

void TAbstractFrameLoader::initSystem

(

)

[protected, virtual]

This method initializes the system

virtual void zeus::TAbstractFrameLoader::onInitPropertiesFailed

(

)

[inline, protected, virtual]

virtual void zeus::TAbstractFrameLoader::onInitSecurityFailed

(

)

[inline, protected, virtual]

virtual void zeus::TAbstractFrameLoader::onInitSystemLibrariesFailed

(

)

[inline, protected, virtual]

---

Member Data Documentation

TDirectory zeus::TAbstractFrameLoader::m_WorkingDir [protected]

Working directory.

TAutoPtr<TDirectory> zeus::TAbstractFrameLoader::m_ptrBaseDirectory [protected]

TFile zeus::TAbstractFrameLoader::m_ModuleFile [protected]

Module file of the application.

TAutoPtr<IXObject> zeus::TAbstractFrameLoader::m_ptrRootObject [protected]

Root object of the Framework.

TAutoPtr<TPropertyFile> zeus::TAbstractFrameLoader::m_ptrSystemSettings [protected]

Loaded property file.

TString zeus::TAbstractFrameLoader::m_strPropertyFileName [protected]

Property file name.

TString zeus::TAbstractFrameLoader::m_strConfigFileName [protected]

Configuration file of the XML MOM structure.

TArgumentParser& zeus::TAbstractFrameLoader::m_rArgumentParser [protected]

Parses the arguments of the execution.

Uint zeus::TAbstractFrameLoader::m_uiSecurityHandle [protected]

Security handle.

---

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

• AbstractFrameLoader.h
• AbstractFrameLoader.cpp