vrfElevationalConfigurationStateRecord.h

Go to the documentation of this file.

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

#pragma once

#include <vrfExtObjects/dllExport.h>
#include <vrfExtObjects/vrfWeatherStateEnums.h>

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

// This record will represent an elevational configuration in the environment. 
// A weather area can have multiples of these records and they should be 
// ordered by altitude.

struct DtNetElevationalConfigurationStateRecord
{
   DtNetEnvironmentalRecord      myHeader;
   DtNetU32                      myRecordVersion;
   DtNetFloat64                  myBaseAltitude; 
   DtNetFloat64                  myWindSpeed; 
   DtNetFloat64                  myWindDirection; 
   DtNetFloat64                  myVisibilityDistance; 
   DtNetU32                      myVisibilityObscurant;
   DtNetInt32                    myCloudType;
   DtNetFloat64                  myCloudDensity; 
   DtNetFloat64                  mySkyCoverage; 
};

class DT_DLL_vrfExtObjects DtVrfElevationalConfigurationStateRecord :
   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.
   DtVrfElevationalConfigurationStateRecord();

   DtVrfElevationalConfigurationStateRecord(
      const DtVrfElevationalConfigurationStateRecord& orig);

   DtVrfElevationalConfigurationStateRecord(const DtNetElevationalConfigurationStateRecord&);

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

   // Destructor
   virtual ~DtVrfElevationalConfigurationStateRecord() 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;

   // See #myVisibilityDistance
   virtual void setVisibilityDistance(double value);
   virtual double visibilityDistance() const;

   // See #myVisibilityObscurant
   virtual void setVisibilityObscurant(DtVrfWeatherVisibilityObscurantType value);
   virtual DtVrfWeatherVisibilityObscurantType visibilityObscurant() const;

   // See #myCloudType
   virtual void setCloudType(int value);
   virtual int cloudType() const;

   // See #myCloudDensity
   virtual void setCloudDensity(double value);
   virtual double cloudDensity() const;

   // See #mySkyCoverage
   virtual void setSkyCoverage(double value);
   virtual double skyCoverage() 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 DtNetElevationalConfigurationStateRecord* objStateNetRep() const;
   DtNetElevationalConfigurationStateRecord* 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.
   DtVrfElevationalConfigurationStateRecord* self() const;

   virtual bool resizeNetRep(int newSize) override;

protected:
   int myNetRepSize;
};