DtFomClassMgr Class Reference

Inheritance diagram for DtFomClassMgr:

Collaboration diagram for DtFomClassMgr:

Public Member Functions
	DtFomClassMgr (const DtFomClassMgr &orig)
	Copy Constructor - must use clone instead.
virtual	~DtFomClassMgr ()
	Destructor.
virtual void	addSpace (const char *name)
	FED file loading functions.
virtual void	addDimension (const char *spaceName, const char *dimName)
	Define a dimension within a routing space.
virtual void	addDimension (const char *dimName, unsigned long upperBound, unsigned long defaultLowerBound, unsigned long defaultUpperBound, bool excluded, const MAKRti::DtString &normalization)
	Define a dimension. Used when initializing from FED file.
virtual bool	addInteractionDimension (const char *interactionName, const char *dimension)
	Add regions to the class Return true if add was successful (i.e., dimension is valid)
virtual bool	addInterClass (const char *name, const char *baseName, MAKRti::DtTransportType transport, MAKRti::DtOrderType order, DtSharingType sharing, const MAKRti::DtString &semantics, const char *space=NULL)
	Define a class. Used when initializing from FED file.
virtual bool	addInterClass (const char *name, const char *baseName, MAKRti::DtTransportType transport, MAKRti::DtOrderType order, const char *spaceName=NULL)
virtual bool	addObjClass (const char *name, const char *baseName, DtSharingType sharing, const MAKRti::DtString &semantics)
virtual bool	addObjClass (const char *name, const char *baseName)
	Define a class. Used when initializing from FED file.
virtual void	addParameter (const char *className, const char *paramName)
virtual void	addParameter (const char *className, const char *paramName, const char *semantics)
	Define an parameter of a class.
virtual bool	addAttributeDimension (const char *className, const char *attrName, const char *dimName)
	Define the dimensions of an attribute Return true if add was successful (i.e., dimension is valid)
virtual void	addAttribute (const char *className, const char *attrName, MAKRti::DtTransportType transport, MAKRti::DtOrderType order, DtSharingType sharing, DtFomUpdateType updateType, const MAKRti::DtString &updateCondition, DtOwnershipType ownershipType, const MAKRti::DtString &semantics, const char *spaceName=NULL)
	Define an attribute of a class.
virtual void	addAttribute (const char *className, const char *attrName, MAKRti::DtTransportType transport, MAKRti::DtOrderType order, const char *spaceName=NULL)
virtual void	initUpdateRates (DtRIDParameters *params)
const MAKRti::DtUpdateRateSetT &	getUpdateRates () const
	Get a set of the update Rates.
float	updateRateByName (const char *name)
	Get the rate (Float) from an Update rate by its name.
int	positionOfRate (float rate) const
	Get the position of this rate (sorted ascending).
bool	knownUpdateRate (const MAKRti::DtString &rateName) const
	Check to see if an update rate with this name exists.
virtual DtMergeFomStatus	mergeObjectClasses (DtFedTarget const &module)
	Merge the contents of the specified FomMgr with this.
virtual DtMergeFomStatus	mergeObjectInfo (DtObjectClassInfo const &classInfo)
	Merge the contents of the specified objectClass with this.
virtual void	mergeAttributes (DtObjectClassInfo const &classInfo, DtFomClassMgr const &module)
	Merge the attributes of the given class into the same class in this FOM.
virtual DtMergeFomStatus	mergeInteractionClasses (DtFedTarget const &module)
	Merge the contents of the specified interactionClasses with this.
virtual DtMergeFomStatus	mergeInteractionInfo (DtInteractionClassInfo const &interInfo, const char *spaceName=0)
	Merge the contents of the specified InteractionInfo with this.
virtual void	mergeParameters (DtInteractionClassInfo const &interInfo)
	Merge the given interaction parameters into the same class in this FOM.
virtual DtMergeFomStatus	mergeSpaces (DtFedTarget const &module)
	Merge the given routing spaces with this.
virtual DtMergeFomStatus	mergeDimensions (DtSpaceInfo const &spaceInfo)
	Merge the given dimensions into the same space in this FOM.
virtual DtMergeFomStatus	mergeSwitches (DtFedTarget const &module)
	Merge the given switches with this.
virtual DtObjectClassHandle	classHandle (const char *theName, bool throwException=true)
	Querying functions.
virtual const char *	className (DtObjectClassHandle theHandle, bool throwException=true)
	Get class name from handle.
virtual DtAttributeHandle	attrHandle (const char *theName, DtObjectClassHandle whichClass, bool throwException=true)
	Get attribute handle from name.
virtual const char *	attrName (DtAttributeHandle theHandle, DtObjectClassHandle whichClass, bool throwException=true)
	Get attribute name from handle Returns pointer to internal memory.
virtual DtObjectClassInfo *	classByName (const char *name) const
	Returns the class descriptor for the name.
virtual DtObjectClassInfo *	classByHandle (DtObjectClassHandle handle) const
	Returns the class descriptor for the handle.
virtual DtObjectClassInfo *	objectRootClass () const
	Returns the root object class descriptor.
virtual DtObjectClassHandle	objectRootHandle () const
	Returns the handle of the root object.
virtual int	numClasses () const
	Get the number of classes.
virtual void	addClassHdlForUnknownClass (DtObjectClassHandle handle, DtObjectClassHandle baseClassHandle)
	Adds a known class handle for which we have no other information other than its base class.
virtual DtInteractionClassInfo *	interactionByName (const char *name) const
	Returns the class descriptor for the name.
virtual DtInteractionClassInfo *	interactionByHandle (DtInteractionClassHandle handle) const
	Returns the class descriptor for the handle.
virtual DtInteractionClassInfo *	interactionRootClass () const
	Returns the root interaction class descriptor.
virtual DtInteractionClassHandle	interactionRootHandle () const
	Returns the handle of the root interaction.
virtual DtInteractionClassHandle	interactionHandle (const char *theName, bool throwException=true)
	Get class handle from name.
virtual const char *	interactionName (DtInteractionClassHandle theHandle, bool throwException=true)
	Get class name from handle.
virtual DtParameterHandle	paramHandle (const char *theName, DtInteractionClassHandle whichClass, bool throwException=true)
	Get parameter handle from name.
virtual const char *	paramName (DtParameterHandle theHandle, DtInteractionClassHandle whichClass, bool throwException=true)
	Get parameter name from handle Returns pointer to internal memory.
virtual int	numInteractions () const
	Get num interactions.
virtual void	addInteractionHdlForUnknownClass (DtInteractionClassHandle handle, DtInteractionClassHandle baseClassHandle)
	Adds a known class handle for which we have no other information other than its base class.
virtual void	initDMFilteringParameters (const DtRIDParameters *params)
	DM Filtering.
virtual void	printDMSubscriptions ()
virtual bool	save (DtRtiSaveFile &file)
	save and restore
virtual void	prepareToRestore ()
	Prepare the state information to be restored (i.e., clear out existing data).
virtual bool	restore (DtRtiSaveFile &file)
	Restore the state information from the given file.
virtual void	setExtend13and1516interop (bool enable)
	set/get 1.3 and 1516 interoperability status
virtual bool	extend13and1516interop () const
virtual void	print () const
	Print the contents.
virtual DtFomClassMgr *	clone ()
	Return a copy of this instance.
virtual void	setDistributor (DtSynchronousFileDistributor *distributor)
	Adding the distributor so we can take FOMs from it.
virtual DtSynchronousFileDistributor *	distributor () const
virtual void	setConveyRegionDesignatorSets (bool value)
	switches
virtual void	addFedFileName (const MAKRti::DtString &name)
virtual const std::vector < MAKRti::DtString > &	fedFiles () const

Static Public Member Functions
static DtFomClassMgr *	create (DtRIDParameters *p)
	Creates an instance of a DtFomClassMgr.
static void	setCreatorFunction (DtFomClassMgrCreator fn)
	Call this function to set an alternate creator function With this function, users can replace this DtFomClassMgr with their own derived class.

Public Attributes
unsigned long	myCrc
	This is 0 by default.

Protected Member Functions
	DtFomClassMgr (DtRIDParameters *params)
	Constructor - used by create.
	DtFomClassMgr ()
	Constructor - must use create instead.
DtFomClassMgr &	operator= (const DtFomClassMgr &orig)
	assignment operator (not implemented)
void	init ()
virtual DtInteractionClassInfo *	addInterClassSorted (const char *name, const char *baseName, MAKRti::DtTransportType transport, MAKRti::DtOrderType order, DtSpaceHandle spaceH, DtInteractionClassInfo *baseClass, DtSharingType sharing, const MAKRti::DtString &semantics)
	Add a new interaction class with sorted or unsorted (deprecated) handles.
virtual DtInteractionClassInfo *	addInterClassUnsorted (const char *name, const char *baseName, MAKRti::DtTransportType transport, MAKRti::DtOrderType order, DtSpaceHandle spaceH, DtInteractionClassInfo *baseClass, DtSharingType sharing, const MAKRti::DtString &semantics)
virtual DtObjectClassInfo *	addObjClassSorted (const char *name, const char *baseName, DtSharingType sharing, const MAKRti::DtString &semantics, DtObjectClassInfo *baseClass)
	Add a new object class with sorted or unsorted (deprecated) handles.
virtual DtObjectClassInfo *	addObjClassUnsorted (const char *name, const char *baseName, DtSharingType sharing, const MAKRti::DtString &semantics, DtObjectClassInfo *baseClass)
virtual bool	objectClassPresent (const char *name, unsigned int startIndex=0, unsigned int endIndex=0) const
	Helper function for insertion and merging.
virtual bool	attrPresent (const char *name, DtObjectClassInfo *classInfo, unsigned int startIndex=0, unsigned int endIndex=0) const
virtual bool	interactionClassPresent (const char *name, unsigned int startIndex=0, unsigned int endIndex=0) const
virtual unsigned int	objectClassPosition (const char *name, unsigned int startIndex=0, unsigned int endIndex=0) const
	Helper function for insertion and merging. Where should class be inserted.
virtual unsigned int	interactionClassPosition (const char *name, unsigned int startIndex=0, unsigned int endIndex=0) const
virtual bool	resolveAttributeDimensions (MAKRti::DtString &errorString, bool &fomReadError)
virtual bool	resolveInteractionDimensions (MAKRti::DtString &errorString, bool &fomReadError)
virtual bool	resolveAttributeTransportations (MAKRti::DtString &errorString, bool &fomReadError)
virtual bool	resolveInteractionTransportations (MAKRti::DtString &errorString, bool &fomReadError)
virtual bool	resolveObjectClasses (MAKRti::DtString &errorString, bool &fomReadError)
virtual bool	resolveInteractionClasses (MAKRti::DtString &errorString, bool &fomReadError)
virtual bool	resolveAttributes (MAKRti::DtString &errorString, bool &fomReadError)
virtual bool	resolveParameters (MAKRti::DtString &errorString, bool &fomReadError)
virtual bool	resolveDimensions (MAKRti::DtString &errorString, bool &fomReadError)
virtual void	addAttrInfoToChildren (DtObjectClassInfo *classDesc, const MAKRti::DtString &attributeName, DtDimensionHandle dimensionHandle)

Protected Attributes
DtObjectClassVector	myClasses
	Object classes.
int	myFirstMomObjectHandle
	First object class handle of MOM objects.
DtInteractionClassVector	myInteractions
	Interaction classes.
int	myFirstMomInteractionHandle
	First interaction class handle of MOM interactions.
bool	my13and1516interop
	Indicates that 13 and 1516 interoperability is enabled.
bool	myEnableFomBackwardsCompatibility
	Indicates that backwards compatibility is enabled.
bool	myMergingEnabled
	Indicates if FOM Module Merging is enabled.
DtSynchronousFileDistributor *	myDistributor
std::vector< MAKRti::DtString >	myFedFiles
bool	myOverrideConveyRegions
	RID file specifies to override the FOM convey regions switch.
DtObjectClassHandle	myMutableLastObjClassLookup
	Cached value for the last object class lookup.
DtInteractionClassHandle	myMutableLastInterClassLookup
	Cached value for the last interaction class lookup.

Static Protected Attributes
static DtFomClassMgrCreator	theCreator = 0
	Creator function creates instance of this class or subclass.

Constructor & Destructor Documentation

DtFomClassMgr::DtFomClassMgr ( DtRIDParameters *  params )

protected

Constructor - used by create.

References DtRIDParameters::attributeRelevanceAdvisorySwitch, DtRIDParameters::autoProvideSwitch, DtRIDParameters::conveyProducingFederateSwitch, DtRIDParameters::exceptionReportingSwitch, init(), DtRIDParameters::interactionRelevanceAdvisorySwitch, myOverrideConveyRegions, setConveyRegionDesignatorSets(), and DtRIDParameters::strictFomChecking.

DtFomClassMgr::DtFomClassMgr ( )

protected

Constructor - must use create instead.

References init().

Referenced by clone(), and create().

DtFomClassMgr::DtFomClassMgr

(

const DtFomClassMgr &

orig

)

Copy Constructor - must use clone instead.

References myClasses, and myInteractions.

DtFomClassMgr::~DtFomClassMgr ( )

virtual

Destructor.

References DtDeleteVectorOfPointers(), myClasses, and myInteractions.

Member Function Documentation

void DtFomClassMgr::addAttribute ( const char *  className, const char *  attrName, MAKRti::DtTransportType  transport, MAKRti::DtOrderType  order, DtSharingType  sharing, DtFomUpdateType  updateType, const MAKRti::DtString &  updateCondition, DtOwnershipType  ownershipType, const MAKRti::DtString &  semantics, const char *  spaceName = NULL  )

virtual

Define an attribute of a class.

Used when initializing from FED file.

References DtObjectClassInfo::addAttr(), addAttributeDimension(), classByName(), DtDefaultSpaceHandle, DtFomUpdateTypeNA, DtOwnershipTypeNoTransfer, extend13and1516interop(), DtObjectClassInfo::handle(), myEnableFomBackwardsCompatibility, DtAttrInfo::nameIsPrivilegeToDelete(), DtObjectClassInfo::numAttributes(), and theObjectRootHandle.

Referenced by addAttribute().

void DtFomClassMgr::addAttribute ( const char *  className, const char *  attrName, MAKRti::DtTransportType  transport, MAKRti::DtOrderType  order, const char *  spaceName = NULL  )

virtual

References addAttribute(), DtFomUpdateTypeNA, DtOwnershipTypeNoTransfer, and DtSharingTypePublishSubscribe.

bool DtFomClassMgr::addAttributeDimension ( const char *  className, const char *  attrName, const char *  dimName  )

virtual

Define the dimensions of an attribute Return true if add was successful (i.e., dimension is valid)

References DtAttrInfo::addDimension(), DtObjectClassInfo::attrByName(), classByName(), DtGlobalSpaceHandle, DtInvalidHandle, and myMergingEnabled.

Referenced by addAttribute().

void DtFomClassMgr::addAttrInfoToChildren ( DtObjectClassInfo *  classDesc, const MAKRti::DtString &  attributeName, DtDimensionHandle  dimensionHandle  )

protectedvirtual

References DtAttrInfo::addDimension(), DtObjectClassInfo::attrByName(), and DtObjectClassInfo::subclasses().

Referenced by resolveAttributeDimensions().

void DtFomClassMgr::addClassHdlForUnknownClass ( DtObjectClassHandle  handle, DtObjectClassHandle  baseClassHandle  )

virtual

Adds a known class handle for which we have no other information other than its base class.

This is necessary with FOM module merging. We may not have full information about modules added to the federation after we joined, but we need to know if those classes are subclasses of the classes we are subscribed to. Will not add info for classes which are already known.

References addObjClassUnsorted(), classByHandle(), DtObjectClassInfo::name(), DtObjectClassInfo::setDiscoveredHandle(), DtObjectClassInfo::setIsUnknown(), and DtObjectClassInfo::sharing().

Referenced by DtRtiExecFederateMgr::processNewFomClasses().

void DtFomClassMgr::addDimension ( const char *  spaceName, const char *  dimName  )

virtual

Define a dimension within a routing space.

Used when initializing from FED file.

References extend13and1516interop(), and my13and1516interop.

virtual void DtFomClassMgr::addDimension ( const char *  dimName, unsigned long  upperBound, unsigned long  defaultLowerBound, unsigned long  defaultUpperBound, bool  excluded, const MAKRti::DtString &  normalization  )

virtual

Define a dimension. Used when initializing from FED file.

void DtFomClassMgr::addFedFileName ( const MAKRti::DtString &  name )

virtual

References myFedFiles.

Referenced by DtRtiExecFederateMgr::mergeFomModules().

bool DtFomClassMgr::addInteractionDimension ( const char *  interactionName, const char *  dimension  )

virtual

Add regions to the class Return true if add was successful (i.e., dimension is valid)

References DtInteractionClassInfo::addDimension(), DtGlobalSpaceHandle, DtInvalidHandle, interactionByName(), and myMergingEnabled.

Referenced by addInterClass().

void DtFomClassMgr::addInteractionHdlForUnknownClass ( DtInteractionClassHandle  handle, DtInteractionClassHandle  baseClassHandle  )

virtual

Adds a known class handle for which we have no other information other than its base class.

This is necessary with FOM module merging. We may not have full information about modules added to the federation after we joined, but we need to know if those classes are subclasses of the classes we are subscribed to. Will not add info for classes which are already known.

References addInterClassUnsorted(), DtDefaultSpaceHandle, interactionByHandle(), DtInteractionClassInfo::name(), DtInteractionClassInfo::order(), DtInteractionClassInfo::setDiscoveredHandle(), DtInteractionClassInfo::setIsUnknown(), DtInteractionClassInfo::sharing(), and DtInteractionClassInfo::transport().

Referenced by DtRtiExecFederateMgr::processNewFomClasses().

bool DtFomClassMgr::addInterClass ( const char *  name, const char *  baseName, MAKRti::DtTransportType  transport, MAKRti::DtOrderType  order, DtSharingType  sharing, const MAKRti::DtString &  semantics, const char *  space = NULL  )

virtual

Define a class. Used when initializing from FED file.

References addInteractionDimension(), addInterClassSorted(), addInterClassUnsorted(), DtDefaultSpaceHandle, extend13and1516interop(), interactionByName(), myEnableFomBackwardsCompatibility, and NULL.

Referenced by addInterClass(), addTestToFom(), and mergeInteractionInfo().

bool DtFomClassMgr::addInterClass ( const char *  name, const char *  baseName, MAKRti::DtTransportType  transport, MAKRti::DtOrderType  order, const char *  spaceName = NULL  )

virtual

References addInterClass(), and DtSharingTypePublishSubscribe.

DtInteractionClassInfo * DtFomClassMgr::addInterClassSorted ( const char *  name, const char *  baseName, MAKRti::DtTransportType  transport, MAKRti::DtOrderType  order, DtSpaceHandle  spaceH, DtInteractionClassInfo *  baseClass, DtSharingType  sharing, const MAKRti::DtString &  semantics  )

protectedvirtual

Add a new interaction class with sorted or unsorted (deprecated) handles.

References interactionClassPosition(), interactionClassPresent(), myFirstMomInteractionHandle, myInteractions, myMutableLastInterClassLookup, DtInteractionClassInfo::setFomType(), DtInteractionClassInfo::setHandle(), DtInteractionClassInfo::setOrder(), DtInteractionClassInfo::setSpaceHandle(), and DtInteractionClassInfo::setTransport().

Referenced by addInterClass().

DtInteractionClassInfo * DtFomClassMgr::addInterClassUnsorted ( const char *  name, const char *  baseName, MAKRti::DtTransportType  transport, MAKRti::DtOrderType  order, DtSpaceHandle  spaceH, DtInteractionClassInfo *  baseClass, DtSharingType  sharing, const MAKRti::DtString &  semantics  )

protectedvirtual

References myInteractions, myMutableLastInterClassLookup, DtInteractionClassInfo::setFomType(), and DtInteractionClassInfo::setSpaceHandle().

Referenced by addInteractionHdlForUnknownClass(), and addInterClass().

bool DtFomClassMgr::addObjClass ( const char *  name, const char *  baseName, DtSharingType  sharing, const MAKRti::DtString &  semantics  )

virtual

References DtObjectClassInfo::addAttr(), addObjClassSorted(), addObjClassUnsorted(), DtObjectClassInfo::baseClass(), classByName(), DtFomUpdateTypeNA, DtOwnershipTypeDivestAcquire, myEnableFomBackwardsCompatibility, NULL, DtObjectClassInfo::numAttributes(), and DtAttrInfo::privilegeToDeleteName().

Referenced by addObjClass(), and mergeObjectInfo().

bool DtFomClassMgr::addObjClass ( const char *  name, const char *  baseName  )

virtual

Define a class. Used when initializing from FED file.

References addObjClass(), and DtSharingTypePublishSubscribe.

DtObjectClassInfo * DtFomClassMgr::addObjClassSorted ( const char *  name, const char *  baseName, DtSharingType  sharing, const MAKRti::DtString &  semantics, DtObjectClassInfo *  baseClass  )

protectedvirtual

Add a new object class with sorted or unsorted (deprecated) handles.

References myClasses, myFirstMomObjectHandle, objectClassPosition(), objectClassPresent(), and DtObjectClassInfo::setFomType().

Referenced by addObjClass().

DtObjectClassInfo * DtFomClassMgr::addObjClassUnsorted ( const char *  name, const char *  baseName, DtSharingType  sharing, const MAKRti::DtString &  semantics, DtObjectClassInfo *  baseClass  )

protectedvirtual

References myClasses, and DtObjectClassInfo::setFomType().

Referenced by addClassHdlForUnknownClass(), and addObjClass().

void DtFomClassMgr::addParameter ( const char *  className, const char *  paramName  )

virtual

Referenced by addTestToFom().

void DtFomClassMgr::addParameter ( const char *  className, const char *  paramName, const char *  semantics  )

virtual

Define an parameter of a class.

Used when initializing from FED file.

References DtInteractionClassInfo::addParam(), interactionByName(), and myEnableFomBackwardsCompatibility.

void DtFomClassMgr::addSpace ( const char *  name )

virtual

FED file loading functions.

Define a routing space. Used when initializing from FED file.

References myEnableFomBackwardsCompatibility.

Referenced by mergeDimensions().

DtAttributeHandle DtFomClassMgr::attrHandle ( const char *  theName, DtObjectClassHandle  whichClass, bool  throwException = true  )

virtual

Get attribute handle from name.

References DtObjectClassInfo::attrHandle(), classByHandle(), and DtInvalidHandle.

const char * DtFomClassMgr::attrName ( DtAttributeHandle  theHandle, DtObjectClassHandle  whichClass, bool  throwException = true  )

virtual

Get attribute name from handle Returns pointer to internal memory.

References DtObjectClassInfo::attrName(), and classByHandle().

bool DtFomClassMgr::attrPresent ( const char *  name, DtObjectClassInfo *  classInfo, unsigned int  startIndex = 0, unsigned int  endIndex = 0  ) const

protectedvirtual

References DtObjectClassInfo::attrs(), and DtAttrInfo::name().

DtObjectClassInfo * DtFomClassMgr::classByHandle ( DtObjectClassHandle  handle ) const

virtual

Returns the class descriptor for the handle.

References myClasses.

Referenced by DtRtiObject::acquireRemoteSubscriptions(), addClassHdlForUnknownClass(), DtObjectMgr::addPendingRegister(), attrHandle(), attrName(), className(), DtRtiObject::decode(), DtNetStatsMonitor::gatherClassDataAndSend(), DtObjectMgr::processGiveToLrc(), DtObjectMgr::processMultiRegister(), DtObjectMgr::processNewObj(), DtObjectMgr::processPub(), DtObjectMgr::processRegister(), DtObjectMgr::processResign(), DtObjectMgr::processSub(), DtObjectMgr::processUnsub(), DtObjectMgr::processUpdate(), DtObjectMgr::publish(), DtObjectMgr::published(), DtObjectMgr::registerObj(), DtObjectMgr::requestClassUpdate(), DtNetStatsMonitor::sendAttributeState(), DtObjectMgr::sendPendingStopReg(), DtObjectMgr::sendPendingSubscription(), DtObjectMgr::setDiscoveredClass(), DtObjectMgr::subscribe(), DtObjectMgr::subscribed(), DtObjectMgr::unpublishAttributes(), DtObjectMgr::unpublishClass(), DtObjectMgr::unsubscribeAttributes(), and DtObjectMgr::unsubscribeClass().

DtObjectClassInfo * DtFomClassMgr::classByName ( const char *  name ) const

virtual

Returns the class descriptor for the name.

References myClasses, and myMutableLastObjClassLookup.

Referenced by addAttribute(), addAttributeDimension(), addObjClass(), classHandle(), initDMFilteringParameters(), initUpdateRates(), mergeAttributes(), mergeObjectInfo(), resolveAttributeDimensions(), and resolveAttributeTransportations().

DtObjectClassHandle DtFomClassMgr::classHandle ( const char *  theName, bool  throwException = true  )

virtual

Querying functions.

Get class handle from name

References classByName(), DtInvalidHandle, and DtObjectClassInfo::handle().

const char * DtFomClassMgr::className ( DtObjectClassHandle  theHandle, bool  throwException = true  )

virtual

Get class name from handle.

Returns pointer to internal memory.

References classByHandle(), and DtObjectClassInfo::name().

Referenced by DtNetStatsMonitor::addDiscoveredObject(), DtNetStatsMonitor::addRegisteredObject(), resolveAttributeDimensions(), and resolveAttributeTransportations().

DtFomClassMgr * DtFomClassMgr::clone ( )

virtual

Return a copy of this instance.

References DtFomClassMgr().

Referenced by DtSimpleFederateMgr::mergeFomModules(), DtRtiExecFederateMgr::mergeFomModules(), DtFedExec::processJoin(), and DtFederateMgr::readFedFile().

DtFomClassMgr * DtFomClassMgr::create ( DtRIDParameters *  p )

static

Creates an instance of a DtFomClassMgr.

References DtFomClassMgr(), and theCreator.

Referenced by DtFedExec::processCreateReady(), DtFedExec::processJoin(), setCreatorFunction(), DtFederateMgr::testReadFedFile(), and DtRtiExecFederateMgr::testReadFomModules().

DtSynchronousFileDistributor * DtFomClassMgr::distributor ( ) const

virtual

References myDistributor.

Referenced by setDistributor().

bool DtFomClassMgr::extend13and1516interop ( ) const

virtual

References my13and1516interop.

Referenced by addAttribute(), addDimension(), and addInterClass().

const std::vector< MAKRti::DtString > & DtFomClassMgr::fedFiles ( ) const

virtual

References myFedFiles.

const MAKRti::DtUpdateRateSetT & DtFomClassMgr::getUpdateRates

(

)

const

Get a set of the update Rates.

void DtFomClassMgr::init ( )

protected

References DtDefaultSpaceHandle, DtGlobalSpaceHandle, my13and1516interop, and myEnableFomBackwardsCompatibility.

Referenced by DtFomClassMgr().

void DtFomClassMgr::initDMFilteringParameters ( const DtRIDParameters *  params )

virtual

DM Filtering.

References DtDMFilterStruct::address, classByName(), DtDMFilterStruct::className, DtRIDParameters::destAddr(), DtInteractionClassInfo::destinationAddress(), DtObjectClassInfo::destinationAddress(), DtInteractionClassInfo::destinationDevice(), DtObjectClassInfo::destinationDevice(), DtDMFilterStruct::devAddress, DtDMFilterStruct::inclusive, interactionByName(), DtRIDParameters::interactionMulticastDefinitions(), interactionRootClass(), DtRIDParameters::networkInterfaceAddr(), DtRIDParameters::objectMulticastDefinitions(), objectRootClass(), printDMSubscriptions(), DtInteractionClassInfo::setDestination(), DtObjectClassInfo::setDestination(), and DtRIDParameters::useDMFiltering().

void DtFomClassMgr::initUpdateRates ( DtRIDParameters *  params )

virtual

References classByName(), DtRIDParameters::enableUpdateRateReduction, knownUpdateRate(), DtAssistantPopupHelper::popupAssistantMessage(), DtObjectClassInfo::setSubscribedRate(), updateRateByName(), DtRIDParameters::updateRates(), and DtRIDParameters::updateRateSubscriptions().

DtInteractionClassInfo * DtFomClassMgr::interactionByHandle ( DtInteractionClassHandle  handle ) const

virtual

Returns the class descriptor for the handle.

References myInteractions.

Referenced by addInteractionHdlForUnknownClass(), DtInteractionMgr::evaluateSubscription(), DtNetStatsMonitor::gatherClassDataAndSend(), DtInteractionMgr::getTransport(), interactionName(), DtInteractionMgr::localAddrMap(), paramHandle(), paramName(), DtInteractionMgr::processInteraction(), DtInteractionMgr::processPub(), DtInteractionMgr::processResign(), DtInteractionMgr::processSub(), DtInteractionMgr::processUnsub(), DtInteractionMgr::publish(), DtInteractionMgr::published(), DtNetStatsMonitor::recordInteractionStats(), DtInteractionMgr::send(), DtInteractionMgr::sendInteractionMsg(), DtNetStatsMonitor::sendParameterState(), DtInteractionMgr::setOrder(), DtInteractionMgr::setTransport(), DtInteractionMgr::subscribe(), DtInteractionMgr::unpublish(), and DtInteractionMgr::unsubscribe().

DtInteractionClassInfo * DtFomClassMgr::interactionByName ( const char *  name ) const

virtual

Returns the class descriptor for the name.

References myInteractions, and myMutableLastInterClassLookup.

Referenced by addInteractionDimension(), addInterClass(), addParameter(), addTestToFom(), DtTestInteraction::DtTestInteraction(), initDMFilteringParameters(), interactionHandle(), mergeInteractionInfo(), mergeParameters(), resolveInteractionDimensions(), and resolveInteractionTransportations().

unsigned int DtFomClassMgr::interactionClassPosition ( const char *  name, unsigned int  startIndex = 0, unsigned int  endIndex = 0  ) const

protectedvirtual

References myInteractions, and DtInteractionClassInfo::name().

Referenced by addInterClassSorted().

bool DtFomClassMgr::interactionClassPresent ( const char *  name, unsigned int  startIndex = 0, unsigned int  endIndex = 0  ) const

protectedvirtual

References myInteractions, and DtInteractionClassInfo::name().

Referenced by addInterClassSorted().

DtInteractionClassHandle DtFomClassMgr::interactionHandle ( const char *  theName, bool  throwException = true  )

virtual

Get class handle from name.

References DtInvalidHandle, DtInteractionClassInfo::handle(), and interactionByName().

const char * DtFomClassMgr::interactionName ( DtInteractionClassHandle  theHandle, bool  throwException = true  )

virtual

Get class name from handle.

Returns pointer to internal memory.

References interactionByHandle(), and DtInteractionClassInfo::name().

Referenced by DtNetStatsMonitor::addRecvdInteraction(), DtNetStatsMonitor::addSentInteraction(), DtNetStatsMonitor::recordInteractionStats(), resolveInteractionDimensions(), and resolveInteractionTransportations().

DtInteractionClassInfo * DtFomClassMgr::interactionRootClass ( ) const

virtual

Returns the root interaction class descriptor.

References myInteractions, and theInteractionRootHandle.

Referenced by addTestToFom(), DtNetStatsMonitor::createSerializedTreesAndSend(), initDMFilteringParameters(), DtNetStatsMonitor::sendInitParamState(), and DtNetStatsMonitor::sendParameterNames().

DtInteractionClassHandle DtFomClassMgr::interactionRootHandle ( ) const

virtual

Returns the handle of the root interaction.

References theInteractionRootHandle.

bool DtFomClassMgr::knownUpdateRate

(

const MAKRti::DtString &

rateName

)

const

Check to see if an update rate with this name exists.

Referenced by initUpdateRates().

void DtFomClassMgr::mergeAttributes ( DtObjectClassInfo const &  classInfo, DtFomClassMgr const &  module  )

virtual

Merge the attributes of the given class into the same class in this FOM.

References DtObjectClassInfo::addAttr(), DtAttrInfo::addDimension(), DtObjectClassInfo::attrByName(), DtObjectClassInfo::attrs(), classByName(), DtAttrInfo::dimensions(), myEnableFomBackwardsCompatibility, DtAttrInfo::name(), DtObjectClassInfo::name(), DtAttrInfo::order(), DtAttrInfo::ownershipType(), DtAttrInfo::semantics(), DtAttrInfo::sharingType(), DtAttrInfo::space(), DtAttrInfo::transport(), DtAttrInfo::updateCondition(), and DtAttrInfo::updateType().

Referenced by mergeObjectClasses().

DtMergeFomStatus DtFomClassMgr::mergeDimensions ( DtSpaceInfo const &  spaceInfo )

virtual

Merge the given dimensions into the same space in this FOM.

References addSpace(), DtMergeFomStatusFailedDimensions, DtMergeFomStatusSuccess, and my13and1516interop.

Referenced by mergeSpaces().

DtMergeFomStatus DtFomClassMgr::mergeInteractionClasses ( DtFedTarget const &  module )

virtual

Merge the contents of the specified interactionClasses with this.

References DtMergeFomStatusAlreadyPresentSuccess, DtMergeFomStatusSuccess, mergeInteractionInfo(), mergeParameters(), myInteractions, and DtInteractionClassInfo::spaceHandle().

DtMergeFomStatus DtFomClassMgr::mergeInteractionInfo ( DtInteractionClassInfo const &  interInfo, const char *  spaceName = 0  )

virtual

Merge the contents of the specified InteractionInfo with this.

References addInterClass(), DtInteractionClassInfo::baseClass(), DtInteractionClassInfo::dimensions(), DtMergeFomStatusAlreadyPresentSuccess, DtMergeFomStatusFailedInteractionClass, DtMergeFomStatusFailedScaffolding, DtMergeFomStatusSuccess, interactionByName(), DtInteractionClassInfo::isScaffolding(), DtInteractionClassInfo::name(), DtInteractionClassInfo::order(), DtInteractionClassInfo::sameAncestry(), DtInteractionClassInfo::semantics(), DtInteractionClassInfo::setDimensions(), DtInteractionClassInfo::setTransport(), DtInteractionClassInfo::sharing(), and DtInteractionClassInfo::transport().

Referenced by mergeInteractionClasses().

DtMergeFomStatus DtFomClassMgr::mergeObjectClasses ( DtFedTarget const &  module )

virtual

Merge the contents of the specified FomMgr with this.

References DtMergeFomStatusAlreadyPresentSuccess, DtMergeFomStatusSuccess, mergeAttributes(), mergeObjectInfo(), and myClasses.

DtMergeFomStatus DtFomClassMgr::mergeObjectInfo ( DtObjectClassInfo const &  classInfo )

virtual

Merge the contents of the specified objectClass with this.

References addObjClass(), DtObjectClassInfo::baseClass(), classByName(), DtMergeFomStatusAlreadyPresentSuccess, DtMergeFomStatusFailedObjectClass, DtMergeFomStatusFailedScaffolding, DtMergeFomStatusSuccess, DtObjectClassInfo::isScaffolding(), DtObjectClassInfo::name(), DtObjectClassInfo::sameAncestry(), DtObjectClassInfo::semantics(), and DtObjectClassInfo::sharing().

Referenced by mergeObjectClasses().

void DtFomClassMgr::mergeParameters ( DtInteractionClassInfo const &  interInfo )

virtual

Merge the given interaction parameters into the same class in this FOM.

References DtInteractionClassInfo::addParam(), interactionByName(), myEnableFomBackwardsCompatibility, DtParamInfo::name(), DtInteractionClassInfo::name(), DtInteractionClassInfo::paramByName(), DtInteractionClassInfo::params(), and DtParamInfo::semantics().

Referenced by mergeInteractionClasses().

DtMergeFomStatus DtFomClassMgr::mergeSpaces ( DtFedTarget const &  module )

virtual

Merge the given routing spaces with this.

References DtMergeFomStatusSuccess, and mergeDimensions().

DtMergeFomStatus DtFomClassMgr::mergeSwitches ( DtFedTarget const &  module )

virtual

Merge the given switches with this.

References DtMergeFomStatusFailedSwitches, DtMergeFomStatusSuccess, and setConveyRegionDesignatorSets().

int DtFomClassMgr::numClasses ( ) const

virtual

Get the number of classes.

References myClasses.

Referenced by DtNetStatsMonitor::createSerializedTreesAndSend(), DtNetStatsMonitor::gatherClassDataAndSend(), DtFedExec::processJoin(), and DtObjectMgr::processResign().

int DtFomClassMgr::numInteractions ( ) const

virtual

Get num interactions.

References myInteractions.

Referenced by DtNetStatsMonitor::createSerializedTreesAndSend(), DtNetStatsMonitor::gatherClassDataAndSend(), DtFedExec::processJoin(), and DtInteractionMgr::processResign().

unsigned int DtFomClassMgr::objectClassPosition ( const char *  name, unsigned int  startIndex = 0, unsigned int  endIndex = 0  ) const

protectedvirtual

Helper function for insertion and merging. Where should class be inserted.

References myClasses, and DtObjectClassInfo::name().

Referenced by addObjClassSorted().

bool DtFomClassMgr::objectClassPresent ( const char *  name, unsigned int  startIndex = 0, unsigned int  endIndex = 0  ) const

protectedvirtual

Helper function for insertion and merging.

.Check for presence of name between start and end Index.

References myClasses, and DtObjectClassInfo::name().

Referenced by addObjClassSorted().

DtObjectClassInfo * DtFomClassMgr::objectRootClass ( ) const

virtual

Returns the root object class descriptor.

References myClasses, and theObjectRootHandle.

Referenced by DtNetStatsMonitor::createSerializedTreesAndSend(), initDMFilteringParameters(), DtNetStatsMonitor::sendAttributeNames(), and DtNetStatsMonitor::sendInitAttrState().

DtObjectClassHandle DtFomClassMgr::objectRootHandle ( ) const

virtual

Returns the handle of the root object.

References theObjectRootHandle.

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

protected

assignment operator (not implemented)

DtParameterHandle DtFomClassMgr::paramHandle ( const char *  theName, DtInteractionClassHandle  whichClass, bool  throwException = true  )

virtual

Get parameter handle from name.

References DtInvalidHandle, interactionByHandle(), and DtInteractionClassInfo::paramHandle().

const char * DtFomClassMgr::paramName ( DtParameterHandle  theHandle, DtInteractionClassHandle  whichClass, bool  throwException = true  )

virtual

Get parameter name from handle Returns pointer to internal memory.

References interactionByHandle(), and DtInteractionClassInfo::paramName().

int DtFomClassMgr::positionOfRate

(

float

rate

)

const

Get the position of this rate (sorted ascending).

First position is 1 and 0 indicates rate not found.

Referenced by DtObjectMgr::addClassMulticast(), and DtObjectMgr::removeClassMulticast().

void DtFomClassMgr::prepareToRestore ( )

virtual

Prepare the state information to be restored (i.e., clear out existing data).

Referenced by DtRtiExecFederateMgr::prepareToRestoreLRC().

void DtFomClassMgr::print ( ) const

virtual

Print the contents.

References myClasses, and myInteractions.

void DtFomClassMgr::printDMSubscriptions ( )

virtual

References myClasses, and myInteractions.

Referenced by initDMFilteringParameters().

bool DtFomClassMgr::resolveAttributeDimensions ( MAKRti::DtString &  errorString, bool &  fomReadError  )

protectedvirtual

References addAttrInfoToChildren(), DtAttrInfo::addDimension(), DtObjectClassInfo::attrByName(), classByName(), className(), DtGlobalSpaceHandle, and DtInvalidHandle.

Referenced by resolveAttributes().

bool DtFomClassMgr::resolveAttributes ( MAKRti::DtString &  errorString, bool &  fomReadError  )

protectedvirtual

References DtInvalidHandle, myClasses, resolveAttributeDimensions(), and resolveAttributeTransportations().

bool DtFomClassMgr::resolveAttributeTransportations ( MAKRti::DtString &  errorString, bool &  fomReadError  )

protectedvirtual

References DtObjectClassInfo::attrByName(), classByName(), className(), and DtAttrInfo::setTransport().

Referenced by resolveAttributes().

bool DtFomClassMgr::resolveDimensions ( MAKRti::DtString &  errorString, bool &  fomReadError  )

protectedvirtual

bool DtFomClassMgr::resolveInteractionClasses ( MAKRti::DtString &  errorString, bool &  fomReadError  )

protectedvirtual

References myInteractions, resolveInteractionDimensions(), and resolveInteractionTransportations().

bool DtFomClassMgr::resolveInteractionDimensions ( MAKRti::DtString &  errorString, bool &  fomReadError  )

protectedvirtual

References DtInteractionClassInfo::addDimension(), DtGlobalSpaceHandle, DtInvalidHandle, interactionByName(), and interactionName().

Referenced by resolveInteractionClasses().

bool DtFomClassMgr::resolveInteractionTransportations ( MAKRti::DtString &  errorString, bool &  fomReadError  )

protectedvirtual

References interactionByName(), interactionName(), and DtInteractionClassInfo::setTransport().

Referenced by resolveInteractionClasses().

bool DtFomClassMgr::resolveObjectClasses ( MAKRti::DtString &  errorString, bool &  fomReadError  )

protectedvirtual

References myClasses.

bool DtFomClassMgr::resolveParameters ( MAKRti::DtString &  errorString, bool &  fomReadError  )

protectedvirtual

bool DtFomClassMgr::restore ( DtRtiSaveFile &  file )

virtual

Restore the state information from the given file.

References DtRtiSaveInteractionClassType, DtRtiSaveObjectClassType, DtObjectClassPacket::header, DtInteractionClassPacket::header, myClasses, myInteractions, DtSaveDataHeader::packetType, and DtRtiSaveFile::readNextPacket().

Referenced by DtRtiExecFederateMgr::restoreLRC().

bool DtFomClassMgr::save ( DtRtiSaveFile &  file )

virtual

save and restore

Save the state information to the given file

References myClasses, and myInteractions.

Referenced by DtRtiExecFederateMgr::saveLRC().

void DtFomClassMgr::setConveyRegionDesignatorSets ( bool  value )

virtual

switches

Overrides setConveyRegionDesignatorSets to ensure we are properly respecting the RID file configuration

References myOverrideConveyRegions.

Referenced by DtFomClassMgr(), and mergeSwitches().

void DtFomClassMgr::setCreatorFunction ( DtFomClassMgrCreator  fn )

static

Call this function to set an alternate creator function With this function, users can replace this DtFomClassMgr with their own derived class.

References create(), DtBindCreator(), and theCreator.

void DtFomClassMgr::setDistributor ( DtSynchronousFileDistributor *  distributor )

virtual

Adding the distributor so we can take FOMs from it.

References distributor(), and myDistributor.

Referenced by DtRtiExecFederateMgr::mergeFomModules().

void DtFomClassMgr::setExtend13and1516interop ( bool  enable )

virtual

set/get 1.3 and 1516 interoperability status

References my13and1516interop.

Referenced by DtFedExec::processCreateReady(), DtFedExec::processJoin(), DtFederateMgr::testReadFedFile(), and DtRtiExecFederateMgr::testReadFomModules().

float DtFomClassMgr::updateRateByName

(

const char *

name

)

Get the rate (Float) from an Update rate by its name.

Referenced by initUpdateRates().

Member Data Documentation

bool DtFomClassMgr::my13and1516interop

protected

Indicates that 13 and 1516 interoperability is enabled.

Referenced by addDimension(), extend13and1516interop(), init(), mergeDimensions(), and setExtend13and1516interop().

DtObjectClassVector DtFomClassMgr::myClasses

protected

Object classes.

Referenced by addObjClassSorted(), addObjClassUnsorted(), classByHandle(), classByName(), DtFomClassMgr(), mergeObjectClasses(), numClasses(), objectClassPosition(), objectClassPresent(), objectRootClass(), print(), printDMSubscriptions(), resolveAttributes(), resolveObjectClasses(), restore(), save(), and ~DtFomClassMgr().

unsigned long DtFomClassMgr::myCrc

This is 0 by default.

If its explicitly set, then it will be the CRC of the file read into this DtFomClassMgr. if it is 0, then it could either be a merged file (made up of multiple files, so we don't know the CRC of that) or is just some uninitialized DtFomClassMgr

Referenced by DtFederateMgr::addToParsedFomMap().

DtSynchronousFileDistributor* DtFomClassMgr::myDistributor

protected

Referenced by distributor(), and setDistributor().

bool DtFomClassMgr::myEnableFomBackwardsCompatibility

protected

Indicates that backwards compatibility is enabled.

Referenced by addAttribute(), addInterClass(), addObjClass(), addParameter(), addSpace(), init(), mergeAttributes(), and mergeParameters().

std::vector<MAKRti::DtString> DtFomClassMgr::myFedFiles

protected

Referenced by addFedFileName(), and fedFiles().

int DtFomClassMgr::myFirstMomInteractionHandle

protected

First interaction class handle of MOM interactions.

Referenced by addInterClassSorted().

int DtFomClassMgr::myFirstMomObjectHandle

protected

First object class handle of MOM objects.

Referenced by addObjClassSorted().

DtInteractionClassVector DtFomClassMgr::myInteractions

protected

Interaction classes.

Referenced by addInterClassSorted(), addInterClassUnsorted(), DtFomClassMgr(), interactionByHandle(), interactionByName(), interactionClassPosition(), interactionClassPresent(), interactionRootClass(), mergeInteractionClasses(), numInteractions(), print(), printDMSubscriptions(), resolveInteractionClasses(), restore(), save(), and ~DtFomClassMgr().

bool DtFomClassMgr::myMergingEnabled

protected

Indicates if FOM Module Merging is enabled.

Attribute and Interaction Dimension are changed when merging is enabled.

Referenced by addAttributeDimension(), and addInteractionDimension().

DtInteractionClassHandle DtFomClassMgr::myMutableLastInterClassLookup

mutableprotected

Cached value for the last interaction class lookup.

When merging interactions we sometimes lookup the same class name multiple times.

Referenced by addInterClassSorted(), addInterClassUnsorted(), and interactionByName().

DtObjectClassHandle DtFomClassMgr::myMutableLastObjClassLookup

mutableprotected

Cached value for the last object class lookup.

When merging objects we sometimes lookup the same class name multiple times.

Referenced by classByName().

bool DtFomClassMgr::myOverrideConveyRegions

protected

RID file specifies to override the FOM convey regions switch.

Referenced by DtFomClassMgr(), and setConveyRegionDesignatorSets().

DtFomClassMgrCreator DtFomClassMgr::theCreator = 0

staticprotected

Creator function creates instance of this class or subclass.

Referenced by create(), and setCreatorFunction().

---

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

• fomMgr.h
• fomMgr.cxx