globalEnvironmentStateRepository.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjcore/weatherStateRepository.h"
#include <vrfExtObjects/vrfWeatherStateEnums.h>
#include <readerWriter/rwBoolean.h>

class DtGlobalEnvironmentParameters;

class DT_DLL_vrfobjcore DtGlobalEnvironmentStateRepository : public DtWeatherStateRepository
{
public:

   DtGlobalEnvironmentStateRepository (DtVrfObject* vrfObject,
      const DtObjectType& objectType, DtVrfObjectParameters* parameters,
      const DtString& rwName = DtString::nullString(), DtReaderWriterRegistry* parentRegistry = 0);

   DtGlobalEnvironmentStateRepository(const DtGlobalEnvironmentStateRepository& orig,
      const DtString& rwName = DtString::nullString(), DtReaderWriterRegistry* parentRegistry = 0);

   DtGlobalEnvironmentStateRepository& operator=(const DtGlobalEnvironmentStateRepository& orig);

   virtual ~DtGlobalEnvironmentStateRepository();

   virtual void resetToDefaults();

   virtual void setForceUpdate(bool);
   virtual bool forceUpdate() const;

   static DtVrfObjectStateRepository* creator(const DtString& name,
      DtVrfObject* vrfObject, const DtObjectType& objectType,
      DtVrfObjectParameters* parameters, DtReaderWriterRegistry* parentRegistry);

   static DtGlobalEnvironmentStateRepository* 
      isGlobalEnvironmentStateRepository(DtSimObjectStateRepository* repository);

   virtual DtSimObjectStateRepository* clone(const DtString& rwName = DtString::nullString(),
      DtReaderWriterRegistry* parentRegistry = 0) const;

   virtual DtString type() const;

   virtual bool createParameters();
   virtual void initializeFromParameters();
   virtual const DtGlobalEnvironmentParameters* globalEnvironmentParameters() const;


   virtual void setTimeOfDay(double value);

   virtual double timeOfDay() const;

   virtual void setDateAndTimeOfDay(double val);

   virtual bool dateAndTimeOfDaySpecified() const;

   virtual double dateAndTimeOfDay() const;

   virtual DtString timeOfDayString() const;


   virtual void setUseDayNightIlluminationModel(bool);
   virtual bool useDayNightIlluminationModel() const;


   virtual void setTimeOfDayAdvancementSpeed(double value);
   virtual double timeOfDayAdvancementSpeed() const;

   virtual void setScenarioStartTime(time_t i);
   virtual int scenarioStartTime() const;

   virtual void setCanSetScenarioPreStartTime(bool);
   virtual bool canSetScenarioPreStartTime() const;

   virtual void setTimeToLocalOnFirstPlacement(bool);
   virtual bool timeToLocalOnFirstPlacement() const;

private:
   DtGlobalEnvironmentStateRepository();

protected:

   DtRwReal            myTimeOfDay;

   DtRwReal            myTimeOfDayAdvancementSpeed;

   DtRwBoolean         myUseDayNightIlluminationModel;

   DtRwInt mySetScenarioStartTimeAtLocalOnFirstObjectCreationToTime;


   bool myForceUpdate;
};