underwaterAcousticPdu.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2013 MAK Technologies, Inc
 * All rights reserved.
 ****************************************************************************/


#pragma once

#if DtDIS

#include <vlutil/vlMachineTypes.h>

#include <vl/packets/undwaAcP.h>
#include <vl/underwaterAcousticEmitterSystem.h>
#include <vl/underwaterAcousticAddtnlPassiveAct.h>
#include <vl/exerciseConn.h>
#include <vl/underwaterAcousticShaftSpeed.h>
#include <vl/underwaterAcousticBeam.h>
#include <vl/hostStructs.h>
#include <vl/stateMsgDIS.h>

#include <matrix/vlMath.h>

#define DtINCONSISTENT_UA_PDU_LENGTH       1
#define DtINCONSISTENT_UA_SYS_LENGTHS      2
#define DtINCONSISTENT_UA_SYS_BEAM_LENGTHS 3

class DtUnderwaterAcousticPdu;

typedef void (*DtUnderwaterAcousticPduCb)( DtUnderwaterAcousticPdu* pdu, void* usr );

class DT_DLL_VL DtUnderwaterAcousticPdu : public DtStateMsg
{
public:

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

   virtual ~DtUnderwaterAcousticPdu();

   DtUnderwaterAcousticPdu& operator = ( const DtUnderwaterAcousticPdu& orig );

   virtual void setEmittingEntityID( const DtEntityIdentifier& entity );
   virtual const DtEntityIdentifier& emittingEntityID() const;

   virtual void setEventID( const DtEventID& event );
   virtual const DtEventID& eventID() const;

   virtual void setStateChangeUpdate( DtUnderwaterAcousticUpdate upd );
   virtual DtUnderwaterAcousticUpdate stateChangeUpdate() const;

   virtual void setPassiveParameterIndex(
      DtUnderwaterAcousticPassiveParmIndex ind );
   virtual DtUnderwaterAcousticPassiveParmIndex
      passiveParameterIndex() const;

   virtual void setPropulsionPlantConfig(
      DtUnderwaterAcousticPropulsionPlantConfig config );
   virtual DtUnderwaterAcousticPropulsionPlantConfig
      propulsionPlantConfig() const;

   virtual bool setNumShafts( DtU8 num );
   virtual DtU8 numShafts() const;

   virtual bool setNumAdditionalPassiveAct( DtU8 num );
   virtual DtU8 numAdditionalPassiveAct() const;

   virtual bool setNumEmitterSystems( DtU8 num );
   virtual DtU8 numEmitterSystems() const;

   virtual bool setNumBeams( int emitterSystemIndex, DtU8 num );
   virtual DtU8 numBeams( int emitterSystemIndex ) const;

   virtual bool setShaftSpeed( int index,
      const DtUnderwaterAcousticShaftSpeed& record );
   virtual bool getShaftSpeed( int index,
      DtUnderwaterAcousticShaftSpeed& record ) const;

   virtual bool setAddtnlPassiveAct( int index,
      const DtUnderwaterAcousticAddtnlPassiveAct& record );
   virtual bool getAddtnlPassiveAct( int index,
      DtUnderwaterAcousticAddtnlPassiveAct& record ) const;

   virtual bool setEmitterSystem( int index,
      const DtUnderwaterAcousticEmitterSystem& record );
   virtual bool getEmitterSystem( int index,
      DtUnderwaterAcousticEmitterSystem& record ) const;

   virtual bool setBeam( int emitterSystemIndex, int beamIndex,
      const DtUnderwaterAcousticBeam& record );
   virtual bool getBeam( int emitterSystemIndex, int beamIndex,
      DtUnderwaterAcousticBeam& 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,
      DtUnderwaterAcousticPduCb cb, void* usr );
   static void removeCallback( DtExerciseConn* conn,
      DtUnderwaterAcousticPduCb cb, void* usr );

protected:

   DtUnderwaterAcousticPdu* self() const;

   virtual DtPduKind internalGetPduKind() const { return DtUnderwaterAcousticPduKind; }

   virtual DtNetUnderwaterAcousticPdu* netPduStruct() const;

   virtual char* var() const;

   virtual int shaftSpeedRecordOffset( int recordIndex ) const;

   virtual int passiveActRecordOffset( int recordIndex ) const;

   virtual int emitterSystemRecordOffset( int recordIndex ) const;

   virtual int beamDataRecordOffset( int emitterSystemIndex, int beamIndex ) const;

   int computeStatus() const;

protected:

   static const int theNetUaPduSize;
   static const int theNetShaftSize;
   static const int theNetApaSize;
   static const int theNetSystemSize;
   static const int theNetBeamSize;

protected:

   DtEntityIdentifier                myEntityID;
   DtEventID                         myEventID;

};

#endif // DtDIS