VR-Link API Documentation for HLA 1.3
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions
DtRprFomMapper Class Reference

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
virtual ~DtRprFomMapper ()
 destructor
virtual void init (DtExerciseConn *conn)
 Virtual function override.
- Public Member Functions inherited from DtEmptyFomMapper
 DtEmptyFomMapper ()
 Default constructor.
virtual ~DtEmptyFomMapper ()
 destructor
DtStateDecoderFactorydfltStateDecoderFactory ()
 Returns the default state decoder factory.
DtStateEncoderFactorydfltStateEncoderFactory ()
 Returns the default state encoder factory.
DtInteractionDecoderFactorydfltInteractionDecoderFactory ()
 Returns the default interaction decoder factory.
DtInteractionEncoderFactorydfltInteractionEncoderFactory ()
 Returns the default state interaction factory.
DtHlaObjectFactorydfltHlaObjectFactory ()
 Returns the default HlaObject factory.
DtInteractionFactorydfltInteractionFactory ()
 Returns the default Interaction factory.
- Public Member Functions inherited from DtFomMapper
 DtFomMapper ()
 Default constructor.
virtual ~DtFomMapper ()
 destructor
virtual DtStateDecoderFactorysetStateDecoderFactory (DtStateDecoderFactory *fact)
 Set/Get the current factory that can be used to create DtHlaStateDecoders.
virtual DtStateDecoderFactorystateDecoderFactory ()
virtual DtStateEncoderFactorysetStateEncoderFactory (DtStateEncoderFactory *fact)
 Set/Get the current factory that can be used to create DtHlaStateEncoders.
virtual DtStateEncoderFactorystateEncoderFactory ()
virtual
DtInteractionDecoderFactory
setInteractionDecoderFactory (DtInteractionDecoderFactory *fact)
 Set/Get the current factory that can be used to create DtInteractionDecoders.
virtual
DtInteractionDecoderFactory
interactionDecoderFactory ()
virtual
DtInteractionEncoderFactory
setInteractionEncoderFactory (DtInteractionEncoderFactory *fact)
 Set/Get the current factory that can be used to create DtInteractionEncoders.
virtual
DtInteractionEncoderFactory
interactionEncoderFactory ()
virtual DtHlaObjectFactorysetHlaObjectFactory (DtHlaObjectFactory *fact)
 Set/Get the current factory that can be used to create DtHlaObjects.
virtual DtHlaObjectFactoryhlaObjectFactory ()
virtual DtInteractionFactorysetInteractionFactory (DtInteractionFactory *fact)
 Set/Get the current factory that can be used to create DtInteractions.
virtual DtInteractionFactoryinteractionFactory ()
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.
virtual void setObjectClassChooser (const char *vrlinkClassName, DtObjectClassChooser chooser)
virtual char * chooseObjectClass (const char *vrlinkClassName, void *usr=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).
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.
virtual void setInteractionClassChooser (const char *vrlinkClassName, DtInteractionClassChooser chooser)
virtual char * chooseInteractionClass (const DtInteraction &inter) const
 Chooses a FOM interaction class to be by a particular derived DtInteraction class named vrlinkClassName.
virtual void setInteractionClasses (const char *vrlinkClassName, const DtList &classes)
 Set/Get a list of names (char*) of FOM classes that can be decoded into the derived DtInteraction class whose name is name.
virtual DtListinteractionClasses (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.
virtual void setObjectClassNames (const char *vrlinkClassName, const DtList &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.
virtual DtListobjectClassNames (const char *vrlinkClassName)
virtual DtListobjectClassHandles (const char *vrlinkClassName)
 Similar to objectClassNames, but returns a DtList of ObjectClassHandles instead.
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.
virtual void setVersion (double vers)
 Returns the version number of the FOM, as passed to setVersion.
virtual double version () const
virtual void setRevision (int val)
 Sets the revision number of the FOM.
virtual int revision () const
 Returns the revision number of the FOM.
virtual DtObjectClassChooser 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.
virtual DtInteractionClassChooser 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.

Static Public Member Functions

static DtFomMappercreate (void *usr)
 Creator function - returns new instance of DtRprFomMapper.
static char * dfltEntityClassChooser (const char *vrlinkClassName, DtExerciseConn *exConn, void *usr)
 The default entity class chooser function.
static char * entityClassChooser08 (const char *vrlinkClassName, DtExerciseConn *exConn, void *usr)
 The entity class chooser function for RPR FOM version 0.8.
static char * entityClassChooserPre08 (const char *vrlinkClassName, DtExerciseConn *exConn, void *usr)
 The entity class chooser function for older RPR FOM versions.
static char * dfltEmitterBeamClassChooser (const char *vrlinkClassName, DtExerciseConn *exConn, void *usr)
 The default emitter beam class chooser function.
static char * emitterBeamClassChooserPre08 (const char *vrlinkClassName, DtExerciseConn *exConn, void *usr)
 The default emitter beam class chooser function.
static char * dfltSignalClassChooser (DtExerciseConn *exConn, const DtInteraction &inter)
 The default signal class chooser function.
static char * dfltIffClassChooser (const char *vrlinkClassName, DtExerciseConn *exConn, void *usr)
 The default iff class chooser function.
static char * dfltPointObjClassChooser (const char *vrlinkClassName, DtExerciseConn *exConn, void *usr)
 The default point object class chooser function.
static char * dfltArealObjClassChooser (const char *vrlinkClassName, DtExerciseConn *exConn, void *usr)
 The default areal object class chooser function.
static char * dfltLinearObjClassChooser (const char *vrlinkClassName, DtExerciseConn *exConn, void *usr)
 The default linear object class chooser function.
static char * dfltArealObjTransClassChooser (DtExerciseConn *exConn, const DtInteraction &inter)
 The default areal object transaction class chooser function.
static char * dfltLinearObjTransClassChooser (DtExerciseConn *exConn, const DtInteraction &inter)
 The default linear object transaction class chooser function.
static char * dfltPointObjTransClassChooser (DtExerciseConn *exConn, const DtInteraction &inter)
 The default point object transaction class chooser function.

Protected Member Functions

 DtRprFomMapper (const DtRprFomMapper &orig)
 copy constructor
DtRprFomMapperoperator= (const DtRprFomMapper &orig)
 assignment operator
virtual void initInterClasses ()
 Set myInterClasses to contain default mappings.
virtual void initObjClasses ()
 Set myObjClassesClasses to contain default mappings.
virtual void initObjChoosers ()
 Setup the object class choosers.
virtual void initInterChoosers ()
 Setup the interaction class choosers.
- Protected Member Functions inherited from DtEmptyFomMapper
 DtEmptyFomMapper (const DtEmptyFomMapper &orig)
 copy constructor - not implemented.
DtEmptyFomMapperoperator= (const DtEmptyFomMapper &orig)
 assignment operator - not implemented.
- Protected Member Functions inherited from DtFomMapper
 DtFomMapper (const DtFomMapper &orig)
 copy constructor - not implemented.
DtFomMapperoperator= (const DtFomMapper &orig)
 assignment operator - not implemented.

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.
typedef char *(* DtObjectClassChooser )(const char *vrlinkClassName, DtExerciseConn *conn, void *usr)
 A function that chooses an object class from the FOM based based on the name of a C++ class derived from DtObjectPublisher, and arbitrary user data (e.g.
- Protected Attributes inherited from DtEmptyFomMapper
DtStateDecoderFactorymyDfltDecFact
 Default factories and other objects.
DtStateEncoderFactorymyDfltEncFact
DtInteractionDecoderFactorymyDfltInterDecFact
DtInteractionEncoderFactorymyDfltInterEncFact
DtHlaObjectFactorymyDfltObjFact
DtInteractionFactorymyDfltInterFact

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.

Constructor & Destructor Documentation

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

default constructor w

Parameters
versThe version of the FOM to use
revThe 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.

Reimplemented from DtEmptyFomMapper.

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.

Reimplemented in MyFomMapper.

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:

Document ID: Generated on Wed Aug 14 15:35:11 EDT 2013 from SVN revision 130445
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)