OpenStudio:model
 AllClasses Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages

#include "ScheduleConstant.hpp"

Inheritance diagram for openstudio::model::ScheduleConstant:

Public Member Functions

 ScheduleConstant (const Model &model)
virtual ~ScheduleConstant ()
double value () const
boost::optional< QuantitygetValue (bool returnIP=false) const
void setValue (double value)
bool setValue (const Quantity &value)

Static Public Member Functions

static IddObjectType iddObjectType ()

Protected Types

typedef
detail::ScheduleConstant_Impl 
ImplType

Protected Member Functions

 ScheduleConstant (std::shared_ptr< detail::ScheduleConstant_Impl > impl)

Related 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

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

boost::optional<Quantity> openstudio::model::ScheduleConstant::getValue ( bool  returnIP = false) const

Returns the value of this ScheduleConstant as a Quantity if scheduleTypeLimits() is set.

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

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

double openstudio::model::ScheduleConstant::value ( ) const

Friends And Related Function Documentation

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