VR-Link Example Members

This group contains files, classes and their members that are distributed as VR-Link Examples. More...

Classes
class	MyEntityStateRep
	Because this example adds a concept that did not already exist in VR-Link's DtEntityStateRepository class, we create this subclass of DtEntityStateRepository that adds the concept of mass. More...
class	MyFireInteraction
	Because this example adds a concept that did not already exist in VR-Link's DtFireInteraction class, we create this subclass of DtFireInteraction that adds the concept of temperature. More...
class	DtF18EntityStateRep
	An example subclass of the DtEntityStateRepository. More...
class	DtF18EntityDecoder
	An example subclass of DtPlatformDecoder for use with DtF18EntityStateRep. More...
class	DtF18EntityEncoder
	An example subclass of DtPlatformEncoder for use with DtF18EntityStateRep. More...
class	DtF18Initializer
	DtF18Initializer derives from DtVrlApplicationInitializer and describes how command line/configuration file parameters can be added to a VR-Link application. More...
class	DtVehicleSim
	Part of the F18 example. More...
class	DtLauncherInitializer
	DtLauncherInitializer derives from DtVrlApplicationInitializer and describes how command line/MTL parameters could be added to a VR-Link application. More...
class	MyFomMapper
	The MyFomMapper class - a FOM Mapper with mappings between VR-Link's FOM independent API and the FOM described in MyFom.fed. More...
class	ShootDecoder
	A decoder for the ShootInteraction. More...
class	ShootEncoder
	This is a simple encoder for the Shoot Interaction in the myFomMap example. More...
class	VehicleDecoder
	A simple FOM Mapper decoder class for the MyFomMap example. More...
class	VehicleEncoder
	A simple FOM encoder class. More...
struct	Point2GeometryData
	an example class for Environmental Process objects More...
struct	Point1GeometryData
	An example class for the DtEnvironmentalProcess example. More...
class	TestDecoder
	This class decodes the Test interaction into the TestInteraction class. More...
class	TestEncoder
	This class encodes a Test interaction from a TestInteraction object. More...
class	TestInteraction
	The TestInteraction class is used to represent interactions of the FOM class "Test". More...
class	TestSimpleInteraction
	Define the TestSimpleInteraction class. More...

Files
file	f18Init.h
file	launcherInit.h
file	f18Init.h

Macros
#define	DtADD_ENCODER(className, derivedEnc)
#define	DtADD_DECODER(className, derivedDec)
#define	DtDECLARE_SHOOT_PARAM_DECODER(paramName)   DtDECLARE_PARAM_DECODER(DtFireInteraction, paramName)
	This macro can be used to declare the parameter decoding functions, which are static members of ShootDecoder. More...
#define	DtDECLARE_VEHICLE_ATTR_DECODER(attrName)   DtDECLARE_ATTR_DECODER(DtEntityStateRepository, attrName)
	This macro can be used to declare the attribute decoding functions, which are static members of VehicleDecoder. More...
#define	DtDECLARE_TEST_ATTR_CHECKER(attrName)   DtDECLARE_ATTR_CHECKER(DtEntityStateRepository, attrName)
	This macro is used to declare static member functions for determining whether or not an attribute's update condition has been met. More...
#define	DtDECLARE_TEST_ATTR_ENCODER(attrName)   DtDECLARE_ATTR_ENCODER(DtEntityStateRepository, attrName)
	This macro is used to declare static member functions that perform attribute encoding. More...
#define	DtDECLARE_TEST_PARAM_ENCODER(paramName)   DtDECLARE_PARAM_ENCODER(TestInteraction, paramName)
	We define several macros that can be helpful in defining the class, and the individual encoding functions. More...
#define	DtDEFINE_SIMPLE_TEST_PARAM_ENCODER(paramName, netType, inspector)
	This one can be used to define a "simple" parameter encoding function: one in which we merely obtain the data from this object using an inspector function, extract the data from the PHVPS, cast to to the "net" type used to store the FOM representation of the parameter, and add it to an RTI::ParameterHandleValuePairSet. More...

Typedefs
typedef void(*	TestInteractionCb )(TestInteraction *inter, void *usr)
	Create a type called TestInteractionCb. More...
typedef void(*	TestSimpleInteractionCb )(TestSimpleInteraction *inter, void *usr)
	Create a type called TestSimpleInteractionCb. More...

Functions
char *	DtF18EntityChooser (const char *vrlinkClassName, DtExerciseConn *exConn, void *usr)

Detailed Description

This group contains files, classes and their members that are distributed as VR-Link Examples.

These members are not considered part of the VR-Link API. Customers may use these classes as a starting point for their own applications. For more information about VR-Link Examples please see the VR-Link Examples page.

Macro Definition Documentation

#define DtADD_DECODER	(		className,
			derivedDec
	)

Value:

{ \
   DtObjClassDesc* classDesc = exConn.fom()->objClassByName(#className); \
   if (classDesc) \
   { \
      exConn.fomMapper()->stateDecoderFactory()->addDecoder( \
         classDesc->handle(), new derivedDec(&exConn, classDesc)); \
   } \
   else \
   { \
      DtWarn("Can't add decoder for object class %s: Not in FOM.\n", #className); \
   } \
}

#define DtADD_ENCODER	(		className,
			derivedEnc
	)

Value:

{ \
   DtObjClassDesc* classDesc = exConn.fom()->objClassByName(#className); \
   if (classDesc) \
   { \
      exConn.fomMapper()->stateEncoderFactory()->addEncoder( \
         classDesc->handle(), new derivedEnc(&exConn, classDesc)); \
   } \
   else \
   { \
      DtWarn("Can't add encoder for object class %s: Not in FOM.\n", #className); \
   } \
}

#define DtDECLARE_SHOOT_PARAM_DECODER

(

paramName

)

DtDECLARE_PARAM_DECODER(DtFireInteraction, paramName)

This macro can be used to declare the parameter decoding functions, which are static members of ShootDecoder.

Just pass the name of the parameter. It uses a more general macro defined in interDecoder.h.

#define DtDECLARE_TEST_ATTR_CHECKER

(

attrName

)

DtDECLARE_ATTR_CHECKER(DtEntityStateRepository, attrName)

This macro is used to declare static member functions for determining whether or not an attribute's update condition has been met.

#define DtDECLARE_TEST_ATTR_ENCODER

(

attrName

)

DtDECLARE_ATTR_ENCODER(DtEntityStateRepository, attrName)

This macro is used to declare static member functions that perform attribute encoding.

#define DtDECLARE_TEST_PARAM_ENCODER

(

paramName

)

DtDECLARE_PARAM_ENCODER(TestInteraction, paramName)

We define several macros that can be helpful in defining the class, and the individual encoding functions.

This one can be used to declare the parameter encoding functions, which are static members of TestEncoder. Just pass the name of the parameter. It uses a more general macro defined in interEncoder.h.

#define DtDECLARE_VEHICLE_ATTR_DECODER

(

attrName

)

DtDECLARE_ATTR_DECODER(DtEntityStateRepository, attrName)

This macro can be used to declare the attribute decoding functions, which are static members of VehicleDecoder.

Just pass the name of the attribute. It uses a more general macro defined in hStateDecoder.h.

#define DtDEFINE_SIMPLE_TEST_PARAM_ENCODER	(		paramName,
			netType,
			inspector
	)

Value:

DtDEFINE_SIMPLE_PARAM_ENCODER(TestEncoder, TestInteraction, \
      paramName, netType, inspector)

This one can be used to define a "simple" parameter encoding function: one in which we merely obtain the data from this object using an inspector function, extract the data from the PHVPS, cast to to the "net" type used to store the FOM representation of the parameter, and add it to an RTI::ParameterHandleValuePairSet.

This works when the native type returned by the inspector function can be implicitly cast to the "net" type. If this is not the case, a more complex parameter encoder must be written. Arguments are the name of the parameter, the "net" type to use to store the FOM representation, and the name of the mutator function to call.

Typedef Documentation

typedef void(* TestInteractionCb)(TestInteraction *inter, void *usr)

Create a type called TestInteractionCb.

Functions of this type can be registered as callbacks to be called on receipt of TestInteractions. Forward declaration of TestInteraction is necessary first.

typedef void(* TestSimpleInteractionCb)(TestSimpleInteraction *inter, void *usr)

Create a type called TestSimpleInteractionCb.

Functions of this type can be registered as callbacks to be called on receipt of TestInteractions. Forward declaration of TestSimpleInteraction is necessary first.

Function Documentation

char* DtF18EntityChooser	(	const char *	vrlinkClassName,
		DtExerciseConn *	exConn,
		void *	usr
	)

References DtRprFomMapper::dfltEntityClassChooser(), DtF18, and DtEntityType::subCategory().