OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | Protected Member Functions | Related Functions | List of all members
openstudio::model::WeatherFile Class Reference

#include <WeatherFile.hpp>

+ Inheritance diagram for openstudio::model::WeatherFile:

Public Member Functions

boost::optional< std::string > environmentName () const
 
boost::optional< EpwFile > file (const openstudio::path &dir=openstudio::path()) const
 Load and return the EpwFile. More...
 
bool makeUrlAbsolute (const openstudio::path &searchDirectory)
 Search for file and save the absolute url if successful. More...
 
bool makeUrlRelative (const openstudio::path &basePath=openstudio::path())
 Save the url as relative to basePath, or just keep the file name and extension if basePath.empty(). More...
 
boost::optional< Sitesite () const
 
Constructors and Destructors
virtual ~WeatherFile ()=default
 
 WeatherFile (const WeatherFile &other)=default
 
 WeatherFile (WeatherFile &&other)=default
 
WeatherFileoperator= (const WeatherFile &)=default
 
WeatherFileoperator= (WeatherFile &&)=default
 
Getters
std::string city () const
 
std::string stateProvinceRegion () const
 
std::string country () const
 
std::string dataSource () const
 
std::string wMONumber () const
 
double latitude () const
 
double longitude () const
 
double timeZone () const
 
double elevation () const
 
bool isElevationDefaulted () const
 
boost::optional< std::string > url () const
 
boost::optional< openstudio::path > path () const
 
boost::optional< std::string > checksum () const
 
boost::optional< int > startDateActualYear () const
 
boost::optional< DayOfWeek > startDayOfWeek () const
 
Setters
bool setCity (const std::string &city)
 
bool setStateProvinceRegion (const std::string &stateProvinceRegion)
 
bool setCountry (const std::string &country)
 
bool setDataSource (const std::string &dataSource)
 
bool setWMONumber (const std::string &wMONumber)
 
bool setLatitude (double latitude)
 
bool setLongitude (double longitude)
 
bool setTimeZone (double timeZone)
 
bool setElevation (double elevation)
 
void resetElevation ()
 
- Public Member Functions inherited from openstudio::model::ModelObject
virtual ~ModelObject ()=default
 
 ModelObject (const ModelObject &other)=default
 
 ModelObject (ModelObject &&other)=default
 
ModelObjectoperator= (const ModelObject &)=default
 
ModelObjectoperator= (ModelObject &&)=default
 
ModelObject clone () const
 Creates a deep copy of this object, placing it in this object's model(). More...
 
ModelObject clone (Model model) const
 Creates a deep copy of this object, placing it in model. More...
 
Component createComponent () const
 Method for creating sharable Model snippets. More...
 
Model model () const
 Returns the Model that contains this object. More...
 
boost::optional< ParentObjectparent () const
 Return this object's parent in the hierarchy, if it has one. More...
 
std::vector< ResourceObjectresources () const
 Get the resources directly used by this ModelObject. More...
 
template<typename T >
std::vector< T > getModelObjectSources () const
 Get all objects of type T that point to this object. More...
 
template<typename T >
std::vector< T > getModelObjectSources (IddObjectType iddObjectType) const
 Get all objects of type T that point to this object. More...
 
template<typename T >
boost::optional< T > getModelObjectTarget (unsigned index) const
 Get the object of type T pointed to by this object from field index. More...
 
template<typename T >
std::vector< T > getModelObjectTargets () const
 Get all objects of type T to which this object points. More...
 
const std::vector< std::string > & outputVariableNames () const
 Get all output variables names that could be associated with this object. More...
 
std::vector< OutputVariableoutputVariables () const
 Get all output variables associated with this object, must run simulation to generate data. More...
 
boost::optional
< openstudio::TimeSeries > 
getData (const OutputVariable &variable, const std::string &envPeriod) const
 Get data associated with this output variable and this object. More...
 
std::vector< LifeCycleCostlifeCycleCosts () const
 Returns the list of all LifeCycleCosts that refer to this object. More...
 
std::vector< IdfObject > removeLifeCycleCosts ()
 Removes all LifeCycleCosts that refer to this object. More...
 
IddObjectType iddObjectType () const
 This is a virtual function that will tell you the type of iddObject you are dealing with. More...
 
AdditionalProperties additionalProperties () const
 Returns this object's additional properties, constructing a new object if necessary. More...
 
bool hasAdditionalProperties () const
 Returns true if this object has additional properties. More...
 
std::vector< IdfObject > removeAdditionalProperties ()
 Removes all additional properties that refer to this object. More...
 
boost::optional< std::string > cadObjectId () const
 
bool setCADObjectId (const std::string &cadObjectId)
 
boost::optional< std::string > gbXMLId () const
 
bool setGBXMLId (const std::string &gbXMLId)
 
boost::optional< std::string > displayName () const
 
bool setDisplayName (const std::string &displayName)
 
bool setParent (ParentObject &newParent)
 set the parent, child may have to call non-const methods on the parent More...
 
bool operator< (const ModelObject &right) const
 
bool operator== (const ModelObject &other) const
 equality test More...
 
bool operator!= (const ModelObject &other) const
 inequality test More...
 
std::vector< ScheduleTypeKeygetScheduleTypeKeys (const Schedule &schedule) const
 Return the ScheduleTypeKeys indicating how schedule is used in this object. More...
 
boost::optional< double > getAutosizedValue (const std::string &valueName, const std::string &units) const
 Gets the autosized component value from the sql file. More...
 
virtual std::vector
< EMSActuatorNames
emsActuatorNames () const
 Return the names of the available ems actuators. More...
 
virtual std::vector< std::string > emsInternalVariableNames () const
 Return the names of the available ems internal variables. More...
 
boost::optional< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 

Static Public Member Functions

Static Methods
static IddObjectType iddObjectType ()
 
static boost::optional
< WeatherFile
setWeatherFile (Model &model, const openstudio::EpwFile &epwFile)
 Sets WeatherFile in the Model based on EpwFile input. More...
 

Protected Member Functions

 WeatherFile (Model &model)
 
- Protected Member Functions inherited from openstudio::model::ModelObject
 ModelObject (IddObjectType type, const Model &model, bool fastName=false)
 
 ModelObject (std::shared_ptr< detail::ModelObject_Impl > impl)
 

Related Functions

(Note that these are not member functions.)

using OptionalWeatherFile = boost::optional< WeatherFile >
 
using WeatherFileVector = std::vector< WeatherFile >
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 

Detailed Description

WeatherFile derives from ModelObject and is an interface to the OpenStudio IDD object named "OS:WeatherFile".

WeatherFile is a unique object which references an EPW format weather file to use for EnergyPlus simulation. EnergyPlus requires the weather file for simulation be named in.epw and located in the same directory as the input IDF file. The WeatherFile object provides a mechanism for an OpenStudio Model to reference a weather file in a more permanent way. The RunManager is able to locate the actual weather file needed and place it in the EnergyPlus run directory at simulation time. WeatherFile does not have a public constructor because it is a unique ModelObject. To get the WeatherFile object for a Model or create one if it does not yet exist use model.getUniqueObject<WeatherFile>(). To get the WeatherFile object for a Model but not create one if it does not yet exist use model.getOptionalUniqueObject<WeatherFile>().

Constructor & Destructor Documentation

virtual openstudio::model::WeatherFile::~WeatherFile ( )
virtualdefault
openstudio::model::WeatherFile::WeatherFile ( const WeatherFile other)
default
openstudio::model::WeatherFile::WeatherFile ( WeatherFile &&  other)
default
openstudio::model::WeatherFile::WeatherFile ( Model model)
explicitprotected

Member Function Documentation

boost::optional<std::string> openstudio::model::WeatherFile::checksum ( ) const
std::string openstudio::model::WeatherFile::city ( ) const
std::string openstudio::model::WeatherFile::country ( ) const
std::string openstudio::model::WeatherFile::dataSource ( ) const
double openstudio::model::WeatherFile::elevation ( ) const
boost::optional<std::string> openstudio::model::WeatherFile::environmentName ( ) const
boost::optional<EpwFile> openstudio::model::WeatherFile::file ( const openstudio::path &  dir = openstudio::path()) const

Load and return the EpwFile.

Optional argument dir can be used as a base path if url field is relative.

static IddObjectType openstudio::model::WeatherFile::iddObjectType ( )
static
bool openstudio::model::WeatherFile::isElevationDefaulted ( ) const
double openstudio::model::WeatherFile::latitude ( ) const
double openstudio::model::WeatherFile::longitude ( ) const
bool openstudio::model::WeatherFile::makeUrlAbsolute ( const openstudio::path &  searchDirectory)

Search for file and save the absolute url if successful.

bool openstudio::model::WeatherFile::makeUrlRelative ( const openstudio::path &  basePath = openstudio::path())

Save the url as relative to basePath, or just keep the file name and extension if basePath.empty().

WeatherFile& openstudio::model::WeatherFile::operator= ( const WeatherFile )
default
WeatherFile& openstudio::model::WeatherFile::operator= ( WeatherFile &&  )
default
boost::optional<openstudio::path> openstudio::model::WeatherFile::path ( ) const
void openstudio::model::WeatherFile::resetElevation ( )
bool openstudio::model::WeatherFile::setCity ( const std::string &  city)
bool openstudio::model::WeatherFile::setCountry ( const std::string &  country)
bool openstudio::model::WeatherFile::setDataSource ( const std::string &  dataSource)
bool openstudio::model::WeatherFile::setElevation ( double  elevation)
bool openstudio::model::WeatherFile::setLatitude ( double  latitude)
bool openstudio::model::WeatherFile::setLongitude ( double  longitude)
bool openstudio::model::WeatherFile::setStateProvinceRegion ( const std::string &  stateProvinceRegion)
bool openstudio::model::WeatherFile::setTimeZone ( double  timeZone)
static boost::optional<WeatherFile> openstudio::model::WeatherFile::setWeatherFile ( Model model,
const openstudio::EpwFile &  epwFile 
)
static

Sets WeatherFile in the Model based on EpwFile input.

bool openstudio::model::WeatherFile::setWMONumber ( const std::string &  wMONumber)
boost::optional<Site> openstudio::model::WeatherFile::site ( ) const
boost::optional<int> openstudio::model::WeatherFile::startDateActualYear ( ) const
boost::optional<DayOfWeek> openstudio::model::WeatherFile::startDayOfWeek ( ) const
std::string openstudio::model::WeatherFile::stateProvinceRegion ( ) const
double openstudio::model::WeatherFile::timeZone ( ) const
boost::optional<std::string> openstudio::model::WeatherFile::url ( ) const
std::string openstudio::model::WeatherFile::wMONumber ( ) const

Friends And Related Function Documentation

using OptionalWeatherFile = boost::optional<WeatherFile>
related
using WeatherFileVector = std::vector<WeatherFile>
related