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)
virtual	~ScheduleCompact () override=default
	ScheduleCompact (const ScheduleCompact &other)=default
	ScheduleCompact (ScheduleCompact &&other)=default
ScheduleCompact &	operator= (const ScheduleCompact &)=default
ScheduleCompact &	operator= (ScheduleCompact &&)=default
bool	setToConstantValue (double value)
bool	isConstantValue () const
boost::optional< double >	constantValue () const

Static Public Member Functions
static IddObjectType	iddObjectType ()

Protected Types
using	ImplType = detail::ScheduleCompact_Impl

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

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

Detailed Description

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

Member Typedef Documentation

using openstudio::model::ScheduleCompact::ImplType = detail::ScheduleCompact_Impl

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.

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

overridevirtualdefault

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

Otherwise creates an empty ScheduleCompact.

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

default

openstudio::model::ScheduleCompact::ScheduleCompact ( ScheduleCompact &&  other )

default

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).

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.)

ScheduleCompact& openstudio::model::ScheduleCompact::operator= ( const ScheduleCompact &  )

default

ScheduleCompact& openstudio::model::ScheduleCompact::operator= ( ScheduleCompact &&  )

default

bool openstudio::model::ScheduleCompact::setToConstantValue

(

double

value

)

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

Friends And Related Function Documentation

using OptionalScheduleCompact = boost::optional<ScheduleCompact>

related

using ScheduleCompactVector = std::vector<ScheduleCompact>

related