Cimex
CIMEX (CIM-Expanded) DTOs are used by the following service APIs:
- Topology Genesis Service API - Returns CIMEX data for "as-designed" circuit models
- Topology Nodes Service API - Returns CIMEX data for real-time "active/connected" topology
Table of Contents
- Battery Unit
- Breaker
- Connected Equipment
- Controllable Load
- DC Unit
- Disconnector
- Energy Consumer
- Energy Source
- Equipment
- Cimex
- Fuse
- Generating Unit
- Generic Switch
- Hyper Region
- Intersections
- Jumper
- Linear Shunt Compensator
- Line Segment
- Load Break Switch
- Location
- Photo Voltaic Unit
- Power Electronics Connection
- Power Transformer
- Recloser
- Region
- Transformer Tank
- Voltage Regulator
Battery Unit - extends DC Unit
| Field | Type | Label | Description |
|---|---|---|---|
| ratedE | double | ||
| storedE | double | ||
| batteryState | string |
Breaker - extends GenericSwitch
| Field | Type | Label | Description |
|---|---|---|---|
| breakingCapacity | int |
Connected Equipment
| Field | Type | Label | Description |
|---|---|---|---|
| mrid | int | ||
| type | JS_ENUM | JSEquipType | unknown, breaker, disconnector, energyConsumer, energySource, fuse, generatingUnit, intersections, jumper, linearShuntCompensator, lineSegment, loadBreakSwitch, powerElectronicsConnection, powerTransformer, recloser, transformerTank, voltageRegulator, transformer, controllableLoad, last |
| EquipmentRef | enum | Equipment |
Controllable Load
| Field | Type | Label | Description |
|---|---|---|---|
| watts | int | ||
| vars | int | ||
| isUncontrollable | bool | ||
| normalOpen | bool |
DC Unit
| Field | Type | Label | Description |
|---|---|---|---|
| unitId | string | ||
| unitType | JS_ENUM | JSDCUnitType | None, BatteryUnit, PhotoVoltaicUnit, Last |
Disconnector - extends Equipment
| Field | Type | Label | Description |
|---|
Energy Consumer - extends Equipment
| Field | Type | Label | Description |
|---|
Energy Source - extends Equipment
| Field | Type | Label | Description |
|---|
Equipment
| Field | Type | Label | Description |
|---|---|---|---|
| mrid | string | ||
| name | string | ||
| phase | string | ||
| feederHead | bool | false | |
| connectedString | string | ||
| connectedEquipment | vector <Connected Equipment> | ||
| location | vector <Location> | ||
| equipmentType | JS_ENUM | JSEquipType | unknown, breaker, disconnector, energyConsumer, energySource, fuse, generatingUnit, intersections, jumper, linearShuntCompensator, lineSegment, loadBreakSwitch, powerElectronicsConnection, powerTransformer, recloser, transformerTank, voltageRegulator, transformer, controllableLoad, last |
| siblings | vector<string> | ||
| regions | vector<string> | ||
| voltRange | vector<float> |
Cimex
| Field | Type | Label | Description |
|---|---|---|---|
| breaker | vector <Breaker> | ||
| energySource | vector <Energy Source> | ||
| generatingUnit | vector <Generating Unit> | ||
| intersections | vector <Intersections> | ||
| lineSegment | vector <Line Segment> | ||
| linearShuntCompensator | vector <Linear Shunt Compensator> | ||
| loadBreakSwitch | vector <Load Break Switch> | ||
| powerElectronicsConnection | vector <Power Electronics Connection> | ||
| recloser | vector <Recloser> | ||
| voltageRegulator | vector <Voltage Regulator> | ||
| fuse | vector <Fuse> | ||
| jumper | vector <Jumper> | ||
| disconnector | vector <Disconnector> | ||
| powerTransformer | vector <Power Transformer> | ||
| transformerTank | vector <Transformer Tank> | ||
| controllableLoad | vector <Controllable Load> |
Fuse - extends Equipment
| Field | Type | Label | Description |
|---|
Generating Unit - extends Equipment
| Field | Type | Label | Description |
|---|---|---|---|
| ratedS | double | ||
| powerFactor | double |
Generic Switch - extends Equipment
| Field | Type | Label | Description |
|---|---|---|---|
| normalOpen | bool | ||
| closed | bool | true |
Hyper Region
| Field | Type | Label | Description |
|---|---|---|---|
| regions | vector <Region> | ||
| equipment | Cimex |
Intersections - extends Equipment
| Field | Type | Label | Description |
|---|---|---|---|
| connectedCount | int |
Jumper - extends Equipment
| Field | Type | Label | Description |
|---|
Linear Shunt Compensator - extends Equipment
| Field | Type | Label | Description |
|---|---|---|---|
| bPerSection | double | ||
| nomU | double | ||
| vars | double |
Line Segment - extends Equipment
| Field | Type | Label | Description |
|---|
Load Break Switch - extends Generic Switch
| Field | Type | Label | Description |
|---|
Location
| Field | Type | Label | Description |
|---|---|---|---|
| x | float | ||
| y | float |
Photo Voltaic Unit - extends DC Unit
| Field | Type | Label | Description |
|---|---|---|---|
| breakingCapacity | int |
Power Electronics Connection - extends Equipment
| Field | Type | Label | Description |
|---|---|---|---|
| unit | JS_ENUM | DC Unit | |
| maxIFault | double | ||
| p | double | ||
| q | double | ||
| ratedS | double | ||
| ratedU | double |
Power Transformer - extends Equipment
| Field | Type | Label | Description |
|---|---|---|---|
| highV | float | ||
| lowV | float |
Recloser - extends Generic Switch
| Field | Type | Label | Description |
|---|---|---|---|
| breakingCapacity | int |
Region
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| mrid | string |
Transformer Tank - extends Equipment
| Field | Type | Label | Description |
|---|---|---|---|
| ptId | string |
Voltage Regulator - extends Equipment
| Field | Type | Label | Description |
|---|---|---|---|
| lowStep | int | ||
| highStep | int | ||
| volts | int | ||
| normalStep | int | ||
| svi | float |