Instances of DtEnvironmentProcessPublisher are used for local or source simulations of environment processes, (i.e. More...

Inheritance diagram for DtEnvironmentProcessPublisher:

Collaboration diagram for DtEnvironmentProcessPublisher:

Public Types
typedef DtEnvironmentProcessRepository (	DtStateRepCreator )()
	Function prototype for functions that create DtEnvironmentProcessRepositories. More...

Public Member Functions
	DtEnvironmentProcessPublisher (DtEnvironmentProcessRepository stateRepToUse, DtExerciseConn conn, const char name=0, const DtDDMRegionSet regionSetToUse=0)
	Constructor. More...

	DtEnvironmentProcessPublisher (RTI::ObjectClassHandle h, DtExerciseConn conn, const char name=0, const DtDDMRegionSet *regionSetToUse=0)
	Constructor. More...

	DtEnvironmentProcessPublisher (DtExerciseConn conn, const char name=0, const DtDDMRegionSet *regionSetToUse=0)
	Constructor. More...

virtual	~DtEnvironmentProcessPublisher ()
	destructor More...

virtual DtEnvironmentProcessRepository *	environmentProcessStateRep ()
	Returns a pointer to the DtEnvironmentProcessRepository - through which you can set or inspect current state information. More...

virtual DtEnvironmentProcessRepository *	epsr ()
	Synonym for environmentProcessStateRep(). More...

virtual const char *	classToUse () const
	Returns the name of the FOM object class to use. More...

Public Member Functions inherited from DtObjectPublisher
	DtObjectPublisher (DtExerciseConn conn, DtStateRepository stateRep, DtStateRepository asSeenByRemote, bool okToDeleteStateRep=true, const DtDDMRegionSet regionSet=0)
	Constructor. More...

virtual	~DtObjectPublisher ()
	Destructor. More...

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. More...

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. More...

virtual void	setHlaObject (DtHlaObjectWithStateRep obj, DtHlaStateEncoder encoder=0, DtHlaStateDecoder *decoder=0)
	This version takes an existing DtHlaObject, and uses it. More...

virtual void	detachHlaObject ()
	Detach HLA object - bringing the DtObjectPublisher back to the state it was in before setHlaObject was called. More...

virtual DtStateRepository *	stateRep ()
	Returns a pointer to the DtStateRepository - through which you can set or inspect current state information. More...

virtual DtStateRepository *	sr ()
	Synonym for stateRep(). More...

virtual DtStateRepository *	approximateRemoteStateRep ()
	Returns a pointer to the approximate remote DtStateRepository – This state repository contains the contents of the last sent message. More...

virtual DtHlaStateDecoder *	decoder ()
	Returns a pointer to the Decoder being used to decode state messages that we send back into the asSeenByRemote SR. More...

virtual DtHlaStateEncoder *	encoder ()
	Returns a pointer to the Encoder being used to encode current state into an outgoing message. More...

virtual DtHlaObjectWithStateRep *	hlaObject ()
	Get the object's hlaObject. More...

virtual DtExerciseConn *	exerciseConn ()
	Get our exercise connection. More...

virtual const DtObjectId &	id () const
	Get the object's local identifier. More...

virtual const DtObjectId &	objectId () const
	Get the object's local identifier. More...

virtual const DtObjectId &	localId () const
	Get the object's local identifier. More...

virtual const DtString &	name () const
	Get the object's name. More...

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. More...

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. More...

virtual void	forceUpdate (const RTI::AttributeHandleSet &set)

virtual void	tick ()
	Tick (update) this object. More...

virtual void	parallelTick ()
	Tick (update) this object in parallel threads. More...

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. More...

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. More...

virtual void	removeRegion (DtDDMRegionSP regionToRemove)
	Removes the specified region from the set of publishing regions, and calls unassociateRegionForUpdates on the RTI Ambassador. More...

	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. More...

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. More...

Static Public Member Functions inherited from DtObjectPublisher
static void	removeObjectCb (DtHlaObject obj, void pub)
	Callback to be called when our underlying DtHlaObject goes away. More...

Protected Member Functions
	DtEnvironmentProcessPublisher (const char name=0, const DtDDMRegionSet regionSetToUse=0)
	Constructor which does not include the DtExerciseConn and does not register the HLA object. More...

	DtEnvironmentProcessPublisher (const DtEnvironmentProcessPublisher &orig)
	copy constructor – not implemented More...

DtEnvironmentProcessPublisher &	operator= (const DtEnvironmentProcessPublisher &orig)
	copy constructor – not implemented More...

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. More...

virtual void	setExerciseConn (DtExerciseConn *conn)
	Allows the DtExerciseConn to be set after initial publisher creation. More...

virtual void	processRemoveObject (DtHlaObject *obj)
	Called by removeObjectCb to detachHlaObject when our underlying DtHlaObject goes away. More...

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

Instances of DtEnvironmentProcessPublisher are used for local or source simulations of environment processes, (i.e.

these entities are not dependent on data being produced elsewhere on the network for their existence).

Examples: Environmental Process Example

Member Typedef Documentation

typedef DtEnvironmentProcessRepository*(* DtEnvironmentProcessPublisher::DtStateRepCreator)()

Function prototype for functions that create DtEnvironmentProcessRepositories.

Constructor & Destructor Documentation

DtEnvironmentProcessPublisher::DtEnvironmentProcessPublisher	(	DtEnvironmentProcessRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const char *	name = `0`,
		const DtDDMRegionSet *	regionSetToUse = `0`
	)

Constructor.

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

Constructor.

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

Constructor.

virtual DtEnvironmentProcessPublisher::~DtEnvironmentProcessPublisher ( )

virtual

destructor

DtEnvironmentProcessPublisher::DtEnvironmentProcessPublisher	(	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.

DtEnvironmentProcessPublisher::DtEnvironmentProcessPublisher ( const DtEnvironmentProcessPublisher & orig )

protected

copy constructor – not implemented

Member Function Documentation

virtual const char* DtEnvironmentProcessPublisher::classToUse ( ) const

virtual

Returns the name of the FOM object class to use.

Default implementation is to ask the FOM Mapper.

DtEnvironmentProcessRepository * DtEnvironmentProcessPublisher::environmentProcessStateRep ( )

inlinevirtual

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

References DtObjectPublisher::myStateRep.

DtEnvironmentProcessRepository * DtEnvironmentProcessPublisher::epsr ( )

inlinevirtual

Synonym for environmentProcessStateRep().

References DtObjectPublisher::myStateRep.

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

protected

copy constructor – not implemented

static DtStateRepCreator DtEnvironmentProcessPublisher::setStateRepCreator ( DtStateRepCreator creator )

static

Give us a function to be used for creating SRs.

Member Data Documentation

DtStateRepCreator DtEnvironmentProcessPublisher::theStateRepCreator

staticprotected

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

environmentProcessPublisherHLA.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation