standardVariableRecord.h

Go to the documentation of this file.

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

#pragma once

#include <vlutil/vlMachineTypes.h>
#include "vl/hostStructs.h"
#include "vl/packets/standardVariableRecordP.h"

enum DtStandardVariableRetCode
{
   DtStandardVariableValid,
   DtStandardVariableBadLength,
   DtStandardVariableBadId,
   DtStandardVariableBadIndex
};

class DT_DLL_VL DtStandardVariableRecord
{
public:

   DtStandardVariableRecord();

   virtual ~DtStandardVariableRecord();

   virtual bool operator==(const DtStandardVariableRecord& other) = 0;

   virtual unsigned int recordType() const = 0;
   virtual void setRecordType(unsigned int recordType) = 0;

   virtual unsigned int recordLength() const = 0;
   virtual void setRecordLength(unsigned int recordLength) = 0;

   virtual void printData() const;

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

   // Writes the network representation to the given address.
   // The assumption is that this memory is allocated and is of the proper size.
   virtual void writeRecord(void * addr) const = 0;

   virtual void setFromNet( const void* netRecord, unsigned int length, DtStandardVariableRetCode* retCode = NULL) = 0;

   virtual unsigned unpaddedNetsize() const = 0;

   virtual unsigned int netSize();

   virtual DtStandardVariableRecord* clone() const = 0;

   // These are used by the exercise connection when received as partial updates from non coupled attribute PDUs
   virtual void setOriginatingSimulationAddress(const DtSimulationAddress&);
   virtual const DtSimulationAddress& originatingSimulationAddress() const;

protected:
      DtSimulationAddress myOriginatingSimulationAddress;
};