waterSurfaceRecord.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1992-2025 MAK Technologies, Inc
** All rights reserved.
*********************************************************************/


#pragma once

#include <vl/iceStruct.h>
#include <vl/metocLayerRecord.h>
#include <vl/packets/waterSurfaceRecordP.h>
#include <vl/waterCurrentStruct.h>
#include <vl/waveStruct.h>


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

   DtWaterSurfaceRecord(const DtWaterSurfaceRecord& orig);

   DtWaterSurfaceRecord(void* netBuffer, unsigned int size);

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

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

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

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


   virtual void setSeaState(const DtSeaStateEnum16& ss);
   virtual const DtSeaStateEnum16 seaState() const;
   virtual void setSalinity(const DtFloat32& sal);
   virtual const DtFloat32 salinity() const;
   virtual void setTide(const DtFloat32& tide);
   virtual const DtFloat32 tide() const;
   virtual void setIceStruct(const DtIceStruct& layer);
   virtual const DtIceStruct iceStruct() const;
   virtual void setCurrentStruct(const DtWaterCurrentStruct& current);
   virtual const DtWaterCurrentStruct currentStruct() const;
   virtual void setWaveStruct(const DtWaveStruct& current);
   virtual const DtWaveStruct waveStruct() const;
   virtual void setSwellStruct(const DtWaveStruct& swell);
   virtual const DtWaveStruct swellStruct() const;
   virtual void setChoppiness(const DtFloat32& chop);
   virtual const DtFloat32 choppiness() const;
   virtual void setSurgeDepth(const DtFloat32& sd);
   virtual const DtFloat32 surgeDepth() const;
   virtual void setSurfaceTransparency(const DtFloat32& st);
   virtual const DtFloat32 surfaceTransparency() const;
   virtual void setDriveSeaStateFromWind(const bool& dssfw);
   virtual const bool driveSeaStateFromWind() 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:
   DtNetWaterSurfaceRecord* myRecordPtr;

protected:
   static const unsigned int theMinimumSize;

};