DtGriddedDataPublisher Class Reference

class DtGriddedDataPublisher: More...

Inheritance diagram for DtGriddedDataPublisher:

Collaboration diagram for DtGriddedDataPublisher:

Public Types
typedef DtGriddedDataRepository *(*	DtStateRepCreator )()
	Function prototype for functions that create DtGriddedDataRepositories.

Public Member Functions
	DtGriddedDataPublisher (DtGriddedDataRepository *stateRepToUse, DtExerciseConn *conn, const char *name=0, const DtDDMRegionSet *regionSetToUse=0)
	Constructor.
	DtGriddedDataPublisher (RTI::ObjectClassHandle h, DtExerciseConn *conn, const char *name=0, const DtDDMRegionSet *regionSetToUse=0)
	Constructor.
	DtGriddedDataPublisher (DtExerciseConn *conn, const char *name=0, const DtDDMRegionSet *regionSetToUse=0)
	Constructor.
virtual	~DtGriddedDataPublisher ()
virtual DtGriddedDataRepository *	gridDataStateRep ()
	Returns a pointer to the DtGriddedDataRepository - through which you can set or inspect current state information.
virtual DtGriddedDataRepository *	gdsr ()
	Synonym for gridDataStateRep().
virtual const char *	classToUse () const
	Returns the name of the FOM object class to use.
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	parallelTick ()
	Tick (update) this object in parallel threads.
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)

Static Public Member Functions
static DtStateRepCreator	setStateRepCreator (DtStateRepCreator creator)
	Give us a function to be used for creating SRs.
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 Member Functions
	DtGriddedDataPublisher (const char *name=0, const DtDDMRegionSet *regionSetToUse=0)
	Constructor which does not include the DtExerciseConn and does not register the HLA object.
	DtGriddedDataPublisher (const DtGriddedDataPublisher &orig)
	copy constructor – Not Implemented
DtGriddedDataPublisher &	operator= (const DtGriddedDataPublisher &orig)
	copy constructor – Not Implemented
Protected Member Functions inherited from DtObjectPublisher
	DtObjectPublisher (DtStateRepository *stateRep, DtStateRepository *asSeenByRemote, bool okToDeleteStateRep=true, const DtDDMRegionSet *regionSet=0)
	Constructor which does not include the DtExerciseConn.
virtual void	setExerciseConn (DtExerciseConn *conn)
	Allows the DtExerciseConn to be set after initial publisher creation.
virtual void	processRemoveObject (DtHlaObject *obj)
	Called by removeObjectCb to detachHlaObject when our underlying DtHlaObject goes away.

Static Protected Attributes
static DtStateRepCreator	theStateRepCreator

Additional Inherited Members
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

class DtGriddedDataPublisher:

Instances of DtGriddedDataPublisher are used for local or source simulation of gridded data objects. (i.e. these entities are not dependent on data being produced elsewhere on the network for their existence). These entities send data to the network.

Member Typedef Documentation

typedef DtGriddedDataRepository*(* DtGriddedDataPublisher::DtStateRepCreator)()

Function prototype for functions that create DtGriddedDataRepositories.

Constructor & Destructor Documentation

DtGriddedDataPublisher::DtGriddedDataPublisher	(	DtGriddedDataRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const char *	name = 0,
		const DtDDMRegionSet *	regionSetToUse = 0
	)

Constructor.

DtGriddedDataPublisher::DtGriddedDataPublisher	(	RTI::ObjectClassHandle	h,
		DtExerciseConn *	conn,
		const char *	name = 0,
		const DtDDMRegionSet *	regionSetToUse = 0
	)

Constructor.

DtGriddedDataPublisher::DtGriddedDataPublisher	(	DtExerciseConn *	conn,
		const char *	name = 0,
		const DtDDMRegionSet *	regionSetToUse = 0
	)

Constructor.

virtual DtGriddedDataPublisher::~DtGriddedDataPublisher ( )

virtual

DtGriddedDataPublisher::DtGriddedDataPublisher ( const char *  name = 0, const DtDDMRegionSet *  regionSetToUse = 0  )

protected

Constructor which does not include the DtExerciseConn and does not register the HLA object.

This is typically not desired, but may be useful in certain cases when a derived publisher wants to better control how the object is published.

DtGriddedDataPublisher::DtGriddedDataPublisher ( const DtGriddedDataPublisher &  orig )

protected

copy constructor – Not Implemented

Member Function Documentation

virtual const char* DtGriddedDataPublisher::classToUse ( ) const

virtual

Returns the name of the FOM object class to use.

Default implementation is to ask the FOM Mapper.

DtGriddedDataRepository * DtGriddedDataPublisher::gdsr ( )

inlinevirtual

Synonym for gridDataStateRep().

References DtObjectPublisher::myStateRep.

DtGriddedDataRepository * DtGriddedDataPublisher::gridDataStateRep ( )

inlinevirtual

Returns a pointer to the DtGriddedDataRepository - through which you can set or inspect current state information.

References DtObjectPublisher::myStateRep.

DtGriddedDataPublisher& DtGriddedDataPublisher::operator= ( const DtGriddedDataPublisher &  orig )

protected

copy constructor – Not Implemented

static DtStateRepCreator DtGriddedDataPublisher::setStateRepCreator ( DtStateRepCreator  creator )

static

Give us a function to be used for creating SRs.

Member Data Documentation

DtStateRepCreator DtGriddedDataPublisher::theStateRepCreator

staticprotected

---

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

• griddedDataPublisherHLA.h