zeus::TZeusAPI Class Reference

#include <ZeusAPI.h>

Inheritance diagram for zeus::TZeusAPI:

List of all members.

Public Member Functions
	TZeusAPI (IXObject &rObject)
virtual	~TZeusAPI ()
virtual Retval MQUALIFIER	createObjectOfModule (const IString &rModuleName, const InterfaceID &rInterfaceID, IZUnknown *&rpIface)
virtual Retval MQUALIFIER	executeCommand (Uint uiMode, const IString &rstrTarget, const IString &rstrMainData, const IString &rstrAddData, const IString &rstrStreamData, Uint uiSecurity, Uint uiExecutionMode)
virtual Retval MQUALIFIER	getCastedObject (const IString &rPath, const InterfaceID &rIfaceID, IZUnknown *&rpObj)
virtual Retval MQUALIFIER	getObject (const IString &rPath, IXObject *&rpObj)
virtual Retval MQUALIFIER	getObjects (const IString &rstrPath, IXObjectCollection *&rpCollection)
virtual Retval MQUALIFIER	getPropertyValue (const IString &rName, IString &rValue) const
virtual Retval MQUALIFIER	getUserValue (const IString &rName, IString &rValue) const
virtual void MQUALIFIER	logMessage (Uint uiMode, const IString &rstrMessage)
virtual Retval MQUALIFIER	setPropertyValue (const IString &rName, const IString &rValue)
virtual Retval MQUALIFIER	setUserValue (const IString &rName, const IString &rValue)
virtual Retval MQUALIFIER	askForInterface (const InterfaceID &rInterfaceID, IZUnknown *&rpIface)
virtual void MQUALIFIER	addRef () const
virtual void MQUALIFIER	release () const
Protected Attributes
IXObject &	m_rObject
	Cross Reference of the parent module.

---

Detailed Description

Implementation of the Zeus framework API

---

Constructor & Destructor Documentation

TZeusAPI::TZeusAPI

(

IXObject &

rObject )

Creates a new Zeus API Object

TZeusAPI::~TZeusAPI

(

)

[virtual]

Destroys the Zeus API Object

---

Member Function Documentation

virtual void MQUALIFIER zeus::TZeusAPI::addRef

(

)

const [virtual]

See also:

IZUnknown::addRef

Reimplemented from zeus::TZObject.

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

See also:

IZUnknown::askForInterface

Reimplemented from zeus::TZObject.

Retval MQUALIFIER TZeusAPI::createObjectOfModule	(	const IString &	rModuleName,
		const InterfaceID &	rInterfaceID,
		IZUnknown *&	rpIface
	)		[virtual]

See also:

IZeusAPI::createObjectOfModule

Implements zeus::IZeusAPI.

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

See also:

IZeusAPI::executeCommand

Implements zeus::IZeusAPI.

Retval MQUALIFIER zeus::TZeusAPI::getCastedObject	(	const IString &	rPath,
		const InterfaceID &	rIfaceID,
		IZUnknown *&	rpObj
	)		[inline, virtual]

See also:

IZeusAPI::getXObject

Implements zeus::IZeusAPI.

Retval MQUALIFIER zeus::TZeusAPI::getObject	(	const IString &	rPath,
		IXObject *&	rpObj
	)		[inline, virtual]

See also:

IZeusAPI::getXObject

Implements zeus::IZeusAPI.

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

See also:

IZeusAPI::getObjects

Implements zeus::IZeusAPI.

Retval MQUALIFIER TZeusAPI::getPropertyValue	(	const IString &	rName,
		IString &	rValue
	)		const [virtual]

See also:

IZeusAPI::getPropertyValue

Implements zeus::IZeusAPI.

Retval MQUALIFIER TZeusAPI::getUserValue	(	const IString &	rName,
		IString &	rValue
	)		const [virtual]

See also:

IZeusAPI::setUserValue

Implements zeus::IZeusAPI.

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

See also:

IZeusAPI::logMessage

Implements zeus::IZeusAPI.

virtual void MQUALIFIER zeus::TZeusAPI::release

(

)

const [virtual]

See also:

IZUnknown::release

Reimplemented from zeus::TZObject.

Retval MQUALIFIER TZeusAPI::setPropertyValue	(	const IString &	rName,
		const IString &	rValue
	)		[virtual]

See also:

IZeusAPI::setPropertyValue

Implements zeus::IZeusAPI.

Retval MQUALIFIER TZeusAPI::setUserValue	(	const IString &	rName,
		const IString &	rValue
	)		[virtual]

See also:

IZeusAPI::setUserValue

Implements zeus::IZeusAPI.

---

Member Data Documentation

IXObject& zeus::TZeusAPI::m_rObject [protected]

Cross Reference of the parent module.

---

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

• ZeusAPI.h
• ZeusAPI.cpp