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

#include <YearDescription.hpp>

+ Inheritance diagram for openstudio::model::YearDescription:

Public Member Functions

int assumedYear () const
 Returns assumed year for date calculations. More...
 
openstudio::Date makeDate (openstudio::MonthOfYear monthOfYear, unsigned dayOfMonth)
 Returns a date which may be used in this model. More...
 
openstudio::Date makeDate (unsigned monthOfYear, unsigned dayOfMonth)
 
openstudio::Date makeDate (openstudio::NthDayOfWeekInMonth n, openstudio::DayOfWeek dayOfWeek, openstudio::MonthOfYear monthOfYear)
 nth weekday of month generators More...
 
openstudio::Date makeDate (unsigned dayOfYear)
 day of year More...
 
Constructors and Destructors
virtual ~YearDescription ()=default
 
 YearDescription (const YearDescription &other)=default
 
 YearDescription (YearDescription &&other)=default
 
YearDescriptionoperator= (const YearDescription &)=default
 
YearDescriptionoperator= (YearDescription &&)=default
 
Getters
boost::optional< int > calendarYear () const
 
std::string dayofWeekforStartDay () const
 
bool isDayofWeekforStartDayDefaulted () const
 
bool isLeapYear () const
 
bool isIsLeapYearDefaulted () const
 
Setters
bool setCalendarYear (int calendarYear)
 
void resetCalendarYear ()
 
bool setDayofWeekforStartDay (const std::string &dayofWeekforStartDay)
 
void resetDayofWeekforStartDay ()
 
bool setIsLeapYear (bool isLeapYear)
 
void resetIsLeapYear ()
 
- Public Member Functions inherited from openstudio::model::ParentObject
std::vector< IddObjectType > allowableChildTypes () const
 Returns a vector of allowable children types. More...
 
std::vector< ModelObjectchildren () const
 Return direct child objects in the Model. More...
 
ParentObjectoperator= (const ParentObject &)=default
 
ParentObjectoperator= (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
 
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 std::vector< std::string > validDayofWeekforStartDayValues ()
 

Related Functions

(Note that these are not member functions.)

using OptionalYearDescription = boost::optional< YearDescription >
 
using YearDescriptionVector = std::vector< YearDescription >
 

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
using ImplType = detail::ModelObject_Impl
 
- 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)
 

Detailed Description

YearDescription is a ParentObject that wraps the OpenStudio IDD object 'OS_YearDescription'.

Constructor & Destructor Documentation

virtual openstudio::model::YearDescription::~YearDescription ( )
virtualdefault
openstudio::model::YearDescription::YearDescription ( const YearDescription other)
default
openstudio::model::YearDescription::YearDescription ( YearDescription &&  other)
default

Member Function Documentation

int openstudio::model::YearDescription::assumedYear ( ) const

Returns assumed year for date calculations.

boost::optional<int> openstudio::model::YearDescription::calendarYear ( ) const
std::string openstudio::model::YearDescription::dayofWeekforStartDay ( ) const
static IddObjectType openstudio::model::YearDescription::iddObjectType ( )
static
bool openstudio::model::YearDescription::isDayofWeekforStartDayDefaulted ( ) const
bool openstudio::model::YearDescription::isIsLeapYearDefaulted ( ) const
bool openstudio::model::YearDescription::isLeapYear ( ) const
openstudio::Date openstudio::model::YearDescription::makeDate ( openstudio::MonthOfYear  monthOfYear,
unsigned  dayOfMonth 
)

Returns a date which may be used in this model.

Will throw if dayOfMonth is not appropriate for monthOfYear.

openstudio::Date openstudio::model::YearDescription::makeDate ( unsigned  monthOfYear,
unsigned  dayOfMonth 
)
openstudio::Date openstudio::model::YearDescription::makeDate ( openstudio::NthDayOfWeekInMonth  n,
openstudio::DayOfWeek  dayOfWeek,
openstudio::MonthOfYear  monthOfYear 
)

nth weekday of month generators

openstudio::Date openstudio::model::YearDescription::makeDate ( unsigned  dayOfYear)

day of year

YearDescription& openstudio::model::YearDescription::operator= ( const YearDescription )
default
YearDescription& openstudio::model::YearDescription::operator= ( YearDescription &&  )
default
void openstudio::model::YearDescription::resetCalendarYear ( )
void openstudio::model::YearDescription::resetDayofWeekforStartDay ( )
void openstudio::model::YearDescription::resetIsLeapYear ( )
bool openstudio::model::YearDescription::setCalendarYear ( int  calendarYear)
bool openstudio::model::YearDescription::setDayofWeekforStartDay ( const std::string &  dayofWeekforStartDay)
bool openstudio::model::YearDescription::setIsLeapYear ( bool  isLeapYear)
static std::vector<std::string> openstudio::model::YearDescription::validDayofWeekforStartDayValues ( )
static

Friends And Related Function Documentation

using OptionalYearDescription = boost::optional<YearDescription>
related
using YearDescriptionVector = std::vector<YearDescription>
related