The MyFomMapper class - a FOM Mapper with mappings between VR-Link's FOM independent API and the FOM described in MyFom.fed. More...

Inheritance diagram for MyFomMapper:

Collaboration diagram for MyFomMapper:

Public Member Functions
	MyFomMapper ()

virtual	~MyFomMapper ()

virtual void	init (DtExerciseConn *conn)
	Initialize the instance, once an exercise connection is available. 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...

Protected Member Functions
	MyFomMapper (const MyFomMapper &orig)

MyFomMapper &	operator= (const MyFomMapper &orig)

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

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

The MyFomMapper class - a FOM Mapper with mappings between VR-Link's FOM independent API and the FOM described in MyFom.fed.

We can tell VR-Link to use this FOM Mapper either by passing an instance to the DtExerciseConn constructor, or by creating a FOM Mapper shared library whose DtCreateFomMapper function returns an instance of this class, and telling VR-Link to use the FOM Mapper in that shared library.

Constructor & Destructor Documentation

MyFomMapper::MyFomMapper ( )

virtual MyFomMapper::~MyFomMapper ( )

virtual

MyFomMapper::MyFomMapper ( const MyFomMapper & orig )

protected

Member Function Documentation

virtual void MyFomMapper::init ( DtExerciseConn * conn )

virtual

Initialize the instance, once an exercise connection is available.

Called by DtExerciseConn constructor.

Reimplemented from DtEmptyFomMapper.

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

protected

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

myFomMap.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation