DtEntityPublisher Class Reference

Instances of DtEntityPublisher are used for local or source simulations of entities (i.e. More...

Inheritance diagram for DtEntityPublisher:

Collaboration diagram for DtEntityPublisher:

List of all members.

Public Types
typedef DtEntityStateRepository *(*	DtStateRepCreator )()
	Function prototype for functions that create DtEntityStateRepositories.
Public Member Functions
	DtEntityPublisher (DtEntityStateRepository *stateRepToUse, DtExerciseConn *conn, const char *name=0, const DtDDMRegionSet *regionSetToUse=0)
	Constructor -- state rep must contain entityType.
	DtEntityPublisher (RTI::ObjectClassHandle h, DtExerciseConn *conn, const char *name=0, const DtDDMRegionSet *regionSetToUse=0)
	Constructor.
	DtEntityPublisher (const DtEntityType &type, DtExerciseConn *conn, const char *name=0, const DtDDMRegionSet *regionSetToUse=0)
	Constructor.
	DtEntityPublisher (const DtEntityType &type, DtExerciseConn *conn, DtDeadReckonTypes algorithm, DtForceType forceId, const DtEntityType &guise=guiseSameAsType(), const char *name=0, const DtDDMRegionSet *regionSetToUse=0)
	Constructor.
	DtEntityPublisher (DtHlaObjectWithStateRep *obj, DtExerciseConn *conn)
	Constructor that creates a publisher for an existing DtHlaObject.
virtual	~DtEntityPublisher ()
	destructor
virtual DtEntityStateRepository *	entityStateRep ()
	Returns a pointer to the EntityStateRepository - through which you can set or inspect current state information.
virtual DtEntityStateRepository *	esr ()
	Synonym for entityStateRep().
virtual void	tick ()
	If there is a region, update it, and then call down to base tick.
Static Public Member Functions
static const DtEntityType &	guiseSameAsType ()
	Returns a constant that can be passed to the constructor indicating that we should use the entity type as our guise.
static DtStateRepCreator	setStateRepCreator (DtStateRepCreator creator)
	Give us a function to be used for creating SRs.
static void	setDfltRotationThreshold (double r)
static double	dfltRotationThreshold ()
static void	setDfltTranslationThreshold (double t)
static double	dfltTranslationThreshold ()
Protected Member Functions
void	init ()
	not virtual, called from the constructor
void	createGeographicRegion (DtExerciseConn *conn)
	Creates the publishers region.
	DtEntityPublisher (const DtEntityPublisher &orig)
	copy constructor - Not Implemented
DtEntityPublisher &	operator= (const DtEntityPublisher &orig)
	assignment operator - Not Implemented
const char *	objectClassNameFromType (const DtEntityType &type)
	Non-virtual, since called from constructor.
Protected Attributes
DtBoost::shared_ptr < DtGeodeticRegion >	myGeodeticPublishingRegion
Static Protected Attributes
static DtStateRepCreator	theStateRepCreator

---

Detailed Description

Instances of DtEntityPublisher are used for local or source simulations of entities (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 DtEntityStateRepository*(* DtEntityPublisher::DtStateRepCreator)()

Function prototype for functions that create DtEntityStateRepositories.

---

Constructor & Destructor Documentation

DtEntityPublisher::DtEntityPublisher	(	DtEntityStateRepository *	stateRepToUse,
		DtExerciseConn *	conn,
		const char *	name = 0,
		const DtDDMRegionSet *	regionSetToUse = 0
	)

Constructor -- state rep must contain entityType.

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

Constructor.

DtEntityPublisher::DtEntityPublisher	(	const DtEntityType &	type,
		DtExerciseConn *	conn,
		const char *	name = 0,
		const DtDDMRegionSet *	regionSetToUse = 0
	)

Constructor.

DtEntityPublisher::DtEntityPublisher	(	const DtEntityType &	type,
		DtExerciseConn *	conn,
		DtDeadReckonTypes	algorithm,
		DtForceType	forceId,
		const DtEntityType &	guise = guiseSameAsType(),
		const char *	name = 0,
		const DtDDMRegionSet *	regionSetToUse = 0
	)

Constructor.

DtEntityPublisher::DtEntityPublisher	(	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 DtEntityPublisher::~DtEntityPublisher

(

)

[virtual]

destructor

DtEntityPublisher::DtEntityPublisher

(

const DtEntityPublisher &

orig

)

[protected]

copy constructor - Not Implemented

---

Member Function Documentation

void DtEntityPublisher::createGeographicRegion

(

DtExerciseConn *

conn

)

[protected]

Creates the publishers region.

Not virtual, since it is called from the constructor.

Exceptions:

DtException

if the region cannot be created

static double DtEntityPublisher::dfltRotationThreshold

(

)

[static]

Deprecated:

Please use the DtThresholder static member functions instead.

static double DtEntityPublisher::dfltTranslationThreshold

(

)

[static]

Deprecated:

Please use the DtThresholder static member functions instead.

DtEntityStateRepository * DtEntityPublisher::entityStateRep

(

)

[inline, virtual]

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

References DtObjectPublisher::myStateRep.

DtEntityStateRepository * DtEntityPublisher::esr

(

)

[inline, virtual]

Synonym for entityStateRep().

References DtObjectPublisher::myStateRep.

static const DtEntityType& DtEntityPublisher::guiseSameAsType

(

)

[static]

Returns a constant that can be passed to the constructor indicating that we should use the entity type as our guise.

(g++ forces us to define this function before we define our constructors)

void DtEntityPublisher::init

(

)

[protected]

not virtual, called from the constructor

const char* DtEntityPublisher::objectClassNameFromType

(

const DtEntityType &

type

)

[protected]

Non-virtual, since called from constructor.

If you don't like the default mapping between entity type and object class, just pass the object class handle you want to the constructor.

DtEntityPublisher& DtEntityPublisher::operator=

(

const DtEntityPublisher &

orig

)

[protected]

assignment operator - Not Implemented

static void DtEntityPublisher::setDfltRotationThreshold

(

double

r

)

[static]

Deprecated:

Please use the DtThresholder static member functions instead.

static void DtEntityPublisher::setDfltTranslationThreshold

(

double

t

)

[static]

Deprecated:

Please use the DtThresholder static member functions instead.

static DtStateRepCreator DtEntityPublisher::setStateRepCreator

(

DtStateRepCreator

creator

)

[static]

Give us a function to be used for creating SRs.

virtual void DtEntityPublisher::tick

(

)

[virtual]

If there is a region, update it, and then call down to base tick.

Reimplemented from DtObjectPublisher.

---

Member Data Documentation

DtBoost::shared_ptr<DtGeodeticRegion> DtEntityPublisher::myGeodeticPublishingRegion [protected]

DtStateRepCreator DtEntityPublisher::theStateRepCreator [static, protected]

---

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

• hEntityPub.h