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

#include <ScheduleConstant.hpp>

+ Inheritance diagram for openstudio::model::ScheduleConstant:

Public Member Functions

Constructors and Destructors
 ScheduleConstant (const Model &model)
 Creates new ScheduleConstant in model and sets its value to 0.0. More...
 
virtual ~ScheduleConstant ()
 
Getters
double value () const
 
Setters
bool setValue (double value)
 
- Public Member Functions inherited from openstudio::model::Schedule
virtual ~Schedule ()
 
- Public Member Functions inherited from openstudio::model::ScheduleBase
virtual ~ScheduleBase ()
 
boost::optional
< ScheduleTypeLimits
scheduleTypeLimits () const
 Returns the ScheduleTypeLimits of this object, if set. More...
 
bool setScheduleTypeLimits (const ScheduleTypeLimits &scheduleTypeLimits)
 Returns true if scheduleTypeLimits is compatible with this object and is actually set. More...
 
bool resetScheduleTypeLimits ()
 Returns true if the scheduleTypeLimits() of this object is successfully cleared. More...
 
void ensureNoLeapDays ()
 
- 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...
 
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...
 
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 ()
 

Protected Types

typedef
detail::ScheduleConstant_Impl 
ImplType
 Sets this ScheduleConstant's value if scheduleTypeLimits() is set and value can be properly converted to the 'SI' units so implied. More...
 
- Protected Types inherited from openstudio::model::ModelObject
typedef detail::ModelObject_Impl ImplType
 

Protected Member Functions

 ScheduleConstant (std::shared_ptr< detail::ScheduleConstant_Impl > impl)
 
- 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)
 

Related Functions

(Note that these are not member functions.)

typedef boost::optional
< ScheduleConstant
OptionalScheduleConstant
 
typedef std::vector
< ScheduleConstant
ScheduleConstantVector
 

Detailed Description

ScheduleConstant is a Schedule that wraps the OpenStudio IDD object 'OS:Schedule:Constant'.

Member Typedef Documentation

typedef detail::ScheduleConstant_Impl openstudio::model::ScheduleConstant::ImplType
protected

Sets this ScheduleConstant's value if scheduleTypeLimits() is set and value can be properly converted to the 'SI' units so implied.

Constructor & Destructor Documentation

openstudio::model::ScheduleConstant::ScheduleConstant ( const Model model)
explicit

Creates new ScheduleConstant in model and sets its value to 0.0.

virtual openstudio::model::ScheduleConstant::~ScheduleConstant ( )
inlinevirtual
openstudio::model::ScheduleConstant::ScheduleConstant ( std::shared_ptr< detail::ScheduleConstant_Impl >  impl)
explicitprotected

Member Function Documentation

static IddObjectType openstudio::model::ScheduleConstant::iddObjectType ( )
static
bool openstudio::model::ScheduleConstant::setValue ( double  value)
double openstudio::model::ScheduleConstant::value ( ) const

Friends And Related Function Documentation

typedef boost::optional<ScheduleConstant> OptionalScheduleConstant
related
typedef std::vector<ScheduleConstant> ScheduleConstantVector
related