#include <WeatherFile.hpp>

Inheritance diagram for openstudio::model::WeatherFile:

Public Member Functions
Constructors and Destructors
virtual	~WeatherFile () override=default

	WeatherFile (const WeatherFile &other)=default

	WeatherFile (WeatherFile &&other)=default

WeatherFile &	operator= (const WeatherFile &)=default

WeatherFile &	operator= (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

Public Member Functions inherited from openstudio::model::ModelObject
virtual	~ModelObject () override=default

	ModelObject (const ModelObject &other)=default

	ModelObject (ModelObject &&other)=default

ModelObject &	operator= (const ModelObject &)=default

ModelObject &	operator= (ModelObject &&)=default

ModelObject	clone () const
	Creates a deep copy of this object, placing it in this object's model().

ModelObject	clone (Model model) const
	Creates a deep copy of this object, placing it in model.

Component	createComponent () const
	Method for creating sharable Model snippets.

Model	model () const
	Returns the Model that contains this object.

boost::optional< ParentObject >	parent () const
	Return this object's parent in the hierarchy, if it has one.

std::vector< ResourceObject >	resources () const
	Get the resources directly used by this ModelObject.

template<typename T >
std::vector< T >	getModelObjectSources () const
	Get all objects of type T that point to this object.

template<typename T >
std::vector< T >	getModelObjectSources (IddObjectType iddObjectType) const
	Get all objects of type T that point to this object.

template<typename T >
boost::optional< T >	getModelObjectTarget (unsigned index) const
	Get the object of type T pointed to by this object from field index.

template<typename T >
std::vector< T >	getModelObjectTargets () const
	Get all objects of type T to which this object points.

const std::vector< std::string > &	outputVariableNames () const
	Get all output variables names that could be associated with this object.

std::vector< OutputVariable >	outputVariables () const
	Get all output variables associated with this object, must run simulation to generate data.

boost::optional< openstudio::TimeSeries >	getData (const OutputVariable &variable, const std::string &envPeriod) const
	Get data associated with this output variable and this object.

std::vector< LifeCycleCost >	lifeCycleCosts () const
	Returns the list of all LifeCycleCosts that refer to this object.

std::vector< IdfObject >	removeLifeCycleCosts ()
	Removes all LifeCycleCosts that refer to this object.

IddObjectType	iddObjectType () const
	This is a virtual function that will tell you the type of iddObject you are dealing with.

AdditionalProperties	additionalProperties () const
	Returns this object's additional properties, constructing a new object if necessary.

bool	hasAdditionalProperties () const
	Returns true if this object has additional properties.

std::vector< IdfObject >	removeAdditionalProperties ()
	Removes all additional properties that refer to this object.

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

bool	operator< (const ModelObject &right) const

bool	operator== (const ModelObject &other) const
	equality test

bool	operator!= (const ModelObject &other) const
	inequality test

std::vector< ScheduleTypeKey >	getScheduleTypeKeys (const Schedule &schedule) const
	Return the ScheduleTypeKeys indicating how schedule is used in this object.

boost::optional< double >	getAutosizedValue (const std::string &valueName, const std::string &units) const
	Gets the autosized component value from the sql file.

virtual std::vector< EMSActuatorNames >	emsActuatorNames () const
	Return the names of the available ems actuators.

virtual std::vector< std::string >	emsInternalVariableNames () const
	Return the names of the available ems internal variables.

boost::optional< ModelObject >	connectedObject (unsigned port) const

boost::optional< unsigned >	connectedObjectPort (unsigned port) const

Public Member Functions inherited from openstudio::WorkspaceObject
bool	canBeSource () const

bool	canBeSource () const

bool	canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const

bool	canBeSource (unsigned index, const std::vector< std::string > &refLists=std::vector< std::string >()) const

std::vector< std::string >	canBeTarget () const

std::vector< std::string >	canBeTarget () const

std::vector< unsigned >	getSourceIndices (const Handle &targetHandle) const

std::vector< unsigned >	getSourceIndices (const Handle &targetHandle) const

std::vector< WorkspaceObject >	getSources (IddObjectType type) const

std::vector< WorkspaceObject >	getSources (IddObjectType type) const

boost::optional< WorkspaceObject >	getTarget (unsigned index) const

boost::optional< WorkspaceObject >	getTarget (unsigned index) const

IdfObject	idfObject ()

IdfObject	idfObject () const

bool	initialized () const

bool	initialized () const

bool	isSource () const

bool	isSource () const

bool	isTarget () const

bool	isTarget () const

unsigned	numSources () const

unsigned	numSources () const

bool	objectListFieldsEqual (const WorkspaceObject &other) const

bool	objectListFieldsEqual (const WorkspaceObject &other) const

bool	objectListFieldsNonConflicting (const WorkspaceObject &other) const

bool	objectListFieldsNonConflicting (const WorkspaceObject &other) const

bool	operator< (const WorkspaceObject &right) const

bool	operator< (const WorkspaceObject &right) const

std::ostream &	operator<< (std::ostream &os, const WorkspaceObject &workspaceObject)

WorkspaceObject &	operator= (const WorkspaceObject &)=default

WorkspaceObject &	operator= (const WorkspaceObject &)=default

WorkspaceObject &	operator= (WorkspaceObject &&)=default

WorkspaceObject &	operator= (WorkspaceObject &&)=default

std::vector< openstudio::IdfObject >	remove ()

std::vector< openstudio::IdfObject >	remove ()

bool	setPointer (unsigned index, const Handle &targetHandle)

bool	setPointer (unsigned index, const Handle &targetHandle)

std::vector< WorkspaceObject >	sources () const

std::vector< WorkspaceObject >	sources () const

std::vector< WorkspaceObject >	targets () const

std::vector< WorkspaceObject >	targets () const

Workspace	workspace () const

Workspace	workspace () const

	WorkspaceObject (const WorkspaceObject &other)=default

	WorkspaceObject (const WorkspaceObject &other)=default

	WorkspaceObject (WorkspaceObject &&other)=default

	WorkspaceObject (WorkspaceObject &&other)=default

virtual	~WorkspaceObject () override=default

virtual	~WorkspaceObject () override=default

Public Member Functions inherited from openstudio::IdfObject
std::string	briefDescription () const

std::string	briefDescription () const

T	cast () const

std::vector< T >	castVector (const std::vector< U > &objects)

std::vector< std::vector< std::string > >	clearExtensibleGroups ()

std::vector< std::vector< std::string > >	clearExtensibleGroups ()

IdfObject	clone (bool keepHandle=false) const

IdfObject	clone (bool keepHandle=false) const

std::string	comment () const

std::string	comment () const

boost::optional< std::string >	createName (bool overwrite=true)

boost::optional< std::string >	createName (bool overwrite=true)

std::vector< unsigned >	dataFields () const

std::vector< unsigned >	dataFields () const

bool	dataFieldsEqual (const IdfObject &other) const

bool	dataFieldsEqual (const IdfObject &other) const

std::vector< std::string >	eraseExtensibleGroup (unsigned groupIndex)

std::vector< std::string >	eraseExtensibleGroup (unsigned groupIndex)

std::vector< IdfExtensibleGroup >	extensibleGroups () const

std::vector< IdfExtensibleGroup >	extensibleGroups () const

boost::optional< std::string >	fieldComment (unsigned index, bool returnDefault=false) const

boost::optional< std::string >	fieldComment (unsigned index, bool returnDefault=false) const

boost::optional< double >	getDouble (unsigned index, bool returnDefault=false) const

boost::optional< double >	getDouble (unsigned index, bool returnDefault=false) const

IdfExtensibleGroup	getExtensibleGroup (unsigned groupIndex) const

IdfExtensibleGroup	getExtensibleGroup (unsigned groupIndex) const

boost::optional< std::string >	getField (unsigned index, bool returnDefault=false) const

boost::optional< std::string >	getField (unsigned index, bool returnDefault=false) const

std::vector< Handle >	getHandles (const std::vector< T > &objects)

boost::optional< int >	getInt (unsigned index, bool returnDefault=false) const

boost::optional< int >	getInt (unsigned index, bool returnDefault=false) const

OSOptionalQuantity	getQuantity (unsigned index, bool returnDefault=false, bool returnIP=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< std::string >	getString (unsigned index, bool returnDefault=false, bool returnUninitializedEmpty=false) const

boost::optional< unsigned >	getUnsigned (unsigned index, bool returnDefault=false) const

boost::optional< unsigned >	getUnsigned (unsigned index, bool returnDefault=false) const

Handle	handle () const

Handle	handle () const

IddObject	iddObject () const

IddObject	iddObject () const

	IdfObject (const IddObject &, bool fastName=false)

	IdfObject (const IddObject &, bool fastName=false)

	IdfObject (const IdfObject &other)

	IdfObject (const IdfObject &other)

	IdfObject (IddObjectType type, bool fastName=false)

	IdfObject (IddObjectType type, bool fastName=false)

	IdfObject (IdfObject &&other) noexcept

	IdfObject (IdfObject &&other) noexcept

void	initializeFields (bool fill_default=false)

void	initializeFields (bool fill_default=false)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)

IdfExtensibleGroup	insertExtensibleGroup (unsigned groupIndex, const std::vector< std::string > &values)

bool	isDataField (unsigned index) const

bool	isDataField (unsigned index) const

bool	isEmpty (unsigned index) const

bool	isEmpty (unsigned index) const

bool	isObjectListField (unsigned index) const

bool	isObjectListField (unsigned index) const

bool	isValid (StrictnessLevel level, bool checkNames=false) const

bool	isValid (StrictnessLevel level, bool checkNames=false) const

boost::optional< unsigned >	maxExtensibleGroups () const

boost::optional< unsigned >	maxExtensibleGroups () const

boost::optional< unsigned >	maxFields () const

boost::optional< unsigned >	maxFields () const

unsigned	minExtensibleGroups () const

unsigned	minExtensibleGroups () const

unsigned	minFields () const

unsigned	minFields () const

boost::optional< std::string >	name (bool returnDefault=false) const

boost::optional< std::string >	name (bool returnDefault=false) const

std::string	nameString (bool returnDefault=false) const

std::string	nameString (bool returnDefault=false) const

unsigned	numExtensibleGroups () const

unsigned	numExtensibleGroups () const

unsigned	numFields () const

unsigned	numFields () const

unsigned	numNonextensibleFields () const

unsigned	numNonextensibleFields () const

std::vector< unsigned >	objectListFields () const

std::vector< unsigned >	objectListFields () const

bool	objectListFieldsEqual (const IdfObject &other) const

bool	objectListFieldsEqual (const IdfObject &other) const

bool	objectListFieldsNonConflicting (const IdfObject &other) const

bool	objectListFieldsNonConflicting (const IdfObject &other) const

bool	operator!= (const IdfObject &other) const

bool	operator!= (const IdfObject &other) const

std::ostream &	operator<< (std::ostream &os, const IdfObject &IdfObject)

IdfObject &	operator= (const IdfObject &other)

IdfObject &	operator= (const IdfObject &other)

IdfObject &	operator= (IdfObject &&other) noexcept

IdfObject &	operator= (IdfObject &&other) noexcept

bool	operator== (const IdfObject &other) const

bool	operator== (const IdfObject &other) const

boost::optional< T >	optionalCast () const

std::vector< std::string >	popExtensibleGroup ()

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

IdfExtensibleGroup	pushExtensibleGroup (const std::vector< std::string > &values)

IdfExtensibleGroup	pushExtensibleGroup (const std::vector< std::string > &values)

std::vector< unsigned >	requiredFields () const

std::vector< unsigned >	requiredFields () const

void	setComment (const std::string &msg)

void	setComment (const std::string &msg)

bool	setDouble (unsigned index, double value)

bool	setDouble (unsigned index, double value)

bool	setFieldComment (unsigned index, const std::string &cmnt)

bool	setFieldComment (unsigned index, const std::string &cmnt)

bool	setInt (unsigned index, int value)

bool	setInt (unsigned index, int value)

boost::optional< std::string >	setName (const std::string &newName)

boost::optional< std::string >	setName (const std::string &newName)

bool	setQuantity (unsigned index, const Quantity &q)

bool	setQuantity (unsigned index, const Quantity &q)

bool	setString (unsigned index, const std::string &value)

bool	setString (unsigned index, const std::string &value)

bool	setUnsigned (unsigned index, unsigned value)

bool	setUnsigned (unsigned index, unsigned value)

std::vector< T >	subsetCastVector (const std::vector< U > &original)

ValidityReport	validityReport (StrictnessLevel level, bool checkNames=false) const

ValidityReport	validityReport (StrictnessLevel level, bool checkNames=false) const

virtual	~IdfObject ()=default

virtual	~IdfObject ()=default

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.

Static Public Member Functions inherited from openstudio::IdfObject
static boost::optional< IdfObject >	load (const std::string &text)

static boost::optional< IdfObject >	load (const std::string &text, const IddObject &iddObject)

static int	printedFieldSpace ()

Related Symbols
(Note that these are not member symbols.)
using	OptionalWeatherFile = boost::optional<WeatherFile>

using	WeatherFileVector = std::vector<WeatherFile>

Related Symbols inherited from openstudio::model::ModelObject
std::vector< ResourceObject >	getRecursiveResources (const ModelObject &object)
	Returns all ResourceObjects accessible by recursively calling .resources() starting from object.

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

boost::optional< Site >	site () const

boost::optional< EpwFile >	file (const openstudio::path &dir=openstudio::path()) const
	Load and return the EpwFile.

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

bool	makeUrlAbsolute (const openstudio::path &searchDirectory)
	Search for file and save the absolute url if successful.

boost::optional< std::string >	environmentName () const

	WeatherFile (Model &model)

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< IdfObject >	IdfObjectVector

typedef boost::optional< IdfObject >	OptionalIdfObject

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

Protected Types inherited from openstudio::WorkspaceObject
typedef detail::WorkspaceObject_Impl	ImplType

Protected Types inherited from openstudio::IdfObject
typedef detail::IdfObject_Impl	ImplType

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)

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

◆ ~WeatherFile()

virtual openstudio::model::WeatherFile::~WeatherFile ( )

overridevirtualdefault

◆ WeatherFile() [1/3]

openstudio::model::WeatherFile::WeatherFile ( const WeatherFile & other )

default

◆ WeatherFile() [2/3]

openstudio::model::WeatherFile::WeatherFile ( WeatherFile && other )

default

◆ WeatherFile() [3/3]

openstudio::model::WeatherFile::WeatherFile ( Model & model )

explicitprotected

Member Function Documentation

◆ checksum()

boost::optional< std::string > openstudio::model::WeatherFile::checksum ( ) const

◆ city()

std::string openstudio::model::WeatherFile::city ( ) const

◆ country()

std::string openstudio::model::WeatherFile::country ( ) const

◆ dataSource()

std::string openstudio::model::WeatherFile::dataSource ( ) const

◆ elevation()

double openstudio::model::WeatherFile::elevation ( ) const

◆ environmentName()

boost::optional< std::string > openstudio::model::WeatherFile::environmentName ( ) const

◆ file()

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.

◆ iddObjectType()

static IddObjectType openstudio::model::WeatherFile::iddObjectType ( )

static

◆ isElevationDefaulted()

bool openstudio::model::WeatherFile::isElevationDefaulted ( ) const

◆ latitude()

double openstudio::model::WeatherFile::latitude ( ) const

◆ longitude()

double openstudio::model::WeatherFile::longitude ( ) const

◆ makeUrlAbsolute()

bool openstudio::model::WeatherFile::makeUrlAbsolute ( const openstudio::path & searchDirectory )

Search for file and save the absolute url if successful.

◆ makeUrlRelative()

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

◆ operator=() [1/2]

WeatherFile & openstudio::model::WeatherFile::operator= ( const WeatherFile & )

default

◆ operator=() [2/2]

WeatherFile & openstudio::model::WeatherFile::operator= ( WeatherFile && )

default

◆ path()

boost::optional< openstudio::path > openstudio::model::WeatherFile::path ( ) const

◆ resetElevation()

void openstudio::model::WeatherFile::resetElevation ( )

◆ setCity()

bool openstudio::model::WeatherFile::setCity ( const std::string & city )

◆ setCountry()

bool openstudio::model::WeatherFile::setCountry ( const std::string & country )

◆ setDataSource()

bool openstudio::model::WeatherFile::setDataSource ( const std::string & dataSource )

◆ setElevation()

bool openstudio::model::WeatherFile::setElevation ( double elevation )

◆ setLatitude()

bool openstudio::model::WeatherFile::setLatitude ( double latitude )

◆ setLongitude()

bool openstudio::model::WeatherFile::setLongitude ( double longitude )

◆ setStateProvinceRegion()

bool openstudio::model::WeatherFile::setStateProvinceRegion ( const std::string & stateProvinceRegion )

◆ setTimeZone()

bool openstudio::model::WeatherFile::setTimeZone ( double timeZone )

◆ setWeatherFile()

static boost::optional< WeatherFile > openstudio::model::WeatherFile::setWeatherFile	(	Model &	model,
		const openstudio::EpwFile &	epwFile )

static

Sets WeatherFile in the Model based on EpwFile input.

◆ setWMONumber()

bool openstudio::model::WeatherFile::setWMONumber ( const std::string & wMONumber )

◆ site()

boost::optional< Site > openstudio::model::WeatherFile::site ( ) const

◆ startDateActualYear()

boost::optional< int > openstudio::model::WeatherFile::startDateActualYear ( ) const

◆ startDayOfWeek()

boost::optional< DayOfWeek > openstudio::model::WeatherFile::startDayOfWeek ( ) const

◆ stateProvinceRegion()

std::string openstudio::model::WeatherFile::stateProvinceRegion ( ) const

◆ timeZone()

double openstudio::model::WeatherFile::timeZone ( ) const

◆ url()

boost::optional< std::string > openstudio::model::WeatherFile::url ( ) const

◆ wMONumber()

std::string openstudio::model::WeatherFile::wMONumber ( ) const

Friends And Related Symbol Documentation

◆ OptionalWeatherFile

using OptionalWeatherFile = boost::optional<WeatherFile>

using WeatherFileVector = std::vector<WeatherFile>

Public Member Functions

Static Public Member Functions

Related Symbols

Setters

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~WeatherFile()

◆ WeatherFile() [1/3]

◆ WeatherFile() [2/3]

◆ WeatherFile() [3/3]

Member Function Documentation

◆ checksum()

◆ city()

◆ country()

◆ dataSource()

◆ elevation()

◆ environmentName()

◆ file()

◆ iddObjectType()

◆ isElevationDefaulted()

◆ latitude()

◆ longitude()

◆ makeUrlAbsolute()

◆ makeUrlRelative()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ path()

◆ resetElevation()

◆ setCity()

◆ setCountry()

◆ setDataSource()

◆ setElevation()

◆ setLatitude()

◆ setLongitude()

◆ setStateProvinceRegion()

◆ setTimeZone()

◆ setWeatherFile()

◆ setWMONumber()

◆ site()

◆ startDateActualYear()

◆ startDayOfWeek()

◆ stateProvinceRegion()

◆ timeZone()

◆ url()

◆ wMONumber()

Friends And Related Symbol Documentation

◆ OptionalWeatherFile

◆ WeatherFileVector