ClampContainer

Type: object

Hash table of Clamp objects

 No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^.+$
root Clamp.json
Type: object

A Clamp is a galvanic connection at a line segment where other equipment is connected. A Clamp does not cut the line segment.
A Clamp is ConductingEquipment and has one Terminal with an associated ConnectivityNode. Any other ConductingEquipment can be connected to the Clamp ConnectivityNode.

 No Additional Properties

root Clamp PowerSystemResource.Location
Type: string

Pointer to Location object

root Clamp PowerSystemResource.GenericAction
Type: string

Pointer to SwitchingAction object

root Clamp Clamp.ClampAction
Type: string

Pointer to SwitchingAction object

root Clamp ConductingEquipment.Terminals
Type: array

Array of Terminal objects

 No Additional Items

Each item of this array must be:

root Clamp ConductingEquipment.Terminals Terminal.json
Type: object

An AC electrical connection point to a piece of conducting equipment. Terminals are connected at physical connection points called connectivity nodes.

 No Additional Properties

root Clamp ConductingEquipment.Terminals Terminal ACDCTerminal.connected
Type: boolean

The connected status is related to a bus-branch model and the topological node to terminal relation. True implies the terminal is connected to the related topological node and false implies it is not.
In a bus-branch model, the connected status is used to tell if equipment is disconnected without having to change the connectivity described by the topological node to terminal relation. A valid case is that conducting equipment can be connected in one end and open in the other. In particular for an AC line segment, where the reactive line charging can be significant, this is a relevant case.

root Clamp ConductingEquipment.Terminals Terminal Terminal.phases
Type: enum (of string)

Represents the normal network phasing condition. If the attribute is missing, three phases (ABC) shall be assumed, except for terminals of grounding classes (specializations of EarthFaultCompensator, GroundDisconnector, and Ground) which will be assumed to be N. Therefore, phase code ABCN is explicitly declared when needed, e.g. for star point grounding equipment.
The phase code on terminals connecting same ConnectivityNode or same TopologicalNode as well as for equipment between two terminals shall be consistent.

Must be one of:

  • "ACN"
  • "s2N"
  • "N"
  • "X"
  • "BN"
  • "s12N"
  • "none"
  • "s1"
  • "AC"
  • "ABC"
  • "AB"
  • "s1N"
  • "BC"
  • "XY"
  • "ABCN"
  • "C"
  • "s12"
  • "AN"
  • "XYN"
  • "ABN"
  • "XN"
  • "s2"
  • "CN"
  • "B"
  • "A"
  • "BCN"

root Clamp ConductingEquipment.Terminals Terminal ACDCTerminal.sequenceNumber
Type: integer

The orientation of the terminal connections for a multiple terminal conducting equipment. The sequence numbering starts with 1 and additional terminals should follow in increasing order. The first terminal is the "starting point" for a two terminal branch.

root Clamp ConductingEquipment.Terminals Terminal Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root Clamp ConductingEquipment.Terminals Terminal IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root Clamp ConductingEquipment.Terminals Terminal IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root Clamp ConductingEquipment.Terminals Terminal IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root Clamp ConductingEquipment.Terminals Terminal IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.

root Clamp Clamp.ACLineSegment
Type: string

Pointer to ACLineSegment object

root Clamp ConductingEquipment.BaseVoltage
Type: string

Pointer to BaseVoltage object

root Clamp ConductingEquipment.SvStatus
Type: array

Array of SvStatus objects

 No Additional Items

Each item of this array must be:

root Clamp ConductingEquipment.SvStatus SvStatus.json
Type: object

State variable for status.

 No Additional Properties

root Clamp ConductingEquipment.SvStatus SvStatus SvStatus.inService
Type: boolean

The in service status as a result of topology processing. It indicates if the equipment is considered as energized by the power flow. It reflects if the equipment is connected within a solvable island. It does not necessarily reflect whether or not the island was solved by the power flow.

root Clamp ConductingEquipment.SvStatus SvStatus SvStatus.phase
Type: enum (of string)

The individual phase status. If the attribute is unspecified, then three phase model is assumed.

Must be one of:

  • "B"
  • "N"
  • "C"
  • "s2"
  • "A"
  • "s1"

root Clamp Equipment.aggregate
Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

root Clamp Equipment.networkAnalysisEnabled
Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

root Clamp Clamp.lengthFromTerminal1
Type: object or number

The length to the place where the clamp is located starting from side one of the line segment, i.e. the line segment terminal with sequence number equal to 1.

root Clamp Clamp.lengthFromTerminal1 unit
Type: enum (of string) Default: "m"

nan

Must be one of:

  • "JPerkg"
  • "NPerm"
  • "WPerW"
  • "JPermol"
  • "WPerm2sr"
  • "V"
  • "A2h"
  • "JPerK"
  • "m3Perkg"
  • "HzPerHz"
  • "T"
  • "Vh"
  • "tonne"
  • "JPerm2"
  • "CPerkg"
  • "VPerHz"
  • "ohm"
  • "K"
  • "m3Compensated"
  • "lx"
  • "lPerh"
  • "APerm"
  • "charPers"
  • "katPerm3"
  • "Pas"
  • "ohmPerm"
  • "radPers2"
  • "Btu"
  • "WPers"
  • "h"
  • "lPerl"
  • "l"
  • "As"
  • "cosPhi"
  • "W"
  • "count"
  • "PaPers"
  • "onePerHz"
  • "m3Pers"
  • "KPers"
  • "Vs"
  • "m2Pers"
  • "Ah"
  • "deg"
  • "mPers2"
  • "lm"
  • "d"
  • "JPerkgK"
  • "m"
  • "min"
  • "dB"
  • "Gy"
  • "Nm"
  • "JPerm3"
  • "sPers"
  • "Q"
  • "rev"
  • "N"
  • "Bq"
  • "WPermK"
  • "GyPers"
  • "HPerm"
  • "molPerkg"
  • "molPerm3"
  • "Wb"
  • "VPerm"
  • "WPerm2"
  • "kn"
  • "CPerm2"
  • "anglemin"
  • "Oe"
  • "kgm"
  • "character"
  • "APerA"
  • "A2s"
  • "Qh"
  • "JPers"
  • "Hz"
  • "rad"
  • "kat"
  • "degC"
  • "bar"
  • "M"
  • "molPermol"
  • "kgPerJ"
  • "J"
  • "HzPers"
  • "WPersr"
  • "anglesec"
  • "F"
  • "Mx"
  • "ha"
  • "SPerm"
  • "gal"
  • "mmHg"
  • "m2"
  • "mPers"
  • "V2h"
  • "m3"
  • "G"
  • "H"
  • "mol"
  • "rotPers"
  • "VAh"
  • "mPerm3"
  • "onePerm"
  • "V2"
  • "WPerA"
  • "Pa"
  • "kgPerm3"
  • "CPerm3"
  • "Sv"
  • "S"
  • "JPermolK"
  • "ft3"
  • "Wh"
  • "radPers"
  • "ohmm"
  • "kgm2"
  • "m3Perh"
  • "dBm"
  • "VA"
  • "A2"
  • "s"
  • "therm"
  • "VArh"
  • "cd"
  • "VPerV"
  • "gPerg"
  • "kg"
  • "A"
  • "m3Uncompensated"
  • "ppm"
  • "FPerm"
  • "C"
  • "sr"
  • "none"
  • "VPerVAr"
  • "VAr"
  • "VPerVA"
  • "lPers"

root Clamp Clamp.lengthFromTerminal1 multiplier
Type: enum (of string) Default: "none"

nan

Must be one of:

  • "f"
  • "c"
  • "G"
  • "d"
  • "z"
  • "p"
  • "y"
  • "h"
  • "Y"
  • "a"
  • "none"
  • "k"
  • "m"
  • "n"
  • "E"
  • "da"
  • "T"
  • "M"
  • "P"
  • "Z"
  • "micro"

root Clamp Clamp.lengthFromTerminal1 value
Type: number Default: null

nan

root Clamp Equipment.normallyInService
Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

root Clamp Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root Clamp Equipment.inService
Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

root Clamp IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root Clamp IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root Clamp IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root Clamp IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.