OpenStudio:model
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Attributes | Related Functions | List of all members
openstudio::model::ScheduleType Struct Reference

#include <ScheduleTypeRegistry.hpp>

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, bool isStringent=false)
 Returns true if candidate is consistent with scheduleType. More...
 
typedef std::vector< ScheduleTypeScheduleTypeVector
 

Detailed Description

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

Friends And Related Function Documentation

bool isCompatible ( const ScheduleType scheduleType,
const ScheduleTypeLimits candidate,
bool  isStringent = false 
)
related

Returns true if candidate is consistent with scheduleType.

When isStringent is true, we also check that if scheduleType does not have a lower/upper bound, then candidate must not have them either.

typedef std::vector<ScheduleType> ScheduleTypeVector
related

Member Data Documentation

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