DtCreateObjReqInter Class Reference

Instances of DtCreateObjReqInter are used to represent CreateObjectRequest Interactions in the RPR FOM. More...

Inheritance diagram for DtCreateObjReqInter:

Collaboration diagram for DtCreateObjReqInter:

Public Member Functions
	DtCreateObjReqInter ()
	default constructor
virtual	~DtCreateObjReqInter ()
	destructor
	DtCreateObjReqInter (const DtCreateObjReqInter &orig)
	copy constructor
DtCreateObjReqInter &	operator= (const DtCreateObjReqInter &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 void	setObjectClass (DtU32 id)
	Set/Get object class.
virtual DtU32	objectClass () const
virtual void	setNumPairs (DtU32 pairs)
	Set/Get the number of attribute/value pairs.
virtual DtU32	numPairs () const
virtual void	setAvPairSet (const RTI::AttributeHandleValuePairSet &atts)
virtual const RTI::AttributeHandleValuePairSet &	avPairSet () const
virtual void	setAttributeHandle (DtU32 index, DtU32 handle)
	Set/Get the attribute handle given an index.
virtual DtU32	attributeHandle (DtU32 index) const
virtual void	setAttributeValueLength (DtU32 index, DtU32 length)
	Set/Get the attribute value length given and index.
virtual DtU32	attributeValueLength (DtU32 index) const
virtual void	setAttributeValue (DtU32 index, const char *usr)
virtual const char *	attributeValue (DtU32 index) const
virtual DtDatumRecordSet *	datumRecSet ()
	Return the DtDatumRecordSet which an InteractionWithData uses to store its fixed and var records.
virtual const DtDatumRecordSet *	datumRecSet () const
virtual void	setRequestId (DtU32 id)
	Set/Get request ID.
virtual DtU32	requestId () 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	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 a DtCreateObjReqInter.
static void	addCallback (DtExerciseConn *conn, DtCreateObjReqInterCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs.
static void	removeCallback (DtExerciseConn *conn, DtCreateObjReqInterCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())

Protected Attributes
DtU32	myObjectClass
DtDatumRecordSet	myRecordSet
DtU32	myRequestId
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 DtCreateObjReqInter are used to represent CreateObjectRequest Interactions in the RPR FOM.

Constructor & Destructor Documentation

DtCreateObjReqInter::DtCreateObjReqInter

(

)

default constructor

virtual DtCreateObjReqInter::~DtCreateObjReqInter ( )

virtual

destructor

DtCreateObjReqInter::DtCreateObjReqInter

(

const DtCreateObjReqInter &

orig

)

copy constructor

Member Function Documentation

static void DtCreateObjReqInter::addCallback ( DtExerciseConn *  conn, DtCreateObjReqInterCb  cb, void *  usr, DtDDMRegionSP  region = DtDDMRegionSP()  )

static

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

virtual DtU32 DtCreateObjReqInter::attributeHandle ( DtU32  index ) const

virtual

virtual const char* DtCreateObjReqInter::attributeValue ( DtU32  index ) const

virtual

virtual DtU32 DtCreateObjReqInter::attributeValueLength ( DtU32  index ) const

virtual

virtual const RTI::AttributeHandleValuePairSet& DtCreateObjReqInter::avPairSet ( ) const

virtual

static DtInteraction* DtCreateObjReqInter::create ( )

static

Create a DtCreateObjReqInter.

Caller is responsible for deletion.

virtual DtDatumRecordSet* DtCreateObjReqInter::datumRecSet ( )

virtual

Return the DtDatumRecordSet which an InteractionWithData uses to store its fixed and var records.

In general, the wrapper functions above should be used rather than going directly through the DtDatumRecordSet, which is necessary only when doing encoding and decoding of network representations.

virtual const DtDatumRecordSet* DtCreateObjReqInter::datumRecSet ( ) const

virtual

const char * DtCreateObjReqInter::name ( ) const

inlinevirtual

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

Implements DtInteraction.

virtual DtU32 DtCreateObjReqInter::numPairs ( ) const

virtual

DtU32 DtCreateObjReqInter::objectClass ( ) const

inlinevirtual

References myObjectClass.

DtCreateObjReqInter& DtCreateObjReqInter::operator=

(

const DtCreateObjReqInter &

orig

)

assignment operator

virtual void DtCreateObjReqInter::printData ( ) const

virtual

Print the interaction's data to DtInfo.

Reimplemented from DtInteraction.

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

virtual

Print the interaction's data to the specified stream.

Reimplemented from DtInteraction.

static void DtCreateObjReqInter::removeCallback ( DtExerciseConn *  conn, DtCreateObjReqInterCb  cb, void *  usr, DtDDMRegionSP  region = DtDDMRegionSP()  )

static

DtU32 DtCreateObjReqInter::requestId ( ) const

inlinevirtual

References myRequestId.

virtual void DtCreateObjReqInter::setAttributeHandle ( DtU32  index, DtU32  handle  )

virtual

Set/Get the attribute handle given an index.

virtual void DtCreateObjReqInter::setAttributeValue ( DtU32  index, const char *  usr  )

virtual

virtual void DtCreateObjReqInter::setAttributeValueLength ( DtU32  index, DtU32  length  )

virtual

Set/Get the attribute value length given and index.

virtual void DtCreateObjReqInter::setAvPairSet ( const RTI::AttributeHandleValuePairSet &  atts )

virtual

virtual void DtCreateObjReqInter::setNumPairs ( DtU32  pairs )

virtual

Set/Get the number of attribute/value pairs.

void DtCreateObjReqInter::setObjectClass ( DtU32  id )

inlinevirtual

Set/Get object class.

References myObjectClass.

void DtCreateObjReqInter::setRequestId ( DtU32  id )

inlinevirtual

Set/Get request ID.

References myRequestId.

Member Data Documentation

DtU32 DtCreateObjReqInter::myObjectClass

protected

Referenced by objectClass(), and setObjectClass().

DtDatumRecordSet DtCreateObjReqInter::myRecordSet

protected

DtU32 DtCreateObjReqInter::myRequestId

protected

Referenced by requestId(), and setRequestId().

---

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

• createObjReqInter.h