VR-Link API Documentation for HLA Evolved
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtEmptyFomMapper Class Reference

An instance of DtEmptyFomMapper is a DtFomMapper that has no mappings registered between FOM classes and VR-Link classes. More...

+ Inheritance diagram for DtEmptyFomMapper:
+ Collaboration diagram for DtEmptyFomMapper:

Public Member Functions

 DtEmptyFomMapper ()
 Default constructor.
virtual ~DtEmptyFomMapper ()
 destructor
virtual void init (DtExerciseConn *conn)
 Initialize the instance, once an exercise connection is available.
DtStateDecoderFactory * dfltStateDecoderFactory ()
 Returns the default state decoder factory.
DtStateEncoderFactory * dfltStateEncoderFactory ()
 Returns the default state encoder factory.
DtInteractionDecoderFactory * dfltInteractionDecoderFactory ()
 Returns the default interaction decoder factory.
DtInteractionEncoderFactory * dfltInteractionEncoderFactory ()
 Returns the default state interaction factory.
DtHlaObjectFactory * dfltHlaObjectFactory ()
 Returns the default HlaObject factory.
DtInteractionFactory * dfltInteractionFactory ()
 Returns the default Interaction factory.
- Public Member Functions inherited from DtFomMapper
 DtFomMapper ()
 Default constructor.
virtual ~DtFomMapper ()
 destructor
virtual DtStateDecoderFactory * setStateDecoderFactory (DtStateDecoderFactory *fact)
 Set/Get the current factory that can be used to create DtHlaStateDecoders.
virtual DtStateDecoderFactory * stateDecoderFactory ()
virtual DtStateEncoderFactory * setStateEncoderFactory (DtStateEncoderFactory *fact)
 Set/Get the current factory that can be used to create DtHlaStateEncoders.
virtual DtStateEncoderFactory * stateEncoderFactory ()
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 DtHlaObjectFactory * setHlaObjectFactory (DtHlaObjectFactory *fact)
 Set/Get the current factory that can be used to create DtHlaObjects.
virtual DtHlaObjectFactory * hlaObjectFactory ()
virtual DtInteractionFactory * setInteractionFactory (DtInteractionFactory *fact)
 Set/Get the current factory that can be used to create DtInteractions.
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.
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 DtList * 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.
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 DtList * objectClassNames (const char *vrlinkClassName)
virtual DtList * objectClassHandles (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 DtFomMapper * create (void *usr=NULL)
 A Creator function that returns a DtEmptyFomMapper configured with no mappings at all.

Protected Member Functions

 DtEmptyFomMapper (const DtEmptyFomMapper &orig)
 copy constructor - not implemented.
DtEmptyFomMapper & operator= (const DtEmptyFomMapper &orig)
 assignment operator - not implemented.
- Protected Member Functions inherited from DtFomMapper
 DtFomMapper (const DtFomMapper &orig)
 copy constructor - not implemented.
DtFomMapper & operator= (const DtFomMapper &orig)
 assignment operator - not implemented.

Protected Attributes

DtStateDecoderFactory * myDfltDecFact
 Default factories and other objects.
DtStateEncoderFactory * myDfltEncFact
DtInteractionDecoderFactory * myDfltInterDecFact
DtInteractionEncoderFactory * myDfltInterEncFact
DtHlaObjectFactory * myDfltObjFact
DtInteractionFactory * myDfltInterFact
- Protected Attributes inherited from DtFomMapper
DtExerciseConn * myExConn
DtStateDecoderFactory * myDecFact
 Current factories and other objects.
DtStateEncoderFactory * myEncFact
DtInteractionDecoderFactory * myInterDecFact
DtInteractionEncoderFactory * myInterEncFact
DtHlaObjectFactory * myObjFact
DtInteractionFactory * myInterFact
DtHashlist myIntMapList
 Hash list that maps names of C++ classes derived from DtInteraction to lists of names of FOM classes.
DtHashlist myObjMapList
 Hash list that maps names of C++ classes derived from DtReflectedObjectList to lists of names of FOM classes.
DtHashlist myObjChooserList
 Hash list that 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.
DtHashlist mySimpleObjChooserList
 Hash list that maps names of C++ classes derived from DtObjectPublisher to single FOM object class names.
DtHashlist myInterChooserList
 Hash list that 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.
DtHashlist mySimpleInterChooserList
 Hash list that maps names of C++ classes derived from DtInteraction to single FOM object class names.
DtList myObjHandleList
 The object returned by objectClassHandles.
DtList myEmptyList
 Just an empty list to return when no class list has been registered for a particular VR-Link class.
double myVersion
int myRevision

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.

Detailed Description

An instance of DtEmptyFomMapper is a DtFomMapper that has no mappings registered between FOM classes and VR-Link classes.

Mappings can be added later.

Constructor & Destructor Documentation

DtEmptyFomMapper::DtEmptyFomMapper ( )

Default constructor.

Typically, most initialization takes place within init(), which is called by DtExerciseConn's constructor.

virtual DtEmptyFomMapper::~DtEmptyFomMapper ( )
virtual

destructor

DtEmptyFomMapper::DtEmptyFomMapper ( const DtEmptyFomMapper &  orig)
protected

copy constructor - not implemented.

Member Function Documentation

static DtFomMapper* DtEmptyFomMapper::create ( void *  usr = NULL)
static

A Creator function that returns a DtEmptyFomMapper configured with no mappings at all.

Reimplemented in DtRprFomMapper.

DtHlaObjectFactory* DtEmptyFomMapper::dfltHlaObjectFactory ( )

Returns the default HlaObject factory.

DtInteractionDecoderFactory* DtEmptyFomMapper::dfltInteractionDecoderFactory ( )

Returns the default interaction decoder factory.

DtInteractionEncoderFactory* DtEmptyFomMapper::dfltInteractionEncoderFactory ( )

Returns the default state interaction factory.

DtInteractionFactory* DtEmptyFomMapper::dfltInteractionFactory ( )

Returns the default Interaction factory.

DtStateDecoderFactory* DtEmptyFomMapper::dfltStateDecoderFactory ( )

Returns the default state decoder factory.

DtStateEncoderFactory* DtEmptyFomMapper::dfltStateEncoderFactory ( )

Returns the default state encoder factory.

virtual void DtEmptyFomMapper::init ( DtExerciseConn *  conn)
virtual

Initialize the instance, once an exercise connection is available.

Called by DtExerciseConn constructor.

Implements DtFomMapper.

Reimplemented in DtRprFomMapper, and MyFomMapper.

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

assignment operator - not implemented.

Member Data Documentation

DtStateDecoderFactory* DtEmptyFomMapper::myDfltDecFact
protected

Default factories and other objects.

DtStateEncoderFactory* DtEmptyFomMapper::myDfltEncFact
protected
DtInteractionDecoderFactory* DtEmptyFomMapper::myDfltInterDecFact
protected
DtInteractionEncoderFactory* DtEmptyFomMapper::myDfltInterEncFact
protected
DtInteractionFactory* DtEmptyFomMapper::myDfltInterFact
protected
DtHlaObjectFactory* DtEmptyFomMapper::myDfltObjFact
protected

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)