DtInteractionClassInfo Class Reference

Collaboration diagram for DtInteractionClassInfo:

Public Member Functions
	DtInteractionClassInfo (const char *name, DtInteractionClassInfo *base, DtInteractionClassHandle handle, DtSharingType sharing, MAKRti::DtString semantics, MAKRti::DtTransportType transport, MAKRti::DtOrderType order)
	Constructors.
	DtInteractionClassInfo (const DtInteractionClassInfo &orig)
	Copy constructor (not implemented)
DtInteractionClassInfo &	operator= (const DtInteractionClassInfo &orig)
	Assignment operator (not implemented)
virtual	~DtInteractionClassInfo ()
	Destructor.
virtual void	setFomType (MAKRti::DtFomType type)
virtual MAKRti::DtFomType	fomType () const
virtual void	addParam (const char *paramName, const char *semantics, bool addSorted)
	Adds an parameter to the class (called during FED processing).
virtual void	addSubclass (DtInteractionClassInfo *sub)
	Add a subclass (called during FED processing).
virtual DtDimensionHandleSet const &	dimensions () const
	Set/Get dimensions.
virtual void	setDimensions (DtDimensionHandleSet const &dimList)
virtual void	addDimension (DtDimensionHandle dimHandle)
	Add/Remove a dimesion handle.
virtual void	removeDimension (DtDimensionHandle dimHandle)
virtual const char *	name () const
	Return class name, as in FED.
virtual bool	isName (const char *name)
	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 bool	isFullName (const char *name)
	Root name is required.
virtual DtParameterHandle	paramHandle (const char *theName)
	Get parameter handle from name.
virtual char *	paramName (DtParameterHandle theHandle)
	Get parameter name from handle.
virtual DtInteractionClassHandle	handle () const
	Get/set class handle.
virtual void	setHandle (DtInteractionClassHandle handleValue)
virtual DtInteractionClassHandle	discoveredHandle () const
	Get/set discovered class handle This value is always 0 if isUnknown() is false.
virtual void	setDiscoveredHandle (DtInteractionClassHandle handleValue)
virtual DtInteractionClassInfo *	baseClass () const
	Return pointer to base class descriptor.
virtual void	setBaseClass (DtInteractionClassInfo *base)
	Set base class pointer (User should not need to call this);.
virtual MAKRti::DtList *	subclasses ()
	Return list of subclasses.
virtual int	isOfClass (DtInteractionClassHandle handle) const
	Returns 1 if this class is handle or is a subclass of handle.
virtual void	publish (DtInteractionMgr *interMgr)
	Publish and unpublish.
virtual void	unpublish ()
virtual int	published () const
	Return 1 if we are publishing this class, 0 otherwise.
virtual void	subscribe (bool active)
	Subscribe and unsubscribe.
virtual void	unsubscribe ()
virtual int	subscribed () const
	Return 1 if we are subscribed to this class, 0 otherwise.
virtual void	remoteSubscribe (DtFederateHandle fedHandle, DtInteractionMgr *interMgr)
	Call when another federate subscribes to this class actively.
virtual void	remotePassiveSubscribe (DtFederateHandle fedHandle, DtInteractionMgr *interMgr)
	Call when another federate subscribes to this class passively.
virtual void	remoteUnsubscribe (DtFederateHandle fedHandle, DtInteractionMgr *interMgr, bool forSmartForwarding)
	Call when another federate unsubscribes to this class.
virtual bool	remoteFederateIsSubscribed (DtFederateHandle fedHandle) const
	Returns true if the remote federate is subscribed to this class.
virtual int	numRemoteFederatesSubscribed () const
	Returns number of remote federates subscribed to this class.
virtual const MAKRti::DtList &	subscribedFederates () const
	Returns a list of federates who are subscribed to this interaction.
virtual bool	relevant () const
	Returns true if the class is relevant, false otherwise.
virtual DtParamInfo *	paramByName (const char *theName)
	Get parameter descriptor by name or handle.
virtual DtParamInfo *	paramByHandle (const DtParameterHandle theHandle)
virtual MAKRti::DtTransportType	transport () const
	Set/Get transport type representing transport mechanism.
virtual void	setTransport (MAKRti::DtTransportType theTransport)
DtSharingType	sharing () const
void	setSharing (const DtSharingType sharing)
const char *	semantics () const
void	setSemantics (const MAKRti::DtString &semantics)
virtual MAKRti::DtOrderType	order () const
	Set/Get order type.
virtual void	setOrder (MAKRti::DtOrderType theOrder)
virtual void	setSpaceHandle (DtSpaceHandle spaceHandleValue)
	Return the space handle.
virtual DtSpaceHandle	spaceHandle () const
virtual MAKRti::DtInetAddr	destinationAddress () const
	set the destination to send to when using DM Filtering
virtual MAKRti::DtInetAddr	destinationDevice () const
virtual void	setDestination (MAKRti::DtInetAddr addr, MAKRti::DtInetAddr devAddr, bool inclusive, MAKRti::DtInetAddr oldAddr, MAKRti::DtInetAddr oldDevAddr)
virtual int	subscribedWithRegion () const
	Return 1 if we are subscribed to this class with region, 0 otherwise.
virtual int	numParameters () const
	Returns the number of parameters.
virtual DtParamVector const &	params () const
	Returns the list of parameters.
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.
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.
virtual void	overrideDestinations (DtBitMask const &mask)
	Permanently override destinations with given mask.
virtual void	clearDestinationOverride ()
	Remove destination override.
virtual bool	save (DtRtiSaveFile &file)
	save and restore
virtual bool	restore (DtInteractionClassPacket *packet)
virtual void	print () const
	Print the contents.
virtual bool	sameAncestry (const DtInteractionClassInfo *) const
	Test for equality.
bool	operator== (const DtInteractionClassInfo &other) const
bool	operator!= (const DtInteractionClassInfo &other) const
bool	isScaffolding () const
	Determines whether the class is a scaffolding class.
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.
void	setIsUnknown (bool unknown)

Protected Member Functions
virtual void	addRemoteSubscription (DtFederateHandle fedHandle)
	Add/delete remote subscription to this class by indicated federate.
virtual void	addRemotePassiveSubscription (DtFederateHandle fedHandle)
virtual void	deleteRemoteSubscription (DtFederateHandle fedHandle, bool isForSmartForwarding=false)
virtual void	updateRelevance (DtInteractionMgr *interMgr)
	Update the relevance field of this class and all subclasses, based on current subscriptions.
void	addParamSorted (const char *paramName, MAKRti::DtString semantics)
	Insert Parameters in sorted or unsorted (deprecated) order.
void	addParamUnsorted (const char *paramName, MAKRti::DtString semantics)

Static Protected Member Functions
static bool	sameInteractionClass (const DtInteractionClassInfo &, const DtInteractionClassInfo &)
static bool	sameParamsUnsorted (const std::vector< DtParamInfo > &, const std::vector< DtParamInfo > &)
static bool	sameParamsSorted (const std::vector< DtParamInfo > &, const std::vector< DtParamInfo > &)

Protected Attributes
MAKRti::DtString	myName
DtInteractionClassHandle	myHandle
DtInteractionClassHandle	myDiscoveredHandle
DtSpaceHandle	mySpaceHandle
DtDimensionHandleSet	myDimensions
MAKRti::DtFomType	myFomType
DtSubcribeInteractionType	mySubscribed
int	myPublished
DtInteractionClassInfo *	myBase
MAKRti::DtList	mySubclasses
MAKRti::DtTransportType	myTransport
MAKRti::DtString	mySemantics
DtSharingType	mySharing
MAKRti::DtOrderType	myOrder
DtParamVector	myParams
int	myFirstParam
MAKRti::DtHashlist	myRemoteSubscriptions
MAKRti::DtHashlist	myRemotePassiveSubscriptions
DtBitMask	myRemoteSubscriberMask
DtBitMask *	myForceDestinationsMask
	Create this bit mask to temporarily force destinations after publish.
DtBitMask *	myOverrideDestinationsMask
	Create this bit mask to permanently override destinations.
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.

Static Private Attributes
static const unsigned int	theMaxParams = 300

Constructor & Destructor Documentation

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

Constructors.

References addParam(), addSubclass(), false, fomType(), myFirstParam, myParams, paramName(), semantics(), and setFomType().

DtInteractionClassInfo::DtInteractionClassInfo

(

const DtInteractionClassInfo &

orig

)

Copy constructor (not implemented)

References myForceDestinationsMask, myOverrideDestinationsMask, myRemotePassiveSubscriptions, myRemoteSubscriptions, and NULL.

DtInteractionClassInfo::~DtInteractionClassInfo ( )

virtual

Destructor.

References myForceDestinationsMask, myOverrideDestinationsMask, myRemotePassiveSubscriptions, myRemoteSubscriberMask, myRemoteSubscriptions, mySubclasses, NULL, and DtBitMask::reset().

Member Function Documentation

void DtInteractionClassInfo::addDimension ( DtDimensionHandle  dimHandle )

virtual

Add/Remove a dimesion handle.

References myDimensions.

Referenced by DtFomClassMgr::addInteractionDimension(), and DtFomClassMgr::resolveInteractionDimensions().

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

virtual

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

References addParamSorted(), addParamUnsorted(), myParams, paramByName(), and theMaxParams.

Referenced by DtFomClassMgr::addParameter(), DtInteractionClassInfo(), and DtFomClassMgr::mergeParameters().

void DtInteractionClassInfo::addParamSorted ( const char *  paramName, MAKRti::DtString  semantics  )

protected

Insert Parameters in sorted or unsorted (deprecated) order.

References fomType(), myFirstParam, myParams, and name().

Referenced by addParam().

void DtInteractionClassInfo::addParamUnsorted ( const char *  paramName, MAKRti::DtString  semantics  )

protected

References fomType(), myParams, and DtParamInfo::setFomType().

Referenced by addParam().

void DtInteractionClassInfo::addRemotePassiveSubscription ( DtFederateHandle  fedHandle )

protectedvirtual

References DtRtiMtdDestinationList::destinationIndex(), myRemotePassiveSubscriptions, myRemoteSubscriberMask, DtBitMask::setBit(), and DtRtiMsg::smartForwardingEnabled().

Referenced by remotePassiveSubscribe().

void DtInteractionClassInfo::addRemoteSubscription ( DtFederateHandle  fedHandle )

protectedvirtual

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

References DtRtiMtdDestinationList::destinationIndex(), myRemoteSubscriberMask, myRemoteSubscriptions, DtBitMask::setBit(), and DtRtiMsg::smartForwardingEnabled().

Referenced by remoteSubscribe(), and restore().

void DtInteractionClassInfo::addSubclass ( DtInteractionClassInfo *  sub )

virtual

Add a subclass (called during FED processing).

References mySubclasses.

Referenced by DtInteractionClassInfo(), and setBaseClass().

DtInteractionClassInfo * DtInteractionClassInfo::baseClass ( ) const

virtual

Return pointer to base class descriptor.

References myBase.

Referenced by DtInteractionMgr::firstSubscribedClass(), getDestinations(), DtNetStatsMonitor::getNameFromInteraction(), isOfClass(), DtFomClassMgr::mergeInteractionInfo(), DtFedExec::processJoin(), DtInteractionMgr::processPub(), sameAncestry(), and updateRelevance().

void DtInteractionClassInfo::clearDestinationOverride ( )

virtual

Remove destination override.

References myOverrideDestinationsMask.

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

protectedvirtual

References DtRtiMtdDestinationList::destinationIndex(), myRemotePassiveSubscriptions, myRemoteSubscriberMask, myRemoteSubscriptions, DtBitMask::setBit(), and DtRtiMsg::smartForwardingEnabled().

Referenced by remoteUnsubscribe().

MAKRti::DtInetAddr DtInteractionClassInfo::destinationAddress ( ) const

virtual

set the destination to send to when using DM Filtering

References myAddr.

Referenced by DtInteractionMgr::addClassMulticast(), DtFomClassMgr::initDMFilteringParameters(), DtInteractionMgr::localAddrMap(), and DtInteractionMgr::removeClassMulticast().

MAKRti::DtInetAddr DtInteractionClassInfo::destinationDevice ( ) const

virtual

References myDevAddr.

Referenced by DtInteractionMgr::addClassMulticast(), and DtFomClassMgr::initDMFilteringParameters().

DtDimensionHandleSet const & DtInteractionClassInfo::dimensions ( ) const

virtual

Set/Get dimensions.

References myDimensions.

Referenced by DtFomClassMgr::mergeInteractionInfo(), and DtInteractionMgr::processInteraction().

DtInteractionClassHandle DtInteractionClassInfo::discoveredHandle ( ) const

virtual

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

References myDiscoveredHandle.

Referenced by DtNetStatsMonitor::recordInteractionStats().

MAKRti::DtFomType DtInteractionClassInfo::fomType ( ) const

virtual

References myFomType.

Referenced by addParamSorted(), addParamUnsorted(), DtInteractionClassInfo(), isFullName(), and isName().

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.

References myClock, myForceDestinationsMask, and myForceDestinationsTime.

Referenced by publish().

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.

References baseClass(), getDestinations(), myClock, myForceDestinationsMask, myForceDestinationsTime, myOverrideDestinationsMask, myRemoteSubscriberMask, and NULL.

Referenced by getDestinations(), and DtInteractionMgr::sendInteractionMsg().

DtInteractionClassHandle DtInteractionClassInfo::handle ( ) const

virtual

Get/set class handle.

References myHandle.

Referenced by DtNetStatsMonitor::createSerializedTreesAndSend(), DtTestInteraction::DtTestInteraction(), DtInteractionMgr::firstSubscribedClass(), DtNetStatsMonitor::gatherClassDataAndSend(), DtFomClassMgr::interactionHandle(), isOfClass(), paramByHandle(), DtInteractionMgr::processInteraction(), DtFedExec::processJoin(), DtInteractionMgr::processPub(), publish(), DtNetStatsMonitor::recursivelyAddInteractions(), DtNetStatsMonitor::recursivelyAddParametersNames(), DtNetStatsMonitor::recursivelyAddParamInitState(), remotePassiveSubscribe(), remoteSubscribe(), remoteUnsubscribe(), DtNetStatsMonitor::sendInitParamState(), DtNetStatsMonitor::sendParameterNames(), DtNetStatsMonitor::sendParameterState(), and updateRelevance().

bool DtInteractionClassInfo::isFullName ( const char *  name )

virtual

Root name is required.

References fomType(), myName, and name().

Referenced by isName().

bool DtInteractionClassInfo::isName ( const char *  name )

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.

References fomType(), isFullName(), and name().

Referenced by paramByName().

int DtInteractionClassInfo::isOfClass ( DtInteractionClassHandle  handle ) const

virtual

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

References baseClass(), handle(), and isOfClass().

Referenced by isOfClass().

bool DtInteractionClassInfo::isScaffolding

(

)

const

Determines whether the class is a scaffolding class.

References myFirstParam, and params().

Referenced by DtFomClassMgr::mergeInteractionInfo().

bool DtInteractionClassInfo::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.

References myIsUnknown.

Referenced by DtNetStatsMonitor::recordInteractionStats(), DtNetStatsMonitor::recursivelyAddInteractions(), DtNetStatsMonitor::recursivelyAddParametersNames(), DtNetStatsMonitor::recursivelyAddParamInitState(), and DtNetStatsMonitor::sendParameterState().

const char * DtInteractionClassInfo::name ( ) const

virtual

Return class name, as in FED.

References myName.

Referenced by DtFomClassMgr::addInteractionHdlForUnknownClass(), addParamSorted(), addTestToFom(), DtNetStatsMonitor::gatherClassDataAndSend(), DtNetStatsMonitor::getNameFromInteraction(), DtFomClassMgr::interactionClassPosition(), DtFomClassMgr::interactionClassPresent(), DtFomClassMgr::interactionName(), isFullName(), isName(), DtFomClassMgr::mergeInteractionInfo(), DtFomClassMgr::mergeParameters(), DtNetStatsMonitor::recordInteractionStats(), sameAncestry(), sameInteractionClass(), and sameParamsUnsorted().

int DtInteractionClassInfo::numParameters ( ) const

virtual

Returns the number of parameters.

References myParams.

Referenced by DtTestInteraction::DtTestInteraction().

int DtInteractionClassInfo::numRemoteFederatesSubscribed ( ) const

virtual

Returns number of remote federates subscribed to this class.

References myRemoteSubscriptions.

Referenced by remotePassiveSubscribe(), remoteSubscribe(), remoteUnsubscribe(), and updateRelevance().

bool DtInteractionClassInfo::operator!=

(

const DtInteractionClassInfo &

other

)

const

References sameInteractionClass().

DtInteractionClassInfo& DtInteractionClassInfo::operator=

(

const DtInteractionClassInfo &

orig

)

Assignment operator (not implemented)

bool DtInteractionClassInfo::operator==

(

const DtInteractionClassInfo &

other

)

const

References sameInteractionClass().

MAKRti::DtOrderType DtInteractionClassInfo::order ( ) const

virtual

Set/Get order type.

References myOrder.

Referenced by DtFomClassMgr::addInteractionHdlForUnknownClass(), DtFomClassMgr::mergeInteractionInfo(), DtNetStatsMonitor::recursivelyAddParamInitState(), sameInteractionClass(), DtInteractionMgr::send(), DtNetStatsMonitor::sendInitParamState(), and DtNetStatsMonitor::sendParameterState().

void DtInteractionClassInfo::overrideDestinations ( DtBitMask const &  mask )

virtual

Permanently override destinations with given mask.

References myOverrideDestinationsMask.

DtParamInfo * DtInteractionClassInfo::paramByHandle ( const DtParameterHandle  theHandle )

virtual

References handle(), myParams, and NULL.

Referenced by DtInteractionMsg::fillFromNetBigParams(), DtInteractionMsg::fillFromNetParams(), paramName(), print(), and DtInteractionMgr::send().

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

virtual

Get parameter descriptor by name or handle.

References isName(), myParams, and NULL.

Referenced by addParam(), DtFomClassMgr::mergeParameters(), and paramHandle().

DtParameterHandle DtInteractionClassInfo::paramHandle ( const char *  theName )

virtual

Get parameter handle from name.

References DtParamInfo::handle(), and paramByName().

Referenced by DtTestInteraction::DtTestInteraction(), and DtFomClassMgr::paramHandle().

char * DtInteractionClassInfo::paramName ( DtParameterHandle  theHandle )

virtual

Get parameter name from handle.

References DtParamInfo::name(), and paramByHandle().

Referenced by DtInteractionClassInfo(), and DtFomClassMgr::paramName().

DtParamVector const & DtInteractionClassInfo::params ( ) const

virtual

Returns the list of parameters.

References myParams.

Referenced by isScaffolding(), DtFomClassMgr::mergeParameters(), DtNetStatsMonitor::recursivelyAddParametersNames(), DtNetStatsMonitor::recursivelyAddParamInitState(), sameInteractionClass(), DtNetStatsMonitor::sendInitParamState(), DtNetStatsMonitor::sendParameterNames(), and DtNetStatsMonitor::sendParameterState().

void DtInteractionClassInfo::print ( ) const

virtual

Print the contents.

References myBase, myDimensions, myHandle, myName, myOrder, myParams, mySpaceHandle, myTransport, and paramByHandle().

void DtInteractionClassInfo::publish ( DtInteractionMgr *  interMgr )

virtual

Publish and unpublish.

References DtInteractionMgr::addPendingStartInters(), forceDestinations(), DtRtiMtdDestinationList::getMaxDestinations(), handle(), myPublished, myRemoteSubscriberMask, DtInteractionMgr::params(), published(), relevant(), and DtBitMask::reset().

Referenced by DtInteractionMgr::publish().

int DtInteractionClassInfo::published ( ) const

virtual

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

References myPublished.

Referenced by DtInteractionMgr::getTransport(), publish(), DtInteractionMgr::published(), DtNetStatsMonitor::recursivelyAddParamInitState(), DtInteractionMgr::send(), DtNetStatsMonitor::sendInitParamState(), DtNetStatsMonitor::sendParameterState(), DtInteractionMgr::setOrder(), DtInteractionMgr::setTransport(), DtInteractionMgr::unpublish(), and updateRelevance().

bool DtInteractionClassInfo::relevant ( ) const

virtual

Returns true if the class is relevant, false otherwise.

References myRelevant.

Referenced by publish(), and updateRelevance().

bool DtInteractionClassInfo::remoteFederateIsSubscribed ( DtFederateHandle  fedHandle ) const

virtual

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

References myRemoteSubscriptions, and NULL.

Referenced by remotePassiveSubscribe(), remoteSubscribe(), and remoteUnsubscribe().

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

virtual

Call when another federate subscribes to this class passively.

Simply stores passive subscription, does not updateRelevance.

References addRemotePassiveSubscription(), handle(), numRemoteFederatesSubscribed(), and remoteFederateIsSubscribed().

Referenced by DtInteractionMgr::processSub().

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.

References addRemoteSubscription(), handle(), numRemoteFederatesSubscribed(), remoteFederateIsSubscribed(), and updateRelevance().

Referenced by DtInteractionMgr::processSub().

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.

References deleteRemoteSubscription(), handle(), numRemoteFederatesSubscribed(), remoteFederateIsSubscribed(), DtRtiMsg::smartForwardingEnabled(), and updateRelevance().

Referenced by DtInteractionMgr::processResign(), DtInteractionMgr::processSub(), and DtInteractionMgr::processUnsub().

void DtInteractionClassInfo::removeDimension ( DtDimensionHandle  dimHandle )

virtual

References myDimensions.

bool DtInteractionClassInfo::restore ( DtInteractionClassPacket *  packet )

virtual

References addRemoteSubscription(), DtOrderType, DtInteractionClassPacket::handle, myHandle, myOrder, myPublished, myRelevant, myRemoteSubscriberMask, myRemoteSubscriptions, mySubscribed, myTransport, DtInteractionClassPacket::numRemoteSubs, DtInteractionClassPacket::order, DtInteractionClassPacket::published, DtInteractionClassPacket::relevant, DtBitMask::reset(), DtInteractionClassPacket::subscribed, DtInteractionClassPacket::tally0, DtInteractionClassPacket::tally1, DtInteractionClassPacket::tally2, DtInteractionClassPacket::tally3, and DtInteractionClassPacket::transport.

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

virtual

Test for equality.

References baseClass(), and name().

Referenced by DtFomClassMgr::mergeInteractionInfo().

bool DtInteractionClassInfo::sameInteractionClass ( const DtInteractionClassInfo &  firstClass, const DtInteractionClassInfo &  secondClass  )

staticprotected

References name(), order(), params(), sameParamsUnsorted(), semantics(), sharing(), and transport().

Referenced by operator!=(), and operator==().

bool DtInteractionClassInfo::sameParamsSorted ( const std::vector< DtParamInfo > &  first, const std::vector< DtParamInfo > &  second  )

staticprotected

bool DtInteractionClassInfo::sameParamsUnsorted ( const std::vector< DtParamInfo > &  first, const std::vector< DtParamInfo > &  second  )

staticprotected

References name().

Referenced by sameInteractionClass().

bool DtInteractionClassInfo::save ( DtRtiSaveFile &  file )

virtual

save and restore

References DtRtiSaveInteractionClassType, DtInteractionClassPacket::handle, DtInteractionClassPacket::header, myHandle, myOrder, myPublished, myRelevant, myRemoteSubscriptions, mySubscribed, myTransport, DtInteractionClassPacket::numRemoteSubs, DtInteractionClassPacket::order, DtSaveDataHeader::packetSize, DtSaveDataHeader::packetType, DtInteractionClassPacket::published, DtInteractionClassPacket::relevant, DtInteractionClassPacket::subscribed, DtInteractionClassPacket::tally0, DtInteractionClassPacket::tally1, DtInteractionClassPacket::tally2, DtInteractionClassPacket::tally3, DtInteractionClassPacket::transport, and DtRtiSaveFile::writePacket().

const char * DtInteractionClassInfo::semantics

(

)

const

References mySemantics.

Referenced by DtInteractionClassInfo(), DtFomClassMgr::mergeInteractionInfo(), and sameInteractionClass().

void DtInteractionClassInfo::setBaseClass ( DtInteractionClassInfo *  base )

virtual

Set base class pointer (User should not need to call this);.

References addSubclass(), and myBase.

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

virtual

References myAddr, myDevAddr, and mySubclasses.

Referenced by DtFomClassMgr::initDMFilteringParameters().

void DtInteractionClassInfo::setDimensions ( DtDimensionHandleSet const &  dimList )

virtual

References myDimensions.

Referenced by DtFomClassMgr::mergeInteractionInfo().

void DtInteractionClassInfo::setDiscoveredHandle ( DtInteractionClassHandle  handleValue )

virtual

References myDiscoveredHandle.

Referenced by DtFomClassMgr::addInteractionHdlForUnknownClass().

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

virtual

References myFomType.

Referenced by DtFomClassMgr::addInterClassSorted(), DtFomClassMgr::addInterClassUnsorted(), and DtInteractionClassInfo().

void DtInteractionClassInfo::setHandle ( DtInteractionClassHandle  handleValue )

virtual

References myHandle.

Referenced by DtFomClassMgr::addInterClassSorted().

void DtInteractionClassInfo::setIsUnknown

(

bool

unknown

)

References myIsUnknown.

Referenced by DtFomClassMgr::addInteractionHdlForUnknownClass().

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

virtual

References myOrder.

Referenced by DtFomClassMgr::addInterClassSorted(), and DtInteractionMgr::setOrder().

void DtInteractionClassInfo::setSemantics

(

const MAKRti::DtString &

semantics

)

References mySemantics.

void DtInteractionClassInfo::setSharing

(

const DtSharingType

sharing

)

References mySharing.

void DtInteractionClassInfo::setSpaceHandle ( DtSpaceHandle  spaceHandleValue )

virtual

Return the space handle.

References mySpaceHandle.

Referenced by DtFomClassMgr::addInterClassSorted(), and DtFomClassMgr::addInterClassUnsorted().

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

virtual

References myTransport.

Referenced by DtFomClassMgr::addInterClassSorted(), DtFomClassMgr::mergeInteractionInfo(), and DtInteractionMgr::setTransport().

DtSharingType DtInteractionClassInfo::sharing

(

)

const

References mySharing.

Referenced by DtFomClassMgr::addInteractionHdlForUnknownClass(), DtFomClassMgr::mergeInteractionInfo(), and sameInteractionClass().

DtSpaceHandle DtInteractionClassInfo::spaceHandle ( ) const

virtual

References mySpaceHandle.

Referenced by DtFomClassMgr::mergeInteractionClasses().

MAKRti::DtList * DtInteractionClassInfo::subclasses ( )

virtual

Return list of subclasses.

References mySubclasses.

Referenced by DtInteractionMgr::addClassMulticast(), DtNetStatsMonitor::createSerializedTreesAndSend(), DtNetStatsMonitor::recursivelyAddInteractions(), DtNetStatsMonitor::recursivelyAddParametersNames(), DtNetStatsMonitor::recursivelyAddParamInitState(), DtInteractionMgr::removeClassMulticast(), DtNetStatsMonitor::sendInitParamState(), DtNetStatsMonitor::sendParameterNames(), and updateRelevance().

void DtInteractionClassInfo::subscribe ( bool  active )

virtual

Subscribe and unsubscribe.

References DtSubcribeInteractionActive, DtSubcribeInteractionPassive, and mySubscribed.

Referenced by DtInteractionMgr::subscribe().

int DtInteractionClassInfo::subscribed ( ) const

virtual

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

References mySubscribed.

Referenced by DtInteractionMgr::processPub(), DtNetStatsMonitor::recursivelyAddParamInitState(), DtNetStatsMonitor::sendInitParamState(), DtInteractionMgr::sendInteractionMsg(), DtNetStatsMonitor::sendParameterState(), DtInteractionMgr::subscribe(), DtInteractionMgr::subscribed(), and DtInteractionMgr::unsubscribe().

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

virtual

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

References myRemoteSubscriptions.

int DtInteractionClassInfo::subscribedWithRegion ( ) const

virtual

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

References NULL.

Referenced by DtInteractionMgr::processPub(), DtInteractionMgr::sendInteractionMsg(), DtInteractionMgr::subscribed(), and DtInteractionMgr::unsubscribe().

MAKRti::DtTransportType DtInteractionClassInfo::transport ( ) const

virtual

Set/Get transport type representing transport mechanism.

References myTransport.

Referenced by DtFomClassMgr::addInteractionHdlForUnknownClass(), DtInteractionMgr::getTransport(), DtFomClassMgr::mergeInteractionInfo(), DtNetStatsMonitor::recursivelyAddParamInitState(), sameInteractionClass(), DtInteractionMgr::send(), DtNetStatsMonitor::sendInitParamState(), and DtNetStatsMonitor::sendParameterState().

void DtInteractionClassInfo::unpublish ( )

virtual

References myPublished.

Referenced by DtInteractionMgr::unpublish().

void DtInteractionClassInfo::unsubscribe ( )

virtual

References DtSubcribeInteractionNone, and mySubscribed.

Referenced by DtInteractionMgr::unsubscribe().

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.

References DtInteractionMgr::addPendingStartInters(), DtInteractionMgr::addPendingStopInters(), baseClass(), handle(), myRelevant, NULL, numRemoteFederatesSubscribed(), published(), relevant(), subclasses(), and updateRelevance().

Referenced by remoteSubscribe(), remoteUnsubscribe(), and updateRelevance().

Member Data Documentation

MAKRti::DtInetAddr DtInteractionClassInfo::myAddr

protected

Referenced by destinationAddress(), and setDestination().

DtInteractionClassInfo* DtInteractionClassInfo::myBase

protected

Referenced by baseClass(), print(), and setBaseClass().

MAKRti::DtClock DtInteractionClassInfo::myClock

protected

Referenced by forceDestinations(), and getDestinations().

MAKRti::DtInetAddr DtInteractionClassInfo::myDevAddr

protected

Referenced by destinationDevice(), and setDestination().

DtDimensionHandleSet DtInteractionClassInfo::myDimensions

protected

Referenced by addDimension(), dimensions(), print(), removeDimension(), and setDimensions().

DtInteractionClassHandle DtInteractionClassInfo::myDiscoveredHandle

protected

Referenced by discoveredHandle(), and setDiscoveredHandle().

int DtInteractionClassInfo::myFirstParam

protected

Referenced by addParamSorted(), DtInteractionClassInfo(), and isScaffolding().

MAKRti::DtFomType DtInteractionClassInfo::myFomType

protected

Referenced by fomType(), and setFomType().

DtBitMask* DtInteractionClassInfo::myForceDestinationsMask

protected

Create this bit mask to temporarily force destinations after publish.

Referenced by DtInteractionClassInfo(), forceDestinations(), getDestinations(), and ~DtInteractionClassInfo().

MAKRti::DtTime DtInteractionClassInfo::myForceDestinationsTime

protected

Referenced by forceDestinations(), and getDestinations().

DtInteractionClassHandle DtInteractionClassInfo::myHandle

protected

Referenced by handle(), print(), restore(), save(), and setHandle().

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.

Referenced by isUnknown(), and setIsUnknown().

MAKRti::DtString DtInteractionClassInfo::myName

protected

Referenced by isFullName(), name(), and print().

MAKRti::DtOrderType DtInteractionClassInfo::myOrder

protected

Referenced by order(), print(), restore(), save(), and setOrder().

DtBitMask* DtInteractionClassInfo::myOverrideDestinationsMask

protected

Create this bit mask to permanently override destinations.

Referenced by clearDestinationOverride(), DtInteractionClassInfo(), getDestinations(), overrideDestinations(), and ~DtInteractionClassInfo().

DtParamVector DtInteractionClassInfo::myParams

protected

Referenced by addParam(), addParamSorted(), addParamUnsorted(), DtInteractionClassInfo(), numParameters(), paramByHandle(), paramByName(), params(), and print().

int DtInteractionClassInfo::myPublished

protected

Referenced by publish(), published(), restore(), save(), and unpublish().

bool DtInteractionClassInfo::myRelevant

protected

Referenced by relevant(), restore(), save(), and updateRelevance().

MAKRti::DtHashlist DtInteractionClassInfo::myRemotePassiveSubscriptions

protected

Referenced by addRemotePassiveSubscription(), deleteRemoteSubscription(), DtInteractionClassInfo(), and ~DtInteractionClassInfo().

DtBitMask DtInteractionClassInfo::myRemoteSubscriberMask

protected

Referenced by addRemotePassiveSubscription(), addRemoteSubscription(), deleteRemoteSubscription(), getDestinations(), publish(), restore(), and ~DtInteractionClassInfo().

MAKRti::DtHashlist DtInteractionClassInfo::myRemoteSubscriptions

protected

Referenced by addRemoteSubscription(), deleteRemoteSubscription(), DtInteractionClassInfo(), numRemoteFederatesSubscribed(), remoteFederateIsSubscribed(), restore(), save(), subscribedFederates(), and ~DtInteractionClassInfo().

MAKRti::DtString DtInteractionClassInfo::mySemantics

protected

Referenced by semantics(), and setSemantics().

DtSharingType DtInteractionClassInfo::mySharing

protected

Referenced by setSharing(), and sharing().

DtSpaceHandle DtInteractionClassInfo::mySpaceHandle

protected

Referenced by print(), setSpaceHandle(), and spaceHandle().

MAKRti::DtList DtInteractionClassInfo::mySubclasses

protected

Referenced by addSubclass(), setDestination(), subclasses(), and ~DtInteractionClassInfo().

DtSubcribeInteractionType DtInteractionClassInfo::mySubscribed

protected

Referenced by restore(), save(), subscribe(), subscribed(), and unsubscribe().

MAKRti::DtTransportType DtInteractionClassInfo::myTransport

protected

Referenced by print(), restore(), save(), setTransport(), and transport().

const unsigned int DtInteractionClassInfo::theMaxParams = 300

staticprivate

Referenced by addParam().

---

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

• intClassInfo.h
• intClassInfo.cxx