Instances of DtCommentInteraction are used to represent Comment Interactions in the RPR FOM. More...

Inheritance diagram for DtCommentInteraction:

Collaboration diagram for DtCommentInteraction:

Public Member Functions
	DtCommentInteraction ()
	default constructor
virtual	~DtCommentInteraction ()
	destructor
	DtCommentInteraction (const DtCommentInteraction &orig)
	copy constructor
DtCommentInteraction &	operator= (const DtCommentInteraction &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	setSenderId (const DtEntityIdentifier &id)
	Set/Get sender ID.
virtual const DtEntityIdentifier &	senderId () const
virtual void	setReceiverId (const DtEntityIdentifier &id)
	Set/Get receiver ID.
virtual const DtEntityIdentifier &	receiverId () const
virtual void	setComment (const char *message, int size)
	Set/Get the comment; warning: inspector returns a readable text string.
virtual const char *	comment () const
virtual const char *	name () const
	Name of the interaction. (Not necessarily the ClassName from the FOM.)
Public Member Functions inherited from DtInteractionWithData
	DtInteractionWithData ()
	default constructor
virtual	~DtInteractionWithData ()
	destructor
	DtInteractionWithData (const DtInteractionWithData &orig)
	copy constructor
DtInteractionWithData &	operator= (const DtInteractionWithData &orig)
	assignment operator
virtual int	numFixedFields () const
virtual int	numVarFields () const
	Returns number of variable length fields.
virtual DtDatumParam	varDatumId (int index) const
	Returns the datum param found in the index'th variable datum record.
virtual void	setVarDatumId (int index, DtDatumParam id, DtDatumRetCode *retcode=0)
virtual DtDatumParam	fixedDatumId (int index) const
	Returns the datum param found in the index'th fixed datum record.
virtual void	setFixedDatumId (int index, DtDatumParam id, DtDatumRetCode *retcode=0)
virtual DtDatumParam	datumId (DtDatumRecordType fixedOrVar, int index) const
	Returns the datum param found in the index'th fixed or variable datum record, depending on whether fixedOrVar is DtFixed or DtVar.
virtual int	datumSizeBits (DtDatumRecordType fixedOrVar, int index) const
	Returns the number of bits of data contained in the value fields of the index'th fixed or variable datum record, depending on whether fixedOrVar is DtFixed or DtVar.
virtual int	datumSizeBytes (DtDatumRecordType fixedOrVar, int index) const
	Returns the number of bytes of data contained in the value fields of the index'th fixed or variable datum record, depending on whether fixedOrVar is DtFixed or DtVar.
virtual void	getIndex (DtDatumParam param, DtDatumRecordType fixedOrVar, int index, DtDatumRetCode *retcode=0) const
	Looks through all fixed and variable records for one containing param as the parameter ID.
virtual DtFloat32	datumValFloat32 (DtDatumRecordType fixedOrVar, int index, DtDatumRetCode *retcode=0) const
	***** INSPECTING DATUM VALUES BY INDEX ******* If you know the data type of the value contained in a particular record, use one of the following to return it.
virtual DtFloat64	datumValFloat64 (DtDatumRecordType fixedOrVar, int index, DtDatumRetCode *retcode=0) const
virtual unsigned long	datumValUnsigned32 (DtDatumRecordType fixedOrVar, int index, DtDatumRetCode *retcode=0) const
virtual long	datumValInt32 (DtDatumRecordType fixedOrVar, int index, DtDatumRetCode *retcode=0) const
virtual const char *	datumValByteArray (DtDatumRecordType fixedOrVar, int index) const
virtual DtFloat32	datumValFloat32 (DtDatumParam param, DtDatumRetCode *retcode=0) const
	***** INSPECTING DATUM VALUES BY PARAM ID ******* If you know the data type of the value contained in a particular record, use one of the following to return it.
virtual DtFloat64	datumValFloat64 (DtDatumParam param, DtDatumRetCode *retcode=0) const
virtual unsigned long	datumValUnsigned32 (DtDatumParam param, DtDatumRetCode *retcode=0) const
virtual long	datumValInt32 (DtDatumParam param, DtDatumRetCode *retcode=0) const
virtual const char *	datumValByteArray (DtDatumParam param, DtDatumRetCode *retcode=0) const
virtual void	initDataSection (const DtDatumParam fixedParams, const DtVarDatumSpec specList)
	**************** MUTATOR FUNCTIONS ****************
virtual void	setNumFixedFields (int newNum)
	Sets the number of fixed or variable fields to newNum.
virtual void	setNumVarFields (int newNum)
virtual void	setDatumParam (DtDatumRecordType fixedOrVar, int index, DtDatumParam param, DtDatumRetCode *retcode=0)
	Set the datum ID in the index'th fixed or variable datum record to param, depending on whether fixedOrVar is DtFixed or DtVar.
virtual void	setVarDataBytes (int index, int length, DtDatumRetCode *retcode=0)
	Allocates length bytes for the index'th variable datum record.
virtual void	setDatumValFloat64 (DtDatumRecordType fixedOrVar, int index, DtFloat64 val, DtDatumRetCode *retcode=0)
	***** SETTING DATA VALUES BY INDEX ******* Use one of the following to set the data value in a fixed or variable datum record, depending on the data type of your data.
virtual void	setDatumValFloat32 (DtDatumRecordType fixedOrVar, int index, DtFloat32 val, DtDatumRetCode *retcode=0)
virtual void	setDatumValInt32 (DtDatumRecordType fixedOrVar, int index, long val, DtDatumRetCode *retcode=0)
virtual void	setDatumValUnsigned32 (DtDatumRecordType fixedOrVar, int index, unsigned long val, DtDatumRetCode *retcode=0)
virtual void	setDatumValByteArray (DtDatumRecordType fixedOrVar, int index, const char val, DtDatumRetCode retcode=0)
virtual void	setDatumValFloat64 (DtDatumParam param, DtFloat64 val, DtDatumRetCode *retcode=0)
	**** SETTING DATA VALUES BY PARAM ID ******* Use one of the following to set the data value in a fixed or variable datum record, depending on the data type of your data.
virtual void	setDatumValFloat32 (DtDatumParam param, DtFloat32 val, DtDatumRetCode *retcode=0)
virtual void	setDatumValInt32 (DtDatumParam param, long val, DtDatumRetCode *retcode=0)
virtual void	setDatumValUnsigned32 (DtDatumParam param, unsigned long val, DtDatumRetCode *retcode=0)
virtual void	setDatumValByteArray (DtDatumParam param, const char val, DtDatumRetCode retcode=0)
virtual DtDatumRecordSet *	datumRecSet ()
	Return the DtDatumRecordSet which an InteractionWithData uses to store its fixed and var records.
virtual const DtDatumRecordSet *	datumRecSet () 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::ParameterHandleValueMap &	phvm () const
	Get the parameter handle value pair set for the interaction.
virtual void	setFromPhvm (const RTI::ParameterHandleValueMap &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 RTI::VariableLengthData &a_tag)
	Set the user-defined tag.
virtual void	setTag (const RTI::VariableLengthData &tag)
	Set the user-defined tag.
virtual const RTI::VariableLengthData &	tag () const
	Get the user-defined tag.
virtual const RTI::RegionHandleSet *	conveyedRegion () const
	Get & Set the conveyed region of the reflected state message.
virtual void	setConveyedRegion (const RTI::RegionHandleSet *sentRegionHandleSet)
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::LogicalTime &ft)
	This is used for TSO interactions.
virtual const RTI::LogicalTime *	fedTime () const
	When the interaction is received, if the federate sending the interaction had TSO set then the fedTime will be set.
virtual void	setMessageRetractionHandle (const RTI::MessageRetractionHandle &handle)
	Get/Set the MessageRetractionHandle.
virtual RTI::MessageRetractionHandle	messageRetractionHandle () const
	Get the message retraction handle. For more info see setMessageRetractionHandle.

Static Public Member Functions
static DtInteraction *	create ()
	Create a DtCommentInteraction.
static void	addCallback (DtExerciseConn conn, DtCommentInteractionCb cb, void usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs.
static void	removeCallback (DtExerciseConn conn, DtCommentInteractionCb cb, void usr, DtDDMRegionSP region=DtDDMRegionSP())

Protected Attributes
DtEntityIdentifier	myOrigEnt
DtEntityIdentifier	myReceiveEnt
Protected Attributes inherited from DtInteractionWithData
DtDatumRecordSet	myRecSet
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
RTI::LogicalTime *	myFedTime
RTI::ParameterHandleValueMap	myPvList
RTI::MessageRetractionHandle	myRetractionHandle
RTI::VariableLengthData	myTag
const RTI::RegionHandleSet *	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 DtCommentInteraction are used to represent Comment Interactions in the RPR FOM.

The variable datum record is accessed through DtInteractionWithData member functions.

Constructor & Destructor Documentation

DtCommentInteraction::DtCommentInteraction ( )

default constructor

virtual DtCommentInteraction::~DtCommentInteraction ( )

virtual

destructor

DtCommentInteraction::DtCommentInteraction ( const DtCommentInteraction & orig )

copy constructor

Member Function Documentation

static void DtCommentInteraction::addCallback	(	DtExerciseConn *	conn,
		DtCommentInteractionCb	cb,
		void *	usr,
		DtDDMRegionSP	region = `DtDDMRegionSP()`
	)

static

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

virtual const char* DtCommentInteraction::comment ( ) const

virtual

static DtInteraction* DtCommentInteraction::create ( )

static

Create a DtCommentInteraction.

Caller is responsible for deletion.

virtual const char* DtCommentInteraction::name ( ) const

virtual

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

Implements DtInteraction.

DtCommentInteraction& DtCommentInteraction::operator= ( const DtCommentInteraction & orig )

assignment operator

virtual void DtCommentInteraction::printData ( ) const

virtual

Print the interaction's data to DtInfo.

Reimplemented from DtInteractionWithData.

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

virtual

Print the interaction's data to the specified stream.

Reimplemented from DtInteractionWithData.

virtual const DtEntityIdentifier& DtCommentInteraction::receiverId ( ) const

virtual

static void DtCommentInteraction::removeCallback	(	DtExerciseConn *	conn,
		DtCommentInteractionCb	cb,
		void *	usr,
		DtDDMRegionSP	region = `DtDDMRegionSP()`
	)

static

virtual const DtEntityIdentifier& DtCommentInteraction::senderId ( ) const

virtual

virtual void DtCommentInteraction::setComment	(	const char *	message,
		int	size
	)

virtual

Set/Get the comment; warning: inspector returns a readable text string.

Use DtInteractionWithData member functions to get non-string comments. Comments are sent in the first Var Message Record.

virtual void DtCommentInteraction::setReceiverId ( const DtEntityIdentifier & id )

virtual

Set/Get receiver ID.

virtual void DtCommentInteraction::setSenderId ( const DtEntityIdentifier & id )

virtual

Set/Get sender ID.

Member Data Documentation

DtEntityIdentifier DtCommentInteraction::myOrigEnt

protected

DtEntityIdentifier DtCommentInteraction::myReceiveEnt

protected

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

commentInteractionHLA.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation