DtFederateShadow Class Reference

Collaboration diagram for DtFederateShadow:

Public Member Functions
	DtFederateShadow (DtFederationShadow *parent, DtHandle connHandle, DtFederateHandle handle, const MAKRti::DtString &name)
	Constructor. More...
virtual	~DtFederateShadow ()
	Destructor. More...
virtual DtFederateHandle	handle () const
	Get the federate handle. More...
virtual DtHandle	connectionHandle () const
	Get connection handle. More...
virtual const MAKRti::DtString &	name () const
	Get federate name. More...
virtual DtFomModuleManager *	fomManager ()
	Get the FOM Module Manager. More...
virtual void	addObject (DtObjectInstanceHandle instanceHandle, const char *objectName, DtObjectClassInfo *classInfo, const DtAttributeHandleSet &ownedAttributes, const DtAttributeHandleSet &lrcAttributes)
	Add an object. More...
DtObjectShadow *	object (DtObjectInstanceHandle objectHandle)
	Get an object. More...
virtual void	removeObject (DtObjectInstanceHandle instanceHandle)
	Remove an object. More...
virtual bool	ownsObject (DtObjectInstanceHandle objectHandle)
	Return true if federate owns the object's priviledgeToDelete attribute. More...
virtual void	removeAttributes (DtObjectInstanceHandle objectHandle, const DtAttributeHandleSet &attributes)
	Remove attributes (owned or LRC managed) from object Note object may be removed from federate if owned and LRC managed attribute sets become empty. More...
virtual void	processRegisterObject (DtObjectInstanceHandle objectHandle, const DtString &objectName, DtObjectClassHandle classHandle, const DtAttributeHandleSet &attributes)
	Handle register object. More...
virtual void	processMultiRegister (DtObjectClassHandle classHandle, const DtAttributeHandleSet &ownedAttributes, const char *objectPointer, unsigned long objectCount)
	Handle register multiple object. More...
virtual void	processAssocPubReg (DtObjectInstanceHandle objectHandle, const DtString &objectName, DtObjectClassHandle classHandle, const DtAttributeHandleSet &attributes)
	Handle associate region with attributes. More...
virtual void	processUnconditionalDivest (DtObjectInstanceHandle objectHandle, const DtAttributeHandleSet &attributes)
	Handle ownership unconditional divest. More...
virtual void	processNotifyAcquire (DtObjectInstanceHandle instanceHandle, const char *objectName, DtObjectClassHandle classHandle, const DtAttributeHandleSet &attributes)
	Handle ownership notify acquire. More...
virtual void	processGiveToLrc (DtObjectInstanceHandle objectHandle, const char *objectName, DtObjectClassHandle classHandle, const DtAttributeHandleSet &attributes)
	Handle ownership give to LRC. More...
virtual void	processResign (DtResignAction action, DtResignReason reason)
	Handle federate resign. More...

Static Public Member Functions
static DtFederateShadow *	create (DtFederationShadow *parent, DtHandle connHandle, DtFederateHandle handle, const MAKRti::DtString &name)
	Creates an instance of a DtFederateShadow;. More...
static void	setCreatorFunction (DtFederateShadowCreator creator)
	Call this function to set an alternate creator function With this function, users can replace this DtFederateShadow with their own derived class. More...

Protected Member Functions
virtual void	releaseAllAttributes ()
	Release the attributes to the RTI Used when federate was lost or forced to resign and has resign directive to divest attributes. More...
virtual void	deleteOwnedObjects ()
	Delete objects from federation where federate owns priviledgeToDelete. More...
virtual void	sendAndDeleteMessage (DtRtiMsg *message)
	Send the message using the internal transport type and setting the federation and federate handle values Delete the message after sending. More...

Protected Attributes
DtFederationShadow *	myParent
DtFederateHandle	myHandle
DtHandle	myConnectionHandle
MAKRti::DtString	myName
DtObjectShadowByInstanceMap	myObjects
	Objects with attributes owned by this federate or managed by its LRC. More...

Static Protected Attributes
static DtFederateShadowCreator	theCreator

Private Member Functions
	DtFederateShadow (const DtFederateShadow &)
	Not implemented. More...
DtFederateShadow &	operator= (const DtFederateShadow &)
	Not implemented. More...

Constructor & Destructor Documentation

DtFederateShadow::DtFederateShadow	(	DtFederationShadow *	parent,
		DtHandle	connHandle,
		DtFederateHandle	handle,
		const MAKRti::DtString &	name
	)

Constructor.

virtual DtFederateShadow::~DtFederateShadow ( )

virtual

Destructor.

DtFederateShadow::DtFederateShadow ( const DtFederateShadow &  )

private

Not implemented.

Member Function Documentation

virtual void DtFederateShadow::addObject ( DtObjectInstanceHandle  instanceHandle, const char *  objectName, DtObjectClassInfo *  classInfo, const DtAttributeHandleSet &  ownedAttributes, const DtAttributeHandleSet &  lrcAttributes  )

virtual

Add an object.

DtHandle DtFederateShadow::connectionHandle ( ) const

inlinevirtual

Get connection handle.

References myConnectionHandle.

static DtFederateShadow* DtFederateShadow::create ( DtFederationShadow *  parent, DtHandle  connHandle, DtFederateHandle  handle, const MAKRti::DtString &  name  )

static

Creates an instance of a DtFederateShadow;.

virtual void DtFederateShadow::deleteOwnedObjects ( )

protectedvirtual

Delete objects from federation where federate owns priviledgeToDelete.

virtual DtFomModuleManager* DtFederateShadow::fomManager ( )

virtual

Get the FOM Module Manager.

DtFederateHandle DtFederateShadow::handle ( ) const

inlinevirtual

Get the federate handle.

References myHandle.

virtual const MAKRti::DtString& DtFederateShadow::name ( ) const

virtual

Get federate name.

DtObjectShadow* DtFederateShadow::object

(

DtObjectInstanceHandle

objectHandle

)

Get an object.

DtFederateShadow& DtFederateShadow::operator= ( const DtFederateShadow &  )

private

Not implemented.

virtual bool DtFederateShadow::ownsObject ( DtObjectInstanceHandle  objectHandle )

virtual

Return true if federate owns the object's priviledgeToDelete attribute.

virtual void DtFederateShadow::processAssocPubReg ( DtObjectInstanceHandle  objectHandle, const DtString &  objectName, DtObjectClassHandle  classHandle, const DtAttributeHandleSet &  attributes  )

virtual

Handle associate region with attributes.

virtual void DtFederateShadow::processGiveToLrc ( DtObjectInstanceHandle  objectHandle, const char *  objectName, DtObjectClassHandle  classHandle, const DtAttributeHandleSet &  attributes  )

virtual

Handle ownership give to LRC.

virtual void DtFederateShadow::processMultiRegister ( DtObjectClassHandle  classHandle, const DtAttributeHandleSet &  ownedAttributes, const char *  objectPointer, unsigned long  objectCount  )

virtual

Handle register multiple object.

virtual void DtFederateShadow::processNotifyAcquire ( DtObjectInstanceHandle  instanceHandle, const char *  objectName, DtObjectClassHandle  classHandle, const DtAttributeHandleSet &  attributes  )

virtual

Handle ownership notify acquire.

virtual void DtFederateShadow::processRegisterObject ( DtObjectInstanceHandle  objectHandle, const DtString &  objectName, DtObjectClassHandle  classHandle, const DtAttributeHandleSet &  attributes  )

virtual

Handle register object.

virtual void DtFederateShadow::processResign ( DtResignAction  action, DtResignReason  reason  )

virtual

Handle federate resign.

virtual void DtFederateShadow::processUnconditionalDivest ( DtObjectInstanceHandle  objectHandle, const DtAttributeHandleSet &  attributes  )

virtual

Handle ownership unconditional divest.

virtual void DtFederateShadow::releaseAllAttributes ( )

protectedvirtual

Release the attributes to the RTI Used when federate was lost or forced to resign and has resign directive to divest attributes.

virtual void DtFederateShadow::removeAttributes ( DtObjectInstanceHandle  objectHandle, const DtAttributeHandleSet &  attributes  )

virtual

Remove attributes (owned or LRC managed) from object Note object may be removed from federate if owned and LRC managed attribute sets become empty.

virtual void DtFederateShadow::removeObject ( DtObjectInstanceHandle  instanceHandle )

virtual

Remove an object.

virtual void DtFederateShadow::sendAndDeleteMessage ( DtRtiMsg *  message )

protectedvirtual

Send the message using the internal transport type and setting the federation and federate handle values Delete the message after sending.

static void DtFederateShadow::setCreatorFunction ( DtFederateShadowCreator  creator )

static

Call this function to set an alternate creator function With this function, users can replace this DtFederateShadow with their own derived class.

Member Data Documentation

DtHandle DtFederateShadow::myConnectionHandle

protected

Referenced by connectionHandle().

DtFederateHandle DtFederateShadow::myHandle

protected

Referenced by handle().

MAKRti::DtString DtFederateShadow::myName

protected

DtObjectShadowByInstanceMap DtFederateShadow::myObjects

protected

Objects with attributes owned by this federate or managed by its LRC.

DtFederationShadow* DtFederateShadow::myParent

protected

DtFederateShadowCreator DtFederateShadow::theCreator

staticprotected

---

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

• federateShadow.h