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

#include <RunPeriodControlSpecialDays.hpp>

+ Inheritance diagram for openstudio::model::RunPeriodControlSpecialDays:

Public Member Functions

Constructors and Destructors
 RunPeriodControlSpecialDays (const std::string &startDate, Model &model)
 Constructor with string, will throw if incorrect format. More...
 
 RunPeriodControlSpecialDays (const openstudio::MonthOfYear &monthOfYear, unsigned day, Model &model)
 Constructor with month of year and day, e.g. More...
 
 RunPeriodControlSpecialDays (const openstudio::NthDayOfWeekInMonth &nth, const openstudio::DayOfWeek &dayOfWeek, const openstudio::MonthOfYear &monthOfYear, Model &model)
 Constructor from nth day in month, e.g. More...
 
virtual ~RunPeriodControlSpecialDays ()=default
 
 RunPeriodControlSpecialDays (const RunPeriodControlSpecialDays &other)=default
 
 RunPeriodControlSpecialDays (RunPeriodControlSpecialDays &&other)=default
 
RunPeriodControlSpecialDaysoperator= (const RunPeriodControlSpecialDays &)=default
 
RunPeriodControlSpecialDaysoperator= (RunPeriodControlSpecialDays &&)=default
 
Getters
openstudio::Date startDate () const
 
unsigned duration () const
 
std::string specialDayType () const
 
Setters
bool setStartDate (const std::string &startDate)
 
bool setStartDate (const openstudio::MonthOfYear &monthOfYear, unsigned day)
 
bool setStartDate (const openstudio::NthDayOfWeekInMonth &nth, const openstudio::DayOfWeek &dayOfWeek, const openstudio::MonthOfYear &monthOfYear)
 
bool setDuration (unsigned duration)
 
bool setSpecialDayType (const std::string &specialDayType)
 
void ensureNoLeapDays ()
 
- 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 IddObjectType iddObjectType ()
 Returns the IddObjectType. More...
 
Static Methods
static std::vector< std::string > specialDayTypeValues ()
 
static std::vector< std::string > validSpecialDayTypeValues ()
 

Related Functions

(Note that these are not member functions.)

using OptionalRunPeriodControlSpecialDays = boost::optional< RunPeriodControlSpecialDays >
 
using RunPeriodControlSpecialDaysVector = std::vector< RunPeriodControlSpecialDays >
 

Additional Inherited Members

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

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

Constructor & Destructor Documentation

openstudio::model::RunPeriodControlSpecialDays::RunPeriodControlSpecialDays ( const std::string &  startDate,
Model model 
)

Constructor with string, will throw if incorrect format.

openstudio::model::RunPeriodControlSpecialDays::RunPeriodControlSpecialDays ( const openstudio::MonthOfYear &  monthOfYear,
unsigned  day,
Model model 
)

Constructor with month of year and day, e.g.

Jan, 1.

openstudio::model::RunPeriodControlSpecialDays::RunPeriodControlSpecialDays ( const openstudio::NthDayOfWeekInMonth &  nth,
const openstudio::DayOfWeek &  dayOfWeek,
const openstudio::MonthOfYear &  monthOfYear,
Model model 
)

Constructor from nth day in month, e.g.

1st Friday in January.

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

Member Function Documentation

unsigned openstudio::model::RunPeriodControlSpecialDays::duration ( ) const
void openstudio::model::RunPeriodControlSpecialDays::ensureNoLeapDays ( )
static IddObjectType openstudio::model::RunPeriodControlSpecialDays::iddObjectType ( )
static

Returns the IddObjectType.

RunPeriodControlSpecialDays& openstudio::model::RunPeriodControlSpecialDays::operator= ( const RunPeriodControlSpecialDays )
default
RunPeriodControlSpecialDays& openstudio::model::RunPeriodControlSpecialDays::operator= ( RunPeriodControlSpecialDays &&  )
default
bool openstudio::model::RunPeriodControlSpecialDays::setDuration ( unsigned  duration)
bool openstudio::model::RunPeriodControlSpecialDays::setSpecialDayType ( const std::string &  specialDayType)
bool openstudio::model::RunPeriodControlSpecialDays::setStartDate ( const std::string &  startDate)
bool openstudio::model::RunPeriodControlSpecialDays::setStartDate ( const openstudio::MonthOfYear &  monthOfYear,
unsigned  day 
)
bool openstudio::model::RunPeriodControlSpecialDays::setStartDate ( const openstudio::NthDayOfWeekInMonth &  nth,
const openstudio::DayOfWeek &  dayOfWeek,
const openstudio::MonthOfYear &  monthOfYear 
)
std::string openstudio::model::RunPeriodControlSpecialDays::specialDayType ( ) const
static std::vector<std::string> openstudio::model::RunPeriodControlSpecialDays::specialDayTypeValues ( )
static
openstudio::Date openstudio::model::RunPeriodControlSpecialDays::startDate ( ) const
static std::vector<std::string> openstudio::model::RunPeriodControlSpecialDays::validSpecialDayTypeValues ( )
static

Friends And Related Function Documentation