#include <ScheduleTypeRegistry.hpp>

Public Member Functions
OSOptionalQuantity	getLowerLimitValue (bool returnIP=false) const
	Returns the lowerLimitValue as an OSOptionalQuantity by using static methods on ScheduleTypeLimits. More...

OSOptionalQuantity	getUpperLimitValue (bool returnIP=false) const
	Returns the upperLimitValue as an OSOptionalQuantity by using static methods on ScheduleTypeLimits. More...

Public Attributes
std::string	className
	The name of a class that can point to a schedule. More...

bool	isContinuous
	Set to true if the schedule values are continuous (doubles); false if they are discrete (integers). More...

boost::optional< double >	lowerLimitValue
	Minimum value for this schedule type (or unbounded if == boost::none). More...

std::string	scheduleDisplayName
	The display name of that schedule (which is used as a key in ScheduleTypeRegistrySingleton, and is also intented for use in UI displays). More...

std::string	scheduleRelationshipName
	The name of the Relationship that points from the user (of type className) to the Schedule. More...

std::string	unitType
	Key into the ScheduleTypeLimits field "Unit Type". More...

boost::optional< double >	upperLimitValue
	Maximum value for this schedule type (or unbounded if == boost::none). More...

Related Functions
(Note that these are not member functions.)
bool	isCompatible (const ScheduleType &scheduleType, const ScheduleTypeLimits &candidate)
	Returns true if candidate is consistent with scheduleType. More...

typedef std::vector< ScheduleType >	ScheduleTypeVector

Detailed Description

Data structure for registering and viewing a specific type of schedule that can exist in a Model.

Member Function Documentation

OSOptionalQuantity openstudio::model::ScheduleType::getLowerLimitValue ( bool returnIP = false ) const

Returns the lowerLimitValue as an OSOptionalQuantity by using static methods on ScheduleTypeLimits.

OSOptionalQuantity openstudio::model::ScheduleType::getUpperLimitValue ( bool returnIP = false ) const

Returns the upperLimitValue as an OSOptionalQuantity by using static methods on ScheduleTypeLimits.

std::string openstudio::model::ScheduleType::className

The name of a class that can point to a schedule.

bool openstudio::model::ScheduleType::isContinuous

Set to true if the schedule values are continuous (doubles); false if they are discrete (integers).

Used to set or test the ScheduleTypeLimits field "Numeric Type".

boost::optional<double> openstudio::model::ScheduleType::lowerLimitValue

Minimum value for this schedule type (or unbounded if == boost::none).

std::string openstudio::model::ScheduleType::scheduleDisplayName

The display name of that schedule (which is used as a key in ScheduleTypeRegistrySingleton, and is also intented for use in UI displays).

std::string openstudio::model::ScheduleType::scheduleRelationshipName

The name of the Relationship that points from the user (of type className) to the Schedule.

std::string openstudio::model::ScheduleType::unitType

Key into the ScheduleTypeLimits field "Unit Type".

boost::optional<double> openstudio::model::ScheduleType::upperLimitValue

Maximum value for this schedule type (or unbounded if == boost::none).