datumRecordSet.h

Go to the documentation of this file.

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



#ifndef datumRecordSet_H_
#define datumRecordSet_H_

#include "hostStructs.h"
#include <vlpi/idTypeMap.h>
#include <vlutil/vlBaseMsg.h>
#include "packets/dataP.h"

enum DtDatumRetCode
{
   DtDatumValid,
   DtDatumBadLength,
   DtDatumBadId,
   DtDatumBadIndex
};

enum DtDatumRecordType
{
   DtFixed,
   DtVar
};

class DT_DLL_VL DtVarDatumSpec
{
public:
   DtDatumParam param;
   int length;
};

#define DtNullDatumParam DtDatumParam(0)
#define DtNullVarDatumSpec DtNullDatumParam,0

class DT_DLL_VL DtDatumRecordSet : public DtBaseMsg
{
public:
    
   DtDatumRecordSet(DtBufferPtr bufferPtr = DtUSE_INTERNAL_BUFFER);

   DtDatumRecordSet(const void* netRep, int size, 
      DtBufferPtr bufferPtr = DtUSE_INTERNAL_BUFFER);

   virtual ~DtDatumRecordSet();

   DtDatumRecordSet(const DtDatumRecordSet& orig);

   DtDatumRecordSet& operator=(const DtDatumRecordSet& orig);
 
   virtual int numFixedFields() const;

   virtual int numVarFields() const;

   virtual DtDatumParam varDatumId(int index) const;

   virtual DtDatumParam fixedDatumId(int index) const;

   virtual DtDatumParam datumId(DtDatumRecordType fixedOrVar, int index) const;

   virtual int datumSizeBits(DtDatumRecordType fixedOrVar, int index) const;

   virtual int datumSizeBytes(DtDatumRecordType fixedOrVar, int index) const;

   virtual void getIndex(DtDatumParam param, DtDatumRecordType* fixedOrVar, 
      int* index, DtDatumRetCode* retcode = NULL) const;


   virtual DtFloat32 datumValFloat32(DtDatumRecordType fixedOrVar, int index, 
      DtDatumRetCode* retcode = NULL) const;
   virtual DtFloat64 datumValFloat64(DtDatumRecordType fixedOrVar, int index, 
      DtDatumRetCode* retcode = NULL) const;
   virtual unsigned long datumValUnsigned32(DtDatumRecordType fixedOrVar,
      int index, DtDatumRetCode* retcode = NULL) const;
   virtual long datumValInt32(DtDatumRecordType fixedOrVar, int index, 
      DtDatumRetCode* retcode = NULL) const;   
   virtual const char* datumValByteArray(DtDatumRecordType fixedOrVar, 
      int index) const;


   virtual DtFloat32 datumValFloat32(DtDatumParam param, 
      DtDatumRetCode* retcode = NULL) const;
   virtual DtFloat64 datumValFloat64(DtDatumParam param, 
      DtDatumRetCode* retcode = NULL) const;
   virtual unsigned long datumValUnsigned32(DtDatumParam param, 
      DtDatumRetCode* retcode = NULL) const;
   virtual long datumValInt32(DtDatumParam param, 
      DtDatumRetCode* retcode = NULL) const;
   virtual const char* datumValByteArray(DtDatumParam param, 
      DtDatumRetCode* retcode = NULL) const;


   virtual void init(const DtDatumParam* fixedParams,
      const DtVarDatumSpec* specList); 

   virtual void setNumFixedFields(int newNum);
   virtual void setNumVarFields(int newNum);

   virtual void setDatumParam(DtDatumRecordType fixedOrVar, int index, DtDatumParam param, 
      DtDatumRetCode* retcode = NULL);

   virtual void setVarDataBytes(int index, int length, DtDatumRetCode* retcode = NULL);


   virtual void setDatumValFloat64(DtDatumRecordType fixedOrVar, int index, DtFloat64 val, 
      DtDatumRetCode* retcode = NULL); 
   virtual void setDatumValFloat32(DtDatumRecordType fixedOrVar, int index, DtFloat32 val, 
      DtDatumRetCode* retcode = NULL); 
   virtual void setDatumValInt32(DtDatumRecordType fixedOrVar, int index, long val, 
      DtDatumRetCode* retcode = NULL); 
   virtual void setDatumValUnsigned32(DtDatumRecordType fixedOrVar, int index, 
      unsigned long val, DtDatumRetCode* retcode = NULL); 
   virtual void setDatumValByteArray(DtDatumRecordType fixedOrVar, int index, 
      const char* val, DtDatumRetCode* retcode = NULL); 
   

   virtual void setDatumValFloat64(DtDatumParam param, DtFloat64 val, 
      DtDatumRetCode* retcode = NULL); 
   virtual void setDatumValFloat32(DtDatumParam param, DtFloat32 val, 
      DtDatumRetCode* retcode = NULL); 
   virtual void setDatumValInt32(DtDatumParam param, long val, 
      DtDatumRetCode* retcode = NULL); 
   virtual void setDatumValUnsigned32(DtDatumParam param, unsigned long val, 
      DtDatumRetCode* retcode = NULL); 
   virtual void setDatumValByteArray(DtDatumParam param, const char* val, 
      DtDatumRetCode* retcode = NULL); 
 
   virtual void printData() const;

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

   virtual DtNetDataPduTail* netDataRep() const;

   virtual DtNetFixDatum* nthFixedDataRecord(int index) const;

   virtual DtNetVarDatum* nthVarDataRecord(int index) const;

   virtual void setFromNetFixed(const char* fixedFields, int numFixedFields);

   virtual void setFromNetVar(const char* varFields, int numVarFields,
      int totalVarFieldsLength);

protected:

   friend class DtPduWithData;

   virtual void sizeChanged(int size);
  
   virtual void* datumValPtr(DtDatumRecordType fixedOrVar, int index) const;
};

inline DtNetDataPduTail* DtDatumRecordSet::netDataRep() const
{
   return (DtNetDataPduTail*) netRep();
}

#define DtFIXED DtFixed
#define DtVAR DtVar
#define DtDATUM_VALID DtDatumValid
#define DtDATUM_BAD_LENGTH DtDatumBadLength
#define DtDATUM_BAD_ID DtDatumBadId
#define DtDATUM_BAD_INDEX DtDatumBadIndex

#endif