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

#include <ScheduleWeek.hpp>

+ Inheritance diagram for openstudio::model::ScheduleWeek:

Public Member Functions

Constructors and Destructors
 ScheduleWeek (const Model &model)
virtual ~ScheduleWeek ()
boost::optional< ScheduleDaysundaySchedule () const
boost::optional< ScheduleDaymondaySchedule () const
boost::optional< ScheduleDaytuesdaySchedule () const
boost::optional< ScheduleDaywednesdaySchedule () const
boost::optional< ScheduleDaythursdaySchedule () const
boost::optional< ScheduleDayfridaySchedule () const
boost::optional< ScheduleDaysaturdaySchedule () const
boost::optional< ScheduleDayholidaySchedule () const
boost::optional< ScheduleDaysummerDesignDaySchedule () const
boost::optional< ScheduleDaywinterDesignDaySchedule () const
boost::optional< ScheduleDaycustomDay1Schedule () const
boost::optional< ScheduleDaycustomDay2Schedule () const
bool setSundaySchedule (const ScheduleDay &schedule)
bool setMondaySchedule (const ScheduleDay &schedule)
bool setTuesdaySchedule (const ScheduleDay &schedule)
bool setWednesdaySchedule (const ScheduleDay &schedule)
bool setThursdaySchedule (const ScheduleDay &schedule)
bool setFridaySchedule (const ScheduleDay &schedule)
bool setSaturdaySchedule (const ScheduleDay &schedule)
bool setHolidaySchedule (const ScheduleDay &schedule)
bool setSummerDesignDaySchedule (const ScheduleDay &schedule)
bool setWinterDesignDaySchedule (const ScheduleDay &schedule)
bool setCustomDay1Schedule (const ScheduleDay &schedule)
bool setCustomDay2Schedule (const ScheduleDay &schedule)
bool setAllSchedules (const ScheduleDay &schedule)
 Set schedules for all days. More...
bool setWeekdaySchedule (const ScheduleDay &schedule)
 Set schedules for all weekdays. More...
bool setWeekendSchedule (const ScheduleDay &schedule)
 Set schedules for all weekends. More...
- Public Member Functions inherited from openstudio::model::ResourceObject
unsigned directUseCount (bool excludeChildren=false) const
 Returns the number of objects that use this resource directly. More...
unsigned nonResourceObjectUseCount (bool excludeChildren=false) const
 Returns the number of non-ResourceObjects that use this resource either directly or indirectly. More...
virtual ~ResourceObject ()
- 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...
virtual ~ParentObject ()
- Public Member Functions inherited from openstudio::model::ModelObject
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< 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...
< 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...
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 (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< ModelObjectconnectedObject (unsigned port) const
boost::optional< unsigned > connectedObjectPort (unsigned port) const

Static Public Member Functions

static IddObjectType iddObjectType ()

Related Functions

(Note that these are not member functions.)

typedef boost::optional
< ScheduleWeek
typedef std::vector< ScheduleWeekScheduleWeekVector

Additional Inherited Members

- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
- Protected Member Functions inherited from openstudio::model::ResourceObject
 ResourceObject (IddObjectType type, const Model &model)
 Constructs a new PlanarSurface object in the model. More...
- 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

ScheduleWeek is a ResourceObject that wraps the OpenStudio IDD object 'OS_Schedule_Week'.

Constructor & Destructor Documentation

openstudio::model::ScheduleWeek::ScheduleWeek ( const Model model)
virtual openstudio::model::ScheduleWeek::~ScheduleWeek ( )

Member Function Documentation

boost::optional<ScheduleDay> openstudio::model::ScheduleWeek::customDay1Schedule ( ) const
boost::optional<ScheduleDay> openstudio::model::ScheduleWeek::customDay2Schedule ( ) const
boost::optional<ScheduleDay> openstudio::model::ScheduleWeek::fridaySchedule ( ) const
boost::optional<ScheduleDay> openstudio::model::ScheduleWeek::holidaySchedule ( ) const
static IddObjectType openstudio::model::ScheduleWeek::iddObjectType ( )
boost::optional<ScheduleDay> openstudio::model::ScheduleWeek::mondaySchedule ( ) const
boost::optional<ScheduleDay> openstudio::model::ScheduleWeek::saturdaySchedule ( ) const
bool openstudio::model::ScheduleWeek::setAllSchedules ( const ScheduleDay schedule)

Set schedules for all days.

bool openstudio::model::ScheduleWeek::setCustomDay1Schedule ( const ScheduleDay schedule)
bool openstudio::model::ScheduleWeek::setCustomDay2Schedule ( const ScheduleDay schedule)
bool openstudio::model::ScheduleWeek::setFridaySchedule ( const ScheduleDay schedule)
bool openstudio::model::ScheduleWeek::setHolidaySchedule ( const ScheduleDay schedule)
bool openstudio::model::ScheduleWeek::setMondaySchedule ( const ScheduleDay schedule)
bool openstudio::model::ScheduleWeek::setSaturdaySchedule ( const ScheduleDay schedule)
bool openstudio::model::ScheduleWeek::setSummerDesignDaySchedule ( const ScheduleDay schedule)
bool openstudio::model::ScheduleWeek::setSundaySchedule ( const ScheduleDay schedule)
bool openstudio::model::ScheduleWeek::setThursdaySchedule ( const ScheduleDay schedule)
bool openstudio::model::ScheduleWeek::setTuesdaySchedule ( const ScheduleDay schedule)
bool openstudio::model::ScheduleWeek::setWednesdaySchedule ( const ScheduleDay schedule)
bool openstudio::model::ScheduleWeek::setWeekdaySchedule ( const ScheduleDay schedule)

Set schedules for all weekdays.

bool openstudio::model::ScheduleWeek::setWeekendSchedule ( const ScheduleDay schedule)

Set schedules for all weekends.

bool openstudio::model::ScheduleWeek::setWinterDesignDaySchedule ( const ScheduleDay schedule)
boost::optional<ScheduleDay> openstudio::model::ScheduleWeek::summerDesignDaySchedule ( ) const
boost::optional<ScheduleDay> openstudio::model::ScheduleWeek::sundaySchedule ( ) const
boost::optional<ScheduleDay> openstudio::model::ScheduleWeek::thursdaySchedule ( ) const
boost::optional<ScheduleDay> openstudio::model::ScheduleWeek::tuesdaySchedule ( ) const
boost::optional<ScheduleDay> openstudio::model::ScheduleWeek::wednesdaySchedule ( ) const
boost::optional<ScheduleDay> openstudio::model::ScheduleWeek::winterDesignDaySchedule ( ) const

Friends And Related Function Documentation

typedef boost::optional<ScheduleWeek> OptionalScheduleWeek
typedef std::vector<ScheduleWeek> ScheduleWeekVector