DtEmitterBeamPublisher Class Reference

Instances of DtEmitterBeamPublisher are used for local or source simulations of emitter beams, (i.e. More...

Inheritance diagram for DtEmitterBeamPublisher:

Collaboration diagram for DtEmitterBeamPublisher:

Public Types
typedef DtEmitterBeamRepository *(*	DtStateRepCreator )()
	Function prototype for functions that create DtBeamRepositories.

Public Member Functions
	DtEmitterBeamPublisher (RTI::ObjectClassHandle h, DtExerciseConn *conn, DtEmitterBeamRepository *bsr=0, const char *name=0, const DtDDMRegionSet *regionSetToUse=0)
	constructor. NULL bsr means create your own.
	DtEmitterBeamPublisher (DtExerciseConn *conn, DtEmitterBeamRepository *bsr=0, const char *name=0, const DtDDMRegionSet *regionSetToUse=0)
	constructor. NULL bsr means create your own.
	DtEmitterBeamPublisher (DtHlaObjectWithStateRep *obj, DtExerciseConn *conn)
	Constructor that creates a publisher for an existing DtHlaObject.
virtual	~DtEmitterBeamPublisher ()
	destructor
virtual DtEmitterBeamRepository *	emitrBeamRep ()
	Returns a pointer to the DtEmitterBeamRepository - through which you can set or inspect current state information.
virtual DtEmitterBeamRepository *	bsr ()
	Synonym for emitrBeamRep().
virtual const char *	classToUse (DtEmitterBeamRepository *bsr) const
	Returns the name of the FOM object class handle 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	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
	DtEmitterBeamPublisher (const DtEmitterBeamPublisher &orig)
	copy constructor
DtEmitterBeamPublisher &	operator= (const DtEmitterBeamPublisher &orig)
	assignment operator
Protected Member Functions inherited from DtObjectPublisher
virtual void	processRemoveObject (DtHlaObject *obj)
	Called by removeObjectCb to detachHlaObject when our underlying DtHlaObject goes away.

Protected Attributes
bool	myOwnBsr
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

Static Protected Attributes
static DtStateRepCreator	theStateRepCreator

Detailed Description

Instances of DtEmitterBeamPublisher are used for local or source simulations of emitter beams, (i.e.

these entities are not dependent on data being produced elsewhere on the network for their existence). These emitter beams send data to the network.

Member Typedef Documentation

typedef DtEmitterBeamRepository*(* DtEmitterBeamPublisher::DtStateRepCreator)()

Function prototype for functions that create DtBeamRepositories.

Constructor & Destructor Documentation

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

constructor. NULL bsr means create your own.

DtEmitterBeamPublisher::DtEmitterBeamPublisher	(	DtExerciseConn *	conn,
		DtEmitterBeamRepository *	bsr = 0,
		const char *	name = 0,
		const DtDDMRegionSet *	regionSetToUse = 0
	)

constructor. NULL bsr means create your own.

DtEmitterBeamPublisher::DtEmitterBeamPublisher	(	DtHlaObjectWithStateRep *	obj,
		DtExerciseConn *	conn
	)

Constructor that creates a publisher for an existing DtHlaObject.

(DtHlaObjectWithStateRep is derived from DtHlaObject.) Typically used in conjunction with ownership management, when you want to take ownership and begin updating some attributes of an object that you have already discovered.

virtual DtEmitterBeamPublisher::~DtEmitterBeamPublisher ( )

virtual

destructor

DtEmitterBeamPublisher::DtEmitterBeamPublisher ( const DtEmitterBeamPublisher &  orig )

protected

copy constructor

Member Function Documentation

DtEmitterBeamRepository * DtEmitterBeamPublisher::bsr ( )

inlinevirtual

Synonym for emitrBeamRep().

References DtObjectPublisher::myStateRep.

virtual const char* DtEmitterBeamPublisher::classToUse ( DtEmitterBeamRepository *  bsr ) const

virtual

Returns the name of the FOM object class handle to use.

DtEmitterBeamRepository * DtEmitterBeamPublisher::emitrBeamRep ( )

inlinevirtual

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

References DtObjectPublisher::myStateRep.

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

protected

assignment operator

static DtStateRepCreator DtEmitterBeamPublisher::setStateRepCreator ( DtStateRepCreator  creator )

static

Give us a function to be used for creating SRs.

Member Data Documentation

bool DtEmitterBeamPublisher::myOwnBsr

protected

DtStateRepCreator DtEmitterBeamPublisher::theStateRepCreator

staticprotected

---

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

• hEmitrBeamPub.h