environmentalProcessPdu.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2017 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <vl/pdu.h>
#include <vl/stateMsg.h>
#include <vl/exerciseConn.h>
#include <vl/environmentalGeometryRecord.h>
#include <vlpi/environmentTypeRecord.h>
#include <vlutil/vlMachineTypes.h>
#include <vl/packets/envProcP.h>
#include <vector>

class DtEnvironmentalProcessPdu;

typedef void (*DtEnvironmentalProcessPduCb)( DtEnvironmentalProcessPdu* pdu, void* usr );

#if DtDIS
class DT_DLL_VL DtEnvironmentalProcessPdu : public DtStateMsg
#else
class DT_DLL_VL DtEnvironmentalProcessPdu : public DtPdu
#endif
{
public:

   DtEnvironmentalProcessPdu( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER );

   DtEnvironmentalProcessPdu( const DtNetEnvironmentalProcessPdu* initial,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory* pduFactory = 0 );

   DtEnvironmentalProcessPdu( const DtEnvironmentalProcessPdu& orig );

   virtual ~DtEnvironmentalProcessPdu();

   DtEnvironmentalProcessPdu& operator = ( const DtEnvironmentalProcessPdu& orig );

   virtual void setEnvironmentalProcessID( const DtEntityIdentifier& entity );
   virtual const DtEntityIdentifier& environmentalProcessID() const;

   virtual void setEnvironmentType( const DtEnvironmentTypeRecord& type );
   virtual const DtEnvironmentTypeRecord& environmentType() const;

   virtual void setModelType( DtEnvironmentalModelType value );
   virtual DtEnvironmentalModelType modelType() const;

   virtual void setEnvironmentalStatus( DtU8 value );
   virtual DtU8 environmentalStatus() const;

   virtual void setEnvironmentalStatusBit( DtEnvironmentalStatusBit bit, bool value );
   virtual bool environmentalStatusBit( DtEnvironmentalStatusBit bit ) const;

   virtual bool setNumberOfEnvironmentalRecords( DtU16 newNumberOfRecords );
   virtual DtU16 numberOfEnvironmentalRecords() const;

   virtual void setSequenceNumber( DtU16 value );
   virtual DtU16 sequenceNumber() const;

   virtual bool setRecordBitSize( int recordIndex, int newRecordBitSize );

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

   virtual void setEnvironmentalRecord( int index, const DtEnvironmentalRecord& envRecord );

   virtual DtNetEnvironmentalRecord* recordPointer( int recordIndex ) const;

   //****


   virtual int numberOfGeometryRecords() const;

   virtual DtEnvironmentalRecordType geometryRecordType( int index ) const;

   virtual DtEnvironmentalRecordType stateRecordType( int index ) const;

   virtual bool getGeometryRecord( int index,
      DtEnvironmentalGeometryRecord& geometryRecord ) const;

   virtual bool getStateRecord( int index,
      DtEnvironmentalRecord& stateRecord ) const;

public:

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

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

   static void setLengthIsWholeEnvRec( bool lengthMode );
   static bool lengthIsWholeEnvRec();

protected:

   virtual DtPduKind internalGetPduKind() const;

   DtNetEnvironmentalProcessPdu* netPduStruct()  const;

   DtEnvironmentalProcessPdu* self() const;

   virtual char* var() const;

   virtual int recordOffset( int recordIndex ) const;

   virtual void invalidateCache();

   void verifyRecDataSize();

protected:

   static const int theStaticSize;
   static bool theLengthIsWholeRec;

   DtEntityIdentifier myEntityID;
   DtEnvironmentTypeRecord myEnvironmentType;
   mutable std::vector<int> myOffsetCache;

};