DtInteractionClassInfo Class Reference

Collaboration diagram for DtInteractionClassInfo:

Public Types
typedef std::map < DtInteractionClassHandle, DtInteractionClassInfo * >	DtInteractionClassByHandleMap
typedef std::map < MAKRti::DtString, DtInteractionClassInfo * >	DtInteractionClassByNameMap

Public Member Functions
	DtInteractionClassInfo (const char *name, DtInteractionClassInfo *base, DtInteractionClassHandle handle, DtSharingType sharing, MAKRti::DtString semantics, MAKRti::DtTransportType transport, MAKRti::DtOrderType order)
	Constructors. More...
	DtInteractionClassInfo (const DtInteractionClassInfo &orig)
	Copy constructor (not implemented) More...
DtInteractionClassInfo &	operator= (const DtInteractionClassInfo &orig)
	Assignment operator (not implemented) More...
virtual	~DtInteractionClassInfo ()
	Destructor. More...
virtual DtParamInfo *	addParam (const char *paramName, const char *semantics, bool addSorted)
	Adds an parameter to the class (called during FED processing). More...
virtual DtParamInfo *	mergeParam (const char *paramName, const char *semantics)
	Adds an parameter to the class (called during FED processing). More...
virtual void	addSubclass (DtInteractionClassInfo *sub)
	Add a subclass (called during FED processing). More...
virtual const char *	name () const
	Return class name, as in FED. More...
virtual DtInteractionClassInfo *	baseClass () const
	Return pointer to base class descriptor. More...
virtual void	setBaseClass (DtInteractionClassInfo *base)
	Set base class pointer (used when deep copying FOM target not when constructing target) More...
virtual int	isOfClass (DtInteractionClassHandle handle) const
	Returns 1 if this class is handle or is a subclass of handle. More...
virtual bool	isMom ()
	Return true if this is a MOM class. More...
virtual bool	isRoot ()
	Return true if this is the Root class. More...
virtual int	numParameters () const
	Returns the number of parameters. More...
virtual DtParameterByHandleMap const &	params () const
	Returns the list of parameter infos. More...
virtual DtParameterByHandleMap const &	ownParams () const
	Returns the set of parameter infos just from this class. More...
virtual DtParameterHandleSet const &	parameterHandles () const
	Return the set of parameter handles. More...
virtual DtParameterHandle	paramHandle (const char *theName)
	Get parameter handle from name. More...
virtual char *	paramName (DtParameterHandle theHandle)
	Get parameter name from handle. More...
virtual void	publish (DtInteractionMgr *interMgr)
	Publish this class. More...
virtual void	unpublish ()
	Unpublish this class. More...
virtual int	published () const
	Return 1 if we are publishing this class, 0 otherwise. More...
virtual void	subscribe (bool active)
	Subscribe this class. More...
virtual void	unsubscribe ()
	Unsubscribe this class. More...
virtual int	subscribed () const
	Return 1 if we are subscribed to this class, 0 otherwise. More...
virtual void	remoteSubscribe (DtFederateHandle fedHandle, DtInteractionMgr *interMgr)
	Call when another federate subscribes to this class actively. More...
virtual void	remotePassiveSubscribe (DtFederateHandle fedHandle, DtInteractionMgr *interMgr)
	Call when another federate subscribes to this class passively. More...
virtual void	remoteUnsubscribe (DtFederateHandle fedHandle, DtInteractionMgr *interMgr, bool forSmartForwarding)
	Call when another federate unsubscribes to this class. More...
virtual bool	remoteFederateIsSubscribed (DtFederateHandle fedHandle) const
	Returns true if the remote federate is subscribed to this class. More...
virtual int	numRemoteFederatesSubscribed () const
	Returns number of remote federates subscribed to this class. More...
virtual const MAKRti::DtList &	subscribedFederates () const
	Returns a list of federates who are subscribed to this interaction. More...
virtual bool	relevant () const
	Returns true if the class is relevant, false otherwise. More...
virtual bool	isScaffolding () const
	Determines whether the class is a scaffolding class. More...
virtual bool	diffClass (const DtInteractionClassInfo &classInfo, DtParameterByHandleMap &diff) const
	First test given class for equality excluding parameters. More...
virtual bool	isUnknown () const
	Determines whether this class is an unknown class, merely present to indicate that it is in other FOM modules not in use by this federate. More...
virtual void	setIsUnknown (bool unknown)
	Set whether this class is well defined. More...
virtual bool	sameInteractionClass (const DtInteractionClassInfo &interInfo, DtParameterByHandleMap *collectParametersToMerge) const
	Compare the given interaction classes If not Null, collect parameters to merge from supplied class; otherwise, extra parameters are invalid. More...
virtual bool	sameParameters (const DtParameterByHandleMap &paramHandles, DtParameterByHandleMap *collectParametersToMerge) const
	Compare the given parameter handles with the handles of this interaction (only ones where names match if missing parameters are allowed) More...
virtual bool	diffParameters (const DtInteractionClassInfo &classInfo, DtParameterByHandleMap &diff) const
	Take the difference of own parameters between classes: the given class info from this class info. More...
virtual void	setFomType (MAKRti::DtFomType type)
	Set/Get FOM type. More...
virtual MAKRti::DtFomType	fomType () const
	Set/Get FOM type. More...
virtual DtDimensionHandleStdSet const &	dimensions () const
	Set/Get dimensions. More...
virtual void	setDimensions (DtDimensionHandleStdSet const &dimList)
	Set/Get dimensions. More...
virtual void	addDimension (DtDimensionHandle dimHandle)
	Add/Remove a dimension handle. More...
virtual void	removeDimension (DtDimensionHandle dimHandle)
	Add/Remove a dimension handle. More...
virtual bool	isName (const char *name) const
	Return boolean: name matches? Compare depends on FOM type: insensitive for 1.3 and sensitive for 1516. More...
virtual bool	isFullName (const char *name) const
	Root name is required. More...
virtual DtInteractionClassHandle	handle () const
	Get/set class handle. More...
virtual void	setHandle (DtInteractionClassHandle handleValue)
	Get/set class handle. More...
virtual DtInteractionClassHandle	discoveredHandle () const
	Get/set discovered class handle This value is always 0 if isUnknown() is false. More...
virtual void	setDiscoveredHandle (DtInteractionClassHandle handleValue)
	Get/set discovered class handle This value is always 0 if isUnknown() is false. More...
virtual const DtInteractionClassByHandleMap &	subclasses () const
	Return list of subclasses. More...
virtual DtInteractionClassByHandleMap &	subclasses ()
	Return list of subclasses. More...
virtual DtParamInfo *	paramByHandle (const DtParameterHandle theHandle)
	Get parameter descriptor by name. More...
virtual const DtParamInfo *	paramByHandle (const DtParameterHandle theHandle) const
	Get parameter descriptor by name. More...
virtual DtParamInfo *	paramByName (const char *theName)
	Get parameter descriptor by handle. More...
virtual const DtParamInfo *	paramByName (const char *theName) const
	Get parameter descriptor by handle. More...
virtual MAKRti::DtTransportType	transport () const
	Set/Get transport type representing transport mechanism. More...
virtual void	setTransport (MAKRti::DtTransportType theTransport)
	Set/Get transport type representing transport mechanism. More...
DtSharingType	sharing () const
	Set/Get sharing (pub/sub) More...
void	setSharing (const DtSharingType sharing)
	Set/Get sharing (pub/sub) More...
const char *	semantics () const
	Set/Get semantics. More...
void	setSemantics (const MAKRti::DtString &semantics)
	Set/Get semantics. More...
virtual MAKRti::DtOrderType	order () const
	Set/Get order type. More...
virtual void	setOrder (MAKRti::DtOrderType theOrder)
	Set/Get order type. More...
virtual void	setSpaceHandle (DtSpaceHandle spaceHandleValue)
	Return the space handle. More...
virtual DtSpaceHandle	spaceHandle () const
	Return the space handle. More...
virtual MAKRti::DtInetAddr	destinationAddress () const
	Get the destination address used to send when using DM Filtering. More...
virtual MAKRti::DtInetAddr	destinationDevice () const
	Get the destination device used to send when using DM Filtering. More...
virtual void	setDestination (MAKRti::DtInetAddr addr, MAKRti::DtInetAddr devAddr, bool inclusive, MAKRti::DtInetAddr oldAddr, MAKRti::DtInetAddr oldDevAddr)
	Set the destination address and device used to send when using DM Filtering. More...
virtual int	subscribedWithRegion () const
	Return 1 if we are subscribed to this class with region, 0 otherwise. More...
virtual DtBitMask	getDestinations (bool includeBaseClass=true) const
	Get the list of remote subscribers to the class = update destinations The base class destination masks are added unless specified otherwise. More...
virtual void	forceDestinations (DtBitMask const &mask, MAKRti::DtTime delay)
	Temporarily force destinations with this mask for given delay A negative time delay will force the destinations indefinitely. More...
virtual void	overrideDestinations (DtBitMask const &mask)
	Permanently override destinations with given mask. More...
virtual void	clearDestinationOverride ()
	Remove destination override. More...
virtual bool	save (DtRtiSaveFile &file)
	Save (volatile) contents of this class. More...
virtual bool	restore (DtInteractionClassPacket *packet)
	Restore (volatile) contents of this class. More...
virtual void	print () const
	Print the contents. More...
virtual bool	sameAncestry (const DtInteractionClassInfo *) const
	Test for equality. More...
bool	operator== (const DtInteractionClassInfo &other) const
	Return the space handle. More...
bool	operator!= (const DtInteractionClassInfo &other) const
	Return the space handle. More...

Static Public Member Functions
static const char *	swapRootName (const char *name, MAKRti::DtFomType fomType, MAKRti::DtString &adjustedName)
	Swap or add the root class name part of the given name to the this class' FOM type Return the adjusted name's c string. More...

Protected Member Functions
virtual void	inheritMergedParameter (const DtParamInfo &param)
	Inherit the given merged parameter from base class recursively through subclasses. More...
virtual void	updateRelevance (DtInteractionMgr *interMgr)
	Update the relevance field of this class and all subclasses, based on current subscriptions. More...
virtual void	reIndexParametersByName (DtParamInfo *paramInfo)
	The given parameter was just added with the next handle. More...
virtual void	nameUpdateCheck ()
	Update indicators of root and MOM class. More...
virtual void	emptyParameters ()
	Empty the parameter lists. More...
void	addInheritedParameters (const DtInteractionClassInfo &baseClass)
	Add an inherited parameter (makes copy of given parameter) More...
void	addInheritedParameter (const DtParamInfo &paramInfo)
	Add inherited parameters from the given base class (makes copies of the parameters) More...
void	addOwnParameter (DtParamInfo *paramInfo)
	Add an own parameter. More...
virtual void	addRemoteSubscription (DtFederateHandle fedHandle)
	Add/delete remote subscription to this class by indicated federate. More...
virtual void	addRemotePassiveSubscription (DtFederateHandle fedHandle)
	Add/delete remote subscription to this class by indicated federate. More...
virtual void	deleteRemoteSubscription (DtFederateHandle fedHandle, bool isForSmartForwarding=false)
	Add/delete remote subscription to this class by indicated federate. More...
void	updateAvailableParameterHandle (DtParameterHandle paramHandle)
	The given parameter handle is now occupied. Update the next available parameter handle. More...
void	updateAvailableParameterHandles (const DtParameterHandleStdSet &handles)
	The given parameter handle is now occupied. Update the next available parameter handle. More...
void	addUsedParameter (DtParameterHandle handle)
	Add parameter handle(s) to used list by this class or one of its sub classes Recursively add to base classes. More...
void	addUsedParameters (const DtParameterHandleStdSet &handles)
	Add parameter handle(s) to used list by this class or one of its sub classes Recursively add to base classes. More...

Protected Attributes
MAKRti::DtString	myName
DtInteractionClassHandle	myHandle
DtInteractionClassHandle	myDiscoveredHandle
DtSpaceHandle	mySpaceHandle
DtDimensionHandleStdSet	myDimensions
MAKRti::DtFomType	myFomType
bool	myIsMom
bool	myIsRoot
DtSubcribeInteractionType	mySubscribed
int	myPublished
DtInteractionClassInfo *	myBase
DtInteractionClassByHandleMap	mySubclassByHandle
DtInteractionClassByNameMap	mySubclassesByName
MAKRti::DtTransportType	myTransport
MAKRti::DtString	mySemantics
DtSharingType	mySharing
DtParameterHandle	myAvailableParameterHandle
	The available parameter handle which is the maximum of this classes own parameters or any of its subclasses. More...
MAKRti::DtOrderType	myOrder
DtParameterByHandleMap	myParamsByHandle
DtParameterByHandleMap	myOwnParamsByHandle
DtParameterByNameMap	myParamsByName
DtParameterByNameMap	myOwnParamsByName
DtParameterHandleStdSet	myUsedParameterHandles
DtParameterHandleSet	myParameterHandleSet
int	myFirstParam
MAKRti::DtHashlist	myRemoteSubscriptions
MAKRti::DtHashlist	myRemotePassiveSubscriptions
DtBitMask	myRemoteSubscriberMask
DtBitMask *	myForceDestinationsMask
	Create this bit mask to temporarily force destinations after publish. More...
DtBitMask *	myOverrideDestinationsMask
	Create this bit mask to permanently override destinations. More...
MAKRti::DtTime	myForceDestinationsTime
bool	myRelevant
MAKRti::DtInetAddr	myAddr
MAKRti::DtInetAddr	myDevAddr
MAKRti::DtClock	myClock
bool	myIsUnknown
	Indicates whether this class is an unknown class, merely present to indicate that it is in other FOM modules not in use by this federate. More...

Static Private Attributes
static const unsigned int	theMaxParams

Member Typedef Documentation

typedef std::map<DtInteractionClassHandle, DtInteractionClassInfo*> DtInteractionClassInfo::DtInteractionClassByHandleMap

typedef std::map<MAKRti::DtString, DtInteractionClassInfo*> DtInteractionClassInfo::DtInteractionClassByNameMap

Constructor & Destructor Documentation

DtInteractionClassInfo::DtInteractionClassInfo	(	const char *	name,
		DtInteractionClassInfo *	base,
		DtInteractionClassHandle	handle,
		DtSharingType	sharing,
		MAKRti::DtString	semantics,
		MAKRti::DtTransportType	transport,
		MAKRti::DtOrderType	order
	)

Constructors.

DtInteractionClassInfo::DtInteractionClassInfo

(

const DtInteractionClassInfo &

orig

)

Copy constructor (not implemented)

virtual DtInteractionClassInfo::~DtInteractionClassInfo ( )

virtual

Destructor.

Member Function Documentation

virtual void DtInteractionClassInfo::addDimension ( DtDimensionHandle  dimHandle )

virtual

Add/Remove a dimension handle.

void DtInteractionClassInfo::addInheritedParameter ( const DtParamInfo &  paramInfo )

protected

Add inherited parameters from the given base class (makes copies of the parameters)

void DtInteractionClassInfo::addInheritedParameters ( const DtInteractionClassInfo &  baseClass )

protected

Add an inherited parameter (makes copy of given parameter)

void DtInteractionClassInfo::addOwnParameter ( DtParamInfo *  paramInfo )

protected

Add an own parameter.

virtual DtParamInfo* DtInteractionClassInfo::addParam ( const char *  paramName, const char *  semantics, bool  addSorted  )

virtual

Adds an parameter to the class (called during FED processing).

virtual void DtInteractionClassInfo::addRemotePassiveSubscription ( DtFederateHandle  fedHandle )

protectedvirtual

Add/delete remote subscription to this class by indicated federate.

virtual void DtInteractionClassInfo::addRemoteSubscription ( DtFederateHandle  fedHandle )

protectedvirtual

Add/delete remote subscription to this class by indicated federate.

virtual void DtInteractionClassInfo::addSubclass ( DtInteractionClassInfo *  sub )

virtual

Add a subclass (called during FED processing).

void DtInteractionClassInfo::addUsedParameter ( DtParameterHandle  handle )

protected

Add parameter handle(s) to used list by this class or one of its sub classes Recursively add to base classes.

void DtInteractionClassInfo::addUsedParameters ( const DtParameterHandleStdSet &  handles )

protected

Add parameter handle(s) to used list by this class or one of its sub classes Recursively add to base classes.

virtual DtInteractionClassInfo* DtInteractionClassInfo::baseClass ( ) const

virtual

Return pointer to base class descriptor.

virtual void DtInteractionClassInfo::clearDestinationOverride ( )

virtual

Remove destination override.

virtual void DtInteractionClassInfo::deleteRemoteSubscription ( DtFederateHandle  fedHandle, bool  isForSmartForwarding = false  )

protectedvirtual

Add/delete remote subscription to this class by indicated federate.

virtual MAKRti::DtInetAddr DtInteractionClassInfo::destinationAddress ( ) const

virtual

Get the destination address used to send when using DM Filtering.

virtual MAKRti::DtInetAddr DtInteractionClassInfo::destinationDevice ( ) const

virtual

Get the destination device used to send when using DM Filtering.

virtual bool DtInteractionClassInfo::diffClass ( const DtInteractionClassInfo &  classInfo, DtParameterByHandleMap &  diff  ) const

virtual

First test given class for equality excluding parameters.

Then take diff of its parameters from this info's parameters where matching parameters must be equal. Warning! - parameter diff is a shallow copy Returns true if class and matching parameters are the same; otherwise, false

virtual bool DtInteractionClassInfo::diffParameters ( const DtInteractionClassInfo &  classInfo, DtParameterByHandleMap &  diff  ) const

virtual

Take the difference of own parameters between classes: the given class info from this class info.

Warning! - diff is a shallow copy Returns true if matching parameters are the same; otherwise, false

virtual DtDimensionHandleStdSet const& DtInteractionClassInfo::dimensions ( ) const

virtual

Set/Get dimensions.

virtual DtInteractionClassHandle DtInteractionClassInfo::discoveredHandle ( ) const

virtual

Get/set discovered class handle This value is always 0 if isUnknown() is false.

virtual void DtInteractionClassInfo::emptyParameters ( )

protectedvirtual

Empty the parameter lists.

virtual MAKRti::DtFomType DtInteractionClassInfo::fomType ( ) const

virtual

Set/Get FOM type.

virtual void DtInteractionClassInfo::forceDestinations ( DtBitMask const &  mask, MAKRti::DtTime  delay  )

virtual

Temporarily force destinations with this mask for given delay A negative time delay will force the destinations indefinitely.

virtual DtBitMask DtInteractionClassInfo::getDestinations ( bool  includeBaseClass = true ) const

virtual

Get the list of remote subscribers to the class = update destinations The base class destination masks are added unless specified otherwise.

virtual DtInteractionClassHandle DtInteractionClassInfo::handle ( ) const

virtual

Get/set class handle.

virtual void DtInteractionClassInfo::inheritMergedParameter ( const DtParamInfo &  param )

protectedvirtual

Inherit the given merged parameter from base class recursively through subclasses.

virtual bool DtInteractionClassInfo::isFullName ( const char *  name ) const

virtual

Root name is required.

virtual bool DtInteractionClassInfo::isMom ( )

virtual

Return true if this is a MOM class.

virtual bool DtInteractionClassInfo::isName ( const char *  name ) const

virtual

Return boolean: name matches? Compare depends on FOM type: insensitive for 1.3 and sensitive for 1516.

Root name is prepended to name if necessary.

virtual int DtInteractionClassInfo::isOfClass ( DtInteractionClassHandle  handle ) const

virtual

Returns 1 if this class is handle or is a subclass of handle.

virtual bool DtInteractionClassInfo::isRoot ( )

virtual

Return true if this is the Root class.

virtual bool DtInteractionClassInfo::isScaffolding ( ) const

virtual

Determines whether the class is a scaffolding class.

virtual bool DtInteractionClassInfo::isUnknown ( ) const

virtual

Determines whether this class is an unknown class, merely present to indicate that it is in other FOM modules not in use by this federate.

virtual DtParamInfo* DtInteractionClassInfo::mergeParam ( const char *  paramName, const char *  semantics  )

virtual

Adds an parameter to the class (called during FED processing).

virtual const char* DtInteractionClassInfo::name ( ) const

virtual

Return class name, as in FED.

virtual void DtInteractionClassInfo::nameUpdateCheck ( )

protectedvirtual

Update indicators of root and MOM class.

virtual int DtInteractionClassInfo::numParameters ( ) const

virtual

Returns the number of parameters.

virtual int DtInteractionClassInfo::numRemoteFederatesSubscribed ( ) const

virtual

Returns number of remote federates subscribed to this class.

bool DtInteractionClassInfo::operator!=

(

const DtInteractionClassInfo &

other

)

const

Return the space handle.

DtInteractionClassInfo& DtInteractionClassInfo::operator=

(

const DtInteractionClassInfo &

orig

)

Assignment operator (not implemented)

bool DtInteractionClassInfo::operator==

(

const DtInteractionClassInfo &

other

)

const

Return the space handle.

virtual MAKRti::DtOrderType DtInteractionClassInfo::order ( ) const

virtual

Set/Get order type.

virtual void DtInteractionClassInfo::overrideDestinations ( DtBitMask const &  mask )

virtual

Permanently override destinations with given mask.

virtual DtParameterByHandleMap const& DtInteractionClassInfo::ownParams ( ) const

virtual

Returns the set of parameter infos just from this class.

virtual DtParamInfo* DtInteractionClassInfo::paramByHandle ( const DtParameterHandle  theHandle )

virtual

Get parameter descriptor by name.

virtual const DtParamInfo* DtInteractionClassInfo::paramByHandle ( const DtParameterHandle  theHandle ) const

virtual

Get parameter descriptor by name.

virtual DtParamInfo* DtInteractionClassInfo::paramByName ( const char *  theName )

virtual

Get parameter descriptor by handle.

virtual const DtParamInfo* DtInteractionClassInfo::paramByName ( const char *  theName ) const

virtual

Get parameter descriptor by handle.

virtual DtParameterHandleSet const& DtInteractionClassInfo::parameterHandles ( ) const

virtual

Return the set of parameter handles.

virtual DtParameterHandle DtInteractionClassInfo::paramHandle ( const char *  theName )

virtual

Get parameter handle from name.

virtual char* DtInteractionClassInfo::paramName ( DtParameterHandle  theHandle )

virtual

Get parameter name from handle.

virtual DtParameterByHandleMap const& DtInteractionClassInfo::params ( ) const

virtual

Returns the list of parameter infos.

virtual void DtInteractionClassInfo::print ( ) const

virtual

Print the contents.

virtual void DtInteractionClassInfo::publish ( DtInteractionMgr *  interMgr )

virtual

Publish this class.

virtual int DtInteractionClassInfo::published ( ) const

virtual

Return 1 if we are publishing this class, 0 otherwise.

virtual void DtInteractionClassInfo::reIndexParametersByName ( DtParamInfo *  paramInfo )

protectedvirtual

The given parameter was just added with the next handle.

Adjust handles of own parameters so that they are indexed by name sort order.

virtual bool DtInteractionClassInfo::relevant ( ) const

virtual

Returns true if the class is relevant, false otherwise.

virtual bool DtInteractionClassInfo::remoteFederateIsSubscribed ( DtFederateHandle  fedHandle ) const

virtual

Returns true if the remote federate is subscribed to this class.

virtual void DtInteractionClassInfo::remotePassiveSubscribe ( DtFederateHandle  fedHandle, DtInteractionMgr *  interMgr  )

virtual

Call when another federate subscribes to this class passively.

Simply stores passive subscription, does not updateRelevance.

virtual void DtInteractionClassInfo::remoteSubscribe ( DtFederateHandle  fedHandle, DtInteractionMgr *  interMgr  )

virtual

Call when another federate subscribes to this class actively.

Updates subscriptions for this class, then calls updateRelevance.

virtual void DtInteractionClassInfo::remoteUnsubscribe ( DtFederateHandle  fedHandle, DtInteractionMgr *  interMgr, bool  forSmartForwarding  )

virtual

Call when another federate unsubscribes to this class.

Updates subscriptions for this class, then calls updateRelevance.

virtual void DtInteractionClassInfo::removeDimension ( DtDimensionHandle  dimHandle )

virtual

Add/Remove a dimension handle.

virtual bool DtInteractionClassInfo::restore ( DtInteractionClassPacket *  packet )

virtual

Restore (volatile) contents of this class.

virtual bool DtInteractionClassInfo::sameAncestry ( const DtInteractionClassInfo *  ) const

virtual

Test for equality.

virtual bool DtInteractionClassInfo::sameInteractionClass ( const DtInteractionClassInfo &  interInfo, DtParameterByHandleMap *  collectParametersToMerge  ) const

virtual

Compare the given interaction classes If not Null, collect parameters to merge from supplied class; otherwise, extra parameters are invalid.

virtual bool DtInteractionClassInfo::sameParameters ( const DtParameterByHandleMap &  paramHandles, DtParameterByHandleMap *  collectParametersToMerge  ) const

virtual

Compare the given parameter handles with the handles of this interaction (only ones where names match if missing parameters are allowed)

virtual bool DtInteractionClassInfo::save ( DtRtiSaveFile &  file )

virtual

Save (volatile) contents of this class.

const char* DtInteractionClassInfo::semantics

(

)

const

Set/Get semantics.

virtual void DtInteractionClassInfo::setBaseClass ( DtInteractionClassInfo *  base )

virtual

Set base class pointer (used when deep copying FOM target not when constructing target)

virtual void DtInteractionClassInfo::setDestination ( MAKRti::DtInetAddr  addr, MAKRti::DtInetAddr  devAddr, bool  inclusive, MAKRti::DtInetAddr  oldAddr, MAKRti::DtInetAddr  oldDevAddr  )

virtual

Set the destination address and device used to send when using DM Filtering.

virtual void DtInteractionClassInfo::setDimensions ( DtDimensionHandleStdSet const &  dimList )

virtual

Set/Get dimensions.

virtual void DtInteractionClassInfo::setDiscoveredHandle ( DtInteractionClassHandle  handleValue )

virtual

Get/set discovered class handle This value is always 0 if isUnknown() is false.

virtual void DtInteractionClassInfo::setFomType ( MAKRti::DtFomType  type )

virtual

Set/Get FOM type.

virtual void DtInteractionClassInfo::setHandle ( DtInteractionClassHandle  handleValue )

virtual

Get/set class handle.

virtual void DtInteractionClassInfo::setIsUnknown ( bool  unknown )

virtual

Set whether this class is well defined.

virtual void DtInteractionClassInfo::setOrder ( MAKRti::DtOrderType  theOrder )

virtual

Set/Get order type.

void DtInteractionClassInfo::setSemantics

(

const MAKRti::DtString &

semantics

)

Set/Get semantics.

void DtInteractionClassInfo::setSharing

(

const DtSharingType

sharing

)

Set/Get sharing (pub/sub)

virtual void DtInteractionClassInfo::setSpaceHandle ( DtSpaceHandle  spaceHandleValue )

virtual

Return the space handle.

virtual void DtInteractionClassInfo::setTransport ( MAKRti::DtTransportType  theTransport )

virtual

Set/Get transport type representing transport mechanism.

DtSharingType DtInteractionClassInfo::sharing

(

)

const

Set/Get sharing (pub/sub)

virtual DtSpaceHandle DtInteractionClassInfo::spaceHandle ( ) const

virtual

Return the space handle.

virtual const DtInteractionClassByHandleMap& DtInteractionClassInfo::subclasses ( ) const

virtual

Return list of subclasses.

virtual DtInteractionClassByHandleMap& DtInteractionClassInfo::subclasses ( )

virtual

Return list of subclasses.

virtual void DtInteractionClassInfo::subscribe ( bool  active )

virtual

Subscribe this class.

virtual int DtInteractionClassInfo::subscribed ( ) const

virtual

Return 1 if we are subscribed to this class, 0 otherwise.

virtual const MAKRti::DtList& DtInteractionClassInfo::subscribedFederates ( ) const

virtual

Returns a list of federates who are subscribed to this interaction.

virtual int DtInteractionClassInfo::subscribedWithRegion ( ) const

virtual

Return 1 if we are subscribed to this class with region, 0 otherwise.

static const char* DtInteractionClassInfo::swapRootName ( const char *  name, MAKRti::DtFomType  fomType, MAKRti::DtString &  adjustedName  )

static

Swap or add the root class name part of the given name to the this class' FOM type Return the adjusted name's c string.

virtual MAKRti::DtTransportType DtInteractionClassInfo::transport ( ) const

virtual

Set/Get transport type representing transport mechanism.

virtual void DtInteractionClassInfo::unpublish ( )

virtual

Unpublish this class.

virtual void DtInteractionClassInfo::unsubscribe ( )

virtual

Unsubscribe this class.

void DtInteractionClassInfo::updateAvailableParameterHandle ( DtParameterHandle  paramHandle )

protected

The given parameter handle is now occupied. Update the next available parameter handle.

void DtInteractionClassInfo::updateAvailableParameterHandles ( const DtParameterHandleStdSet &  handles )

protected

The given parameter handle is now occupied. Update the next available parameter handle.

virtual void DtInteractionClassInfo::updateRelevance ( DtInteractionMgr *  interMgr )

protectedvirtual

Update the relevance field of this class and all subclasses, based on current subscriptions.

Add pending turnOn/OffInteractions when appropriate.

Member Data Documentation

MAKRti::DtInetAddr DtInteractionClassInfo::myAddr

protected

DtParameterHandle DtInteractionClassInfo::myAvailableParameterHandle

protected

The available parameter handle which is the maximum of this classes own parameters or any of its subclasses.

DtInteractionClassInfo* DtInteractionClassInfo::myBase

protected

MAKRti::DtClock DtInteractionClassInfo::myClock

protected

MAKRti::DtInetAddr DtInteractionClassInfo::myDevAddr

protected

DtDimensionHandleStdSet DtInteractionClassInfo::myDimensions

protected

DtInteractionClassHandle DtInteractionClassInfo::myDiscoveredHandle

protected

int DtInteractionClassInfo::myFirstParam

protected

MAKRti::DtFomType DtInteractionClassInfo::myFomType

protected

DtBitMask* DtInteractionClassInfo::myForceDestinationsMask

protected

Create this bit mask to temporarily force destinations after publish.

MAKRti::DtTime DtInteractionClassInfo::myForceDestinationsTime

protected

DtInteractionClassHandle DtInteractionClassInfo::myHandle

protected

bool DtInteractionClassInfo::myIsMom

protected

bool DtInteractionClassInfo::myIsRoot

protected

bool DtInteractionClassInfo::myIsUnknown

protected

Indicates whether this class is an unknown class, merely present to indicate that it is in other FOM modules not in use by this federate.

MAKRti::DtString DtInteractionClassInfo::myName

protected

MAKRti::DtOrderType DtInteractionClassInfo::myOrder

protected

DtBitMask* DtInteractionClassInfo::myOverrideDestinationsMask

protected

Create this bit mask to permanently override destinations.

DtParameterByHandleMap DtInteractionClassInfo::myOwnParamsByHandle

protected

DtParameterByNameMap DtInteractionClassInfo::myOwnParamsByName

protected

DtParameterHandleSet DtInteractionClassInfo::myParameterHandleSet

protected

DtParameterByHandleMap DtInteractionClassInfo::myParamsByHandle

protected

DtParameterByNameMap DtInteractionClassInfo::myParamsByName

protected

int DtInteractionClassInfo::myPublished

protected

bool DtInteractionClassInfo::myRelevant

protected

MAKRti::DtHashlist DtInteractionClassInfo::myRemotePassiveSubscriptions

protected

DtBitMask DtInteractionClassInfo::myRemoteSubscriberMask

protected

MAKRti::DtHashlist DtInteractionClassInfo::myRemoteSubscriptions

protected

MAKRti::DtString DtInteractionClassInfo::mySemantics

protected

DtSharingType DtInteractionClassInfo::mySharing

protected

DtSpaceHandle DtInteractionClassInfo::mySpaceHandle

protected

DtInteractionClassByHandleMap DtInteractionClassInfo::mySubclassByHandle

protected

DtInteractionClassByNameMap DtInteractionClassInfo::mySubclassesByName

protected

DtSubcribeInteractionType DtInteractionClassInfo::mySubscribed

protected

MAKRti::DtTransportType DtInteractionClassInfo::myTransport

protected

DtParameterHandleStdSet DtInteractionClassInfo::myUsedParameterHandles

protected

const unsigned int DtInteractionClassInfo::theMaxParams

staticprivate

---

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

• intClassInfo.h