Connections

Wires

class mhrc.automation.wire.Wire

Wire Component Command Object

Base class for WireOrthogonal, WireBranch, Bus, TLine and Cable components.

To construct a new wire, use UserCanvas.add_wire().

Identification

Wire.vertices([vertices])

Set or get the vertices of the wire

Parameters:vertices – a list of (x,y) coordinates (optional)
Returns:A list of (x,y) coordinates.

Orthogonal Wires

class mhrc.automation.wire.WireOrthogonal

Orthogonal Wire Component Command Object

Each segment of the wire will be either horizontal or vertical. Diagonal segments are not allowed.

Identification

WireOrthogonal.vertices([vertices])

Set or get the vertices of the wire

Parameters:vertices – a list of (x,y) coordinates (optional)
Returns:A list of (x,y) coordinates.

Buses

class mhrc.automation.bus.BusComponent

Bus Component Command Object

To construct a new wire, use UserCanvas.add_bus().

Configuration

BusComponent.vertices([vertices])

Set or get the vertices of the wire

Parameters:vertices – a list of (x,y) coordinates (optional)
Returns:A list of (x,y) coordinates.
BusComponent.set_parameters([scenario, ]name=value[, ...])

Set the Bus component parameters.

Bus Parameters
Parameter Type Description
Name str Name of the Bus
BaseKV str Bus Base Voltage, in kV. May be zero.
Parameters:
  • scenario (str) – Name of scenario to set parameters for. (optional)
  • **kwargs – One or more name=value keyword parameters
BusComponent.get_parameters(scenario=None)

Get the Bus component parameters.

Parameters:scenario (str) – Name of scenario to get parameters from. (optional)
Returns:A dictionary of property name=value pairs.

T-Lines

class mhrc.automation.tline.TLineComponent

TLine Component Command Object

Configuration

TLineComponent.canvas()
TLineComponent.set_parameters([scenario, ]name=value[, ...])

Set the TLine component parameters.

The valid parameters for the component are determined by the component definition.

Parameters:
  • scenario (str) – Name of scenario to set parameters for. (optional)
  • **kwargs – One or more name=value keyword parameters
TLineComponent.get_parameters(scenario=None)

Get TLine component parameters

get_parameters(‘xxx’) - set parameters for scenario ‘xxx’.

Cables

class mhrc.automation.cable.CableComponent

Cable Component Command Object

Configuration

CableComponent.canvas()
CableComponent.set_parameters(scenario=None, **parameters)

Set Cable component parameters

set_parameters(param1=value1, param2=value2, …) - sets param1, param2 set_parameters(‘xxx’, …) - set parameters for scenario ‘xxx’.

CableComponent.get_parameters(scenario=None)

Get Cable component parameters

get_parameters(‘xxx’) - set parameters for scenario ‘xxx’.