IO_Objects

Template and interface classes that handle evaluator inputs and outputs.

class IO_Objects.AnyValue(name='')

A Descriptor that can take on any possible value. Intended to be used as a placeholder.

sample(value)

This is a placeholder descriptor. Therefore, sampling is not possible.

validate(value) → bool

All values are accepted by this Descriptor, so validate always returns True

Parameters:value – The value to validate Returns:True

class IO_Objects.Descriptor(name='')

Base class for descriptors.

Descriptors describe a set of possible values for a single input. They are used in Parameters to specify the possible input space.

sample(value)

Takes a value in the range 0-1 and returns a valid value for this parameter

validate(value) → bool

Checks if value is a valid value for this Descriptor.

Parameters:value – The value to check. Returns:True if the value is valid False otherwise

class IO_Objects.DummySelector

A selector that does not modify the building. Intended to be used as a placeholder.

get(building)

Getting the value of this placeholder is not possible.

This function will raise a NotImplementedError.

set(building, value)

This placeholder will not do anything with the given value.

class IO_Objects.IOBase(name='')

Base class for inputs, objectives and constraints.

name is used for generating DataFrame column titles.

has_default_name()

Returns:True if this object is using its default name, false otherwise

class IO_Objects.Objective(name='')

Base class for objectives.

class IO_Objects.ReprMixin

Adds a useful string representation to subclasses

class IO_Objects.Selector

Base Class for Selectors, which describe what attribute of the model is read or modified

get(building)

Get the current value of this attribute of the building

Parameters:building – Returns:

set(building, value)

Modifies building, setting the attribute this selector corresponds to to value

Parameters:

• building – the building to modify.
• value – the value to set this selector’s attribute to.

Returns:

setup(building) → None

Modifies the building so that it is ready for this selector