lcPdu.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 1998 MaK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
#ifndef lcPdu_h_
#define lcPdu_h_


#pragma once

#include "loggerControlDefines.h"
#include "packets/lgrControlP.h"
#include <vlutil/vlMachineTypes.h>
#include <vlutil/vlPrintUtil.h>
#include <matrix/LibMatrix.h>
#include <matrix/vlMath.h>
#include <vlpi/parseEnum.h>
#include <vl/interaction.h>
#include <vl/exerciseConn.h>
#include <vl/hostStructs.h>
#include <vl/pdu.h>



enum DtLgrCommandExt
{
   DtLgrBeginExtension        = 22, // DtLgrTotalState+1
   DtLgrEmpty                 = 22,
   DtLgrConnect               = 23,
   DtLgrConnectionEstablished = 24,
   DtLgrDisconnect            = 25,
   DtLgrAcknowledge           = 26,
   DtLgrCommandKind           = 27,
   DtLgrResponse              = 28,
   DtLgrLgrHeartbeat          = 29
};

enum DtLgrProtocol
{
   DtLGR_UNKNOWN_PROTOCOL = 0,
   DtLGR_DIS = 1,
   DtLGR_HLA_13 = 2,
   DtLGR_HLA_1516 = 3,
   DtLGR_HLA_1516_EVOLVED = 4,
#if !DtHLA
   DtLGR_PROTOCOL_IN_USE = DtLGR_DIS,
#elif DtHLA_1516_EVOLVED
   DtLGR_PROTOCOL_IN_USE = DtLGR_HLA_1516_EVOLVED,
#elif DtHLA_1516
      DtLGR_PROTOCOL_IN_USE = DtLGR_HLA_1516,
#else
      DtLGR_PROTOCOL_IN_USE = DtLGR_HLA_13
#endif
};


enum DtLgrMode
{
   DtLGR_PLAY   = 0,
   DtLGR_PAUSE  = 1,
   DtLGR_RECORD = 2,
   DtLGR_STOP   = 3,
   DtLGR_EMPTY  = 4,
   DtLGR_LOOP   = 5
};


enum DtLgrDirection
{
   DtLGR_STOPPED   =  0, 
   DtLGR_NOPKT     =  0, 
   DtLGR_FORWARDS  =  1,
   DtLGR_BACKWARDS = -1
};


enum DtLgrFilePosition 
{
   DtLGR_NOFILE = 0,
   DtLGR_START  = 1,
   DtLGR_MIDDLE = 2,
   DtLGR_END    = 3
};


enum DtLgrStyle
{
   DtLGR_PRISTINE = 0,
   DtLGR_RVA      = 1
};


enum DtLgrProcess
{
   DtLGR_NONE = 0,
   DtLGR_MINE = 1,
   DtLGR_ALL  = 2
};


enum DtLgrCtrlFlagStates
{
   DtLGR_EMPTY_FLAG      = 0,
   DtLGR_STATE_REQUEST   = 1,
   DtLGR_TIME_CONSTR_ON  = 2,
   DtLGR_TIME_CONSTR_OFF = 3,
   DtLGR_TIME_REGLTD_ON  = 4,
   DtLGR_TIME_REGLTD_OFF = 5,
   DtLGR_OWN_FED_AMB_ON  = 6,
   DtLGR_OWN_FED_AMB_OFF = 7
};

#if DtDIS

class DT_DLL_LOGGERCONTROL DtExerciseConn;
class DT_DLL_LOGGERCONTROL DtLgrControlPdu;

typedef DtLgrControlPdu DtLgrControlInteraction;
typedef void (*DtLgrControlInteractionCb)
   ( DtLgrControlInteraction* inter, void* usr );

#endif

#if DtHLA
class DT_DLL_LOGGERCONTROL DtLgrControlPdu : public DtPdu
#else
class DT_DLL_LOGGERCONTROL DtLgrControlPdu : public DtInteraction
#endif
{
public:

   DtLgrControlPdu( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER, int pduSize=sizeof(DtNetLgrControlPdu) );

   DtLgrControlPdu( const DtNetLgrControlPdu* initial,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory* pduFactory = 0 );

   virtual ~DtLgrControlPdu();

   DtLgrControlPdu( const DtLgrControlPdu& src );

   DtLgrControlPdu& operator=( const DtLgrControlPdu& src );

   virtual const DtEntityIdentifier& receiverId() const;
   virtual void setReceiverId( const DtEntityIdentifier& id );

   virtual const DtEntityIdentifier& senderId() const;
   virtual void setSenderId( const DtEntityIdentifier& id );

   virtual DtLgrCommand lgrCommand() const;

   virtual DtU16 lctVersion() const;
   void setLctVersion(DtU16 versionNumber);

   virtual DtU32 sequence() const;
   virtual void setSequence(DtU32 sequenceNumber);

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

   virtual bool checkVersion() const;

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

   static DtLgrControlPdu* create( DtLgrCommand command );

   static DtLgrControlPdu* create( DtLgrCommandExt command );

   static bool checkVersion(DtNetLgrControlPdu* header);

#if DtDIS

   static void addCallback( DtExerciseConn* conn,
      DtLgrControlInteractionCb cb, void* usr );
   static void removeCallback( DtExerciseConn* conn,
      DtLgrControlInteractionCb cb, void* usr );
#endif

   static DtU16 addressWildcard();

   static const DtEntityIdentifier& wildcardAddress();

   static const char* lgrModeEnum2string( DtLgrMode md );

   static const char* lgrFilePosEnum2string( DtLgrFilePosition pos );

   static const char* lgrStateFlag2string( DtLgrCtrlFlagStates flg );

public:

   // Prior to version 12.2 release 8, some subclasses performed initPdu that zeroed out the version.
   // This flag allows the version check to be disabled so these subclasses sent from older versions
   // will not be rejected.
   static bool theDisableCheckVersion;
   
protected:
   virtual void setLgrCommand( DtLgrCommand com );
   virtual void setLgrCommand( DtLgrCommandExt com );

   virtual DtNetLgrControlPdu* controlHeader();

   virtual DtNetLgrControlPdu* controlHeader() const;

   DtPduKind internalGetPduKind() const { return DtLgrControlPduKind; }

protected:
   DtEntityIdentifier mySenderId;
   DtEntityIdentifier myReceiverId;

protected:
   static const DtU16 theAddressWildcard = ((1<<16)-1); // 65535 or 0xFFFF
   static const DtEntityIdentifier theWildcardAddress;
};

DT_DLL_LOGGERCONTROL const char *DtLgrCommandEnumString(DtLgrCommand param);

#endif // lcPdu_h_