VR-Link API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
DtIntercomControlPdu Class Reference

Instances of DtIntercomControlPdu are used to communicate state information for simulated intercom devices. More...

+ Inheritance diagram for DtIntercomControlPdu:
+ Collaboration diagram for DtIntercomControlPdu:

Public Member Functions

 DtIntercomControlPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Constructors. More...
 
 DtIntercomControlPdu (const DtNetIntercomControlPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
 
 DtIntercomControlPdu (const DtIntercomControlPdu &orig)
 
virtual ~DtIntercomControlPdu ()
 destructor More...
 
DtIntercomControlPduoperator= (const DtIntercomControlPdu &orig)
 Assignment operator. More...
 
virtual void setControlType (DtIntercomCtlType controlType)
 Set/Get intercom control type. More...
 
virtual DtIntercomCtlType controlType () const
 
virtual void setCommClass (DtIntercomCommClass commClass)
 Set/Get intercom communications channel class. More...
 
virtual DtIntercomCommClass commClass () const
 
virtual void setCommType (DtIntercomCommType commType)
 Set/Get intercom communications channel type. More...
 
virtual DtIntercomCommType commType () const
 
virtual void setSourceEntityID (const DtEntityIdentifier &entity)
 Set/Get source entity identifier. More...
 
virtual const DtEntityIdentifiersourceEntityID () const
 
virtual void setSourceDeviceID (DtU16 deviceID)
 Set/Get source communications device ID. More...
 
virtual DtU16 sourceDeviceID () const
 
virtual void setSourceLineID (DtU8 lineID)
 Set/Get source line ID. More...
 
virtual DtU8 sourceLineID () const
 
virtual void setTransmitPriority (DtU8 transmitPriority)
 Set/Get transmit priority. More...
 
virtual DtU8 transmitPriority () const
 
virtual void setTransmitLineState (DtIntercomTransLineState lineState)
 Set/Get transmit line state. More...
 
virtual DtIntercomTransLineState transmitLineState () const
 
virtual void setCmdType (DtIntercomCmdType cmdType)
 Set/Get intercom command type. More...
 
virtual DtIntercomCmdType cmdType () const
 
virtual void setMasterEntityID (const DtEntityIdentifier &entity)
 Set/Get master entity identifier. More...
 
virtual const DtEntityIdentifiermasterEntityID () const
 
virtual void setMasterDeviceID (DtU16 deviceID)
 Set/Get master communications device ID. More...
 
virtual DtU16 masterDeviceID () const
 
virtual void setMasterChannelID (DtU16 channelID)
 Set/Get master channel ID. More...
 
virtual DtU16 masterChannelID () const
 
virtual DtU32 parmRecordsLength () const
 Get the parameters length. More...
 
virtual bool setNumParmRecords (int numRecords)
 Set/Get number of parameter records (this is not a PDU field). More...
 
virtual int numParmRecords () const
 
virtual bool getRecordType (int parmIndex, DtIntercomCtlRecType &recordType) const
 Get the record type for parameter record parmIndex. More...
 
virtual bool setParmRecord (int parmIndex, const DtIntercomEntityDestRec &init)
 Set/Get the parameter record type and values of record parmIndex to values specified by the initializer in the second argument. More...
 
virtual bool getParmRecord (int parmIndex, DtIntercomEntityDestRec &record) const
 
virtual bool setParmRecord (int parmIndex, const DtIntercomGroupDestRec &init)
 
virtual bool getParmRecord (int parmIndex, DtIntercomGroupDestRec &record) const
 
virtual bool setParmRecord (int parmIndex, const DtIntercomGroupAsgmtRec &init)
 
virtual bool getParmRecord (int parmIndex, DtIntercomGroupAsgmtRec &record) const
 
virtual void printData () const
 Print the data contained by this PDU. More...
 
virtual void printDataToStream (std::ostream &stream) const
 Print the data to a stream. More...
 
- Public Member Functions inherited from DtInteraction
 DtInteraction ()
 default constructor More...
 
virtual ~DtInteraction ()
 destructor More...
 
 DtInteraction (const DtInteraction &orig)
 copy constructor More...
 
DtInteractionoperator= (const DtInteraction &orig)
 assignment operator More...
 
- Public Member Functions inherited from DtPduWithAttributeRecordSets
 DtPduWithAttributeRecordSets ()
 Constructor. More...
 
 DtPduWithAttributeRecordSets (const DtPduWithAttributeRecordSets &orig)
 Constructor. More...
 
DtPduWithAttributeRecordSetsoperator= (const DtPduWithAttributeRecordSets &other)
 Assignment operator. More...
 
virtual ~DtPduWithAttributeRecordSets ()
 Destructor. More...
 
virtual void printToStream (std::ostream &stream) const
 Print the contents of the PDU. This will call DtPdu's printToStream and also call printRecordSets() More...
 
virtual void printRecordSets (bool printEntityObjectId=false) const
 Prints the Record Sets to DtInfo. More...
 
virtual void printRecordSetsToStream (std::ostream &stream, bool printEntityObjectId=false) const
 Prints the Record Sets to the specified stream. More...
 
virtual void addRecord (std::auto_ptr< DtStandardVariableRecord > record, const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
 Adds a Record. More...
 
virtual void removeRecord (unsigned int index, const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
 Removes a Record. More...
 
virtual void clearRecordSet (const DtEntityIdentifier &id=DtEntityIdentifier::nullId())
 Removes all Records and deletes the recordSet for the given Entity/Object Identifier. More...
 
virtual void clearAllRecordSets ()
 Removes all RecordSets. More...
 
virtual std::vector
< DtEntityIdentifier
recordSetIdentifiers () const
 Returns a vector of Entity/Object Identifiers. These are the Identifiers for the Record Sets. More...
 
virtual void getRecordSetIdentifiers (std::vector< DtEntityIdentifier > &entityIdVector) const
 Returns by reference the vector of Entity/Object Identifiers. More...
 
virtual const
DtStandardVariableRecordPtrVector
records (const DtEntityIdentifier &id=DtEntityIdentifier::nullId()) const
 This will return the Records for a given Entity/Object Identifier. More...
 
virtual const
DtAttributeRecordSet
recordSet (const DtEntityIdentifier &id) const
 This will return the Record Set for a given Entity/Object Identifier. More...
 
virtual const
DtStandardVariableRecordPtrVector 
allRecords () const
 This will return the Records of all Record Sets. More...
 
virtual unsigned int numberOfRecords () const
 Returns the number of records for all Record Sets. More...
 
virtual unsigned int numberOfRecords (const DtEntityIdentifier &id) const
 Returns the number of records in the Record Set for the given Entity/Object Identifier. More...
 
virtual bool containsStandardRecordSets () const
 Returns if this PDU contains Standard Record Sets. (This is only applicable to DIS 7 and higher). More...
 
virtual const DtSimulationAddressattributePduSimulationAddress () const
 Returns the Simulation address if an attribute PDU was coupled. Used internally in VR-Link in Reflected Lists. More...
 
virtual void setAttributePduSimulationAddress (const DtSimulationAddress &addr)
 Sets the Simulation address if an attribute PDU was coupled. Used internally in VR-Link in Reflected Lists. More...
 
virtual void encode ()
 Encode method. More...
 
virtual void decode (DtPduFactory *pduFactory=0)
 Decode method. More...
 
virtual unsigned int attributeRecordSetsNetSize () const
 Network Size of the all Attribute Record Sets. More...
 
virtual unsigned int recordSetsNetSize () const
 Network Size of the all Record Sets. More...
 
virtual void setStandardVariableRecordFactory (DtStandardVariableRecordFactory *factory)
 Sets/gets the Standard Variable Record Factory used for decoding. More...
 
virtual
DtStandardVariableRecordFactory
standardVariableRecordFactory () const
 
virtual unsigned int numberOfRecordSets () const
 Gets the number of Attribute Record Sets. More...
 
virtual const
DtAttributeRecordSetMap
attributeRecordSetMap () const
 Get the AttributeRecordSet Map. More...
 
virtual int computeMasterAttributeRecordType () const
 Get the Master Attribute Record Type (if applicable, this will return MULTIPLES_PRESENT if not) More...
 
virtual void setAttributeStrategy (DtAttributePduStrategy strat)
 
virtual DtAttributePduStrategy attributePduStrategy () const
 
virtual bool shouldAttributePduBeCoupled () const
 
- Public Member Functions inherited from DtPdu
virtual ~DtPdu ()
 Destructor. More...
 
 DtPdu (const DtPdu &pdu, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Copy constructor. More...
 
DtPduoperator= (const DtPdu &pdu)
 Assignment operator. More...
 
virtual void * packet () const
 Older function that returns a pointer to the network representation. More...
 
virtual int status () const
 Get PDU status. More...
 
virtual void setVersion (int vers)
 Set/Get protocol version from PDU header. More...
 
virtual int protocolVersion () const
 
virtual void setExerciseId (int id)
 Set/Get exerciseID in PDU header. More...
 
virtual int exerciseId () const
 
virtual DtPduKind kind () const
 Returns PDU kind from PDU header. More...
 
virtual DtProtocolFamily protocolFamily () const
 Returns protocol family from PDU header. More...
 
virtual void setTimeStamp (DtTime time, DtTimeStampType type=DtTimeStampRelative)
 Set the PDU header's time stamp to reflect time and type. More...
 
virtual DtTime timeStamp () const
 Return the time (in seconds past an hour) encoded in the PDU header's time stamp. More...
 
virtual DtTimeStampType timeStampType () const
 Return the type of the time stamp, as indicated in PDU header. More...
 
virtual void setReceivedTime (DtTime t)
 absRealTime when PDU was received into buffer. More...
 
virtual DtTime receivedTime () const
 
virtual void setPduLength (unsigned int length)
 Set the PDU header's length. More...
 
virtual unsigned int pduLength () const
 Return the length of the PDU, as indicated in the PDU header. More...
 
virtual void setPduStatus (int)
 Set the PDU Status in the PDU header. More...
 
virtual int pduStatus () const
 Returns the PDU Status from the PDU header. More...
 
virtual void setTransferredEntityIndicator (bool difference)
 Set the Transferred Entity Indicator in the PDU header False is No Difference True is Difference. More...
 
virtual bool transferredEntityIndicator () const
 Returns the Transferred Entity Indicator from the PDU header False is No Difference True is Difference. More...
 
virtual void setLvcIndicator (DtPduStatusLVCIndicator lvcIndicator)
 Set the LVC Indicator in the PDU header. More...
 
virtual DtPduStatusLVCIndicator lvcIndicator () const
 Returns the LVC Indicator from the PDU header. More...
 
virtual void setCoupledExtensionIndicator (bool coupled)
 Set the Coupled Extension Indicator in the PDU Header False is Not Coupled True is Coupled. More...
 
virtual bool coupledExtensionIndicator () const
 Returns the Coupled Extension Indicator from the PDU Header False is Not Coupled True is Coupled. More...
 
virtual void setFireTypeIndicator (DtPduStatusFireTypeIndicator fireTypeIndicator)
 Set the Fire Type Indicator in the PDU header. More...
 
virtual
DtPduStatusFireTypeIndicator 
fireTypeIndicator () const
 Returns the Fire Type Indicator from the PDU header. More...
 
virtual void setDetonationTypeIndicator (DtPduStatusDetonationTypeIndicator detonationTypeIndicator)
 Set the Detonation Type Indicator in the PDU header. More...
 
virtual
DtPduStatusDetonationTypeIndicator 
detonationTypeIndicator () const
 Returns the Detonation Type Indicator from the PDU header. More...
 
virtual void setRadioAttachedIndicator (DtPduStatusRadioAttachedIndicator radioAttachedIndicator)
 Set the Radio Attached Indicator in the PDU header. More...
 
virtual
DtPduStatusRadioAttachedIndicator 
radioAttachedIndicator () const
 Returns the Radio Attached Indicator from the PDU header. More...
 
virtual void setIntercomAttachedIndicator (DtPduStatusIntercomAttachedIndicator intercomAttachedIndicator)
 Set the Intercom Attached Indicator in the PDU header. More...
 
virtual
DtPduStatusIntercomAttachedIndicator 
intercomAttachedIndicator () const
 Returns the Intercom Attached Indicator from the PDU header. More...
 
virtual void setIffSimulationMode (bool interactive)
 Set the IFF Simulation Mode in the PDU header. More...
 
virtual bool iffSimulationMode () const
 Returns the IFF Simulation Mode from the PDU header. More...
 
virtual void setActiveInterrogationIndicator (bool active)
 Set the Active Interrogation Indicator in the PDU header. More...
 
virtual bool activeInterrogationIndicator () const
 Returns the Active Interrogation Indicator from the PDU header. More...
 
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. More...
 
virtual DtNetPduHeadernetHeader () const
 Returns a pointer to the PDU's header. More...
 
virtual void print () const
 Print the contents of the PDU by calling printToStream(DtInfo). More...
 
virtual void printHeader () const
 Print the PDU's header. This calls printHeaderToStream(DtInfo). More...
 
virtual void printHeaderToStream (std::ostream &stream) const
 Print the PDU's header to a stream. More...
 
virtual void printDataToString (DtString &str) const
 
virtual void printPduInHexToStream (std::ostream &stream, unsigned int numberOfColumns) const
 Prints the entire PDU's internal buffer to the stream in Hex. More...
 
virtual bool isTransientPdu () const
 This method returns true if transient, false if state. More...
 
- Public Member Functions inherited from DtBaseMsg
virtual ~DtBaseMsg ()
 Destructor. More...
 
 DtBaseMsg (const DtBaseMsg &msg, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
 Copy constructor. More...
 
DtBaseMsgoperator= (const DtBaseMsg &msg)
 Assignment. More...
 
virtual const char * netRep () const
 Get network representation. More...
 
virtual int length () const
 Get size of message. More...
 
 DtBaseMsg ()
 Constructor Object is not fully constructed until initMsg is called. More...
 
void initMsg (int size, DtBufferPtr bufferPtr)
 
void initMsg (const void *initial, int size, DtBufferPtr bufferPtr)
 
virtual void changeSize (int size)
 Changes the size of the message. More...
 
virtual void changeBufferSize (int size)
 Changes the size of the message buffer, but not the message itself. More...
 
virtual void insertBytes (int offset, int numBytes)
 Inserts numBytes zeroed-out bytes at the indicated offset into the net rep. More...
 
virtual void insertBytes (void *address, int numBytes)
 Inserts numBytes zeroed-out bytes at the indicated address. More...
 
virtual void deleteBytes (int offset, int numBytes)
 Deletes numBytes bytes at the indicated offset in the net rep. More...
 
virtual void deleteBytes (void *address, int numBytes)
 Deletes numBytes bytes starting at the indicated address. More...
 
virtual void clearAll ()
 Zeros out all bytes in the network representation. More...
 
virtual void * newInternalBuffer (int size)
 Sets myInternalBuff to point to a malloc'ed buffer of size bytes. More...
 

Static Public Member Functions

static DtPducreate (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
 Create a DtIntercomControlPdu. More...
 
static void addCallback (DtExerciseConn *conn, DtIntercomControlPduCb cb, void *usr)
 Add (register)/Remove (deregister) function to be called when pdu is received. More...
 
static void removeCallback (DtExerciseConn *conn, DtIntercomControlPduCb cb, void *usr)
 

Protected Member Functions

virtual DtPduKind internalGetPduKind () const
 Returns the internal PDU kind. More...
 
virtual DtNetIntercomControlPdunetPduStruct () const
 Casts the netPdu element to our network struct. More...
 
DtIntercomControlPduself () const
 Casts the 'this' pointer for changing elements in a const function. More...
 
virtual char * var () const
 Returns a pointer to the first byte of variable length data. More...
 
virtual int recordOffset (int recordIndex) const
 Returns the offset (in bytes) of the given parameter record. More...
 
virtual void resizeRecord (DtNetIntercomParmRec *rec, int newSize)
 Resize a given parameter record to the size indicated. More...
 
- Protected Member Functions inherited from DtPduWithAttributeRecordSets
virtual void deepAttributeRecordSetMapCopy (const DtAttributeRecordSetMap &orig)
 Performs a deep copy. More...
 
virtual void printRecordSetToStream (const DtEntityIdentifier &id, std::ostream &stream) const
 
- Protected Member Functions inherited from DtPdu
 DtPdu ()
 Constructor. More...
 
virtual void setStatus (int okStatus)
 Sets the PDU's status to okStatus. More...
 
virtual void initPdu (int size, DtBufferPtr buffer)
 Must be called after default ctor before PDU is completely constructed. More...
 
virtual void initPdu (const void *initial, DtBufferPtr buffer, DtPduFactory *pduFactory)
 Called by from-net-rep ctor. Initializes DtBaseMsg. More...
 
virtual DtProtocolFamily kindToFamily (DtPduKind kind) const
 Maps PDU kind to ProtocolFamily. More...
 
virtual void sizeChanged (int size)
 Called by changeSize. Sets the size in the header to size. More...
 
virtual void clearData ()
 zeros out all bytes after the PDU header. More...
 
virtual void initHeader (DtPduKind kind, int size)
 Initializes PDU header. Called by initPdu. More...
 
virtual bool isTEIApplicable () const
 Returns whether a PDU Status is applicable to this PDU (based on PDU Type) These methods are only relevant in DIS 7 and greater. More...
 
virtual bool isLVCApplicable () const
 
virtual bool isCEIApplicable () const
 
virtual bool isFTIApplicable () const
 
virtual bool isDTIApplicable () const
 
virtual bool isRAIApplicable () const
 
virtual bool isIAIApplicable () const
 
virtual bool isISMApplicable () const
 
virtual bool isAIIApplicable () const
 

Protected Attributes

int myNumParmRecords
 Number of parameter records in this PDU. More...
 
DtEntityIdentifier myEntityID
 Temporary object for reference returns. More...
 
- Protected Attributes inherited from DtPduWithAttributeRecordSets
DtAttributeRecordSetMap myAttributeRecordSetMap
 The Map which holds the Record Sets (Set of Record Sets) where the Entity Identifier is the key. More...
 
bool isRecordSetOwned
 
bool isPduExtending
 
DtStandardVariableRecordFactorymySVRFactory
 
DtPduDecodermyAttributeDecoder
 
DtPduEncodermyAttributeEncoder
 
DtSimulationAddress myAttributePduOriginatingSimulationAddress
 
DtAttributePduStrategy myAttributePduStrategy
 
- Protected Attributes inherited from DtPdu
DtPduEncodermyEncoder
 
DtPduDecodermyDecoder
 
int myOKStatus
 
DtTime myReceivedTime
 
- Protected Attributes inherited from DtBaseMsg
void * myNetMsg
 
void * myInternalBuff
 
int myIntBuffSize
 
int myMsgSize
 
int myNetworkMsgSize
 

Static Protected Attributes

static const int theStaticSize
 Size of PDU with zero parameter records. More...
 
- Static Protected Attributes inherited from DtPduWithAttributeRecordSets
static const DtAttributeRecordSet theEmptyAttributeRecordSet
 

Detailed Description

Instances of DtIntercomControlPdu are used to communicate state information for simulated intercom devices.

Constructor & Destructor Documentation

DtIntercomControlPdu::DtIntercomControlPdu ( DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER)

Constructors.

DtIntercomControlPdu::DtIntercomControlPdu ( const DtNetIntercomControlPdu initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER,
DtPduFactory pduFactory = 0 
)
DtIntercomControlPdu::DtIntercomControlPdu ( const DtIntercomControlPdu orig)
virtual DtIntercomControlPdu::~DtIntercomControlPdu ( )
virtual

destructor

Member Function Documentation

static void DtIntercomControlPdu::addCallback ( DtExerciseConn conn,
DtIntercomControlPduCb  cb,
void *  usr 
)
static

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

virtual DtIntercomCmdType DtIntercomControlPdu::cmdType ( ) const
virtual
virtual DtIntercomCommClass DtIntercomControlPdu::commClass ( ) const
virtual
virtual DtIntercomCommType DtIntercomControlPdu::commType ( ) const
virtual
virtual DtIntercomCtlType DtIntercomControlPdu::controlType ( ) const
virtual
static DtPdu* DtIntercomControlPdu::create ( const DtNetPacket initial,
DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER,
DtPduFactory pduFactory = 0 
)
static

Create a DtIntercomControlPdu.

Caller is responsible for deletion.

virtual bool DtIntercomControlPdu::getParmRecord ( int  parmIndex,
DtIntercomEntityDestRec record 
) const
virtual
virtual bool DtIntercomControlPdu::getParmRecord ( int  parmIndex,
DtIntercomGroupDestRec record 
) const
virtual
virtual bool DtIntercomControlPdu::getParmRecord ( int  parmIndex,
DtIntercomGroupAsgmtRec record 
) const
virtual
virtual bool DtIntercomControlPdu::getRecordType ( int  parmIndex,
DtIntercomCtlRecType recordType 
) const
virtual

Get the record type for parameter record parmIndex.

If parmIndex is out of range or the parameter is invalid, then false is returned.

virtual DtPduKind DtIntercomControlPdu::internalGetPduKind ( ) const
protectedvirtual

Returns the internal PDU kind.

Implements DtPdu.

virtual DtU16 DtIntercomControlPdu::masterChannelID ( ) const
virtual
virtual DtU16 DtIntercomControlPdu::masterDeviceID ( ) const
virtual
virtual const DtEntityIdentifier& DtIntercomControlPdu::masterEntityID ( ) const
virtual
virtual DtNetIntercomControlPdu* DtIntercomControlPdu::netPduStruct ( ) const
protectedvirtual

Casts the netPdu element to our network struct.

virtual int DtIntercomControlPdu::numParmRecords ( ) const
virtual
DtIntercomControlPdu& DtIntercomControlPdu::operator= ( const DtIntercomControlPdu orig)

Assignment operator.

virtual DtU32 DtIntercomControlPdu::parmRecordsLength ( ) const
virtual

Get the parameters length.

This field is automatically changed by the functions: setNumParmRecords(), and setParmRecord()

virtual void DtIntercomControlPdu::printData ( ) const
virtual

Print the data contained by this PDU.

Reimplemented from DtPdu.

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

Print the data to a stream.

Reimplemented from DtPdu.

virtual int DtIntercomControlPdu::recordOffset ( int  recordIndex) const
protectedvirtual

Returns the offset (in bytes) of the given parameter record.

static void DtIntercomControlPdu::removeCallback ( DtExerciseConn conn,
DtIntercomControlPduCb  cb,
void *  usr 
)
static
virtual void DtIntercomControlPdu::resizeRecord ( DtNetIntercomParmRec rec,
int  newSize 
)
protectedvirtual

Resize a given parameter record to the size indicated.

DtIntercomControlPdu* DtIntercomControlPdu::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 DtIntercomControlPdu::setCmdType ( DtIntercomCmdType  cmdType)
virtual

Set/Get intercom command type.

virtual void DtIntercomControlPdu::setCommClass ( DtIntercomCommClass  commClass)
virtual

Set/Get intercom communications channel class.

virtual void DtIntercomControlPdu::setCommType ( DtIntercomCommType  commType)
virtual

Set/Get intercom communications channel type.

virtual void DtIntercomControlPdu::setControlType ( DtIntercomCtlType  controlType)
virtual

Set/Get intercom control type.

virtual void DtIntercomControlPdu::setMasterChannelID ( DtU16  channelID)
virtual

Set/Get master channel ID.

virtual void DtIntercomControlPdu::setMasterDeviceID ( DtU16  deviceID)
virtual

Set/Get master communications device ID.

virtual void DtIntercomControlPdu::setMasterEntityID ( const DtEntityIdentifier entity)
virtual

Set/Get master entity identifier.

virtual bool DtIntercomControlPdu::setNumParmRecords ( int  numRecords)
virtual

Set/Get number of parameter records (this is not a PDU field).

If the required space would exceed the maximum space permitted for a PDU, then false may be returned.

virtual bool DtIntercomControlPdu::setParmRecord ( int  parmIndex,
const DtIntercomEntityDestRec init 
)
virtual

Set/Get the parameter record type and values of record parmIndex to values specified by the initializer in the second argument.

If parmIndex is out of bounds, or if the record type does not match the function (for a get), then false is returned. If the space would exceed the maximum space permitted for a PDU (for a set) then false may be returned.

virtual bool DtIntercomControlPdu::setParmRecord ( int  parmIndex,
const DtIntercomGroupDestRec init 
)
virtual
virtual bool DtIntercomControlPdu::setParmRecord ( int  parmIndex,
const DtIntercomGroupAsgmtRec init 
)
virtual
virtual void DtIntercomControlPdu::setSourceDeviceID ( DtU16  deviceID)
virtual

Set/Get source communications device ID.

virtual void DtIntercomControlPdu::setSourceEntityID ( const DtEntityIdentifier entity)
virtual

Set/Get source entity identifier.

virtual void DtIntercomControlPdu::setSourceLineID ( DtU8  lineID)
virtual

Set/Get source line ID.

virtual void DtIntercomControlPdu::setTransmitLineState ( DtIntercomTransLineState  lineState)
virtual

Set/Get transmit line state.

virtual void DtIntercomControlPdu::setTransmitPriority ( DtU8  transmitPriority)
virtual

Set/Get transmit priority.

virtual DtU16 DtIntercomControlPdu::sourceDeviceID ( ) const
virtual
virtual const DtEntityIdentifier& DtIntercomControlPdu::sourceEntityID ( ) const
virtual
virtual DtU8 DtIntercomControlPdu::sourceLineID ( ) const
virtual
virtual DtIntercomTransLineState DtIntercomControlPdu::transmitLineState ( ) const
virtual
virtual DtU8 DtIntercomControlPdu::transmitPriority ( ) const
virtual
virtual char* DtIntercomControlPdu::var ( ) const
protectedvirtual

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

Member Data Documentation

DtEntityIdentifier DtIntercomControlPdu::myEntityID
protected

Temporary object for reference returns.

int DtIntercomControlPdu::myNumParmRecords
protected

Number of parameter records in this PDU.

const int DtIntercomControlPdu::theStaticSize
staticprotected

Size of PDU with zero parameter records.


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

Document ID: Generated on Tue Feb 2 21:02:17 EST 2021 from SVN revision 223668
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)