zeus::IZeusAPI Class Reference

#include <IZeusAPI.hpp>

Inheritance diagram for zeus::IZeusAPI:

List of all members.

Public Member Functions
virtual Retval MQUALIFIER	createObjectOfModule (const IString &rstrModuleName, const InterfaceID &rInterfaceID, IZUnknown *&rpIface)=0
virtual Retval MQUALIFIER	executeCommand (Uint uiMode, const IString &rstrTarget, const IString &rstrMainData, const IString &rstrAddData, const IString &rstrStreamData, Uint uiSecurity, Uint uiExecutionMode)=0
virtual Retval MQUALIFIER	getCastedObject (const IString &rstrPath, const InterfaceID &rIfaceID, IZUnknown *&rpObj)=0
virtual Retval MQUALIFIER	getObject (const IString &rstrPath, IXObject *&rpObj)=0
virtual Retval MQUALIFIER	getObjects (const IString &rstrPath, IXObjectCollection *&rpCollection)=0
virtual Retval MQUALIFIER	getPropertyValue (const IString &rstrName, IString &rstrValue) const =0
virtual Retval MQUALIFIER	getUserValue (const IString &rstrName, IString &rstrValue) const =0
virtual void MQUALIFIER	logMessage (Uint uiMode, const IString &rstrMessage)=0
virtual Retval MQUALIFIER	setPropertyValue (const IString &rstrName, const IString &rstrValue)=0
virtual Retval MQUALIFIER	setUserValue (const IString &rstrName, const IString &rstrValue)=0

---

Detailed Description

The Zeus Application Programming Interface is used to access the framework functionality and to receive other framework interfaces.

---

Member Function Documentation

virtual Retval MQUALIFIER zeus::IZeusAPI::createObjectOfModule	(	const IString &	rstrModuleName,
		const InterfaceID &	rInterfaceID,
		IZUnknown *&	rpIface
	)		[pure virtual]

This method is used to load a new Interface out of a specific module of the MOM system

Parameters:

rstrModuleName,:	Name of the module
rInterfaceID,:	ID of the required interface
rpIface,:	Return parameter

Return values:

RET_NOERROR,:	Interface returned
RET_INVALID_PARAMETER,:	Invalid parameter received
RET_REQUEST_FAILED,:	Could not return the interface, either the module name or the interface_id is invalid

Implemented in zeus::TZeusAPI.

virtual Retval MQUALIFIER zeus::IZeusAPI::executeCommand	(	Uint	uiMode,
		const IString &	rstrTarget,
		const IString &	rstrMainData,
		const IString &	rstrAddData,
		const IString &	rstrStreamData,
		Uint	uiSecurity,
		Uint	uiExecutionMode
	)		[pure virtual]

executes a command

Parameters:

uiMode,:	mode of the command
rstrTarget,:	Target name
rstrMainData,:	Main data
rstrAddData,:	additional data
rstrStreamData,:	streamed data
uiSecurity,:	Security ID (normaly 0)
uiExecutionMode,:	Execution mode

Return values:

RET_NOERROR,:	Command executed
RET_REQUEST_FAILED,:	Could not execute command

Implemented in zeus::TZeusAPI.

virtual Retval MQUALIFIER zeus::IZeusAPI::getCastedObject	(	const IString &	rstrPath,
		const InterfaceID &	rIfaceID,
		IZUnknown *&	rpObj
	)		[pure virtual]

Try to find an object in the MOM System and returns the casted interface.

Parameters:

rstrPath,:	Name of the object to be returned
rIfaceID,:	InterfaceID
rpObj,:	Return parameter of the object

Return values:

RET_NOERROR,:	Object found and returned
RET_REQUEST_FAILED,:	No object or module found

Implemented in zeus::TZeusAPI.

virtual Retval MQUALIFIER zeus::IZeusAPI::getObject	(	const IString &	rstrPath,
		IXObject *&	rpObj
	)		[pure virtual]

Try to find an object in the MOM System

Parameters:

rstrPath,:	Name of the object to be returned
rpObj,:	Return parameter of the object

Return values:

RET_NOERROR,:	Object found and returned
RET_REQUEST_FAILED,:	No object or module found

Implemented in zeus::TZeusAPI.

virtual Retval MQUALIFIER zeus::IZeusAPI::getObjects	(	const IString &	rstrPath,
		IXObjectCollection *&	rpCollection
	)		[pure virtual]

Try to find a collection of objects in the MOM System

Parameters:

rstrPath,:	Name of the object to be returned
rpCollection,:	Return parameter of the collection

Return values:

RET_NOERROR,:	Objects found and returned
RET_REQUEST_FAILED,:	No object or module found

Implemented in zeus::TZeusAPI.

virtual Retval MQUALIFIER zeus::IZeusAPI::getPropertyValue	(	const IString &	rstrName,
		IString &	rstrValue
	)		const [pure virtual]

Reads a property value out of the settings manager

Implemented in zeus::TZeusAPI.

virtual Retval MQUALIFIER zeus::IZeusAPI::getUserValue	(	const IString &	rstrName,
		IString &	rstrValue
	)		const [pure virtual]

Reads a user value out of the settings manager

Parameters:

rstrName,:	Key of the user value
rstrValue,:	return value

Implemented in zeus::TZeusAPI.

virtual void MQUALIFIER zeus::IZeusAPI::logMessage	(	Uint	uiMode,
		const IString &	rstrMessage
	)		[pure virtual]

sends a message to the logger

Parameters:

uiMode,:	Logmode
rstrMessage,:	Message to log

Implemented in zeus::TZeusAPI.

virtual Retval MQUALIFIER zeus::IZeusAPI::setPropertyValue	(	const IString &	rstrName,
		const IString &	rstrValue
	)		[pure virtual]

Writes a property value to the settings manager

Implemented in zeus::TZeusAPI.

virtual Retval MQUALIFIER zeus::IZeusAPI::setUserValue	(	const IString &	rstrName,
		const IString &	rstrValue
	)		[pure virtual]

Writes a user value to the settings manager

Parameters:

rstrName,:	Key of the user value
rstrValue,:	return value

Implemented in zeus::TZeusAPI.

---

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

• IZeusAPI.hpp