|
|
| ScheduleRule (ScheduleRuleset &scheduleRuleset) |
| Constructor associates this rule with the given ruleset. More...
|
|
| ScheduleRule (ScheduleRuleset &scheduleRuleset, const ScheduleDay &daySchedule) |
| Constructor associates this rule with the given ruleset. More...
|
|
virtual | ~ScheduleRule () |
|
|
ScheduleRuleset | scheduleRuleset () const |
|
int | ruleIndex () const |
|
ScheduleDay | daySchedule () const |
|
bool | applySunday () const |
|
bool | applyMonday () const |
|
bool | applyTuesday () const |
|
bool | applyWednesday () const |
|
bool | applyThursday () const |
|
bool | applyFriday () const |
|
bool | applySaturday () const |
|
std::string | dateSpecificationType () const |
|
boost::optional< openstudio::Date > | startDate () const |
| Returns the start date of the date range if set. More...
|
|
boost::optional< openstudio::Date > | endDate () const |
| Returns the end date of the date range if set. More...
|
|
std::vector< openstudio::Date > | specificDates () const |
| Returns the specific dates specified if any. More...
|
|
|
bool | setApplySunday (bool applySunday) |
|
void | setApplySundayNoFail (bool applySunday) |
|
bool | setApplyMonday (bool applyMonday) |
|
void | setApplyMondayNoFail (bool applyMonday) |
|
bool | setApplyTuesday (bool applyTuesday) |
|
void | setApplyTuesdayNoFail (bool applyTuesday) |
|
bool | setApplyWednesday (bool applyWednesday) |
|
void | setApplyWednesdayNoFail (bool applyWednesday) |
|
bool | setApplyThursday (bool applyThursday) |
|
void | setApplyThursdayNoFail (bool applyThursday) |
|
bool | setApplyFriday (bool applyFriday) |
|
void | setApplyFridayNoFail (bool applyFriday) |
|
bool | setApplySaturday (bool applySaturday) |
|
void | setApplySaturdayNoFail (bool applySaturday) |
|
bool | setStartDate (const openstudio::Date &date) |
| Sets the start date of the date range, will delete any specific dates specified. More...
|
|
bool | setEndDate (const openstudio::Date &date) |
| Sets the end date of the date range, will delete any specific dates specified. More...
|
|
bool | addSpecificDate (const openstudio::Date &date) |
| Adds a specific date, will delete start and end dates. More...
|
|
void | ensureNoLeapDays () |
|
|
bool | containsDate (const openstudio::Date &date) |
| Returns true if this rule covers the given date. More...
|
|
std::vector< bool > | containsDates (const std::vector< openstudio::Date > &dates) |
| Returns whether or not this rule covers each given date. More...
|
|
bool | applyAllDays () const |
| Returns true if the rule applies to all days from Monday to Sunday. More...
|
|
bool | applyWeekdays () const |
| Returns true if the rule applies to all weekdays Monday to Friday. More...
|
|
bool | applyWeekends () const |
| Returns true if the rule applies to Saturday and Sunday. More...
|
|
bool | setApplyAllDays (bool applyAllDays) |
|
bool | setApplyWeekdays (bool applyWeekdays) |
|
bool | setApplyWeekends (bool applyWeekends) |
|
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...
|
|
virtual | ~ParentObject () |
|
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< 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 (std::string valueName, std::string unitString) 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 |
|
ScheduleRule is a ParentObject that wraps the OpenStudio IDD object 'OS:Schedule:Rule'.