intercomControlPdu.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1992-2013 VT MAK
** All rights reserved.
*********************************************************************/



#pragma once

#if DtDIS

#include <vlutil/vlMachineTypes.h>
#include "hostStructs.h"
#include "interactionDIS.h"
#include "exerciseConn.h"

#include "packets/intercmCtlP.h"

#include "intercomParmRec.h"
#include "intercomEntityDestRec.h"
#include "intercomGroupAsgmtRec.h"
#include "intercomGroupDestRec.h"



class DT_DLL_VL DtIntercomControlPdu;

typedef void (*DtIntercomControlPduCb)(DtIntercomControlPdu* pdu, void* usr);


class DT_DLL_VL DtIntercomControlPdu : public DtInteraction
{

public:

   DtIntercomControlPdu(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
   DtIntercomControlPdu(const DtNetIntercomControlPdu* initial,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory* pduFactory = 0);
   DtIntercomControlPdu(const DtIntercomControlPdu& orig);

   virtual ~DtIntercomControlPdu();

   DtIntercomControlPdu& operator=(const DtIntercomControlPdu& orig);

   virtual void setControlType(DtIntercomCtlType controlType);
   virtual DtIntercomCtlType controlType() const;

   virtual void setCommClass(DtIntercomCommClass commClass);
   virtual DtIntercomCommClass commClass() const;

   virtual void setCommType(DtIntercomCommType commType);
   virtual DtIntercomCommType commType() const;

   virtual void setSourceEntityID(const DtEntityIdentifier& entity);
   virtual const DtEntityIdentifier& sourceEntityID() const;

   virtual void setSourceDeviceID(DtU16 deviceID);
   virtual DtU16 sourceDeviceID() const;

   virtual void setSourceLineID(DtU8 lineID);
   virtual DtU8 sourceLineID() const;

   virtual void setTransmitPriority(DtU8 transmitPriority);
   virtual DtU8 transmitPriority() const; 

   virtual void setTransmitLineState(DtIntercomTransLineState lineState);
   virtual DtIntercomTransLineState transmitLineState() const;

   virtual void setCmdType(DtIntercomCmdType cmdType);
   virtual DtIntercomCmdType cmdType() const;

   virtual void setMasterEntityID(const DtEntityIdentifier& entity);
   virtual const DtEntityIdentifier& masterEntityID() const;

   virtual void setMasterDeviceID(DtU16 deviceID);
   virtual DtU16 masterDeviceID() const;

   virtual void setMasterChannelID(DtU16 channelID);
   virtual DtU16 masterChannelID() const;

   virtual DtU32 parmRecordsLength() const;

   virtual bool setNumParmRecords(int numRecords);
   virtual int numParmRecords() const;

   virtual bool getRecordType(int parmIndex,
      DtIntercomCtlRecType& recordType) const;

   virtual bool setParmRecord(int parmIndex,
      const DtIntercomEntityDestRec& init);
   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;

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

public:

   static DtPdu* create(const DtNetPacket* initial,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory* pduFactory = 0);

   static void addCallback(DtExerciseConn* conn,
      DtIntercomControlPduCb cb, void* usr);
   static void removeCallback(DtExerciseConn* conn,
      DtIntercomControlPduCb cb, void* usr);

protected:

   virtual DtPduKind internalGetPduKind() const;

   virtual DtNetIntercomControlPdu* netPduStruct()  const; 

   DtIntercomControlPdu* self() const; 

   virtual char* var() const;

   virtual int recordOffset(int recordIndex) const;

   virtual void resizeRecord(DtNetIntercomParmRec* rec, int newSize);

protected:

   static const int theStaticSize;

protected:

   int myNumParmRecords;

   DtEntityIdentifier myEntityID;

};

#endif