OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends 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< EpwFilefile (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 ()
 
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
 
Setters
void setCity (std::string city)
 
void setStateProvinceRegion (std::string stateProvinceRegion)
 
void setCountry (std::string country)
 
void setDataSource (std::string dataSource)
 
void setWMONumber (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 ()
 
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< IdfObjectremoveLifeCycleCosts ()
 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...
 
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< ModelObjectconnectedObject (unsigned port) const
 
boost::optional< unsigned > connectedObjectPort (unsigned port) const
 
- Public Member Functions inherited from openstudio::WorkspaceObject
bool canBeSource () const
 
bool canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const
 
std::vector< std::string > canBeTarget () const
 
std::vector< unsigned > getSourceIndices (const Handle &targetHandle) const
 
std::vector< WorkspaceObjectgetSources (IddObjectType type) const
 
boost::optional< WorkspaceObjectgetTarget (unsigned index) const
 
IdfObject idfObject ()
 
IdfObject idfObject () const
 
bool initialized () const
 
bool isSource () const
 
bool isTarget () const
 
unsigned numSources () const
 
bool objectListFieldsEqual (const WorkspaceObject &other) const
 
bool objectListFieldsNonConflicting (const WorkspaceObject &other) const
 
bool operator< (const WorkspaceObject &right) const
 
std::ostream & operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)
 
std::vector
< openstudio::IdfObject
remove ()
 
bool setPointer (unsigned index, const Handle &targetHandle)
 
std::vector< WorkspaceObjectsources () const
 
std::vector< WorkspaceObjecttargets () const
 
Workspace workspace () const
 
virtual ~WorkspaceObject ()
 
- Public Member Functions inherited from openstudio::IdfObject
std::string briefDescription () const
 
cast () const
 
std::vector< T > castVector (const std::vector< U > &objects)
 
std::vector< std::vector
< std::string > > 
clearExtensibleGroups ()
 
IdfObject clone (bool keepHandle=false) const
 
std::string comment () const
 
boost::optional< std::string > createName (bool overwrite=true)
 
std::vector< unsigned > dataFields () const
 
bool dataFieldsEqual (const IdfObject &other) const
 
std::vector< std::string > eraseExtensibleGroup (unsigned groupIndex)
 
std::vector< IdfExtensibleGroupextensibleGroups () const
 
boost::optional< std::string > fieldComment (unsigned index, bool returnDefault=false) const
 
boost::optional< double > getDouble (unsigned index, bool returnDefault=false) const
 
IdfExtensibleGroup getExtensibleGroup (unsigned groupIndex) const
 
std::vector< Handle > getHandles (const std::vector< T > &objects)
 
boost::optional< intgetInt (unsigned index, bool returnDefault=false) const
 
OSOptionalQuantity getQuantity (unsigned index, bool returnDefault=false, bool returnIP=false) const
 
boost::optional< std::string > getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const
 
boost::optional< unsigned > getUnsigned (unsigned index, bool returnDefault=false) const
 
boost::optional< QUrl > getURL (unsigned index, bool returnDefault=false) const
 
Handle handle () const
 
IddObject iddObject () const
 
 IdfObject (IddObjectType type, bool fastName=false)
 
 IdfObject (const IddObject &, bool fastName=false)
 
 IdfObject (const IdfObject &other)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex)
 
IdfExtensibleGroup insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)
 
bool isDataField (unsigned index) const
 
bool isEmpty (unsigned index) const
 
bool isObjectListField (unsigned index) const
 
bool isValid (StrictnessLevel level) const
 
boost::optional< unsigned > maxExtensibleGroups () const
 
boost::optional< unsigned > maxFields () const
 
unsigned minExtensibleGroups () const
 
unsigned minFields () const
 
boost::optional< std::string > name (bool returnDefault=false) const
 
std::string nameString (bool returnDefault=false) const
 
unsigned numExtensibleGroups () const
 
unsigned numFields () const
 
unsigned numNonextensibleFields () const
 
std::vector< unsigned > objectListFields () const
 
bool objectListFieldsEqual (const IdfObject &other) const
 
bool objectListFieldsNonConflicting (const IdfObject &other) const
 
bool operator!= (const IdfObject &other) const
 
std::ostream & operator<< (std::ostream &os, const IdfObject &IdfObject)
 
bool operator== (const IdfObject &other) const
 
boost::optional< T > optionalCast () const
 
std::vector< std::string > popExtensibleGroup ()
 
std::ostream & print (std::ostream &os) const
 
std::ostream & printField (std::ostream &os, unsigned index, bool isLastField=false) const
 
std::ostream & printName (std::ostream &os, bool hasFields=true) const
 
IdfExtensibleGroup pushExtensibleGroup ()
 
IdfExtensibleGroup pushExtensibleGroup (const std::vector< std::string > &values)
 
std::vector< unsigned > requiredFields () const
 
void setComment (const std::string &msg)
 
bool setDouble (unsigned index, double value)
 
bool setFieldComment (unsigned index, const std::string &cmnt)
 
bool setInt (unsigned index, int value)
 
boost::optional< std::string > setName (const std::string &newName)
 
bool setQuantity (unsigned index, const Quantity &q)
 
bool setString (unsigned index, const std::string &value)
 
bool setUnsigned (unsigned index, unsigned value)
 
std::vector< T > subsetCastVector (const std::vector< U > &original)
 
ValidityReport validityReport (StrictnessLevel level, bool checkNames=true) const
 
virtual ~IdfObject ()
 

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...
 
- Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObjectload (const std::string &text)
 
static boost::optional< IdfObjectload (const std::string &text, const IddObject &iddObject)
 
static int printedFieldSpace ()
 

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)
 
- Protected Member Functions inherited from openstudio::WorkspaceObject
 WorkspaceObject (std::shared_ptr< detail::WorkspaceObject_Impl > impl)
 
- Protected Member Functions inherited from openstudio::IdfObject
 IdfObject (std::shared_ptr< detail::IdfObject_Impl > impl)
 

Related Functions

(Note that these are not member functions.)

typedef boost::optional
< WeatherFile
OptionalWeatherFile
 
typedef std::vector< WeatherFileWeatherFileVector
 

Additional Inherited Members

- Public Types inherited from openstudio::WorkspaceObject
typedef boost::optional
< WorkspaceObject
OptionalWorkspaceObject
 
typedef std::vector
< WorkspaceObject
WorkspaceObjectVector
 
- Public Types inherited from openstudio::IdfObject
typedef std::pair< IdfObject,
IdfObject
IdfObjectPair
 
typedef std::vector< IdfObjectIdfObjectVector
 
typedef boost::optional
< IdfObject
OptionalIdfObject
 
- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 
- Protected Types inherited from openstudio::WorkspaceObject
typedef
detail::WorkspaceObject_Impl 
ImplType
 
- Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl ImplType
 

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 ( )
inlinevirtual
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().

boost::optional<openstudio::path> openstudio::model::WeatherFile::path ( ) const
void openstudio::model::WeatherFile::resetElevation ( )
void openstudio::model::WeatherFile::setCity ( std::string  city)
void openstudio::model::WeatherFile::setCountry ( std::string  country)
void openstudio::model::WeatherFile::setDataSource ( std::string  dataSource)
bool openstudio::model::WeatherFile::setElevation ( double  elevation)
bool openstudio::model::WeatherFile::setLatitude ( double  latitude)
bool openstudio::model::WeatherFile::setLongitude ( double  longitude)
void openstudio::model::WeatherFile::setStateProvinceRegion ( 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.

void openstudio::model::WeatherFile::setWMONumber ( std::string  wMONumber)
boost::optional<Site> openstudio::model::WeatherFile::site ( ) 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

typedef boost::optional<WeatherFile> OptionalWeatherFile
related
typedef std::vector<WeatherFile> WeatherFileVector
related