 |
VR-Link API Documentation for DIS
|
|
VR-Link API Documentation for DIS
|
class DtMinefieldStatePdu: More...
Inheritance diagram for DtMinefieldStatePdu: Collaboration diagram for DtMinefieldStatePdu:Public Member Functions | |
| DtMinefieldStatePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| Constructors. | |
| DtMinefieldStatePdu (const DtNetMinefieldStatePdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) | |
| DtMinefieldStatePdu (const DtMinefieldStatePdu &orig) | |
| virtual | ~DtMinefieldStatePdu () |
| destructor | |
| DtMinefieldStatePdu & | operator= (const DtMinefieldStatePdu &orig) |
| Assignment operator. | |
| virtual void | setMinefieldID (const DtEntityIdentifier &id) |
| Set/Get minefield ID. | |
| virtual const DtEntityIdentifier & | minefieldID () const |
| virtual void | setSequenceNumber (DtU16 field) |
| Set/Get minefield sequence number. | |
| virtual DtU16 | sequenceNumber () const |
| virtual void | setForceID (DtForceType force) |
| Set/Get the force ID. | |
| virtual DtForceType | forceID () const |
| virtual bool | setNumPerimeterPoints (DtU8 num) |
| Set/Get the number of perimeter points. | |
| virtual DtU8 | numPerimeterPoints () const |
| virtual void | setMinefieldType (const DtEntityType &type) |
| Set/Get minefield type. | |
| virtual const DtEntityType & | minefieldType () const |
| virtual bool | setNumMineTypes (DtU16 num) |
| Set/Get the number of mine types. | |
| virtual DtU16 | numMineTypes () const |
| virtual void | setLocation (const DtVector &coords) |
| Set/Get location of minefield. | |
| virtual const DtVector & | location () const |
| virtual void | setOrientation (const DtTaitBryan &orientation) |
| Set/Get orientation. | |
| virtual const DtTaitBryan & | orientation () const |
| virtual void | setAppearance (DtU16 app) |
| Set/Get appearance (as a 16 bit integer). | |
| virtual DtU16 | appearance () const |
| virtual void | setAppearanceAttribute (DtAppearAttribute attr, DtAppearAttrVal val) |
| Set/Get appearance by attribute. | |
| virtual DtAppearAttrVal | appearanceAttribute (DtAppearAttribute attr) const |
| virtual void | setMinefieldProtocolMode (DtMinefieldProtocol mode) |
| Set/Get which network protocol mode is being used in the minefield transmission. | |
| virtual DtMinefieldProtocol | minefieldProtocolMode () const |
| virtual bool | setPerimeterPoint (int index, const DtMinefieldPerimeterRecord &init) |
| Set/Get a perimeter point coordinate record, returns false if the index is out of range. | |
| virtual bool | getPerimeterPoint (int index, DtMinefieldPerimeterRecord &record) const |
| virtual bool | setMineType (int index, const DtEntityType &init) |
| Set/Get a mine type record. | |
| virtual bool | getMineType (int index, DtEntityType &record) 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. | |
Static Public Member Functions | |
| static DtPdu * | create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER) |
| Create a DtMinefieldStatePdu. | |
| static void | addCallback (DtExerciseConn *conn, DtMinefieldStatePduCb cb, void *usr) |
| Add (register)/Remove (deregister) function to be called when pdu is received. | |
| static void | removeCallback (DtExerciseConn *conn, DtMinefieldStatePduCb cb, void *usr) |
Protected Member Functions | |
| virtual DtPduKind | internalGetPduKind () const |
| Returns the internal PDU kind. | |
| virtual DtNetMinefieldStatePdu * | netPduStruct () const |
| Casts the netPdu element to our network struct. | |
| DtMinefieldStatePdu * | self () const |
| Casts the 'this' pointer for changing elements in a const function Non-virtual since you can't override based on return type. | |
| virtual char * | var () const |
| Returns a pointer to the first byte of variable length data. | |
| virtual int | perimeterPointRecordOffset (int recordIndex) const |
| Returns a buffer offset to a perimeter point record. | |
| virtual int | mineTypeRecordOffset (int recordIndex) const |
| Returns a buffer offset to a mine type record. | |
Protected Attributes | |
| DtEntityIdentifier | myEntityID |
| Temporary objects for reference returns. | |
| DtEntityType | myEntityType |
| DtTaitBryan | myEulerAngles |
| DtVector | myVector |
| DtMinefieldPerimeterRecord | myPerimeterRecord |
Static Protected Attributes | |
| static const int | theStaticSize |
| Size of PDU with zero parameter records. | |
class DtMinefieldStatePdu:
Instances of DtMinefieldStatePdu are used to communicate minefield state information.
Constructors.
| DtMinefieldStatePdu::DtMinefieldStatePdu | ( | const DtNetMinefieldStatePdu * | initial, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) |
| DtMinefieldStatePdu::DtMinefieldStatePdu | ( | const DtMinefieldStatePdu & | orig | ) |
| virtual DtMinefieldStatePdu::~DtMinefieldStatePdu | ( | ) | [virtual] |
destructor
| static void DtMinefieldStatePdu::addCallback | ( | DtExerciseConn * | conn, |
| DtMinefieldStatePduCb | cb, | ||
| void * | usr | ||
| ) | [static] |
Add (register)/Remove (deregister) function to be called when pdu is received.
| virtual DtU16 DtMinefieldStatePdu::appearance | ( | ) | const [virtual] |
| virtual DtAppearAttrVal DtMinefieldStatePdu::appearanceAttribute | ( | DtAppearAttribute | attr | ) | const [virtual] |
| static DtPdu* DtMinefieldStatePdu::create | ( | const DtNetPacket * | initial, |
| DtBufferPtr | buffer = DtUSE_INTERNAL_BUFFER |
||
| ) | [static] |
Create a DtMinefieldStatePdu.
Caller is responsible for deletion.
| virtual DtForceType DtMinefieldStatePdu::forceID | ( | ) | const [virtual] |
| virtual bool DtMinefieldStatePdu::getMineType | ( | int | index, |
| DtEntityType & | record | ||
| ) | const [virtual] |
| virtual bool DtMinefieldStatePdu::getPerimeterPoint | ( | int | index, |
| DtMinefieldPerimeterRecord & | record | ||
| ) | const [virtual] |
| virtual DtPduKind DtMinefieldStatePdu::internalGetPduKind | ( | ) | const [protected, virtual] |
Returns the internal PDU kind.
Implements DtPdu.
| virtual const DtVector& DtMinefieldStatePdu::location | ( | ) | const [virtual] |
| virtual const DtEntityIdentifier& DtMinefieldStatePdu::minefieldID | ( | ) | const [virtual] |
| virtual DtMinefieldProtocol DtMinefieldStatePdu::minefieldProtocolMode | ( | ) | const [virtual] |
| virtual const DtEntityType& DtMinefieldStatePdu::minefieldType | ( | ) | const [virtual] |
| virtual int DtMinefieldStatePdu::mineTypeRecordOffset | ( | int | recordIndex | ) | const [protected, virtual] |
Returns a buffer offset to a mine type record.
| virtual DtNetMinefieldStatePdu* DtMinefieldStatePdu::netPduStruct | ( | ) | const [protected, virtual] |
Casts the netPdu element to our network struct.
| virtual DtU16 DtMinefieldStatePdu::numMineTypes | ( | ) | const [virtual] |
| virtual DtU8 DtMinefieldStatePdu::numPerimeterPoints | ( | ) | const [virtual] |
| DtMinefieldStatePdu& DtMinefieldStatePdu::operator= | ( | const DtMinefieldStatePdu & | orig | ) |
Assignment operator.
| virtual const DtTaitBryan& DtMinefieldStatePdu::orientation | ( | ) | const [virtual] |
| virtual int DtMinefieldStatePdu::perimeterPointRecordOffset | ( | int | recordIndex | ) | const [protected, virtual] |
Returns a buffer offset to a perimeter point record.
| virtual void DtMinefieldStatePdu::printData | ( | ) | const [virtual] |
Print the data contained by this PDU.
Reimplemented from DtPdu.
| virtual void DtMinefieldStatePdu::printDataToStream | ( | std::ostream & | stream | ) | const [virtual] |
Print the data to a stream.
Reimplemented from DtPdu.
| static void DtMinefieldStatePdu::removeCallback | ( | DtExerciseConn * | conn, |
| DtMinefieldStatePduCb | cb, | ||
| void * | usr | ||
| ) | [static] |
| DtMinefieldStatePdu* DtMinefieldStatePdu::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 DtU16 DtMinefieldStatePdu::sequenceNumber | ( | ) | const [virtual] |
| virtual void DtMinefieldStatePdu::setAppearance | ( | DtU16 | app | ) | [virtual] |
Set/Get appearance (as a 16 bit integer).
| virtual void DtMinefieldStatePdu::setAppearanceAttribute | ( | DtAppearAttribute | attr, |
| DtAppearAttrVal | val | ||
| ) | [virtual] |
Set/Get appearance by attribute.
| virtual void DtMinefieldStatePdu::setForceID | ( | DtForceType | force | ) | [virtual] |
Set/Get the force ID.
| virtual void DtMinefieldStatePdu::setLocation | ( | const DtVector & | coords | ) | [virtual] |
Set/Get location of minefield.
| virtual void DtMinefieldStatePdu::setMinefieldID | ( | const DtEntityIdentifier & | id | ) | [virtual] |
Set/Get minefield ID.
| virtual void DtMinefieldStatePdu::setMinefieldProtocolMode | ( | DtMinefieldProtocol | mode | ) | [virtual] |
Set/Get which network protocol mode is being used in the minefield transmission.
| virtual void DtMinefieldStatePdu::setMinefieldType | ( | const DtEntityType & | type | ) | [virtual] |
Set/Get minefield type.
| virtual bool DtMinefieldStatePdu::setMineType | ( | int | index, |
| const DtEntityType & | init | ||
| ) | [virtual] |
Set/Get a mine type record.
Returns false if the index is out of range.
| virtual bool DtMinefieldStatePdu::setNumMineTypes | ( | DtU16 | num | ) | [virtual] |
Set/Get the number of mine types.
| virtual bool DtMinefieldStatePdu::setNumPerimeterPoints | ( | DtU8 | num | ) | [virtual] |
Set/Get the number of perimeter points.
| virtual void DtMinefieldStatePdu::setOrientation | ( | const DtTaitBryan & | orientation | ) | [virtual] |
Set/Get orientation.
| virtual bool DtMinefieldStatePdu::setPerimeterPoint | ( | int | index, |
| const DtMinefieldPerimeterRecord & | init | ||
| ) | [virtual] |
Set/Get a perimeter point coordinate record, returns false if the index is out of range.
| virtual void DtMinefieldStatePdu::setSequenceNumber | ( | DtU16 | field | ) | [virtual] |
Set/Get minefield sequence number.
| virtual char* DtMinefieldStatePdu::var | ( | ) | const [protected, virtual] |
Returns a pointer to the first byte of variable length data.
DtEntityIdentifier DtMinefieldStatePdu::myEntityID [protected] |
Temporary objects for reference returns.
DtEntityType DtMinefieldStatePdu::myEntityType [protected] |
DtTaitBryan DtMinefieldStatePdu::myEulerAngles [protected] |
DtVector DtMinefieldStatePdu::myVector [protected] |
const int DtMinefieldStatePdu::theStaticSize [static, protected] |
Size of PDU with zero parameter records.
