subsurfaceLayerRecord.h

Go to the documentation of this file.

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


#pragma once

#include <vl/metocLayerRecord.h>
#include <vl/packets/subsurfaceLayerRecordP.h>
#include <vl/layerStruct.h>
#include <vl/waterCurrentStruct.h>


class DT_DLL_VL DtSubsurfaceLayerRecord : public DtMetocLayerRecord
{
public:
   DtSubsurfaceLayerRecord();

   DtSubsurfaceLayerRecord(const DtSubsurfaceLayerRecord& orig);

   DtSubsurfaceLayerRecord(void* netBuffer, unsigned int size);

   virtual DtSubsurfaceLayerRecord& operator=(const DtSubsurfaceLayerRecord& record);

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

   virtual bool operator==(const DtSubsurfaceLayerRecord& record);

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

   virtual void setLayerStruct(const DtLayerStruct& layer);
   virtual const DtLayerStruct layerStruct() const;
   virtual void setCurrentStruct(const DtWaterCurrentStruct& current);
   virtual const DtWaterCurrentStruct currentStruct() const;
   virtual void setSalinity(const DtFloat32& val);
   virtual const DtFloat32 salinity() const;
   virtual void setBottomType(const DtSedimentTypeEnum32& val);
   virtual const DtSedimentTypeEnum32 bottomType() const;
   virtual void setPermeability(const DtFloat32& val);
   virtual const DtFloat32 permeability() const;

   // 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;

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

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

   virtual unsigned int unpaddedNetsize() const;

   virtual unsigned int paddedNetSize() const;

   virtual DtStandardVariableRecord* clone() const;

public:
   static DtStandardVariableRecord* create(void* addr, unsigned int length);

   static unsigned int recordTypeToUse();

   static void setRecordTypeToUse(unsigned int typeToUse);

protected:
   DtNetSubsurfaceLayerRecord* myRecordPtr;

protected:
   static const unsigned int theMinimumSize;

};