MyFomMapper Class Reference

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.
Public Member Functions inherited from DtEmptyFomMapper
	DtEmptyFomMapper ()
	Default constructor.
virtual	~DtEmptyFomMapper ()
	destructor
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.

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

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.
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.
Protected Attributes inherited from DtEmptyFomMapper
DtStateDecoderFactory *	myDfltDecFact
	Default factories and other objects.
DtStateEncoderFactory *	myDfltEncFact
DtInteractionDecoderFactory *	myDfltInterDecFact
DtInteractionEncoderFactory *	myDfltInterEncFact
DtHlaObjectFactory *	myDfltObjFact
DtInteractionFactory *	myDfltInterFact

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