DtInterClassDesc Class Reference

Instances of DtInterClassDesc are used to represent HLA Object and Interaction classes. More...

Collaboration diagram for DtInterClassDesc:

List of all members.

Public Member Functions
	DtInterClassDesc (const char *className, DtInterClassDesc *base, RTI::InteractionClassHandle handle, DtExerciseConn *exConn)
	constructor
virtual	~DtInterClassDesc ()
	destructor
virtual void	addParam (const char *paramName)
	Add a parameter (Used when reading FED file).
virtual RTI::InteractionClassHandle	handle () const
	Get the object's class handle.
virtual const char *	name () const
	Get the object's class name.
virtual const DtInterClassDesc *	baseClass () const
	Return a pointer to the base class's descriptor, NULL if none.
virtual DtInterClassDesc *	baseClass ()
	Return a pointer to the base class's descriptor, NULL if none.
virtual int	isOfClass (RTI::InteractionClassHandle hand) const
	Returns 1 if the class is of class hand or a subclass of hand, 0 otherwise.
virtual int	numParameters () const
	Get the number of parameters associated with this object.
virtual RTI::ParameterHandle	parameterHandleByName (const char *paramName)
	Returns the attribute handle for this attribute name.
virtual DtString	parameterNameByHandle (const RTI::ParameterHandle &hand)
	Returns a string holding the name of the attribute handle.
virtual const RTI::ParameterHandleSet &	paramHandleSet () const
	Get the set of valid parameter handles for this class.
virtual const RTI::ParameterHandleSet &	ownParamHandles () const
	Get the set of non-inherited parameter handles for this class.
virtual void	publish ()
	Publish the class, and register start and stopUpdates callbacks.
virtual void	unpublish ()
	Unpublish the class, and deregister start and stopUpdates callbacks.
virtual void	subscribe ()
	Subscribe to the class.
virtual void	subscribe (DtDDMRegionSP region)
	Subscribe with region.
virtual void	passiveSubscribe ()
	Subscribe passively to the class.
virtual void	unsubscribe ()
	Unsubscribe to the class.
virtual void	unsubscribe (DtDDMRegionSP region)
	Unsubscribe to the class with region.
virtual bool	published () const
	Returns true if the class is published, false otherwise.
virtual bool	subscribed () const
	Returns true if the class is subscribed, false otherwise.
virtual DtVrlRtiAmbassador *	rtiAmb ()
	Get my RTI ambassador.
virtual bool	neededByFederation () const
	Returns true if the interaction class is needed by the federation false otherwise.
virtual bool	everPublished () const
	Return true if we have ever published the class using DtInterClassDesc::publish, false otherwise.
virtual bool	everSubscribed () const
	Return true if we have ever subscribed to the class using DtInterClassDesc::subscribe, false otherwise.
virtual void	setUserTagModifier (DtInteractionTagModifierSP modifier)
virtual DtInteractionTagModifierSP	userTagModifier ()
Static Public Member Functions
static void	setMaxParameters (int num)
	Set/Get maximum number of allowable parameters for an interaction.
static int	maxParameters ()
static void	setSubscriptionTimeDelay (double delay)
	Set a time delay to occur after calling RTI::RTIambassador::subscribe() The purpose of this function is to get around a bug in DMSO RTI NG v3.2 for Win98.
Protected Member Functions
virtual void	processStartInters (RTI::InteractionClassHandle hand)
	Callback for handling startInters RTI callback.
virtual void	processStopInters (RTI::InteractionClassHandle hand)
	Callback for handling stopInters RTI callback.
	DtInterClassDesc (const DtInterClassDesc &orig)
	copy constructor -- Not Implemented
DtInterClassDesc &	operator= (const DtInterClassDesc &orig)
	assignment operator -- Not Implemented
Static Protected Member Functions
static void	startIntersCb (RTI::InteractionClassHandle hand, void *usr)
	Callback for handling startInters RTI callback.
static void	stopIntersCb (RTI::InteractionClassHandle hand, void *usr)
	Callback for handling stopInters RTI callback.
Protected Attributes
DtString	myName
RTI::InteractionClassHandle	myHandle
RTI::ParameterHandleSet *	myParams
RTI::ParameterHandleSet *	myOwnParams
DtInterClassDesc *	myBase
DtExerciseConn *	myExConn
bool	myNeededFlag
bool	myPublished
bool	mySubscribed
bool	myEverPublished
bool	myEverSubscribed
RTI::ParameterHandle	myMinParamHand
RTI::ParameterHandle	myMaxParamHand
int	myNumSubscribeRequests
DtInteractionTagModifierSP	myTagModifier
std::set< DtDDMRegionSP >	mySubscribedRegions
Static Protected Attributes
static int	theMaxParams
static double	theSubscriptionTimeDelay

---

Detailed Description

Instances of DtInterClassDesc are used to represent HLA Object and Interaction classes.

---

Constructor & Destructor Documentation

DtInterClassDesc::DtInterClassDesc	(	const char *	className,
		DtInterClassDesc *	base,
		RTI::InteractionClassHandle	handle,
		DtExerciseConn *	exConn
	)

constructor

virtual DtInterClassDesc::~DtInterClassDesc

(

)

[virtual]

destructor

DtInterClassDesc::DtInterClassDesc

(

const DtInterClassDesc &

orig

)

[protected]

copy constructor -- Not Implemented

---

Member Function Documentation

virtual void DtInterClassDesc::addParam

(

const char *

paramName

)

[virtual]

Add a parameter (Used when reading FED file).

const DtInterClassDesc * DtInterClassDesc::baseClass

(

)

const [inline, virtual]

Return a pointer to the base class's descriptor, NULL if none.

References myBase.

DtInterClassDesc * DtInterClassDesc::baseClass

(

)

[inline, virtual]

Return a pointer to the base class's descriptor, NULL if none.

References myBase.

virtual bool DtInterClassDesc::everPublished

(

)

const [virtual]

Return true if we have ever published the class using DtInterClassDesc::publish, false otherwise.

virtual bool DtInterClassDesc::everSubscribed

(

)

const [virtual]

Return true if we have ever subscribed to the class using DtInterClassDesc::subscribe, false otherwise.

RTI::InteractionClassHandle DtInterClassDesc::handle

(

)

const [inline, virtual]

Get the object's class handle.

References myHandle.

Referenced by DtInteraction::interactionClassHandle().

virtual int DtInterClassDesc::isOfClass

(

RTI::InteractionClassHandle

hand

)

const [virtual]

Returns 1 if the class is of class hand or a subclass of hand, 0 otherwise.

int DtInterClassDesc::maxParameters

(

)

[inline, static]

References theMaxParams.

const char * DtInterClassDesc::name

(

)

const [inline, virtual]

Get the object's class name.

References DtString::c_str(), and myName.

Referenced by DtInteraction::interactionClassName().

virtual bool DtInterClassDesc::neededByFederation

(

)

const [virtual]

Returns true if the interaction class is needed by the federation false otherwise.

int DtInterClassDesc::numParameters

(

)

const [inline, virtual]

Get the number of parameters associated with this object.

References myParams.

Referenced by DtInteraction::numParameters().

DtInterClassDesc& DtInterClassDesc::operator=

(

const DtInterClassDesc &

orig

)

[protected]

assignment operator -- Not Implemented

const RTI::ParameterHandleSet & DtInterClassDesc::ownParamHandles

(

)

const [inline, virtual]

Get the set of non-inherited parameter handles for this class.

virtual RTI::ParameterHandle DtInterClassDesc::parameterHandleByName

(

const char *

paramName

)

[virtual]

Returns the attribute handle for this attribute name.

virtual DtString DtInterClassDesc::parameterNameByHandle

(

const RTI::ParameterHandle &

hand

)

[virtual]

Returns a string holding the name of the attribute handle.

const RTI::ParameterHandleSet & DtInterClassDesc::paramHandleSet

(

)

const [inline, virtual]

Get the set of valid parameter handles for this class.

Includes parameters inherited from base classes.

virtual void DtInterClassDesc::passiveSubscribe

(

)

[virtual]

Subscribe passively to the class.

virtual void DtInterClassDesc::processStartInters

(

RTI::InteractionClassHandle

hand

)

[protected, virtual]

Callback for handling startInters RTI callback.

virtual void DtInterClassDesc::processStopInters

(

RTI::InteractionClassHandle

hand

)

[protected, virtual]

Callback for handling stopInters RTI callback.

virtual void DtInterClassDesc::publish

(

)

[virtual]

Publish the class, and register start and stopUpdates callbacks.

virtual bool DtInterClassDesc::published

(

)

const [virtual]

Returns true if the class is published, false otherwise.

virtual DtVrlRtiAmbassador* DtInterClassDesc::rtiAmb

(

)

[virtual]

Get my RTI ambassador.

void DtInterClassDesc::setMaxParameters

(

int

num

)

[inline, static]

Set/Get maximum number of allowable parameters for an interaction.

References theMaxParams.

void DtInterClassDesc::setSubscriptionTimeDelay

(

double

delay

)

[inline, static]

Set a time delay to occur after calling RTI::RTIambassador::subscribe() The purpose of this function is to get around a bug in DMSO RTI NG v3.2 for Win98.

If a delay is not used on Win98, DMSO RTI NG may miss subscribe messages and then fail to call discoverObjectInstance() when it's appropriate In most circumstances, you would never want to call this function.

References theSubscriptionTimeDelay.

virtual void DtInterClassDesc::setUserTagModifier

(

DtInteractionTagModifierSP

modifier

)

[virtual]

static void DtInterClassDesc::startIntersCb	(	RTI::InteractionClassHandle	hand,
		void *	usr
	)		[static, protected]

Callback for handling startInters RTI callback.

static void DtInterClassDesc::stopIntersCb	(	RTI::InteractionClassHandle	hand,
		void *	usr
	)		[static, protected]

Callback for handling stopInters RTI callback.

virtual void DtInterClassDesc::subscribe

(

)

[virtual]

Subscribe to the class.

virtual void DtInterClassDesc::subscribe

(

DtDDMRegionSP

region

)

[virtual]

Subscribe with region.

virtual bool DtInterClassDesc::subscribed

(

)

const [virtual]

Returns true if the class is subscribed, false otherwise.

virtual void DtInterClassDesc::unpublish

(

)

[virtual]

Unpublish the class, and deregister start and stopUpdates callbacks.

virtual void DtInterClassDesc::unsubscribe

(

)

[virtual]

Unsubscribe to the class.

virtual void DtInterClassDesc::unsubscribe

(

DtDDMRegionSP

region

)

[virtual]

Unsubscribe to the class with region.

virtual DtInteractionTagModifierSP DtInterClassDesc::userTagModifier

(

)

[virtual]

---

Member Data Documentation

DtInterClassDesc* DtInterClassDesc::myBase [protected]

Referenced by baseClass().

bool DtInterClassDesc::myEverPublished [protected]

bool DtInterClassDesc::myEverSubscribed [protected]

DtExerciseConn* DtInterClassDesc::myExConn [protected]

RTI::InteractionClassHandle DtInterClassDesc::myHandle [protected]

Referenced by handle().

RTI::ParameterHandle DtInterClassDesc::myMaxParamHand [protected]

RTI::ParameterHandle DtInterClassDesc::myMinParamHand [protected]

DtString DtInterClassDesc::myName [protected]

Referenced by name().

bool DtInterClassDesc::myNeededFlag [protected]

int DtInterClassDesc::myNumSubscribeRequests [protected]

RTI::ParameterHandleSet* DtInterClassDesc::myOwnParams [protected]

RTI::ParameterHandleSet* DtInterClassDesc::myParams [protected]

Referenced by numParameters().

bool DtInterClassDesc::myPublished [protected]

bool DtInterClassDesc::mySubscribed [protected]

std::set<DtDDMRegionSP> DtInterClassDesc::mySubscribedRegions [protected]

DtInteractionTagModifierSP DtInterClassDesc::myTagModifier [protected]

int DtInterClassDesc::theMaxParams [static, protected]

Referenced by maxParameters(), and setMaxParameters().

double DtInterClassDesc::theSubscriptionTimeDelay [static, protected]

Referenced by setSubscriptionTimeDelay().

---

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

• intClassDesc.h