IO_Objects

class IO_Objects.AnyValue(**kwargs)[source]

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

sample(value)[source]

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

Parameters:value
validate(value)[source]

Checks if value is a valid value for this parameter.

Parameters:value – The value to check
Returns:True if the value is valid False otherwise
class IO_Objects.Descriptor(**kwargs)[source]
sample(value)[source]

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

Parameters:value
validate(value) → bool[source]

Checks if value is a valid value for this parameter.

Parameters:value – The value to check
Returns:True if the value is valid False otherwise
class IO_Objects.DummySelector[source]

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

class IO_Objects.IOBase(name)[source]

Base class for inputs, objectives and constraints.

Parameters:name (str) – For generating DataFrame column titles.
class IO_Objects.Objective(name)[source]

Base class for objectives.

class IO_Objects.ReprMixin[source]

Adds a useful string representation to subclasses

class IO_Objects.Selector[source]

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

setup(building) → None[source]

Modifies the building so that it is ready for this selector