If you define DtSIMPLE_RPR to 1, and include this file, then this file defines a class called DtSimpleFomMapper - a FOM Mapper that contains mappings for only the subset of RPR FOM objects/interactions that are used by most MAK tools. More...

Inheritance diagram for DtRprFomMapper:

Collaboration diagram for DtRprFomMapper:

Public Member Functions
	DtRprFomMapper (double vers=1.0, int rev=1)
	default constructor w More...

virtual	~DtRprFomMapper ()
	destructor More...

virtual void	init (DtExerciseConn *conn)
	Virtual function override. More...

Public Member Functions inherited from DtEmptyFomMapper
	DtEmptyFomMapper ()
	Default constructor. More...

virtual	~DtEmptyFomMapper ()
	destructor More...

DtStateDecoderFactory *	dfltStateDecoderFactory ()
	Returns the default state decoder factory. More...

DtStateEncoderFactory *	dfltStateEncoderFactory ()
	Returns the default state encoder factory. More...

DtInteractionDecoderFactory *	dfltInteractionDecoderFactory ()
	Returns the default interaction decoder factory. More...

DtInteractionEncoderFactory *	dfltInteractionEncoderFactory ()
	Returns the default state interaction factory. More...

DtHlaObjectFactory *	dfltHlaObjectFactory ()
	Returns the default HlaObject factory. More...

DtInteractionFactory *	dfltInteractionFactory ()
	Returns the default Interaction factory. More...

Public Member Functions inherited from DtFomMapper
	DtFomMapper ()
	Default constructor. More...

virtual	~DtFomMapper ()
	destructor More...

virtual DtStateDecoderFactory *	setStateDecoderFactory (DtStateDecoderFactory *fact)
	Set/Get the current factory that can be used to create DtHlaStateDecoders. More...

virtual DtStateDecoderFactory *	stateDecoderFactory ()

virtual DtStateEncoderFactory *	setStateEncoderFactory (DtStateEncoderFactory *fact)
	Set/Get the current factory that can be used to create DtHlaStateEncoders. More...

virtual DtStateEncoderFactory *	stateEncoderFactory ()

virtual DtInteractionDecoderFactory *	setInteractionDecoderFactory (DtInteractionDecoderFactory *fact)
	Set/Get the current factory that can be used to create DtInteractionDecoders. More...

virtual DtInteractionDecoderFactory *	interactionDecoderFactory ()

virtual DtInteractionEncoderFactory *	setInteractionEncoderFactory (DtInteractionEncoderFactory *fact)
	Set/Get the current factory that can be used to create DtInteractionEncoders. More...

virtual DtInteractionEncoderFactory *	interactionEncoderFactory ()

virtual DtHlaObjectFactory *	setHlaObjectFactory (DtHlaObjectFactory *fact)
	Set/Get the current factory that can be used to create DtHlaObjects. More...

virtual DtHlaObjectFactory *	hlaObjectFactory ()

virtual DtInteractionFactory *	setInteractionFactory (DtInteractionFactory *fact)
	Set/Get the current factory that can be used to create DtInteractions. More...

virtual DtInteractionFactory *	interactionFactory ()

virtual void	setObjectClassToChoose (const char vrlinkClassName, const char fomClassName)
	Tell the FOM Mapper how to choose a FOM object class to use for objects being published by a particular kind of object publisher. More...

virtual void	setObjectClassChooser (const char *vrlinkClassName, DtObjectClassChooser chooser)

virtual void	setObjectClassChooser (const char vrlinkClassName, DtObjectClassChooserWithUsrData chooser, void usr)

virtual const char *	chooseObjectClass (const char vrlinkClassName, void fomClassSpecific=NULL) const
	Chooses an object class to represent an object managed by the C++ class named vrlinkClassName (which should be a class derived from DtObjectPublisher). More...

virtual void	setInteractionClassToChoose (const char vrlinkClassName, const char fomClassName)
	Tell the FOM Mapper how to choose a FOM interaction class to use for a particular kind of derived DtInteraction. More...

virtual void	setInteractionClassChooser (const char *vrlinkClassName, DtInteractionClassChooser chooser)

virtual void	setInteractionClassChooser (const char vrlinkClassName, DtInteractionClassChooserWithUsrData chooser, void usr)

virtual const char *	chooseInteractionClass (const DtInteraction &inter) const
	Chooses a FOM interaction class to be by a particular derived DtInteraction class named vrlinkClassName. More...

virtual void	setInteractionClasses (const char *vrlinkClassName, const std::vector< DtString > &classes)
	Set/Get a list of names (char*) of FOM classes that can be decoded into the derived DtInteraction class whose name is name. More...

virtual const std::vector < DtString > *	interactionClasses (const char *vrlinkClassName)

virtual void	setInteractionClass (const char vrlinkClassName, const char fomClassName)
	When there is only a single FOM class to be associated with a VR-Link interaction class, then there is no need to create a DtList. More...

virtual void	addInteractionClassName (const char vrlinkClassName, const char objClassName, bool includeSubclasses)
	Modify the list of names of FOM interactions that should be subscribed to by a particular subclass of VR-Link. More...

virtual void	removeInteractionClassName (const char vrlinkClassName, const char objClassName, bool includeSubclasses)

virtual void	setObjectClassNames (const char *vrlinkClassName, const std::vector< DtString > &classes)
	Set/Get a list of names (char*) of FOM object classes that should be subscribed to by a particular subclass of VR-Link's DtReflectedObjectList. More...

virtual const std::vector < DtString > *	objectClassNames (const char *vrlinkClassName)

virtual DtList *	objectClassHandles (const char *vrlinkClassName)
	Similar to objectClassNames, but returns a DtList of ObjectClassHandles instead. More...

virtual void	setObjectClass (const char vrlinkClassName, const char fomClassName)
	When there is only a single FOM class to be associated with a VR-Link DtReflectedObjectList class, then there is no need to create a DtList. More...

virtual void	addObjectClassName (const char vrlinkClassName, const char objClassName, bool includeSubclasses)
	Modify the list of names of FOM objects that should be subscribed to by a particular subclass of VR-Link. More...

virtual void	removeObjectClassName (const char vrlinkClassName, const char objClassName, bool includeSubclasses)

virtual void	setVersion (double vers)
	Returns the version number of the FOM, as passed to setVersion. More...

virtual double	version () const

virtual void	setRevision (int val)
	Sets the revision number of the FOM. More...

virtual int	revision () const
	Returns the revision number of the FOM. More...

virtual const DtObjectClassChooserInfo *	objectClassChooser (const char *vrlinkClassName) const
	Return the FOM-class-chooser function, if any, that has been associated with the name of a C++ class derived from DtObjectPublisher using setObjectClassChooser. More...

virtual const DtInteractionClassChooserInfo *	interactionClassChooser (const char *vrlinkClassName) const
	Return the FOM-class-chooser function, if any, that has been associated with the name of a C++ class derived from DtInteraction using setInteractionClassChooser. More...

Static Public Member Functions
static DtFomMapper *	create (void *usr)
	Creator function - returns new instance of DtRprFomMapper. More...

static char *	dfltEntityClassChooser (const char vrlinkClassName, DtExerciseConn exConn, void *usr)
	The default entity class chooser function. More...

static char *	entityClassChooser08 (const char vrlinkClassName, DtExerciseConn exConn, void *usr)
	The entity class chooser function for RPR FOM version 0.8. More...

static char *	entityClassChooserPre08 (const char vrlinkClassName, DtExerciseConn exConn, void *usr)
	The entity class chooser function for older RPR FOM versions. More...

static char *	dfltEmitterBeamClassChooser (const char vrlinkClassName, DtExerciseConn exConn, void *usr)
	The default emitter beam class chooser function. More...

static char *	emitterBeamClassChooserPre08 (const char vrlinkClassName, DtExerciseConn exConn, void *usr)
	The default emitter beam class chooser function. More...

static char *	dfltSignalClassChooser (DtExerciseConn *exConn, const DtInteraction &inter)
	The default signal class chooser function. More...

static char *	dfltIffClassChooser (const char vrlinkClassName, DtExerciseConn exConn, void *usr)
	The default iff class chooser function. More...

static char *	dfltPointObjClassChooser (const char vrlinkClassName, DtExerciseConn exConn, void *usr)
	The default point object class chooser function. More...

static char *	dfltArealObjClassChooser (const char vrlinkClassName, DtExerciseConn exConn, void *usr)
	The default areal object class chooser function. More...

static char *	dfltLinearObjClassChooser (const char vrlinkClassName, DtExerciseConn exConn, void *usr)
	The default linear object class chooser function. More...

static char *	dfltArealObjTransClassChooser (DtExerciseConn *exConn, const DtInteraction &inter)
	The default areal object transaction class chooser function. More...

static char *	dfltLinearObjTransClassChooser (DtExerciseConn *exConn, const DtInteraction &inter)
	The default linear object transaction class chooser function. More...

static char *	dfltPointObjTransClassChooser (DtExerciseConn *exConn, const DtInteraction &inter)
	The default point object transaction class chooser function. More...

Static Public Member Functions inherited from DtEmptyFomMapper
static DtFomMapper *	create (void *usr=NULL)
	A Creator function that returns a DtEmptyFomMapper configured with no mappings at all. More...

Protected Member Functions
	DtRprFomMapper (const DtRprFomMapper &orig)
	copy constructor More...

DtRprFomMapper &	operator= (const DtRprFomMapper &orig)
	assignment operator More...

virtual void	initInterClasses ()
	Set myInterClasses to contain default mappings. More...

virtual void	initObjClasses ()
	Set myObjClassesClasses to contain default mappings. More...

virtual void	initObjChoosers ()
	Setup the object class choosers. More...

virtual void	initInterChoosers ()
	Setup the interaction class choosers. More...

Protected Member Functions inherited from DtEmptyFomMapper
	DtEmptyFomMapper (const DtEmptyFomMapper &orig)
	copy constructor - not implemented. More...

DtEmptyFomMapper &	operator= (const DtEmptyFomMapper &orig)
	assignment operator - not implemented. More...

Protected Member Functions inherited from DtFomMapper
	DtFomMapper (const DtFomMapper &orig)
	copy constructor - not implemented. More...

DtFomMapper &	operator= (const DtFomMapper &orig)
	assignment operator - not implemented. More...

Additional Inherited Members
Public Types inherited from DtFomMapper
typedef char (	DtInteractionClassChooser )(DtExerciseConn *exConn, const DtInteraction &inter)
	A function that chooses an interaction class from the FOM based on the contents of a derived DtInteraction object. More...

typedef char (	DtInteractionClassChooserWithUsrData )(DtExerciseConn exConn, const DtInteraction &inter, void usr)
	Same as DtInteractionClassChooser but allows a user to specify a void* to be passed as user data. More...

typedef char (	DtObjectClassChooser )(const char vrlinkClassName, DtExerciseConn conn, void *fomClassSpecific)
	A function that chooses an object class from the FOM based based on the name of a C++ class derived from DtObjectPublisher and FOM class specific data deemed relevant by the publisher class (e.g. More...

typedef char (	DtObjectClassChooserWithUsrData )(const char vrlinkClassName, DtExerciseConn conn, void fomClassSpecific, void usr)
	Same as DtObjectClassChooser but allows a user to specify a void* to be passed as user data. More...

typedef std::map< DtString, std::vector< DtString > >	DtStringVectorMap

Protected Attributes inherited from DtEmptyFomMapper
DtStateDecoderFactory *	myDfltDecFact
	Default factories and other objects. More...

DtStateEncoderFactory *	myDfltEncFact

DtInteractionDecoderFactory *	myDfltInterDecFact

DtInteractionEncoderFactory *	myDfltInterEncFact

DtHlaObjectFactory *	myDfltObjFact

DtInteractionFactory *	myDfltInterFact

Protected Attributes inherited from DtFomMapper
DtExerciseConn *	myExConn

DtStateDecoderFactory *	myDecFact
	Current factories and other objects. More...

DtStateEncoderFactory *	myEncFact

DtInteractionDecoderFactory *	myInterDecFact

DtInteractionEncoderFactory *	myInterEncFact

DtHlaObjectFactory *	myObjFact

DtInteractionFactory *	myInterFact

DtStringVectorMap	myIntMapList
	Maps of the names of C++ classes derived from DtInteraction to sets of names of FOM classes. More...

DtStringVectorMap	myObjMapList
	Maps of the names of C++ classes derived from DtReflectedObjectList to sets of names of FOM classes. More...

std::map< DtString, DtObjectClassChooserInfo >	myObjChooserList
	Maps names of C++ classes derived from DtObjectPublisher to DtObjectClassChoosers - functions that can choose an object class name from the FOM to use for the object. More...

std::map< DtString, DtString >	mySimpleObjChooserList
	Maps names of C++ classes derived from DtObjectPublisher to single FOM object class names. More...

std::map< DtString, DtInteractionClassChooserInfo >	myInterChooserList
	Maps names of C++ classes derived from DtInteraction to DtInteractionClassChoosers - functions that can choose an interaction class name from the FOM to use for the interaction. More...

std::map< DtString, DtString >	mySimpleInterChooserList
	Maps names of C++ classes derived from DtInteraction to single FOM object class names. More...

DtList	myObjHandleList
	The object returned by objectClassHandles. More...

DtList	myEmptyList
	Just an empty list to return when no class list has been registered for a particular VR-Link class. More...

double	myVersion

int	myRevision

Detailed Description

If you define DtSIMPLE_RPR to 1, and include this file, then this file defines a class called DtSimpleFomMapper - a FOM Mapper that contains mappings for only the subset of RPR FOM objects/interactions that are used by most MAK tools.

Instances of DtRprFomMapper are DtFomMappers configured to map between VR-Link classes and functionality to RPR FOM classes, attributes and parameters. Note that there is also a revision number that exists for each RPR FOM version. The following describes the fixes made for each revision. In order to take advantage of a fix, the user will need to provide the revision number, either through instantiation of the DtRprFomMapper class, or through the DtVrlApplicationInitializer. Note that setting the revision to a number will also pick up all fixes in previous revisions - i.e. setting revision to 3 will pick up revision 2 fixes as well.

Revision 2 (RPR 2 draft 17)
- The NumberOfObjectIDs field of the RTIObjectIdArrayStruct was fixed to be 4 bytes, rather than 2, and holds the number of ID's, not the number of bytes.
- The VariableDatumStruct in Comment interactions was fixed to conform to the standard.
Revision 3 (RPR 2 draft 17)
- The GridDataRecordType0/1/2 structures were fixed so that the number of data bytes/values is sent out as 4 bytes, instead of 2
Revision 4 (RPR 2 draft 17)
- Fixed encoding of Environment Record data in The EnvironmentProcess class.
Revision 5 (RPR 2 draft 14 & RPR 2 draft 17)
- Fixed encoding of VariableDatumStruct in the ActionRequest, ActionResponse, Comment, Data, EventReport, and SetData interactions.
- Fixed encoding and decoding of ArticulatedParts for detonation interactions
Revision 6 (RPR 2 draft 17)
- Fixed encoding of Underwater Acoustic Beams to include a reference to their parent system.

Constructor & Destructor Documentation

DtRprFomMapper::DtRprFomMapper	(	double	vers = `1.0`,
		int	rev = `1`
	)

default constructor w

Parameters

vers	The version of the FOM to use
rev	The revision of the FOM Mapper for vers FOM.

virtual DtRprFomMapper::~DtRprFomMapper ( )

virtual

destructor

DtRprFomMapper::DtRprFomMapper ( const DtRprFomMapper & orig )

protected

copy constructor

Member Function Documentation

static DtFomMapper* DtRprFomMapper::create ( void * usr )

static

Creator function - returns new instance of DtRprFomMapper.

usr is cast to a pointer to double. If the pointer is NULL, or the value pointed to is 0.0, the default version is used in the DtRprFomMapper constructor. Otherwise the value is passed to the DtRprFomMapper constructor as the version number.

static char* DtRprFomMapper::dfltArealObjClassChooser	(	const char *	vrlinkClassName,
		DtExerciseConn *	exConn,
		void *	usr
	)

static

The default areal object class chooser function.

static char* DtRprFomMapper::dfltArealObjTransClassChooser	(	DtExerciseConn *	exConn,
		const DtInteraction &	inter
	)

static

The default areal object transaction class chooser function.

static char* DtRprFomMapper::dfltEmitterBeamClassChooser	(	const char *	vrlinkClassName,
		DtExerciseConn *	exConn,
		void *	usr
	)

static

The default emitter beam class chooser function.

static char* DtRprFomMapper::dfltEntityClassChooser	(	const char *	vrlinkClassName,
		DtExerciseConn *	exConn,
		void *	usr
	)

static

The default entity class chooser function.

Referenced by DtF18EntityChooser().

static char* DtRprFomMapper::dfltIffClassChooser	(	const char *	vrlinkClassName,
		DtExerciseConn *	exConn,
		void *	usr
	)

static

The default iff class chooser function.

static char* DtRprFomMapper::dfltLinearObjClassChooser	(	const char *	vrlinkClassName,
		DtExerciseConn *	exConn,
		void *	usr
	)

static

The default linear object class chooser function.

static char* DtRprFomMapper::dfltLinearObjTransClassChooser	(	DtExerciseConn *	exConn,
		const DtInteraction &	inter
	)

static

The default linear object transaction class chooser function.

static char* DtRprFomMapper::dfltPointObjClassChooser	(	const char *	vrlinkClassName,
		DtExerciseConn *	exConn,
		void *	usr
	)

static

The default point object class chooser function.

static char* DtRprFomMapper::dfltPointObjTransClassChooser	(	DtExerciseConn *	exConn,
		const DtInteraction &	inter
	)

static

The default point object transaction class chooser function.

static char* DtRprFomMapper::dfltSignalClassChooser	(	DtExerciseConn *	exConn,
		const DtInteraction &	inter
	)

static

The default signal class chooser function.

static char* DtRprFomMapper::emitterBeamClassChooserPre08	(	const char *	vrlinkClassName,
		DtExerciseConn *	exConn,
		void *	usr
	)

static

The default emitter beam class chooser function.

static char* DtRprFomMapper::entityClassChooser08	(	const char *	vrlinkClassName,
		DtExerciseConn *	exConn,
		void *	usr
	)

static

The entity class chooser function for RPR FOM version 0.8.

static char* DtRprFomMapper::entityClassChooserPre08	(	const char *	vrlinkClassName,
		DtExerciseConn *	exConn,
		void *	usr
	)

static

The entity class chooser function for older RPR FOM versions.

virtual void DtRprFomMapper::init ( DtExerciseConn * conn )

virtual

Virtual function override.

init actually initializes most data. It is called from DtExerciseConn constructor.

Reimplemented from DtEmptyFomMapper.

virtual void DtRprFomMapper::initInterChoosers ( )

protectedvirtual

Setup the interaction class choosers.

virtual void DtRprFomMapper::initInterClasses ( )

protectedvirtual

Set myInterClasses to contain default mappings.

virtual void DtRprFomMapper::initObjChoosers ( )

protectedvirtual

Setup the object class choosers.

virtual void DtRprFomMapper::initObjClasses ( )

protectedvirtual

Set myObjClassesClasses to contain default mappings.

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

protected

assignment operator

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

rprFomMapper.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation