makVrv::DtAgent Class Reference

A distributed object agent base class. More...

Inheritance diagram for makVrv::DtAgent:

Public Member Functions
virtual	~DtAgent ()
	DTOR.
DtAgentManagerInterface &	sceneInterface ()
	Get the scene interface, the scene interface may not be NULL (so a reference is safe.
void	setSceneInterface (DtAgentManagerInterface *iface)
	Set the internal scene interface pointer.
void	init (DtAgentManagerInterface &sceneInterface, bool bDistribute)
	Initialize the object proxy this must be called once before using the object.
const std::string &	className () const
	Get the class name.
void	clean ()
void	dirty ()
DtUniqueID	uniqueId () const
	inline accessor
bool	distributeMessages () const
	Accessor for myDistributeMessageFlag.

Protected Member Functions
DtMessage &	startNewCall (unsigned int function)
	Inline get arguments for a operation call operation.
void	addCreateObjectCall ()
	Add a call which will create the actual object.
void	addDeleteObjectCall ()
	Add a call to delete an object.
unsigned int	callCount () const
	Get the number of calls.
template<typename C >
void	queueOperationCall (unsigned int state_function, void(C::*m)())
	DtAgent ()
	Support up to 9 args, if more needed simply add, as they are template functions that will be dynamically generated.
	DtAgent (DtAgent &)
	Copy CTOR is used internally for last update values.
DtAgentManagerInterface::OrderedCallList &	callList ()
	Get a pointer to the call list.

Protected Attributes
DtAgentManagerInterface *	mySceneInterface
DtUniqueID	myUniqueId
std::string	myClassName
bool	myUpdateFlag
DtAgentManagerInterface::OrderedCallList	myCalls
bool	myDistributeObjectFlag

Friends
class	DtAgentManagerInterface
	Allow the scene manager interface access the processed functions.
class	DtAgentManager

Detailed Description

A distributed object agent base class.

Constructor & Destructor Documentation

virtual makVrv::DtAgent::~DtAgent ( )

virtual

DTOR.

makVrv::DtAgent::DtAgent ( )

protected

Support up to 9 args, if more needed simply add, as they are template functions that will be dynamically generated.

CTOR

makVrv::DtAgent::DtAgent ( DtAgent &  )

protected

Copy CTOR is used internally for last update values.

Member Function Documentation

DtAgentManagerInterface & makVrv::DtAgent::sceneInterface ( )

inline

Get the scene interface, the scene interface may not be NULL (so a reference is safe.

References mySceneInterface.

void makVrv::DtAgent::setSceneInterface ( DtAgentManagerInterface *  iface )

inline

Set the internal scene interface pointer.

References mySceneInterface.

void makVrv::DtAgent::init	(	DtAgentManagerInterface &	sceneInterface,
		bool	bDistribute
	)

Initialize the object proxy this must be called once before using the object.

It will be called automatically during proxy creation

const std::string & makVrv::DtAgent::className ( ) const

inline

Get the class name.

References myClassName.

void makVrv::DtAgent::clean ( )

inline

References myCalls, and myUpdateFlag.

void makVrv::DtAgent::dirty ( )

inline

References mySceneInterface, myUpdateFlag, and makVrv::DtAgentManagerInterface::queueObjectForUpdate().

Referenced by queueOperationCall().

DtUniqueID makVrv::DtAgent::uniqueId ( ) const

inline

inline accessor

References myUniqueId.

bool makVrv::DtAgent::distributeMessages ( ) const

inline

Accessor for myDistributeMessageFlag.

Get myDistributeMessageFlag.

Returns true if messages are going to be distributed to each slave in addition to the master.

References myDistributeObjectFlag.

DtMessage & makVrv::DtAgent::startNewCall ( unsigned int  function )

inlineprotected

Inline get arguments for a operation call operation.

References makVrv::DtAgentManagerInterface::createNewCallID(), myCalls, myDistributeObjectFlag, mySceneInterface, and myUniqueId.

Referenced by queueOperationCall().

void makVrv::DtAgent::addCreateObjectCall ( )

protected

Add a call which will create the actual object.

void makVrv::DtAgent::addDeleteObjectCall ( )

protected

Add a call to delete an object.

unsigned int makVrv::DtAgent::callCount ( ) const

inlineprotected

Get the number of calls.

References myCalls.

template<typename C >

void makVrv::DtAgent::queueOperationCall ( unsigned int  state_function, void(C::*)()  m  )

inlineprotected

References dirty(), and startNewCall().

DtAgentManagerInterface::OrderedCallList & makVrv::DtAgent::callList ( )

inlineprotected

Get a pointer to the call list.

References myCalls.

Friends And Related Function Documentation

friend class DtAgentManagerInterface

friend

Allow the scene manager interface access the processed functions.

friend class DtAgentManager

friend

Member Data Documentation

DtAgentManagerInterface* makVrv::DtAgent::mySceneInterface

protected

Referenced by dirty(), sceneInterface(), setSceneInterface(), and startNewCall().

DtUniqueID makVrv::DtAgent::myUniqueId

protected

Referenced by startNewCall(), and uniqueId().

std::string makVrv::DtAgent::myClassName

protected

Referenced by className().

bool makVrv::DtAgent::myUpdateFlag

protected

Referenced by clean(), and dirty().

DtAgentManagerInterface::OrderedCallList makVrv::DtAgent::myCalls

protected

Referenced by callCount(), callList(), clean(), and startNewCall().

bool makVrv::DtAgent::myDistributeObjectFlag

protected

Referenced by distributeMessages(), and startNewCall().

---

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

• DtAgent.h
• DtAgent.inl