MAK RTIspy API Documentation for HLA 1.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtFomClassMgr Class Reference
+ Inheritance diagram for DtFomClassMgr:
+ Collaboration diagram for DtFomClassMgr:

Public Member Functions

 DtFomClassMgr ()
 Constructor - Do not use this publicly. More...
 
 DtFomClassMgr (const DtFomClassMgr &orig)
 Copy Constructor - must use clone instead. More...
 
virtual ~DtFomClassMgr ()
 Destructor. More...
 
virtual void addSpace (const char *name)
 FED file loading functions. More...
 
virtual void addDimension (const char *spaceName, const char *dimName)
 Define a dimension within a routing space. More...
 
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. More...
 
virtual bool addInteractionDimension (const char *interactionName, const char *dimension)
 Add dimensions to the interaction class Return true if add was successful (i.e., dimension is valid) More...
 
virtual bool addInteractionClass (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. More...
 
virtual bool addInterClass (const char *name, const char *baseName, MAKRti::DtTransportType transport, MAKRti::DtOrderType order, const char *spaceName=NULL)
 
virtual bool addObjectDimension (const char *objectClassName, const char *dimension)
 Add dimension to the object class Return true if add was successful (i.e., dimension is valid) More...
 
virtual bool addObjectClass (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. More...
 
virtual void addHandleForUnknownObjectClass (DtObjectClassHandle handle, DtObjectClassHandle baseClassHandle)
 Adds a known class handle for which we have no other information other than its base class. More...
 
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. More...
 
virtual bool addAttributeDimension (const char *className, const char *attributeName, const char *dimName)
 Define the dimensions of an attribute Return true if add was successful (i.e., dimension is valid) More...
 
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. More...
 
virtual void addAttribute (const char *className, const char *attrName, MAKRti::DtTransportType transport, MAKRti::DtOrderType order, const char *spaceName=NULL)
 
virtual void initUpdateRates (DtRIDParameters *params)
 Initialize the updates rates using the given RID parameters. More...
 
const MAKRti::DtUpdateRateSetT & getUpdateRates () const
 Get a set of the update Rates. More...
 
float updateRateByName (const char *name)
 Get the rate (Float) from an Update rate by its name. More...
 
int positionOfRate (float rate) const
 Get the position of this rate (sorted ascending). More...
 
bool knownUpdateRate (const MAKRti::DtString &rateName) const
 Check to see if an update rate with this name exists. More...
 
virtual DtMergeFomStatus mergeObjectClasses (DtFedTarget const &module)
 Merge the contents of the specified FomMgr with this. More...
 
virtual DtMergeFomStatus mergeObjectInfo (DtObjectClassInfo const &classInfo, DtAttributeByHandleMap &attributesToMerge)
 Merge the contents of the specified objectClass with this. More...
 
virtual void mergeAttributes (DtObjectClassInfo const &classInfo, const DtAttributeByHandleMap &attributesToMerge, DtFomClassMgr const &module)
 Merge the attributes of the given class into the same class in this FOM. More...
 
virtual DtMergeFomStatus mergeInteractionClasses (DtFedTarget const &module)
 Merge the contents of the specified interactionClasses with this. More...
 
virtual DtMergeFomStatus mergeInteractionInfo (DtInteractionClassInfo const &interInfo, const char *spaceName, DtParameterByHandleMap &parametersToMerge)
 Merge the contents of the specified InteractionInfo with this. More...
 
virtual void mergeParameters (DtInteractionClassInfo const &interInfo, const DtParameterByHandleMap &parametersToMerge)
 Merge the given interaction parameters into the same class in this FOM. More...
 
virtual DtMergeFomStatus mergeSpaces (DtFedTarget const &module)
 Merge the given routing spaces with this. More...
 
virtual DtMergeFomStatus mergeDimensions (DtSpaceInfo const &spaceInfo)
 Merge the given dimensions into the same space in this FOM. More...
 
virtual DtObjectClassHandle classHandle (const char *theName, bool throwException=true) const
 Querying functions. More...
 
virtual const char * className (DtObjectClassHandle theHandle, const char *defaultName="ObjectClassNotDefined") const
 Get class name from handle. More...
 
virtual DtObjectClassInfoclassByName (const char *name)
 Returns the class descriptor for the name. More...
 
virtual const DtObjectClassInfoclassByName (const char *name) const
 
virtual DtObjectClassInfoclassByHandle (DtObjectClassHandle handle)
 Returns the class descriptor for the handle. More...
 
virtual const DtObjectClassInfoclassByHandle (DtObjectClassHandle handle) const
 
virtual DtObjectClassInfoobjectRootClass ()
 Returns the root object class descriptor. More...
 
virtual const DtObjectClassInfoobjectRootClass () const
 
virtual DtObjectClassHandle objectRootHandle () const
 Returns the handle of the root object. More...
 
virtual int numClasses () const
 Get the number of classes. More...
 
virtual int firstFomObjectClassHandle ()
 Get the first FOM object class handle (excluding ObjectRoot and MOM); Returns -1 if no FOM object classes exist. More...
 
virtual int lastFomObjectClassHandle ()
 Get the last FOM object handle (excluding ObjectRoot and MOM); Returns -1 if no FOM object classes exist. More...
 
virtual std::set< const
DtObjectClassInfo * > & 
getObjectClassDifferences (const DtFomClassMgr &otherFom, std::set< const DtObjectClassInfo * > &diffSet) const
 Get the object classes from the given FOM that are not in this FOM. More...
 
virtual std::set< const
DtInteractionClassInfo * > & 
getInteractionClassDifferences (const DtFomClassMgr &otherFom, std::set< const DtInteractionClassInfo * > &diffSet) const
 Get the interaction classes from the given FOM that are not in this FOM. More...
 
virtual DtAttributeHandle attrHandle (const char *theName, DtObjectClassHandle whichClass, bool throwException=true) const
 Get attribute handle from name. More...
 
virtual const char * attrName (DtAttributeHandle theHandle, DtObjectClassHandle whichClass, bool throwException=true) const
 Get attribute name from handle Returns pointer to internal memory. More...
 
virtual DtInteractionClassHandle interactionRootHandle () const
 Returns the handle of the root interaction. More...
 
virtual DtInteractionClassHandle interactionHandle (const char *theName, bool throwException=true) const
 Get class handle from name. More...
 
virtual const char * interactionName (DtInteractionClassHandle theHandle, const char *defaultName="InteractionClassNotDefined") const
 Get class name from handle. More...
 
virtual int numInteractions () const
 Get number of interactions. More...
 
virtual int firstFomInteractionClassHandle ()
 Get the first FOM interaction handle (not InteractionRoot nor MOM); Returns -1 if no FOM interactions exist. More...
 
virtual int lastFomInteractionClassHandle ()
 Get the last FOM interaction handle (not InteractionRoot nor MOM); Returns -1 if no FOM interactions exist. More...
 
virtual void addHandleForUnknownInteractionClass (DtInteractionClassHandle handle, DtInteractionClassHandle baseClassHandle)
 Adds a known class handle for which we have no other information other than its base class. More...
 
virtual DtParameterHandle paramHandle (const char *theName, DtInteractionClassHandle whichClass, bool throwException=true)
 Get parameter handle from name. More...
 
virtual const char * paramName (DtParameterHandle theHandle, DtInteractionClassHandle whichClass, bool throwException=true)
 Get parameter name from handle Returns pointer to internal memory. More...
 
virtual void initDMFilteringParameters (const DtRIDParameters *params)
 DM Filtering. More...
 
virtual void printDMSubscriptions ()
 
virtual bool save (DtRtiSaveFile &file)
 save and restore More...
 
virtual void prepareToRestore ()
 Prepare the state information to be restored (i.e., clear out existing data). More...
 
virtual bool restore (DtRtiSaveFile &file)
 Restore the state information from the given file. More...
 
virtual void setExtend13and1516interop (bool enable)
 set/get 1.3 and 1516 interoperability status More...
 
virtual bool extend13and1516interop () const
 
virtual void print () const
 Print the contents. More...
 
virtual DtFomClassMgrclone ()
 Return a copy of this instance. More...
 
virtual void setConveyRegionDesignatorSets (bool value)
 switches More...
 
virtual void addFedFileName (const MAKRti::DtString &name)
 
virtual const
MAKRti::DtNameVector & 
fedFiles () const
 
virtual DtInteractionClassInfointeractionByName (const char *name)
 Returns the class descriptor for the name. More...
 
virtual const
DtInteractionClassInfo
interactionByName (const char *name) const
 Returns the class descriptor for the name. More...
 
virtual DtInteractionClassInfointeractionByHandle (DtInteractionClassHandle handle)
 Returns the class descriptor for the handle. More...
 
virtual const
DtInteractionClassInfo
interactionByHandle (DtInteractionClassHandle handle) const
 Returns the class descriptor for the handle. More...
 
virtual DtInteractionClassInfointeractionRootClass ()
 Returns the root interaction class descriptor. More...
 
virtual const
DtInteractionClassInfo
interactionRootClass () const
 Returns the root interaction class descriptor. More...
 

Static Public Member Functions

static DtFomClassMgrcreate (DtRIDParameters *p)
 Creates an instance of a DtFomClassMgr. More...
 
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. More...
 

Public Attributes

unsigned long myCrc
 This is 0 by default. More...
 

Protected Types

typedef std::map
< DtObjectClassHandle,
DtObjectClassInfo * > 
DtObjectClassByHandleMap
 Maintain classes as a list of pointers that are hierarchically linked. More...
 
typedef std::map
< MAKRti::DtString,
DtObjectClassInfo * > 
DtObjectClassByNameMap
 
typedef std::map
< DtInteractionClassHandle,
DtInteractionClassInfo * > 
DtInteractionClassByHandleMap
 
typedef std::map
< MAKRti::DtString,
DtInteractionClassInfo * > 
DtInteractionClassByNameMap
 

Protected Member Functions

 DtFomClassMgr (DtRIDParameters *params)
 Constructor - used by create. More...
 
DtFomClassMgroperator= (const DtFomClassMgr &orig)
 assignment operator (not implemented) More...
 
void init ()
 
virtual void adjustInteractionHandlesByName (DtInteractionClassInfo *classInfo)
 The given interaction class was just added to the end. More...
 
virtual void adjustObjectHandlesByName (DtObjectClassInfo *classInfo)
 The given object class was just added to the end. More...
 
virtual DtMergeFomStatus mergeObjectDimensions (DtFomClassMgr const &module, DtObjectClassInfo const &objectInfo)
 Merge the dimension from the given object class taken from the given module into the associated interaction in this module. More...
 
virtual DtMergeFomStatus mergeInteractionDimensions (DtFomClassMgr const &module, DtInteractionClassInfo const &interInfo)
 Merge the dimension from the given interaction taken from the given module into the associated interaction in this module. More...
 
virtual void addAttrInfoToChildren (DtObjectClassInfo *classDesc, const MAKRti::DtString &attributeName, DtDimensionHandle dimensionHandle)
 Helper functions for resolving. More...
 
virtual bool componentSortingIsActive () const
 When adding components should they be sorted? More...
 
virtual bool resolveObjectDimensions (MAKRti::DtString &errorString, bool &fomReadError)
 After all the tables have been processed attempt to resolve references to between components that were not fully processed yet. More...
 
virtual bool resolveAttributeDimensions (MAKRti::DtString &errorString, bool &fomReadError)
 After all the tables have been processed attempt to resolve references to between components that were not fully processed yet. More...
 
virtual bool resolveInteractionDimensions (MAKRti::DtString &errorString, bool &fomReadError)
 After all the tables have been processed attempt to resolve references to between components that were not fully processed yet. More...
 
virtual bool resolveAttributeTransportations (MAKRti::DtString &errorString, bool &fomReadError)
 After all the tables have been processed attempt to resolve references to between components that were not fully processed yet. More...
 
virtual bool resolveInteractionTransportations (MAKRti::DtString &errorString, bool &fomReadError)
 After all the tables have been processed attempt to resolve references to between components that were not fully processed yet. More...
 
virtual bool resolveObjectClasses (MAKRti::DtString &errorString, bool &fomReadError)
 After all the tables have been processed attempt to resolve references to between components that were not fully processed yet. More...
 
virtual bool resolveInteractionClasses (MAKRti::DtString &errorString, bool &fomReadError)
 After all the tables have been processed attempt to resolve references to between components that were not fully processed yet. More...
 
virtual bool resolveAttributes (MAKRti::DtString &errorString, bool &fomReadError)
 After all the tables have been processed attempt to resolve references to between components that were not fully processed yet. More...
 
virtual bool resolveParameters (MAKRti::DtString &errorString, bool &fomReadError)
 After all the tables have been processed attempt to resolve references to between components that were not fully processed yet. More...
 
virtual bool resolveDimensions (MAKRti::DtString &errorString, bool &fomReadError)
 After all the tables have been processed attempt to resolve references to between components that were not fully processed yet. More...
 

Protected Attributes

DtObjectClassByHandleMap myObjectsByHandle
 Object classes. More...
 
DtObjectClassByNameMap myObjectsByName
 
DtObjectClassByNameMap myObjectsExcludeMomByName
 
DtObjectClassByNameMap myObjectsMomByName
 
DtInteractionClassByHandleMap myInteractionsByHandle
 Interaction classes. More...
 
DtInteractionClassByNameMap myInteractionsByName
 
DtInteractionClassByNameMap myInteractionsExcludeMomByName
 
DtInteractionClassByNameMap myInteractionsMomByName
 
bool my13and1516interop
 Indicates that 13 and 1516 interoperability is enabled. More...
 
bool myEnableComponentSorting
 Indicates that FOM component sorting is enabled. More...
 
bool myMergingEnabled
 Indicates if FOM Module Merging is enabled. More...
 
MAKRti::DtNameVector myFedFiles
 
bool myOverrideConveyRegions
 RID file specifies to override the FOM convey regions switch. More...
 
const DtDimensionHandleStdSet myEmptyDimHandleSet
 

Static Protected Attributes

static const unsigned int theLastMomObjectHandle
 Last class handle of MOM objects Block of handles up to this value are reserved for MOM object classes. More...
 
static const unsigned int theLastMomInteractionHandle
 Last class handle of MOM interactions Block of handles up to this value are reserved for MOM interaction classes. More...
 
static const unsigned int theInteractionRootHandle
 The interaction root handle This value is reserved for the root interaction class handle. More...
 
static const unsigned int theObjectRootHandle
 The object root handle This value is reserved for the root object class handle. More...
 
static DtFomClassMgrCreator theCreator
 Creator function creates instance of this class or subclass. More...
 

Member Typedef Documentation

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

Maintain classes as a list of pointers that are hierarchically linked.

typedef std::map<MAKRti::DtString, DtObjectClassInfo*> DtFomClassMgr::DtObjectClassByNameMap
protected

Constructor & Destructor Documentation

DtFomClassMgr::DtFomClassMgr ( DtRIDParameters params)
protected

Constructor - used by create.

DtFomClassMgr::DtFomClassMgr ( )

Constructor - Do not use this publicly.

This needed to be public so std::map of these objects as values could be created. Use create method or the protected constructor that create uses.

DtFomClassMgr::DtFomClassMgr ( const DtFomClassMgr orig)

Copy Constructor - must use clone instead.

virtual DtFomClassMgr::~DtFomClassMgr ( )
virtual

Destructor.

Member Function Documentation

virtual 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.

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

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

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

Helper functions for resolving.

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

Define a dimension within a routing space.

Used when initializing from FED file.

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.

virtual void DtFomClassMgr::addFedFileName ( const MAKRti::DtString &  name)
virtual
virtual void DtFomClassMgr::addHandleForUnknownInteractionClass ( 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.

virtual void DtFomClassMgr::addHandleForUnknownObjectClass ( 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.

virtual bool DtFomClassMgr::addInteractionClass ( 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.

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

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

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

Define a class. Used when initializing from FED file.

virtual bool DtFomClassMgr::addObjectClass ( const char *  name,
const char *  baseName,
DtSharingType  sharing,
const MAKRti::DtString &  semantics 
)
virtual
virtual bool DtFomClassMgr::addObjectDimension ( const char *  objectClassName,
const char *  dimension 
)
virtual

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

virtual void DtFomClassMgr::addParameter ( const char *  className,
const char *  paramName 
)
virtual
virtual 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.

virtual void DtFomClassMgr::addSpace ( const char *  name)
virtual

FED file loading functions.

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

virtual void DtFomClassMgr::adjustInteractionHandlesByName ( DtInteractionClassInfo classInfo)
protectedvirtual

The given interaction class was just added to the end.

Reinsert it in sorted order adjusting handles as necessary.

virtual void DtFomClassMgr::adjustObjectHandlesByName ( DtObjectClassInfo classInfo)
protectedvirtual

The given object class was just added to the end.

Reinsert it in sorted order adjusting handles as necessary.

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

Get attribute handle from name.

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

Get attribute name from handle Returns pointer to internal memory.

virtual DtObjectClassInfo* DtFomClassMgr::classByHandle ( DtObjectClassHandle  handle)
virtual

Returns the class descriptor for the handle.

virtual const DtObjectClassInfo* DtFomClassMgr::classByHandle ( DtObjectClassHandle  handle) const
virtual
virtual DtObjectClassInfo* DtFomClassMgr::classByName ( const char *  name)
virtual

Returns the class descriptor for the name.

virtual const DtObjectClassInfo* DtFomClassMgr::classByName ( const char *  name) const
virtual
virtual DtObjectClassHandle DtFomClassMgr::classHandle ( const char *  theName,
bool  throwException = true 
) const
virtual

Querying functions.

Get class handle from name

virtual const char* DtFomClassMgr::className ( DtObjectClassHandle  theHandle,
const char *  defaultName = "ObjectClassNotDefined" 
) const
virtual

Get class name from handle.

Use default name if not found; throw exception if default name is NULL. Returns pointer to internal memory.

virtual DtFomClassMgr* DtFomClassMgr::clone ( )
virtual

Return a copy of this instance.

virtual bool DtFomClassMgr::componentSortingIsActive ( ) const
protectedvirtual

When adding components should they be sorted?

static DtFomClassMgr* DtFomClassMgr::create ( DtRIDParameters p)
static

Creates an instance of a DtFomClassMgr.

virtual bool DtFomClassMgr::extend13and1516interop ( ) const
virtual
virtual const MAKRti::DtNameVector& DtFomClassMgr::fedFiles ( ) const
virtual
virtual int DtFomClassMgr::firstFomInteractionClassHandle ( )
virtual

Get the first FOM interaction handle (not InteractionRoot nor MOM); Returns -1 if no FOM interactions exist.

virtual int DtFomClassMgr::firstFomObjectClassHandle ( )
virtual

Get the first FOM object class handle (excluding ObjectRoot and MOM); Returns -1 if no FOM object classes exist.

virtual std::set<const DtInteractionClassInfo*>& DtFomClassMgr::getInteractionClassDifferences ( const DtFomClassMgr otherFom,
std::set< const DtInteractionClassInfo * > &  diffSet 
) const
virtual

Get the interaction classes from the given FOM that are not in this FOM.

Return the retrieved set

virtual std::set<const DtObjectClassInfo*>& DtFomClassMgr::getObjectClassDifferences ( const DtFomClassMgr otherFom,
std::set< const DtObjectClassInfo * > &  diffSet 
) const
virtual

Get the object classes from the given FOM that are not in this FOM.

Return the retrieved set

const MAKRti::DtUpdateRateSetT& DtFomClassMgr::getUpdateRates ( ) const

Get a set of the update Rates.

void DtFomClassMgr::init ( )
protected
virtual void DtFomClassMgr::initDMFilteringParameters ( const DtRIDParameters params)
virtual

DM Filtering.

virtual void DtFomClassMgr::initUpdateRates ( DtRIDParameters params)
virtual

Initialize the updates rates using the given RID parameters.

virtual DtInteractionClassInfo* DtFomClassMgr::interactionByHandle ( DtInteractionClassHandle  handle)
virtual

Returns the class descriptor for the handle.

virtual const DtInteractionClassInfo* DtFomClassMgr::interactionByHandle ( DtInteractionClassHandle  handle) const
virtual

Returns the class descriptor for the handle.

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

Returns the class descriptor for the name.

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

Returns the class descriptor for the name.

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

Get class handle from name.

virtual const char* DtFomClassMgr::interactionName ( DtInteractionClassHandle  theHandle,
const char *  defaultName = "InteractionClassNotDefined" 
) const
virtual

Get class name from handle.

Use default name if not found; throw exception if default name is NULL. Returns pointer to internal memory.

virtual DtInteractionClassInfo* DtFomClassMgr::interactionRootClass ( )
virtual

Returns the root interaction class descriptor.

virtual const DtInteractionClassInfo* DtFomClassMgr::interactionRootClass ( ) const
virtual

Returns the root interaction class descriptor.

virtual DtInteractionClassHandle DtFomClassMgr::interactionRootHandle ( ) const
virtual

Returns the handle of the root interaction.

bool DtFomClassMgr::knownUpdateRate ( const MAKRti::DtString &  rateName) const

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

virtual int DtFomClassMgr::lastFomInteractionClassHandle ( )
virtual

Get the last FOM interaction handle (not InteractionRoot nor MOM); Returns -1 if no FOM interactions exist.

virtual int DtFomClassMgr::lastFomObjectClassHandle ( )
virtual

Get the last FOM object handle (excluding ObjectRoot and MOM); Returns -1 if no FOM object classes exist.

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

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

virtual DtMergeFomStatus DtFomClassMgr::mergeDimensions ( DtSpaceInfo const &  spaceInfo)
virtual

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

virtual DtMergeFomStatus DtFomClassMgr::mergeInteractionClasses ( DtFedTarget const &  module)
virtual

Merge the contents of the specified interactionClasses with this.

virtual DtMergeFomStatus DtFomClassMgr::mergeInteractionDimensions ( DtFomClassMgr const &  module,
DtInteractionClassInfo const &  interInfo 
)
protectedvirtual

Merge the dimension from the given interaction taken from the given module into the associated interaction in this module.

virtual DtMergeFomStatus DtFomClassMgr::mergeInteractionInfo ( DtInteractionClassInfo const &  interInfo,
const char *  spaceName,
DtParameterByHandleMap parametersToMerge 
)
virtual

Merge the contents of the specified InteractionInfo with this.

virtual DtMergeFomStatus DtFomClassMgr::mergeObjectClasses ( DtFedTarget const &  module)
virtual

Merge the contents of the specified FomMgr with this.

virtual DtMergeFomStatus DtFomClassMgr::mergeObjectDimensions ( DtFomClassMgr const &  module,
DtObjectClassInfo const &  objectInfo 
)
protectedvirtual

Merge the dimension from the given object class taken from the given module into the associated interaction in this module.

virtual DtMergeFomStatus DtFomClassMgr::mergeObjectInfo ( DtObjectClassInfo const &  classInfo,
DtAttributeByHandleMap attributesToMerge 
)
virtual

Merge the contents of the specified objectClass with this.

Attributes needed to be merged are passed back

virtual void DtFomClassMgr::mergeParameters ( DtInteractionClassInfo const &  interInfo,
const DtParameterByHandleMap parametersToMerge 
)
virtual

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

virtual DtMergeFomStatus DtFomClassMgr::mergeSpaces ( DtFedTarget const &  module)
virtual

Merge the given routing spaces with this.

virtual int DtFomClassMgr::numClasses ( ) const
virtual

Get the number of classes.

virtual int DtFomClassMgr::numInteractions ( ) const
virtual

Get number of interactions.

virtual DtObjectClassInfo* DtFomClassMgr::objectRootClass ( )
virtual

Returns the root object class descriptor.

virtual const DtObjectClassInfo* DtFomClassMgr::objectRootClass ( ) const
virtual
virtual DtObjectClassHandle DtFomClassMgr::objectRootHandle ( ) const
virtual

Returns the handle of the root object.

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

assignment operator (not implemented)

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

Get parameter handle from name.

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

Get parameter name from handle Returns pointer to internal memory.

int DtFomClassMgr::positionOfRate ( float  rate) const

Get the position of this rate (sorted ascending).

First position is 1 and 0 indicates rate not found.

virtual void DtFomClassMgr::prepareToRestore ( )
virtual

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

virtual void DtFomClassMgr::print ( ) const
virtual

Print the contents.

virtual void DtFomClassMgr::printDMSubscriptions ( )
virtual
virtual bool DtFomClassMgr::resolveAttributeDimensions ( MAKRti::DtString &  errorString,
bool &  fomReadError 
)
protectedvirtual

After all the tables have been processed attempt to resolve references to between components that were not fully processed yet.

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

After all the tables have been processed attempt to resolve references to between components that were not fully processed yet.

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

After all the tables have been processed attempt to resolve references to between components that were not fully processed yet.

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

After all the tables have been processed attempt to resolve references to between components that were not fully processed yet.

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

After all the tables have been processed attempt to resolve references to between components that were not fully processed yet.

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

After all the tables have been processed attempt to resolve references to between components that were not fully processed yet.

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

After all the tables have been processed attempt to resolve references to between components that were not fully processed yet.

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

After all the tables have been processed attempt to resolve references to between components that were not fully processed yet.

virtual bool DtFomClassMgr::resolveObjectDimensions ( MAKRti::DtString &  errorString,
bool &  fomReadError 
)
protectedvirtual

After all the tables have been processed attempt to resolve references to between components that were not fully processed yet.

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

After all the tables have been processed attempt to resolve references to between components that were not fully processed yet.

virtual bool DtFomClassMgr::restore ( DtRtiSaveFile file)
virtual

Restore the state information from the given file.

virtual bool DtFomClassMgr::save ( DtRtiSaveFile file)
virtual

save and restore

Save the state information to the given file

virtual void DtFomClassMgr::setConveyRegionDesignatorSets ( bool  value)
virtual

switches

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

static 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.

virtual void DtFomClassMgr::setExtend13and1516interop ( bool  enable)
virtual

set/get 1.3 and 1516 interoperability status

float DtFomClassMgr::updateRateByName ( const char *  name)

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

Member Data Documentation

bool DtFomClassMgr::my13and1516interop
protected

Indicates that 13 and 1516 interoperability is enabled.

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

const DtDimensionHandleStdSet DtFomClassMgr::myEmptyDimHandleSet
protected
bool DtFomClassMgr::myEnableComponentSorting
protected

Indicates that FOM component sorting is enabled.

MAKRti::DtNameVector DtFomClassMgr::myFedFiles
protected
DtInteractionClassByHandleMap DtFomClassMgr::myInteractionsByHandle
protected

Interaction classes.

DtInteractionClassByNameMap DtFomClassMgr::myInteractionsByName
protected
DtInteractionClassByNameMap DtFomClassMgr::myInteractionsExcludeMomByName
protected
DtInteractionClassByNameMap DtFomClassMgr::myInteractionsMomByName
protected
bool DtFomClassMgr::myMergingEnabled
protected

Indicates if FOM Module Merging is enabled.

Attribute and Interaction Dimension are changed when merging is enabled.

DtObjectClassByHandleMap DtFomClassMgr::myObjectsByHandle
protected

Object classes.

DtObjectClassByNameMap DtFomClassMgr::myObjectsByName
protected
DtObjectClassByNameMap DtFomClassMgr::myObjectsExcludeMomByName
protected
DtObjectClassByNameMap DtFomClassMgr::myObjectsMomByName
protected
bool DtFomClassMgr::myOverrideConveyRegions
protected

RID file specifies to override the FOM convey regions switch.

DtFomClassMgrCreator DtFomClassMgr::theCreator
staticprotected

Creator function creates instance of this class or subclass.

const unsigned int DtFomClassMgr::theInteractionRootHandle
staticprotected

The interaction root handle This value is reserved for the root interaction class handle.

const unsigned int DtFomClassMgr::theLastMomInteractionHandle
staticprotected

Last class handle of MOM interactions Block of handles up to this value are reserved for MOM interaction classes.

const unsigned int DtFomClassMgr::theLastMomObjectHandle
staticprotected

Last class handle of MOM objects Block of handles up to this value are reserved for MOM object classes.

const unsigned int DtFomClassMgr::theObjectRootHandle
staticprotected

The object root handle This value is reserved for the root object class handle.


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

Document ID: Generated on Sun Jul 20 16:15:30 EDT 2025 from SVN revision 277985
Copyright © 2005-2025 MAK Technologies Inc. All Rights Reserved (www.mak.com)