DtGenericObjectPublisher Class Reference

Instances of DtGenericObjectPublisher are used for local or source simulations of objects for which a more specific publisher does not exist. More...

Inheritance diagram for DtGenericObjectPublisher:

Collaboration diagram for DtGenericObjectPublisher:

Public Member Functions
	DtGenericObjectPublisher (DtExerciseConn *conn, const char *className, const char *objName=0, const DtDDMRegionSet *regionSetToUse=0)
	Constructor - configure base class with proper FOM class, state repositories, encoder and decoder.
virtual	~DtGenericObjectPublisher ()
	destructor
virtual DtStateRepository *	genericStateRep ()
	Returns a pointer to the DtStateRepository - through which you can set current state information.
virtual DtStateRepository *	gsr ()
	Synonym for genericStateRep().
Public Member Functions inherited from DtObjectPublisher
	DtObjectPublisher (DtExerciseConn *conn, DtStateRepository *stateRep, DtStateRepository *asSeenByRemote, bool okToDeleteStateRep=true, const DtDDMRegionSet *regionSet=0)
	Constructor.
virtual	~DtObjectPublisher ()
	Destructor.
virtual void	setHlaObject (const char *className, DtHlaStateEncoder *encoder=0, DtHlaStateDecoder *decoder=0, const char *objectName=0, const DtDDMRegionSet *regionSet=0)
	A DtObjectPublisher is not capable of communicating data through the RTI until setHlaObject is called.
virtual void	setHlaObject (RTI::ObjectClassHandle hand, DtHlaStateEncoder *encoder=0, DtHlaStateDecoder *decoder=0, const char *objectName=0, const DtDDMRegionSet *regionSet=0)
	This version takes a classHandle and optional object name, and creates the DtHlaObject for you.
virtual void	setHlaObject (DtHlaObjectWithStateRep *obj, DtHlaStateEncoder *encoder=0, DtHlaStateDecoder *decoder=0)
	This version takes an existing DtHlaObject, and uses it.
virtual void	detachHlaObject ()
	Detach HLA object - bringing the DtObjectPublisher back to the state it was in before setHlaObject was called.
virtual DtStateRepository *	stateRep ()
	Returns a pointer to the DtStateRepository - through which you can set or inspect current state information.
virtual DtStateRepository *	sr ()
	Synonym for stateRep().
virtual DtStateRepository *	approximateRemoteStateRep ()
	Returns a pointer to the approximate remote DtStateRepository – This state repository contains the contents of the last sent message.
virtual DtHlaStateDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode state messages that we send back into the asSeenByRemote SR.
virtual DtHlaStateEncoder *	encoder ()
	Returns a pointer to the Encoder being used to encode current state into an outgoing message.
virtual DtHlaObjectWithStateRep *	hlaObject ()
	Get the object's hlaObject.
virtual DtExerciseConn *	exerciseConn ()
	Get our exercise connection.
virtual const DtObjectId &	id () const
	Get the object's local identifier.
virtual const DtObjectId &	objectId () const
	Get the object's local identifier.
virtual const DtObjectId &	localId () const
	Get the object's local identifier.
virtual const DtString &	name () const
	Get the object's name.
virtual const DtGlobalObjectDesignator &	globalId () const
	Get the HLA object's global object designator - the object name in RTI1.3.3, but the objectId in RTI1.0.3.
virtual void	forceUpdate ()
	Specify a set of attributes that should be included in the ahvps the next time tick is called, even if they would not otherwise need to be sent.
virtual void	forceUpdate (const RTI::AttributeHandleSet &set)
virtual void	tick ()
	Tick (update) this object.
virtual void	setDeleteObjInDtorFlag (bool onOff)
	Set/Get a flag that determines whether to try to delete the HLA object that we represent, upon destruction of this DtObjectPublisher.
virtual bool	deleteObjInDtorFlag () const
virtual const DtDDMRegionSet &	publishingRegions () const
virtual void	addRegion (DtDDMRegionSP regionToAdd)
	Adds the specified region to the set of publishing regions, and calls associateRegionForUpdates on the RTI Ambassador.
virtual void	removeRegion (DtDDMRegionSP regionToRemove)
	Removes the specified region from the set of publishing regions, and calls unassociateRegionForUpdates on the RTI Ambassador.
	DtObjectPublisher (DtExerciseConn *conn, const char *name=0)
	These constructors and init functions are obsolete, but are here for backwards compatibility with pre-3.4 releases.
void	init (RTI::ObjectClassHandle hand, DtStateRepository *stateRep, DtStateRepository *asSeenByRemote, DtHlaStateEncoder *encoder=0, DtHlaStateDecoder *decoder=0)
void	init (const char *className, DtStateRepository *stateRep, DtStateRepository *asSeenByRemote, DtHlaStateEncoder *encoder=0, DtHlaStateDecoder *decoder=0)

Protected Member Functions
	DtGenericObjectPublisher (const DtGenericObjectPublisher &other)
	Copy CTOR – Not Implemented.
DtGenericObjectPublisher &	operator= (const DtGenericObjectPublisher &other)
	Assignment Operator – Not Implemented.
Protected Member Functions inherited from DtObjectPublisher
virtual void	processRemoveObject (DtHlaObject *obj)
	Called by removeObjectCb to detachHlaObject when our underlying DtHlaObject goes away.

Additional Inherited Members
Static Public Member Functions inherited from DtObjectPublisher
static void	removeObjectCb (DtHlaObject *obj, void *pub)
	Callback to be called when our underlying DtHlaObject goes away.
Protected Attributes inherited from DtObjectPublisher
DtExerciseConn *	myExConn
DtHlaObjectWithStateRep *	myHlaObj
DtStateRepository *	myStateRep
DtStateRepository *	myAsSeenByRemote
DtHlaStateEncoder *	myEncoder
DtHlaStateDecoder *	myDecoder
DtObjectId	myObjectId
bool	myOkToDeleteStateRepFlag
DtString	myName
bool	myDeleteObjInDtorFlag
DtDDMRegionSet	myPublishingRegions

Detailed Description

Instances of DtGenericObjectPublisher are used for local or source simulations of objects for which a more specific publisher does not exist.

The publisher sends data to the network when necessary. This class is derived from DtObjectPublisher, which does most of the work. The derived class mostly exists to provide type safety, and to configure the base object.

Constructor & Destructor Documentation

DtGenericObjectPublisher::DtGenericObjectPublisher	(	DtExerciseConn *	conn,
		const char *	className,
		const char *	objName = 0,
		const DtDDMRegionSet *	regionSetToUse = 0
	)

Constructor - configure base class with proper FOM class, state repositories, encoder and decoder.

virtual DtGenericObjectPublisher::~DtGenericObjectPublisher ( )

virtual

destructor

DtGenericObjectPublisher::DtGenericObjectPublisher ( const DtGenericObjectPublisher &  other )

protected

Copy CTOR – Not Implemented.

Member Function Documentation

virtual DtStateRepository* DtGenericObjectPublisher::genericStateRep ( )

virtual

Returns a pointer to the DtStateRepository - through which you can set current state information.

virtual DtStateRepository* DtGenericObjectPublisher::gsr ( )

virtual

Synonym for genericStateRep().

DtGenericObjectPublisher& DtGenericObjectPublisher::operator= ( const DtGenericObjectPublisher &  other )

protected

Assignment Operator – Not Implemented.

---

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

• genericObjectPublisher.h