TestInteraction Class Reference

The TestInteraction class is used to represent interactions of the FOM class "Test". More...

Inheritance diagram for TestInteraction:

Collaboration diagram for TestInteraction:

Public Member Functions
	TestInteraction ()
	Blank Constructor - constructs a blank TestInteraction ready to be filled out and sent by application code.
virtual	~TestInteraction ()
	Destructor Not required by VR-Link, but should clearly be written if this class has any dynamic data that needs to be cleaned up.
	TestInteraction (const TestInteraction &orig)
	Copy constructor.
TestInteraction &	operator= (const TestInteraction &orig)
	Assignment operator.
virtual const char *	name () const
	Virtual function override.
virtual void	printData () const
	Virtual function override.
virtual void	setNumber (int num)
	Set/Get the parameter named "Number".
virtual int	number () const
virtual void	setVector (const DtVector &vec)
	Set/Get the parameter named "Vector".
virtual const DtVector &	vector () const
Public Member Functions inherited from DtInteractionWithEncDec
	DtInteractionWithEncDec ()
	default constructor
virtual	~DtInteractionWithEncDec ()
	destructor
	DtInteractionWithEncDec (const DtInteractionWithEncDec &orig)
	copy constructor
DtInteractionWithEncDec &	operator= (const DtInteractionWithEncDec &orig)
	assignment operator
virtual void	setExConn (DtExerciseConn *exConn, DtInterClassDesc *classDesc=NULL)
	Sets the interaction's ExerciseConn and class descriptor.
virtual const RTI::ParameterHandleValuePairSet &	phvps () const
	Get the parameter handle value pair set for the interaction.
virtual void	setFromPhvps (const RTI::ParameterHandleValuePairSet &pvList)
	Set contents from a parameter handle value pair set.
virtual void	useThese (DtInteractionEncoder *enc, DtInteractionDecoder *dec, DtInteractionRep *data)
	Specify an encoder, decoder, and interaction data repository to use in encoding and decoding.
virtual DtInteractionEncoder *	encoder () const
	Return the encoder we are using.
virtual DtInteractionDecoder *	decoder () const
	Return the decoder we are using.
virtual void	setParameterByHandle (const RTI::ParameterHandle &attrHdl, const char *attrValue, unsigned size)
	Set the Parameter with the given handle.
virtual const char *	getParameterByHandle (const RTI::ParameterHandle &attrHdl, unsigned &size) const
	Get a pointer to Parameter value for the Parameter with the given handle.
virtual void	setParameterByName (const DtString &name, const char *attrValue, unsigned size)
	Set the Parameter with the given name.
virtual const char *	getParameterByName (const DtString &name, unsigned &size) const
	Get a pointer to Parameter value for the Parameter with the given name.
Public Member Functions inherited from DtInteraction
	DtInteraction ()
	default constructor
virtual	~DtInteraction ()
	destructor
	DtInteraction (const DtInteraction &orig)
	copy constructor
DtInteraction &	operator= (const DtInteraction &orig)
	assignment operator
virtual RTI::InteractionClassHandle	interactionClassHandle () const
	Get the interaction class handle. Returns 0 if no classDesc.
virtual char *	interactionClassName () const
	Get the interaction class name. Returns NULL if no classDesc.
virtual int	numParameters () const
	Get the number of parameters. Returns 0 if no classDesc.
virtual bool	neededByFederation () const
	Returns true if the interaction class is needed by the federation false otherwise.
virtual void	print () const
	Print the interaction's host rep data, including header.
virtual void	printToStream (std::ostream &stream) const
	Print the interaction to a stream.
virtual void	printHeader () const
	Print the header info.
virtual void	printHeaderToStream (std::ostream &stream) const
	Print the header info to a stream.
virtual void	printDataToString (DtString &buff) const
	Print the interaction's data to the string provided.
virtual void	printDataToStream (std::ostream &stream) const
	Print the interaction's data to the stream.
virtual void	printParams (bool withHex) const
	Print the header followed by the interaction's parameters.
virtual void	printParamsToStream (std::ostream &stream, bool withHex) const
	Print the header followed by the interaction's parameters to a stream.
virtual DtExerciseConn *	exerciseConn () const
	Get the current exercise connection.
virtual DtInterClassDesc *	classDesc () const
	Get the current class descriptor we're using for this interaction.
virtual bool	customTagSet () const
	Get whether a custom tag has been set on the interaction or not.
virtual void	setCustomTag (const DtString &a_tag)
	Set the user-defined tag.
virtual void	setTag (const DtString &tag)
	Set the user-defined tag.
virtual const DtString &	tag () const
	Get the user-defined tag.
virtual const RTI::Region *	conveyedRegion () const
	Get & Set the conveyed region of the reflected state message.
virtual void	setConveyedRegion (const RTI::Region *region)
virtual void	setProducingFederateHandle (RTI::FederateHandle federateHandle)
	HLA Evolved added an argument that provides the FederateHandle of the federate that produced the interaction being received.
virtual RTI::FederateHandle	producingFederateHandle () const
	The producing federate handle. Invalid if not enabled (or could be from MOM).
virtual const DtString &	producingFederateName () const
	The producing federate handle is used to get the federate name (cached after first access).
virtual void	setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
	Set the time of validity of the message, and whether this represents relative or absolute time.
virtual DtTime	timeStamp () const
	Return the time of validity of the message (in seconds past an hour) as set by setTimeStamp.
virtual DtTimeStampType	timeStampType () const
	Return the type of the time stamp.
virtual DtTime	guessTimeValid (DtTime referenceTime) const
	Since timestamp only represents number of seconds past the hour, guessTimeValid chooses the hour that would make the timestamp closest to reference time, and returns a time that is timestamp seconds past that hour.
virtual void	setFedTime (const RTI::FedTime &ft)
	This is used for TSO interactions.
virtual const RTI::FedTime *	fedTime () const
	When the interaction is received, if the federate sending the interaction had TSO set then the fedTime will be set.
virtual void	setEventRetractionHandle (const RTI::EventRetractionHandle &handle)
	Get/Set the EventRetractionHandle.
virtual RTI::EventRetractionHandle	eventRetractionHandle () const
	Get the event retraction handle. For more info see setEventRetractionHandle.

Static Public Member Functions
static DtInteraction *	create ()
	Create and return a new TestInteraction.
static void	addCallback (DtExerciseConn *conn, TestInteractionCb cb, void *usr)
	Wrappers around DtExerciseConn's add/removeCallback functions.
static void	removeCallback (DtExerciseConn *conn, TestInteractionCb cb, void *usr)

Protected Member Functions
virtual const char *	interactionClassToUse (DtExerciseConn *exConn) const
	Virtual function override.
virtual DtInteractionDecoder *	createDecoder (DtExerciseConn *exConn) const
	Virtual function override.
virtual DtInteractionEncoder *	createEncoder (DtExerciseConn *exConn) const
	Virtual function override.
Protected Member Functions inherited from DtInteractionWithEncDec
virtual DtInteractionDecoder *	decoderToUse (DtExerciseConn *exConn) const
	Returns a decoder to use for decoding the interaction.
virtual DtInteractionEncoder *	encoderToUse (DtExerciseConn *exConn) const
	Returns an encoder to use for encoding the interaction.
Protected Member Functions inherited from DtInteraction
virtual RTI::ParameterHandleValuePairSet *	privPvList () const
	Returns a pointer to a private pvList that can be used as a return value by phvps.
DtInteraction *	self () const
	Get rid of const-ness on the "this" pointer in order to access non-const functions from const member functions (such as simple accessors).

Protected Attributes
int	myNum
DtVector	myVec
Protected Attributes inherited from DtInteractionWithEncDec
DtInteractionDecoder *	myDecoder
DtInteractionEncoder *	myEncoder
DtInteractionRep *	myData
std::map< RTI::ParameterHandle, DtGenericParameterInfo * >	myParametersByHandle
	parameters by handle.
Protected Attributes inherited from DtInteraction
DtInterClassDesc *	myClassDesc
DtExerciseConn *	myExConn
DtTime	myTime
DtTimeStampType	myTimeType
DtString	myTag
RTI::ParameterHandleValuePairSet *	myPvList
int	myPvListMaxSize
RTI::FedTime *	myFedTime
RTI::EventRetractionHandle	myRetractionHandle
const RTI::Region *	myConveyedRegion
bool	myCustomTagSet

Additional Inherited Members
Static Protected Attributes inherited from DtInteraction
static bool	theTagIsAsciiTime

Detailed Description

The TestInteraction class is used to represent interactions of the FOM class "Test".

It has two parameters: "Number", which is represented by a 32-bit integer, and "Vector", which is represented by an array of three 64-bit floating point numbers (doubles).

Constructor & Destructor Documentation

TestInteraction::TestInteraction

(

)

Blank Constructor - constructs a blank TestInteraction ready to be filled out and sent by application code.

Required.

virtual TestInteraction::~TestInteraction ( )

virtual

Destructor Not required by VR-Link, but should clearly be written if this class has any dynamic data that needs to be cleaned up.

TestInteraction::TestInteraction

(

const TestInteraction &

orig

)

Copy constructor.

Not required by VR-Link, but needed if you will ever want to copy TestInteractions.

Member Function Documentation

static void TestInteraction::addCallback ( DtExerciseConn *  conn, TestInteractionCb  cb, void *  usr  )

static

Wrappers around DtExerciseConn's add/removeCallback functions.

Not required since the DtExerciseConn functions may be used instead, but strongly encouraged, so that the non-typesafe cast can be limited to this one place. In addition, within add-callback, we choose to register the TestInteraction class with VR-Link, letting VR-Link know to create one of these to represent the right FOM class.

static DtInteraction* TestInteraction::create ( )

static

Create and return a new TestInteraction.

Basically a wrapper around the constructor. It is necessary because pointers to static functions like this can be registered with a DtInteractionFactory, but constructors can not. Required.

virtual DtInteractionDecoder* TestInteraction::createDecoder ( DtExerciseConn *  exConn ) const

protectedvirtual

Virtual function override.

Creates and returns a decoder to be used by setFromPhvps to decode a ParameterHandleValuePairSet into this interaction. Implementing this function is required, unless you would like to rely on the default behavior - which is to obtain a new instance of the right decoder from the FOM Mapper. If you choose this option, you must configure the FOM Mapper so that it can correctly provide this object.

Reimplemented from DtInteractionWithEncDec.

virtual DtInteractionEncoder* TestInteraction::createEncoder ( DtExerciseConn *  exConn ) const

protectedvirtual

Virtual function override.

Creates and returns an encoder to be used by phvps to encode the data in this interaction into a ParameterHandleValuePairSet. Implementing this function is required, unless you would like to rely on the default behavior - which is to obtain a new instance of the right encoder from the FOM Mapper. If you choose this option, you must configure the FOM Mapper so that it can correctly provide this object.

Reimplemented from DtInteractionWithEncDec.

virtual const char* TestInteraction::interactionClassToUse ( DtExerciseConn *  exConn ) const

protectedvirtual

Virtual function override.

Returns the name of the FOM class to use to represent this interaction when sending. It is called from within setExConn, when that function is called by DtExerciseConn::send. Implementing this function is required unless you would like to rely on the default behavior - which is to obtain the class to use from the FOM Mapper. If you choose this option, you must configure the FomMapper so that it can correctly provide this information.

Reimplemented from DtInteraction.

virtual const char* TestInteraction::name ( ) const

virtual

Virtual function override.

Should return the name of this C++ class, which is not necessarily the Interaction Class name from the FOM. Required.

Implements DtInteraction.

virtual int TestInteraction::number ( ) const

virtual

TestInteraction& TestInteraction::operator=

(

const TestInteraction &

orig

)

Assignment operator.

Not required by VR-Link, but needed if you will ever want to copy TestInteractions.

virtual void TestInteraction::printData ( ) const

virtual

Virtual function override.

Prints the data values in the interaction. Not strictly required, but encouraged, since otherwise calling print() on an instance of this class with merely print raw hex data.

Reimplemented from DtInteraction.

static void TestInteraction::removeCallback ( DtExerciseConn *  conn, TestInteractionCb  cb, void *  usr  )

static

virtual void TestInteraction::setNumber ( int  num )

virtual

Set/Get the parameter named "Number".

virtual void TestInteraction::setVector ( const DtVector &  vec )

virtual

Set/Get the parameter named "Vector".

virtual const DtVector& TestInteraction::vector ( ) const

virtual

Member Data Documentation

int TestInteraction::myNum

protected

DtVector TestInteraction::myVec

protected

---

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

• testInter.h