ScheduleCompact Class Reference

#include "ScheduleCompact.hpp"

Inheritance diagram for openstudio::model::ScheduleCompact:

Public Member Functions
	ScheduleCompact (const Model &model)
	ScheduleCompact (const Model &model, double constantValue)
	ScheduleCompact (const Model &model, const Quantity &constantValue)
virtual	~ScheduleCompact ()
void	setToConstantValue (double value)
bool	setToConstantValue (const Quantity &value)
bool	isConstantValue () const
boost::optional< double >	constantValue () const
boost::optional< Quantity >	getConstantValue (bool returnIP=false) const

Static Public Member Functions
static IddObjectType	iddObjectType ()

Protected Types
typedef detail::ScheduleCompact_Impl	ImplType

Protected Member Functions
	ScheduleCompact (std::shared_ptr< detail::ScheduleCompact_Impl > impl)

Related Functions
typedef boost::optional < ScheduleCompact >	OptionalScheduleCompact
typedef std::vector < ScheduleCompact >	ScheduleCompactVector

Detailed Description

ScheduleCompact is a Schedule that wraps the OpenStudio IDD object 'OS:Schedule:Compact'.

Member Typedef Documentation

typedef detail::ScheduleCompact_Impl openstudio::model::ScheduleCompact::ImplType

protected

Constructor & Destructor Documentation

openstudio::model::ScheduleCompact::ScheduleCompact ( const Model &  model )

explicit

Creates an empty (no values set for any days) ScheduleCompact.

openstudio::model::ScheduleCompact::ScheduleCompact	(	const Model &	model,
		double	constantValue
	)

Creates a ScheduleCompact with constantValue applied to the entire year.

openstudio::model::ScheduleCompact::ScheduleCompact	(	const Model &	model,
		const Quantity &	constantValue
	)

Creates a ScheduleCompact with constantValue applied to the entire year, if scheduleTypeLimits() and the units are compatible.

Otherwise creates an empty ScheduleCompact.

virtual openstudio::model::ScheduleCompact::~ScheduleCompact ( )

inlinevirtual

openstudio::model::ScheduleCompact::ScheduleCompact ( std::shared_ptr< detail::ScheduleCompact_Impl >  impl )

explicitprotected

Member Function Documentation

boost::optional<double> openstudio::model::ScheduleCompact::constantValue

(

)

const

Returns this ScheduleCompact's constant value, if this ScheduleCompact conforms to that pattern.

Otherwise returns boost::none (evaluates to false).

boost::optional<Quantity> openstudio::model::ScheduleCompact::getConstantValue

(

bool

returnIP = false

)

const

Returns this ScheduleCompact's constant value as a Quantity, if this ScheduleCompact conforms to that pattern and scheduleTypeLimits() is set.

Otherwise returns boost::none (evaluates to false).

static IddObjectType openstudio::model::ScheduleCompact::iddObjectType ( )

static

bool openstudio::model::ScheduleCompact::isConstantValue

(

)

const

Returns true if this ScheduleCompact has a single value applied to the entire year.

(Roughly–the text fields are not checked.)

void openstudio::model::ScheduleCompact::setToConstantValue

(

double

value

)

Clears all existing data and sets the data so that value will be applied to the entire year.

bool openstudio::model::ScheduleCompact::setToConstantValue

(

const Quantity &

value

)

If value can be converted to scheduleTypeLimit()'s units, then all existing data is cleared and value is set (after unit conversion, if necessary).

Friends And Related Function Documentation

typedef boost::optional<ScheduleCompact> OptionalScheduleCompact

related

typedef std::vector<ScheduleCompact> ScheduleCompactVector

related