VeraGridEngine.IO.iidm.devices package

Submodules

VeraGridEngine.IO.iidm.devices.iidm_area module

class VeraGridEngine.IO.iidm.devices.iidm_area.IidmArea(_id: str, name: str = '', area_type: str = '', interchange_target: float = 0.0)

Bases: IidmObject

to_veragrid() → Area

Convert

VeraGridEngine.IO.iidm.devices.iidm_bus module

class VeraGridEngine.IO.iidm.devices.iidm_bus.IidmBus(_id: str, area_number: int, status: str, nodes: List[int])

Bases: IidmObject

to_veragrid(area_dict: Dict[int, Area]) → Bus

Convert

VeraGridEngine.IO.iidm.devices.iidm_busbar_section module

class VeraGridEngine.IO.iidm.devices.iidm_busbar_section.IidmBusbarSection(_id: str)

Bases: IidmObject

VeraGridEngine.IO.iidm.devices.iidm_circuit module

class VeraGridEngine.IO.iidm.devices.iidm_circuit.IidmCircuit

Bases: object

VeraGridEngine.IO.iidm.devices.iidm_dangling_line module

class VeraGridEngine.IO.iidm.devices.iidm_dangling_line.IidmDanglingLine(_id: str, bus: str, p0: float, q0: float, u0: float, r: float, x: float, g: float, b: float)

Bases: IidmObject

VeraGridEngine.IO.iidm.devices.iidm_discrete_measurement module

class VeraGridEngine.IO.iidm.devices.iidm_discrete_measurement.IidmDiscreteMeasurement(id: str, equipmentId: str, value: bool)

Bases: IidmObject

VeraGridEngine.IO.iidm.devices.iidm_generator module

class VeraGridEngine.IO.iidm.devices.iidm_generator.IidmGenerator(id_, bus, targetP, targetQ, targetV)

Bases: IidmObject

class VeraGridEngine.IO.iidm.devices.iidm_generator.IidmGeneratorShortCircuit(generatorId: str, voltageFactor: float, k: float)

Bases: IidmObject

VeraGridEngine.IO.iidm.devices.iidm_identifiable_short_circuit module

class VeraGridEngine.IO.iidm.devices.iidm_identifiable_short_circuit.IidmIdentifiableShortCircuit(id: str, voltageSource: bool)

Bases: IidmObject

VeraGridEngine.IO.iidm.devices.iidm_line module

class VeraGridEngine.IO.iidm.devices.iidm_line.IidmLine(id: str, voltageLevelId1: str, bus1: str, voltageLevelId2: str, bus2: str, r: float, x: float, g1: float, b1: float, g2: float, b2: float)

Bases: IidmObject

VeraGridEngine.IO.iidm.devices.iidm_load module

class VeraGridEngine.IO.iidm.devices.iidm_load.IidmLoad(id, bus, p0, q0)

Bases: IidmObject

VeraGridEngine.IO.iidm.devices.iidm_node_breaker_topology module

class VeraGridEngine.IO.iidm.devices.iidm_node_breaker_topology.IidmNodeBreakerTopology(id: str)

Bases: IidmObject

VeraGridEngine.IO.iidm.devices.iidm_object module

class VeraGridEngine.IO.iidm.devices.iidm_object.IidmObject(class_name)

Bases: object

RteObject

get_prop_value(prop: BaseProperty)

Get property value :param prop: :return:

get_properties() → List[BaseProperty]

Get list of properties :return: List[BaseProperty]

get_rdfid() → str

Convert the idtag to RDFID :return: UUID converted to RDFID

register_property(property_name: str, class_type: TypeVar | object, unit: Unit = <VeraGridEngine.IO.base.units.Unit object>, denominator_unit: Unit = <VeraGridEngine.IO.base.units.Unit object>, description: str = '', max_chars=None, min_value=-1e+20, max_value=1e+20)

Register property of this object :param property_name: :param class_type: :param unit: :param denominator_unit: :param description: :param max_chars: :param min_value: :param max_value: :param format_rule: some formatting rule

VeraGridEngine.IO.iidm.devices.observability_area module

class VeraGridEngine.IO.iidm.devices.observability_area.ObservabilityArea(id: str, name: str)

Bases: IidmObject

VeraGridEngine.IO.iidm.devices.operating_status module

class VeraGridEngine.IO.iidm.devices.operating_status.OperatingStatus(id: str, inService: bool)

Bases: IidmObject

VeraGridEngine.IO.iidm.devices.rtesubstation module

class VeraGridEngine.IO.iidm.devices.rtesubstation.IidmSubstation(id, country, tso, geographicalTags)

Bases: IidmObject

VeraGridEngine.IO.iidm.devices.shunt module

class VeraGridEngine.IO.iidm.devices.shunt.Shunt(id: str, bus: str, g: float, b: float)

Bases: IidmObject

VeraGridEngine.IO.iidm.devices.standby_automation module

class VeraGridEngine.IO.iidm.devices.standby_automation.StandbyAutomaton(id: str, enabled: bool)

Bases: IidmObject

VeraGridEngine.IO.iidm.devices.startup module

class VeraGridEngine.IO.iidm.devices.startup.Startup(generatorId: str, startupTime: float)

Bases: IidmObject

VeraGridEngine.IO.iidm.devices.static_var_compensator module

class VeraGridEngine.IO.iidm.devices.static_var_compensator.StaticVarCompensator(id: str, bus: str, bMin: float, bMax: float, voltageSetPoint: float)

Bases: IidmObject

VeraGridEngine.IO.iidm.devices.switch module

class VeraGridEngine.IO.iidm.devices.switch.Switch(id: str, bus1: str, bus2: str, kind: str, open: bool, retained: bool)

Bases: IidmObject

VeraGridEngine.IO.iidm.devices.two_winding_transformer module

class VeraGridEngine.IO.iidm.devices.two_winding_transformer.PhaseTapChanger(regulationMode: str, tapPosition: int, regulationValue: float, regulating: bool)

Bases: IidmObject

class VeraGridEngine.IO.iidm.devices.two_winding_transformer.RatioTapChanger(lowTapPosition: int, tapPosition: int, regulationMode: str, regulationValue: float, loadTapChangingCapabilities: bool, regulating: bool, targetDeadband: float)

Bases: IidmObject

class VeraGridEngine.IO.iidm.devices.two_winding_transformer.RatioTapChangerStep(rho: float, r: float = 0.0, x: float = 0.0, g: float = 0.0, b: float = 0.0)

Bases: IidmObject

class VeraGridEngine.IO.iidm.devices.two_winding_transformer.TwoWindingsTransformer(id: str, voltageLevelId1: str, bus1: str, voltageLevelId2: str, bus2: str, r: float, x: float, g: float, b: float, ratedU1: float, ratedU2: float)

Bases: IidmObject

VeraGridEngine.IO.iidm.devices.voltage_level module

class VeraGridEngine.IO.iidm.devices.voltage_level.IidmVoltageLevel(_id, nominalV, topologyKind, name='')

Bases: IidmObject

to_veragrid() → VoltageLevel

Returns:

Module contents