Public Member Functions | Protected Member Functions | Protected Attributes

zeus::TModule Class Reference

#include <Module.h>

Inheritance diagram for zeus::TModule:
zeus::TXLoaderObject zeus::IModule zeus::TXObject zeus::IXLoaderObject zeus::IZUnknown zeus::TZObject zeus::IXObject zeus::IZUnknown zeus::IZUnknown zeus::IZUnknown

List of all members.

Public Member Functions

 TModule (IXMLNode &rNode)
virtual Uint MQUALIFIER getMode () const
virtual void MQUALIFIER activate ()
virtual void MQUALIFIER deactivate ()
virtual bool MQUALIFIER isActive (bool bGlobaly=false) const
virtual Retval MQUALIFIER getZeusAPI (IZeusAPI *&rpApi)
virtual Retval MQUALIFIER getModule (const IString &rName, IModule *&rpModule)
void MQUALIFIER getName (IString &rName) const
virtual Retval MQUALIFIER registerActiveModule (IModule &rModule)
virtual Retval MQUALIFIER unregisterActiveModule (IModule &rModule)
virtual Retval MQUALIFIER getActiveModule (IModule *&rpModule)
virtual Retval MQUALIFIER getModuleSession (IModuleSession *&rpSession)
virtual void MQUALIFIER getModuleSessionLibrary (IString &rName) const
virtual Retval MQUALIFIER load ()
virtual Retval MQUALIFIER unload ()
virtual bool MQUALIFIER freeze ()
virtual bool MQUALIFIER unfreeze ()
virtual Retval MQUALIFIER askForInterface (const InterfaceID &rInterfaceID, IZUnknown *&rpIface)
virtual void MQUALIFIER addRef () const
virtual void MQUALIFIER release () const

Protected Member Functions

 REG_SUB_BEGIN (TModule) REG_SUB_ADD(TModule
virtual ~TModule ()
virtual void createAPI (TZeusAPI *&rpAPI)

Protected Attributes

TModule
REG_SUB_END TZeusAPIm_pZeusAPI
 Zeus API Object.
IModuleSessionm_pSession
 Module Session Object.

Detailed Description

The TModule class spezifies a node of the MOM Tree


Constructor & Destructor Documentation

TModule::~TModule (  ) [protected, virtual]

Destroys the module


Member Function Documentation

void MQUALIFIER TModule::activate (  ) [virtual]
See also:
IModule::activate If no active module is registered and this is not a leaf module, it will activate the first module found in the list. This will go on until the leaf is reached or a activemodule is found.

Implements zeus::IModule.

virtual void MQUALIFIER zeus::TModule::addRef (  ) const [virtual]
See also:
IZUnknown::addRef

Reimplemented from zeus::TXLoaderObject.

virtual Retval MQUALIFIER zeus::TModule::askForInterface ( const InterfaceID rInterfaceID,
IZUnknown *&  rpIface 
) [virtual]
See also:
IZUnknown::askForInterface

Reimplemented from zeus::TXLoaderObject.

void TModule::createAPI ( TZeusAPI *&  rpAPI ) [protected, virtual]

Creates the API for module sessions

void MQUALIFIER TModule::deactivate (  ) [virtual]

The deactivation does not remove the ActiveModule Reference of this module. According to the MOM2 specification, this reference is kept.

See also:
IModule::deactivate

Implements zeus::IModule.

bool MQUALIFIER TModule::freeze (  ) [virtual]
See also:
IXObject::freeze

Reimplemented from zeus::TXLoaderObject.

Retval MQUALIFIER TModule::getActiveModule ( IModule *&  rpModule ) [virtual]
Uint MQUALIFIER TModule::getMode (  ) const [virtual]
See also:
IModule::getMode

Implements zeus::IModule.

Retval MQUALIFIER TModule::getModule ( const IString rName,
IModule *&  rpModule 
) [virtual]
See also:
IModule::getModule

Implements zeus::IModule.

Retval MQUALIFIER TModule::getModuleSession ( IModuleSession *&  rpSession ) [virtual]
void MQUALIFIER zeus::TModule::getModuleSessionLibrary ( IString rName ) const [inline, virtual]
void MQUALIFIER zeus::TModule::getName ( IString rName ) const [inline, virtual]
See also:
IModule::getName

Implements zeus::IModule.

Retval MQUALIFIER TModule::getZeusAPI ( IZeusAPI *&  rpApi ) [virtual]
See also:
IModule::getZeusAPI

Implements zeus::IModule.

bool MQUALIFIER TModule::isActive ( bool  bGlobaly = false ) const [virtual]
See also:
IModule::isActive

Implements zeus::IModule.

Retval MQUALIFIER TModule::load (  ) [virtual]
See also:
IXLoaderObject::load

Reimplemented from zeus::TXLoaderObject.

zeus::TModule::REG_SUB_BEGIN ( TModule   ) [protected]
Retval MQUALIFIER TModule::registerActiveModule ( IModule rModule ) [virtual]
See also:
IModule::registerActiveModule A module is registring themself as active. If this module (parent) is not marked as active itself, iy will to it at this moment. This will go on until the root module or a already active parent is reached.

Implements zeus::IModule.

virtual void MQUALIFIER zeus::TModule::release (  ) const [virtual]
See also:
IZUnknown::release

Reimplemented from zeus::TXLoaderObject.

bool MQUALIFIER TModule::unfreeze (  ) [virtual]
See also:
IXObject::unfreeze

Reimplemented from zeus::TXLoaderObject.

Retval MQUALIFIER TModule::unload (  ) [virtual]
See also:
IXLoaderObject::unload

Reimplemented from zeus::TXLoaderObject.

Retval MQUALIFIER TModule::unregisterActiveModule ( IModule rModule ) [virtual]

Member Data Documentation

Module Session Object.

REG_SUB_END TZeusAPI* zeus::TModule::m_pZeusAPI [protected]

Zeus API Object.

TModule::TModule [protected]

Creates the module


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:27