honeybee_energy.schedule.typelimit module

Schedule type definition.

class honeybee_energy.schedule.typelimit.ScheduleTypeLimit(identifier, lower_limit=NoLimit, upper_limit=NoLimit, numeric_type='Continuous', unit_type='Dimensionless')

Bases: object

Energy schedule type definition.

Schedule types exist for the sole purpose of validating schedule values against upper/lower limits and assigning a data type and units to the schedule values.

Parameters:

• identifier – Text string for a unique Schedule Type ID. Must be < 100 characters and not contain any EnergyPlus special characters. This will be used to identify the object across a model and in the exported IDF.

• lower_limit – An optional number for the lower limit for values in the schedule. If None or a NoLimit object, there will be no lower limit.

• upper_limit – An optional number for the upper limit for values in the schedule. If None or a NoLimit object, there will be no upper limit.

• numeric_type – Either one of two strings: ‘Continuous’ or ‘Discrete’. The latter means that only integers are accepted as schedule values. (Default: Continuous).

• unit_type –

  Text for an EnergyPlus unit type, which will be used to assign units to the values in the schedule. Note that this field is not used in the actual calculations of EnergyPlus. (Default: Dimensionless). Choose from the following options:

  • Dimensionless

  • Temperature

  • DeltaTemperature

  • PrecipitationRate

  • Angle

  • ConvectionCoefficient

  • ActivityLevel

  • Velocity

  • Capacity

  • Power

  • Availability

  • Percent

  • Control

  • Mode

Properties:

• identifier

• display_name

• lower_limit

• upper_limit

• numeric_type

• unit_type

• data_type

• unit

ToString()

Overwrite .NET ToString.

duplicate()

Get a copy of this object.

static extract_all_from_idf_file(idf_file)

Extract all ScheduleTypeLimit objects from an EnergyPlus IDF file.

Parameters:

idf_file – A path to an IDF file containing objects for ScheduleTypeLimits.

Returns:

schedule_type_limits – A list of all ScheduleTypeLimits objects in the

IDF file as honeybee_energy ScheduleTypeLimit objects.

classmethod from_dict(data)

Create a ScheduleTypeLimit from a dictionary.

Parameters:

data – ScheduleTypeLimit dictionary following the format below.

{
"type": 'ScheduleTypeLimit',
"identifier": 'Fractional',
"display_name": 'Fractional',
"lower_limit": 0,
"upper_limit": 1,
"numeric_type": Continuous,
"unit_type": "Dimensionless"
}

classmethod from_idf(idf_string)

Create a ScheduleTypeLimit from an IDF string of ScheduleTypeLimits.

Parameters:

idf_string – A text string describing EnergyPlus ScheduleTypeLimits.

to_dict()

Shade construction dictionary representation.

to_idf()

IDF string for the ScheduleTypeLimits of this object.

ScheduleTypeLimits,
    my type limit,            !- name
    ,                         !- lower limit value
    ,                         !- upper limit value
    Continuous,               !- numeric type
    Percent;                  !- unit type

NUMERIC_TYPES = ('Continuous', 'Discrete')

UNIT_TYPES = ('Dimensionless', 'Temperature', 'DeltaTemperature', 'PrecipitationRate', 'Angle', 'ConvectionCoefficient', 'ActivityLevel', 'Velocity', 'Capacity', 'Power', 'Availability', 'Percent', 'Control', 'Mode')

property data_type

Get the Ladybug DataType object corresponding to the energyplus unit type.

This object can be used for creating Ladybug DataCollections, performing unit conversions of schedule values, etc.

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property identifier

Get the text string for unique schedule type identifier.

property lower_limit

Get the lower limit of the schedule type.

property numeric_type

Text noting whether schedule values are ‘Continuous’ or ‘Discrete’.

property unit

Get the string describing the units of the schedule values (ie. ‘C’, ‘W’).

property unit_type

Get the text string describing the energyplus unit type.

property upper_limit

Get the upper limit of the schedule type.