#include <RunPeriod.hpp>

Inheritance diagram for openstudio::model::RunPeriod:

Public Member Functions
bool	isAnnual () const
	Returns true if RunPeriod specifies run between 1/1-12/31. More...

bool	isPartialYear () const
	Returns true if not annual simulation. More...

bool	isRepeated () const
	Returns true if numTimePeriodRepeats is greater than 1. More...

Constructors and Destructors
virtual	~RunPeriod ()=default

	RunPeriod (const RunPeriod &other)=default

	RunPeriod (RunPeriod &&other)=default

RunPeriod &	operator= (const RunPeriod &)=default

RunPeriod &	operator= (RunPeriod &&)=default

Getters
int	getBeginMonth () const

int	getBeginDayOfMonth () const

int	getEndMonth () const

int	getEndDayOfMonth () const

bool	getUseWeatherFileHolidays () const

bool	getUseWeatherFileDaylightSavings () const

bool	getApplyWeekendHolidayRule () const

bool	getUseWeatherFileRainInd () const

bool	getUseWeatherFileSnowInd () const

int	getNumTimePeriodRepeats () const

Setters
bool	setBeginMonth (int month)

bool	setBeginDayOfMonth (int day)

bool	setEndMonth (int month)

bool	setEndDayOfMonth (int day)

bool	setUseWeatherFileHolidays (bool use)

bool	setUseWeatherFileDaylightSavings (bool use)

bool	setApplyWeekendHolidayRule (bool apply)

bool	setUseWeatherFileRainInd (bool rainInd)

bool	setUseWeatherFileSnowInd (bool snowInd)

bool	setNumTimePeriodRepeats (int numRepeats)

void	ensureNoLeapDays ()

Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType >	allowableChildTypes () const
	Returns a vector of allowable children types. More...

std::vector< ModelObject >	children () const
	Return direct child objects in the Model. More...

ParentObject &	operator= (const ParentObject &)=default

ParentObject &	operator= (ParentObject &&)=default

	ParentObject (const ParentObject &other)=default

	ParentObject (ParentObject &&other)=default

virtual	~ParentObject ()=default

Public Member Functions inherited from openstudio::model::ModelObject
virtual	~ModelObject ()=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(). 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< ParentObject >	parent () const
	Return this object's parent in the hierarchy, if it has one. More...

std::vector< ResourceObject >	resources () 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< OutputVariable >	outputVariables () 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< LifeCycleCost >	lifeCycleCosts () 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< ScheduleTypeKey >	getScheduleTypeKeys (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< ModelObject >	connectedObject (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< WorkspaceObject >	getSources (IddObjectType type) const

boost::optional< WorkspaceObject >	getTarget (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)

WorkspaceObject &	operator= (WorkspaceObject &&)=default

WorkspaceObject &	operator= (const WorkspaceObject &)=default

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

bool	setPointer (unsigned index, const Handle &targetHandle)

std::vector< WorkspaceObject >	sources () const

std::vector< WorkspaceObject >	targets () const

Workspace	workspace () const

	WorkspaceObject (const WorkspaceObject &other)=default

	WorkspaceObject (WorkspaceObject &&other)=default

virtual	~WorkspaceObject ()=default

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

T	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< IdfExtensibleGroup >	extensibleGroups () 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

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

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

Handle	handle () const

IddObject	iddObject () const

	IdfObject (IddObjectType type, bool fastName=false)

	IdfObject (const IdfObject &other)

	IdfObject (const IddObject &, bool fastName=false)

	IdfObject (IdfObject &&other) noexcept

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, bool checkNames=false) 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)

IdfObject &	operator= (IdfObject &&other) noexcept

IdfObject &	operator= (const IdfObject &other)

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 (const std::vector< std::string > &values)

IdfExtensibleGroup	pushExtensibleGroup ()

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=false) const

virtual	~IdfObject ()=default

Static Public Member Functions
static IddObjectType	iddObjectType ()
	Returns the IddObjectType. More...

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 Functions
(Note that these are not member functions.)
using	OptionalRunPeriod = boost::optional< RunPeriod >

using	RunPeriodVector = std::vector< RunPeriod >

Related Functions inherited from openstudio::model::ParentObject
std::vector< ModelObject >	getRecursiveChildren (const ParentObject &object, bool includeLifeCycleCostsAndAdditionalProperties=false, bool includeUsedResources=true)
	Returns object and all other objects accessible by calling children() on encountered ParentObjects . More...

std::vector< ModelObject >	getRecursiveChildrenAndResources (const ModelObject &object)
	Returns object and all other objects accessible by calling children() and resources() on encountered ModelObjects . More...

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

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::ParentObject
	ParentObject (IddObjectType type, const Model &model)
	Constructs a new ParentObject object in the model. More...

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

RunPeriod derives from ParentObject and is an interface to the unique OpenStudio IDD object named "RunPeriod".

RunPeriod defines a period of time over which to run an EnergyPlus weather file simulation. Some applications require a full annual EnergyPlus simulation, others do not.

Constructor & Destructor Documentation

virtual openstudio::model::RunPeriod::~RunPeriod ( )

virtualdefault

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

default

openstudio::model::RunPeriod::RunPeriod ( RunPeriod && other )

default

Member Function Documentation

void openstudio::model::RunPeriod::ensureNoLeapDays ( )

bool openstudio::model::RunPeriod::getApplyWeekendHolidayRule ( ) const

int openstudio::model::RunPeriod::getBeginDayOfMonth ( ) const

int openstudio::model::RunPeriod::getBeginMonth ( ) const

int openstudio::model::RunPeriod::getEndDayOfMonth ( ) const

int openstudio::model::RunPeriod::getEndMonth ( ) const

int openstudio::model::RunPeriod::getNumTimePeriodRepeats ( ) const

bool openstudio::model::RunPeriod::getUseWeatherFileDaylightSavings ( ) const

bool openstudio::model::RunPeriod::getUseWeatherFileHolidays ( ) const

bool openstudio::model::RunPeriod::getUseWeatherFileRainInd ( ) const

bool openstudio::model::RunPeriod::getUseWeatherFileSnowInd ( ) const

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

static

Returns the IddObjectType.

bool openstudio::model::RunPeriod::isAnnual ( ) const

Returns true if RunPeriod specifies run between 1/1-12/31.

bool openstudio::model::RunPeriod::isPartialYear ( ) const

Returns true if not annual simulation.

bool openstudio::model::RunPeriod::isRepeated ( ) const

Returns true if numTimePeriodRepeats is greater than 1.

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

default

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

default

bool openstudio::model::RunPeriod::setApplyWeekendHolidayRule ( bool apply )

bool openstudio::model::RunPeriod::setBeginDayOfMonth ( int day )

bool openstudio::model::RunPeriod::setBeginMonth ( int month )

bool openstudio::model::RunPeriod::setEndDayOfMonth ( int day )

bool openstudio::model::RunPeriod::setEndMonth ( int month )

bool openstudio::model::RunPeriod::setNumTimePeriodRepeats ( int numRepeats )

bool openstudio::model::RunPeriod::setUseWeatherFileDaylightSavings ( bool use )

bool openstudio::model::RunPeriod::setUseWeatherFileHolidays ( bool use )

bool openstudio::model::RunPeriod::setUseWeatherFileRainInd ( bool rainInd )

bool openstudio::model::RunPeriod::setUseWeatherFileSnowInd ( bool snowInd )

Friends And Related Function Documentation

using OptionalRunPeriod = boost::optional<RunPeriod>

Public Member Functions

Static Public Member Functions

Related Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation