DtLeAppearancePdu Class Reference

class DtLeAppearancePdu: More...

Inheritance diagram for DtLeAppearancePdu:

Collaboration diagram for DtLeAppearancePdu:

Public Member Functions
	DtLeAppearancePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructors.
	DtLeAppearancePdu (const DtNetLeAppearancePdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtLeAppearancePdu (const DtLeAppearancePdu &orig)
virtual	~DtLeAppearancePdu ()
	destructor
DtLeAppearancePdu &	operator= (const DtLeAppearancePdu &orig)
	Assignment operator.
virtual void	setSubProtocol (DtSubProtocol value)
	Set/Get the sub-protocol number.
virtual DtSubProtocol	subProtocol () const
virtual void	setEntityID (const DtLeEntityID &id)
	Set/Get entity ID.
virtual const DtLeEntityID &	entityID () const
virtual DtU8	appearanceField1 () const
	Get the first appearance flag field (this field is automatically maintained by the PDU as other PDU fields are set).
virtual bool	appearanceField1Flag (DtLE_AppearanceField1Flag flag) const
	Get the value for a specific appearance flag from the first appearance field.
virtual bool	getAppearanceField2 (DtU8 &value) const
	The following accessor functions refer to records which are optional.
virtual bool	getAppearanceField2Flag (DtLE_AppearanceField2Flag flag, bool &value) const
	Get the value for a specific appearance flag from the second appearance field.
virtual void	setForceID (DtForceType force)
	Set/Get the force ID.
virtual bool	getForceID (DtForceType &force) const
virtual void	setEntityType (const DtEntityType &type)
	Set/Get entity type.
virtual bool	getEntityType (DtEntityType &type) const
virtual void	setAlternativeEntityType (const DtEntityType &type)
	Set/Get alternative entity type.
virtual bool	getAlternativeEntityType (DtEntityType &type) const
virtual void	setMarkingCharacterSet (DtCharacterSet value)
	Set/Get marking character set.
virtual bool	getMarkingCharacterSet (DtCharacterSet &value) const
virtual void	setMarkingText (DtU8 *dataPtr)
	Set/Get marking text (copies 11 bytes).
virtual bool	getMarkingText (DtU8 *dataPtr) const
virtual void	setCapabilities (DtU32 value)
	Set/Get capabilities (as a 32-bit integer).
virtual bool	getCapabilities (DtU32 &value) const
virtual void	setCapability (DtCapability flag, bool value)
	Set/Get a particular capability (as a Boolean).
virtual bool	getCapability (DtCapability flag, bool &value) const
virtual void	setVisualAppearance (DtU32 value)
	Set/Get visual appearance (as a 32 bit integer).
virtual bool	getVisualAppearance (DtU32 &value) const
virtual void	setVisualAppearanceAttribute (DtAppearAttribute attr, DtAppearAttrVal val)
	Set/Get appearance by attribute.
virtual bool	getVisualAppearanceAttribute (DtAppearAttribute attr, DtAppearAttrVal &val)
virtual void	setIR_Appearance (DtU32 value)
	Set/Get IR appearance (as a 32 bit integer).
virtual bool	getIR_Appearance (DtU32 &value) const
virtual void	setEM_Appearance (DtU32 value)
	Set/Get EM appearance (as a 32 bit integer).
virtual bool	getEM_Appearance (DtU32 &value) const
virtual void	setAudioAppearance (DtU32 value)
	Set/Get audio appearance (as a 32 bit integer).
virtual bool	getAudioAppearance (DtU32 &value) const
virtual void	printData () const
	Print the data contained by this PDU.
virtual void	printDataToStream (std::ostream &stream) const
	Print the data to a stream.
virtual void	printHeader () const
	Print the header (override to include the new sub-protocol field).
virtual void	printHeaderToStream (std::ostream &stream) const
	Print the header to a stream.
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	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)
	Create a DtLeAppearancePdu.
static void	addCallback (DtExerciseConn *conn, DtLeAppearancePduCb cb, void *usr)
	Add (register)/Remove (deregister) function to be called when pdu is received.
static void	removeCallback (DtExerciseConn *conn, DtLeAppearancePduCb cb, void *usr)

Protected Member Functions
virtual DtPduKind	internalGetPduKind () const
	Returns the internal PDU kind.
virtual DtNetLeAppearancePdu *	netPduStruct () const
	Casts the netPdu element to our network struct.
DtLeAppearancePdu *	self () const
	Casts the 'this' pointer for changing elements in a const function.
virtual char *	var () const
	Returns a pointer to the first byte of variable length data.
virtual void	setAppearanceField1 (DtU8 value)
	Set appearance field 1.
virtual void	setAppearanceField1Flag (DtLE_AppearanceField1Flag flag)
	Set a flag of appearance field 1.
virtual void	clearField1Flags (DtLE_AppearanceField1Flag flag)
	Clear a flag and all following flags in appearance field 1.
virtual void	setAppearanceField2 (DtU8 value)
	Set appearance field 2.
virtual void	setAppearanceField2Flag (DtLE_AppearanceField2Flag flag)
	Set a flag of appearance field 2.
virtual int	appearanceField1Offset () const
	Returns the offset (in bytes) of a field in the variable data region.
virtual int	appearanceField2Offset () const
virtual int	forceID_Offset () const
virtual int	entityTypeOffset () const
virtual int	alternativeEntityTypeOffset () const
virtual int	entityMarkingOffset () const
virtual int	capabilitiesOffset () const
virtual int	visualAppearanceOffset () const
virtual int	IR_AppearanceOffset () const
virtual int	EM_AppearanceOffset () const
virtual int	audioAppearanceOffset () const

Protected Attributes
DtLeEntityID	myEntityID
	Temporary objects for reference returns.

Static Protected Attributes
static const int	theStaticSize
	Size of PDU with zero parameter records.

Detailed Description

class DtLeAppearancePdu:

Instances of DtLeAppearancePdu are used to send appearance information for live entities.

Constructor & Destructor Documentation

DtLeAppearancePdu::DtLeAppearancePdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructors.

DtLeAppearancePdu::DtLeAppearancePdu	(	const DtNetLeAppearancePdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

DtLeAppearancePdu::DtLeAppearancePdu

(

const DtLeAppearancePdu &

orig

)

virtual DtLeAppearancePdu::~DtLeAppearancePdu ( )

virtual

destructor

Member Function Documentation

static void DtLeAppearancePdu::addCallback ( DtExerciseConn *  conn, DtLeAppearancePduCb  cb, void *  usr  )

static

Add (register)/Remove (deregister) function to be called when pdu is received.

virtual int DtLeAppearancePdu::alternativeEntityTypeOffset ( ) const

protectedvirtual

virtual DtU8 DtLeAppearancePdu::appearanceField1 ( ) const

virtual

Get the first appearance flag field (this field is automatically maintained by the PDU as other PDU fields are set).

virtual bool DtLeAppearancePdu::appearanceField1Flag ( DtLE_AppearanceField1Flag  flag ) const

virtual

Get the value for a specific appearance flag from the first appearance field.

virtual int DtLeAppearancePdu::appearanceField1Offset ( ) const

protectedvirtual

Returns the offset (in bytes) of a field in the variable data region.

virtual int DtLeAppearancePdu::appearanceField2Offset ( ) const

protectedvirtual

virtual int DtLeAppearancePdu::audioAppearanceOffset ( ) const

protectedvirtual

virtual int DtLeAppearancePdu::capabilitiesOffset ( ) const

protectedvirtual

virtual void DtLeAppearancePdu::clearField1Flags ( DtLE_AppearanceField1Flag  flag )

protectedvirtual

Clear a flag and all following flags in appearance field 1.

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

static

Create a DtLeAppearancePdu.

Caller is responsible for deletion.

virtual int DtLeAppearancePdu::EM_AppearanceOffset ( ) const

protectedvirtual

virtual const DtLeEntityID& DtLeAppearancePdu::entityID ( ) const

virtual

virtual int DtLeAppearancePdu::entityMarkingOffset ( ) const

protectedvirtual

virtual int DtLeAppearancePdu::entityTypeOffset ( ) const

protectedvirtual

virtual int DtLeAppearancePdu::forceID_Offset ( ) const

protectedvirtual

virtual bool DtLeAppearancePdu::getAlternativeEntityType ( DtEntityType &  type ) const

virtual

virtual bool DtLeAppearancePdu::getAppearanceField2 ( DtU8 &  value ) const

virtual

The following accessor functions refer to records which are optional.

The set methods create the record in the PDU if it does not already exist. The get methods return false if the record does not exist. Get the second appearance flag field (this field is automatically maintained by the PDU as other PDU fields are set).

virtual bool DtLeAppearancePdu::getAppearanceField2Flag ( DtLE_AppearanceField2Flag  flag, bool &  value  ) const

virtual

Get the value for a specific appearance flag from the second appearance field.

virtual bool DtLeAppearancePdu::getAudioAppearance ( DtU32 &  value ) const

virtual

virtual bool DtLeAppearancePdu::getCapabilities ( DtU32 &  value ) const

virtual

virtual bool DtLeAppearancePdu::getCapability ( DtCapability  flag, bool &  value  ) const

virtual

virtual bool DtLeAppearancePdu::getEM_Appearance ( DtU32 &  value ) const

virtual

virtual bool DtLeAppearancePdu::getEntityType ( DtEntityType &  type ) const

virtual

virtual bool DtLeAppearancePdu::getForceID ( DtForceType &  force ) const

virtual

virtual bool DtLeAppearancePdu::getIR_Appearance ( DtU32 &  value ) const

virtual

virtual bool DtLeAppearancePdu::getMarkingCharacterSet ( DtCharacterSet &  value ) const

virtual

virtual bool DtLeAppearancePdu::getMarkingText ( DtU8 *  dataPtr ) const

virtual

virtual bool DtLeAppearancePdu::getVisualAppearance ( DtU32 &  value ) const

virtual

virtual bool DtLeAppearancePdu::getVisualAppearanceAttribute ( DtAppearAttribute  attr, DtAppearAttrVal &  val  )

virtual

virtual DtPduKind DtLeAppearancePdu::internalGetPduKind ( ) const

protectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

virtual int DtLeAppearancePdu::IR_AppearanceOffset ( ) const

protectedvirtual

virtual DtNetLeAppearancePdu* DtLeAppearancePdu::netPduStruct ( ) const

protectedvirtual

Casts the netPdu element to our network struct.

DtLeAppearancePdu& DtLeAppearancePdu::operator=

(

const DtLeAppearancePdu &

orig

)

Assignment operator.

virtual void DtLeAppearancePdu::printData ( ) const

virtual

Print the data contained by this PDU.

Reimplemented from DtPdu.

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

virtual

Print the data to a stream.

Reimplemented from DtPdu.

virtual void DtLeAppearancePdu::printHeader ( ) const

virtual

Print the header (override to include the new sub-protocol field).

Reimplemented from DtPdu.

virtual void DtLeAppearancePdu::printHeaderToStream ( std::ostream &  stream ) const

virtual

Print the header to a stream.

Reimplemented from DtPdu.

static void DtLeAppearancePdu::removeCallback ( DtExerciseConn *  conn, DtLeAppearancePduCb  cb, void *  usr  )

static

DtLeAppearancePdu* DtLeAppearancePdu::self ( ) const

protected

Casts the 'this' pointer for changing elements in a const function.

Non-virtual, since you can't override based on return type.

virtual void DtLeAppearancePdu::setAlternativeEntityType ( const DtEntityType &  type )

virtual

Set/Get alternative entity type.

virtual void DtLeAppearancePdu::setAppearanceField1 ( DtU8  value )

protectedvirtual

Set appearance field 1.

virtual void DtLeAppearancePdu::setAppearanceField1Flag ( DtLE_AppearanceField1Flag  flag )

protectedvirtual

Set a flag of appearance field 1.

virtual void DtLeAppearancePdu::setAppearanceField2 ( DtU8  value )

protectedvirtual

Set appearance field 2.

virtual void DtLeAppearancePdu::setAppearanceField2Flag ( DtLE_AppearanceField2Flag  flag )

protectedvirtual

Set a flag of appearance field 2.

virtual void DtLeAppearancePdu::setAudioAppearance ( DtU32  value )

virtual

Set/Get audio appearance (as a 32 bit integer).

virtual void DtLeAppearancePdu::setCapabilities ( DtU32  value )

virtual

Set/Get capabilities (as a 32-bit integer).

virtual void DtLeAppearancePdu::setCapability ( DtCapability  flag, bool  value  )

virtual

Set/Get a particular capability (as a Boolean).

virtual void DtLeAppearancePdu::setEM_Appearance ( DtU32  value )

virtual

Set/Get EM appearance (as a 32 bit integer).

virtual void DtLeAppearancePdu::setEntityID ( const DtLeEntityID &  id )

virtual

Set/Get entity ID.

virtual void DtLeAppearancePdu::setEntityType ( const DtEntityType &  type )

virtual

Set/Get entity type.

virtual void DtLeAppearancePdu::setForceID ( DtForceType  force )

virtual

Set/Get the force ID.

virtual void DtLeAppearancePdu::setIR_Appearance ( DtU32  value )

virtual

Set/Get IR appearance (as a 32 bit integer).

virtual void DtLeAppearancePdu::setMarkingCharacterSet ( DtCharacterSet  value )

virtual

Set/Get marking character set.

virtual void DtLeAppearancePdu::setMarkingText ( DtU8 *  dataPtr )

virtual

Set/Get marking text (copies 11 bytes).

virtual void DtLeAppearancePdu::setSubProtocol ( DtSubProtocol  value )

virtual

Set/Get the sub-protocol number.

virtual void DtLeAppearancePdu::setVisualAppearance ( DtU32  value )

virtual

Set/Get visual appearance (as a 32 bit integer).

virtual void DtLeAppearancePdu::setVisualAppearanceAttribute ( DtAppearAttribute  attr, DtAppearAttrVal  val  )

virtual

Set/Get appearance by attribute.

virtual DtSubProtocol DtLeAppearancePdu::subProtocol ( ) const

virtual

virtual char* DtLeAppearancePdu::var ( ) const

protectedvirtual

Returns a pointer to the first byte of variable length data.

virtual int DtLeAppearancePdu::visualAppearanceOffset ( ) const

protectedvirtual

Member Data Documentation

DtLeEntityID DtLeAppearancePdu::myEntityID

protected

Temporary objects for reference returns.

const int DtLeAppearancePdu::theStaticSize

staticprotected

Size of PDU with zero parameter records.

---

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

• leAppearPdu.h