vrfWindLevelStateRecord.h

Go to the documentation of this file.

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

#pragma once

#include <vrfExtObjects/dllExport.h>
#include <vl/environmentalRecord.h>
#include <vlpi/disEnums.h>

// This record will represent a wind layer in a weather area.  A weather area can have multiples of these
// records and they should be ordered by altitude.

struct DtNetWindLevelStateRecord
{
   DtNetEnvironmentalRecord      myHeader;
   DtNetU32                      myRecordVersion;
   DtNetFloat64                  myBaseAltitude; 
   DtNetFloat64                  myWindSpeed;; 
   DtNetFloat64                  myWindDirection; 
   DtNetFloat64                  myUnused1;
   DtNetFloat64                  myUnused2;
   DtNetFloat64                  myUnused3;
};

class DT_DLL_vrfExtObjects DtVrfWindLevelStateRecord :
   public DtEnvironmentalRecord
{
public:
   // Default Constructor.  To function properly, the state record should be
   // initialized with an entity type.  If you don't know it yet at creation
   // time, you can use this constructor; but call setEntityType() before
   // using the appearance accessors.
   DtVrfWindLevelStateRecord();

   DtVrfWindLevelStateRecord(
      const DtVrfWindLevelStateRecord& orig);

   DtVrfWindLevelStateRecord(const DtNetWindLevelStateRecord&);

   // Assignment Operator
   const DtVrfWindLevelStateRecord& operator=(
      const DtVrfWindLevelStateRecord& orig);

   // Destructor
   virtual ~DtVrfWindLevelStateRecord() override;

   // Clone.  Return a copy of this instance.
   virtual DtEnvironmentalRecord *clone() const override;

   // See #myBaseAltitude
   virtual void setBaseAltitude(double value);
   virtual double baseAltitude() const;

   // See #myWindSpeed
   virtual void setWindSpeed(double value);
   virtual double windSpeed() const;

   // See #myWindDirection
   virtual void setWindDirection(double value);
   virtual double windDirection() const;

   // This doesn't need to be called explicitly.  If any routine that needs
   // the repository finds that it hasn't been created yet, it calls this
   // method.
   virtual bool createNetworkRepresentation() override;

   // returns the network representation of the environmental record
   const DtNetWindLevelStateRecord* objStateNetRep() const;
   DtNetWindLevelStateRecord* objStateNetRep();

   // used by the PDU class to fill in the network representation
   virtual void setFromNet(const DtNetEnvironmentalRecord &buffer,
                           int protocolVersion) override;

   virtual int netRepSize() const override;

protected:

   // Casts the 'this' pointer for changing elements in a const function.
   DtVrfWindLevelStateRecord* self() const;

   virtual bool resizeNetRep(int newSize) override;

protected:
   int myNetRepSize;
};