DtServiceRequestPdu Class Reference

Inheritance diagram for DtServiceRequestPdu:

Collaboration diagram for DtServiceRequestPdu:

Public Types
enum	{ PduStaticSize = 28 }

Public Member Functions
	DtServiceRequestPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtServiceRequestPdu (const DtNetServiceRequestPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtServiceRequestPdu (const DtEntityIdentifier &requester, const DtEntityIdentifier &servicer, DtServiceType serviceType=DtServiceTypeRepair, DtBufferPtr another=DtUSE_INTERNAL_BUFFER)
	DtServiceRequestPdu (const DtEntityIdentifier &requester, const DtEntityIdentifier &servicer, const DtEntityType &supply, float quantity, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
const DtEntityIdentifier &	requestingId () const
void	setRequestingId (const DtEntityIdentifier &requester)
const DtEntityIdentifier &	servicingId () const
void	setServicingId (const DtEntityIdentifier &servicer)
DtServiceType	serviceType () const
void	setServiceType (DtServiceType service)
int	numSupplyTypes () const
void	setNumSupplyTypes (int numTypes)
const DtEntityType &	nthSupply (int supplyIndex, float *quantity=NULL, int *retCode=NULL) const
void	setNthSupply (int supplyIndex, const DtEntityType &supply, float quantity, int *retCode=NULL)
float	supplyQuantity (const DtEntityType &supply) const
virtual void	printData () const
	Print the PDU's data (not including header).
virtual void	printDataToStream (std::ostream &stream) const
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
Public Member Functions inherited from DtPdu
virtual	~DtPdu ()
	Destructor.
	DtPdu (const DtPdu &pdu, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Copy constructor.
DtPdu &	operator= (const DtPdu &pdu)
	Assignment operator.
virtual void *	packet () const
	Older function that returns a pointer to the network representation.
virtual int	status () const
	Get PDU status.
virtual void	setVersion (int vers)
	Set/Get protocol version from PDU header.
virtual int	protocolVersion () const
virtual void	setExerciseId (int id)
	Set/Get exerciseID in PDU header.
virtual int	exerciseId () const
virtual DtPduKind	kind () const
	Returns PDU kind from PDU header.
virtual DtProtocolFamily	protocolFamily () const
	Returns protocol family from PDU header.
virtual void	setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
	Set the PDU header's time stamp to reflect time and type.
virtual DtTime	timeStamp () const
	Return the time (in seconds past an hour) encoded in the PDU header's time stamp.
virtual DtTimeStampType	timeStampType () const
	Return the type of the time stamp, as indicated in PDU header.
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 DtNetPduHeader *	netHeader () const
	Returns a pointer to the PDU's header.
virtual void	print () const
	Print the contents of the PDU by calling printToStream(DtInfo).
virtual void	printToStream (std::ostream &stream) const
	Print the contents of the PDU by calling printHeaderToStream and printDataToStream.
virtual void	printHeader () const
	Print the PDU's header. This calls printHeaderToStream(DtInfo).
virtual void	printHeaderToStream (std::ostream &stream) const
	Print the PDU's header to a stream.
virtual void	printDataToString (DtString &str) const
Public Member Functions inherited from DtBaseMsg
virtual	~DtBaseMsg ()
	Destructor.
	DtBaseMsg (const DtBaseMsg &msg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Copy constructor.
DtBaseMsg &	operator= (const DtBaseMsg &msg)
	Assignment.
virtual const char *	netRep () const
	Get network representation.
virtual int	length () const
	Get size of message.

Static Public Member Functions
static DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
static void	addCallback (DtExerciseConn *conn, DtServiceRequestPduCb cb, void *usr)
static void	removeCallback (DtExerciseConn *conn, DtServiceRequestPduCb cb, void *usr)

Protected Member Functions
DtPduKind	internalGetPduKind () const
	Returns the PDU kind associated with the derived PDU class.
int	indexInBounds (int ind) const

Protected Attributes
DtEntityIdentifier	reqId
DtEntityIdentifier	servId
DtEntityType	supType

Member Enumeration Documentation

anonymous enum

Enumerator:

PduStaticSize

Constructor & Destructor Documentation

DtServiceRequestPdu::DtServiceRequestPdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

DtServiceRequestPdu::DtServiceRequestPdu	(	const DtNetServiceRequestPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtServiceRequestPdu::DtServiceRequestPdu	(	const DtEntityIdentifier &	requester,
		const DtEntityIdentifier &	servicer,
		DtServiceType	serviceType = DtServiceTypeRepair,
		DtBufferPtr	another = DtUSE_INTERNAL_BUFFER
	)

DtServiceRequestPdu::DtServiceRequestPdu	(	const DtEntityIdentifier &	requester,
		const DtEntityIdentifier &	servicer,
		const DtEntityType &	supply,
		float	quantity,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

Member Function Documentation

static void DtServiceRequestPdu::addCallback ( DtExerciseConn *  conn, DtServiceRequestPduCb  cb, void *  usr  )

static

static DtPdu* DtServiceRequestPdu::create ( const DtNetPacket *  initial, DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER  )

static

int DtServiceRequestPdu::indexInBounds ( int  ind ) const

protected

DtPduKind DtServiceRequestPdu::internalGetPduKind ( ) const

inlineprotectedvirtual

Returns the PDU kind associated with the derived PDU class.

Implements DtPdu.

References DtServiceRequestPduKind.

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

int DtServiceRequestPdu::numSupplyTypes

(

)

const

virtual void DtServiceRequestPdu::printData ( ) const

virtual

Print the PDU's data (not including header).

Base DtPdu version just prints hex. Use the printDataToString to put the data into a DtString instead of simply sending the output to stdout. printData() calls printDataToStream(DtInfo).

Reimplemented from DtPdu.

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

virtual

Reimplemented from DtPdu.

static void DtServiceRequestPdu::removeCallback ( DtExerciseConn *  conn, DtServiceRequestPduCb  cb, void *  usr  )

static

const DtEntityIdentifier& DtServiceRequestPdu::requestingId

(

)

const

DtServiceType DtServiceRequestPdu::serviceType

(

)

const

const DtEntityIdentifier& DtServiceRequestPdu::servicingId

(

)

const

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

void DtServiceRequestPdu::setNumSupplyTypes

(

int

numTypes

)

void DtServiceRequestPdu::setRequestingId

(

const DtEntityIdentifier &

requester

)

void DtServiceRequestPdu::setServiceType

(

DtServiceType

service

)

void DtServiceRequestPdu::setServicingId

(

const DtEntityIdentifier &

servicer

)

float DtServiceRequestPdu::supplyQuantity

(

const DtEntityType &

supply

)

const

Member Data Documentation

DtEntityIdentifier DtServiceRequestPdu::reqId

protected

DtEntityIdentifier DtServiceRequestPdu::servId

protected

DtEntityType DtServiceRequestPdu::supType

protected

---

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

• servReqPdu.h