DtResupplyOfferInteraction Class Reference

class DtResupplyOfferInteraction: More...

Inheritance diagram for DtResupplyOfferInteraction:

Collaboration diagram for DtResupplyOfferInteraction:

Public Member Functions
	DtResupplyOfferInteraction ()
	default constructor
virtual	~DtResupplyOfferInteraction ()
	destructor
	DtResupplyOfferInteraction (const DtResupplyOfferInteraction &orig)
	copy constructor
DtResupplyOfferInteraction &	operator= (const DtResupplyOfferInteraction &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	setReceivingId (const DtGlobalObjectDesignator &receiver)
	Set/Get the receiving object.
virtual const DtGlobalObjectDesignator &	receivingId () const
virtual void	setSupplyingId (const DtGlobalObjectDesignator &supplier)
	Set/Get the repairing object.
virtual const DtGlobalObjectDesignator &	supplyingId () const
virtual void	setSupplies (const void *data, int numBytes)
	Set/Get the supplies memory block all at once.
virtual const void *	supplies () const
virtual void	setNumSupplyTypes (int numTypes)
	Supporting functions to get/set the Supply Array.
virtual int	numSupplyTypes () const
virtual void	setNthSupply (int supplyIndex, const DtEntityType &supply, float quantity, int *retCode=NULL)
virtual const DtEntityType &	nthSupply (int supplyIndex, float *quantity=NULL, int *retCode=NULL) const
virtual float	supplyQuantity (const DtEntityType &supply) const
virtual void	changeSuppliesSize (int newSize)
virtual int	indexInBounds (int ind) 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::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 DtResupplyOfferInteraction.
static void	addCallback (DtExerciseConn *conn, DtResupplyOfferInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
	Add (register)/Remove (deregister) function to be called when interaction occurs.
static void	removeCallback (DtExerciseConn *conn, DtResupplyOfferInteractionCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())

Protected Attributes
DtGlobalObjectDesignator	myReceivingObject
DtGlobalObjectDesignator	mySupplyingObject
int	myNumSupplyTypes
DtNetSupplyQuantity *	mySupplies
DtEntityType	myNthSupply
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

class DtResupplyOfferInteraction:

Instances of DtResupplyOfferInteraction are used to represent ResupplyOffer Interactions in the RPR FOM.

Constructor & Destructor Documentation

DtResupplyOfferInteraction::DtResupplyOfferInteraction

(

)

default constructor

virtual DtResupplyOfferInteraction::~DtResupplyOfferInteraction ( )

virtual

destructor

DtResupplyOfferInteraction::DtResupplyOfferInteraction

(

const DtResupplyOfferInteraction &

orig

)

copy constructor

Member Function Documentation

static void DtResupplyOfferInteraction::addCallback ( DtExerciseConn *  conn, DtResupplyOfferInteractionCb  cb, void *  usr, DtDDMRegionSP  region = DtDDMRegionSP()  )

static

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

virtual void DtResupplyOfferInteraction::changeSuppliesSize ( int  newSize )

virtual

static DtInteraction* DtResupplyOfferInteraction::create ( )

static

Create a DtResupplyOfferInteraction.

Caller is responsible for deletion.

virtual int DtResupplyOfferInteraction::indexInBounds ( int  ind ) const

virtual

const char * DtResupplyOfferInteraction::name ( ) const

inlinevirtual

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

Implements DtInteraction.

virtual const DtEntityType& DtResupplyOfferInteraction::nthSupply ( int  supplyIndex, float *  quantity = NULL, int *  retCode = NULL  ) const

virtual

virtual int DtResupplyOfferInteraction::numSupplyTypes ( ) const

virtual

DtResupplyOfferInteraction& DtResupplyOfferInteraction::operator=

(

const DtResupplyOfferInteraction &

orig

)

assignment operator

virtual void DtResupplyOfferInteraction::printData ( ) const

virtual

Print the interaction's data to DtInfo.

Reimplemented from DtInteraction.

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

virtual

Print the interaction's data to the specified stream.

Reimplemented from DtInteraction.

const DtGlobalObjectDesignator & DtResupplyOfferInteraction::receivingId ( ) const

inlinevirtual

References myReceivingObject.

static void DtResupplyOfferInteraction::removeCallback ( DtExerciseConn *  conn, DtResupplyOfferInteractionCb  cb, void *  usr, DtDDMRegionSP  region = DtDDMRegionSP()  )

static

virtual void DtResupplyOfferInteraction::setNthSupply ( int  supplyIndex, const DtEntityType &  supply, float  quantity, int *  retCode = NULL  )

virtual

virtual void DtResupplyOfferInteraction::setNumSupplyTypes ( int  numTypes )

virtual

Supporting functions to get/set the Supply Array.

void DtResupplyOfferInteraction::setReceivingId ( const DtGlobalObjectDesignator &  receiver )

inlinevirtual

Set/Get the receiving object.

References myReceivingObject.

virtual void DtResupplyOfferInteraction::setSupplies ( const void *  data, int  numBytes  )

virtual

Set/Get the supplies memory block all at once.

void DtResupplyOfferInteraction::setSupplyingId ( const DtGlobalObjectDesignator &  supplier )

inlinevirtual

Set/Get the repairing object.

References mySupplyingObject.

virtual const void* DtResupplyOfferInteraction::supplies ( ) const

virtual

const DtGlobalObjectDesignator & DtResupplyOfferInteraction::supplyingId ( ) const

inlinevirtual

References mySupplyingObject.

virtual float DtResupplyOfferInteraction::supplyQuantity ( const DtEntityType &  supply ) const

virtual

Member Data Documentation

DtEntityType DtResupplyOfferInteraction::myNthSupply

protected

int DtResupplyOfferInteraction::myNumSupplyTypes

protected

DtGlobalObjectDesignator DtResupplyOfferInteraction::myReceivingObject

protected

Referenced by receivingId(), and setReceivingId().

DtNetSupplyQuantity* DtResupplyOfferInteraction::mySupplies

protected

DtGlobalObjectDesignator DtResupplyOfferInteraction::mySupplyingObject

protected

Referenced by setSupplyingId(), and supplyingId().

---

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

• resupplyOfferInteraction.h