VR-Vantage 2.8 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Typedefs | Enumerations | Functions
makVrfVrlinkExtToolkit Namespace Reference

Classes

class  DtExtendedAttributeDecoder
class  DtExtendedAttributeEncoder
class  DtExtendedAttributesObjectDecoder
 Instances of DtExtendedAttributesObjectDecoder are used to decode data from the network into DtExtendedAttributesObjectStateRepository objects. More...
class  DtExtendedAttributesObjectEncoder
 Instances of DtExtendedAttributesObjectEncoder encode data from DtExtendedAttributesObjectStateRepository objects to the net structures to be sent to the network. More...
class  DtExtendedAttributesObjectPublisher
 Instances of DtExtendedAttributesObjectPublisher publish ExtendedAttributes objects to the network. More...
class  DtExtendedAttributesObjectStateRepository
 Instances of DtExtendedAttributesObjectStateRepository are used to store state data for ExtendedAttributesObject objects. More...
struct  DtNetExtendedAttributeStruct
 The network structure for the header of each extended attribute. More...
class  DtReflectedExtendedAttributesObject
 Instances of DtReflectedExtendedAttributesObject are used to represent a simulated HLAobjectRoot.VrfExtendedAttributes object reflected across a network. More...
class  DtReflectedExtendedAttributesObjectList
 Instances of DtReflectedExtendedAttributesObjectList manage a list of DtReflectedExtendedAttributesObject objects. More...
class  DtExtendedAttributeInfo
class  DtStateRepositoryWithExtendedAttributesInterface
 Defines the interface for all DtStateRepositoryWithExtendedAttributes classes. More...
class  DtStateRepositoryWithExtendedAttributes
 This template class can be used to extend any existing State Repository class which is a subclass of DtVrfExtensions to add the ability to process extended attributes from an extended subclass of the FOM class handled by the original SR class. More...

Typedefs

typedef void(* DtExtendedAttributesObjectCallbackFunction )(DtReflectedExtendedAttributesObject *obj, void *userData)
 Signature of the callback function that takes a DtReflectedExtendedAttributesObject and user data.
typedef std::map< DtString,
RTI::AttributeHandle > 
DtAttributeNameToHandleMap
typedef std::map
< RTI::AttributeHandle,
DtString
DtAttributeHandleToNameMap
typedef std::map< DtString,
DtExtendedAttributeInfo * > 
DtAttributesByNameMap
typedef std::map
< RTI::AttributeHandle,
DtExtendedAttributeInfo * > 
DtAttributesByHandleMap
typedef std::set
< RTI::AttributeHandle > 
DtAttributeHandleSet
typedef std::set< DtStringDtAttributeNameSet

Enumerations

enum  DtGetAttributeFilter { DtNoAttributeFilter = 0, DtOnlyUpdatedAttributes = 1 << 0, DtOnlyFullAttributes = 1 << 1 }
 This enumeration defines filters can be used when requesting attributes. More...

Functions

DT_DLL_vrfExtObjects unsigned DtVrfObjectDataRecordType (unsigned offset)
template<typename StateRepType >
void setAttributeNameToHandleMap (DtObjClassDesc *desc)
 Sets the attribute name to handle map for the extended state rep for the given FOM class.
void setExtendedAttributesNameToHandleMap (DtObjClassDesc *desc)
 Sets the attribute name to handle map for the Extended Attributes state rep for the given FOM class.
bool areClassNamesEquivalent (const DtString &name1, const DtString &name2)
template<typename StateRepType , typename PublisherType , typename ReflectedObjType >
void registerExtendedAttributeClasses (const DtString &fullBaseClassName, const DtString &publisherName, const DtString &reflListName, const DtFomMapper::DtObjectClassChooserWithUsrData &classChooser, void *classChooserUsr, DtExerciseConn *exConn)
 Registers the necessary state rep creators, encoder, decoder, and checker functions for the given FOM classes which extend a supported VR-Link class.

Typedef Documentation

typedef void(* makVrfVrlinkExtToolkit::DtExtendedAttributesObjectCallbackFunction)(DtReflectedExtendedAttributesObject *obj, void *userData)

Signature of the callback function that takes a DtReflectedExtendedAttributesObject and user data.

typedef std::map<DtString, RTI::AttributeHandle> makVrfVrlinkExtToolkit::DtAttributeNameToHandleMap
typedef std::map<RTI::AttributeHandle, DtString> makVrfVrlinkExtToolkit::DtAttributeHandleToNameMap
typedef std::set<RTI::AttributeHandle> makVrfVrlinkExtToolkit::DtAttributeHandleSet

Enumeration Type Documentation

This enumeration defines filters can be used when requesting attributes.

If an attribute does not match all specified filters, it will not be returned.

Enumerator:
DtNoAttributeFilter 

No filter, will return any requested attribute.

DtOnlyUpdatedAttributes 

Returns only attributes that have been updated since the last request for them.

DtOnlyFullAttributes 

Returns only attributes that are considered "full" attributes.

In HLA, this means that the attribute is a defined FOM class attribute, not just one of the generic VRF extended attributes in VrfExtendedAttributes.ExtendedAttributes.

Function Documentation

DT_DLL_vrfExtObjects unsigned makVrfVrlinkExtToolkit::DtVrfObjectDataRecordType ( unsigned  offset)
template<typename StateRepType >
void makVrfVrlinkExtToolkit::setAttributeNameToHandleMap ( DtObjClassDesc *  desc)

Sets the attribute name to handle map for the extended state rep for the given FOM class.

void makVrfVrlinkExtToolkit::setExtendedAttributesNameToHandleMap ( DtObjClassDesc *  desc)
inline

Sets the attribute name to handle map for the Extended Attributes state rep for the given FOM class.

References makVrfVrlinkExtToolkit::DtExtendedAttributesObjectStateRepository::setAttributeNameToHandleMap().

Referenced by registerExtendedAttributeClasses().

bool makVrfVrlinkExtToolkit::areClassNamesEquivalent ( const DtString name1,
const DtString name2 
)
inline
template<typename StateRepType , typename PublisherType , typename ReflectedObjType >
void makVrfVrlinkExtToolkit::registerExtendedAttributeClasses ( const DtString fullBaseClassName,
const DtString publisherName,
const DtString reflListName,
const DtFomMapper::DtObjectClassChooserWithUsrData &  classChooser,
void classChooserUsr,
DtExerciseConn *  exConn 
)

Registers the necessary state rep creators, encoder, decoder, and checker functions for the given FOM classes which extend a supported VR-Link class.

All attributes of the subclasses will be stored in an extended attribute list without encoding or decoding. These settings will affect all publishers and reflected lists created after this. fullBaseClassName is the full name of the base class to be registered. All subclasses of this class will be registered as well. publisherName is the name of the VR-Link publisher class. Used to register the classChooser function. reflListName is the name of the VR-Link reflected list class. Used to register which classes will be fed into reflected lists of this type. classChooser is a function that will choose which FOM object class a publisher will publish to the network, based on entity type. If 0, will not be set. classChooserUsr is the user data pointer to pass to the classChooser. exConn is the VR-Link exercise connection.

References areClassNamesEquivalent(), DtALMOST, and setExtendedAttributesNameToHandleMap().



Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)