zeus::IModule Class Reference

#include <IModule.hpp>

Inheritance diagram for zeus::IModule:

List of all members.

Public Member Functions
virtual Uint MQUALIFIER	getMode () const =0
virtual void MQUALIFIER	activate ()=0
virtual void MQUALIFIER	deactivate ()=0
virtual bool MQUALIFIER	isActive (bool bGlobaly=false) const =0
virtual Retval MQUALIFIER	getZeusAPI (IZeusAPI *&rpApi)=0
virtual Retval MQUALIFIER	getModule (const IString &rName, IModule *&rpModule)=0
virtual void MQUALIFIER	getName (IString &rName) const =0
virtual Retval MQUALIFIER	registerActiveModule (IModule &rModule)=0
virtual Retval MQUALIFIER	unregisterActiveModule (IModule &rModule)=0
virtual Retval MQUALIFIER	getActiveModule (IModule *&rpModule)=0
virtual Retval MQUALIFIER	getModuleSession (IModuleSession *&rpSession)=0
virtual void MQUALIFIER	getModuleSessionLibrary (IString &rName) const =0

---

Detailed Description

The IModule Interface defines an abstract node of the MOM tree

---

Member Function Documentation

virtual void MQUALIFIER zeus::IModule::activate

(

)

[pure virtual]

This method activates a module.

Implemented in zeus::TModule, and zeus::TSystemManager.

virtual void MQUALIFIER zeus::IModule::deactivate

(

)

[pure virtual]

This method deactivates a module.

Implemented in zeus::TModule, and zeus::TSystemManager.

virtual Retval MQUALIFIER zeus::IModule::getActiveModule

(

IModule *&

rpModule )

[pure virtual]

This method retuns the active module of a manager.

Parameters:

rpModule

: new active module

Return values:

RET_NOERROR	: active module returned
RET_REQUEST_FAILED	: No active module found

Implemented in zeus::TModule, and zeus::TSystemManager.

virtual Uint MQUALIFIER zeus::IModule::getMode

(

)

const [pure virtual]

Gets the mode of a module

Return values:

MODULEMODE_NORMAL	: Normal mode. Module will be loaded when needed
MODULEMODE_LOAD	: Loads the module imediately

Implemented in zeus::TModule, and zeus::TSystemManager.

virtual Retval MQUALIFIER zeus::IModule::getModule	(	const IString &	rName,
		IModule *&	rpModule
	)		[pure virtual]

This method is used to get a module by name. Its functionality is the same as IXObject::getObject() but it returns only object of Type IModule. For all others use getObject directly.

Parameters:

rName	: Name or path of the module
rpModule	: return parameter of the module

Return values:

RET_NOERROR	: Module found
RET_REQUEST_FAILED	; No module with this name found

Implemented in zeus::TModule, and zeus::TSystemManager.

virtual Retval MQUALIFIER zeus::IModule::getModuleSession

(

IModuleSession *&

rpSession )

[pure virtual]

This method retuns the module session object of this module. The session is normally created within a library and is used as a non dynamic factory interface (gateway) to the library objects

Parameters:

rpSession

: return parameter to receive the loaded session

Return values:

RET_NOERROR	: session returned
RET_REQUEST_FAILED	: No session available

Implemented in zeus::TModule, and zeus::TSystemManager.

virtual void MQUALIFIER zeus::IModule::getModuleSessionLibrary

(

IString &

rName )

const [pure virtual]

This method retuns the module session library

Parameters:

rName

: return parameter of the filename from the module session library

Implemented in zeus::TModule, and zeus::TSystemManager.

virtual void MQUALIFIER zeus::IModule::getName

(

IString &

rName )

const [pure virtual]

Returns the name of a module

Parameters:

rName

: Return parameter of the name

Implemented in zeus::TModule, and zeus::TSystemManager.

virtual Retval MQUALIFIER zeus::IModule::getZeusAPI

(

IZeusAPI *&

rpApi )

[pure virtual]

Returns the API of zeus for this specific module.

Parameters:

rpApi

: Return value of the api

Return values:

RET_NOERROR	: API returned
RET_REQUEST_FAILED	: No API found

Implemented in zeus::TModule, and zeus::TSystemManager.

virtual bool MQUALIFIER zeus::IModule::isActive

(

bool

bGlobaly = false )

const [pure virtual]

Checks if a module is activated

Parameters:

bGlobaly

: false = is module localy active (at the parent) (default). true = is module globaly active (whole MOM tree)

Return values:

true	: Module is activated
false	: The module is not activated

Implemented in zeus::TModule, and zeus::TSystemManager.

virtual Retval MQUALIFIER zeus::IModule::registerActiveModule

(

IModule &

rModule )

[pure virtual]

This method registeres a new active module. The active module must be a child of the parent, otherwise RET_REQUEST_FAILED will be returned.

Parameters:

rModule

: new active module

Return values:

RET_NOERROR	: No Error occured registring the active module
RET_REQUEST_FAILED	: unable to register module as active

Implemented in zeus::TModule, and zeus::TSystemManager.

virtual Retval MQUALIFIER zeus::IModule::unregisterActiveModule

(

IModule &

rModule )

[pure virtual]

This method unregisteres an active module. The active module must be a active child of the parent, otherwise RET_REQUEST_FAILED will be returned.

Parameters:

rModule

: module to deactivate

Return values:

RET_NOERROR	: No Error occured registring the deactive module
RET_REQUEST_FAILED	: unable to unregister module as deactive

Implemented in zeus::TModule, and zeus::TSystemManager.

---

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

• IModule.hpp