include/vrfExtObjects/envWeatherStateRec.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2008 MaK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: envWeatherStateRec.h,v $ $Revision: 1.3 $ $State: Exp $
** Created: 6/13/08 MEM
/*******************************************************************************/

//
// File:        envWeatherStateRec.h
//
// Class:       DtVrfEnvironmentalWeatherStateRecord
//
#ifndef envWeatherStateRec_H_
#define envWeatherStateRec_H_

#include <vl/envRec.h>
#include <vlpi/disEnums.h>
#include <vl/objDesList.h>
#include <vrfExtObjects/vrfExtObjectsDefines.h>

// Definition of the FIXED PORTION of the weather state object.
// This will be followed by a variable length string of bytes to represent
// the object label, and 0 or more global object designators to represent
// any subordinate objects within the object represented.

struct DtNetWeatherStateRecord : public DtNetEnvironmentalRecord
{
   //DtNetEnvironmentalRecord      myHeader;  

   DtNetU32                      myRecordVersion;
   DtNetFloat64                  myAirTurbidity;
   DtNetU32                      myCloudState;
   DtNetFloat64                  myPrecipitationIntensity;
   DtNetU32                      myPrecipitationType;
   DtNetFloat64                  myVisibility;
   DtNetFloat64                  myWindDirection;
   DtNetFloat64                  myWindSpeed;   
   DtNetFloat64                  myIllumination;
   DtNetFloat64                  myTimeOfDay;
   DtNetFloat64                  myTimeOfDayAdvancementSpeed;   
};

//
// Class Description: DtVrfEnvironmentalWeatherStateRecord 
//
class DT_DLL_vrfExtObjects DtVrfEnvironmentalWeatherStateRecord : 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.
   DtVrfEnvironmentalWeatherStateRecord();

   // Copy Constructor
   DtVrfEnvironmentalWeatherStateRecord(const DtVrfEnvironmentalWeatherStateRecord& orig);

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

   // Destructor
   virtual ~DtVrfEnvironmentalWeatherStateRecord();

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

   // See #myAirTurbidity
   virtual void setAirTurbidity(double value);
   virtual double airTurbidity() const;

   // See #myCloudState
    virtual void setCloudState(unsigned int value);
    virtual unsigned int cloudState() const;

   // See #myPrecipitationIntensity
   virtual void setPrecipitationIntensity(double value);
   virtual double precipitationIntensity() const;

   // See #myPrecipitationType
   virtual void setPrecipitationType(unsigned int value);
   virtual unsigned int precipitationType() const;

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

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

   // See #myVisibility
   virtual void setVisibility(double value);
   virtual double visibility() const;

   // See #myIllumination
   virtual void setIllumination(double value);
   virtual double illumination() const;

   // The number of seconds past midnight.
   virtual void setTimeOfDay(double seconds);
   virtual double timeOfDay() const;

   // The rate at which time of day is advancing, based on simulation time.
   // For example, 0 indicates that TOD is paused, 1 means it is advancing normally.
   virtual void setTimeOfDayAdvancementSpeed(double factor);
   virtual double timeOfDayAdvancementSpeed() 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();

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

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

   virtual int netRepSize() const;

protected:

   virtual bool resizeNetRep(int newSize);

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


protected:

   int myNetRepSize;
};

#endif // DIS_VERS >= 5