DtActionRequestToObjInter Class Reference

Instances of DtActionRequestToObjInter are used to represent ActionRequestToObject Interactions in the RPR FOM. More...

Inheritance diagram for DtActionRequestToObjInter:

Collaboration diagram for DtActionRequestToObjInter:

Public Member Functions
	DtActionRequestToObjInter ()
	default constructor
virtual	~DtActionRequestToObjInter ()
	destructor
	DtActionRequestToObjInter (const DtActionRequestToObjInter &orig)
	copy constructor
DtActionRequestToObjInter &	operator= (const DtActionRequestToObjInter &orig)
	assignment operator
virtual void	printData () const
	Print the interaction's data to DtInfo.
virtual void	printDataToStream (std::ostream &stream) const
	Print the interaction's data to the specified stream.
virtual const DtGlobalObjectDesignatorList &	objectIDs () const
	Return the Object ID list.
virtual DtGlobalObjectDesignatorList *	objectIDs ()
virtual void	setNumIds (DtU8 numIds)
	Set/Get number of IDs.
virtual DtU8	numIds () const
virtual void	setNthObjectId (DtInt32 idIndex, const DtGlobalObjectDesignator &id)
	Set/Get the nth ObjectId.
virtual const DtGlobalObjectDesignator &	nthObjectId (DtInt32 idIndex) const
virtual void	setAction (DtActionId action)
	Set/Get action enum.
virtual DtActionId	action () const
virtual const char *	name () const
	Name of the interaction (Not necessarily the ClassName from the FOM).
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	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	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 a DtActionRequestToObjInter.
static void	addCallback (DtExerciseConn *conn, DtActionRequestToObjInterCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs.
static void	removeCallback (DtExerciseConn *conn, DtActionRequestToObjInterCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())

Protected Attributes
DtGlobalObjectDesignatorList	myObjectList
DtGlobalObjectDesignator	myNthId
DtActionId	myAction
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
Protected Member Functions inherited from DtInteractionWithEncDec
virtual DtInteractionDecoder *	createDecoder (DtExerciseConn *exConn) const
	Called by decoderToUse to obtain a new'ed decoder.
virtual DtInteractionEncoder *	createEncoder (DtExerciseConn *exConn) const
	Called by encoderToUse to obtain a new'ed encoder.
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.
Static Protected Attributes inherited from DtInteraction
static bool	theTagIsAsciiTime

Detailed Description

Instances of DtActionRequestToObjInter are used to represent ActionRequestToObject Interactions in the RPR FOM.

Constructor & Destructor Documentation

DtActionRequestToObjInter::DtActionRequestToObjInter

(

)

default constructor

virtual DtActionRequestToObjInter::~DtActionRequestToObjInter ( )

virtual

destructor

DtActionRequestToObjInter::DtActionRequestToObjInter

(

const DtActionRequestToObjInter &

orig

)

copy constructor

Member Function Documentation

virtual DtActionId DtActionRequestToObjInter::action ( ) const

virtual

static void DtActionRequestToObjInter::addCallback ( DtExerciseConn *  conn, DtActionRequestToObjInterCb  cb, void *  usr, DtDDMRegionSP  region = DtDDMRegionSP()  )

static

Add (register)/Remove (deregister) function to be called when interaction occurs.

static DtInteraction* DtActionRequestToObjInter::create ( )

static

Create a DtActionRequestToObjInter.

Caller is responsible for deletion.

virtual const char* DtActionRequestToObjInter::name ( ) const

virtual

Name of the interaction (Not necessarily the ClassName from the FOM).

Implements DtInteraction.

virtual const DtGlobalObjectDesignator& DtActionRequestToObjInter::nthObjectId ( DtInt32  idIndex ) const

virtual

virtual DtU8 DtActionRequestToObjInter::numIds ( ) const

virtual

virtual const DtGlobalObjectDesignatorList& DtActionRequestToObjInter::objectIDs ( ) const

virtual

Return the Object ID list.

virtual DtGlobalObjectDesignatorList* DtActionRequestToObjInter::objectIDs ( )

virtual

DtActionRequestToObjInter& DtActionRequestToObjInter::operator=

(

const DtActionRequestToObjInter &

orig

)

assignment operator

virtual void DtActionRequestToObjInter::printData ( ) const

virtual

Print the interaction's data to DtInfo.

Reimplemented from DtInteraction.

virtual void DtActionRequestToObjInter::printDataToStream ( std::ostream &  stream ) const

virtual

Print the interaction's data to the specified stream.

Reimplemented from DtInteraction.

static void DtActionRequestToObjInter::removeCallback ( DtExerciseConn *  conn, DtActionRequestToObjInterCb  cb, void *  usr, DtDDMRegionSP  region = DtDDMRegionSP()  )

static

virtual void DtActionRequestToObjInter::setAction ( DtActionId  action )

virtual

Set/Get action enum.

virtual void DtActionRequestToObjInter::setNthObjectId ( DtInt32  idIndex, const DtGlobalObjectDesignator &  id  )

virtual

Set/Get the nth ObjectId.

virtual void DtActionRequestToObjInter::setNumIds ( DtU8  numIds )

virtual

Set/Get number of IDs.

Member Data Documentation

DtActionId DtActionRequestToObjInter::myAction

protected

DtGlobalObjectDesignator DtActionRequestToObjInter::myNthId

protected

DtGlobalObjectDesignatorList DtActionRequestToObjInter::myObjectList

protected

---

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

• actionRequestToObjInter.h