package model
Overview
Provides Common Information Model (CIM) classes for electrical, topological, asset, spatial and other categories of objects that are germane to electric network operations.
Some examples are shown in the following image:
These classes are the types of, and objects contained in, the RDD that are created by the CIMReader, e.g. RDD[Switch].
Classes are nested according to the hierarchical package structure found in CIM.
Each class has the reference to its parent class, available as the sup
method,
and also as a typed reference of the same name as the parent class.
This is illustrated in the following image, where the object with id TE1932 (a Switch) is found in RDD[Switch] and all RDD for which the relation 'a Switch "Is A" X' holds, e.g. RDD[ConductingEquipment]:
The packages and their descriptions are itemized below.
A short summary of all classes is found below that. The classes can be ordered by package (Grouped) or alphabetically. The classes are also listed in the panel on the left for easy reference.
AlternateModels
AssetInfo
This package is an extension of Assets package and contains the core information classes that support asset management and different network and work planning applications with specialized AssetInfo subclasses.
They hold attributes that can be referenced by not only Asset-s or AssetModel-s but also by ConductingEquipment-s.
AssetMeas
Assets
This package contains the core information classes that support asset management applications that deal with the physical and lifecycle aspects of various network resources (as opposed to power system resource models defined in IEC61970::Wires package, which support network applications).
AsynchronousMachineDynamics
An asynchronous machine model represents a (induction) generator or motor with no external connection to the rotor windings, e.g. a squirrel-cage induction machine.
The interconnection with the electrical network equations can differ among simulation tools. The program only needs to know the terminal to which this asynchronous machine is connected in order to establish the correct interconnection. The interconnection with the motor’s equipment could also differ due to input and output signals required by standard models. The asynchronous machine model is used to model wind generators type 1 and type 2. For these, normal practice is to include the rotor flux transients and neglect the stator flux transients.
AuxiliaryEquipment
Contains equipment which is not normal conducting equipment such as sensors, fault locators, and surge protectors.
These devices do not define power carrying topological connections as conducting equipment, but are associated to terminals of other conducting equipment.
CSC
Common
This package contains the information classes that support distribution management in general.
CongestionRevenueRights
Congestion rent is a major, highly volatile charge currently faced by many participants in the LMP-based electrical energy markets.
For this reason, the ISOs offer congestion revenue rights (CRR), also known as financial transmission rights or transmission congestion contracts. These are financial instruments that allow market participants to hedge against congestion charges when they schedule their generation, load and bilateral energy transactions.
Contingency
Contingencies to be studied.
ControlArea
The ControlArea package models area specifications which can be used for a variety of purposes.
The package as a whole models potentially overlapping control area specifications for the purpose of actual generation control, load forecast area load capture, or powerflow based analysis.
Core
Contains the core PowerSystemResource and ConductingEquipment entities shared by all applications plus common collections of those entities.
Not all applications require all the Core entities. This package does not depend on any other package except the Domain package, but most of the other packages have associations and generalizations that depend on it.
Customers
This package contains the core information classes that support customer billing applications.
DC
This package contains model for direct current equipment and controls.
DER
DiagramLayout
This package describes diagram layout.
This describes how objects are arranged in a coordinate system rather than how they are rendered.
DiscontinuousExcitationControlDynamics
In certain system configurations, continuous excitation control with terminal voltage and power system stabilizing regulator input signals does not ensure that the potential of the excitation system for improving system stability is fully exploited.
For these situations, discontinuous excitation control signals can be employed to enhance stability following large transient disturbances. <font color="#0f0f0f">For additional information please refer to IEEE 421.5-2005, 12.</font>
Domain
The domain package defines primitive datatypes that are used by classes in other packages.
Stereotypes are used to describe the datatypes. The following stereotypes are defined: <<enumeration>> A list of permissible constant values. <<Primitive>> The most basic data types used to compose all other data types. <<CIMDatatype>> A datatype that contains a value attribute, an optional unit of measure and a unit multiplier. The unit and multiplier may be specified as a static variable initialized to the allowed value. <<Compound>> A composite of Primitive, enumeration, CIMDatatype or other Compound classes, as long as the Compound classes do not recurse. For all datatypes both positive and negative values are allowed unless stated otherwise for a particular datatype.
EnergyArea
EnvDomain
Environmental
Equivalents
The equivalents package models equivalent networks.
ExcitationSystemDynamics
The excitation system model provides the field voltage (Efd) for a synchronous machine model.
It is linked to a specific generator (synchronous machine). The representation of all limits used by the models (not including IEEE standard models) shall comply with the representation defined in the Annex E of the IEEE 421.5-2005, unless specified differently in the documentation of the model. The parameters are different for each excitation system model; the same parameter name can have different meaning in different models.
ExternalInputs
Inputs to the market system from external sources.
Faults
The package describes faults that may happen to conducting equipment, e.g. tree falling on a power line.
Feeder
GenerationTrainingSimulation
The GenerationTrainingSimululation package contains prime movers, such as turbines and boilers, which are needed for simulation and educational purposes.
GenericDataSet
Contains classes used for generic dataset modelling.
HVDCDynamics
High voltage direct current (HVDC) models.
ICCPConfiguration
This package models configuration of ICCP required for bilateral exchanges.
IEC61968
The IEC 61968 subpackages of the CIM are developed, standardized and maintained by IEC TC57 Working Group 14: interfaces for distribution management (WG14).
Currently, normative parts of the model support the needs of information exchange defined in IEC 61968-3, IEC 61968-4, IEC 61968-9 and in IEC 61968-13.
IEC61970
Top package for IEC 61970.
IEC62325
The IEC 62325 subpackages of the CIM are developed, standardized and maintained by the IEC TC57.
InfAssetInfo
InfAssets
The package is used to define asset-level models for objects.
Assets may be comprised of other assets and may have relationships to other assets. Assets also have owners and values. Assets may also have a relationship to a PowerSystemResource in the Wires model.
TODO: The following has been copied from a very old version of draft Part 11, so the references are wrong, but we store the knowledge here to reuse later: "Assets are the basic units which define a physical infrastructure. PowerSystemResources are logical objects meaningful to operations which are constructed from one or more Assets, although PowerSystemResources are not required to specifiy their component Assets. The Asset package is comprosed of several packages. The key concepts of an Asset are as follows:
- Assets can have names, through inheritance to the Naming package
- Assets are physical entities which have a lifecycle
- One or more assets can be associated to create a PowerSystemResource
- Assets can be grouped (aggregated) with other Assets
- Assets are typically either 'point' or 'linear' assets, which relate to physical geometry
- Assets have a close relationship to Work as a consequence of their lifecycle
The following sections describe the packages in the Assets package. The AssetBasics package defines the relationship between Asset and other classes, such as Organization, PowerSystemResource and Document. Point assets are those assets whose physical location can be described in terms of a single coordinate, such as a pole or a switch. Linear assets are those assets whose physical location is best described in terms of a line, plyline or polygon. Asset work triggers are used to determine when inspection and/or maintenance are required for assets".
InfAvailabilityPlans
Contains the planned schedules for equipment availability, primarily intended for future studies.
InfCommon
This package contains functions common for distribution management.
InfCongestionRevenueRights
InfCustomers
The package is used to define detailed customer models.
InfERPSupport
The package contains portions of the model defined byEnterprise Resource Planning (ERP) standards like those proposed by the Open Applications Group (OAG).
It is provided to facilitate integration among electric utility applications (CIM) and enterprise resource planning (ERP) applications (as defined by OAG). Rather than inventing new CIM classes that accomplish similar functionality as in existing ERP models, the preferred approach is to use and extend ERP classes as appropriate in other packages. If a model other that the OAG standard is used as a basis for ERP integration, the utility classes labeld "Erp..." should be associated with the appropriate classes of that standard. In fact, definitions of "Erp..." classes are based on OAG Nouns to facilitate this process.
TODO: The following has been copied from a very old version of draft Part 11, so the references are wrong, but we store the knowledge here to reuse later: "The Enterprise Resource Planning (ERP) Support Package contains portions of the model defined by ERP standards like those proposed by the Open Applications Group (OAG). This package is provided to facilitate integration among electric utility applications (CIM) and enterprise resource planning (ERP) applications (OAG). Rather than inventing new CIM classes that accomplish similar functionality as in existing ERP models, the preferred approach is to use and extend ERP classes as appropriate in other packages. If a model other that the OAG standard is used as a basis for ERP integration, the utility classes labeled "Erp..." should be associated with the appropriate classes of that standard".
InfEnergyScheduling
This package provides the capability to schedule and account for transactions for the exchange of electric power between companies.
It includes transations for megawatts which are generated, consumed, lost, passed through, sold and purchased. These classes are used by Accounting and Billing for Energy, Generation Capacity, Transmission, and Ancillary Services.
InfExternalInputs
InfFinancial
This package is responsible for Settlement and Billing.
These classes represent the legal entities who participate in formal or informal agreements.
InfHVDCDynamics
InfLocations
InfMarketOperations
InfMarketResults
InfOperationalLimits
The description of computed or dynamic limits.
These classes would likely go into the OperationalLimits package.
InfParticipantInterfaces
InfReferenceData
InfReservation
InfSIPS
System Integrity Protection Schemes (SIPS) (IEC terminology).
Other names used are: Remedial Action Schemes (RAS) or System Protection Schemes (SPS).
InfTypeAsset
InfWiresExt
InfWork
The package covers all types of work, including inspection, maintenance, repair, restoration, and construction.
It covers the full life cycle including request, initiate, track and record work. Standardized designs (compatible units) are used where possible.
TODO: The following has been copied from a very old version of draft Part 11, so the references are wrong, but we store the knowledge here to reuse later: "The Work package is used to define classes related to work. There are several different aspects of work. The Work Initiation (Work, Project, Request). The Work Design package is used for managing designs (CompatibleUnit, Design, DesignLocation, WorkTask). The Work Schedule package is used for the scheduling and coordination of work (AccessPermit, MaterialItem, OneCallRequest, Regulation). The Work Closing package is used for tracking costs of work (CostType, LaborItem, WorkCostDetail, VehicleItem). The Work Standards package is used for the definition of compatible units (CULaborItem, CUVehicleItem, CUGroup). This package is used for inspection and maintenance (InspectionDataSet, Procedure). The WorkService package defines Appointment class".
LoadControl
This package is an extension of the Metering package and contains the information classes that support specialised applications such as demand-side management using load control equipment.
These classes are generally associated with the point where a service is delivered to the customer.
LoadDynamics
Dynamic load models are used to represent the dynamic real and reactive load behaviour of a load from the static power flow model.
Dynamic load models can be defined as applying either to a single load (energy consumer) or to a group of energy consumers. Large industrial motors or groups of similar motors can be represented by a synchronous machine model (SynchronousMachineDynamics) or an asynchronous machine model (AsynchronousMachineDynamics), which are usually represented as generators with negative active power output in the static (power flow) data.
LoadModel
This package is responsible for modelling the energy consumers and the system load as curves and associated curve data.
Special circumstances that may affect the load, such as seasons and day types, are also included here.
This information is used by Load Forecasting and Load Management.
MarketCommon
This package contains the common objects shared by MarketManagement, MarketOperations and Environmental packages.
MarketManagement
This package contains all core CIM Market Extensions required for market management systems.
MarketOpCommon
This package contains the common objects shared by MarketOperations packages.
MarketPlan
Market plan definitions for planned markets, planned market events, actual market runs, actual market events.
MarketQualitySystem
Post-market accounting, calculation and meter data corrections to reduce invoicing errors and disputes.
Reduces manual validation, verification and correction of transactional data that could affect market settlements. Republishing of market results with affected data corrected.
MarketResults
Results from the execution of a market.
Meas
Contains entities that describe dynamic measurement data exchanged between applications.
MechanicalLoadDynamics
A mechanical load represents the variation in a motor's shaft torque or power as a function of shaft speed.
Metering
This package contains the core information classes that support end device applications with specialized classes for metering and premises area network devices, and remote reading functions.
These classes are generally associated with the point where a service is delivered to the customer.
ModelOperations
NetworkModelFrames
NetworkModelProjects
Defining meta-data for a change set in the functional Power System model.
OperationalLimits
This package models a specification of limits associated with equipment and other operational entities.
Operations
This package contains the core information classes that support operations and outage management applications.
OverexcitationLimiterDynamics
Overexcitation limiters (OELs) are also referred to as maximum excitation limiters and field current limiters. The possibility of voltage collapse in stressed power systems increases the importance of modelling these limiters in studies of system conditions that cause machines to operate at high levels of excitation for a sustained period, such as voltage collapse or system-islanding.
Such events typically occur over a long time frame compared with transient or small-signal stability simulations.
PFVArControllerType1Dynamics
<font color="#0f0f0f">Excitation systems for synchronous machines are sometimes supplied with an optional means of automatically adjusting generator output reactive power (VAr) or power factor (PF) to a user-specified value.
This can be accomplished with either a reactive power or power factor controller or regulator. A reactive power or power factor controller is defined as a PF/VAr controller in IEEE 421.1 as “a control function that acts through the reference adjuster to modify the voltage regulator set point to maintain the synchronous machine steady-state power factor or reactive power at a predetermined value.” </font> <font color="#0f0f0f">For additional information please refer to IEEE 421.5-2005, 11.</font>
PFVArControllerType2Dynamics
<font color="#0f0f0f">A var/pf regulator is defined as “a synchronous machine regulator that functions to maintain the power factor or reactive component of power at a predetermined value.” </font> <font color="#0f0f0f">For additional information please refer to IEEE 421.5-2005, 11.</font> <font color="#0f0f0f">
</font>
PackageDependencies
This package shows all the root level subpackage dependencies of the combined CIM model.
ParticipantInterfaces
Market participant interfaces for bids and trades.
PaymentMetering
This package is an extension of the Metering package and contains the information classes that support specialised applications such as prepayment metering.
These classes are generally associated with the collection and control of revenue from the customer for a delivered service.
PowerSystemStabilizerDynamics
The power system stabilizer (PSS) model provides an input (Vs) to the excitation system model to improve damping of system oscillations.
A variety of input signals can be used depending on the particular design.
Production
The production package is responsible for classes which describe various kinds of generators.
These classes also provide production costing information which is used to economically allocate demand among committed units and calculate reserve quantities.
Protection
An extension to the Core and Wires packages that models information for protection equipment such as relays.
These entities are used within training simulators and distribution network fault location applications.
ReferenceData
Market static reference data.
SCADA
Contains entities to model information used by Supervisory Control and Data Acquisition (SCADA) applications.
Supervisory control supports operator control of equipment, such as opening or closing a breaker. Data acquisition gathers telemetered data from various sources. The subtypes of the Telemetry entity deliberately match the UCA and IEC 61850 definitions. This package also supports alarm presentation but it is not expected to be used by other applications.
StandardInterconnections
This subclause describes the standard interconnections for various types of equipment.
These interconnections are understood by the application programs and can be identified based on the presence of one of the key classes with a relationship to the static power flow model: SynchronousMachineDynamics, AsynchronousMachineDynamics, EnergyConsumerDynamics or WindTurbineType3or4Dynamics. The relationships between classes expressed in the interconnection diagrams are intended to support dynamic behaviour described by either standard models or user-defined models. In the interconnection diagrams, boxes which are black in colour represent function blocks whose functionality can be provided by one of many standard models or by a user-defined model. Blue boxes represent specific standard models. A dashed box means that the function block or specific standard model is optional.
StandardModels
This subclause contains standard dynamic model specifications grouped into packages by standard function block (type of equipment being modelled).
In the CIM, standard dynamic models are expressed by means of a class named with the standard model name and attributes reflecting each of the parameters necessary to describe the behaviour of an instance of the standard model.
StateVariables
State variables for analysis solutions such as powerflow.
StaticVarCompensatorDynamics
Static var compensator (SVC) models.
SynchronousMachineDynamics
For conventional power generating units (e.g., thermal, hydro, combustion turbine), a synchronous machine model represents the electrical characteristics of the generator and the mechanical characteristics of the turbine-generator rotational inertia.
Large industrial motors or groups of similar motors can be represented by individual motor models which are represented as generators with negative active power in the static (power flow) data. The interconnection with the electrical network equations can differ among simulation tools. The tool only needs to know the synchronous machine to establish the correct interconnection. The interconnection with the motor’s equipment could also differ due to input and output signals required by standard models.
Topology
An extension to the Core Package that, in association with the Terminal class, models Connectivity, that is the physical definition of how equipment is connected together.
In addition it models Topology, that is the logical definition of how equipment is connected via closed switches. The Topology definition is independent of the other electrical characteristics.
TurbineGovernorDynamics
The turbine-governor model is linked to one or two synchronous generators and determines the shaft mechanical power (Pm) or torque (Tm) for the generator model.
Unlike IEEE standard models for other function blocks, the three IEEE turbine-governor standard models (GovHydroIEEE0, GovHydroIEEE2, and GovSteamIEEE1) are documented in IEEE Transactions, not in IEEE standards. For that reason, diagrams are supplied for those models. A 2012 IEEE report, Dynamic Models for Turbine-Governors in Power System Studies, provides updated information on a variety of models including IEEE, vendor and reliability authority models. Fully incorporating the results of that report into the CIM dynamics model is a future effort.
TurbineLoadControllerDynamics
A turbine load controller acts to maintain turbine power at a set value by continuous adjustment of the turbine governor speed-load reference.
UnderexcitationLimiterDynamics
Underexcitation limiters (UELs) act to boost excitation.
The UEL typically senses either a combination of voltage and current of the synchronous machine or a combination of real and reactive power. Some UELs utilize a temperature or pressure recalibration feature, in which the UEL characteristic is shifted depending upon the generator cooling gas temperature or pressure.
UserDefinedModels
This subclause contains user-defined dynamic model classes to support the exchange of both proprietary and explicitly defined user-defined models. <u>Proprietary models</u> represent behaviour which, while not defined by a standard model class, is mutually understood by the sending and receiving applications based on the name passed in the .name attribute of the appropriate xxxUserDefined class.
Proprietary model parameters are passed as general attributes using as many instances of the ProprietaryParameterDynamics class as there are parameters. <u>Explicitly defined models</u> describe dynamic behaviour in detail in terms of control blocks and their input and output signals. Note that the classes to support explicitly defined modelling are not currently defined - it is future work intended to also be supported by the family of xxxUserDefined classes. Both types of user-defined models use the family of xxxUserDefined classes, which allow a user-defined model to be used: - as the model for an individual standard function block (such as a turbine-governor or power system stabilizer) in a standard interconnection model whose other function blocks could be either standard or user-defined. For an illustration of this form of usage for a proprietary model, see the ExampleFunctionBlockProprietaryModel diagram in subclause 5.5. - as the complete representation of a dynamic behaviour model (for an entire synchronous machine, for example) where standard function blocks and standard interconnections are not used at all. For an illustration of this form of usage for a proprietary model, see the ExampleCompleteProprietaryModel diagram in subclause 5.5.
VSC
VoltageAdjusterDynamics
<font color="#0f0f0f">A voltage adjuster is a reference adjuster that uses inputs from a reactive power or power factor controller to modify the voltage regulator set point to maintain the synchronous machine steady-state power factor or reactive power at a predetermined value. </font>
<font color="#0f0f0f">For additional information please refer to IEEE 421.5-2005, 11.</font>
VoltageCompensatorDynamics
<font color="#0f0f0f">Synchronous machine terminal voltage transducer and current compensator models</font> adjust the terminal voltage feedback to the excitation system by adding a quantity that is proportional to the terminal current of the generator.
It is linked to a specific generator (synchronous machine). <font color="#0f0f0f">Several types of compensation are available on most excitation systems. Synchronous machine active and reactive current compensation are the most common. Either reactive droop compensation and/or line-drop compensation can be used, simulating an impedance drop and effectively regulating at some point other than the terminals of the machine. The impedance or range of adjustment and type of compensation should be specified for different types. </font> <font color="#0f0f0f">Care shall be taken to ensure that a consistent PU system is utilized for the compensator parameters and the synchronous machine current base.</font> <font color="#0f0f0f">For further information see IEEE 421.5-2005, 4.</font>
<font color="#0f0f0f"> </font>
WindDynamics
Wind turbines are generally divided into four types, which are currently significant in power systems.
The four types have the following characteristics: - type 1: wind turbine with directly grid connected asynchronous generator with fixed rotor resistance (typically squirrel cage); - type 2: wind turbine with directly grid connected asynchronous generator with variable rotor resistance; - type 3: wind turbines with doubly-fed asynchronous generators (directly connected stator and rotor connected through power converter); - type 4: wind turbines connected to the grid through a full size power converter. Models included in this package are according to IEC 61400-27-1:2015.
Wires
An extension to the Core and Topology package that models information on the electrical characteristics of Transmission and Distribution networks.
This package is used by network applications such as State Estimation, Load Flow and Optimal Power Flow.
Work
This package contains the core information classes that support work management and network extension planning applications.
unused
- Grouped
- Alphabetic
- By Inheritance
- model
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
final
case class
ACDCConverter(ConductingEquipment: ConductingEquipment = null, baseS: Double = 0.0, idc: Double = 0.0, idleLoss: Double = 0.0, maxP: Double = 0.0, maxUdc: Double = 0.0, minP: Double = 0.0, minUdc: Double = 0.0, numberOfValves: Int = 0, p: Double = 0.0, poleLossP: Double = 0.0, q: Double = 0.0, ratedUdc: Double = 0.0, resistiveLoss: Double = 0.0, switchingLoss: Double = 0.0, targetPpcc: Double = 0.0, targetUdc: Double = 0.0, uc: Double = 0.0, udc: Double = 0.0, valveU0: Double = 0.0, DCTerminals: List[String] = null, PccTerminal: String = null) extends Element with Product with Serializable
A unit with valves for three phases, together with unit control equipment, essential protective and switching devices, DC storage capacitors, phase reactors and auxiliaries, if any, used for conversion.
A unit with valves for three phases, together with unit control equipment, essential protective and switching devices, DC storage capacitors, phase reactors and auxiliaries, if any, used for conversion.
- ConductingEquipment
ConductingEquipment Reference to the superclass object.
- baseS
Base apparent power of the converter pole. The attribute shall be a positive value.
- idc
Converter DC current, also called Id. It is converter’s state variable, result from power flow.
- idleLoss
Active power loss in pole at no power transfer. It is converter’s configuration data used in power flow. The attribute shall be a positive value.
- maxP
Maximum active power limit. The value is overwritten by values of VsCapabilityCurve, if present.
- maxUdc
The maximum voltage on the DC side at which the converter should operate. It is converter’s configuration data used in power flow. The attribute shall be a positive value.
- minP
Minimum active power limit. The value is overwritten by values of VsCapabilityCurve, if present.
- minUdc
The minimum voltage on the DC side at which the converter should operate. It is converter’s configuration data used in power flow. The attribute shall be a positive value.
- numberOfValves
Number of valves in the converter. Used in loss calculations.
- p
Active power at the point of common coupling. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution in the case a simplified power flow model is used.
- poleLossP
The active power loss at a DC Pole = idleLoss + switchingLoss*|Idc| + resitiveLoss*Idc2. For lossless operation Pdc=Pac. For rectifier operation with losses Pdc=Pac-lossP. For inverter operation with losses Pdc=Pac+lossP. It is converter’s state variable used in power flow. The attribute shall be a positive value.
- q
Reactive power at the point of common coupling. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution in the case a simplified power flow model is used.
- ratedUdc
Rated converter DC voltage, also called UdN. The attribute shall be a positive value. It is converter’s configuration data used in power flow. For instance a bipolar HVDC link with value 200 kV has a 400kV difference between the dc lines.
- resistiveLoss
It is converter’s configuration data used in power flow. Refer to poleLossP. The attribute shall be a positive value.
- switchingLoss
Switching losses, relative to the base apparent power 'baseS'. Refer to poleLossP. The attribute shall be a positive value.
- targetPpcc
Real power injection target in AC grid, at point of common coupling. Load sign convention is used, i.e. positive sign means flow out from a node.
- targetUdc
Target value for DC voltage magnitude. The attribute shall be a positive value.
- uc
Line-to-line converter voltage, the voltage at the AC side of the valve. It is converter’s state variable, result from power flow. The attribute shall be a positive value.
- udc
Converter voltage at the DC side, also called Ud. It is converter’s state variable, result from power flow. The attribute shall be a positive value.
- valveU0
Valve threshold voltage, also called Uvalve. Forward voltage drop when the valve is conducting. Used in loss calculations, i.e. the switchLoss depend on numberOfValves * valveU0.
- DCTerminals
ACDCConverterDCTerminal A DC converter have DC converter terminals. A converter has two DC converter terminals.
- PccTerminal
Terminal Point of common coupling terminal for this converter DC side. It is typically the terminal on the power transformer (or switch) closest to the AC network.
-
final
case class
ACDCConverterDCTerminal(DCBaseTerminal: DCBaseTerminal = null, polarity: String = null, DCConductingEquipment: String = null) extends Element with Product with Serializable
A DC electrical connection point at the AC/DC converter.
A DC electrical connection point at the AC/DC converter.
The AC/DC converter is electrically connected also to the AC side. The AC connection is inherited from the AC conducting equipment in the same way as any other AC equipment. The AC/DC converter DC terminal is separate from generic DC terminal to restrict the connection with the AC side to AC/DC converter and so that no other DC conducting equipment can be connected to the AC side.
- DCBaseTerminal
DCBaseTerminal Reference to the superclass object.
- polarity
Represents the normal network polarity condition. Depending on the converter configuration the value shall be set as follows:
- For a monopole with two converter terminals use DCPolarityKind “positive” and “negative”.
- For a bi-pole or symmetric monopole with three converter terminals use DCPolarityKind “positive”, “middle” and “negative”.
- DCConductingEquipment
ACDCConverter A DC converter terminal belong to an DC converter.
-
final
case class
ACDCTerminal(IdentifiedObject: IdentifiedObject = null, connected: Boolean = false, sequenceNumber: Int = 0, BusNameMarker: String = null, Measurements: List[String] = null, OperationalLimitSet: List[String] = null) extends Element with Product with Serializable
An electrical connection point (AC or DC) to a piece of conducting equipment.
An electrical connection point (AC or DC) to a piece of conducting equipment.
Terminals are connected at physical connection points called connectivity nodes.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- connected
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.
- sequenceNumber
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.
- BusNameMarker
BusNameMarker The bus name marker used to name the bus (topological node).
- Measurements
Measurement Measurements associated with this terminal defining where the measurement is placed in the network topology. It may be used, for instance, to capture the sensor position, such as a voltage transformer (PT) at a busbar or a current transformer (CT) at the bar between a breaker and an isolator.
- OperationalLimitSet
OperationalLimitSet The operational limit sets at the terminal.
-
final
case class
ACLineSegment(Conductor: Conductor = null, b0ch: Double = 0.0, bch: Double = 0.0, g0ch: Double = 0.0, gch: Double = 0.0, r: Double = 0.0, r0: Double = 0.0, shortCircuitEndTemperature: Double = 0.0, x: Double = 0.0, x0: Double = 0.0, ACLineSegmentPhases: List[String] = null, Clamp: List[String] = null, Cut: List[String] = null, LineFaults: List[String] = null, LineGroundingAction: String = null, LineJumpingAction: String = null, PerLengthImpedance: String = null, WireSpacingInfo: String = null) extends Element with Product with Serializable
A wire or combination of wires, with consistent electrical characteristics, building a single electrical system, used to carry alternating current between points in the power system.
A wire or combination of wires, with consistent electrical characteristics, building a single electrical system, used to carry alternating current between points in the power system.
For symmetrical, transposed three phase lines, it is sufficient to use attributes of the line segment, which describe impedances and admittances for the entire length of the segment. Additionally impedances can be computed by using length and associated per length impedances. The BaseVoltage at the two ends of ACLineSegments in a Line shall have the same BaseVoltage.nominalVoltage. However, boundary lines may have slightly different BaseVoltage.nominalVoltages and variation is allowed. Larger voltage difference in general requires use of an equivalent branch.
- Conductor
Conductor Reference to the superclass object.
- b0ch
Zero sequence shunt (charging) susceptance, uniformly distributed, of the entire line section.
- bch
Positive sequence shunt (charging) susceptance, uniformly distributed, of the entire line section. This value represents the full charging over the full length of the line.
- g0ch
Zero sequence shunt (charging) conductance, uniformly distributed, of the entire line section.
- gch
Positive sequence shunt (charging) conductance, uniformly distributed, of the entire line section.
- r
Positive sequence series resistance of the entire line section.
- r0
Zero sequence series resistance of the entire line section.
- shortCircuitEndTemperature
Maximum permitted temperature at the end of SC for the calculation of minimum short-circuit currents. Used for short circuit data exchange according to IEC 60909.
- x
Positive sequence series reactance of the entire line section.
- x0
Zero sequence series reactance of the entire line section.
- ACLineSegmentPhases
ACLineSegmentPhase The line segment phases which belong to the line segment.
- Clamp
Clamp The clamps connected to the line segment.
- Cut
Cut Cuts applied to the line segment.
- LineFaults
LineFault The line faults of the line segment.
- LineGroundingAction
GroundAction Ground action involving clamp usage (for the case when the ground is applied along the line segment instead of at its terminals).
- LineJumpingAction
JumperAction Jumper action involving clamp usage (for the case when the jumper is applied along the line segment instead of at its terminals).
- PerLengthImpedance
PerLengthImpedance Per-length impedance of this line segment.
- WireSpacingInfo
WireSpacingInfo undocumented
-
final
case class
ACLineSegmentPhase(PowerSystemResource: PowerSystemResource = null, phase: String = null, sequenceNumber: Int = 0, ACLineSegment: String = null, WireInfo: String = null) extends Element with Product with Serializable
Represents a single wire of an alternating current line segment.
Represents a single wire of an alternating current line segment.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- phase
The phase connection of the wire at both ends.
- sequenceNumber
Number designation for this line segment phase. Each line segment phase within a line segment should have a unique sequence number. This is useful for unbalanced modelling to bind the mathematical model (PhaseImpedanceData of PerLengthPhaseImpedance) with the connectivity model (this class) and the physical model (WirePosition) without tight coupling.
- ACLineSegment
ACLineSegment The line segment to which the phase belongs.
- WireInfo
WireInfo undocumented
-
final
case class
ASRequirements(Element: BasicElement = null, intervalStartTime: String = null, ReserveDemandCurve: List[String] = null) extends Element with Product with Serializable
Models Ancillary Service Requirements.
Models Ancillary Service Requirements.
Describes interval for which the requirement is applicable.
- Element
Reference to the superclass object.
- intervalStartTime
The start of the time interval for which requirement is defined.
- ReserveDemandCurve
ReserveDemandCurve undocumented
-
final
case class
ASTMStandard(Element: BasicElement = null, standardEdition: String = null, standardNumber: String = null) extends Element with Product with Serializable
Standard published by ASTM (ASTM International).
Standard published by ASTM (ASTM International).
- Element
Reference to the superclass object.
- standardEdition
Edition of ASTM standard.
- standardNumber
ASTM standard number.
-
final
case class
AcceptanceTest(Element: BasicElement = null, dateTime: String = null, success: Boolean = false, type: String = null) extends Element with Product with Serializable
Acceptance test for assets.
Acceptance test for assets.
- Element
Reference to the superclass object.
- dateTime
Date and time the asset was last tested using the 'type' of test and yielding the current status in 'success' attribute.
- success
True if asset has passed acceptance test and may be placed in or is in service. It is set to false if asset is removed from service and is required to be tested again before being placed back in service, possibly in a new location. Since asset may go through multiple tests during its lifecycle, the date of each acceptance test may be recorded in 'Asset.ActivityRecord.status.dateTime'.
- type
Type of test or group of tests that was conducted on 'dateTime'.
-
final
case class
AccessPermit(WorkDocument: WorkDocument = null, applicationNumber: String = null, effectiveDate: String = null, expirationDate: String = null, payment: Double = 0.0, permitID: String = null) extends Element with Product with Serializable
A permit is sometimes needed to provide legal access to land or equipment.
A permit is sometimes needed to provide legal access to land or equipment.
For example, local authority permission for road works.
- WorkDocument
WorkDocument Reference to the superclass object.
- applicationNumber
Permit application number that is used by municipality, state, province, etc.
- effectiveDate
Date that permit became official.
- expirationDate
Permit expiration date.
- payment
Total cost of permit.
- permitID
Permit identifier.
-
final
case class
AccountMovement(Element: BasicElement = null, amount: Double = 0.0, dateTime: String = null, reason: String = null) extends Element with Product with Serializable
Credit/debit movements for an account.
Credit/debit movements for an account.
- Element
Reference to the superclass object.
- amount
Amount that was credited to/debited from an account. For example: payment received/interest charge on arrears.
- dateTime
Date and time when the credit/debit transaction was performed.
- reason
Reason for credit/debit transaction on an account. Example: payment received/arrears interest levied.
-
final
case class
AccountNotification(Element: BasicElement = null, customerNotificationType: String = null, methodType: String = null, note: String = null, time: String = null, CustomerAccount: String = null) extends Element with Product with Serializable
Notifications for move-in, move-out, delinquencies, etc.
Notifications for move-in, move-out, delinquencies, etc.
- Element
Reference to the superclass object.
- customerNotificationType
undocumented
- methodType
undocumented
- note
undocumented
- time
undocumented
- CustomerAccount
CustomerAccount undocumented
-
final
case class
AccountingUnit(Element: BasicElement = null, energyUnit: Double = 0.0, monetaryUnit: String = null, multiplier: String = null, value: Double = 0.0) extends Element with Product with Serializable
Unit for accounting; use either 'energyUnit' or 'currencyUnit' to specify the unit for 'value'.
Unit for accounting; use either 'energyUnit' or 'currencyUnit' to specify the unit for 'value'.
- Element
Reference to the superclass object.
- energyUnit
Unit of service.
- monetaryUnit
Unit of currency.
- multiplier
Multiplier for the 'energyUnit' or 'monetaryUnit'.
- value
Value expressed in applicable units.
-
final
case class
Accumulator(Measurement: Measurement = null, maxValue: Int = 0, AccumulatorValues: List[String] = null, LimitSets: List[String] = null) extends Element with Product with Serializable
Accumulator represents an accumulated (counted) Measurement, e.g.
Accumulator represents an accumulated (counted) Measurement, e.g. an energy value.
- Measurement
Measurement Reference to the superclass object.
- maxValue
Normal value range maximum for any of the MeasurementValue.values. Used for scaling, e.g. in bar graphs or of telemetered raw values.
- AccumulatorValues
AccumulatorValue The values connected to this measurement.
- LimitSets
AccumulatorLimitSet A measurement may have zero or more limit ranges defined for it.
-
final
case class
AccumulatorLimit(Limit: Limit = null, value: Int = 0, LimitSet: String = null) extends Element with Product with Serializable
Limit values for Accumulator measurements.
Limit values for Accumulator measurements.
- Limit
Limit Reference to the superclass object.
- value
The value to supervise against. The value is positive.
- LimitSet
AccumulatorLimitSet The set of limits.
-
final
case class
AccumulatorLimitSet(LimitSet: LimitSet = null, Limits: List[String] = null, Measurements: List[String] = null) extends Element with Product with Serializable
An AccumulatorLimitSet specifies a set of Limits that are associated with an Accumulator measurement.
An AccumulatorLimitSet specifies a set of Limits that are associated with an Accumulator measurement.
- LimitSet
LimitSet Reference to the superclass object.
- Limits
AccumulatorLimit The limit values used for supervision of Measurements.
- Measurements
Accumulator The Measurements using the LimitSet.
-
final
case class
AccumulatorReset(Control: Control = null, AccumulatorValue: String = null) extends Element with Product with Serializable
This command resets the counter value to zero.
This command resets the counter value to zero.
- Control
Control Reference to the superclass object.
- AccumulatorValue
AccumulatorValue The accumulator value that is reset by the command.
-
final
case class
AccumulatorValue(MeasurementValue: MeasurementValue = null, value: Int = 0, Accumulator: String = null, AccumulatorReset: String = null) extends Element with Product with Serializable
AccumulatorValue represents an accumulated (counted) MeasurementValue.
AccumulatorValue represents an accumulated (counted) MeasurementValue.
- MeasurementValue
MeasurementValue Reference to the superclass object.
- value
The value to supervise. The value is positive.
- Accumulator
Accumulator Measurement to which this value is connected.
- AccumulatorReset
AccumulatorReset The command that resets the accumulator value.
-
final
case class
AceTariffType(Element: BasicElement = null, type: String = null, MarketDocument: List[String] = null, Point: List[String] = null, Unit: List[String] = null) extends Element with Product with Serializable
The Area Control Error tariff type that is applied or used.
The Area Control Error tariff type that is applied or used.
- Element
Reference to the superclass object.
- type
The coded type of an ACE tariff.
- MarketDocument
MarketDocument undocumented
- Point
Point undocumented
- Unit
Unit_ undocumented
-
final
case class
ActionRequest(Element: BasicElement = null, actionName: String = null, Bid: List[String] = null, Trade: List[String] = null) extends Element with Product with Serializable
Action request against an existing Trade.
-
final
case class
ActivePowerLimit(OperationalLimit: OperationalLimit = null, normalValue: Double = 0.0, value: Double = 0.0) extends Element with Product with Serializable
Limit on active power flow.
Limit on active power flow.
- OperationalLimit
OperationalLimit Reference to the superclass object.
- normalValue
The normal value of active power limit. The attribute shall be a positive value or zero.
- value
Value of active power limit. The attribute shall be a positive value or zero.
-
final
case class
ActivityRecord(IdentifiedObject: IdentifiedObject = null, createdDateTime: String = null, reason: String = null, severity: String = null, status: String = null, type: String = null, Assets: List[String] = null, Author: String = null) extends Element with Product with Serializable
Records activity for an entity at a point in time; activity may be for an event that has already occurred or for a planned activity.
Records activity for an entity at a point in time; activity may be for an event that has already occurred or for a planned activity.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- createdDateTime
Date and time this activity record has been created (different from the 'status.dateTime', which is the time of a status change of the associated object, if applicable).
- reason
Reason for event resulting in this activity record, typically supplied when user initiated.
- severity
Severity level of event resulting in this activity record.
- status
Status Information on consequence of event resulting in this activity record.
- type
Type of event resulting in this activity record.
- Assets
Asset All assets for which this activity record has been created.
- Author
Author Author of this activity record.
-
final
case class
AdjacentCASet(IdentifiedObject: IdentifiedObject = null, lossPercentage_1: Double = 0.0, BidSelfSched: List[String] = null, HostControlArea: String = null, RTO: String = null, RegisteredResource: List[String] = null, SubControlArea: List[String] = null) extends Element with Product with Serializable
Groups Adjacent Control Areas.
Groups Adjacent Control Areas.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- lossPercentage_1
Loss percentage
- BidSelfSched
BidSelfSched undocumented
- HostControlArea
HostControlArea undocumented
- RTO
RTO undocumented
- RegisteredResource
RegisteredResource undocumented
- SubControlArea
SubControlArea undocumented
-
final
case class
AggregateNode(IdentifiedObject: IdentifiedObject = null, anodeType: String = null, qualifASOrder: Int = 0, AreaLoadCurve: List[String] = null, CnodeDistributionFactor: List[String] = null, Instruction: List[String] = null, Pnode: List[String] = null, RTO: String = null, RegisteredResource: List[String] = null, SubControlArea: List[String] = null) extends Element with Product with Serializable
An aggregated node can define a typed grouping further defined by the AnodeType enumeratuion.
An aggregated node can define a typed grouping further defined by the AnodeType enumeratuion.
Types range from System Zone/Regions to Market Energy Regions to Aggregated Loads and Aggregated Generators.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- anodeType
Type of aggregated node
- qualifASOrder
Processing Order for AS self-provisions for this region. The priority of this attribute directs the awards of any resource that resides in overlapping regions. The regions are processed in priority manner.
- AreaLoadCurve
AreaLoadCurve undocumented
- CnodeDistributionFactor
CnodeDistributionFactor undocumented
- Instruction
Instructions undocumented
- Pnode
Pnode undocumented
- RTO
RTO undocumented
- RegisteredResource
RegisteredResource A RegisteredResource can be associated to only one AggregateNode if not connected to a Pnode or MktConnectivityNode.
- SubControlArea
SubControlArea undocumented
-
final
case class
AggregateScore(AnalyticScore: AnalyticScore = null, AnalyticScore_attr: List[String] = null) extends Element with Product with Serializable
An aggregated indicative scoring by an analytic, which is based on other analytic scores, that can be used to characterize the health of or the risk associated with one or more assets.
An aggregated indicative scoring by an analytic, which is based on other analytic scores, that can be used to characterize the health of or the risk associated with one or more assets.
- AnalyticScore
AnalyticScore Reference to the superclass object.
- AnalyticScore_attr
AnalyticScore Analytic score contributing to this aggregate score.
-
final
case class
AggregatedPnode(Pnode: Pnode = null, apnodeType: String = null, participationCategory: String = null, GenDistributionFactor: List[String] = null, LoadDistributionFactor: List[String] = null, MPMTestResults: List[String] = null, MPMTestThreshold: List[String] = null, MktCombinedCyclePlant: List[String] = null, PnodeDistributionFactor: List[String] = null, TACArea: List[String] = null, TradingHubValues: List[String] = null) extends Element with Product with Serializable
An aggregated pricing node is a specialized type of pricing node used to model items such as System Zone, Default Price Zone, Custom Price Zone, Control Area, Aggregated Generation, Aggregated Particpating Load, Aggregated Non-Participating Load, Trading Hub, Designated Control Area(DCA) Zone.
An aggregated pricing node is a specialized type of pricing node used to model items such as System Zone, Default Price Zone, Custom Price Zone, Control Area, Aggregated Generation, Aggregated Particpating Load, Aggregated Non-Participating Load, Trading Hub, Designated Control Area(DCA) Zone.
- Pnode
Pnode Reference to the superclass object.
- apnodeType
Aggregate Price Node Types
- participationCategory
Designated Control Area participation in LMP price measurement 'Y' - Participates in both Local Market Power Mitigation (LMPM) and System Market Power Mitigation (SMPM) 'N' - Not included in LMP price measures 'S' - Participatesin SMPM price measures 'L' - Participatesin LMPM price measures
- GenDistributionFactor
GenDistributionFactor undocumented
- LoadDistributionFactor
LoadDistributionFactor undocumented
- MPMTestResults
MPMTestResults undocumented
- MPMTestThreshold
MPMTestThreshold undocumented
- MktCombinedCyclePlant
MktCombinedCyclePlant undocumented
- PnodeDistributionFactor
PnodeDistributionFactor undocumented
- TACArea
TACArea undocumented
- TradingHubValues
TradingHubValues undocumented
-
final
case class
Agreement(Document: Document = null, signDate: String = null, validityInterval: String = null) extends Element with Product with Serializable
Formal agreement between two parties defining the terms and conditions for a set of services.
Formal agreement between two parties defining the terms and conditions for a set of services.
The specifics of the services are, in turn, defined via one or more service agreements.
- Document
Document Reference to the superclass object.
- signDate
Date this agreement was consummated among associated persons and/or organisations.
- validityInterval
Date and time interval this agreement is valid (from going into effect to termination).
-
final
case class
AirCompressor(PowerSystemResource: PowerSystemResource = null, airCompressorRating: Double = 0.0, CAESPlant: String = null, CombustionTurbine: String = null) extends Element with Product with Serializable
Combustion turbine air compressor which is an integral part of a compressed air energy storage (CAES) plant.
Combustion turbine air compressor which is an integral part of a compressed air energy storage (CAES) plant.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- airCompressorRating
Rating of the CAES air compressor.
- CAESPlant
CAESPlant An air compressor may be a member of a compressed air energy storage plant.
- CombustionTurbine
CombustionTurbine A CAES air compressor is driven by combustion turbine.
-
final
case class
AlertTypeList(IdentifiedObject: IdentifiedObject = null, version: String = null, EnvironmentalAlert: List[String] = null, EnvironmentalDataAuthority: String = null) extends Element with Product with Serializable
A named list of alert types.
A named list of alert types.
Note: the name of the list is reflected in the .name attribute (inherited from IdentifiedObject).
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- version
The version of the named list of alert types.
- EnvironmentalAlert
EnvironmentalAlert An alert whose type is drawn from this alert type list.
- EnvironmentalDataAuthority
EnvironmentalDataAuthority The environmental data authority responsible for publishing this list of alert types.
-
final
case class
AllocationResult(Element: BasicElement = null, intervalStartTime: String = null, updateTimeStamp: String = null, updateUser: String = null, AllocationResultValues: List[String] = null) extends Element with Product with Serializable
Models Market clearing results.
Models Market clearing results.
Indicates market horizon, interval based. Used by a market quality system for billing and settlement purposes.
- Element
Reference to the superclass object.
- intervalStartTime
undocumented
- updateTimeStamp
undocumented
- updateUser
undocumented
- AllocationResultValues
AllocationResultValues undocumented
-
final
case class
AllocationResultValues(Element: BasicElement = null, aggregateType: String = null, allocationMwHour: Double = 0.0, allocationPrice: Double = 0.0, energyTypeCode: String = null, marketServiceType: String = null, AllocationResult: String = null, RegisteredResource: String = null) extends Element with Product with Serializable
Models Market clearing results in terms of price and MW values.
Models Market clearing results in terms of price and MW values.
- Element
Reference to the superclass object.
- aggregateType
"1" -- "Detail", "2" -- "Aggregate by Market service type", in which case, the "AllocationEnergyType" field will not be filled; "3" -- "Aggregate by "AllocationEnergyType", in which case "MarketServiceType" will not be filled.
- allocationMwHour
undocumented
- allocationPrice
undocumented
- energyTypeCode
undocumented
- marketServiceType
Choices are: ME - Market Energy Capacity; SR - Spinning Reserve Capacity; NR - Non-Spinning Reserve Capacity; DAC - Day Ahead Capacity; DEC - Derate Capacity
- AllocationResult
AllocationResult undocumented
- RegisteredResource
RegisteredResource undocumented
-
final
case class
AltGeneratingUnitMeas(IdentifiedObject: IdentifiedObject = null, priority: Int = 0, AnalogValue: String = null, ControlAreaGeneratingUnit: String = null) extends Element with Product with Serializable
A prioritized measurement to be used for the generating unit in the control area specification.
A prioritized measurement to be used for the generating unit in the control area specification.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- priority
Priority of a measurement usage. Lower numbers have first priority.
- AnalogValue
AnalogValue The specific analog value used as a source.
- ControlAreaGeneratingUnit
ControlAreaGeneratingUnit The control area generating unit to which the prioritized measurement assignment is applied.
-
final
case class
AltTieMeas(IdentifiedObject: IdentifiedObject = null, priority: Int = 0, AnalogValue: String = null, TieFlow: String = null) extends Element with Product with Serializable
A prioritized measurement to be used for the tie flow as part of the control area specification.
A prioritized measurement to be used for the tie flow as part of the control area specification.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- priority
Priority of a measurement usage. Lower numbers have first priority.
- AnalogValue
AnalogValue The specific analog value used as a source.
- TieFlow
TieFlow The tie flow of the alternate measurements.
- final case class AlternateModel(IdentifiedObject: IdentifiedObject = null, AlternateModelGroup: String = null, Dataset: String = null) extends Element with Product with Serializable
- final case class AlternateModelGroup(IdentifiedObject: IdentifiedObject = null, AlternateModel: List[String] = null) extends Element with Product with Serializable
-
final
case class
Analog(Measurement: Measurement = null, maxValue: Double = 0.0, minValue: Double = 0.0, normalValue: Double = 0.0, positiveFlowIn: Boolean = false, AnalogValues: List[String] = null, LimitSets: List[String] = null) extends Element with Product with Serializable
Analog represents an analog Measurement.
Analog represents an analog Measurement.
- Measurement
Measurement Reference to the superclass object.
- maxValue
Normal value range maximum for any of the MeasurementValue.values. Used for scaling, e.g. in bar graphs or of telemetered raw values.
- minValue
Normal value range minimum for any of the MeasurementValue.values. Used for scaling, e.g. in bar graphs or of telemetered raw values.
- normalValue
Normal measurement value, e.g., used for percentage calculations.
- positiveFlowIn
If true then this measurement is an active power, reactive power or current with the convention that a positive value measured at the Terminal means power is flowing into the related PowerSystemResource.
- AnalogValues
AnalogValue The values connected to this measurement.
- LimitSets
AnalogLimitSet A measurement may have zero or more limit ranges defined for it.
-
final
case class
AnalogControl(Control: Control = null, maxValue: Double = 0.0, minValue: Double = 0.0, AnalogValue: String = null) extends Element with Product with Serializable
An analog control used for supervisory control.
An analog control used for supervisory control.
- Control
Control Reference to the superclass object.
- maxValue
Normal value range maximum for any of the Control.value. Used for scaling, e.g. in bar graphs.
- minValue
Normal value range minimum for any of the Control.value. Used for scaling, e.g. in bar graphs.
- AnalogValue
AnalogValue The MeasurementValue that is controlled.
-
final
case class
AnalogLimit(Limit: Limit = null, value: Double = 0.0, LimitSet: String = null) extends Element with Product with Serializable
Limit values for Analog measurements.
Limit values for Analog measurements.
- Limit
Limit Reference to the superclass object.
- value
The value to supervise against.
- LimitSet
AnalogLimitSet The set of limits.
-
final
case class
AnalogLimitSet(LimitSet: LimitSet = null, Limits: List[String] = null, Measurements: List[String] = null) extends Element with Product with Serializable
An AnalogLimitSet specifies a set of Limits that are associated with an Analog measurement.
An AnalogLimitSet specifies a set of Limits that are associated with an Analog measurement.
- LimitSet
LimitSet Reference to the superclass object.
- Limits
AnalogLimit The limit values used for supervision of Measurements.
- Measurements
Analog The Measurements using the LimitSet.
-
final
case class
AnalogMeasurementValueQuality(MeasurementValueQuality: MeasurementValueQuality = null, scadaQualityCode: String = null) extends Element with Product with Serializable
Measurement quality flags for Analog Values.
Measurement quality flags for Analog Values.
- MeasurementValueQuality
MeasurementValueQuality Reference to the superclass object.
- scadaQualityCode
The quality code for the given Analog Value.
-
final
case class
AnalogValue(MeasurementValue: MeasurementValue = null, value: Double = 0.0, AltGeneratingUnit: List[String] = null, AltTieMeas: List[String] = null, Analog: String = null, AnalogControl: String = null) extends Element with Product with Serializable
AnalogValue represents an analog MeasurementValue.
AnalogValue represents an analog MeasurementValue.
- MeasurementValue
MeasurementValue Reference to the superclass object.
- value
The value to supervise.
- AltGeneratingUnit
AltGeneratingUnitMeas The alternate generating unit for which this measurement value applies.
- AltTieMeas
AltTieMeas The usage of the measurement within the control area specification.
- Analog
Analog Measurement to which this value is connected.
- AnalogControl
AnalogControl The Control variable associated with the MeasurementValue.
-
final
case class
Analytic(Document: Document = null, bestValue: Double = 0.0, kind: String = null, scaleKind: String = null, worstValue: Double = 0.0, AnalyticScore: List[String] = null, Asset: List[String] = null, AssetGroup: List[String] = null, AssetHealthEvent: List[String] = null) extends Element with Product with Serializable
An algorithm or calculation for making an assessment about an asset or asset grouping for lifecycle decision making.
An algorithm or calculation for making an assessment about an asset or asset grouping for lifecycle decision making.
- Document
Document Reference to the superclass object.
- bestValue
Value that indicates best possible numeric value.
- kind
Kind of analytic this analytic is.
- scaleKind
The scoring scale kind.
- worstValue
Value that indicates worst possible numeric value.
- AnalyticScore
AnalyticScore Analytic score produced by this analytic.
- Asset
Asset Asset on which this analytic can be performed.
- AssetGroup
AssetGroup Asset group on which this analytic can be performed.
- AssetHealthEvent
AssetHealthEvent Asset health event which can be generated by this analytic.
-
final
case class
AnalyticScore(IdentifiedObject: IdentifiedObject = null, calculationDateTime: String = null, effectiveDateTime: String = null, value: Double = 0.0, Analytic: String = null, Asset: String = null, AssetAggregateScore: String = null, AssetGroup: String = null) extends Element with Product with Serializable
An indicative scoring by an analytic that can be used to characterize the health of or the risk associated with one or more assets.
An indicative scoring by an analytic that can be used to characterize the health of or the risk associated with one or more assets.
The analytic score reflects the results of an execution of an analytic against an asset or group of assets.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- calculationDateTime
Timestamp of when the score was calculated.
- effectiveDateTime
Date-time for when the score applies.
- value
Asset health score value.
- Analytic
Analytic Analytic which was executed to arrive at this analytic score..
- Asset
Asset Asset to which this analytic score applies.
- AssetAggregateScore
AggregateScore Aggregate score to which this analytic score contributed.
- AssetGroup
AssetGroup Asset group to which this analytic score applies..
-
final
case class
AncillaryServiceClearing(MarketFactors: MarketFactors = null, MarketCaseClearing: String = null, MarketRegionResults: List[String] = null) extends Element with Product with Serializable
Model of results of market clearing with respect to Ancillary Service products.
Model of results of market clearing with respect to Ancillary Service products.
- MarketFactors
MarketFactors Reference to the superclass object.
- MarketCaseClearing
MarketCaseClearing undocumented
- MarketRegionResults
MarketRegionResults undocumented
- final case class AnnotatedProjectDependency(IdentifiedObject: IdentifiedObject = null, dependencyType: String = null, DependentOnStage: String = null, DependingStage: String = null) extends Element with Product with Serializable
-
final
case class
ApparentPowerLimit(OperationalLimit: OperationalLimit = null, normalValue: Double = 0.0, value: Double = 0.0) extends Element with Product with Serializable
Apparent power limit.
Apparent power limit.
- OperationalLimit
OperationalLimit Reference to the superclass object.
- normalValue
The normal apparent power limit. The attribute shall be a positive value or zero.
- value
The apparent power limit. The attribute shall be a positive value or zero.
-
final
case class
Appointment(IdentifiedObject: IdentifiedObject = null, callAhead: Boolean = false, meetingInterval: String = null, Persons: List[String] = null, Works: List[String] = null) extends Element with Product with Serializable
Meeting time and location.
Meeting time and location.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- callAhead
True if requested to call customer when someone is about to arrive at their premises.
- meetingInterval
Date and time reserved for appointment.
- Persons
PersonRole All persons for this appointment.
- Works
Work All works for this appointment.
-
final
case class
Approver(DocumentPersonRole: DocumentPersonRole = null, Documents: List[String] = null) extends Element with Product with Serializable
Person who accepted/signed or rejected the document.
Person who accepted/signed or rejected the document.
- DocumentPersonRole
DocumentPersonRole Reference to the superclass object.
- Documents
Document All documents for this approver.
-
final
case class
AreaLoadBid(Bid: Bid = null, demandBidMW: Double = 0.0, LoadBid: List[String] = null) extends Element with Product with Serializable
AreaLoadBid is not submitted by a market participant into the Markets.
AreaLoadBid is not submitted by a market participant into the Markets.
Instead, it is simply an aggregation of all LoadBids contained wtihin a specific SubControlArea. This entity should inherit from Bid for representation of the timeframe (startTime, stopTime) and the market type.
-
final
case class
AreaLoadCurve(RegularIntervalSchedule: RegularIntervalSchedule = null, forecastType: String = null, AggregateNode: String = null, TACArea: String = null) extends Element with Product with Serializable
Area load curve definition.
Area load curve definition.
- RegularIntervalSchedule
RegularIntervalSchedule Reference to the superclass object.
- forecastType
Load forecast area type.
- AggregateNode
AggregateNode undocumented
- TACArea
TACArea undocumented
-
final
case class
AreaReserveSpec(Element: BasicElement = null, lowerRegMarginReqt: Double = 0.0, opReserveReqt: Double = 0.0, primaryReserveReqt: Double = 0.0, raiseRegMarginReqt: Double = 0.0, spinningReserveReqt: Double = 0.0, Description: String = null, SubControlArea: List[String] = null) extends Element with Product with Serializable
The control area's reserve specification.
The control area's reserve specification.
- Element
Reference to the superclass object.
- lowerRegMarginReqt
Lower regulating margin requirement in MW, the amount of generation that can be dropped by control in 10 minutes
- opReserveReqt
Operating reserve requirement in MW, where operating reserve is the generating capability that is fully available within 30 minutes. Operating reserve is composed of primary reserve (t less than 10 min) and secondary reserve (10 less than t less than 30 min).
- primaryReserveReqt
Primary reserve requirement in MW, where primary reserve is generating capability that is fully available within 10 minutes. Primary reserve is composed of spinning reserve and quick-start reserve.
- raiseRegMarginReqt
Raise regulating margin requirement in MW, the amount of generation that can be picked up by control in 10 minutes
- spinningReserveReqt
Spinning reserve requirement in MW, spinning reserve is generating capability that is presently synchronized to the network and is fully available within 10 minutes
- Description
Description of the object or instance.
- SubControlArea
SubControlArea undocumented
-
final
case class
AssemblyDescription(IdentifiedObject: IdentifiedObject = null, ModelSpecification: List[String] = null) extends Element with Product with Serializable
A description for how to assemble model parts for a specific purpose.
A description for how to assemble model parts for a specific purpose.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ModelSpecification
ModelPartSpecification The models that are part of the assembly descrption.
-
final
case class
AssemblyManifest(IdentifiedObject: IdentifiedObject = null) extends Element with Product with Serializable
A collection of model parts when combined form a case or part of a case.
A collection of model parts when combined form a case or part of a case.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
-
final
case class
Asset(IdentifiedObject: IdentifiedObject = null, acceptanceTest: String = null, baselineCondition: String = null, baselineLossOfLife: Double = 0.0, critical: Boolean = false, electronicAddress: String = null, inUseDate: String = null, inUseState: String = null, kind: String = null, lifecycleDate: String = null, lifecycleState: String = null, lotNumber: String = null, position: String = null, purchasePrice: Double = 0.0, retiredReason: String = null, serialNumber: String = null, status: String = null, type: String = null, utcNumber: String = null, ActivityRecords: List[String] = null, Analytic: List[String] = null, AnalyticScore: List[String] = null, AssetContainer: String = null, AssetDeployment: String = null, AssetFunction: List[String] = null, AssetGroup: List[String] = null, AssetInfo: String = null, AssetPropertyCurves: List[String] = null, BreakerOperation: String = null, ConfigurationEvents: List[String] = null, ErpInventory: String = null, ErpItemMaster: String = null, ErpRecDeliveryItems: List[String] = null, FinancialInfo: String = null, Location: String = null, Measurements: List[String] = null, Medium: List[String] = null, OperationalTags: List[String] = null, OrganisationRoles: List[String] = null, Ownerships: List[String] = null, PowerSystemResources: List[String] = null, ProcedureDataSet: List[String] = null, Procedures: List[String] = null, ProductAssetModel: String = null, Reconditionings: List[String] = null, ReliabilityInfos: List[String] = null, ReplacementWorkTasks: List[String] = null, ScheduledEvents: List[String] = null, WorkTasks: List[String] = null) extends Element with Product with Serializable
Tangible resource of the utility, including power system equipment, various end devices, cabinets, buildings, etc.
Tangible resource of the utility, including power system equipment, various end devices, cabinets, buildings, etc.
For electrical network equipment, the role of the asset is defined through PowerSystemResource and its subclasses, defined mainly in the Wires model (refer to IEC61970-301 and model package IEC61970::Wires). Asset description places emphasis on the physical characteristics of the equipment fulfilling that role.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- acceptanceTest
AcceptanceTest Information on acceptance test.
- baselineCondition
Condition of asset at last baseline. Examples include new, rebuilt, overhaul required, other. Refer to inspection data for information on the most current condition of the asset.
- baselineLossOfLife
Percentage of initial life expectancy that has been lost as of the last life expectancy baseline. Represents (initial life expectancy - current life expectancy) / initial life expectancy.
- critical
True if asset is considered critical for some reason (for example, a pole with critical attachments).
- electronicAddress
Electronic address.
- inUseDate
InUseDate In use dates for this asset.
- inUseState
Indication of whether asset is currently deployed (in use), ready to be put into use or not available for use.
- kind
Kind of asset. Used in description of asset components in asset instance templates.
- lifecycleDate
LifecycleDate <was lifecycle> Lifecycle dates for this asset.
- lifecycleState
Current lifecycle state of asset.
- lotNumber
Lot number for this asset. Even for the same model and version number, many assets are manufactured in lots.
- position
Position of asset or asset component. May often be in relation to other assets or components.
- purchasePrice
Purchase price of asset.
- retiredReason
Reason asset retired.
- serialNumber
Serial number of this asset.
- status
Status of this asset.
- type
Utility-specific classification of Asset and its subtypes, according to their corporate standards, practices, and existing IT systems (e.g., for management of assets, maintenance, work, outage, customers, etc.).
- utcNumber
Uniquely tracked commodity (UTC) number.
- ActivityRecords
ActivityRecord All activity records created for this asset.
- Analytic
Analytic Analytic performed on this asset.
- AnalyticScore
AnalyticScore Analytic result related to this asset.
- AssetContainer
AssetContainer Container of this asset.
- AssetDeployment
AssetDeployment This asset's deployment.
- AssetFunction
AssetFunction undocumented
- AssetGroup
AssetGroup Asset group of which this asset is a part.
- AssetInfo
AssetInfo Data applicable to this asset.
- AssetPropertyCurves
AssetPropertyCurve undocumented
- BreakerOperation
SwitchOperationSummary Breaker operation information for this breaker.
- ConfigurationEvents
ConfigurationEvent All configuration events created for this asset.
- ErpInventory
ErpInventory undocumented
- ErpItemMaster
ErpItemMaster undocumented
- ErpRecDeliveryItems
ErpRecDelvLineItem undocumented
- FinancialInfo
FinancialInfo Financial information related to this asset.
- Location
Location Location of this asset.
- Measurements
Measurement Measurement related to this asset.
- Medium
Medium Medium with which this asset is filled.
- OperationalTags
OperationalTag All operational tags placed on this asset.
- OrganisationRoles
AssetOrganisationRole All roles an organisation plays for this asset.
- Ownerships
Ownership All ownerships of this asset.
- PowerSystemResources
PowerSystemResource All power system resources used to electrically model this asset. For example, transformer asset is electrically modelled with a transformer and its windings and tap changer.
- ProcedureDataSet
ProcedureDataSet Procedure data set that applies to this asset.
- Procedures
Procedure All procedures applicable to this asset.
- ProductAssetModel
ProductAssetModel The model of this asset.
- Reconditionings
Reconditioning undocumented
- ReliabilityInfos
ReliabilityInfo undocumented
- ReplacementWorkTasks
WorkTask All work tasks on replacement of this old asset.
- ScheduledEvents
ScheduledEvent Scheduled event related to this asset.
- WorkTasks
WorkTask All non-replacement work tasks performed on this asset.
-
final
case class
AssetAnalog(Analog: Analog = null, detectionLimit: Double = 0.0, precision: Double = 0.0, reportingTemperature: Double = 0.0, TestStandard: String = null) extends Element with Product with Serializable
Definition of type of analog useful in asset domain.
Definition of type of analog useful in asset domain.
- Analog
Analog Reference to the superclass object.
- detectionLimit
Detection limit of related analog value if different from detection limit of test standard or if there is no test standard. The detection limit (also known as lower limit of detection or limit of detection (LOD), is the lowest quantity of a substance that can be distinguished from the absence of that substance (a blank value) within a stated confidence limit (generally 1%).
- precision
Precision of related analog value if different from precision of test standard or if there is no test standard. Precision is a measure of how closely individual measurements agree with one another. Expressed as 'plus or minus' the value of this attribute.
- reportingTemperature
Reporting temperature of related analog value if different from reporting temperature of test standard or if there is no test standard. Reporting temperature is what gas volumes are normalized to. Different reporting temperatures are used by different sources. For example, ASTM specifies 0°C, whereas IEC specifies 20°C. Online monitors often have their own unique reporting temperatures.
- TestStandard
TestStandard The lab test standard to which this asset health analog is related.
-
final
case class
AssetContainer(Asset: Asset = null, Assets: List[String] = null, LandProperties: List[String] = null, Seals: List[String] = null) extends Element with Product with Serializable
Asset that is aggregation of other assets such as conductors, transformers, switchgear, land, fences, buildings, equipment, vehicles, etc.
Asset that is aggregation of other assets such as conductors, transformers, switchgear, land, fences, buildings, equipment, vehicles, etc.
- Asset
Asset Reference to the superclass object.
- Assets
Asset All assets within this container asset.
- LandProperties
LandProperty undocumented
- Seals
Seal All seals applied to this asset container.
-
final
case class
AssetDeployment(IdentifiedObject: IdentifiedObject = null, breakerApplication: String = null, deploymentDate: String = null, deploymentState: String = null, facilityKind: String = null, likelihoodOfFailure: Int = 0, transformerApplication: String = null, Asset: String = null, BaseVoltage: String = null) extends Element with Product with Serializable
Deployment of asset deployment in a power system resource role.
Deployment of asset deployment in a power system resource role.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- breakerApplication
Type of network role breaker is playing in this deployment (applies to breaker assets only).
- deploymentDate
DeploymentDate Dates of asset deployment.
- deploymentState
Current deployment state of asset.
- facilityKind
Kind of facility (like substation or pole or building or plant or service center) at which asset deployed.
- likelihoodOfFailure
Likelihood of asset failure on a scale of 1(low) to 100 (high).
- transformerApplication
Type of network role transformer is playing in this deployment (applies to transformer assets only).
- Asset
Asset Asset in this deployment.
- BaseVoltage
BaseVoltage Base voltage of this network asset deployment.
-
final
case class
AssetDiscrete(Discrete: Discrete = null, TestStandard: String = null) extends Element with Product with Serializable
Definition of type of discrete useful in asset domain.
Definition of type of discrete useful in asset domain.
- Discrete
Discrete Reference to the superclass object.
- TestStandard
TestStandard The lab test standard to which this asset health discrete is related.
-
final
case class
AssetFunction(IdentifiedObject: IdentifiedObject = null, configID: String = null, firmwareID: String = null, hardwareID: String = null, password: String = null, programID: String = null, Asset: String = null) extends Element with Product with Serializable
Function performed by an asset.
Function performed by an asset.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- configID
Configuration specified for this function.
- firmwareID
Firmware version.
- hardwareID
Hardware version.
- password
Password needed to access this function.
- programID
Name of program.
- Asset
Asset undocumented
-
final
case class
AssetGroup(Document: Document = null, kind: String = null, Analytic: List[String] = null, AnalyticScore: List[String] = null, Asset: List[String] = null) extends Element with Product with Serializable
A grouping of assets created for a purpose such as fleet analytics, inventory or compliance management.
A grouping of assets created for a purpose such as fleet analytics, inventory or compliance management.
- Document
Document Reference to the superclass object.
- kind
Kind of asset group this asset group is.
- Analytic
Analytic Analytic which can be performed on this asset group.
- AnalyticScore
AnalyticScore Analytic score for this asset group.
- Asset
Asset Asset which is a part of this asset group.
-
final
case class
AssetHealthEvent(ActivityRecord: ActivityRecord = null, actionRecommendation: String = null, actionTimeline: String = null, effectiveDateTime: String = null, Analytic: String = null) extends Element with Product with Serializable
An asset health-related event that is created by an analytic.
An asset health-related event that is created by an analytic.
The event is a record of a change in asset health.
- ActivityRecord
ActivityRecord Reference to the superclass object.
- actionRecommendation
Recommendation for action.
- actionTimeline
Time horizon for action.
- effectiveDateTime
The date and time when the event is effective.
- Analytic
Analytic Analytic that initiated this asset health event.
-
final
case class
AssetInfo(IdentifiedObject: IdentifiedObject = null, Assets: List[String] = null, CatalogAssetType: String = null, PowerSystemResources: List[String] = null, ProductAssetModel: String = null) extends Element with Product with Serializable
Set of attributes of an asset, representing typical datasheet information of a physical device that can be instantiated and shared in different data exchange contexts: - as attributes of an asset instance (installed or in stock) - as attributes of an asset model (product by a manufacturer)
Set of attributes of an asset, representing typical datasheet information of a physical device that can be instantiated and shared in different data exchange contexts: - as attributes of an asset instance (installed or in stock) - as attributes of an asset model (product by a manufacturer)
- as attributes of a type asset (generic type of an asset as used in designs/extension planning).
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- Assets
Asset All assets described by this data.
- CatalogAssetType
CatalogAssetType Asset information (nameplate) for this catalog asset type.
- PowerSystemResources
PowerSystemResource All power system resources with this datasheet information.
- ProductAssetModel
ProductAssetModel Product asset model which conforms to this catalog asset type.
-
final
case class
AssetLocationHazard(Hazard: Hazard = null, kind: String = null, Locations: List[String] = null) extends Element with Product with Serializable
Potential hazard related to the location of an asset.
Potential hazard related to the location of an asset.
Examples are trees growing under overhead power lines, a park being located by a substation (i.e., children climb fence to recover a ball), a lake near an overhead distribution line (fishing pole/line contacting power lines), dangerous neighbour, etc.
-
final
case class
AssetModelCatalogue(IdentifiedObject: IdentifiedObject = null, status: String = null, AssetModelCatalogueItems: List[String] = null) extends Element with Product with Serializable
Catalogue of available types of products and materials that are used to build or install, maintain or operate an Asset.
Catalogue of available types of products and materials that are used to build or install, maintain or operate an Asset.
Each catalogue item is for a specific product (AssetModel) available from a specific supplier.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- status
undocumented
- AssetModelCatalogueItems
AssetModelCatalogueItem undocumented
-
final
case class
AssetModelCatalogueItem(Document: Document = null, unitCost: Double = 0.0, AssetModel: String = null, AssetModelCatalogue: String = null, ErpPOLineItems: List[String] = null, ErpQuoteLineItems: List[String] = null) extends Element with Product with Serializable
Provides pricing and other relevant information about a specific manufacturer's product (i.e., AssetModel), and its price from a given supplier.
Provides pricing and other relevant information about a specific manufacturer's product (i.e., AssetModel), and its price from a given supplier.
A single AssetModel may be availble from multiple suppliers. Note that manufacturer and supplier are both types of organisation, which the association is inherited from Document.
- Document
Document Reference to the superclass object.
- unitCost
Unit cost for an asset model from a specific supplier, either for a unit cost or cost per unit length. Cost is for material or asset only and does not include labor to install/construct or configure it.
- AssetModel
ProductAssetModel undocumented
- AssetModelCatalogue
AssetModelCatalogue undocumented
- ErpPOLineItems
ErpPOLineItem undocumented
- ErpQuoteLineItems
ErpQuoteLineItem undocumented
-
final
case class
AssetOrganisationRole(OrganisationRole: OrganisationRole = null, Assets: List[String] = null) extends Element with Product with Serializable
Role an organisation plays with respect to asset.
Role an organisation plays with respect to asset.
- OrganisationRole
OrganisationRole Reference to the superclass object.
- Assets
Asset All assets for this organisation role.
-
final
case class
AssetOwner(AssetOrganisationRole: AssetOrganisationRole = null, Ownerships: List[String] = null) extends Element with Product with Serializable
Owner of the asset.
Owner of the asset.
- AssetOrganisationRole
AssetOrganisationRole Reference to the superclass object.
- Ownerships
Ownership All ownerships of this owner.
-
final
case class
AssetPropertyCurve(Curve: Curve = null, Assets: List[String] = null, Specification: String = null) extends Element with Product with Serializable
An Asset Property that is described through curves rather than as a data point.
An Asset Property that is described through curves rather than as a data point.
The relationship is to be defined between an independent variable (X-axis) and one or two dependent variables (Y1-axis and Y2-axis).
- Curve
Curve Reference to the superclass object.
- Assets
Asset undocumented
- Specification
Specification undocumented
-
final
case class
AssetStringMeasurement(StringMeasurement: StringMeasurement = null, kind: String = null, TestStandard: String = null) extends Element with Product with Serializable
Definition of type of string measurement useful in asset domain.
Definition of type of string measurement useful in asset domain.
- StringMeasurement
StringMeasurement Reference to the superclass object.
- kind
Kind of string useful in asset domain.
- TestStandard
TestStandard Test standard which describes this asset string measurement.
-
final
case class
AssetTemperaturePressureAnalog(AssetAnalog: AssetAnalog = null, kind: String = null) extends Element with Product with Serializable
Temperature or pressure type of asset analog.
Temperature or pressure type of asset analog.
- AssetAnalog
AssetAnalog Reference to the superclass object.
- kind
Kind of analog representing temperature or pressure related to an asset.
-
final
case class
AssetTestLab(AssetOrganisationRole: AssetOrganisationRole = null, LabTestDataSet: List[String] = null) extends Element with Product with Serializable
Test lab that performs various types of testing related to assets.
Test lab that performs various types of testing related to assets.
- AssetOrganisationRole
AssetOrganisationRole Reference to the superclass object.
- LabTestDataSet
LabTestDataSet A set of lab test results produced by this test lab.
-
final
case class
AssetTestSampleTaker(AssetOrganisationRole: AssetOrganisationRole = null, Specimen: List[String] = null) extends Element with Product with Serializable
Identity of person/organization that took sample.
Identity of person/organization that took sample.
- AssetOrganisationRole
AssetOrganisationRole Reference to the superclass object.
- Specimen
Specimen Specimen taken by this sample taker.
-
final
case class
AssetUser(AssetOrganisationRole: AssetOrganisationRole = null) extends Element with Product with Serializable
Organisation that is a user of the asset.
Organisation that is a user of the asset.
- AssetOrganisationRole
AssetOrganisationRole Reference to the superclass object.
-
final
case class
Assignment(WorkDocument: WorkDocument = null, effectivePeriod: String = null, Crews: List[String] = null) extends Element with Product with Serializable
An assignment is given to an ErpPerson, Crew, Organisation, Equipment Item, Tool, etc.
An assignment is given to an ErpPerson, Crew, Organisation, Equipment Item, Tool, etc. and may be used to perform Work, WorkTasks, Procedures, etc.
TimeSchedules may be set up directly for Assignments or indirectly via the associated WorkTask. Note that these associations are all inherited through the recursive relationship on Document.
- WorkDocument
WorkDocument Reference to the superclass object.
- effectivePeriod
Period between the assignment becoming effective and its expiration.
- Crews
OldCrew All Crews having this Assignment.
-
final
case class
AsynchronousMachine(RotatingMachine: RotatingMachine = null, asynchronousMachineType: String = null, converterFedDrive: Boolean = false, efficiency: Double = 0.0, iaIrRatio: Double = 0.0, nominalFrequency: Double = 0.0, nominalSpeed: Double = 0.0, polePairNumber: Int = 0, ratedMechanicalPower: Double = 0.0, reversible: Boolean = false, rr1: Double = 0.0, rr2: Double = 0.0, rxLockedRotorRatio: Double = 0.0, tpo: Double = 0.0, tppo: Double = 0.0, xlr1: Double = 0.0, xlr2: Double = 0.0, xm: Double = 0.0, xp: Double = 0.0, xpp: Double = 0.0, xs: Double = 0.0, AsynchronousMachineDynamics: String = null) extends Element with Product with Serializable
A rotating machine whose shaft rotates asynchronously with the electrical field.
A rotating machine whose shaft rotates asynchronously with the electrical field.
Also known as an induction machine with no external connection to the rotor windings, e.g. squirrel-cage induction machine.
- RotatingMachine
RotatingMachine Reference to the superclass object.
- asynchronousMachineType
Indicates the type of Asynchronous Machine (motor or generator).
- converterFedDrive
Indicates whether the machine is a converter fed drive. Used for short circuit data exchange according to IEC 60909.
- efficiency
Efficiency of the asynchronous machine at nominal operation as a percentage. Indicator for converter drive motors. Used for short circuit data exchange according to IEC 60909.
- iaIrRatio
Ratio of locked-rotor current to the rated current of the motor (Ia/Ir). Used for short circuit data exchange according to IEC 60909.
- nominalFrequency
Nameplate data indicates if the machine is 50 Hz or 60 Hz.
- nominalSpeed
Nameplate data. Depends on the slip and number of pole pairs.
- polePairNumber
Number of pole pairs of stator. Used for short circuit data exchange according to IEC 60909.
- ratedMechanicalPower
Rated mechanical power (Pr in IEC 60909-0). Used for short circuit data exchange according to IEC 60909.
- reversible
Indicates for converter drive motors if the power can be reversible. Used for short circuit data exchange according to IEC 60909.
- rr1
Damper 1 winding resistance.
- rr2
Damper 2 winding resistance.
- rxLockedRotorRatio
Locked rotor ratio (R/X). Used for short circuit data exchange according to IEC 60909.
- tpo
Transient rotor time constant (greater than tppo).
- tppo
Sub-transient rotor time constant (greater than 0).
- xlr1
Damper 1 winding leakage reactance.
- xlr2
Damper 2 winding leakage reactance.
- xm
Magnetizing reactance.
- xp
Transient reactance (unsaturated) (greater than or equal to xpp).
- xpp
Sub-transient reactance (unsaturated).
- xs
Synchronous reactance (greater than xp).
- AsynchronousMachineDynamics
AsynchronousMachineDynamics Asynchronous machine dynamics model used to describe dynamic behaviour of this asynchronous machine.
-
final
case class
AsynchronousMachineDynamics(RotatingMachineDynamics: RotatingMachineDynamics = null, AsynchronousMachine: String = null, MechanicalLoadDynamics: String = null, TurbineGovernorDynamics: String = null, WindTurbineType1or2Dynamics: String = null) extends Element with Product with Serializable
Asynchronous machine whose behaviour is described by reference to a standard model expressed in either time constant reactance form or equivalent circuit form <font color="#0f0f0f">or by definition of a user-defined model.</font> Parameter details:
Asynchronous machine whose behaviour is described by reference to a standard model expressed in either time constant reactance form or equivalent circuit form <font color="#0f0f0f">or by definition of a user-defined model.</font> Parameter details:
- Asynchronous machine parameters such as Xl, Xs, etc. are actually used as inductances in the model, but are commonly referred to as reactances since, at nominal frequency, the PU values are the same.
However, some references use the symbol L instead of X.
- RotatingMachineDynamics
RotatingMachineDynamics Reference to the superclass object.
- AsynchronousMachine
AsynchronousMachine Asynchronous machine to which this asynchronous machine dynamics model applies.
- MechanicalLoadDynamics
MechanicalLoadDynamics Mechanical load model associated with this asynchronous machine model.
- TurbineGovernorDynamics
TurbineGovernorDynamics Turbine-governor model associated with this asynchronous machine model.
- WindTurbineType1or2Dynamics
WindTurbineType1or2Dynamics Wind generator type 1 or type 2 model associated with this asynchronous machine model.
-
final
case class
AsynchronousMachineEquivalentCircuit(AsynchronousMachineDynamics: AsynchronousMachineDynamics = null, rr1: Double = 0.0, rr2: Double = 0.0, xlr1: Double = 0.0, xlr2: Double = 0.0, xm: Double = 0.0) extends Element with Product with Serializable
The electrical equations of all variations of the asynchronous model are based on the AsynchronousEquivalentCircuit diagram for the direct- and quadrature- axes, with two equivalent rotor windings in each axis.
The electrical equations of all variations of the asynchronous model are based on the AsynchronousEquivalentCircuit diagram for the direct- and quadrature- axes, with two equivalent rotor windings in each axis.
Equations for conversion between equivalent circuit and time constant reactance forms: Xs = Xm + Xl X' = Xl + Xm x Xlr1 / (Xm + Xlr1) X'' = Xl + Xm x Xlr1 x Xlr2 / (Xm x Xlr1 + Xm x Xlr2 + Xlr1 x Xlr2) T'o = (Xm + Xlr1) / (omega0 x Rr1) T''o = (Xm x Xlr1 + Xm x Xlr2 + Xlr1 x Xlr2) / (omega0 x Rr2 x (Xm + Xlr1) Same equations using CIM attributes from AsynchronousMachineTimeConstantReactance class on left of "=" and AsynchronousMachineEquivalentCircuit class on right (except as noted): xs = xm + RotatingMachineDynamics.statorLeakageReactance xp = RotatingMachineDynamics.statorLeakageReactance + xm x xlr1 / (xm + xlr1) xpp = RotatingMachineDynamics.statorLeakageReactance + xm x xlr1 x xlr2 / (xm x xlr1 + xm x xlr2 + xlr1 x xlr2) tpo = (xm + xlr1) / (2 x pi x nominal frequency x rr1) tppo = (xm x xlr1 + xm x xlr2 + xlr1 x xlr2) / (2 x pi x nominal frequency x rr2 x (xm + xlr1).
- AsynchronousMachineDynamics
AsynchronousMachineDynamics Reference to the superclass object.
- rr1
Damper 1 winding resistance.
- rr2
Damper 2 winding resistance.
- xlr1
Damper 1 winding leakage reactance.
- xlr2
Damper 2 winding leakage reactance.
- xm
Magnetizing reactance.
-
final
case class
AsynchronousMachineTimeConstantReactance(AsynchronousMachineDynamics: AsynchronousMachineDynamics = null, tpo: Double = 0.0, tppo: Double = 0.0, xp: Double = 0.0, xpp: Double = 0.0, xs: Double = 0.0) extends Element with Product with Serializable
Parameter details:
Parameter details:
- If X'' = X', a single cage (one equivalent rotor winding per axis) is modelled.
- The “p” in the attribute names is a substitution for a “prime” in the usual parameter notation, e.g. tpo refers to T'o.
The parameters used for models expressed in time constant reactance form include: - RotatingMachine.ratedS (MVAbase); - RotatingMachineDynamics.damping (D); - RotatingMachineDynamics.inertia (H); - RotatingMachineDynamics.saturationFactor (S1); - RotatingMachineDynamics.saturationFactor120 (S12); - RotatingMachineDynamics.statorLeakageReactance (Xl); - RotatingMachineDynamics.statorResistance (Rs); - .xs (Xs); - .xp (X'); - .xpp (X''); - .tpo (T'o);
- .tppo (T''o).
- AsynchronousMachineDynamics
AsynchronousMachineDynamics Reference to the superclass object.
- tpo
Transient rotor time constant (T'o) (> AsynchronousMachineTimeConstantReactance.tppo). Typical value = 5.
- tppo
Subtransient rotor time constant (T''o) (> 0). Typical value = 0,03.
- xp
Transient reactance (unsaturated) (X') (>= AsynchronousMachineTimeConstantReactance.xpp). Typical value = 0,5.
- xpp
Subtransient reactance (unsaturated) (X'') (> RotatingMachineDynamics.statorLeakageReactance). Typical value = 0,2.
- xs
Synchronous reactance (Xs) (>= AsynchronousMachineTimeConstantReactance.xp). Typical value = 1,8.
-
final
case class
AsynchronousMachineUserDefined(AsynchronousMachineDynamics: AsynchronousMachineDynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Asynchronous machine whose dynamic behaviour is described by a user-defined model.
Asynchronous machine whose dynamic behaviour is described by a user-defined model.
- AsynchronousMachineDynamics
AsynchronousMachineDynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
AtmosphericAnalog(EnvironmentalAnalog: EnvironmentalAnalog = null, kind: String = null) extends Element with Product with Serializable
Analog (float) measuring an atmospheric condition.
Analog (float) measuring an atmospheric condition.
- EnvironmentalAnalog
EnvironmentalAnalog Reference to the superclass object.
- kind
Kind of atmospheric analog.
-
final
case class
AtmosphericPhenomenon(EnvironmentalPhenomenon: EnvironmentalPhenomenon = null, altitude: String = null, base: String = null, direction: Double = 0.0, maxCoverage: Double = 0.0, minCoverage: Double = 0.0, speed: Double = 0.0) extends Element with Product with Serializable
An atmospheric phenomenon with a base and altitude providing the vertical coverage (combined with the Location to provide three dimensional space).
An atmospheric phenomenon with a base and altitude providing the vertical coverage (combined with the Location to provide three dimensional space).
- EnvironmentalPhenomenon
EnvironmentalPhenomenon Reference to the superclass object.
- altitude
The maximum altitude of the phenomenon.
- base
The base altitude of the phenomenon.
- direction
The direction the phenomenon is moving.
- maxCoverage
The maximum percentage coverage
- minCoverage
The minimum percentage coverage
- speed
The speed of the phenomenon
-
final
case class
AttributeInstanceComponent(Element: BasicElement = null, attribute: String = null, attributeValue: String = null, position: Int = 0, MarketDocument: List[String] = null, TimeSeries: List[String] = null) extends Element with Product with Serializable
A class used to provide information about an attribute.
A class used to provide information about an attribute.
- Element
Reference to the superclass object.
- attribute
The identification of the formal name of an attribute.
- attributeValue
The instance value of the attribute.
- position
A sequential value representing a relative sequence number.
- MarketDocument
MarketDocument undocumented
- TimeSeries
TimeSeries undocumented
-
final
case class
AttributeProperty(Element: BasicElement = null, propertyName: String = null, propertyValue: String = null, sequence: String = null, MktUserAttribute: String = null) extends Element with Product with Serializable
Property for a particular attribute that contains name and value.
Property for a particular attribute that contains name and value.
- Element
Reference to the superclass object.
- propertyName
undocumented
- propertyValue
undocumented
- sequence
undocumented
- MktUserAttribute
MktUserAttribute undocumented
-
final
case class
Auction(IdentifiedObject: IdentifiedObject = null, allocationMode: String = null, cancelled: String = null, category: String = null, paymentTerms: String = null, rights: String = null, type: String = null, TimeSeries: List[String] = null) extends Element with Product with Serializable
A class providing the identification and type of an auction.
A class providing the identification and type of an auction.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- allocationMode
Identification of the method of allocation in an auction.
- cancelled
An indicator that signifies that the auction has been cancelled.
- category
The product category of an auction.
- paymentTerms
The terms which dictate the determination of the bid payment price.
- rights
The rights of use the transmission capacity acquired in an auction.
- type
The kind of the Auction (e.g. implicit, explicit ...).
- TimeSeries
TimeSeries undocumented
-
final
case class
Author(DocumentPersonRole: DocumentPersonRole = null, ActivityRecords: List[String] = null, Documents: List[String] = null) extends Element with Product with Serializable
Person who created document or activity record.
Person who created document or activity record.
- DocumentPersonRole
DocumentPersonRole Reference to the superclass object.
- ActivityRecords
ActivityRecord All activity records with this author.
- Documents
Document All documents of this this author.
-
final
case class
AuxiliaryAccount(Document: Document = null, balance: Double = 0.0, due: String = null, lastCredit: String = null, lastDebit: String = null, principleAmount: Double = 0.0, AuxiliaryAgreement: String = null, Charges: List[String] = null, PaymentTransactions: List[String] = null) extends Element with Product with Serializable
Variable and dynamic part of auxiliary agreement, generally representing the current state of the account related to the outstanding balance defined in auxiliary agreement.
Variable and dynamic part of auxiliary agreement, generally representing the current state of the account related to the outstanding balance defined in auxiliary agreement.
- Document
Document Reference to the superclass object.
- balance
The total amount currently remaining on this account that is required to be paid in order to settle the account to zero. This excludes any due amounts not yet paid.
- due
Due Current amounts now due for payment on this account.
- lastCredit
AccountMovement Details of the last credit transaction performed on this account.
- lastDebit
AccountMovement Details of the last debit transaction performed on this account.
- principleAmount
The initial principle amount, with which this account was instantiated.
- AuxiliaryAgreement
AuxiliaryAgreement Auxiliary agreement regulating this account.
- Charges
Charge All charges levied on this account.
- PaymentTransactions
Transaction All payments against this account.
-
final
case class
AuxiliaryAgreement(Agreement: Agreement = null, arrearsInterest: Double = 0.0, auxCycle: String = null, auxPriorityCode: String = null, fixedAmount: Double = 0.0, minAmount: Double = 0.0, payCycle: String = null, subType: String = null, vendPortion: Double = 0.0, vendPortionArrear: Double = 0.0, AuxiliaryAccounts: List[String] = null, CustomerAgreement: String = null) extends Element with Product with Serializable
An ad-hoc auxiliary account agreement associated with a customer agreement, not part of the customer's account, but typically subject to formal agreement between customer and supplier (utility).
An ad-hoc auxiliary account agreement associated with a customer agreement, not part of the customer's account, but typically subject to formal agreement between customer and supplier (utility).
Typically this is used to collect revenue owed by the customer for other services or arrears accrued with the utility for other services. It is typically linked to a prepaid token purchase transaction, thus forcing the customer to make a payment towards settlement of the auxiliary account balance whenever the customer needs to purchase a prepaid token for electricity. The present status of the auxiliary agreement can be defined in the context of the utility's business rules, for example: enabled, disabled, pending, over recovered, under recovered, written off, etc.
- Agreement
Agreement Reference to the superclass object.
- arrearsInterest
The interest per annum to be charged prorata on 'AuxiliaryAccount.dueArrears' at the end of each 'payCycle'.
- auxCycle
The frequency for automatically recurring auxiliary charges, where 'AuxiliaryAccount.initialCharge' is recursively added to 'AuxiliaryAccount.dueCurrent' at the start of each 'auxCycle'. For example: on a specified date and time; hourly; daily; weekly; monthly; 3-monthly; 6-monthly; 12-monthly; etc.
- auxPriorityCode
The coded priority indicating the priority that this auxiliary agreement has above other auxiliary agreements (associated with the same customer agreement) when it comes to competing for settlement from a payment transaction or token purchase.
- fixedAmount
The fixed amount that has to be collected from each vending transaction towards settlement of this auxiliary agreement. Note that there may be multiple tokens vended per vending transaction, but this is not relevant.
- minAmount
The minimum amount that has to be paid at any transaction towards settling this auxiliary agreement or reducing the balance.
- payCycle
The contractually expected payment frequency (by the customer). Examples are: ad-hoc; on specified date; hourly, daily, weekly, monthly. etc.
- subType
Sub-classification of the inherited 'type' for this AuxiliaryAgreement.
- vendPortion
The percentage of the transaction amount that has to be collected from each vending transaction towards settlement of this auxiliary agreement when payments are not in arrears. Note that there may be multiple tokens vended per vending transaction, but this is not relevant.
- vendPortionArrear
The percentage of the transaction amount that has to be collected from each vending transaction towards settlement of this auxiliary agreement when payments are in arrears. Note that there may be multiple tokens vended per vending transaction, but this is not relevant.
- AuxiliaryAccounts
AuxiliaryAccount All auxiliary accounts regulated by this agreement.
- CustomerAgreement
CustomerAgreement Customer agreement this (non-service related) auxiliary agreement refers to.
-
final
case class
AuxiliaryCost(Element: BasicElement = null, intervalStartTime: String = null, marketType: String = null, updateTimeStamp: String = null, updateUser: String = null, AuxillaryValues: List[String] = null) extends Element with Product with Serializable
Models Market clearing results for Auxiliary costs.
Models Market clearing results for Auxiliary costs.
- Element
Reference to the superclass object.
- intervalStartTime
undocumented
- marketType
undocumented
- updateTimeStamp
undocumented
- updateUser
undocumented
- AuxillaryValues
AuxiliaryValues undocumented
-
final
case class
AuxiliaryEquipment(Equipment: Equipment = null, Terminal: String = null) extends Element with Product with Serializable
AuxiliaryEquipment describe equipment that is not performing any primary functions but support for the equipment performing the primary function.
AuxiliaryEquipment describe equipment that is not performing any primary functions but support for the equipment performing the primary function.
AuxiliaryEquipment is attached to primary equipment via an association with Terminal.
-
final
case class
AuxiliaryObject(Element: BasicElement = null, RegisteredGenerator: String = null, RegisteredLoad: String = null) extends Element with Product with Serializable
Models Auxiliary Values.
Models Auxiliary Values.
- Element
Reference to the superclass object.
- RegisteredGenerator
RegisteredGenerator undocumented
- RegisteredLoad
RegisteredLoad undocumented
-
final
case class
AuxiliaryValues(AuxiliaryObject: AuxiliaryObject = null, availUndispatchedQ: Double = 0.0, incrementalORAvail: Double = 0.0, maxExpostCapacity: Double = 0.0, minExpostCapacity: Double = 0.0, noLoadCost: Double = 0.0, noLoadCostEligibilityFlag: String = null, startUpCost: Double = 0.0, startUpCostEligibilityFlag: String = null, AuxillaryCost: String = null, FiveMinAuxillaryData: String = null, TenMinAuxillaryData: String = null) extends Element with Product with Serializable
Models Auxiliary Values.
Models Auxiliary Values.
- AuxiliaryObject
AuxiliaryObject Reference to the superclass object.
- availUndispatchedQ
undocumented
- incrementalORAvail
undocumented
- maxExpostCapacity
undocumented
- minExpostCapacity
undocumented
- noLoadCost
undocumented
- noLoadCostEligibilityFlag
undocumented
- startUpCost
undocumented
- startUpCostEligibilityFlag
undocumented
- AuxillaryCost
AuxiliaryCost undocumented
- FiveMinAuxillaryData
FiveMinAuxiliaryData undocumented
- TenMinAuxillaryData
TenMinAuxiliaryData undocumented
-
final
case class
AvailablityPlan(IdentifiedObject: IdentifiedObject = null, validPeriod: String = null) extends Element with Product with Serializable
The collection of all the availability schedules for a given time range.
The collection of all the availability schedules for a given time range.
Only one availability plan shall be valid for the same period.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- validPeriod
The period of time for which the plan is valid.
-
final
case class
BWRSteamSupply(SteamSupply: SteamSupply = null, highPowerLimit: Double = 0.0, inCoreThermalTC: Double = 0.0, integralGain: Double = 0.0, lowPowerLimit: Double = 0.0, lowerLimit: Double = 0.0, pressureLimit: Double = 0.0, pressureSetpointGA: Double = 0.0, pressureSetpointTC1: Double = 0.0, pressureSetpointTC2: Double = 0.0, proportionalGain: Double = 0.0, rfAux1: Double = 0.0, rfAux2: Double = 0.0, rfAux3: Double = 0.0, rfAux4: Double = 0.0, rfAux5: Double = 0.0, rfAux6: Double = 0.0, rfAux7: Double = 0.0, rfAux8: Double = 0.0, rodPattern: Double = 0.0, rodPatternConstant: Double = 0.0, upperLimit: Double = 0.0) extends Element with Product with Serializable
Boiling water reactor used as a steam supply to a steam turbine.
Boiling water reactor used as a steam supply to a steam turbine.
- SteamSupply
SteamSupply Reference to the superclass object.
- highPowerLimit
High power limit.
- inCoreThermalTC
In-core thermal time constant.
- integralGain
Integral gain.
- lowPowerLimit
Low power limit.
- lowerLimit
Initial lower limit.
- pressureLimit
Pressure limit.
- pressureSetpointGA
Pressure setpoint gain adjuster.
- pressureSetpointTC1
Pressure setpoint time constant.
- pressureSetpointTC2
Pressure setpoint time constant.
- proportionalGain
Proportional gain.
- rfAux1
Coefficient for modelling the effect of off-nominal frequency and voltage on recirculation and core flow, which affects the BWR power output.
- rfAux2
Coefficient for modelling the effect of off-nominal frequency and voltage on recirculation and core flow, which affects the BWR power output.
- rfAux3
Coefficient for modelling the effect of off-nominal frequency and voltage on recirculation and core flow, which affects the BWR power output.
- rfAux4
Coefficient for modelling the effect of off-nominal frequency and voltage on recirculation and core flow, which affects the BWR power output.
- rfAux5
Coefficient for modelling the effect of off-nominal frequency and voltage on recirculation and core flow, which affects the BWR power output.
- rfAux6
Coefficient for modelling the effect of off-nominal frequency and voltage on recirculation and core flow, which affects the BWR power output.
- rfAux7
Coefficient for modelling the effect of off-nominal frequency and voltage on recirculation and core flow, which affects the BWR power output.
- rfAux8
Coefficient for modelling the effect of off-nominal frequency and voltage on recirculation and core flow, which affects the BWR power output.
- rodPattern
Rod pattern.
- rodPatternConstant
Constant associated with rod pattern.
- upperLimit
Initial upper limit.
-
final
case class
Bank(OrganisationRole: OrganisationRole = null, bic: String = null, iban: String = null, BankAccounts: List[String] = null) extends Element with Product with Serializable
Organisation that is a commercial bank, agency, or other institution that offers a similar service.
Organisation that is a commercial bank, agency, or other institution that offers a similar service.
- OrganisationRole
OrganisationRole Reference to the superclass object.
- bic
Bank identifier code as defined in ISO 9362; for use in countries wher IBAN is not yet in operation.
- iban
International bank account number defined in ISO 13616; for countries where IBAN is not in operation, the existing BIC or SWIFT codes may be used instead (see ISO 9362).
- BankAccounts
BankAccount All BankAccounts this Bank provides.
-
final
case class
BankAccount(Document: Document = null, accountNumber: String = null, Bank: String = null, ServiceSupplier: String = null) extends Element with Product with Serializable
Bank account.
Bank account.
- Document
Document Reference to the superclass object.
- accountNumber
Account reference number.
- Bank
Bank Bank that provides this BankAccount.
- ServiceSupplier
ServiceSupplier ServiceSupplier that is owner of this BankAccount.
-
final
case class
BankAccountDetail(Element: BasicElement = null, accountNumber: String = null, bankName: String = null, branchCode: String = null, holderID: String = null, holderName: String = null) extends Element with Product with Serializable
Details of a bank account.
Details of a bank account.
- Element
Reference to the superclass object.
- accountNumber
Operational account reference number.
- bankName
Name of bank where account is held.
- branchCode
Branch of bank where account is held.
- holderID
National identity number (or equivalent) of account holder.
- holderName
Name of account holder.
-
final
case class
BaseCaseConstraintLimit(Curve: Curve = null, SecurityConstraintSum: String = null) extends Element with Product with Serializable
Possibly time-varying max MW or MVA and optionally Min MW limit or MVA limit (Y1 and Y2, respectively) assigned to a contingency analysis base case.
Possibly time-varying max MW or MVA and optionally Min MW limit or MVA limit (Y1 and Y2, respectively) assigned to a contingency analysis base case.
Use CurveSchedule XAxisUnits to specify MW or MVA. To be used only if the BaseCaseConstraintLimit differs from the DefaultConstraintLimit.
- Curve
Curve Reference to the superclass object.
- SecurityConstraintSum
SecurityConstraintSum undocumented
-
final
case class
BaseFrequency(IdentifiedObject: IdentifiedObject = null, frequency: Double = 0.0) extends Element with Product with Serializable
The BaseFrequency class describes a base frequency for a power system network.
The BaseFrequency class describes a base frequency for a power system network.
In case of multiple power networks with different frequencies, e.g. 50 Hz or 60 Hz each network will have its own base frequency class. Hence it is assumed that power system objects having different base frequencies appear in separate documents where each document has a single base frequency instance.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- frequency
The base frequency.
-
final
case class
BasePower(IdentifiedObject: IdentifiedObject = null, basePower: Double = 0.0) extends Element with Product with Serializable
The BasePower class defines the base power used in the per unit calculations.
The BasePower class defines the base power used in the per unit calculations.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- basePower
Value used as base power.
-
final
case class
BaseReading(MeasurementValue: MeasurementValue = null, reportedDateTime: String = null, source: String = null, timePeriod: String = null, value: String = null, ReadingQualities: List[String] = null) extends Element with Product with Serializable
Common representation for reading values.
Common representation for reading values.
Note that a reading value may have multiple qualities, as produced by various systems ('ReadingQuality.source').
- MeasurementValue
MeasurementValue Reference to the superclass object.
- reportedDateTime
(used only when there are detailed auditing requirements) Date and time at which the reading was first delivered to the metering system.
- source
System that originally supplied the reading (e.g., customer, AMI system, handheld reading system, another enterprise system, etc.).
- timePeriod
Start and end of the period for those readings whose type has a time attribute such as 'billing', seasonal' or 'forTheSpecifiedPeriod'.
- value
Value of this reading.
- ReadingQualities
ReadingQuality All qualities of this reading.
-
final
case class
BaseVoltage(IdentifiedObject: IdentifiedObject = null, nominalVoltage: Double = 0.0, ConductingEquipment: List[String] = null, NetworkAssetDeployment: List[String] = null, TopologicalNode: List[String] = null, TransformerEnds: List[String] = null, VoltageLevel: List[String] = null) extends Element with Product with Serializable
Defines a system base voltage which is referenced.
Defines a system base voltage which is referenced.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- nominalVoltage
The power system resource's base voltage. Shall be a positive value and not zero.
- ConductingEquipment
ConductingEquipment All conducting equipment with this base voltage. Use only when there is no voltage level container used and only one base voltage applies. For example, not used for transformers.
- NetworkAssetDeployment
AssetDeployment A network asset deployment at this base voltage level.
- TopologicalNode
TopologicalNode The topological nodes at the base voltage.
- TransformerEnds
TransformerEnd Transformer ends at the base voltage. This is essential for PU calculation.
- VoltageLevel
VoltageLevel The voltage levels having this base voltage.
-
final
case class
BaseWork(Document: Document = null, kind: String = null, priority: String = null, statusKind: String = null, TimeSchedules: List[String] = null, WorkActivityRecords: List[String] = null, WorkLocation: String = null) extends Element with Product with Serializable
Common representation for work and work tasks.
Common representation for work and work tasks.
- Document
Document Reference to the superclass object.
- kind
Kind of work.
- priority
Priority of work.
- statusKind
Kind of work status.
- TimeSchedules
WorkTimeSchedule All time schedules for this work or work task.
- WorkActivityRecords
WorkActivityRecord All activity records for this work or work task.
- WorkLocation
WorkLocation Location for this work/task.
-
case class
BasicElement(Element: Element = null, mRID: String = null) extends Element with Product with Serializable
Top level element.
Top level element.
Not all elements really have an mRID (classes in package Common like PositionPoint and PostalAddress) But Spark needs identifiers for joins, so, for now all elements have an mRID.
- Element
Reference to the superclass object.
- mRID
Master resource identifier issued by a model authority. By convention, this is used as the RDF id in the CIM XML.
-
final
case class
BasicIntervalSchedule(IdentifiedObject: IdentifiedObject = null, startTime: String = null, value1Multiplier: String = null, value1Unit: String = null, value2Multiplier: String = null, value2Unit: String = null) extends Element with Product with Serializable
Schedule of values at points in time.
Schedule of values at points in time.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- startTime
The time for the first time point. The value can be a time of day, not a specific date.
- value1Multiplier
Multiplier for value1.
- value1Unit
Value1 units of measure.
- value2Multiplier
Multiplier for value2.
- value2Unit
Value2 units of measure.
-
final
case class
BatteryUnit(PowerElectronicsUnit: PowerElectronicsUnit = null, batteryState: String = null, ratedE: Double = 0.0, storedE: Double = 0.0) extends Element with Product with Serializable
An electrochemical energy storage device.
An electrochemical energy storage device.
- PowerElectronicsUnit
PowerElectronicsUnit Reference to the superclass object.
- batteryState
The current state of the battery (charging, full, etc.).
- ratedE
Full energy storage capacity of the battery. The attribute shall be a positive value.
- storedE
Amount of energy currently stored. The attribute shall be a positive value or zero and lower than BatteryUnit.ratedE.
-
final
case class
Bay(EquipmentContainer: EquipmentContainer = null, bayEnergyMeasFlag: Boolean = false, bayPowerMeasFlag: Boolean = false, breakerConfiguration: String = null, busBarConfiguration: String = null, Circuit: String = null, Substation: String = null, VoltageLevel: String = null) extends Element with Product with Serializable
A collection of power system resources (within a given substation) including conducting equipment, protection relays, measurements, and telemetry.
A collection of power system resources (within a given substation) including conducting equipment, protection relays, measurements, and telemetry.
A bay typically represents a physical grouping related to modularization of equipment.
- EquipmentContainer
EquipmentContainer Reference to the superclass object.
- bayEnergyMeasFlag
Indicates the presence/absence of energy measurements.
- bayPowerMeasFlag
Indicates the presence/absence of active/reactive power measurements.
- breakerConfiguration
Breaker configuration.
- busBarConfiguration
Busbar configuration.
- Circuit
Circuit undocumented
- Substation
Substation Substation containing the bay.
- VoltageLevel
VoltageLevel The voltage level containing this bay.
-
final
case class
Bid(Document: Document = null, marketType: String = null, startTime: String = null, stopTime: String = null, ActionRequest: String = null, BidHourlySchedule: List[String] = null, ChargeProfiles: List[String] = null, EnergyMarket: String = null, MarketParticipant: String = null, MitigatedBid: List[String] = null, MitigatedBidSegment: List[String] = null, ProductBids: List[String] = null, RMRDetermination: List[String] = null) extends Element with Product with Serializable
Represents both bids to purchase and offers to sell energy or ancillary services in an RTO-sponsored market.
Represents both bids to purchase and offers to sell energy or ancillary services in an RTO-sponsored market.
- Document
Document Reference to the superclass object.
- marketType
The market type, DAM or RTM.
- startTime
Start time and date for which bid applies.
- stopTime
Stop time and date for which bid is applicable.
- ActionRequest
ActionRequest undocumented
- BidHourlySchedule
BidHourlySchedule undocumented
- ChargeProfiles
ChargeProfile undocumented
- EnergyMarket
EnergyMarket undocumented
- MarketParticipant
MarketParticipant undocumented
- MitigatedBid
MitigatedBid undocumented
- MitigatedBidSegment
MitigatedBidSegment undocumented
- ProductBids
ProductBid A bid comprises one or more product bids of market products
- RMRDetermination
RMRDetermination undocumented
-
final
case class
BidDistributionFactor(Element: BasicElement = null, timeIntervalEnd: String = null, timeIntervalStart: String = null, PnodeDistributionFactor: List[String] = null, ProductBid: String = null) extends Element with Product with Serializable
This class allows SC to input different time intervals for distribution factors.
This class allows SC to input different time intervals for distribution factors.
- Element
Reference to the superclass object.
- timeIntervalEnd
End of the time interval n which bid is valid (yyyy-mm-dd hh24: mi: ss)
- timeIntervalStart
Start of the time interval in which bid is valid (yyyy-mm-dd hh24: mi: ss).
- PnodeDistributionFactor
PnodeDistributionFactor undocumented
- ProductBid
ProductBid undocumented
-
final
case class
BidError(IdentifiedObject: IdentifiedObject = null, componentType: String = null, endTime: String = null, errMessage: String = null, errPriority: Int = 0, logTimeStamp: String = null, msgLevel: Int = 0, ruleID: Int = 0, startTime: String = null, MarketProduct: String = null, ResourceBid: List[String] = null) extends Element with Product with Serializable
This class represent the error information for a bid that is detected during bid validation.
This class represent the error information for a bid that is detected during bid validation.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- componentType
undocumented
- endTime
hour wihthin the bid for which the error applies
- errMessage
error message
- errPriority
Priority number for the error message
- logTimeStamp
undocumented
- msgLevel
undocumented
- ruleID
undocumented
- startTime
hour wihthin the bid for which the error applies
- MarketProduct
MarketProduct undocumented
- ResourceBid
ResourceBid undocumented
-
final
case class
BidHourlyProductSchedule(RegularIntervalSchedule: RegularIntervalSchedule = null, ProductBid: String = null) extends Element with Product with Serializable
Containment for bid parameters that are dependent on a market product type.
Containment for bid parameters that are dependent on a market product type.
- RegularIntervalSchedule
RegularIntervalSchedule Reference to the superclass object.
- ProductBid
ProductBid undocumented
-
final
case class
BidHourlySchedule(RegularIntervalSchedule: RegularIntervalSchedule = null, Bid: String = null) extends Element with Product with Serializable
Containment for bid hourly parameters that are not product dependent.
Containment for bid hourly parameters that are not product dependent.
- RegularIntervalSchedule
RegularIntervalSchedule Reference to the superclass object.
- Bid
Bid undocumented
-
final
case class
BidPriceCap(Element: BasicElement = null, bidCeiling: Double = 0.0, bidCeilingAS: Double = 0.0, bidFloor: Double = 0.0, bidFloorAS: Double = 0.0, defaultPrice: Double = 0.0, marketType: String = null, MarketProduct: String = null) extends Element with Product with Serializable
This class represent the bid price cap.
This class represent the bid price cap.
- Element
Reference to the superclass object.
- bidCeiling
Bid Ceiling ($/MWH)
- bidCeilingAS
Bid Ceiling ($/MWH) for generic AS versus a specific market product
- bidFloor
Bid Floor, ($/MWH)
- bidFloorAS
Bid Floor ($/MWH) for generic AS versus a specific market product
- defaultPrice
Bid Default Price($/MWH)
- marketType
Market Type of the cap (DAM or RTM)
- MarketProduct
MarketProduct undocumented
-
final
case class
BidPriceCurve(Curve: Curve = null, BidSchedule: List[String] = null) extends Element with Product with Serializable
Relationship between unit operating price in $/hour (Y-axis) and unit output in MW (X-axis).
Relationship between unit operating price in $/hour (Y-axis) and unit output in MW (X-axis).
- Curve
Curve Reference to the superclass object.
- BidSchedule
BidPriceSchedule undocumented
-
final
case class
BidPriceSchedule(RegularIntervalSchedule: RegularIntervalSchedule = null, bidType: String = null, mitigationStatus: String = null, BidPriceCurve: String = null, ProductBid: String = null) extends Element with Product with Serializable
Defines bid schedules to allow a product bid to use specified bid price curves for different time intervals.
Defines bid schedules to allow a product bid to use specified bid price curves for different time intervals.
- RegularIntervalSchedule
RegularIntervalSchedule Reference to the superclass object.
- bidType
BID Type: I - Initial Bid; F - Final Bid
- mitigationStatus
Mitigation Status: 'S' - Mitigated by SMPM because of "misconduct" 'L; - Mitigated by LMPM because of "misconduct" 'R' - Modified by LMPM because of RMR rules 'M' - Mitigated because of "misconduct" both by SMPM and LMPM 'B' - Mitigated because of "misconduct" both by SMPM and modified by LMLM because of RMR rules 'O' - original
- BidPriceCurve
BidPriceCurve undocumented
- ProductBid
ProductBid undocumented
-
final
case class
BidSelfSched(RegularIntervalSchedule: RegularIntervalSchedule = null, balancingFlag: String = null, bidType: String = null, priorityFlag: String = null, pumpSelfSchedMw: Double = 0.0, referenceType: String = null, selfSchedMw: Double = 0.0, selfSchedSptResource: String = null, selfSchedType: String = null, updateType: String = null, wheelingTransactionReference: String = null, AdjacentCASet: String = null, HostControlArea: String = null, ProductBid: String = null, SubControlArea: String = null, TransmissionContractRight: String = null) extends Element with Product with Serializable
Defines self schedule values to be used for specified time intervals.
Defines self schedule values to be used for specified time intervals.
- RegularIntervalSchedule
RegularIntervalSchedule Reference to the superclass object.
- balancingFlag
This is a Y/N flag for a self-schedule of a resource per market per date and hour, using a specific TR ID. It indicates whether a self-schedule using a TR is balanced with another self-schedule using the same TR ID.
- bidType
bidType has two types as the required output of requirements and qualified pre-dispatch.
- priorityFlag
This is a Y/N flag for a self-schedule of a resource per market per date and hour, using a specific TR ID. It indicates whether a self-schedule using a TR has scheduling priority in DAM/RTM.
- pumpSelfSchedMw
Contains the PriceTaker, ExistingTransmissionContract, TransmissionOwnershipRights pumping self schedule quantity. If this value is not null, then the unit is in pumping mode.
- referenceType
Indication of which type of self schedule is being referenced.
- selfSchedMw
Self scheduled value
- selfSchedSptResource
Price Taker Export Self Sched Support Resource
- selfSchedType
This attribute is used to specify if a bid includes a self sched bid. If so what self sched type is it. The possible values are shown as follow but not limited to: 'ETC' - Existing transmission contract 'TOR' - Transmission ownership right 'RMR' - Reliability must run 'RGMR' - Regulatory must run "RMT" - Relaiability must take "PT" - Price taker "LPT" - Low price taker "SP" - Self provision "RA" - Resource adequacy This attribute is originally defined in the BidSelfSched class
- updateType
undocumented
- wheelingTransactionReference
A unique identifier of a wheeling transaction. A wheeling transaction is a balanced Energy exchange among Supply and Demand Resources.
- AdjacentCASet
AdjacentCASet undocumented
- HostControlArea
HostControlArea undocumented
- ProductBid
ProductBid undocumented
- SubControlArea
SubControlArea undocumented
- TransmissionContractRight
ContractRight undocumented
-
final
case class
BidSet(IdentifiedObject: IdentifiedObject = null, GeneratingBids: List[String] = null) extends Element with Product with Serializable
As set of mutually exclusive bids for which a maximum of one may be scheduled.
As set of mutually exclusive bids for which a maximum of one may be scheduled.
Of these generating bids, only one generating bid can be scheduled at a time.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- GeneratingBids
GeneratingBid undocumented
-
final
case class
BidTimeSeries(TimeSeries: TimeSeries = null, blockBid: String = null, direction: String = null, divisible: String = null, exclusiveBidsIdentification: String = null, linkedBidsIdentification: String = null, minimumActivationQuantity: Double = 0.0, priority: Int = 0, status: String = null, stepIncrementQuantity: Double = 0.0) extends Element with Product with Serializable
The formal specification of specific characteristics related to a bid.
The formal specification of specific characteristics related to a bid.
- TimeSeries
TimeSeries Reference to the superclass object.
- blockBid
Indication that the values in the period are considered as a whole. They cannot be changed or subdivided.
- direction
The coded identification of the energy flow.
- divisible
An indication whether or not each element of the bid may be partially accepted or not.
- exclusiveBidsIdentification
Unique identification associated with all linked tenders. The identification of a set of tenders that are linked together signifying that only one can be accepted. This identification is defined by the tenderer and must be unique for a given auction.
- linkedBidsIdentification
Unique identification associated with all linked bids.
- minimumActivationQuantity
The minimum quantity of energy that can be activated at a given time interval.
- priority
The numeric local priority given to a bid. Lower numeric values will have higher priority.
- status
The information about the status of the bid, such as "shared", "restricted", ...
- stepIncrementQuantity
The minimum increment that can be applied for an increase in an activation request.
-
final
case class
BilateralExchangeActor(IdentifiedObject: IdentifiedObject = null, CommunicationLink: List[String] = null, ConsumerBilateralExchange: List[String] = null, ProvidedBilateralIOPoint: List[String] = null, ProviderBilateralExchange: List[String] = null) extends Element with Product with Serializable
BilateralExchangeActor describes an actor that provides ICCP data, consumes ICCP data or both.
BilateralExchangeActor describes an actor that provides ICCP data, consumes ICCP data or both.
The ICCP data provider lists the data it makes available to an ICCP data consumer. This data is described by ProvidedBilateralPoints. The relation between an ICCP data provider and a consumer is established by a BilateralExchangeAgreement. It is up to the ICCP data consumer to select what ProvidedBilateralPoints to use. The selection made is not described in this information model.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- CommunicationLink
CommunicationLink Communication addressing for a Bilateral Table used by a ICCP data provider or consumer.
- ConsumerBilateralExchange
BilateralExchangeAgreement Agreement to information subscriber.
- ProvidedBilateralIOPoint
ProvidedBilateralPoint ICCP information in a Bilateral table that will be exposed to a remote peer.
- ProviderBilateralExchange
BilateralExchangeAgreement Agreement to information provider.
-
final
case class
BilateralExchangeAgreement(IdentifiedObject: IdentifiedObject = null, Consumer: String = null, Provider: String = null) extends Element with Product with Serializable
This is the representation of the information exchange agreement between peers.
This is the representation of the information exchange agreement between peers.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- Consumer
BilateralExchangeActor Subscriber of information from a remote peer.
- Provider
BilateralExchangeActor Provider of information to a remote peer.
-
final
case class
BilateralTransaction(Element: BasicElement = null, curtailTimeMax: Int = 0, curtailTimeMin: Int = 0, marketType: String = null, purchaseTimeMax: Int = 0, purchaseTimeMin: Int = 0, scope: String = null, totalTranChargeMax: Double = 0.0, transactionType: String = null) extends Element with Product with Serializable
Bilateral transaction
Bilateral transaction
- Element
Reference to the superclass object.
- curtailTimeMax
Maximum curtailment time in number of trading intervals
- curtailTimeMin
Minimum curtailment time in number of trading intervals
- marketType
Market type (default=DA) DA - Day Ahead RT - Real Time HA - Hour Ahead
- purchaseTimeMax
Maximum purchase time in number of trading intervals
- purchaseTimeMin
Minimum purchase time in number of trading intervals
- scope
Transaction scope: 'Internal' (default) 'External'
- totalTranChargeMax
Maximum total transmission (congestion) charges in monetary units
- transactionType
Transaction type (default 1) 1 - Fixed 2 - Dispatchable continuous 3 - Dispatchable block-loading
-
final
case class
BillDeterminant(Document: Document = null, calculationLevel: String = null, configVersion: String = null, deleteStatus: String = null, effectiveDate: String = null, exception: String = null, factor: String = null, frequency: String = null, numberInterval: Int = 0, offset: String = null, precisionLevel: String = null, primaryYN: String = null, referenceFlag: String = null, reportable: String = null, roundOff: String = null, source: String = null, terminationDate: String = null, unitOfMeasure: String = null, ChargeComponents: List[String] = null, ChargeProfile: String = null, ChargeProfileData: List[String] = null, MktUserAttribute: List[String] = null) extends Element with Product with Serializable
Models various charges to support billing and settlement.
Models various charges to support billing and settlement.
- Document
Document Reference to the superclass object.
- calculationLevel
Level in charge calculation order.
- configVersion
The version of configuration of calculation logic in the settlement.
- deleteStatus
undocumented
- effectiveDate
undocumented
- exception
undocumented
- factor
undocumented
- frequency
undocumented
- numberInterval
Number of intervals of bill determiant in trade day, e.g. 300 for five minute intervals.
- offset
undocumented
- precisionLevel
The level of precision in the current value.
- primaryYN
undocumented
- referenceFlag
undocumented
- reportable
undocumented
- roundOff
undocumented
- source
undocumented
- terminationDate
undocumented
- unitOfMeasure
The UOM for the current value of the Bill Determinant.
- ChargeComponents
ChargeComponent A BillDeterminant can have 0-n ChargeComponent and a ChargeComponent can associate to 0-n BillDeterminant.
- ChargeProfile
ChargeProfile undocumented
- ChargeProfileData
ChargeProfileData undocumented
- MktUserAttribute
MktUserAttribute undocumented
- final case class BlockDispatchComponent(EnergyComponent: EnergyComponent = null) extends Element with Product with Serializable
- final case class BlockDispatchInstruction(IdentifiedObject: IdentifiedObject = null) extends Element with Product with Serializable
- final case class BlockDispatchOrder(IdentifiedObject: IdentifiedObject = null, p: Double = 0.0, sequence: Int = 0) extends Element with Product with Serializable
- final case class BlockingFunction(Element: BasicElement = null, Delay: String = null, VSCtype1: String = null) extends Element with Product with Serializable
-
final
case class
BranchEndFlow(Element: BasicElement = null, loadDumpRating: Double = 0.0, longTermRating: Double = 0.0, mVARFlow: Double = 0.0, mwFlow: Double = 0.0, normalRating: Double = 0.0, shortTermRating: Double = 0.0, MktACLineSegmentEndAFlow: List[String] = null, MktACLineSegmentEndBFlow: List[String] = null, MktPowerTransformerEndAFlow: List[String] = null, MktPowerTransformerEndBFlow: List[String] = null, MktSeriesCompensatorEndBFlow: List[String] = null, MktSeriresCompensatorEndAFlow: List[String] = null) extends Element with Product with Serializable
Dynamic flows and ratings associated with a branch end.
Dynamic flows and ratings associated with a branch end.
- Element
Reference to the superclass object.
- loadDumpRating
The Load Dump Rating for the branch
- longTermRating
The Long Term Rating for the branch
- mVARFlow
The MVAR flow on the branch Attribute Usage: Reactive power flow at the series device, transformer, phase shifter, or line end
- mwFlow
The MW flow on the branch Attribute Usage: Active power flow at the series device, transformer, phase shifter, or line end
- normalRating
The Normal Rating for the branch
- shortTermRating
The Short Term Rating for the branch
- MktACLineSegmentEndAFlow
MktACLineSegment undocumented
- MktACLineSegmentEndBFlow
MktACLineSegment undocumented
- MktPowerTransformerEndAFlow
MktPowerTransformer undocumented
- MktPowerTransformerEndBFlow
MktPowerTransformer undocumented
- MktSeriesCompensatorEndBFlow
MktSeriesCompensator undocumented
- MktSeriresCompensatorEndAFlow
MktSeriesCompensator undocumented
-
final
case class
BranchGroup(IdentifiedObject: IdentifiedObject = null, maximumActivePower: Double = 0.0, maximumReactivePower: Double = 0.0, minimumActivePower: Double = 0.0, minimumReactivePower: Double = 0.0, monitorActivePower: Boolean = false, monitorReactivePower: Boolean = false, BranchGroupTerminal: List[String] = null, PinBranchGroup: List[String] = null) extends Element with Product with Serializable
A group of branch terminals whose directed flow summation is to be monitored.
A group of branch terminals whose directed flow summation is to be monitored.
A branch group need not form a cutset of the network.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- maximumActivePower
The maximum active power flow.
- maximumReactivePower
The maximum reactive power flow.
- minimumActivePower
The minimum active power flow.
- minimumReactivePower
The minimum reactive power flow.
- monitorActivePower
Monitor the active power flow.
- monitorReactivePower
Monitor the reactive power flow.
- BranchGroupTerminal
BranchGroupTerminal The directed branch group terminals to be summed.
- PinBranchGroup
PinBranchGroup undocumented
-
final
case class
BranchGroupTerminal(Element: BasicElement = null, positiveFlowIn: Boolean = false, BranchGroup: String = null, Terminal: String = null) extends Element with Product with Serializable
A specific directed terminal flow for a branch group.
A specific directed terminal flow for a branch group.
- Element
Reference to the superclass object.
- positiveFlowIn
The flow into the terminal is summed if set true. The flow out of the terminal is summed if set false.
- BranchGroup
BranchGroup The branch group to which the directed branch group terminals belong.
- Terminal
Terminal The terminal to be summed.
-
final
case class
Breaker(ProtectedSwitch: ProtectedSwitch = null, inTransitTime: Double = 0.0) extends Element with Product with Serializable
A mechanical switching device capable of making, carrying, and breaking currents under normal circuit conditions and also making, carrying for a specified time, and breaking currents under specified abnormal circuit conditions e.g.
A mechanical switching device capable of making, carrying, and breaking currents under normal circuit conditions and also making, carrying for a specified time, and breaking currents under specified abnormal circuit conditions e.g. those of short circuit.
- ProtectedSwitch
ProtectedSwitch Reference to the superclass object.
- inTransitTime
The transition time from open to close.
-
final
case class
BreakerInfo(OldSwitchInfo: OldSwitchInfo = null, phaseTrip: Double = 0.0) extends Element with Product with Serializable
Properties of breaker assets.
Properties of breaker assets.
- OldSwitchInfo
OldSwitchInfo Reference to the superclass object.
- phaseTrip
Phase trip rating.
-
final
case class
BusNameMarker(IdentifiedObject: IdentifiedObject = null, priority: Int = 0, ReportingGroup: String = null, Terminal: List[String] = null, TopologicalNode: String = null) extends Element with Product with Serializable
Used to apply user standard names to TopologicalNodes.
Used to apply user standard names to TopologicalNodes.
Associated with one or more terminals that are normally connected with the bus name. The associated terminals are normally connected by non-retained switches. For a ring bus station configuration, all BusbarSection terminals in the ring are typically associated. For a breaker and a half scheme, both BusbarSections would normally be associated. For a ring bus, all BusbarSections would normally be associated. For a "straight" busbar configuration, normally only the main terminal at the BusbarSection would be associated.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- priority
Priority of bus name marker for use as topology bus name. Use 0 for do not care. Use 1 for highest priority. Use 2 as priority is less than 1 and so on.
- ReportingGroup
ReportingGroup The reporting group to which this bus name marker belongs.
- Terminal
ACDCTerminal The terminals associated with this bus name marker.
- TopologicalNode
TopologicalNode A user defined topological node that was originally defined in a planning model not yet having topology described by ConnectivityNodes. Once ConnectivityNodes has been created they may linked to user defined ToplogicalNdes using BusNameMarkers.
-
final
case class
BusbarSection(Connector: Connector = null, ipMax: Double = 0.0, VoltageControlZone: String = null) extends Element with Product with Serializable
A conductor, or group of conductors, with negligible impedance, that serve to connect other conducting equipment within a single substation.
A conductor, or group of conductors, with negligible impedance, that serve to connect other conducting equipment within a single substation.
Voltage measurements are typically obtained from voltage transformers that are connected to busbar sections. A bus bar section may have many physical terminals but for analysis is modelled with exactly one logical terminal.
- Connector
Connector Reference to the superclass object.
- ipMax
Maximum allowable peak short-circuit current of busbar (Ipmax in IEC 60909-0). Mechanical limit of the busbar in the substation itself. Used for short circuit data exchange according to IEC 60909.
- VoltageControlZone
VoltageControlZone A VoltageControlZone is controlled by a designated BusbarSection.
-
final
case class
BusbarSectionInfo(AssetInfo: AssetInfo = null, ratedCurrent: Double = 0.0, ratedVoltage: Double = 0.0) extends Element with Product with Serializable
Busbar section data.
Busbar section data.
- AssetInfo
AssetInfo Reference to the superclass object.
- ratedCurrent
Rated current.
- ratedVoltage
Rated voltage.
-
final
case class
Bushing(Asset: Asset = null, BushingInsulationPFs: List[String] = null, FixedContact: String = null, MovingContact: String = null, Terminal: String = null) extends Element with Product with Serializable
Bushing asset.
Bushing asset.
- Asset
Asset Reference to the superclass object.
- BushingInsulationPFs
BushingInsulationPF undocumented
- FixedContact
InterrupterUnit Fixed contact of interrupter to which this bushing is attached.
- MovingContact
InterrupterUnit Moving contact of interrupter to which this bushing is attached.
- Terminal
Terminal Terminal to which this bushing is attached.
-
final
case class
BushingInfo(AssetInfo: AssetInfo = null, c1Capacitance: Double = 0.0, c1PowerFactor: Double = 0.0, c2Capacitance: Double = 0.0, c2PowerFactor: Double = 0.0, insulationKind: String = null, ratedCurrent: Double = 0.0, ratedImpulseWithstandVoltage: Double = 0.0, ratedLineToGroundVoltage: Double = 0.0, ratedVoltage: Double = 0.0) extends Element with Product with Serializable
Bushing datasheet information.
Bushing datasheet information.
- AssetInfo
AssetInfo Reference to the superclass object.
- c1Capacitance
Factory measured capacitance, measured between the power factor tap and the bushing conductor.
- c1PowerFactor
Factory measured insulation power factor, measured between the power factor tap and the bushing conductor.
- c2Capacitance
Factory measured capacitance measured between the power factor tap and ground.
- c2PowerFactor
Factory measured insulation power factor, measured between the power factor tap and ground.
- insulationKind
Kind of insulation.
- ratedCurrent
Rated current for bushing as installed.
- ratedImpulseWithstandVoltage
Rated impulse withstand voltage, also known as BIL (Basic Impulse Level).
- ratedLineToGroundVoltage
Rated line-to-ground voltage. Also referred to as Uy on bushing nameplate.
- ratedVoltage
Rated voltage. Can be referred to as Um, system voltage or class on bushing nameplate.
-
final
case class
BushingInsulationPF(IdentifiedObject: IdentifiedObject = null, status: String = null, testKind: String = null, Bushing: String = null, TransformerObservation: String = null) extends Element with Product with Serializable
Bushing insulation power factor condition as a result of a test.
Bushing insulation power factor condition as a result of a test.
Typical status values are: Acceptable, Minor Deterioration or Moisture Absorption, Major Deterioration or Moisture Absorption, Failed.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- status
undocumented
- testKind
Kind of test for this bushing.
- Bushing
Bushing undocumented
- TransformerObservation
TransformerObservation undocumented
-
final
case class
BusinessCase(WorkDocument: WorkDocument = null, corporateCode: String = null, Projects: List[String] = null, Works: List[String] = null) extends Element with Product with Serializable
Business justification for capital expenditures, usually addressing operations and maintenance costs as well.
Business justification for capital expenditures, usually addressing operations and maintenance costs as well.
- WorkDocument
WorkDocument Reference to the superclass object.
- corporateCode
A codified representation of the business case (i.e., codes for highway relocation, replace substation transformers, etc.).
- Projects
Project undocumented
- Works
Work undocumented
-
final
case class
BusinessPlan(Document: Document = null) extends Element with Product with Serializable
A BusinessPlan is an organized sequence of predetermined actions required to complete a future organizational objective.
A BusinessPlan is an organized sequence of predetermined actions required to complete a future organizational objective.
It is a type of document that typically references a schedule, physical and/or logical resources (assets and/or PowerSystemResources), locations, etc.
- Document
Document Reference to the superclass object.
-
final
case class
BusinessRole(OrganisationRole: OrganisationRole = null, status: String = null, type: String = null) extends Element with Product with Serializable
A business role that this organisation plays.
A business role that this organisation plays.
A single organisation typically performs many functions, each one described as a role.
- OrganisationRole
OrganisationRole Reference to the superclass object.
- status
undocumented
- type
Classification by utility's corporate standards and practices.
-
final
case class
CAESPlant(PowerSystemResource: PowerSystemResource = null, energyStorageCapacity: Double = 0.0, ratedCapacityP: Double = 0.0, AirCompressor: String = null, ThermalGeneratingUnit: String = null) extends Element with Product with Serializable
Compressed air energy storage plant.
Compressed air energy storage plant.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- energyStorageCapacity
The rated energy storage capacity. The attribute shall be a positive value.
- ratedCapacityP
The CAES plant's gross rated generating capacity. The attribute shall be a positive value.
- AirCompressor
AirCompressor An air compressor may be a member of a compressed air energy storage plant.
- ThermalGeneratingUnit
ThermalGeneratingUnit A thermal generating unit may be a member of a compressed air energy storage plant.
- final case class CCAinverter(Element: BasicElement = null) extends Element with Product with Serializable
- final case class CCArectifierControl(Element: BasicElement = null) extends Element with Product with Serializable
-
final
case class
CIGREStandard(Element: BasicElement = null, standardEdition: String = null, standardNumber: String = null) extends Element with Product with Serializable
Standard published by CIGRE (Council on Large Electric Systems).
Standard published by CIGRE (Council on Large Electric Systems).
- Element
Reference to the superclass object.
- standardEdition
Edition of CIGRE standard.
- standardNumber
CIGRE standard number.
-
final
case class
CRRMarket(Market: Market = null, labelID: String = null, CongestionRevenueRight: List[String] = null) extends Element with Product with Serializable
Model that describes the Congestion Revenue Rights Auction Market.
Model that describes the Congestion Revenue Rights Auction Market.
- Market
Market Reference to the superclass object.
- labelID
labelID - an ID for a set of apnodes/pnodes used in a CRR market
- CongestionRevenueRight
CongestionRevenueRight undocumented
-
final
case class
CRROrgRole(OrganisationRole: OrganisationRole = null, kind: String = null, status: String = null, CongestionRevenueRight: String = null) extends Element with Product with Serializable
Identifies a way in which an organisation may participate with a defined Congestion Revenue Right (CRR).
Identifies a way in which an organisation may participate with a defined Congestion Revenue Right (CRR).
- OrganisationRole
OrganisationRole Reference to the superclass object.
- kind
Kind of role the organisation is with regards to the congestion revenue rights.
- status
Status of congestion revenue rights organisation role.
- CongestionRevenueRight
CongestionRevenueRight undocumented
-
final
case class
CRRSegment(IdentifiedObject: IdentifiedObject = null, amount: Double = 0.0, clearingPrice: Double = 0.0, endDateTime: String = null, quantity: Double = 0.0, startDateTime: String = null, CongestionRevenueRight: String = null, Sink: List[String] = null, Source: List[String] = null) extends Element with Product with Serializable
CRRSegment represents a segment of a CRR in a particular time frame.
CRRSegment represents a segment of a CRR in a particular time frame.
The segment class contains amount, clearing price, start date and time, end date and time.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- amount
Dollar amount = quantity x clearingPrice
- clearingPrice
Clearing price of a CRR
- endDateTime
segment end date time
- quantity
The MW amount associated with the CRR
- startDateTime
segment start date time
- CongestionRevenueRight
CongestionRevenueRight undocumented
- Sink
Pnode undocumented
- Source
Pnode undocumented
-
final
case class
CSCDynamics(HVDCDynamics: HVDCDynamics = null, CSConverter: String = null) extends Element with Product with Serializable
CSC function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
CSC function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
- HVDCDynamics
HVDCDynamics Reference to the superclass object.
- CSConverter
CsConverter Current source converter to which current source converter dynamics model applies.
-
final
case class
CSCUserDefined(CSCDynamics: CSCDynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Current source converter (CSC) function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
Current source converter (CSC) function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
- CSCDynamics
CSCDynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
- final case class CSCtype1(CSCDynamics: CSCDynamics = null) extends Element with Product with Serializable
-
final
case class
CTTempActivePowerCurve(Curve: Curve = null, CombustionTurbine: String = null) extends Element with Product with Serializable
Relationship between the combustion turbine's power output rating in gross active power (X-axis) and the ambient air temperature (Y-axis).
Relationship between the combustion turbine's power output rating in gross active power (X-axis) and the ambient air temperature (Y-axis).
- Curve
Curve Reference to the superclass object.
- CombustionTurbine
CombustionTurbine A combustion turbine may have an active power versus ambient temperature relationship.
-
final
case class
CUAllowableAction(WorkIdentifiedObject: WorkIdentifiedObject = null, status: String = null, CompatibleUnits: List[String] = null) extends Element with Product with Serializable
Allowed actions: Install, Remove, Transfer, Abandon, etc.
Allowed actions: Install, Remove, Transfer, Abandon, etc.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- status
undocumented
- CompatibleUnits
CompatibleUnit undocumented
-
final
case class
CUContractorItem(WorkIdentifiedObject: WorkIdentifiedObject = null, activityCode: String = null, bidAmount: Double = 0.0, status: String = null, CompatibleUnits: List[String] = null) extends Element with Product with Serializable
Compatible unit contractor item.
Compatible unit contractor item.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- activityCode
Activity code identifies a specific and distinguishable unit of work.
- bidAmount
The amount that a given contractor will charge for performing this unit of work.
- status
undocumented
- CompatibleUnits
CompatibleUnit undocumented
-
final
case class
CUGroup(WorkIdentifiedObject: WorkIdentifiedObject = null, status: String = null, ChildCUGroups: List[String] = null, CompatibleUnits: List[String] = null, DesignLocationCUs: List[String] = null, ParentCUGroups: List[String] = null) extends Element with Product with Serializable
A Compatible Unit Group identifies a set of compatible units which may be jointly utilized for estimating and designating jobs.
A Compatible Unit Group identifies a set of compatible units which may be jointly utilized for estimating and designating jobs.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- status
undocumented
- ChildCUGroups
CUGroup undocumented
- CompatibleUnits
CompatibleUnit undocumented
- DesignLocationCUs
DesignLocationCU undocumented
- ParentCUGroups
CUGroup undocumented
-
final
case class
CULaborCode(WorkIdentifiedObject: WorkIdentifiedObject = null, code: String = null, status: String = null, CULaborItems: List[String] = null) extends Element with Product with Serializable
Labor code associated with various compatible unit labor items.
Labor code associated with various compatible unit labor items.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- code
Labor code.
- status
undocumented
- CULaborItems
CULaborItem undocumented
-
final
case class
CULaborItem(WorkIdentifiedObject: WorkIdentifiedObject = null, activityCode: String = null, laborDuration: Double = 0.0, laborRate: Double = 0.0, status: String = null, CULaborCode: String = null, CompatibleUnits: List[String] = null, QualificationRequirements: List[String] = null) extends Element with Product with Serializable
Compatible unit labor item.
Compatible unit labor item.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- activityCode
Activity code identifies a specific and distinguishable unit of work.
- laborDuration
Estimated time to perform work.
- laborRate
The labor rate applied for work.
- status
undocumented
- CULaborCode
CULaborCode undocumented
- CompatibleUnits
CompatibleUnit undocumented
- QualificationRequirements
QualificationRequirement undocumented
-
final
case class
CUMaterialItem(WorkIdentifiedObject: WorkIdentifiedObject = null, corporateCode: String = null, quantity: String = null, status: String = null, CompatibleUnits: List[String] = null, PropertyUnits: List[String] = null, TypeMaterial: String = null) extends Element with Product with Serializable
Compatible unit of a consumable supply item.
Compatible unit of a consumable supply item.
For example, nuts, bolts, brackets, glue, etc.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- corporateCode
Code for material.
- quantity
Quantity of the TypeMaterial for this CU, used to determine estimated costs based on a per unit cost or a cost per unit length specified in the TypeMaterial.
- status
undocumented
- CompatibleUnits
CompatibleUnit undocumented
- PropertyUnits
PropertyUnit undocumented
- TypeMaterial
TypeMaterial undocumented
-
final
case class
CUWorkEquipmentItem(WorkIdentifiedObject: WorkIdentifiedObject = null, equipCode: String = null, rate: Double = 0.0, status: String = null, CompatibleUnits: List[String] = null, TypeAsset: String = null) extends Element with Product with Serializable
Compatible unit for various types of WorkEquipmentAssets, including vehicles.
Compatible unit for various types of WorkEquipmentAssets, including vehicles.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- equipCode
The equipment type code.
- rate
Standard usage rate for the type of vehicle.
- status
undocumented
- CompatibleUnits
CompatibleUnit undocumented
- TypeAsset
WorkAsset undocumented
-
final
case class
Cabinet(AssetContainer: AssetContainer = null) extends Element with Product with Serializable
Enclosure that offers protection to the equipment it contains and/or safety to people/animals outside it.
Enclosure that offers protection to the equipment it contains and/or safety to people/animals outside it.
- AssetContainer
AssetContainer Reference to the superclass object.
-
final
case class
CableInfo(WireInfo: WireInfo = null, constructionKind: String = null, diameterOverCore: Double = 0.0, diameterOverInsulation: Double = 0.0, diameterOverJacket: Double = 0.0, diameterOverScreen: Double = 0.0, isStrandFill: Boolean = false, nominalTemperature: Double = 0.0, outerJacketKind: String = null, sheathAsNeutral: Boolean = false, shieldMaterial: String = null) extends Element with Product with Serializable
Cable data.
Cable data.
- WireInfo
WireInfo Reference to the superclass object.
- constructionKind
Kind of construction of this cable.
- diameterOverCore
Diameter over the core, including any semi-con screen; should be the insulating layer's inside diameter.
- diameterOverInsulation
Diameter over the insulating layer, excluding outer screen.
- diameterOverJacket
Diameter over the outermost jacketing layer.
- diameterOverScreen
Diameter over the outer screen; should be the shield's inside diameter.
- isStrandFill
True if wire strands are extruded in a way to fill the voids in the cable.
- nominalTemperature
Maximum nominal design operating temperature.
- outerJacketKind
Kind of outer jacket of this cable.
- sheathAsNeutral
True if sheath / shield is used as a neutral (i.e., bonded).
- shieldMaterial
Material of the shield.
-
final
case class
CalculationMethodHierarchy(IdentifiedObject: IdentifiedObject = null, CalculationMethodOrder: List[String] = null, Measurement: List[String] = null, MeasurementValue: String = null) extends Element with Product with Serializable
The hierarchy of calculation methods used to derive this measurement.
The hierarchy of calculation methods used to derive this measurement.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- CalculationMethodOrder
CalculationMethodOrder Order of a statistical calculation associated with this calculation method hierarchy.
- Measurement
Measurement Measurement to which this calculation method hierarchy applies.
- MeasurementValue
MeasurementValue Measurement value to which this calculation method hierarchy applies.
-
final
case class
CalculationMethodOrder(Element: BasicElement = null, order: Int = 0, CalculationMethodHierarchy: String = null, StatisicalCalculation: String = null) extends Element with Product with Serializable
The order of this calculation method in a hierarchy of calculation methods.
The order of this calculation method in a hierarchy of calculation methods.
- Element
Reference to the superclass object.
- order
Order of the statistical calculation method within the calculation method hierarchy.
- CalculationMethodHierarchy
CalculationMethodHierarchy The calculation method hierarchy of which this order of statistical calculation is a member.
- StatisicalCalculation
StatisticalCalculation The statistical calculation done at this order.
-
final
case class
Capability(WorkIdentifiedObject: WorkIdentifiedObject = null, performanceFactor: String = null, status: String = null, type: String = null, validityInterval: String = null, Crafts: List[String] = null, Crew: String = null, WorkTasks: List[String] = null) extends Element with Product with Serializable
Capabilities of a crew.
Capabilities of a crew.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- performanceFactor
Capability performance factor.
- status
undocumented
- type
Classification by utility's work management standards and practices.
- validityInterval
Date and time interval for which this capability is valid (when it became effective and when it expires).
- Crafts
Craft undocumented
- Crew
OldCrew undocumented
- WorkTasks
OldWorkTask undocumented
-
final
case class
Card(Element: BasicElement = null, accountHolderName: String = null, cvNumber: String = null, expiryDate: String = null, pan: String = null, Tender: String = null) extends Element with Product with Serializable
Documentation of the tender when it is a type of card (credit, debit, etc).
Documentation of the tender when it is a type of card (credit, debit, etc).
- Element
Reference to the superclass object.
- accountHolderName
Name of account holder.
- cvNumber
The card verification number.
- expiryDate
The date when this card expires.
- pan
The primary account number.
- Tender
Tender Payment tender this card is being used for.
-
final
case class
Cashier(IdentifiedObject: IdentifiedObject = null, electronicAddress: String = null, CashierShifts: List[String] = null) extends Element with Product with Serializable
The operator of the point of sale for the duration of CashierShift.
The operator of the point of sale for the duration of CashierShift.
Cashier is under the exclusive management control of Vendor.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- electronicAddress
Electronic address.
- CashierShifts
CashierShift All shifts operated by this cashier.
-
final
case class
CashierShift(Shift: Shift = null, cashFloat: Double = 0.0, Cashier: String = null, PointOfSale: String = null, Receipts: List[String] = null, Transactions: List[String] = null) extends Element with Product with Serializable
The operating shift for a cashier, during which the cashier may transact against the cashier shift, subject to vendor shift being open.
The operating shift for a cashier, during which the cashier may transact against the cashier shift, subject to vendor shift being open.
- Shift
Shift Reference to the superclass object.
- cashFloat
The amount of cash that the cashier brings to start the shift and that will be taken away at the end of the shift; i.e. the cash float does not get banked.
- Cashier
Cashier Cashier operating this shift.
- PointOfSale
PointOfSale Point of sale that is in operation during this shift.
- Receipts
Receipt All Receipts recorded for this Shift.
- Transactions
Transaction All transactions recorded during this cashier shift.
-
final
case class
CatalogAssetType(IdentifiedObject: IdentifiedObject = null, estimatedUnitCost: Double = 0.0, kind: String = null, quantity: String = null, stockItem: Boolean = false, type: String = null, AssetInfo: String = null, CompatibleUnits: List[String] = null, ErpBomItemDatas: List[String] = null, ErpInventoryIssues: List[String] = null, ErpReqLineItems: List[String] = null, ProductAssetModel: List[String] = null, TypeAssetCatalogue: String = null) extends Element with Product with Serializable
a Assets that may be used for planning, work or design purposes.
a Assets that may be used for planning, work or design purposes.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- estimatedUnitCost
Estimated unit cost (or cost per unit length) of this type of asset. It does not include labor to install, construct or configure it.
- kind
Kind of asset (from enumerated list).
- quantity
The value, unit of measure, and multiplier for the quantity.
- stockItem
True if item is a stock item (default).
- type
Description of type of asset.
- AssetInfo
AssetInfo Generic nameplate information associated with this catalog asset type.
- CompatibleUnits
CompatibleUnit undocumented
- ErpBomItemDatas
ErpBomItemData undocumented
- ErpInventoryIssues
ErpIssueInventory undocumented
- ErpReqLineItems
ErpReqLineItem undocumented
- ProductAssetModel
ProductAssetModel Product asset model conforming to this catalog asset type.
- TypeAssetCatalogue
TypeAssetCatalogue undocumented
-
final
case class
ChangeSet(DataSet: DataSet = null, ChangeSetMember: List[String] = null, IncrementalDatasetArg: List[String] = null, NMProjectStage: String = null, NetworkModelProjectChangeVersion: List[String] = null) extends Element with Product with Serializable
Describes a set of changes that can be applied in different situations.
Describes a set of changes that can be applied in different situations.
A given registered target object MRID may only be referenced once by the contained change set members.
- DataSet
DataSet Reference to the superclass object.
- ChangeSetMember
ChangeSetMember Data objects contained in the dataset.
- IncrementalDatasetArg
IncrementalDatasetArg undocumented
- NMProjectStage
NetworkModelProjectStage undocumented
- NetworkModelProjectChangeVersion
NetworkModelProjectChangeVersion The project of the details of model changes.
-
final
case class
ChangeSetMember(Element: BasicElement = null, Changeset: String = null, PropertiesObject: String = null, TargetObject: String = null) extends Element with Product with Serializable
A CRUD-style data object.
A CRUD-style data object.
- Element
Reference to the superclass object.
- Changeset
ChangeSet Dataset containing the data objects.
- PropertiesObject
IdentifiedObject The CIM object holding the properties of this dataset context. Sometimes properties are not required and only the reference to the registered object is required.
- TargetObject
IdentifiedObject The registered CIM object.
-
final
case class
Channel(IdentifiedObject: IdentifiedObject = null, isVirtual: Boolean = false, ReadingType: String = null, Register: String = null) extends Element with Product with Serializable
A single path for the collection or reporting of register values over a period of time.
A single path for the collection or reporting of register values over a period of time.
For example, a register which measures forward energy can have two channels, one providing bulk quantity readings and the other providing interval readings of a fixed interval size.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- isVirtual
If true, the data is being calculated by an enterprise system rather than metered directly.
- ReadingType
ReadingType Reading type for register values reported/collected by this channel.
- Register
Register Register whose values are collected/reported by this channel.
-
final
case class
Charge(IdentifiedObject: IdentifiedObject = null, fixedPortion: String = null, kind: String = null, variablePortion: Double = 0.0, AuxiliaryAccounts: List[String] = null, ChildCharges: List[String] = null, ConsumptionTariffIntervals: List[String] = null, ParentCharge: String = null, TimeTariffIntervals: List[String] = null) extends Element with Product with Serializable
A charge element associated with other entities such as tariff structures, auxiliary agreements or other charge elements.
A charge element associated with other entities such as tariff structures, auxiliary agreements or other charge elements.
The total charge amount applicable to this instance of charge is the sum of fixed and variable portion.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- fixedPortion
AccountingUnit The fixed portion of this charge element.
- kind
The kind of charge to be applied.
- variablePortion
The variable portion of this charge element, calculated as a percentage of the total amount of a parent charge.
- AuxiliaryAccounts
AuxiliaryAccount All auxiliary accounts to which this charge has to be levied.
- ChildCharges
Charge All sub-components of this complex charge.
- ConsumptionTariffIntervals
ConsumptionTariffInterval Tariff intervals to which this consumption-based charge has to be levied.
- ParentCharge
Charge Parent of this charge sub-component.
- TimeTariffIntervals
TimeTariffInterval Tariff intervals to which this time-based charge has to be levied.
-
final
case class
ChargeComponent(IdentifiedObject: IdentifiedObject = null, deleteStatus: String = null, effectiveDate: String = null, equation: String = null, message: String = null, roundOff: String = null, sum: String = null, terminationDate: String = null, type: String = null, BillDeterminants: List[String] = null, ChargeTypes: List[String] = null) extends Element with Product with Serializable
A Charge Component is a list of configurable charge quality items to feed into settlement calculation and/or bill determinants.
A Charge Component is a list of configurable charge quality items to feed into settlement calculation and/or bill determinants.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- deleteStatus
undocumented
- effectiveDate
undocumented
- equation
undocumented
- message
undocumented
- roundOff
undocumented
- sum
undocumented
- terminationDate
undocumented
- type
undocumented
- BillDeterminants
BillDeterminant A BillDeterminant can have 0-n ChargeComponent and a ChargeComponent can associate to 0-n BillDeterminant.
- ChargeTypes
ChargeType A ChargeType can have 0-n ChargeComponent and a ChargeComponent can associate to 0-n ChargeType
-
final
case class
ChargeGroup(IdentifiedObject: IdentifiedObject = null, effectiveDate: String = null, marketCode: String = null, terminationDate: String = null, ChargeGroupChild: List[String] = null, ChargeGroupParent: String = null, ChargeType: List[String] = null, MktUserAttribute: List[String] = null) extends Element with Product with Serializable
Charge Group is the grouping of Charge Types for settlement invoicing purpose.
Charge Group is the grouping of Charge Types for settlement invoicing purpose.
Examples such as Ancillary Services, Interests, etc.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- effectiveDate
undocumented
- marketCode
undocumented
- terminationDate
undocumented
- ChargeGroupChild
ChargeGroup A ChargeGroup instance can have relationships with other ChargeGroup instances.
- ChargeGroupParent
ChargeGroup A ChargeGroup instance can have relationships with other ChargeGroup instances.
- ChargeType
ChargeType A ChargeGroup can have 0-n ChargeType. A ChargeType can associate to 0-n ChargeGroup.
- MktUserAttribute
MktUserAttribute undocumented
-
final
case class
ChargeProfile(Profile: Profile = null, frequency: String = null, numberInterval: Int = 0, type: String = null, unitOfMeasure: String = null, Bid: String = null, BillDeterminant: String = null, ChargeProfileData: List[String] = null, PassTroughBill: String = null) extends Element with Product with Serializable
A type of profile for financial charges.
A type of profile for financial charges.
- Profile
Profile Reference to the superclass object.
- frequency
The calculation frequency, daily or monthly.
- numberInterval
The number of intervals in the profile data.
- type
The type of profile. It could be amount, price, or quantity.
- unitOfMeasure
The unit of measure applied to the value attribute of the profile data.
- Bid
Bid undocumented
- BillDeterminant
BillDeterminant undocumented
- ChargeProfileData
ChargeProfileData undocumented
- PassTroughBill
PassThroughBill undocumented
-
final
case class
ChargeProfileData(Element: BasicElement = null, sequence: Int = 0, timeStamp: String = null, value: Double = 0.0, BillDeterminant: String = null, ChargeProfile: String = null) extends Element with Product with Serializable
Model of various charges associated with an energy profile to support billing and settlement.
Model of various charges associated with an energy profile to support billing and settlement.
- Element
Reference to the superclass object.
- sequence
The sequence number of the profile.
- timeStamp
The date and time of an interval.
- value
The value of an interval given a profile type (amount, price, or quantity), subject to the UOM.
- BillDeterminant
BillDeterminant undocumented
- ChargeProfile
ChargeProfile undocumented
-
final
case class
ChargeType(Document: Document = null, chargeOrder: String = null, chargeVersion: String = null, effectiveDate: String = null, factor: String = null, frequencyType: String = null, terminationDate: String = null, totalInterval: String = null, ChargeComponents: List[String] = null, ChargeGroup: List[String] = null, MajorChargeGroup: List[String] = null, MktUserAttribute: List[String] = null) extends Element with Product with Serializable
Charge Type is the basic level configuration for settlement to process specific charges for invoicing purpose.
Charge Type is the basic level configuration for settlement to process specific charges for invoicing purpose.
Examples such as: Day Ahead Spinning Reserve Default Invoice Interest Charge, etc.
- Document
Document Reference to the superclass object.
- chargeOrder
undocumented
- chargeVersion
undocumented
- effectiveDate
undocumented
- factor
undocumented
- frequencyType
undocumented
- terminationDate
undocumented
- totalInterval
undocumented
- ChargeComponents
ChargeComponent A ChargeType can have 0-n ChargeComponent and a ChargeComponent can associate to 0-n ChargeType
- ChargeGroup
ChargeGroup A ChargeGroup can have 0-n ChargeType. A ChargeType can associate to 0-n ChargeGroup.
- MajorChargeGroup
MajorChargeGroup A MajorChargeGroup can have 0-n ChargeType. A ChargeType can associate to 0-n MajorChargeGroup.
- MktUserAttribute
MktUserAttribute undocumented
-
final
case class
Cheque(Element: BasicElement = null, bankAccountDetail: String = null, chequeNumber: String = null, date: String = null, kind: String = null, micrNumber: String = null, Tender: String = null) extends Element with Product with Serializable
The actual tender when it is a type of cheque.
The actual tender when it is a type of cheque.
- Element
Reference to the superclass object.
- bankAccountDetail
BankAccountDetail Details of the account holder and bank.
- chequeNumber
Cheque reference number as printed on the cheque.
- date
Date when cheque becomes valid.
- kind
Kind of cheque.
- micrNumber
The magnetic ink character recognition number printed on the cheque.
- Tender
Tender Payment tender the cheque is being used for.
- final case class Circuit(Line: Line = null, EndBay: List[String] = null, EndTerminal: List[String] = null) extends Element with Product with Serializable
-
final
case class
Clamp(ConductingEquipment: ConductingEquipment = null, lengthFromTerminal1: Double = 0.0, ACLineSegment: String = null, ClampAction: String = null, JumperAction: String = null) extends Element with Product with Serializable
A Clamp is a galvanic connection at a line segment where other equipment is connected.
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.
- ConductingEquipment
ConductingEquipment Reference to the superclass object.
- lengthFromTerminal1
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.
- ACLineSegment
ACLineSegment The line segment to which the clamp is connected.
- ClampAction
ClampAction undocumented
- JumperAction
JumperAction undocumented
-
final
case class
ClampAction(SwitchingAction: SwitchingAction = null, kind: String = null, Clamp: String = null) extends Element with Product with Serializable
Action on Clamp as a switching step
Action on Clamp as a switching step
- SwitchingAction
SwitchingAction Reference to the superclass object.
- kind
Switching action to perform
- Clamp
Clamp undocumented
-
final
case class
ClassificationCondition(IdentifiedObject: IdentifiedObject = null, duration: Double = 0.0, test: String = null, EnvironmentalAnalog: List[String] = null, EnvironmentalStringMeasurement: List[String] = null, PhenomenonClassification: String = null) extends Element with Product with Serializable
A classification condition used to define preconditions that must be met by a phenomena classification.
A classification condition used to define preconditions that must be met by a phenomena classification.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- duration
The duration of the of the condition in seconds
- test
The test applied to the value.
- EnvironmentalAnalog
EnvironmentalAnalog Analog which contributes to the definition of this classification condition.
- EnvironmentalStringMeasurement
EnvironmentalStringMeasurement String measurement which contributes to the definition of this classification condition.
- PhenomenonClassification
PhenomenonClassification Phenomenon classification to which this condition relates.
-
final
case class
ClearanceAction(SwitchingAction: SwitchingAction = null, kind: String = null, Clearance: String = null) extends Element with Product with Serializable
Action on clearance document as a switching step.
Action on clearance document as a switching step.
- SwitchingAction
SwitchingAction Reference to the superclass object.
- kind
Clearance action to perform.
- Clearance
ClearanceDocument Clearance associated with this clearance action.
-
final
case class
ClearanceDocument(SafetyDocument: SafetyDocument = null, mustBeDeenergised: Boolean = false, mustBeGrounded: Boolean = false, ClearanceAction: String = null, TaggedPSRs: List[String] = null) extends Element with Product with Serializable
Safety document used to authorise work on conducting equipment in the field.
Safety document used to authorise work on conducting equipment in the field.
Tagged equipment is not allowed to be operated.
- SafetyDocument
SafetyDocument Reference to the superclass object.
- mustBeDeenergised
If true, the equipment must be deenergised.
- mustBeGrounded
If true, the equipment must be grounded.
- ClearanceAction
ClearanceAction Clearance action associated with this clearance.
- TaggedPSRs
PowerSystemResource All power system resources tagged through this clearance.
-
final
case class
CloudCondition(AtmosphericPhenomenon: AtmosphericPhenomenon = null, kind: String = null) extends Element with Product with Serializable
A classified cloud phenomenon with a type.
A classified cloud phenomenon with a type.
- AtmosphericPhenomenon
AtmosphericPhenomenon Reference to the superclass object.
- kind
The type of the cloud as defined by the CloudKind enumeration.
-
final
case class
CnodeDistributionFactor(IdentifiedObject: IdentifiedObject = null, factor: Double = 0.0, podLossFactor: Double = 0.0, AggregateNode: String = null, HostControlArea: String = null, MktConnectivityNode: String = null, SubControlArea: String = null) extends Element with Product with Serializable
Participation factors per Cnode.
Participation factors per Cnode.
Used to calculate "participation" of Cnode in an AggregateNode. Each Cnode associated to an AggregateNode would be assigned a participation factor for its participation within the AggregateNode.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- factor
Used to calculate "participation" of Cnode in an AggregateNode
- podLossFactor
Point of delivery loss factor
- AggregateNode
AggregateNode undocumented
- HostControlArea
HostControlArea undocumented
- MktConnectivityNode
MktConnectivityNode undocumented
- SubControlArea
SubControlArea undocumented
-
final
case class
CogenerationPlant(PowerSystemResource: PowerSystemResource = null, cogenHPSendoutRating: Double = 0.0, cogenHPSteamRating: Double = 0.0, cogenLPSendoutRating: Double = 0.0, cogenLPSteamRating: Double = 0.0, ratedP: Double = 0.0, SteamSendoutSchedule: String = null, ThermalGeneratingUnits: List[String] = null) extends Element with Product with Serializable
A set of thermal generating units for the production of electrical energy and process steam (usually from the output of the steam turbines).
A set of thermal generating units for the production of electrical energy and process steam (usually from the output of the steam turbines).
The steam sendout is typically used for industrial purposes or for municipal heating and cooling.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- cogenHPSendoutRating
The high pressure steam sendout.
- cogenHPSteamRating
The high pressure steam rating.
- cogenLPSendoutRating
The low pressure steam sendout.
- cogenLPSteamRating
The low pressure steam rating.
- ratedP
The rated output active power of the cogeneration plant. The attribute shall be a positive value.
- SteamSendoutSchedule
SteamSendoutSchedule A cogeneration plant has a steam sendout schedule.
- ThermalGeneratingUnits
ThermalGeneratingUnit A thermal generating unit may be a member of a cogeneration plant.
-
final
case class
ComFunction(EndDeviceFunction: EndDeviceFunction = null, amrAddress: String = null, amrRouter: String = null, direction: String = null, technology: String = null, ComModule: String = null) extends Element with Product with Serializable
Communication function of communication equipment or a device such as a meter.
Communication function of communication equipment or a device such as a meter.
- EndDeviceFunction
EndDeviceFunction Reference to the superclass object.
- amrAddress
Communication ID number (e.g. serial number, IP address, telephone number, etc.) of the AMR module which serves this meter.
- amrRouter
Communication ID number (e.g. port number, serial number, data collector ID, etc.) of the parent device associated to this AMR module.
- direction
Kind of communication direction.
- technology
Kind of communication technology.
- ComModule
ComModule Module performing this communication function.
-
final
case class
ComMedia(Asset: Asset = null) extends Element with Product with Serializable
Communication media such as fibre optic cable, power-line, telephone, etc.
Communication media such as fibre optic cable, power-line, telephone, etc.
- Asset
Asset Reference to the superclass object.
-
final
case class
ComModule(Asset: Asset = null, amrSystem: String = null, supportsAutonomousDst: Boolean = false, timeZoneOffset: Double = 0.0, ComFunctions: List[String] = null) extends Element with Product with Serializable
An asset having communications capabilities that can be paired with a meter or other end device to provide the device with communication ability, through associated communication function.
An asset having communications capabilities that can be paired with a meter or other end device to provide the device with communication ability, through associated communication function.
An end device that has communications capabilities through embedded hardware can use that function directly (without the communication module), or combine embedded communication function with additional communication functions provided through an external communication module (e.g. zigbee).
- Asset
Asset Reference to the superclass object.
- amrSystem
Automated meter reading (AMR) system communicating with this com module.
- supportsAutonomousDst
If true, autonomous daylight saving time (DST) function is supported.
- timeZoneOffset
Time zone offset relative to GMT for the location of this com module.
- ComFunctions
ComFunction All functions this communication module performs.
-
final
case class
CombinedCycleConfiguration(RegisteredGenerator: RegisteredGenerator = null, primaryConfiguration: Boolean = false, CombinedCycleConfigurationMember: List[String] = null, CombinedCycleLogicalConfiguration: String = null, FromTransitionState: List[String] = null, ShutdownFlag: Boolean = false, StartupFlag: Boolean = false, ToTransitionState: List[String] = null) extends Element with Product with Serializable
Configuration options for combined cycle units.
Configuration options for combined cycle units.
For example, a Combined Cycle with (CT1, CT2, ST1) will have (CT1, ST1) and (CT2, ST1) configurations as part of(1CT + 1STlogicalconfiguration).
- RegisteredGenerator
RegisteredGenerator Reference to the superclass object.
- primaryConfiguration
Whether this CombinedCycleConfiguration is the primary configuration in the associated Logical configuration?
- CombinedCycleConfigurationMember
CombinedCycleConfigurationMember undocumented
- CombinedCycleLogicalConfiguration
CombinedCycleLogicalConfiguration undocumented
- FromTransitionState
CombinedCycleTransitionState undocumented
- ShutdownFlag
Whether Combined Cycle Plant can be shut-down in this Configuration?
- StartupFlag
Whether Combined Cycle Plant can be started in this Logical Configuration?
- ToTransitionState
CombinedCycleTransitionState undocumented
-
final
case class
CombinedCycleConfigurationMember(IdentifiedObject: IdentifiedObject = null, primary: Boolean = false, steam: Boolean = false, CombinedCycleConfiguration: String = null, MktThermalGeneratingUnit: String = null) extends Element with Product with Serializable
Configuration Member of CCP Configuration.
Configuration Member of CCP Configuration.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- primary
primary configuration.
- steam
Steam plant.
- CombinedCycleConfiguration
CombinedCycleConfiguration undocumented
- MktThermalGeneratingUnit
MktThermalGeneratingUnit undocumented
-
final
case class
CombinedCycleLogicalConfiguration(IdentifiedObject: IdentifiedObject = null, CombinedCycleConfiguration: List[String] = null, MktCombinedCyclePlant: String = null) extends Element with Product with Serializable
Logical Configuration of a Combined Cycle plant.
Logical Configuration of a Combined Cycle plant.
Operating Combined Cycle Plant (CCP) configurations are represented as Logical CCP Resources. Logical representation shall be used for Market applications to optimize and control Market Operations. Logical representation is also necessary for controlling the number of CCP configurations and to temper performance issues that may otherwise occur.
For example,(2CT configuration),(1CT + 1ST configuration) are examples of logical configuration, without specifying the specific CT and ST participating in the configuration.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- CombinedCycleConfiguration
CombinedCycleConfiguration undocumented
- MktCombinedCyclePlant
MktCombinedCyclePlant undocumented
-
final
case class
CombinedCyclePlant(PowerSystemResource: PowerSystemResource = null, combCyclePlantRating: Double = 0.0, ThermalGeneratingUnits: List[String] = null) extends Element with Product with Serializable
A set of combustion turbines and steam turbines where the exhaust heat from the combustion turbines is recovered to make steam for the steam turbines, resulting in greater overall plant efficiency.
A set of combustion turbines and steam turbines where the exhaust heat from the combustion turbines is recovered to make steam for the steam turbines, resulting in greater overall plant efficiency.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- combCyclePlantRating
The combined cycle plant's active power output rating.
- ThermalGeneratingUnits
ThermalGeneratingUnit A thermal generating unit may be a member of a combined cycle plant.
-
final
case class
CombinedCycleTransitionState(Element: BasicElement = null, upTransition: Boolean = false, FromConfiguration: String = null, ToConfiguration: String = null) extends Element with Product with Serializable
Defines the available from and to Transition States for the Combine Cycle Configurations.
Defines the available from and to Transition States for the Combine Cycle Configurations.
- Element
Reference to the superclass object.
- upTransition
Flag indicating whether this is an UP transition. If not, it is a DOWN transition.
- FromConfiguration
CombinedCycleConfiguration undocumented
- ToConfiguration
CombinedCycleConfiguration undocumented
-
final
case class
CombustionTurbine(PrimeMover: PrimeMover = null, ambientTemp: Double = 0.0, auxPowerVersusFrequency: Double = 0.0, auxPowerVersusVoltage: Double = 0.0, capabilityVersusFrequency: Double = 0.0, heatRecoveryFlag: Boolean = false, powerVariationByTemp: Double = 0.0, referenceTemp: Double = 0.0, timeConstant: Double = 0.0, AirCompressor: String = null, CTTempActivePowerCurve: String = null, HeatRecoveryBoiler: String = null) extends Element with Product with Serializable
A prime mover that is typically fuelled by gas or light oil.
A prime mover that is typically fuelled by gas or light oil.
- PrimeMover
PrimeMover Reference to the superclass object.
- ambientTemp
Default ambient temperature to be used in modelling applications.
- auxPowerVersusFrequency
Off-nominal frequency effect on turbine auxiliaries. Per unit reduction in auxiliary active power consumption versus per unit reduction in frequency (from rated frequency).
- auxPowerVersusVoltage
Off-nominal voltage effect on turbine auxiliaries. Per unit reduction in auxiliary active power consumption versus per unit reduction in auxiliary bus voltage (from a specified voltage level).
- capabilityVersusFrequency
Off-nominal frequency effect on turbine capability. Per unit reduction in unit active power capability versus per unit reduction in frequency (from rated frequency).
- heatRecoveryFlag
Flag that is set to true if the combustion turbine is associated with a heat recovery boiler.
- powerVariationByTemp
Per unit change in power per (versus) unit change in ambient temperature.
- referenceTemp
Reference temperature at which the output of the turbine was defined.
- timeConstant
The time constant for the turbine.
- AirCompressor
AirCompressor A CAES air compressor is driven by combustion turbine.
- CTTempActivePowerCurve
CTTempActivePowerCurve A combustion turbine may have an active power versus ambient temperature relationship.
- HeatRecoveryBoiler
HeatRecoveryBoiler A combustion turbine may have a heat recovery boiler for making steam.
-
final
case class
Command(Control: Control = null, normalValue: Int = 0, value: Int = 0, DiscreteValue: String = null, ValueAliasSet: String = null) extends Element with Product with Serializable
A Command is a discrete control used for supervisory control.
A Command is a discrete control used for supervisory control.
- Control
Control Reference to the superclass object.
- normalValue
Normal value for Control.value e.g. used for percentage scaling.
- value
The value representing the actuator output.
- DiscreteValue
DiscreteValue The MeasurementValue that is controlled.
- ValueAliasSet
ValueAliasSet The ValueAliasSet used for translation of a Control value to a name.
-
final
case class
CommitmentClearing(MarketFactors: MarketFactors = null, Commitments: List[String] = null) extends Element with Product with Serializable
Models results of market clearing which call for commitment of units.
Models results of market clearing which call for commitment of units.
- MarketFactors
MarketFactors Reference to the superclass object.
- Commitments
Commitments undocumented
-
final
case class
Commitments(Element: BasicElement = null, commitmentType: String = null, instructionCost: Double = 0.0, instructionType: String = null, intervalEndTime: String = null, intervalStartTime: String = null, minStatusChangeTime: Int = 0, noLoadCost: Double = 0.0, updateTimeStamp: String = null, updateType: String = null, updateUser: String = null, CommitmentClearing: List[String] = null, RegisteredResource: String = null) extends Element with Product with Serializable
Provides the necessary information (on a resource basis) to capture the Startup/Shutdown commitment results.
Provides the necessary information (on a resource basis) to capture the Startup/Shutdown commitment results.
This information is relevant to all markets.
- Element
Reference to the superclass object.
- commitmentType
the type of UC status (self commitment, ISO commitment, or SCUC commitment)
- instructionCost
Total cost associated with changing the status of the resource.
- instructionType
Indicator of either a Start-Up or a Shut-Down.
- intervalEndTime
End time for the commitment period. This will be on an interval boundary.
- intervalStartTime
Start time for the commitment period. This will be on an interval boundary.
- minStatusChangeTime
SCUC commitment period start-up time. Calculated start up time based on the StartUpTimeCurve provided with the Bid. This is a combination of StartUp time bid and Unit down time. Units is minutes
- noLoadCost
Unit no load cost in case of energy commodity
- updateTimeStamp
undocumented
- updateType
undocumented
- updateUser
undocumented
- CommitmentClearing
CommitmentClearing undocumented
- RegisteredResource
RegisteredResource undocumented
-
final
case class
CommodityDefinition(IdentifiedObject: IdentifiedObject = null, commodityCurrency: String = null, commodityUnit: String = null, commodityUnitMultiplier: String = null, CommodityPrice: List[String] = null, MarketProduct: String = null, Pnode: String = null, RTO: String = null) extends Element with Product with Serializable
Commodities in the context of IEC 62325 are MarketProducts (energy, regulation, reserve, etc) traded at a specific location, which in this case is a Pnode (either a specific pricing node or a pricing area or zone defined as a collection of pricing nodes).
Commodities in the context of IEC 62325 are MarketProducts (energy, regulation, reserve, etc) traded at a specific location, which in this case is a Pnode (either a specific pricing node or a pricing area or zone defined as a collection of pricing nodes).
The CommodityDefinition is a container for these two parameters, plus the unit of measure and the currency in which the Commodity is traded. Each CommodityDefinition should be relatively static; defined once and rarely changed.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- commodityCurrency
The currency in which the Commodity is traded, using the standard conventions associated with the Currency enumeration.
- commodityUnit
The unit of measure in which the Commodity is traded, using the standard conventions associated with the UnitSymbol enumeration.
- commodityUnitMultiplier
The unit multiplier, e.g. "k" to convert the unit "W-h" to "kW-h", using the standard conventions associated with the UnitMultiplier enumeration.
- CommodityPrice
CommodityPrice undocumented
- MarketProduct
MarketProduct undocumented
- Pnode
Pnode undocumented
- RTO
RTO undocumented
-
final
case class
CommodityPrice(Element: BasicElement = null, timeIntervalPeriod: String = null, value: Double = 0.0, CommodityDefinition: String = null, PnodeClearing: String = null, PriceDescriptor: String = null) extends Element with Product with Serializable
The CommodityPrice class is used to define the price of a commodity during a given time interval.
The CommodityPrice class is used to define the price of a commodity during a given time interval.
The interval may be long, e.g. a year, or very short, e.g. 5 minutes. There will be many instances of the CommodityPrice class for each instance of the CommodityDefinition to which it is associated. Note that there may be more than once price associated with a given interval and these variances are described by the association (or associations) with the PriceDescriptor class.
- Element
Reference to the superclass object.
- timeIntervalPeriod
The time interval over which the CommodityPrice is valid, using the standard conventions associated with the DateTimeInterval class.
- value
The price of the Commodity, expressed as a floating point value with the currency and unit of measure defined in the associated CommodityDefinition class.
- CommodityDefinition
CommodityDefinition undocumented
- PnodeClearing
PnodeClearing undocumented
- PriceDescriptor
PriceDescriptor undocumented
-
final
case class
CommunicationLink(PowerSystemResource: PowerSystemResource = null, BilateralExchangeActor: String = null, RemoteUnits: List[String] = null) extends Element with Product with Serializable
The connection to remote units is through one or more communication links.
The connection to remote units is through one or more communication links.
Reduntant links may exist. The CommunicationLink class inherits PowerSystemResource. The intention is to allow CommunicationLinks to have Measurements. These Measurements can be used to model link status as operational, out of service, unit failure etc.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- BilateralExchangeActor
BilateralExchangeActor ICCP data provider or consumer using communication addressing for a Bilateral table.
- RemoteUnits
RemoteUnit RTUs may be attached to communication links.
-
final
case class
CompatibleUnit(WorkDocument: WorkDocument = null, estCost: Double = 0.0, quantity: String = null, CUAllowableAction: String = null, CUContractorItems: List[String] = null, CUGroup: String = null, CULaborItems: List[String] = null, CUMaterialItems: List[String] = null, CUWorkEquipmentItems: List[String] = null, CostType: String = null, DesignLocationCUs: List[String] = null, GenericAssetModel: String = null, Procedures: List[String] = null, PropertyUnit: String = null) extends Element with Product with Serializable
A pre-planned job model containing labor, material, and accounting requirements for standardized job planning.
A pre-planned job model containing labor, material, and accounting requirements for standardized job planning.
- WorkDocument
WorkDocument Reference to the superclass object.
- estCost
Estimated total cost for perfoming CU.
- quantity
The quantity, unit of measure, and multiplier at the CU level that applies to the materials.
- CUAllowableAction
CUAllowableAction undocumented
- CUContractorItems
CUContractorItem undocumented
- CUGroup
CUGroup undocumented
- CULaborItems
CULaborItem undocumented
- CUMaterialItems
CUMaterialItem undocumented
- CUWorkEquipmentItems
CUWorkEquipmentItem undocumented
- CostType
CostType undocumented
- DesignLocationCUs
DesignLocationCU undocumented
- GenericAssetModel
CatalogAssetType undocumented
- Procedures
Procedure undocumented
- PropertyUnit
PropertyUnit undocumented
-
final
case class
CompleteModelToBeDeleted(ModelToBeDeleted: ModelToBeDeleted = null) extends Element with Product with Serializable
A complete model can be used in applications to perform meaningful calculations, e.g.
A complete model can be used in applications to perform meaningful calculations, e.g. a study case in offline tools or a real time model in a SCADA/EMS.
- ModelToBeDeleted
ModelToBeDeleted Reference to the superclass object.
-
final
case class
ComplianceEvent(ActivityRecord: ActivityRecord = null, deadline: String = null) extends Element with Product with Serializable
Compliance events are used for reporting regulatory or contract compliance issues and/or variances.
Compliance events are used for reporting regulatory or contract compliance issues and/or variances.
These might be created as a consequence of local business processes and associated rules. It is anticipated that this class will be customised extensively to meet local implementation needs. Use inherited 'type' to indicate that, for example, expected performance will not be met or reported as mandated.
- ActivityRecord
ActivityRecord Reference to the superclass object.
- deadline
The deadline for compliance.
-
final
case class
CompositeSwitch(Equipment: Equipment = null, compositeSwitchType: String = null, Switches: List[String] = null) extends Element with Product with Serializable
A model of a set of individual Switches normally enclosed within the same cabinet and possibly with interlocks that restrict the combination of switch positions.
A model of a set of individual Switches normally enclosed within the same cabinet and possibly with interlocks that restrict the combination of switch positions.
These are typically found in medium voltage distribution networks. A CompositeSwitch could represent a Ring-Main-Unit (RMU), or pad-mounted switchgear, with primitive internal devices such as an internal bus-bar plus 3 or 4 internal switches each of which may individually be open or closed. A CompositeSwitch and a set of contained Switches can also be used to represent a multi-position switch e.g. a switch that can connect a circuit to Ground, Open or Busbar.
-
final
case class
CompositeSwitchInfo(AssetInfo: AssetInfo = null, ganged: Boolean = false, initOpMode: String = null, interruptingRating: Double = 0.0, kind: String = null, phaseCode: String = null, phaseCount: Int = 0, ratedVoltage: Double = 0.0, remote: Boolean = false, switchStateCount: Int = 0) extends Element with Product with Serializable
Properties of a composite switch.
Properties of a composite switch.
- AssetInfo
AssetInfo Reference to the superclass object.
- ganged
True if multi-phase switch controls all phases concurrently.
- initOpMode
Initial operating mode, with the following values: Automatic, Manual.
- interruptingRating
Breaking capacity, or short circuit rating, is the maximum rated current which the device can safely interrupt at the rated voltage.
- kind
Kind of composite switch.
- phaseCode
Phases carried, if applicable.
- phaseCount
Supported number of phases, typically 0, 1 or 3.
- ratedVoltage
Rated voltage.
- remote
True if device is capable of being operated by remote control.
- switchStateCount
Number of switch states represented by the composite switch.
-
final
case class
ConcentricNeutralCableInfo(CableInfo: CableInfo = null, diameterOverNeutral: Double = 0.0, neutralStrandCount: Int = 0, neutralStrandGmr: Double = 0.0, neutralStrandRDC20: Double = 0.0, neutralStrandRadius: Double = 0.0) extends Element with Product with Serializable
Concentric neutral cable data.
Concentric neutral cable data.
- CableInfo
CableInfo Reference to the superclass object.
- diameterOverNeutral
Diameter over the concentric neutral strands.
- neutralStrandCount
Number of concentric neutral strands.
- neutralStrandGmr
Geometric mean radius of the neutral strand.
- neutralStrandRDC20
DC resistance per unit length of the neutral strand at 20 °C.
- neutralStrandRadius
Outside radius of the neutral strand.
-
final
case class
ConditionFactor(WorkIdentifiedObject: WorkIdentifiedObject = null, cfValue: String = null, kind: String = null, status: String = null, DesignLocationCUs: List[String] = null, DesignLocations: List[String] = null, Designs: List[String] = null) extends Element with Product with Serializable
This is to specify the various condition factors for a design that may alter the cost estimate or the allocation.
This is to specify the various condition factors for a design that may alter the cost estimate or the allocation.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- cfValue
The actual value of the condition factor, such as labor flat fee or percentage.
- kind
Kind of this condition factor.
- status
undocumented
- DesignLocationCUs
DesignLocationCU undocumented
- DesignLocations
DesignLocation undocumented
- Designs
Design undocumented
-
final
case class
ConductingEquipment(Equipment: Equipment = null, BaseVoltage: String = null, GroundingAction: String = null, JumpingAction: String = null, Outage: String = null, ProtectionEquipments: List[String] = null, ProtectiveActionAdjustment: List[String] = null, SvStatus: List[String] = null, Terminals: List[String] = null) extends Element with Product with Serializable
The parts of the AC power system that are designed to carry current or that are conductively connected through terminals.
The parts of the AC power system that are designed to carry current or that are conductively connected through terminals.
- Equipment
Equipment Reference to the superclass object.
- BaseVoltage
BaseVoltage Base voltage of this conducting equipment. Use only when there is no voltage level container used and only one base voltage applies. For example, not used for transformers.
- GroundingAction
GroundAction Action involving grounding operation on this conducting equipment.
- JumpingAction
JumperAction Jumper action involving jumping operation on this conducting equipment.
- Outage
Outage undocumented
- ProtectionEquipments
ProtectionEquipment Protection equipment used to protect specific conducting equipment.
- ProtectiveActionAdjustment
ProtectiveActionAdjustment The operating condition to the Conducting Equipment is changed when protective action adjustment is activated. For ShuntCompensator or other conducting equipment that operates on discrete values (integer), the values given in float will be rounded.
- SvStatus
SvStatus The status state variable associated with this conducting equipment.
- Terminals
Terminal Conducting equipment have terminals that may be connected to other conducting equipment terminals via connectivity nodes or topological nodes.
-
final
case class
Conductor(ConductingEquipment: ConductingEquipment = null, len: Double = 0.0) extends Element with Product with Serializable
Combination of conducting material with consistent electrical characteristics, building a single electrical system, used to carry current between points in the power system.
Combination of conducting material with consistent electrical characteristics, building a single electrical system, used to carry current between points in the power system.
- ConductingEquipment
ConductingEquipment Reference to the superclass object.
- len
Segment length for calculating line section capabilities.
-
final
case class
ConfigurationEvent(ActivityRecord: ActivityRecord = null, effectiveDateTime: String = null, modifiedBy: String = null, remark: String = null, ChangedAsset: String = null, ChangedDocument: String = null, ChangedLocation: String = null, ChangedOrganisationRole: String = null, ChangedPersonRole: String = null, ChangedServiceCategory: String = null, ChangedUsagePoint: String = null, FaultCauseType: String = null, PowerSystemResource: String = null) extends Element with Product with Serializable
Used to report details on creation, change or deletion of an entity or its configuration.
Used to report details on creation, change or deletion of an entity or its configuration.
- ActivityRecord
ActivityRecord Reference to the superclass object.
- effectiveDateTime
Date and time this event has or will become effective.
- modifiedBy
Source/initiator of modification.
- remark
Free text remarks.
- ChangedAsset
Asset Asset whose change resulted in this configuration event.
- ChangedDocument
Document Document whose change resulted in this configuration event.
- ChangedLocation
Location Location whose change resulted in this configuration event.
- ChangedOrganisationRole
OrganisationRole Organisation role whose change resulted in this configuration event.
- ChangedPersonRole
PersonRole Person role whose change resulted in this configuration event.
- ChangedServiceCategory
ServiceCategory Service category whose change resulted in this configuration event.
- ChangedUsagePoint
UsagePoint Usage point whose change resulted in this configuration event.
- FaultCauseType
FaultCauseType undocumented
- PowerSystemResource
PowerSystemResource undocumented
-
final
case class
ConformLoad(EnergyConsumer: EnergyConsumer = null, LoadGroup: String = null) extends Element with Product with Serializable
ConformLoad represent loads that follow a daily load change pattern where the pattern can be used to scale the load with a system load.
ConformLoad represent loads that follow a daily load change pattern where the pattern can be used to scale the load with a system load.
- EnergyConsumer
EnergyConsumer Reference to the superclass object.
- LoadGroup
ConformLoadGroup Group of this ConformLoad.
-
final
case class
ConformLoadGroup(LoadGroup: LoadGroup = null, ConformLoadSchedules: List[String] = null, EnergyConsumers: List[String] = null) extends Element with Product with Serializable
A group of loads conforming to an allocation pattern.
A group of loads conforming to an allocation pattern.
- LoadGroup
LoadGroup Reference to the superclass object.
- ConformLoadSchedules
ConformLoadSchedule The ConformLoadSchedules in the ConformLoadGroup.
- EnergyConsumers
ConformLoad Conform loads assigned to this ConformLoadGroup.
-
final
case class
ConformLoadSchedule(SeasonDayTypeSchedule: SeasonDayTypeSchedule = null, ConformLoadGroup: String = null) extends Element with Product with Serializable
A curve of load versus time (X-axis) showing the active power values (Y1-axis) and reactive power (Y2-axis) for each unit of the period covered.
A curve of load versus time (X-axis) showing the active power values (Y1-axis) and reactive power (Y2-axis) for each unit of the period covered.
This curve represents a typical pattern of load over the time period for a given day type and season.
- SeasonDayTypeSchedule
SeasonDayTypeSchedule Reference to the superclass object.
- ConformLoadGroup
ConformLoadGroup The ConformLoadGroup where the ConformLoadSchedule belongs.
-
final
case class
CongestionArea(AggregatedPnode: AggregatedPnode = null, IndividualPnode: List[String] = null) extends Element with Product with Serializable
Designated Congestion Area Definition (DCA).
Designated Congestion Area Definition (DCA).
- AggregatedPnode
AggregatedPnode Reference to the superclass object.
- IndividualPnode
IndividualPnode undocumented
-
final
case class
CongestionRevenueRight(Document: Document = null, cRRcategory: String = null, cRRtype: String = null, hedgeType: String = null, timeOfUse: String = null, tradeSliceID: String = null, CRRMarket: String = null, CRROrgRole: List[String] = null, CRRSegment: List[String] = null, Flowgate: String = null) extends Element with Product with Serializable
Congestion Revenue Rights (CRR) class that is inherited from a Document class.
Congestion Revenue Rights (CRR) class that is inherited from a Document class.
A CRR is a financial concept that is used to hedge congestion charges.
The CRR is usually settled based on the Locational Marginal Prices (LMPs) that are calculated in the day-ahead market. These LMPs are determined by the Day-ahead resource schedules/bids. CRRs will not hedge against marginal losses. If the congestion component of LMP at the sink is greater than at the source, then the CRR owner is entitled to receive a portion of congestion revenues. If the congestion component at the sink is less than at the source, then an obligation-type CRR owner will be charged, but an option-type CRR owner will not.
- Document
Document Reference to the superclass object.
- cRRcategory
CRR category represents 'PTP' for a point-to-point CRR, or 'NSR' for a Network Service Right. If CRR category is 'PTP', both Source ID and Sink ID fields are required. If CRR category is 'NSR' only one field, either Source ID or Sink ID, shall be not null and the other shall be null. However, the 'NSR' category will include at least three records.
- cRRtype
Type of the CRR, from the possible type definitions in the CRR System (e.g. 'LSE', 'ETC').
- hedgeType
Hedge type Obligation or Option. An obligation type requires the holder to receive or pay the congestion rent. An option type gives the holder the option of receiving or paying the congestion rent.
- timeOfUse
Time of Use flag of the CRR - Peak (ON), Offpeak (OFF) or all 24 hours (24HR).
- tradeSliceID
Segment of the CRR described in the current record.
- CRRMarket
CRRMarket undocumented
- CRROrgRole
CRROrgRole undocumented
- CRRSegment
CRRSegment undocumented
- Flowgate
Flowgate undocumented
-
final
case class
ConnectDisconnectFunction(EndDeviceFunction: EndDeviceFunction = null, eventCount: Int = 0, isConnected: Boolean = false, isDelayedDiscon: Boolean = false, isLocalAutoDisconOp: Boolean = false, isLocalAutoReconOp: Boolean = false, isRemoteAutoDisconOp: Boolean = false, isRemoteAutoReconOp: Boolean = false, rcdInfo: String = null, Switches: List[String] = null) extends Element with Product with Serializable
A function that will disconnect and reconnect the customer's load under defined conditions.
A function that will disconnect and reconnect the customer's load under defined conditions.
- EndDeviceFunction
EndDeviceFunction Reference to the superclass object.
- eventCount
Running cumulative count of connect or disconnect events, for the lifetime of this function or until the value is cleared.
- isConnected
True if this function is in the connected state.
- isDelayedDiscon
If set true, the switch may disconnect the service at the end of a specified time delay after the disconnect signal has been given. If set false, the switch may disconnect the service immediately after the disconnect signal has been given. This is typically the case for over current circuit-breakers which are classified as either instantaneous or slow acting.
- isLocalAutoDisconOp
If set true and if disconnection can be operated locally, the operation happens automatically. Otherwise it happens manually.
- isLocalAutoReconOp
If set true and if reconnection can be operated locally, then the operation happens automatically. Otherwise, it happens manually.
- isRemoteAutoDisconOp
If set true and if disconnection can be operated remotely, then the operation happens automatically. If set false and if disconnection can be operated remotely, then the operation happens manually.
- isRemoteAutoReconOp
If set true and if reconnection can be operated remotely, then the operation happens automatically. If set false and if reconnection can be operated remotely, then the operation happens manually.
- rcdInfo
RemoteConnectDisconnectInfo Information on remote connect disconnect switch.
- Switches
Switch undocumented
-
final
case class
ConnectivityNode(IdentifiedObject: IdentifiedObject = null, ConnectivityNodeContainer: String = null, Terminals: List[String] = null, TopologicalNode: String = null) extends Element with Product with Serializable
Connectivity nodes are points where terminals of AC conducting equipment are connected together with zero impedance.
Connectivity nodes are points where terminals of AC conducting equipment are connected together with zero impedance.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ConnectivityNodeContainer
ConnectivityNodeContainer Container of this connectivity node.
- Terminals
Terminal Terminals interconnected with zero impedance at a this connectivity node.
- TopologicalNode
TopologicalNode The topological node to which this connectivity node is assigned. May depend on the current state of switches in the network.
-
final
case class
ConnectivityNodeContainer(PowerSystemResource: PowerSystemResource = null, ConnectivityNodes: List[String] = null, TopologicalNode: List[String] = null) extends Element with Product with Serializable
A base class for all objects that may contain connectivity nodes or topological nodes.
A base class for all objects that may contain connectivity nodes or topological nodes.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- ConnectivityNodes
ConnectivityNode Connectivity nodes which belong to this connectivity node container.
- TopologicalNode
TopologicalNode The topological nodes which belong to this connectivity node container.
-
final
case class
Connector(ConductingEquipment: ConductingEquipment = null) extends Element with Product with Serializable
A conductor, or group of conductors, with negligible impedance, that serve to connect other conducting equipment within a single substation and are modelled with a single logical terminal.
A conductor, or group of conductors, with negligible impedance, that serve to connect other conducting equipment within a single substation and are modelled with a single logical terminal.
- ConductingEquipment
ConductingEquipment Reference to the superclass object.
-
final
case class
ConstraintClearing(MarketFactors: MarketFactors = null, ConstraintResults: List[String] = null) extends Element with Product with Serializable
Groups all items associated with Binding Constraints and Constraint Violations per interval and market.
Groups all items associated with Binding Constraints and Constraint Violations per interval and market.
- MarketFactors
MarketFactors Reference to the superclass object.
- ConstraintResults
ConstraintResults undocumented
-
final
case class
ConstraintDuration(Element: BasicElement = null, duration: String = null, type: String = null, TimeSeries: List[String] = null) extends Element with Product with Serializable
Duration constraint to activate, to put in operation, to deactivate, ...
Duration constraint to activate, to put in operation, to deactivate, ... a given event.
- Element
Reference to the superclass object.
- duration
The duration of the constraint.
- type
The type of the constraint.
- TimeSeries
TimeSeries undocumented
-
final
case class
ConstraintResults(IdentifiedObject: IdentifiedObject = null, baseFlow: Double = 0.0, bindingLimit: Double = 0.0, clearedValue: Double = 0.0, competitivePathConstraint: String = null, constraintType: String = null, limitFlag: String = null, optimizationFlag: String = null, overloadMW: Double = 0.0, percentMW: Double = 0.0, shadowPrice: Double = 0.0, updateTimeStamp: String = null, updateType: String = null, updateUser: String = null, BGLimit: Double = 0.0, BGTRResCap: Double = 0.0, ConstraintClearing: String = null, Flowgate: String = null, MktContingency: String = null) extends Element with Product with Serializable
Provides the Market results for the constraint processing for either the DAM or RTM.
Provides the Market results for the constraint processing for either the DAM or RTM.
The data includes the constraint type (binding or violated), the solved value for the constraint, and the associated shadow price.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- baseFlow
Branch base Power Flow.
- bindingLimit
MW Limit.
- clearedValue
Cleared MW.
- competitivePathConstraint
Non-competitive path constraint Flag"(Y/N) indicating whether the shadow price on a non-competitive path was non-zero.
- constraintType
Type of constraint.
- limitFlag
Limit flag ('Maximum', 'Minimum').
- optimizationFlag
Included in optimization Y/N.
- overloadMW
Transmission overload MW.
- percentMW
Actual MW flow as percent of limit.
- shadowPrice
Shadow Price ($/MW) for the commodity. Shadow price for the corresponding constraint.
- updateTimeStamp
Update time stamp.
- updateType
MQS change type.
- updateUser
Updated user.
- BGLimit
This value is determined in DA and RTM. The SCUC optimization ensures that the MW flow on the Branch Group will not exceed this limit in the relevant direction.
- BGTRResCap
Branch Group TR Reservation Capacity - This value is determined in DA and RTM. It is the amount of spare transmission capacity that is left for the TR holder to use.
- ConstraintClearing
ConstraintClearing undocumented
- Flowgate
Flowgate undocumented
- MktContingency
MktContingency undocumented
-
final
case class
ConstraintTerm(IdentifiedObject: IdentifiedObject = null, factor: String = null, function: String = null, SecurityConstraintSum: String = null) extends Element with Product with Serializable
A constraint term is one element of a linear constraint.
A constraint term is one element of a linear constraint.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- factor
undocumented
- function
The function is an enumerated value that can be 'active', 'reactive', or 'VA' to indicate the type of flow.
- SecurityConstraintSum
SecurityConstraintSum undocumented
-
final
case class
ConsumptionTariffInterval(Element: BasicElement = null, sequenceNumber: Int = 0, startValue: Double = 0.0, Charges: List[String] = null, ReadingType: String = null, TariffProfiles: List[String] = null, TouTariffIntervals: List[String] = null) extends Element with Product with Serializable
One of a sequence of intervals defined in terms of consumption quantity of a service such as electricity, water, gas, etc.
One of a sequence of intervals defined in terms of consumption quantity of a service such as electricity, water, gas, etc.
It is typically used in association with TariffProfile to define the steps or blocks in a step tariff structure, where startValue simultaneously defines the entry value of this step and the closing value of the previous step. Where consumption is >= startValue it falls within this interval and where consumption is < startValue it falls within the previous interval.
- Element
Reference to the superclass object.
- sequenceNumber
A sequential reference that defines the identity of this interval and its relative position with respect to other intervals in a sequence of intervals.
- startValue
The lowest level of consumption that defines the starting point of this interval. The interval extends to the start of the next interval or until it is reset to the start of the first interval by TariffProfile.tariffCycle.
- Charges
Charge All charges used to define this consumption tariff interval.
- ReadingType
ReadingType Reading type for 'startValue'.
- TariffProfiles
TariffProfile All tariff profiles defined by this consumption tariff interval.
- TouTariffIntervals
TimeTariffInterval All time of use tariff intervals influenced by this consumption tariff interval.
-
final
case class
Contingency(IdentifiedObject: IdentifiedObject = null, mustStudy: Boolean = false, ContingencyElement: List[String] = null) extends Element with Product with Serializable
An event threatening system reliability, consisting of one or more contingency elements.
An event threatening system reliability, consisting of one or more contingency elements.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- mustStudy
Set true if must study this contingency.
- ContingencyElement
ContingencyElement A contingency can have any number of contingency elements.
-
final
case class
ContingencyConstraintLimit(Curve: Curve = null, MWLimitSchedules: String = null, MktContingency: String = null, SecurityConstraintSum: String = null) extends Element with Product with Serializable
Possibly time-varying max MW or MVA and optionally Min MW limit or MVA limit (Y1 and Y2, respectively) assigned to a constraint for a specific contingency.
Possibly time-varying max MW or MVA and optionally Min MW limit or MVA limit (Y1 and Y2, respectively) assigned to a constraint for a specific contingency.
Use CurveSchedule XAxisUnits to specify MW or MVA.
- Curve
Curve Reference to the superclass object.
- MWLimitSchedules
MWLimitSchedule undocumented
- MktContingency
MktContingency undocumented
- SecurityConstraintSum
SecurityConstraintSum undocumented
-
final
case class
ContingencyElement(IdentifiedObject: IdentifiedObject = null, Contingency: String = null) extends Element with Product with Serializable
An element of a system event to be studied by contingency analysis, representing a change in status of a single piece of equipment.
An element of a system event to be studied by contingency analysis, representing a change in status of a single piece of equipment.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- Contingency
Contingency A contingency element belongs to one contingency.
-
final
case class
ContingencyEquipment(ContingencyElement: ContingencyElement = null, contingentStatus: String = null, Equipment: String = null) extends Element with Product with Serializable
Equipment whose in service status is to change, such as a power transformer or AC line segment.
Equipment whose in service status is to change, such as a power transformer or AC line segment.
- ContingencyElement
ContingencyElement Reference to the superclass object.
- contingentStatus
The status for the associated equipment when in the contingency state. This status is independent of the case to which the contingency is originally applied, but defines the equipment status when the contingency is applied.
- Equipment
Equipment The single piece of equipment to which to apply the contingency.
-
final
case class
ContractDistributionFactor(Element: BasicElement = null, factor: Double = 0.0, sinkFlag: String = null, sourceFlag: String = null, Flowgate: String = null, RegisteredResource: String = null, TransmissionContractRight: String = null) extends Element with Product with Serializable
Distribution among resources at the sink point or source point.
Distribution among resources at the sink point or source point.
- Element
Reference to the superclass object.
- factor
MW value that this resource provides to the overall contract.
- sinkFlag
This value will be set to YES if the referenced Cnode is defined as the sink point in the contract.
- sourceFlag
This value will be set to YES if the referenced Cnode is defined as the source point in the contract.
- Flowgate
Flowgate undocumented
- RegisteredResource
RegisteredResource undocumented
- TransmissionContractRight
ContractRight undocumented
-
final
case class
ContractRight(IdentifiedObject: IdentifiedObject = null, chainOrder: Int = 0, contractMW: Double = 0.0, contractPrice: Double = 0.0, contractPriority: Int = 0, contractStatus: String = null, contractType: String = null, financialLocation: String = null, financialRightsDAM: String = null, financialRightsRTM: String = null, fuelAdder: Double = 0.0, latestSchedMinutes: Int = 0, latestSchedMktType: String = null, maxNetDependableCapacity: Double = 0.0, maximumScheduleQuantity: Double = 0.0, maximumServiceHours: Int = 0, maximumStartups: Int = 0, minimumLoad: Double = 0.0, minimumScheduleQuantity: Double = 0.0, physicalRightsDAM: String = null, physicalRightsRTM: String = null, startupLeadTime: Int = 0, BidSelfSched: List[String] = null, Chain_TransmissionRightChain: String = null, ContractDistributionFactor: List[String] = null, Ind_TransmissionRightChain: String = null, RTO: String = null, SchedulingCoordinator: String = null, SubstitutionResourceList: List[String] = null, TREntitlement: List[String] = null, TRType: String = null, TransmissionInterfaceEntitlement: List[String] = null) extends Element with Product with Serializable
Provides definition of Transmission Ownership Right and Existing Transmission Contract identifiers for use by SCUC.
Provides definition of Transmission Ownership Right and Existing Transmission Contract identifiers for use by SCUC.
RMR contract hosting: Startup lead time, Contract Service Limits, Max Service Hours, Max MWhs, Max Start-ups, Ramp Rate, Max Net Dependable Capacity, Min Capacity and Unit Substitution for DAM/RTM to retrieve.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- chainOrder
When used in conjunction with a Transmission Right contract chain, this is the precedence for the contracts.
- contractMW
MW value of the contract
- contractPrice
Financial value of the contract
- contractPriority
Priority for the contract. This should be unique amoung all contracts for a specific resource. This value is the directive for the SCUC algorithm on the order to satisfy/cut contracts.
- contractStatus
Contract status
- contractType
type of the contract. Possible values are but not limited by: ETC, TOR or RMR and RMT self schedules
- financialLocation
Indicator if the location associated with this contract is financial (e.g. pricing nodes) or physical (e.g. connectivity nodes).
- financialRightsDAM
Flag to indicate this contract provides financial rights in the DA Market
- financialRightsRTM
Flag to indicate this contract provides financial rights in the RT Market
- fuelAdder
Estimated Fuel Adder
- latestSchedMinutes
This indicates the latest schedule minutes (e.g. t - xx) that this resource can be notified to respond. This attribute is only used if the market type is not supplied.
- latestSchedMktType
This indicates the latest schedule market type a contract can be applied to. This is used in conjunction with the latestSchedMinutes attribute to determine the latest time this contract can be called in. The possible values for this attribute are: DAM, RTM or it can be omitted. If omitted, the latestSchedMinutes attribute defines the value.
- maxNetDependableCapacity
Maximum Net Dependable Capacity
- maximumScheduleQuantity
Maximum schedule MW quantity
- maximumServiceHours
Maximum service hours
- maximumStartups
Maximum startups
- minimumLoad
Minimum Load
- minimumScheduleQuantity
Minimum schedule quanity
- physicalRightsDAM
Flag to indicate this contract provides physical rights in the DA Market
- physicalRightsRTM
Flag to indicate this contract provides physical rights in the RT Market
- startupLeadTime
Start up lead time
- BidSelfSched
BidSelfSched undocumented
- Chain_TransmissionRightChain
TransmissionRightChain undocumented
- ContractDistributionFactor
ContractDistributionFactor undocumented
- Ind_TransmissionRightChain
TransmissionRightChain undocumented
- RTO
RTO undocumented
- SchedulingCoordinator
SchedulingCoordinator undocumented
- SubstitutionResourceList
SubstitutionResourceList undocumented
- TREntitlement
TREntitlement undocumented
- TRType
Transmission Right type - is this an individual contract right or a chain contract right. Types = CHAIN or INDIVIDUAL
- TransmissionInterfaceEntitlement
TransmissionInterfaceRightEntitlement undocumented
-
final
case class
ContractorItem(WorkIdentifiedObject: WorkIdentifiedObject = null, activityCode: String = null, bidAmount: Double = 0.0, cost: Double = 0.0, status: String = null, ErpPayables: List[String] = null, WorkCostDetail: String = null, WorkTask: String = null) extends Element with Product with Serializable
Contractor information for work task.
Contractor information for work task.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- activityCode
Activity code identifies a specific and distinguishable unit of work.
- bidAmount
The amount that a given contractor will charge for performing this unit of work.
- cost
The total amount charged.
- status
undocumented
- ErpPayables
ErpPayable undocumented
- WorkCostDetail
WorkCostDetail undocumented
- WorkTask
OldWorkTask undocumented
-
final
case class
Control(IOPoint: IOPoint = null, controlType: String = null, operationInProgress: Boolean = false, timeStamp: String = null, unitMultiplier: String = null, unitSymbol: String = null, ControlAction: String = null, PowerSystemResource: String = null, RemoteControl: String = null) extends Element with Product with Serializable
Control is used for supervisory/device control.
Control is used for supervisory/device control.
It represents control outputs that are used to change the state in a process, e.g. close or open breaker, a set point value or a raise lower command.
- IOPoint
IOPoint Reference to the superclass object.
- controlType
Specifies the type of Control, e.g. BreakerOn/Off, GeneratorVoltageSetPoint, TieLineFlow etc. The ControlType.name shall be unique among all specified types and describe the type.
- operationInProgress
Indicates that a client is currently sending control commands that has not completed.
- timeStamp
The last time a control output was sent.
- unitMultiplier
The unit multiplier of the controlled quantity.
- unitSymbol
The unit of measure of the controlled quantity.
- ControlAction
ControlAction undocumented
- PowerSystemResource
PowerSystemResource Regulating device governed by this control output.
- RemoteControl
RemoteControl The remote point controlling the physical actuator.
-
final
case class
ControlAction(SwitchingAction: SwitchingAction = null, analogValue: Double = 0.0, discreteValue: Int = 0, Control: String = null) extends Element with Product with Serializable
Control executed as a switching step.
Control executed as a switching step.
- SwitchingAction
SwitchingAction Reference to the superclass object.
- analogValue
The analog value used for the analog control, the raise/lower control and the set point control
- discreteValue
The integer value used for the command or the accumulator reset.
- Control
Control undocumented
-
final
case class
ControlArea(PowerSystemResource: PowerSystemResource = null, netInterchange: Double = 0.0, pTolerance: Double = 0.0, type: String = null, ControlAreaGeneratingUnit: List[String] = null, EnergyArea: String = null, TieFlow: List[String] = null) extends Element with Product with Serializable
A control area is a grouping of generating units and/or loads and a cutset of tie lines (as terminals) which may be used for a variety of purposes including automatic generation control, power flow solution area interchange control specification, and input to load forecasting.
A control area is a grouping of generating units and/or loads and a cutset of tie lines (as terminals) which may be used for a variety of purposes including automatic generation control, power flow solution area interchange control specification, and input to load forecasting.
All generation and load within the area defined by the terminals on the border are considered in the area interchange control. Note that any number of overlapping control area specifications can be superimposed on the physical model. The following general principles apply to ControlArea: 1. The control area orientation for net interchange is positive for an import, negative for an export. 2. The control area net interchange is determined by summing flows in Terminals. The Terminals are identified by creating a set of TieFlow objects associated with a ControlArea object. Each TieFlow object identifies one Terminal. 3. In a single network model, a tie between two control areas must be modelled in both control area specifications, such that the two representations of the tie flow sum to zero. 4. The normal orientation of Terminal flow is positive for flow into the conducting equipment that owns the Terminal. (i.e. flow from a bus into a device is positive.) However, the orientation of each flow in the control area specification must align with the control area convention, i.e. import is positive. If the orientation of the Terminal flow referenced by a TieFlow is positive into the control area, then this is confirmed by setting TieFlow.positiveFlowIn flag TRUE. If not, the orientation must be reversed by setting the TieFlow.positiveFlowIn flag FALSE.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- netInterchange
The specified positive net interchange into the control area, i.e. positive sign means flow into the area.
- pTolerance
Active power net interchange tolerance. The attribute shall be a positive value or zero.
- type
The primary type of control area definition used to determine if this is used for automatic generation control, for planning interchange control, or other purposes. A control area specified with primary type of automatic generation control could still be forecast and used as an interchange area in power flow analysis.
- ControlAreaGeneratingUnit
ControlAreaGeneratingUnit The generating unit specifications for the control area.
- EnergyArea
EnergyArea The energy area that is forecast from this control area specification.
- TieFlow
TieFlow The tie flows associated with the control area.
-
final
case class
ControlAreaDesignation(Element: BasicElement = null, attained: String = null, native: String = null, RegisteredResource: List[String] = null, SubControlArea: List[String] = null) extends Element with Product with Serializable
Indicates Control Area associated with self-schedule.
Indicates Control Area associated with self-schedule.
- Element
Reference to the superclass object.
- attained
Attained.
- native
Native.
- RegisteredResource
RegisteredResource undocumented
- SubControlArea
SubControlArea undocumented
-
final
case class
ControlAreaGeneratingUnit(IdentifiedObject: IdentifiedObject = null, AltGeneratingUnitMeas: List[String] = null, ControlArea: String = null, GeneratingUnit: String = null) extends Element with Product with Serializable
A control area generating unit.
A control area generating unit.
This class is needed so that alternate control area definitions may include the same generating unit. It should be noted that only one instance within a control area should reference a specific generating unit.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- AltGeneratingUnitMeas
AltGeneratingUnitMeas The link to prioritized measurements for this GeneratingUnit.
- ControlArea
ControlArea The parent control area for the generating unit specifications.
- GeneratingUnit
GeneratingUnit The generating unit specified for this control area. Note that a control area should include a GeneratingUnit only once.
-
final
case class
ControlAreaOperator(Organisation: Organisation = null, CAChildOf: List[String] = null, ControlledBy: String = null) extends Element with Product with Serializable
Operates the Control Area.
Operates the Control Area.
Approves and implements energy transactions. Verifies both Inter-Control Area and Intra-Control Area transactions for the power system before granting approval (and implementing) the transactions.
- Organisation
Organisation Reference to the superclass object.
- CAChildOf
TieLine A ControlAreaOperator has a collection of tie points that ring the ControlArea, called a TieLine.
- ControlledBy
HostControlArea A ControlAreaCompany controls a ControlArea.
-
final
case class
ControlAreaSolutionData(Element: BasicElement = null, solvedInterchange: Double = 0.0, solvedLosses: Double = 0.0, MktControlArea: String = null) extends Element with Product with Serializable
State Estimator Solution Pool Interchange and Losses.
State Estimator Solution Pool Interchange and Losses.
- Element
Reference to the superclass object.
- solvedInterchange
Pool MW Interchange Attribute Usage: The active power interchange of the pool
- solvedLosses
Pool Losses MW Attribute Usage: The active power losses of the pool in MW
- MktControlArea
MktControlArea undocumented
-
final
case class
ControlledAppliance(Element: BasicElement = null, isElectricVehicle: Boolean = false, isExteriorLighting: Boolean = false, isGenerationSystem: Boolean = false, isHvacCompressorOrFurnace: Boolean = false, isInteriorLighting: Boolean = false, isIrrigationPump: Boolean = false, isManagedCommercialIndustrialLoad: Boolean = false, isPoolPumpSpaJacuzzi: Boolean = false, isSimpleMiscLoad: Boolean = false, isSmartAppliance: Boolean = false, isStripAndBaseboardHeater: Boolean = false, isWaterHeater: Boolean = false) extends Element with Product with Serializable
Appliance controlled with a PAN device control.
Appliance controlled with a PAN device control.
- Element
Reference to the superclass object.
- isElectricVehicle
True if the appliance is an electric vehicle.
- isExteriorLighting
True if the appliance is exterior lighting.
- isGenerationSystem
True if the appliance is a generation system.
- isHvacCompressorOrFurnace
True if the appliance is HVAC compressor or furnace.
- isInteriorLighting
True if the appliance is interior lighting.
- isIrrigationPump
True if the appliance is an irrigation pump.
- isManagedCommercialIndustrialLoad
True if the appliance is managed commercial or industrial load.
- isPoolPumpSpaJacuzzi
True if the appliance is a pool, pump, spa or jacuzzi.
- isSimpleMiscLoad
True if the appliance is a simple miscellaneous load.
- isSmartAppliance
True if the appliance is a smart appliance.
- isStripAndBaseboardHeater
True if the appliance is a stip or baseboard heater.
- isWaterHeater
True if the appliance is a water heater.
-
final
case class
CoolingPowerRating(IdentifiedObject: IdentifiedObject = null, coolingKind: String = null, powerRating: Double = 0.0, stage: Int = 0, Reconditionings: List[String] = null) extends Element with Product with Serializable
There are often stages of power which are associated with stages of cooling.
There are often stages of power which are associated with stages of cooling.
For instance, a transformer may be rated 121kV on the primary, 15kV on the secondary and 4kV on the tertiary winding. These are voltage ratings and the power ratings are generally the same for all three windings and independent of the voltage ratings, there are instances where the tertiary may have a lower power rating. For example, for three stages, the power rating may be 15/20/25 MVA and the cooling is OA/FA/FOA. The 15 MVA rating goes with the OA cooling (Oil and Air cooling). This is called the self cooled rating as there are no external cooling enhancements. The 20 MVA rating goes with the FA cooling (Forced Air cooling), this means that when the fans are running and thus enhancing the cooling characteristics, the transformer can operate at a power level of 20 MVA. The 25 MVA rating goes with the FOA cooling (Forced Oil and Air cooling), this means that when the fans and pumps are running and thus enhancing the cooling characteristics even more than before, the transformer can operate at a power level of 25 MVA. This 15/20/25 MVA does not state how the power is split between the various windings. It may be 25 MVA input on the primary, 25 MVA output on the secondary and 0 MVA output on the tertiary. It may also operate at 25 MVA input on the primary, 17 MVA output on the secondary and 8 MVA output on the tertiary.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- coolingKind
Kind of cooling system.
- powerRating
The power rating associated with type of cooling specified for this stage.
- stage
Stage of cooling and associated power rating.
- Reconditionings
Reconditioning undocumented
-
final
case class
CoordinateSystem(IdentifiedObject: IdentifiedObject = null, crsUrn: String = null, Locations: List[String] = null) extends Element with Product with Serializable
Coordinate reference system.
Coordinate reference system.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- crsUrn
A Uniform Resource Name (URN) for the coordinate reference system (crs) used to define 'Location. PositionPoints'. An example would be the European Petroleum Survey Group (EPSG) code for a coordinate reference system, defined in URN under the Open Geospatial Consortium (OGC) namespace as: urn:ogc:def:crs:EPSG::XXXX, where XXXX is an EPSG code (a full list of codes can be found at the EPSG Registry web site http://www.epsg-registry.org/). To define the coordinate system as being WGS84 (latitude, longitude) using an EPSG OGC, this attribute would be urn:ogc:def:crs:EPSG::4236. A profile should limit this code to a set of allowed URNs agreed to by all sending and receiving parties.
- Locations
Location All locations described with position points in this coordinate system.
-
final
case class
CostType(WorkIdentifiedObject: WorkIdentifiedObject = null, amountAssignable: Boolean = false, code: String = null, level: String = null, stage: String = null, status: String = null, ChildCostTypes: List[String] = null, CompatibleUnits: List[String] = null, ErpJournalEntries: List[String] = null, ParentCostType: String = null, WorkCostDetails: List[String] = null) extends Element with Product with Serializable
A categorization for resources, often costs, in accounting transactions.
A categorization for resources, often costs, in accounting transactions.
Examples include: material components, building in service, coal sales, overhead, etc.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- amountAssignable
True if an amount can be assigned to the resource element (e.g., building in service, transmission plant, software development capital); false otherwise (e.g., internal labor, material components).
- code
A codified representation of the resource element.
- level
The level of the resource element in the hierarchy of resource elements (recursive relationship).
- stage
The stage for which this costType applies: estimated design, estimated actual or actual actual.
- status
undocumented
- ChildCostTypes
CostType undocumented
- CompatibleUnits
CompatibleUnit undocumented
- ErpJournalEntries
ErpJournalEntry undocumented
- ParentCostType
CostType undocumented
- WorkCostDetails
WorkCostDetail undocumented
-
final
case class
Craft(IdentifiedObject: IdentifiedObject = null, status: String = null, type: String = null, Capabilities: List[String] = null, ErpPersons: List[String] = null, Skills: List[String] = null) extends Element with Product with Serializable
Craft of a person or a crew.
Craft of a person or a crew.
Examples include overhead electric, underground electric, high pressure gas, etc. This ensures necessary knowledge and skills before being allowed to perform certain types of work.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- status
undocumented
- type
Classification by utility's work mangement standards and practices.
- Capabilities
Capability undocumented
- ErpPersons
OldPerson undocumented
- Skills
Skill undocumented
-
final
case class
Crew(IdentifiedObject: IdentifiedObject = null, status: String = null, CrewMembers: List[String] = null, CrewType: String = null, FieldDispatchHistory: List[String] = null, Location: String = null, Outage: List[String] = null, SwitchingAction: String = null, WorkAssets: List[String] = null, WorkTasks: List[String] = null) extends Element with Product with Serializable
Group of people with specific skills, tools, and vehicles.
Group of people with specific skills, tools, and vehicles.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- status
Status Status of this crew.
- CrewMembers
CrewMember All members of this crew.
- CrewType
CrewType Type of this crew.
- FieldDispatchHistory
FieldDispatchHistory undocumented
- Location
Location undocumented
- Outage
Outage undocumented
- SwitchingAction
SwitchingAction undocumented
- WorkAssets
WorkAsset All work assets used by this crew.
- WorkTasks
WorkTask All work tasks this crew participates in.
-
final
case class
CrewMember(OperationPersonRole: OperationPersonRole = null, Crew: String = null) extends Element with Product with Serializable
Member of a crew.
Member of a crew.
- OperationPersonRole
OperationPersonRole Reference to the superclass object.
- Crew
Crew Crew to which this crew member belongs.
-
final
case class
CrewType(IdentifiedObject: IdentifiedObject = null, Crews: List[String] = null) extends Element with Product with Serializable
Custom description of the type of crew.
Custom description of the type of crew.
This may be used to determine the type of work the crew can be assigned to. Examples include repair, tree trimming, switching, etc.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- Crews
Crew All crews of this type.
-
final
case class
CrossCompoundTurbineGovernorDynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null, HighPressureSynchronousMachineDynamics: String = null, LowPressureSynchronousMachineDynamics: String = null) extends Element with Product with Serializable
Turbine-governor cross-compound function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
Turbine-governor cross-compound function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- HighPressureSynchronousMachineDynamics
SynchronousMachineDynamics High-pressure synchronous machine with which this cross-compound turbine governor is associated.
- LowPressureSynchronousMachineDynamics
SynchronousMachineDynamics Low-pressure synchronous machine with which this cross-compound turbine governor is associated.
-
final
case class
CsConverter(ACDCConverter: ACDCConverter = null, alpha: Double = 0.0, gamma: Double = 0.0, maxAlpha: Double = 0.0, maxGamma: Double = 0.0, maxIdc: Double = 0.0, minAlpha: Double = 0.0, minGamma: Double = 0.0, minIdc: Double = 0.0, operatingMode: String = null, pPccControl: String = null, ratedIdc: Double = 0.0, targetAlpha: Double = 0.0, targetGamma: Double = 0.0, targetIdc: Double = 0.0, CSCDynamics: String = null) extends Element with Product with Serializable
DC side of the current source converter (CSC).
DC side of the current source converter (CSC).
The firing angle controls the dc voltage at the converter, both for rectifier and inverter. The difference between the dc voltages of the rectifier and inverter determines the dc current. The extinction angle is used to limit the dc voltage at the inverter, if needed, and is not used in active power control. The firing angle, transformer tap position and number of connected filters are the primary means to control a current source dc line. Higher level controls are built on top, e.g. dc voltage, dc current and active power. From a steady state perspective it is sufficient to specify the wanted active power transfer (ACDCConverter.targetPpcc) and the control functions will set the dc voltage, dc current, firing angle, transformer tap position and number of connected filters to meet this. Therefore attributes targetAlpha and targetGamma are not applicable in this case. The reactive power consumed by the converter is a function of the firing angle, transformer tap position and number of connected filter, which can be approximated with half of the active power. The losses is a function of the dc voltage and dc current. The attributes minAlpha and maxAlpha define the range of firing angles for rectifier operation between which no discrete tap changer action takes place. The range is typically 10-18 degrees. The attributes minGamma and maxGamma define the range of extinction angles for inverter operation between which no discrete tap changer action takes place. The range is typically 17-20 degrees.
- ACDCConverter
ACDCConverter Reference to the superclass object.
- alpha
Firing angle that determines the dc voltage at the converter dc terminal. Typical value between 10 degrees and 18 degrees for a rectifier. It is converter’s state variable, result from power flow. The attribute shall be a positive value.
- gamma
Extinction angle. It is used to limit the dc voltage at the inverter if needed. Typical value between 17 degrees and 20 degrees for an inverter. It is converter’s state variable, result from power flow. The attribute shall be a positive value.
- maxAlpha
Maximum firing angle. It is converter’s configuration data used in power flow. The attribute shall be a positive value.
- maxGamma
Maximum extinction angle. It is converter’s configuration data used in power flow. The attribute shall be a positive value.
- maxIdc
The maximum direct current (Id) on the DC side at which the converter should operate. It is converter’s configuration data use in power flow. The attribute shall be a positive value.
- minAlpha
Minimum firing angle. It is converter’s configuration data used in power flow. The attribute shall be a positive value.
- minGamma
Minimum extinction angle. It is converter’s configuration data used in power flow. The attribute shall be a positive value.
- minIdc
The minimum direct current (Id) on the DC side at which the converter should operate. It is converter’s configuration data used in power flow. The attribute shall be a positive value.
- operatingMode
Indicates whether the DC pole is operating as an inverter or as a rectifier. It is converter’s control variable used in power flow.
- pPccControl
Kind of active power control.
- ratedIdc
Rated converter DC current, also called IdN. The attribute shall be a positive value. It is converter’s configuration data used in power flow.
- targetAlpha
Target firing angle. It is converter’s control variable used in power flow. It is only applicable for rectifier if continuous tap changer control is used. Allowed values are within the range minAlpha<=targetAlpha<=maxAlpha. The attribute shall be a positive value.
- targetGamma
Target extinction angle. It is converter’s control variable used in power flow. It is only applicable for inverter if continuous tap changer control is used. Allowed values are within the range minGamma<=targetGamma<=maxGamma. The attribute shall be a positive value.
- targetIdc
DC current target value. It is converter’s control variable used in power flow. The attribute shall be a positive value.
- CSCDynamics
CSCDynamics Current source converter dynamics model used to describe dynamic behaviour of this converter.
-
final
case class
CurrentEmergencyScheduledInterchange(IdentifiedObject: IdentifiedObject = null, emergencyScheduleMW: Double = 0.0, emergencyScheduleRampTime: Int = 0, emergencyScheduleStartTime: String = null, InternalControlArea: String = null) extends Element with Product with Serializable
Control area emergency schedules
Control area emergency schedules
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- emergencyScheduleMW
Net tie MW. These are three entries, the current emergency schedule interchange and the two future schedules if they exist.
- emergencyScheduleRampTime
Ramp time, the ramping time for a schedule. This is calculated as the remaining time to ramp if a schedule is ramping. Measured in seconds, but can be negattive.
- emergencyScheduleStartTime
Net tie time, the start time for a schedule. This is calculated as the current time if a schedule is ramping.
- InternalControlArea
InternalControlArea undocumented
-
final
case class
CurrentLimit(OperationalLimit: OperationalLimit = null, normalValue: Double = 0.0, value: Double = 0.0) extends Element with Product with Serializable
Operational limit on current.
Operational limit on current.
- OperationalLimit
OperationalLimit Reference to the superclass object.
- normalValue
The normal value for limit on current flow. The attribute shall be a positive value or zero.
- value
Limit on current flow. The attribute shall be a positive value or zero.
-
final
case class
CurrentRelay(ProtectionEquipment: ProtectionEquipment = null, currentLimit1: Double = 0.0, currentLimit2: Double = 0.0, currentLimit3: Double = 0.0, inverseTimeFlag: Boolean = false, timeDelay1: Double = 0.0, timeDelay2: Double = 0.0, timeDelay3: Double = 0.0) extends Element with Product with Serializable
A device that checks current flow values in any direction or designated direction.
A device that checks current flow values in any direction or designated direction.
- ProtectionEquipment
ProtectionEquipment Reference to the superclass object.
- currentLimit1
Current limit number one 1 for inverse time pickup.
- currentLimit2
Current limit number 2 for inverse time pickup.
- currentLimit3
Current limit number 3 for inverse time pickup.
- inverseTimeFlag
Set true if the current relay has inverse time characteristic.
- timeDelay1
Inverse time delay number 1 for current limit number 1.
- timeDelay2
Inverse time delay number 2 for current limit number 2.
- timeDelay3
Inverse time delay number 3 for current limit number 3.
-
final
case class
CurrentScheduledInterchange(Element: BasicElement = null, currentNetTieMW: Double = 0.0, useEmergencySchedule: Boolean = false, InternalControlArea: String = null) extends Element with Product with Serializable
Control area current net tie (scheduled interchange) sent to real time dispatch.
Control area current net tie (scheduled interchange) sent to real time dispatch.
- Element
Reference to the superclass object.
- currentNetTieMW
Current control area net tie MW (the sum of the tie line flows, i.e the sum of flows into and out of the control area), the current instantaneous scheduled interchange.
- useEmergencySchedule
Use Emergency Schedule Attribute Usage: Emergency use indicator, false = Emergency Schedular OFF, true = Emergency Schedular ON.
- InternalControlArea
InternalControlArea undocumented
- final case class CurrentState(IdentifiedObject: IdentifiedObject = null) extends Element with Product with Serializable
-
final
case class
CurrentTransformer(Sensor: Sensor = null, accuracyClass: String = null, accuracyLimit: Double = 0.0, coreBurden: Double = 0.0, ctClass: String = null, usage: String = null) extends Element with Product with Serializable
Instrument transformer used to measure electrical qualities of the circuit that is being protected and/or monitored.
Instrument transformer used to measure electrical qualities of the circuit that is being protected and/or monitored.
Typically used as current transducer for the purpose of metering or protection. A typical secondary current rating would be 5A.
- Sensor
Sensor Reference to the superclass object.
- accuracyClass
CT accuracy classification.
- accuracyLimit
Percent of rated current for which the CT remains accurate within specified limits.
- coreBurden
Power burden of the CT core.
- ctClass
CT classification; i.e. class 10P.
- usage
Intended usage of the CT; i.e. metering, protection.
-
final
case class
CurrentTransformerInfo(AssetInfo: AssetInfo = null, accuracyClass: String = null, accuracyLimit: Double = 0.0, coreCount: Int = 0, ctClass: String = null, kneePointCurrent: Double = 0.0, kneePointVoltage: Double = 0.0, maxRatio: String = null, nominalRatio: String = null, primaryFlsRating: Double = 0.0, primaryRatio: String = null, ratedCurrent: Double = 0.0, secondaryFlsRating: Double = 0.0, secondaryRatio: String = null, tertiaryFlsRating: Double = 0.0, tertiaryRatio: String = null, usage: String = null) extends Element with Product with Serializable
Properties of current transformer asset.
Properties of current transformer asset.
- AssetInfo
AssetInfo Reference to the superclass object.
- accuracyClass
CT accuracy classification.
- accuracyLimit
Accuracy limit.
- coreCount
Number of cores.
- ctClass
undocumented
- kneePointCurrent
Maximum primary current where the CT still displays linear characteristicts.
- kneePointVoltage
Maximum voltage across the secondary terminals where the CT still displays linear characteristicts.
- maxRatio
Maximum ratio between the primary and secondary current.
- nominalRatio
Nominal ratio between the primary and secondary current; i.e. 100:5.
- primaryFlsRating
Full load secondary (FLS) rating for primary winding.
- primaryRatio
Ratio for the primary winding tap changer.
- ratedCurrent
Rated current on the primary side.
- secondaryFlsRating
Full load secondary (FLS) rating for secondary winding.
- secondaryRatio
Ratio for the secondary winding tap changer.
- tertiaryFlsRating
Full load secondary (FLS) rating for tertiary winding.
- tertiaryRatio
Ratio for the tertiary winding tap changer.
- usage
Usage: eg. metering, protection, etc.
-
final
case class
CurtailmentProfile(Profile: Profile = null, EnergyTransaction: String = null) extends Element with Product with Serializable
Curtailing entity must be providing at least one service to the EnergyTransaction.
Curtailing entity must be providing at least one service to the EnergyTransaction.
The CurtailmentProfile must be completely contained within the EnergyProfile timeframe for this EnergyTransaction.
- Profile
Profile Reference to the superclass object.
- EnergyTransaction
EnergyTransaction An EnergyTransaction may be curtailed by any of the participating entities.
-
final
case class
Curve(IdentifiedObject: IdentifiedObject = null, curveStyle: String = null, xMultiplier: String = null, xUnit: String = null, y1Multiplier: String = null, y1Unit: String = null, y2Multiplier: String = null, y2Unit: String = null, y3Multiplier: String = null, y3Unit: String = null, CurveDatas: List[String] = null) extends Element with Product with Serializable
A multi-purpose curve or functional relationship between an independent variable (X-axis) and dependent (Y-axis) variables.
A multi-purpose curve or functional relationship between an independent variable (X-axis) and dependent (Y-axis) variables.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- curveStyle
The style or shape of the curve.
- xMultiplier
Multiplier for X-axis.
- xUnit
The X-axis units of measure.
- y1Multiplier
Multiplier for Y1-axis.
- y1Unit
The Y1-axis units of measure.
- y2Multiplier
Multiplier for Y2-axis.
- y2Unit
The Y2-axis units of measure.
- y3Multiplier
Multiplier for Y3-axis.
- y3Unit
The Y3-axis units of measure.
- CurveDatas
CurveData The point data values that define this curve.
-
final
case class
CurveData(Element: BasicElement = null, xvalue: Double = 0.0, y1value: Double = 0.0, y2value: Double = 0.0, y3value: Double = 0.0, Curve: String = null) extends Element with Product with Serializable
Multi-purpose data points for defining a curve.
Multi-purpose data points for defining a curve.
The use of this generic class is discouraged if a more specific class can be used to specify the X and Y axis values along with their specific data types.
- Element
Reference to the superclass object.
- xvalue
The data value of the X-axis variable, depending on the X-axis units.
- y1value
The data value of the first Y-axis variable, depending on the Y-axis units.
- y2value
The data value of the second Y-axis variable (if present), depending on the Y-axis units.
- y3value
The data value of the third Y-axis variable (if present), depending on the Y-axis units.
- Curve
Curve The curve of this curve data point.
-
final
case class
Customer(OrganisationRole: OrganisationRole = null, kind: String = null, locale: String = null, priority: String = null, pucNumber: String = null, specialNeed: String = null, status: String = null, vip: Boolean = false, CustomerAccounts: List[String] = null, CustomerAgreements: List[String] = null, CustomerNotifications: List[String] = null, Customer_attr: List[String] = null, EndDevices: List[String] = null, ErpPersons: List[String] = null, OutagePlan: String = null, PlannedOutageNotification: List[String] = null, TroubleTickets: List[String] = null, Works: List[String] = null) extends Element with Product with Serializable
Organisation receiving services from service supplier.
Organisation receiving services from service supplier.
- OrganisationRole
OrganisationRole Reference to the superclass object.
- kind
Kind of customer.
- locale
Locale designating language to use in communications with this customer.
- priority
Priority of the customer.
- pucNumber
(if applicable) Public utilities commission (PUC) identification number.
- specialNeed
True if customer organisation has special service needs such as life support, hospitals, etc.
- status
Status of this customer.
- vip
(deprecated) (use 'priority' instead) True if this is an important customer. Importance is for matters different than those in 'specialNeed' attribute.
- CustomerAccounts
CustomerAccount All accounts of this customer.
- CustomerAgreements
CustomerAgreement All agreements of this customer.
- CustomerNotifications
CustomerNotification All notifications required by this customer.
- Customer_attr
Customer undocumented
- EndDevices
EndDevice All end devices of this customer.
- ErpPersons
OldPerson undocumented
- OutagePlan
OutagePlan The outage plan that identifies the customers that are affected.
- PlannedOutageNotification
PlannedOutageNotification undocumented
- TroubleTickets
TroubleTicket All trouble tickets for this customer.
- Works
Work All the works performed for this customer.
-
final
case class
CustomerAccount(Document: Document = null, billingCycle: String = null, budgetBill: String = null, lastBillAmount: Double = 0.0, AccountNotification: List[String] = null, Customer: String = null, CustomerAgreements: List[String] = null, CustomerBillingInfos: List[String] = null, ErpInvoicees: List[String] = null, PaymentTransactions: List[String] = null, WorkBillingInfos: List[String] = null) extends Element with Product with Serializable
Assignment of a group of products and services purchased by the customer through a customer agreement, used as a mechanism for customer billing and payment.
Assignment of a group of products and services purchased by the customer through a customer agreement, used as a mechanism for customer billing and payment.
It contains common information from the various types of customer agreements to create billings (invoices) for a customer and receive payment.
- Document
Document Reference to the superclass object.
- billingCycle
Cycle day on which the associated customer account will normally be billed, used to determine when to produce the billing.
- budgetBill
Budget bill code.
- lastBillAmount
The last amount that will be billed to the customer prior to shut off of the account.
- AccountNotification
AccountNotification undocumented
- Customer
Customer Customer owning this account.
- CustomerAgreements
CustomerAgreement All agreements for this customer account.
- CustomerBillingInfos
CustomerBillingInfo undocumented
- ErpInvoicees
ErpInvoice undocumented
- PaymentTransactions
Transaction All payment transactions for this customer account.
- WorkBillingInfos
WorkBillingInfo undocumented
-
final
case class
CustomerAgreement(Agreement: Agreement = null, isPrePay: Boolean = false, loadMgmt: String = null, shutOffDateTime: String = null, AuxiliaryAgreements: List[String] = null, Customer: String = null, CustomerAccount: String = null, DemandResponsePrograms: List[String] = null, MeterReadings: List[String] = null, PricingStructures: List[String] = null, ServiceCategory: String = null, ServiceLocations: List[String] = null, ServiceSupplier: String = null, StandardIndustryCode: String = null, UsagePoints: List[String] = null) extends Element with Product with Serializable
Agreement between the customer and the service supplier to pay for service at a specific service location.
Agreement between the customer and the service supplier to pay for service at a specific service location.
It records certain billing information about the type of service provided at the service location and is used during charge creation to determine the type of service.
- Agreement
Agreement Reference to the superclass object.
- isPrePay
If true, the customer is a pre-pay customer for the specified service.
- loadMgmt
Load management code.
- shutOffDateTime
Final date and time the service will be billed to the previous customer.
- AuxiliaryAgreements
AuxiliaryAgreement All (non-service related) auxiliary agreements that refer to this customer agreement.
- Customer
Customer Customer for this agreement.
- CustomerAccount
CustomerAccount Customer account owning this agreement.
- DemandResponsePrograms
DemandResponseProgram All demand response programs the customer is enrolled in through this customer agreement.
- MeterReadings
MeterReading (could be deprecated in the future) All meter readings for this customer agreement.
- PricingStructures
PricingStructure All pricing structures applicable to this customer agreement.
- ServiceCategory
ServiceCategory Service category for this agreement.
- ServiceLocations
ServiceLocation All service locations regulated by this customer agreement.
- ServiceSupplier
ServiceSupplier Service supplier for this customer agreement.
- StandardIndustryCode
StandardIndustryCode undocumented
- UsagePoints
UsagePoint All service delivery points regulated by this customer agreement.
-
final
case class
CustomerBillingInfo(Document: Document = null, billingDate: String = null, dueDate: String = null, kind: String = null, lastPaymentAmt: Double = 0.0, lastPaymentDate: String = null, outBalance: Double = 0.0, pymtPlanAmt: Double = 0.0, pymtPlanType: String = null, CustomerAccount: String = null, ErpInvoiceLineItems: List[String] = null) extends Element with Product with Serializable
The creation of the monthly customer billing statements is the method employed to notify Customers of charges, adjustments and credits applied to their account for Services and Products.
The creation of the monthly customer billing statements is the method employed to notify Customers of charges, adjustments and credits applied to their account for Services and Products.
The actuall billing occurs through an ErpInvoice. The CustomerBillingInfo includes information from the payment, collection, meter reading, installed meter, service, site, customer, customer account, customer agreement, services and pricing subject areas. Each component price shows up as a separate line item on the ErpInvoice. The Customer Billing Statement may include collection and account messages, marketing/civic event messages and bill inserts. One Customer Billing Statement is produced for all Agreements under a CustomerAccount per billing cycle date defined in 'CustomerAccount.billingCycle'. The history of CustomerBillingInfo, Invoices and Payments is to be maintained in associated ActivityRecords.
- Document
Document Reference to the superclass object.
- billingDate
Business date designated for the billing run which produced this CustomerBillingInfo.
- dueDate
Calculated date upon which a customer billing amount is due, used in the invoicing process to determine when a Customer's Payment is delinquent. It takes into consideration the regulatory criteria and the Customer's requested due date. In the absence of a Customer requested due date, the due date is typically calculated from the regulated number of days and the 'billingDate'.
- kind
Kind of bill customer receives.
- lastPaymentAmt
Amount of the last payment received from the customer. It is retained in the Customer Billing system, although the details of each payment are tracked in the ERP system.
- lastPaymentDate
Date of the last payment received from the customer. It is retained in the Customer Billing system, although the details of each payment are tracked in the ERP system.
- outBalance
Outstanding balance on the CustomerAccount as of the statement date.
- pymtPlanAmt
Monthly amortized amount due during each billing cycle for the CustomerAccount balance for which the Payment Plan is set-up.
- pymtPlanType
Type of payment plan.
- CustomerAccount
CustomerAccount undocumented
- ErpInvoiceLineItems
ErpInvoiceLineItem undocumented
-
final
case class
CustomerConsumer(Organisation: Organisation = null, CustChildOf: List[String] = null) extends Element with Product with Serializable
The energy buyer in the energy marketplace.
The energy buyer in the energy marketplace.
- Organisation
Organisation Reference to the superclass object.
- CustChildOf
TieLine A ControlAreaOperator or CustomerConsumer may ring their perimeter with metering, which can create a unique SubControlArea at the collection of metering points, called a TieLine.
-
final
case class
CustomerNotification(Element: BasicElement = null, contactType: String = null, contactValue: String = null, earliestDateTimeToCall: String = null, latestDateTimeToCall: String = null, trigger: String = null, Customer: String = null, Incident: String = null, TroubleTickets: List[String] = null) extends Element with Product with Serializable
Conditions for notifying the customer about the changes in the status of their service (e.g., outage restore, estimated restoration time, tariff or service level change, etc.)
Conditions for notifying the customer about the changes in the status of their service (e.g., outage restore, estimated restoration time, tariff or service level change, etc.)
- Element
Reference to the superclass object.
- contactType
Type of contact (e.g., phone, email, etc.).
- contactValue
Value of contact type (e.g., phone number, email address, etc.).
- earliestDateTimeToCall
Earliest date time to call the customer.
- latestDateTimeToCall
Latest date time to call the customer.
- trigger
Trigger for this notification.
- Customer
Customer Customer requiring this notification.
- Incident
Incident Incident as a subject of this customer notification.
- TroubleTickets
TroubleTicket All trouble tickets with this notification.
-
final
case class
Cut(Switch: Switch = null, lengthFromTerminal1: Double = 0.0, ACLineSegment: String = null, CutAction: String = null) extends Element with Product with Serializable
A cut separates a line segment into two parts.
A cut separates a line segment into two parts.
The cut appears as a switch inserted between these two parts and connects them together. As the cut is normally open there is no galvanic connection between the two line segment parts. But it is possible to close the cut to get galvanic connection. The cut terminals are oriented towards the line segment terminals with the same sequence number. Hence the cut terminal with sequence number equal to 1 is oriented to the line segment's terminal with sequence number equal to 1. The cut terminals also act as connection points for jumpers and other equipment, e.g. a mobile generator. To enable this, connectivity nodes are placed at the cut terminals. Once the connectivity nodes are in place any conducting equipment can be connected at them.
- Switch
Switch Reference to the superclass object.
- lengthFromTerminal1
The length to the place where the cut is located starting from side one of the cut line segment, i.e. the line segment Terminal with sequenceNumber equal to 1.
- ACLineSegment
ACLineSegment The line segment to which the cut is applied.
- CutAction
CutAction Action taken with this cut.
-
final
case class
CutAction(SwitchingAction: SwitchingAction = null, kind: String = null, Cut: String = null) extends Element with Product with Serializable
Action on cut as a switching step.
Action on cut as a switching step.
- SwitchingAction
SwitchingAction Reference to the superclass object.
- kind
Switching action to perform.
- Cut
Cut Cut on which this action is taken.
-
final
case class
Cyclone(AtmosphericPhenomenon: AtmosphericPhenomenon = null, centralPressure: Double = 0.0, maxSurfaceWindSpeed: Double = 0.0, windForce: Int = 0) extends Element with Product with Serializable
A cyclone (or tropical cyclone), a rapidly-rotating storm system characterized by a low-pressure center, strong winds, and a spiral arrangement of thunderstorms that produce heavy rain.
A cyclone (or tropical cyclone), a rapidly-rotating storm system characterized by a low-pressure center, strong winds, and a spiral arrangement of thunderstorms that produce heavy rain.
- AtmosphericPhenomenon
AtmosphericPhenomenon Reference to the superclass object.
- centralPressure
The central pressure of the cyclone during the time interval.
- maxSurfaceWindSpeed
The maximum surface wind speed of the cyclone during the time interval.
- windForce
Wind Force as classified on the Beaufort Scale (0-12) during the time interval.
-
final
case class
DCBaseTerminal(ACDCTerminal: ACDCTerminal = null, DCNode: String = null, DCTopologicalNode: String = null) extends Element with Product with Serializable
An electrical connection point at a piece of DC conducting equipment.
An electrical connection point at a piece of DC conducting equipment.
DC terminals are connected at one physical DC node that may have multiple DC terminals connected. A DC node is similar to an AC connectivity node. The model requires that DC connections are distinct from AC connections.
- ACDCTerminal
ACDCTerminal Reference to the superclass object.
- DCNode
DCNode The DC connectivity node to which this DC base terminal connects with zero impedance.
- DCTopologicalNode
DCTopologicalNode See association end Terminal. TopologicalNode.
-
final
case class
DCBreaker(DCSwitch: DCSwitch = null) extends Element with Product with Serializable
A breaker within a DC system.
A breaker within a DC system.
- DCSwitch
DCSwitch Reference to the superclass object.
-
final
case class
DCBusbar(DCConductingEquipment: DCConductingEquipment = null) extends Element with Product with Serializable
A busbar within a DC system.
A busbar within a DC system.
- DCConductingEquipment
DCConductingEquipment Reference to the superclass object.
-
final
case class
DCChopper(DCConductingEquipment: DCConductingEquipment = null) extends Element with Product with Serializable
Low resistance equipment used in the internal DC circuit to balance voltages.
Low resistance equipment used in the internal DC circuit to balance voltages.
It has typically positive and negative pole terminals and a ground.
- DCConductingEquipment
DCConductingEquipment Reference to the superclass object.
-
final
case class
DCConductingEquipment(Equipment: Equipment = null, ratedUdc: Double = 0.0, DCTerminals: List[String] = null, ProtectiveActionAdjustment: List[String] = null) extends Element with Product with Serializable
The parts of the DC power system that are designed to carry current or that are conductively connected through DC terminals.
The parts of the DC power system that are designed to carry current or that are conductively connected through DC terminals.
- Equipment
Equipment Reference to the superclass object.
- ratedUdc
Rated DC device voltage. The attribute shall be a positive value. It is configuration data used in power flow.
- DCTerminals
DCTerminal A DC conducting equipment has DC terminals.
- ProtectiveActionAdjustment
ProtectiveActionAdjustment undocumented
-
final
case class
DCConverterUnit(DCEquipmentContainer: DCEquipmentContainer = null, operationMode: String = null, Substation: String = null) extends Element with Product with Serializable
Indivisible operative unit comprising all equipment between the point of common coupling on the AC side and the point of common coupling – DC side, essentially one or more converters, together with one or more converter transformers, converter control equipment, essential protective and switching devices and auxiliaries, if any, used for conversion.
Indivisible operative unit comprising all equipment between the point of common coupling on the AC side and the point of common coupling – DC side, essentially one or more converters, together with one or more converter transformers, converter control equipment, essential protective and switching devices and auxiliaries, if any, used for conversion.
- DCEquipmentContainer
DCEquipmentContainer Reference to the superclass object.
- operationMode
The operating mode of an HVDC bipole (bipolar, monopolar metallic return, etc).
- Substation
Substation The containing substation of the DC converter unit.
-
final
case class
DCDisconnector(DCSwitch: DCSwitch = null) extends Element with Product with Serializable
A disconnector within a DC system.
A disconnector within a DC system.
- DCSwitch
DCSwitch Reference to the superclass object.
-
final
case class
DCEquipmentContainer(EquipmentContainer: EquipmentContainer = null, DCNodes: List[String] = null, DCTopologicalNode: List[String] = null) extends Element with Product with Serializable
A modelling construct to provide a root class for containment of DC as well as AC equipment.
A modelling construct to provide a root class for containment of DC as well as AC equipment.
The class differ from the EquipmentContaner for AC in that it may also contain DCNode-s. Hence it can contain both AC and DC equipment.
- EquipmentContainer
EquipmentContainer Reference to the superclass object.
- DCNodes
DCNode The DC nodes contained in the DC equipment container.
- DCTopologicalNode
DCTopologicalNode The topological nodes which belong to this connectivity node container.
-
final
case class
DCGround(DCConductingEquipment: DCConductingEquipment = null, inductance: Double = 0.0, r: Double = 0.0) extends Element with Product with Serializable
A ground within a DC system.
A ground within a DC system.
- DCConductingEquipment
DCConductingEquipment Reference to the superclass object.
- inductance
Inductance to ground.
- r
Resistance to ground.
-
final
case class
DCLine(DCEquipmentContainer: DCEquipmentContainer = null, Region: String = null) extends Element with Product with Serializable
Overhead lines and/or cables connecting two or more HVDC substations.
Overhead lines and/or cables connecting two or more HVDC substations.
- DCEquipmentContainer
DCEquipmentContainer Reference to the superclass object.
- Region
SubGeographicalRegion The SubGeographicalRegion containing the DC line.
-
final
case class
DCLineSegment(DCConductingEquipment: DCConductingEquipment = null, capacitance: Double = 0.0, inductance: Double = 0.0, len: Double = 0.0, resistance: Double = 0.0, PerLengthParameter: String = null) extends Element with Product with Serializable
A wire or combination of wires not insulated from one another, with consistent electrical characteristics, used to carry direct current between points in the DC region of the power system.
A wire or combination of wires not insulated from one another, with consistent electrical characteristics, used to carry direct current between points in the DC region of the power system.
- DCConductingEquipment
DCConductingEquipment Reference to the superclass object.
- capacitance
Capacitance of the DC line segment. Significant for cables only.
- inductance
Inductance of the DC line segment. Negligible compared with DCSeriesDevice used for smoothing.
- len
Segment length for calculating line section capabilities.
- resistance
Resistance of the DC line segment.
- PerLengthParameter
PerLengthDCLineParameter Set of per-length parameters for this line segment.
-
final
case class
DCNode(IdentifiedObject: IdentifiedObject = null, DCEquipmentContainer: String = null, DCTerminals: List[String] = null, DCTopologicalNode: String = null) extends Element with Product with Serializable
DC nodes are points where terminals of DC conducting equipment are connected together with zero impedance.
DC nodes are points where terminals of DC conducting equipment are connected together with zero impedance.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- DCEquipmentContainer
DCEquipmentContainer The DC container for the DC nodes.
- DCTerminals
DCBaseTerminal DC base terminals interconnected with zero impedance at a this DC connectivity node.
- DCTopologicalNode
DCTopologicalNode The DC topological node to which this DC connectivity node is assigned. May depend on the current state of switches in the network.
-
final
case class
DCSeriesDevice(DCConductingEquipment: DCConductingEquipment = null, inductance: Double = 0.0, resistance: Double = 0.0) extends Element with Product with Serializable
A series device within the DC system, typically a reactor used for filtering or smoothing.
A series device within the DC system, typically a reactor used for filtering or smoothing.
Needed for transient and short circuit studies.
- DCConductingEquipment
DCConductingEquipment Reference to the superclass object.
- inductance
Inductance of the device.
- resistance
Resistance of the DC device.
-
final
case class
DCShunt(DCConductingEquipment: DCConductingEquipment = null, capacitance: Double = 0.0, resistance: Double = 0.0) extends Element with Product with Serializable
A shunt device within the DC system, typically used for filtering.
A shunt device within the DC system, typically used for filtering.
Needed for transient and short circuit studies.
- DCConductingEquipment
DCConductingEquipment Reference to the superclass object.
- capacitance
Capacitance of the DC shunt.
- resistance
Resistance of the DC device.
-
final
case class
DCSwitch(DCConductingEquipment: DCConductingEquipment = null) extends Element with Product with Serializable
A switch within the DC system.
A switch within the DC system.
- DCConductingEquipment
DCConductingEquipment Reference to the superclass object.
-
final
case class
DCTerminal(DCBaseTerminal: DCBaseTerminal = null, DCConductingEquipment: String = null) extends Element with Product with Serializable
An electrical connection point to generic DC conducting equipment.
An electrical connection point to generic DC conducting equipment.
- DCBaseTerminal
DCBaseTerminal Reference to the superclass object.
- DCConductingEquipment
DCConductingEquipment An DC terminal belong to a DC conducting equipment.
-
final
case class
DCTopologicalIsland(IdentifiedObject: IdentifiedObject = null, DCTopologicalNodes: List[String] = null) extends Element with Product with Serializable
An electrically connected subset of the network.
An electrically connected subset of the network.
DC topological islands can change as the current network state changes, e.g. due to: - disconnect switches or breakers changing state in a SCADA/EMS. - manual creation, change or deletion of topological nodes in a planning tool. Only energised TopologicalNode-s shall be part of the topological island.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- DCTopologicalNodes
DCTopologicalNode The DC topological nodes in a DC topological island.
-
final
case class
DCTopologicalNode(IdentifiedObject: IdentifiedObject = null, DCEquipmentContainer: String = null, DCNodes: List[String] = null, DCTerminals: List[String] = null, DCTopologicalIsland: String = null) extends Element with Product with Serializable
DC bus.
DC bus.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- DCEquipmentContainer
DCEquipmentContainer The connectivity node container to which the topological node belongs.
- DCNodes
DCNode The DC connectivity nodes combined together to form this DC topological node. May depend on the current state of switches in the network.
- DCTerminals
DCBaseTerminal See association end TopologicalNode. Terminal.
- DCTopologicalIsland
DCTopologicalIsland A DC topological node belongs to a DC topological island.
-
final
case class
DCvoltageControl(Element: BasicElement = null, kivdc: Double = 0.0, kpvdc: Double = 0.0, vdcmax: Double = 0.0, vdcmin: Double = 0.0, Delay: String = null, VSCtype1: String = null) extends Element with Product with Serializable
DC voltage control used for voltage regulation.
DC voltage control used for voltage regulation.
- final case class DERCurveData(Element: BasicElement = null, intervalNumber: Int = 0, maxYValue: Double = 0.0, minYValue: Double = 0.0, nominalYValue: Double = 0.0, timeStamp: String = null, DERMonitorableParameter: String = null, DispatchSchedule: String = null) extends Element with Product with Serializable
- final case class DERFunction(Element: BasicElement = null, connectDisconnect: Boolean = false, frequencyWattCurveFunction: Boolean = false, maxRealPowerLimiting: Boolean = false, rampRateControl: Boolean = false, reactivePowerDispatch: Boolean = false, realPowerDispatch: Boolean = false, voltVarCurveFunction: Boolean = false, voltWattCurveFunction: Boolean = false, voltageRegulation: Boolean = false, EndDeviceGroup: List[String] = null) extends Element with Product with Serializable
- final case class DERGroupDispatch(IdentifiedObject: IdentifiedObject = null, EndDeviceGroup: List[String] = null) extends Element with Product with Serializable
- final case class DERGroupForecast(IdentifiedObject: IdentifiedObject = null, predictionCreationDate: String = null, EndDeviceGroup: List[String] = null) extends Element with Product with Serializable
- final case class DERMonitorableParameter(Element: BasicElement = null, flowDirection: String = null, yMultiplier: String = null, yUnit: String = null, yUnitInstalledMax: Double = 0.0, yUnitInstalledMin: Double = 0.0, DERCurveData: String = null, DERParameter: String = null, DispatchSchedule: List[String] = null, EndDeviceGroup: List[String] = null) extends Element with Product with Serializable
-
final
case class
DINStandard(Element: BasicElement = null, standardEdition: String = null, standardNumber: String = null) extends Element with Product with Serializable
Standard published by DIN (German Institute of Standards).
Standard published by DIN (German Institute of Standards).
- Element
Reference to the superclass object.
- standardEdition
Edition of DIN standard.
- standardNumber
DIN standard number.
-
final
case class
DataSet(Element: BasicElement = null, description: String = null, mRID: String = null, name: String = null, AlternateModel: String = null, Profile: List[String] = null) extends Element with Product with Serializable
A generic container of a version of instance data.
A generic container of a version of instance data.
The MRID can be used in an audit trail, not in reusable script intended to work with new versions of data. A dataset could be serialized multiple times and in multiple technologies, yet retain the same identity.
- Element
Reference to the superclass object.
- description
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.
- mRID
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 Edition 1, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.
- name
The name is any free human readable and possibly non unique text naming the object.
- AlternateModel
AlternateModel The alternate model using the data.
- Profile
Profile2 The profiles that describe the contents of the data set and the rules governing the contents of the data set.
-
final
case class
DatasetArg(ModelOperationArg: ModelOperationArg = null, Dataset: String = null, OperationDatasetArgDescription: String = null) extends Element with Product with Serializable
A model operation argument referencing a dataset instance.
A model operation argument referencing a dataset instance.
- ModelOperationArg
ModelOperationArg Reference to the superclass object.
- Dataset
InstanceSet Dataset referenced by this argument of a model operation..
- OperationDatasetArgDescription
DatasetArgDescription The type of role for this dataset role. Should only reference role types that belong to the operation type of the associated operation.
- final case class DatasetArgDescription(ModelOperationArgDescription: ModelOperationArgDescription = null, OperationDatasetArg: List[String] = null) extends Element with Product with Serializable
-
final
case class
DateAndOrTime(Element: BasicElement = null, date: String = null, time: String = null, MarketDocument: List[String] = null, TimeSeries: List[String] = null) extends Element with Product with Serializable
The date and/or the time.
The date and/or the time.
- Element
Reference to the superclass object.
- date
Date as "yyyy-mm-dd", which conforms with ISO 8601
- time
Time as "hh:mm:ss.sssZ", which conforms with ISO 8601.
- MarketDocument
MarketDocument undocumented
- TimeSeries
TimeSeries undocumented
-
final
case class
DateInterval(Element: BasicElement = null, end: String = null, start: String = null) extends Element with Product with Serializable
Interval between two dates.
Interval between two dates.
- Element
Reference to the superclass object.
- end
End date of this interval.
- start
Start date of this interval.
-
final
case class
DateTimeInterval(Element: BasicElement = null, end: String = null, start: String = null) extends Element with Product with Serializable
Interval between two date and time points, where the interval includes the start time but excludes end time.
Interval between two date and time points, where the interval includes the start time but excludes end time.
- Element
Reference to the superclass object.
- end
End date and time of this interval. The end date and time where the interval is defined up to, but excluded.
- start
Start date and time of this interval. The start date and time is included in the defined interval.
-
final
case class
DayType(IdentifiedObject: IdentifiedObject = null, SeasonDayTypeSchedules: List[String] = null) extends Element with Product with Serializable
Group of similar days.
Group of similar days.
For example it could be used to represent weekdays, weekend, or holidays.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- SeasonDayTypeSchedules
SeasonDayTypeSchedule Schedules that use this DayType.
-
final
case class
DecimalQuantity(Element: BasicElement = null, currency: String = null, multiplier: String = null, unit: String = null, value: Double = 0.0) extends Element with Product with Serializable
Quantity with decimal value and associated unit or currency information.
Quantity with decimal value and associated unit or currency information.
- Element
Reference to the superclass object.
- currency
Currency of this quantity.
- multiplier
Unit multiplier of this quantity.
- unit
Unit of this quantity.
- value
Value of this quantity.
-
final
case class
DefaultBid(Bid: Bid = null, bidType: String = null, minLoadCost: Double = 0.0, peakFlag: String = null, DefaultBidCurve: String = null, RegisteredResource: String = null) extends Element with Product with Serializable
DefaultBid is a generic class to hold Default Energy Bid, Default Startup Bid, and Default Minimum Load Bid:
DefaultBid is a generic class to hold Default Energy Bid, Default Startup Bid, and Default Minimum Load Bid:
Default Energy Bid A Default Energy Bid is a monotonically increasing staircase function consisting at maximum 10 economic bid segments, or 10 ($/MW, MW) pairs.
There are three methods for determining the Default Energy Bid:
- Cost Based: derived from the Heat Rate or Average Cost multiplied by the Gas Price Index plus 10%.
- LMP Based: a weighted average of LMPs in the preceding 90 days.
- Negotiated: an amount negotiated with the designated Independent Entity.
Default Startup Bid A Default Startup Bid (DSUB) shall be calculated for each RMR unit based on the Startup Cost stored in the Master File and the applicable GPI and EPI.
Default Minimum Load Bid A Default Minimum Load Bid (DMLB) shall be calculated for each RMR unit based on the Minimum Load Cost stored in the Master File and the applicable GPI.
- Bid
Bid Reference to the superclass object.
- bidType
Default bid type such as Default Energy Bid, Default Minimum Load Bid, and Default Startup Bid
- minLoadCost
Minimum load cost in $/hr
- peakFlag
on-peak, off-peak, or all
- DefaultBidCurve
DefaultBidCurve undocumented
- RegisteredResource
RegisteredResource undocumented
-
final
case class
DefaultBidCurve(Curve: Curve = null, curveType: String = null, debAdderFlag: String = null, DefaultBid: String = null) extends Element with Product with Serializable
Default bid curve for default energy bid curve and default startup curves (cost and time).
Default bid curve for default energy bid curve and default startup curves (cost and time).
- Curve
Curve Reference to the superclass object.
- curveType
To indicate a type used for a default energy bid curve, such as LMP, cost or consultative based.
- debAdderFlag
Default energy bid adder flag
- DefaultBid
DefaultBid undocumented
-
final
case class
DefaultBidCurveData(CurveData: CurveData = null, bidSegmentCalcType: String = null) extends Element with Product with Serializable
Curve data for default bid curve and startup cost curve.
Curve data for default bid curve and startup cost curve.
- CurveData
CurveData Reference to the superclass object.
- bidSegmentCalcType
Type of calculation basis used to define the default bid segment curve.
-
final
case class
DefaultConstraintLimit(Curve: Curve = null, SecurityConstraintSum: String = null) extends Element with Product with Serializable
Possibly time-varying max MW or MVA and optionally Min MW limit or MVA limit (Y1 and Y2, respectively) applied as a default value if no specific constraint limits are specified for a contingency analysis.
Possibly time-varying max MW or MVA and optionally Min MW limit or MVA limit (Y1 and Y2, respectively) applied as a default value if no specific constraint limits are specified for a contingency analysis.
Use CurveSchedule XAxisUnits to specify MW or MVA.
- Curve
Curve Reference to the superclass object.
- SecurityConstraintSum
SecurityConstraintSum undocumented
-
final
case class
Delay(Element: BasicElement = null, tm: Double = 0.0, BlockingFunction: String = null, DCvoltageControl: String = null, PFmode: String = null, Pcontrol: String = null, Qlimiter: String = null, Qmode: String = null, Qregulator: String = null, Umode: String = null) extends Element with Product with Serializable
All the measurements are filtered by a first lag element with a time constant TM.
All the measurements are filtered by a first lag element with a time constant TM.
- Element
Reference to the superclass object.
- tm
Time constant.
- BlockingFunction
BlockingFunction undocumented
- DCvoltageControl
DCvoltageControl undocumented
- PFmode
PFmode undocumented
- Pcontrol
Pcontrol undocumented
- Qlimiter
Qlimiter undocumented
- Qmode
Qmode undocumented
- Qregulator
Qregulator undocumented
- Umode
Umode undocumented
-
final
case class
DemandResponseProgram(IdentifiedObject: IdentifiedObject = null, type: String = null, validityInterval: String = null, CustomerAgreements: List[String] = null, EndDeviceGroups: List[String] = null, UsagePointGroups: List[String] = null) extends Element with Product with Serializable
Demand response program.
Demand response program.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- type
Type of demand response program; examples are CPP (critical-peak pricing), RTP (real-time pricing), DLC (direct load control), DBP (demand bidding program), BIP (base interruptible program). Note that possible types change a lot and it would be impossible to enumerate them all.
- validityInterval
Interval within which the program is valid.
- CustomerAgreements
CustomerAgreement All customer agreements through which the customer is enrolled in this demand response program.
- EndDeviceGroups
EndDeviceGroup All groups of end devices enrolled in this demand response program.
- UsagePointGroups
UsagePointGroup All usage point groups enrolled in this demand response program.
-
final
case class
DeploymentDate(Element: BasicElement = null, inServiceDate: String = null, installedDate: String = null, notYetInstalledDate: String = null, outOfServiceDate: String = null, removedDate: String = null) extends Element with Product with Serializable
Dates for deployment events of an asset.
Dates for deployment events of an asset.
May have multiple deployment type dates for this device and a compound type allows a query to return multiple dates.
- Element
Reference to the superclass object.
- inServiceDate
Date and time asset most recently put in service.
- installedDate
Date and time asset most recently installed.
- notYetInstalledDate
Date and time of asset deployment transition to not yet installed.
- outOfServiceDate
Date and time asset most recently taken out of service.
- removedDate
Date and time asset most recently removed.
-
final
case class
Design(WorkDocument: WorkDocument = null, costEstimate: Double = 0.0, kind: String = null, price: Double = 0.0, ConditionFactors: List[String] = null, DesignLocations: List[String] = null, DesignLocationsCUs: List[String] = null, ErpBOMs: List[String] = null, ErpQuoteLineItem: String = null, Work: String = null, WorkCostDetails: List[String] = null, WorkTasks: List[String] = null) extends Element with Product with Serializable
A design for consideration by customers, potential customers, or internal work.
A design for consideration by customers, potential customers, or internal work.
Note that the Version of design is the revision attribute that is inherited from Document.
- WorkDocument
WorkDocument Reference to the superclass object.
- costEstimate
Estimated cost (not price) of design.
- kind
Kind of this design.
- price
Price to customer for implementing design.
- ConditionFactors
ConditionFactor undocumented
- DesignLocations
DesignLocation undocumented
- DesignLocationsCUs
DesignLocationCU undocumented
- ErpBOMs
ErpBOM undocumented
- ErpQuoteLineItem
ErpQuoteLineItem undocumented
- Work
Work undocumented
- WorkCostDetails
WorkCostDetail undocumented
- WorkTasks
OldWorkTask undocumented
-
final
case class
DesignLocation(WorkIdentifiedObject: WorkIdentifiedObject = null, spanLength: Double = 0.0, status: String = null, ConditionFactors: List[String] = null, DesignLocationCUs: List[String] = null, Designs: List[String] = null, ErpBomItemDatas: List[String] = null, MiscCostItems: List[String] = null, WorkLocations: List[String] = null) extends Element with Product with Serializable
A logical part of the design (e.g., pole and all equipment on a pole).
A logical part of the design (e.g., pole and all equipment on a pole).
This includes points and spans.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- spanLength
The legth of the span from the previous pole to this pole.
- status
undocumented
- ConditionFactors
ConditionFactor undocumented
- DesignLocationCUs
DesignLocationCU undocumented
- Designs
Design undocumented
- ErpBomItemDatas
ErpBomItemData undocumented
- MiscCostItems
MiscCostItem undocumented
- WorkLocations
WorkLocation undocumented
-
final
case class
DesignLocationCU(WorkIdentifiedObject: WorkIdentifiedObject = null, cuAccount: String = null, cuAction: String = null, cuQuantity: String = null, cuUsage: String = null, removalDate: String = null, status: String = null, toBeEnergised: Boolean = false, CUGroups: List[String] = null, CompatibleUnits: List[String] = null, ConditionFactors: List[String] = null, DesignLocation: String = null, Designs: List[String] = null, WorkTasks: List[String] = null) extends Element with Product with Serializable
Compatible unit at a given design location.
Compatible unit at a given design location.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- cuAccount
A code that helps direct accounting (capital, expense, or accounting treatment).
- cuAction
A code that instructs the crew what action to perform.
- cuQuantity
The quantity of the CU being assigned to this location.
- cuUsage
As the same CU can be used for different purposes and accounting purposes, usage must be specified. Examples include: distribution, transmission, substation.
- removalDate
Year when a CU that represents an asset is removed.
- status
undocumented
- toBeEnergised
True if associated electrical equipment is intended to be energized while work is being performed.
- CUGroups
CUGroup undocumented
- CompatibleUnits
CompatibleUnit undocumented
- ConditionFactors
ConditionFactor undocumented
- DesignLocation
DesignLocation undocumented
- Designs
Design undocumented
- WorkTasks
OldWorkTask undocumented
-
final
case class
DiagnosisDataSet(ProcedureDataSet: ProcedureDataSet = null, effect: String = null, failureMode: String = null, finalCause: String = null, finalCode: String = null, finalOrigin: String = null, finalRemark: String = null, phaseCode: String = null, preliminaryCode: String = null, preliminaryDateTime: String = null, preliminaryRemark: String = null, rootCause: String = null, rootOrigin: String = null, rootRemark: String = null) extends Element with Product with Serializable
The result of a problem (typically an asset failure) diagnosis.
The result of a problem (typically an asset failure) diagnosis.
Contains complete information like what might be received from a lab doing forensic analysis of a failed asset.
- ProcedureDataSet
ProcedureDataSet Reference to the superclass object.
- effect
Effect of problem.
- failureMode
Failuer mode, for example: Failure to Insulate; Failure to conduct; Failure to contain oil; Failure to provide ground plane; Other.
- finalCause
Cause of problem determined during diagnosis.
- finalCode
Code for diagnosed probem type.
- finalOrigin
Origin of problem determined during diagnosis.
- finalRemark
Remarks pertaining to findings during problem diagnosis.
- phaseCode
Phase(s) diagnosed.
- preliminaryCode
Code for problem type determined during preliminary assessment.
- preliminaryDateTime
Date and time preliminary assessment of problem was performed.
- preliminaryRemark
Remarks pertaining to preliminary assessment of problem.
- rootCause
Root cause of problem determined during diagnosis.
- rootOrigin
Root origin of problem determined during diagnosis.
- rootRemark
Remarks pertaining to root cause findings during problem diagnosis.
-
final
case class
Diagram(IdentifiedObject: IdentifiedObject = null, orientation: String = null, x1InitialView: Double = 0.0, x2InitialView: Double = 0.0, y1InitialView: Double = 0.0, y2InitialView: Double = 0.0, DiagramElements: List[String] = null, DiagramStyle: String = null) extends Element with Product with Serializable
The diagram being exchanged.
The diagram being exchanged.
The coordinate system is a standard Cartesian coordinate system and the orientation attribute defines the orientation. The initial view related attributes can be used to specify an initial view with the x,y coordinates of the diagonal points.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- orientation
Coordinate system orientation of the diagram. A positive orientation gives standard “right-hand” orientation, with negative orientation indicating a “left-hand” orientation. For 2D diagrams, a positive orientation will result in X values increasing from left to right and Y values increasing from bottom to top. A negative orientation gives the “left-hand” orientation (favoured by computer graphics displays) with X values increasing from left to right and Y values increasing from top to bottom.
- x1InitialView
X coordinate of the first corner of the initial view.
- x2InitialView
X coordinate of the second corner of the initial view.
- y1InitialView
Y coordinate of the first corner of the initial view.
- y2InitialView
Y coordinate of the second corner of the initial view.
- DiagramElements
DiagramObject A diagram is made up of multiple diagram objects.
- DiagramStyle
DiagramStyle A Diagram may have a DiagramStyle.
-
final
case class
DiagramObject(IdentifiedObject: IdentifiedObject = null, drawingOrder: Int = 0, isPolygon: Boolean = false, offsetX: Double = 0.0, offsetY: Double = 0.0, rotation: Double = 0.0, Diagram: String = null, DiagramObjectPoints: List[String] = null, DiagramObjectStyle: String = null, IdentifiedObject_attr: String = null, VisibilityLayers: List[String] = null) extends Element with Product with Serializable
An object that defines one or more points in a given space.
An object that defines one or more points in a given space.
This object can be associated with anything that specializes IdentifiedObject. For single line diagrams such objects typically include such items as analog values, breakers, disconnectors, power transformers, and transmission lines.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- drawingOrder
The drawing order of this element. The higher the number, the later the element is drawn in sequence. This is used to ensure that elements that overlap are rendered in the correct order.
- isPolygon
Defines whether or not the diagram objects points define the boundaries of a polygon or the routing of a polyline. If this value is true then a receiving application should consider the first and last points to be connected.
- offsetX
The offset in the X direction. This is used for defining the offset from centre for rendering an icon (the default is that a single point specifies the centre of the icon). The offset is in per-unit with 0 indicating there is no offset from the horizontal centre of the icon. -0.5 indicates it is offset by 50% to the left and 0.5 indicates an offset of 50% to the right.
- offsetY
The offset in the Y direction. This is used for defining the offset from centre for rendering an icon (the default is that a single point specifies the centre of the icon). The offset is in per-unit with 0 indicating there is no offset from the vertical centre of the icon. The offset direction is dependent on the orientation of the diagram, with -0.5 and 0.5 indicating an offset of +/- 50% on the vertical axis.
- rotation
Sets the angle of rotation of the diagram object. Zero degrees is pointing to the top of the diagram. Rotation is clockwise. DiagramObject.rotation=0 has the following meaning: The connection point of an element which has one terminal is pointing to the top side of the diagram. The connection point "From side" of an element which has more than one terminal is pointing to the top side of the diagram. DiagramObject.rotation=90 has the following meaning: The connection point of an element which has one terminal is pointing to the right hand side of the diagram. The connection point "From side" of an element which has more than one terminal is pointing to the right hand side of the diagram.
- Diagram
Diagram A diagram object is part of a diagram.
- DiagramObjectPoints
DiagramObjectPoint A diagram object can have 0 or more points to reflect its layout position, routing (for polylines) or boundary (for polygons).
- DiagramObjectStyle
DiagramObjectStyle A diagram object has a style associated that provides a reference for the style used in the originating system.
- IdentifiedObject_attr
IdentifiedObject The domain object to which this diagram object is associated.
- VisibilityLayers
VisibilityLayer A diagram object can be part of multiple visibility layers.
-
final
case class
DiagramObjectGluePoint(Element: BasicElement = null, DiagramObjectPoints: List[String] = null) extends Element with Product with Serializable
This is used for grouping diagram object points from different diagram objects that are considered to be glued together in a diagram even if they are not at the exact same coordinates.
This is used for grouping diagram object points from different diagram objects that are considered to be glued together in a diagram even if they are not at the exact same coordinates.
- Element
Reference to the superclass object.
- DiagramObjectPoints
DiagramObjectPoint A diagram object glue point is associated with 2 or more object points that are considered to be 'glued' together.
-
final
case class
DiagramObjectPoint(Element: BasicElement = null, sequenceNumber: Int = 0, xPosition: Double = 0.0, yPosition: Double = 0.0, zPosition: Double = 0.0, DiagramObject: String = null, DiagramObjectGluePoint: String = null) extends Element with Product with Serializable
A point in a given space defined by 3 coordinates and associated to a diagram object.
A point in a given space defined by 3 coordinates and associated to a diagram object.
The coordinates may be positive or negative as the origin does not have to be in the corner of a diagram.
- Element
Reference to the superclass object.
- sequenceNumber
The sequence position of the point, used for defining the order of points for diagram objects acting as a polyline or polygon with more than one point. The attribute shall be a positive value.
- xPosition
The X coordinate of this point.
- yPosition
The Y coordinate of this point.
- zPosition
The Z coordinate of this point.
- DiagramObject
DiagramObject The diagram object with which the points are associated.
- DiagramObjectGluePoint
DiagramObjectGluePoint The 'glue' point to which this point is associated.
-
final
case class
DiagramObjectStyle(IdentifiedObject: IdentifiedObject = null, StyledObjects: List[String] = null) extends Element with Product with Serializable
A reference to a style used by the originating system for a diagram object.
A reference to a style used by the originating system for a diagram object.
A diagram object style describes information such as line thickness, shape such as circle or rectangle etc, and colour.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- StyledObjects
DiagramObject A style can be assigned to multiple diagram objects.
-
final
case class
DiagramStyle(IdentifiedObject: IdentifiedObject = null, Diagram: List[String] = null) extends Element with Product with Serializable
The diagram style refers to a style used by the originating system for a diagram.
The diagram style refers to a style used by the originating system for a diagram.
A diagram style describes information such as schematic, geographic, etc.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- Diagram
Diagram A DiagramStyle can be used by many Diagrams.
-
final
case class
DifferentialModel(Element: BasicElement = null) extends Element with Product with Serializable
A set of statements describing the changes in the network model.
A set of statements describing the changes in the network model.
The statement is defined in the incremental model.
- Element
Reference to the superclass object.
-
final
case class
DimensionsInfo(IdentifiedObject: IdentifiedObject = null, orientation: String = null, sizeDepth: Double = 0.0, sizeDiameter: Double = 0.0, sizeLength: Double = 0.0, sizeWidth: Double = 0.0, Specifications: List[String] = null) extends Element with Product with Serializable
As applicable, the basic linear, area, or volume dimensions of an asset, asset type (AssetModel) or other type of object (such as land area).
As applicable, the basic linear, area, or volume dimensions of an asset, asset type (AssetModel) or other type of object (such as land area).
Units and multipliers are specified per dimension.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- orientation
A description of the orientation of the object relative to the dimensions. As an example, a vault may have north-south orientation for the sizeLength measurement and sizeDepth may be the height of the vault.
- sizeDepth
Depth measurement.
- sizeDiameter
Diameter measurement.
- sizeLength
Length measurement.
- sizeWidth
Width measurement.
- Specifications
Specification undocumented
-
final
case class
DiscExcContIEEEDEC1A(DiscontinuousExcitationControlDynamics: DiscontinuousExcitationControlDynamics = null, esc: Double = 0.0, kan: Double = 0.0, ketl: Double = 0.0, tan: Double = 0.0, td: Double = 0.0, tl1: Double = 0.0, tl2: Double = 0.0, tw5: Double = 0.0, val: Double = 0.0, vanmax: Double = 0.0, vomax: Double = 0.0, vomin: Double = 0.0, vsmax: Double = 0.0, vsmin: Double = 0.0, vtc: Double = 0.0, vtlmt: Double = 0.0, vtm: Double = 0.0, vtn: Double = 0.0) extends Element with Product with Serializable
IEEE type DEC1A discontinuous excitation control model that boosts generator excitation to a level higher than that demanded by the voltage regulator and stabilizer immediately following a system fault.
IEEE type DEC1A discontinuous excitation control model that boosts generator excitation to a level higher than that demanded by the voltage regulator and stabilizer immediately following a system fault.
Reference: IEEE 421.5-2005, 12.2.
- DiscontinuousExcitationControlDynamics
DiscontinuousExcitationControlDynamics Reference to the superclass object.
- esc
Speed change reference (ESC). Typical value = 0,0015.
- kan
Discontinuous controller gain (KAN). Typical value = 400.
- ketl
Terminal voltage limiter gain (KETL). Typical value = 47.
- tan
Discontinuous controller time constant (TAN) (>= 0). Typical value = 0,08.
- td
Time constant (TD) (>= 0). Typical value = 0,03.
- tl1
Time constant (TL1) (>= 0). Typical value = 0,025.
- tl2
Time constant (TL2) (>= 0). Typical value = 1,25.
- tw5
DEC washout time constant (TW5) (>= 0). Typical value = 5.
- val
Regulator voltage reference (VAL). Typical value = 5,5.
- vanmax
Limiter for Van (VANMAX).
- vomax
Limiter (VOMAX) (> DiscExcContIEEEDEC1A.vomin). Typical value = 0,3.
- vomin
Limiter (VOMIN) (< DiscExcContIEEEDEC1A.vomax). Typical value = 0,1.
- vsmax
Limiter (VSMAX)(> DiscExcContIEEEDEC1A.vsmin). Typical value = 0,2.
- vsmin
Limiter (VSMIN) (< DiscExcContIEEEDEC1A.vsmax). Typical value = -0,066.
- vtc
Terminal voltage level reference (VTC). Typical value = 0,95.
- vtlmt
Voltage reference (VTLMT). Typical value = 1,1.
- vtm
Voltage limits (VTM). Typical value = 1,13.
- vtn
Voltage limits (VTN). Typical value = 1,12.
-
final
case class
DiscExcContIEEEDEC2A(DiscontinuousExcitationControlDynamics: DiscontinuousExcitationControlDynamics = null, td1: Double = 0.0, td2: Double = 0.0, vdmax: Double = 0.0, vdmin: Double = 0.0, vk: Double = 0.0) extends Element with Product with Serializable
IEEE type DEC2A model for discontinuous excitation control.
IEEE type DEC2A model for discontinuous excitation control.
This system provides transient excitation boosting via an open-loop control as initiated by a trigger signal generated remotely. Reference: IEEE 421.5-2005 12.3.
- DiscontinuousExcitationControlDynamics
DiscontinuousExcitationControlDynamics Reference to the superclass object.
- td1
Discontinuous controller time constant (TD1) (>= 0).
- td2
Discontinuous controller washout time constant (TD2) (>= 0).
- vdmax
Limiter (VDMAX) (> DiscExcContIEEEDEC2A.vdmin).
- vdmin
Limiter (VDMIN) (< DiscExcContIEEEDEC2A.vdmax).
- vk
Discontinuous controller input reference (VK).
-
final
case class
DiscExcContIEEEDEC3A(DiscontinuousExcitationControlDynamics: DiscontinuousExcitationControlDynamics = null, tdr: Double = 0.0, vtmin: Double = 0.0) extends Element with Product with Serializable
IEEE type DEC3A model.
IEEE type DEC3A model.
In some systems, the stabilizer output is disconnected from the regulator immediately following a severe fault to prevent the stabilizer from competing with action of voltage regulator during the first swing. Reference: IEEE 421.5-2005 12.4.
- DiscontinuousExcitationControlDynamics
DiscontinuousExcitationControlDynamics Reference to the superclass object.
- tdr
Reset time delay (TDR) (>= 0).
- vtmin
Terminal undervoltage comparison level (VTMIN).
-
final
case class
DisconnectingCircuitBreaker(Breaker: Breaker = null) extends Element with Product with Serializable
A circuit breaking device including disconnecting function, eliminating the need for separate disconnectors.
A circuit breaking device including disconnecting function, eliminating the need for separate disconnectors.
- Breaker
Breaker Reference to the superclass object.
-
final
case class
Disconnector(Switch: Switch = null) extends Element with Product with Serializable
A manually operated or motor operated mechanical switching device used for changing the connections in a circuit, or for isolating a circuit or equipment from a source of power.
A manually operated or motor operated mechanical switching device used for changing the connections in a circuit, or for isolating a circuit or equipment from a source of power.
It is required to open or close circuits when negligible current is broken or made.
- Switch
Switch Reference to the superclass object.
-
final
case class
DiscontinuousExcitationControlDynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null, ExcitationSystemDynamics: String = null, RemoteInputSignal: String = null) extends Element with Product with Serializable
Discontinuous excitation control function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model</font>.
Discontinuous excitation control function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model</font>.
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- ExcitationSystemDynamics
ExcitationSystemDynamics Excitation system model with which this discontinuous excitation control model is associated.
- RemoteInputSignal
RemoteInputSignal Remote input signal used by this discontinuous excitation control system model.
-
final
case class
DiscontinuousExcitationControlUserDefined(DiscontinuousExcitationControlDynamics: DiscontinuousExcitationControlDynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Discontinuous excitation control function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
Discontinuous excitation control function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
- DiscontinuousExcitationControlDynamics
DiscontinuousExcitationControlDynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
Discrete(Measurement: Measurement = null, maxValue: Int = 0, minValue: Int = 0, normalValue: Int = 0, DiscreteValues: List[String] = null, ValueAliasSet: String = null) extends Element with Product with Serializable
Discrete represents a discrete Measurement, i.e.
Discrete represents a discrete Measurement, i.e. a Measurement representing discrete values, e.g. a Breaker position.
- Measurement
Measurement Reference to the superclass object.
- maxValue
Normal value range maximum for any of the MeasurementValue.values. Used for scaling, e.g. in bar graphs or of telemetered raw values.
- minValue
Normal value range minimum for any of the MeasurementValue.values. Used for scaling, e.g. in bar graphs or of telemetered raw values.
- normalValue
Normal measurement value, e.g., used for percentage calculations.
- DiscreteValues
DiscreteValue The values connected to this measurement.
- ValueAliasSet
ValueAliasSet The ValueAliasSet used for translation of a MeasurementValue.value to a name.
-
final
case class
DiscreteMeasurementValueQuality(MeasurementValueQuality: MeasurementValueQuality = null, manualReplaceIndicator: Boolean = false, removeFromOperationIndicator: Boolean = false) extends Element with Product with Serializable
Measurement quality flags for Discrete Values.
Measurement quality flags for Discrete Values.
- MeasurementValueQuality
MeasurementValueQuality Reference to the superclass object.
- manualReplaceIndicator
Switch Manual Replace Indicator. Flag indicating that the switch is manual replace.
- removeFromOperationIndicator
Removed From Operation Indicator. Flag indicating that the switch is removed from operation.
-
final
case class
DiscreteValue(MeasurementValue: MeasurementValue = null, value: Int = 0, Command: String = null, Discrete: String = null) extends Element with Product with Serializable
DiscreteValue represents a discrete MeasurementValue.
DiscreteValue represents a discrete MeasurementValue.
- MeasurementValue
MeasurementValue Reference to the superclass object.
- value
The value to supervise.
- Command
Command The Control variable associated with the MeasurementValue.
- Discrete
Discrete Measurement to which this value is connected.
-
final
case class
DispatchInstReply(IdentifiedObject: IdentifiedObject = null, acceptMW: Double = 0.0, acceptStatus: String = null, certificationName: String = null, clearedMW: Double = 0.0, instructionTime: String = null, instructionType: String = null, passIndicator: String = null, receivedTime: String = null, startTime: String = null, RegisteredResource: String = null) extends Element with Product with Serializable
Response from registered resource acknowledging receipt of dispatch instructions.
Response from registered resource acknowledging receipt of dispatch instructions.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- acceptMW
The accepted mw amount by the responder. aka response mw.
- acceptStatus
The accept status submitted by the responder. enumeration type needs to be defined
- certificationName
The Subject DN is the X509 Certificate Subject DN. This is the essentially the certificate name presented by the client. In the case of ADS Certificates, this will be the user name. It may be from an API Client or the MP Client (GUI). The Subject ID normally includes more than just the user name (Common Name), it can also contain information such as City, Company ID, etc.
- clearedMW
MW amount associated with instruction. For 5 minute binding dispatches, this is the Goto MW or DOT
- instructionTime
The target date/time for the received instruction.
- instructionType
instruction type: commitment out of sequence dispatch
- passIndicator
The type of run for the market clearing.
- receivedTime
Timestamp indicating the time at which the instruction was received.
- startTime
start time
- RegisteredResource
RegisteredResource undocumented
- final case class DispatchSchedule(Element: BasicElement = null, confidence: Double = 0.0, curveStyleKind: String = null, numberOfIntervals: Int = 0, startTime: String = null, timeIntervalDuration: Int = 0, timeIntervalUnit: String = null, DERCurveData: List[String] = null, DERMonitorableParameter: String = null) extends Element with Product with Serializable
- final case class DispatchablePowerCapability(Element: BasicElement = null, currentActivePower: Double = 0.0, currentApparentPower: Double = 0.0, currentReactivePower: Double = 0.0, maxActivePower: Double = 0.0, maxApparentPower: Double = 0.0, maxReactivePower: Double = 0.0, minActivePower: Double = 0.0, minApparentPower: Double = 0.0, minReactivePower: Double = 0.0, EndDevice: String = null, EndDeviceGroup: String = null) extends Element with Product with Serializable
-
final
case class
DistributedResourceActualEvent(MarketActualEvent: MarketActualEvent = null, totalPowerAdjustment: Double = 0.0, InstructionClearing: List[String] = null, InstructionClearingDOT: List[String] = null, ResourcePerformanceEvaluations: List[String] = null) extends Element with Product with Serializable
A demand response event is created when there is a need to call upon resources to respond to demand adjustment requests.
A demand response event is created when there is a need to call upon resources to respond to demand adjustment requests.
These events are created by ISO/RTO system operations and managed by a demand response management system (DRMS). These events may or may not be coordinated with the Market Events and a defined Energy Market. The event will call for the deployment of a number of registered resources, or for deployment of resources within a zone (an organizational area within the power system that contains a number of resources).
- MarketActualEvent
MarketActualEvent Reference to the superclass object.
- totalPowerAdjustment
Total active power adjustment (e.g. load reduction) requested for this demand response event.
- InstructionClearing
InstructionClearing ActualDemandResponseEvents may exist that are not part of a coordinated MarketActualEvent associated to a Market. These ActualDemandResponseEvents can have many InstructionClearing Instructions for specified RegisteredResources or DemandResponse AggregateNodes.
- InstructionClearingDOT
InstructionClearingDOT undocumented
- ResourcePerformanceEvaluations
ResourcePerformanceEvaluation undocumented
-
final
case class
DistributionFactorSet(Element: BasicElement = null, intervalEndTime: String = null, intervalStartTime: String = null, marketType: String = null, GenDistributionFactor: List[String] = null, LoadDistributionFactor: List[String] = null, SysLoadDistribuFactor: List[String] = null) extends Element with Product with Serializable
A containing class that groups all the distribution factors within a market.
A containing class that groups all the distribution factors within a market.
This is calculated daily for DA factors and hourly for RT factors.
- Element
Reference to the superclass object.
- intervalEndTime
The end of the time interval for which requirement is defined.
- intervalStartTime
The start of the time interval for which requirement is defined.
- marketType
Market type.
- GenDistributionFactor
GenDistributionFactor undocumented
- LoadDistributionFactor
LoadDistributionFactor undocumented
- SysLoadDistribuFactor
SysLoadDistributionFactor undocumented
-
final
case class
DobleStandard(Element: BasicElement = null, standardEdition: String = null, standardNumber: String = null) extends Element with Product with Serializable
Standard published by Doble.
Standard published by Doble.
- Element
Reference to the superclass object.
- standardEdition
Edition of Doble standard.
- standardNumber
Doble standard number.
-
final
case class
Document(IdentifiedObject: IdentifiedObject = null, authorName: String = null, comment: String = null, createdDateTime: String = null, docStatus: String = null, electronicAddress: String = null, lastModifiedDateTime: String = null, revisionNumber: String = null, status: String = null, subject: String = null, title: String = null, type: String = null, Approver: String = null, Author: String = null, ConfigurationEvents: List[String] = null, Editor: String = null, Issuer: String = null) extends Element with Product with Serializable
Parent class for different groupings of information collected and managed as a part of a business process.
Parent class for different groupings of information collected and managed as a part of a business process.
It will frequently contain references to other objects, such as assets, people and power system resources.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- authorName
Name of the author of this document.
- comment
Free text comment.
- createdDateTime
Date and time that this document was created.
- docStatus
Status Status of this document. For status of subject matter this document represents (e.g., Agreement, Work), use 'status' attribute. Example values for 'docStatus.status' are draft, approved, cancelled, etc.
- electronicAddress
ElectronicAddress Electronic address.
- lastModifiedDateTime
Date and time this document was last modified. Documents may potentially be modified many times during their lifetime.
- revisionNumber
Revision number for this document.
- status
Status Status of subject matter (e.g., Agreement, Work) this document represents. For status of the document itself, use 'docStatus' attribute.
- subject
Document subject.
- title
Document title.
- type
Utility-specific classification of this document, according to its corporate standards, practices, and existing IT systems (e.g., for management of assets, maintenance, work, outage, customers, etc.).
- Approver
Approver Approver of this document.
- Author
Author Author of this document.
- ConfigurationEvents
ConfigurationEvent All configuration events created for this document.
- Editor
Editor Editor of this document.
- Issuer
Issuer Issuer of this document.
-
final
case class
DocumentOrganisationRole(OrganisationRole: OrganisationRole = null) extends Element with Product with Serializable
Role an organisation plays with respect to documents.
Role an organisation plays with respect to documents.
- OrganisationRole
OrganisationRole Reference to the superclass object.
-
final
case class
DocumentPersonRole(PersonRole: PersonRole = null) extends Element with Product with Serializable
Person role with respect to documents.
Person role with respect to documents.
- PersonRole
PersonRole Reference to the superclass object.
-
final
case class
Domain(IdentifiedObject: IdentifiedObject = null, MarketDocument: List[String] = null, Price: List[String] = null, Quantity: List[String] = null, RegisteredResource: List[String] = null, TimeSeries: List[String] = null) extends Element with Product with Serializable
An area of activity defined within the energy market.
An area of activity defined within the energy market.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- MarketDocument
MarketDocument undocumented
- Price
Price undocumented
- Quantity
Quantity undocumented
- RegisteredResource
RegisteredResource undocumented
- TimeSeries
TimeSeries undocumented
-
final
case class
DopInstruction(Element: BasicElement = null, mwDOP: Double = 0.0, plotPriority: Int = 0, runIndicatorDOP: String = null, timestampDOP: String = null, updateTimeStamp: String = null, updateType: String = null, updateUser: String = null, InstructionClearingDOP: List[String] = null, RegisteredResouce: String = null) extends Element with Product with Serializable
Provides the necessary information (on a resource basis) to capture the Dispatch Operating Point (DOP) results on a Dispatch interval.
Provides the necessary information (on a resource basis) to capture the Dispatch Operating Point (DOP) results on a Dispatch interval.
This information is only relevant to the RT interval market.
- Element
Reference to the superclass object.
- mwDOP
Dispatched Operating Point (MW)
- plotPriority
A value used to establish priority of the DOP when plotting. This is only applicable when two DOPs exist for the same time, but with different MW values. E.g. when indicating a step in the curve. Its used to determine if the curve steps up or down.
- runIndicatorDOP
Indication of DOP validity. Shows the DOP is calculated from the latest run (YES). A NO indicator shows that the DOP is copied from a previous execution. Up to 2 intervals can be missed.
- timestampDOP
DOP time stamp
- updateTimeStamp
undocumented
- updateType
undocumented
- updateUser
undocumented
- InstructionClearingDOP
InstructionClearingDOP undocumented
- RegisteredResouce
RegisteredResource undocumented
-
final
case class
DotInstruction(Element: BasicElement = null, actualRampRate: Double = 0.0, compliantIndicator: String = null, economicMaxOverride: Double = 0.0, expectedEnergy: Double = 0.0, generatorPerformanceDegree: Double = 0.0, hourAheadSchedEnergy: Double = 0.0, hourlySchedule: Double = 0.0, instructionTime: String = null, maximumEmergencyInd: Boolean = false, meterLoadFollowing: Double = 0.0, nonRampRestrictedMW: Double = 0.0, nonSpinReserve: Double = 0.0, previousDOTTimeStamp: String = null, rampRateLimit: Double = 0.0, regulationStatus: String = null, spinReserve: Double = 0.0, standardRampEnergy: Double = 0.0, supplementalEnergy: Double = 0.0, unitStatus: Int = 0, DOT: Double = 0.0, InstructionClearingDOT: List[String] = null, RegisteredResource: String = null) extends Element with Product with Serializable
Provides the necessary information (on a resource basis) to capture the Dispatch Operating Target (DOT) results on a Dispatch interval.
Provides the necessary information (on a resource basis) to capture the Dispatch Operating Target (DOT) results on a Dispatch interval.
This information is only relevant to the RT interval market.
- Element
Reference to the superclass object.
- actualRampRate
Actual ramp rate.
- compliantIndicator
Flag indicating whether or not the resource was in compliance with the instruction (plus/minus 10%). Directs if a unit is allowed to set the price (ex-post pricing).
- economicMaxOverride
Economic Max Limit override for unit, this value is null, if it is not, this value overrides the Energy column value. Allows dispatcher to override the unit's energy value.
- expectedEnergy
Expected energy.
- generatorPerformanceDegree
The Degree of Generator Performance (DGP) used for the unit. Measure of how a generator responds to raise /lower signals. Calculated every five minutes.
- hourAheadSchedEnergy
HASP results.
- hourlySchedule
Hourly Schedule (DA Energy Schedule).
- instructionTime
The date/time for the instruction.
- maximumEmergencyInd
True if maximum emergency limit activated; false otherwise. If unit is requested to move up to its max emergency limit., this flag is set to true.
- meterLoadFollowing
Meter Sub System Load Following.
- nonRampRestrictedMW
Desired MW that is not ramp restricted. If no ramp rate limit existed for the unit, this is the MW value tha t the unit was requested to move to.
- nonSpinReserve
Non Spin Reserve used to procure energy.
- previousDOTTimeStamp
Timestamp when the previous DOT value was issued.
- rampRateLimit
The ramp rate limit for the unit in MWs per minute. Participant bidding data.
- regulationStatus
Regulation Status (Yes/No).
- spinReserve
Spin Reserve used to procure energy.
- standardRampEnergy
Standard ramping energy (MWH).
- supplementalEnergy
Supplemental Energy procure by Real Time Dispatch.
- unitStatus
Output results from the case identifying the reason the unit was committed by the software.
- DOT
Dispatch operating target value.
- InstructionClearingDOT
InstructionClearingDOT undocumented
- RegisteredResource
RegisteredResource undocumented
-
final
case class
DrumBoiler(FossilSteamSupply: FossilSteamSupply = null, drumBoilerRating: Double = 0.0) extends Element with Product with Serializable
Drum boiler.
Drum boiler.
- FossilSteamSupply
FossilSteamSupply Reference to the superclass object.
- drumBoilerRating
Rating of drum boiler in steam units.
-
final
case class
DuctBank(AssetContainer: AssetContainer = null, circuitCount: Int = 0, WireSpacingInfos: List[String] = null) extends Element with Product with Serializable
A duct contains individual wires in the layout as specified with associated wire spacing instances; number of them gives the number of conductors in this duct.
A duct contains individual wires in the layout as specified with associated wire spacing instances; number of them gives the number of conductors in this duct.
- AssetContainer
AssetContainer Reference to the superclass object.
- circuitCount
Number of circuits in duct bank. Refer to associations between a duct (ConductorAsset) and an ACLineSegment to understand which circuits are in which ducts.
- WireSpacingInfos
WireSpacingInfo undocumented
-
final
case class
Due(Element: BasicElement = null, arrears: Double = 0.0, charges: Double = 0.0, current: Double = 0.0, interest: Double = 0.0, principle: Double = 0.0) extends Element with Product with Serializable
Details on amounts due for an account.
Details on amounts due for an account.
- Element
Reference to the superclass object.
- arrears
Part of 'current' that constitutes the arrears portion.
- charges
Part of 'current' that constitutes the charge portion: 'charges' = 'Charge.fixedPortion' + 'Charge.variablePortion'.
- current
Current total amount now due: current = principle + arrears + interest + charges. Typically the rule for settlement priority is: interest dues, then arrears dues, then current dues, then charge dues.
- interest
Part of 'current' that constitutes the interest portion.
- principle
Part of 'current' that constitutes the portion of the principle amount currently due.
-
final
case class
DynamicSchedule(BasicIntervalSchedule: BasicIntervalSchedule = null, dynSchedSignRev: Boolean = false, dynSchedStatus: String = null, MktMeasurement: String = null, Receive_SubControlArea: String = null, Send_SubControlArea: String = null) extends Element with Product with Serializable
A continuously variable component of a control area's MW net interchange schedule.
A continuously variable component of a control area's MW net interchange schedule.
Dynamic schedules are sent and received by control areas.
- BasicIntervalSchedule
BasicIntervalSchedule Reference to the superclass object.
- dynSchedSignRev
Dynamic schedule sign reversal required (true/false)
- dynSchedStatus
The "active" or "inactive" status of the dynamic schedule
- MktMeasurement
MktMeasurement undocumented
- Receive_SubControlArea
SubControlArea A control area can receive dynamic schedules from other control areas
- Send_SubControlArea
SubControlArea A control area can send dynamic schedules to other control areas
-
final
case class
DynamicsFunctionBlock(IdentifiedObject: IdentifiedObject = null, enabled: Boolean = false) extends Element with Product with Serializable
Abstract parent class for all Dynamics function blocks.
Abstract parent class for all Dynamics function blocks.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- enabled
Function block used indicator. true = use of function block is enabled false = use of function block is disabled.
-
final
case class
EPAStandard(Element: BasicElement = null, standardEdition: String = null, standardNumber: String = null) extends Element with Product with Serializable
Standard published by EPA (United States Environmental Protection Agency).
Standard published by EPA (United States Environmental Protection Agency).
- Element
Reference to the superclass object.
- standardEdition
Edition of EPA standard.
- standardNumber
EPA standard number.
-
final
case class
EarthFaultCompensator(ConductingEquipment: ConductingEquipment = null, r: Double = 0.0) extends Element with Product with Serializable
A conducting equipment used to represent a connection to ground which is typically used to compensate earth faults.
A conducting equipment used to represent a connection to ground which is typically used to compensate earth faults.
An earth fault compensator device modelled with a single terminal implies a second terminal solidly connected to ground. If two terminals are modelled, the ground is not assumed and normal connection rules apply.
- ConductingEquipment
ConductingEquipment Reference to the superclass object.
- r
Nominal resistance of device.
-
final
case class
Earthquake(GeosphericPhenomenon: GeosphericPhenomenon = null, focalDepth: String = null, intensity: Int = 0, magnitude: Double = 0.0) extends Element with Product with Serializable
An earthquake.
An earthquake.
- GeosphericPhenomenon
GeosphericPhenomenon Reference to the superclass object.
- focalDepth
The depth below the earth's surface of the earthquake's focal point.
- intensity
The intensity of the earthquake as defined by the Modified Mercalli Intensity (MMI) scale. Possible values are 1-12, corresponding to I-XII.
- magnitude
The magnitude of the earthquake as defined on the Moment Magnitude (Mw) scale, which measures the size of earthquakes in terms of the energy released. Must be greater than zero.
-
final
case class
Editor(DocumentPersonRole: DocumentPersonRole = null, Documents: List[String] = null) extends Element with Product with Serializable
Person who modified the document.
Person who modified the document.
- DocumentPersonRole
DocumentPersonRole Reference to the superclass object.
- Documents
Document All documents for this editor.
-
final
case class
ElectronicAddress(Element: BasicElement = null, email1: String = null, email2: String = null, lan: String = null, mac: String = null, password: String = null, radio: String = null, userID: String = null, web: String = null) extends Element with Product with Serializable
Electronic address information.
Electronic address information.
- Element
Reference to the superclass object.
- email1
Primary email address.
- email2
Alternate email address.
- lan
Address on local area network.
- mac
MAC (Media Access Control) address.
- password
Password needed to log in.
- radio
Radio address.
- userID
User ID needed to log in, which can be for an individual person, an organisation, a location, etc.
- web
World wide web address.
-
trait
Element extends Row with Serializable with Cloneable with Product
Lowest level class in the CIM hierarchy.
Lowest level class in the CIM hierarchy.
All CIM model objects inherit from this class, either directly or indirectly.
Provides overridable functionality to:
- Annotations
- @SQLUserDefinedType()
-
final
case class
EmissionAccount(Curve: Curve = null, emissionType: String = null, emissionValueSource: String = null, ThermalGeneratingUnit: String = null) extends Element with Product with Serializable
Accounts for tracking emissions usage and credits for thermal generating units.
Accounts for tracking emissions usage and credits for thermal generating units.
A unit may have zero or more emission accounts, and will typically have one for tracking usage and one for tracking credits.
- Curve
Curve Reference to the superclass object.
- emissionType
The type of emission, for example sulfur dioxide (SO2). The y1AxisUnits of the curve contains the unit of measure (e.g. kg) and the emissionType is the type of emission (e.g. sulfur dioxide).
- emissionValueSource
The source of the emission value.
- ThermalGeneratingUnit
ThermalGeneratingUnit A thermal generating unit may have one or more emission allowance accounts.
-
final
case class
EmissionCurve(Curve: Curve = null, emissionContent: Double = 0.0, emissionType: String = null, isNetGrossP: Boolean = false, ThermalGeneratingUnit: String = null) extends Element with Product with Serializable
Relationship between the unit's emission rate in units of mass per hour (Y-axis) and output active power (X-axis) for a given type of emission.
Relationship between the unit's emission rate in units of mass per hour (Y-axis) and output active power (X-axis) for a given type of emission.
This curve applies when only one type of fuel is being burned.
- Curve
Curve Reference to the superclass object.
- emissionContent
The emission content per quantity of fuel burned.
- emissionType
The type of emission, which also gives the production rate measurement unit. The y1AxisUnits of the curve contains the unit of measure (e.g. kg) and the emissionType is the type of emission (e.g. sulfur dioxide).
- isNetGrossP
Flag is set to true when output is expressed in net active power.
- ThermalGeneratingUnit
ThermalGeneratingUnit A thermal generating unit may have one or more emission curves.
-
final
case class
EndDevice(AssetContainer: AssetContainer = null, amrSystem: String = null, installCode: String = null, isPan: Boolean = false, isSmartInverter: Boolean = false, isVirtual: Boolean = false, timeZoneOffset: Double = 0.0, Customer: String = null, DispatchablePowerCapability: List[String] = null, EndDeviceControls: List[String] = null, EndDeviceEvents: List[String] = null, EndDeviceFunctions: List[String] = null, EndDeviceGroups: List[String] = null, EndDeviceInfo: String = null, ServiceLocation: String = null, UsagePoint: String = null) extends Element with Product with Serializable
Asset container that performs one or more end device functions.
Asset container that performs one or more end device functions.
One type of end device is a meter which can perform metering, load management, connect/disconnect, accounting functions, etc. Some end devices, such as ones monitoring and controlling air conditioners, refrigerators, pool pumps may be connected to a meter. All end devices may have communication capability defined by the associated communication function(s). An end device may be owned by a consumer, a service provider, utility or otherwise. There may be a related end device function that identifies a sensor or control point within a metering application or communications systems (e.g., water, gas, electricity). Some devices may use an optical port that conforms to the ANSI C12.18 standard for communications.
- AssetContainer
AssetContainer Reference to the superclass object.
- amrSystem
Automated meter reading (AMR) or other communication system responsible for communications to this end device.
- installCode
Installation code.
- isPan
If true, this is a premises area network (PAN) device.
- isSmartInverter
undocumented
- isVirtual
If true, there is no physical device. As an example, a virtual meter can be defined to aggregate the consumption for two or more physical meters. Otherwise, this is a physical hardware device.
- timeZoneOffset
Time zone offset relative to GMT for the location of this end device.
- Customer
Customer Customer owning this end device.
- DispatchablePowerCapability
DispatchablePowerCapability undocumented
- EndDeviceControls
EndDeviceControl All end device controls sending commands to this end device.
- EndDeviceEvents
EndDeviceEvent All events reported by this end device.
- EndDeviceFunctions
EndDeviceFunction All end device functions this end device performs.
- EndDeviceGroups
EndDeviceGroup All end device groups referring to this end device.
- EndDeviceInfo
EndDeviceInfo End device data.
- ServiceLocation
ServiceLocation Service location whose service delivery is measured by this end device.
- UsagePoint
UsagePoint Usage point to which this end device belongs.
-
final
case class
EndDeviceAction(Element: BasicElement = null, command: String = null, duration: Double = 0.0, durationIndefinite: Boolean = false, startDateTime: String = null, EndDeviceControl: String = null) extends Element with Product with Serializable
Action/command performed by an end device on a device other than the end device.
Action/command performed by an end device on a device other than the end device.
- Element
Reference to the superclass object.
- command
Command text.
- duration
Amount of time the action of this control is to remain active.
- durationIndefinite
True if the action of this control is indefinite.
- startDateTime
Start date and time for action of this control.
- EndDeviceControl
EndDeviceControl End device control issuing this end device action.
-
final
case class
EndDeviceCapability(Element: BasicElement = null, autonomousDst: Boolean = false, communication: Boolean = false, connectDisconnect: Boolean = false, demandResponse: Boolean = false, electricMetering: Boolean = false, gasMetering: Boolean = false, metrology: Boolean = false, onRequestRead: Boolean = false, outageHistory: Boolean = false, pressureCompensation: Boolean = false, pricingInfo: Boolean = false, pulseOutput: Boolean = false, relaysProgramming: Boolean = false, reverseFlow: Boolean = false, superCompressibilityCompensation: Boolean = false, temperatureCompensation: Boolean = false, textMessage: Boolean = false, waterMetering: Boolean = false) extends Element with Product with Serializable
Inherent capabilities of an end device (i.e., the functions it supports).
Inherent capabilities of an end device (i.e., the functions it supports).
- Element
Reference to the superclass object.
- autonomousDst
True if autonomous DST (daylight saving time) function is supported.
- communication
True if communication function is supported.
- connectDisconnect
True if connect and disconnect function is supported.
- demandResponse
True if demand response function is supported.
- electricMetering
True if electric metering function is supported.
- gasMetering
True if gas metering function is supported.
- metrology
True if metrology function is supported.
- onRequestRead
True if on request read function is supported.
- outageHistory
True if outage history function is supported.
- pressureCompensation
True if device performs pressure compensation for metered quantities.
- pricingInfo
True if pricing information is supported.
- pulseOutput
True if device produces pulse outputs.
- relaysProgramming
True if relays programming function is supported.
- reverseFlow
True if reverse flow function is supported.
- superCompressibilityCompensation
True if device performs super compressibility compensation for metered quantities.
- temperatureCompensation
True if device performs temperature compensation for metered quantities.
- textMessage
True if the displaying of text messages is supported.
- waterMetering
True if water metering function is supported.
-
final
case class
EndDeviceControl(IdentifiedObject: IdentifiedObject = null, drProgramLevel: Int = 0, drProgramMandatory: Boolean = false, issuerID: String = null, issuerTrackingID: String = null, priceSignal: String = null, primaryDeviceTiming: String = null, reason: String = null, scheduledInterval: String = null, secondaryDeviceTiming: String = null, EndDeviceAction: String = null, EndDeviceControlType: String = null, EndDeviceGroups: List[String] = null, EndDevices: List[String] = null, UsagePointGroups: List[String] = null, UsagePoints: List[String] = null) extends Element with Product with Serializable
Instructs an end device (or an end device group) to perform a specified action.
Instructs an end device (or an end device group) to perform a specified action.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- drProgramLevel
Level of a demand response program request, where 0=emergency. Note: Attribute is not defined on DemandResponseProgram as it is not its inherent property (it serves to control it).
- drProgramMandatory
Whether a demand response program request is mandatory. Note: Attribute is not defined on DemandResponseProgram as it is not its inherent property (it serves to control it).
- issuerID
Unique identifier of the business entity originating an end device control.
- issuerTrackingID
Identifier assigned by the initiator (e.g. retail electric provider) of an end device control action to uniquely identify the demand response event, text message, or other subject of the control action. Can be used when cancelling an event or text message request or to identify the originating event or text message in a consequential end device event.
- priceSignal
(if applicable) Price signal used as parameter for this end device control.
- primaryDeviceTiming
EndDeviceTiming Timing for the control actions performed on the device identified in the end device control.
- reason
Reason for the control action that allows to determine how to continue processing. For example, disconnect meter command may require different processing by the receiving system if it has been issued for a network-related reason (protection) or for a payment-related reason.
- scheduledInterval
(if control has scheduled duration) Date and time interval the control has been scheduled to execute within.
- secondaryDeviceTiming
EndDeviceTiming Timing for the control actions performed by devices that are responding to event related information sent to the primary device indicated in the end device control. For example, load control actions performed by a PAN device in response to demand response event information sent to a PAN gateway server.
- EndDeviceAction
EndDeviceAction End device action issued by this end device control.
- EndDeviceControlType
EndDeviceControlType Type of this end device control.
- EndDeviceGroups
EndDeviceGroup All end device groups receiving commands from this end device control.
- EndDevices
EndDevice All end devices receiving commands from this end device control.
- UsagePointGroups
UsagePointGroup All usage point groups receiving commands from this end device control.
- UsagePoints
UsagePoint All usage points receiving commands from this end device control.
-
final
case class
EndDeviceControlType(IdentifiedObject: IdentifiedObject = null, domain: String = null, eventOrAction: String = null, subDomain: String = null, type: String = null, EndDeviceControls: List[String] = null) extends Element with Product with Serializable
Detailed description for a control produced by an end device.
Detailed description for a control produced by an end device.
Values in attributes allow for creation of recommended codes to be used for identifying end device controls as follows: <type>.<domain>.<subDomain>.<eventOrAction>.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- domain
High-level nature of the control.
- eventOrAction
The most specific part of this control type. It is mainly in the form of a verb that gives action to the control that just occurred.
- subDomain
More specific nature of the control, as a further sub-categorisation of 'domain'.
- type
Type of physical device from which the control was created. A value of zero (0) can be used when the source is unknown.
- EndDeviceControls
EndDeviceControl All end device controls of this type.
-
final
case class
EndDeviceEvent(ActivityRecord: ActivityRecord = null, issuerID: String = null, issuerTrackingID: String = null, userID: String = null, EndDevice: String = null, EndDeviceEventDetails: List[String] = null, EndDeviceEventType: String = null, MeterReading: String = null, UsagePoint: String = null) extends Element with Product with Serializable
Event detected by a device function associated with the end device.
Event detected by a device function associated with the end device.
- ActivityRecord
ActivityRecord Reference to the superclass object.
- issuerID
Unique identifier of the business entity originating an end device control.
- issuerTrackingID
Identifier assigned by the initiator (e.g. retail electric provider) of an end device control action to uniquely identify the demand response event, text message, or other subject of the control action. Can be used when cancelling an event or text message request or to identify the originating event or text message in a consequential end device event.
- userID
(if user initiated) ID of user who initiated this end device event.
- EndDevice
EndDevice End device that reported this end device event.
- EndDeviceEventDetails
EndDeviceEventDetail All details of this end device event.
- EndDeviceEventType
EndDeviceEventType Type of this end device event.
- MeterReading
MeterReading Set of measured values to which this event applies.
- UsagePoint
UsagePoint Usage point for which this end device event is reported.
-
final
case class
EndDeviceEventDetail(Element: BasicElement = null, name: String = null, value: String = null, EndDeviceEvent: String = null) extends Element with Product with Serializable
Name-value pair, specific to end device events.
Name-value pair, specific to end device events.
- Element
Reference to the superclass object.
- name
Name.
- value
Value, including unit information.
- EndDeviceEvent
EndDeviceEvent End device owning this detail.
-
final
case class
EndDeviceEventType(IdentifiedObject: IdentifiedObject = null, domain: String = null, eventOrAction: String = null, subDomain: String = null, type: String = null, EndDeviceEvents: List[String] = null) extends Element with Product with Serializable
Detailed description for an event produced by an end device.
Detailed description for an event produced by an end device.
Values in attributes allow for creation of recommended codes to be used for identifying end device events as follows: <type>.<domain>.<subDomain>.<eventOrAction>.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- domain
High-level nature of the event. By properly classifying events by a small set of domain codes, a system can more easily run reports based on the types of events that have occurred or been received.
- eventOrAction
The most specific part of this event type. It is mainly in the form of a verb that gives action to the event that just occurred.
- subDomain
More specific nature of the event, as a further sub-categorisation of 'domain'.
- type
Type of physical device from which the event was created. A value of zero (0) can be used when the source is unknown.
- EndDeviceEvents
EndDeviceEvent All end device events of this type.
-
final
case class
EndDeviceFunction(AssetFunction: AssetFunction = null, enabled: Boolean = false, EndDevice: String = null, Registers: List[String] = null) extends Element with Product with Serializable
Function performed by an end device such as a meter, communication equipment, controllers, etc.
Function performed by an end device such as a meter, communication equipment, controllers, etc.
- AssetFunction
AssetFunction Reference to the superclass object.
- enabled
True if the function is enabled.
- EndDevice
EndDevice End device that performs this function.
- Registers
Register All registers for quantities metered by this end device function.
-
final
case class
EndDeviceGroup(IdentifiedObject: IdentifiedObject = null, status: String = null, type: String = null, version: String = null, DERFunction: String = null, DERGroupDispatch: List[String] = null, DERGroupForecast: List[String] = null, DERMonitorableParameter: List[String] = null, DemandResponsePrograms: List[String] = null, DispatchablePowerCapability: String = null, EndDeviceControls: List[String] = null, EndDevices: List[String] = null) extends Element with Product with Serializable
Abstraction for management of group communications within a two-way AMR system or the data for a group of related end devices.
Abstraction for management of group communications within a two-way AMR system or the data for a group of related end devices.
Commands can be issued to all of the end devices that belong to the group using a defined group address and the underlying AMR communication infrastructure. A DERGroup and a PANDeviceGroup is an EndDeviceGroup.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- status
undocumented
- type
Type of this group.
- version
undocumented
- DERFunction
DERFunction undocumented
- DERGroupDispatch
DERGroupDispatch undocumented
- DERGroupForecast
DERGroupForecast undocumented
- DERMonitorableParameter
DERMonitorableParameter undocumented
- DemandResponsePrograms
DemandResponseProgram All demand response programs this group of end devices is enrolled in.
- DispatchablePowerCapability
DispatchablePowerCapability undocumented
- EndDeviceControls
EndDeviceControl All end device controls sending commands to this end device group.
- EndDevices
EndDevice All end devices this end device group refers to.
-
final
case class
EndDeviceInfo(AssetInfo: AssetInfo = null, capability: String = null, isSolidState: Boolean = false, phaseCount: Int = 0, ratedCurrent: Double = 0.0, ratedVoltage: Double = 0.0, EndDevices: List[String] = null) extends Element with Product with Serializable
End device data.
End device data.
- AssetInfo
AssetInfo Reference to the superclass object.
- capability
EndDeviceCapability Inherent capabilities of the device (i.e., the functions it supports).
- isSolidState
If true, this is a solid state end device (as opposed to a mechanical or electromechanical device).
- phaseCount
Number of potential phases the end device supports, typically 0, 1 or 3.
- ratedCurrent
Rated current.
- ratedVoltage
Rated voltage.
- EndDevices
EndDevice All end devices described with this data.
-
final
case class
EndDeviceTiming(Element: BasicElement = null, duration: Double = 0.0, durationIndefinite: Boolean = false, interval: String = null, randomisation: String = null) extends Element with Product with Serializable
Timing for the control actions of end devices.
Timing for the control actions of end devices.
- Element
Reference to the superclass object.
- duration
Duration of the end device control action or the business event that is the subject of the end device control.
- durationIndefinite
True if 'duration' is indefinite.
- interval
Start and end time of an interval during which end device control actions are to be executed.
- randomisation
Kind of randomisation to be applied to the end device control actions to be executed.
-
final
case class
EnergyArea(IdentifiedObject: IdentifiedObject = null, ControlArea: String = null) extends Element with Product with Serializable
Describes an area having energy production or consumption.
Describes an area having energy production or consumption.
Specializations are intended to support the load allocation function as typically required in energy management systems or planning studies to allocate hypothesized load levels to individual load points for power flow analysis. Often the energy area can be linked to both measured and forecast load levels.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ControlArea
ControlArea The control area specification that is used for the load forecast.
- final case class EnergyComponent(IdentifiedObject: IdentifiedObject = null) extends Element with Product with Serializable
-
final
case class
EnergyConnection(ConductingEquipment: ConductingEquipment = null) extends Element with Product with Serializable
A connection of energy generation or consumption on the power system model.
A connection of energy generation or consumption on the power system model.
- ConductingEquipment
ConductingEquipment Reference to the superclass object.
-
final
case class
EnergyConsumer(EnergyConnection: EnergyConnection = null, customerCount: Int = 0, grounded: Boolean = false, p: Double = 0.0, pfixed: Double = 0.0, pfixedPct: Double = 0.0, phaseConnection: String = null, q: Double = 0.0, qfixed: Double = 0.0, qfixedPct: Double = 0.0, EnergyConsumerAction: String = null, EnergyConsumerPhase: List[String] = null, LoadDynamics: String = null, LoadResponse: String = null, PowerCutZone: String = null) extends Element with Product with Serializable
Generic user of energy - a point of consumption on the power system model.
Generic user of energy - a point of consumption on the power system model.
EnergyConsumer.pfixed, .qfixed, .pfixedPct and .qfixedPct have meaning only if there is no LoadResponseCharacteristic associated with EnergyConsumer or if LoadResponseCharacteristic.exponentModel is set to False.
- EnergyConnection
EnergyConnection Reference to the superclass object.
- customerCount
Number of individual customers represented by this demand.
- grounded
Used for Yn and Zn connections. True if the neutral is solidly grounded.
- p
Active power of the load. Load sign convention is used, i.e. positive sign means flow out from a node. For voltage dependent loads the value is at rated voltage. Starting value for a steady state solution.
- pfixed
Active power of the load that is a fixed quantity and does not vary as load group value varies. Load sign convention is used, i.e. positive sign means flow out from a node.
- pfixedPct
Fixed active power as a percentage of load group fixed active power. Used to represent the time-varying components. Load sign convention is used, i.e. positive sign means flow out from a node.
- phaseConnection
The type of phase connection, such as wye or delta.
- q
Reactive power of the load. Load sign convention is used, i.e. positive sign means flow out from a node. For voltage dependent loads the value is at rated voltage. Starting value for a steady state solution.
- qfixed
Reactive power of the load that is a fixed quantity and does not vary as load group value varies. Load sign convention is used, i.e. positive sign means flow out from a node.
- qfixedPct
Fixed reactive power as a percentage of load group fixed reactive power. Used to represent the time-varying components. Load sign convention is used, i.e. positive sign means flow out from a node.
- EnergyConsumerAction
EnergyConsumerAction undocumented
- EnergyConsumerPhase
EnergyConsumerPhase The individual phase models for this energy consumer.
- LoadDynamics
LoadDynamics Load dynamics model used to describe dynamic behaviour of this energy consumer.
- LoadResponse
LoadResponseCharacteristic The load response characteristic of this load. If missing, this load is assumed to be constant power.
- PowerCutZone
PowerCutZone The energy consumer is assigned to this power cut zone.
-
final
case class
EnergyConsumerAction(SwitchingAction: SwitchingAction = null, kind: String = null, EnergyConsumer: String = null) extends Element with Product with Serializable
Action to connect or disconnect the Energy Consumer from its Terminal
Action to connect or disconnect the Energy Consumer from its Terminal
- SwitchingAction
SwitchingAction Reference to the superclass object.
- kind
Switching action to perform
- EnergyConsumer
EnergyConsumer undocumented
-
final
case class
EnergyConsumerPhase(PowerSystemResource: PowerSystemResource = null, p: Double = 0.0, pfixed: Double = 0.0, pfixedPct: Double = 0.0, phase: String = null, q: Double = 0.0, qfixed: Double = 0.0, qfixedPct: Double = 0.0, EnergyConsumer: String = null) extends Element with Product with Serializable
A single phase of an energy consumer.
A single phase of an energy consumer.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- p
Active power of the load. Load sign convention is used, i.e. positive sign means flow out from a node. For voltage dependent loads the value is at rated voltage. Starting value for a steady state solution.
- pfixed
Active power of the load that is a fixed quantity. Load sign convention is used, i.e. positive sign means flow out from a node.
- pfixedPct
Fixed active power as per cent of load group fixed active power. Load sign convention is used, i.e. positive sign means flow out from a node.
- phase
Phase of this energy consumer component. If the energy consumer is wye connected, the connection is from the indicated phase to the central ground or neutral point. If the energy consumer is delta connected, the phase indicates an energy consumer connected from the indicated phase to the next logical non-neutral phase.
- q
Reactive power of the load. Load sign convention is used, i.e. positive sign means flow out from a node. For voltage dependent loads the value is at rated voltage. Starting value for a steady state solution.
- qfixed
Reactive power of the load that is a fixed quantity. Load sign convention is used, i.e. positive sign means flow out from a node.
- qfixedPct
Fixed reactive power as per cent of load group fixed reactive power. Load sign convention is used, i.e. positive sign means flow out from a node.
- EnergyConsumer
EnergyConsumer The energy consumer to which this phase belongs.
- final case class EnergyGroup(PowerSystemResource: PowerSystemResource = null, isSlack: Boolean = false, p: Double = 0.0) extends Element with Product with Serializable
-
final
case class
EnergyMarket(Market: Market = null, Bids: List[String] = null, MarketResults: String = null, RTO: String = null, RegisteredResources: List[String] = null, Settlements: List[String] = null) extends Element with Product with Serializable
Energy and Ancillary Market (e.g.
Energy and Ancillary Market (e.g.
Energy, Spinning Reserve, Non-Spinning Reserve) with a description of the Market operation control parameters.
- Market
Market Reference to the superclass object.
- Bids
Bid undocumented
- MarketResults
MarketResults undocumented
- RTO
RTO undocumented
- RegisteredResources
RegisteredResource undocumented
- Settlements
Settlement undocumented
-
final
case class
EnergyPriceCurve(Element: BasicElement = null, EnergyTransactions: List[String] = null, FTRs: List[String] = null) extends Element with Product with Serializable
Relationship between a price in $(or other monetary unit) /hour (Y-axis) and a MW value (X-axis).
Relationship between a price in $(or other monetary unit) /hour (Y-axis) and a MW value (X-axis).
- Element
Reference to the superclass object.
- EnergyTransactions
EnergyTransaction undocumented
- FTRs
FTR undocumented
-
final
case class
EnergyPriceIndex(IdentifiedObject: IdentifiedObject = null, energyPriceIndex: Double = 0.0, energyPriceIndexType: String = null, lastModified: String = null, validPeriod: String = null, RegisteredGenerator: String = null) extends Element with Product with Serializable
An Energy Price Index for each Resource is valid for a period (e.g.
An Energy Price Index for each Resource is valid for a period (e.g. daily) that is identified by a Valid Period Start Time and a Valid Period End Time.
An Energy Price Index is in $/MWh.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- energyPriceIndex
Energy price index
- energyPriceIndexType
EPI type such as wholesale or retail
- lastModified
Time updated
- validPeriod
Valid period for which the energy price index is valid.
- RegisteredGenerator
RegisteredGenerator undocumented
-
final
case class
EnergyProduct(Agreement: Agreement = null, EnergyTransactions: List[String] = null, GenerationProvider: String = null, ResoldBy_Marketer: List[String] = null, TitleHeldBy_Marketer: String = null) extends Element with Product with Serializable
An EnergyProduct is offered commercially as a ContractOrTariff.
An EnergyProduct is offered commercially as a ContractOrTariff.
- Agreement
Agreement Reference to the superclass object.
- EnergyTransactions
EnergyTransaction The "Source" for an EnergyTransaction is an EnergyProduct which is injected into a ControlArea. Typically this is a ServicePoint.
- GenerationProvider
GenerationProvider undocumented
- ResoldBy_Marketer
Marketer A Marketer may resell an EnergyProduct.
- TitleHeldBy_Marketer
Marketer A Marketer holds title to an EnergyProduct.
-
final
case class
EnergyProfile(Profile: Profile = null, EnergyTransaction: String = null, TransactionBid: String = null) extends Element with Product with Serializable
Specifies the start time, stop time, level for an EnergyTransaction.
Specifies the start time, stop time, level for an EnergyTransaction.
- Profile
Profile Reference to the superclass object.
- EnergyTransaction
EnergyTransaction An EnergyTransaction shall have at least one EnergyProfile.
- TransactionBid
TransactionBid undocumented
-
final
case class
EnergySchedulingType(IdentifiedObject: IdentifiedObject = null, EnergySource: List[String] = null) extends Element with Product with Serializable
Used to define the type of generation for scheduling purposes.
Used to define the type of generation for scheduling purposes.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- EnergySource
EnergySource Energy Source of a particular Energy Scheduling Type.
-
final
case class
EnergySource(EnergyConnection: EnergyConnection = null, activePower: Double = 0.0, nominalVoltage: Double = 0.0, pMax: Double = 0.0, pMin: Double = 0.0, r: Double = 0.0, r0: Double = 0.0, reactivePower: Double = 0.0, rn: Double = 0.0, voltageAngle: Double = 0.0, voltageMagnitude: Double = 0.0, x: Double = 0.0, x0: Double = 0.0, xn: Double = 0.0, EnergySchedulingType: String = null, EnergySourceAction: String = null, EnergySourcePhase: List[String] = null) extends Element with Product with Serializable
A generic equivalent for an energy supplier on a transmission or distribution voltage level.
A generic equivalent for an energy supplier on a transmission or distribution voltage level.
- EnergyConnection
EnergyConnection Reference to the superclass object.
- activePower
High voltage source active injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for steady state solutions.
- nominalVoltage
Phase-to-phase nominal voltage.
- pMax
This is the maximum active power that can be produced by the source. Load sign convention is used, i.e. positive sign means flow out from a TopologicalNode (bus) into the conducting equipment.
- pMin
This is the minimum active power that can be produced by the source. Load sign convention is used, i.e. positive sign means flow out from a TopologicalNode (bus) into the conducting equipment.
- r
Positive sequence Thevenin resistance.
- r0
Zero sequence Thevenin resistance.
- reactivePower
High voltage source reactive injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for steady state solutions.
- rn
Negative sequence Thevenin resistance.
- voltageAngle
Phase angle of a-phase open circuit used when voltage characteristics need to be imposed at the node associated with the terminal of the energy source, such as when voltages and angles from the transmission level are used as input to the distribution network. The attribute shall be a positive value or zero.
- voltageMagnitude
Phase-to-phase open circuit voltage magnitude used when voltage characteristics need to be imposed at the node associated with the terminal of the energy source, such as when voltages and angles from the transmission level are used as input to the distribution network. The attribute shall be a positive value or zero.
- x
Positive sequence Thevenin reactance.
- x0
Zero sequence Thevenin reactance.
- xn
Negative sequence Thevenin reactance.
- EnergySchedulingType
EnergySchedulingType Energy Scheduling Type of an Energy Source.
- EnergySourceAction
EnergySourceAction Action taken with this energy source.
- EnergySourcePhase
EnergySourcePhase The individual phase information of the energy source.
-
final
case class
EnergySourceAction(SwitchingAction: SwitchingAction = null, kind: String = null, EnergySource: String = null) extends Element with Product with Serializable
Action on energy source as a switching step.
Action on energy source as a switching step.
- SwitchingAction
SwitchingAction Reference to the superclass object.
- kind
Switching action to perform.
- EnergySource
EnergySource Energy source on which this action is taken.
-
final
case class
EnergySourcePhase(PowerSystemResource: PowerSystemResource = null, phase: String = null, EnergySource: String = null) extends Element with Product with Serializable
Represents the single phase information of an unbalanced energy source.
Represents the single phase information of an unbalanced energy source.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- phase
Phase of this energy source component. If the energy source wye connected, the connection is from the indicated phase to the central ground or neutral point. If the energy source is delta connected, the phase indicates an energy source connected from the indicated phase to the next logical non-neutral phase.
- EnergySource
EnergySource The energy sourceto which the phase belongs.
-
final
case class
EnergyTransaction(Document: Document = null, capacityBacked: Boolean = false, congestChargeMax: Double = 0.0, deliveryPointP: Double = 0.0, energyMin: Double = 0.0, firmInterchangeFlag: Boolean = false, payCongestion: Boolean = false, reason: String = null, receiptPointP: Double = 0.0, state: String = null, CurtailmentProfiles: List[String] = null, EnergyPriceCurves: List[String] = null, EnergyProduct: String = null, EnergyProfiles: List[String] = null, Export_SubControlArea: String = null, Import_SubControlArea: String = null, LossProfiles: List[String] = null, TieLines: List[String] = null, TransmissionReservation: String = null) extends Element with Product with Serializable
Specifies the schedule for energy transfers between interchange areas that are necessary to satisfy the associated interchange transaction.
Specifies the schedule for energy transfers between interchange areas that are necessary to satisfy the associated interchange transaction.
- Document
Document Reference to the superclass object.
- capacityBacked
Interchange capacity flag. When the flag is set to true, it indicates a transaction is capacity backed.
- congestChargeMax
Maximum congestion charges in monetary units.
- deliveryPointP
Delivery point active power.
- energyMin
Transaction minimum active power if dispatchable.
- firmInterchangeFlag
Firm interchange flag indicates whether or not this energy transaction can be changed without potential financial consequences.
- payCongestion
Willing to Pay congestion flag
- reason
Reason for energy transaction.
- receiptPointP
Receipt point active power.
- state
{ Approve | Deny | Study }
- CurtailmentProfiles
CurtailmentProfile An EnergyTransaction may be curtailed by any of the participating entities.
- EnergyPriceCurves
EnergyPriceCurve undocumented
- EnergyProduct
EnergyProduct The "Source" for an EnergyTransaction is an EnergyProduct which is injected into a ControlArea. Typically this is a ServicePoint.
- EnergyProfiles
EnergyProfile An EnergyTransaction shall have at least one EnergyProfile.
- Export_SubControlArea
SubControlArea Energy is transferred between interchange areas
- Import_SubControlArea
SubControlArea Energy is transferred between interchange areas
- LossProfiles
LossProfile An EnergyTransaction may have a LossProfile.
- TieLines
TieLine A dynamic energy transaction can act as a pseudo tie line.
- TransmissionReservation
TransmissionReservation undocumented
- final case class EnergyTypeReference(IdentifiedObject: IdentifiedObject = null, kind: String = null) extends Element with Product with Serializable
-
final
case class
EnvironmentalAlert(ActivityRecord: ActivityRecord = null, alertType: String = null, cancelledDateTime: String = null, headline: String = null, inEffect: String = null, AlertTypeList: String = null, EnvironmentalDataProvider: String = null, EnvironmentalLocationKind: List[String] = null) extends Element with Product with Serializable
An environmental alert issued by a provider or system.
An environmental alert issued by a provider or system.
- ActivityRecord
ActivityRecord Reference to the superclass object.
- alertType
The type of the issued alert which is drawn from the specified alert type list.
- cancelledDateTime
Time and date alert cancelled. Used only if alert is cancelled before it expires.
- headline
An abbreviated textual description of the alert issued. Note: the full text of the alert appears in the .description attribute (inherited from IdentifiedObject).
- inEffect
The interval for which this weather alert is in effect.
- AlertTypeList
AlertTypeList The list of alert types from which the type of this alert is drawn.
- EnvironmentalDataProvider
EnvironmentalDataProvider Environmental data provider for this alert.
- EnvironmentalLocationKind
EnvironmentalLocationType Type of location to which this environmental alert applies.
-
final
case class
EnvironmentalAnalog(Analog: Analog = null, ClassificationCondition: String = null, EnvironmentalInformation: String = null, EnvironmentalMonitoringStation: String = null, ReportingCapability: String = null) extends Element with Product with Serializable
Analog (float) measurement of relevance in the environmental domain.
Analog (float) measurement of relevance in the environmental domain.
- Analog
Analog Reference to the superclass object.
- ClassificationCondition
ClassificationCondition Classification condition which this analog helps define.
- EnvironmentalInformation
EnvironmentalInformation Observation or forecast with which this environmental analog measurement is associated.
- EnvironmentalMonitoringStation
EnvironmentalMonitoringStation Monitoring station which provides this environmental analog measurement.
- ReportingCapability
ReportingCapability The reporting capability this environmental value set helps define.
-
final
case class
EnvironmentalCodedValue(StringMeasurementValue: StringMeasurementValue = null, coverageKind: String = null, intensityKind: String = null, probabilityPercent: Double = 0.0, weatherKind: String = null) extends Element with Product with Serializable
An environmental value described using a coded value.
An environmental value described using a coded value.
A triplicate of enumerated values representing intensity, coverage, type of weather is used. These may be concatenated into the string value.
- StringMeasurementValue
StringMeasurementValue Reference to the superclass object.
- coverageKind
Code representing the coverage of the weather condition.
- intensityKind
Code representing the intensity of the weather condition.
- probabilityPercent
Probability of weather condition occurring during the time interval expressed as a percentage. Applicable only when weather condition is related to a forecast (not an observation).
- weatherKind
Code representing the type of weather condition.
-
final
case class
EnvironmentalDataAuthority(OrganisationRole: OrganisationRole = null, AlertTypeList: List[String] = null, PhenomenonClassification: List[String] = null) extends Element with Product with Serializable
An entity defining classifications or categories of environmental information, like phenomena or alerts.
An entity defining classifications or categories of environmental information, like phenomena or alerts.
- OrganisationRole
OrganisationRole Reference to the superclass object.
- AlertTypeList
AlertTypeList A specific version of a list of alerts published by this environmental data authority.
- PhenomenonClassification
PhenomenonClassification Phenomenon classification defined by this environmental data authority.
-
final
case class
EnvironmentalDataProvider(OrganisationRole: OrganisationRole = null, EnvironmentalAlert: List[String] = null, EnvironmentalInformation: List[String] = null) extends Element with Product with Serializable
Entity providing environmental data.
Entity providing environmental data.
Could be an observed weather data provider, an entity providing forecasts, an authority providing alerts, etc.
- OrganisationRole
OrganisationRole Reference to the superclass object.
- EnvironmentalAlert
EnvironmentalAlert Alert issued by this environmental data provider.
- EnvironmentalInformation
EnvironmentalInformation Environmental information provided by this environmental data provider.
-
final
case class
EnvironmentalDependentLimit(LimitDependency: LimitDependency = null) extends Element with Product with Serializable
This is a environmental based limit dependency model for calculating operational limits.
This is a environmental based limit dependency model for calculating operational limits.
- LimitDependency
LimitDependency Reference to the superclass object.
-
final
case class
EnvironmentalDiscrete(Discrete: Discrete = null, kind: String = null, EnvironmentalInformation: String = null) extends Element with Product with Serializable
Discrete (integer) measurement of relevance in the environmental domain.
Discrete (integer) measurement of relevance in the environmental domain.
- Discrete
Discrete Reference to the superclass object.
- kind
Kind of environmental discrete (integer).
- EnvironmentalInformation
EnvironmentalInformation Observation or forecast with which this environmental discrete (integer) is associated.
-
final
case class
EnvironmentalEvent(ActivityRecord: ActivityRecord = null, EnvironmentalInformation: List[String] = null) extends Element with Product with Serializable
An environmental event to which one or more forecasts or observations may be tied and which may relate to or affect one or more assets.
An environmental event to which one or more forecasts or observations may be tied and which may relate to or affect one or more assets.
This class is intended to be used as a means of grouping forecasts and/or observations and could be used for a variety of purposes, including:
- to define a 'named' event like Hurricane Katrina and allow the historic (or forecast) values for phenomena and measurements (precipitation, temperature) across time to be associated with it
- to identify assets that were (or are forecast to be) affected by a phenomenon or set of measurements
- ActivityRecord
ActivityRecord Reference to the superclass object.
- EnvironmentalInformation
EnvironmentalInformation Forecast or observation related to this environmental event.
-
final
case class
EnvironmentalInformation(IdentifiedObject: IdentifiedObject = null, created: String = null, EnvironmentalAnalog: List[String] = null, EnvironmentalDataProvider: String = null, EnvironmentalDiscrete: List[String] = null, EnvironmentalEvent: List[String] = null, EnvironmentalPhenomenon: List[String] = null, EnvironmentalStringMeasurement: List[String] = null) extends Element with Product with Serializable
Abstract class (with concrete child classes of Observation and Forecast) that groups phenomenon and/or environmental value sets.
Abstract class (with concrete child classes of Observation and Forecast) that groups phenomenon and/or environmental value sets.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- created
The timestamp of when the forecast was created
- EnvironmentalAnalog
EnvironmentalAnalog Environmental analog associated with this observation or forecast.
- EnvironmentalDataProvider
EnvironmentalDataProvider Environmental data provider supplying this environmental information.
- EnvironmentalDiscrete
EnvironmentalDiscrete Environmental discrete (integer) associated with this observation or forecast.
- EnvironmentalEvent
EnvironmentalEvent Environmental event to which this forecast or observation relates.
- EnvironmentalPhenomenon
EnvironmentalPhenomenon undocumented
- EnvironmentalStringMeasurement
EnvironmentalStringMeasurement Environmental string measurement associated with this forecast or observation.
-
final
case class
EnvironmentalLocationType(Element: BasicElement = null, kind: String = null, EnvironmentalAlert: List[String] = null, EnvironmentalPhenomenon: List[String] = null, Location: String = null) extends Element with Product with Serializable
Type of environmental location.
Type of environmental location.
Used when an environmental alert or phenomenon has multiple locations associated with it.
- Element
Reference to the superclass object.
- kind
The kind of location. Typical values might be center, extent, primary, secondary, etc.
- EnvironmentalAlert
EnvironmentalAlert Environmental alert applying to location of this type.
- EnvironmentalPhenomenon
EnvironmentalPhenomenon Environmental phenomenon for which this location is of relevance.
- Location
Location Location of this instance of ths kind of environmental location.
-
final
case class
EnvironmentalMonitoringStation(IdentifiedObject: IdentifiedObject = null, dstObserved: Boolean = false, isNetworked: Boolean = false, timeZoneOffset: Double = 0.0, EnvironmentalAnalog: List[String] = null, Location: String = null, ReportingCapability: List[String] = null, TimeSeries: List[String] = null, UsagePoint: List[String] = null) extends Element with Product with Serializable
An environmental monitoring station, examples of which could be a weather station or a seismic monitoring station.
An environmental monitoring station, examples of which could be a weather station or a seismic monitoring station.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- dstObserved
Whether this station is currently reporting using daylight saving time. Intended to aid a utility Weather Service in interpreting information coming from a station and has no direct relationship to the manner in which time is expressed in EnvironmentalValueSet.
- isNetworked
Indication that station is part of a network of stations used to monitor weather phenomena covering a large geographical area.
- timeZoneOffset
The time offset from UTC (a.k.a. GMT) configured in the station "clock", not (necessarily) the time zone in which the station is physically located. This attribute exists to support management of utility monitoring stations and has no direct relationship to the manner in which time is expressed in EnvironmentalValueSet.
- EnvironmentalAnalog
EnvironmentalAnalog Environmental analog measurement provided by this monitoring station.
- Location
Location Location of this monitoring station.
- ReportingCapability
ReportingCapability One of the reporting capabilities of this monitoring station.
- TimeSeries
TimeSeries undocumented
- UsagePoint
UsagePoint undocumented
-
final
case class
EnvironmentalPhenomenon(Element: BasicElement = null, timeInterval: String = null, EnvironmentalInformation: String = null, EnvironmentalLocationKind: List[String] = null, PhenomenonClassification: String = null) extends Element with Product with Serializable
The actual or forecast characteristics of an environmental phenomenon at a specific point in time (or during a specific time interval) that may have both a center and area/line location.
The actual or forecast characteristics of an environmental phenomenon at a specific point in time (or during a specific time interval) that may have both a center and area/line location.
- Element
Reference to the superclass object.
- timeInterval
The timestamp of the phenomenon as a single point or time interval.
- EnvironmentalInformation
EnvironmentalInformation The forecast or observation of which this phenomenon description is a part.
- EnvironmentalLocationKind
EnvironmentalLocationType Location of relevance to this environmental phenomenon.
- PhenomenonClassification
PhenomenonClassification The classification of this phenomenon.
-
final
case class
EnvironmentalStringMeasurement(StringMeasurement: StringMeasurement = null, ClassificationCondition: String = null, EnvironmentalInformation: String = null) extends Element with Product with Serializable
String measurement of relevance in the environmental domain.
String measurement of relevance in the environmental domain.
- StringMeasurement
StringMeasurement Reference to the superclass object.
- ClassificationCondition
ClassificationCondition Classification condition which this string measurement helps define.
- EnvironmentalInformation
EnvironmentalInformation Observation or forecast with which this environmental string is associated.
-
final
case class
Equipment(PowerSystemResource: PowerSystemResource = null, aggregate: Boolean = false, inService: Boolean = false, networkAnalysisEnabled: Boolean = false, normallyInService: Boolean = false, AdditionalEquipmentContainer: List[String] = null, ContingencyEquipment: List[String] = null, EqiupmentLimitSeriesComponent: List[String] = null, EquipmentContainer: String = null, Faults: List[String] = null, LimitDependencyModel: List[String] = null, OperationalLimitSet: List[String] = null, OperationalRestrictions: List[String] = null, Outages: List[String] = null, PinEquipment: List[String] = null, ProtectiveActionEquipment: List[String] = null, UsagePoints: List[String] = null, WeatherStation: List[String] = null) extends Element with Product with Serializable
The parts of a power system that are physical devices, electronic or mechanical.
The parts of a power system that are physical devices, electronic or mechanical.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- aggregate
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.
- inService
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.
- networkAnalysisEnabled
The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.
- normallyInService
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.
- AdditionalEquipmentContainer
EquipmentContainer Additional equipment container beyond the primary equipment container. The equipment is contained in another equipment container, but also grouped with this equipment container.
- ContingencyEquipment
ContingencyEquipment The contingency equipments in which this equipment participates.
- EqiupmentLimitSeriesComponent
EquipmentLimitSeriesComponent Equipment limit series calculation component to which this equipment contributes.
- EquipmentContainer
EquipmentContainer Container of this equipment.
- Faults
Fault All faults on this equipment.
- LimitDependencyModel
LimitDependency Limit dependencymodels organized under this equipment as a means for organizing the model in a tree view.
- OperationalLimitSet
OperationalLimitSet The operational limit sets associated with this equipment.
- OperationalRestrictions
OperationalRestriction All operational restrictions for this equipment.
- Outages
Outage All outages in which this equipment is involved.
- PinEquipment
PinEquipment undocumented
- ProtectiveActionEquipment
ProtectiveActionEquipment Protective action is controlling equipment. This can be direct signals from the control center, or emulation of action done by protection equipment.
- UsagePoints
UsagePoint All usage points connected to the electrical grid through this equipment.
- WeatherStation
WeatherStation undocumented
-
final
case class
EquipmentContainer(ConnectivityNodeContainer: ConnectivityNodeContainer = null, AdditionalGroupedEquipment: List[String] = null, Equipments: List[String] = null) extends Element with Product with Serializable
A modelling construct to provide a root class for containing equipment.
A modelling construct to provide a root class for containing equipment.
- ConnectivityNodeContainer
ConnectivityNodeContainer Reference to the superclass object.
- AdditionalGroupedEquipment
Equipment The additonal contained equipment. The equipment belong to the equipment container. The equipment is contained in another equipment container, but also grouped with this equipment container. Examples include when a switch contained in a substation is also desired to be grouped with a line contianer or when a switch is included in a secondary substation and also grouped in a feeder.
- Equipments
Equipment Contained equipment.
-
final
case class
EquipmentFault(Fault: Fault = null, Terminal: String = null) extends Element with Product with Serializable
A fault applied at the terminal, external to the equipment.
-
final
case class
EquipmentLimitSeriesComponent(IdentifiedObject: IdentifiedObject = null, Equipment: String = null, SeriesEquipmentDependentLimit: String = null) extends Element with Product with Serializable
This represents one instance of an equipment that contributes to the calculation of an operational limit.
This represents one instance of an equipment that contributes to the calculation of an operational limit.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- Equipment
Equipment Equipment contributing toward the series limit. The reference here is to Equipment rather than a specific limit on the equipment so the grouiping can be reused for multiple limits of different types on the same instance of equipment.
- SeriesEquipmentDependentLimit
SeriesEquipmentDependentLimit Calculation in which the refernce to equipment applies.
- final case class EquipmentUnavailabilitySchedule(IdentifiedObject: IdentifiedObject = null) extends Element with Product with Serializable
-
final
case class
EquivalentBranch(EquivalentEquipment: EquivalentEquipment = null, negativeR12: Double = 0.0, negativeR21: Double = 0.0, negativeX12: Double = 0.0, negativeX21: Double = 0.0, positiveR12: Double = 0.0, positiveR21: Double = 0.0, positiveX12: Double = 0.0, positiveX21: Double = 0.0, r: Double = 0.0, r21: Double = 0.0, x: Double = 0.0, x21: Double = 0.0, zeroR12: Double = 0.0, zeroR21: Double = 0.0, zeroX12: Double = 0.0, zeroX21: Double = 0.0) extends Element with Product with Serializable
The class represents equivalent branches.
The class represents equivalent branches.
In cases where a transformer phase shift is modelled and the EquivalentBranch is spanning the same nodes, the impedance quantities for the EquivalentBranch shall consider the needed phase shift.
- EquivalentEquipment
EquivalentEquipment Reference to the superclass object.
- negativeR12
Negative sequence series resistance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909. EquivalentBranch is a result of network reduction prior to the data exchange.
- negativeR21
Negative sequence series resistance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909. EquivalentBranch is a result of network reduction prior to the data exchange.
- negativeX12
Negative sequence series reactance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909. Usage : EquivalentBranch is a result of network reduction prior to the data exchange.
- negativeX21
Negative sequence series reactance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909. Usage: EquivalentBranch is a result of network reduction prior to the data exchange.
- positiveR12
Positive sequence series resistance from terminal sequence 1 to terminal sequence 2 . Used for short circuit data exchange according to IEC 60909. EquivalentBranch is a result of network reduction prior to the data exchange.
- positiveR21
Positive sequence series resistance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909. EquivalentBranch is a result of network reduction prior to the data exchange.
- positiveX12
Positive sequence series reactance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909. Usage : EquivalentBranch is a result of network reduction prior to the data exchange.
- positiveX21
Positive sequence series reactance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909. Usage : EquivalentBranch is a result of network reduction prior to the data exchange.
- r
Positive sequence series resistance of the reduced branch.
- r21
Resistance from terminal sequence 2 to terminal sequence 1 . Used for steady state power flow. This attribute is optional and represent unbalanced network such as off-nominal phase shifter. If only EquivalentBranch.r is given, then EquivalentBranch.r21 is assumed equal to EquivalentBranch.r. Usage rule : EquivalentBranch is a result of network reduction prior to the data exchange.
- x
Positive sequence series reactance of the reduced branch.
- x21
Reactance from terminal sequence 2 to terminal sequence 1. Used for steady state power flow. This attribute is optional and represents an unbalanced network such as off-nominal phase shifter. If only EquivalentBranch.x is given, then EquivalentBranch.x21 is assumed equal to EquivalentBranch.x. Usage rule: EquivalentBranch is a result of network reduction prior to the data exchange.
- zeroR12
Zero sequence series resistance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909. EquivalentBranch is a result of network reduction prior to the data exchange.
- zeroR21
Zero sequence series resistance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909. Usage : EquivalentBranch is a result of network reduction prior to the data exchange.
- zeroX12
Zero sequence series reactance from terminal sequence 1 to terminal sequence 2. Used for short circuit data exchange according to IEC 60909. Usage : EquivalentBranch is a result of network reduction prior to the data exchange.
- zeroX21
Zero sequence series reactance from terminal sequence 2 to terminal sequence 1. Used for short circuit data exchange according to IEC 60909. Usage : EquivalentBranch is a result of network reduction prior to the data exchange.
-
final
case class
EquivalentEquipment(ConductingEquipment: ConductingEquipment = null, EquivalentNetwork: String = null) extends Element with Product with Serializable
The class represents equivalent objects that are the result of a network reduction.
The class represents equivalent objects that are the result of a network reduction.
The class is the base for equivalent objects of different types.
- ConductingEquipment
ConductingEquipment Reference to the superclass object.
- EquivalentNetwork
EquivalentNetwork The equivalent where the reduced model belongs.
-
final
case class
EquivalentInjection(EquivalentEquipment: EquivalentEquipment = null, maxP: Double = 0.0, maxQ: Double = 0.0, minP: Double = 0.0, minQ: Double = 0.0, p: Double = 0.0, q: Double = 0.0, r: Double = 0.0, r0: Double = 0.0, r2: Double = 0.0, regulationCapability: Boolean = false, regulationStatus: Boolean = false, regulationTarget: Double = 0.0, x: Double = 0.0, x0: Double = 0.0, x2: Double = 0.0, ReactiveCapabilityCurve: String = null) extends Element with Product with Serializable
This class represents equivalent injections (generation or load).
This class represents equivalent injections (generation or load).
Voltage regulation is allowed only at the point of connection.
- EquivalentEquipment
EquivalentEquipment Reference to the superclass object.
- maxP
Maximum active power of the injection.
- maxQ
Maximum reactive power of the injection. Used for modelling of infeed for load flow exchange. Not used for short circuit modelling. If maxQ and minQ are not used ReactiveCapabilityCurve can be used.
- minP
Minimum active power of the injection.
- minQ
Minimum reactive power of the injection. Used for modelling of infeed for load flow exchange. Not used for short circuit modelling. If maxQ and minQ are not used ReactiveCapabilityCurve can be used.
- p
Equivalent active power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for steady state solutions.
- q
Equivalent reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for steady state solutions.
- r
Positive sequence resistance. Used to represent Extended-Ward (IEC 60909). Usage : Extended-Ward is a result of network reduction prior to the data exchange.
- r0
Zero sequence resistance. Used to represent Extended-Ward (IEC 60909). Usage : Extended-Ward is a result of network reduction prior to the data exchange.
- r2
Negative sequence resistance. Used to represent Extended-Ward (IEC 60909). Usage : Extended-Ward is a result of network reduction prior to the data exchange.
- regulationCapability
Specifies whether or not the EquivalentInjection has the capability to regulate the local voltage. If true the EquivalentInjection can regulate. If false the EquivalentInjection cannot regulate. ReactiveCapabilityCurve can only be associated with EquivalentInjection if the flag is true.
- regulationStatus
Specifies the regulation status of the EquivalentInjection. True is regulating. False is not regulating.
- regulationTarget
The target voltage for voltage regulation. The attribute shall be a positive value.
- x
Positive sequence reactance. Used to represent Extended-Ward (IEC 60909). Usage : Extended-Ward is a result of network reduction prior to the data exchange.
- x0
Zero sequence reactance. Used to represent Extended-Ward (IEC 60909). Usage : Extended-Ward is a result of network reduction prior to the data exchange.
- x2
Negative sequence reactance. Used to represent Extended-Ward (IEC 60909). Usage : Extended-Ward is a result of network reduction prior to the data exchange.
- ReactiveCapabilityCurve
ReactiveCapabilityCurve The reactive capability curve used by this equivalent injection.
-
final
case class
EquivalentNetwork(ConnectivityNodeContainer: ConnectivityNodeContainer = null, EquivalentEquipments: List[String] = null) extends Element with Product with Serializable
A class that groups electrical equivalents, including internal nodes, of a network that has been reduced.
A class that groups electrical equivalents, including internal nodes, of a network that has been reduced.
The ConnectivityNodes contained in the equivalent are intended to reflect internal nodes of the equivalent. The boundary Connectivity nodes where the equivalent connects outside itself are not contained by the equivalent.
- ConnectivityNodeContainer
ConnectivityNodeContainer Reference to the superclass object.
- EquivalentEquipments
EquivalentEquipment The associated reduced equivalents.
-
final
case class
EquivalentShunt(EquivalentEquipment: EquivalentEquipment = null, b: Double = 0.0, g: Double = 0.0) extends Element with Product with Serializable
The class represents equivalent shunts.
The class represents equivalent shunts.
- EquivalentEquipment
EquivalentEquipment Reference to the superclass object.
- b
Positive sequence shunt susceptance.
- g
Positive sequence shunt conductance.
-
final
case class
ErpBOM(ErpDocument: ErpDocument = null, Design: String = null, ErpBomItemDatas: List[String] = null) extends Element with Product with Serializable
Information that generally describes the Bill of Material Structure and its contents for a utility.
Information that generally describes the Bill of Material Structure and its contents for a utility.
This is used by ERP systems to transfer Bill of Material information between two business applications.
- ErpDocument
ErpDocument Reference to the superclass object.
- Design
Design undocumented
- ErpBomItemDatas
ErpBomItemData undocumented
-
final
case class
ErpBankAccount(BankAccount: BankAccount = null, bankABA: String = null) extends Element with Product with Serializable
Relationship under a particular name, usually evidenced by a deposit against which withdrawals can be made.
Relationship under a particular name, usually evidenced by a deposit against which withdrawals can be made.
Types of bank accounts include: demand, time, custodial, joint, trustee, corporate, special, and regular accounts. A statement of transactions during a fiscal period and the resulting balance is maintained on each account. For Payment metering, the account is associated with Bank and Supplier, reflecting details of the bank account used for depositing revenue collected by TokenVendor. The name of the account holder should be specified in 'name' attribute.
- BankAccount
BankAccount Reference to the superclass object.
- bankABA
Bank ABA.
-
final
case class
ErpBomItemData(ErpIdentifiedObject: ErpIdentifiedObject = null, DesignLocation: String = null, ErpBOM: String = null, TypeAsset: String = null) extends Element with Product with Serializable
An individual item on a bill of materials.
An individual item on a bill of materials.
- ErpIdentifiedObject
ErpIdentifiedObject Reference to the superclass object.
- DesignLocation
DesignLocation undocumented
- ErpBOM
ErpBOM undocumented
- TypeAsset
CatalogAssetType undocumented
-
final
case class
ErpChartOfAccounts(ErpDocument: ErpDocument = null) extends Element with Product with Serializable
Accounting structure of a business.
Accounting structure of a business.
Each account represents a financial aspect of a business, such as its Accounts Payable, or the value of its inventory, or its office supply expenses.
- ErpDocument
ErpDocument Reference to the superclass object.
-
final
case class
ErpCompetency(ErpIdentifiedObject: ErpIdentifiedObject = null, ErpPersons: List[String] = null) extends Element with Product with Serializable
Information that describes aptitudes of a utility employee.
Information that describes aptitudes of a utility employee.
Unlike Skills that an ErpPerson must be certified to perform before undertaking certain type of assignments (to be able to perfrom a Craft), ErpCompetency has more to do with typical Human Resource (HR) matters such as schooling, training, etc.
- ErpIdentifiedObject
ErpIdentifiedObject Reference to the superclass object.
- ErpPersons
OldPerson undocumented
-
final
case class
ErpDocument(Document: Document = null) extends Element with Product with Serializable
Shadow class for Document, to isolate subclassing from this package.
Shadow class for Document, to isolate subclassing from this package.
If any subclass gets normative and needs inheritance, it will inherit directly from Document.
- Document
Document Reference to the superclass object.
-
final
case class
ErpEngChangeOrder(ErpDocument: ErpDocument = null) extends Element with Product with Serializable
General Utility Engineering Change Order information.
General Utility Engineering Change Order information.
- ErpDocument
ErpDocument Reference to the superclass object.
-
final
case class
ErpIdentifiedObject(IdentifiedObject: IdentifiedObject = null) extends Element with Product with Serializable
Shadow class for IdentifiedObject, to isolate subclassing from this package.
Shadow class for IdentifiedObject, to isolate subclassing from this package.
If any subclass gets normative and needs inheritance, it will inherit directly from IdentifiedObject.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
-
final
case class
ErpInventory(ErpIdentifiedObject: ErpIdentifiedObject = null, status: String = null, Asset: String = null) extends Element with Product with Serializable
Utility inventory-related information about an item or part (and not for description of the item and its attributes).
Utility inventory-related information about an item or part (and not for description of the item and its attributes).
It is used by ERP applications to enable the synchronization of Inventory data that exists on separate Item Master databases. This data is not the master data that describes the attributes of the item such as dimensions, weight, or unit of measure - it describes the item as it exists at a specific location.
- ErpIdentifiedObject
ErpIdentifiedObject Reference to the superclass object.
- status
undocumented
- Asset
Asset undocumented
-
final
case class
ErpInventoryCount(ErpIdentifiedObject: ErpIdentifiedObject = null, status: String = null) extends Element with Product with Serializable
This is related to Inventory physical counts organized by AssetModel.
This is related to Inventory physical counts organized by AssetModel.
Note that a count of a type of asset can be accomplished by the association inherited by AssetModel (from Document) to Asset. It enables ERP applications to transfer an inventory count between ERP and the actual physical inventory location. This count may be a cycle count or a physical count.
- ErpIdentifiedObject
ErpIdentifiedObject Reference to the superclass object.
- status
undocumented
-
final
case class
ErpInvoice(ErpDocument: ErpDocument = null, amount: Double = 0.0, billMediaKind: String = null, dueDate: String = null, kind: String = null, mailedDate: String = null, proForma: Boolean = false, referenceNumber: String = null, transactionDateTime: String = null, transferType: String = null, CustomerAccount: String = null, ErpInvoiceLineItems: List[String] = null) extends Element with Product with Serializable
A roll up of invoice line items.
A roll up of invoice line items.
The whole invoice has a due date and amount to be paid, with information such as customer, banks etc. being obtained through associations. The invoice roll up is based on individual line items that each contain amounts and descriptions for specific services or products.
- ErpDocument
ErpDocument Reference to the superclass object.
- amount
Total amount due on this invoice based on line items and applicable adjustments.
- billMediaKind
Kind of media by which the CustomerBillingInfo was delivered.
- dueDate
Calculated date upon which the Invoice amount is due.
- kind
Kind of invoice (default is 'sales').
- mailedDate
Date on which the customer billing statement/invoice was printed/mailed.
- proForma
True if payment is to be paid by a Customer to accept a particular ErpQuote (with associated Design) and have work initiated, at which time an associated ErpInvoice should automatically be generated. EprPayment.subjectStatus satisfies terms specificed in the ErpQuote.
- referenceNumber
Number of an invoice to be reference by this invoice.
- transactionDateTime
Date and time when the invoice is issued.
- transferType
Type of invoice transfer.
- CustomerAccount
CustomerAccount undocumented
- ErpInvoiceLineItems
ErpInvoiceLineItem undocumented
-
final
case class
ErpInvoiceLineItem(ErpDocument: ErpDocument = null, billPeriod: String = null, glAccount: String = null, glDateTime: String = null, kind: String = null, lineAmount: Double = 0.0, lineNumber: String = null, lineVersion: String = null, netAmount: Double = 0.0, previousAmount: Double = 0.0, ComponentErpInvoiceLineItems: List[String] = null, ContainerErpInvoiceLineItem: String = null, CustomerBillingInfos: List[String] = null, ErpInvoice: String = null, ErpJournalEntries: List[String] = null, ErpPayableLineItem: String = null, ErpPayments: List[String] = null, ErpQuoteLineItem: String = null, ErpRecDelvLineItem: String = null, ErpRecLineItem: String = null, UserAttributes: List[String] = null, WorkBillingInfos: List[String] = null) extends Element with Product with Serializable
An individual line item on an invoice.
An individual line item on an invoice.
- ErpDocument
ErpDocument Reference to the superclass object.
- billPeriod
Bill period for the line item.
- glAccount
General Ledger account code, must be a valid combination.
- glDateTime
Date and time line item will be posted to the General Ledger.
- kind
Kind of line item.
- lineAmount
Amount due for this line item.
- lineNumber
Line item number on invoice statement.
- lineVersion
Version number of the bill run.
- netAmount
Net line item charge amount.
- previousAmount
Previous line item charge amount.
- ComponentErpInvoiceLineItems
ErpInvoiceLineItem undocumented
- ContainerErpInvoiceLineItem
ErpInvoiceLineItem undocumented
- CustomerBillingInfos
CustomerBillingInfo Customer billing for services rendered.
- ErpInvoice
ErpInvoice undocumented
- ErpJournalEntries
ErpJournalEntry undocumented
- ErpPayableLineItem
ErpPayableLineItem undocumented
- ErpPayments
ErpPayment undocumented
- ErpQuoteLineItem
ErpQuoteLineItem undocumented
- ErpRecDelvLineItem
ErpRecDelvLineItem undocumented
- ErpRecLineItem
ErpRecLineItem undocumented
- UserAttributes
UserAttribute undocumented
- WorkBillingInfos
WorkBillingInfo undocumented
-
final
case class
ErpIssueInventory(ErpIdentifiedObject: ErpIdentifiedObject = null, status: String = null, TypeAsset: String = null, TypeMaterial: String = null) extends Element with Product with Serializable
Can be used to request an application to process an issue or request information about an issue.
Can be used to request an application to process an issue or request information about an issue.
- ErpIdentifiedObject
ErpIdentifiedObject Reference to the superclass object.
- status
undocumented
- TypeAsset
CatalogAssetType undocumented
- TypeMaterial
TypeMaterial undocumented
-
final
case class
ErpItemMaster(ErpIdentifiedObject: ErpIdentifiedObject = null, status: String = null, Asset: String = null) extends Element with Product with Serializable
Any unique purchased part for manufactured product tracked by ERP systems for a utility.
Any unique purchased part for manufactured product tracked by ERP systems for a utility.
Item, as used by the OAG, refers to the basic information about an item, including its attributes, cost, and locations. It does not include item quantities. Compare to the Inventory, which includes all quantities and other location-specific information.
- ErpIdentifiedObject
ErpIdentifiedObject Reference to the superclass object.
- status
undocumented
- Asset
Asset undocumented
-
final
case class
ErpJournal(ErpDocument: ErpDocument = null, ErpJournalEntries: List[String] = null) extends Element with Product with Serializable
Book for recording accounting transactions as they occur.
Book for recording accounting transactions as they occur.
Transactions and adjustments are first recorded in a journal, which is like a diary of instructions, advising which account to be charged and by how much. A journal represents a change in the balances of a business's financial accounts. Many tasks or transactions throughout an enterprise will result in the creation of a journal. Some examples are creating a customer invoice, paying a vendor, transferring inventory, or paying employees.
- ErpDocument
ErpDocument Reference to the superclass object.
- ErpJournalEntries
ErpJournalEntry undocumented
-
final
case class
ErpJournalEntry(ErpIdentifiedObject: ErpIdentifiedObject = null, accountID: String = null, amount: Double = 0.0, postingDateTime: String = null, sourceID: String = null, status: String = null, transactionDateTime: String = null, CostTypes: List[String] = null, ErpInvoiceLineItem: String = null, ErpJournal: String = null, ErpLedgerEntry: String = null, ErpPayableLineItems: List[String] = null, ErpRecLineItems: List[String] = null) extends Element with Product with Serializable
Details of an individual entry in a journal, which is to be posted to a ledger on the posting date.
Details of an individual entry in a journal, which is to be posted to a ledger on the posting date.
- ErpIdentifiedObject
ErpIdentifiedObject Reference to the superclass object.
- accountID
Account identifier for this entry.
- amount
The amount of the debit or credit for this account.
- postingDateTime
Date and time this entry is to be posted to the ledger.
- sourceID
The identifer of the source for this entry.
- status
undocumented
- transactionDateTime
Date and time journal entry was recorded.
- CostTypes
CostType undocumented
- ErpInvoiceLineItem
ErpInvoiceLineItem undocumented
- ErpJournal
ErpJournal undocumented
- ErpLedgerEntry
ErpLedgerEntry undocumented
- ErpPayableLineItems
ErpPayableLineItem undocumented
- ErpRecLineItems
ErpRecLineItem undocumented
-
final
case class
ErpLedBudLineItem(ErpIdentifiedObject: ErpIdentifiedObject = null, status: String = null, ErpLedBudLineItem_attr: String = null, ErpLedgerBudget: String = null) extends Element with Product with Serializable
Individual entry of a given Ledger Budget, typically containing information such as amount, accounting date, accounting period, and is associated with the applicable general ledger account.
Individual entry of a given Ledger Budget, typically containing information such as amount, accounting date, accounting period, and is associated with the applicable general ledger account.
- ErpIdentifiedObject
ErpIdentifiedObject Reference to the superclass object.
- status
undocumented
- ErpLedBudLineItem_attr
ErpLedgerEntry undocumented
- ErpLedgerBudget
ErpLedgerBudget undocumented
-
final
case class
ErpLedger(ErpDocument: ErpDocument = null, ErpLedgerEntries: List[String] = null) extends Element with Product with Serializable
In accounting transactions, a ledger is a book containing accounts to which debits and credits are posted from journals, where transactions are initially recorded.
In accounting transactions, a ledger is a book containing accounts to which debits and credits are posted from journals, where transactions are initially recorded.
Journal entries are periodically posted to the ledger. Ledger Actual represents actual amounts by account within ledger within company or business area. Actual amounts may be generated in a source application and then loaded to a specific ledger within the enterprise general ledger or budget application.
- ErpDocument
ErpDocument Reference to the superclass object.
- ErpLedgerEntries
ErpLedgerEntry undocumented
-
final
case class
ErpLedgerBudget(ErpDocument: ErpDocument = null, ErpLedBudLineItems: List[String] = null) extends Element with Product with Serializable
Information for utility Ledger Budgets.
Information for utility Ledger Budgets.
They support the transfer budget amounts between all possible source applications throughout an enterprise and a general ledger or budget application.
- ErpDocument
ErpDocument Reference to the superclass object.
- ErpLedBudLineItems
ErpLedBudLineItem undocumented
-
final
case class
ErpLedgerEntry(ErpIdentifiedObject: ErpIdentifiedObject = null, accountID: String = null, accountKind: String = null, amount: Double = 0.0, postedDateTime: String = null, status: String = null, transactionDateTime: String = null, ErpJounalEntry: String = null, ErpLedger: String = null, ErpLedgerEntry_attr: String = null, UserAttributes: List[String] = null) extends Element with Product with Serializable
Details of an individual entry in a ledger, which was posted from a journal on the posted date.
Details of an individual entry in a ledger, which was posted from a journal on the posted date.
- ErpIdentifiedObject
ErpIdentifiedObject Reference to the superclass object.
- accountID
Account identifier for this entry.
- accountKind
Kind of account for this entry.
- amount
The amount of the debit or credit for this account.
- postedDateTime
Date and time this entry was posted to the ledger.
- status
undocumented
- transactionDateTime
Date and time journal entry was recorded.
- ErpJounalEntry
ErpJournalEntry undocumented
- ErpLedger
ErpLedger undocumented
- ErpLedgerEntry_attr
ErpLedBudLineItem undocumented
- UserAttributes
UserAttribute undocumented
-
final
case class
ErpPOLineItem(ErpDocument: ErpDocument = null, AssetModelCatalogueItem: String = null, ErpPurchaseOrder: String = null, ErpRecDelLineItem: String = null, ErpReqLineItem: String = null) extends Element with Product with Serializable
Of an ErpPurchaseOrder, this is an individually ordered item or product along with the quantity, price and other descriptive information.
Of an ErpPurchaseOrder, this is an individually ordered item or product along with the quantity, price and other descriptive information.
- ErpDocument
ErpDocument Reference to the superclass object.
- AssetModelCatalogueItem
AssetModelCatalogueItem undocumented
- ErpPurchaseOrder
ErpPurchaseOrder undocumented
- ErpRecDelLineItem
ErpRecDelvLineItem undocumented
- ErpReqLineItem
ErpReqLineItem undocumented
-
final
case class
ErpPayable(ErpDocument: ErpDocument = null, ContractorItems: List[String] = null, ErpPayableLineItems: List[String] = null) extends Element with Product with Serializable
A transaction that represents an invoice from a supplier.
A transaction that represents an invoice from a supplier.
A payable (or voucher) is an open item, approved and ready for payment, in the Accounts Payable ledger.
- ErpDocument
ErpDocument Reference to the superclass object.
- ContractorItems
ContractorItem undocumented
- ErpPayableLineItems
ErpPayableLineItem undocumented
-
final
case class
ErpPayableLineItem(ErpIdentifiedObject: ErpIdentifiedObject = null, status: String = null, ErpInvoiceLineItem: String = null, ErpJournalEntries: List[String] = null, ErpPayable: String = null, ErpPayments: List[String] = null) extends Element with Product with Serializable
Of an ErpPayable, a line item references an ErpInvoiceLineitem or other source such as credit memos.
Of an ErpPayable, a line item references an ErpInvoiceLineitem or other source such as credit memos.
- ErpIdentifiedObject
ErpIdentifiedObject Reference to the superclass object.
- status
undocumented
- ErpInvoiceLineItem
ErpInvoiceLineItem undocumented
- ErpJournalEntries
ErpJournalEntry undocumented
- ErpPayable
ErpPayable undocumented
- ErpPayments
ErpPayment undocumented
-
final
case class
ErpPayment(ErpDocument: ErpDocument = null, termsPayment: String = null, ErpInvoiceLineItems: List[String] = null, ErpPayableLineItems: List[String] = null, ErpRecLineItems: List[String] = null) extends Element with Product with Serializable
Payment infromation and status for any individual line item of an ErpInvoice (e.g., when payment is from a customer).
Payment infromation and status for any individual line item of an ErpInvoice (e.g., when payment is from a customer).
ErpPayable is also updated when payment is to a supplier and ErpReceivable is updated when payment is from a customer. Multiple payments can be made against a single line item and an individual payment can apply to more that one line item.
- ErpDocument
ErpDocument Reference to the superclass object.
- termsPayment
Payment terms (e.g., net 30).
- ErpInvoiceLineItems
ErpInvoiceLineItem undocumented
- ErpPayableLineItems
ErpPayableLineItem undocumented
- ErpRecLineItems
ErpRecLineItem undocumented
-
final
case class
ErpPersonnel(ErpIdentifiedObject: ErpIdentifiedObject = null, status: String = null, ErpPersons: List[String] = null) extends Element with Product with Serializable
Information that applies to the basic data about a utility person, used by ERP applications to transfer Personnel data for a worker.
Information that applies to the basic data about a utility person, used by ERP applications to transfer Personnel data for a worker.
- ErpIdentifiedObject
ErpIdentifiedObject Reference to the superclass object.
- status
undocumented
- ErpPersons
OldPerson undocumented
-
final
case class
ErpProjectAccounting(ErpDocument: ErpDocument = null, ErpTimeEntries: List[String] = null, Projects: List[String] = null, WorkCostDetails: List[String] = null, Works: List[String] = null) extends Element with Product with Serializable
Utility Project Accounting information, used by ERP applications to enable all relevant sub-systems that submit single sided transactions to transfer information with a Project Accounting Application.
Utility Project Accounting information, used by ERP applications to enable all relevant sub-systems that submit single sided transactions to transfer information with a Project Accounting Application.
This would include, but not necessarily be limited to: Accounts Payable, Accounts Receivable, Budget, Order Management, Purchasing, Time and Labor, Travel and Expense.
- ErpDocument
ErpDocument Reference to the superclass object.
- ErpTimeEntries
ErpTimeEntry undocumented
- Projects
Project undocumented
- WorkCostDetails
WorkCostDetail undocumented
- Works
Work undocumented
-
final
case class
ErpPurchaseOrder(ErpDocument: ErpDocument = null, ErpPOLineItems: List[String] = null) extends Element with Product with Serializable
A document that communicates an order to purchase goods from a buyer to a supplier.
A document that communicates an order to purchase goods from a buyer to a supplier.
The PurchaseOrder carries information to and from the buyer and supplier. It is a legally binding document once both Parties agree to the contents and the specified terms and conditions of the order.
- ErpDocument
ErpDocument Reference to the superclass object.
- ErpPOLineItems
ErpPOLineItem undocumented
-
final
case class
ErpQuote(ErpDocument: ErpDocument = null, ErpQuoteLineItems: List[String] = null) extends Element with Product with Serializable
Document describing the prices of goods or services provided by a supplier.
Document describing the prices of goods or services provided by a supplier.
It includes the terms of the purchase, delivery proposals, identification of goods or services ordered, as well as their quantities.
- ErpDocument
ErpDocument Reference to the superclass object.
- ErpQuoteLineItems
ErpQuoteLineItem undocumented
-
final
case class
ErpQuoteLineItem(ErpIdentifiedObject: ErpIdentifiedObject = null, status: String = null, AssetModelCatalogueItem: String = null, Design: String = null, ErpInvoiceLineItem: String = null, ErpQuote: String = null, ErpReqLineItem: String = null) extends Element with Product with Serializable
Of an ErpQuote, the item or product quoted along with quantity, price and other descriptive information.
Of an ErpQuote, the item or product quoted along with quantity, price and other descriptive information.
- ErpIdentifiedObject
ErpIdentifiedObject Reference to the superclass object.
- status
undocumented
- AssetModelCatalogueItem
AssetModelCatalogueItem undocumented
- Design
Design undocumented
- ErpInvoiceLineItem
ErpInvoiceLineItem Some utilities provide quotes to customer for services, where the customer accepts the quote by making a payment. An invoice is required for this to occur.
- ErpQuote
ErpQuote undocumented
- ErpReqLineItem
ErpReqLineItem undocumented
-
final
case class
ErpRecDelvLineItem(ErpIdentifiedObject: ErpIdentifiedObject = null, status: String = null, Assets: List[String] = null, ErpInvoiceLineItem: String = null, ErpPOLineItem: String = null, ErpReceiveDelivery: String = null) extends Element with Product with Serializable
Of an ErpReceiveDelivery, this is an individually received good or service by the Organisation receiving goods or services.
Of an ErpReceiveDelivery, this is an individually received good or service by the Organisation receiving goods or services.
It may be used to indicate receipt of goods in conjunction with a purchase order line item.
- ErpIdentifiedObject
ErpIdentifiedObject Reference to the superclass object.
- status
undocumented
- Assets
Asset undocumented
- ErpInvoiceLineItem
ErpInvoiceLineItem undocumented
- ErpPOLineItem
ErpPOLineItem undocumented
- ErpReceiveDelivery
ErpReceiveDelivery undocumented
-
final
case class
ErpRecLineItem(ErpIdentifiedObject: ErpIdentifiedObject = null, status: String = null, ErpInvoiceLineItem: String = null, ErpJournalEntries: List[String] = null, ErpPayments: List[String] = null, ErpReceivable: String = null) extends Element with Product with Serializable
Individual entry of an ErpReceivable, it is a particular transaction representing an invoice, credit memo or debit memo to a customer.
Individual entry of an ErpReceivable, it is a particular transaction representing an invoice, credit memo or debit memo to a customer.
- ErpIdentifiedObject
ErpIdentifiedObject Reference to the superclass object.
- status
undocumented
- ErpInvoiceLineItem
ErpInvoiceLineItem undocumented
- ErpJournalEntries
ErpJournalEntry undocumented
- ErpPayments
ErpPayment undocumented
- ErpReceivable
ErpReceivable undocumented
-
final
case class
ErpReceivable(ErpDocument: ErpDocument = null, ErpRecLineItems: List[String] = null) extends Element with Product with Serializable
Transaction representing an invoice, credit memo or debit memo to a customer.
Transaction representing an invoice, credit memo or debit memo to a customer.
It is an open (unpaid) item in the Accounts Receivable ledger.
- ErpDocument
ErpDocument Reference to the superclass object.
- ErpRecLineItems
ErpRecLineItem undocumented
-
final
case class
ErpReceiveDelivery(ErpDocument: ErpDocument = null, ErpRecDelvLineItems: List[String] = null) extends Element with Product with Serializable
Transaction for an Organisation receiving goods or services that may be used to indicate receipt of goods in conjunction with a purchase order.
Transaction for an Organisation receiving goods or services that may be used to indicate receipt of goods in conjunction with a purchase order.
A receivable is an open (unpaid) item in the Accounts Receivable ledger.
- ErpDocument
ErpDocument Reference to the superclass object.
- ErpRecDelvLineItems
ErpRecDelvLineItem undocumented
-
final
case class
ErpReqLineItem(ErpIdentifiedObject: ErpIdentifiedObject = null, code: String = null, cost: Double = 0.0, deliveryDate: String = null, quantity: Int = 0, status: String = null, ErpPOLineItem: String = null, ErpQuoteLineItem: String = null, ErpRequisition: String = null, TypeAsset: String = null, TypeMaterial: String = null) extends Element with Product with Serializable
Information that describes a requested item and its attributes.
Information that describes a requested item and its attributes.
- ErpIdentifiedObject
ErpIdentifiedObject Reference to the superclass object.
- code
undocumented
- cost
Cost of material.
- deliveryDate
undocumented
- quantity
Quantity of item requisitioned.
- status
undocumented
- ErpPOLineItem
ErpPOLineItem undocumented
- ErpQuoteLineItem
ErpQuoteLineItem undocumented
- ErpRequisition
ErpRequisition undocumented
- TypeAsset
CatalogAssetType undocumented
- TypeMaterial
TypeMaterial undocumented
-
final
case class
ErpRequisition(ErpDocument: ErpDocument = null, ErpReqLineItems: List[String] = null) extends Element with Product with Serializable
General information that applies to a utility requisition that is a request for the purchase of goods or services.
General information that applies to a utility requisition that is a request for the purchase of goods or services.
Typically, a requisition leads to the creation of a purchase order to a specific supplier.
- ErpDocument
ErpDocument Reference to the superclass object.
- ErpReqLineItems
ErpReqLineItem undocumented
-
final
case class
ErpSalesOrder(ErpDocument: ErpDocument = null) extends Element with Product with Serializable
General purpose Sales Order is used for utility service orders, etc.
General purpose Sales Order is used for utility service orders, etc.
As used by the OAG, the SalesOrder is a step beyond a PurchaseOrder in that the receiving entity of the order also communicates SalesInformoration about the Order along with the Order itself.
- ErpDocument
ErpDocument Reference to the superclass object.
-
final
case class
ErpSiteLevelData(ErpIdentifiedObject: ErpIdentifiedObject = null, status: String = null, LandProperty: String = null) extends Element with Product with Serializable
For a utility, general information that describes physical locations of organizations or the location codes and their meanings.
For a utility, general information that describes physical locations of organizations or the location codes and their meanings.
This enables ERP applications to ensure that the physical location identifiers are synchronized between the business applications.
- ErpIdentifiedObject
ErpIdentifiedObject Reference to the superclass object.
- status
undocumented
- LandProperty
LandProperty undocumented
-
final
case class
ErpTimeEntry(ErpIdentifiedObject: ErpIdentifiedObject = null, status: String = null, ErpProjectAccounting: String = null, ErpTimeSheet: String = null) extends Element with Product with Serializable
An individual entry on an ErpTimeSheet.
An individual entry on an ErpTimeSheet.
- ErpIdentifiedObject
ErpIdentifiedObject Reference to the superclass object.
- status
undocumented
- ErpProjectAccounting
ErpProjectAccounting undocumented
- ErpTimeSheet
ErpTimeSheet undocumented
-
final
case class
ErpTimeSheet(ErpDocument: ErpDocument = null, ErpTimeEntries: List[String] = null) extends Element with Product with Serializable
Time sheet for employees and contractors.
Time sheet for employees and contractors.
Note that ErpTimeSheet inherits the relationship to ErpPerson from Document.
- ErpDocument
ErpDocument Reference to the superclass object.
- ErpTimeEntries
ErpTimeEntry undocumented
-
final
case class
EstimatedRestorationTime(Element: BasicElement = null, confidenceKind: String = null, ert: String = null, ertSource: String = null, Outage: List[String] = null) extends Element with Product with Serializable
The Estimated Restoration Time for a single outage
The Estimated Restoration Time for a single outage
- Element
Reference to the superclass object.
- confidenceKind
provides the confidence level that this ERT can be accomplished. This may be changed/updated as needed.
- ert
estimated time the outage will be restored
- ertSource
defines the source that provided the ERT value.
- Outage
Outage undocumented
-
final
case class
ExPostLoss(MarketFactors: MarketFactors = null, ExPostLossResults: List[String] = null) extends Element with Product with Serializable
Model of ex-post calcultion of MW losses.
Model of ex-post calcultion of MW losses.
- MarketFactors
MarketFactors Reference to the superclass object.
- ExPostLossResults
ExPostLossResults undocumented
-
final
case class
ExPostLossResults(Element: BasicElement = null, ehvLossMW: Double = 0.0, totalLossMW: Double = 0.0, ExPostLoss: String = null, SubControlArea: String = null) extends Element with Product with Serializable
Model results of ex-post calculation of MW losses.
Model results of ex-post calculation of MW losses.
Summarizes loss in two categories losses on the the extra high voltage transmission and total losses. Calculated for each subcontrol area.
- Element
Reference to the superclass object.
- ehvLossMW
EHV MW losses in the company Attribute Usage: Information purposes - Output of LPA engine.
- totalLossMW
Total MW losses in the company Attribute Usage: Information purposes - Output of LPA engine.
- ExPostLoss
ExPostLoss undocumented
- SubControlArea
SubControlArea undocumented
-
final
case class
ExPostMarketRegion(MarketFactors: MarketFactors = null, ExPostMarketRegionResults: String = null) extends Element with Product with Serializable
Model of ex-post calculation of cleared MW on a regional basis.
Model of ex-post calculation of cleared MW on a regional basis.
- MarketFactors
MarketFactors Reference to the superclass object.
- ExPostMarketRegionResults
ExPostMarketRegionResults undocumented
-
final
case class
ExPostMarketRegionResults(Element: BasicElement = null, exPostClearedPrice: Double = 0.0, ExPostMarketRegion: String = null, MarketRegion: String = null) extends Element with Product with Serializable
Model of expost calculation of cleared MW on a region basis.
Model of expost calculation of cleared MW on a region basis.
Includes cleared price.
- Element
Reference to the superclass object.
- exPostClearedPrice
undocumented
- ExPostMarketRegion
ExPostMarketRegion undocumented
- MarketRegion
MarketRegion undocumented
-
final
case class
ExPostPricing(MarketFactors: MarketFactors = null, energyPrice: Double = 0.0, ExPostResults: List[String] = null) extends Element with Product with Serializable
Model of ex-post pricing of nodes.
Model of ex-post pricing of nodes.
- MarketFactors
MarketFactors Reference to the superclass object.
- energyPrice
market energy price
- ExPostResults
ExPostPricingResults undocumented
-
final
case class
ExPostPricingResults(Element: BasicElement = null, congestLMP: Double = 0.0, lmp: Double = 0.0, lossLMP: Double = 0.0, ExPostPricing: String = null, Pnode: String = null) extends Element with Product with Serializable
Model of ex-post pricing of nodes.
Model of ex-post pricing of nodes.
Includes LMP information, pnode based.
- Element
Reference to the superclass object.
- congestLMP
Congestion component of Location Marginal Price (LMP) in monetary units per MW; congestion component of the hourly LMP at a specific pricing node Attribute Usage: Result of the Security, Pricing, and Dispatch(SPD)/Simultaneous Feasibility Test(SFT) software and denotes the hourly congestion component of LMP for each pricing node.
- lmp
5 min weighted average LMP; the Location Marginal Price of the Pnode for which price calculation is carried out. Attribute Usage: 5 min weighted average LMP to be displayed on UI
- lossLMP
Loss component of Location Marginal Price (LMP) in monetary units per MW; loss component of the hourly LMP at a specific pricing node Attribute Usage: Result of the Security, Pricing, and Dispatch(SPD)/Simultaneous Feasibility Test(SFT) software and denotes the hourly loss component of LMP for each pricing node.
- ExPostPricing
ExPostPricing undocumented
- Pnode
Pnode undocumented
-
final
case class
ExPostResource(MarketFactors: MarketFactors = null, ExPostResourceResults: List[String] = null) extends Element with Product with Serializable
Model of ex-post pricing of resources.
Model of ex-post pricing of resources.
- MarketFactors
MarketFactors Reference to the superclass object.
- ExPostResourceResults
ExPostResourceResults undocumented
-
final
case class
ExPostResourceResults(Element: BasicElement = null, congestionLMP: Double = 0.0, desiredMW: Double = 0.0, dispatchRate: Double = 0.0, lmp: Double = 0.0, lossLMP: Double = 0.0, maxEconomicMW: Double = 0.0, minEconomicMW: Double = 0.0, resourceMW: Double = 0.0, status: String = null, ExPostResource: String = null, RegisteredResource: String = null) extends Element with Product with Serializable
Model of ex-post pricing of resources contains components of LMPs: energy, congestion, loss.
Model of ex-post pricing of resources contains components of LMPs: energy, congestion, loss.
Resource based.
- Element
Reference to the superclass object.
- congestionLMP
LMP component in USD (deprecated)
- desiredMW
Desired output of unit
- dispatchRate
Unit Dispatch rate from real time unit dispatch.
- lmp
LMP (Local Marginal Price) in USD at the equipment (deprecated)
- lossLMP
loss lmp (deprecated)
- maxEconomicMW
Economic Maximum MW
- minEconomicMW
Economic Minimum MW
- resourceMW
Current MW output of the equipment Attribute Usage: Information purposes - Information purposes - Output of LPA engine.
- status
Status of equipment
- ExPostResource
ExPostResource undocumented
- RegisteredResource
RegisteredResource undocumented
-
final
case class
ExcAC1A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, hvlvgates: Boolean = false, ka: Double = 0.0, kc: Double = 0.0, kd: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, kf1: Double = 0.0, kf2: Double = 0.0, ks: Double = 0.0, seve1: Double = 0.0, seve2: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, vamax: Double = 0.0, vamin: Double = 0.0, ve1: Double = 0.0, ve2: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
Modified IEEE AC1A alternator-supplied rectifier excitation system with different rate feedback source.
Modified IEEE AC1A alternator-supplied rectifier excitation system with different rate feedback source.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- hvlvgates
Indicates if both HV gate and LV gate are active (HVLVgates). true = gates are used false = gates are not used. Typical value = true.
- ka
Voltage regulator gain (Ka) (> 0). Typical value = 400.
- kc
Rectifier loading factor proportional to commutating reactance (Kc) (>= 0). Typical value = 0,2.
- kd
Demagnetizing factor, a function of exciter alternator reactances (Kd) (>= 0). Typical value = 0,38.
- ke
Exciter constant related to self-excited field (Ke). Typical value = 1.
- kf
Excitation control system stabilizer gains (Kf) (>= 0). Typical value = 0,03.
- kf1
Coefficient to allow different usage of the model (Kf1) (>= 0). Typical value = 0.
- kf2
Coefficient to allow different usage of the model (Kf2) (>= 0). Typical value = 1.
- ks
Coefficient to allow different usage of the model-speed coefficient (Ks) (>= 0). Typical value = 0.
- seve1
Exciter saturation function value at the corresponding exciter voltage, Ve1, back of commutating reactance (Se[Ve1]) (>= 0). Typical value = 0,1.
- seve2
Exciter saturation function value at the corresponding exciter voltage, Ve2, back of commutating reactance (Se[Ve2]) (>= 0). Typical value = 0,03.
- ta
Voltage regulator time constant (Ta) (> 0). Typical value = 0,02.
- tb
Voltage regulator time constant (Tb) (>= 0). Typical value = 0.
- tc
Voltage regulator time constant (Tc) (>= 0). Typical value = 0.
- te
Exciter time constant, integration rate associated with exciter control (Te) (> 0). Typical value = 0,8.
- tf
Excitation control system stabilizer time constant (Tf) (> 0). Typical value = 1.
- vamax
Maximum voltage regulator output (Vamax) (> 0). Typical value = 14,5.
- vamin
Minimum voltage regulator output (Vamin) (< 0). Typical value = -14,5.
- ve1
Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve1) (> 0). Typical value = 4,18.
- ve2
Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve2) (> 0). Typical value = 3,14.
- vrmax
Maximum voltage regulator outputs (Vrmax) (> 0). Typical value = 6,03.
- vrmin
Minimum voltage regulator outputs (Vrmin) (< 0). Typical value = -5,43.
-
final
case class
ExcAC2A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, hvgate: Boolean = false, ka: Double = 0.0, kb: Double = 0.0, kb1: Double = 0.0, kc: Double = 0.0, kd: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, kh: Double = 0.0, kl: Double = 0.0, kl1: Double = 0.0, ks: Double = 0.0, lvgate: Boolean = false, seve1: Double = 0.0, seve2: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, vamax: Double = 0.0, vamin: Double = 0.0, ve1: Double = 0.0, ve2: Double = 0.0, vfemax: Double = 0.0, vlr: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
Modified IEEE AC2A alternator-supplied rectifier excitation system with different field current limit.
Modified IEEE AC2A alternator-supplied rectifier excitation system with different field current limit.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- hvgate
Indicates if HV gate is active (HVgate). true = gate is used false = gate is not used. Typical value = true.
- ka
Voltage regulator gain (Ka) (> 0). Typical value = 400.
- kb
Second stage regulator gain (Kb) (> 0). Exciter field current controller gain. Typical value = 25.
- kb1
Second stage regulator gain (Kb1). It is exciter field current controller gain used as alternative to Kb to represent a variant of the ExcAC2A model. Typical value = 25.
- kc
Rectifier loading factor proportional to commutating reactance (Kc) (>= 0). Typical value = 0,28.
- kd
Demagnetizing factor, a function of exciter alternator reactances (Kd) (>= 0). Typical value = 0,35.
- ke
Exciter constant related to self-excited field (Ke). Typical value = 1.
- kf
Excitation control system stabilizer gains (Kf) (>= 0). Typical value = 0,03.
- kh
Exciter field current feedback gain (Kh) (>= 0). Typical value = 1.
- kl
Exciter field current limiter gain (Kl). Typical value = 10.
- kl1
Coefficient to allow different usage of the model (Kl1). Typical value = 1.
- ks
Coefficient to allow different usage of the model-speed coefficient (Ks) (>= 0). Typical value = 0.
- lvgate
Indicates if LV gate is active (LVgate). true = gate is used false = gate is not used. Typical value = true.
- seve1
Exciter saturation function value at the corresponding exciter voltage, Ve1, back of commutating reactance (Se[Ve1]) (>= 0). Typical value = 0,037.
- seve2
Exciter saturation function value at the corresponding exciter voltage, Ve2, back of commutating reactance (Se[Ve2]) (>= 0). Typical value = 0,012.
- ta
Voltage regulator time constant (Ta) (> 0). Typical value = 0,02.
- tb
Voltage regulator time constant (Tb) (>= 0). Typical value = 0.
- tc
Voltage regulator time constant (Tc) (>= 0). Typical value = 0.
- te
Exciter time constant, integration rate associated with exciter control (Te) (> 0). Typical value = 0,6.
- tf
Excitation control system stabilizer time constant (Tf) (> 0). Typical value = 1.
- vamax
Maximum voltage regulator output (Vamax) (> 0). Typical value = 8.
- vamin
Minimum voltage regulator output (Vamin) (< 0). Typical value = -8.
- ve1
Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve1) (> 0). Typical value = 4,4.
- ve2
Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve2) (> 0). Typical value = 3,3.
- vfemax
Exciter field current limit reference (Vfemax) (>= 0). Typical value = 4,4.
- vlr
Maximum exciter field current (Vlr) (> 0). Typical value = 4,4.
- vrmax
Maximum voltage regulator outputs (Vrmax) (> 0). Typical value = 105.
- vrmin
Minimum voltage regulator outputs (Vrmin) (< 0). Typical value = -95.
-
final
case class
ExcAC3A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efdn: Double = 0.0, ka: Double = 0.0, kc: Double = 0.0, kd: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, kf1: Double = 0.0, kf2: Double = 0.0, klv: Double = 0.0, kn: Double = 0.0, kr: Double = 0.0, ks: Double = 0.0, seve1: Double = 0.0, seve2: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, vamax: Double = 0.0, vamin: Double = 0.0, ve1: Double = 0.0, ve2: Double = 0.0, vemin: Double = 0.0, vfemax: Double = 0.0, vlv: Double = 0.0) extends Element with Product with Serializable
Modified IEEE AC3A alternator-supplied rectifier excitation system with different field current limit.
Modified IEEE AC3A alternator-supplied rectifier excitation system with different field current limit.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- efdn
Value of Efd at which feedback gain changes (Efdn) (> 0). Typical value = 2,36.
- ka
Voltage regulator gain (Ka) (> 0). Typical value = 45,62.
- kc
Rectifier loading factor proportional to commutating reactance (Kc) (>= 0). Typical value = 0,104.
- kd
Demagnetizing factor, a function of exciter alternator reactances (Kd) (>= 0). Typical value = 0,499.
- ke
Exciter constant related to self-excited field (Ke). Typical value = 1.
- kf
Excitation control system stabilizer gains (Kf) (>= 0). Typical value = 0,143.
- kf1
Coefficient to allow different usage of the model (Kf1). Typical value = 1.
- kf2
Coefficient to allow different usage of the model (Kf2). Typical value = 0.
- klv
Gain used in the minimum field voltage limiter loop (Klv). Typical value = 0,194.
- kn
Excitation control system stabilizer gain (Kn) (>= 0). Typical value =0,05.
- kr
Constant associated with regulator and alternator field power supply (Kr) (> 0). Typical value =3,77.
- ks
Coefficient to allow different usage of the model-speed coefficient (Ks). Typical value = 0.
- seve1
Exciter saturation function value at the corresponding exciter voltage, Ve1, back of commutating reactance (Se[Ve1]) (>= 0). Typical value = 1,143.
- seve2
Exciter saturation function value at the corresponding exciter voltage, Ve2, back of commutating reactance (Se[Ve2]) (>= 0). Typical value = 0,1.
- ta
Voltage regulator time constant (Ta) (> 0). Typical value = 0,013.
- tb
Voltage regulator time constant (Tb) (>= 0). Typical value = 0.
- tc
Voltage regulator time constant (Tc) (>= 0). Typical value = 0.
- te
Exciter time constant, integration rate associated with exciter control (Te) (> 0). Typical value = 1,17.
- tf
Excitation control system stabilizer time constant (Tf) (> 0). Typical value = 1.
- vamax
Maximum voltage regulator output (Vamax) (> 0). Typical value = 1.
- vamin
Minimum voltage regulator output (Vamin) (< 0). Typical value = -0,95.
- ve1
Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve1) (> 0). Typical value = 6.24.
- ve2
Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve2) (> 0). Typical value = 4,68.
- vemin
Minimum exciter voltage output (Vemin) (<= 0). Typical value = 0.
- vfemax
Exciter field current limit reference (Vfemax) (>= 0). Typical value = 16.
- vlv
Field voltage used in the minimum field voltage limiter loop (Vlv). Typical value = 0,79.
-
final
case class
ExcAC4A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, ka: Double = 0.0, kc: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, vimax: Double = 0.0, vimin: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
Modified IEEE AC4A alternator-supplied rectifier excitation system with different minimum controller output.
Modified IEEE AC4A alternator-supplied rectifier excitation system with different minimum controller output.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- ka
Voltage regulator gain (Ka) (> 0). Typical value = 200.
- kc
Rectifier loading factor proportional to commutating reactance (Kc) (>= 0). Typical value = 0.
- ta
Voltage regulator time constant (Ta) (> 0). Typical value = 0,015.
- tb
Voltage regulator time constant (Tb) (>= 0). Typical value = 10.
- tc
Voltage regulator time constant (Tc) (>= 0). Typical value = 1.
- vimax
Maximum voltage regulator input limit (Vimax) (> 0). Typical value = 10.
- vimin
Minimum voltage regulator input limit (Vimin) (< 0). Typical value = -10.
- vrmax
Maximum voltage regulator output (Vrmax) (> 0). Typical value = 5,64.
- vrmin
Minimum voltage regulator output (Vrmin) (< 0). Typical value = -4,53.
-
final
case class
ExcAC5A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, a: Double = 0.0, efd1: Double = 0.0, efd2: Double = 0.0, ka: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, ks: Double = 0.0, seefd1: Double = 0.0, seefd2: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, te: Double = 0.0, tf1: Double = 0.0, tf2: Double = 0.0, tf3: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
Modified IEEE AC5A alternator-supplied rectifier excitation system with different minimum controller output.
Modified IEEE AC5A alternator-supplied rectifier excitation system with different minimum controller output.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- a
Coefficient to allow different usage of the model (a). Typical value = 1.
- efd1
Exciter voltage at which exciter saturation is defined (Efd1) (> 0). Typical value = 5,6.
- efd2
Exciter voltage at which exciter saturation is defined (Efd2) (> 0). Typical value = 4,2.
- ka
Voltage regulator gain (Ka) (> 0). Typical value = 400.
- ke
Exciter constant related to self-excited field (Ke). Typical value = 1.
- kf
Excitation control system stabilizer gains (Kf) (>= 0). Typical value = 0,03.
- ks
Coefficient to allow different usage of the model-speed coefficient (Ks). Typical value = 0.
- seefd1
Exciter saturation function value at the corresponding exciter voltage, Efd1 (Se[Efd1]) (>= 0). Typical value = 0,86.
- seefd2
Exciter saturation function value at the corresponding exciter voltage, Efd2 (Se[Efd2]) (>= 0). Typical value = 0,5.
- ta
Voltage regulator time constant (Ta) (> 0). Typical value = 0,02.
- tb
Voltage regulator time constant (Tb) (>= 0). Typical value = 0.
- tc
Voltage regulator time constant (Tc) (>= 0). Typical value = 0.
- te
Exciter time constant, integration rate associated with exciter control (Te) (> 0). Typical value = 0,8.
- tf1
Excitation control system stabilizer time constant (Tf1) (> 0). Typical value = 1.
- tf2
Excitation control system stabilizer time constant (Tf2) (>= 0). Typical value = 0,8.
- tf3
Excitation control system stabilizer time constant (Tf3) (>= 0). Typical value = 0.
- vrmax
Maximum voltage regulator output (Vrmax) (> 0). Typical value = 7,3.
- vrmin
Minimum voltage regulator output (Vrmin) (< 0). Typical value =-7,3.
-
final
case class
ExcAC6A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, ka: Double = 0.0, kc: Double = 0.0, kd: Double = 0.0, ke: Double = 0.0, kh: Double = 0.0, ks: Double = 0.0, seve1: Double = 0.0, seve2: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, te: Double = 0.0, th: Double = 0.0, tj: Double = 0.0, tk: Double = 0.0, vamax: Double = 0.0, vamin: Double = 0.0, ve1: Double = 0.0, ve2: Double = 0.0, vfelim: Double = 0.0, vhmax: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
Modified IEEE AC6A alternator-supplied rectifier excitation system with speed input.
Modified IEEE AC6A alternator-supplied rectifier excitation system with speed input.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- ka
Voltage regulator gain (Ka) (> 0). Typical value = 536.
- kc
Rectifier loading factor proportional to commutating reactance (Kc) (>= 0). Typical value = 0,173.
- kd
Demagnetizing factor, a function of exciter alternator reactances (Kd) (>= 0). Typical value = 1,91.
- ke
Exciter constant related to self-excited field (Ke). Typical value = 1,6.
- kh
Exciter field current limiter gain (Kh) (>= 0). Typical value = 92.
- ks
Coefficient to allow different usage of the model-speed coefficient (Ks). Typical value = 0.
- seve1
Exciter saturation function value at the corresponding exciter voltage, Ve1, back of commutating reactance (Se[Ve1]) (>= 0). Typical value = 0,214.
- seve2
Exciter saturation function value at the corresponding exciter voltage, Ve2, back of commutating reactance (Se[Ve2]) (>= 0). Typical value = 0,044.
- ta
Voltage regulator time constant (Ta) (>= 0). Typical value = 0,086.
- tb
Voltage regulator time constant (Tb) (>= 0). Typical value = 9.
- tc
Voltage regulator time constant (Tc) (>= 0). Typical value = 3.
- te
Exciter time constant, integration rate associated with exciter control (Te) (> 0). Typical value = 1.
- th
Exciter field current limiter time constant (Th) (> 0). Typical value = 0,08.
- tj
Exciter field current limiter time constant (Tj) (>= 0). Typical value = 0,02.
- tk
Voltage regulator time constant (Tk) (>= 0). Typical value = 0,18.
- vamax
Maximum voltage regulator output (Vamax) (> 0). Typical value = 75.
- vamin
Minimum voltage regulator output (Vamin) (< 0). Typical value = -75.
- ve1
Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve1) (> 0). Typical value = 7,4.
- ve2
Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve2) (> 0). Typical value = 5,55.
- vfelim
Exciter field current limit reference (Vfelim) (> 0). Typical value = 19.
- vhmax
Maximum field current limiter signal reference (Vhmax) (> 0). Typical value = 75.
- vrmax
Maximum voltage regulator output (Vrmax) (> 0). Typical value = 44.
- vrmin
Minimum voltage regulator output (Vrmin) (< 0). Typical value = -36.
-
final
case class
ExcAC8B(ExcitationSystemDynamics: ExcitationSystemDynamics = null, inlim: Boolean = false, ka: Double = 0.0, kc: Double = 0.0, kd: Double = 0.0, kdr: Double = 0.0, ke: Double = 0.0, kir: Double = 0.0, kpr: Double = 0.0, ks: Double = 0.0, pidlim: Boolean = false, seve1: Double = 0.0, seve2: Double = 0.0, ta: Double = 0.0, tdr: Double = 0.0, te: Double = 0.0, telim: Boolean = false, ve1: Double = 0.0, ve2: Double = 0.0, vemin: Double = 0.0, vfemax: Double = 0.0, vimax: Double = 0.0, vimin: Double = 0.0, vpidmax: Double = 0.0, vpidmin: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0, vtmult: Boolean = false) extends Element with Product with Serializable
Modified IEEE AC8B alternator-supplied rectifier excitation system with speed input and input limiter.
Modified IEEE AC8B alternator-supplied rectifier excitation system with speed input and input limiter.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- inlim
Input limiter indicator. true = input limiter Vimax and Vimin is considered false = input limiter Vimax and Vimin is not considered. Typical value = true.
- ka
Voltage regulator gain (Ka) (> 0). Typical value = 1.
- kc
Rectifier loading factor proportional to commutating reactance (Kc) (>= 0). Typical value = 0,55.
- kd
Demagnetizing factor, a function of exciter alternator reactances (Kd) (>= 0). Typical value = 1,1.
- kdr
Voltage regulator derivative gain (Kdr) (>= 0). Typical value = 10.
- ke
Exciter constant related to self-excited field (Ke). Typical value = 1.
- kir
Voltage regulator integral gain (Kir) (>= 0). Typical value = 5.
- kpr
Voltage regulator proportional gain (Kpr) (> 0 if ExcAC8B.kir = 0). Typical value = 80.
- ks
Coefficient to allow different usage of the model-speed coefficient (Ks). Typical value = 0.
- pidlim
PID limiter indicator. true = input limiter Vpidmax and Vpidmin is considered false = input limiter Vpidmax and Vpidmin is not considered. Typical value = true.
- seve1
Exciter saturation function value at the corresponding exciter voltage, Ve1, back of commutating reactance (Se[Ve1]) (>= 0). Typical value = 0,3.
- seve2
Exciter saturation function value at the corresponding exciter voltage, Ve2, back of commutating reactance (Se[Ve2]) (>= 0). Typical value = 3.
- ta
Voltage regulator time constant (Ta) (>= 0). Typical value = 0.
- tdr
Lag time constant (Tdr) (> 0 if ExcAC8B.kdr > 0). Typical value = 0,1.
- te
Exciter time constant, integration rate associated with exciter control (Te) (> 0). Typical value = 1,2.
- telim
Selector for the limiter on the block (1/sTe). See diagram for meaning of true and false. Typical value = false.
- ve1
Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve1) (> 0). Typical value = 6,5.
- ve2
Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve2) (> 0). Typical value = 9.
- vemin
Minimum exciter voltage output (Vemin) (<= 0). Typical value = 0.
- vfemax
Exciter field current limit reference (Vfemax). Typical value = 6.
- vimax
Input signal maximum (Vimax) (> ExcAC8B.vimin). Typical value = 35.
- vimin
Input signal minimum (Vimin) (< ExcAC8B.vimax). Typical value = -10.
- vpidmax
PID maximum controller output (Vpidmax) (> ExcAC8B.vpidmin). Typical value = 35.
- vpidmin
PID minimum controller output (Vpidmin) (< ExcAC8B.vpidmax). Typical value = -10.
- vrmax
Maximum voltage regulator output (Vrmax) (> 0). Typical value = 35.
- vrmin
Minimum voltage regulator output (Vrmin) (< 0). Typical value = 0.
- vtmult
Multiply by generator's terminal voltage indicator. true =the limits Vrmax and Vrmin are multiplied by the generator’s terminal voltage to represent a thyristor power stage fed from the generator terminals false = limits are not multiplied by generator's terminal voltage. Typical value = false.
-
final
case class
ExcANS(ExcitationSystemDynamics: ExcitationSystemDynamics = null, blint: Int = 0, ifmn: Double = 0.0, ifmx: Double = 0.0, k2: Double = 0.0, k3: Double = 0.0, kce: Double = 0.0, krvecc: Int = 0, kvfif: Int = 0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, tb: Double = 0.0, vrmn: Double = 0.0, vrmx: Double = 0.0) extends Element with Product with Serializable
Italian excitation system.
Italian excitation system.
It represents static field voltage or excitation current feedback excitation system.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- blint
Governor control flag (BLINT). 0 = lead-lag regulator 1 = proportional integral regulator. Typical value = 0.
- ifmn
Minimum exciter current (IFMN). Typical value = -5,2.
- ifmx
Maximum exciter current (IFMX). Typical value = 6,5.
- k2
Exciter gain (K2). Typical value = 20.
- k3
AVR gain (K3). Typical value = 1000.
- kce
Ceiling factor (KCE). Typical value = 1.
- krvecc
Feedback enabling (KRVECC). 0 = open loop control 1 = closed loop control. Typical value = 1.
- kvfif
Rate feedback signal flag (KVFIF). 0 = output voltage of the exciter 1 = exciter field current. Typical value = 0.
- t1
Time constant (T1) (>= 0). Typical value = 20.
- t2
Time constant (T2) (>= 0). Typical value = 0,05.
- t3
Time constant (T3) (>= 0). Typical value = 1,6.
- tb
Exciter time constant (TB) (>= 0). Typical value = 0,04.
- vrmn
Minimum AVR output (VRMN). Typical value = -5,2.
- vrmx
Maximum AVR output (VRMX). Typical value = 6,5.
-
final
case class
ExcAVR1(ExcitationSystemDynamics: ExcitationSystemDynamics = null, e1: Double = 0.0, e2: Double = 0.0, ka: Double = 0.0, kf: Double = 0.0, se1: Double = 0.0, se2: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, vrmn: Double = 0.0, vrmx: Double = 0.0) extends Element with Product with Serializable
Italian excitation system corresponding to IEEE (1968) type 1 model.
Italian excitation system corresponding to IEEE (1968) type 1 model.
It represents an exciter dynamo and electromechanical regulator.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- e1
Field voltage value 1 (E1). Typical value = 4.18.
- e2
Field voltage value 2 (E2). Typical value = 3,14.
- ka
AVR gain (KA). Typical value = 500.
- kf
Rate feedback gain (KF). Typical value = 0,12.
- se1
Saturation factor at E1 (S[E1]). Typical value = 0,1.
- se2
Saturation factor at E2 (S[E2]). Typical value = 0,03.
- ta
AVR time constant (TA) (>= 0). Typical value = 0,2.
- tb
AVR time constant (TB) (>= 0). Typical value = 0.
- te
Exciter time constant (TE) (>= 0). Typical value = 1.
- tf
Rate feedback time constant (TF) (>= 0). Typical value = 1.
- vrmn
Minimum AVR output (VRMN). Typical value = -6.
- vrmx
Maximum AVR output (VRMX). Typical value = 7.
-
final
case class
ExcAVR2(ExcitationSystemDynamics: ExcitationSystemDynamics = null, e1: Double = 0.0, e2: Double = 0.0, ka: Double = 0.0, kf: Double = 0.0, se1: Double = 0.0, se2: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, te: Double = 0.0, tf1: Double = 0.0, tf2: Double = 0.0, vrmn: Double = 0.0, vrmx: Double = 0.0) extends Element with Product with Serializable
Italian excitation system corresponding to IEEE (1968) type 2 model.
Italian excitation system corresponding to IEEE (1968) type 2 model.
It represents an alternator and rotating diodes and electromechanic voltage regulators.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- e1
Field voltage value 1 (E1). Typical value = 4,18.
- e2
Field voltage value 2 (E2). Typical value = 3,14.
- ka
AVR gain (KA). Typical value = 500.
- kf
Rate feedback gain (KF). Typical value = 0,12.
- se1
Saturation factor at E1 (S[E1]). Typical value = 0.1.
- se2
Saturation factor at E2 (S[E2]). Typical value = 0,03.
- ta
AVR time constant (TA) (>= 0). Typical value = 0,02.
- tb
AVR time constant (TB) (>= 0). Typical value = 0.
- te
Exciter time constant (TE) (>= 0). Typical value = 1.
- tf1
Rate feedback time constant (TF1) (>= 0). Typical value = 1.
- tf2
Rate feedback time constant (TF2) (>= 0). Typical value = 1.
- vrmn
Minimum AVR output (VRMN). Typical value = -6.
- vrmx
Maximum AVR output (VRMX). Typical value = 7.
-
final
case class
ExcAVR3(ExcitationSystemDynamics: ExcitationSystemDynamics = null, e1: Double = 0.0, e2: Double = 0.0, ka: Double = 0.0, se1: Double = 0.0, se2: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, te: Double = 0.0, vrmn: Double = 0.0, vrmx: Double = 0.0) extends Element with Product with Serializable
Italian excitation system.
Italian excitation system.
It represents an exciter dynamo and electric regulator.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- e1
Field voltage value 1 (E1). Typical value = 4,18.
- e2
Field voltage value 2 (E2). Typical value = 3,14.
- ka
AVR gain (KA). Typical value = 100.
- se1
Saturation factor at E1 (S[E1]). Typical value = 0,1.
- se2
Saturation factor at E2 (S[E2]). Typical value = 0,03.
- t1
AVR time constant (T1) (>= 0). Typical value = 20.
- t2
AVR time constant (T2) (>= 0). Typical value = 1,6.
- t3
AVR time constant (T3) (>= 0). Typical value = 0,66.
- t4
AVR time constant (T4) (>= 0). Typical value = 0,07.
- te
Exciter time constant (TE) (>= 0). Typical value = 1.
- vrmn
Minimum AVR output (VRMN). Typical value = -7,5.
- vrmx
Maximum AVR output (VRMX). Typical value = 7,5.
-
final
case class
ExcAVR4(ExcitationSystemDynamics: ExcitationSystemDynamics = null, imul: Boolean = false, ka: Double = 0.0, ke: Double = 0.0, kif: Double = 0.0, t1: Double = 0.0, t1if: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, tif: Double = 0.0, vfmn: Double = 0.0, vfmx: Double = 0.0, vrmn: Double = 0.0, vrmx: Double = 0.0) extends Element with Product with Serializable
Italian excitation system.
Italian excitation system.
It represents a static exciter and electric voltage regulator.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- imul
AVR output voltage dependency selector (IMUL). true = selector is connected false = selector is not connected. Typical value = true.
- ka
AVR gain (KA). Typical value = 300.
- ke
Exciter gain (KE). Typical value = 1.
- kif
Exciter internal reactance (KIF). Typical value = 0.
- t1
AVR time constant (T1) (>= 0). Typical value = 4,8.
- t1if
Exciter current feedback time constant (T1IF) (>= 0). Typical value = 60.
- t2
AVR time constant (T2) (>= 0). Typical value = 1,5.
- t3
AVR time constant (T3) (>= 0). Typical value = 0.
- t4
AVR time constant (T4) (>= 0). Typical value = 0.
- tif
Exciter current feedback time constant (TIF) (>= 0). Typical value = 0.
- vfmn
Minimum exciter output (VFMN). Typical value = 0.
- vfmx
Maximum exciter output (VFMX). Typical value = 5.
- vrmn
Minimum AVR output (VRMN). Typical value = 0.
- vrmx
Maximum AVR output (VRMX). Typical value = 5.
-
final
case class
ExcAVR5(ExcitationSystemDynamics: ExcitationSystemDynamics = null, ka: Double = 0.0, rex: Double = 0.0, ta: Double = 0.0) extends Element with Product with Serializable
Manual excitation control with field circuit resistance.
Manual excitation control with field circuit resistance.
This model can be used as a very simple representation of manual voltage control.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- ka
Gain (Ka).
- rex
Effective output resistance (Rex). Rex represents the effective output resistance seen by the excitation system.
- ta
Time constant (Ta) (>= 0).
-
final
case class
ExcAVR7(ExcitationSystemDynamics: ExcitationSystemDynamics = null, a1: Double = 0.0, a2: Double = 0.0, a3: Double = 0.0, a4: Double = 0.0, a5: Double = 0.0, a6: Double = 0.0, k1: Double = 0.0, k3: Double = 0.0, k5: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, t5: Double = 0.0, t6: Double = 0.0, vmax1: Double = 0.0, vmax3: Double = 0.0, vmax5: Double = 0.0, vmin1: Double = 0.0, vmin3: Double = 0.0, vmin5: Double = 0.0) extends Element with Product with Serializable
IVO excitation system.
IVO excitation system.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- a1
Lead coefficient (A1). Typical value = 0,5.
- a2
Lag coefficient (A2). Typical value = 0,5.
- a3
Lead coefficient (A3). Typical value = 0,5.
- a4
Lag coefficient (A4). Typical value = 0,5.
- a5
Lead coefficient (A5). Typical value = 0,5.
- a6
Lag coefficient (A6). Typical value = 0,5.
- k1
Gain (K1). Typical value = 1.
- k3
Gain (K3). Typical value = 3.
- k5
Gain (K5). Typical value = 1.
- t1
Lead time constant (T1) (>= 0). Typical value = 0,05.
- t2
Lag time constant (T2) (>= 0). Typical value = 0,1.
- t3
Lead time constant (T3) (>= 0). Typical value = 0,1.
- t4
Lag time constant (T4) (>= 0). Typical value = 0,1.
- t5
Lead time constant (T5) (>= 0). Typical value = 0,1.
- t6
Lag time constant (T6) (>= 0). Typical value = 0,1.
- vmax1
Lead-lag maximum limit (Vmax1) (> ExcAVR7.vmin1). Typical value = 5.
- vmax3
Lead-lag maximum limit (Vmax3) (> ExcAVR7.vmin3). Typical value = 5.
- vmax5
Lead-lag maximum limit (Vmax5) (> ExcAVR7.vmin5). Typical value = 5.
- vmin1
Lead-lag minimum limit (Vmin1) (< ExcAVR7.vmax1). Typical value = -5.
- vmin3
Lead-lag minimum limit (Vmin3) (< ExcAVR7.vmax3). Typical value = -5.
- vmin5
Lead-lag minimum limit (Vmin5) (< ExcAVR7.vmax5). Typical value = -2.
-
final
case class
ExcBBC(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efdmax: Double = 0.0, efdmin: Double = 0.0, k: Double = 0.0, switch: Boolean = false, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0, xe: Double = 0.0) extends Element with Product with Serializable
Transformer fed static excitation system (static with ABB regulator).
Transformer fed static excitation system (static with ABB regulator).
This model represents a static excitation system in which a gated thyristor bridge fed by a transformer at the main generator terminals feeds the main generator directly.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- efdmax
Maximum open circuit exciter voltage (Efdmax) (> ExcBBC.efdmin). Typical value = 5.
- efdmin
Minimum open circuit exciter voltage (Efdmin) (< ExcBBC.efdmax). Typical value = -5.
- k
Steady state gain (K) (not = 0). Typical value = 300.
- switch
Supplementary signal routing selector (switch). true = Vs connected to 3rd summing point false = Vs connected to 1st summing point (see diagram). Typical value = false.
- t1
Controller time constant (T1) (>= 0). Typical value = 6.
- t2
Controller time constant (T2) (>= 0). Typical value = 1.
- t3
Lead/lag time constant (T3) (>= 0). If = 0, block is bypassed. Typical value = 0,05.
- t4
Lead/lag time constant (T4) (>= 0). If = 0, block is bypassed. Typical value = 0,01.
- vrmax
Maximum control element output (Vrmax) (> ExcBBC.vrmin). Typical value = 5.
- vrmin
Minimum control element output (Vrmin) (< ExcBBC.vrmax). Typical value = -5.
- xe
Effective excitation transformer reactance (Xe) (>= 0). Xe models the regulation of the transformer/rectifier unit. Typical value = 0,05.
-
final
case class
ExcCZ(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efdmax: Double = 0.0, efdmin: Double = 0.0, ka: Double = 0.0, ke: Double = 0.0, kp: Double = 0.0, ta: Double = 0.0, tc: Double = 0.0, te: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
Czech proportion/integral exciter.
Czech proportion/integral exciter.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- efdmax
Exciter output maximum limit (Efdmax) (> ExcCZ.efdmin).
- efdmin
Exciter output minimum limit (Efdmin) (< ExcCZ.efdmax).
- ka
Regulator gain (Ka).
- ke
Exciter constant related to self-excited field (Ke).
- kp
Regulator proportional gain (Kp).
- ta
Regulator time constant (Ta) (>= 0).
- tc
Regulator integral time constant (Tc) (>= 0).
- te
Exciter time constant, integration rate associated with exciter control (Te) (>= 0).
- vrmax
Voltage regulator maximum limit (Vrmax) (> ExcCZ.vrmin).
- vrmin
Voltage regulator minimum limit (Vrmin) (< ExcCZ.vrmax).
-
final
case class
ExcDC1A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efd1: Double = 0.0, efd2: Double = 0.0, efdmax: Double = 0.0, efdmin: Double = 0.0, exclim: Boolean = false, ka: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, ks: Double = 0.0, seefd1: Double = 0.0, seefd2: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
Modified IEEE DC1A direct current commutator exciter with speed input and without underexcitation limiters (UEL) inputs.
Modified IEEE DC1A direct current commutator exciter with speed input and without underexcitation limiters (UEL) inputs.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- efd1
Exciter voltage at which exciter saturation is defined (Efd1) (> 0). Typical value = 3,1.
- efd2
Exciter voltage at which exciter saturation is defined (Efd2) (> 0). Typical value = 2,3.
- efdmax
Maximum voltage exciter output limiter (Efdmax) (> ExcDC1A.efdmin). Typical value = 99.
- efdmin
Minimum voltage exciter output limiter (Efdmin) (< ExcDC1A.edfmax). Typical value = -99.
- exclim
(exclim). IEEE standard is ambiguous about lower limit on exciter output. true = a lower limit of zero is applied to integrator output false = a lower limit of zero is not applied to integrator output. Typical value = true.
- ka
Voltage regulator gain (Ka) (> 0). Typical value = 46.
- ke
Exciter constant related to self-excited field (Ke). Typical value = 0.
- kf
Excitation control system stabilizer gain (Kf) (>= 0). Typical value = 0,1.
- ks
Coefficient to allow different usage of the model-speed coefficient (Ks). Typical value = 0.
- seefd1
Exciter saturation function value at the corresponding exciter voltage, Efd1 (Se[Eefd1]) (>= 0). Typical value = 0,33.
- seefd2
Exciter saturation function value at the corresponding exciter voltage, Efd2 (Se[Eefd2]) (>= 0). Typical value = 0,1.
- ta
Voltage regulator time constant (Ta) (> 0). Typical value = 0,06.
- tb
Voltage regulator time constant (Tb) (>= 0). Typical value = 0.
- tc
Voltage regulator time constant (Tc) (>= 0). Typical value = 0.
- te
Exciter time constant, integration rate associated with exciter control (Te) (> 0). Typical value = 0,46.
- tf
Excitation control system stabilizer time constant (Tf) (> 0). Typical value = 1.
- vrmax
Maximum voltage regulator output (Vrmax) (> ExcDC1A.vrmin). Typical value = 1.
- vrmin
Minimum voltage regulator output (Vrmin) (< 0 and < ExcDC1A.vrmax). Typical value = -0,9.
-
final
case class
ExcDC2A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efd1: Double = 0.0, efd2: Double = 0.0, exclim: Boolean = false, ka: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, ks: Double = 0.0, seefd1: Double = 0.0, seefd2: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, tf1: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0, vtlim: Boolean = false) extends Element with Product with Serializable
Modified IEEE DC2A direct current commutator exciter with speed input, one more leg block in feedback loop and without underexcitation limiters (UEL) inputs.
Modified IEEE DC2A direct current commutator exciter with speed input, one more leg block in feedback loop and without underexcitation limiters (UEL) inputs.
DC type 2 excitation system model with added speed multiplier, added lead-lag, and voltage-dependent limits.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- efd1
Exciter voltage at which exciter saturation is defined (Efd1) (> 0). Typical value = 3,05.
- efd2
Exciter voltage at which exciter saturation is defined (Efd2) (> 0). Typical value = 2,29.
- exclim
(exclim). IEEE standard is ambiguous about lower limit on exciter output. true = a lower limit of zero is applied to integrator output false = a lower limit of zero is not applied to integrator output. Typical value = true.
- ka
Voltage regulator gain (Ka) (> 0). Typical value = 300.
- ke
Exciter constant related to self-excited field (Ke). If Ke is entered as zero, the model calculates an effective value of Ke such that the initial condition value of Vr is zero. The zero value of Ke is not changed. If Ke is entered as non-zero, its value is used directly, without change. Typical value = 1.
- kf
Excitation control system stabilizer gain (Kf) (>= 0). Typical value = 0,1.
- ks
Coefficient to allow different usage of the model-speed coefficient (Ks). Typical value = 0.
- seefd1
Exciter saturation function value at the corresponding exciter voltage, Efd1 (Se[Efd1]) (>= 0). Typical value = 0,279.
- seefd2
Exciter saturation function value at the corresponding exciter voltage, Efd2 (Se[Efd2]) (>= 0). Typical value = 0,117.
- ta
Voltage regulator time constant (Ta) (> 0). Typical value = 0,01.
- tb
Voltage regulator time constant (Tb) (>= 0). Typical value = 0.
- tc
Voltage regulator time constant (Tc) (>= 0). Typical value = 0.
- te
Exciter time constant, integration rate associated with exciter control (Te) (> 0). Typical value = 1,33.
- tf
Excitation control system stabilizer time constant (Tf) (> 0). Typical value = 0,675.
- tf1
Excitation control system stabilizer time constant (Tf1) (>= 0). Typical value = 0.
- vrmax
Maximum voltage regulator output (Vrmax) (> ExcDC2A.vrmin). Typical value = 4,95.
- vrmin
Minimum voltage regulator output (Vrmin) (< 0 and < ExcDC2A.vrmax). Typical value = -4,9.
- vtlim
(Vtlim). true = limiter at the block (Ka / [1 + sTa]) is dependent on Vt false = limiter at the block is not dependent on Vt. Typical value = true.
-
final
case class
ExcDC3A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efd1: Double = 0.0, efd2: Double = 0.0, efdlim: Boolean = false, efdmax: Double = 0.0, efdmin: Double = 0.0, exclim: Boolean = false, ke: Double = 0.0, kr: Double = 0.0, ks: Double = 0.0, kv: Double = 0.0, seefd1: Double = 0.0, seefd2: Double = 0.0, te: Double = 0.0, trh: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
Modified IEEE DC3A direct current commutator exciter with speed input, and deadband.
Modified IEEE DC3A direct current commutator exciter with speed input, and deadband.
DC old type 4.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- efd1
Exciter voltage at which exciter saturation is defined (Efd1) (> 0). Typical value = 2,6.
- efd2
Exciter voltage at which exciter saturation is defined (Efd2) (> 0). Typical value = 3,45.
- efdlim
(Efdlim). true = exciter output limiter is active false = exciter output limiter not active. Typical value = true.
- efdmax
Maximum voltage exciter output limiter (Efdmax) (> ExcDC3A.efdmin). Typical value = 99.
- efdmin
Minimum voltage exciter output limiter (Efdmin) (< ExcDC3A.efdmax). Typical value = -99.
- exclim
(exclim). IEEE standard is ambiguous about lower limit on exciter output. true = a lower limit of zero is applied to integrator output false = a lower limit of zero not applied to integrator output. Typical value = true.
- ke
Exciter constant related to self-excited field (Ke). Typical value = 1.
- kr
Deadband (Kr). Typical value = 0.
- ks
Coefficient to allow different usage of the model-speed coefficient (Ks). Typical value = 0.
- kv
Fast raise/lower contact setting (Kv) (> 0). Typical value = 0,05.
- seefd1
Exciter saturation function value at the corresponding exciter voltage, Efd1 (Se[Efd1]) (>= 0). Typical value = 0,1.
- seefd2
Exciter saturation function value at the corresponding exciter voltage, Efd2 (Se[Efd2]) (>= 0). Typical value = 0,35.
- te
Exciter time constant, integration rate associated with exciter control (Te) (> 0). Typical value = 1,83.
- trh
Rheostat travel time (Trh) (> 0). Typical value = 20.
- vrmax
Maximum voltage regulator output (Vrmax) (> 0). Typical value = 5.
- vrmin
Minimum voltage regulator output (Vrmin) (<= 0). Typical value = 0.
-
final
case class
ExcDC3A1(ExcitationSystemDynamics: ExcitationSystemDynamics = null, exclim: Boolean = false, ka: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, ki: Double = 0.0, kp: Double = 0.0, ta: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, vb1max: Double = 0.0, vblim: Boolean = false, vbmax: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
Modified old IEEE type 3 excitation system.
Modified old IEEE type 3 excitation system.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- exclim
(exclim). true = lower limit of zero is applied to integrator output false = lower limit of zero not applied to integrator output. Typical value = true.
- ka
Voltage regulator gain (Ka) (> 0). Typical value = 300.
- ke
Exciter constant related to self-excited field (Ke). Typical value = 1.
- kf
Excitation control system stabilizer gain (Kf) (>= 0). Typical value = 0,1.
- ki
Potential circuit gain coefficient (Ki) (>= 0). Typical value = 4,83.
- kp
Potential circuit gain coefficient (Kp) (>= 0). Typical value = 4,37.
- ta
Voltage regulator time constant (Ta) (> 0). Typical value = 0,01.
- te
Exciter time constant, integration rate associated with exciter control (Te) (> 0). Typical value = 1,83.
- tf
Excitation control system stabilizer time constant (Tf) (>= 0). Typical value = 0,675.
- vb1max
Available exciter voltage limiter (Vb1max) (> 0). Typical value = 11,63.
- vblim
Vb limiter indicator. true = exciter Vbmax limiter is active false = Vb1max is active. Typical value = true.
- vbmax
Available exciter voltage limiter (Vbmax) (> 0). Typical value = 11,63.
- vrmax
Maximum voltage regulator output (Vrmax) (> ExcDC3A1.vrmin). Typical value = 5.
- vrmin
Minimum voltage regulator output (Vrmin) (< 0 and < ExcDC3A1.vrmax). Typical value = 0.
-
final
case class
ExcELIN1(ExcitationSystemDynamics: ExcitationSystemDynamics = null, dpnf: Double = 0.0, efmax: Double = 0.0, efmin: Double = 0.0, ks1: Double = 0.0, ks2: Double = 0.0, smax: Double = 0.0, tfi: Double = 0.0, tnu: Double = 0.0, ts1: Double = 0.0, ts2: Double = 0.0, tsw: Double = 0.0, vpi: Double = 0.0, vpnf: Double = 0.0, vpu: Double = 0.0, xe: Double = 0.0) extends Element with Product with Serializable
Static PI transformer fed excitation system ELIN (VATECH) - simplified model.
Static PI transformer fed excitation system ELIN (VATECH) - simplified model.
This model represents an all-static excitation system. A PI voltage controller establishes a desired field current set point for a proportional current controller. The integrator of the PI controller has a follow-up input to match its signal to the present field current. A power system stabilizer with power input is included in the model.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- dpnf
Controller follow up deadband (Dpnf). Typical value = 0.
- efmax
Maximum open circuit excitation voltage (Efmax) (> ExcELIN1.efmin). Typical value = 5.
- efmin
Minimum open circuit excitation voltage (Efmin) (< ExcELIN1.efmax). Typical value = -5.
- ks1
Stabilizer gain 1 (Ks1). Typical value = 0.
- ks2
Stabilizer gain 2 (Ks2). Typical value = 0.
- smax
Stabilizer limit output (smax). Typical value = 0,1.
- tfi
Current transducer time constant (Tfi) (>= 0). Typical value = 0.
- tnu
Controller reset time constant (Tnu) (>= 0). Typical value = 2.
- ts1
Stabilizer phase lag time constant (Ts1) (>= 0). Typical value = 1.
- ts2
Stabilizer filter time constant (Ts2) (>= 0). Typical value = 1.
- tsw
Stabilizer parameters (Tsw) (>= 0). Typical value = 3.
- vpi
Current controller gain (Vpi). Typical value = 12,45.
- vpnf
Controller follow up gain (Vpnf). Typical value = 2.
- vpu
Voltage controller proportional gain (Vpu). Typical value = 34,5.
- xe
Excitation transformer effective reactance (Xe) (>= 0). Xe represents the regulation of the transformer/rectifier unit. Typical value = 0,06.
-
final
case class
ExcELIN2(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efdbas: Double = 0.0, iefmax: Double = 0.0, iefmax2: Double = 0.0, iefmin: Double = 0.0, k1: Double = 0.0, k1ec: Double = 0.0, k2: Double = 0.0, k3: Double = 0.0, k4: Double = 0.0, kd1: Double = 0.0, ke2: Double = 0.0, ketb: Double = 0.0, pid1max: Double = 0.0, seve1: Double = 0.0, seve2: Double = 0.0, tb1: Double = 0.0, te: Double = 0.0, te2: Double = 0.0, ti1: Double = 0.0, ti3: Double = 0.0, ti4: Double = 0.0, tr4: Double = 0.0, upmax: Double = 0.0, upmin: Double = 0.0, ve1: Double = 0.0, ve2: Double = 0.0, xp: Double = 0.0) extends Element with Product with Serializable
Detailed excitation system ELIN (VATECH).
Detailed excitation system ELIN (VATECH).
This model represents an all-static excitation system. A PI voltage controller establishes a desired field current set point for a proportional current controller. The integrator of the PI controller has a follow-up input to match its signal to the present field current. Power system stabilizer models used in conjunction with this excitation system model: PssELIN2, PssIEEE2B, Pss2B.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- efdbas
Gain (Efdbas). Typical value = 0,1.
- iefmax
Limiter (Iefmax) (> ExcELIN2.iefmin). Typical value = 1.
- iefmax2
Minimum open circuit excitation voltage (Iefmax2). Typical value = -5.
- iefmin
Limiter (Iefmin) (< ExcELIN2.iefmax). Typical value = 1.
- k1
Voltage regulator input gain (K1). Typical value = 0.
- k1ec
Voltage regulator input limit (K1ec). Typical value = 2.
- k2
Gain (K2). Typical value = 5.
- k3
Gain (K3). Typical value = 0,1.
- k4
Gain (K4). Typical value = 0.
- kd1
Voltage controller derivative gain (Kd1). Typical value = 34,5.
- ke2
Gain (Ke2). Typical value = 0,1.
- ketb
Gain (Ketb). Typical value = 0,06.
- pid1max
Controller follow up gain (PID1max). Typical value = 2.
- seve1
Exciter saturation function value at the corresponding exciter voltage, Ve1, back of commutating reactance (Se[Ve1]) (>= 0). Typical value = 0.
- seve2
Exciter saturation function value at the corresponding exciter voltage, Ve2, back of commutating reactance (Se[Ve2]) (>= 0). Typical value = 1.
- tb1
Voltage controller derivative washout time constant (Tb1) (>= 0). Typical value = 12,45.
- te
Time constant (Te) (>= 0). Typical value = 0.
- te2
Time Constant (Te2) (>= 0). Typical value = 1.
- ti1
Controller follow up deadband (Ti1). Typical value = 0.
- ti3
Time constant (Ti3) (>= 0). Typical value = 3.
- ti4
Time constant (Ti4) (>= 0). Typical value = 0.
- tr4
Time constant (Tr4) (>= 0). Typical value = 1.
- upmax
Limiter (Upmax) (> ExcELIN2.upmin). Typical value = 3.
- upmin
Limiter (Upmin) (< ExcELIN2.upmax). Typical value = 0.
- ve1
Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve1) (> 0). Typical value = 3.
- ve2
Exciter alternator output voltages back of commutating reactance at which saturation is defined (Ve2) (> 0). Typical value = 0.
- xp
Excitation transformer effective reactance (Xp). Typical value = 1.
-
final
case class
ExcHU(ExcitationSystemDynamics: ExcitationSystemDynamics = null, ae: Double = 0.0, ai: Double = 0.0, atr: Double = 0.0, emax: Double = 0.0, emin: Double = 0.0, imax: Double = 0.0, imin: Double = 0.0, ke: Double = 0.0, ki: Double = 0.0, te: Double = 0.0, ti: Double = 0.0, tr: Double = 0.0) extends Element with Product with Serializable
Hungarian excitation system, with built-in voltage transducer.
Hungarian excitation system, with built-in voltage transducer.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- ae
Major loop PI tag gain factor (Ae). Typical value = 3.
- ai
Minor loop PI tag gain factor (Ai). Typical value = 22.
- atr
AVR constant (Atr). Typical value = 2,19.
- emax
Field voltage control signal upper limit on AVR base (Emax) (> ExcHU.emin). Typical value = 0,996.
- emin
Field voltage control signal lower limit on AVR base (Emin) (< ExcHU.emax). Typical value = -0,866.
- imax
Major loop PI tag output signal upper limit (Imax) (> ExcHU.imin). Typical value = 2,19.
- imin
Major loop PI tag output signal lower limit (Imin) (< ExcHU.imax). Typical value = 0,1.
- ke
Voltage base conversion constant (Ke). Typical value = 4,666.
- ki
Current base conversion constant (Ki). Typical value = 0,21428.
- te
Major loop PI tag integration time constant (Te) (>= 0). Typical value = 0,154.
- ti
Minor loop PI control tag integration time constant (Ti) (>= 0). Typical value = 0,01333.
- tr
Filter time constant (Tr) (>= 0). If a voltage compensator is used in conjunction with this excitation system model, Tr should be set to 0. Typical value = 0,01.
-
final
case class
ExcIEEEAC1A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, ka: Double = 0.0, kc: Double = 0.0, kd: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, seve1: Double = 0.0, seve2: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, vamax: Double = 0.0, vamin: Double = 0.0, ve1: Double = 0.0, ve2: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type AC1A model.
IEEE 421.5-2005 type AC1A model.
The model represents the field-controlled alternator-rectifier excitation systems designated type AC1A. These excitation systems consist of an alternator main exciter with non-controlled rectifiers. Reference: IEEE 421.5-2005, 6.1.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- ka
Voltage regulator gain (KA) (> 0). Typical value = 400.
- kc
Rectifier loading factor proportional to commutating reactance (KC) (>= 0). Typical value = 0,2.
- kd
Demagnetizing factor, a function of exciter alternator reactances (KD) (>= 0). Typical value = 0,38.
- ke
Exciter constant related to self-excited field (KE). Typical value = 1.
- kf
Excitation control system stabilizer gains (KF) (>= 0). Typical value = 0,03.
- seve1
Exciter saturation function value at the corresponding exciter voltage, VE1, back of commutating reactance (SE[VE1]) (>= 0). Typical value = 0,1.
- seve2
Exciter saturation function value at the corresponding exciter voltage, VE2, back of commutating reactance (SE[VE2]) (>= 0). Typical value = 0,03.
- ta
Voltage regulator time constant (TA) (> 0). Typical value = 0,02.
- tb
Voltage regulator time constant (TB) (>= 0). Typical value = 0.
- tc
Voltage regulator time constant (TC) (>= 0). Typical value = 0.
- te
Exciter time constant, integration rate associated with exciter control (TE) (> 0). Typical value = 0,8.
- tf
Excitation control system stabilizer time constant (TF) (> 0). Typical value = 1.
- vamax
Maximum voltage regulator output (VAMAX) (> 0). Typical value = 14,5.
- vamin
Minimum voltage regulator output (VAMIN) (< 0). Typical value = -14,5.
- ve1
Exciter alternator output voltages back of commutating reactance at which saturation is defined (VE1) (> 0). Typical value = 4,18.
- ve2
Exciter alternator output voltages back of commutating reactance at which saturation is defined (VE2) (> 0). Typical value = 3,14.
- vrmax
Maximum voltage regulator outputs (VRMAX) (> 0). Typical value = 6,03.
- vrmin
Minimum voltage regulator outputs (VRMIN) (< 0). Typical value = -5,43.
-
final
case class
ExcIEEEAC2A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, ka: Double = 0.0, kb: Double = 0.0, kc: Double = 0.0, kd: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, kh: Double = 0.0, seve1: Double = 0.0, seve2: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, vamax: Double = 0.0, vamin: Double = 0.0, ve1: Double = 0.0, ve2: Double = 0.0, vfemax: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type AC2A model.
IEEE 421.5-2005 type AC2A model.
The model represents a high initial response field-controlled alternator-rectifier excitation system. The alternator main exciter is used with non-controlled rectifiers. The type AC2A model is similar to that of type AC1A except for the inclusion of exciter time constant compensation and exciter field current limiting elements. Reference: IEEE 421.5-2005, 6.2.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- ka
Voltage regulator gain (KA) (> 0). Typical value = 400.
- kb
Second stage regulator gain (KB) (> 0). Typical value = 25.
- kc
Rectifier loading factor proportional to commutating reactance (KC) (>= 0). Typical value = 0,28.
- kd
Demagnetizing factor, a function of exciter alternator reactances (KD) (>= 0). Typical value = 0,35.
- ke
Exciter constant related to self-excited field (KE) (>= 0). Typical value = 1.
- kf
Excitation control system stabilizer gains (KF) (>= 0). Typical value = 0,03.
- kh
Exciter field current feedback gain (KH) (>= 0). Typical value = 1.
- seve1
Exciter saturation function value at the corresponding exciter voltage, VE1, back of commutating reactance (SE[VE1]) (>= 0). Typical value = 0,037.
- seve2
Exciter saturation function value at the corresponding exciter voltage, VE2, back of commutating reactance (SE[VE2]) (>= 0). Typical value = 0,012.
- ta
Voltage regulator time constant (TA) (> 0). Typical value = 0,02.
- tb
Voltage regulator time constant (TB) (>= 0). Typical value = 0.
- tc
Voltage regulator time constant (TC) (>= 0). Typical value = 0.
- te
Exciter time constant, integration rate associated with exciter control (TE) (> 0). Typical value = 0,6.
- tf
Excitation control system stabilizer time constant (TF) (> 0). Typical value = 1.
- vamax
Maximum voltage regulator output (VAMAX) (> 0). Typical value = 8.
- vamin
Minimum voltage regulator output (VAMIN) (< 0). Typical value = -8.
- ve1
Exciter alternator output voltages back of commutating reactance at which saturation is defined (VE1) (> 0). Typical value = 4,4.
- ve2
Exciter alternator output voltages back of commutating reactance at which saturation is defined (VE2) (> 0). Typical value = 3,3.
- vfemax
Exciter field current limit reference (VFEMAX) (> 0). Typical value = 4,4.
- vrmax
Maximum voltage regulator outputs (VRMAX) (> 0). Typical value = 105.
- vrmin
Minimum voltage regulator outputs (VRMIN) (< 0). Typical value = -95.
-
final
case class
ExcIEEEAC3A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efdn: Double = 0.0, ka: Double = 0.0, kc: Double = 0.0, kd: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, kn: Double = 0.0, kr: Double = 0.0, seve1: Double = 0.0, seve2: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, vamax: Double = 0.0, vamin: Double = 0.0, ve1: Double = 0.0, ve2: Double = 0.0, vemin: Double = 0.0, vfemax: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type AC3A model.
IEEE 421.5-2005 type AC3A model.
The model represents the field-controlled alternator-rectifier excitation systems designated type AC3A. These excitation systems include an alternator main exciter with non-controlled rectifiers. The exciter employs self-excitation, and the voltage regulator power is derived from the exciter output voltage. Therefore, this system has an additional nonlinearity, simulated by the use of a multiplier whose inputs are the voltage regulator command signal, Va, and the exciter output voltage, Efd, times KR. This model is applicable to excitation systems employing static voltage regulators. Reference: IEEE 421.5-2005, 6.3.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- efdn
Value of Efd at which feedback gain changes (EFDN) (> 0). Typical value = 2,36.
- ka
Voltage regulator gain (KA) (> 0). Typical value = 45,62.
- kc
Rectifier loading factor proportional to commutating reactance (KC) (>= 0). Typical value = 0,104.
- kd
Demagnetizing factor, a function of exciter alternator reactances (KD) (>= 0). Typical value = 0,499.
- ke
Exciter constant related to self-excited field (KE). Typical value = 1.
- kf
Excitation control system stabilizer gains (KF) (>= 0). Typical value = 0,143.
- kn
Excitation control system stabilizer gain (KN) (>= 0). Typical value = 0,05.
- kr
Constant associated with regulator and alternator field power supply (KR) (> 0). Typical value = 3,77.
- seve1
Exciter saturation function value at the corresponding exciter voltage, VE1, back of commutating reactance (SE[VE1]) (>= 0). Typical value = 1,143.
- seve2
Exciter saturation function value at the corresponding exciter voltage, VE2, back of commutating reactance (SE[VE2]) (>= 0). Typical value = 0,1.
- ta
Voltage regulator time constant (TA) (> 0). Typical value = 0,013.
- tb
Voltage regulator time constant (TB) (>= 0). Typical value = 0.
- tc
Voltage regulator time constant (TC) (>= 0). Typical value = 0.
- te
Exciter time constant, integration rate associated with exciter control (TE) (> 0). Typical value = 1,17.
- tf
Excitation control system stabilizer time constant (TF) (> 0). Typical value = 1.
- vamax
Maximum voltage regulator output (VAMAX) (> 0). Typical value = 1.
- vamin
Minimum voltage regulator output (VAMIN) (< 0). Typical value = -0,95.
- ve1
Exciter alternator output voltages back of commutating reactance at which saturation is defined (VE1) (> 0). Typical value = 6,24.
- ve2
Exciter alternator output voltages back of commutating reactance at which saturation is defined (VE2) (> 0). Typical value = 4,68.
- vemin
Minimum exciter voltage output (VEMIN) (<= 0). Typical value = 0.
- vfemax
Exciter field current limit reference (VFEMAX) (>= 0). Typical value = 16.
-
final
case class
ExcIEEEAC4A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, ka: Double = 0.0, kc: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, vimax: Double = 0.0, vimin: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type AC4A model.
IEEE 421.5-2005 type AC4A model.
The model represents type AC4A alternator-supplied controlled-rectifier excitation system which is quite different from the other types of AC systems. This high initial response excitation system utilizes a full thyristor bridge in the exciter output circuit. The voltage regulator controls the firing of the thyristor bridges. The exciter alternator uses an independent voltage regulator to control its output voltage to a constant value. These effects are not modelled; however, transient loading effects on the exciter alternator are included. Reference: IEEE 421.5-2005, 6.4.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- ka
Voltage regulator gain (KA) (> 0). Typical value = 200.
- kc
Rectifier loading factor proportional to commutating reactance (KC) (>= 0). Typical value = 0.
- ta
Voltage regulator time constant (TA) (> 0). Typical value = 0,015.
- tb
Voltage regulator time constant (TB) (>= 0). Typical value = 10.
- tc
Voltage regulator time constant (TC) (>= 0). Typical value = 1.
- vimax
Maximum voltage regulator input limit (VIMAX) (> 0). Typical value = 10.
- vimin
Minimum voltage regulator input limit (VIMIN) (< 0). Typical value = -10.
- vrmax
Maximum voltage regulator output (VRMAX) (> 0). Typical value = 5,64.
- vrmin
Minimum voltage regulator output (VRMIN) (< 0). Typical value = -4,53.
-
final
case class
ExcIEEEAC5A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efd1: Double = 0.0, efd2: Double = 0.0, ka: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, seefd1: Double = 0.0, seefd2: Double = 0.0, ta: Double = 0.0, te: Double = 0.0, tf1: Double = 0.0, tf2: Double = 0.0, tf3: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type AC5A model.
IEEE 421.5-2005 type AC5A model.
The model represents a simplified model for brushless excitation systems. The regulator is supplied from a source, such as a permanent magnet generator, which is not affected by system disturbances. Unlike other AC models, this model uses loaded rather than open circuit exciter saturation data in the same way as it is used for the DC models. Because the model has been widely implemented by the industry, it is sometimes used to represent other types of systems when either detailed data for them are not available or simplified models are required. Reference: IEEE 421.5-2005, 6.5.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- efd1
Exciter voltage at which exciter saturation is defined (EFD1) (> 0). Typical value = 5,6.
- efd2
Exciter voltage at which exciter saturation is defined (EFD2) (> 0). Typical value = 4,2.
- ka
Voltage regulator gain (KA) (> 0). Typical value = 400.
- ke
Exciter constant related to self-excited field (KE). Typical value = 1.
- kf
Excitation control system stabilizer gains (KF) (>= 0). Typical value = 0,03.
- seefd1
Exciter saturation function value at the corresponding exciter voltage, EFD1 (SE[EFD1]) (>= 0). Typical value = 0,86.
- seefd2
Exciter saturation function value at the corresponding exciter voltage, EFD2 (SE[EFD2]) (>= 0). Typical value = 0,5.
- ta
Voltage regulator time constant (TA) (> 0). Typical value = 0,02.
- te
Exciter time constant, integration rate associated with exciter control (TE) (> 0). Typical value = 0,8.
- tf1
Excitation control system stabilizer time constant (TF1) (> 0). Typical value = 1.
- tf2
Excitation control system stabilizer time constant (TF2) (>= 0). Typical value = 1.
- tf3
Excitation control system stabilizer time constant (TF3) (>= 0). Typical value = 1.
- vrmax
Maximum voltage regulator output (VRMAX) (> 0). Typical value = 7,3.
- vrmin
Minimum voltage regulator output (VRMIN) (< 0). Typical value = -7,3.
-
final
case class
ExcIEEEAC6A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, ka: Double = 0.0, kc: Double = 0.0, kd: Double = 0.0, ke: Double = 0.0, kh: Double = 0.0, seve1: Double = 0.0, seve2: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, te: Double = 0.0, th: Double = 0.0, tj: Double = 0.0, tk: Double = 0.0, vamax: Double = 0.0, vamin: Double = 0.0, ve1: Double = 0.0, ve2: Double = 0.0, vfelim: Double = 0.0, vhmax: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type AC6A model.
IEEE 421.5-2005 type AC6A model.
The model represents field-controlled alternator-rectifier excitation systems with system-supplied electronic voltage regulators. The maximum output of the regulator, VR, is a function of terminal voltage, VT. The field current limiter included in the original model AC6A remains in the 2005 update. Reference: IEEE 421.5-2005, 6.6.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- ka
Voltage regulator gain (KA) (> 0). Typical value = 536.
- kc
Rectifier loading factor proportional to commutating reactance (KC) (>= 0). Typical value = 0,173.
- kd
Demagnetizing factor, a function of exciter alternator reactances (KD) (>= 0). Typical value = 1,91.
- ke
Exciter constant related to self-excited field (KE). Typical value = 1,6.
- kh
Exciter field current limiter gain (KH) (>= 0). Typical value = 92.
- seve1
Exciter saturation function value at the corresponding exciter voltage, VE1, back of commutating reactance (SE[VE1]) (>= 0). Typical value = 0,214.
- seve2
Exciter saturation function value at the corresponding exciter voltage, VE2, back of commutating reactance (SE[VE2]) (>= 0). Typical value = 0,044.
- ta
Voltage regulator time constant (TA) (>= 0). Typical value = 0,086.
- tb
Voltage regulator time constant (TB) (>= 0). Typical value = 9.
- tc
Voltage regulator time constant (TC) (>= 0). Typical value = 3.
- te
Exciter time constant, integration rate associated with exciter control (TE) (> 0). Typical value = 1.
- th
Exciter field current limiter time constant (TH) (> 0). Typical value = 0,08.
- tj
Exciter field current limiter time constant (TJ) (>= 0). Typical value = 0,02.
- tk
Voltage regulator time constant (TK) (>= 0). Typical value = 0,18.
- vamax
Maximum voltage regulator output (VAMAX) (> 0). Typical value = 75.
- vamin
Minimum voltage regulator output (VAMIN) (< 0). Typical value = -75.
- ve1
Exciter alternator output voltages back of commutating reactance at which saturation is defined (VE1) (> 0). Typical value = 7,4.
- ve2
Exciter alternator output voltages back of commutating reactance at which saturation is defined (VE2) (> 0). Typical value = 5,55.
- vfelim
Exciter field current limit reference (VFELIM) (> 0). Typical value = 19.
- vhmax
Maximum field current limiter signal reference (VHMAX) (> 0). Typical value = 75.
- vrmax
Maximum voltage regulator output (VRMAX) (> 0). Typical value = 44.
- vrmin
Minimum voltage regulator output (VRMIN) (< 0). Typical value = -36.
-
final
case class
ExcIEEEAC7B(ExcitationSystemDynamics: ExcitationSystemDynamics = null, kc: Double = 0.0, kd: Double = 0.0, kdr: Double = 0.0, ke: Double = 0.0, kf1: Double = 0.0, kf2: Double = 0.0, kf3: Double = 0.0, kia: Double = 0.0, kir: Double = 0.0, kl: Double = 0.0, kp: Double = 0.0, kpa: Double = 0.0, kpr: Double = 0.0, seve1: Double = 0.0, seve2: Double = 0.0, tdr: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, vamax: Double = 0.0, vamin: Double = 0.0, ve1: Double = 0.0, ve2: Double = 0.0, vemin: Double = 0.0, vfemax: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type AC7B model.
IEEE 421.5-2005 type AC7B model.
The model represents excitation systems which consist of an AC alternator with either stationary or rotating rectifiers to produce the DC field requirements. It is an upgrade to earlier AC excitation systems, which replace only the controls but retain the AC alternator and diode rectifier bridge. Reference: IEEE 421.5-2005, 6.7. Note, however, that in IEEE 421.5-2005, the [1 / sTE] block is shown as [1 / (1 + sTE)], which is incorrect.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- kc
Rectifier loading factor proportional to commutating reactance (KC) (>= 0). Typical value = 0,18.
- kd
Demagnetizing factor, a function of exciter alternator reactances (KD) (>= 0). Typical value = 0,02.
- kdr
Voltage regulator derivative gain (KDR) (>= 0). Typical value = 0.
- ke
Exciter constant related to self-excited field (KE). Typical value = 1.
- kf1
Excitation control system stabilizer gain (KF1) (>= 0). Typical value = 0,212.
- kf2
Excitation control system stabilizer gain (KF2) (>= 0). Typical value = 0.
- kf3
Excitation control system stabilizer gain (KF3) (>= 0). Typical value = 0.
- kia
Voltage regulator integral gain (KIA) (>= 0). Typical value = 59,69.
- kir
Voltage regulator integral gain (KIR) (>= 0). Typical value = 4,24.
- kl
Exciter field voltage lower limit parameter (KL). Typical value = 10.
- kp
Potential circuit gain coefficient (KP) (> 0). Typical value = 4,96.
- kpa
Voltage regulator proportional gain (KPA) (> 0 if ExcIEEEAC7B.kia = 0). Typical value = 65,36.
- kpr
Voltage regulator proportional gain (KPR) (> 0 if ExcIEEEAC7B.kir = 0). Typical value = 4,24.
- seve1
Exciter saturation function value at the corresponding exciter voltage, VE1, back of commutating reactance (SE[VE1]) (>= 0). Typical value = 0,44.
- seve2
Exciter saturation function value at the corresponding exciter voltage, VE2, back of commutating reactance (SE[VE2]) (>= 0). Typical value = 0,075.
- tdr
Lag time constant (TDR) (>= 0). Typical value = 0.
- te
Exciter time constant, integration rate associated with exciter control (TE) (> 0). Typical value = 1,1.
- tf
Excitation control system stabilizer time constant (TF) (> 0). Typical value = 1.
- vamax
Maximum voltage regulator output (VAMAX) (> 0). Typical value = 1.
- vamin
Minimum voltage regulator output (VAMIN) (< 0). Typical value = -0,95.
- ve1
Exciter alternator output voltages back of commutating reactance at which saturation is defined (VE1) (> 0). Typical value = 6,3.
- ve2
Exciter alternator output voltages back of commutating reactance at which saturation is defined (VE2) (> 0). Typical value = 3,02.
- vemin
Minimum exciter voltage output (VEMIN) (<= 0). Typical value = 0.
- vfemax
Exciter field current limit reference (VFEMAX). Typical value = 6,9.
- vrmax
Maximum voltage regulator output (VRMAX) (> 0). Typical value = 5,79.
- vrmin
Minimum voltage regulator output (VRMIN) (< 0). Typical value = -5,79.
-
final
case class
ExcIEEEAC8B(ExcitationSystemDynamics: ExcitationSystemDynamics = null, ka: Double = 0.0, kc: Double = 0.0, kd: Double = 0.0, kdr: Double = 0.0, ke: Double = 0.0, kir: Double = 0.0, kpr: Double = 0.0, seve1: Double = 0.0, seve2: Double = 0.0, ta: Double = 0.0, tdr: Double = 0.0, te: Double = 0.0, ve1: Double = 0.0, ve2: Double = 0.0, vemin: Double = 0.0, vfemax: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type AC8B model.
IEEE 421.5-2005 type AC8B model.
This model represents a PID voltage regulator with either a brushless exciter or DC exciter. The AVR in this model consists of PID control, with separate constants for the proportional (KPR), integral (KIR), and derivative (KDR) gains. The representation of the brushless exciter (TE, KE, SE, KC, KD) is similar to the model type AC2A. The type AC8B model can be used to represent static voltage regulators applied to brushless excitation systems. Digitally based voltage regulators feeding DC rotating main exciters can be represented with the AC type AC8B model with the parameters KC and KD set to 0. For thyristor power stages fed from the generator terminals, the limits VRMAX and VRMIN should be a function of terminal voltage: VT x VRMAX and VT x VRMIN. Reference: IEEE 421.5-2005, 6.8.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- ka
Voltage regulator gain (KA) (> 0). Typical value = 1.
- kc
Rectifier loading factor proportional to commutating reactance (KC) (>= 0). Typical value = 0,55.
- kd
Demagnetizing factor, a function of exciter alternator reactances (KD) (>= 0). Typical value = 1,1.
- kdr
Voltage regulator derivative gain (KDR) (>= 0). Typical value = 10.
- ke
Exciter constant related to self-excited field (KE). Typical value = 1.
- kir
Voltage regulator integral gain (KIR) (>= 0). Typical value = 5.
- kpr
Voltage regulator proportional gain (KPR) (> 0 if ExcIEEEAC8B.kir = 0). Typical value = 80.
- seve1
Exciter saturation function value at the corresponding exciter voltage, VE1, back of commutating reactance (SE[VE1]) (>= 0). Typical value = 0,3.
- seve2
Exciter saturation function value at the corresponding exciter voltage, VE2, back of commutating reactance (SE[VE2]) (>= 0). Typical value = 3.
- ta
Voltage regulator time constant (TA) (>= 0). Typical value = 0.
- tdr
Lag time constant (TDR) (> 0). Typical value = 0,1.
- te
Exciter time constant, integration rate associated with exciter control (TE) (> 0). Typical value = 1,2.
- ve1
Exciter alternator output voltages back of commutating reactance at which saturation is defined (VE1) (> 0). Typical value = 6,5.
- ve2
Exciter alternator output voltages back of commutating reactance at which saturation is defined (VE2) (> 0). Typical value = 9.
- vemin
Minimum exciter voltage output (VEMIN) (<= 0). Typical value = 0.
- vfemax
Exciter field current limit reference (VFEMAX). Typical value = 6.
- vrmax
Maximum voltage regulator output (VRMAX) (> 0). Typical value = 35.
- vrmin
Minimum voltage regulator output (VRMIN) (<= 0). Typical value = 0.
-
final
case class
ExcIEEEDC1A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efd1: Double = 0.0, efd2: Double = 0.0, exclim: Boolean = false, ka: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, seefd1: Double = 0.0, seefd2: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, uelin: Boolean = false, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type DC1A model.
IEEE 421.5-2005 type DC1A model.
This model represents field-controlled DC commutator exciters with continuously acting voltage regulators (especially the direct-acting rheostatic, rotating amplifier, and magnetic amplifier types). Because this model has been widely implemented by the industry, it is sometimes used to represent other types of systems when detailed data for them are not available or when a simplified model is required. Reference: IEEE 421.5-2005, 5.1.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- efd1
Exciter voltage at which exciter saturation is defined (EFD1) (> 0). Typical value = 3,1.
- efd2
Exciter voltage at which exciter saturation is defined (EFD2) (> 0). Typical value = 2,3.
- exclim
(exclim). IEEE standard is ambiguous about lower limit on exciter output. true = a lower limit of zero is applied to integrator output false = a lower limit of zero is not applied to integrator output. Typical value = true.
- ka
Voltage regulator gain (KA) (> 0). Typical value = 46.
- ke
Exciter constant related to self-excited field (KE). Typical value = 0.
- kf
Excitation control system stabilizer gain (KF) (>= 0). Typical value = 0.1.
- seefd1
Exciter saturation function value at the corresponding exciter voltage, EFD1 (SE[EFD1]) (>= 0). Typical value = 0.33.
- seefd2
Exciter saturation function value at the corresponding exciter voltage, EFD2 (SE[EFD2]) (>= 0). Typical value = 0,1.
- ta
Voltage regulator time constant (TA) (> 0). Typical value = 0,06.
- tb
Voltage regulator time constant (TB) (>= 0). Typical value = 0.
- tc
Voltage regulator time constant (TC) (>= 0). Typical value = 0.
- te
Exciter time constant, integration rate associated with exciter control (TE) (> 0). Typical value = 0,46.
- tf
Excitation control system stabilizer time constant (TF) (> 0). Typical value = 1.
- uelin
UEL input (uelin). true = input is connected to the HV gate false = input connects to the error signal. Typical value = true.
- vrmax
Maximum voltage regulator output (VRMAX) (> ExcIEEEDC1A.vrmin). Typical value = 1.
- vrmin
Minimum voltage regulator output (VRMIN) (< 0 and < ExcIEEEDC1A.vrmax). Typical value = -0,9.
-
final
case class
ExcIEEEDC2A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efd1: Double = 0.0, efd2: Double = 0.0, exclim: Double = 0.0, ka: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, seefd1: Double = 0.0, seefd2: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, uelin: Boolean = false, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type DC2A model.
IEEE 421.5-2005 type DC2A model.
This model represents field-controlled DC commutator exciters with continuously acting voltage regulators having supplies obtained from the generator or auxiliary bus. It differs from the type DC1A model only in the voltage regulator output limits, which are now proportional to terminal voltage VT. It is representative of solid-state replacements for various forms of older mechanical and rotating amplifier regulating equipment connected to DC commutator exciters. Reference: IEEE 421.5-2005, 5.2.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- efd1
Exciter voltage at which exciter saturation is defined (EFD1) (> 0). Typical value = 3,05.
- efd2
Exciter voltage at which exciter saturation is defined (EFD2) (> 0). Typical value = 2,29.
- exclim
(exclim). IEEE standard is ambiguous about lower limit on exciter output. Typical value = - 999 which means that there is no limit applied.
- ka
Voltage regulator gain (KA) (> 0). Typical value = 300.
- ke
Exciter constant related to self-excited field (KE). Typical value = 1.
- kf
Excitation control system stabilizer gain (KF) (>= 0). Typical value = 0,1.
- seefd1
Exciter saturation function value at the corresponding exciter voltage, EFD1 (SE[EFD1]) (>= 0). Typical value = 0,279.
- seefd2
Exciter saturation function value at the corresponding exciter voltage, EFD2 (SE[EFD2]) (>= 0). Typical value = 0,117.
- ta
Voltage regulator time constant (TA) (> 0). Typical value = 0,01.
- tb
Voltage regulator time constant (TB) (>= 0). Typical value = 0.
- tc
Voltage regulator time constant (TC) (>= 0). Typical value = 0.
- te
Exciter time constant, integration rate associated with exciter control (TE) (> 0). Typical value = 1,33.
- tf
Excitation control system stabilizer time constant (TF) (> 0). Typical value = 0,675.
- uelin
UEL input (uelin). true = input is connected to the HV gate false = input connects to the error signal. Typical value = true.
- vrmax
Maximum voltage regulator output (VRMAX)(> ExcIEEEDC2A.vrmin). Typical value = 4,95.
- vrmin
Minimum voltage regulator output (VRMIN) (< 0 and < ExcIEEEDC2A.vrmax). Typical value = -4,9.
-
final
case class
ExcIEEEDC3A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efd1: Double = 0.0, efd2: Double = 0.0, exclim: Boolean = false, ke: Double = 0.0, kv: Double = 0.0, seefd1: Double = 0.0, seefd2: Double = 0.0, te: Double = 0.0, trh: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type DC3A model.
IEEE 421.5-2005 type DC3A model.
This model represents older systems, in particular those DC commutator exciters with non-continuously acting regulators that were commonly used before the development of the continuously acting varieties. These systems respond at basically two different rates, depending upon the magnitude of voltage error. For small errors, adjustment is made periodically with a signal to a motor-operated rheostat. Larger errors cause resistors to be quickly shorted or inserted and a strong forcing signal applied to the exciter. Continuous motion of the motor-operated rheostat occurs for these larger error signals, even though it is bypassed by contactor action. Reference: IEEE 421.5-2005, 5.3.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- efd1
Exciter voltage at which exciter saturation is defined (EFD1) (> 0). Typical value = 3,375.
- efd2
Exciter voltage at which exciter saturation is defined (EFD2) (> 0). Typical value = 3,15.
- exclim
(exclim). IEEE standard is ambiguous about lower limit on exciter output. true = a lower limit of zero is applied to integrator output false = a lower limit of zero is not applied to integrator output. Typical value = true.
- ke
Exciter constant related to self-excited field (KE). Typical value = 0,05.
- kv
Fast raise/lower contact setting (KV) (> 0). Typical value = 0,05.
- seefd1
Exciter saturation function value at the corresponding exciter voltage, EFD1 (SE[EFD1]) (>= 0). Typical value = 0,267.
- seefd2
Exciter saturation function value at the corresponding exciter voltage, EFD2 (SE[EFD2]) (>= 0). Typical value = 0,068.
- te
Exciter time constant, integration rate associated with exciter control (TE) (> 0). Typical value = 0,5.
- trh
Rheostat travel time (TRH) (> 0). Typical value = 20.
- vrmax
Maximum voltage regulator output (VRMAX) (> 0). Typical value = 1.
- vrmin
Minimum voltage regulator output (VRMIN) (<= 0). Typical value = 0.
-
final
case class
ExcIEEEDC4B(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efd1: Double = 0.0, efd2: Double = 0.0, ka: Double = 0.0, kd: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, ki: Double = 0.0, kp: Double = 0.0, oelin: Boolean = false, seefd1: Double = 0.0, seefd2: Double = 0.0, ta: Double = 0.0, td: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, uelin: Boolean = false, vemin: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type DC4B model.
IEEE 421.5-2005 type DC4B model.
These excitation systems utilize a field-controlled DC commutator exciter with a continuously acting voltage regulator having supplies obtained from the generator or auxiliary bus. Reference: IEEE 421.5-2005, 5.4.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- efd1
Exciter voltage at which exciter saturation is defined (EFD1) (> 0). Typical value = 1,75.
- efd2
Exciter voltage at which exciter saturation is defined (EFD2) (> 0). Typical value = 2,33.
- ka
Voltage regulator gain (KA) (> 0). Typical value = 1.
- kd
Regulator derivative gain (KD) (>= 0). Typical value = 20.
- ke
Exciter constant related to self-excited field (KE). Typical value = 1.
- kf
Excitation control system stabilizer gain (KF) (>= 0). Typical value = 0.
- ki
Regulator integral gain (KI) (>= 0). Typical value = 20.
- kp
Regulator proportional gain (KP) (>= 0). Typical value = 20.
- oelin
OEL input (OELin). true = LV gate false = subtract from error signal. Typical value = true.
- seefd1
Exciter saturation function value at the corresponding exciter voltage, EFD1 (SE[EFD1]) (>= 0). Typical value = 0,08.
- seefd2
Exciter saturation function value at the corresponding exciter voltage, EFD2 (SE[EFD2]) (>= 0). Typical value = 0,27.
- ta
Voltage regulator time constant (TA) (> 0). Typical value = 0,2.
- td
Regulator derivative filter time constant (TD) (> 0 if ExcIEEEDC4B.kd > 0). Typical value = 0,01.
- te
Exciter time constant, integration rate associated with exciter control (TE) (> 0). Typical value = 0,8.
- tf
Excitation control system stabilizer time constant (TF) (>= 0). Typical value = 1.
- uelin
UEL input (UELin). true = HV gate false = add to error signal. Typical value = true.
- vemin
Minimum exciter voltage output (VEMIN) (<= 0). Typical value = 0.
- vrmax
Maximum voltage regulator output (VRMAX) (> ExcIEEEDC4B.vrmin). Typical value = 2,7.
- vrmin
Minimum voltage regulator output (VRMIN) (<= 0 and < ExcIEEEDC4B.vrmax). Typical value = -0,9.
-
final
case class
ExcIEEEST1A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, ilr: Double = 0.0, ka: Double = 0.0, kc: Double = 0.0, kf: Double = 0.0, klr: Double = 0.0, pssin: Boolean = false, ta: Double = 0.0, tb: Double = 0.0, tb1: Double = 0.0, tc: Double = 0.0, tc1: Double = 0.0, tf: Double = 0.0, uelin: String = null, vamax: Double = 0.0, vamin: Double = 0.0, vimax: Double = 0.0, vimin: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type ST1A model.
IEEE 421.5-2005 type ST1A model.
This model represents systems in which excitation power is supplied through a transformer from the generator terminals (or the unit’s auxiliary bus) and is regulated by a controlled rectifier. The maximum exciter voltage available from such systems is directly related to the generator terminal voltage. Reference: IEEE 421.5-2005, 7.1.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- ilr
Exciter output current limit reference (ILR). Typical value = 0.
- ka
Voltage regulator gain (KA) (> 0). Typical value = 190.
- kc
Rectifier loading factor proportional to commutating reactance (KC) (>= 0). Typical value = 0,08.
- kf
Excitation control system stabilizer gains (KF) (>= 0). Typical value = 0.
- klr
Exciter output current limiter gain (KLR). Typical value = 0.
- pssin
Selector of the Power System Stabilizer (PSS) input (PSSin). true = PSS input (Vs) added to error signal false = PSS input (Vs) added to voltage regulator output. Typical value = true.
- ta
Voltage regulator time constant (TA) (>= 0). Typical value = 0.
- tb
Voltage regulator time constant (TB) (>= 0). Typical value = 10.
- tb1
Voltage regulator time constant (TB1) (>= 0). Typical value = 0.
- tc
Voltage regulator time constant (TC) (>= 0). Typical value = 1.
- tc1
Voltage regulator time constant (TC1) (>= 0). Typical value = 0.
- tf
Excitation control system stabilizer time constant (TF) (>= 0). Typical value = 1.
- uelin
Selector of the connection of the UEL input (UELin). Typical value = ignoreUELsignal.
- vamax
Maximum voltage regulator output (VAMAX) (> 0). Typical value = 14,5.
- vamin
Minimum voltage regulator output (VAMIN) (< 0). Typical value = -14,5.
- vimax
Maximum voltage regulator input limit (VIMAX) (> 0). Typical value = 999.
- vimin
Minimum voltage regulator input limit (VIMIN) (< 0). Typical value = -999.
- vrmax
Maximum voltage regulator outputs (VRMAX) (> 0). Typical value = 7,8.
- vrmin
Minimum voltage regulator outputs (VRMIN) (< 0). Typical value = -6,7.
-
final
case class
ExcIEEEST2A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efdmax: Double = 0.0, ka: Double = 0.0, kc: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, ki: Double = 0.0, kp: Double = 0.0, ta: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, uelin: Boolean = false, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type ST2A model.
IEEE 421.5-2005 type ST2A model.
Some static systems use both current and voltage sources (generator terminal quantities) to comprise the power source. The regulator controls the exciter output through controlled saturation of the power transformer components. These compound-source rectifier excitation systems are designated type ST2A and are represented by ExcIEEEST2A. Reference: IEEE 421.5-2005, 7.2.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- efdmax
Maximum field voltage (EFDMax) (>= 0). Typical value = 99.
- ka
Voltage regulator gain (KA) (> 0). Typical value = 120.
- kc
Rectifier loading factor proportional to commutating reactance (KC) (>= 0). Typical value = 1,82.
- ke
Exciter constant related to self-excited field (KE). Typical value = 1.
- kf
Excitation control system stabilizer gains (KF) (>= 0). Typical value = 0,05.
- ki
Potential circuit gain coefficient (KI) (>= 0). Typical value = 8.
- kp
Potential circuit gain coefficient (KP) (>= 0). Typical value = 4,88.
- ta
Voltage regulator time constant (TA) (> 0). Typical value = 0,15.
- te
Exciter time constant, integration rate associated with exciter control (TE) (> 0). Typical value = 0,5.
- tf
Excitation control system stabilizer time constant (TF) (>= 0). Typical value = 1.
- uelin
UEL input (UELin). true = HV gate false = add to error signal. Typical value = true.
- vrmax
Maximum voltage regulator outputs (VRMAX) (> 0). Typical value = 1.
- vrmin
Minimum voltage regulator outputs (VRMIN) (<= 0). Typical value = 0.
-
final
case class
ExcIEEEST3A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, ka: Double = 0.0, kc: Double = 0.0, kg: Double = 0.0, ki: Double = 0.0, km: Double = 0.0, kp: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, thetap: Double = 0.0, tm: Double = 0.0, vbmax: Double = 0.0, vgmax: Double = 0.0, vimax: Double = 0.0, vimin: Double = 0.0, vmmax: Double = 0.0, vmmin: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0, xl: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type ST3A model.
IEEE 421.5-2005 type ST3A model.
Some static systems utilize a field voltage control loop to linearize the exciter control characteristic. This also makes the output independent of supply source variations until supply limitations are reached. These systems utilize a variety of controlled-rectifier designs: full thyristor complements or hybrid bridges in either series or shunt configurations. The power source can consist of only a potential source, either fed from the machine terminals or from internal windings. Some designs can have compound power sources utilizing both machine potential and current. These power sources are represented as phasor combinations of machine terminal current and voltage and are accommodated by suitable parameters in model type ST3A which is represented by ExcIEEEST3A. Reference: IEEE 421.5-2005, 7.3.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- ka
Voltage regulator gain (KA) (> 0). This is parameter K in the IEEE standard. Typical value = 200.
- kc
Rectifier loading factor proportional to commutating reactance (KC) (>= 0). Typical value = 0,2.
- kg
Feedback gain constant of the inner loop field regulator (KG) (>= 0). Typical value = 1.
- ki
Potential circuit gain coefficient (KI) (>= 0). Typical value = 0.
- km
Forward gain constant of the inner loop field regulator (KM) (> 0). Typical value = 7,93.
- kp
Potential circuit gain coefficient (KP) (> 0). Typical value = 6,15.
- ta
Voltage regulator time constant (TA) (>= 0). Typical value = 0.
- tb
Voltage regulator time constant (TB) (>= 0). Typical value = 10.
- tc
Voltage regulator time constant (TC) (>= 0). Typical value = 1.
- thetap
Potential circuit phase angle (thetap). Typical value = 0.
- tm
Forward time constant of inner loop field regulator (TM) (> 0). Typical value = 0,4.
- vbmax
Maximum excitation voltage (VBMax) (> 0). Typical value = 6,9.
- vgmax
Maximum inner loop feedback voltage (VGMax) (>= 0). Typical value = 5,8.
- vimax
Maximum voltage regulator input limit (VIMAX) (> 0). Typical value = 0,2.
- vimin
Minimum voltage regulator input limit (VIMIN) (< 0). Typical value = -0,2.
- vmmax
Maximum inner loop output (VMMax) (> 0). Typical value = 1.
- vmmin
Minimum inner loop output (VMMin) (<= 0). Typical value = 0.
- vrmax
Maximum voltage regulator output (VRMAX) (> 0). Typical value = 10.
- vrmin
Minimum voltage regulator output (VRMIN) (< 0). Typical value = -10.
- xl
Reactance associated with potential source (XL) (>= 0). Typical value = 0,081.
-
final
case class
ExcIEEEST4B(ExcitationSystemDynamics: ExcitationSystemDynamics = null, kc: Double = 0.0, kg: Double = 0.0, ki: Double = 0.0, kim: Double = 0.0, kir: Double = 0.0, kp: Double = 0.0, kpm: Double = 0.0, kpr: Double = 0.0, ta: Double = 0.0, thetap: Double = 0.0, vbmax: Double = 0.0, vmmax: Double = 0.0, vmmin: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0, xl: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type ST4B model.
IEEE 421.5-2005 type ST4B model.
This model is a variation of the type ST3A model, with a proportional plus integral (PI) regulator block replacing the lag-lead regulator characteristic that is in the ST3A model. Both potential and compound source rectifier excitation systems are modelled. The PI regulator blocks have non-windup limits that are represented. The voltage regulator of this model is typically implemented digitally. Reference: IEEE 421.5-2005, 7.4.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- kc
Rectifier loading factor proportional to commutating reactance (KC) (>= 0). Typical value = 0,113.
- kg
Feedback gain constant of the inner loop field regulator (KG) (>= 0). Typical value = 0.
- ki
Potential circuit gain coefficient (KI) (>= 0). Typical value = 0.
- kim
Voltage regulator integral gain output (KIM). Typical value = 0.
- kir
Voltage regulator integral gain (KIR). Typical value = 10,75.
- kp
Potential circuit gain coefficient (KP) (> 0). Typical value = 9,3.
- kpm
Voltage regulator proportional gain output (KPM). Typical value = 1.
- kpr
Voltage regulator proportional gain (KPR). Typical value = 10,75.
- ta
Voltage regulator time constant (TA) (>= 0). Typical value = 0,02.
- thetap
Potential circuit phase angle (thetap). Typical value = 0.
- vbmax
Maximum excitation voltage (VBMax) (> 0). Typical value = 11,63.
- vmmax
Maximum inner loop output (VMMax) (> ExcIEEEST4B.vmmin). Typical value = 99.
- vmmin
Minimum inner loop output (VMMin) (< ExcIEEEST4B.vmmax). Typical value = -99.
- vrmax
Maximum voltage regulator output (VRMAX) (> 0). Typical value = 1.
- vrmin
Minimum voltage regulator output (VRMIN) (< 0). Typical value = -0,87.
- xl
Reactance associated with potential source (XL) (>= 0). Typical value = 0,124.
-
final
case class
ExcIEEEST5B(ExcitationSystemDynamics: ExcitationSystemDynamics = null, kc: Double = 0.0, kr: Double = 0.0, t1: Double = 0.0, tb1: Double = 0.0, tb2: Double = 0.0, tc1: Double = 0.0, tc2: Double = 0.0, tob1: Double = 0.0, tob2: Double = 0.0, toc1: Double = 0.0, toc2: Double = 0.0, tub1: Double = 0.0, tub2: Double = 0.0, tuc1: Double = 0.0, tuc2: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type ST5B model.
IEEE 421.5-2005 type ST5B model.
The type ST5B excitation system is a variation of the type ST1A model, with alternative overexcitation and underexcitation inputs and additional limits. The block diagram in the IEEE 421.5 standard has input signal Vc and does not indicate the summation point with Vref. The implementation of the ExcIEEEST5B shall consider summation point with Vref. Reference: IEEE 421.5-2005, 7.5.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- kc
Rectifier regulation factor (KC) (>= 0). Typical value = 0,004.
- kr
Regulator gain (KR) (> 0). Typical value = 200.
- t1
Firing circuit time constant (T1) (>= 0). Typical value = 0,004.
- tb1
Regulator lag time constant (TB1) (>= 0). Typical value = 6.
- tb2
Regulator lag time constant (TB2) (>= 0). Typical value = 0,01.
- tc1
Regulator lead time constant (TC1) (>= 0). Typical value = 0,8.
- tc2
Regulator lead time constant (TC2) (>= 0). Typical value = 0,08.
- tob1
OEL lag time constant (TOB1) (>= 0). Typical value = 2.
- tob2
OEL lag time constant (TOB2) (>= 0). Typical value = 0,08.
- toc1
OEL lead time constant (TOC1) (>= 0). Typical value = 0,1.
- toc2
OEL lead time constant (TOC2) (>= 0). Typical value = 0,08.
- tub1
UEL lag time constant (TUB1) (>= 0). Typical value = 10.
- tub2
UEL lag time constant (TUB2) (>= 0). Typical value = 0,05.
- tuc1
UEL lead time constant (TUC1) (>= 0). Typical value = 2.
- tuc2
UEL lead time constant (TUC2) (>= 0). Typical value = 0,1.
- vrmax
Maximum voltage regulator output (VRMAX) (> 0). Typical value = 5.
- vrmin
Minimum voltage regulator output (VRMIN) (< 0). Typical value = -4.
-
final
case class
ExcIEEEST6B(ExcitationSystemDynamics: ExcitationSystemDynamics = null, ilr: Double = 0.0, kci: Double = 0.0, kff: Double = 0.0, kg: Double = 0.0, kia: Double = 0.0, klr: Double = 0.0, km: Double = 0.0, kpa: Double = 0.0, oelin: String = null, tg: Double = 0.0, vamax: Double = 0.0, vamin: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type ST6B model.
IEEE 421.5-2005 type ST6B model.
This model consists of a PI voltage regulator with an inner loop field voltage regulator and pre-control. The field voltage regulator implements a proportional control. The pre-control and the delay in the feedback circuit increase the dynamic response. Reference: IEEE 421.5-2005, 7.6.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- ilr
Exciter output current limit reference (ILR) (> 0). Typical value = 4,164.
- kci
Exciter output current limit adjustment (KCI) (> 0). Typical value = 1,0577.
- kff
Pre-control gain constant of the inner loop field regulator (KFF). Typical value = 1.
- kg
Feedback gain constant of the inner loop field regulator (KG) (>= 0). Typical value = 1.
- kia
Voltage regulator integral gain (KIA) (> 0). Typical value = 45,094.
- klr
Exciter output current limiter gain (KLR) (> 0). Typical value = 17,33.
- km
Forward gain constant of the inner loop field regulator (KM). Typical value = 1.
- kpa
Voltage regulator proportional gain (<u>K</u><u>PA</u>) (> 0). Typical value = 18,038.
- oelin
OEL input selector (OELin). Typical value = noOELinput.
- tg
Feedback time constant of inner loop field voltage regulator (TG) (>= 0). Typical value = 0,02.
- vamax
Maximum voltage regulator output (VAMAX) (> 0). Typical value = 4,81.
- vamin
Minimum voltage regulator output (VAMIN) (< 0). Typical value = -3,85.
- vrmax
Maximum voltage regulator output (VRMAX) (> 0). Typical value = 4,81.
- vrmin
Minimum voltage regulator output (VRMIN) (< 0). Typical value = -3,85.
-
final
case class
ExcIEEEST7B(ExcitationSystemDynamics: ExcitationSystemDynamics = null, kh: Double = 0.0, kia: Double = 0.0, kl: Double = 0.0, kpa: Double = 0.0, oelin: String = null, tb: Double = 0.0, tc: Double = 0.0, tf: Double = 0.0, tg: Double = 0.0, tia: Double = 0.0, uelin: String = null, vmax: Double = 0.0, vmin: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type ST7B model.
IEEE 421.5-2005 type ST7B model.
This model is representative of static potential-source excitation systems. In this system, the AVR consists of a PI voltage regulator. A phase lead-lag filter in series allows the introduction of a derivative function, typically used with brushless excitation systems. In that case, the regulator is of the PID type. In addition, the terminal voltage channel includes a phase lead-lag filter. The AVR includes the appropriate inputs on its reference for overexcitation limiter (OEL1), underexcitation limiter (UEL), stator current limiter (SCL), and current compensator (DROOP). All these limitations, when they work at voltage reference level, keep the PSS (VS signal from PSS) in operation. However, the UEL limitation can also be transferred to the high value (HV) gate acting on the output signal. In addition, the output signal passes through a low value (LV) gate for a ceiling overexcitation limiter (OEL2). Reference: IEEE 421.5-2005, 7.7.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- kh
High-value gate feedback gain (KH) (>= 0). Typical value = 1.
- kia
Voltage regulator integral gain (KIA) (>= 0). Typical value = 1.
- kl
Low-value gate feedback gain (KL) (>= 0). Typical value = 1.
- kpa
Voltage regulator proportional gain (KPA) (> 0). Typical value = 40.
- oelin
OEL input selector (OELin). Typical value = noOELinput.
- tb
Regulator lag time constant (TB) (>= 0). Typical value = 1.
- tc
Regulator lead time constant (TC) (>= 0). Typical value = 1.
- tf
Excitation control system stabilizer time constant (TF) (>= 0). Typical value = 1.
- tg
Feedback time constant of inner loop field voltage regulator (TG) (>= 0). Typical value = 1.
- tia
Feedback time constant (TIA) (>= 0). Typical value = 3.
- uelin
UEL input selector (UELin). Typical value = noUELinput.
- vmax
Maximum voltage reference signal (VMAX) (> 0 and > ExcIEEEST7B.vmin). Typical value = 1,1.
- vmin
Minimum voltage reference signal (VMIN) (> 0 and < ExcIEEEST7B.vmax). Typical value = 0,9.
- vrmax
Maximum voltage regulator output (VRMAX) (> 0). Typical value = 5.
- vrmin
Minimum voltage regulator output (VRMIN) (< 0). Typical value = -4,5.
-
final
case class
ExcNI(ExcitationSystemDynamics: ExcitationSystemDynamics = null, busFedSelector: Boolean = false, ka: Double = 0.0, kf: Double = 0.0, r: Double = 0.0, ta: Double = 0.0, tf1: Double = 0.0, tf2: Double = 0.0, tr: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
Bus or solid fed SCR (silicon-controlled rectifier) bridge excitation system model type NI (NVE).
Bus or solid fed SCR (silicon-controlled rectifier) bridge excitation system model type NI (NVE).
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- busFedSelector
Fed by selector (BusFedSelector). true = bus fed (switch is closed) false = solid fed (switch is open). Typical value = true.
- ka
Voltage regulator gain (Ka) (> 0). Typical value = 210.
- kf
Excitation control system stabilizer gain (Kf) (> 0). Typical value 0,01.
- r
rc / rfd (R) (>= 0). 0 means exciter has negative current capability > 0 means exciter does not have negative current capability. Typical value = 5.
- ta
Voltage regulator time constant (Ta) (> 0). Typical value = 0,02.
- tf1
Excitation control system stabilizer time constant (Tf1) (> 0). Typical value = 1,0.
- tf2
Excitation control system stabilizer time constant (Tf2) (> 0). Typical value = 0,1.
- tr
Time constant (Tr) (>= 0). Typical value = 0,02.
- vrmax
Maximum voltage regulator ouput (Vrmax) (> ExcNI.vrmin). Typical value = 5,0.
- vrmin
Minimum voltage regulator ouput (Vrmin) (< ExcNI.vrmax). Typical value = -2,0.
-
final
case class
ExcOEX3T(ExcitationSystemDynamics: ExcitationSystemDynamics = null, e1: Double = 0.0, e2: Double = 0.0, ka: Double = 0.0, kc: Double = 0.0, kd: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, see1: Double = 0.0, see2: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, t5: Double = 0.0, t6: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
Modified IEEE type ST1 excitation system with semi-continuous and acting terminal voltage limiter.
Modified IEEE type ST1 excitation system with semi-continuous and acting terminal voltage limiter.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- e1
Saturation parameter (E1).
- e2
Saturation parameter (E2).
- ka
Gain (KA).
- kc
Gain (KC).
- kd
Gain (KD).
- ke
Gain (KE).
- kf
Gain (KF).
- see1
Saturation parameter (SE[E1]).
- see2
Saturation parameter (SE[E2]).
- t1
Time constant (T1) (>= 0).
- t2
Time constant (T2) (>= 0).
- t3
Time constant (T3) (>= 0).
- t4
Time constant (T4) (>= 0).
- t5
Time constant (T5) (>= 0).
- t6
Time constant (T6) (>= 0).
- te
Time constant (TE) (>= 0).
- tf
Time constant (TF) (>= 0).
- vrmax
Limiter (VRMAX) (> ExcOEX3T.vrmin).
- vrmin
Limiter (VRMIN) (< ExcOEX3T.vrmax).
-
final
case class
ExcPIC(ExcitationSystemDynamics: ExcitationSystemDynamics = null, e1: Double = 0.0, e2: Double = 0.0, efdmax: Double = 0.0, efdmin: Double = 0.0, ka: Double = 0.0, kc: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, ki: Double = 0.0, kp: Double = 0.0, se1: Double = 0.0, se2: Double = 0.0, ta1: Double = 0.0, ta2: Double = 0.0, ta3: Double = 0.0, ta4: Double = 0.0, te: Double = 0.0, tf1: Double = 0.0, tf2: Double = 0.0, vr1: Double = 0.0, vr2: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
Proportional/integral regulator excitation system.
Proportional/integral regulator excitation system.
This model can be used to represent excitation systems with a proportional-integral (PI) voltage regulator controller.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- e1
Field voltage value 1 (E1). Typical value = 0.
- e2
Field voltage value 2 (E2). Typical value = 0.
- efdmax
Exciter maximum limit (Efdmax) (> ExcPIC.efdmin). Typical value = 8.
- efdmin
Exciter minimum limit (Efdmin) (< ExcPIC.efdmax). Typical value = -0,87.
- ka
PI controller gain (Ka). Typical value = 3,15.
- kc
Exciter regulation factor (Kc). Typical value = 0,08.
- ke
Exciter constant (Ke). Typical value = 0.
- kf
Rate feedback gain (Kf). Typical value = 0.
- ki
Current source gain (Ki). Typical value = 0.
- kp
Potential source gain (Kp). Typical value = 6,5.
- se1
Saturation factor at E1 (Se1). Typical value = 0.
- se2
Saturation factor at E2 (Se2). Typical value = 0.
- ta1
PI controller time constant (Ta1) (>= 0). Typical value = 1.
- ta2
Voltage regulator time constant (Ta2) (>= 0). Typical value = 0,01.
- ta3
Lead time constant (Ta3) (>= 0). Typical value = 0.
- ta4
Lag time constant (Ta4) (>= 0). Typical value = 0.
- te
Exciter time constant (Te) (>= 0). Typical value = 0.
- tf1
Rate feedback time constant (Tf1) (>= 0). Typical value = 0.
- tf2
Rate feedback lag time constant (Tf2) (>= 0). Typical value = 0.
- vr1
PI maximum limit (Vr1). Typical value = 1.
- vr2
PI minimum limit (Vr2). Typical value = -0,87.
- vrmax
Voltage regulator maximum limit (Vrmax) (> ExcPIC.vrmin). Typical value = 1.
- vrmin
Voltage regulator minimum limit (Vrmin) (< ExcPIC.vrmax). Typical value = -0,87.
-
final
case class
ExcREXS(ExcitationSystemDynamics: ExcitationSystemDynamics = null, e1: Double = 0.0, e2: Double = 0.0, fbf: String = null, flimf: Double = 0.0, kc: Double = 0.0, kd: Double = 0.0, ke: Double = 0.0, kefd: Double = 0.0, kf: Double = 0.0, kh: Double = 0.0, kii: Double = 0.0, kip: Double = 0.0, ks: Double = 0.0, kvi: Double = 0.0, kvp: Double = 0.0, kvphz: Double = 0.0, nvphz: Double = 0.0, se1: Double = 0.0, se2: Double = 0.0, ta: Double = 0.0, tb1: Double = 0.0, tb2: Double = 0.0, tc1: Double = 0.0, tc2: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, tf1: Double = 0.0, tf2: Double = 0.0, tp: Double = 0.0, vcmax: Double = 0.0, vfmax: Double = 0.0, vfmin: Double = 0.0, vimax: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0, xc: Double = 0.0) extends Element with Product with Serializable
General purpose rotating excitation system.
General purpose rotating excitation system.
This model can be used to represent a wide range of excitation systems whose DC power source is an AC or DC generator. It encompasses IEEE type AC1, AC2, DC1, and DC2 excitation system models.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- e1
Field voltage value 1 (E1). Typical value = 3.
- e2
Field voltage value 2 (E2). Typical value = 4.
- fbf
Rate feedback signal flag (fbf). Typical value = fieldCurrent.
- flimf
Limit type flag (Flimf). Typical value = 0.
- kc
Rectifier regulation factor (Kc). Typical value = 0,05.
- kd
Exciter regulation factor (Kd). Typical value = 2.
- ke
Exciter field proportional constant (Ke). Typical value = 1.
- kefd
Field voltage feedback gain (Kefd). Typical value = 0.
- kf
Rate feedback gain (Kf) (>= 0). Typical value = 0,05.
- kh
Field voltage controller feedback gain (Kh). Typical value = 0.
- kii
Field current regulator integral gain (Kii). Typical value = 0.
- kip
Field current regulator proportional gain (Kip). Typical value = 1.
- ks
Coefficient to allow different usage of the model-speed coefficient (Ks). Typical value = 0.
- kvi
Voltage regulator integral gain (Kvi). Typical value = 0.
- kvp
Voltage regulator proportional gain (Kvp). Typical value = 2800.
- kvphz
V/Hz limiter gain (Kvphz). Typical value = 0.
- nvphz
Pickup speed of V/Hz limiter (Nvphz). Typical value = 0.
- se1
Saturation factor at E1 (Se1). Typical value = 0,0001.
- se2
Saturation factor at E2 (Se2). Typical value = 0,001.
- ta
Voltage regulator time constant (Ta) (>= 0). If = 0, block is bypassed. Typical value = 0,01.
- tb1
Lag time constant (Tb1) (>= 0). If = 0, block is bypassed. Typical value = 0.
- tb2
Lag time constant (Tb2) (>= 0). If = 0, block is bypassed. Typical value = 0.
- tc1
Lead time constant (Tc1) (>= 0). Typical value = 0.
- tc2
Lead time constant (Tc2) (>= 0). Typical value = 0.
- te
Exciter field time constant (Te) (> 0). Typical value = 1,2.
- tf
Rate feedback time constant (Tf) (>= 0). If = 0, the feedback path is not used. Typical value = 1.
- tf1
Feedback lead time constant (Tf1) (>= 0). Typical value = 0.
- tf2
Feedback lag time constant (Tf2) (>= 0). If = 0, block is bypassed. Typical value = 0.
- tp
Field current bridge time constant (Tp) (>= 0). Typical value = 0.
- vcmax
Maximum compounding voltage (Vcmax). Typical value = 0.
- vfmax
Maximum exciter field current (Vfmax) (> ExcREXS.vfmin). Typical value = 47.
- vfmin
Minimum exciter field current (Vfmin) (< ExcREXS.vfmax). Typical value = -20.
- vimax
Voltage regulator input limit (Vimax). Typical value = 0,1.
- vrmax
Maximum controller output (Vrmax) (> ExcREXS.vrmin). Typical value = 47.
- vrmin
Minimum controller output (Vrmin) (< ExcREXS.vrmax). Typical value = -20.
- xc
Exciter compounding reactance (Xc). Typical value = 0.
-
final
case class
ExcRQB(ExcitationSystemDynamics: ExcitationSystemDynamics = null, ki0: Double = 0.0, ki1: Double = 0.0, klir: Double = 0.0, klus: Double = 0.0, lsat: Double = 0.0, lus: Double = 0.0, mesu: Double = 0.0, t4m: Double = 0.0, tc: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, ucmax: Double = 0.0, ucmin: Double = 0.0) extends Element with Product with Serializable
Excitation system type RQB (four-loop regulator, r?gulateur quatre boucles, developed in France) primarily used in nuclear or thermal generating units.
Excitation system type RQB (four-loop regulator, r?gulateur quatre boucles, developed in France) primarily used in nuclear or thermal generating units.
This excitation system shall be always used together with power system stabilizer type PssRQB.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- ki0
Voltage reference input gain (Ki0). Typical value = 12,7.
- ki1
Voltage input gain (Ki1). Typical value = -16,8.
- klir
OEL input gain (KLIR). Typical value = 12,13.
- klus
Limiter gain (KLUS). Typical value = 50.
- lsat
Integrator limiter (LSAT). Typical value = 5,73.
- lus
Setpoint (LUS). Typical value = 0,12.
- mesu
Voltage input time constant (MESU) (>= 0). Typical value = 0,02.
- t4m
Input time constant (T4M) (>= 0). Typical value = 5.
- tc
Lead lag time constant (TC) (>= 0). Typical value = 0,02.
- te
Lead lag time constant (TE) (>= 0). Typical value = 0,22.
- tf
Exciter time constant (TF) (>= 0). Typical value = 0,01.
- ucmax
Maximum voltage reference limit (UCMAX) (> ExcRQB.ucmin). Typical value = 1,1.
- ucmin
Minimum voltage reference limit (UCMIN) (< ExcRQB.ucmax). Typical value = 0,9.
-
final
case class
ExcSCRX(ExcitationSystemDynamics: ExcitationSystemDynamics = null, cswitch: Boolean = false, emax: Double = 0.0, emin: Double = 0.0, k: Double = 0.0, rcrfd: Double = 0.0, tatb: Double = 0.0, tb: Double = 0.0, te: Double = 0.0) extends Element with Product with Serializable
Simple excitation system with generic characteristics typical of many excitation systems; intended for use where negative field current could be a problem.
Simple excitation system with generic characteristics typical of many excitation systems; intended for use where negative field current could be a problem.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- cswitch
Power source switch (Cswitch). true = fixed voltage of 1.0 PU false = generator terminal voltage.
- emax
Maximum field voltage output (Emax) (> ExcSCRX.emin). Typical value = 5.
- emin
Minimum field voltage output (Emin) (< ExcSCRX.emax). Typical value = 0.
- k
Gain (K) (> 0). Typical value = 200.
- rcrfd
Ratio of field discharge resistance to field winding resistance ([rc / rfd]). Typical value = 0.
- tatb
Gain reduction ratio of lag-lead element ([Ta / Tb]). The parameter Ta is not defined explicitly. Typical value = 0.1.
- tb
Denominator time constant of lag-lead block (Tb) (>= 0). Typical value = 10.
- te
Time constant of gain block (Te) (> 0). Typical value = 0,02.
-
final
case class
ExcSEXS(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efdmax: Double = 0.0, efdmin: Double = 0.0, emax: Double = 0.0, emin: Double = 0.0, k: Double = 0.0, kc: Double = 0.0, tatb: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, te: Double = 0.0) extends Element with Product with Serializable
Simplified excitation system.
Simplified excitation system.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- efdmax
Field voltage clipping maximum limit (Efdmax) (> ExcSEXS.efdmin). Typical value = 5.
- efdmin
Field voltage clipping minimum limit (Efdmin) (< ExcSEXS.efdmax). Typical value = -5.
- emax
Maximum field voltage output (Emax) (> ExcSEXS.emin). Typical value = 5.
- emin
Minimum field voltage output (Emin) (< ExcSEXS.emax). Typical value = -5.
- k
Gain (K) (> 0). Typical value = 100.
- kc
PI controller gain (Kc) (> 0 if ExcSEXS.tc > 0). Typical value = 0,08.
- tatb
Gain reduction ratio of lag-lead element ([Ta / Tb]). Typical value = 0,1.
- tb
Denominator time constant of lag-lead block (Tb) (>= 0). Typical value = 10.
- tc
PI controller phase lead time constant (Tc) (>= 0). Typical value = 0.
- te
Time constant of gain block (Te) (> 0). Typical value = 0,05.
-
final
case class
ExcSK(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efdmax: Double = 0.0, efdmin: Double = 0.0, emax: Double = 0.0, emin: Double = 0.0, k: Double = 0.0, k1: Double = 0.0, k2: Double = 0.0, kc: Double = 0.0, kce: Double = 0.0, kd: Double = 0.0, kgob: Double = 0.0, kp: Double = 0.0, kqi: Double = 0.0, kqob: Double = 0.0, kqp: Double = 0.0, nq: Double = 0.0, qconoff: Boolean = false, qz: Double = 0.0, remote: Boolean = false, sbase: Double = 0.0, tc: Double = 0.0, te: Double = 0.0, ti: Double = 0.0, tp: Double = 0.0, tr: Double = 0.0, uimax: Double = 0.0, uimin: Double = 0.0, urmax: Double = 0.0, urmin: Double = 0.0, vtmax: Double = 0.0, vtmin: Double = 0.0, yp: Double = 0.0) extends Element with Product with Serializable
Slovakian excitation system.
Slovakian excitation system.
UEL and secondary voltage control are included in this model. When this model is used, there cannot be a separate underexcitation limiter or VAr controller model.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- efdmax
Field voltage clipping upper level limit (Efdmax) (> ExcSK.efdmin).
- efdmin
Field voltage clipping lower level limit (Efdmin) (< ExcSK.efdmax).
- emax
Maximum field voltage output (Emax) (> ExcSK.emin). Typical value = 20.
- emin
Minimum field voltage output (Emin) (< ExcSK.emax). Typical value = -20.
- k
Gain (K). Typical value = 1.
- k1
Parameter of underexcitation limit (K1). Typical value = 0,1364.
- k2
Parameter of underexcitation limit (K2). Typical value = -0,3861.
- kc
PI controller gain (Kc). Typical value = 70.
- kce
Rectifier regulation factor (Kce). Typical value = 0.
- kd
Exciter internal reactance (Kd). Typical value = 0.
- kgob
P controller gain (Kgob). Typical value = 10.
- kp
PI controller gain (Kp). Typical value = 1.
- kqi
PI controller gain of integral component (Kqi). Typical value = 0.
- kqob
Rate of rise of the reactive power (Kqob).
- kqp
PI controller gain (Kqp). Typical value = 0.
- nq
Deadband of reactive power (nq). Determines the range of sensitivity. Typical value = 0,001.
- qconoff
Secondary voltage control state (Qc_on_off). true = secondary voltage control is on false = secondary voltage control is off. Typical value = false.
- qz
Desired value (setpoint) of reactive power, manual setting (Qz).
- remote
Selector to apply automatic calculation in secondary controller model (remote). true = automatic calculation is activated false = manual set is active; the use of desired value of reactive power (Qz) is required. Typical value = true.
- sbase
Apparent power of the unit (Sbase) (> 0). Unit = MVA. Typical value = 259.
- tc
PI controller phase lead time constant (Tc) (>= 0). Typical value = 8.
- te
Time constant of gain block (Te) (>= 0). Typical value = 0,1.
- ti
PI controller phase lead time constant (Ti) (>= 0). Typical value = 2.
- tp
Time constant (Tp) (>= 0). Typical value = 0,1.
- tr
Voltage transducer time constant (Tr) (>= 0). Typical value = 0,01.
- uimax
Maximum error (UImax) (> ExcSK.uimin). Typical value = 10.
- uimin
Minimum error (UImin) (< ExcSK.uimax). Typical value = -10.
- urmax
Maximum controller output (URmax) (> ExcSK.urmin). Typical value = 10.
- urmin
Minimum controller output (URmin) (< ExcSK.urmax). Typical value = -10.
- vtmax
Maximum terminal voltage input (Vtmax) (> ExcSK.vtmin). Determines the range of voltage deadband. Typical value = 1,05.
- vtmin
Minimum terminal voltage input (Vtmin) (< ExcSK.vtmax). Determines the range of voltage deadband. Typical value = 0,95.
- yp
Maximum output (Yp). Typical value = 1.
-
final
case class
ExcST1A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, ilr: Double = 0.0, ka: Double = 0.0, kc: Double = 0.0, kf: Double = 0.0, klr: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tb1: Double = 0.0, tc: Double = 0.0, tc1: Double = 0.0, tf: Double = 0.0, vamax: Double = 0.0, vamin: Double = 0.0, vimax: Double = 0.0, vimin: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0, xe: Double = 0.0) extends Element with Product with Serializable
Modification of an old IEEE ST1A static excitation system without overexcitation limiter (OEL) and underexcitation limiter (UEL).
Modification of an old IEEE ST1A static excitation system without overexcitation limiter (OEL) and underexcitation limiter (UEL).
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- ilr
Exciter output current limit reference (Ilr). Typical value = 0.
- ka
Voltage regulator gain (Ka) (> 0). Typical value = 190.
- kc
Rectifier loading factor proportional to commutating reactance (Kc) (>= 0). Typical value = 0,05.
- kf
Excitation control system stabilizer gains (Kf) (>= 0). Typical value = 0.
- klr
Exciter output current limiter gain (Klr). Typical value = 0.
- ta
Voltage regulator time constant (Ta) (>= 0). Typical value = 0,02.
- tb
Voltage regulator time constant (Tb) (>= 0). Typical value = 10.
- tb1
Voltage regulator time constant (Tb1) (>= 0). Typical value = 0.
- tc
Voltage regulator time constant (Tc) (>= 0). Typical value = 1.
- tc1
Voltage regulator time constant (Tc1) (>= 0). Typical value = 0.
- tf
Excitation control system stabilizer time constant (Tf) (>= 0). Typical value = 1.
- vamax
Maximum voltage regulator output (Vamax) (> 0). Typical value = 999.
- vamin
Minimum voltage regulator output (Vamin) (< 0). Typical value = -999.
- vimax
Maximum voltage regulator input limit (Vimax) (> 0). Typical value = 999.
- vimin
Minimum voltage regulator input limit (Vimin) (< 0). Typical value = -999.
- vrmax
Maximum voltage regulator outputs (Vrmax) (> 0) . Typical value = 7,8.
- vrmin
Minimum voltage regulator outputs (Vrmin) (< 0). Typical value = -6,7.
- xe
Excitation xfmr effective reactance (Xe). Typical value = 0,04.
-
final
case class
ExcST2A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efdmax: Double = 0.0, ka: Double = 0.0, kc: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, ki: Double = 0.0, kp: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, uelin: Boolean = false, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
Modified IEEE ST2A static excitation system with another lead-lag block added to match the model defined by WECC.
Modified IEEE ST2A static excitation system with another lead-lag block added to match the model defined by WECC.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- efdmax
Maximum field voltage (Efdmax) (>= 0). Typical value = 99.
- ka
Voltage regulator gain (Ka) (> 0). Typical value = 120.
- kc
Rectifier loading factor proportional to commutating reactance (Kc) (>= 0). Typical value = 1,82.
- ke
Exciter constant related to self-excited field (Ke). Typical value = 1.
- kf
Excitation control system stabilizer gains (kf) (>= 0). Typical value = 0,05.
- ki
Potential circuit gain coefficient (Ki) (>= 0). Typical value = 8.
- kp
Potential circuit gain coefficient (Kp) (>= 0). Typical value = 4,88.
- ta
Voltage regulator time constant (Ta) (> 0). Typical value = 0,15.
- tb
Voltage regulator time constant (Tb) (>= 0). Typical value = 0.
- tc
Voltage regulator time constant (Tc) (>= 0). Typical value = 0.
- te
Exciter time constant, integration rate associated with exciter control (Te) (> 0). Typical value = 0,5.
- tf
Excitation control system stabilizer time constant (Tf) (>= 0). Typical value = 0,7.
- uelin
UEL input (UELin). true = HV gate false = add to error signal. Typical value = false.
- vrmax
Maximum voltage regulator outputs (Vrmax) (> 0). Typical value = 1.
- vrmin
Minimum voltage regulator outputs (Vrmin) (< 0). Typical value = -1.
-
final
case class
ExcST3A(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efdmax: Double = 0.0, kc: Double = 0.0, kg: Double = 0.0, ki: Double = 0.0, kj: Double = 0.0, km: Double = 0.0, kp: Double = 0.0, ks: Double = 0.0, ks1: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, thetap: Double = 0.0, tm: Double = 0.0, vbmax: Double = 0.0, vgmax: Double = 0.0, vimax: Double = 0.0, vimin: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0, xl: Double = 0.0) extends Element with Product with Serializable
Modified IEEE ST3A static excitation system with added speed multiplier.
Modified IEEE ST3A static excitation system with added speed multiplier.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- efdmax
Maximum AVR output (Efdmax) (>= 0). Typical value = 6,9.
- kc
Rectifier loading factor proportional to commutating reactance (Kc) (>= 0). Typical value = 1,1.
- kg
Feedback gain constant of the inner loop field regulator (Kg) (>= 0). Typical value = 1.
- ki
Potential circuit gain coefficient (Ki) (>= 0). Typical value = 4,83.
- kj
AVR gain (Kj) (> 0). Typical value = 200.
- km
Forward gain constant of the inner loop field regulator (Km) (> 0). Typical value = 7,04.
- kp
Potential source gain (Kp) (> 0). Typical value = 4,37.
- ks
Coefficient to allow different usage of the model-speed coefficient (Ks). Typical value = 0.
- ks1
Coefficient to allow different usage of the model-speed coefficient (Ks1). Typical value = 0.
- tb
Voltage regulator time constant (Tb) (>= 0). Typical value = 6,67.
- tc
Voltage regulator time constant (Tc) (>= 0). Typical value = 1.
- thetap
Potential circuit phase angle (thetap). Typical value = 20.
- tm
Forward time constant of inner loop field regulator (Tm) (> 0). Typical value = 1.
- vbmax
Maximum excitation voltage (Vbmax) (> 0). Typical value = 8,63.
- vgmax
Maximum inner loop feedback voltage (Vgmax) (>= 0). Typical value = 6,53.
- vimax
Maximum voltage regulator input limit (Vimax) (> 0). Typical value = 0,2.
- vimin
Minimum voltage regulator input limit (Vimin) (< 0). Typical value = -0,2.
- vrmax
Maximum voltage regulator output (Vrmax) (> 0). Typical value = 1.
- vrmin
Minimum voltage regulator output (Vrmin) (< 0). Typical value = -1.
- xl
Reactance associated with potential source (Xl) (>= 0). Typical value = 0,09.
-
final
case class
ExcST4B(ExcitationSystemDynamics: ExcitationSystemDynamics = null, kc: Double = 0.0, kg: Double = 0.0, ki: Double = 0.0, kim: Double = 0.0, kir: Double = 0.0, kp: Double = 0.0, kpm: Double = 0.0, kpr: Double = 0.0, lvgate: Boolean = false, ta: Double = 0.0, thetap: Double = 0.0, uel: Boolean = false, vbmax: Double = 0.0, vgmax: Double = 0.0, vmmax: Double = 0.0, vmmin: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0, xl: Double = 0.0) extends Element with Product with Serializable
Modified IEEE ST4B static excitation system with maximum inner loop feedback gain Vgmax.
Modified IEEE ST4B static excitation system with maximum inner loop feedback gain Vgmax.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- kc
Rectifier loading factor proportional to commutating reactance (Kc) (>= 0). Typical value = 0,113.
- kg
Feedback gain constant of the inner loop field regulator (Kg) (>= 0). Typical value = 0.
- ki
Potential circuit gain coefficient (Ki) (>= 0). Typical value = 0.
- kim
Voltage regulator integral gain output (Kim). Typical value = 0.
- kir
Voltage regulator integral gain (Kir). Typical value = 10,75.
- kp
Potential circuit gain coefficient (Kp) (> 0). Typical value = 9,3.
- kpm
Voltage regulator proportional gain output (Kpm). Typical value = 1.
- kpr
Voltage regulator proportional gain (Kpr). Typical value = 10,75.
- lvgate
Selector (LVGate). true = LVGate is part of the block diagram false = LVGate is not part of the block diagram. Typical value = false.
- ta
Voltage regulator time constant (Ta) (>= 0). Typical value = 0,02.
- thetap
Potential circuit phase angle (thetap). Typical value = 0.
- uel
Selector (UEL). true = UEL is part of block diagram false = UEL is not part of block diagram. Typical value = false.
- vbmax
Maximum excitation voltage (Vbmax) (> 0). Typical value = 11,63.
- vgmax
Maximum inner loop feedback voltage (Vgmax) (>= 0). Typical value = 5,8.
- vmmax
Maximum inner loop output (Vmmax) (> ExcST4B.vmmin). Typical value = 99.
- vmmin
Minimum inner loop output (Vmmin) (< ExcST4B.vmmax). Typical value = -99.
- vrmax
Maximum voltage regulator output (Vrmax) (> 0). Typical value = 1.
- vrmin
Minimum voltage regulator output (Vrmin) (< 0). Typical value = -0,87.
- xl
Reactance associated with potential source (Xl) (>= 0). Typical value = 0,124.
-
final
case class
ExcST6B(ExcitationSystemDynamics: ExcitationSystemDynamics = null, ilr: Double = 0.0, k1: Boolean = false, kcl: Double = 0.0, kff: Double = 0.0, kg: Double = 0.0, kia: Double = 0.0, klr: Double = 0.0, km: Double = 0.0, kpa: Double = 0.0, kvd: Double = 0.0, oelin: String = null, tg: Double = 0.0, ts: Double = 0.0, tvd: Double = 0.0, vamax: Double = 0.0, vamin: Double = 0.0, vilim: Boolean = false, vimax: Double = 0.0, vimin: Double = 0.0, vmult: Boolean = false, vrmax: Double = 0.0, vrmin: Double = 0.0, xc: Double = 0.0) extends Element with Product with Serializable
Modified IEEE ST6B static excitation system with PID controller and optional inner feedback loop.
Modified IEEE ST6B static excitation system with PID controller and optional inner feedback loop.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- ilr
Exciter output current limit reference (Ilr) (> 0). Typical value = 4,164.
- k1
Selector (K1). true = feedback is from Ifd false = feedback is not from Ifd. Typical value = true.
- kcl
Exciter output current limit adjustment (Kcl) (> 0). Typical value = 1,0577.
- kff
Pre-control gain constant of the inner loop field regulator (Kff). Typical value = 1.
- kg
Feedback gain constant of the inner loop field regulator (Kg) (>= 0). Typical value = 1.
- kia
Voltage regulator integral gain (Kia) (> 0). Typical value = 45,094.
- klr
Exciter output current limit adjustment (Kcl) (> 0). Typical value = 17,33.
- km
Forward gain constant of the inner loop field regulator (Km). Typical value = 1.
- kpa
Voltage regulator proportional gain (Kpa) (> 0). Typical value = 18,038.
- kvd
Voltage regulator derivative gain (Kvd). Typical value = 0.
- oelin
OEL input selector (OELin). Typical value = noOELinput (corresponds to OELin = 0 on diagram).
- tg
Feedback time constant of inner loop field voltage regulator (Tg) (>= 0). Typical value = 0,02.
- ts
Rectifier firing time constant (Ts) (>= 0). Typical value = 0.
- tvd
Voltage regulator derivative gain (Tvd) (>= 0). Typical value = 0.
- vamax
Maximum voltage regulator output (Vamax) (> 0). Typical value = 4,81.
- vamin
Minimum voltage regulator output (Vamin) (< 0). Typical value = -3,85.
- vilim
Selector (Vilim). true = Vimin-Vimax limiter is active false = Vimin-Vimax limiter is not active. Typical value = true.
- vimax
Maximum voltage regulator input limit (Vimax) (> ExcST6B.vimin). Typical value = 10.
- vimin
Minimum voltage regulator input limit (Vimin) (< ExcST6B.vimax). Typical value = -10.
- vmult
Selector (vmult). true = multiply regulator output by terminal voltage false = do not multiply regulator output by terminal voltage. Typical value = true.
- vrmax
Maximum voltage regulator output (Vrmax) (> 0). Typical value = 4,81.
- vrmin
Minimum voltage regulator output (Vrmin) (< 0). Typical value = -3,85.
- xc
Excitation source reactance (Xc). Typical value = 0,05.
-
final
case class
ExcST7B(ExcitationSystemDynamics: ExcitationSystemDynamics = null, kh: Double = 0.0, kia: Double = 0.0, kl: Double = 0.0, kpa: Double = 0.0, oelin: String = null, tb: Double = 0.0, tc: Double = 0.0, tf: Double = 0.0, tg: Double = 0.0, tia: Double = 0.0, ts: Double = 0.0, uelin: String = null, vmax: Double = 0.0, vmin: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
Modified IEEE ST7B static excitation system without stator current limiter (SCL) and current compensator (DROOP) inputs.
Modified IEEE ST7B static excitation system without stator current limiter (SCL) and current compensator (DROOP) inputs.
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- kh
High-value gate feedback gain (Kh) (>= 0). Typical value = 1.
- kia
Voltage regulator integral gain (Kia) (>= 0). Typical value = 1.
- kl
Low-value gate feedback gain (Kl) (>= 0). Typical value = 1.
- kpa
Voltage regulator proportional gain (Kpa) (> 0). Typical value = 40.
- oelin
OEL input selector (OELin). Typical value = noOELinput.
- tb
Regulator lag time constant (Tb) (>= 0). Typical value = 1.
- tc
Regulator lead time constant (Tc) (>= 0). Typical value = 1.
- tf
Excitation control system stabilizer time constant (Tf) (>= 0). Typical value = 1.
- tg
Feedback time constant of inner loop field voltage regulator (Tg) (>= 0). Typical value = 1.
- tia
Feedback time constant (Tia) (>= 0). Typical value = 3.
- ts
Rectifier firing time constant (Ts) (>= 0). Typical value = 0.
- uelin
UEL input selector (UELin). Typical value = noUELinput.
- vmax
Maximum voltage reference signal (Vmax) (> 0 and > ExcST7B.vmin)). Typical value = 1,1.
- vmin
Minimum voltage reference signal (Vmin) (> 0 and < ExcST7B.vmax). Typical value = 0,9.
- vrmax
Maximum voltage regulator output (Vrmax) (> 0). Typical value = 5.
- vrmin
Minimum voltage regulator output (Vrmin) (< 0). Typical value = -4,5.
-
final
case class
ExcitationSystemDynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null, DiscontinuousExcitationControlDynamics: String = null, OverexcitationLimiterDynamics: String = null, PFVArControllerType1Dynamics: String = null, PFVArControllerType2Dynamics: String = null, PowerSystemStabilizerDynamics: String = null, SynchronousMachineDynamics: String = null, UnderexcitationLimiterDynamics: String = null, VoltageCompensatorDynamics: String = null) extends Element with Product with Serializable
Excitation system function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
Excitation system function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- DiscontinuousExcitationControlDynamics
DiscontinuousExcitationControlDynamics Discontinuous excitation control model associated with this excitation system model.
- OverexcitationLimiterDynamics
OverexcitationLimiterDynamics Overexcitation limiter model associated with this excitation system model.
- PFVArControllerType1Dynamics
PFVArControllerType1Dynamics Power factor or VAr controller type 1 model associated with this excitation system model.
- PFVArControllerType2Dynamics
PFVArControllerType2Dynamics Power factor or VAr controller type 2 model associated with this excitation system model.
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Power system stabilizer model associated with this excitation system model.
- SynchronousMachineDynamics
SynchronousMachineDynamics Synchronous machine model with which this excitation system model is associated.
- UnderexcitationLimiterDynamics
UnderexcitationLimiterDynamics Undrexcitation limiter model associated with this excitation system model.
- VoltageCompensatorDynamics
VoltageCompensatorDynamics Voltage compensator model associated with this excitation system model.
-
final
case class
ExcitationSystemUserDefined(ExcitationSystemDynamics: ExcitationSystemDynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Excitation system function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
Excitation system function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
- ExcitationSystemDynamics
ExcitationSystemDynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
ExpectedEnergy(Element: BasicElement = null, intervalStartTime: String = null, updateTimeStamp: String = null, updateUser: String = null, ExpectedEnergyValues: List[String] = null) extends Element with Product with Serializable
Model Expected Energy from Market Clearing, interval based.
Model Expected Energy from Market Clearing, interval based.
- Element
Reference to the superclass object.
- intervalStartTime
undocumented
- updateTimeStamp
undocumented
- updateUser
undocumented
- ExpectedEnergyValues
ExpectedEnergyValues undocumented
-
final
case class
ExpectedEnergyValues(Element: BasicElement = null, energyTypeCode: String = null, expectedMwh: Double = 0.0, ExpectedEnergy: String = null, RegisteredResource: String = null) extends Element with Product with Serializable
Model Expected Energy from Market Clearing.
Model Expected Energy from Market Clearing.
- Element
Reference to the superclass object.
- energyTypeCode
undocumented
- expectedMwh
undocumented
- ExpectedEnergy
ExpectedEnergy undocumented
- RegisteredResource
RegisteredResource undocumented
- final case class ExtensionItem(Element: BasicElement = null, extName: String = null, extType: String = null, extValue: String = null) extends Element with Product with Serializable
- final case class ExtensionsList(Element: BasicElement = null, extensionsItem: String = null) extends Element with Product with Serializable
-
final
case class
ExternalCustomerAgreement(Agreement: Agreement = null) extends Element with Product with Serializable
A type of customer agreement involving an external agency.
A type of customer agreement involving an external agency.
For example, a customer may form a contracts with an Energy Service Supplier if Direct Access is permitted.
- Agreement
Agreement Reference to the superclass object.
-
final
case class
ExternalNetworkInjection(RegulatingCondEq: RegulatingCondEq = null, governorSCD: Double = 0.0, ikSecond: Boolean = false, maxInitialSymShCCurrent: Double = 0.0, maxP: Double = 0.0, maxQ: Double = 0.0, maxR0ToX0Ratio: Double = 0.0, maxR1ToX1Ratio: Double = 0.0, maxZ0ToZ1Ratio: Double = 0.0, minInitialSymShCCurrent: Double = 0.0, minP: Double = 0.0, minQ: Double = 0.0, minR0ToX0Ratio: Double = 0.0, minR1ToX1Ratio: Double = 0.0, minZ0ToZ1Ratio: Double = 0.0, p: Double = 0.0, q: Double = 0.0, referencePriority: Int = 0, voltageFactor: Double = 0.0) extends Element with Product with Serializable
This class represents the external network and it is used for IEC 60909 calculations.
This class represents the external network and it is used for IEC 60909 calculations.
- RegulatingCondEq
RegulatingCondEq Reference to the superclass object.
- governorSCD
Power Frequency Bias. This is the change in power injection divided by the change in frequency and negated. A positive value of the power frequency bias provides additional power injection upon a drop in frequency.
- ikSecond
Indicates whether initial symmetrical short-circuit current and power have been calculated according to IEC (Ik"). Used only if short circuit calculations are done according to superposition method.
- maxInitialSymShCCurrent
Maximum initial symmetrical short-circuit currents (Ik" max) in A (Ik" = Sk"/(SQRT(3) Un)). Used for short circuit data exchange according to IEC 60909.
- maxP
Maximum active power of the injection.
- maxQ
Maximum reactive power limit. It is used for modelling of infeed for load flow exchange and not for short circuit modelling.
- maxR0ToX0Ratio
Maximum ratio of zero sequence resistance of Network Feeder to its zero sequence reactance (R(0)/X(0) max). Used for short circuit data exchange according to IEC 60909.
- maxR1ToX1Ratio
Maximum ratio of positive sequence resistance of Network Feeder to its positive sequence reactance (R(1)/X(1) max). Used for short circuit data exchange according to IEC 60909.
- maxZ0ToZ1Ratio
Maximum ratio of zero sequence impedance to its positive sequence impedance (Z(0)/Z(1) max). Used for short circuit data exchange according to IEC 60909.
- minInitialSymShCCurrent
Minimum initial symmetrical short-circuit currents (Ik" min) in A (Ik" = Sk"/(SQRT(3) Un)). Used for short circuit data exchange according to IEC 60909.
- minP
Minimum active power of the injection.
- minQ
Minimum reactive power limit. It is used for modelling of infeed for load flow exchange and not for short circuit modelling.
- minR0ToX0Ratio
Indicates whether initial symmetrical short-circuit current and power have been calculated according to IEC (Ik"). Used for short circuit data exchange according to IEC 6090.
- minR1ToX1Ratio
Minimum ratio of positive sequence resistance of Network Feeder to its positive sequence reactance (R(1)/X(1) min). Used for short circuit data exchange according to IEC 60909.
- minZ0ToZ1Ratio
Minimum ratio of zero sequence impedance to its positive sequence impedance (Z(0)/Z(1) min). Used for short circuit data exchange according to IEC 60909.
- p
Active power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for steady state solutions.
- q
Reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for steady state solutions.
- referencePriority
Priority of unit for use as powerflow voltage phase angle reference bus selection. 0 = don t care (default) 1 = highest priority. 2 is less than 1 and so on.
- voltageFactor
Voltage factor in pu, which was used to calculate short-circuit current Ik" and power Sk". Used only if short circuit calculations are done according to superposition method.
-
final
case class
FACTSDevice(Asset: Asset = null, kind: String = null) extends Element with Product with Serializable
FACTS device asset.
FACTS device asset.
- Asset
Asset Reference to the superclass object.
- kind
Kind of FACTS device.
-
final
case class
FTR(Agreement: Agreement = null, action: String = null, baseEnergy: Double = 0.0, class: String = null, ftrType: String = null, optimized: String = null, EnergyPriceCurve: String = null, Flowgate: String = null, Pnodes: List[String] = null) extends Element with Product with Serializable
Financial Transmission Rights (FTR) regarding transmission capacity at a flowgate.
Financial Transmission Rights (FTR) regarding transmission capacity at a flowgate.
- Agreement
Agreement Reference to the superclass object.
- action
Buy, Sell
- baseEnergy
Quantity, typically MWs - Seller owns all rights being offered, MWs over time on same Point of Receipt, Point of Delivery, or Resource.
- class
Peak, Off-peak, 24-hour
- ftrType
Type of rights being offered (product) allowed to be auctioned (option, obligation).
- optimized
Fixed (covers re-configuration, grandfathering) or Optimized (up for sale/purchase
- EnergyPriceCurve
EnergyPriceCurve undocumented
- Flowgate
Flowgate undocumented
- Pnodes
Pnode undocumented
-
final
case class
Facility(AssetContainer: AssetContainer = null, kind: String = null) extends Element with Product with Serializable
A facility may contain buildings, storage facilities, switching facilities, power generation, manufacturing facilities, maintenance facilities, etc.
A facility may contain buildings, storage facilities, switching facilities, power generation, manufacturing facilities, maintenance facilities, etc.
- AssetContainer
AssetContainer Reference to the superclass object.
- kind
Kind of this facility.
-
final
case class
FailureEvent(ActivityRecord: ActivityRecord = null, breakerFailureReason: String = null, corporateCode: String = null, failureClassification: String = null, failureDateTime: String = null, failureIsolationMethod: String = null, failureMode: String = null, faultLocatingMethod: String = null, location: String = null, rootCause: String = null, transformerFailureReason: String = null) extends Element with Product with Serializable
An event where an asset has failed to perform its functions within specified parameters.
An event where an asset has failed to perform its functions within specified parameters.
This class is intended to reflect the failure itself. Additional information resulting from forensic analysis could be captured by a diagnosis data set.
- ActivityRecord
ActivityRecord Reference to the superclass object.
- breakerFailureReason
Reason for breaker failure.
- corporateCode
Code for asset failure.
- failureClassification
Classification of failure.
- failureDateTime
Time and date of asset failure.
- failureIsolationMethod
How the asset failure was isolated from the system.
- failureMode
What asset failed to be able to do.
- faultLocatingMethod
The method used for locating the faulted part of the asset. For example, cable options include: Cap Discharge-Thumping, Bridge Method, Visual Inspection, Other.
- location
Failure location on an object.
- rootCause
Root cause of asset failure.
- transformerFailureReason
Reason for transformer failure.
-
final
case class
Fault(IdentifiedObject: IdentifiedObject = null, impedance: String = null, kind: String = null, occurredDateTime: String = null, phases: String = null, FaultCauseTypes: List[String] = null, FaultyEquipment: String = null, Location: String = null, Outage: String = null) extends Element with Product with Serializable
Abnormal condition causing current flow through conducting equipment, such as caused by equipment failure or short circuits from objects not typically modelled (for example, a tree falling on a line).
Abnormal condition causing current flow through conducting equipment, such as caused by equipment failure or short circuits from objects not typically modelled (for example, a tree falling on a line).
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- impedance
FaultImpedance Fault impedance. Its usage is described by 'kind'.
- kind
The kind of phase fault.
- occurredDateTime
The date and time at which the fault occurred.
- phases
The phases participating in the fault. The fault connections into these phases are further specified by the type of fault.
- FaultCauseTypes
FaultCauseType All types of fault cause.
- FaultyEquipment
Equipment Equipment carrying this fault.
- Location
Location undocumented
- Outage
Outage Outage associated with this fault.
-
final
case class
FaultCauseType(IdentifiedObject: IdentifiedObject = null, ConfigurationEvent: List[String] = null, Faults: List[String] = null) extends Element with Product with Serializable
Type of cause of the fault.
Type of cause of the fault.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ConfigurationEvent
ConfigurationEvent undocumented
- Faults
Fault All faults with this cause type.
-
final
case class
FaultImpedance(Element: BasicElement = null, rGround: Double = 0.0, rLineToLine: Double = 0.0, xGround: Double = 0.0, xLineToLine: Double = 0.0) extends Element with Product with Serializable
Impedance description for the fault.
Impedance description for the fault.
- Element
Reference to the superclass object.
- rGround
The resistance of the fault between phases and ground.
- rLineToLine
The resistance of the fault between phases.
- xGround
The reactance of the fault between phases and ground.
- xLineToLine
The reactance of the fault between phases.
-
final
case class
FaultIndicator(AuxiliaryEquipment: AuxiliaryEquipment = null) extends Element with Product with Serializable
A FaultIndicator is typically only an indicator (which may or may not be remotely monitored), and not a piece of equipment that actually initiates a protection event.
A FaultIndicator is typically only an indicator (which may or may not be remotely monitored), and not a piece of equipment that actually initiates a protection event.
It is used for FLISR (Fault Location, Isolation and Restoration) purposes, assisting with the dispatch of crews to "most likely" part of the network (i.e. assists with determining circuit section where the fault most likely happened).
- AuxiliaryEquipment
AuxiliaryEquipment Reference to the superclass object.
-
final
case class
FaultIndicatorInfo(AssetInfo: AssetInfo = null, resetKind: String = null) extends Element with Product with Serializable
Parameters of fault indicator asset.
Parameters of fault indicator asset.
- AssetInfo
AssetInfo Reference to the superclass object.
- resetKind
Kind of reset mechanisim of this fault indicator.
-
final
case class
Feeder(EquipmentContainer: EquipmentContainer = null, NamingSecondarySubstation: List[String] = null, NormalEnergizedSubstation: List[String] = null, NormalEnergizingSubstation: String = null, NormalHeadTerminal: List[String] = null) extends Element with Product with Serializable
A collection of equipment for organizational purposes, used for grouping distribution resources.
A collection of equipment for organizational purposes, used for grouping distribution resources.
The organization a feeder does not necessarily reflect connectivity or current operation state.
- EquipmentContainer
EquipmentContainer Reference to the superclass object.
- NamingSecondarySubstation
Substation The secondary substations that are normally energized from the feeder. Used for naming purposes. Should be consistent with the other associations for energizing terminal specification and the feeder energization specification.
- NormalEnergizedSubstation
Substation The substations that are normally energized by the feeder.
- NormalEnergizingSubstation
Substation The substation that nominally energizes the feeder. Also used for naming purposes.
- NormalHeadTerminal
Terminal The normal head terminal or terminals of the feeder.
-
final
case class
FieldDispatchHistory(IdentifiedObject: IdentifiedObject = null, Crew: String = null, FieldDispatchStep: List[String] = null, PlannedOutage: String = null, UnplannedOutage: String = null) extends Element with Product with Serializable
The history of field dispatch statuses for this work.
The history of field dispatch statuses for this work.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- Crew
Crew undocumented
- FieldDispatchStep
FieldDispatchStep undocumented
- PlannedOutage
PlannedOutage undocumented
- UnplannedOutage
UnplannedOutage undocumented
-
final
case class
FieldDispatchStep(Element: BasicElement = null, dispatchStatus: String = null, occurredDateTime: String = null, remarks: String = null, sequenceNumber: Int = 0, FieldDispatchHistory: String = null) extends Element with Product with Serializable
Details of the step in the field dispatch history.
Details of the step in the field dispatch history.
- Element
Reference to the superclass object.
- dispatchStatus
The status of one or more crews dispatched to perform field work at one or more work sites
- occurredDateTime
The date and time at which the dispatch status occurred.
- remarks
freeform comments related to the dispatch to perform field work.
- sequenceNumber
The sequence number of the field dispatch step within the field dispatch history. Begins with 1 and increments up.
- FieldDispatchHistory
FieldDispatchHistory undocumented
-
final
case class
FieldSafetySupervisor(CrewMember: CrewMember = null, IssuedSafetyDocuments: List[String] = null, ReleasedSafetyDocuments: List[String] = null) extends Element with Product with Serializable
Crew member on work site responsible for all local safety measures for the work crew doing maintenance, construction and repair in a substation or on a power line/cable.
Crew member on work site responsible for all local safety measures for the work crew doing maintenance, construction and repair in a substation or on a power line/cable.
- CrewMember
CrewMember Reference to the superclass object.
- IssuedSafetyDocuments
SafetyDocument All safety documents issued to this supervisor.
- ReleasedSafetyDocuments
SafetyDocument All safety documents released by this supervisor.
-
final
case class
FinancialInfo(IdentifiedObject: IdentifiedObject = null, account: String = null, actualPurchaseCost: Double = 0.0, costDescription: String = null, costType: String = null, financialValue: Double = 0.0, plantTransferDateTime: String = null, purchaseDateTime: String = null, purchaseOrderNumber: String = null, quantity: String = null, valueDateTime: String = null, warrantyEndDateTime: String = null, Asset: String = null) extends Element with Product with Serializable
Various current financial properties associated with a particular asset.
Various current financial properties associated with a particular asset.
Historical properties may be determined by ActivityRecords associated with the asset.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- account
The account to which this actual material item is charged.
- actualPurchaseCost
The actual purchase cost of this particular asset.
- costDescription
Description of the cost.
- costType
Type of cost to which this Material Item belongs.
- financialValue
Value of asset as of 'valueDateTime'.
- plantTransferDateTime
Date and time asset's financial value was put in plant for regulatory accounting purposes (e.g., for rate base calculations). This is sometime referred to as the "in-service date".
- purchaseDateTime
Date and time asset was purchased.
- purchaseOrderNumber
Purchase order identifier.
- quantity
The quantity of the asset if per unit length, for example conductor.
- valueDateTime
Date and time at which the financial value was last established.
- warrantyEndDateTime
Date and time warranty on asset expires.
- Asset
Asset The asset to which this financial information relates.
-
final
case class
Fire(GeosphericPhenomenon: GeosphericPhenomenon = null) extends Element with Product with Serializable
A fire, often uncontrolled, covering an area of land which typically contains combustible vegetation.
A fire, often uncontrolled, covering an area of land which typically contains combustible vegetation.
Associated location information is assumed to describe the total area burned as of a specified time.
- GeosphericPhenomenon
GeosphericPhenomenon Reference to the superclass object.
-
final
case class
FiveMinAuxiliaryData(Element: BasicElement = null, intervalStartTime: String = null, updateTimeStamp: String = null, updateUser: String = null, AuxillaryValues: List[String] = null) extends Element with Product with Serializable
Models 5-Minutes Auxiliary Data.
Models 5-Minutes Auxiliary Data.
- Element
Reference to the superclass object.
- intervalStartTime
undocumented
- updateTimeStamp
undocumented
- updateUser
undocumented
- AuxillaryValues
AuxiliaryValues undocumented
-
final
case class
FloatQuantity(Element: BasicElement = null, multiplier: String = null, unit: String = null, value: Double = 0.0) extends Element with Product with Serializable
Quantity with float value and associated unit information.
Quantity with float value and associated unit information.
- Element
Reference to the superclass object.
- multiplier
Unit multiplier of this quantity.
- unit
Unit of this quantity.
- value
Value of this quantity.
-
final
case class
Flood(HydrosphericPhenomenon: HydrosphericPhenomenon = null) extends Element with Product with Serializable
A flood, an overflowing of a large amount of water beyond its normal confines, esp.
A flood, an overflowing of a large amount of water beyond its normal confines, esp. over what is normally dry land.
- HydrosphericPhenomenon
HydrosphericPhenomenon Reference to the superclass object.
-
final
case class
FlowDirection(Element: BasicElement = null, direction: String = null, Point: List[String] = null, TimeSeries: List[String] = null) extends Element with Product with Serializable
The coded identification of the direction of energy flow.
The coded identification of the direction of energy flow.
- Element
Reference to the superclass object.
- direction
The coded identification of the direction of energy flow.
- Point
Point undocumented
- TimeSeries
TimeSeries undocumented
-
final
case class
Flowgate(PowerSystemResource: PowerSystemResource = null, direction: String = null, exportMWRating: Double = 0.0, importMWRating: Double = 0.0, CongestionRevenueRight: String = null, ConstraintResults: List[String] = null, ContractDistributionFactor: List[String] = null, FTRs: List[String] = null, FlowgateRelief: List[String] = null, FlowgateValue: List[String] = null, From_SubControlArea: String = null, GeneratingUnitDynamicValues: List[String] = null, GenericConstraints: String = null, HostControlArea: String = null, InterTie: List[String] = null, InterTieResults: List[String] = null, MktLine: List[String] = null, MktPowerTransformer: List[String] = null, MktTerminal: List[String] = null, RegisteredInterTie: List[String] = null, SecurityConstraints: String = null, To_SubControlArea: String = null, TranmissionRightEntitlement: List[String] = null, TransmissionCapacity: List[String] = null, ViolationLimits: List[String] = null) extends Element with Product with Serializable
A flowgate, is single or group of transmission elements intended to model MW flow impact relating to transmission limitations and transmission service usage.
A flowgate, is single or group of transmission elements intended to model MW flow impact relating to transmission limitations and transmission service usage.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- direction
The direction of the flowgate, export or import
- exportMWRating
Export MW rating
- importMWRating
Import MW rating
- CongestionRevenueRight
CongestionRevenueRight undocumented
- ConstraintResults
ConstraintResults undocumented
- ContractDistributionFactor
ContractDistributionFactor undocumented
- FTRs
FTR undocumented
- FlowgateRelief
FlowgateRelief undocumented
- FlowgateValue
FlowgateValue undocumented
- From_SubControlArea
SubControlArea undocumented
- GeneratingUnitDynamicValues
GeneratingUnitDynamicValues undocumented
- GenericConstraints
GenericConstraints undocumented
- HostControlArea
HostControlArea undocumented
- InterTie
SchedulingPoint undocumented
- InterTieResults
InterTieResults undocumented
- MktLine
MktLine undocumented
- MktPowerTransformer
MktPowerTransformer undocumented
- MktTerminal
MktTerminal undocumented
- RegisteredInterTie
RegisteredInterTie undocumented
- SecurityConstraints
SecurityConstraints undocumented
- To_SubControlArea
SubControlArea undocumented
- TranmissionRightEntitlement
TransmissionInterfaceRightEntitlement undocumented
- TransmissionCapacity
TransmissionCapacity undocumented
- ViolationLimits
ViolationLimit undocumented
-
final
case class
FlowgatePartner(IdentifiedObject: IdentifiedObject = null, FlowgateValue: String = null) extends Element with Product with Serializable
Flowgate defined partner.
Flowgate defined partner.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- FlowgateValue
FlowgateValue undocumented
-
final
case class
FlowgateRelief(Element: BasicElement = null, effectiveDate: String = null, idcTargetMktFlow: Int = 0, terminateDate: String = null, Flowgate: String = null) extends Element with Product with Serializable
IDC (Interchange Distribution Calulator) sends data for a TLR (Transmission Loading Relief).
IDC (Interchange Distribution Calulator) sends data for a TLR (Transmission Loading Relief).
- Element
Reference to the superclass object.
- effectiveDate
Date/Time when record becomes effective Used to determine when a record becomes effective.
- idcTargetMktFlow
Energy Flow level that should be maintained according to the TLR rules as specified by the IDC. For Realtime Markets use in dispatch to control constraints under TLR and calculate unconstrained market flows
- terminateDate
Date/Time when record is no longer effective Used to determine when a record is no longer effective
- Flowgate
Flowgate undocumented
-
final
case class
FlowgateValue(Element: BasicElement = null, economicDispatchLimit: Int = 0, effectiveDate: String = null, firmNetworkLimit: Int = 0, flowDirectionFlag: String = null, mktFlow: Int = 0, netFirmNetworkLimit: Int = 0, Flowgate: String = null, FlowgatePartner: String = null) extends Element with Product with Serializable
Day Ahead, Network Native Load, Economic Dispatch, values used for calculation of Network Native Load (NNL) Determinator process.
Day Ahead, Network Native Load, Economic Dispatch, values used for calculation of Network Native Load (NNL) Determinator process.
- Element
Reference to the superclass object.
- economicDispatchLimit
Limit for Economic Dispatch priority 6 energy flow on the specified flowgate for the specified time period.
- effectiveDate
Date/Time when record becomes effective Used to determine when a record becomes effective
- firmNetworkLimit
Limit for firm flow on the specified flowgate for the specified time period. The amount of energy flow over a specifed flowgate due to generation in the market which can be classified as Firm Network priority.
- flowDirectionFlag
Specifies the direction of energy flow in the flowgate
- mktFlow
The amount of energy flow over a specifed flowgate due to generation in the market.
- netFirmNetworkLimit
Net Energy flow in flowgate for the associated FlowgatePartner
- Flowgate
Flowgate undocumented
- FlowgatePartner
FlowgatePartner undocumented
-
final
case class
ForbiddenRegion(IdentifiedObject: IdentifiedObject = null, crossTime: Int = 0, crossingCost: Double = 0.0, highMW: Double = 0.0, lowMW: Double = 0.0, RegisteredResource: List[String] = null) extends Element with Product with Serializable
Forbbiden region is operating ranges where the units are unable to maintain steady operation without causing equipment damage.
Forbbiden region is operating ranges where the units are unable to maintain steady operation without causing equipment damage.
The four attributes that define a forbidden region are the low MW, the High MW, the crossing time, and the crossing cost.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- crossTime
Time to cross the forbidden region in minutes.
- crossingCost
Cost associated with crossing the forbidden region
- highMW
High end of the region definition
- lowMW
Low end of the region definition.
- RegisteredResource
RegisteredResource undocumented
-
final
case class
Forecast(EnvironmentalInformation: EnvironmentalInformation = null, validFor: String = null) extends Element with Product with Serializable
A forecast group of value sets and/or phenomena characteristics.
A forecast group of value sets and/or phenomena characteristics.
- EnvironmentalInformation
EnvironmentalInformation Reference to the superclass object.
- validFor
The interval for which the forecast is valid. For example, a forecast issued now for tomorrow might be valid for the next 2 hours.
-
final
case class
FormerReference(IdentifiedObject: IdentifiedObject = null, RegisteredResource: String = null) extends Element with Product with Serializable
Used to indicate former references to the same piece of equipment.
Used to indicate former references to the same piece of equipment.
The ID, name, and effectivity dates are utilized.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- RegisteredResource
RegisteredResource undocumented
-
final
case class
FossilFuel(IdentifiedObject: IdentifiedObject = null, fossilFuelType: String = null, fuelCost: Double = 0.0, fuelDispatchCost: Double = 0.0, fuelEffFactor: Double = 0.0, fuelHandlingCost: Double = 0.0, fuelHeatContent: Double = 0.0, fuelMixture: Double = 0.0, fuelSulfur: Double = 0.0, highBreakpointP: Double = 0.0, lowBreakpointP: Double = 0.0, FuelAllocationSchedules: List[String] = null, ThermalGeneratingUnit: String = null) extends Element with Product with Serializable
The fossil fuel consumed by the non-nuclear thermal generating unit.
The fossil fuel consumed by the non-nuclear thermal generating unit.
For example, coal, oil, gas, etc. These are the specific fuels that the generating unit can consume.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- fossilFuelType
The type of fossil fuel, such as coal, oil, or gas.
- fuelCost
The cost in terms of heat value for the given type of fuel.
- fuelDispatchCost
The cost of fuel used for economic dispatching which includes: fuel cost, transportation cost, and incremental maintenance cost.
- fuelEffFactor
The efficiency factor for the fuel (per unit) in terms of the effective energy absorbed.
- fuelHandlingCost
Handling and processing cost associated with this fuel.
- fuelHeatContent
The amount of heat per weight (or volume) of the given type of fuel.
- fuelMixture
Relative amount of the given type of fuel, when multiple fuels are being consumed.
- fuelSulfur
The fuel's fraction of pollution credit per unit of heat content.
- highBreakpointP
The active power output level of the unit at which the given type of fuel is switched on. This fuel (e.g., oil) is sometimes used to supplement the base fuel (e.g., coal) at high active power output levels.
- lowBreakpointP
The active power output level of the unit at which the given type of fuel is switched off. This fuel (e.g., oil) is sometimes used to stabilize the base fuel (e.g., coal) at low active power output levels.
- FuelAllocationSchedules
FuelAllocationSchedule A fuel allocation schedule shall have a fossil fuel.
- ThermalGeneratingUnit
ThermalGeneratingUnit A thermal generating unit may have one or more fossil fuels.
-
final
case class
FossilSteamSupply(SteamSupply: SteamSupply = null, auxPowerVersusFrequency: Double = 0.0, auxPowerVersusVoltage: Double = 0.0, boilerControlMode: String = null, controlErrorBiasP: Double = 0.0, controlIC: Double = 0.0, controlPC: Double = 0.0, controlPEB: Double = 0.0, controlPED: Double = 0.0, controlTC: Double = 0.0, feedWaterIG: Double = 0.0, feedWaterPG: Double = 0.0, feedWaterTC: Double = 0.0, fuelDemandLimit: Double = 0.0, fuelSupplyDelay: Double = 0.0, fuelSupplyTC: Double = 0.0, maxErrorRateP: Double = 0.0, mechPowerSensorLag: Double = 0.0, minErrorRateP: Double = 0.0, pressureCtrlDG: Double = 0.0, pressureCtrlIG: Double = 0.0, pressureCtrlPG: Double = 0.0, pressureFeedback: Int = 0, superHeater1Capacity: Double = 0.0, superHeater2Capacity: Double = 0.0, superHeaterPipePD: Double = 0.0, throttlePressureSP: Double = 0.0) extends Element with Product with Serializable
Fossil fuelled boiler (e.g., coal, oil, gas).
Fossil fuelled boiler (e.g., coal, oil, gas).
- SteamSupply
SteamSupply Reference to the superclass object.
- auxPowerVersusFrequency
Off nominal frequency effect on auxiliary real power. Per unit active power variation versus per unit frequency variation.
- auxPowerVersusVoltage
Off nominal voltage effect on auxiliary real power. Per unit active power variation versus per unit voltage variation.
- boilerControlMode
The control mode of the boiler.
- controlErrorBiasP
Active power error bias ratio.
- controlIC
Integral constant.
- controlPC
Proportional constant.
- controlPEB
Pressure error bias ratio.
- controlPED
Pressure error deadband.
- controlTC
Time constant.
- feedWaterIG
Feedwater integral gain ratio.
- feedWaterPG
Feedwater proportional gain ratio.
- feedWaterTC
Feedwater time constant ratio.
- fuelDemandLimit
Fuel demand limit.
- fuelSupplyDelay
Fuel delay.
- fuelSupplyTC
Fuel supply time constant.
- maxErrorRateP
Active power maximum error rate limit.
- mechPowerSensorLag
Mechanical power sensor lag.
- minErrorRateP
Active power minimum error rate limit.
- pressureCtrlDG
Pressure control derivative gain ratio.
- pressureCtrlIG
Pressure control integral gain ratio.
- pressureCtrlPG
Pressure control proportional gain ratio.
- pressureFeedback
Pressure feedback indicator.
- superHeater1Capacity
Drum/primary superheater capacity.
- superHeater2Capacity
Secondary superheater capacity.
- superHeaterPipePD
Superheater pipe pressure drop constant.
- throttlePressureSP
Throttle pressure setpoint.
-
final
case class
FrameworkPart(ModelAuthoritySet: ModelAuthoritySet = null, Frame: String = null, ModelFrameType: String = null) extends Element with Product with Serializable
The type of alternate model frame.
The type of alternate model frame.
For example, it could be generator group used to represent generators in state estimator, planning, planning dynamics, short circuit, or real-time dynamics etc., but does not specifically represent any one alternative model. This need to know what objects to be removed in the realization of any one alternate model.
- ModelAuthoritySet
ModelAuthoritySet Reference to the superclass object.
- Frame
NetworkFrame undocumented
- ModelFrameType
ModelFrameType Model frame type of the model frame.
-
final
case class
FrequencyConverter(RegulatingCondEq: RegulatingCondEq = null, frequency: Double = 0.0, maxP: Double = 0.0, maxU: Double = 0.0, minP: Double = 0.0, minU: Double = 0.0) extends Element with Product with Serializable
A device to convert from one frequency to another (e.g., frequency F1 to F2) comprises a pair of FrequencyConverter instances.
A device to convert from one frequency to another (e.g., frequency F1 to F2) comprises a pair of FrequencyConverter instances.
One converts from F1 to DC, the other converts the DC to F2.
- RegulatingCondEq
RegulatingCondEq Reference to the superclass object.
- frequency
Frequency on the AC side.
- maxP
The maximum active power on the DC side at which the frequency converter should operate.
- maxU
The maximum voltage on the DC side at which the frequency converter should operate.
- minP
The minimum active power on the DC side at which the frequency converter should operate.
- minU
The minimum voltage on the DC side at which the frequency converter should operate.
-
final
case class
FuelAllocationSchedule(Curve: Curve = null, fuelAllocationEndDate: String = null, fuelAllocationStartDate: String = null, fuelType: String = null, maxFuelAllocation: Double = 0.0, minFuelAllocation: Double = 0.0, FossilFuel: String = null, ThermalGeneratingUnit: String = null) extends Element with Product with Serializable
The amount of fuel of a given type which is allocated for consumption over a specified period of time.
The amount of fuel of a given type which is allocated for consumption over a specified period of time.
- Curve
Curve Reference to the superclass object.
- fuelAllocationEndDate
The end time and date of the fuel allocation schedule.
- fuelAllocationStartDate
The start time and date of the fuel allocation schedule.
- fuelType
The type of fuel, which also indicates the corresponding measurement unit.
- maxFuelAllocation
The maximum amount of fuel that is allocated for consumption for the scheduled time period.
- minFuelAllocation
The minimum amount of fuel that is allocated for consumption for the scheduled time period, e.g., based on a "take-or-pay" contract.
- FossilFuel
FossilFuel A fuel allocation schedule shall have a fossil fuel.
- ThermalGeneratingUnit
ThermalGeneratingUnit A thermal generating unit may have one or more fuel allocation schedules.
-
final
case class
FuelCostCurve(Curve: Curve = null, RegisteredGenerator: String = null) extends Element with Product with Serializable
Relationship between unit fuel cost in $/kWh(Y-axis) and unit output in MW (X-axis).
Relationship between unit fuel cost in $/kWh(Y-axis) and unit output in MW (X-axis).
- Curve
Curve Reference to the superclass object.
- RegisteredGenerator
RegisteredGenerator undocumented
-
final
case class
FuelRegion(IdentifiedObject: IdentifiedObject = null, fuelRegionType: String = null, lastModified: String = null, GasPrice: String = null, OilPrice: String = null, RTO: String = null, RegisteredGenerator: List[String] = null) extends Element with Product with Serializable
Indication of region for fuel inventory purposes.
Indication of region for fuel inventory purposes.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- fuelRegionType
The type of fuel region
- lastModified
Time of last update
- GasPrice
GasPrice undocumented
- OilPrice
OilPrice undocumented
- RTO
RTO undocumented
- RegisteredGenerator
RegisteredGenerator undocumented
-
final
case class
Fuse(Switch: Switch = null) extends Element with Product with Serializable
An overcurrent protective device with a circuit opening fusible part that is heated and severed by the passage of overcurrent through it.
An overcurrent protective device with a circuit opening fusible part that is heated and severed by the passage of overcurrent through it.
A fuse is considered a switching device because it breaks current.
- Switch
Switch Reference to the superclass object.
-
final
case class
GasPrice(Element: BasicElement = null, gasPriceIndex: Double = 0.0, FuelRegion: String = null) extends Element with Product with Serializable
Price of gas in monetary units.
Price of gas in monetary units.
- Element
Reference to the superclass object.
- gasPriceIndex
The average natural gas price at a defined fuel region.
- FuelRegion
FuelRegion undocumented
-
final
case class
Gate(IdentifiedObject: IdentifiedObject = null, kind: String = null, GateInputPin: List[String] = null, PinGate: List[String] = null, ProtectiveActionCom: List[String] = null, ProtectiveActionEnabled: List[String] = null, RemedialActionScheme: List[String] = null, StageTrigger: List[String] = null, StageTriggerArmed: List[String] = null, StageTriggerCom: List[String] = null, TriggerCondition: List[String] = null) extends Element with Product with Serializable
Logical gate than support logical operation based on the input.
Logical gate than support logical operation based on the input.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- kind
The logical operation of the gate.
- GateInputPin
GateInputPin Input to the gate.
- PinGate
PinGate undocumented
- ProtectiveActionCom
ProtectiveAction For the ProtectiveAction to be activated the condition for communication needs to be met (true).
- ProtectiveActionEnabled
ProtectiveAction undocumented
- RemedialActionScheme
RemedialActionScheme undocumented
- StageTrigger
StageTrigger undocumented
- StageTriggerArmed
StageTrigger undocumented
- StageTriggerCom
StageTrigger undocumented
- TriggerCondition
TriggerCondition undocumented
-
final
case class
GateInputPin(IdentifiedObject: IdentifiedObject = null, aDLogicKind: String = null, absoluteValue: Boolean = false, duration: Double = 0.0, negate: Boolean = false, thresholdPercentage: Double = 0.0, thresholdValue: Double = 0.0, Gate: String = null) extends Element with Product with Serializable
Input pin for a logical gate.
Input pin for a logical gate.
The condition described in the input pin will give a logical true or false. Result from measurement and calculation are converted to a true or false.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- aDLogicKind
The compare operation.
- absoluteValue
If true, use the absolute value for compare..
- duration
The duration the compare condition need to be present before given a true. Default is 0 seconds.
- negate
Invert/negate the result of the compare.
- thresholdPercentage
The threshold percentage that should be used for compare with the percentage change between input value and threshold value.
- thresholdValue
The threshold value that should be used for compare with the input value.
- Gate
Gate undocumented
-
final
case class
GenDistributionFactor(Element: BasicElement = null, factor: Double = 0.0, AggregatedPnode: String = null, DistributionFactorSet: List[String] = null, IndividualPnode: String = null) extends Element with Product with Serializable
This class models the generation distribution factors.
This class models the generation distribution factors.
This class needs to be used along with the AggregatedPnode and the IndividualPnode to show the distribution of each individual party.
- Element
Reference to the superclass object.
- factor
Used to calculate generation "participation" of an individual pnond in an AggregatePnode.
- AggregatedPnode
AggregatedPnode undocumented
- DistributionFactorSet
DistributionFactorSet undocumented
- IndividualPnode
IndividualPnode undocumented
-
final
case class
GenICompensationForGenJ(IdentifiedObject: IdentifiedObject = null, rcij: Double = 0.0, xcij: Double = 0.0, SynchronousMachineDynamics: String = null, VcompIEEEType2: String = null) extends Element with Product with Serializable
Resistive and reactive components of compensation for generator associated with IEEE type 2 voltage compensator for current flow out of another generator in the interconnection.
Resistive and reactive components of compensation for generator associated with IEEE type 2 voltage compensator for current flow out of another generator in the interconnection.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- rcij
<font color="#0f0f0f">Resistive component of compensation of generator associated with this IEEE type 2 voltage compensator for current flow out of another generator (Rcij).</font>
- xcij
<font color="#0f0f0f">Reactive component of compensation of generator associated with this IEEE type 2 voltage compensator for current flow out of another generator (Xcij).</font>
- SynchronousMachineDynamics
SynchronousMachineDynamics Standard synchronous machine out of which current flow is being compensated for.
- VcompIEEEType2
VCompIEEEType2 The standard IEEE type 2 voltage compensator of this compensation.
-
final
case class
GenUnitOpCostCurve(Curve: Curve = null, isNetGrossP: Boolean = false, GeneratingUnit: String = null) extends Element with Product with Serializable
Relationship between unit operating cost (Y-axis) and unit output active power (X-axis).
Relationship between unit operating cost (Y-axis) and unit output active power (X-axis).
The operating cost curve for thermal units is derived from heat input and fuel costs. The operating cost curve for hydro units is derived from water flow rates and equivalent water costs.
- Curve
Curve Reference to the superclass object.
- isNetGrossP
Flag is set to true when output is expressed in net active power.
- GeneratingUnit
GeneratingUnit A generating unit may have one or more cost curves, depending upon fuel mixture and fuel cost.
-
final
case class
GenUnitOpSchedule(RegularIntervalSchedule: RegularIntervalSchedule = null, GeneratingUnit: String = null) extends Element with Product with Serializable
The generating unit's Operator-approved current operating schedule (or plan), typically produced with the aid of unit commitment type analyses.
The generating unit's Operator-approved current operating schedule (or plan), typically produced with the aid of unit commitment type analyses.
The X-axis represents absolute time. The Y1-axis represents the status (0=off-line and unavailable: 1=available: 2=must run: 3=must run at fixed power value: etc.). The Y2-axis represents the must run fixed power value where required.
- RegularIntervalSchedule
RegularIntervalSchedule Reference to the superclass object.
- GeneratingUnit
GeneratingUnit A generating unit may have an operating schedule, indicating the planned operation of the unit.
-
final
case class
GeneralClearing(MarketFactors: MarketFactors = null, GeneralClearingResults: List[String] = null) extends Element with Product with Serializable
Model of clearing result of the market run at the market level.
Model of clearing result of the market run at the market level.
Identifies interval.
- MarketFactors
MarketFactors Reference to the superclass object.
- GeneralClearingResults
GeneralClearingResults undocumented
-
final
case class
GeneralClearingResults(Element: BasicElement = null, loadForecast: Double = 0.0, totalLoad: Double = 0.0, totalNetInterchange: Double = 0.0, GeneralClearing: String = null, SubControlArea: String = null) extends Element with Product with Serializable
Provides the adjusted load forecast value on a load forecast zone basis.
Provides the adjusted load forecast value on a load forecast zone basis.
- Element
Reference to the superclass object.
- loadForecast
Load Prediction/Forecast (MW), by Time Period (5', 10', 15')
- totalLoad
Amount of load in the control zone Attribute Usage: hourly load value for the specific area
- totalNetInterchange
Amount of interchange for the control zone Attribute Usage: hourly interchange value for the specific area
- GeneralClearing
GeneralClearing undocumented
- SubControlArea
SubControlArea undocumented
-
final
case class
GeneratingBid(ResourceBid: ResourceBid = null, combinedCycleUnitOffer: String = null, downTimeMax: Double = 0.0, installedCapacity: Double = 0.0, lowerRampRate: Double = 0.0, maxEmergencyMW: Double = 0.0, maximumEconomicMW: Double = 0.0, minEmergencyMW: Double = 0.0, minimumEconomicMW: Double = 0.0, noLoadCost: Double = 0.0, notificationTime: Double = 0.0, operatingMode: String = null, raiseRampRate: Double = 0.0, rampCurveType: Int = 0, startUpRampRate: Double = 0.0, startUpType: Int = 0, startupCost: Double = 0.0, upTimeMax: Double = 0.0, BidSet: String = null, NotificationTimeCurve: String = null, RampRateCurve: List[String] = null, RegisteredGenerator: String = null, SecurityConstraints: List[String] = null, StartUpCostCurve: String = null, StartUpTimeCurve: String = null) extends Element with Product with Serializable
Offer to supply energy/ancillary services from a generating unit or resource.
Offer to supply energy/ancillary services from a generating unit or resource.
- ResourceBid
ResourceBid Reference to the superclass object.
- combinedCycleUnitOffer
Will indicate if the unit is part of a CC offer or not
- downTimeMax
Maximum down time.
- installedCapacity
Installed Capacity value
- lowerRampRate
Maximum Dn ramp rate in MW/min
- maxEmergencyMW
Power rating available for unit under emergency conditions greater than or equal to maximum economic limit.
- maximumEconomicMW
Maximum high economic MW limit, that should not exceed the maximum operating MW limit
- minEmergencyMW
Minimum power rating for unit under emergency conditions, which is less than or equal to the economic minimum.
- minimumEconomicMW
Low economic MW limit that shall be greater than or equal to the minimum operating MW limit
- noLoadCost
Resource fixed no load cost.
- notificationTime
Time required for crew notification prior to start up of the unit.
- operatingMode
Bid operating mode ('C' - cycling, 'F' - fixed, 'M' - must run, 'U' - unavailable)
- raiseRampRate
Maximum Up ramp rate in MW/min
- rampCurveType
Ramp curve type: 0 - Fixed ramp rate independent of rate function unit MW output 1 - Static ramp rates as a function of unit MW output only 2 - Dynamic ramp rates as a function of unit MW output and ramping time
- startUpRampRate
Resource startup ramp rate (MW/minute)
- startUpType
Resource startup type: 1 - Fixed startup time and fixed startup cost 2 - Startup time as a function of down time and fixed startup cost 3 - Startup cost as a function of down time
- startupCost
Startup cost/price
- upTimeMax
Maximum up time.
- BidSet
BidSet undocumented
- NotificationTimeCurve
NotificationTimeCurve undocumented
- RampRateCurve
RampRateCurve undocumented
- RegisteredGenerator
RegisteredGenerator undocumented
- SecurityConstraints
SecurityConstraints undocumented
- StartUpCostCurve
StartUpCostCurve undocumented
- StartUpTimeCurve
StartUpTimeCurve undocumented
-
final
case class
GeneratingUnit(Equipment: Equipment = null, allocSpinResP: Double = 0.0, autoCntrlMarginP: Double = 0.0, baseP: Double = 0.0, controlDeadband: Double = 0.0, controlPulseHigh: Double = 0.0, controlPulseLow: Double = 0.0, controlResponseRate: Double = 0.0, efficiency: Double = 0.0, genControlMode: String = null, genControlSource: String = null, governorMPL: Double = 0.0, governorSCD: Double = 0.0, highControlLimit: Double = 0.0, initialP: Double = 0.0, longPF: Double = 0.0, lowControlLimit: Double = 0.0, lowerRampRate: Double = 0.0, maxEconomicP: Double = 0.0, maxOperatingP: Double = 0.0, maximumAllowableSpinningReserve: Double = 0.0, minEconomicP: Double = 0.0, minOperatingP: Double = 0.0, minimumOffTime: Double = 0.0, modelDetail: Int = 0, nominalP: Double = 0.0, normalPF: Double = 0.0, penaltyFactor: Double = 0.0, raiseRampRate: Double = 0.0, ratedGrossMaxP: Double = 0.0, ratedGrossMinP: Double = 0.0, ratedNetMaxP: Double = 0.0, shortPF: Double = 0.0, startupCost: Double = 0.0, startupTime: Double = 0.0, tieLinePF: Double = 0.0, totalEfficiency: Double = 0.0, variableCost: Double = 0.0, ControlAreaGeneratingUnit: List[String] = null, GenUnitOpCostCurves: List[String] = null, GenUnitOpSchedule: String = null, GrossToNetActivePowerCurves: List[String] = null, RotatingMachine: List[String] = null) extends Element with Product with Serializable
A single or set of synchronous machines for converting mechanical power into alternating-current power.
A single or set of synchronous machines for converting mechanical power into alternating-current power.
For example, individual machines within a set may be defined for scheduling purposes while a single control signal is derived for the set. In this case there would be a GeneratingUnit for each member of the set and an additional GeneratingUnit corresponding to the set.
- Equipment
Equipment Reference to the superclass object.
- allocSpinResP
The planned unused capacity (spinning reserve) which can be used to support emergency load.
- autoCntrlMarginP
The planned unused capacity which can be used to support automatic control overruns.
- baseP
For dispatchable units, this value represents the economic active power basepoint, for units that are not dispatchable, this value represents the fixed generation value. The value shall be between the operating low and high limits.
- controlDeadband
Unit control error deadband. When a unit's desired active power change is less than this deadband, then no control pulses will be sent to the unit.
- controlPulseHigh
Pulse high limit which is the largest control pulse that the unit can respond to.
- controlPulseLow
Pulse low limit which is the smallest control pulse that the unit can respond to.
- controlResponseRate
Unit response rate which specifies the active power change for a control pulse of one second in the most responsive loading level of the unit.
- efficiency
The efficiency of the unit in converting mechanical energy, from the prime mover, into electrical energy.
- genControlMode
The unit control mode.
- genControlSource
The source of controls for a generating unit. Defines the control status of the generating unit.
- governorMPL
Governor motor position limit.
- governorSCD
Governor Speed Changer Droop. This is the change in generator power output divided by the change in frequency normalized by the nominal power of the generator and the nominal frequency and expressed in percent and negated. A positive value of speed change droop provides additional generator output upon a drop in frequency.
- highControlLimit
High limit for secondary (AGC) control.
- initialP
Default initial active power which is used to store a powerflow result for the initial active power for this unit in this network configuration.
- longPF
Generating unit long term economic participation factor.
- lowControlLimit
Low limit for secondary (AGC) control.
- lowerRampRate
The normal maximum rate the generating unit active power output can be lowered by control actions.
- maxEconomicP
Maximum high economic active power limit, that should not exceed the maximum operating active power limit.
- maxOperatingP
This is the maximum operating active power limit the dispatcher can enter for this unit.
- maximumAllowableSpinningReserve
Maximum allowable spinning reserve. Spinning reserve will never be considered greater than this value regardless of the current operating point.
- minEconomicP
Low economic active power limit that shall be greater than or equal to the minimum operating active power limit.
- minOperatingP
This is the minimum operating active power limit the dispatcher can enter for this unit.
- minimumOffTime
Minimum time interval between unit shutdown and startup.
- modelDetail
Detail level of the generator model data.
- nominalP
The nominal power of the generating unit. Used to give precise meaning to percentage based attributes such as the governor speed change droop (governorSCD attribute). The attribute shall be a positive value equal to or less than RotatingMachine.ratedS.
- normalPF
Generating unit economic participation factor. The sum of the participation factors across generating units does not have to sum to one. It is used for representing distributed slack participation factor. The attribute shall be a positive value or zero.
- penaltyFactor
Defined as: 1 / ( 1 - Incremental Transmission Loss); with the Incremental Transmission Loss expressed as a plus or minus value. The typical range of penalty factors is (0.9 to 1.1).
- raiseRampRate
The normal maximum rate the generating unit active power output can be raised by control actions.
- ratedGrossMaxP
The unit's gross rated maximum capacity (book value). The attribute shall be a positive value.
- ratedGrossMinP
The gross rated minimum generation level which the unit can safely operate at while delivering power to the transmission grid. The attribute shall be a positive value.
- ratedNetMaxP
The net rated maximum capacity determined by subtracting the auxiliary power used to operate the internal plant machinery from the rated gross maximum capacity. The attribute shall be a positive value.
- shortPF
Generating unit short term economic participation factor.
- startupCost
The initial startup cost incurred for each start of the GeneratingUnit.
- startupTime
Time it takes to get the unit on-line, from the time that the prime mover mechanical power is applied.
- tieLinePF
Generating unit economic participation factor.
- totalEfficiency
The efficiency of the unit in converting the fuel into electrical energy.
- variableCost
The variable cost component of production per unit of ActivePower.
- ControlAreaGeneratingUnit
ControlAreaGeneratingUnit ControlArea specifications for this generating unit.
- GenUnitOpCostCurves
GenUnitOpCostCurve A generating unit may have one or more cost curves, depending upon fuel mixture and fuel cost.
- GenUnitOpSchedule
GenUnitOpSchedule A generating unit may have an operating schedule, indicating the planned operation of the unit.
- GrossToNetActivePowerCurves
GrossToNetActivePowerCurve A generating unit may have a gross active power to net active power curve, describing the losses and auxiliary power requirements of the unit.
- RotatingMachine
RotatingMachine A synchronous machine may operate as a generator and as such becomes a member of a generating unit.
-
final
case class
GeneratingUnitDynamicValues(Element: BasicElement = null, lossFactor: Double = 0.0, mVAR: Double = 0.0, maximumMW: Double = 0.0, minimumMW: Double = 0.0, mw: Double = 0.0, sensitivity: Double = 0.0, Flowgate: String = null, MktGeneratingUnit: String = null) extends Element with Product with Serializable
Optimal Power Flow or State Estimator Unit Data for Operator Training Simulator.
Optimal Power Flow or State Estimator Unit Data for Operator Training Simulator.
This is used for RealTime, Study and Maintenance Users.
- Element
Reference to the superclass object.
- lossFactor
Loss Factor
- mVAR
Unit reactive power generation in MVAR
- maximumMW
The maximum active power generation of the unit in MW
- minimumMW
The minimum active power generation of the unit in MW
- mw
Unit active power generation in MW
- sensitivity
Unit sencivity factor. The distribution factors (DFAX) for the unit
- Flowgate
Flowgate undocumented
- MktGeneratingUnit
MktGeneratingUnit undocumented
-
final
case class
GenerationProvider(Organisation: Organisation = null, ProvidedBy: List[String] = null) extends Element with Product with Serializable
The energy seller in the energy marketplace.
The energy seller in the energy marketplace.
- Organisation
Organisation Reference to the superclass object.
- ProvidedBy
EnergyProduct undocumented
-
final
case class
GeneratorTypeAsset(CatalogAssetType: CatalogAssetType = null, maxP: Double = 0.0, maxQ: Double = 0.0, minP: Double = 0.0, minQ: Double = 0.0, rDirectSubtrans: Double = 0.0, rDirectSync: Double = 0.0, rDirectTrans: Double = 0.0, rQuadSubtrans: Double = 0.0, rQuadSync: Double = 0.0, rQuadTrans: Double = 0.0, xDirectSubtrans: Double = 0.0, xDirectSync: Double = 0.0, xDirectTrans: Double = 0.0, xQuadSubtrans: Double = 0.0, xQuadSync: Double = 0.0, xQuadTrans: Double = 0.0) extends Element with Product with Serializable
Generic generation equipment that may be used for various purposes such as work planning.
Generic generation equipment that may be used for various purposes such as work planning.
It defines both the Real and Reactive power properties (modelled at the PSR level as a GeneratingUnit + SynchronousMachine).
- CatalogAssetType
CatalogAssetType Reference to the superclass object.
- maxP
Maximum real power limit.
- maxQ
Maximum reactive power limit.
- minP
Minimum real power generated.
- minQ
Minimum reactive power generated.
- rDirectSubtrans
Direct-axis subtransient resistance.
- rDirectSync
Direct-axis synchronous resistance.
- rDirectTrans
Direct-axis transient resistance.
- rQuadSubtrans
Quadrature-axis subtransient resistance.
- rQuadSync
Quadrature-axis synchronous resistance.
- rQuadTrans
Quadrature-axis transient resistance.
- xDirectSubtrans
Direct-axis subtransient reactance.
- xDirectSync
Direct-axis synchronous reactance.
- xDirectTrans
Direct-axis transient reactance.
- xQuadSubtrans
Quadrature-axis subtransient reactance.
- xQuadSync
Quadrature-axis synchronous reactance.
- xQuadTrans
Quadrature-axis transient reactance.
-
final
case class
GenericAction(SwitchingAction: SwitchingAction = null, PowerSystemResource: String = null) extends Element with Product with Serializable
An arbitrary switching step.
An arbitrary switching step.
- SwitchingAction
SwitchingAction Reference to the superclass object.
- PowerSystemResource
PowerSystemResource undocumented
-
final
case class
GenericConstraints(IdentifiedObject: IdentifiedObject = null, intervalEndTime: String = null, intervalStartTime: String = null, maxLimit: Double = 0.0, minLimit: Double = 0.0, Flowgate: List[String] = null, TransmissionCapacity: List[String] = null) extends Element with Product with Serializable
Generic constraints can represent secure areas, voltage profile, transient stability and voltage collapse limits.
Generic constraints can represent secure areas, voltage profile, transient stability and voltage collapse limits.
The generic constraints can be one of the following forms: a) Thermal MW limit constraints type b) Group line flow constraint type
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- intervalEndTime
Interval End Time
- intervalStartTime
Interval Start Time
- maxLimit
Maximum Limit (MW)
- minLimit
Minimum Limit (MW)
- Flowgate
Flowgate undocumented
- TransmissionCapacity
TransmissionCapacity undocumented
- final case class GenericDataSetVersion(Element: BasicElement = null, majorVersion: String = null, minorVersion: String = null, published: String = null) extends Element with Product with Serializable
-
final
case class
GeographicalRegion(IdentifiedObject: IdentifiedObject = null, Regions: List[String] = null) extends Element with Product with Serializable
A geographical region of a power system network model.
A geographical region of a power system network model.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- Regions
SubGeographicalRegion All sub-geographical regions within this geographical region.
-
final
case class
GeosphericAnalog(EnvironmentalAnalog: EnvironmentalAnalog = null, kind: String = null) extends Element with Product with Serializable
Analog (float) measuring a geospheric condition.
Analog (float) measuring a geospheric condition.
- EnvironmentalAnalog
EnvironmentalAnalog Reference to the superclass object.
- kind
Kind of geospheric analog.
-
final
case class
GeosphericPhenomenon(EnvironmentalPhenomenon: EnvironmentalPhenomenon = null) extends Element with Product with Serializable
A geospheric phenomenon.
A geospheric phenomenon.
- EnvironmentalPhenomenon
EnvironmentalPhenomenon Reference to the superclass object.
-
final
case class
GovCT1(TurbineGovernorDynamics: TurbineGovernorDynamics = null, aset: Double = 0.0, db: Double = 0.0, dm: Double = 0.0, ka: Double = 0.0, kdgov: Double = 0.0, kigov: Double = 0.0, kiload: Double = 0.0, kimw: Double = 0.0, kpgov: Double = 0.0, kpload: Double = 0.0, kturb: Double = 0.0, ldref: Double = 0.0, maxerr: Double = 0.0, minerr: Double = 0.0, mwbase: Double = 0.0, r: Double = 0.0, rclose: Double = 0.0, rdown: Double = 0.0, ropen: Double = 0.0, rselect: String = null, rup: Double = 0.0, ta: Double = 0.0, tact: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, tdgov: Double = 0.0, teng: Double = 0.0, tfload: Double = 0.0, tpelec: Double = 0.0, tsa: Double = 0.0, tsb: Double = 0.0, vmax: Double = 0.0, vmin: Double = 0.0, wfnl: Double = 0.0, wfspd: Boolean = false) extends Element with Product with Serializable
General model for any prime mover with a PID governor, used primarily for combustion turbine and combined cycle units.
General model for any prime mover with a PID governor, used primarily for combustion turbine and combined cycle units.
This model can be used to represent a variety of prime movers controlled by PID governors. It is suitable, for example, for the representation of:
- gas turbine and single shaft combined cycle turbines
- diesel engines with modern electronic or digital governors
- steam turbines where steam is supplied from a large boiler drum or a large header whose pressure is substantially constant over the period under study
- simple hydro turbines in dam configurations where the water column length is short and water inertia effects are minimal.
Additional information on this model is available in the 2012 IEEE report, Dynamic Models for Turbine-Governors in Power System Studies, 3.1.2.3 pages 3-4 (GGOV1).
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- aset
Acceleration limiter setpoint (Aset). Unit = PU / s. Typical value = 0,01.
- db
Speed governor deadband in PU speed (db). In the majority of applications, it is recommended that this value be set to zero. Typical value = 0.
- dm
Speed sensitivity coefficient (Dm). Dm can represent either the variation of the engine power with the shaft speed or the variation of maximum power capability with shaft speed. If it is positive it describes the falling slope of the engine speed verses power characteristic as speed increases. A slightly falling characteristic is typical for reciprocating engines and some aero-derivative turbines. If it is negative the engine power is assumed to be unaffected by the shaft speed, but the maximum permissible fuel flow is taken to fall with falling shaft speed. This is characteristic of single-shaft industrial turbines due to exhaust temperature limits. Typical value = 0.
- ka
Acceleration limiter gain (Ka). Typical value = 10.
- kdgov
Governor derivative gain (Kdgov). Typical value = 0.
- kigov
Governor integral gain (Kigov). Typical value = 2.
- kiload
Load limiter integral gain for PI controller (Kiload). Typical value = 0,67.
- kimw
Power controller (reset) gain (Kimw). The default value of 0,01 corresponds to a reset time of 100 s. A value of 0,001 corresponds to a relatively slow-acting load controller. Typical value = 0,01.
- kpgov
Governor proportional gain (Kpgov). Typical value = 10.
- kpload
Load limiter proportional gain for PI controller (Kpload). Typical value = 2.
- kturb
Turbine gain (Kturb) (> 0). Typical value = 1,5.
- ldref
Load limiter reference value (Ldref). Typical value = 1.
- maxerr
Maximum value for speed error signal (maxerr) (> GovCT1.minerr). Typical value = 0,05.
- minerr
Minimum value for speed error signal (minerr) (< GovCT1.maxerr). Typical value = -0,05.
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- r
Permanent droop (R). Typical value = 0,04.
- rclose
Minimum valve closing rate (Rclose). Unit = PU / s. Typical value = -0,1.
- rdown
Maximum rate of load limit decrease (Rdown). Typical value = -99.
- ropen
Maximum valve opening rate (Ropen). Unit = PU / s. Typical value = 0.10.
- rselect
Feedback signal for droop (Rselect). Typical value = electricalPower.
- rup
Maximum rate of load limit increase (Rup). Typical value = 99.
- ta
Acceleration limiter time constant (Ta) (> 0). Typical value = 0,1.
- tact
Actuator time constant (Tact) (>= 0). Typical value = 0,5.
- tb
Turbine lag time constant (Tb) (> 0). Typical value = 0,5.
- tc
Turbine lead time constant (Tc) (>= 0). Typical value = 0.
- tdgov
Governor derivative controller time constant (Tdgov) (>= 0). Typical value = 1.
- teng
Transport time delay for diesel engine used in representing diesel engines where there is a small but measurable transport delay between a change in fuel flow setting and the development of torque (Teng) (>= 0). Teng should be zero in all but special cases where this transport delay is of particular concern. Typical value = 0.
- tfload
Load-limiter time constant (Tfload) (> 0). Typical value = 3.
- tpelec
Electrical power transducer time constant (Tpelec) (> 0). Typical value = 1.
- tsa
Temperature detection lead time constant (Tsa) (>= 0). Typical value = 4.
- tsb
Temperature detection lag time constant (Tsb) (>= 0). Typical value = 5.
- vmax
Maximum valve position limit (Vmax) (> GovCT1.vmin). Typical value = 1.
- vmin
Minimum valve position limit (Vmin) (< GovCT1.vmax). Typical value = 0,15.
- wfnl
No load fuel flow (Wfnl). Typical value = 0,2.
- wfspd
Switch for fuel source characteristic to recognize that fuel flow, for a given fuel valve stroke, can be proportional to engine speed (Wfspd). true = fuel flow proportional to speed (for some gas turbines and diesel engines with positive displacement fuel injectors) false = fuel control system keeps fuel flow independent of engine speed. Typical value = true.
-
final
case class
GovCT2(TurbineGovernorDynamics: TurbineGovernorDynamics = null, aset: Double = 0.0, db: Double = 0.0, dm: Double = 0.0, flim1: Double = 0.0, flim10: Double = 0.0, flim2: Double = 0.0, flim3: Double = 0.0, flim4: Double = 0.0, flim5: Double = 0.0, flim6: Double = 0.0, flim7: Double = 0.0, flim8: Double = 0.0, flim9: Double = 0.0, ka: Double = 0.0, kdgov: Double = 0.0, kigov: Double = 0.0, kiload: Double = 0.0, kimw: Double = 0.0, kpgov: Double = 0.0, kpload: Double = 0.0, kturb: Double = 0.0, ldref: Double = 0.0, maxerr: Double = 0.0, minerr: Double = 0.0, mwbase: Double = 0.0, plim1: Double = 0.0, plim10: Double = 0.0, plim2: Double = 0.0, plim3: Double = 0.0, plim4: Double = 0.0, plim5: Double = 0.0, plim6: Double = 0.0, plim7: Double = 0.0, plim8: Double = 0.0, plim9: Double = 0.0, prate: Double = 0.0, r: Double = 0.0, rclose: Double = 0.0, rdown: Double = 0.0, ropen: Double = 0.0, rselect: String = null, rup: Double = 0.0, ta: Double = 0.0, tact: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, tdgov: Double = 0.0, teng: Double = 0.0, tfload: Double = 0.0, tpelec: Double = 0.0, tsa: Double = 0.0, tsb: Double = 0.0, vmax: Double = 0.0, vmin: Double = 0.0, wfnl: Double = 0.0, wfspd: Boolean = false) extends Element with Product with Serializable
General governor with frequency-dependent fuel flow limit.
General governor with frequency-dependent fuel flow limit.
This model is a modification of the GovCT1 model in order to represent the frequency-dependent fuel flow limit of a specific gas turbine manufacturer.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- aset
Acceleration limiter setpoint (Aset). Unit = PU / s. Typical value = 10.
- db
Speed governor deadband in PU speed (db). In the majority of applications, it is recommended that this value be set to zero. Typical value = 0.
- dm
Speed sensitivity coefficient (Dm). Dm can represent either the variation of the engine power with the shaft speed or the variation of maximum power capability with shaft speed. If it is positive it describes the falling slope of the engine speed verses power characteristic as speed increases. A slightly falling characteristic is typical for reciprocating engines and some aero-derivative turbines. If it is negative the engine power is assumed to be unaffected by the shaft speed, but the maximum permissible fuel flow is taken to fall with falling shaft speed. This is characteristic of single-shaft industrial turbines due to exhaust temperature limits. Typical value = 0.
- flim1
Frequency threshold 1 (Flim1). Unit = Hz. Typical value = 59.
- flim10
Frequency threshold 10 (Flim10). Unit = Hz. Typical value = 0.
- flim2
Frequency threshold 2 (Flim2). Unit = Hz. Typical value = 0.
- flim3
Frequency threshold 3 (Flim3). Unit = Hz. Typical value = 0.
- flim4
Frequency threshold 4 (Flim4). Unit = Hz. Typical value = 0.
- flim5
Frequency threshold 5 (Flim5). Unit = Hz. Typical value = 0.
- flim6
Frequency threshold 6 (Flim6). Unit = Hz. Typical value = 0.
- flim7
Frequency threshold 7 (Flim7). Unit = Hz. Typical value = 0.
- flim8
Frequency threshold 8 (Flim8). Unit = Hz. Typical value = 0.
- flim9
Frequency threshold 9 (Flim9). Unit = Hz. Typical value = 0.
- ka
Acceleration limiter gain (Ka). Typical value = 10.
- kdgov
Governor derivative gain (Kdgov). Typical value = 0.
- kigov
Governor integral gain (Kigov). Typical value = 0,45.
- kiload
Load limiter integral gain for PI controller (Kiload). Typical value = 1.
- kimw
Power controller (reset) gain (Kimw). The default value of 0,01 corresponds to a reset time of 100 seconds. A value of 0,001 corresponds to a relatively slow-acting load controller. Typical value = 0.
- kpgov
Governor proportional gain (Kpgov). Typical value = 4.
- kpload
Load limiter proportional gain for PI controller (Kpload). Typical value = 1.
- kturb
Turbine gain (Kturb). Typical value = 1,9168.
- ldref
Load limiter reference value (Ldref). Typical value = 1.
- maxerr
Maximum value for speed error signal (Maxerr) (> GovCT2.minerr). Typical value = 1.
- minerr
Minimum value for speed error signal (Minerr) (< GovCT2.maxerr). Typical value = -1.
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- plim1
Power limit 1 (Plim1). Typical value = 0,8325.
- plim10
Power limit 10 (Plim10). Typical value = 0.
- plim2
Power limit 2 (Plim2). Typical value = 0.
- plim3
Power limit 3 (Plim3). Typical value = 0.
- plim4
Power limit 4 (Plim4). Typical value = 0.
- plim5
Power limit 5 (Plim5). Typical value = 0.
- plim6
Power limit 6 (Plim6). Typical value = 0.
- plim7
Power limit 7 (Plim7). Typical value = 0.
- plim8
Power limit 8 (Plim8). Typical value = 0.
- plim9
Power Limit 9 (Plim9). Typical value = 0.
- prate
Ramp rate for frequency-dependent power limit (Prate). Typical value = 0,017.
- r
Permanent droop (R). Typical value = 0,05.
- rclose
Minimum valve closing rate (Rclose). Unit = PU / s. Typical value = -99.
- rdown
Maximum rate of load limit decrease (Rdown). Typical value = -99.
- ropen
Maximum valve opening rate (Ropen). Unit = PU / s. Typical value = 99.
- rselect
Feedback signal for droop (Rselect). Typical value = electricalPower.
- rup
Maximum rate of load limit increase (Rup). Typical value = 99.
- ta
Acceleration limiter time constant (Ta) (>= 0). Typical value = 1.
- tact
Actuator time constant (Tact) (>= 0). Typical value = 0,4.
- tb
Turbine lag time constant (Tb) (>= 0). Typical value = 0,1.
- tc
Turbine lead time constant (Tc) (>= 0). Typical value = 0.
- tdgov
Governor derivative controller time constant (Tdgov) (>= 0). Typical value = 1.
- teng
Transport time delay for diesel engine used in representing diesel engines where there is a small but measurable transport delay between a change in fuel flow setting and the development of torque (Teng) (>= 0). Teng should be zero in all but special cases where this transport delay is of particular concern. Typical value = 0.
- tfload
Load limiter time constant (Tfload) (>= 0). Typical value = 3.
- tpelec
Electrical power transducer time constant (Tpelec) (>= 0). Typical value = 2,5.
- tsa
Temperature detection lead time constant (Tsa) (>= 0). Typical value = 0.
- tsb
Temperature detection lag time constant (Tsb) (>= 0). Typical value = 50.
- vmax
Maximum valve position limit (Vmax) (> GovCT2.vmin). Typical value = 1.
- vmin
Minimum valve position limit (Vmin) (< GovCT2.vmax). Typical value = 0,175.
- wfnl
No load fuel flow (Wfnl). Typical value = 0,187.
- wfspd
Switch for fuel source characteristic to recognize that fuel flow, for a given fuel valve stroke, can be proportional to engine speed (Wfspd). true = fuel flow proportional to speed (for some gas turbines and diesel engines with positive displacement fuel injectors) false = fuel control system keeps fuel flow independent of engine speed. Typical value = false.
-
final
case class
GovGAST(TurbineGovernorDynamics: TurbineGovernorDynamics = null, at: Double = 0.0, dturb: Double = 0.0, kt: Double = 0.0, mwbase: Double = 0.0, r: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, vmax: Double = 0.0, vmin: Double = 0.0) extends Element with Product with Serializable
Single shaft gas turbine.
Single shaft gas turbine.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- at
Ambient temperature load limit (Load Limit). Typical value = 1.
- dturb
Turbine damping factor (Dturb). Typical value = 0,18.
- kt
Temperature limiter gain (Kt). Typical value = 3.
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- r
Permanent droop (R) (>0). Typical value = 0,04.
- t1
Governor mechanism time constant (T1) (>= 0). T1 represents the natural valve positioning time constant of the governor for small disturbances, as seen when rate limiting is not in effect. Typical value = 0,5.
- t2
Turbine power time constant (T2) (>= 0). T2 represents delay due to internal energy storage of the gas turbine engine. T2 can be used to give a rough approximation to the delay associated with acceleration of the compressor spool of a multi-shaft engine, or with the compressibility of gas in the plenum of a free power turbine of an aero-derivative unit, for example. Typical value = 0,5.
- t3
Turbine exhaust temperature time constant (T3) (>= 0). Typical value = 3.
- vmax
Maximum turbine power, PU of MWbase (Vmax) (> GovGAST.vmin). Typical value = 1.
- vmin
Minimum turbine power, PU of MWbase (Vmin) (< GovGAST.vmax). Typical value = 0.
-
final
case class
GovGAST1(TurbineGovernorDynamics: TurbineGovernorDynamics = null, a: Double = 0.0, b: Double = 0.0, db1: Double = 0.0, db2: Double = 0.0, eps: Double = 0.0, fidle: Double = 0.0, gv1: Double = 0.0, gv2: Double = 0.0, gv3: Double = 0.0, gv4: Double = 0.0, gv5: Double = 0.0, gv6: Double = 0.0, ka: Double = 0.0, kt: Double = 0.0, lmax: Double = 0.0, loadinc: Double = 0.0, ltrate: Double = 0.0, mwbase: Double = 0.0, pgv1: Double = 0.0, pgv2: Double = 0.0, pgv3: Double = 0.0, pgv4: Double = 0.0, pgv5: Double = 0.0, pgv6: Double = 0.0, r: Double = 0.0, rmax: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, t5: Double = 0.0, tltr: Double = 0.0, vmax: Double = 0.0, vmin: Double = 0.0) extends Element with Product with Serializable
Modified single shaft gas turbine.
Modified single shaft gas turbine.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- a
Turbine power time constant numerator scale factor (a). Typical value = 0,8.
- b
Turbine power time constant denominator scale factor (b) (>0). Typical value = 1.
- db1
Intentional dead-band width (db1). Unit = Hz. Typical value = 0.
- db2
Unintentional dead-band (db2). Unit = MW. Typical value = 0.
- eps
Intentional db hysteresis (eps). Unit = Hz. Typical value = 0.
- fidle
Fuel flow at zero power output (Fidle). Typical value = 0,18.
- gv1
Nonlinear gain point 1, PU gv (Gv1). Typical value = 0.
- gv2
Nonlinear gain point 2,PU gv (Gv2). Typical value = 0.
- gv3
Nonlinear gain point 3, PU gv (Gv3). Typical value = 0.
- gv4
Nonlinear gain point 4, PU gv (Gv4). Typical value = 0.
- gv5
Nonlinear gain point 5, PU gv (Gv5). Typical value = 0.
- gv6
Nonlinear gain point 6, PU gv (Gv6). Typical value = 0.
- ka
Governor gain (Ka). Typical value = 0.
- kt
Temperature limiter gain (Kt). Typical value = 3.
- lmax
Ambient temperature load limit (Lmax). Lmax is the turbine power output corresponding to the limiting exhaust gas temperature. Typical value = 1.
- loadinc
Valve position change allowed at fast rate (Loadinc). Typical value = 0,05.
- ltrate
Maximum long term fuel valve opening rate (Ltrate). Typical value = 0,02.
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- pgv1
Nonlinear gain point 1, PU power (Pgv1). Typical value = 0.
- pgv2
Nonlinear gain point 2, PU power (Pgv2). Typical value = 0.
- pgv3
Nonlinear gain point 3, PU power (Pgv3). Typical value = 0.
- pgv4
Nonlinear gain point 4, PU power (Pgv4). Typical value = 0.
- pgv5
Nonlinear gain point 5, PU power (Pgv5). Typical value = 0.
- pgv6
Nonlinear gain point 6, PU power (Pgv6). Typical value = 0.
- r
Permanent droop (R) (>0). Typical value = 0,04.
- rmax
Maximum fuel valve opening rate (Rmax). Unit = PU / s. Typical value = 1.
- t1
Governor mechanism time constant (T1) (>= 0). T1 represents the natural valve positioning time constant of the governor for small disturbances, as seen when rate limiting is not in effect. Typical value = 0,5.
- t2
Turbine power time constant (T2) (>= 0). T2 represents delay due to internal energy storage of the gas turbine engine. T2 can be used to give a rough approximation to the delay associated with acceleration of the compressor spool of a multi-shaft engine, or with the compressibility of gas in the plenum of the free power turbine of an aero-derivative unit, for example. Typical value = 0,5.
- t3
Turbine exhaust temperature time constant (T3) (>= 0). T3 represents delay in the exhaust temperature and load limiting system. Typical value = 3.
- t4
Governor lead time constant (T4) (>= 0). Typical value = 0.
- t5
Governor lag time constant (T5) (>= 0). If = 0, entire gain and lead-lag block is bypassed. Typical value = 0.
- tltr
Valve position averaging time constant (Tltr) (>= 0). Typical value = 10.
- vmax
Maximum turbine power, PU of MWbase (Vmax) (> GovGAST1.vmin). Typical value = 1.
- vmin
Minimum turbine power, PU of MWbase (Vmin) (< GovGAST1.vmax). Typical value = 0.
-
final
case class
GovGAST2(TurbineGovernorDynamics: TurbineGovernorDynamics = null, a: Double = 0.0, af1: Double = 0.0, af2: Double = 0.0, b: Double = 0.0, bf1: Double = 0.0, bf2: Double = 0.0, c: Double = 0.0, cf2: Double = 0.0, ecr: Double = 0.0, etd: Double = 0.0, k3: Double = 0.0, k4: Double = 0.0, k5: Double = 0.0, k6: Double = 0.0, kf: Double = 0.0, mwbase: Double = 0.0, t: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, t5: Double = 0.0, tc: Double = 0.0, tcd: Double = 0.0, tf: Double = 0.0, tmax: Double = 0.0, tmin: Double = 0.0, tr: Double = 0.0, trate: Double = 0.0, tt: Double = 0.0, w: Double = 0.0, x: Double = 0.0, y: Double = 0.0, z: Int = 0) extends Element with Product with Serializable
Gas turbine.
Gas turbine.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- a
Valve positioner (A).
- af1
Exhaust temperature parameter (Af1). Unit = PU temperature. Based on temperature in degrees C.
- af2
Coefficient equal to 0,5(1-speed) (Af2).
- b
Valve positioner (B).
- bf1
(Bf1). Bf1 = E(1 - W) where E (speed sensitivity coefficient) is 0,55 to 0,65 x Tr. Unit = PU temperature. Based on temperature in degrees C.
- bf2
Turbine torque coefficient Khhv (depends on heating value of fuel stream in combustion chamber) (Bf2).
- c
Valve positioner (C).
- cf2
Coefficient defining fuel flow where power output is 0% (Cf2). Synchronous but no output. Typically 0,23 x Khhv (23% fuel flow).
- ecr
Combustion reaction time delay (Ecr) (>= 0).
- etd
Turbine and exhaust delay (Etd) (>= 0).
- k3
Ratio of fuel adjustment (K3).
- k4
Gain of radiation shield (K4).
- k5
Gain of radiation shield (K5).
- k6
Minimum fuel flow (K6).
- kf
Fuel system feedback (Kf).
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- t
Fuel control time constant (T) (>= 0).
- t3
Radiation shield time constant (T3) (>= 0).
- t4
Thermocouple time constant (T4) (>= 0).
- t5
Temperature control time constant (T5) (>= 0).
- tc
Temperature control (Tc). Unit = °F or °C depending on parameters Af1 and Bf1.
- tcd
Compressor discharge time constant (Tcd) (>= 0).
- tf
Fuel system time constant (Tf) (>= 0).
- tmax
Maximum turbine limit (Tmax) (> GovGAST2.tmin).
- tmin
Minimum turbine limit (Tmin) (< GovGAST2.tmax).
- tr
Rated temperature (Tr). Unit = °C depending on parameters Af1 and Bf1.
- trate
Turbine rating (Trate). Unit = MW.
- tt
Temperature controller integration rate (Tt) (>= 0).
- w
Governor gain (1/droop) on turbine rating (W).
- x
Governor lead time constant (X) (>= 0).
- y
Governor lag time constant (Y) (> 0).
- z
Governor mode (Z). 1 = droop 0 = isochronous.
-
final
case class
GovGAST3(TurbineGovernorDynamics: TurbineGovernorDynamics = null, bca: Double = 0.0, bp: Double = 0.0, dtc: Double = 0.0, ka: Double = 0.0, kac: Double = 0.0, kca: Double = 0.0, ksi: Double = 0.0, ky: Double = 0.0, mnef: Double = 0.0, mxef: Double = 0.0, rcmn: Double = 0.0, rcmx: Double = 0.0, tac: Double = 0.0, tc: Double = 0.0, td: Double = 0.0, tfen: Double = 0.0, tg: Double = 0.0, tsi: Double = 0.0, tt: Double = 0.0, ttc: Double = 0.0, ty: Double = 0.0) extends Element with Product with Serializable
Generic turbogas with acceleration and temperature controller.
Generic turbogas with acceleration and temperature controller.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- bca
Acceleration limit set-point (Bca). Unit = 1/s. Typical value = 0,01.
- bp
Droop (bp). Typical value = 0,05.
- dtc
Exhaust temperature variation due to fuel flow increasing from 0 to 1 PU (deltaTc). Typical value = 390.
- ka
Minimum fuel flow (Ka). Typical value = 0,23.
- kac
Fuel system feedback (KAC). Typical value = 0.
- kca
Acceleration control integral gain (Kca). Unit = 1/s. Typical value = 100.
- ksi
Gain of radiation shield (Ksi). Typical value = 0,8.
- ky
Coefficient of transfer function of fuel valve positioner (Ky). Typical value = 1.
- mnef
Fuel flow maximum negative error value (MNef). Typical value = -0,05.
- mxef
Fuel flow maximum positive error value (MXef). Typical value = 0,05.
- rcmn
Minimum fuel flow (RCMN). Typical value = -0,1.
- rcmx
Maximum fuel flow (RCMX). Typical value = 1.
- tac
Fuel control time constant (Tac) (>= 0). Typical value = 0,1.
- tc
Compressor discharge volume time constant (Tc) (>= 0). Typical value = 0,2.
- td
Temperature controller derivative gain (Td) (>= 0). Typical value = 3,3.
- tfen
Turbine rated exhaust temperature correspondent to Pm=1 PU (Tfen). Typical value = 540.
- tg
Time constant of speed governor (Tg) (>= 0). Typical value = 0,05.
- tsi
Time constant of radiation shield (Tsi) (>= 0). Typical value = 15.
- tt
Temperature controller integration rate (Tt). Typical value = 250.
- ttc
Time constant of thermocouple (Ttc) (>= 0). Typical value = 2,5.
- ty
Time constant of fuel valve positioner (Ty) (>= 0). Typical value = 0,2.
-
final
case class
GovGAST4(TurbineGovernorDynamics: TurbineGovernorDynamics = null, bp: Double = 0.0, ktm: Double = 0.0, mnef: Double = 0.0, mxef: Double = 0.0, rymn: Double = 0.0, rymx: Double = 0.0, ta: Double = 0.0, tc: Double = 0.0, tcm: Double = 0.0, tm: Double = 0.0, ty: Double = 0.0) extends Element with Product with Serializable
Generic turbogas.
Generic turbogas.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- bp
Droop (bp). Typical value = 0,05.
- ktm
Compressor gain (Ktm). Typical value = 0.
- mnef
Fuel flow maximum negative error value (MNef). Typical value = -0,05.
- mxef
Fuel flow maximum positive error value (MXef). Typical value = 0,05.
- rymn
Minimum valve opening (RYMN). Typical value = 0.
- rymx
Maximum valve opening (RYMX). Typical value = 1,1.
- ta
Maximum gate opening velocity (TA) (>= 0). Typical value = 3.
- tc
Maximum gate closing velocity (TC) (>= 0). Typical value = 0,5.
- tcm
Fuel control time constant (Tcm) (>= 0). Typical value = 0,1.
- tm
Compressor discharge volume time constant (Tm) (>= 0). Typical value = 0,2.
- ty
Time constant of fuel valve positioner (Ty) (>= 0). Typical value = 0,1.
-
final
case class
GovGASTWD(TurbineGovernorDynamics: TurbineGovernorDynamics = null, a: Double = 0.0, af1: Double = 0.0, af2: Double = 0.0, b: Double = 0.0, bf1: Double = 0.0, bf2: Double = 0.0, c: Double = 0.0, cf2: Double = 0.0, ecr: Double = 0.0, etd: Double = 0.0, k3: Double = 0.0, k4: Double = 0.0, k5: Double = 0.0, k6: Double = 0.0, kd: Double = 0.0, kdroop: Double = 0.0, kf: Double = 0.0, ki: Double = 0.0, kp: Double = 0.0, mwbase: Double = 0.0, t: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, t5: Double = 0.0, tc: Double = 0.0, tcd: Double = 0.0, td: Double = 0.0, tf: Double = 0.0, tmax: Double = 0.0, tmin: Double = 0.0, tr: Double = 0.0, trate: Double = 0.0, tt: Double = 0.0) extends Element with Product with Serializable
Woodward™ gas turbine governor.
Woodward™ gas turbine governor. [Footnote: Woodward gas turbines are an example of suitable products available commercially.
This information is given for the convenience of users of this document and does not constitute an endorsement by IEC of these products.]
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- a
Valve positioner (A).
- af1
Exhaust temperature parameter (Af1).
- af2
Coefficient equal to 0,5(1-speed) (Af2).
- b
Valve positioner (B).
- bf1
(Bf1). Bf1 = E(1-w) where E (speed sensitivity coefficient) is 0,55 to 0,65 x Tr.
- bf2
Turbine torque coefficient Khhv (depends on heating value of fuel stream in combustion chamber) (Bf2).
- c
Valve positioner (C).
- cf2
Coefficient defining fuel flow where power output is 0 % (Cf2). Synchronous but no output. Typically 0,23 x Khhv (23 % fuel flow).
- ecr
Combustion reaction time delay (Ecr) (>= 0).
- etd
Turbine and exhaust delay (Etd) (>= 0).
- k3
Ratio of fuel adjustment (K3).
- k4
Gain of radiation shield (K4).
- k5
Gain of radiation shield (K5).
- k6
Minimum fuel flow (K6).
- kd
Drop governor gain (Kd).
- kdroop
(Kdroop) (>= 0).
- kf
Fuel system feedback (Kf).
- ki
Isochronous Governor Gain (Ki).
- kp
PID proportional gain (Kp).
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- t
Fuel control time constant (T) (>= 0).
- t3
Radiation shield time constant (T3) (>= 0).
- t4
Thermocouple time constant (T4) (>= 0).
- t5
Temperature control time constant (T5) (>= 0).
- tc
Temperature control (Tc).
- tcd
Compressor discharge time constant (Tcd) (>= 0).
- td
Power transducer time constant (Td) (>= 0).
- tf
Fuel system time constant (Tf) (>= 0).
- tmax
Maximum Turbine limit (Tmax) (> GovGASTWD.tmin).
- tmin
Minimum turbine limit (Tmin) (< GovGASTWD.tmax).
- tr
Rated temperature (Tr).
- trate
Turbine rating (Trate). Unit = MW.
- tt
Temperature controller integration rate (Tt) (>= 0).
-
final
case class
GovHydro1(TurbineGovernorDynamics: TurbineGovernorDynamics = null, at: Double = 0.0, dturb: Double = 0.0, gmax: Double = 0.0, gmin: Double = 0.0, hdam: Double = 0.0, mwbase: Double = 0.0, qnl: Double = 0.0, rperm: Double = 0.0, rtemp: Double = 0.0, tf: Double = 0.0, tg: Double = 0.0, tr: Double = 0.0, tw: Double = 0.0, velm: Double = 0.0) extends Element with Product with Serializable
Basic hydro turbine governor.
Basic hydro turbine governor.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- at
Turbine gain (At) (> 0). Typical value = 1,2.
- dturb
Turbine damping factor (Dturb) (>= 0). Typical value = 0,5.
- gmax
Maximum gate opening (Gmax) (> 0 and > GovHydro.gmin). Typical value = 1.
- gmin
Minimum gate opening (Gmin) (>= 0 and < GovHydro1.gmax). Typical value = 0.
- hdam
Turbine nominal head (hdam). Typical value = 1.
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- qnl
No-load flow at nominal head (qnl) (>= 0). Typical value = 0,08.
- rperm
Permanent droop (R) (> 0). Typical value = 0,04.
- rtemp
Temporary droop (r) (> GovHydro1.rperm). Typical value = 0,3.
- tf
Filter time constant (Tf) (> 0). Typical value = 0,05.
- tg
Gate servo time constant (Tg) (> 0). Typical value = 0,5.
- tr
Washout time constant (Tr) (> 0). Typical value = 5.
- tw
Water inertia time constant (Tw) (> 0). Typical value = 1.
- velm
Maximum gate velocity (Vlem) (> 0). Typical value = 0,2.
-
final
case class
GovHydro2(TurbineGovernorDynamics: TurbineGovernorDynamics = null, aturb: Double = 0.0, bturb: Double = 0.0, db1: Double = 0.0, db2: Double = 0.0, eps: Double = 0.0, gv1: Double = 0.0, gv2: Double = 0.0, gv3: Double = 0.0, gv4: Double = 0.0, gv5: Double = 0.0, gv6: Double = 0.0, kturb: Double = 0.0, mwbase: Double = 0.0, pgv1: Double = 0.0, pgv2: Double = 0.0, pgv3: Double = 0.0, pgv4: Double = 0.0, pgv5: Double = 0.0, pgv6: Double = 0.0, pmax: Double = 0.0, pmin: Double = 0.0, rperm: Double = 0.0, rtemp: Double = 0.0, tg: Double = 0.0, tp: Double = 0.0, tr: Double = 0.0, tw: Double = 0.0, uc: Double = 0.0, uo: Double = 0.0) extends Element with Product with Serializable
IEEE hydro turbine governor with straightforward penstock configuration and hydraulic-dashpot governor.
IEEE hydro turbine governor with straightforward penstock configuration and hydraulic-dashpot governor.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- aturb
Turbine numerator multiplier (Aturb). Typical value = -1.
- bturb
Turbine denominator multiplier (Bturb) (> 0). Typical value = 0,5.
- db1
Intentional deadband width (db1). Unit = Hz. Typical value = 0.
- db2
Unintentional deadband (db2). Unit = MW. Typical value = 0.
- eps
Intentional db hysteresis (eps). Unit = Hz. Typical value = 0.
- gv1
Nonlinear gain point 1, PU gv (Gv1). Typical value = 0.
- gv2
Nonlinear gain point 2, PU gv (Gv2). Typical value = 0.
- gv3
Nonlinear gain point 3, PU gv (Gv3). Typical value = 0.
- gv4
Nonlinear gain point 4, PU gv (Gv4). Typical value = 0.
- gv5
Nonlinear gain point 5, PU gv (Gv5). Typical value = 0.
- gv6
Nonlinear gain point 6, PU gv (Gv6). Typical value = 0.
- kturb
Turbine gain (Kturb). Typical value = 1.
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- pgv1
Nonlinear gain point 1, PU power (Pgv1). Typical value = 0.
- pgv2
Nonlinear gain point 2, PU power (Pgv2). Typical value = 0.
- pgv3
Nonlinear gain point 3, PU power (Pgv3). Typical value = 0.
- pgv4
Nonlinear gain point 4, PU power (Pgv4). Typical value = 0.
- pgv5
Nonlinear gain point 5, PU power (Pgv5). Typical value = 0.
- pgv6
Nonlinear gain point 6, PU power (Pgv6). Typical value = 0.
- pmax
Maximum gate opening (Pmax) (> GovHydro2.pmin). Typical value = 1.
- pmin
Minimum gate opening (Pmin) (< GovHydro2.pmax). Typical value = 0.
- rperm
Permanent droop (Rperm). Typical value = 0,05.
- rtemp
Temporary droop (Rtemp). Typical value = 0,5.
- tg
Gate servo time constant (Tg) (> 0). Typical value = 0,5.
- tp
Pilot servo valve time constant (Tp) (>= 0). Typical value = 0,03.
- tr
Dashpot time constant (Tr) (>= 0). Typical value = 12.
- tw
Water inertia time constant (Tw) (>= 0). Typical value = 2.
- uc
Maximum gate closing velocity (Uc) (< 0). Unit = PU / s. Typical value = -0,1.
- uo
Maximum gate opening velocity (Uo). Unit = PU / s. Typical value = 0,1.
-
final
case class
GovHydro3(TurbineGovernorDynamics: TurbineGovernorDynamics = null, at: Double = 0.0, db1: Double = 0.0, db2: Double = 0.0, dturb: Double = 0.0, eps: Double = 0.0, governorControl: Boolean = false, gv1: Double = 0.0, gv2: Double = 0.0, gv3: Double = 0.0, gv4: Double = 0.0, gv5: Double = 0.0, gv6: Double = 0.0, h0: Double = 0.0, k1: Double = 0.0, k2: Double = 0.0, kg: Double = 0.0, ki: Double = 0.0, mwbase: Double = 0.0, pgv1: Double = 0.0, pgv2: Double = 0.0, pgv3: Double = 0.0, pgv4: Double = 0.0, pgv5: Double = 0.0, pgv6: Double = 0.0, pmax: Double = 0.0, pmin: Double = 0.0, qnl: Double = 0.0, relec: Double = 0.0, rgate: Double = 0.0, td: Double = 0.0, tf: Double = 0.0, tp: Double = 0.0, tt: Double = 0.0, tw: Double = 0.0, velcl: Double = 0.0, velop: Double = 0.0) extends Element with Product with Serializable
Modified IEEE hydro governor-turbine.
Modified IEEE hydro governor-turbine.
This model differs from that defined in the IEEE modelling guideline paper in that the limits on gate position and velocity do not permit "wind up" of the upstream signals.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- at
Turbine gain (At) (>0). Typical value = 1,2.
- db1
Intentional dead-band width (db1). Unit = Hz. Typical value = 0.
- db2
Unintentional dead-band (db2). Unit = MW. Typical value = 0.
- dturb
Turbine damping factor (Dturb). Typical value = 0,2.
- eps
Intentional db hysteresis (eps). Unit = Hz. Typical value = 0.
- governorControl
Governor control flag (Cflag). true = PID control is active false = double derivative control is active. Typical value = true.
- gv1
Nonlinear gain point 1, PU gv (Gv1). Typical value = 0.
- gv2
Nonlinear gain point 2, PU gv (Gv2). Typical value = 0.
- gv3
Nonlinear gain point 3, PU gv (Gv3). Typical value = 0.
- gv4
Nonlinear gain point 4, PU gv (Gv4). Typical value = 0.
- gv5
Nonlinear gain point 5, PU gv (Gv5). Typical value = 0.
- gv6
Nonlinear gain point 6, PU gv (Gv6). Typical value = 0.
- h0
Turbine nominal head (H0). Typical value = 1.
- k1
Derivative gain (K1). Typical value = 0,01.
- k2
Double derivative gain, if Cflag = -1 (K2). Typical value = 2,5.
- kg
Gate servo gain (Kg). Typical value = 2.
- ki
Integral gain (Ki). Typical value = 0,5.
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- pgv1
Nonlinear gain point 1, PU power (Pgv1). Typical value = 0.
- pgv2
Nonlinear gain point 2, PU power (Pgv2). Typical value = 0.
- pgv3
Nonlinear gain point 3, PU power (Pgv3). Typical value = 0.
- pgv4
Nonlinear gain point 4, PU power (Pgv4). Typical value = 0.
- pgv5
Nonlinear gain point 5, PU power (Pgv5). Typical value = 0.
- pgv6
Nonlinear gain point 6, PU power (Pgv6). Typical value = 0.
- pmax
Maximum gate opening, PU of MWbase (Pmax) (> GovHydro3.pmin). Typical value = 1.
- pmin
Minimum gate opening, PU of MWbase (Pmin) (< GovHydro3.pmax). Typical value = 0.
- qnl
No-load turbine flow at nominal head (Qnl). Typical value = 0,08.
- relec
Steady-state droop, PU, for electrical power feedback (Relec). Typical value = 0,05.
- rgate
Steady-state droop, PU, for governor output feedback (Rgate). Typical value = 0.
- td
Input filter time constant (Td) (>= 0). Typical value = 0,05.
- tf
Washout time constant (Tf) (>= 0). Typical value = 0,1.
- tp
Gate servo time constant (Tp) (>= 0). Typical value = 0,05.
- tt
Power feedback time constant (Tt) (>= 0). Typical value = 0,2.
- tw
Water inertia time constant (Tw) (>= 0). If = 0, block is bypassed. Typical value = 1.
- velcl
Maximum gate closing velocity (Velcl). Unit = PU / s. Typical value = -0,2.
- velop
Maximum gate opening velocity (Velop). Unit = PU / s. Typical value = 0,2.
-
final
case class
GovHydro4(TurbineGovernorDynamics: TurbineGovernorDynamics = null, at: Double = 0.0, bgv0: Double = 0.0, bgv1: Double = 0.0, bgv2: Double = 0.0, bgv3: Double = 0.0, bgv4: Double = 0.0, bgv5: Double = 0.0, bmax: Double = 0.0, db1: Double = 0.0, db2: Double = 0.0, dturb: Double = 0.0, eps: Double = 0.0, gmax: Double = 0.0, gmin: Double = 0.0, gv0: Double = 0.0, gv1: Double = 0.0, gv2: Double = 0.0, gv3: Double = 0.0, gv4: Double = 0.0, gv5: Double = 0.0, hdam: Double = 0.0, model: String = null, mwbase: Double = 0.0, pgv0: Double = 0.0, pgv1: Double = 0.0, pgv2: Double = 0.0, pgv3: Double = 0.0, pgv4: Double = 0.0, pgv5: Double = 0.0, qnl: Double = 0.0, rperm: Double = 0.0, rtemp: Double = 0.0, tblade: Double = 0.0, tg: Double = 0.0, tp: Double = 0.0, tr: Double = 0.0, tw: Double = 0.0, uc: Double = 0.0, uo: Double = 0.0) extends Element with Product with Serializable
Hydro turbine and governor.
Hydro turbine and governor.
Represents plants with straight-forward penstock configurations and hydraulic governors of the traditional 'dashpot' type. This model can be used to represent simple, Francis/Pelton or Kaplan turbines.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- at
Turbine gain (At). Typical value = 1,2.
- bgv0
Kaplan blade servo point 0 (Bgv0) (= 0 for simple, = 0 for Francis/Pelton). Typical value for Kaplan = 0.
- bgv1
Kaplan blade servo point 1 (Bgv1) (= 0 for simple, = 0 for Francis/Pelton). Typical value for Kaplan = 0.
- bgv2
Kaplan blade servo point 2 (Bgv2) (= 0 for simple, = 0 for Francis/Pelton). Typical value for Kaplan = 0,1.
- bgv3
Kaplan blade servo point 3 (Bgv3) (= 0 for simple, = 0 for Francis/Pelton). Typical value for Kaplan = 0,667.
- bgv4
Kaplan blade servo point 4 (Bgv4) (= 0 for simple, = 0 for Francis/Pelton). Typical value for Kaplan = 0,9.
- bgv5
Kaplan blade servo point 5 (Bgv5) (= 0 for simple, = 0 for Francis/Pelton). Typical value for Kaplan = 1.
- bmax
Maximum blade adjustment factor (Bmax) (= 0 for simple, = 0 for Francis/Pelton). Typical value for Kaplan = 1,1276.
- db1
Intentional deadband width (db1). Unit = Hz. Typical value = 0.
- db2
Unintentional dead-band (db2). Unit = MW. Typical value = 0.
- dturb
Turbine damping factor (Dturb). Unit = delta P (PU of MWbase) / delta speed (PU). Typical value for simple = 0,5, Francis/Pelton = 1,1, Kaplan = 1,1.
- eps
Intentional db hysteresis (eps). Unit = Hz. Typical value = 0.
- gmax
Maximum gate opening, PU of MWbase (Gmax) (> GovHydro4.gmin). Typical value = 1.
- gmin
Minimum gate opening, PU of MWbase (Gmin) (< GovHydro4.gmax). Typical value = 0.
- gv0
Nonlinear gain point 0, PU gv (Gv0) (= 0 for simple). Typical for Francis/Pelton = 0,1, Kaplan = 0,1.
- gv1
Nonlinear gain point 1, PU gv (Gv1) (= 0 for simple, > GovHydro4.gv0 for Francis/Pelton and Kaplan). Typical value for Francis/Pelton = 0,4, Kaplan = 0,4.
- gv2
Nonlinear gain point 2, PU gv (Gv2) (= 0 for simple, > GovHydro4.gv1 for Francis/Pelton and Kaplan). Typical value for Francis/Pelton = 0,5, Kaplan = 0,5.
- gv3
Nonlinear gain point 3, PU gv (Gv3) (= 0 for simple, > GovHydro4.gv2 for Francis/Pelton and Kaplan). Typical value for Francis/Pelton = 0,7, Kaplan = 0,7.
- gv4
Nonlinear gain point 4, PU gv (Gv4) (= 0 for simple, > GovHydro4.gv3 for Francis/Pelton and Kaplan). Typical value for Francis/Pelton = 0,8, Kaplan = 0,8.
- gv5
Nonlinear gain point 5, PU gv (Gv5) (= 0 for simple, < 1 and > GovHydro4.gv4 for Francis/Pelton and Kaplan). Typical value for Francis/Pelton = 0,9, Kaplan = 0,9.
- hdam
Head available at dam (hdam). Typical value = 1.
- model
The kind of model being represented (simple, Francis/Pelton or Kaplan).
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- pgv0
Nonlinear gain point 0, PU power (Pgv0) (= 0 for simple). Typical value = 0.
- pgv1
Nonlinear gain point 1, PU power (Pgv1) (= 0 for simple). Typical value for Francis/Pelton = 0,42, Kaplan = 0,35.
- pgv2
Nonlinear gain point 2, PU power (Pgv2) (= 0 for simple). Typical value for Francis/Pelton = 0,56, Kaplan = 0,468.
- pgv3
Nonlinear gain point 3, PU power (Pgv3) (= 0 for simple). Typical value for Francis/Pelton = 0,8, Kaplan = 0,796.
- pgv4
Nonlinear gain point 4, PU power (Pgv4) (= 0 for simple). Typical value for Francis/Pelton = 0,9, Kaplan = 0,917.
- pgv5
Nonlinear gain point 5, PU power (Pgv5) (= 0 for simple). Typical value for Francis/Pelton = 0,97, Kaplan = 0,99.
- qnl
No-load flow at nominal head (Qnl). Typical value for simple = 0,08, Francis/Pelton = 0, Kaplan = 0.
- rperm
Permanent droop (Rperm) (>= 0). Typical value = 0,05.
- rtemp
Temporary droop (Rtemp) (>= 0). Typical value = 0,3.
- tblade
Blade servo time constant (Tblade) (>= 0). Typical value = 100.
- tg
Gate servo time constant (Tg) (> 0). Typical value = 0,5.
- tp
Pilot servo time constant (Tp) (>= 0). Typical value = 0,1.
- tr
Dashpot time constant (Tr) (>= 0). Typical value = 5.
- tw
Water inertia time constant (Tw) (> 0). Typical value = 1.
- uc
Max gate closing velocity (Uc). Typical value = 0,2.
- uo
Max gate opening velocity (Uo). Typical value = 0,2.
-
final
case class
GovHydroDD(TurbineGovernorDynamics: TurbineGovernorDynamics = null, aturb: Double = 0.0, bturb: Double = 0.0, db1: Double = 0.0, db2: Double = 0.0, eps: Double = 0.0, gmax: Double = 0.0, gmin: Double = 0.0, gv1: Double = 0.0, gv2: Double = 0.0, gv3: Double = 0.0, gv4: Double = 0.0, gv5: Double = 0.0, gv6: Double = 0.0, inputSignal: Boolean = false, k1: Double = 0.0, k2: Double = 0.0, kg: Double = 0.0, ki: Double = 0.0, mwbase: Double = 0.0, pgv1: Double = 0.0, pgv2: Double = 0.0, pgv3: Double = 0.0, pgv4: Double = 0.0, pgv5: Double = 0.0, pgv6: Double = 0.0, pmax: Double = 0.0, pmin: Double = 0.0, r: Double = 0.0, td: Double = 0.0, tf: Double = 0.0, tp: Double = 0.0, tt: Double = 0.0, tturb: Double = 0.0, velcl: Double = 0.0, velop: Double = 0.0) extends Element with Product with Serializable
Double derivative hydro governor and turbine.
Double derivative hydro governor and turbine.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- aturb
Turbine numerator multiplier (Aturb) (see parameter detail 3). Typical value = -1.
- bturb
Turbine denominator multiplier (Bturb) (see parameter detail 3). Typical value = 0,5.
- db1
Intentional dead-band width (db1). Unit = Hz. Typical value = 0.
- db2
Unintentional dead-band (db2). Unit = MW. Typical value = 0.
- eps
Intentional db hysteresis (eps). Unit = Hz. Typical value = 0.
- gmax
Maximum gate opening (Gmax) (> GovHydroDD.gmin). Typical value = 0.
- gmin
Minimum gate opening (Gmin) (< GovHydroDD.gmax). Typical value = 0.
- gv1
Nonlinear gain point 1, PU gv (Gv1). Typical value = 0.
- gv2
Nonlinear gain point 2, PU gv (Gv2). Typical value = 0.
- gv3
Nonlinear gain point 3, PU gv (Gv3). Typical value = 0.
- gv4
Nonlinear gain point 4, PU gv (Gv4). Typical value = 0.
- gv5
Nonlinear gain point 5, PU gv (Gv5). Typical value = 0.
- gv6
Nonlinear gain point 6, PU gv (Gv6). Typical value = 0.
- inputSignal
Input signal switch (Flag). true = Pe input is used false = feedback is received from CV. Flag is normally dependent on Tt. If Tt is zero, Flag is set to false. If Tt is not zero, Flag is set to true. Typical value = true.
- k1
Single derivative gain (K1). Typical value = 3,6.
- k2
Double derivative gain (K2). Typical value = 0,2.
- kg
Gate servo gain (Kg). Typical value = 3.
- ki
Integral gain (Ki). Typical value = 1.
- mwbase
Base for power values (MWbase) (>0). Unit = MW.
- pgv1
Nonlinear gain point 1, PU power (Pgv1). Typical value = 0.
- pgv2
Nonlinear gain point 2, PU power (Pgv2). Typical value = 0.
- pgv3
Nonlinear gain point 3, PU power (Pgv3). Typical value = 0.
- pgv4
Nonlinear gain point 4, PU power (Pgv4). Typical value = 0.
- pgv5
Nonlinear gain point 5, PU power (Pgv5). Typical value = 0.
- pgv6
Nonlinear gain point 6, PU power (Pgv6). Typical value = 0.
- pmax
Maximum gate opening, PU of MWbase (Pmax) (> GovHydroDD.pmin). Typical value = 1.
- pmin
Minimum gate opening, PU of MWbase (Pmin) (> GovHydroDD.pmax). Typical value = 0.
- r
Steady state droop (R). Typical value = 0,05.
- td
Input filter time constant (Td) (>= 0). If = 0, block is bypassed. Typical value = 0.
- tf
Washout time constant (Tf) (>= 0). Typical value = 0,1.
- tp
Gate servo time constant (Tp) (>= 0). If = 0, block is bypassed. Typical value = 0,35.
- tt
Power feedback time constant (Tt) (>= 0). If = 0, block is bypassed. Typical value = 0,02.
- tturb
Turbine time constant (Tturb) (>= 0). See parameter detail 3. Typical value = 0,8.
- velcl
Maximum gate closing velocity (Velcl). Unit = PU / s. Typical value = -0,14.
- velop
Maximum gate opening velocity (Velop). Unit = PU / s. Typical value = 0,09.
-
final
case class
GovHydroFrancis(TurbineGovernorDynamics: TurbineGovernorDynamics = null, am: Double = 0.0, av0: Double = 0.0, av1: Double = 0.0, bp: Double = 0.0, db1: Double = 0.0, etamax: Double = 0.0, governorControl: String = null, h1: Double = 0.0, h2: Double = 0.0, hn: Double = 0.0, kc: Double = 0.0, kg: Double = 0.0, kt: Double = 0.0, qc0: Double = 0.0, qn: Double = 0.0, ta: Double = 0.0, td: Double = 0.0, ts: Double = 0.0, twnc: Double = 0.0, twng: Double = 0.0, tx: Double = 0.0, va: Double = 0.0, valvmax: Double = 0.0, valvmin: Double = 0.0, vc: Double = 0.0, waterTunnelSurgeChamberSimulation: Boolean = false, zsfc: Double = 0.0) extends Element with Product with Serializable
Detailed hydro unit - Francis model.
Detailed hydro unit - Francis model.
This model can be used to represent three types of governors. A schematic of the hydraulic system of detailed hydro unit models, such as Francis and Pelton, is provided in the DetailedHydroModelHydraulicSystem diagram.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- am
Opening section SEFF at the maximum efficiency (Am). Typical value = 0,7.
- av0
Area of the surge tank (AV0). Unit = m2. Typical value = 30.
- av1
Area of the compensation tank (AV1). Unit = m2. Typical value = 700.
- bp
Droop (Bp). Typical value = 0,05.
- db1
Intentional dead-band width (DB1). Unit = Hz. Typical value = 0.
- etamax
Maximum efficiency (EtaMax). Typical value = 1,05.
- governorControl
Governor control flag (Cflag). Typical value = mechanicHydrolicTachoAccelerator.
- h1
Head of compensation chamber water level with respect to the level of penstock (H1). Unit = km. Typical value = 0,004.
- h2
Head of surge tank water level with respect to the level of penstock (H2). Unit = km. Typical value = 0,040.
- hn
Rated hydraulic head (Hn). Unit = km. Typical value = 0,250.
- kc
Penstock loss coefficient (due to friction) (Kc). Typical value = 0,025.
- kg
Water tunnel and surge chamber loss coefficient (due to friction) (Kg). Typical value = 0,025.
- kt
Washout gain (Kt). Typical value = 0,25.
- qc0
No-load turbine flow at nominal head (Qc0). Typical value = 0,1.
- qn
Rated flow (Qn). Unit = m3/s. Typical value = 250.
- ta
Derivative gain (Ta) (>= 0). Typical value = 3.
- td
Washout time constant (Td) (>= 0). Typical value = 6.
- ts
Gate servo time constant (Ts) (>= 0). Typical value = 0,5.
- twnc
Water inertia time constant (Twnc) (>= 0). Typical value = 1.
- twng
Water tunnel and surge chamber inertia time constant (Twng) (>= 0). Typical value = 3.
- tx
Derivative feedback gain (Tx) (>= 0). Typical value = 1.
- va
Maximum gate opening velocity (Va). Unit = PU / s. Typical value = 0,06.
- valvmax
Maximum gate opening (ValvMax) (> GovHydroFrancis.valvmin). Typical value = 1,1.
- valvmin
Minimum gate opening (ValvMin) (< GovHydroFrancis.valvmax). Typical value = 0.
- vc
Maximum gate closing velocity (Vc). Unit = PU / s. Typical value = -0,06.
- waterTunnelSurgeChamberSimulation
Water tunnel and surge chamber simulation (Tflag). true = enable of water tunnel and surge chamber simulation false = inhibit of water tunnel and surge chamber simulation. Typical value = false.
- zsfc
Head of upper water level with respect to the level of penstock (Zsfc). Unit = km. Typical value = 0,025.
-
final
case class
GovHydroIEEE0(TurbineGovernorDynamics: TurbineGovernorDynamics = null, k: Double = 0.0, mwbase: Double = 0.0, pmax: Double = 0.0, pmin: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0) extends Element with Product with Serializable
IEEE simplified hydro governor-turbine model.
IEEE simplified hydro governor-turbine model.
Used for mechanical-hydraulic and electro-hydraulic turbine governors, with or without steam feedback. Typical values given are for mechanical-hydraulic turbine-governor. Ref<font color="#0f0f0f">erence: IEEE Transactions on Power Apparatus and Systems, November/December 1973, Volume PAS-92, Number 6, Dynamic Models for Steam and Hydro Turbines in Power System Studies, page 1904.</font>
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- k
Governor gain (K).
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- pmax
Gate maximum (Pmax) (> GovHydroIEEE0.pmin).
- pmin
Gate minimum (Pmin) (< GovHydroIEEE.pmax).
- t1
Governor lag time constant (T1) (>= 0). Typical value = 0,25.
- t2
Governor lead time constant (T2) (>= 0). Typical value = 0.
- t3
Gate actuator time constant (T3) (>= 0). Typical value = 0,1.
- t4
Water starting time (T4) (>= 0).
-
final
case class
GovHydroIEEE2(TurbineGovernorDynamics: TurbineGovernorDynamics = null, aturb: Double = 0.0, bturb: Double = 0.0, gv1: Double = 0.0, gv2: Double = 0.0, gv3: Double = 0.0, gv4: Double = 0.0, gv5: Double = 0.0, gv6: Double = 0.0, kturb: Double = 0.0, mwbase: Double = 0.0, pgv1: Double = 0.0, pgv2: Double = 0.0, pgv3: Double = 0.0, pgv4: Double = 0.0, pgv5: Double = 0.0, pgv6: Double = 0.0, pmax: Double = 0.0, pmin: Double = 0.0, rperm: Double = 0.0, rtemp: Double = 0.0, tg: Double = 0.0, tp: Double = 0.0, tr: Double = 0.0, tw: Double = 0.0, uc: Double = 0.0, uo: Double = 0.0) extends Element with Product with Serializable
IEEE hydro turbine governor model represents plants with straightforward penstock configurations and hydraulic-dashpot governors.
IEEE hydro turbine governor model represents plants with straightforward penstock configurations and hydraulic-dashpot governors.
Ref<font color="#0f0f0f">erence: IEEE Transactions on Power Apparatus and Systems, November/December 1973, Volume PAS-92, Number 6, Dynamic Models for Steam and Hydro Turbines in Power System Studies, page 1904.</font>
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- aturb
Turbine numerator multiplier (Aturb). Typical value = -1.
- bturb
Turbine denominator multiplier (Bturb) (> 0). Typical value = 0,5.
- gv1
Nonlinear gain point 1, PU gv (Gv1). Typical value = 0.
- gv2
Nonlinear gain point 2, PU gv (Gv2). Typical value = 0.
- gv3
Nonlinear gain point 3, PU gv (Gv3). Typical value = 0.
- gv4
Nonlinear gain point 4, PU gv (Gv4). Typical value = 0.
- gv5
Nonlinear gain point 5, PU gv (Gv5). Typical value = 0.
- gv6
Nonlinear gain point 6, PU gv (Gv6). Typical value = 0.
- kturb
Turbine gain (Kturb). Typical value = 1.
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- pgv1
Nonlinear gain point 1, PU power (Pgv1). Typical value = 0.
- pgv2
Nonlinear gain point 2, PU power (Pgv2). Typical value = 0.
- pgv3
Nonlinear gain point 3, PU power (Pgv3). Typical value = 0.
- pgv4
Nonlinear gain point 4, PU power (Pgv4). Typical value = 0.
- pgv5
Nonlinear gain point 5, PU power (Pgv5). Typical value = 0.
- pgv6
Nonlinear gain point 6, PU power (Pgv6). Typical value = 0.
- pmax
Maximum gate opening (Pmax) (> GovHydroIEEE2.pmin). Typical value = 1.
- pmin
Minimum gate opening (Pmin) (<GovHydroIEEE2.pmax). Typical value = 0.
- rperm
Permanent droop (Rperm). Typical value = 0,05.
- rtemp
Temporary droop (Rtemp). Typical value = 0,5.
- tg
Gate servo time constant (Tg) (>= 0). Typical value = 0,5.
- tp
Pilot servo valve time constant (Tp) (>= 0). Typical value = 0,03.
- tr
Dashpot time constant (Tr) (>= 0). Typical value = 12.
- tw
Water inertia time constant (Tw) (>= 0). Typical value = 2.
- uc
Maximum gate closing velocity (Uc) (<0). Typical value = -0,1.
- uo
Maximum gate opening velocity (Uo). Unit = PU / s. Typical value = 0,1.
-
final
case class
GovHydroPID(TurbineGovernorDynamics: TurbineGovernorDynamics = null, aturb: Double = 0.0, bturb: Double = 0.0, db1: Double = 0.0, db2: Double = 0.0, eps: Double = 0.0, gv1: Double = 0.0, gv2: Double = 0.0, gv3: Double = 0.0, gv4: Double = 0.0, gv5: Double = 0.0, gv6: Double = 0.0, inputSignal: Boolean = false, kd: Double = 0.0, kg: Double = 0.0, ki: Double = 0.0, kp: Double = 0.0, mwbase: Double = 0.0, pgv1: Double = 0.0, pgv2: Double = 0.0, pgv3: Double = 0.0, pgv4: Double = 0.0, pgv5: Double = 0.0, pgv6: Double = 0.0, pmax: Double = 0.0, pmin: Double = 0.0, r: Double = 0.0, td: Double = 0.0, tf: Double = 0.0, tp: Double = 0.0, tt: Double = 0.0, tturb: Double = 0.0, velcl: Double = 0.0, velop: Double = 0.0) extends Element with Product with Serializable
PID governor and turbine.
PID governor and turbine.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- aturb
Turbine numerator multiplier (Aturb) (see parameter detail 3). Typical value -1.
- bturb
Turbine denominator multiplier (Bturb) (see parameter detail 3). Typical value = 0,5.
- db1
Intentional dead-band width (db1). Unit = Hz. Typical value = 0.
- db2
Unintentional dead-band (db2). Unit = MW. Typical value = 0.
- eps
Intentional db hysteresis (eps). Unit = Hz. Typical value = 0.
- gv1
Nonlinear gain point 1, PU gv (Gv1). Typical value = 0.
- gv2
Nonlinear gain point 2, PU gv (Gv2). Typical value = 0.
- gv3
Nonlinear gain point 3, PU gv (Gv3). Typical value = 0.
- gv4
Nonlinear gain point 4, PU gv (Gv4). Typical value = 0.
- gv5
Nonlinear gain point 5, PU gv (Gv5). Typical value = 0.
- gv6
Nonlinear gain point 6, PU gv (Gv6). Typical value = 0.
- inputSignal
Input signal switch (Flag). true = Pe input is used false = feedback is received from CV. Flag is normally dependent on Tt. If Tt is zero, Flag is set to false. If Tt is not zero, Flag is set to true. Typical value = true.
- kd
Derivative gain (Kd). Typical value = 1,11.
- kg
Gate servo gain (Kg). Typical value = 2,5.
- ki
Integral gain (Ki). Typical value = 0,36.
- kp
Proportional gain (Kp). Typical value = 0,1.
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- pgv1
Nonlinear gain point 1, PU power (Pgv1). Typical value = 0.
- pgv2
Nonlinear gain point 2, PU power (Pgv2). Typical value = 0.
- pgv3
Nonlinear gain point 3, PU power (Pgv3). Typical value = 0.
- pgv4
Nonlinear gain point 4, PU power (Pgv4). Typical value = 0.
- pgv5
Nonlinear gain point 5, PU power (Pgv5). Typical value = 0.
- pgv6
Nonlinear gain point 6, PU power (Pgv6). Typical value = 0.
- pmax
Maximum gate opening, PU of MWbase (Pmax) (> GovHydroPID.pmin). Typical value = 1.
- pmin
Minimum gate opening, PU of MWbase (Pmin) (< GovHydroPID.pmax). Typical value = 0.
- r
Steady state droop (R). Typical value = 0,05.
- td
Input filter time constant (Td) (>= 0). If = 0, block is bypassed. Typical value = 0.
- tf
Washout time constant (Tf) (>= 0). Typical value = 0,1.
- tp
Gate servo time constant (Tp) (>= 0). If = 0, block is bypassed. Typical value = 0,35.
- tt
Power feedback time constant (Tt) (>= 0). If = 0, block is bypassed. Typical value = 0,02.
- tturb
Turbine time constant (Tturb) (>= 0). See Parameter detail 3. Typical value = 0,8.
- velcl
Maximum gate closing velocity (Velcl). Unit = PU / s. Typical value = -0,14.
- velop
Maximum gate opening velocity (Velop). Unit = PU / s. Typical value = 0,09.
-
final
case class
GovHydroPID2(TurbineGovernorDynamics: TurbineGovernorDynamics = null, atw: Double = 0.0, d: Double = 0.0, feedbackSignal: Boolean = false, g0: Double = 0.0, g1: Double = 0.0, g2: Double = 0.0, gmax: Double = 0.0, gmin: Double = 0.0, kd: Double = 0.0, ki: Double = 0.0, kp: Double = 0.0, mwbase: Double = 0.0, p1: Double = 0.0, p2: Double = 0.0, p3: Double = 0.0, rperm: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, treg: Double = 0.0, tw: Double = 0.0, velmax: Double = 0.0, velmin: Double = 0.0) extends Element with Product with Serializable
Hydro turbine and governor.
Hydro turbine and governor.
Represents plants with straightforward penstock configurations and "three term" electro-hydraulic governors (i.e. WoodwardTM electronic). [Footnote: Woodward electronic governors are an example of suitable products available commercially. This information is given for the convenience of users of this document and does not constitute an endorsement by IEC of these products.]
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- atw
Factor multiplying Tw (Atw). Typical value = 0.
- d
Turbine damping factor (D). Unit = delta P / delta speed. Typical value = 0.
- feedbackSignal
Feedback signal type flag (Flag). true = use gate position feedback signal false = use Pe.
- g0
Gate opening at speed no load (G0). Typical value = 0.
- g1
Intermediate gate opening (G1). Typical value = 0.
- g2
Intermediate gate opening (G2). Typical value = 0.
- gmax
Maximum gate opening (Gmax) (> GovHydroPID2.gmin). Typical value = 0.
- gmin
Minimum gate opening (Gmin) (> GovHydroPID2.gmax). Typical value = 0.
- kd
Derivative gain (Kd). Typical value = 0.
- ki
Reset gain (Ki). Unit = PU/s. Typical value = 0.
- kp
Proportional gain (Kp). Typical value = 0.
- mwbase
Base for power values (MWbase) (>0). Unit = MW.
- p1
Power at gate opening G1 (P1). Typical value = 0.
- p2
Power at gate opening G2 (P2). Typical value = 0.
- p3
Power at full opened gate (P3). Typical value = 0.
- rperm
Permanent drop (Rperm). Typical value = 0.
- ta
Controller time constant (Ta) (>= 0). Typical value = 0.
- tb
Gate servo time constant (Tb) (> 0).
- treg
Speed detector time constant (Treg) (>= 0). Typical value = 0.
- tw
Water inertia time constant (Tw) (>= 0). Typical value = 0.
- velmax
Maximum gate opening velocity (Velmax) (< GovHydroPID2.velmin). Unit = PU / s. Typical value = 0.
- velmin
Maximum gate closing velocity (Velmin) (> GovHydroPID2.velmax). Unit = PU / s. Typical value = 0.
-
final
case class
GovHydroPelton(TurbineGovernorDynamics: TurbineGovernorDynamics = null, av0: Double = 0.0, av1: Double = 0.0, bp: Double = 0.0, db1: Double = 0.0, db2: Double = 0.0, h1: Double = 0.0, h2: Double = 0.0, hn: Double = 0.0, kc: Double = 0.0, kg: Double = 0.0, qc0: Double = 0.0, qn: Double = 0.0, simplifiedPelton: Boolean = false, staticCompensating: Boolean = false, ta: Double = 0.0, ts: Double = 0.0, tv: Double = 0.0, twnc: Double = 0.0, twng: Double = 0.0, tx: Double = 0.0, va: Double = 0.0, valvmax: Double = 0.0, valvmin: Double = 0.0, vav: Double = 0.0, vc: Double = 0.0, vcv: Double = 0.0, waterTunnelSurgeChamberSimulation: Boolean = false, zsfc: Double = 0.0) extends Element with Product with Serializable
Detailed hydro unit - Pelton model.
Detailed hydro unit - Pelton model.
This model can be used to represent the dynamic related to water tunnel and surge chamber. The DetailedHydroModelHydraulicSystem diagram, located under the GovHydroFrancis class, provides a schematic of the hydraulic system of detailed hydro unit models, such as Francis and Pelton.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- av0
Area of the surge tank (AV0). Unit = m2. Typical value = 30.
- av1
Area of the compensation tank (AV1). Unit = m2. Typical value = 700.
- bp
Droop (bp). Typical value = 0,05.
- db1
Intentional dead-band width (DB1). Unit = Hz. Typical value = 0.
- db2
Intentional dead-band width of valve opening error (DB2). Unit = Hz. Typical value = 0,01.
- h1
Head of compensation chamber water level with respect to the level of penstock (H1). Unit = km. Typical value = 0,004.
- h2
Head of surge tank water level with respect to the level of penstock (H2). Unit = km. Typical value = 0,040.
- hn
Rated hydraulic head (Hn). Unit = km. Typical value = 0,250.
- kc
Penstock loss coefficient (due to friction) (Kc). Typical value = 0,025.
- kg
Water tunnel and surge chamber loss coefficient (due to friction) (Kg). Typical value = 0,025.
- qc0
No-load turbine flow at nominal head (Qc0). Typical value = 0,05.
- qn
Rated flow (Qn). Unit = m3/s. Typical value = 250.
- simplifiedPelton
Simplified Pelton model simulation (Sflag). true = enable of simplified Pelton model simulation false = enable of complete Pelton model simulation (non-linear gain). Typical value = true.
- staticCompensating
Static compensating characteristic (Cflag). It should be true if simplifiedPelton = false. true = enable of static compensating characteristic false = inhibit of static compensating characteristic. Typical value = false.
- ta
Derivative gain (accelerometer time constant) (Ta) (>= 0). Typical value = 3.
- ts
Gate servo time constant (Ts) (>= 0). Typical value = 0,15.
- tv
Servomotor integrator time constant (Tv) (>= 0). Typical value = 0,3.
- twnc
Water inertia time constant (Twnc) (>= 0). Typical value = 1.
- twng
Water tunnel and surge chamber inertia time constant (Twng) (>= 0). Typical value = 3.
- tx
Electronic integrator time constant (Tx) (>= 0). Typical value = 0,5.
- va
Maximum gate opening velocity (Va). Unit = PU / s. Typical value = 0,06.
- valvmax
Maximum gate opening (ValvMax) (> GovHydroPelton.valvmin). Typical value = 1,1.
- valvmin
Minimum gate opening (ValvMin) (< GovHydroPelton.valvmax). Typical value = 0.
- vav
Maximum servomotor valve opening velocity (Vav). Typical value = 0,1.
- vc
Maximum gate closing velocity (Vc). Unit = PU / s. Typical value = -0,06.
- vcv
Maximum servomotor valve closing velocity (Vcv). Typical value = -0,1.
- waterTunnelSurgeChamberSimulation
Water tunnel and surge chamber simulation (Tflag). true = enable of water tunnel and surge chamber simulation false = inhibit of water tunnel and surge chamber simulation. Typical value = false.
- zsfc
Head of upper water level with respect to the level of penstock (Zsfc). Unit = km. Typical value = 0,025.
-
final
case class
GovHydroR(TurbineGovernorDynamics: TurbineGovernorDynamics = null, at: Double = 0.0, db1: Double = 0.0, db2: Double = 0.0, dturb: Double = 0.0, eps: Double = 0.0, gmax: Double = 0.0, gmin: Double = 0.0, gv1: Double = 0.0, gv2: Double = 0.0, gv3: Double = 0.0, gv4: Double = 0.0, gv5: Double = 0.0, gv6: Double = 0.0, h0: Double = 0.0, inputSignal: Boolean = false, kg: Double = 0.0, ki: Double = 0.0, mwbase: Double = 0.0, pgv1: Double = 0.0, pgv2: Double = 0.0, pgv3: Double = 0.0, pgv4: Double = 0.0, pgv5: Double = 0.0, pgv6: Double = 0.0, pmax: Double = 0.0, pmin: Double = 0.0, qnl: Double = 0.0, r: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, t5: Double = 0.0, t6: Double = 0.0, t7: Double = 0.0, t8: Double = 0.0, td: Double = 0.0, tp: Double = 0.0, tt: Double = 0.0, tw: Double = 0.0, velcl: Double = 0.0, velop: Double = 0.0) extends Element with Product with Serializable
Fourth order lead-lag governor and hydro turbine.
Fourth order lead-lag governor and hydro turbine.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- at
Turbine gain (At). Typical value = 1,2.
- db1
Intentional dead-band width (db1). Unit = Hz. Typical value = 0.
- db2
Unintentional dead-band (db2). Unit = MW. Typical value = 0.
- dturb
Turbine damping factor (Dturb). Typical value = 0,2.
- eps
Intentional db hysteresis (eps). Unit = Hz. Typical value = 0.
- gmax
Maximum governor output (Gmax) (> GovHydroR.gmin). Typical value = 1,05.
- gmin
Minimum governor output (Gmin) (< GovHydroR.gmax). Typical value = -0,05.
- gv1
Nonlinear gain point 1, PU gv (Gv1). Typical value = 0.
- gv2
Nonlinear gain point 2, PU gv (Gv2). Typical value = 0.
- gv3
Nonlinear gain point 3, PU gv (Gv3). Typical value = 0.
- gv4
Nonlinear gain point 4, PU gv (Gv4). Typical value = 0.
- gv5
Nonlinear gain point 5, PU gv (Gv5). Typical value = 0.
- gv6
Nonlinear gain point 6, PU gv (Gv6). Typical value = 0.
- h0
Turbine nominal head (H0). Typical value = 1.
- inputSignal
Input signal switch (Flag). true = Pe input is used false = feedback is received from CV. Flag is normally dependent on Tt. If Tt is zero, Flag is set to false. If Tt is not zero, Flag is set to true. Typical value = true.
- kg
Gate servo gain (Kg). Typical value = 2.
- ki
Integral gain (Ki). Typical value = 0,5.
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- pgv1
Nonlinear gain point 1, PU power (Pgv1). Typical value = 0.
- pgv2
Nonlinear gain point 2, PU power (Pgv2). Typical value = 0.
- pgv3
Nonlinear gain point 3, PU power (Pgv3). Typical value = 0.
- pgv4
Nonlinear gain point 4, PU power (Pgv4). Typical value = 0.
- pgv5
Nonlinear gain point 5, PU power (Pgv5). Typical value = 0.
- pgv6
Nonlinear gain point 6, PU power (Pgv6). Typical value = 0.
- pmax
Maximum gate opening, PU of MWbase (Pmax) (> GovHydroR.pmin). Typical value = 1.
- pmin
Minimum gate opening, PU of MWbase (Pmin) (< GovHydroR.pmax). Typical value = 0.
- qnl
No-load turbine flow at nominal head (Qnl). Typical value = 0,08.
- r
Steady-state droop (R). Typical value = 0,05.
- t1
Lead time constant 1 (T1) (>= 0). Typical value = 1,5.
- t2
Lag time constant 1 (T2) (>= 0). Typical value = 0,1.
- t3
Lead time constant 2 (T3) (>= 0). Typical value = 1,5.
- t4
Lag time constant 2 (T4) (>= 0). Typical value = 0,1.
- t5
Lead time constant 3 (T5) (>= 0). Typical value = 0.
- t6
Lag time constant 3 (T6) (>= 0). Typical value = 0,05.
- t7
Lead time constant 4 (T7) (>= 0). Typical value = 0.
- t8
Lag time constant 4 (T8) (>= 0). Typical value = 0,05.
- td
Input filter time constant (Td) (>= 0). Typical value = 0,05.
- tp
Gate servo time constant (Tp) (>= 0). Typical value = 0,05.
- tt
Power feedback time constant (Tt) (>= 0). Typical value = 0.
- tw
Water inertia time constant (Tw) (> 0). Typical value = 1.
- velcl
Maximum gate closing velocity (Velcl). Unit = PU / s. Typical value = -0,2.
- velop
Maximum gate opening velocity (Velop). Unit = PU / s. Typical value = 0,2.
-
final
case class
GovHydroWEH(TurbineGovernorDynamics: TurbineGovernorDynamics = null, db: Double = 0.0, dicn: Double = 0.0, dpv: Double = 0.0, dturb: Double = 0.0, feedbackSignal: Boolean = false, fl1: Double = 0.0, fl2: Double = 0.0, fl3: Double = 0.0, fl4: Double = 0.0, fl5: Double = 0.0, fp1: Double = 0.0, fp10: Double = 0.0, fp2: Double = 0.0, fp3: Double = 0.0, fp4: Double = 0.0, fp5: Double = 0.0, fp6: Double = 0.0, fp7: Double = 0.0, fp8: Double = 0.0, fp9: Double = 0.0, gmax: Double = 0.0, gmin: Double = 0.0, gtmxcl: Double = 0.0, gtmxop: Double = 0.0, gv1: Double = 0.0, gv2: Double = 0.0, gv3: Double = 0.0, gv4: Double = 0.0, gv5: Double = 0.0, kd: Double = 0.0, ki: Double = 0.0, kp: Double = 0.0, mwbase: Double = 0.0, pmss1: Double = 0.0, pmss10: Double = 0.0, pmss2: Double = 0.0, pmss3: Double = 0.0, pmss4: Double = 0.0, pmss5: Double = 0.0, pmss6: Double = 0.0, pmss7: Double = 0.0, pmss8: Double = 0.0, pmss9: Double = 0.0, rpg: Double = 0.0, rpp: Double = 0.0, td: Double = 0.0, tdv: Double = 0.0, tg: Double = 0.0, tp: Double = 0.0, tpe: Double = 0.0, tw: Double = 0.0) extends Element with Product with Serializable
WoodwardTM electric hydro governor.
WoodwardTM electric hydro governor. [Footnote: Woodward electric hydro governors are an example of suitable products available commercially.
This information is given for the convenience of users of this document and does not constitute an endorsement by IEC of these products.]
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- db
Speed deadband (db).
- dicn
Value to allow the integral controller to advance beyond the gate limits (Dicn).
- dpv
Value to allow the pilot valve controller to advance beyond the gate limits (Dpv).
- dturb
Turbine damping factor (Dturb). Unit = delta P (PU of MWbase) / delta speed (PU).
- feedbackSignal
Feedback signal selection (Sw). true = PID output (if R-Perm-Gate = droop and R-Perm-Pe = 0) false = electrical power (if R-Perm-Gate = 0 and R-Perm-Pe = droop) or false = gate position (if R-Perm-Gate = droop and R-Perm-Pe = 0). Typical value = false.
- fl1
Flowgate 1 (Fl1). Flow value for gate position point 1 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow.
- fl2
Flowgate 2 (Fl2). Flow value for gate position point 2 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow.
- fl3
Flowgate 3 (Fl3). Flow value for gate position point 3 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow.
- fl4
Flowgate 4 (Fl4). Flow value for gate position point 4 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow.
- fl5
Flowgate 5 (Fl5). Flow value for gate position point 5 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow.
- fp1
Flow P1 (Fp1). Turbine flow value for point 1 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- fp10
Flow P10 (Fp10). Turbine flow value for point 10 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- fp2
Flow P2 (Fp2). Turbine flow value for point 2 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- fp3
Flow P3 (Fp3). Turbine flow value for point 3 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- fp4
Flow P4 (Fp4). Turbine flow value for point 4 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- fp5
Flow P5 (Fp5). Turbine flow value for point 5 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- fp6
Flow P6 (Fp6). Turbine flow value for point 6 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- fp7
Flow P7 (Fp7). Turbine flow value for point 7 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- fp8
Flow P8 (Fp8). Turbine flow value for point 8 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- fp9
Flow P9 (Fp9). Turbine flow value for point 9 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- gmax
Maximum gate position (Gmax) (> GovHydroWEH.gmin).
- gmin
Minimum gate position (Gmin) (< GovHydroWEH.gmax).
- gtmxcl
Maximum gate closing rate (Gtmxcl).
- gtmxop
Maximum gate opening rate (Gtmxop).
- gv1
Gate 1 (Gv1). Gate Position value for point 1 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow.
- gv2
Gate 2 (Gv2). Gate Position value for point 2 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow.
- gv3
Gate 3 (Gv3). Gate Position value for point 3 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow.
- gv4
Gate 4 (Gv4). Gate Position value for point 4 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow.
- gv5
Gate 5 (Gv5). Gate Position value for point 5 for lookup table representing water flow through the turbine as a function of gate position to produce steady state flow.
- kd
Derivative controller derivative gain (Kd).
- ki
Derivative controller Integral gain (Ki).
- kp
Derivative control gain (Kp).
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- pmss1
Pmss flow P1 (Pmss1). Mechanical power output for turbine flow point 1 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- pmss10
Pmss flow P10 (Pmss10). Mechanical power output for turbine flow point 10 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- pmss2
Pmss flow P2 (Pmss2). Mechanical power output for turbine flow point 2 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- pmss3
Pmss flow P3 (Pmss3). Mechanical power output for turbine flow point 3 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- pmss4
Pmss flow P4 (Pmss4). Mechanical power output for turbine flow point 4 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- pmss5
Pmss flow P5 (Pmss5). Mechanical power output for turbine flow point 5 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- pmss6
Pmss flow P6 (Pmss6). Mechanical power output for turbine flow point 6 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- pmss7
Pmss flow P7 (Pmss7). Mechanical power output for turbine flow point 7 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- pmss8
Pmss flow P8 (Pmss8). Mechanical power output for turbine flow point 8 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- pmss9
Pmss flow P9 (Pmss9). Mechanical power output for turbine flow point 9 for lookup table representing PU mechanical power on machine MVA rating as a function of turbine flow.
- rpg
Permanent droop for governor output feedback (R-Perm-Gate).
- rpp
Permanent droop for electrical power feedback (R-Perm-Pe).
- td
Derivative controller time constant (Td) (>= 0). Limits the derivative characteristic beyond a breakdown frequency to avoid amplification of high-frequency noise.
- tdv
Distributive valve time lag time constant (Tdv) (>= 0).
- tg
Value to allow the distribution valve controller to advance beyond the gate movement rate limit (Tg) (>= 0).
- tp
Pilot valve time lag time constant (Tp) (>= 0).
- tpe
Electrical power droop time constant (Tpe) (>= 0).
- tw
Water inertia time constant (Tw) (> 0).
-
final
case class
GovHydroWPID(TurbineGovernorDynamics: TurbineGovernorDynamics = null, d: Double = 0.0, gatmax: Double = 0.0, gatmin: Double = 0.0, gv1: Double = 0.0, gv2: Double = 0.0, gv3: Double = 0.0, kd: Double = 0.0, ki: Double = 0.0, kp: Double = 0.0, mwbase: Double = 0.0, pgv1: Double = 0.0, pgv2: Double = 0.0, pgv3: Double = 0.0, pmax: Double = 0.0, pmin: Double = 0.0, reg: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, treg: Double = 0.0, tw: Double = 0.0, velmax: Double = 0.0, velmin: Double = 0.0) extends Element with Product with Serializable
WoodwardTM PID hydro governor.
WoodwardTM PID hydro governor. [Footnote: Woodward PID hydro governors are an example of suitable products available commercially.
This information is given for the convenience of users of this document and does not constitute an endorsement by IEC of these products.]
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- d
Turbine damping factor (D). Unit = delta P / delta speed.
- gatmax
Gate opening limit maximum (Gatmax) (> GovHydroWPID.gatmin).
- gatmin
Gate opening limit minimum (Gatmin) (< GovHydroWPID.gatmax).
- gv1
Gate position 1 (Gv1).
- gv2
Gate position 2 (Gv2).
- gv3
Gate position 3 (Gv3) (= 1,0).
- kd
Derivative gain (Kd). Typical value = 1,11.
- ki
Reset gain (Ki). Typical value = 0,36.
- kp
Proportional gain (Kp). Typical value = 0,1.
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- pgv1
Output at Gv1 PU of MWbase (Pgv1).
- pgv2
Output at Gv2 PU of MWbase (Pgv2).
- pgv3
Output at Gv3 PU of MWbase (Pgv3).
- pmax
Maximum power output (Pmax) (> GovHydroWPID.pmin).
- pmin
Minimum power output (Pmin) (< GovHydroWPID.pmax).
- reg
Permanent drop (Reg).
- ta
Controller time constant (Ta) (>= 0). Typical value = 0.
- tb
Gate servo time constant (Tb) (>= 0). Typical value = 0.
- treg
Speed detector time constant (Treg) (>= 0).
- tw
Water inertia time constant (Tw) (>= 0). Typical value = 0.
- velmax
Maximum gate opening velocity (Velmax) (> GovHydroWPID.velmin). Unit = PU / s. Typical value = 0.
- velmin
Maximum gate closing velocity (Velmin) (< GovHydroWPID.velmax). Unit = PU / s. Typical value = 0.
-
final
case class
GovSteam0(TurbineGovernorDynamics: TurbineGovernorDynamics = null, dt: Double = 0.0, mwbase: Double = 0.0, r: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, vmax: Double = 0.0, vmin: Double = 0.0) extends Element with Product with Serializable
A simplified steam turbine governor.
A simplified steam turbine governor.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- dt
Turbine damping coefficient (Dt). Unit = delta P / delta speed. Typical value = 0.
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- r
Permanent droop (R). Typical value = 0,05.
- t1
Steam bowl time constant (T1) (> 0). Typical value = 0,5.
- t2
Numerator time constant of T2/T3 block (T2) (>= 0). Typical value = 3.
- t3
Reheater time constant (T3) (> 0). Typical value = 10.
- vmax
Maximum valve position, PU of mwcap (Vmax) (> GovSteam0.vmin). Typical value = 1.
- vmin
Minimum valve position, PU of mwcap (Vmin) (< GovSteam0.vmax). Typical value = 0.
-
final
case class
GovSteam1(TurbineGovernorDynamics: TurbineGovernorDynamics = null, db1: Double = 0.0, db2: Double = 0.0, eps: Double = 0.0, gv1: Double = 0.0, gv2: Double = 0.0, gv3: Double = 0.0, gv4: Double = 0.0, gv5: Double = 0.0, gv6: Double = 0.0, k: Double = 0.0, k1: Double = 0.0, k2: Double = 0.0, k3: Double = 0.0, k4: Double = 0.0, k5: Double = 0.0, k6: Double = 0.0, k7: Double = 0.0, k8: Double = 0.0, mwbase: Double = 0.0, pgv1: Double = 0.0, pgv2: Double = 0.0, pgv3: Double = 0.0, pgv4: Double = 0.0, pgv5: Double = 0.0, pgv6: Double = 0.0, pmax: Double = 0.0, pmin: Double = 0.0, sdb1: Boolean = false, sdb2: Boolean = false, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, t5: Double = 0.0, t6: Double = 0.0, t7: Double = 0.0, uc: Double = 0.0, uo: Double = 0.0, valve: Boolean = false) extends Element with Product with Serializable
Steam turbine governor, based on the GovSteamIEEE1 (with optional deadband and nonlinear valve gain added).
Steam turbine governor, based on the GovSteamIEEE1 (with optional deadband and nonlinear valve gain added).
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- db1
Intentional deadband width (db1). Unit = Hz. Typical value = 0.
- db2
Unintentional deadband (db2). Unit = MW. Typical value = 0.
- eps
Intentional db hysteresis (eps). Unit = Hz. Typical value = 0.
- gv1
Nonlinear gain valve position point 1 (GV1). Typical value = 0.
- gv2
Nonlinear gain valve position point 2 (GV2). Typical value = 0,4.
- gv3
Nonlinear gain valve position point 3 (GV3). Typical value = 0,5.
- gv4
Nonlinear gain valve position point 4 (GV4). Typical value = 0,6.
- gv5
Nonlinear gain valve position point 5 (GV5). Typical value = 1.
- gv6
Nonlinear gain valve position point 6 (GV6). Typical value = 0.
- k
Governor gain (reciprocal of droop) (K) (> 0). Typical value = 25.
- k1
Fraction of HP shaft power after first boiler pass (K1). Typical value = 0,2.
- k2
Fraction of LP shaft power after first boiler pass (K2). Typical value = 0.
- k3
Fraction of HP shaft power after second boiler pass (K3). Typical value = 0,3.
- k4
Fraction of LP shaft power after second boiler pass (K4). Typical value = 0.
- k5
Fraction of HP shaft power after third boiler pass (K5). Typical value = 0,5.
- k6
Fraction of LP shaft power after third boiler pass (K6). Typical value = 0.
- k7
Fraction of HP shaft power after fourth boiler pass (K7). Typical value = 0.
- k8
Fraction of LP shaft power after fourth boiler pass (K8). Typical value = 0.
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- pgv1
Nonlinear gain power value point 1 (Pgv1). Typical value = 0.
- pgv2
Nonlinear gain power value point 2 (Pgv2). Typical value = 0,75.
- pgv3
Nonlinear gain power value point 3 (Pgv3). Typical value = 0,91.
- pgv4
Nonlinear gain power value point 4 (Pgv4). Typical value = 0,98.
- pgv5
Nonlinear gain power value point 5 (Pgv5). Typical value = 1.
- pgv6
Nonlinear gain power value point 6 (Pgv6). Typical value = 0.
- pmax
Maximum valve opening (Pmax) (> GovSteam1.pmin). Typical value = 1.
- pmin
Minimum valve opening (Pmin) (>= 0 and < GovSteam1.pmax). Typical value = 0.
- sdb1
Intentional deadband indicator. true = intentional deadband is applied false = intentional deadband is not applied. Typical value = true.
- sdb2
Unintentional deadband location. true = intentional deadband is applied before point "A" false = intentional deadband is applied after point "A". Typical value = true.
- t1
Governor lag time constant (T1) (>= 0). Typical value = 0.
- t2
Governor lead time constant (T2) (>= 0). Typical value = 0.
- t3
Valve positioner time constant (T3) (> 0). Typical value = 0,1.
- t4
Inlet piping/steam bowl time constant (T4) (>= 0). Typical value = 0,3.
- t5
Time constant of second boiler pass (T5) (>= 0). Typical value = 5.
- t6
Time constant of third boiler pass (T6) (>= 0). Typical value = 0,5.
- t7
Time constant of fourth boiler pass (T7) (>= 0). Typical value = 0.
- uc
Maximum valve closing velocity (Uc) (< 0). Unit = PU / s. Typical value = -10.
- uo
Maximum valve opening velocity (Uo) (> 0). Unit = PU / s. Typical value = 1.
- valve
Nonlinear valve characteristic. true = nonlinear valve characteristic is used false = nonlinear valve characteristic is not used. Typical value = true.
-
final
case class
GovSteam2(TurbineGovernorDynamics: TurbineGovernorDynamics = null, dbf: Double = 0.0, k: Double = 0.0, mnef: Double = 0.0, mxef: Double = 0.0, pmax: Double = 0.0, pmin: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0) extends Element with Product with Serializable
Simplified governor.
Simplified governor.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- dbf
Frequency deadband (DBF). Typical value = 0.
- k
Governor gain (reciprocal of droop) (K). Typical value = 20.
- mnef
Fuel flow maximum negative error value (MNEF). Typical value = -1.
- mxef
Fuel flow maximum positive error value (MXEF). Typical value = 1.
- pmax
Maximum fuel flow (PMAX) (> GovSteam2.pmin). Typical value = 1.
- pmin
Minimum fuel flow (PMIN) (< GovSteam2.pmax). Typical value = 0.
- t1
Governor lag time constant (T1) (> 0). Typical value = 0,45.
- t2
Governor lead time constant (T2) (>= 0). Typical value = 0.
-
final
case class
GovSteamBB(TurbineGovernorDynamics: TurbineGovernorDynamics = null, fcut: Double = 0.0, k2: Double = 0.0, k3: Double = 0.0, kd: Double = 0.0, kg: Double = 0.0, kls: Double = 0.0, kp: Double = 0.0, ks: Double = 0.0, peflag: Boolean = false, pmax: Double = 0.0, pmin: Double = 0.0, t1: Double = 0.0, t4: Double = 0.0, t5: Double = 0.0, t6: Double = 0.0, td: Double = 0.0, tn: Double = 0.0) extends Element with Product with Serializable
European governor model.
European governor model.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- fcut
Frequency deadband (fcut) (>= 0). Typical value = 0,002.
- k2
Gain (K2). Typical value = 0,75.
- k3
Gain (K3). Typical value = 0,5.
- kd
Gain (Kd). Typical value = 1,0.
- kg
Gain (Kg). Typical value = 1,0.
- kls
Gain (Kls) (> 0). Typical value = 0,1.
- kp
Gain (Kp). Typical value = 1,0.
- ks
Gain (Ks). Typical value = 21,0.
- peflag
Electric power input selection (Peflag). true = electric power input false = feedback signal. Typical value = false.
- pmax
High power limit (Pmax) (> GovSteamBB.pmin). Typical value = 1,0.
- pmin
Low power limit (Pmin) (< GovSteamBB.pmax). Typical value = 0.
- t1
Time constant (T1). Typical value = 0,05.
- t4
Time constant (T4). Typical value = 0,15.
- t5
Time constant (T5). Typical value = 12,0.
- t6
Time constant (T6). Typical value = 0,75.
- td
Time constant (Td) (> 0). Typical value = 1,0.
- tn
Time constant (Tn) (> 0). Typical value = 1,0.
-
final
case class
GovSteamCC(CrossCompoundTurbineGovernorDynamics: CrossCompoundTurbineGovernorDynamics = null, dhp: Double = 0.0, dlp: Double = 0.0, fhp: Double = 0.0, flp: Double = 0.0, mwbase: Double = 0.0, pmaxhp: Double = 0.0, pmaxlp: Double = 0.0, rhp: Double = 0.0, rlp: Double = 0.0, t1hp: Double = 0.0, t1lp: Double = 0.0, t3hp: Double = 0.0, t3lp: Double = 0.0, t4hp: Double = 0.0, t4lp: Double = 0.0, t5hp: Double = 0.0, t5lp: Double = 0.0) extends Element with Product with Serializable
Cross compound turbine governor.
Cross compound turbine governor.
Unlike tandem compound units, cross compound units are not on the same shaft.
- CrossCompoundTurbineGovernorDynamics
CrossCompoundTurbineGovernorDynamics Reference to the superclass object.
- dhp
HP damping factor (Dhp). Typical value = 0.
- dlp
LP damping factor (Dlp). Typical value = 0.
- fhp
Fraction of HP power ahead of reheater (Fhp). Typical value = 0,3.
- flp
Fraction of LP power ahead of reheater (Flp). Typical value = 0,7.
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- pmaxhp
Maximum HP value position (Pmaxhp). Typical value = 1.
- pmaxlp
Maximum LP value position (Pmaxlp). Typical value = 1.
- rhp
HP governor droop (Rhp) (> 0). Typical value = 0,05.
- rlp
LP governor droop (Rlp) (> 0). Typical value = 0,05.
- t1hp
HP governor time constant (T1hp) (>= 0). Typical value = 0,1.
- t1lp
LP governor time constant (T1lp) (>= 0). Typical value = 0,1.
- t3hp
HP turbine time constant (T3hp) (>= 0). Typical value = 0,1.
- t3lp
LP turbine time constant (T3lp) (>= 0). Typical value = 0,1.
- t4hp
HP turbine time constant (T4hp) (>= 0). Typical value = 0,1.
- t4lp
LP turbine time constant (T4lp) (>= 0). Typical value = 0,1.
- t5hp
HP reheater time constant (T5hp) (>= 0). Typical value = 10.
- t5lp
LP reheater time constant (T5lp) (>= 0). Typical value = 10.
-
final
case class
GovSteamEU(TurbineGovernorDynamics: TurbineGovernorDynamics = null, chc: Double = 0.0, cho: Double = 0.0, cic: Double = 0.0, cio: Double = 0.0, db1: Double = 0.0, db2: Double = 0.0, hhpmax: Double = 0.0, ke: Double = 0.0, kfcor: Double = 0.0, khp: Double = 0.0, klp: Double = 0.0, komegacor: Double = 0.0, mwbase: Double = 0.0, pmax: Double = 0.0, prhmax: Double = 0.0, simx: Double = 0.0, tb: Double = 0.0, tdp: Double = 0.0, ten: Double = 0.0, tf: Double = 0.0, tfp: Double = 0.0, thp: Double = 0.0, tip: Double = 0.0, tlp: Double = 0.0, tp: Double = 0.0, trh: Double = 0.0, tvhp: Double = 0.0, tvip: Double = 0.0, tw: Double = 0.0, wfmax: Double = 0.0, wfmin: Double = 0.0, wmax1: Double = 0.0, wmax2: Double = 0.0, wwmax: Double = 0.0, wwmin: Double = 0.0) extends Element with Product with Serializable
Simplified boiler and steam turbine with PID governor.
Simplified boiler and steam turbine with PID governor.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- chc
Control valves rate closing limit (Chc). Unit = PU / s. Typical value = -3,3.
- cho
Control valves rate opening limit (Cho). Unit = PU / s. Typical value = 0,17.
- cic
Intercept valves rate closing limit (Cic). Typical value = -2,2.
- cio
Intercept valves rate opening limit (Cio). Typical value = 0,123.
- db1
Deadband of the frequency corrector (db1). Typical value = 0.
- db2
Deadband of the speed governor (db2). Typical value = 0,0004.
- hhpmax
Maximum control valve position (Hhpmax). Typical value = 1.
- ke
Gain of the power controller (Ke). Typical value = 0,65.
- kfcor
Gain of the frequency corrector (Kfcor). Typical value = 20.
- khp
Fraction of total turbine output generated by HP part (Khp). Typical value = 0,277.
- klp
Fraction of total turbine output generated by HP part (Klp). Typical value = 0,723.
- komegacor
Gain of the speed governor (Kwcor). Typical value = 20.
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- pmax
Maximal active power of the turbine (Pmax). Typical value = 1.
- prhmax
Maximum low pressure limit (Prhmax). Typical value = 1,4.
- simx
Intercept valves transfer limit (Simx). Typical value = 0,425.
- tb
Boiler time constant (Tb) (>= 0). Typical value = 100.
- tdp
Derivative time constant of the power controller (Tdp) (>= 0). Typical value = 0.
- ten
Electro hydraulic transducer (Ten) (>= 0). Typical value = 0,1.
- tf
Frequency transducer time constant (Tf) (>= 0). Typical value = 0.
- tfp
Time constant of the power controller (Tfp) (>= 0). Typical value = 0.
- thp
High pressure (HP) time constant of the turbine (Thp) (>= 0). Typical value = 0,31.
- tip
Integral time constant of the power controller (Tip) (>= 0). Typical value = 2.
- tlp
Low pressure (LP) time constant of the turbine (Tlp) (>= 0). Typical value = 0,45.
- tp
Power transducer time constant (Tp) (>= 0). Typical value = 0,07.
- trh
Reheater time constant of the turbine (Trh) (>= 0). Typical value = 8.
- tvhp
Control valves servo time constant (Tvhp) (>= 0). Typical value = 0,1.
- tvip
Intercept valves servo time constant (Tvip) (>= 0). Typical value = 0,15.
- tw
Speed transducer time constant (Tw) (>= 0). Typical value = 0,02.
- wfmax
Upper limit for frequency correction (Wfmax) (> GovSteamEU.wfmin). Typical value = 0,05.
- wfmin
Lower limit for frequency correction (Wfmin) (< GovSteamEU.wfmax). Typical value = -0,05.
- wmax1
Emergency speed control lower limit (wmax1). Typical value = 1,025.
- wmax2
Emergency speed control upper limit (wmax2). Typical value = 1,05.
- wwmax
Upper limit for the speed governor (Wwmax) (> GovSteamEU.wwmin). Typical value = 0,1.
- wwmin
Lower limit for the speed governor frequency correction (Wwmin) (< GovSteamEU.wwmax). Typical value = -1.
-
final
case class
GovSteamFV2(TurbineGovernorDynamics: TurbineGovernorDynamics = null, dt: Double = 0.0, k: Double = 0.0, mwbase: Double = 0.0, r: Double = 0.0, t1: Double = 0.0, t3: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, tt: Double = 0.0, vmax: Double = 0.0, vmin: Double = 0.0) extends Element with Product with Serializable
Steam turbine governor with reheat time constants and modelling of the effects of fast valve closing to reduce mechanical power.
Steam turbine governor with reheat time constants and modelling of the effects of fast valve closing to reduce mechanical power.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- dt
(Dt).
- k
Fraction of the turbine power developed by turbine sections not involved in fast valving (K).
- mwbase
Alternate base used instead of machine base in equipment model if necessary (MWbase) (> 0). Unit = MW.
- r
(R).
- t1
Governor time constant (T1) (>= 0).
- t3
Reheater time constant (T3) (>= 0).
- ta
Time after initial time for valve to close (Ta) (>= 0).
- tb
Time after initial time for valve to begin opening (Tb) (>= 0).
- tc
Time after initial time for valve to become fully open (Tc) (>= 0).
- tt
Time constant with which power falls off after intercept valve closure (Tt) (>= 0).
- vmax
(Vmax) (> GovSteamFV2.vmin).
- vmin
(Vmin) (< GovSteamFV2.vmax).
-
final
case class
GovSteamFV3(TurbineGovernorDynamics: TurbineGovernorDynamics = null, gv1: Double = 0.0, gv2: Double = 0.0, gv3: Double = 0.0, gv4: Double = 0.0, gv5: Double = 0.0, gv6: Double = 0.0, k: Double = 0.0, k1: Double = 0.0, k2: Double = 0.0, k3: Double = 0.0, mwbase: Double = 0.0, pgv1: Double = 0.0, pgv2: Double = 0.0, pgv3: Double = 0.0, pgv4: Double = 0.0, pgv5: Double = 0.0, pgv6: Double = 0.0, pmax: Double = 0.0, pmin: Double = 0.0, prmax: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, t5: Double = 0.0, t6: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, uc: Double = 0.0, uo: Double = 0.0) extends Element with Product with Serializable
Simplified GovSteamIEEE1 steam turbine governor with Prmax limit and fast valving.
Simplified GovSteamIEEE1 steam turbine governor with Prmax limit and fast valving.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- gv1
Nonlinear gain valve position point 1 (GV1). Typical value = 0.
- gv2
Nonlinear gain valve position point 2 (GV2). Typical value = 0,4.
- gv3
Nonlinear gain valve position point 3 (GV3). Typical value = 0,5.
- gv4
Nonlinear gain valve position point 4 (GV4). Typical value = 0,6.
- gv5
Nonlinear gain valve position point 5 (GV5). Typical value = 1.
- gv6
Nonlinear gain valve position point 6 (GV6). Typical value = 0.
- k
Governor gain, (reciprocal of droop) (K). Typical value = 20.
- k1
Fraction of turbine power developed after first boiler pass (K1). Typical value = 0,2.
- k2
Fraction of turbine power developed after second boiler pass (K2). Typical value = 0,2.
- k3
Fraction of hp turbine power developed after crossover or third boiler pass (K3). Typical value = 0,6.
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- pgv1
Nonlinear gain power value point 1 (Pgv1). Typical value = 0.
- pgv2
Nonlinear gain power value point 2 (Pgv2). Typical value = 0,75.
- pgv3
Nonlinear gain power value point 3 (Pgv3). Typical value = 0,91.
- pgv4
Nonlinear gain power value point 4 (Pgv4). Typical value = 0,98.
- pgv5
Nonlinear gain power value point 5 (Pgv5). Typical value = 1.
- pgv6
Nonlinear gain power value point 6 (Pgv6). Typical value = 0.
- pmax
Maximum valve opening, PU of MWbase (Pmax) (> GovSteamFV3.pmin). Typical value = 1.
- pmin
Minimum valve opening, PU of MWbase (Pmin) (< GovSteamFV3.pmax). Typical value = 0.
- prmax
Max. pressure in reheater (Prmax). Typical value = 1.
- t1
Governor lead time constant (T1) (>= 0). Typical value = 0.
- t2
Governor lag time constant (T2) (>= 0). Typical value = 0.
- t3
Valve positioner time constant (T3) (> 0). Typical value = 0.
- t4
Inlet piping/steam bowl time constant (T4) (>= 0). Typical value = 0,2.
- t5
Time constant of second boiler pass (i.e. reheater) (T5) (> 0 if fast valving is used, otherwise >= 0). Typical value = 0,5.
- t6
Time constant of crossover or third boiler pass (T6) (>= 0). Typical value = 10.
- ta
Time to close intercept valve (IV) (Ta) (>= 0). Typical value = 0,97.
- tb
Time until IV starts to reopen (Tb) (>= 0). Typical value = 0,98.
- tc
Time until IV is fully open (Tc) (>= 0). Typical value = 0,99.
- uc
Maximum valve closing velocity (Uc). Unit = PU / s. Typical value = -1.
- uo
Maximum valve opening velocity (Uo). Unit = PU / s. Typical value = 0,1.
-
final
case class
GovSteamFV4(TurbineGovernorDynamics: TurbineGovernorDynamics = null, cpsmn: Double = 0.0, cpsmx: Double = 0.0, crmn: Double = 0.0, crmx: Double = 0.0, kdc: Double = 0.0, kf1: Double = 0.0, kf3: Double = 0.0, khp: Double = 0.0, kic: Double = 0.0, kip: Double = 0.0, kit: Double = 0.0, kmp1: Double = 0.0, kmp2: Double = 0.0, kpc: Double = 0.0, kpp: Double = 0.0, kpt: Double = 0.0, krc: Double = 0.0, ksh: Double = 0.0, lpi: Double = 0.0, lps: Double = 0.0, mnef: Double = 0.0, mxef: Double = 0.0, pr1: Double = 0.0, pr2: Double = 0.0, psmn: Double = 0.0, rsmimn: Double = 0.0, rsmimx: Double = 0.0, rvgmn: Double = 0.0, rvgmx: Double = 0.0, srmn: Double = 0.0, srmx: Double = 0.0, srsmp: Double = 0.0, svmn: Double = 0.0, svmx: Double = 0.0, ta: Double = 0.0, tam: Double = 0.0, tc: Double = 0.0, tcm: Double = 0.0, tdc: Double = 0.0, tf1: Double = 0.0, tf2: Double = 0.0, thp: Double = 0.0, tmp: Double = 0.0, trh: Double = 0.0, tv: Double = 0.0, ty: Double = 0.0, y: Double = 0.0, yhpmn: Double = 0.0, yhpmx: Double = 0.0, ympmn: Double = 0.0, ympmx: Double = 0.0) extends Element with Product with Serializable
Detailed electro-hydraulic governor for steam unit.
Detailed electro-hydraulic governor for steam unit.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- cpsmn
Minimum value of pressure regulator output (Cpsmn). Typical value = -1.
- cpsmx
Maximum value of pressure regulator output (Cpsmx). Typical value = 1.
- crmn
Minimum value of regulator set-point (Crmn). Typical value = 0.
- crmx
Maximum value of regulator set-point (Crmx). Typical value = 1,2.
- kdc
Derivative gain of pressure regulator (Kdc). Typical value = 1.
- kf1
Frequency bias (reciprocal of droop) (Kf1). Typical value = 20.
- kf3
Frequency control (reciprocal of droop) (Kf3). Typical value = 20.
- khp
Fraction of total turbine output generated by HP part (Khp). Typical value = 0,35.
- kic
Integral gain of pressure regulator (Kic). Typical value = 0,0033.
- kip
Integral gain of pressure feedback regulator (Kip). Typical value = 0,5.
- kit
Integral gain of electro-hydraulic regulator (Kit). Typical value = 0,04.
- kmp1
First gain coefficient of intercept valves characteristic (Kmp1). Typical value = 0,5.
- kmp2
Second gain coefficient of intercept valves characteristic (Kmp2). Typical value = 3,5.
- kpc
Proportional gain of pressure regulator (Kpc). Typical value = 0,5.
- kpp
Proportional gain of pressure feedback regulator (Kpp). Typical value = 1.
- kpt
Proportional gain of electro-hydraulic regulator (Kpt). Typical value = 0,3.
- krc
Maximum variation of fuel flow (Krc). Typical value = 0,05.
- ksh
Pressure loss due to flow friction in the boiler tubes (Ksh). Typical value = 0,08.
- lpi
Maximum negative power error (Lpi). Typical value = -0,15.
- lps
Maximum positive power error (Lps). Typical value = 0,03.
- mnef
Lower limit for frequency correction (MNEF). Typical value = -0,05.
- mxef
Upper limit for frequency correction (MXEF). Typical value = 0,05.
- pr1
First value of pressure set point static characteristic (Pr1). Typical value = 0,2.
- pr2
Second value of pressure set point static characteristic, corresponding to Ps0 = 1,0 PU (Pr2). Typical value = 0,75.
- psmn
Minimum value of pressure set point static characteristic (Psmn). Typical value = 1.
- rsmimn
Minimum value of integral regulator (Rsmimn). Typical value = 0.
- rsmimx
Maximum value of integral regulator (Rsmimx). Typical value = 1,1.
- rvgmn
Minimum value of integral regulator (Rvgmn). Typical value = 0.
- rvgmx
Maximum value of integral regulator (Rvgmx). Typical value = 1,2.
- srmn
Minimum valve opening (Srmn). Typical value = 0.
- srmx
Maximum valve opening (Srmx). Typical value = 1,1.
- srsmp
Intercept valves characteristic discontinuity point (Srsmp). Typical value = 0,43.
- svmn
Maximum regulator gate closing velocity (Svmn). Typical value = -0,0333.
- svmx
Maximum regulator gate opening velocity (Svmx). Typical value = 0,0333.
- ta
Control valves rate opening time (Ta) (>= 0). Typical value = 0,8.
- tam
Intercept valves rate opening time (Tam) (>= 0). Typical value = 0,8.
- tc
Control valves rate closing time (Tc) (>= 0). Typical value = 0,5.
- tcm
Intercept valves rate closing time (Tcm) (>= 0). Typical value = 0,5.
- tdc
Derivative time constant of pressure regulator (Tdc) (>= 0). Typical value = 90.
- tf1
Time constant of fuel regulation (Tf1) (>= 0). Typical value = 10.
- tf2
Time constant of steam chest (Tf2) (>= 0). Typical value = 10.
- thp
High pressure (HP) time constant of the turbine (Thp) (>= 0). Typical value = 0,15.
- tmp
Low pressure (LP) time constant of the turbine (Tmp) (>= 0). Typical value = 0,4.
- trh
Reheater time constant of the turbine (Trh) (>= 0). Typical value = 10.
- tv
Boiler time constant (Tv) (>= 0). Typical value = 60.
- ty
Control valves servo time constant (Ty) (>= 0). Typical value = 0,1.
- y
Coefficient of linearized equations of turbine (Stodola formulation) (Y). Typical value = 0,13.
- yhpmn
Minimum control valve position (Yhpmn). Typical value = 0.
- yhpmx
Maximum control valve position (Yhpmx). Typical value = 1,1.
- ympmn
Minimum intercept valve position (Ympmn). Typical value = 0.
- ympmx
Maximum intercept valve position (Ympmx). Typical value = 1,1.
-
final
case class
GovSteamIEEE1(TurbineGovernorDynamics: TurbineGovernorDynamics = null, k: Double = 0.0, k1: Double = 0.0, k2: Double = 0.0, k3: Double = 0.0, k4: Double = 0.0, k5: Double = 0.0, k6: Double = 0.0, k7: Double = 0.0, k8: Double = 0.0, mwbase: Double = 0.0, pmax: Double = 0.0, pmin: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, t5: Double = 0.0, t6: Double = 0.0, t7: Double = 0.0, uc: Double = 0.0, uo: Double = 0.0) extends Element with Product with Serializable
IEEE steam turbine governor model.
IEEE steam turbine governor model.
Ref<font color="#0f0f0f">erence: IEEE Transactions on Power Apparatus and Systems, November/December 1973, Volume PAS-92, Number 6, Dynamic Models for Steam and Hydro Turbines in Power System Studies, page 1904.</font>
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- k
Governor gain (reciprocal of droop) (K) (> 0). Typical value = 25.
- k1
Fraction of HP shaft power after first boiler pass (K1). Typical value = 0,2.
- k2
Fraction of LP shaft power after first boiler pass (K2). Typical value = 0.
- k3
Fraction of HP shaft power after second boiler pass (K3). Typical value = 0,3.
- k4
Fraction of LP shaft power after second boiler pass (K4). Typical value = 0.
- k5
Fraction of HP shaft power after third boiler pass (K5). Typical value = 0,5.
- k6
Fraction of LP shaft power after third boiler pass (K6). Typical value = 0.
- k7
Fraction of HP shaft power after fourth boiler pass (K7). Typical value = 0.
- k8
Fraction of LP shaft power after fourth boiler pass (K8). Typical value = 0.
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- pmax
Maximum valve opening (Pmax) (> GovSteamIEEE1.pmin). Typical value = 1.
- pmin
Minimum valve opening (Pmin) (>= 0 and < GovSteamIEEE1.pmax). Typical value = 0.
- t1
Governor lag time constant (T1) (>= 0). Typical value = 0.
- t2
Governor lead time constant (T2) (>= 0). Typical value = 0.
- t3
Valve positioner time constant (T3) (> 0). Typical value = 0,1.
- t4
Inlet piping/steam bowl time constant (T4) (>= 0). Typical value = 0,3.
- t5
Time constant of second boiler pass (T5) (>= 0). Typical value = 5.
- t6
Time constant of third boiler pass (T6) (>= 0). Typical value = 0,5.
- t7
Time constant of fourth boiler pass (T7) (>= 0). Typical value = 0.
- uc
Maximum valve closing velocity (Uc) (< 0). Unit = PU / s. Typical value = -10.
- uo
Maximum valve opening velocity (Uo) (> 0). Unit = PU / s. Typical value = 1.
-
final
case class
GovSteamSGO(TurbineGovernorDynamics: TurbineGovernorDynamics = null, k1: Double = 0.0, k2: Double = 0.0, k3: Double = 0.0, mwbase: Double = 0.0, pmax: Double = 0.0, pmin: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, t5: Double = 0.0, t6: Double = 0.0) extends Element with Product with Serializable
Simplified steam turbine governor.
Simplified steam turbine governor.
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- k1
One / PU regulation (K1).
- k2
Fraction (K2).
- k3
Fraction (K3).
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- pmax
Upper power limit (Pmax) (> GovSteamSGO.pmin).
- pmin
Lower power limit (Pmin) (>= 0 and < GovSteamSGO.pmax).
- t1
Controller lag (T1) (>= 0).
- t2
Controller lead compensation (T2) (>= 0).
- t3
Governor lag (T3) (> 0).
- t4
Delay due to steam inlet volumes associated with steam chest and inlet piping (T4) (>= 0).
- t5
Reheater delay including hot and cold leads (T5) (>= 0).
- t6
Delay due to IP-LP turbine, crossover pipes and LP end hoods (T6) (>= 0).
-
final
case class
GrossToNetActivePowerCurve(Curve: Curve = null, GeneratingUnit: String = null) extends Element with Product with Serializable
Relationship between the generating unit's gross active power output on the X-axis (measured at the terminals of the machine(s)) and the generating unit's net active power output on the Y-axis (based on utility-defined measurements at the power station).
Relationship between the generating unit's gross active power output on the X-axis (measured at the terminals of the machine(s)) and the generating unit's net active power output on the Y-axis (based on utility-defined measurements at the power station).
Station service loads, when modelled, should be treated as non-conforming bus loads. There may be more than one curve, depending on the auxiliary equipment that is in service.
- Curve
Curve Reference to the superclass object.
- GeneratingUnit
GeneratingUnit A generating unit may have a gross active power to net active power curve, describing the losses and auxiliary power requirements of the unit.
-
final
case class
Ground(ConductingEquipment: ConductingEquipment = null, GroundAction: String = null) extends Element with Product with Serializable
A point where the system is grounded used for connecting conducting equipment to ground.
A point where the system is grounded used for connecting conducting equipment to ground.
The power system model can have any number of grounds.
- ConductingEquipment
ConductingEquipment Reference to the superclass object.
- GroundAction
GroundAction Action taken with this ground.
-
final
case class
GroundAction(SwitchingAction: SwitchingAction = null, kind: String = null, AlongACLineSegment: String = null, Ground: String = null, GroundedEquipment: String = null) extends Element with Product with Serializable
Action on ground as a switching step.
Action on ground as a switching step.
- SwitchingAction
SwitchingAction Reference to the superclass object.
- kind
Switching action to perform.
- AlongACLineSegment
ACLineSegment The line segment that this ground action will affect. This is the only way to access relationship to clamp in case the ground needs to be placed along the line segment.
- Ground
Ground Ground on which this action is taken.
- GroundedEquipment
ConductingEquipment Equipment being grounded with this operation. In case of placing a ground anywhere along a line segment, you must use the clamp (to get the distance from one terminal), so use the explicit relation with line segment. In all other cases (including placing the ground at a line segment terminal), reference to one or more conducting equipment is sufficient.
-
final
case class
GroundDisconnector(Switch: Switch = null) extends Element with Product with Serializable
A manually operated or motor operated mechanical switching device used for isolating a circuit or equipment from ground.
A manually operated or motor operated mechanical switching device used for isolating a circuit or equipment from ground.
- Switch
Switch Reference to the superclass object.
-
final
case class
GroundingImpedance(EarthFaultCompensator: EarthFaultCompensator = null, x: Double = 0.0) extends Element with Product with Serializable
A fixed impedance device used for grounding.
A fixed impedance device used for grounding.
- EarthFaultCompensator
EarthFaultCompensator Reference to the superclass object.
- x
Reactance of device.
-
final
case class
HVDCDynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null) extends Element with Product with Serializable
HVDC whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
HVDC whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- final case class HVDCLookUpTable(Element: BasicElement = null, functionKind: String = null, input: Double = 0.0, output: Double = 0.0, sequence: Int = 0, Qregulator: String = null) extends Element with Product with Serializable
-
final
case class
Hazard(IdentifiedObject: IdentifiedObject = null, status: String = null, type: String = null) extends Element with Product with Serializable
An object or a condition that is a danger for causing loss or perils to an asset and/or people.
An object or a condition that is a danger for causing loss or perils to an asset and/or people.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- status
Status Status of this hazard.
- type
Type of this hazard.
-
final
case class
HealthScore(AggregateScore: AggregateScore = null, AssetRiskScore: String = null) extends Element with Product with Serializable
Score that is indicative of the health of one or more assets.
Score that is indicative of the health of one or more assets.
- AggregateScore
AggregateScore Reference to the superclass object.
- AssetRiskScore
RiskScore Risk score with which this health score is associated.
-
final
case class
HeatInputCurve(Curve: Curve = null, auxPowerMult: Double = 0.0, auxPowerOffset: Double = 0.0, heatInputEff: Double = 0.0, heatInputOffset: Double = 0.0, isNetGrossP: Boolean = false, ThermalGeneratingUnit: String = null) extends Element with Product with Serializable
Relationship between unit heat input in energy per time for main fuel (Y1-axis) and supplemental fuel (Y2-axis) versus unit output in active power (X-axis).
Relationship between unit heat input in energy per time for main fuel (Y1-axis) and supplemental fuel (Y2-axis) versus unit output in active power (X-axis).
The quantity of main fuel used to sustain generation at this output level is prorated for throttling between definition points. The quantity of supplemental fuel used at this output level is fixed and not prorated.
- Curve
Curve Reference to the superclass object.
- auxPowerMult
Power output - auxiliary power multiplier adjustment factor.
- auxPowerOffset
Power output - auxiliary power offset adjustment factor.
- heatInputEff
Heat input - efficiency multiplier adjustment factor.
- heatInputOffset
Heat input - offset adjustment factor.
- isNetGrossP
Flag is set to true when output is expressed in net active power.
- ThermalGeneratingUnit
ThermalGeneratingUnit A thermal generating unit may have a heat input curve.
-
final
case class
HeatRateCurve(Curve: Curve = null, isNetGrossP: Boolean = false, ThermalGeneratingUnit: String = null) extends Element with Product with Serializable
Relationship between unit heat rate per active power (Y-axis) and unit output (X-axis).
Relationship between unit heat rate per active power (Y-axis) and unit output (X-axis).
The heat input is from all fuels.
- Curve
Curve Reference to the superclass object.
- isNetGrossP
Flag is set to true when output is expressed in net active power.
- ThermalGeneratingUnit
ThermalGeneratingUnit A thermal generating unit may have a heat rate curve.
-
final
case class
HeatRecoveryBoiler(FossilSteamSupply: FossilSteamSupply = null, steamSupplyRating2: Double = 0.0, CombustionTurbines: List[String] = null) extends Element with Product with Serializable
The heat recovery system associated with combustion turbines in order to produce steam for combined cycle plants.
The heat recovery system associated with combustion turbines in order to produce steam for combined cycle plants.
- FossilSteamSupply
FossilSteamSupply Reference to the superclass object.
- steamSupplyRating2
The steam supply rating in kilopounds per hour, if dual pressure boiler.
- CombustionTurbines
CombustionTurbine A combustion turbine may have a heat recovery boiler for making steam.
-
final
case class
HostControlArea(PowerSystemResource: PowerSystemResource = null, areaControlMode: String = null, freqSetPoint: Double = 0.0, frequencyBiasFactor: Double = 0.0, AdjacentCASet: String = null, BidSelfSched: List[String] = null, CnodeDistributionFactor: List[String] = null, Controls: String = null, Flowgate: List[String] = null, LossClearingResults: List[String] = null, RTO: String = null, RegisteredResource: List[String] = null, SubControlAreas: List[String] = null, SysLoadDistribuFactor: List[String] = null, TransferInterface: List[String] = null) extends Element with Product with Serializable
A HostControlArea has a set of tie points and a set of generator controls (i.e., AGC).
A HostControlArea has a set of tie points and a set of generator controls (i.e., AGC).
It also has a total load, including transmission and distribution losses.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- areaControlMode
The area's present control mode: (CF = constant frequency) or (CTL = constant tie-line) or (TLB = tie-line bias) or (OFF = off control)
- freqSetPoint
The present power system frequency set point for automatic generation control
- frequencyBiasFactor
The control area's frequency bias factor, in MW/0.1 Hz, for automatic generation control (AGC)
- AdjacentCASet
AdjacentCASet undocumented
- BidSelfSched
BidSelfSched undocumented
- CnodeDistributionFactor
CnodeDistributionFactor undocumented
- Controls
ControlAreaOperator A ControlAreaCompany controls a ControlArea.
- Flowgate
Flowgate undocumented
- LossClearingResults
LossClearingResults undocumented
- RTO
RTO undocumented
- RegisteredResource
RegisteredResource undocumented
- SubControlAreas
SubControlArea The interchange area may operate as a control area
- SysLoadDistribuFactor
SysLoadDistributionFactor undocumented
- TransferInterface
TransferInterface undocumented
-
final
case class
HourlyPreDispatchSchedule(BidHourlySchedule: BidHourlySchedule = null, value: Boolean = false) extends Element with Product with Serializable
An indicator specifying that a resource shall have an Hourly Pre-Dispatch.
An indicator specifying that a resource shall have an Hourly Pre-Dispatch.
The resource could be a RegisteredGenerator or a RegisteredInterTie.
This schedule is assocated with the hourly parameters in a resource bid.
- BidHourlySchedule
BidHourlySchedule Reference to the superclass object.
- value
Flag defining that for this hour in the resource bid the resource shall have an hourly pre-dispatch.
-
final
case class
Hurricane(Cyclone: Cyclone = null, category: Int = 0) extends Element with Product with Serializable
A hurricane, a subtype of cyclone occurring in the North Atlantic Ocean or North-eastern Pacific Ocean whose intensity is measured using the Saffir-Simpson Hurricane Scale.
A hurricane, a subtype of cyclone occurring in the North Atlantic Ocean or North-eastern Pacific Ocean whose intensity is measured using the Saffir-Simpson Hurricane Scale.
- Cyclone
Cyclone Reference to the superclass object.
- category
The hurricane's category during the time interval, using Saffir-Simpson Hurricane Wind Scale, a 1 to 5 rating based on a hurricane's sustained wind speed.
-
final
case class
HydroGeneratingEfficiencyCurve(Curve: Curve = null, HydroGeneratingUnit: String = null) extends Element with Product with Serializable
Relationship between unit efficiency as percentage and unit output active power for a given net head in meters.
Relationship between unit efficiency as percentage and unit output active power for a given net head in meters.
The relationship between efficiency, discharge, head, and power output is expressed as follows: E =KP/HQ where: E is the efficiency, as a percentage; P is the active power; H is the height; Q is the discharge, volume/time unit; K is a constant. For example, a curve instance for a given net head could show efficiency (Y-axis) versus active power output (X-axis) or versus discharge on the X-axis.
- Curve
Curve Reference to the superclass object.
- HydroGeneratingUnit
HydroGeneratingUnit A hydro generating unit has an efficiency curve.
-
final
case class
HydroGeneratingUnit(GeneratingUnit: GeneratingUnit = null, dropHeight: Double = 0.0, energyConversionCapability: String = null, hydroUnitWaterCost: Double = 0.0, turbineType: String = null, HydroGeneratingEfficiencyCurves: List[String] = null, HydroPowerPlant: String = null, PenstockLossCurve: String = null, TailbayLossCurve: List[String] = null) extends Element with Product with Serializable
A generating unit whose prime mover is a hydraulic turbine (e.g., Francis, Pelton, Kaplan).
A generating unit whose prime mover is a hydraulic turbine (e.g., Francis, Pelton, Kaplan).
- GeneratingUnit
GeneratingUnit Reference to the superclass object.
- dropHeight
The height water drops from the reservoir mid-point to the turbine.
- energyConversionCapability
Energy conversion capability for generating.
- hydroUnitWaterCost
The equivalent cost of water that drives the hydro turbine.
- turbineType
Type of turbine.
- HydroGeneratingEfficiencyCurves
HydroGeneratingEfficiencyCurve A hydro generating unit has an efficiency curve.
- HydroPowerPlant
HydroPowerPlant The hydro generating unit belongs to a hydro power plant.
- PenstockLossCurve
PenstockLossCurve A hydro generating unit has a penstock loss curve.
- TailbayLossCurve
TailbayLossCurve A hydro generating unit has a tailbay loss curve.
-
final
case class
HydroPowerPlant(PowerSystemResource: PowerSystemResource = null, dischargeTravelDelay: Double = 0.0, genRatedP: Double = 0.0, hydroPlantStorageType: String = null, penstockType: String = null, plantDischargeCapacity: Double = 0.0, plantRatedHead: Double = 0.0, pumpRatedP: Double = 0.0, surgeTankCode: String = null, surgeTankCrestLevel: Double = 0.0, GenSourcePumpDischargeReservoir: String = null, HydroGeneratingUnits: List[String] = null, HydroPumps: List[String] = null, Reservoir: String = null) extends Element with Product with Serializable
A hydro power station which can generate or pump.
A hydro power station which can generate or pump.
When generating, the generator turbines receive water from an upper reservoir. When pumping, the pumps receive their water from a lower reservoir.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- dischargeTravelDelay
Water travel delay from tailbay to next downstream hydro power station.
- genRatedP
The hydro plant's generating rating active power for rated head conditions. The attribute shall be a positive value.
- hydroPlantStorageType
The type of hydro power plant water storage.
- penstockType
Type and configuration of hydro plant penstock(s).
- plantDischargeCapacity
Total plant discharge capacity.
- plantRatedHead
The plant's rated gross head. The attribute shall be a positive value.
- pumpRatedP
The hydro plant's pumping rating active power for rated head conditions. The attribute shall be a positive value.
- surgeTankCode
A code describing the type (or absence) of surge tank that is associated with the hydro power plant.
- surgeTankCrestLevel
The level at which the surge tank spills.
- GenSourcePumpDischargeReservoir
Reservoir Generators are supplied water from or pumps discharge water to an upstream reservoir.
- HydroGeneratingUnits
HydroGeneratingUnit The hydro generating unit belongs to a hydro power plant.
- HydroPumps
HydroPump The hydro pump may be a member of a pumped storage plant or a pump for distributing water.
- Reservoir
Reservoir Generators discharge water to or pumps are supplied water from a downstream reservoir.
-
final
case class
HydroPump(Equipment: Equipment = null, pumpDischAtMaxHead: Double = 0.0, pumpDischAtMinHead: Double = 0.0, pumpPowerAtMaxHead: Double = 0.0, pumpPowerAtMinHead: Double = 0.0, HydroPowerPlant: String = null, HydroPumpOpSchedule: String = null, RotatingMachine: String = null) extends Element with Product with Serializable
A synchronous motor-driven pump, typically associated with a pumped storage plant.
A synchronous motor-driven pump, typically associated with a pumped storage plant.
- Equipment
Equipment Reference to the superclass object.
- pumpDischAtMaxHead
The pumping discharge under maximum head conditions, usually at full gate.
- pumpDischAtMinHead
The pumping discharge under minimum head conditions, usually at full gate.
- pumpPowerAtMaxHead
The pumping power under maximum head conditions, usually at full gate.
- pumpPowerAtMinHead
The pumping power under minimum head conditions, usually at full gate.
- HydroPowerPlant
HydroPowerPlant The hydro pump may be a member of a pumped storage plant or a pump for distributing water.
- HydroPumpOpSchedule
HydroPumpOpSchedule The hydro pump has a pumping schedule over time, indicating when pumping is to occur.
- RotatingMachine
RotatingMachine The synchronous machine drives the turbine which moves the water from a low elevation to a higher elevation. The direction of machine rotation for pumping may or may not be the same as for generating.
-
final
case class
HydroPumpOpSchedule(RegularIntervalSchedule: RegularIntervalSchedule = null, HydroPump: String = null) extends Element with Product with Serializable
The hydro pump's Operator-approved current operating schedule (or plan), typically produced with the aid of unit commitment type analyses.
The hydro pump's Operator-approved current operating schedule (or plan), typically produced with the aid of unit commitment type analyses.
The unit's operating schedule status is typically given as: (0=unavailable) (1=available to startup or shutdown) (2=must pump).
- RegularIntervalSchedule
RegularIntervalSchedule Reference to the superclass object.
- HydroPump
HydroPump The hydro pump has a pumping schedule over time, indicating when pumping is to occur.
-
final
case class
HydroTurbine(PrimeMover: PrimeMover = null, gateRateLimit: Double = 0.0, gateUpperLimit: Double = 0.0, maxHeadMaxP: Double = 0.0, minHeadMaxP: Double = 0.0, speedRating: Double = 0.0, speedRegulation: Double = 0.0, transientDroopTime: Double = 0.0, transientRegulation: Double = 0.0, turbineRating: Double = 0.0, turbineType: String = null, waterStartingTime: Double = 0.0) extends Element with Product with Serializable
A water driven prime mover.
A water driven prime mover.
Typical turbine types are: Francis, Kaplan, and Pelton.
- PrimeMover
PrimeMover Reference to the superclass object.
- gateRateLimit
Gate rate limit.
- gateUpperLimit
Gate upper limit.
- maxHeadMaxP
Maximum efficiency active power at maximum head conditions.
- minHeadMaxP
Maximum efficiency active power at minimum head conditions.
- speedRating
Rated speed in number of revolutions. The attribute shall be a positive value.
- speedRegulation
Speed regulation.
- transientDroopTime
Transient droop time constant.
- transientRegulation
Transient regulation.
- turbineRating
Rated turbine active power. The attribute shall be a positive value.
- turbineType
Type of turbine.
- waterStartingTime
Water starting time.
-
final
case class
HydrosphericAnalog(EnvironmentalAnalog: EnvironmentalAnalog = null, kind: String = null) extends Element with Product with Serializable
Analog (float) measuring a hydrospheric condition.
Analog (float) measuring a hydrospheric condition.
- EnvironmentalAnalog
EnvironmentalAnalog Reference to the superclass object.
- kind
Kind of hydrospheric analog.
-
final
case class
HydrosphericPhenomenon(EnvironmentalPhenomenon: EnvironmentalPhenomenon = null) extends Element with Product with Serializable
A hydrospheric phenomenon.
A hydrospheric phenomenon.
- EnvironmentalPhenomenon
EnvironmentalPhenomenon Reference to the superclass object.
-
final
case class
ICCPInformationMessage(IdentifiedObject: IdentifiedObject = null, localReference: String = null, scope: String = null, TASE2BilateralTable: List[String] = null) extends Element with Product with Serializable
This class represents the TASE.2 Information Message Object.
This class represents the TASE.2 Information Message Object.
The IdentifiedObject.name attribute must be non-null. The value of the attribute shall be used as the TASE.2 Information Reference, as specified by 60870-6-503.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- localReference
The Local Reference attribute specifies a value agreed upon between sender and receiver of the Information Message. It further identifies the Information Message.
- scope
Indicates if the Point is global scoped (e.g. VCC) or accessible only to the Bilateral table peer (e.g. ICC).
- TASE2BilateralTable
TASE2BilateralTable Bilateral table agreement that includes the informational message.
-
final
case class
ICCPProvidedPoint(ProvidedBilateralPoint: ProvidedBilateralPoint = null, accessPriviledge: String = null, pointQuality: String = null, pointType: String = null, scope: String = null) extends Element with Product with Serializable
The IdentifiedObject.name attribute must have a value.
The IdentifiedObject.name attribute must have a value.
The name attribute shall be used as the DataValue name used for the exchange.
- ProvidedBilateralPoint
ProvidedBilateralPoint Reference to the superclass object.
- accessPriviledge
Provides information regarding the access privileges allowed to the ICCP Point.
- pointQuality
Specifies the type of ICCP quality that will be conveyed as part of the ICCP Point.
- pointType
Indicates the ICCP Point type that is to be conveyed. A CIM AccumlatorValue shall be mapped to an ICCP real. A CIM AnalogValue shall be mapped to an ICCP real. A CIM DiscreteValue shall be mapped to either an ICCP real, state, stateSupplemental, or either protection event type. A CIM StringMeasurementValue does not have a standardized mapping.
- scope
Indicates if the Point is global scoped (e.g. VCC) or accessible only to the Bilateral table peer (e.g. ICC).
-
final
case class
ICCPVCC(BilateralExchangeActor: BilateralExchangeActor = null) extends Element with Product with Serializable
Indicates that the ICCP information is global in nature and normally is available to all authorized peers.
Indicates that the ICCP information is global in nature and normally is available to all authorized peers.
- BilateralExchangeActor
BilateralExchangeActor Reference to the superclass object.
-
final
case class
ICCPVirtualControlCentre(BilateralExchangeActor: BilateralExchangeActor = null, applicationSecurityRequirement: String = null, calling: Boolean = false, clientAndServer: Boolean = false, minimumUpdateInterval: Int = 0, nameOfLocalICC: String = null, supportForBlock1: Boolean = false, supportForBlock2: Boolean = false, supportForBlock3: Boolean = false, supportForBlock4: Boolean = false, supportForBlock5: Boolean = false, supportForDepriciatedBlock8: Boolean = false, transportSecurityRequirement: Boolean = false) extends Element with Product with Serializable
This contains the information that a particular actor exposes for a particular agreed upon ICCP Bilateral Table.
This contains the information that a particular actor exposes for a particular agreed upon ICCP Bilateral Table.
- BilateralExchangeActor
BilateralExchangeActor Reference to the superclass object.
- applicationSecurityRequirement
Specifies the expected security mechanism, per IEC 62351-4, to be utilized.
- calling
Used to indicate if the Provider is responsible for initiating the TASE.2 connection. If the value is TRUE, the provider is responsible for establishing the association. If the value is FALSE, the peer provider of the Bilateral Table will need to establish the association.
- clientAndServer
If True the value indicates that the entity represented by the bilateral table is capable of issuing requests and responding to request (e.g. bidirectional support of ICCP requests). If False, this indicates that a calling entity (e.g. calling = True) will not be able to respond to ICCP requests. If False, and calling=False, this indicates that the entity will only respond to ICCP requests and not issue ICCP requests.
- minimumUpdateInterval
Specifies the fastest update interval that can be provided for integrity information and Transfer Set creation. The value is in seconds.
- nameOfLocalICC
Specifies the ICC scope name that the remote can use to access the information in the Bilateral Table if the information is not VCC scoped. This value may not be null.
- supportForBlock1
Per IEC 60870-6-702: If true indicates support for basic services. Must always be true.
- supportForBlock2
Per IEC 60870-6-702: If true indicates support for extended conditions.
- supportForBlock3
Per IEC 60870-6-702: If true indicates support for blocked transfers.
- supportForBlock4
Per IEC 60870-6-702: If true indicates support for information messages.
- supportForBlock5
Per IEC 60870-6-702: If true indicates support for device control.
- supportForDepriciatedBlock8
Per IEC 60870-6-702: If true indicates support for accounts. The use of this block was deprecated in Edition 3.
- transportSecurityRequirement
If true, then transport level security as specified by IEC 62351-6 is required.
-
final
case class
IEC61968CIMVersion(Element: BasicElement = null, date: String = null, version: String = null) extends Element with Product with Serializable
IEC 61968 version number assigned to this UML model.
IEC 61968 version number assigned to this UML model.
- Element
Reference to the superclass object.
- date
(const=2016-10-31) Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05.
- version
(const=IEC61968CIM13v09) Form is IEC61968CIMXXvYY[a-z] where XX is the major CIM package version and the YY is the minor version. For example IEC61968CIM10v17a. The letter on the version number indicates the changes are due to National Committee comments.
-
final
case class
IEC61970CIMVersion(Element: BasicElement = null, date: String = null, version: String = null) extends Element with Product with Serializable
This is the IEC 61970 CIM version number assigned to this UML model.
This is the IEC 61970 CIM version number assigned to this UML model.
- Element
Reference to the superclass object.
- date
Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05.
- version
Form is IEC61970CIMXXvYY where XX is the major CIM package version and the YY is the minor version. For example IEC61970CIM13v18.
-
final
case class
IEC62325CIMVersion(Element: BasicElement = null, date: String = null, version: String = null) extends Element with Product with Serializable
IEC 62325 version number assigned to this UML model.
IEC 62325 version number assigned to this UML model.
- Element
Reference to the superclass object.
- date
Form is YYYY-MM-DD for example for January 5, 2009 it is 2009-01-05.
- version
Form is IEC62325CIMXXvYY where XX is the major CIM package version and the YY is the minor version. For example IEC62325CIM10v03.
-
final
case class
IECStandard(Element: BasicElement = null, standardEdition: String = null, standardNumber: String = null) extends Element with Product with Serializable
Standard published by IEC (International Electrotechnical Commission).
Standard published by IEC (International Electrotechnical Commission).
- Element
Reference to the superclass object.
- standardEdition
Edition of IEC standard.
- standardNumber
IEC standard number.
-
final
case class
IEEEStandard(Element: BasicElement = null, standardEdition: String = null, standardNumber: String = null) extends Element with Product with Serializable
Standard published by IEEE (Institute of Electrical and Electronics Engineers).
Standard published by IEEE (Institute of Electrical and Electronics Engineers).
- Element
Reference to the superclass object.
- standardEdition
Edition of IEEE standard.
- standardNumber
IEEE standard number.
-
final
case class
IOPoint(IdentifiedObject: IdentifiedObject = null, BilateralToIOPoint: List[String] = null, IOPointSource: String = null) extends Element with Product with Serializable
The class describe a measurement or control value.
The class describe a measurement or control value.
The purpose is to enable having attributes and associations common for measurement and control.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- BilateralToIOPoint
ProvidedBilateralPoint Bilateral ICCP point for the measurement or control.
- IOPointSource
IOPointSource Local merasurement value source for an ICCP point.
-
final
case class
IOPointSource(MeasurementValueSource: MeasurementValueSource = null, IOPoint: List[String] = null) extends Element with Product with Serializable
Indicates the point source for an IO Point.
Indicates the point source for an IO Point.
- MeasurementValueSource
MeasurementValueSource Reference to the superclass object.
- IOPoint
IOPoint ICCP point for a local measurement value source.
-
final
case class
IPAccessPoint(CommunicationLink: CommunicationLink = null, address: String = null, addressType: String = null, gateway: String = null, subnet: String = null) extends Element with Product with Serializable
Internet Protocol Access Point – used to represent an addressing structure is based upon an Internet Protocol (IP) address.
Internet Protocol Access Point – used to represent an addressing structure is based upon an Internet Protocol (IP) address.
- CommunicationLink
CommunicationLink Reference to the superclass object.
- address
Is the dotted decimal IP Address resolve the IP address. The format is controlled by the value of the addressType.
- addressType
IP address type.
- gateway
Is the dotted decimal IPAddress of the first hop router. Format is controlled by the addressType.
- subnet
This is the IP subnet mask which controls the local vs non-local routing.
-
final
case class
ISOStandard(Element: BasicElement = null, standardEdition: String = null, standardNumber: String = null) extends Element with Product with Serializable
Standard published by ISO (International Organization for Standardization).
Standard published by ISO (International Organization for Standardization).
- Element
Reference to the superclass object.
- standardEdition
Edition of ISO standard.
- standardNumber
ISO standard number.
-
final
case class
ISOUpperLayer(TCPAccessPoint: TCPAccessPoint = null, aeInvoke: Int = 0, aeQual: Int = 0, apInvoke: Int = 0, apTitle: String = null, osiPsel: String = null, osiSsel: String = null, osiTsel: String = null, UpperLayerPublicX509Certificate: List[String] = null) extends Element with Product with Serializable
Is a set of configure addressing information that is required since ICCP utilizes addressing other than a TCP port.
Is a set of configure addressing information that is required since ICCP utilizes addressing other than a TCP port.
- TCPAccessPoint
TCPAccessPoint Reference to the superclass object.
- aeInvoke
Is part of the Application Entity addressing as specified by ISO Addressing.
- aeQual
Is the AE qualifier and represents further application level addressing information.
- apInvoke
Is a further application level OSI addressing parameter.
- apTitle
Is a sequence of integer strings separated by ".". The value, in conjunction with other application addressing attributes (e.g. other APs) are used to select a specific application (e.g. the ICCP application entity) per the OSI reference model. The sequence, and its values, represent a namespace whose values are governed by ISO/IEC 7498-3.
- osiPsel
Is the addressing selector for OSI presentation addressing.
- osiSsel
Is the OSI session layer addressing information.
- osiTsel
Is the OSI Transport Layer addressing information.
- UpperLayerPublicX509Certificate
PublicX509Certificate Certificate to be bound for use for Application layer mutual authentication.
- final case class IdcInverterControl(Element: BasicElement = null) extends Element with Product with Serializable
-
final
case class
IdentifiedObject(Element: BasicElement = null, aliasName: String = null, description: String = null, mRID: String = null, name: String = null, DiagramObjects: List[String] = null, InstanceSet: String = null, Names: List[String] = null, PropertiesCIMDataObject: String = null, TargetingCIMDataObject: List[String] = null) extends Element with Product with Serializable
This is a root class to provide common identification for all classes needing identification and naming attributes.
This is a root class to provide common identification for all classes needing identification and naming attributes.
- Element
Reference to the superclass object.
- aliasName
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.
- description
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.
- mRID
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.
- name
The name is any free human readable and possibly non unique text naming the object.
- DiagramObjects
DiagramObject The diagram objects that are associated with the domain object.
- InstanceSet
InstanceSet Dataset containing the data objects.
- Names
Name All names of this identified object.
- PropertiesCIMDataObject
ChangeSetMember The single CIM data object in the appropriate dataset context.
- TargetingCIMDataObject
ChangeSetMember Data objects registered.
- final case class IgnAngleContInverter(Element: BasicElement = null) extends Element with Product with Serializable
-
final
case class
InUseDate(Element: BasicElement = null, inUseDate: String = null, notReadyForUseDate: String = null, readyForUseDate: String = null) extends Element with Product with Serializable
Dates associated with asset 'in use' status.
Dates associated with asset 'in use' status.
May have multiple in use dates for this device and a compound type allows a query to return multiple dates.
- Element
Reference to the superclass object.
- inUseDate
Date asset was most recently put in use.
- notReadyForUseDate
Date of most recent asset transition to not ready for use state.
- readyForUseDate
Date of most recent asset transition to ready for use state.
-
final
case class
InadvertentAccount(Element: BasicElement = null, SubControlArea: String = null) extends Element with Product with Serializable
An account for tracking inadvertent interchange versus time for each control area.
An account for tracking inadvertent interchange versus time for each control area.
A control area may have more than one inadvertent account in order to track inadvertent over one or more specific tie points in addition to the usual overall net inadvertent. Separate accounts would also be used to track designated time periods, such as on-peak and off-peak.
- Element
Reference to the superclass object.
- SubControlArea
SubControlArea A control area can have one or more net inadvertent interchange accounts
-
final
case class
Incident(Document: Document = null, cause: String = null, CustomerNotifications: List[String] = null, IncidentHazard: List[String] = null, Location: String = null, Outage: String = null, Owner: String = null, TroubleOrder: String = null, TroubleTickets: List[String] = null, UnplannedOutage: String = null, Works: List[String] = null) extends Element with Product with Serializable
Description of a problem in the field that may be reported in a trouble ticket or come from another source.
Description of a problem in the field that may be reported in a trouble ticket or come from another source.
It may have to do with an outage.
- Document
Document Reference to the superclass object.
- cause
Cause of this incident.
- CustomerNotifications
CustomerNotification All notifications for a customer related to the status change of this incident.
- IncidentHazard
IncidentHazard All hazards associated with this incident.
- Location
Location Location of this incident.
- Outage
Outage Outage for this incident.
- Owner
Operator Operator who owns this incident.
- TroubleOrder
TroubleOrder undocumented
- TroubleTickets
TroubleTicket All trouble tickets reporting this incident.
- UnplannedOutage
UnplannedOutage undocumented
- Works
Work All works addressing this incident.
-
final
case class
IncidentHazard(Hazard: Hazard = null, Incident: String = null, TroubleTicket: String = null) extends Element with Product with Serializable
Hazardous situation associated with an incident.
Hazardous situation associated with an incident.
Examples are line down, gas leak, fire, etc.
- Hazard
Hazard Reference to the superclass object.
- Incident
Incident Incident associated with this hazard.
- TroubleTicket
TroubleTicket Trouble ticket associated with this hazard.
-
final
case class
IncrementalDatasetArg(ModelOperationArg: ModelOperationArg = null, IncrementalDataset: String = null, IncrementalDatasetArgDescription: String = null) extends Element with Product with Serializable
A generic model operation argument referencing an incremental change description.
A generic model operation argument referencing an incremental change description.
- ModelOperationArg
ModelOperationArg Reference to the superclass object.
- IncrementalDataset
ChangeSet undocumented
- IncrementalDatasetArgDescription
IncrementalDatasetArgDescription undocumented
- final case class IncrementalDatasetArgDescription(ModelOperationArgDescription: ModelOperationArgDescription = null, IncrementalDatasetArg: List[String] = null) extends Element with Product with Serializable
-
final
case class
IncrementalHeatRateCurve(Curve: Curve = null, isNetGrossP: Boolean = false, ThermalGeneratingUnit: String = null) extends Element with Product with Serializable
Relationship between unit incremental heat rate in (delta energy/time) per (delta active power) and unit output in active power.
Relationship between unit incremental heat rate in (delta energy/time) per (delta active power) and unit output in active power.
The IHR curve represents the slope of the HeatInputCurve. Note that the "incremental heat rate" and the "heat rate" have the same engineering units.
- Curve
Curve Reference to the superclass object.
- isNetGrossP
Flag is set to true when output is expressed in net active power.
- ThermalGeneratingUnit
ThermalGeneratingUnit A thermal generating unit may have an incremental heat rate curve.
-
final
case class
IndividualPnode(Pnode: Pnode = null, CongestionArea: List[String] = null, GenDistributionFactor: String = null, LoadDistributionFactor: String = null, MktConnectivityNode: String = null, PnodeDistributionFactor: List[String] = null) extends Element with Product with Serializable
Individual pricing node based on Pnode.
Individual pricing node based on Pnode.
- Pnode
Pnode Reference to the superclass object.
- CongestionArea
CongestionArea undocumented
- GenDistributionFactor
GenDistributionFactor undocumented
- LoadDistributionFactor
LoadDistributionFactor undocumented
- MktConnectivityNode
MktConnectivityNode undocumented
- PnodeDistributionFactor
PnodeDistributionFactor undocumented
-
final
case class
InflowForecast(RegularIntervalSchedule: RegularIntervalSchedule = null, Reservoir: String = null) extends Element with Product with Serializable
Natural water inflow to a reservoir, usually forecasted from predicted rain and snowmelt.
Natural water inflow to a reservoir, usually forecasted from predicted rain and snowmelt.
Typically in one hour increments for up to 10 days. The forecast is given in average cubic meters per second over the time increment.
- RegularIntervalSchedule
RegularIntervalSchedule Reference to the superclass object.
- Reservoir
Reservoir A reservoir may have a "natural" inflow forecast.
-
final
case class
InfoQuestion(WorkDocument: WorkDocument = null, answer: String = null, answerDateTime: String = null, answerRemark: String = null, questionCode: String = null, questionRemark: String = null, questionText: String = null, questionType: String = null) extends Element with Product with Serializable
Questions and answers associated with a type of document for purposes of clarification.
Questions and answers associated with a type of document for purposes of clarification.
Questions may be predefined or ad hoc.
- WorkDocument
WorkDocument Reference to the superclass object.
- answer
Answer to question.
- answerDateTime
The date and time the quesiton was answered.
- answerRemark
Remarks to qualify the answer.
- questionCode
The question code. If blank, refer to questionText.
- questionRemark
Remarks to qualify the question in this situation.
- questionText
For non-coded questions, the question is provided here.
- questionType
The type of the question.
-
final
case class
InspectionAnalog(AssetAnalog: AssetAnalog = null, kind: String = null) extends Element with Product with Serializable
Asset inspection type of analog.
Asset inspection type of analog.
- AssetAnalog
AssetAnalog Reference to the superclass object.
- kind
Kind of analog representing inspection result.
-
final
case class
InspectionDataSet(ProcedureDataSet: ProcedureDataSet = null, locationCondition: String = null, AccordingToSchedules: List[String] = null) extends Element with Product with Serializable
Documents the result of one inspection, for a given attribute of an asset.
Documents the result of one inspection, for a given attribute of an asset.
- ProcedureDataSet
ProcedureDataSet Reference to the superclass object.
- locationCondition
Description of the conditions of the location where the asset resides.
- AccordingToSchedules
ScheduledEventData undocumented
-
final
case class
InspectionDiscrete(AssetDiscrete: AssetDiscrete = null, kind: String = null) extends Element with Product with Serializable
Asset inspection type of discrete.
Asset inspection type of discrete.
- AssetDiscrete
AssetDiscrete Reference to the superclass object.
- kind
Kind of discrete representing inspection result.
-
final
case class
InstanceSet(DataSet: DataSet = null, DatasetArg: List[String] = null, InstanceSetMember: List[String] = null) extends Element with Product with Serializable
Instance of a version of a model part.
Instance of a version of a model part.
This corresponds to a payload of instance data.
- DataSet
DataSet Reference to the superclass object.
- DatasetArg
DatasetArg The role of a dataset in the context of an operation.
- InstanceSetMember
IdentifiedObject Data objects contained in the dataset.
-
final
case class
InstructionClearing(MarketFactors: MarketFactors = null, ActualDemandResponseEvent: String = null, Instructions: List[String] = null, ResourceDeploymentStatus: List[String] = null) extends Element with Product with Serializable
Model of market clearing, relating to commitment instructions.
Model of market clearing, relating to commitment instructions.
Identifies interval.
- MarketFactors
MarketFactors Reference to the superclass object.
- ActualDemandResponseEvent
DistributedResourceActualEvent ActualDemandResponseEvents may exist that are not part of a cordinated MarketActualEvent associated to a Market. These ActualDemandResponseEvents can have many InstructionClearing Instructions for specified RegisteredResources or Distributed Energy Resource type of AggregateNodes.
- Instructions
Instructions undocumented
- ResourceDeploymentStatus
ResourceDeploymentStatus undocumented
-
final
case class
InstructionClearingDOP(MarketFactors: MarketFactors = null, DopInstruction: List[String] = null) extends Element with Product with Serializable
Model of market clearing, related to Dispatch Operating Point.
Model of market clearing, related to Dispatch Operating Point.
Identifies interval.
- MarketFactors
MarketFactors Reference to the superclass object.
- DopInstruction
DopInstruction undocumented
-
final
case class
InstructionClearingDOT(MarketFactors: MarketFactors = null, contingencyActive: String = null, dispatchMode: String = null, DemandResponseActualEvent: String = null, DotInstruction: List[String] = null) extends Element with Product with Serializable
Model of market clearing, related to Dispatch Operating Target (model of anticipatory dispatch).
Model of market clearing, related to Dispatch Operating Target (model of anticipatory dispatch).
Identifies interval.
- MarketFactors
MarketFactors Reference to the superclass object.
- contingencyActive
Indication that the system is currently operating in a contingency mode.
- dispatchMode
undocumented
- DemandResponseActualEvent
DistributedResourceActualEvent undocumented
- DotInstruction
DotInstruction undocumented
-
final
case class
Instructions(Element: BasicElement = null, bindingDOD: Double = 0.0, bindingDOT: Double = 0.0, bindingInstruction: String = null, instructionCost: Double = 0.0, instructionSource: String = null, instructionStartTime: String = null, instructionType: String = null, manuallyBlocked: String = null, minStatusChangeTime: Int = 0, updateTimeStamp: String = null, updateType: String = null, updateUser: String = null, AggregateNode: String = null, InstructionClearing: List[String] = null, RegisteredResource: String = null) extends Element with Product with Serializable
Provides the necessary information (on a resource basis) to capture the Startup/Shutdown instruction results.
Provides the necessary information (on a resource basis) to capture the Startup/Shutdown instruction results.
This information is relevant to the DA Market (RUC only) as well as the RT Market (HASP, Pre-dispatch, and Interval).
- Element
Reference to the superclass object.
- bindingDOD
Binding dispatch operating delta provides a relative delta to be applied. Typically used in demand response instructions. The binding<font color="#0f0f0f">DOD instructions are cumulative; in other words a second DOD instruction does not replace the previous DOD, instead the second DOD adds to the previous DODs.</font>
- bindingDOT
undocumented
- bindingInstruction
undocumented
- instructionCost
Total cost associated with changing the status of the resource.
- instructionSource
instruction source for market quality results (INS, ACT)
- instructionStartTime
Time the resource should be at Pmin (for start ups). Time the resource is off line.
- instructionType
Indicator of either a Start-Up or a Shut-Down.
- manuallyBlocked
Manually Blocked Indicator (Yes/No). The instruction has been blocked by an Operator.
- minStatusChangeTime
Minimum start up time required to bring the unit online (minutes). SCUC commitment period start-up time. Calculated start up time based on the StartUpTimeCurve provided with the Bid. This is a combination of StartUp time bid and Unit down time. Units is minutes
- updateTimeStamp
undocumented
- updateType
undocumented
- updateUser
undocumented
- AggregateNode
AggregateNode undocumented
- InstructionClearing
InstructionClearing undocumented
- RegisteredResource
RegisteredResource undocumented
-
final
case class
IntSchedAgreement(Agreement: Agreement = null, defaultIntegrationMethod: String = null) extends Element with Product with Serializable
A type of agreement that provides the default method by which interchange schedules are to be integrated to obtain hourly MWh schedules for accounting.
A type of agreement that provides the default method by which interchange schedules are to be integrated to obtain hourly MWh schedules for accounting.
- Agreement
Agreement Reference to the superclass object.
- defaultIntegrationMethod
The default method by which interchange schedules are to be integrated to obtain hourly MWh schedules for accounting. Method #1 is to integrate the instantaneous schedule between the hourly boundaries. Method #2 compensates for any up/down ramping that occurs across the hourly boundary (this is called block accounting).
-
final
case class
IntegerQuantity(Element: BasicElement = null, multiplier: String = null, unit: String = null, value: Int = 0) extends Element with Product with Serializable
Quantity with integer value and associated unit information.
Quantity with integer value and associated unit information.
- Element
Reference to the superclass object.
- multiplier
Unit multiplier of this quantity.
- unit
Unit of this quantity.
- value
Value of this quantity.
-
final
case class
InterTieBid(ResourceBid: ResourceBid = null, minHourlyBlock_1: Int = 0, RampRateCurve: List[String] = null, RegisteredInterTie: String = null) extends Element with Product with Serializable
This class represents the inter tie bid.
This class represents the inter tie bid.
- ResourceBid
ResourceBid Reference to the superclass object.
- minHourlyBlock_1
The minimum hourly block for an Inter-Tie Resource supplied within the bid.
- RampRateCurve
RampRateCurve undocumented
- RegisteredInterTie
RegisteredInterTie undocumented
-
final
case class
InterTieClearing(MarketFactors: MarketFactors = null, InterTieResults: List[String] = null) extends Element with Product with Serializable
Model of market clearing related to results at the inter-ties.
Model of market clearing related to results at the inter-ties.
Identifies interval
- MarketFactors
MarketFactors Reference to the superclass object.
- InterTieResults
InterTieResults undocumented
-
final
case class
InterTieDispatchResponse(Element: BasicElement = null, acceptMW: Double = 0.0, acceptStatus: String = null, clearedMW: Double = 0.0, passIndicator: String = null, startTime: String = null, RegisteredInterTie: String = null) extends Element with Product with Serializable
Response from an intertie resource acknowledging receipt of dispatch instructions.
Response from an intertie resource acknowledging receipt of dispatch instructions.
- Element
Reference to the superclass object.
- acceptMW
The accepted mw amount by the responder. aka response mw.
- acceptStatus
The accept status submitted by the responder. Valid values are NON-RESPONSE, ACCEPT, DECLINE, PARTIAL.
- clearedMW
MW amount associated with instruction. For 5 minute binding dispatches, this is the Goto MW or DOT
- passIndicator
Part of the Composite key that downstream app uses to match the instruction
- startTime
Part of the Composite key that downstream app uses to match the instruction
- RegisteredInterTie
RegisteredInterTie undocumented
-
final
case class
InterTieResults(Element: BasicElement = null, baseMW: Double = 0.0, clearedValue: Double = 0.0, Flowgate: String = null, InterTieClearing: String = null) extends Element with Product with Serializable
Provides the tie point specific output from the market applications.
Provides the tie point specific output from the market applications.
Currently, this is defined as the loop flow compensation MW value.
- Element
Reference to the superclass object.
- baseMW
Net Actual MW Flow
- clearedValue
Net Dispatched MW
- Flowgate
Flowgate undocumented
- InterTieClearing
InterTieClearing undocumented
-
final
case class
InterchangeETCData(Element: BasicElement = null, contractNumber: String = null, usageMW: Double = 0.0, InterchangeSchedule: String = null) extends Element with Product with Serializable
Existing Transmission Contract data for an interchange schedule.
Existing Transmission Contract data for an interchange schedule.
- Element
Reference to the superclass object.
- contractNumber
Existing transmission contract number
- usageMW
Existing transmission contract usage MW value
- InterchangeSchedule
InterchangeSchedule undocumented
-
final
case class
InterchangeSchedule(Curve: Curve = null, checkOutType: String = null, directionType: String = null, energyType: String = null, intervalLength: Int = 0, marketType: String = null, operatingDate: String = null, outOfMarketType: Boolean = false, scheduleType: String = null, wcrID: String = null, InterTie: String = null, InterchangeETCData: List[String] = null, RegisteredInterTie: String = null) extends Element with Product with Serializable
Interchange schedule class to hold information for interchange schedules such as import export type, energy type, and etc.
Interchange schedule class to hold information for interchange schedules such as import export type, energy type, and etc.
- Curve
Curve Reference to the superclass object.
- checkOutType
To indicate a check out type such as adjusted capacity or dispatch capacity.
- directionType
Import or export.
- energyType
Energy product type.
- intervalLength
Interval length.
- marketType
Market type.
- operatingDate
Operating date, hour.
- outOfMarketType
To indicate an out-of-market (OOM) schedule.
- scheduleType
Schedule type.
- wcrID
Wheeling Counter-Resource ID (required when Schedule Type=Wheel).
- InterTie
SchedulingPoint undocumented
- InterchangeETCData
InterchangeETCData undocumented
- RegisteredInterTie
RegisteredInterTie undocumented
-
final
case class
IntermittentResourceEligibility(MarketFactors: MarketFactors = null, eligibilityStatus: String = null, RegisteredResource: String = null) extends Element with Product with Serializable
Indicates whether unit is eligible for treatment as a intermittent variable renewable resource.
Indicates whether unit is eligible for treatment as a intermittent variable renewable resource.
- MarketFactors
MarketFactors Reference to the superclass object.
- eligibilityStatus
Indicates whether a resource is eligible for PIRP program for a given hour
- RegisteredResource
RegisteredResource undocumented
-
final
case class
InternalControlArea(IdentifiedObject: IdentifiedObject = null, CurrentEmergencySI: List[String] = null, CurrentScheduledInterchange: String = null) extends Element with Product with Serializable
There is one internal control area in the system, which is the single control area in the primary network company.
There is one internal control area in the system, which is the single control area in the primary network company.
Real time generation control affects only the internal control area.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- CurrentEmergencySI
CurrentEmergencyScheduledInterchange undocumented
- CurrentScheduledInterchange
CurrentScheduledInterchange undocumented
-
final
case class
InternalLocation(WorkLocation: WorkLocation = null, buildingName: String = null, buildingNumber: String = null, floor: Int = 0, roomNumber: String = null) extends Element with Product with Serializable
Description of location internal to a building.
Description of location internal to a building.
- WorkLocation
WorkLocation Reference to the superclass object.
- buildingName
Name of building where location is.
- buildingNumber
Number of building where location is.
- floor
Floor of location.
- roomNumber
Room number of location.
-
final
case class
InterrupterUnit(Asset: Asset = null, Bushing: List[String] = null, OperatingMechanism: String = null) extends Element with Product with Serializable
Breaker interrupter.
Breaker interrupter.
Some interrupters have one fixed and one moving contact, some have 2 fixed contacts, some 2 moving contacts. An interrupter will have relationships with 2 bushings and those relationships may be any combination of the FixedContact and MovingContact associations.
- Asset
Asset Reference to the superclass object.
- Bushing
Bushing Bushing(s) to which the moving contact(s) of this interrupter is(are) attached. Some interrupters have one fixed and one moving contact, some have 2 fixed contacts, some 2 moving contacts. An interrupter will have relationships with 2 bushings and those relationships may be any combination of the FixedContact and MovingContact associations.
- OperatingMechanism
OperatingMechanism Breaker mechanism controlling this interrupter.
-
final
case class
InterrupterUnitInfo(AssetInfo: AssetInfo = null, interruptingMedium: String = null) extends Element with Product with Serializable
Interrupter datasheet information.
Interrupter datasheet information.
- AssetInfo
AssetInfo Reference to the superclass object.
- interruptingMedium
Interrupting medium.
-
final
case class
IntervalBlock(Element: BasicElement = null, IntervalReadings: List[String] = null, MeterReading: String = null, PendingCalculation: String = null, ReadingType: String = null) extends Element with Product with Serializable
Time sequence of readings of the same reading type.
Time sequence of readings of the same reading type.
Contained interval readings may need conversion through the application of an offset and a scalar defined in associated pending. Table 548 shows all association ends of IntervalBlock with other classes. Table 548 – Association ends of Metering::IntervalBlock with other classes Associations name mult to type description
0..* PendingCalculation 0..1 PendingCalculation Pending calculation to apply to interval reading values contained by this block (after which the resulting reading type is different than the original because it reflects the conversion result).
0..* IntervalReadings 0..* IntervalReading Interval reading contained in this block.
0..* ReadingType 0..1 ReadingType Type information for interval reading values contained in this block.
0..* MeterReading 0..1 MeterReading Meter reading containing this interval block.
IntervalReading Data captured at regular intervals of time. Interval data could be captured as incremental data, absolute data, or relative data. The source for the data is usually a tariff quantity or an engineering quantity. Data is typically captured in time-tagged, uniform, fixed-length intervals of 5 min, 10 min, 15 min, 30 min, or 60 min. Note: Interval Data is sometimes also called "Interval Data Readings" (IDR).
- Element
Reference to the superclass object.
- IntervalReadings
IntervalReading Interval reading contained in this block.
- MeterReading
MeterReading Meter reading containing this interval block.
- PendingCalculation
PendingCalculation Pending calculation to apply to interval reading values contained by this block (after which the resulting reading type is different than the original because it reflects the conversion result).
- ReadingType
ReadingType Type information for interval reading values contained in this block.
-
final
case class
IntervalReading(BaseReading: BaseReading = null, IntervalBlocks: List[String] = null) extends Element with Product with Serializable
Data captured at regular intervals of time.
Data captured at regular intervals of time.
Interval data could be captured as incremental data, absolute data, or relative data. The source for the data is usually a tariff quantity or an engineering quantity. Data is typically captured in time-tagged, uniform, fixed-length intervals of 5 min, 10 min, 15 min, 30 min, or 60 min. Note: Interval Data is sometimes also called "Interval Data Readings" (IDR).
- BaseReading
BaseReading Reference to the superclass object.
- IntervalBlocks
IntervalBlock All blocks containing this interval reading.
-
final
case class
IrregularIntervalSchedule(BasicIntervalSchedule: BasicIntervalSchedule = null, TimePoints: List[String] = null) extends Element with Product with Serializable
The schedule has time points where the time between them varies.
The schedule has time points where the time between them varies.
- BasicIntervalSchedule
BasicIntervalSchedule Reference to the superclass object.
- TimePoints
IrregularTimePoint The point data values that define a curve.
-
final
case class
IrregularTimePoint(Element: BasicElement = null, time: Double = 0.0, value1: Double = 0.0, value2: Double = 0.0, IntervalSchedule: String = null) extends Element with Product with Serializable
TimePoints for a schedule where the time between the points varies.
TimePoints for a schedule where the time between the points varies.
- Element
Reference to the superclass object.
- time
The time is relative to the schedule starting time.
- value1
The first value at the time. The meaning of the value is defined by the derived type of the associated schedule.
- value2
The second value at the time. The meaning of the value is defined by the derived type of the associated schedule.
- IntervalSchedule
IrregularIntervalSchedule An IrregularTimePoint belongs to an IrregularIntervalSchedule.
-
final
case class
Issuer(DocumentPersonRole: DocumentPersonRole = null, Documents: List[String] = null) extends Element with Product with Serializable
Person who issued the document and is responsible for its content.
Person who issued the document and is responsible for its content.
- DocumentPersonRole
DocumentPersonRole Reference to the superclass object.
- Documents
Document All documents for this issuer.
-
final
case class
Joint(Asset: Asset = null, configurationKind: String = null, fillKind: String = null, insulation: String = null) extends Element with Product with Serializable
Joint connects two or more cables.
Joint connects two or more cables.
It includes the portion of cable under wipes, welds, or other seals.
- Asset
Asset Reference to the superclass object.
- configurationKind
Configuration of joint.
- fillKind
Material used to fill the joint.
- insulation
The type of insulation around the joint, classified according to the utility's asset management standards and practices.
-
final
case class
Jumper(Switch: Switch = null, JumperAction: String = null) extends Element with Product with Serializable
A short section of conductor with negligible impedance which can be manually removed and replaced if the circuit is de-energized.
A short section of conductor with negligible impedance which can be manually removed and replaced if the circuit is de-energized.
Note that zero-impedance branches can potentially be modelled by other equipment types.
- Switch
Switch Reference to the superclass object.
- JumperAction
JumperAction Action taken with this jumper.
-
final
case class
JumperAction(SwitchingAction: SwitchingAction = null, kind: String = null, ACLineSegments: List[String] = null, Clamp: String = null, JumpedEquipments: List[String] = null, Jumper: String = null) extends Element with Product with Serializable
Action on jumper as a switching step.
Action on jumper as a switching step.
- SwitchingAction
SwitchingAction Reference to the superclass object.
- kind
Switching action to perform.
- ACLineSegments
ACLineSegment The line segment that this jumper action will affect. This is the only way to access relationship to clamp in case the jumper needs to connect along the line segment.
- Clamp
Clamp undocumented
- JumpedEquipments
ConductingEquipment Conducting equipment is affected when the jumper action connects one or both ends of a jumper to the conducting equipment. If the jumper action involves placing one or both ends of a jumper anywhere along a line segment, you must use the clamp (to get the distance from one terminal), using the explicit relation with clamp. In the case of placing one or both ends of the jumper at a line segment terminal, reference to one or more line segments is sufficient.
- Jumper
Jumper Jumper on which this action is taken.
-
final
case class
Junction(Connector: Connector = null) extends Element with Product with Serializable
A point where one or more conducting equipments are connected with zero resistance.
A point where one or more conducting equipments are connected with zero resistance.
- Connector
Connector Reference to the superclass object.
-
final
case class
LabTestDataSet(ProcedureDataSet: ProcedureDataSet = null, conclusion: String = null, conclusionConfidence: String = null, reasonForTest: String = null, testEquipmentID: String = null, AssetTestLab: String = null, Specimen: String = null) extends Element with Product with Serializable
Results of testing done by a lab.
Results of testing done by a lab.
- ProcedureDataSet
ProcedureDataSet Reference to the superclass object.
- conclusion
Conclusion drawn from test results.
- conclusionConfidence
Description of confidence in conclusion.
- reasonForTest
Reason for performing test.
- testEquipmentID
Identity of lab equipment used to perform test.
- AssetTestLab
AssetTestLab Test lab which produced this set of lab test results.
- Specimen
Specimen Specimen on which lab testing done in determining results.
-
final
case class
LaborItem(WorkIdentifiedObject: WorkIdentifiedObject = null, activityCode: String = null, cost: Double = 0.0, laborDuration: Double = 0.0, laborRate: Double = 0.0, status: String = null, ErpPersons: List[String] = null, WorkCostDetail: String = null, WorkTask: String = null) extends Element with Product with Serializable
Labor used for work order.
Labor used for work order.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- activityCode
Activity code identifies a specific and distinguishable unit of work.
- cost
Total cost for labor. Note that this may not be able to be derived from labor rate and time charged.
- laborDuration
Time required to perform work.
- laborRate
The labor rate applied for work.
- status
undocumented
- ErpPersons
OldPerson undocumented
- WorkCostDetail
WorkCostDetail undocumented
- WorkTask
OldWorkTask undocumented
-
final
case class
LaborelecStandard(Element: BasicElement = null, standardEdition: String = null, standardNumber: String = null) extends Element with Product with Serializable
Standard published by Laborelec.
Standard published by Laborelec.
- Element
Reference to the superclass object.
- standardEdition
Edition of Laborelec standard.
- standardNumber
Laborelec standard number.
-
final
case class
LandProperty(IdentifiedObject: IdentifiedObject = null, demographicKind: String = null, externalRecordReference: String = null, kind: String = null, status: String = null, AssetContainers: List[String] = null, ErpOrganisationRoles: List[String] = null, ErpPersonRoles: List[String] = null, ErpSiteLevelDatas: List[String] = null, LocationGrants: List[String] = null, Locations: List[String] = null, RightOfWays: List[String] = null) extends Element with Product with Serializable
Information about a particular piece of (land) property such as its use.
Information about a particular piece of (land) property such as its use.
Ownership of the property may be determined through associations to Organisations and/or ErpPersons.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- demographicKind
Demographics around the site.
- externalRecordReference
Reference allocated by the governing organisation (such as municipality) to this piece of land that has a formal reference to Surveyor General's records. The governing organisation is specified in associated Organisation.
- kind
Kind of (land) property, categorised according to its main functional use from the utility's perspective.
- status
undocumented
- AssetContainers
AssetContainer undocumented
- ErpOrganisationRoles
PropertyOrganisationRole undocumented
- ErpPersonRoles
PersonPropertyRole undocumented
- ErpSiteLevelDatas
ErpSiteLevelData undocumented
- LocationGrants
LocationGrant All location grants this land property has.
- Locations
Location The spatail description of a piece of property.
- RightOfWays
RightOfWay All rights of way this land property has.
-
final
case class
Landslide(GeosphericPhenomenon: GeosphericPhenomenon = null) extends Element with Product with Serializable
A landslide, a large mass of rocks and earth that suddenly and quickly moves down the side of a mountain or hill.
A landslide, a large mass of rocks and earth that suddenly and quickly moves down the side of a mountain or hill.
- GeosphericPhenomenon
GeosphericPhenomenon Reference to the superclass object.
-
final
case class
LevelVsVolumeCurve(Curve: Curve = null, Reservoir: String = null) extends Element with Product with Serializable
Relationship between reservoir volume and reservoir level.
-
final
case class
LifecycleDate(Element: BasicElement = null, installationDate: String = null, manufacturedDate: String = null, purchaseDate: String = null, receivedDate: String = null, removalDate: String = null, retiredDate: String = null) extends Element with Product with Serializable
Dates for asset lifecycle state changes.
Dates for asset lifecycle state changes.
May have multiple lifecycle dates for this device and a compound type allows a query to return multiple dates.
- Element
Reference to the superclass object.
- installationDate
Date current installation was completed, which may not be the same as the in-service date. Asset may have been installed at other locations previously. Ignored if asset is (1) not currently installed (e.g., stored in a depot) or (2) not intended to be installed (e.g., vehicle, tool).
- manufacturedDate
Date the asset was manufactured.
- purchaseDate
Date the asset was purchased. Note that even though an asset may have been purchased, it may not have been received into inventory at the time of purchase.
- receivedDate
Date the asset was received and first placed into inventory.
- removalDate
Date when the asset was last removed from service. Ignored if (1) not intended to be in service, or (2) currently in service.
- retiredDate
Date the asset is permanently retired from service and may be scheduled for disposal. Ignored if asset is (1) currently in service, or (2) permanently removed from service.
-
final
case class
LightningStrike(GeosphericPhenomenon: GeosphericPhenomenon = null, errorEllipseConfidence: Double = 0.0, errorEllipseMajorSemiAxis: Double = 0.0, errorEllipseMinorSemiAxis: Double = 0.0, errorEllipseOrientation: Double = 0.0, negativePolarity: Boolean = false, peakAmplitude: Double = 0.0) extends Element with Product with Serializable
A cloud-to-ground lightning strike at a particular location.
A cloud-to-ground lightning strike at a particular location.
- GeosphericPhenomenon
GeosphericPhenomenon Reference to the superclass object.
- errorEllipseConfidence
Likelihood that strike fell within errorEllipse.
- errorEllipseMajorSemiAxis
Length of major semi-axis (longest radius) of the error ellipse.
- errorEllipseMinorSemiAxis
Length of minor semi-axis (shortest radius) of the error ellipse.
- errorEllipseOrientation
The orientation of the major semi- axis in degrees from True North.
- negativePolarity
The polarity of the strike, with T meaning negative. About 90% of all lightning strokes are negative strokes, meaning that they were initiated by a large concentration of negative charge in the cloud-base; this tends to induce an area of positive charge on the ground.
- peakAmplitude
Peak current of strike.
-
final
case class
Limit(IdentifiedObject: IdentifiedObject = null, Procedures: List[String] = null) extends Element with Product with Serializable
Specifies one limit value for a Measurement.
Specifies one limit value for a Measurement.
A Measurement typically has several limits that are kept together by the LimitSet class. The actual meaning and use of a Limit instance (i.e., if it is an alarm or warning limit or if it is a high or low limit) is not captured in the Limit class. However the name of a Limit instance may indicate both meaning and use.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- Procedures
Procedure undocumented
-
final
case class
LimitDependency(IdentifiedObject: IdentifiedObject = null, Equipment: String = null, OperationalLimit: List[String] = null) extends Element with Product with Serializable
A limit calculation model used to compute an operational limit based on external input such as temperature.
A limit calculation model used to compute an operational limit based on external input such as temperature.
These are intended to be shared among operational limits with the same calculation form that apply to a piece of equipment..
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- Equipment
Equipment The equipment for which this limit dependency model is organized under.
- OperationalLimit
OperationalLimit The operational limits to which this limit dependency model applies.
-
final
case class
LimitScalingLimit(LimitDependency: LimitDependency = null, limitScalingPercent: Double = 0.0, SourceOperationalLimit: String = null) extends Element with Product with Serializable
Specifies an operational limit is calculated by scaling another operational limit.
Specifies an operational limit is calculated by scaling another operational limit.
- LimitDependency
LimitDependency Reference to the superclass object.
- limitScalingPercent
The associated source limit is scaled by this value to compute the limit of the dependency model.
- SourceOperationalLimit
OperationalLimit undocumented
-
final
case class
LimitSet(IdentifiedObject: IdentifiedObject = null, isPercentageLimits: Boolean = false) extends Element with Product with Serializable
Specifies a set of Limits that are associated with a Measurement.
Specifies a set of Limits that are associated with a Measurement.
A Measurement may have several LimitSets corresponding to seasonal or other changing conditions. The condition is captured in the name and description attributes. The same LimitSet may be used for several Measurements. In particular percentage limits are used this way.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- isPercentageLimits
Tells if the limit values are in percentage of normalValue or the specified Unit for Measurements and Controls.
-
final
case class
Line(EquipmentContainer: EquipmentContainer = null, Region: String = null) extends Element with Product with Serializable
Contains equipment beyond a substation belonging to a power transmission line.
Contains equipment beyond a substation belonging to a power transmission line.
- EquipmentContainer
EquipmentContainer Reference to the superclass object.
- Region
SubGeographicalRegion The sub-geographical region of the line.
-
final
case class
LineDetail(Element: BasicElement = null, amount: Double = 0.0, dateTime: String = null, note: String = null, rounding: Double = 0.0) extends Element with Product with Serializable
Details on an amount line, with rounding, date and note.
Details on an amount line, with rounding, date and note.
- Element
Reference to the superclass object.
- amount
Amount for this line item.
- dateTime
Date and time when this line was created in the application process.
- note
Free format note relevant to this line.
- rounding
Totalised monetary value of all errors due to process rounding or truncating that is not reflected in 'amount'.
-
final
case class
LineFault(Fault: Fault = null, lengthFromTerminal1: Double = 0.0, ACLineSegment: String = null) extends Element with Product with Serializable
A fault that occurs on an AC line segment at some point along the length.
A fault that occurs on an AC line segment at some point along the length.
- Fault
Fault Reference to the superclass object.
- lengthFromTerminal1
The length to the place where the fault is located starting from terminal with sequence number 1 of the faulted line segment.
- ACLineSegment
ACLineSegment The line segment of this line fault.
-
final
case class
LinearShuntCompensator(ShuntCompensator: ShuntCompensator = null, b0PerSection: Double = 0.0, bPerSection: Double = 0.0, g0PerSection: Double = 0.0, gPerSection: Double = 0.0) extends Element with Product with Serializable
A linear shunt compensator has banks or sections with equal admittance values.
A linear shunt compensator has banks or sections with equal admittance values.
- ShuntCompensator
ShuntCompensator Reference to the superclass object.
- b0PerSection
Zero sequence shunt (charging) susceptance per section.
- bPerSection
Positive sequence shunt (charging) susceptance per section.
- g0PerSection
Zero sequence shunt (charging) conductance per section.
- gPerSection
Positive sequence shunt (charging) conductance per section.
-
final
case class
LinearShuntCompensatorPhase(ShuntCompensatorPhase: ShuntCompensatorPhase = null, bPerSection: Double = 0.0, gPerSection: Double = 0.0) extends Element with Product with Serializable
A per phase linear shunt compensator has banks or sections with equal admittance values.
A per phase linear shunt compensator has banks or sections with equal admittance values.
- ShuntCompensatorPhase
ShuntCompensatorPhase Reference to the superclass object.
- bPerSection
Susceptance per section of the phase if shunt compensator is wye connected. Susceptance per section phase to phase if shunt compensator is delta connected.
- gPerSection
Conductance per section for this phase if shunt compensator is wye connected. Conductance per section phase to phase if shunt compensator is delta connected.
-
final
case class
LoadAggregate(LoadDynamics: LoadDynamics = null, LoadMotor: String = null, LoadStatic: String = null) extends Element with Product with Serializable
Aggregate loads are used to represent all or part of the real and reactive load from one or more loads in the static (power flow) data.
Aggregate loads are used to represent all or part of the real and reactive load from one or more loads in the static (power flow) data.
This load is usually the aggregation of many individual load devices and the load model is an approximate representation of the aggregate response of the load devices to system disturbances. Standard aggregate load model comprised of static and/or dynamic components. A static load model represents the sensitivity of the real and reactive power consumed by the load to the amplitude and frequency of the bus voltage. A dynamic load model can be used to represent the aggregate response of the motor components of the load.
- LoadDynamics
LoadDynamics Reference to the superclass object.
- LoadMotor
LoadMotor Aggregate motor (dynamic) load associated with this aggregate load.
- LoadStatic
LoadStatic Aggregate static load associated with this aggregate load.
-
final
case class
LoadAggregationPoint(AggregateNode: AggregateNode = null) extends Element with Product with Serializable
A specialized class of type AggregatedNode type.
A specialized class of type AggregatedNode type.
Defines Load Aggregation Points.
- AggregateNode
AggregateNode Reference to the superclass object.
-
final
case class
LoadArea(EnergyArea: EnergyArea = null, SubLoadAreas: List[String] = null) extends Element with Product with Serializable
The class is the root or first level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling.
The class is the root or first level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling.
- EnergyArea
EnergyArea Reference to the superclass object.
- SubLoadAreas
SubLoadArea The SubLoadAreas in the LoadArea.
-
final
case class
LoadBid(ResourceBid: ResourceBid = null, dropRampRate: Double = 0.0, loadRedInitiationCost: Double = 0.0, loadRedInitiationTime: Double = 0.0, marketDate: String = null, meteredValue: Boolean = false, minLoad: Double = 0.0, minLoadReduction: Double = 0.0, minLoadReductionCost: Double = 0.0, minLoadReductionInterval: Double = 0.0, minTimeBetLoadRed: Double = 0.0, pickUpRampRate: Double = 0.0, priceSetting: Boolean = false, reqNoticeTime: Double = 0.0, shutdownCost: Double = 0.0, AreaLoadBid: String = null, LoadReductionPriceCurve: List[String] = null, RampRateCurve: List[String] = null, RegisteredLoad: String = null) extends Element with Product with Serializable
Offer to supply energy/ancillary services from a load resource (participating load reduces consumption).
Offer to supply energy/ancillary services from a load resource (participating load reduces consumption).
- ResourceBid
ResourceBid Reference to the superclass object.
- dropRampRate
Maximum rate that load can be reduced (MW/minute)
- loadRedInitiationCost
load reduction initiation cost
- loadRedInitiationTime
load reduction initiation time
- marketDate
The date represents the NextMarketDate for which the load response bids apply to.
- meteredValue
Flag indicated that the load reduction is metered. (See above) If priceSetting and meteredValue both equal 1, then the facility is eligible to set LMP in the real time market.
- minLoad
Minimum MW load below which it may not be reduced.
- minLoadReduction
Minimum MW for a load reduction (e.g. MW rating of a discrete pump.
- minLoadReductionCost
Cost in $ at the minimum reduced load
- minLoadReductionInterval
Shortest period load reduction shall be maintained before load can be restored to normal levels.
- minTimeBetLoadRed
Shortest time that load shall be left at normal levels before a new load reduction.
- pickUpRampRate
Maximum rate load may be restored (MW/minute)
- priceSetting
Flag to indicate that the facility can set LMP Works in tandem with Metered Value. Greater chance of this being dynamic than the Metered Value, however, it is requested that Price Setting and Metered Value stay at the same source. Currently no customers have implemented the metering capability, but if this option is implemented, then Price Setting could become dynamic. However, Metered Value will remain static.
- reqNoticeTime
Time period that is required from an order to reduce a load to the time that it takes to get to the minimum load reduction.
- shutdownCost
The fixed cost associated with committing a load reduction.
- AreaLoadBid
AreaLoadBid undocumented
- LoadReductionPriceCurve
LoadReductionPriceCurve undocumented
- RampRateCurve
RampRateCurve undocumented
- RegisteredLoad
RegisteredLoad undocumented
-
final
case class
LoadBreakSwitch(ProtectedSwitch: ProtectedSwitch = null) extends Element with Product with Serializable
A mechanical switching device capable of making, carrying, and breaking currents under normal operating conditions.
A mechanical switching device capable of making, carrying, and breaking currents under normal operating conditions.
- ProtectedSwitch
ProtectedSwitch Reference to the superclass object.
-
final
case class
LoadComposite(LoadDynamics: LoadDynamics = null, epfd: Double = 0.0, epfs: Double = 0.0, epvd: Double = 0.0, epvs: Double = 0.0, eqfd: Double = 0.0, eqfs: Double = 0.0, eqvd: Double = 0.0, eqvs: Double = 0.0, h: Double = 0.0, lfac: Double = 0.0, pfrac: Double = 0.0) extends Element with Product with Serializable
Combined static load and induction motor load effects.
Combined static load and induction motor load effects.
The dynamics of the motor are simplified by linearizing the induction machine equations.
- LoadDynamics
LoadDynamics Reference to the superclass object.
- epfd
Active load-frequency dependence index (dynamic) (Epfd). Typical value = 1,5.
- epfs
Active load-frequency dependence index (static) (Epfs). Typical value = 1,5.
- epvd
Active load-voltage dependence index (dynamic) (Epvd). Typical value = 0,7.
- epvs
Active load-voltage dependence index (static) (Epvs). Typical value = 0,7.
- eqfd
Reactive load-frequency dependence index (dynamic) (Eqfd). Typical value = 0.
- eqfs
Reactive load-frequency dependence index (static) (Eqfs). Typical value = 0.
- eqvd
Reactive load-voltage dependence index (dynamic) (Eqvd). Typical value = 2.
- eqvs
Reactive load-voltage dependence index (static) (Eqvs). Typical value = 2.
- h
Inertia constant (H) (>= 0). Typical value = 2,5.
- lfac
Loading factor (Lfac). The ratio of initial P to motor MVA base. Typical value = 0,8.
- pfrac
Fraction of constant-power load to be represented by this motor model (PFRAC) (>= 0,0 and <= 1,0). Typical value = 0,5.
-
final
case class
LoadDistributionFactor(Element: BasicElement = null, pDistFactor: Double = 0.0, qDistFactor: Double = 0.0, AggregatedPnode: String = null, DistributionFactorSet: List[String] = null, IndividualPnode: String = null) extends Element with Product with Serializable
This class models the load distribution factors.
This class models the load distribution factors.
This class should be used in one of two ways:
Use it along with the AggregatedPnode and the IndividualPnode to show the distriubtion of each individual party
OR
Use it with Mkt_EnergyConsumer to represent the current MW/Mvar distribution within it's parnet load group.
- Element
Reference to the superclass object.
- pDistFactor
Real power (MW) load distribution factor
- qDistFactor
Reactive power (MVAr) load distribution factor
- AggregatedPnode
AggregatedPnode undocumented
- DistributionFactorSet
DistributionFactorSet undocumented
- IndividualPnode
IndividualPnode undocumented
-
final
case class
LoadDynamics(IdentifiedObject: IdentifiedObject = null, EnergyConsumer: List[String] = null) extends Element with Product with Serializable
Load whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font> A standard feature of dynamic load behaviour modelling is the ability to associate the same behaviour to multiple energy consumers by means of a single load definition.
Load whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font> A standard feature of dynamic load behaviour modelling is the ability to associate the same behaviour to multiple energy consumers by means of a single load definition.
The load model is always applied to individual bus loads (energy consumers).
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- EnergyConsumer
EnergyConsumer Energy consumer to which this dynamics load model applies.
-
final
case class
LoadFollowingInst(Element: BasicElement = null, endTime: String = null, loadFollowingMW: Double = 0.0, mssInstructionID: String = null, startTime: String = null, RegisteredResource: String = null) extends Element with Product with Serializable
Metered SubSystem Load Following Instruction.
Metered SubSystem Load Following Instruction.
- Element
Reference to the superclass object.
- endTime
Instruction End Time
- loadFollowingMW
Load Following MW Positive for follow-up and negative for follow-down
- mssInstructionID
Unique instruction id per instruction, assigned by the SC and provided to ADS. ADS passes through.
- startTime
Instruction Start Time
- RegisteredResource
RegisteredResource undocumented
-
final
case class
LoadFollowingOperatorInput(Element: BasicElement = null, dataEntryTimeStamp: String = null, tempLoadFollowingDownManualCap: Double = 0.0, tempLoadFollowingUpManualCap: Double = 0.0, updateTimeStamp: String = null, updateType: String = null, updateUser: String = null, RegisteredResource: String = null) extends Element with Product with Serializable
Model of load following capabilities that are entered by operators on a temporary basis.
Model of load following capabilities that are entered by operators on a temporary basis.
Related to Registered Resources in Metered Subsystems.
- Element
Reference to the superclass object.
- dataEntryTimeStamp
Time the data entry was performed
- tempLoadFollowingDownManualCap
temporarily manually entered LFD capacity
- tempLoadFollowingUpManualCap
temporarily manually entered LFU capacity.
- updateTimeStamp
undocumented
- updateType
undocumented
- updateUser
undocumented
- RegisteredResource
RegisteredResource undocumented
-
final
case class
LoadGenericNonLinear(LoadDynamics: LoadDynamics = null, bs: Double = 0.0, bt: Double = 0.0, genericNonLinearLoadModelType: String = null, ls: Double = 0.0, lt: Double = 0.0, tp: Double = 0.0, tq: Double = 0.0) extends Element with Product with Serializable
Generic non-linear dynamic (GNLD) load.
Generic non-linear dynamic (GNLD) load.
This model can be used in mid-term and long-term voltage stability simulations (i.e., to study voltage collapse), as it can replace a more detailed representation of aggregate load, including induction motors, thermostatically controlled and static loads.
- LoadDynamics
LoadDynamics Reference to the superclass object.
- bs
Steady state voltage index for reactive power (BS).
- bt
Transient voltage index for reactive power (BT).
- genericNonLinearLoadModelType
Type of generic non-linear load model.
- ls
Steady state voltage index for active power (LS).
- lt
Transient voltage index for active power (LT).
- tp
Time constant of lag function of active power (TP) (> 0).
- tq
Time constant of lag function of reactive power (TQ) (> 0).
-
final
case class
LoadGroup(IdentifiedObject: IdentifiedObject = null, SubLoadArea: String = null) extends Element with Product with Serializable
The class is the third level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling.
The class is the third level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- SubLoadArea
SubLoadArea The SubLoadArea where the Loadgroup belongs.
-
final
case class
LoadModelPartVersion(Element: BasicElement = null) extends Element with Product with Serializable
Load a model part version.
Load a model part version.
- Element
Reference to the superclass object.
-
final
case class
LoadMotor(IdentifiedObject: IdentifiedObject = null, d: Double = 0.0, h: Double = 0.0, lfac: Double = 0.0, lp: Double = 0.0, lpp: Double = 0.0, ls: Double = 0.0, pfrac: Double = 0.0, ra: Double = 0.0, tbkr: Double = 0.0, tpo: Double = 0.0, tppo: Double = 0.0, tv: Double = 0.0, vt: Double = 0.0, LoadAggregate: String = null) extends Element with Product with Serializable
Aggregate induction motor load.
Aggregate induction motor load.
This model is used to represent a fraction of an ordinary load as "induction motor load". It allows a load that is treated as an ordinary constant power in power flow analysis to be represented by an induction motor in dynamic simulation. This model is intended for representation of aggregations of many motors dispersed through a load represented at a high voltage bus but where there is no information on the characteristics of individual motors. Either a "one-cage" or "two-cage" model of the induction machine can be modelled. Magnetic saturation is not modelled. This model treats a fraction of the constant power part of a load as a motor. During initialisation, the initial power drawn by the motor is set equal to Pfrac times the constant P part of the static load. The remainder of the load is left as a static load. The reactive power demand of the motor is calculated during initialisation as a function of voltage at the load bus. This reactive power demand can be less than or greater than the constant Q component of the load. If the motor's reactive demand is greater than the constant Q component of the load, the model inserts a shunt capacitor at the terminal of the motor to bring its reactive demand down to equal the constant Q reactive load. If an induction motor load model and a static load model are both present for a load, the motor Pfrac is assumed to be subtracted from the power flow constant P load before the static load model is applied. The remainder of the load, if any, is then represented by the static load model.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- d
Damping factor (D). Unit = delta P/delta speed. Typical value = 2.
- h
Inertia constant (H) (>= 0). Typical value = 0,4.
- lfac
Loading factor (Lfac). The ratio of initial P to motor MVA base. Typical value = 0,8.
- lp
Transient reactance (Lp). Typical value = 0,15.
- lpp
Subtransient reactance (Lpp). Typical value = 0,15.
- ls
Synchronous reactance (Ls). Typical value = 3,2.
- pfrac
Fraction of constant-power load to be represented by this motor model (Pfrac) (>= 0,0 and <= 1,0). Typical value = 0,3.
- ra
Stator resistance (Ra). Typical value = 0.
- tbkr
Circuit breaker operating time (Tbkr) (>= 0). Typical value = 0,08.
- tpo
Transient rotor time constant (Tpo) (>= 0). Typical value = 1.
- tppo
Subtransient rotor time constant (Tppo) (>= 0). Typical value = 0,02.
- tv
Voltage trip pickup time (Tv) (>= 0). Typical value = 0,1.
- vt
Voltage threshold for tripping (Vt). Typical value = 0,7.
- LoadAggregate
LoadAggregate Aggregate load to which this aggregate motor (dynamic) load belongs.
-
final
case class
LoadRatio(Element: BasicElement = null, intervalEndTime: String = null, intervalStartTime: String = null, share: Double = 0.0, SchedulingCoordinator: String = null) extends Element with Product with Serializable
Representing the ratio of the load share for the associated SC.
Representing the ratio of the load share for the associated SC.
- Element
Reference to the superclass object.
- intervalEndTime
Interval End Time
- intervalStartTime
Interval Start Time
- share
Share in percentage of total Market load for the selected time interval.
- SchedulingCoordinator
SchedulingCoordinator undocumented
-
final
case class
LoadReductionPriceCurve(Curve: Curve = null, LoadBid: String = null) extends Element with Product with Serializable
This is the price sensitivity that bidder expresses for allowing market load interruption.
-
final
case class
LoadReductionTimeCurve(Curve: Curve = null, loadReductionTimeCurveType: String = null) extends Element with Product with Serializable
This is the cureve that describes the load reduction time.
This is the cureve that describes the load reduction time.
Relationship between time (Y1-axis) vs. MW (X-axis).
- Curve
Curve Reference to the superclass object.
- loadReductionTimeCurveType
type of the curve: Possible values are but not limited to: Max, Min,
-
final
case class
LoadResponseCharacteristic(IdentifiedObject: IdentifiedObject = null, exponentModel: Boolean = false, pConstantCurrent: Double = 0.0, pConstantImpedance: Double = 0.0, pConstantPower: Double = 0.0, pFrequencyExponent: Double = 0.0, pVoltageExponent: Double = 0.0, qConstantCurrent: Double = 0.0, qConstantImpedance: Double = 0.0, qConstantPower: Double = 0.0, qFrequencyExponent: Double = 0.0, qVoltageExponent: Double = 0.0, EnergyConsumer: List[String] = null) extends Element with Product with Serializable
Models the characteristic response of the load demand due to changes in system conditions such as voltage and frequency.
Models the characteristic response of the load demand due to changes in system conditions such as voltage and frequency.
It is not related to demand response. If LoadResponseCharacteristic.exponentModel is True, the exponential voltage or frequency dependent models are specified and used as to calculate active and reactive power components of the load model. The equations to calculate active and reactive power components of the load model are internal to the power flow calculation, hence they use different quantities depending on the use case of the data exchange. The equations for exponential voltage dependent load model injected power are: pInjection= Pnominal* (Voltage/cim:BaseVoltage.nominalVoltage) ** cim:LoadResponseCharacteristic.pVoltageExponent qInjection= Qnominal* (Voltage/cim:BaseVoltage.nominalVoltage) ** cim:LoadResponseCharacteristic.qVoltageExponent Where: 1) * means "multiply" and ** is "raised to power of"; 2) Pnominal and Qnominal represent the active power and reactive power at nominal voltage as any load described by the voltage exponential model shall be given at nominal voltage. This means that EnergyConsumer.p and EnergyConsumer.q are at nominal voltage. 3) After power flow is solved: -pInjection and qInjection correspond to SvPowerflow.p and SvPowerflow.q respectively. - Voltage corresponds to SvVoltage.v at the TopologicalNode where the load is connected.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- exponentModel
Indicates the exponential voltage dependency model is to be used. If false, the coefficient model is to be used. The exponential voltage dependency model consist of the attributes:
- pVoltageExponent
- qVoltageExponent
- pFrequencyExponent
- qFrequencyExponent. The coefficient model consist of the attributes:
- pConstantImpedance
- pConstantCurrent
- pConstantPower
- qConstantImpedance
- qConstantCurrent
- qConstantPower. The sum of pConstantImpedance, pConstantCurrent and pConstantPower shall equal 1. The sum of qConstantImpedance, qConstantCurrent and qConstantPower shall equal 1.
- pConstantCurrent
Portion of active power load modelled as constant current.
- pConstantImpedance
Portion of active power load modelled as constant impedance.
- pConstantPower
Portion of active power load modelled as constant power.
- pFrequencyExponent
Exponent of per unit frequency effecting active power.
- pVoltageExponent
Exponent of per unit voltage effecting real power.
- qConstantCurrent
Portion of reactive power load modelled as constant current.
- qConstantImpedance
Portion of reactive power load modelled as constant impedance.
- qConstantPower
Portion of reactive power load modelled as constant power.
- qFrequencyExponent
Exponent of per unit frequency effecting reactive power.
- qVoltageExponent
Exponent of per unit voltage effecting reactive power.
- EnergyConsumer
EnergyConsumer The set of loads that have the response characteristics.
-
final
case class
LoadStatic(IdentifiedObject: IdentifiedObject = null, ep1: Double = 0.0, ep2: Double = 0.0, ep3: Double = 0.0, eq1: Double = 0.0, eq2: Double = 0.0, eq3: Double = 0.0, kp1: Double = 0.0, kp2: Double = 0.0, kp3: Double = 0.0, kp4: Double = 0.0, kpf: Double = 0.0, kq1: Double = 0.0, kq2: Double = 0.0, kq3: Double = 0.0, kq4: Double = 0.0, kqf: Double = 0.0, staticLoadModelType: String = null, LoadAggregate: String = null) extends Element with Product with Serializable
General static load.
General static load.
This model represents the sensitivity of the real and reactive power consumed by the load to the amplitude and frequency of the bus voltage.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ep1
First term voltage exponent for active power (Ep1). Used only when .staticLoadModelType = exponential.
- ep2
Second term voltage exponent for active power (Ep2). Used only when .staticLoadModelType = exponential.
- ep3
Third term voltage exponent for active power (Ep3). Used only when .staticLoadModelType = exponential.
- eq1
First term voltage exponent for reactive power (Eq1). Used only when .staticLoadModelType = exponential.
- eq2
Second term voltage exponent for reactive power (Eq2). Used only when .staticLoadModelType = exponential.
- eq3
Third term voltage exponent for reactive power (Eq3). Used only when .staticLoadModelType = exponential.
- kp1
First term voltage coefficient for active power (Kp1). Not used when .staticLoadModelType = constantZ.
- kp2
Second term voltage coefficient for active power (Kp2). Not used when .staticLoadModelType = constantZ.
- kp3
Third term voltage coefficient for active power (Kp3). Not used when .staticLoadModelType = constantZ.
- kp4
Frequency coefficient for active power (Kp4) (not = 0 if .staticLoadModelType = zIP2). Used only when .staticLoadModelType = zIP2.
- kpf
Frequency deviation coefficient for active power (Kpf). Not used when .staticLoadModelType = constantZ.
- kq1
First term voltage coefficient for reactive power (Kq1). Not used when .staticLoadModelType = constantZ.
- kq2
Second term voltage coefficient for reactive power (Kq2). Not used when .staticLoadModelType = constantZ.
- kq3
Third term voltage coefficient for reactive power (Kq3). Not used when .staticLoadModelType = constantZ.
- kq4
Frequency coefficient for reactive power (Kq4) (not = 0 when .staticLoadModelType = zIP2). Used only when .staticLoadModelType - zIP2.
- kqf
Frequency deviation coefficient for reactive power (Kqf). Not used when .staticLoadModelType = constantZ.
- staticLoadModelType
Type of static load model. Typical value = constantZ.
- LoadAggregate
LoadAggregate Aggregate load to which this aggregate static load belongs.
-
final
case class
LoadUserDefined(LoadDynamics: LoadDynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Load whose dynamic behaviour is described by a user-defined model.
Load whose dynamic behaviour is described by a user-defined model.
- LoadDynamics
LoadDynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
LocalReliabilityArea(IdentifiedObject: IdentifiedObject = null, RTO: String = null, RegisteredGenerator: List[String] = null) extends Element with Product with Serializable
Allows definition of reliability areas (e.g..
Allows definition of reliability areas (e.g.. load pockets) within the ISO/RTO.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- RTO
RTO undocumented
- RegisteredGenerator
RegisteredGenerator undocumented
-
final
case class
Location(IdentifiedObject: IdentifiedObject = null, direction: String = null, electronicAddress: String = null, geoInfoReference: String = null, mainAddress: String = null, phone1: String = null, phone2: String = null, secondaryAddress: String = null, status: String = null, type: String = null, Assets: List[String] = null, ConfigurationEvents: List[String] = null, CoordinateSystem: String = null, Crew: List[String] = null, Crews: List[String] = null, EnvironmentalLocationKind: List[String] = null, EnvironmentalMonitoringStation: List[String] = null, Fault: List[String] = null, Hazards: List[String] = null, Incident: String = null, LandProperties: List[String] = null, Measurements: List[String] = null, OutageOrder: String = null, PositionPoints: List[String] = null, PowerSystemResources: List[String] = null, Routes: List[String] = null, SwitchingOrder: String = null, TroubleOrder: String = null) extends Element with Product with Serializable
The place, scene, or point of something where someone or something has been, is, and/or will be at a given moment in time.
The place, scene, or point of something where someone or something has been, is, and/or will be at a given moment in time.
It can be defined with one or more position points (coordinates) in a given coordinate system.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- direction
(if applicable) Direction that allows field crews to quickly find a given asset. For a given location, such as a street address, this is the relative direction in which to find the asset. For example, a streetlight may be located at the 'NW' (northwest) corner of the customer's site, or a usage point may be located on the second floor of an apartment building.
- electronicAddress
ElectronicAddress Electronic address.
- geoInfoReference
(if applicable) Reference to geographical information source, often external to the utility.
- mainAddress
StreetAddress Main address of the location.
- phone1
TelephoneNumber Phone number.
- phone2
TelephoneNumber Additional phone number.
- secondaryAddress
StreetAddress Secondary address of the location. For example, PO Box address may have different ZIP code than that in the 'mainAddress'.
- status
Status Status of this location.
- type
Classification by utility's corporate standards and practices, relative to the location itself (e.g., geographical, functional accounting, etc., not a given property that happens to exist at that location).
- Assets
Asset All assets at this location.
- ConfigurationEvents
ConfigurationEvent All configuration events created for this location.
- CoordinateSystem
CoordinateSystem Coordinate system used to describe position points of this location.
- Crew
Crew undocumented
- Crews
OldCrew undocumented
- EnvironmentalLocationKind
EnvironmentalLocationType Kind of environmental location which this location is.
- EnvironmentalMonitoringStation
EnvironmentalMonitoringStation Monitoring station located at this location.
- Fault
Fault undocumented
- Hazards
AssetLocationHazard All asset hazards at this location.
- Incident
Incident Incident at this location.
- LandProperties
LandProperty undocumented
- Measurements
Measurement undocumented
- OutageOrder
OutageOrder undocumented
- PositionPoints
PositionPoint Sequence of position points describing this location, expressed in coordinate system 'Location. CoordinateSystem'.
- PowerSystemResources
PowerSystemResource All power system resources at this location.
- Routes
Route undocumented
- SwitchingOrder
SwitchingOrder undocumented
- TroubleOrder
TroubleOrder undocumented
-
final
case class
LocationGrant(Agreement: Agreement = null, propertyData: String = null, LandProperty: String = null) extends Element with Product with Serializable
A grant provides a right, as defined by type, for a parcel of land.
A grant provides a right, as defined by type, for a parcel of land.
Note that the association to Location, Asset, Organisation, etc. for the Grant is inherited from Agreement, a type of Document.
- Agreement
Agreement Reference to the superclass object.
- propertyData
Property related information that describes the Grant's land parcel. For example, it may be a deed book number, deed book page number, and parcel number.
- LandProperty
LandProperty Land property this location grant applies to.
-
final
case class
LossClearing(MarketFactors: MarketFactors = null, LossClearingResults: List[String] = null) extends Element with Product with Serializable
RT only and is published on 5 minute intervals for the previous RT time interval results.
RT only and is published on 5 minute intervals for the previous RT time interval results.
- MarketFactors
MarketFactors Reference to the superclass object.
- LossClearingResults
LossClearingResults undocumented
-
final
case class
LossClearingResults(Element: BasicElement = null, lossMW: Double = 0.0, HostControlArea: String = null, LossClearing: String = null, RUCZone: String = null, SubControlArea: String = null) extends Element with Product with Serializable
Provides the MW loss for RUC Zones, subcontrol areas, and the total loss.
Provides the MW loss for RUC Zones, subcontrol areas, and the total loss.
- Element
Reference to the superclass object.
- lossMW
undocumented
- HostControlArea
HostControlArea undocumented
- LossClearing
LossClearing undocumented
- RUCZone
RUCZone undocumented
- SubControlArea
SubControlArea undocumented
-
final
case class
LossProfile(Profile: Profile = null, EnergyTransaction: String = null, HasLoss_1: String = null) extends Element with Product with Serializable
LossProfile is associated with an EnerrgyTransaction and must be completely contained within the time frame of the EnergyProfile associated with this EnergyTransaction.
LossProfile is associated with an EnerrgyTransaction and must be completely contained within the time frame of the EnergyProfile associated with this EnergyTransaction.
- Profile
Profile Reference to the superclass object.
- EnergyTransaction
EnergyTransaction An EnergyTransaction may have a LossProfile.
- HasLoss_1
TransmissionProvider Part of the LossProfile for an EnergyTransaction may be a loss for a TransmissionProvider. If so, the TransmissionProvider must be one of the participating entities in the EnergyTransaction.
-
final
case class
LossSensitivity(MarketFactors: MarketFactors = null, lossFactor: Double = 0.0, MktConnectivityNode: String = null) extends Element with Product with Serializable
Loss sensitivity applied to a ConnectivityNode for a given time interval.
Loss sensitivity applied to a ConnectivityNode for a given time interval.
- MarketFactors
MarketFactors Reference to the superclass object.
- lossFactor
Loss penalty factor. Defined as: 1 / ( 1 - Incremental Transmission Loss); with the Incremental Transmission Loss expressed as a plus or minus value. The typical range of penalty factors is (0,9 to 1,1).
- MktConnectivityNode
MktConnectivityNode undocumented
-
final
case class
MPMClearing(MarketFactors: MarketFactors = null, mitigationOccuredFlag: String = null, LMPMFinalFlag: String = null, MPMTestResults: List[String] = null, SMPMFinalFlag: String = null) extends Element with Product with Serializable
Model of results of Market Power tests, and possible mitigation.
Model of results of Market Power tests, and possible mitigation.
Interval based.
- MarketFactors
MarketFactors Reference to the superclass object.
- mitigationOccuredFlag
undocumented
- LMPMFinalFlag
undocumented
- MPMTestResults
MPMTestResults undocumented
- SMPMFinalFlag
undocumented
-
final
case class
MPMResourceStatus(Element: BasicElement = null, resourceStatus: String = null, MPMTestCategory: String = null, MitigatedBidClearing: List[String] = null, RegisteredResource: String = null) extends Element with Product with Serializable
Model of results of Market Power tests, gives status of resource for the associated interval.
Model of results of Market Power tests, gives status of resource for the associated interval.
- Element
Reference to the superclass object.
- resourceStatus
Interval Test Status 'N' - not applicable
- MPMTestCategory
MPMTestCategory undocumented
- MitigatedBidClearing
MitigatedBidClearing undocumented
- RegisteredResource
RegisteredResource undocumented
-
final
case class
MPMTestCategory(IdentifiedObject: IdentifiedObject = null, purposeFlag: String = null, testIdentifier: String = null, testMethod: String = null, MPMResourceStatus: List[String] = null, MPMTestResults: List[String] = null, MPMTestThreshold: List[String] = null) extends Element with Product with Serializable
Provides a reference to the Market Power Mitigation test identifiers and methods for the results of the DA or RT markets.
Provides a reference to the Market Power Mitigation test identifiers and methods for the results of the DA or RT markets.
Specific data is the test identifier (Price, Conduct, or Impact) and the test method (System MPM, Local MPM, Alternate System MPM, or Alternate Local MPM).
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- purposeFlag
Nature of threshold data: 'M' - Mitigation threshold 'R' - Reporting threshold
- testIdentifier
1 - Global Price Test 2 - Global Conduct Test 3 - Global Impact Test 4 - Local Price Test 5 - Local Conduct Test 6 - Local Impact Test
- testMethod
The method of performing the market power monitoring. Examples are Normal (default) thresholds or Alternate thresholds.
- MPMResourceStatus
MPMResourceStatus undocumented
- MPMTestResults
MPMTestResults undocumented
- MPMTestThreshold
MPMTestThreshold undocumented
-
final
case class
MPMTestResults(Element: BasicElement = null, marginPercent: Double = 0.0, outcome: String = null, AggregatedPnode: String = null, MPMClearing: String = null, MPMTestCategory: String = null) extends Element with Product with Serializable
Provides the outcome and margin percent (as appropriate) result data for the MPM tests.
Provides the outcome and margin percent (as appropriate) result data for the MPM tests.
There are relationships to Zone for Designated Congestion Area Tests, CurveSchedData for bid segment tests, to the SubControlArea for the system wide level tests, and Pnodes for the LMPM impact tests.
- Element
Reference to the superclass object.
- marginPercent
Used to show the Margin % result of the Impact test
- outcome
The results of the test. For the Price, Impact, and Conduct tests, typical values are NA, Pass, Fail, Disable, or Skip.
- AggregatedPnode
AggregatedPnode undocumented
- MPMClearing
MPMClearing undocumented
- MPMTestCategory
MPMTestCategory undocumented
-
final
case class
MPMTestThreshold(Element: BasicElement = null, marketType: String = null, percent: Double = 0.0, price: Double = 0.0, AggregatedPnode: List[String] = null, MPMTestCategory: String = null, RegisteredResource: List[String] = null) extends Element with Product with Serializable
Market Power Mitigation (MPM) test thresholds for resource as well as designated congestion areas (DCAs).
Market Power Mitigation (MPM) test thresholds for resource as well as designated congestion areas (DCAs).
- Element
Reference to the superclass object.
- marketType
Market Type (DAM, RTM)
- percent
Price Threshold in %
- price
Price Threshold in $/MW
- AggregatedPnode
AggregatedPnode undocumented
- MPMTestCategory
MPMTestCategory undocumented
- RegisteredResource
RegisteredResource undocumented
-
final
case class
MSSAggregation(IdentifiedObject: IdentifiedObject = null, costRecovery: String = null, grossSettlement: String = null, ignoreLosses: String = null, ignoreMarginalLosses: String = null, loadFollowing: String = null, rucProcurement: String = null, MeteredSubSystem: List[String] = null, RTO: String = null) extends Element with Product with Serializable
Metered Sub-System aggregation of MSS Zones.
Metered Sub-System aggregation of MSS Zones.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- costRecovery
Charge for Emission Costs, Start Up Costs, or Minimum Load Costs.
- grossSettlement
MSS Load Following may select Net vs. Gross settlement. Net Settlement requires the net Demand settled at the MSS LAP and Net Supply needs to settle at the equivalent to the weighted average price of the MSS generation. Gross load will be settled at the System LAP and the Gross supply will be settled at the LMP. MSS Aggregation that elects gross settlement shall have to identify if its resources are Load Following or not.
- ignoreLosses
Provides an indication if losses are to be ignored for this zone. Also refered to as Exclude Marginal Losses.
- ignoreMarginalLosses
Provides an indication if marginal losses are to be ignored for this zone.
- loadFollowing
Indication that this particular MSSA participates in the Load Following function.
- rucProcurement
Indicates that RUC will be procured by the ISO or self provided.
- MeteredSubSystem
MeteredSubSystem undocumented
- RTO
RTO undocumented
-
final
case class
MSSZone(AggregateNode: AggregateNode = null, ignoreLosses: String = null, lossFactor: Double = 0.0, rucGrossSettlement: String = null, MeteredSubSystem: String = null) extends Element with Product with Serializable
Model to define a zone within a Metered Sub System.
Model to define a zone within a Metered Sub System.
- AggregateNode
AggregateNode Reference to the superclass object.
- ignoreLosses
Provides an indication if losses are to be ignored for this metered subsystem zone.
- lossFactor
This is the default loss factor for the Metered Sub-System (MSS) zone. The actual losses are calculated during the RT market.
- rucGrossSettlement
Metered Sub-System (MSS) Load Following may select Net vs. Gross settlement. Net Settlement requires the net Demand settled at the Metered Sub-Sustem (MSS) Load Aggregation Point (LAP) and Net Supply needs to settle at the equivalent to the weighted average price of the MSS generation. Gross load will be settled at the System LAP and the Gross supply will be settled at the LMP. MSS Aggregation that elects gross settlement shall have to identify if its resources are Load Following or not.
- MeteredSubSystem
MeteredSubSystem undocumented
-
final
case class
MWLimitSchedule(Element: BasicElement = null, SecurityConstraintLimit: String = null) extends Element with Product with Serializable
Maximum MW and optionally Minimum MW (Y1 and Y2, respectively).
Maximum MW and optionally Minimum MW (Y1 and Y2, respectively).
- Element
Reference to the superclass object.
- SecurityConstraintLimit
ContingencyConstraintLimit undocumented
-
final
case class
MagneticStorm(SpacePhenomenon: SpacePhenomenon = null, changeDst: Double = 0.0) extends Element with Product with Serializable
A magnetic storm, a temporary disturbance of the earth's magnetic field, induced by radiation and streams of charged particles from the sun.
A magnetic storm, a temporary disturbance of the earth's magnetic field, induced by radiation and streams of charged particles from the sun.
- SpacePhenomenon
SpacePhenomenon Reference to the superclass object.
- changeDst
Change in the disturbance - storm time (Dst) index. The size of a geomagnetic storm is classified as:
- moderate ( -50 nT >minimum of Dst > -100 nT)
- intense (-100 nT > minimum Dst > -250 nT) or
- super-storm ( minimum of Dst < -250 nT).
-
final
case class
Maintainer(AssetOrganisationRole: AssetOrganisationRole = null) extends Element with Product with Serializable
Organisation that maintains assets.
Organisation that maintains assets.
- AssetOrganisationRole
AssetOrganisationRole Reference to the superclass object.
-
final
case class
MaintenanceDataSet(ProcedureDataSet: ProcedureDataSet = null, conditionAfter: String = null, conditionBefore: String = null, maintCode: String = null) extends Element with Product with Serializable
The result of a maintenance activity, a type of Procedure, for a given attribute of an asset.
The result of a maintenance activity, a type of Procedure, for a given attribute of an asset.
- ProcedureDataSet
ProcedureDataSet Reference to the superclass object.
- conditionAfter
Condition of asset just following maintenance procedure.
- conditionBefore
Description of the condition of the asset just prior to maintenance being performed.
- maintCode
Code for the type of maintenance performed.
-
final
case class
MaintenanceLocation(WorkLocation: WorkLocation = null, block: String = null, lot: String = null, nearestIntersection: String = null, subdivision: String = null) extends Element with Product with Serializable
Location where to perform maintenance work.
Location where to perform maintenance work.
- WorkLocation
WorkLocation Reference to the superclass object.
- block
(if applicable) Name, identifier, or description of the block in which work is to occur.
- lot
(if applicable) Name, identifier, or description of the lot in which work is to occur.
- nearestIntersection
The names of streets at the nearest intersection to work area.
- subdivision
(if applicable) Name, identifier, or description of the subdivision in which work is to occur.
-
final
case class
MaintenanceWorkTask(WorkTask: WorkTask = null, breakerMaintenanceKind: String = null, transformerMaintenanceKind: String = null) extends Element with Product with Serializable
Maintenance work task.
Maintenance work task.
Costs associated with this are considered preventive maintenance (PM) costs.
- WorkTask
WorkTask Reference to the superclass object.
- breakerMaintenanceKind
Kind of breaker maintenance performed by this maintenance work task.
- transformerMaintenanceKind
Kind of transformer maintenance performed by this maintenance work task.
-
final
case class
MajorChargeGroup(IdentifiedObject: IdentifiedObject = null, effectiveDate: String = null, frequencyType: String = null, invoiceType: String = null, requireAutorun: String = null, revisionNumber: String = null, runType: String = null, runVersion: String = null, terminationDate: String = null, ChargeType: List[String] = null, MarketInvoice: List[String] = null, MktScheduledEvent: List[String] = null, Settlement: List[String] = null) extends Element with Product with Serializable
A Major Charge Group is the same as Invoice Type which provides the highest level of grouping for charge types configuration.
A Major Charge Group is the same as Invoice Type which provides the highest level of grouping for charge types configuration.
Examples: Market, FERC, RMR.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- effectiveDate
undocumented
- frequencyType
undocumented
- invoiceType
undocumented
- requireAutorun
undocumented
- revisionNumber
Revision number for the major charge group
- runType
undocumented
- runVersion
undocumented
- terminationDate
undocumented
- ChargeType
ChargeType A MajorChargeGroup can have 0-n ChargeType. A ChargeType can associate to 0-n MajorChargeGroup.
- MarketInvoice
MarketInvoice undocumented
- MktScheduledEvent
MarketScheduledEvent undocumented
- Settlement
Settlement undocumented
-
final
case class
Manufacturer(OrganisationRole: OrganisationRole = null, ProductAssetModels: List[String] = null) extends Element with Product with Serializable
Organisation that manufactures asset products.
Organisation that manufactures asset products.
- OrganisationRole
OrganisationRole Reference to the superclass object.
- ProductAssetModels
ProductAssetModel All asset models by this manufacturer.
-
final
case class
Market(IdentifiedObject: IdentifiedObject = null, actualEnd: String = null, actualStart: String = null, dst: Boolean = false, end: String = null, localTimeZone: String = null, start: String = null, status: String = null, timeIntervalLength: Double = 0.0, tradingDay: String = null, tradingPeriod: String = null, MarketFactors: List[String] = null, MarketProducts: List[String] = null, MarketRun: List[String] = null) extends Element with Product with Serializable
Market (e.g.
Market (e.g.
Day Ahead Market, Real Time Market) with a description of the Market operation control parameters.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- actualEnd
Market ending time - actual market end
- actualStart
Market starting time - actual market start
- dst
True if daylight savings time (DST) is in effect.
- end
Market end time.
- localTimeZone
Local time zone.
- start
Market start time.
- status
Market Status 'OPEN', 'CLOSED', 'CLEARED', 'BLOCKED'
- timeIntervalLength
Trading time interval length.
- tradingDay
Market trading date
- tradingPeriod
Trading period that describes the market, possibilities could be for an Energy Market: Day Hour For a CRR Market: Year Month Season
- MarketFactors
MarketFactors undocumented
- MarketProducts
MarketProduct undocumented
- MarketRun
MarketRun undocumented
-
final
case class
MarketActualEvent(IdentifiedObject: IdentifiedObject = null, eventComments: String = null, eventEndTime: String = null, eventStartTime: String = null, eventStatus: String = null, eventType: String = null, MarketRun: String = null, PlannedMarketEvent: String = null) extends Element with Product with Serializable
This class represents the actual instance of an event.
This class represents the actual instance of an event.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- eventComments
Free format comments for the event, for any purpose needed.
- eventEndTime
End time of the event.
- eventStartTime
Start time of the event.
- eventStatus
Event status, e.g. active, canceled, expired, etc.
- eventType
Actual event type.
- MarketRun
MarketRun Market run triggered by this actual event. For example, the DA market run is triggered by the actual open bid submission event and terminated by the actual execution and completion of the DA market run captured by the runState of the MarketRun.
- PlannedMarketEvent
PlannedMarketEvent Planned event executed by this actual event.
-
final
case class
MarketAgreement(MarketDocument: MarketDocument = null) extends Element with Product with Serializable
An identification or eventually the contents of an agreement between two or more parties.
An identification or eventually the contents of an agreement between two or more parties.
- MarketDocument
MarketDocument Reference to the superclass object.
-
final
case class
MarketCaseClearing(MarketFactors: MarketFactors = null, caseType: String = null, modifiedDate: String = null, postedDate: String = null, MarketProductClearing: List[String] = null) extends Element with Product with Serializable
Market case clearing results are posted for a given settlement period.
Market case clearing results are posted for a given settlement period.
- MarketFactors
MarketFactors Reference to the superclass object.
- caseType
Settlement period: 'DA - Bid-in' 'DA - Reliability' 'DA - Amp1' 'DA - Amp2' 'RT - Ex-Ante' 'RT - Ex-Post' 'RT - Amp1' 'RT - Amp2'
- modifiedDate
Last time and date clearing results were manually modified.
- postedDate
Bid clearing results posted time and date.
- MarketProductClearing
AncillaryServiceClearing undocumented
-
final
case class
MarketDocument(Document: Document = null, AceTariffType: List[String] = null, AttributeInstanceComponent: List[String] = null, DateAndOrTime: List[String] = null, Domain: List[String] = null, MarketDocument_attr: List[String] = null, MarketParticipant: List[String] = null, Period: List[String] = null, Process: List[String] = null, Reason: List[String] = null, SelfMarketDocument: List[String] = null, TimeSeries: List[String] = null) extends Element with Product with Serializable
Electronic document containing the information necessary to satisfy a given business process set of requirements.
Electronic document containing the information necessary to satisfy a given business process set of requirements.
- Document
Document Reference to the superclass object.
- AceTariffType
AceTariffType undocumented
- AttributeInstanceComponent
AttributeInstanceComponent undocumented
- DateAndOrTime
DateAndOrTime undocumented
- Domain
Domain undocumented
- MarketDocument_attr
MarketDocument undocumented
- MarketParticipant
MarketParticipant undocumented
- Period
Period undocumented
- Process
Process undocumented
- Reason
Reason undocumented
- SelfMarketDocument
MarketDocument undocumented
- TimeSeries
TimeSeries undocumented
-
final
case class
MarketEvaluationPoint(UsagePoint: UsagePoint = null, TimeSeries: List[String] = null) extends Element with Product with Serializable
The identification of an entity where energy products are measured or computed.
The identification of an entity where energy products are measured or computed.
- UsagePoint
UsagePoint Reference to the superclass object.
- TimeSeries
TimeSeries undocumented
-
final
case class
MarketFactors(Document: Document = null, intervalEndTime: String = null, intervalStartTime: String = null, Market: String = null, MktActivityRecord: List[String] = null) extends Element with Product with Serializable
Aggregation of market information relative for a specific time interval.
Aggregation of market information relative for a specific time interval.
- Document
Document Reference to the superclass object.
- intervalEndTime
The end of the time interval for which requirement is defined.
- intervalStartTime
The start of the time interval for which requirement is defined.
- Market
Market undocumented
- MktActivityRecord
MktActivityRecord undocumented
-
final
case class
MarketInvoice(Element: BasicElement = null, amount: Double = 0.0, billMediaKind: String = null, dueDate: String = null, kind: String = null, mailedDate: String = null, proForma: Boolean = false, referenceNumber: String = null, transactionDateTime: String = null, transferType: String = null, MajorChargeGroup: List[String] = null, MarketInvoiceLineItems: List[String] = null) extends Element with Product with Serializable
A roll up of invoice line items.
A roll up of invoice line items.
The whole invoice has a due date and amount to be paid, with information such as customer, banks etc. being obtained through associations. The invoice roll up is based on individual line items that each contain amounts and descriptions for specific services or products.
- Element
Reference to the superclass object.
- amount
Total amount due on this invoice based on line items and applicable adjustments.
- billMediaKind
Kind of media by which the CustomerBillingInfo was delivered.
- dueDate
Calculated date upon which the Invoice amount is due.
- kind
Kind of invoice (default is 'sales').
- mailedDate
Date on which the customer billing statement/invoice was printed/mailed.
- proForma
True if payment is to be paid by a Customer to accept a particular ErpQuote (with associated Design) and have work initiated, at which time an associated ErpInvoice should automatically be generated. EprPayment.subjectStatus satisfies terms specificed in the ErpQuote.
- referenceNumber
Number of an invoice to be reference by this invoice.
- transactionDateTime
Date and time when the invoice is issued.
- transferType
Type of invoice transfer.
- MajorChargeGroup
MajorChargeGroup undocumented
- MarketInvoiceLineItems
MarketInvoiceLineItem undocumented
-
final
case class
MarketInvoiceLineItem(Element: BasicElement = null, billPeriod: String = null, glAccount: String = null, glDateTime: String = null, kind: String = null, lineAmount: Double = 0.0, lineNumber: String = null, lineVersion: String = null, netAmount: Double = 0.0, previousAmount: Double = 0.0, ComponentMarketInvoiceLineItems: List[String] = null, ContainerMarketInvoiceLineItem: String = null, MarketInvoice: String = null, Settlement: List[String] = null) extends Element with Product with Serializable
An individual line item on an invoice.
An individual line item on an invoice.
- Element
Reference to the superclass object.
- billPeriod
Bill period for the line item.
- glAccount
General Ledger account code, shall be a valid combination.
- glDateTime
Date and time line item will be posted to the General Ledger.
- kind
Kind of line item.
- lineAmount
Amount due for this line item.
- lineNumber
Line item number on invoice statement.
- lineVersion
Version number of the bill run.
- netAmount
Net line item charge amount.
- previousAmount
Previous line item charge amount.
- ComponentMarketInvoiceLineItems
MarketInvoiceLineItem undocumented
- ContainerMarketInvoiceLineItem
MarketInvoiceLineItem undocumented
- MarketInvoice
MarketInvoice undocumented
- Settlement
Settlement undocumented
-
final
case class
MarketLedger(Element: BasicElement = null, MarketLedgerEntries: List[String] = null) extends Element with Product with Serializable
In accounting transactions, a ledger is a book containing accounts to which debits and credits are posted from journals, where transactions are initially recorded.
In accounting transactions, a ledger is a book containing accounts to which debits and credits are posted from journals, where transactions are initially recorded.
Journal entries are periodically posted to the ledger. Ledger actual represents actual amounts by account within ledger within company or within business area. Actual amounts may be generated in a source application and then loaded to a specific ledger within the enterprise general ledger or budget application.
- Element
Reference to the superclass object.
- MarketLedgerEntries
MarketLedgerEntry undocumented
-
final
case class
MarketLedgerEntry(Element: BasicElement = null, accountID: String = null, accountKind: String = null, amount: Double = 0.0, postedDateTime: String = null, status: String = null, transactionDateTime: String = null, MarketLedger: String = null, Settlement: List[String] = null) extends Element with Product with Serializable
Details of an individual entry in a ledger, which was posted from a journal on the posted date.
Details of an individual entry in a ledger, which was posted from a journal on the posted date.
- Element
Reference to the superclass object.
- accountID
Account identifier for this entry.
- accountKind
Kind of account for this entry.
- amount
The amount of the debit or credit for this account.
- postedDateTime
Date and time this entry was posted to the ledger.
- status
Status of ledger entry.
- transactionDateTime
Date and time journal entry was recorded.
- MarketLedger
MarketLedger undocumented
- Settlement
Settlement undocumented
-
final
case class
MarketObjectStatus(Element: BasicElement = null, status: String = null, RegisteredResource: List[String] = null, TimeSeries: List[String] = null) extends Element with Product with Serializable
The condition or position of an object with regard to its standing.
The condition or position of an object with regard to its standing.
- Element
Reference to the superclass object.
- status
The coded condition or position of an object with regard to its standing.
- RegisteredResource
RegisteredResource undocumented
- TimeSeries
TimeSeries undocumented
-
final
case class
MarketParticipant(Organisation: Organisation = null, Bid: List[String] = null, MarketDocument: List[String] = null, MarketPerson: List[String] = null, MarketRole: List[String] = null, RegisteredResource: List[String] = null, SchedulingCoordinator: List[String] = null, TimeSeries: List[String] = null) extends Element with Product with Serializable
An identification of a party acting in a electricity market business process.
An identification of a party acting in a electricity market business process.
This class is used to identify organizations that can participate in market management and/or market operations.
- Organisation
Organisation Reference to the superclass object.
- Bid
Bid undocumented
- MarketDocument
MarketDocument undocumented
- MarketPerson
MarketPerson undocumented
- MarketRole
MarketRole undocumented
- RegisteredResource
RegisteredResource undocumented
- SchedulingCoordinator
SchedulingCoordinator undocumented
- TimeSeries
TimeSeries undocumented
-
final
case class
MarketPerson(IdentifiedObject: IdentifiedObject = null, category: String = null, electronicAddressAlternate: String = null, electronicAddressPrimary: String = null, firstName: String = null, governmentID: String = null, landlinePhone: String = null, lastName: String = null, mName: String = null, mobilePhone: String = null, prefix: String = null, specialNeed: String = null, status: String = null, suffix: String = null, userID: String = null, MarketParticipant: List[String] = null, MarketSkills: List[String] = null) extends Element with Product with Serializable
General purpose information for name and other information to contact people.
General purpose information for name and other information to contact people.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- category
Category of this person relative to utility operations, classified according to the utility's corporate standards and practices. Examples include employee, contractor, agent, not affiliated, etc. This field is not used to indicate whether this person is a customer of the utility. Often an employee or contractor is also a customer. Customer information is gained with relationship to Organisation and CustomerData. In similar fashion, this field does not indicate the various roles this person may fill as part of utility operations.
- electronicAddressAlternate
Alternate Electronic address.
- electronicAddressPrimary
Primary Electronic address.
- firstName
Person's first name.
- governmentID
Unique identifier for person relative to its governing authority, for example a federal tax identifier (such as a Social Security number in the United States).
- landlinePhone
Landline phone number.
- lastName
Person's last (family, sir) name.
- mName
Middle name(s) or initial(s).
- mobilePhone
Mobile phone number.
- prefix
A prefix or title for the person's name, such as Miss, Mister, Doctor, etc.
- specialNeed
Special service needs for the person (contact) are described; examples include life support, etc.
- status
undocumented
- suffix
A suffix for the person's name, such as II, III, etc.
- userID
The user name for the person; required to log in.
- MarketParticipant
MarketParticipant undocumented
- MarketSkills
MarketSkill undocumented
-
final
case class
MarketPlan(IdentifiedObject: IdentifiedObject = null, tradingDay: String = null, PlannedMarket: List[String] = null) extends Element with Product with Serializable
This class identifies a set of planned markets.
This class identifies a set of planned markets.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- tradingDay
Planned market trading day.
- PlannedMarket
PlannedMarket A market plan has a number of markets (DA, HA, RT).
-
final
case class
MarketProduct(IdentifiedObject: IdentifiedObject = null, marketProductType: String = null, rampInterval: Double = 0.0, BidError: List[String] = null, BidPriceCap: List[String] = null, CommodityDefinition: List[String] = null, Market: String = null, MarketRegionResults: String = null, ProductBids: List[String] = null, ReserveReqs: List[String] = null, ResourceAwardInstruction: List[String] = null) extends Element with Product with Serializable
A product traded by an RTO (e.g.
A product traded by an RTO (e.g. energy, 10 minute spinning reserve).
Ancillary service product examples include: Regulation, Regulation Up, Regulation Down, Spinning Reserve, Non-Spinning Reserve, etc.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- marketProductType
Market product type examples: EN (Energy) RU (Regulation Up) RD (Regulation Dn) SR (Spinning Reserve) NR (Non-Spinning Reserve) RC (RUC)
- rampInterval
Ramping time interval for the specific market product type specified by marketProductType attribute. For example, if marketProductType = EN (from enumeration MarketProductType), then the rampInterval is the ramping time interval for Energy.
- BidError
BidError undocumented
- BidPriceCap
BidPriceCap undocumented
- CommodityDefinition
CommodityDefinition undocumented
- Market
Market undocumented
- MarketRegionResults
MarketRegionResults undocumented
- ProductBids
ProductBid undocumented
- ReserveReqs
ReserveReq Market product associated with reserve requirement must be a reserve or regulation product.
- ResourceAwardInstruction
ResourceAwardInstruction undocumented
-
final
case class
MarketQualificationRequirement(IdentifiedObject: IdentifiedObject = null, effectiveDate: String = null, expirationDate: String = null, qualificationID: String = null, status: Int = 0, statusType: String = null, MarketSkills: List[String] = null) extends Element with Product with Serializable
Certain skills are required and shall be certified in order for a person (typically a member of a crew) to be qualified to work on types of equipment.
Certain skills are required and shall be certified in order for a person (typically a member of a crew) to be qualified to work on types of equipment.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- effectiveDate
Effective date of the privilege, terminate date of the privilege, or effective date of the application for the organization
- expirationDate
This is the terminate date of the application for the organization The specific organization can no longer access the application as of the terminate date
- qualificationID
Qualification identifier.
- status
The status of the privilege. Shows the status of the user´s qualification. The current statuses are: 1=New, 2=Active, 3=Refused, 4=Terminated, 5=Withdrawn and it is subject to update.
- statusType
This is the name of the status of the qualification and is used to display the status of the user's or organization's status.
- MarketSkills
MarketSkill undocumented
-
final
case class
MarketRegion(AggregateNode: AggregateNode = null, ExPostMarketRegionResults: List[String] = null, MarketRegionResults: List[String] = null, ReserveDemandCurve: List[String] = null) extends Element with Product with Serializable
A specialized class of AggregatedNode type.
A specialized class of AggregatedNode type.
Defines the MarketRegions. Regions could be system Market Regions, Energy Regions or Ancillary Service Regions.
- AggregateNode
AggregateNode Reference to the superclass object.
- ExPostMarketRegionResults
ExPostMarketRegionResults undocumented
- MarketRegionResults
MarketRegionResults undocumented
- ReserveDemandCurve
ReserveDemandCurve undocumented
-
final
case class
MarketRegionResults(Element: BasicElement = null, clearedMW: Double = 0.0, clearedPrice: Double = 0.0, dispatchCtMW: Double = 0.0, dispatchHydroMW: Double = 0.0, dispatchRate: Double = 0.0, dispatchSteamMW: Double = 0.0, imbalanceEnergyBias: Double = 0.0, limitFlag: String = null, lumpyIndicator: String = null, maxSufficiencyIndex: Double = 0.0, minSufficiencyIndex: Double = 0.0, reqMaxMW: Double = 0.0, reqMinMW: Double = 0.0, selfScheduleMW: Double = 0.0, AncillaryServiceClearing: String = null, MarketProduct: String = null, MarketRegion: String = null) extends Element with Product with Serializable
Provides all Region Ancillary Service results for the DA and RT markets.
Provides all Region Ancillary Service results for the DA and RT markets.
The specific data is commodity type (Regulation Up, Regulation Down, Spinning Reserve, Non-spinning Reserve, or Total Up reserves) based for the cleared MW, cleared price, and total capacity required for the region.
- Element
Reference to the superclass object.
- clearedMW
Cleared generation Value in MW. For AS, this value is clearedMW = AS Total. For AS, clearedMW - selfScheduleMW = AS Procured
- clearedPrice
Marginal Price ($/MW) for the commodity (Energy, Regulation Up, Regulation Down, Spinning Reserve, or Non-spinning reserve) based on the pricing run.
- dispatchCtMW
Dispatchable MW for Combustion units.
- dispatchHydroMW
Dispatchable MW for Hydro units.
- dispatchRate
Dispatch rate in MW/minutes.
- dispatchSteamMW
Dispatchable MW for Steam units.
- imbalanceEnergyBias
Imbalance Energy Bias (MW) by Time Period (5' only)
- limitFlag
Locational AS Flags indicating whether the Upper or Lower Bound limit of the AS regional procurment is binding
- lumpyIndicator
The "Lumpy Flag"(Y/N) indicates whether the resource that sets the price is a lumpy generator by hour over the time horizon. Only applicable for the Day Ahead Market
- maxSufficiencyIndex
Region requirement maximum limit
- minSufficiencyIndex
Region requirement minimum limit
- reqMaxMW
Region requirement maximum limit
- reqMinMW
Region requirement minimum limit
- selfScheduleMW
Aof AS, selfScheduleMW = AS Self-Provided
- AncillaryServiceClearing
AncillaryServiceClearing undocumented
- MarketProduct
MarketProduct undocumented
- MarketRegion
MarketRegion undocumented
-
final
case class
MarketResults(Element: BasicElement = null, ancillarySvcCost: Double = 0.0, contingentOperatingResAvail: String = null, energyCost: Double = 0.0, minimumLoadCost: Double = 0.0, startUpCost: Double = 0.0, totalCost: Double = 0.0, totalRucCost: Double = 0.0, EnergyMarket: String = null) extends Element with Product with Serializable
This class holds elements that are single values for the entire market time horizon.
This class holds elements that are single values for the entire market time horizon.
That is, for the Day Ahead market, there is 1 value for each element, not hourly based. Is a summary of the market run.
- Element
Reference to the superclass object.
- ancillarySvcCost
Total AS Cost (i.e., payment) ($) over the time horizon
- contingentOperatingResAvail
Global Contingent Operating Reserve Availability Indicator (Yes/No)
- energyCost
Total Energy Cost ($) over the time horizon
- minimumLoadCost
Total Minimum Load Cost ($) over the time horizon
- startUpCost
Total Start-up Cost ($) over the time horizon
- totalCost
Total Cost (Energy + AS) cost ($) by over the time horizon
- totalRucCost
The total RUC capacity cost for this interval
- EnergyMarket
EnergyMarket undocumented
-
final
case class
MarketRole(OrganisationRole: OrganisationRole = null, type: String = null, MarketParticipant: List[String] = null) extends Element with Product with Serializable
The external intended behavior played by a party within the electricity market.
The external intended behavior played by a party within the electricity market.
- OrganisationRole
OrganisationRole Reference to the superclass object.
- type
The kind of market roles that can be played by parties for given domains within the electricity market. Types are flexible using dataType of string for free-entry of role types.
- MarketParticipant
MarketParticipant undocumented
-
final
case class
MarketRun(IdentifiedObject: IdentifiedObject = null, executionType: String = null, marketApprovalTime: String = null, marketApprovedStatus: Boolean = false, marketEndTime: String = null, marketStartTime: String = null, marketType: String = null, reportedState: String = null, runState: String = null, Market: String = null, MarketActualEvent: List[String] = null, PlannedMarket: String = null) extends Element with Product with Serializable
This class represents an actual instance of a planned market.
This class represents an actual instance of a planned market.
For example, a Day Ahead market opens with the Bid Submission, ends with the closing of the Bid Submission. The market run represent the whole process. MarketRuns can be defined for markets such as Day Ahead Market, Real Time Market, Hour Ahead Market, Week Ahead Market, etc.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- executionType
The execution type; Day Ahead, Intra Day, Real Time Pre-Dispatch, Real Time Dispatch
- marketApprovalTime
Approved time for case. Identifies the time that the dispatcher approved a specific real time unit dispatch case
- marketApprovedStatus
Set to true when the plan is approved by authority and becomes the official plan for the day ahead market. Identifies the approved case for the market for the specified time interval.
- marketEndTime
The end time defined as the end of the market, market end time.
- marketStartTime
The start time defined as the beginning of the market, market start time.
- marketType
The market type, Day Ahead Market or Real Time Market.
- reportedState
This is the state of market run activity as reported by market systems to the market definition services.
- runState
This is the state controlled by market defintion service. Possible values could be but not limited by: Open, Close.
- Market
Market undocumented
- MarketActualEvent
MarketActualEvent All actual events that trigger this market run.
- PlannedMarket
PlannedMarket A planned market could have multiple market runs for the reason that a planned market could have a rerun.
-
final
case class
MarketScheduledEvent(IdentifiedObject: IdentifiedObject = null, category: String = null, duration: Double = 0.0, status: String = null, MajorChargeGroup: String = null) extends Element with Product with Serializable
Signifies an event to trigger one or more activities, such as reading a meter, recalculating a bill, requesting work, when generating units shall be scheduled for maintenance, when a transformer is scheduled to be refurbished, etc.
Signifies an event to trigger one or more activities, such as reading a meter, recalculating a bill, requesting work, when generating units shall be scheduled for maintenance, when a transformer is scheduled to be refurbished, etc.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- category
Category of scheduled event.
- duration
Duration of the scheduled event, for example, the time to ramp between values.
- status
undocumented
- MajorChargeGroup
MajorChargeGroup undocumented
-
final
case class
MarketSkill(Document: Document = null, certificationPeriod: String = null, effectiveDateTime: String = null, level: String = null, MarketPerson: String = null, MarketQualificationRequirements: List[String] = null) extends Element with Product with Serializable
Proficiency level of a craft, which is required to operate or maintain a particular type of asset and/or perform certain types of work.
Proficiency level of a craft, which is required to operate or maintain a particular type of asset and/or perform certain types of work.
- Document
Document Reference to the superclass object.
- certificationPeriod
Interval between the certification and its expiry.
- effectiveDateTime
Date and time the skill became effective.
- level
Level of skill for a Craft.
- MarketPerson
MarketPerson undocumented
- MarketQualificationRequirements
MarketQualificationRequirement undocumented
-
final
case class
MarketStatement(Document: Document = null, end: String = null, referenceNumber: String = null, start: String = null, tradeDate: String = null, transactionDate: String = null, MarketStatementLineItem: List[String] = null) extends Element with Product with Serializable
A statement is a roll up of statement line items.
A statement is a roll up of statement line items.
Each statement along with its line items provide the details of specific charges at any given time. Used by Billing and Settlement.
- Document
Document Reference to the superclass object.
- end
The end of a bill period.
- referenceNumber
The version number of previous statement (in the case of true up).
- start
The start of a bill period.
- tradeDate
The date of which Settlement is run.
- transactionDate
The date of which this statement is issued.
- MarketStatementLineItem
MarketStatementLineItem undocumented
-
final
case class
MarketStatementLineItem(IdentifiedObject: IdentifiedObject = null, currentAmount: Double = 0.0, currentISOAmount: Double = 0.0, currentISOQuantity: Double = 0.0, currentPrice: Double = 0.0, currentQuantity: Double = 0.0, intervalDate: String = null, intervalNumber: String = null, netAmount: Double = 0.0, netISOAmount: Double = 0.0, netISOQuantity: Double = 0.0, netPrice: Double = 0.0, netQuantity: Double = 0.0, previousAmount: Double = 0.0, previousISOAmount: Double = 0.0, previousISOQuantity: Double = 0.0, previousPrice: Double = 0.0, previousQuantity: Double = 0.0, quantityUOM: String = null, ComponentMarketStatementLineItem: List[String] = null, ContainerMarketStatementLineItem: String = null, MarketStatement: String = null, MktUserAttribute: List[String] = null, PassThroughBill: String = null) extends Element with Product with Serializable
An individual line item on an ISO settlement statement.
An individual line item on an ISO settlement statement.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- currentAmount
Current settlement amount.
- currentISOAmount
Current ISO settlement amount.
- currentISOQuantity
Current ISO settlement quantity.
- currentPrice
Current settlement price.
- currentQuantity
Current settlement quantity, subject to the UOM.
- intervalDate
The date of which the settlement is run.
- intervalNumber
The number of intervals.
- netAmount
Net settlement amount.
- netISOAmount
Net ISO settlement amount.
- netISOQuantity
Net ISO settlement quantity.
- netPrice
Net settlement price.
- netQuantity
Net settlement quantity, subject to the UOM.
- previousAmount
Previous settlement amount.
- previousISOAmount
Previous ISO settlement amount.
- previousISOQuantity
Previous ISO settlement quantity.
- previousPrice
Previous settlement price.
- previousQuantity
Previous settlement quantity, subject to the UOM.
- quantityUOM
The unit of measure for the quantity element of the line item.
- ComponentMarketStatementLineItem
MarketStatementLineItem undocumented
- ContainerMarketStatementLineItem
MarketStatementLineItem undocumented
- MarketStatement
MarketStatement undocumented
- MktUserAttribute
MktUserAttribute undocumented
- PassThroughBill
PassThroughBill undocumented
-
final
case class
Marketer(Organisation: Organisation = null, HoldsTitleTo_EnergyProducts: List[String] = null, Resells_EnergyProduct: List[String] = null) extends Element with Product with Serializable
Matches buyers and sellers, and secures transmission (and other ancillary services) needed to complete the energy transaction.
Matches buyers and sellers, and secures transmission (and other ancillary services) needed to complete the energy transaction.
- Organisation
Organisation Reference to the superclass object.
- HoldsTitleTo_EnergyProducts
EnergyProduct A Marketer holds title to an EnergyProduct.
- Resells_EnergyProduct
EnergyProduct A Marketer may resell an EnergyProduct.
-
final
case class
MaterialItem(IdentifiedObject: IdentifiedObject = null, quantity: String = null, TypeMaterial: String = null, WorkTask: String = null) extends Element with Product with Serializable
The physical consumable supply used for work and other purposes.
The physical consumable supply used for work and other purposes.
It includes items such as nuts, bolts, brackets, glue, etc.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- quantity
Quantity of material used.
- TypeMaterial
TypeMaterial undocumented
- WorkTask
WorkTask undocumented
-
final
case class
MaxStartUpCostCurve(Curve: Curve = null) extends Element with Product with Serializable
The maximum Startup costs and time as a function of down time.
The maximum Startup costs and time as a function of down time.
Relationship between unit startup cost (Y1-axis) vs. unit elapsed down time (X-axis). This is used to validate the information provided in the Bid.
- Curve
Curve Reference to the superclass object.
-
final
case class
Measurement(IdentifiedObject: IdentifiedObject = null, measurementType: String = null, phases: String = null, unitMultiplier: String = null, unitSymbol: String = null, Asset: String = null, CalculationMethodHierarchy: String = null, Locations: List[String] = null, MeasurementAction: String = null, MeasurementCalculatorInput: List[String] = null, PinMeasurement: List[String] = null, PowerSystemResource: String = null, Procedures: List[String] = null, ProtectiveActionAdjustment: List[String] = null, Terminal: String = null) extends Element with Product with Serializable
A Measurement represents any measured, calculated or non-measured non-calculated quantity.
A Measurement represents any measured, calculated or non-measured non-calculated quantity.
Any piece of equipment may contain Measurements, e.g. a substation may have temperature measurements and door open indications, a transformer may have oil temperature and tank pressure measurements, a bay may contain a number of power flow measurements and a Breaker may contain a switch status measurement. The PSR - Measurement association is intended to capture this use of Measurement and is included in the naming hierarchy based on EquipmentContainer. The naming hierarchy typically has Measurements as leaves, e.g. Substation-VoltageLevel-Bay-Switch-Measurement. Some Measurements represent quantities related to a particular sensor location in the network, e.g. a voltage transformer (VT) or potential transformer (PT) at a busbar or a current transformer (CT) at the bar between a breaker and an isolator. The sensing position is not captured in the PSR - Measurement association. Instead it is captured by the Measurement - Terminal association that is used to define the sensing location in the network topology. The location is defined by the connection of the Terminal to ConductingEquipment. If both a Terminal and PSR are associated, and the PSR is of type ConductingEquipment, the associated Terminal should belong to that ConductingEquipment instance. When the sensor location is needed both Measurement-PSR and Measurement-Terminal are used. The Measurement-Terminal association is never used alone.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- measurementType
Specifies the type of measurement. For example, this specifies if the measurement represents an indoor temperature, outdoor temperature, bus voltage, line flow, etc. When the measurementType is set to "Specialization", the type of Measurement is defined in more detail by the specialized class which inherits from Measurement.
- phases
Indicates to which phases the measurement applies and avoids the need to use 'measurementType' to also encode phase information (which would explode the types). The phase information in Measurement, along with 'measurementType' and 'phases' uniquely defines a Measurement for a device, based on normal network phase. Their meaning will not change when the computed energizing phasing is changed due to jumpers or other reasons. If the attribute is missing three phases (ABC) shall be assumed.
- unitMultiplier
The unit multiplier of the measured quantity.
- unitSymbol
The unit of measure of the measured quantity.
- Asset
Asset undocumented
- CalculationMethodHierarchy
CalculationMethodHierarchy Calculation method hierarchy which applies to this analog.
- Locations
Location undocumented
- MeasurementAction
MeasurementAction undocumented
- MeasurementCalculatorInput
MeasurementCalculatorInput undocumented
- PinMeasurement
PinMeasurement undocumented
- PowerSystemResource
PowerSystemResource The power system resource that contains the measurement.
- Procedures
Procedure Measurements are specified in types of documents, such as procedures.
- ProtectiveActionAdjustment
ProtectiveActionAdjustment undocumented
- Terminal
ACDCTerminal One or more measurements may be associated with a terminal in the network.
-
final
case class
MeasurementAction(SwitchingAction: SwitchingAction = null, Measurement: String = null) extends Element with Product with Serializable
Measurement taken as a switching step.
Measurement taken as a switching step.
- SwitchingAction
SwitchingAction Reference to the superclass object.
- Measurement
Measurement undocumented
-
final
case class
MeasurementCalculator(IdentifiedObject: IdentifiedObject = null, kind: String = null, MeasurementCalculatorInput: List[String] = null, PinMeasurement: List[String] = null) extends Element with Product with Serializable
Result of a calculation of one or more measurement.
Result of a calculation of one or more measurement.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- kind
Calculation operation executed on the operants.
- MeasurementCalculatorInput
MeasurementCalculatorInput Used in the calculation.
- PinMeasurement
PinMeasurement undocumented
-
final
case class
MeasurementCalculatorInput(IdentifiedObject: IdentifiedObject = null, absoluteValue: Boolean = false, order: Int = 0, Measurement: String = null, MeasurementCalculator: String = null) extends Element with Product with Serializable
Input to measurement calculation.
Input to measurement calculation.
Support Analog, Discrete and Accumulator.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- absoluteValue
If true, use the absolute value for the calculation.
- order
Positive number that defines the order of the operant in the calculation. 0 = default. The order is not relevant (e.g. summation).
- Measurement
Measurement Measurement used as input to a calculation.
- MeasurementCalculator
MeasurementCalculator undocumented
-
final
case class
MeasurementValue(IOPoint: IOPoint = null, sensorAccuracy: Double = 0.0, timeStamp: String = null, CalculationMethodHierarchy: String = null, ErpPerson: String = null, MeasurementValueQuality: String = null, MeasurementValueSource: String = null, ProcedureDataSet: List[String] = null, RemoteSource: String = null) extends Element with Product with Serializable
The current state for a measurement.
The current state for a measurement.
A state value is an instance of a measurement from a specific source. Measurements can be associated with many state values, each representing a different source for the measurement.
- IOPoint
IOPoint Reference to the superclass object.
- sensorAccuracy
The limit, expressed as a percentage of the sensor maximum, that errors will not exceed when the sensor is used under reference conditions.
- timeStamp
The time when the value was last updated.
- CalculationMethodHierarchy
CalculationMethodHierarchy undocumented
- ErpPerson
OldPerson undocumented
- MeasurementValueQuality
MeasurementValueQuality A MeasurementValue has a MeasurementValueQuality associated with it.
- MeasurementValueSource
MeasurementValueSource A reference to the type of source that updates the MeasurementValue, e.g. SCADA, CCLink, manual, etc. User conventions for the names of sources are contained in the introduction to IEC 61970-301.
- ProcedureDataSet
ProcedureDataSet undocumented
- RemoteSource
RemoteSource Link to the physical telemetered point associated with this measurement.
-
final
case class
MeasurementValueQuality(Quality61850: Quality61850 = null, MeasurementValue: String = null) extends Element with Product with Serializable
Measurement quality flags.
Measurement quality flags.
Bits 0-10 are defined for substation automation in IEC 61850-7-3. Bits 11-15 are reserved for future expansion by that document. Bits 16-31 are reserved for EMS applications.
- Quality61850
Quality61850 Reference to the superclass object.
- MeasurementValue
MeasurementValue A MeasurementValue has a MeasurementValueQuality associated with it.
-
final
case class
MeasurementValueSource(IdentifiedObject: IdentifiedObject = null, MeasurementValues: List[String] = null) extends Element with Product with Serializable
MeasurementValueSource describes the alternative sources updating a MeasurementValue.
MeasurementValueSource describes the alternative sources updating a MeasurementValue.
User conventions for how to use the MeasurementValueSource attributes are defined in IEC 61970-301.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- MeasurementValues
MeasurementValue The MeasurementValues updated by the source.
-
final
case class
MechLoad1(MechanicalLoadDynamics: MechanicalLoadDynamics = null, a: Double = 0.0, b: Double = 0.0, d: Double = 0.0, e: Double = 0.0) extends Element with Product with Serializable
Mechanical load model type 1.
Mechanical load model type 1.
- MechanicalLoadDynamics
MechanicalLoadDynamics Reference to the superclass object.
- a
Speed squared coefficient (a).
- b
Speed coefficient (b).
- d
Speed to the exponent coefficient (d).
- e
Exponent (e).
-
final
case class
MechanicalLoadDynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null, AsynchronousMachineDynamics: String = null, SynchronousMachineDynamics: String = null) extends Element with Product with Serializable
Mechanical load function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
Mechanical load function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- AsynchronousMachineDynamics
AsynchronousMachineDynamics Asynchronous machine model with which this mechanical load model is associated. MechanicalLoadDynamics shall have either an association to SynchronousMachineDynamics or to AsynchronousMachineDynamics.
- SynchronousMachineDynamics
SynchronousMachineDynamics Synchronous machine model with which this mechanical load model is associated. MechanicalLoadDynamics shall have either an association to SynchronousMachineDynamics or AsynchronousMachineDyanmics.
-
final
case class
MechanicalLoadUserDefined(MechanicalLoadDynamics: MechanicalLoadDynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Mechanical load function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
Mechanical load function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
- MechanicalLoadDynamics
MechanicalLoadDynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
Medium(IdentifiedObject: IdentifiedObject = null, kind: String = null, volumeSpec: Double = 0.0, Asset: List[String] = null, Specification: String = null) extends Element with Product with Serializable
A substance that either (1) provides the means of transmission of a force or effect, such as hydraulic fluid, or (2) is used for a surrounding or enveloping substance, such as oil in a transformer or circuit breaker.
A substance that either (1) provides the means of transmission of a force or effect, such as hydraulic fluid, or (2) is used for a surrounding or enveloping substance, such as oil in a transformer or circuit breaker.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- kind
Kind of this medium.
- volumeSpec
The volume of the medium specified for this application. Note that the actual volume is a type of measurement associated witht the asset.
- Asset
Asset Medium with which this asset is filled.
- Specification
Specification undocumented
-
final
case class
MerchantAccount(Document: Document = null, currentBalance: Double = 0.0, provisionalBalance: Double = 0.0, MerchantAgreement: String = null, Transactors: List[String] = null, VendorShifts: List[String] = null) extends Element with Product with Serializable
The operating account controlled by merchant agreement, against which the vendor may vend tokens or receipt payments.
The operating account controlled by merchant agreement, against which the vendor may vend tokens or receipt payments.
Transactions via vendor shift debit the account and bank deposits via bank statement credit the account.
- Document
Document Reference to the superclass object.
- currentBalance
The current operating balance of this account.
- provisionalBalance
The balance of this account after taking into account any pending debits from VendorShift.merchantDebitAmount and pending credits from BankStatement.merchantCreditAmount or credits (see also BankStatement attributes and VendorShift attributes).
- MerchantAgreement
MerchantAgreement Merchant agreement that instantiated this merchant account.
- Transactors
Transactor All transactors this merchant account is registered with.
- VendorShifts
VendorShift All vendor shifts that operate on this merchant account.
-
final
case class
MerchantAgreement(Agreement: Agreement = null, MerchantAccounts: List[String] = null) extends Element with Product with Serializable
A formal controlling contractual agreement between supplier and merchant, in terms of which the merchant is authorised to vend tokens and receipt payments on behalf of the supplier.
A formal controlling contractual agreement between supplier and merchant, in terms of which the merchant is authorised to vend tokens and receipt payments on behalf of the supplier.
The merchant is accountable to the supplier for revenue collected at point of sale.
- Agreement
Agreement Reference to the superclass object.
- MerchantAccounts
MerchantAccount All merchant accounts instantiated as a result of this merchant agreement.
-
final
case class
Meter(EndDevice: EndDevice = null, connectionCategory: String = null, formNumber: String = null, MeterMultipliers: List[String] = null, MeterReadings: List[String] = null, MeterReplacementWorkTasks: List[String] = null, MeterServiceWorkTask: List[String] = null, VendingTransactions: List[String] = null) extends Element with Product with Serializable
Physical asset that performs the metering role of the usage point.
Physical asset that performs the metering role of the usage point.
Used for measuring consumption and detection of events.
- EndDevice
EndDevice Reference to the superclass object.
- connectionCategory
A code used to specify the connection category, e.g. low voltage, where the meter operates.
- formNumber
Meter form designation per ANSI C12.10 or other applicable standard. An alphanumeric designation denoting the circuit arrangement for which the meter is applicable and its specific terminal arrangement.
- MeterMultipliers
MeterMultiplier All multipliers applied at this meter.
- MeterReadings
MeterReading All meter readings provided by this meter.
- MeterReplacementWorkTasks
MeterWorkTask All work tasks on replacement of this old meter.
- MeterServiceWorkTask
MeterWorkTask All non-replacement work tasks on this meter.
- VendingTransactions
Transaction All vending transactions on this meter.
-
final
case class
MeterMultiplier(IdentifiedObject: IdentifiedObject = null, kind: String = null, value: Double = 0.0, Meter: String = null) extends Element with Product with Serializable
Multiplier applied at the meter.
Multiplier applied at the meter.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- kind
Kind of multiplier.
- value
Multiplier value.
- Meter
Meter Meter applying this multiplier.
-
final
case class
MeterReading(IdentifiedObject: IdentifiedObject = null, isCoincidentTrigger: Boolean = false, valuesInterval: String = null, CustomerAgreement: String = null, EndDeviceEvents: List[String] = null, IntervalBlocks: List[String] = null, Meter: String = null, Readings: List[String] = null, UsagePoint: String = null) extends Element with Product with Serializable
Set of values obtained from the meter.
Set of values obtained from the meter.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- isCoincidentTrigger
If true, this meter reading is the meter reading for which other coincident meter readings are requested or provided.
- valuesInterval
Date and time interval of the data items contained within this meter reading.
- CustomerAgreement
CustomerAgreement (could be deprecated in the future) Customer agreement for this meter reading.
- EndDeviceEvents
EndDeviceEvent All end device events associated with this set of measured values.
- IntervalBlocks
IntervalBlock All interval blocks contained in this meter reading.
- Meter
Meter Meter providing this reading.
- Readings
Reading All reading values contained within this meter reading.
- UsagePoint
UsagePoint Usage point from which this meter reading (set of values) has been obtained.
-
final
case class
MeterWorkTask(WorkTask: WorkTask = null, Meter: String = null, OldMeter: String = null, UsagePoint: String = null) extends Element with Product with Serializable
Work task involving meters.
Work task involving meters.
- WorkTask
WorkTask Reference to the superclass object.
- Meter
Meter Meter on which this non-replacement work task is performed.
- OldMeter
Meter Old meter replaced by this work task.
- UsagePoint
UsagePoint Usage point to which this meter service work task applies.
-
final
case class
MeteredSubSystem(IdentifiedObject: IdentifiedObject = null, MSSAggregation: String = null, MSSZone: List[String] = null) extends Element with Product with Serializable
A metered subsystem.
A metered subsystem.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- MSSAggregation
MSSAggregation undocumented
- MSSZone
MSSZone undocumented
-
final
case class
MetrologyRequirement(IdentifiedObject: IdentifiedObject = null, reason: String = null, ReadingTypes: List[String] = null, UsagePoints: List[String] = null) extends Element with Product with Serializable
A specification of the metering requirements for a particular point within a network.
A specification of the metering requirements for a particular point within a network.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- reason
Reason for this metrology requirement being specified.
- ReadingTypes
ReadingType All reading types required to be collected by this metrology requirement.
- UsagePoints
UsagePoint All usage points having this metrology requirement.
-
final
case class
MiscCostItem(WorkIdentifiedObject: WorkIdentifiedObject = null, account: String = null, costPerUnit: Double = 0.0, costType: String = null, externalRefID: String = null, quantity: String = null, status: String = null, DesignLocation: String = null, WorkCostDetail: String = null, WorkTask: String = null) extends Element with Product with Serializable
Various cost items that are not associated with compatible units.
Various cost items that are not associated with compatible units.
Examples include rental equipment, labor, materials, contractor costs, permits - anything not covered in a CU.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- account
This drives the accounting treatment for this misc. item.
- costPerUnit
The cost per unit for this misc. item.
- costType
The cost type for accounting, such as material, labor, vehicle, contractor, equipment, overhead.
- externalRefID
External reference identifier (e.g. purchase order number, serial number) .
- quantity
The quantity of the misc. item being assigned to this location.
- status
undocumented
- DesignLocation
DesignLocation undocumented
- WorkCostDetail
WorkCostDetail undocumented
- WorkTask
OldWorkTask undocumented
-
final
case class
MitigatedBid(IdentifiedObject: IdentifiedObject = null, Bid: String = null, MitigatedBidClearing: List[String] = null) extends Element with Product with Serializable
Mitigated bid results posted for a given settlement period.
Mitigated bid results posted for a given settlement period.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- Bid
Bid undocumented
- MitigatedBidClearing
MitigatedBidClearing undocumented
-
final
case class
MitigatedBidClearing(MarketFactors: MarketFactors = null, MPMResourceStatus: List[String] = null, MitigatedBid: List[String] = null, RMRDetermination: List[String] = null) extends Element with Product with Serializable
Model of market power mitigation through reference or mitigated bids.
Model of market power mitigation through reference or mitigated bids.
Interval based.
- MarketFactors
MarketFactors Reference to the superclass object.
- MPMResourceStatus
MPMResourceStatus undocumented
- MitigatedBid
MitigatedBid undocumented
- RMRDetermination
RMRDetermination undocumented
-
final
case class
MitigatedBidSegment(Element: BasicElement = null, intervalStartTime: String = null, segmentMW: Double = 0.0, segmentNumber: Int = 0, thresholdType: String = null, Bid: String = null) extends Element with Product with Serializable
Model of mitigated bid.
Model of mitigated bid.
Indicates segment of piece-wise linear bid, that has been mitigated.
- Element
Reference to the superclass object.
- intervalStartTime
undocumented
- segmentMW
Mitigated bid segment MW value
- segmentNumber
Mitigated Bid Segment Number
- thresholdType
undocumented
- Bid
Bid undocumented
-
final
case class
MktACLineSegment(ACLineSegment: ACLineSegment = null, EndAFlow: String = null, EndBFlow: String = null) extends Element with Product with Serializable
Subclass of IEC 61970:Wires:ACLineSegment.
Subclass of IEC 61970:Wires:ACLineSegment.
- ACLineSegment
ACLineSegment Reference to the superclass object.
- EndAFlow
BranchEndFlow undocumented
- EndBFlow
BranchEndFlow undocumented
-
final
case class
MktActivityRecord(ActivityRecord: ActivityRecord = null, MarketFactors: List[String] = null) extends Element with Product with Serializable
Subclass of IEC61968: Common:ActivityRecord.
Subclass of IEC61968: Common:ActivityRecord.
- ActivityRecord
ActivityRecord Reference to the superclass object.
- MarketFactors
MarketFactors undocumented
-
final
case class
MktAnalogLimit(AnalogLimit: AnalogLimit = null, exceededLimit: Boolean = false, limitType: String = null) extends Element with Product with Serializable
Subclass of IEC 61970:Meas:AnalogLimit.
Subclass of IEC 61970:Meas:AnalogLimit.
- AnalogLimit
AnalogLimit Reference to the superclass object.
- exceededLimit
true if limit exceeded
- limitType
The type of limit the value represents Branch Limit Types: Short Term Medium Term Long Term Voltage Limits: High Low
-
final
case class
MktAnalogLimitSet(AnalogLimitSet: AnalogLimitSet = null, ratingSet: Int = 0) extends Element with Product with Serializable
Subclass of IEC 61970:Meas:AnalogLimitSet.
Subclass of IEC 61970:Meas:AnalogLimitSet.
- AnalogLimitSet
AnalogLimitSet Reference to the superclass object.
- ratingSet
Rating set numbers
-
final
case class
MktCombinedCyclePlant(CombinedCyclePlant: CombinedCyclePlant = null, AggregatedPnode: String = null, CombinedCycleLogicalConfiguration: List[String] = null) extends Element with Product with Serializable
Subclass of Production: CombinedCyclePlant from IEC 61970 package.
Subclass of Production: CombinedCyclePlant from IEC 61970 package.
A set of combustion turbines and steam turbines where the exhaust heat from the combustion turbines is recovered to make steam for the steam turbines, resulting in greater overall plant efficiency.
- CombinedCyclePlant
CombinedCyclePlant Reference to the superclass object.
- AggregatedPnode
AggregatedPnode undocumented
- CombinedCycleLogicalConfiguration
CombinedCycleLogicalConfiguration undocumented
-
final
case class
MktConductingEquipment(ConductingEquipment: ConductingEquipment = null) extends Element with Product with Serializable
Subclass of IEC 61970:Core:ConductingEquipment.
Subclass of IEC 61970:Core:ConductingEquipment.
- ConductingEquipment
ConductingEquipment Reference to the superclass object.
-
final
case class
MktConnectivityNode(ConnectivityNode: ConnectivityNode = null, CnodeDistributionFactor: List[String] = null, IndividualPnode: String = null, LossPenaltyFactor: List[String] = null, NodeConstraintTerm: List[String] = null, RTO: String = null, RegisteredResource: List[String] = null, SysLoadDistribuFactor: String = null) extends Element with Product with Serializable
Subclass of IEC61970:Topology:ConnectivityNode.
Subclass of IEC61970:Topology:ConnectivityNode.
- ConnectivityNode
ConnectivityNode Reference to the superclass object.
- CnodeDistributionFactor
CnodeDistributionFactor undocumented
- IndividualPnode
IndividualPnode undocumented
- LossPenaltyFactor
LossSensitivity undocumented
- NodeConstraintTerm
NodeConstraintTerm undocumented
- RTO
RTO undocumented
- RegisteredResource
RegisteredResource undocumented
- SysLoadDistribuFactor
SysLoadDistributionFactor undocumented
-
final
case class
MktContingency(Contingency: Contingency = null, loadRolloverFlag: Boolean = false, ltcControlFlag: Boolean = false, participationFactorSet: String = null, screeningFlag: Boolean = false, ConstraintResults: List[String] = null, ContingencyConstraintLimit: List[String] = null, TransferInterfaceSolutionA: String = null, TransferInterfaceSolutionB: String = null) extends Element with Product with Serializable
Subclass of IEC 61970:Contingency.
Subclass of IEC 61970:Contingency.
- Contingency
Contingency Reference to the superclass object.
- loadRolloverFlag
load change flag Flag that indicates whether load rollover and load pickup should be processed for this contingency
- ltcControlFlag
ltc enable flag Flag that indicates if LTCs regulate voltage during the solution of the contingency
- participationFactorSet
Participation Factor flag An indication which set of generator participation factors should be used to re-allocate generation in this contingency
- screeningFlag
sceening flag for outage Flag that indicated whether screening is bypassed for the contingency
- ConstraintResults
ConstraintResults undocumented
- ContingencyConstraintLimit
ContingencyConstraintLimit undocumented
- TransferInterfaceSolutionA
TransferInterfaceSolution undocumented
- TransferInterfaceSolutionB
TransferInterfaceSolution undocumented
-
final
case class
MktControlArea(ControlArea: ControlArea = null, ControlAreaSolutionData: List[String] = null) extends Element with Product with Serializable
Market subclass of IEC 61970:ControlArea.
Market subclass of IEC 61970:ControlArea.
- ControlArea
ControlArea Reference to the superclass object.
- ControlAreaSolutionData
ControlAreaSolutionData undocumented
-
final
case class
MktGeneratingUnit(GeneratingUnit: GeneratingUnit = null, GeneratingUnitDynamicValues: List[String] = null) extends Element with Product with Serializable
Subclass of IEC61970:Production:GeneratingUnit.
Subclass of IEC61970:Production:GeneratingUnit.
- GeneratingUnit
GeneratingUnit Reference to the superclass object.
- GeneratingUnitDynamicValues
GeneratingUnitDynamicValues undocumented
-
final
case class
MktHeatRateCurve(HeatRateCurve: HeatRateCurve = null, RegisteredGenerator: String = null, ResourceVerifiableCosts: String = null) extends Element with Product with Serializable
Subclass of IEC 61970: Generation: Production:HeatRateCurve.
Subclass of IEC 61970: Generation: Production:HeatRateCurve.
- HeatRateCurve
HeatRateCurve Reference to the superclass object.
- RegisteredGenerator
RegisteredGenerator undocumented
- ResourceVerifiableCosts
ResourceVerifiableCosts undocumented
-
final
case class
MktLine(Line: Line = null, Flowgate: List[String] = null, TransmissionRightOfWay: String = null) extends Element with Product with Serializable
Subclass for IEC61970:Wires:Line.
Subclass for IEC61970:Wires:Line.
- Line
Line Reference to the superclass object.
- Flowgate
Flowgate undocumented
- TransmissionRightOfWay
TransmissionRightOfWay undocumented
-
final
case class
MktMeasurement(Measurement: Measurement = null, ByTiePoint: String = null, DynamicSchedule: List[String] = null, ForTiePoint: String = null, Pnode: String = null, ViolationLimit: List[String] = null) extends Element with Product with Serializable
Subclass of IEC61970:Meas:Measurement.
Subclass of IEC61970:Meas:Measurement.
- Measurement
Measurement Reference to the superclass object.
- ByTiePoint
TiePoint A measurement is made on the B side of a tie point
- DynamicSchedule
DynamicSchedule undocumented
- ForTiePoint
TiePoint A measurement is made on the A side of a tie point
- Pnode
Pnode Allows Pnode an association to aggregated resources external DC ties or psuedo tie measurements.
- ViolationLimit
ViolationLimit undocumented
-
final
case class
MktPSRType(PSRType: PSRType = null, psrType: String = null, TimeSeries: List[String] = null) extends Element with Product with Serializable
The type of a power system resource.
The type of a power system resource.
- PSRType
PSRType Reference to the superclass object.
- psrType
The coded type of a power system resource.
- TimeSeries
TimeSeries undocumented
-
final
case class
MktPowerTransformer(PowerTransformer: PowerTransformer = null, EndAFlow: String = null, EndBFlow: String = null, Flowgate: List[String] = null) extends Element with Product with Serializable
Subclass of IEC61970:Wires:PowerTransformer.
Subclass of IEC61970:Wires:PowerTransformer.
- PowerTransformer
PowerTransformer Reference to the superclass object.
- EndAFlow
BranchEndFlow undocumented
- EndBFlow
BranchEndFlow undocumented
- Flowgate
Flowgate undocumented
-
final
case class
MktSeriesCompensator(SeriesCompensator: SeriesCompensator = null, EndAFlow: String = null, EndBFlow: String = null) extends Element with Product with Serializable
Subclass of IEC 61970:Wires:SeriesCompensator.
Subclass of IEC 61970:Wires:SeriesCompensator.
- SeriesCompensator
SeriesCompensator Reference to the superclass object.
- EndAFlow
BranchEndFlow undocumented
- EndBFlow
BranchEndFlow undocumented
-
final
case class
MktShuntCompensator(ShuntCompensator: ShuntCompensator = null, ShuntCompensatorDynamicData: List[String] = null) extends Element with Product with Serializable
Subclass of IEC 61970:Wires:ShuntCompensator.
Subclass of IEC 61970:Wires:ShuntCompensator.
- ShuntCompensator
ShuntCompensator Reference to the superclass object.
- ShuntCompensatorDynamicData
ShuntCompensatorDynamicData undocumented
-
final
case class
MktSwitch(Switch: Switch = null, SwitchStatus: List[String] = null) extends Element with Product with Serializable
Subclass of IEC 61970:Wires:Switch.
Subclass of IEC 61970:Wires:Switch.
- Switch
Switch Reference to the superclass object.
- SwitchStatus
SwitchStatus undocumented
-
final
case class
MktTapChanger(TapChanger: TapChanger = null, TapChangerDynamicData: List[String] = null) extends Element with Product with Serializable
Subclass of IEC 61970:Wires:TapChanger.
Subclass of IEC 61970:Wires:TapChanger.
- TapChanger
TapChanger Reference to the superclass object.
- TapChangerDynamicData
TapChangerDynamicData undocumented
-
final
case class
MktTerminal(Terminal: Terminal = null, Flowgate: String = null, TerminalConstraintTerm: List[String] = null) extends Element with Product with Serializable
Subclass of IEC61970:Core:Terminal.
Subclass of IEC61970:Core:Terminal.
- Terminal
Terminal Reference to the superclass object.
- Flowgate
Flowgate undocumented
- TerminalConstraintTerm
TerminalConstraintTerm undocumented
-
final
case class
MktThermalGeneratingUnit(ThermalGeneratingUnit: ThermalGeneratingUnit = null, CombinedCycleConfigurationMember: List[String] = null) extends Element with Product with Serializable
Subclass of ThermalGeneratingUnit from Production Package in IEC 61970.
Subclass of ThermalGeneratingUnit from Production Package in IEC 61970.
- ThermalGeneratingUnit
ThermalGeneratingUnit Reference to the superclass object.
- CombinedCycleConfigurationMember
CombinedCycleConfigurationMember undocumented
-
final
case class
MktUserAttribute(UserAttribute: UserAttribute = null, AttributeProperty: List[String] = null, BillDeterminant: List[String] = null, ChargeGroup: List[String] = null, ChargeType: List[String] = null, MarketStatementLineItem: List[String] = null, PassThroughBill: List[String] = null) extends Element with Product with Serializable
Subclass of IEC61968:Domain2:UserAttribute.
Subclass of IEC61968:Domain2:UserAttribute.
- UserAttribute
UserAttribute Reference to the superclass object.
- AttributeProperty
AttributeProperty undocumented
- BillDeterminant
BillDeterminant undocumented
- ChargeGroup
ChargeGroup undocumented
- ChargeType
ChargeType undocumented
- MarketStatementLineItem
MarketStatementLineItem undocumented
- PassThroughBill
PassThroughBill undocumented
-
final
case class
ModelAuthority(IdentifiedObject: IdentifiedObject = null, ModelingAuthoritySets: List[String] = null) extends Element with Product with Serializable
A Modeling Authority is an entity responsible for supplying and maintaining the data defining a specific set of objects in a network model.
A Modeling Authority is an entity responsible for supplying and maintaining the data defining a specific set of objects in a network model.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ModelingAuthoritySets
ModelAuthoritySet Modeling Authority Sets supplied and maintained by this Modeling Authority.
-
final
case class
ModelAuthoritySet(IdentifiedObject: IdentifiedObject = null, ModelSpecification: List[String] = null, ModelingAuthority: String = null) extends Element with Product with Serializable
A Modeling Authority Set is a group of objects in a network model where the data is supplied and maintained by the same Modeling Authority.
A Modeling Authority Set is a group of objects in a network model where the data is supplied and maintained by the same Modeling Authority.
This class is typically not included in instance data exchange as this information is tracked by other mechanisms in the exchange.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ModelSpecification
ModelPartSpecification Models of the model frame.
- ModelingAuthority
ModelAuthority Modeling Authority suppliying and maintaining the data for the objects in this Modeling Authority Set.
-
final
case class
ModelFrameType(IdentifiedObject: IdentifiedObject = null, ModelFrame: List[String] = null) extends Element with Product with Serializable
Examples would be "Boundary" or "Region" type of frame.
Examples would be "Boundary" or "Region" type of frame.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ModelFrame
FrameworkPart Model frames of the model frame type.
-
final
case class
ModelOperation(IdentifiedObject: IdentifiedObject = null, sequenceNumber: Int = 0, ModelOperationArg: List[String] = null, ModelOperationDescription: String = null, OperationSequence: String = null) extends Element with Product with Serializable
An operation performed on models.
An operation performed on models.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- sequenceNumber
Sequence number within a operation sequence, lower is first. Normally starts with 1.
- ModelOperationArg
ModelOperationArg Arguments of the operation.
- ModelOperationDescription
ModelOperationDescription The type of the model operation.
- OperationSequence
ModelOperationSequence undocumented
-
final
case class
ModelOperationArg(IdentifiedObject: IdentifiedObject = null, sequenceNumber: Int = 0, ModelOperation: String = null) extends Element with Product with Serializable
Describes the role a dataset plays in a model operation.
Describes the role a dataset plays in a model operation.
The role is applicable only in the context of a single operation.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- sequenceNumber
The sequence number of the argument in an operation. Argument entries are considered in numerical order where the operation requires an ordering.
- ModelOperation
ModelOperation The opeation for the operation argument.
-
final
case class
ModelOperationArgDescription(IdentifiedObject: IdentifiedObject = null, multiplicityMaximum: Int = 0, multiplicityMinimum: Int = 0, ModelOperationDefinition: String = null) extends Element with Product with Serializable
The type of custom operation dataset role for an operation description.
The type of custom operation dataset role for an operation description.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- multiplicityMaximum
The maximum multiplicity of the instance arguments that should be supplied for a single operation. Use -1 to indicate unlimited.
- multiplicityMinimum
The minimum multiplicity of the instance arguments that should be supplied for a single operation. Use zero to indicate optional.
- ModelOperationDefinition
ModelOperationDescription The type of operation for this type of dataset role. Operations referencing the dataset role type should only belong to operations that reference the operation type.
-
final
case class
ModelOperationDescription(IdentifiedObject: IdentifiedObject = null, ModelOperation: List[String] = null, OperationDatasetArgDescription: List[String] = null) extends Element with Product with Serializable
The type of model operation.
The type of model operation.
This class is referenced by model operations and defines the kind of operation.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ModelOperation
ModelOperation The instances of operations that conform to this operation type.
- OperationDatasetArgDescription
ModelOperationArgDescription The type of dataset roles that can be used for a type of general model operation.
-
final
case class
ModelOperationSequence(IdentifiedObject: IdentifiedObject = null, ModelOperation: List[String] = null) extends Element with Product with Serializable
A concrete sequence of operations.
A concrete sequence of operations.
For example, this may be used to describe a specific audit trail, a script or other specific set of actions on specific datasets.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ModelOperation
ModelOperation undocumented
-
final
case class
ModelPartSpecification(IdentifiedObject: IdentifiedObject = null, AssemblyDescription: List[String] = null, FrameworkPart: String = null, Model: List[String] = null) extends Element with Product with Serializable
The type of model.
The type of model.
For example, state estimator, planning, planning dynamics, short circuit, or real-time dynamics etc. The model must conform to a profile.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- AssemblyDescription
AssemblyDescription The assembly description into which model parts should be included.
- FrameworkPart
ModelAuthoritySet Model frame of the model part.
- Model
ModelPartVersion Modle parts conforming to the model part specification.
-
final
case class
ModelPartVersion(ModelToBeDeleted: ModelToBeDeleted = null, ModelSpecification: String = null) extends Element with Product with Serializable
This is a version of a part of a model.
This is a version of a part of a model.
New instances of this class with new identity are instantiated upon changes to the content of this class or changes to the associated data set. Instances of this class are considered immutable. The case audit trail can reference this immutable data to exactly reproduce a case.
- ModelToBeDeleted
ModelToBeDeleted Reference to the superclass object.
- ModelSpecification
ModelPartSpecification Model specification of the modelt.
-
final
case class
ModelToBeDeleted(IdentifiedObject: IdentifiedObject = null) extends Element with Product with Serializable
A Model is a collection of Datasets.
A Model is a collection of Datasets.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
-
final
case class
MonthDayInterval(Element: BasicElement = null, end: String = null, start: String = null) extends Element with Product with Serializable
Interval between two times specified as month and day.
Interval between two times specified as month and day.
- Element
Reference to the superclass object.
- end
End time of this interval.
- start
Start time of this interval.
-
final
case class
MutualCoupling(IdentifiedObject: IdentifiedObject = null, b0ch: Double = 0.0, distance11: Double = 0.0, distance12: Double = 0.0, distance21: Double = 0.0, distance22: Double = 0.0, g0ch: Double = 0.0, r0: Double = 0.0, x0: Double = 0.0, First_Terminal: String = null, Second_Terminal: String = null) extends Element with Product with Serializable
This class represents the zero sequence line mutual coupling.
This class represents the zero sequence line mutual coupling.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- b0ch
Zero sequence mutual coupling shunt (charging) susceptance, uniformly distributed, of the entire line section.
- distance11
Distance to the start of the coupled region from the first line's terminal having sequence number equal to 1.
- distance12
Distance to the end of the coupled region from the first line's terminal with sequence number equal to 1.
- distance21
Distance to the start of coupled region from the second line's terminal with sequence number equal to 1.
- distance22
Distance to the end of coupled region from the second line's terminal with sequence number equal to 1.
- g0ch
Zero sequence mutual coupling shunt (charging) conductance, uniformly distributed, of the entire line section.
- r0
Zero sequence branch-to-branch mutual impedance coupling, resistance.
- x0
Zero sequence branch-to-branch mutual impedance coupling, reactance.
- First_Terminal
Terminal The starting terminal for the calculation of distances along the first branch of the mutual coupling. Normally MutualCoupling would only be used for terminals of AC line segments. The first and second terminals of a mutual coupling should point to different AC line segments.
- Second_Terminal
Terminal The starting terminal for the calculation of distances along the second branch of the mutual coupling.
-
final
case class
Name(Element: BasicElement = null, name: String = null, IdentifiedObject: String = null, NameType: String = null) extends Element with Product with Serializable
The Name class provides the means to define any number of human readable names for an object.
The Name class provides the means to define any number of human readable names for an object.
A name is not to be used for defining inter-object relationships. For inter-object relationships instead use the object identification 'mRID'.
- Element
Reference to the superclass object.
- name
Any free text that name the object.
- IdentifiedObject
IdentifiedObject Identified object that this name designates.
- NameType
NameType Type of this name.
-
final
case class
NameType(Element: BasicElement = null, description: String = null, name: String = null, NameTypeAuthority: String = null, Names: List[String] = null) extends Element with Product with Serializable
Type of name.
Type of name.
Possible values for attribute 'name' are implementation dependent but standard profiles may specify types. An enterprise may have multiple IT systems each having its own local name for the same object, e.g. a planning system may have different names from an EMS. An object may also have different names within the same IT system, e.g. localName as defined in CIM version 14. The definition from CIM14 is: The localName is a human readable name of the object. It is a free text name local to a node in a naming hierarchy similar to a file directory structure. A power system related naming hierarchy may be: Substation, VoltageLevel, Equipment etc. Children of the same parent in such a hierarchy have names that typically are unique among them.
- Element
Reference to the superclass object.
- description
Description of the name type.
- name
Name of the name type.
- NameTypeAuthority
NameTypeAuthority Authority responsible for managing names of this type.
- Names
Name All names of this type.
-
final
case class
NameTypeAuthority(Element: BasicElement = null, description: String = null, name: String = null, NameTypes: List[String] = null) extends Element with Product with Serializable
Authority responsible for creation and management of names of a given type; typically an organization or an enterprise system.
Authority responsible for creation and management of names of a given type; typically an organization or an enterprise system.
- Element
Reference to the superclass object.
- description
Description of the name type authority.
- name
Name of the name type authority.
- NameTypes
NameType All name types managed by this authority.
-
final
case class
NetworkBoundary(FrameworkPart: FrameworkPart = null) extends Element with Product with Serializable
A framework part that is a boundary between 2 frames.
A framework part that is a boundary between 2 frames.
- FrameworkPart
FrameworkPart Reference to the superclass object.
-
final
case class
NetworkFrame(FrameworkPart: FrameworkPart = null, FrameworkPart_attr: List[String] = null) extends Element with Product with Serializable
A region isolated by boundaries.
A region isolated by boundaries.
- FrameworkPart
FrameworkPart Reference to the superclass object.
- FrameworkPart_attr
FrameworkPart undocumented
-
final
case class
NetworkModelCaseDefinition(Element: BasicElement = null) extends Element with Product with Serializable
Instructions to build a network model case, including when appropriate the results.
Instructions to build a network model case, including when appropriate the results.
- Element
Reference to the superclass object.
-
final
case class
NetworkModelProject(NetworkModelProjectComponent: NetworkModelProjectComponent = null, ContainedProject: List[String] = null) extends Element with Product with Serializable
A grouping of network model change descriptions.
A grouping of network model change descriptions.
Primarily used to organize the phases of an overall project.
- NetworkModelProjectComponent
NetworkModelProjectComponent Reference to the superclass object.
- ContainedProject
NetworkModelProjectComponent Projects that are included in this parent project.
- final case class NetworkModelProject2(NetworkModelProjectComponent2: NetworkModelProjectComponent2 = null, Child: List[String] = null) extends Element with Product with Serializable
-
final
case class
NetworkModelProjectChange(NetworkModelProjectComponent: NetworkModelProjectComponent = null, NetworkModelProjectChangeVersion: List[String] = null) extends Element with Product with Serializable
Network model project change described by versions of an associated change set.
Network model project change described by versions of an associated change set.
Has persistent identity over multiple versions of the associated change set.
- NetworkModelProjectComponent
NetworkModelProjectComponent Reference to the superclass object.
- NetworkModelProjectChangeVersion
NetworkModelProjectChangeVersion A specific version of the network model project change.
-
final
case class
NetworkModelProjectChangeVersion(IdentifiedObject: IdentifiedObject = null, comment: String = null, effectiveDateTime: String = null, timeStamp: String = null, ChangeSet: String = null, NetworkModelProjectChange: String = null, NetworkModelProjectState: String = null, SupercededBy: String = null, Supercedes: String = null) extends Element with Product with Serializable
Describes the status and the planned implementation of the associated change set into the as-built model.
Describes the status and the planned implementation of the associated change set into the as-built model.
New instances of this class with new identity are instantiated upon changes to the content of this class or changes to the associated change set. Instances of this class are considered immutable. The case audit trail can reference this immutable data to exactly reproduce a case.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- comment
A user provided comment describing the changes in this version from the previous version.
- effectiveDateTime
The date/time the change set is included in the model.
- timeStamp
The date/time this version was finalized and thus made immutable.
- ChangeSet
ChangeSet The details of model changes for this project. The change set should have a new identifier if it changes.
- NetworkModelProjectChange
NetworkModelProjectChange The persistent network model project change to which this version applies.
- NetworkModelProjectState
NetworkModelProjectState The state of this network model project version.
- SupercededBy
NetworkModelProjectChangeVersion The project version that will supercede this project version.
- Supercedes
NetworkModelProjectChangeVersion Project version that is being superceded.
- final case class NetworkModelProjectCollection(Element: BasicElement = null) extends Element with Product with Serializable
-
final
case class
NetworkModelProjectComponent(IdentifiedObject: IdentifiedObject = null, ContainingProject: String = null, ProjectARelationships: List[String] = null, ProjectBRelationships: List[String] = null) extends Element with Product with Serializable
Abstract class for both a network model project and network model change.
Abstract class for both a network model project and network model change.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ContainingProject
NetworkModelProject The parent project of this project.
- ProjectARelationships
NetworkModelProjectRelationship undocumented
- ProjectBRelationships
NetworkModelProjectRelationship undocumented
- final case class NetworkModelProjectComponent2(IdentifiedObject: IdentifiedObject = null, closed: String = null, created: String = null, updated: String = null, version: Int = 0, Parent: String = null) extends Element with Product with Serializable
- final case class NetworkModelProjectDocument(Element: BasicElement = null) extends Element with Product with Serializable
-
final
case class
NetworkModelProjectRelationship(IdentifiedObject: IdentifiedObject = null, ProjectA: String = null, ProjectB: String = null) extends Element with Product with Serializable
A relationship that assists humans and software building cases by assembling project changes in the correct sequence.
A relationship that assists humans and software building cases by assembling project changes in the correct sequence.
This class may be specialized to create specific types of relationships.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ProjectA
NetworkModelProjectComponent undocumented
- ProjectB
NetworkModelProjectComponent undocumented
- final case class NetworkModelProjectStage(NetworkModelProjectComponent2: NetworkModelProjectComponent2 = null, changesetVersion: Int = 0, commissionedDate: String = null, plannedCommissionedDate: String = null, ChangeSets: List[String] = null, DenpendecyDependingStage: List[String] = null, DependencyDependentOnStage: String = null) extends Element with Product with Serializable
-
final
case class
NetworkModelProjectState(IdentifiedObject: IdentifiedObject = null, NetworkModelProjectChangeVersion: List[String] = null) extends Element with Product with Serializable
A network model project version state.
A network model project version state.
States are agreed upon by the exchange community. Examples are "approved", "proposed", "withdrawn", "committed" etc.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- NetworkModelProjectChangeVersion
NetworkModelProjectChangeVersion The change versions that are at this state.
-
final
case class
NoLoadTest(TransformerTest: TransformerTest = null, energisedEndVoltage: Double = 0.0, excitingCurrent: Double = 0.0, excitingCurrentZero: Double = 0.0, loss: Double = 0.0, lossZero: Double = 0.0, EnergisedEnd: String = null) extends Element with Product with Serializable
No-load test results determine core admittance parameters.
No-load test results determine core admittance parameters.
They include exciting current and core loss measurements from applying voltage to one winding. The excitation may be positive sequence or zero sequence. The test may be repeated at different voltages to measure saturation.
- TransformerTest
TransformerTest Reference to the superclass object.
- energisedEndVoltage
Voltage applied to the winding (end) during test.
- excitingCurrent
Exciting current measured from a positive-sequence or single-phase excitation test.
- excitingCurrentZero
Exciting current measured from a zero-sequence open-circuit excitation test.
- loss
Losses measured from a positive-sequence or single-phase excitation test.
- lossZero
Losses measured from a zero-sequence excitation test.
- EnergisedEnd
TransformerEndInfo Transformer end that current is applied to in this no-load test.
-
final
case class
NodeConstraintTerm(ConstraintTerm: ConstraintTerm = null, MktConnectivityNode: String = null) extends Element with Product with Serializable
To be used only to constrain a quantity that cannot be associated with a terminal.
To be used only to constrain a quantity that cannot be associated with a terminal.
For example, a registered generating unit that is not electrically connected to the network.
- ConstraintTerm
ConstraintTerm Reference to the superclass object.
- MktConnectivityNode
MktConnectivityNode undocumented
-
final
case class
NonConformLoad(EnergyConsumer: EnergyConsumer = null, LoadGroup: String = null) extends Element with Product with Serializable
NonConformLoad represents loads that do not follow a daily load change pattern and whose changes are not correlated with the daily load change pattern.
NonConformLoad represents loads that do not follow a daily load change pattern and whose changes are not correlated with the daily load change pattern.
- EnergyConsumer
EnergyConsumer Reference to the superclass object.
- LoadGroup
NonConformLoadGroup Group of this ConformLoad.
-
final
case class
NonConformLoadGroup(LoadGroup: LoadGroup = null, EnergyConsumers: List[String] = null, NonConformLoadSchedules: List[String] = null) extends Element with Product with Serializable
Loads that do not follow a daily and seasonal load variation pattern.
Loads that do not follow a daily and seasonal load variation pattern.
- LoadGroup
LoadGroup Reference to the superclass object.
- EnergyConsumers
NonConformLoad Conform loads assigned to this ConformLoadGroup.
- NonConformLoadSchedules
NonConformLoadSchedule The NonConformLoadSchedules in the NonConformLoadGroup.
-
final
case class
NonConformLoadSchedule(SeasonDayTypeSchedule: SeasonDayTypeSchedule = null, NonConformLoadGroup: String = null) extends Element with Product with Serializable
An active power (Y1-axis) and reactive power (Y2-axis) schedule (curves) versus time (X-axis) for non-conforming loads, e.g., large industrial load or power station service (where modelled).
An active power (Y1-axis) and reactive power (Y2-axis) schedule (curves) versus time (X-axis) for non-conforming loads, e.g., large industrial load or power station service (where modelled).
- SeasonDayTypeSchedule
SeasonDayTypeSchedule Reference to the superclass object.
- NonConformLoadGroup
NonConformLoadGroup The NonConformLoadGroup where the NonConformLoadSchedule belongs.
-
final
case class
NonStandardItem(WorkDocument: WorkDocument = null, amount: Double = 0.0) extends Element with Product with Serializable
This document provides information for non-standard items like customer contributions (e.g., customer digs trench), vouchers (e.g., credit), and contractor bids.
This document provides information for non-standard items like customer contributions (e.g., customer digs trench), vouchers (e.g., credit), and contractor bids.
- WorkDocument
WorkDocument Reference to the superclass object.
- amount
The projected cost for this item.
-
final
case class
NonlinearShuntCompensator(ShuntCompensator: ShuntCompensator = null, NonlinearShuntCompensatorPoints: List[String] = null) extends Element with Product with Serializable
A non linear shunt compensator has bank or section admittance values that differ.
A non linear shunt compensator has bank or section admittance values that differ.
The attributes g, b, g0 and b0 of the associated NonlinearShuntCompensatorPoint describe the total conductance and admittance of a NonlinearShuntCompensatorPoint at a section number specified by NonlinearShuntCompensatorPoint.sectionNumber.
- ShuntCompensator
ShuntCompensator Reference to the superclass object.
- NonlinearShuntCompensatorPoints
NonlinearShuntCompensatorPoint All points of the non-linear shunt compensator.
-
final
case class
NonlinearShuntCompensatorPhase(ShuntCompensatorPhase: ShuntCompensatorPhase = null, NonlinearShuntCompensatorPhasePoints: List[String] = null) extends Element with Product with Serializable
A per phase non linear shunt compensator has bank or section admittance values that differ.
A per phase non linear shunt compensator has bank or section admittance values that differ.
The attributes g and b of the associated NonlinearShuntCompensatorPhasePoint describe the total conductance and admittance of a NonlinearShuntCompensatorPhasePoint at a section number specified by NonlinearShuntCompensatorPhasePoint.sectionNumber.
- ShuntCompensatorPhase
ShuntCompensatorPhase Reference to the superclass object.
- NonlinearShuntCompensatorPhasePoints
NonlinearShuntCompensatorPhasePoint All points of the non-linear shunt compensator phase.
-
final
case class
NonlinearShuntCompensatorPhasePoint(Element: BasicElement = null, b: Double = 0.0, g: Double = 0.0, sectionNumber: Int = 0, NonlinearShuntCompensatorPhase: String = null) extends Element with Product with Serializable
A per phase non linear shunt compensator bank or section admittance value.
A per phase non linear shunt compensator bank or section admittance value.
The number of NonlinearShuntCompenstorPhasePoint instances associated with a NonlinearShuntCompensatorPhase shall be equal to ShuntCompensatorPhase.maximumSections. ShuntCompensator.sections shall only be set to one of the NonlinearShuntCompenstorPhasePoint.sectionNumber. There is no interpolation between NonlinearShuntCompenstorPhasePoint-s.
- Element
Reference to the superclass object.
- b
Positive sequence shunt (charging) susceptance per section.
- g
Positive sequence shunt (charging) conductance per section.
- sectionNumber
The number of the section.
- NonlinearShuntCompensatorPhase
NonlinearShuntCompensatorPhase Non-linear shunt compensator phase owning this point.
-
final
case class
NonlinearShuntCompensatorPoint(Element: BasicElement = null, b: Double = 0.0, b0: Double = 0.0, g: Double = 0.0, g0: Double = 0.0, sectionNumber: Int = 0, NonlinearShuntCompensator: String = null) extends Element with Product with Serializable
A non linear shunt compensator bank or section admittance value.
A non linear shunt compensator bank or section admittance value.
The number of NonlinearShuntCompenstorPoint instances associated with a NonlinearShuntCompensator shall be equal to ShuntCompensator.maximumSections. ShuntCompensator.sections shall only be set to one of the NonlinearShuntCompenstorPoint.sectionNumber. There is no interpolation between NonlinearShuntCompenstorPoint-s.
- Element
Reference to the superclass object.
- b
Positive sequence shunt (charging) susceptance per section.
- b0
Zero sequence shunt (charging) susceptance per section.
- g
Positive sequence shunt (charging) conductance per section.
- g0
Zero sequence shunt (charging) conductance per section.
- sectionNumber
The number of the section.
- NonlinearShuntCompensator
NonlinearShuntCompensator Non-linear shunt compensator owning this point.
-
final
case class
NotificationTimeCurve(Curve: Curve = null, GeneratingBids: List[String] = null) extends Element with Product with Serializable
Notification time curve as a function of down time.
Notification time curve as a function of down time.
Relationship between crew notification time (Y1-axis) and unit startup time (Y2-axis) vs. unit elapsed down time (X-axis).
- Curve
Curve Reference to the superclass object.
- GeneratingBids
GeneratingBid undocumented
-
final
case class
NuclearGeneratingUnit(GeneratingUnit: GeneratingUnit = null) extends Element with Product with Serializable
A nuclear generating unit.
A nuclear generating unit.
- GeneratingUnit
GeneratingUnit Reference to the superclass object.
-
final
case class
ObjectCreation(ChangeSetMember: ChangeSetMember = null) extends Element with Product with Serializable
An object is to be created in the context.
An object is to be created in the context.
- ChangeSetMember
ChangeSetMember Reference to the superclass object.
-
final
case class
ObjectDeletion(ChangeSetMember: ChangeSetMember = null) extends Element with Product with Serializable
An object is to be deleted in the context.
An object is to be deleted in the context.
- ChangeSetMember
ChangeSetMember Reference to the superclass object.
-
final
case class
ObjectModification(ChangeSetMember: ChangeSetMember = null, ObjectReverseModification: String = null) extends Element with Product with Serializable
The object already exists and is to be modified.
The object already exists and is to be modified.
- ChangeSetMember
ChangeSetMember Reference to the superclass object.
- ObjectReverseModification
ObjectReverseModification The data object holding preconditions of updates.
-
final
case class
ObjectReverseModification(ChangeSetMember: ChangeSetMember = null, ObjectModification: String = null) extends Element with Product with Serializable
Used to specify precondition properties for a preconditioned update.
Used to specify precondition properties for a preconditioned update.
- ChangeSetMember
ChangeSetMember Reference to the superclass object.
- ObjectModification
ObjectModification The associated data object representing the update. Normally the associaiton is specifed, but in the case of a proxy object where the association is removed, we might not reference any data object as it would only reference a proxy data object with no associations.
-
final
case class
Observation(EnvironmentalInformation: EnvironmentalInformation = null) extends Element with Product with Serializable
Observed (actual non-forecast) values sets and/or phenomena characteristics.
Observed (actual non-forecast) values sets and/or phenomena characteristics.
- EnvironmentalInformation
EnvironmentalInformation Reference to the superclass object.
-
final
case class
OilAnalysisFluidAnalog(AssetAnalog: AssetAnalog = null, kind: String = null) extends Element with Product with Serializable
Asset oil analysis fluid test type of analog.
Asset oil analysis fluid test type of analog.
- AssetAnalog
AssetAnalog Reference to the superclass object.
- kind
Kind of analog representing oil fluid test analysis result.
-
final
case class
OilAnalysisFluidDiscrete(AssetDiscrete: AssetDiscrete = null, kind: String = null) extends Element with Product with Serializable
Asset oil analysis fluid type of discrete.
Asset oil analysis fluid type of discrete.
- AssetDiscrete
AssetDiscrete Reference to the superclass object.
- kind
Kind of discrete representing oil fluid test analysis result.
-
final
case class
OilAnalysisGasAnalog(AssetAnalog: AssetAnalog = null, kind: String = null) extends Element with Product with Serializable
Asset oil analysis gas type of analog.
Asset oil analysis gas type of analog.
- AssetAnalog
AssetAnalog Reference to the superclass object.
- kind
Kind of analog representing oil dissolved gases analysis result.
-
final
case class
OilAnalysisMetalsAnalog(AssetAnalog: AssetAnalog = null, kind: String = null) extends Element with Product with Serializable
Asset oil analysis metals type of analog.
Asset oil analysis metals type of analog.
- AssetAnalog
AssetAnalog Reference to the superclass object.
- kind
Kind of analog representing oil metals elements analysis result.
-
final
case class
OilAnalysisMoistureAnalog(AssetAnalog: AssetAnalog = null, kind: String = null) extends Element with Product with Serializable
Asset oil analysis moisture type of analog.
Asset oil analysis moisture type of analog.
- AssetAnalog
AssetAnalog Reference to the superclass object.
- kind
Kind of analog representing oil moisture analysis result.
-
final
case class
OilAnalysisPCBAnalog(AssetAnalog: AssetAnalog = null, kind: String = null) extends Element with Product with Serializable
Asset oil analysis PCB type of analog.
Asset oil analysis PCB type of analog.
- AssetAnalog
AssetAnalog Reference to the superclass object.
- kind
Kind of analog representing oil PCB analysis result.
-
final
case class
OilAnalysisPCBDiscrete(AssetDiscrete: AssetDiscrete = null, kind: String = null) extends Element with Product with Serializable
Asset oil analysis PCB type of discrete.
Asset oil analysis PCB type of discrete.
- AssetDiscrete
AssetDiscrete Reference to the superclass object.
- kind
Kind of discrete representing oil PCB test analysis result.
-
final
case class
OilAnalysisPaperAnalog(AssetAnalog: AssetAnalog = null, kind: String = null) extends Element with Product with Serializable
Asset oil inspection paper type of analog.
Asset oil inspection paper type of analog.
- AssetAnalog
AssetAnalog Reference to the superclass object.
- kind
Kind of analog representing oil paper degradation analysis result.
-
final
case class
OilAnalysisParticleAnalog(AssetAnalog: AssetAnalog = null, kind: String = null) extends Element with Product with Serializable
Asset oil analysis particle type of analog.
Asset oil analysis particle type of analog.
- AssetAnalog
AssetAnalog Reference to the superclass object.
- kind
Kind of analog representing oil particulate analysis result.
-
final
case class
OilAnalysisParticleDiscrete(AssetDiscrete: AssetDiscrete = null, kind: String = null) extends Element with Product with Serializable
Asset oil analysis particle type of discrete.
Asset oil analysis particle type of discrete.
- AssetDiscrete
AssetDiscrete Reference to the superclass object.
- kind
Kind of discrete representing oil particulate analysis result.
-
final
case class
OilPrice(Element: BasicElement = null, oilPriceIndex: Double = 0.0, FuelRegion: String = null) extends Element with Product with Serializable
Price of oil in monetary units.
Price of oil in monetary units.
- Element
Reference to the superclass object.
- oilPriceIndex
The average oil price at a defined fuel region.
- FuelRegion
FuelRegion undocumented
- final case class OilSpecimen(Specimen: Specimen = null, oilSampleTakenFrom: String = null, oilSampleTemperature: Double = 0.0, oilTemperatureSource: String = null, sampleContainer: String = null) extends Element with Product with Serializable
-
final
case class
OldCrew(Crew: Crew = null, type: String = null, Assignments: List[String] = null, Capabilities: List[String] = null, Locations: List[String] = null, Route: String = null, ShiftPatterns: List[String] = null) extends Element with Product with Serializable
A crew is a group of people with specific skills, tools, and vehicles.
A crew is a group of people with specific skills, tools, and vehicles.
- Crew
Crew Reference to the superclass object.
- type
Classification by utility's work management standards and practices.
- Assignments
Assignment All Assignments for this Crew.
- Capabilities
Capability undocumented
- Locations
Location undocumented
- Route
Route undocumented
- ShiftPatterns
ShiftPattern undocumented
-
final
case class
OldPerson(Person: Person = null, status: String = null, type: String = null, Crafts: List[String] = null, CustomerData: String = null, ErpCompetency: String = null, ErpPersonnel: String = null, LaborItems: List[String] = null, LandPropertyRoles: List[String] = null, MeasurementValues: List[String] = null, OrganisationRoles: List[String] = null, Skills: List[String] = null) extends Element with Product with Serializable
General purpose information for name and other information to contact people.
General purpose information for name and other information to contact people.
- Person
Person Reference to the superclass object.
- status
undocumented
- type
Utility-specific classification for this person, according to the utility's corporate standards and practices. Examples include employee, contractor, agent, not affiliated, etc. Note that this field is not used to indicate whether this person is a customer of the utility. Often an employee or contractor is also a customer. Customer information is gained with relationship to Organisation and CustomerData. In similar fashion, this field does not indicate the various roles this person may fill as part of utility operations.
- Crafts
Craft undocumented
- CustomerData
Customer undocumented
- ErpCompetency
ErpCompetency undocumented
- ErpPersonnel
ErpPersonnel undocumented
- LaborItems
LaborItem undocumented
- LandPropertyRoles
PersonPropertyRole undocumented
- MeasurementValues
MeasurementValue undocumented
- OrganisationRoles
PersonOrganisationRole undocumented
- Skills
Skill undocumented
-
final
case class
OldSwitchInfo(SwitchInfo: SwitchInfo = null, dielectricStrength: Double = 0.0, loadBreak: Boolean = false, makingCapacity: Double = 0.0, minimumCurrent: Double = 0.0, poleCount: Int = 0, remote: Boolean = false, withstandCurrent: Double = 0.0) extends Element with Product with Serializable
Properties of switch assets.
Properties of switch assets.
- SwitchInfo
SwitchInfo Reference to the superclass object.
- dielectricStrength
The maximum rms voltage that may be applied across an open contact without breaking down the dielectric properties of the switch in the open position.
- loadBreak
True if switch has load breaking capabiity. Unless specified false, this is always assumed to be true for breakers and reclosers.
- makingCapacity
The highest value of current the switch can make at the rated voltage under specified operating conditions without suffering significant deterioration of its performance.
- minimumCurrent
The lowest value of current that the switch can make, carry and break in uninterrupted duty at the rated voltage under specified operating conditions without suffering significant deterioration of its performance.
- poleCount
Number of poles (i.e. of current carrying conductors that are switched).
- remote
True if device is capable of being operated by remote control.
- withstandCurrent
The highest value of current the switch can carry in the closed position at the rated voltage under specified operating conditions without suffering significant deterioration of its performance.
- final case class OldTransformerEndInfo(TransformerEndInfo: TransformerEndInfo = null, dayOverLoadRating: Double = 0.0, hourOverLoadRating: Double = 0.0, solidInsulationWeight: Double = 0.0, windingInsulationKind: String = null) extends Element with Product with Serializable
- final case class OldTransformerTankInfo(TransformerTankInfo: TransformerTankInfo = null, constructionKind: String = null, coreCoilsWeight: Double = 0.0, coreKind: String = null, function: String = null, neutralBIL: Double = 0.0, oilPreservationKind: String = null) extends Element with Product with Serializable
-
final
case class
OldWorkTask(WorkTask: WorkTask = null, Capabilities: List[String] = null, ContractorItems: List[String] = null, Design: String = null, DesignLocationCUs: List[String] = null, LaborItems: List[String] = null, MiscCostItems: List[String] = null, OverheadCost: String = null, QualificationRequirements: List[String] = null, Usages: List[String] = null, WorkCostDetails: List[String] = null, WorkFlowStep: String = null) extends Element with Product with Serializable
A set of tasks is required to implement a design.
A set of tasks is required to implement a design.
- WorkTask
WorkTask Reference to the superclass object.
- Capabilities
Capability undocumented
- ContractorItems
ContractorItem undocumented
- Design
Design undocumented
- DesignLocationCUs
DesignLocationCU undocumented
- LaborItems
LaborItem undocumented
- MiscCostItems
MiscCostItem undocumented
- OverheadCost
OverheadCost undocumented
- QualificationRequirements
QualificationRequirement undocumented
- Usages
Usage undocumented
- WorkCostDetails
WorkCostDetail undocumented
- WorkFlowStep
WorkFlowStep undocumented
-
final
case class
OneCallRequest(WorkDocument: WorkDocument = null, explosivesUsed: Boolean = false, markedIndicator: Boolean = false, markingInstruction: String = null, WorkLocations: List[String] = null) extends Element with Product with Serializable
A request for other utilities to mark their underground facilities prior to commencement of construction and/or maintenance.
A request for other utilities to mark their underground facilities prior to commencement of construction and/or maintenance.
- WorkDocument
WorkDocument Reference to the superclass object.
- explosivesUsed
True if explosives have been or are planned to be used.
- markedIndicator
True if work location has been marked, for example for a dig area.
- markingInstruction
Instructions for marking a dig area, if applicable.
- WorkLocations
WorkLocation undocumented
-
final
case class
OpenAccessProduct(Agreement: Agreement = null) extends Element with Product with Serializable
Contracts for services offered commercially.
Contracts for services offered commercially.
- Agreement
Agreement Reference to the superclass object.
-
final
case class
OpenCircuitTest(TransformerTest: TransformerTest = null, energisedEndStep: Int = 0, energisedEndVoltage: Double = 0.0, openEndStep: Int = 0, openEndVoltage: Double = 0.0, phaseShift: Double = 0.0, EnergisedEnd: String = null, OpenEnd: String = null) extends Element with Product with Serializable
Open-circuit test results verify winding turn ratios and phase shifts.
Open-circuit test results verify winding turn ratios and phase shifts.
They include induced voltage and phase shift measurements on open-circuit windings, with voltage applied to the energised end. For three-phase windings, the excitation can be a positive sequence (the default) or a zero sequence.
- TransformerTest
TransformerTest Reference to the superclass object.
- energisedEndStep
Tap step number for the energised end of the test pair.
- energisedEndVoltage
Voltage applied to the winding (end) during test.
- openEndStep
Tap step number for the open end of the test pair.
- openEndVoltage
Voltage measured at the open-circuited end, with the energised end set to rated voltage and all other ends open.
- phaseShift
Phase shift measured at the open end with the energised end set to rated voltage and all other ends open.
- EnergisedEnd
TransformerEndInfo Transformer end that current is applied to in this open-circuit test.
- OpenEnd
TransformerEndInfo Transformer end measured for induced voltage and angle in this open-circuit test.
-
final
case class
OpenTieSchedule(BidHourlySchedule: BidHourlySchedule = null, value: Boolean = false) extends Element with Product with Serializable
Result of bid validation against conditions that may exist on an interchange that becomes disconnected or is heavily discounted with respect the MW flow.
Result of bid validation against conditions that may exist on an interchange that becomes disconnected or is heavily discounted with respect the MW flow.
This schedule is assocated with the hourly parameters in a resource bid.
- BidHourlySchedule
BidHourlySchedule Reference to the superclass object.
- value
undocumented
-
final
case class
OperatingMechanism(Asset: Asset = null, InterrupterUnit: List[String] = null) extends Element with Product with Serializable
Breaker mechanism.
Breaker mechanism.
- Asset
Asset Reference to the superclass object.
- InterrupterUnit
InterrupterUnit Interrupter controlled by this mechanism.
-
final
case class
OperatingMechanismInfo(AssetInfo: AssetInfo = null, closeAmps: Double = 0.0, closeVoltage: Double = 0.0, mechanismKind: String = null, motorRunCurrent: Double = 0.0, motorStartCurrent: Double = 0.0, motorVoltage: Double = 0.0, tripAmps: Double = 0.0, tripVoltage: Double = 0.0) extends Element with Product with Serializable
Breaker operating mechanism datasheet information.
Breaker operating mechanism datasheet information.
- AssetInfo
AssetInfo Reference to the superclass object.
- closeAmps
Close current (nominal).
- closeVoltage
Close voltage in volts DC.
- mechanismKind
Kind of breaker operating mechanism.
- motorRunCurrent
Rated motor run current in amps.
- motorStartCurrent
Rated motor start current in amps.
- motorVoltage
Nominal motor voltage in volts DC.
- tripAmps
Trip current (nominal).
- tripVoltage
Trip voltage in volts DC.
-
final
case class
OperatingParticipant(IdentifiedObject: IdentifiedObject = null, OperatingShare: List[String] = null) extends Element with Product with Serializable
An operator of multiple power system resource objects.
An operator of multiple power system resource objects.
Note multple operating participants may operate the same power system resource object. This can be used for modeling jointly owned units where each owner operates as a contractual share.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- OperatingShare
OperatingShare The operating shares of this operating participant. An operating participant can be resused for any number of power system resources.
-
final
case class
OperatingShare(Element: BasicElement = null, percentage: Double = 0.0, OperatingParticipant: String = null, PowerSystemResource: String = null) extends Element with Product with Serializable
Specifies the operations contract relationship between a power system resource and a contract participant.
Specifies the operations contract relationship between a power system resource and a contract participant.
- Element
Reference to the superclass object.
- percentage
Percentage operational ownership between the pair (power system resource and operating participant) associated with this share. The total percentage ownership for a power system resource should add to 100%.
- OperatingParticipant
OperatingParticipant The operating participant having this share with the associated power system resource.
- PowerSystemResource
PowerSystemResource The power system resource to which the share applies.
- final case class Operation(Element: BasicElement = null) extends Element with Product with Serializable
-
final
case class
OperationPersonRole(PersonRole: PersonRole = null) extends Element with Product with Serializable
Person role in the context of utility operations.
Person role in the context of utility operations.
- PersonRole
PersonRole Reference to the superclass object.
-
final
case class
OperationalLimit(IdentifiedObject: IdentifiedObject = null, LimitDependencyModel: List[String] = null, LimitScalingLimit: List[String] = null, OperationalLimitSet: String = null, OperationalLimitType: String = null) extends Element with Product with Serializable
A value and normal value associated with a specific kind of limit.
A value and normal value associated with a specific kind of limit.
The sub class value and normalValue attributes vary inversely to the associated OperationalLimitType.acceptableDuration (acceptableDuration for short). If a particular piece of equipment has multiple operational limits of the same kind (apparent power, current, etc.), the limit with the greatest acceptableDuration shall have the smallest limit value and the limit with the smallest acceptableDuration shall have the largest limit value. Note: A large current can only be allowed to flow through a piece of equipment for a short duration without causing damage, but a lesser current can be allowed to flow for a longer duration.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- LimitDependencyModel
LimitDependency The limit dependency models which are used to calculate this limit. If no limit dependencies are specified then the native limit value is used.
- LimitScalingLimit
LimitScalingLimit undocumented
- OperationalLimitSet
OperationalLimitSet The limit set to which the limit values belong.
- OperationalLimitType
OperationalLimitType The limit type associated with this limit.
-
final
case class
OperationalLimitSet(IdentifiedObject: IdentifiedObject = null, Equipment: String = null, OperationalLimitValue: List[String] = null, Terminal: String = null) extends Element with Product with Serializable
A set of limits associated with equipment.
A set of limits associated with equipment.
Sets of limits might apply to a specific temperature, or season for example. A set of limits may contain different severities of limit levels that would apply to the same equipment. The set may contain limits of different types such as apparent power and current limits or high and low voltage limits that are logically applied together as a set.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- Equipment
Equipment The equipment to which the limit set applies.
- OperationalLimitValue
OperationalLimit Values of equipment limits.
- Terminal
ACDCTerminal The terminal where the operational limit set apply.
-
final
case class
OperationalLimitType(IdentifiedObject: IdentifiedObject = null, acceptableDuration: Double = 0.0, direction: String = null, isInfiniteDuration: Boolean = false, OperationalLimit: List[String] = null, SourceOperationalLimitTypeScaling: List[String] = null, TargetOperationalLimitmTypeScaling: String = null) extends Element with Product with Serializable
The operational meaning of a category of limits.
The operational meaning of a category of limits.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- acceptableDuration
The nominal acceptable duration of the limit. Limits are commonly expressed in terms of the time limit for which the limit is normally acceptable. The actual acceptable duration of a specific limit may depend on other local factors such as temperature or wind speed. The attribute has meaning only if the flag isInfiniteDuration is set to false, hence it shall not be exchanged when isInfiniteDuration is set to true.
- direction
The direction of the limit.
- isInfiniteDuration
Defines if the operational limit type has infinite duration. If true, the limit has infinite duration. If false, the limit has definite duration which is defined by the attribute acceptableDuration.
- OperationalLimit
OperationalLimit The operational limits associated with this type of limit.
- SourceOperationalLimitTypeScaling
OperatonalLimitTypeScaling undocumented
- TargetOperationalLimitmTypeScaling
OperatonalLimitTypeScaling undocumented
-
final
case class
OperationalRestriction(Document: Document = null, activePeriod: String = null, restrictedValue: String = null, Equipments: List[String] = null, ProductAssetModel: String = null) extends Element with Product with Serializable
A document that can be associated with equipment to describe any sort of restrictions compared with the original manufacturer's specification or with the usual operational practice e.g.
A document that can be associated with equipment to describe any sort of restrictions compared with the original manufacturer's specification or with the usual operational practice e.g. temporary maximum loadings, maximum switching current, do not operate if bus couplers are open, etc.
In the UK, for example, if a breaker or switch ever mal-operates, this is reported centrally and utilities use their asset systems to identify all the installed devices of the same manufacturer's type. They then apply operational restrictions in the operational systems to warn operators of potential problems. After appropriate inspection and maintenance, the operational restrictions may be removed.
- Document
Document Reference to the superclass object.
- activePeriod
Interval during which this restriction is applied.
- restrictedValue
Restricted (new) value; includes unit of measure and potentially multiplier.
- Equipments
Equipment All equipments to which this restriction applies.
- ProductAssetModel
ProductAssetModel Asset model to which this restriction applies.
-
final
case class
OperationalTag(Document: Document = null, Asset: String = null, PowerSystemResource: String = null, TagAction: String = null) extends Element with Product with Serializable
Operational tag placed on a power system resource or asset in the context of switching plan execution or other work in the field.
Operational tag placed on a power system resource or asset in the context of switching plan execution or other work in the field.
- Document
Document Reference to the superclass object.
- Asset
Asset Asset on which this tag has been placed.
- PowerSystemResource
PowerSystemResource Power system resource on which this tag has been placed.
- TagAction
TagAction Tag action associated with this tag.
-
final
case class
OperationalUpdatedRating(OperationalRestriction: OperationalRestriction = null, changeType: String = null, PlannedOutage: String = null) extends Element with Product with Serializable
Lowered capability because of deterioration or inadequacy (sometimes referred to as derating or partial outage) or other kind of operational rating change.
Lowered capability because of deterioration or inadequacy (sometimes referred to as derating or partial outage) or other kind of operational rating change.
- OperationalRestriction
OperationalRestriction Reference to the superclass object.
- changeType
Type of operational updated rating, e.g. a derate, a rerate or a return to normal.
- PlannedOutage
PlannedOutage Planned equipment outage with this updated rating.
-
final
case class
OperationsSafetySupervisor(Operator: Operator = null, IssuedSafetyDocuments: List[String] = null, ReleasedSafetyDocuments: List[String] = null) extends Element with Product with Serializable
Operator with responsibility that the work in high voltage installation is executed in a safe manner and according to safety regulation.
Operator with responsibility that the work in high voltage installation is executed in a safe manner and according to safety regulation.
- Operator
Operator Reference to the superclass object.
- IssuedSafetyDocuments
SafetyDocument All safety documents issued by this supervisor.
- ReleasedSafetyDocuments
SafetyDocument All safety documents released to this supervisor.
-
final
case class
OperatonalLimitTypeScaling(Element: BasicElement = null, scalingPercent: Double = 0.0, SourceOperationalLimitType: String = null, TargetOperationalLimit: String = null) extends Element with Product with Serializable
One operational limit type scales values of another operational limit type when under the same operational limit set.
One operational limit type scales values of another operational limit type when under the same operational limit set.
This applies to any operational limit assigned to the target operational limit type and without other limit dependency models.
- Element
Reference to the superclass object.
- scalingPercent
The percentage scaling of the source limit to compute the target limit. Applys to operational limits within an operaitonal limit set when both source and target operational limit types exist.
- SourceOperationalLimitType
OperationalLimitType undocumented
- TargetOperationalLimit
OperationalLimitType undocumented
-
final
case class
Operator(OperationPersonRole: OperationPersonRole = null, Incidents: List[String] = null, SwitchingSteps: List[String] = null) extends Element with Product with Serializable
Control room operator.
Control room operator.
- OperationPersonRole
OperationPersonRole Reference to the superclass object.
- Incidents
Incident All incidents owned by this operator.
- SwitchingSteps
SwitchingAction All switching steps this operator is responsible for.
-
final
case class
OrgOrgRole(OrganisationRole: OrganisationRole = null, clientID: String = null) extends Element with Product with Serializable
Roles played between Organisations and other Organisations.
Roles played between Organisations and other Organisations.
This includes role ups for ogranisations, cost centers, profit centers, regulatory reporting, etc. Note that the parent and child relationship is indicated by the name on each end of the association.
- OrganisationRole
OrganisationRole Reference to the superclass object.
- clientID
Identifiers of the organisation held by another organisation, such as a government agency (federal, state, province, city, county), financial institution (Dun and Bradstreet), etc.
-
final
case class
OrgPnodeAllocation(IdentifiedObject: IdentifiedObject = null, maxMWAllocation: Double = 0.0, Pnode: String = null) extends Element with Product with Serializable
This class models the allocation between asset owners and pricing nodes.
This class models the allocation between asset owners and pricing nodes.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- maxMWAllocation
Maximum MW for the Source/Sink for the Allocation
- Pnode
Pnode undocumented
-
final
case class
OrgResOwnership(IdentifiedObject: IdentifiedObject = null, asscType: String = null, masterSchedulingCoordinatorFlag: String = null, ownershipPercent: Double = 0.0, RegisteredResource: String = null) extends Element with Product with Serializable
This class model the ownership percent and type of ownership between resource and organisation.
This class model the ownership percent and type of ownership between resource and organisation.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- asscType
association type for the association between Organisation and Resource:
- masterSchedulingCoordinatorFlag
Flag to indicate that the SC representing the Resource is the Master SC.
- ownershipPercent
ownership percentage for each resource
- RegisteredResource
RegisteredResource undocumented
-
final
case class
Organisation(IdentifiedObject: IdentifiedObject = null, electronicAddress: String = null, phone1: String = null, phone2: String = null, postalAddress: String = null, streetAddress: String = null, ParentOrganisation: String = null, Roles: List[String] = null, SwitchingPlanRequest: List[String] = null) extends Element with Product with Serializable
Organisation that might have roles as utility, contractor, supplier, manufacturer, customer, etc.
Organisation that might have roles as utility, contractor, supplier, manufacturer, customer, etc.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- electronicAddress
ElectronicAddress Electronic address.
- phone1
TelephoneNumber Phone number.
- phone2
TelephoneNumber Additional phone number.
- postalAddress
StreetAddress Postal address, potentially different than 'streetAddress' (e.g., another city).
- streetAddress
StreetAddress Street address.
- ParentOrganisation
ParentOrganization Parent organisation of this organisation.
- Roles
OrganisationRole All roles of this organisation.
- SwitchingPlanRequest
SwitchingPlanRequest undocumented
-
final
case class
OrganisationRole(IdentifiedObject: IdentifiedObject = null, ConfigurationEvents: List[String] = null, Organisation: String = null) extends Element with Product with Serializable
Identifies a way in which an organisation may participate in the utility enterprise (e.g., customer, manufacturer, etc).
Identifies a way in which an organisation may participate in the utility enterprise (e.g., customer, manufacturer, etc).
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ConfigurationEvents
ConfigurationEvent All configuration events created for this organisation role.
- Organisation
Organisation Organisation having this role.
-
final
case class
Outage(Document: Document = null, actualPeriod: String = null, communityDescriptor: String = null, customersRestored: Int = 0, estimatedPeriod: String = null, metersAffected: Int = 0, originalCustomersServed: Int = 0, originalMetersAffected: Int = 0, outageKind: String = null, statusKind: String = null, summary: String = null, utilityDisclaimer: String = null, Crew: List[String] = null, DeEnergizedUsagePoint: List[String] = null, EnergizedUsagePoint: List[String] = null, Equipments: List[String] = null, EstimatedRestorationTime: String = null, Faults: List[String] = null, Incident: List[String] = null, OutageArea: List[String] = null, OutageIsolationEquipment: List[String] = null, PlannedSwitchActions: List[String] = null, SwitchingPlans: List[String] = null) extends Element with Product with Serializable
Document describing details of an active or planned outage in a part of the electrical network.
Document describing details of an active or planned outage in a part of the electrical network.
A non-planned outage may be created upon: - a breaker trip, - a fault indicator status change, - a meter event indicating customer outage, - a reception of one or more customer trouble calls, or - an operator command, reflecting information obtained from the field crew. Outage restoration may be performed using a switching plan which complements the outage information with detailed switching activities, including the relationship to the crew and work. A planned outage may be created upon: - a request for service, maintenance or construction work in the field, or - an operator-defined outage for what-if/contingency network analysis.
- Document
Document Reference to the superclass object.
- actualPeriod
Actual outage period; end of the period corresponds to the actual restoration time.
- communityDescriptor
a name to denote the community - this could be a name or a code of some kind.
- customersRestored
number of customers that have been restored in the area.
- estimatedPeriod
Estimated outage period for a planned outage. The start of the period is the start of the planned outage and the end of the period corresponds to the end of the planned outage.
- metersAffected
The updated number of meters affected by the outage as reported by the OMS within the utility. It is assumed this number will be updated repeatedly until the full outage is resolved.
- originalCustomersServed
the total number of customers that are served in the area (both outaged and not outaged).
- originalMetersAffected
The original number of meters that were affected as reported by the OMS within the utility. That is, this is the total number of meters that were out at the beginning of the outage.
- outageKind
Defines if the outage has been verified or is only estimated
- statusKind
defines the status of the crew as in dispatched or arrived, etc.
- summary
ServicePointOutageSummary Summary counts of service points (customers) affected by this outage.
- utilityDisclaimer
This contains an disclaimers the utility would like to place on the data provided to any stakeholder. This may be different for different stakeholders. This should possibly be an attribute under the Organization class but it is placed here for now.
- Crew
Crew undocumented
- DeEnergizedUsagePoint
UsagePoint all deenergized useage points associated with the outage.
- EnergizedUsagePoint
UsagePoint All energized usage points associated with this outage.
- Equipments
Equipment All equipments associated with this outage.
- EstimatedRestorationTime
EstimatedRestorationTime undocumented
- Faults
Fault All faults involved in this outage.
- Incident
Incident Incident reported in trouble call that results in this outage.
- OutageArea
OutageArea undocumented
- OutageIsolationEquipment
ConductingEquipment undocumented
- PlannedSwitchActions
SwitchAction All switch actions to apply within the scope of this planned outage. Each such action groups switches to which the action is to apply in order to produce the desired network state considered as outage.
- SwitchingPlans
SwitchingPlan All switching plans that lead to supply restoration due to this outage. Only one will be retained for execution.
-
final
case class
OutageArea(Element: BasicElement = null, earliestReportedTime: String = null, metersServed: Int = 0, outageAreaKind: String = null, Outage: List[String] = null) extends Element with Product with Serializable
This defines the area covered by the Outage.
This defines the area covered by the Outage.
- Element
Reference to the superclass object.
- earliestReportedTime
This is the reported time of the first outage report
- metersServed
defines the number of meters served in the defined area.
- outageAreaKind
defines the type of area that has the outage - county, state, zipcode, etc.
- Outage
Outage undocumented
-
final
case class
OutageOrder(Document: Document = null, comment: String = null, Location: List[String] = null, OutagePlan: String = null) extends Element with Product with Serializable
Transmits an outage plan to a crew in order for the planned outage to be executed.
Transmits an outage plan to a crew in order for the planned outage to be executed.
- Document
Document Reference to the superclass object.
- comment
Free-form comment associated with the outage order
- Location
Location undocumented
- OutagePlan
OutagePlan undocumented
-
final
case class
OutagePlan(Document: Document = null, approvedDateTime: String = null, cancelledDateTime: String = null, plannedPeriod: String = null, purpose: String = null, Customer: List[String] = null, OutageOrder: String = null, PlannedOutage: String = null, SwitchingPlan: String = null) extends Element with Product with Serializable
Document containing the definition of planned outages of equipment and/or usage points.
Document containing the definition of planned outages of equipment and/or usage points.
It will reference switching plans that are used to execute the planned outage.
- Document
Document Reference to the superclass object.
- approvedDateTime
The date and time the outage plan was approved
- cancelledDateTime
Date and Time the planned outage was canceled.
- plannedPeriod
planned start and end time of the planned outage.
- purpose
Purpose of this outage plan, such as whether it is to replace equipment or perform maintenance or repairs or to reconfigure network topology.
- Customer
Customer The customers that are affected by this planned outage.
- OutageOrder
OutageOrder undocumented
- PlannedOutage
PlannedOutage The outage resulting from the execution of the outage plan.
- SwitchingPlan
SwitchingPlan The swiching plan that is associated with the outage plan.
-
final
case class
OverexcLim2(OverexcitationLimiterDynamics: OverexcitationLimiterDynamics = null, ifdlim: Double = 0.0, koi: Double = 0.0, voimax: Double = 0.0, voimin: Double = 0.0) extends Element with Product with Serializable
Different from LimIEEEOEL, LimOEL2 has a fixed pickup threshold and reduces the excitation set-point by means of a non-windup integral regulator.
Different from LimIEEEOEL, LimOEL2 has a fixed pickup threshold and reduces the excitation set-point by means of a non-windup integral regulator.
Irated is the rated machine excitation current (calculated from nameplate conditions: Vnom, Pnom, CosPhinom).
- OverexcitationLimiterDynamics
OverexcitationLimiterDynamics Reference to the superclass object.
- ifdlim
Limit value of rated field current (IFDLIM). Typical value = 1,05.
- koi
Gain Over excitation limiter (KOI). Typical value = 0,1.
- voimax
Maximum error signal (VOIMAX) (> OverexcLim2.voimin). Typical value = 0.
- voimin
Minimum error signal (VOIMIN) (< OverexcLim2.voimax). Typical value = -9999.
-
final
case class
OverexcLimIEEE(OverexcitationLimiterDynamics: OverexcitationLimiterDynamics = null, hyst: Double = 0.0, ifdlim: Double = 0.0, ifdmax: Double = 0.0, itfpu: Double = 0.0, kcd: Double = 0.0, kramp: Double = 0.0) extends Element with Product with Serializable
The over excitation limiter model is intended to represent the significant features of OELs necessary for some large-scale system studies.
The over excitation limiter model is intended to represent the significant features of OELs necessary for some large-scale system studies.
It is the result of a pragmatic approach to obtain a model that can be widely applied with attainable data from generator owners. An attempt to include all variations in the functionality of OELs and duplicate how they interact with the rest of the excitation systems would likely result in a level of application insufficient for the studies for which they are intended. Reference: IEEE OEL 421.5-2005, 9.
- OverexcitationLimiterDynamics
OverexcitationLimiterDynamics Reference to the superclass object.
- hyst
OEL pickup/drop-out hysteresis (HYST). Typical value = 0,03.
- ifdlim
OEL timed field current limit (IFDLIM). Typical value = 1,05.
- ifdmax
OEL instantaneous field current limit (IFDMAX). Typical value = 1,5.
- itfpu
OEL timed field current limiter pickup level (ITFPU). Typical value = 1,05.
- kcd
OEL cooldown gain (KCD). Typical value = 1.
- kramp
OEL ramped limit rate (KRAMP). Unit = PU / s. Typical value = 10.
-
final
case class
OverexcLimX1(OverexcitationLimiterDynamics: OverexcitationLimiterDynamics = null, efd1: Double = 0.0, efd2: Double = 0.0, efd3: Double = 0.0, efddes: Double = 0.0, efdrated: Double = 0.0, kmx: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, vlow: Double = 0.0) extends Element with Product with Serializable
Field voltage over excitation limiter.
Field voltage over excitation limiter.
- OverexcitationLimiterDynamics
OverexcitationLimiterDynamics Reference to the superclass object.
- efd1
Low voltage point on the inverse time characteristic (EFD1). Typical value = 1,1.
- efd2
Mid voltage point on the inverse time characteristic (EFD2). Typical value = 1,2.
- efd3
High voltage point on the inverse time characteristic (EFD3). Typical value = 1,5.
- efddes
Desired field voltage (EFDDES). Typical value = 0,9.
- efdrated
Rated field voltage (EFDRATED). Typical value = 1,05.
- kmx
Gain (KMX). Typical value = 0,01.
- t1
Time to trip the exciter at the low voltage point on the inverse time characteristic (TIME1) (>= 0). Typical value = 120.
- t2
Time to trip the exciter at the mid voltage point on the inverse time characteristic (TIME2) (>= 0). Typical value = 40.
- t3
Time to trip the exciter at the high voltage point on the inverse time characteristic (TIME3) (>= 0). Typical value = 15.
- vlow
Low voltage limit (VLOW) (> 0).
-
final
case class
OverexcLimX2(OverexcitationLimiterDynamics: OverexcitationLimiterDynamics = null, efd1: Double = 0.0, efd2: Double = 0.0, efd3: Double = 0.0, efddes: Double = 0.0, efdrated: Double = 0.0, kmx: Double = 0.0, m: Boolean = false, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, vlow: Double = 0.0) extends Element with Product with Serializable
Field voltage or current overexcitation limiter designed to protect the generator field of an AC machine with automatic excitation control from overheating due to prolonged overexcitation.
Field voltage or current overexcitation limiter designed to protect the generator field of an AC machine with automatic excitation control from overheating due to prolonged overexcitation.
- OverexcitationLimiterDynamics
OverexcitationLimiterDynamics Reference to the superclass object.
- efd1
Low voltage or current point on the inverse time characteristic (EFD1). Typical value = 1,1.
- efd2
Mid voltage or current point on the inverse time characteristic (EFD2). Typical value = 1,2.
- efd3
High voltage or current point on the inverse time characteristic (EFD3). Typical value = 1,5.
- efddes
Desired field voltage if m = false or desired field current if m = true (EFDDES). Typical value = 1.
- efdrated
Rated field voltage if m = false or rated field current if m = true (EFDRATED). Typical value = 1,05.
- kmx
Gain (KMX). Typical value = 0,002.
- m
(m). true = IFD limiting false = EFD limiting.
- t1
Time to trip the exciter at the low voltage or current point on the inverse time characteristic (TIME1) (>= 0). Typical value = 120.
- t2
Time to trip the exciter at the mid voltage or current point on the inverse time characteristic (TIME2) (>= 0). Typical value = 40.
- t3
Time to trip the exciter at the high voltage or current point on the inverse time characteristic (TIME3) (>= 0). Typical value = 15.
- vlow
Low voltage limit (VLOW) (> 0).
-
final
case class
OverexcitationLimiterDynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null, ExcitationSystemDynamics: String = null) extends Element with Product with Serializable
Overexcitation limiter function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
Overexcitation limiter function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- ExcitationSystemDynamics
ExcitationSystemDynamics Excitation system model with which this overexcitation limiter model is associated.
-
final
case class
OverexcitationLimiterUserDefined(OverexcitationLimiterDynamics: OverexcitationLimiterDynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Overexcitation limiter system function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
Overexcitation limiter system function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
- OverexcitationLimiterDynamics
OverexcitationLimiterDynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
OverheadCost(WorkIdentifiedObject: WorkIdentifiedObject = null, code: String = null, cost: Double = 0.0, status: String = null, WorkCostDetails: List[String] = null, WorkTasks: List[String] = null) extends Element with Product with Serializable
Overhead cost applied to work order.
Overhead cost applied to work order.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- code
Overhead code.
- cost
The overhead cost to be applied.
- status
undocumented
- WorkCostDetails
WorkCostDetail undocumented
- WorkTasks
OldWorkTask undocumented
-
final
case class
OverheadWireInfo(WireInfo: WireInfo = null) extends Element with Product with Serializable
Overhead wire data.
Overhead wire data.
- WireInfo
WireInfo Reference to the superclass object.
-
final
case class
Ownership(IdentifiedObject: IdentifiedObject = null, share: Double = 0.0, Asset: String = null, AssetOwner: String = null) extends Element with Product with Serializable
Ownership of e.g.
Ownership of e.g. asset.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- share
Share of this ownership.
- Asset
Asset Asset that is object of this ownership.
- AssetOwner
AssetOwner Asset owner that is subject in this ownership.
-
final
case class
PFVArControllerType1Dynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null, ExcitationSystemDynamics: String = null, RemoteInputSignal: String = null, VoltageAdjusterDynamics: String = null) extends Element with Product with Serializable
Power factor or VAr controller type 1 function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
Power factor or VAr controller type 1 function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- ExcitationSystemDynamics
ExcitationSystemDynamics Excitation system model with which this power actor or VAr controller type 1 model is associated.
- RemoteInputSignal
RemoteInputSignal Remote input signal used by this power factor or VAr controller type 1 model.
- VoltageAdjusterDynamics
VoltageAdjusterDynamics Voltage adjuster model associated with this power factor or VAr controller type 1 model.
-
final
case class
PFVArControllerType1UserDefined(PFVArControllerType1Dynamics: PFVArControllerType1Dynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Power factor or VAr controller type 1 function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
Power factor or VAr controller type 1 function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
- PFVArControllerType1Dynamics
PFVArControllerType1Dynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
PFVArControllerType2Dynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null, ExcitationSystemDynamics: String = null) extends Element with Product with Serializable
Power factor or VAr controller type 2 function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
Power factor or VAr controller type 2 function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- ExcitationSystemDynamics
ExcitationSystemDynamics Excitation system model with which this power factor or VAr controller type 2 is associated.
-
final
case class
PFVArControllerType2UserDefined(PFVArControllerType2Dynamics: PFVArControllerType2Dynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Power factor or VAr controller type 2 function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
Power factor or VAr controller type 2 function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
- PFVArControllerType2Dynamics
PFVArControllerType2Dynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
PFVArType1IEEEPFController(PFVArControllerType1Dynamics: PFVArControllerType1Dynamics = null, ovex: Boolean = false, tpfc: Double = 0.0, vitmin: Double = 0.0, vpf: Double = 0.0, vpfcbw: Double = 0.0, vpfref: Double = 0.0, vvtmax: Double = 0.0, vvtmin: Double = 0.0) extends Element with Product with Serializable
IEEE PF controller type 1 which operates by moving the voltage reference directly.
IEEE PF controller type 1 which operates by moving the voltage reference directly.
Reference: IEEE 421.5-2005, 11.2.
- PFVArControllerType1Dynamics
PFVArControllerType1Dynamics Reference to the superclass object.
- ovex
Overexcitation Flag (OVEX) true = overexcited false = underexcited.
- tpfc
PF controller time delay (TPFC) (>= 0). Typical value = 5.
- vitmin
Minimum machine terminal current needed to enable pf/var controller (VITMIN).
- vpf
Synchronous machine power factor (VPF).
- vpfcbw
PF controller deadband (VPFC_BW). Typical value = 0,05.
- vpfref
PF controller reference (VPFREF).
- vvtmax
Maximum machine terminal voltage needed for pf/var controller to be enabled (VVTMAX) (> PFVArType1IEEEPFController.vvtmin).
- vvtmin
Minimum machine terminal voltage needed to enable pf/var controller (VVTMIN) (< PFVArType1IEEEPFController.vvtmax).
-
final
case class
PFVArType1IEEEVArController(PFVArControllerType1Dynamics: PFVArControllerType1Dynamics = null, tvarc: Double = 0.0, vvar: Double = 0.0, vvarcbw: Double = 0.0, vvarref: Double = 0.0, vvtmax: Double = 0.0, vvtmin: Double = 0.0) extends Element with Product with Serializable
IEEE VAR controller type 1 which operates by moving the voltage reference directly.
IEEE VAR controller type 1 which operates by moving the voltage reference directly.
Reference: IEEE 421.5-2005, 11.3.
- PFVArControllerType1Dynamics
PFVArControllerType1Dynamics Reference to the superclass object.
- tvarc
Var controller time delay (TVARC) (>= 0). Typical value = 5.
- vvar
Synchronous machine power factor (VVAR).
- vvarcbw
Var controller deadband (VVARC_BW). Typical value = 0,02.
- vvarref
Var controller reference (VVARREF).
- vvtmax
Maximum machine terminal voltage needed for pf/VAr controller to be enabled (VVTMAX) (> PVFArType1IEEEVArController.vvtmin).
- vvtmin
Minimum machine terminal voltage needed to enable pf/var controller (VVTMIN) (< PVFArType1IEEEVArController.vvtmax).
-
final
case class
PFVArType2Common1(PFVArControllerType2Dynamics: PFVArControllerType2Dynamics = null, j: Boolean = false, ki: Double = 0.0, kp: Double = 0.0, max: Double = 0.0, ref: Double = 0.0) extends Element with Product with Serializable
Power factor / reactive power regulator.
Power factor / reactive power regulator.
This model represents the power factor or reactive power controller such as the Basler SCP-250. The controller measures power factor or reactive power (PU on generator rated power) and compares it with the operator's set point. [Footnote: Basler SCP-250 is an example of a suitable product available commercially. This information is given for the convenience of users of this document and does not constitute an endorsement by IEC of this product.]
- PFVArControllerType2Dynamics
PFVArControllerType2Dynamics Reference to the superclass object.
- j
Selector (J). true = control mode for reactive power false = control mode for power factor.
- ki
Reset gain (Ki).
- kp
Proportional gain (Kp).
- max
Output limit (max).
- ref
Reference value of reactive power or power factor (Ref). The reference value is initialised by this model. This initialisation can override the value exchanged by this attribute to represent a plant operator's change of the reference setting.
-
final
case class
PFVArType2IEEEPFController(PFVArControllerType2Dynamics: PFVArControllerType2Dynamics = null, exlon: Boolean = false, ki: Double = 0.0, kp: Double = 0.0, pfref: Double = 0.0, vclmt: Double = 0.0, vref: Double = 0.0, vs: Double = 0.0) extends Element with Product with Serializable
IEEE PF controller type 2 which is a summing point type controller making up the outside loop of a two-loop system.
IEEE PF controller type 2 which is a summing point type controller making up the outside loop of a two-loop system.
This controller is implemented as a slow PI type controller. The voltage regulator forms the inner loop and is implemented as a fast controller. Reference: IEEE 421.5-2005, 11.4.
- PFVArControllerType2Dynamics
PFVArControllerType2Dynamics Reference to the superclass object.
- exlon
Overexcitation or under excitation flag (EXLON) true = 1 (not in the overexcitation or underexcitation state, integral action is active) false = 0 (in the overexcitation or underexcitation state, so integral action is disabled to allow the limiter to play its role).
- ki
Integral gain of the pf controller (KI). Typical value = 1.
- kp
Proportional gain of the pf controller (KP). Typical value = 1.
- pfref
Power factor reference (PFREF).
- vclmt
Maximum output of the pf controller (VCLMT). Typical value = 0,1.
- vref
Voltage regulator reference (VREF).
- vs
Generator sensing voltage (VS).
-
final
case class
PFVArType2IEEEVArController(PFVArControllerType2Dynamics: PFVArControllerType2Dynamics = null, exlon: Boolean = false, ki: Double = 0.0, kp: Double = 0.0, qref: Double = 0.0, vclmt: Double = 0.0, vref: Double = 0.0, vs: Double = 0.0) extends Element with Product with Serializable
IEEE VAR controller type 2 which is a summing point type controller.
IEEE VAR controller type 2 which is a summing point type controller.
It makes up the outside loop of a two-loop system. This controller is implemented as a slow PI type controller, and the voltage regulator forms the inner loop and is implemented as a fast controller. Reference: IEEE 421.5-2005, 11.5.
- PFVArControllerType2Dynamics
PFVArControllerType2Dynamics Reference to the superclass object.
- exlon
Overexcitation or under excitation flag (EXLON) true = 1 (not in the overexcitation or underexcitation state, integral action is active) false = 0 (in the overexcitation or underexcitation state, so integral action is disabled to allow the limiter to play its role).
- ki
Integral gain of the pf controller (KI).
- kp
Proportional gain of the pf controller (KP).
- qref
Reactive power reference (QREF).
- vclmt
Maximum output of the pf controller (VCLMT).
- vref
Voltage regulator reference (VREF).
- vs
Generator sensing voltage (VS).
- final case class PFmode(Element: BasicElement = null, Delay: String = null, VSCtype1: String = null) extends Element with Product with Serializable
-
final
case class
PSREvent(ActivityRecord: ActivityRecord = null, kind: String = null, PowerSystemResource: String = null) extends Element with Product with Serializable
Event recording the change in operational status of a power system resource; may be for an event that has already occurred or for a planned activity.
Event recording the change in operational status of a power system resource; may be for an event that has already occurred or for a planned activity.
- ActivityRecord
ActivityRecord Reference to the superclass object.
- kind
Kind of event.
- PowerSystemResource
PowerSystemResource Power system resource that generated this event.
-
final
case class
PSRType(IdentifiedObject: IdentifiedObject = null, PowerSystemResources: List[String] = null) extends Element with Product with Serializable
Classifying instances of the same class, e.g.
Classifying instances of the same class, e.g. overhead and underground ACLineSegments.
This classification mechanism is intended to provide flexibility outside the scope of this document, i.e. provide customisation that is non standard.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- PowerSystemResources
PowerSystemResource Power system resources classified with this power system resource type.
-
final
case class
PWRSteamSupply(SteamSupply: SteamSupply = null, coldLegFBLagTC: Double = 0.0, coldLegFBLeadTC1: Double = 0.0, coldLegFBLeadTC2: Double = 0.0, coldLegFG1: Double = 0.0, coldLegFG2: Double = 0.0, coldLegLagTC: Double = 0.0, coreHTLagTC1: Double = 0.0, coreHTLagTC2: Double = 0.0, coreNeutronicsEffTC: Double = 0.0, coreNeutronicsHT: Double = 0.0, feedbackFactor: Double = 0.0, hotLegLagTC: Double = 0.0, hotLegSteamGain: Double = 0.0, hotLegToColdLegGain: Double = 0.0, pressureCG: Double = 0.0, steamFlowFG: Double = 0.0, steamPressureDropLagTC: Double = 0.0, steamPressureFG: Double = 0.0, throttlePressureFactor: Double = 0.0, throttlePressureSP: Double = 0.0) extends Element with Product with Serializable
Pressurized water reactor used as a steam supply to a steam turbine.
Pressurized water reactor used as a steam supply to a steam turbine.
- SteamSupply
SteamSupply Reference to the superclass object.
- coldLegFBLagTC
Cold leg feedback lag time constant.
- coldLegFBLeadTC1
Cold leg feedback lead time constant.
- coldLegFBLeadTC2
Cold leg feedback lead time constant.
- coldLegFG1
Cold leg feedback gain 1.
- coldLegFG2
Cold leg feedback gain 2.
- coldLegLagTC
Cold leg lag time constant.
- coreHTLagTC1
Core heat transfer lag time constant.
- coreHTLagTC2
Core heat transfer lag time constant.
- coreNeutronicsEffTC
Core neutronics effective time constant.
- coreNeutronicsHT
Core neutronics and heat transfer.
- feedbackFactor
Feedback factor.
- hotLegLagTC
Hot leg lag time constant.
- hotLegSteamGain
Hot leg steam gain.
- hotLegToColdLegGain
Hot leg to cold leg gain.
- pressureCG
Pressure control gain.
- steamFlowFG
Steam flow feedback gain.
- steamPressureDropLagTC
Steam pressure drop lag time constant.
- steamPressureFG
Steam pressure feedback gain.
- throttlePressureFactor
Throttle pressure factor.
- throttlePressureSP
Throttle pressure setpoint.
-
final
case class
PackageDependenciesCIMVersion(Element: BasicElement = null, date: String = null, version: String = null) extends Element with Product with Serializable
The version of dependencies description among top level subpackages of the combined CIM model.
The version of dependencies description among top level subpackages of the combined CIM model.
This is not the same as the combined packages version.
- Element
Reference to the superclass object.
- date
Date of last change to the main package dependencies in format YYYY-MM-DD. This is updated when the version attribute is updated.
- version
The version of the main subpackages of the combined CIM model. The format is simply an integer. The version (and date) initial values should be updated any time the dependencies in the model change and require an actual change to the diagrams within this package.
-
final
case class
PanDemandResponse(EndDeviceAction: EndDeviceAction = null, appliance: String = null, avgLoadAdjustment: Double = 0.0, cancelControlMode: String = null, cancelDateTime: String = null, cancelNow: Boolean = false, coolingOffset: Double = 0.0, coolingSetpoint: Double = 0.0, criticalityLevel: String = null, dutyCycle: Double = 0.0, enrollmentGroup: String = null, heatingOffset: Double = 0.0, heatingSetpoint: Double = 0.0) extends Element with Product with Serializable
PAN control used to issue action/command to PAN devices during a demand response/load control event.
PAN control used to issue action/command to PAN devices during a demand response/load control event.
- EndDeviceAction
EndDeviceAction Reference to the superclass object.
- appliance
ControlledAppliance Appliance being controlled.
- avgLoadAdjustment
Used to define a maximum energy usage limit as a percentage of the client implementations specific average energy usage. The load adjustment percentage is added to 100% creating a percentage limit applied to the client implementations specific average energy usage. A -10% load adjustment percentage will establish an energy usage limit equal to 90% of the client implementations specific average energy usage. Each load adjustment percentage is referenced to the client implementations specific average energy usage. There are no cumulative effects. The range of this field is -100% to +100% with a resolution of 1. A -100% value equals a total load shed. A +100% value will limit the energy usage to the client implementations specific average energy usage.
- cancelControlMode
Encoding of cancel control.
- cancelDateTime
Timestamp when a canceling of the event is scheduled to start.
- cancelNow
If true, a canceling of the event should start immediately.
- coolingOffset
Requested offset to apply to the normal cooling setpoint at the time of the start of the event. It represents a temperature change that will be applied to the associated cooling set point. The temperature offsets will be calculated per the local temperature in the thermostat. The calculated temperature will be interpreted as the number of degrees to be added to the cooling set point. Sequential demand response events are not cumulative. The offset shall be applied to the normal setpoint.
- coolingSetpoint
Requested cooling set point. Temperature set point is typically defined and calculated based on local temperature.
- criticalityLevel
Level of criticality for the action of this control. The action taken by load control devices for an event can be solely based on this value, or in combination with other load control event fields supported by the device.
- dutyCycle
Maximum "on" state duty cycle as a percentage of time. For example, if the value is 80, the device would be in an "on" state for 80% of the time for the duration of the action.
- enrollmentGroup
Provides a mechanism to direct load control actions to groups of PAN devices. It can be used in conjunction with the PAN device types.
- heatingOffset
Requested offset to apply to the normal heating setpoint at the time of the start of the event. It represents a temperature change that will be applied to the associated heating set point. The temperature offsets will be calculated per the local temperature in the thermostat. The calculated temperature will be interpreted as the number of degrees to be subtracted from the heating set point. Sequential demand response events are not cumulative. The offset shall be applied to the normal setpoint.
- heatingSetpoint
Requested heating set point. Temperature set point is typically defined and calculated based on local temperature.
-
final
case class
PanDisplay(EndDeviceAction: EndDeviceAction = null, confirmationRequired: Boolean = false, priority: String = null, textMessage: String = null, transmissionMode: String = null) extends Element with Product with Serializable
PAN action/command used to issue the displaying of text messages on PAN devices.
PAN action/command used to issue the displaying of text messages on PAN devices.
- EndDeviceAction
EndDeviceAction Reference to the superclass object.
- confirmationRequired
If true, the requesting entity (e.g. retail electric provider) requires confirmation of the successful display of the text message.
- priority
Priority associated with the text message to be displayed.
- textMessage
Text to be displayed by a PAN device.
- transmissionMode
Transmission mode to be used for this PAN display control.
-
final
case class
PanPricing(EndDeviceAction: EndDeviceAction = null, providerID: Int = 0, PanPricingDetails: List[String] = null) extends Element with Product with Serializable
PAN action/command used to issue pricing information to a PAN device.
PAN action/command used to issue pricing information to a PAN device.
- EndDeviceAction
EndDeviceAction Reference to the superclass object.
- providerID
Unique identifier for the commodity provider.
- PanPricingDetails
PanPricingDetail All pricing details issued by this PAN pricing command/action.
-
final
case class
PanPricingDetail(Element: BasicElement = null, alternateCostDelivered: Double = 0.0, alternateCostUnit: String = null, currentTimeDate: String = null, generationPrice: Double = 0.0, generationPriceRatio: Double = 0.0, price: Double = 0.0, priceRatio: Double = 0.0, priceTier: Int = 0, priceTierCount: Int = 0, priceTierLabel: String = null, rateLabel: String = null, registerTier: String = null, unitOfMeasure: String = null, PanPricing: String = null) extends Element with Product with Serializable
Detail for a single price command/action.
Detail for a single price command/action.
- Element
Reference to the superclass object.
- alternateCostDelivered
Alternative measure of the cost of the energy consumed. An example might be the emissions of CO2 for each kWh of electricity consumed providing a measure of the environmental cost.
- alternateCostUnit
Cost unit for the alternate cost delivered field. One example is kg of CO2 per unit of measure.
- currentTimeDate
Current time as determined by a PAN device.
- generationPrice
Price of the commodity measured in base unit of currency per 'unitOfMeasure'.
- generationPriceRatio
Ratio of 'generationPrice' to the "normal" price chosen by the commodity provider.
- price
Price of the commodity measured in base unit of currency per 'unitOfMeasure'.
- priceRatio
Ratio of 'price' to the "normal" price chosen by the commodity provider.
- priceTier
Pricing tier as chosen by the commodity provider.
- priceTierCount
Maximum number of price tiers available.
- priceTierLabel
Label for price tier.
- rateLabel
Label of the current billing rate specified by commodity provider.
- registerTier
Register tier accumulating usage information.
- unitOfMeasure
Defines commodity as well as its base unit of measure.
- PanPricing
PanPricing PAN pricing command/action issuing this price detail.
- final case class ParentOrganization(Organisation: Organisation = null, Organisation_attr: List[String] = null) extends Element with Product with Serializable
-
final
case class
Participation(IdentifiedObject: IdentifiedObject = null, factor: Double = 0.0) extends Element with Product with Serializable
Participation level of a given Pnode in a given AggregatePnode.
Participation level of a given Pnode in a given AggregatePnode.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- factor
Used to calculate "participation" of Pnode in an AggregatePnode. For example, for regulation region this factor is 1 and total sum of all factors for a specific regulation region does not have to be 1. For pricing zone the total sum of all factors has to be 1.
-
final
case class
PassThroughBill(Document: Document = null, adjustedAmount: Double = 0.0, amount: Double = 0.0, billEnd: String = null, billRunType: String = null, billStart: String = null, billedTo: String = null, effectiveDate: String = null, isDisputed: Boolean = false, isProfiled: Boolean = false, paidTo: String = null, previousEnd: String = null, previousStart: String = null, price: Double = 0.0, productCode: String = null, providedBy: String = null, quantity: String = null, serviceEnd: String = null, serviceStart: String = null, soldTo: String = null, taxAmount: Double = 0.0, timeZone: String = null, tradeDate: String = null, transactionDate: String = null, transactionType: String = null, ChargeProfiles: List[String] = null, MarketStatementLineItem: String = null, MktUserAttribute: List[String] = null) extends Element with Product with Serializable
Pass Through Bill is used for: 1)Two sided charge transactions with or without ISO involvement 2) Specific direct charges or payments that are calculated outside or provided directly to settlements
Pass Through Bill is used for: 1)Two sided charge transactions with or without ISO involvement 2) Specific direct charges or payments that are calculated outside or provided directly to settlements
3) Specific charge bill determinants that are externally supplied and used in charge calculations
- Document
Document Reference to the superclass object.
- adjustedAmount
undocumented
- amount
The charge amount of the product/service.
- billEnd
Bill period end date
- billRunType
The settlement run type, for example: prelim, final, and rerun.
- billStart
Bill period start date
- billedTo
The company to which the PTB transaction is billed.
- effectiveDate
The effective date of the transaction
- isDisputed
Disputed transaction indicator
- isProfiled
A flag indicating whether there is a profile data associated with the PTB.
- paidTo
The company to which the PTB transaction is paid.
- previousEnd
The previous bill period end date
- previousStart
The previous bill period start date
- price
The price of product/service.
- productCode
The product identifier for determining the charge type of the transaction.
- providedBy
The company by which the PTB transaction service is provided.
- quantity
The product quantity.
- serviceEnd
The end date of service provided, if periodic.
- serviceStart
The start date of service provided, if periodic.
- soldTo
The company to which the PTB transaction is sold.
- taxAmount
The tax on services taken.
- timeZone
The time zone code
- tradeDate
The trade date
- transactionDate
The date the transaction occurs.
- transactionType
The type of transaction. For example, charge customer, bill customer, matching AR/AP, or bill determinant
- ChargeProfiles
ChargeProfile undocumented
- MarketStatementLineItem
MarketStatementLineItem undocumented
- MktUserAttribute
MktUserAttribute undocumented
- final case class Pcontrol(Element: BasicElement = null, Delay: String = null, VSCtype1: String = null) extends Element with Product with Serializable
-
final
case class
PendingCalculation(Element: BasicElement = null, multiplyBeforeAdd: Boolean = false, offset: Int = 0, scalarDenominator: Int = 0, scalarFloat: Double = 0.0, scalarNumerator: Int = 0, IntervalBlocks: List[String] = null, ReadingType: String = null) extends Element with Product with Serializable
When present, a scalar conversion that needs to be applied to every IntervalReading.value contained in IntervalBlock.
When present, a scalar conversion that needs to be applied to every IntervalReading.value contained in IntervalBlock.
This conversion results in a new associated ReadingType, reflecting the true dimensions of IntervalReading values after the conversion.
- Element
Reference to the superclass object.
- multiplyBeforeAdd
Whether scalars should be applied before adding the 'offset'.
- offset
(if applicable) Offset to be added as well as multiplication using scalars.
- scalarDenominator
(if scalar is rational number) When 'IntervalReading.value' is multiplied by 'scalarNumerator' and divided by this value, it causes a unit of measure conversion to occur, resulting in the 'ReadingType.unit'.
- scalarFloat
(if scalar is floating number) When multiplied with 'IntervalReading.value', it causes a unit of measure conversion to occur, according to the 'ReadingType.unit'.
- scalarNumerator
(if scalar is integer or rational number) When the scalar is a simple integer, and this attribute is presented alone and multiplied with 'IntervalReading.value', it causes a unit of measure conversion to occur, resulting in the 'ReadingType.unit'. It is never used in conjunction with 'scalarFloat', only with 'scalarDenominator'.
- IntervalBlocks
IntervalBlock All blocks of interval reading values to which this pending conversion applies.
- ReadingType
ReadingType Reading type resulting from this pending conversion.
-
final
case class
PenstockLossCurve(Curve: Curve = null, HydroGeneratingUnit: String = null) extends Element with Product with Serializable
Relationship between penstock head loss (in meters) and total discharge through the penstock (in cubic meters per second).
Relationship between penstock head loss (in meters) and total discharge through the penstock (in cubic meters per second).
One or more turbines may be connected to the same penstock.
- Curve
Curve Reference to the superclass object.
- HydroGeneratingUnit
HydroGeneratingUnit A hydro generating unit has a penstock loss curve.
-
final
case class
PerLengthDCLineParameter(PerLengthLineParameter: PerLengthLineParameter = null, capacitance: Double = 0.0, inductance: Double = 0.0, resistance: Double = 0.0, DCLineSegments: List[String] = null) extends Element with Product with Serializable
Common type for per-length electrical catalogues describing DC line parameters.
Common type for per-length electrical catalogues describing DC line parameters.
- PerLengthLineParameter
PerLengthLineParameter Reference to the superclass object.
- capacitance
Capacitance per unit of length of the DC line segment; significant for cables only.
- inductance
Inductance per unit of length of the DC line segment.
- resistance
Resistance per length of the DC line segment.
- DCLineSegments
DCLineSegment All line segments described by this set of per-length parameters.
-
final
case class
PerLengthImpedance(PerLengthLineParameter: PerLengthLineParameter = null, ACLineSegments: List[String] = null) extends Element with Product with Serializable
Common type for per-length impedance electrical catalogues.
Common type for per-length impedance electrical catalogues.
- PerLengthLineParameter
PerLengthLineParameter Reference to the superclass object.
- ACLineSegments
ACLineSegment All line segments described by this per-length impedance.
-
final
case class
PerLengthLineParameter(IdentifiedObject: IdentifiedObject = null, WireAssemblyInfo: String = null) extends Element with Product with Serializable
Common type for per-length electrical catalogues describing line parameters.
Common type for per-length electrical catalogues describing line parameters.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- WireAssemblyInfo
WireAssemblyInfo undocumented
-
final
case class
PerLengthPhaseImpedance(PerLengthImpedance: PerLengthImpedance = null, conductorCount: Int = 0, PhaseImpedanceData: List[String] = null) extends Element with Product with Serializable
Impedance and admittance parameters per unit length for n-wire unbalanced lines, in matrix form.
Impedance and admittance parameters per unit length for n-wire unbalanced lines, in matrix form.
- PerLengthImpedance
PerLengthImpedance Reference to the superclass object.
- conductorCount
Number of phase, neutral, and other wires retained. Constrains the number of matrix elements and the phase codes that can be used with this matrix.
- PhaseImpedanceData
PhaseImpedanceData All data that belong to this conductor phase impedance.
-
final
case class
PerLengthSequenceImpedance(PerLengthImpedance: PerLengthImpedance = null, b0ch: Double = 0.0, bch: Double = 0.0, g0ch: Double = 0.0, gch: Double = 0.0, r: Double = 0.0, r0: Double = 0.0, x: Double = 0.0, x0: Double = 0.0) extends Element with Product with Serializable
Sequence impedance and admittance parameters per unit length, for transposed lines of 1, 2, or 3 phases.
Sequence impedance and admittance parameters per unit length, for transposed lines of 1, 2, or 3 phases.
For 1-phase lines, define x=x0=xself. For 2-phase lines, define x=xs-xm and x0=xs+xm.
- PerLengthImpedance
PerLengthImpedance Reference to the superclass object.
- b0ch
Zero sequence shunt (charging) susceptance, per unit of length.
- bch
Positive sequence shunt (charging) susceptance, per unit of length.
- g0ch
Zero sequence shunt (charging) conductance, per unit of length.
- gch
Positive sequence shunt (charging) conductance, per unit of length.
- r
Positive sequence series resistance, per unit of length.
- r0
Zero sequence series resistance, per unit of length.
- x
Positive sequence series reactance, per unit of length.
- x0
Zero sequence series reactance, per unit of length.
-
final
case class
Period(Element: BasicElement = null, resolution: String = null, timeInterval: String = null, MarketDocument: List[String] = null, Point: List[String] = null, Reason: List[String] = null, TimeSeries: List[String] = null) extends Element with Product with Serializable
An identification of a time interval that may have a given resolution.
An identification of a time interval that may have a given resolution.
- Element
Reference to the superclass object.
- resolution
The number of units of time that compose an individual step within a period.
- timeInterval
The start and end date and time for a given interval.
- MarketDocument
MarketDocument undocumented
- Point
Point undocumented
- Reason
Reason undocumented
- TimeSeries
TimeSeries undocumented
-
final
case class
PeriodicStatisticalCalculation(StatisticalCalculation: StatisticalCalculation = null, calculationIntervalMagnitude: Int = 0, calculationIntervalUnit: String = null) extends Element with Product with Serializable
Description of period for which calculation is performed.
Description of period for which calculation is performed.
Conditions: F: {Not sure where these came from… delete from UML?}
- StatisticalCalculation
StatisticalCalculation Reference to the superclass object.
- calculationIntervalMagnitude
Number of units (of calculationIntervalUnit) in the calculation interval.
- calculationIntervalUnit
Unit in which calculation interval is defined.
-
final
case class
Person(IdentifiedObject: IdentifiedObject = null, electronicAddress: String = null, firstName: String = null, landlinePhone: String = null, lastName: String = null, mName: String = null, mobilePhone: String = null, prefix: String = null, specialNeed: String = null, suffix: String = null, Roles: List[String] = null) extends Element with Product with Serializable
General purpose information for name and other information to contact people.
General purpose information for name and other information to contact people.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- electronicAddress
ElectronicAddress Electronic address.
- firstName
Person's first name.
- landlinePhone
TelephoneNumber Landline phone number.
- lastName
Person's last (family, sir) name.
- mName
Middle name(s) or initial(s).
- mobilePhone
TelephoneNumber Mobile phone number.
- prefix
A prefix or title for the person's name, such as Miss, Mister, Doctor, etc.
- specialNeed
Special service needs for the person (contact) are described; examples include life support, etc.
- suffix
A suffix for the person's name, such as II, III, etc.
- Roles
PersonRole All roles of this person.
-
final
case class
PersonOrganisationRole(OrganisationRole: OrganisationRole = null, clientID: String = null, ErpPerson: String = null) extends Element with Product with Serializable
Role an organisation plays with respect to persons.
Role an organisation plays with respect to persons.
- OrganisationRole
OrganisationRole Reference to the superclass object.
- clientID
Identifiers of the person held by an organisation, such as a government agency (federal, state, province, city, county), financial institutions, etc.
- ErpPerson
OldPerson undocumented
-
final
case class
PersonPropertyRole(Role: Role = null, LandProperty: String = null, Person: String = null) extends Element with Product with Serializable
The role of a person relative to a given piece of property.
The role of a person relative to a given piece of property.
Examples of roles include: owner, renter, contractor, etc.
- Role
Role Reference to the superclass object.
- LandProperty
LandProperty undocumented
- Person
OldPerson undocumented
- final case class PersonRole(IdentifiedObject: IdentifiedObject = null, Appointments: List[String] = null, ConfigurationEvents: List[String] = null, Person: String = null) extends Element with Product with Serializable
-
final
case class
PetersenCoil(EarthFaultCompensator: EarthFaultCompensator = null, mode: String = null, nominalU: Double = 0.0, offsetCurrent: Double = 0.0, positionCurrent: Double = 0.0, xGroundMax: Double = 0.0, xGroundMin: Double = 0.0, xGroundNominal: Double = 0.0) extends Element with Product with Serializable
A variable impedance device normally used to offset line charging during single line faults in an ungrounded section of network.
A variable impedance device normally used to offset line charging during single line faults in an ungrounded section of network.
- EarthFaultCompensator
EarthFaultCompensator Reference to the superclass object.
- mode
The mode of operation of the Petersen coil.
- nominalU
The nominal voltage for which the coil is designed.
- offsetCurrent
The offset current that the Petersen coil controller is operating from the resonant point. This is normally a fixed amount for which the controller is configured and could be positive or negative. Typically 0 to 60 A depending on voltage and resonance conditions.
- positionCurrent
The control current used to control the Petersen coil also known as the position current. Typically in the range of 20 mA to 200 mA.
- xGroundMax
The maximum reactance.
- xGroundMin
The minimum reactance.
- xGroundNominal
The nominal reactance. This is the operating point (normally over compensation) that is defined based on the resonance point in the healthy network condition. The impedance is calculated based on nominal voltage divided by position current.
-
final
case class
PhaseImpedanceData(Element: BasicElement = null, b: Double = 0.0, column: Int = 0, fromPhase: String = null, g: Double = 0.0, r: Double = 0.0, row: Int = 0, toPhase: String = null, x: Double = 0.0, PhaseImpedance: String = null) extends Element with Product with Serializable
Impedance and conductance matrix element values.
Impedance and conductance matrix element values.
The diagonal elements are described by the elements having the same toPhase and fromPhase value and the off diagonal elements have different toPhase and fromPhase values. The matrix can also be stored in symmetric lower triangular format using the row and column attributes, which map to ACLineSegmentPhase.sequenceNumber.
- Element
Reference to the superclass object.
- b
Susceptance matrix element value, per length of unit.
- column
The matrix element's column number, in the range 1 to row. Only the lower triangle needs to be stored. This column number matches ACLineSegmentPhase.sequenceNumber.
- fromPhase
Refer to the class description.
- g
Conductance matrix element value, per length of unit.
- r
Resistance matrix element value, per length of unit.
- row
The matrix element’s row number, in the range 1 to PerLengthPhaseImpedance.conductorCount. Only the lower triangle needs to be stored. This row number matches ACLineSegmentPhase.sequenceNumber.
- toPhase
Refer to the class description.
- x
Reactance matrix element value, per length of unit.
- PhaseImpedance
PerLengthPhaseImpedance Conductor phase impedance to which this data belongs.
-
final
case class
PhaseTapChanger(TapChanger: TapChanger = null, TransformerEnd: String = null) extends Element with Product with Serializable
A transformer phase shifting tap model that controls the phase angle difference across the power transformer and potentially the active power flow through the power transformer.
A transformer phase shifting tap model that controls the phase angle difference across the power transformer and potentially the active power flow through the power transformer.
This phase tap model may also impact the voltage magnitude.
- TapChanger
TapChanger Reference to the superclass object.
- TransformerEnd
TransformerEnd Transformer end to which this phase tap changer belongs.
-
final
case class
PhaseTapChangerAsymmetrical(PhaseTapChangerNonLinear: PhaseTapChangerNonLinear = null, windingConnectionAngle: Double = 0.0) extends Element with Product with Serializable
Describes the tap model for an asymmetrical phase shifting transformer in which the difference voltage vector adds to the in-phase winding.
Describes the tap model for an asymmetrical phase shifting transformer in which the difference voltage vector adds to the in-phase winding.
The out-of-phase winding is the transformer end where the tap changer is located. The angle between the in-phase and out-of-phase windings is named the winding connection angle. The phase shift depends on both the difference voltage magnitude and the winding connection angle.
- PhaseTapChangerNonLinear
PhaseTapChangerNonLinear Reference to the superclass object.
- windingConnectionAngle
The phase angle between the in-phase winding and the out-of -phase winding used for creating phase shift. The out-of-phase winding produces what is known as the difference voltage. Setting this angle to 90 degrees is not the same as a symmetrical transformer. The attribute can only be multiples of 30 degrees. The allowed range is -150 degrees to 150 degrees excluding 0.
-
final
case class
PhaseTapChangerLinear(PhaseTapChanger: PhaseTapChanger = null, stepPhaseShiftIncrement: Double = 0.0, xMax: Double = 0.0, xMin: Double = 0.0) extends Element with Product with Serializable
Describes a tap changer with a linear relation between the tap step and the phase angle difference across the transformer.
Describes a tap changer with a linear relation between the tap step and the phase angle difference across the transformer.
This is a mathematical model that is an approximation of a real phase tap changer. The phase angle is computed as stepPhaseShiftIncrement times the tap position. The voltage magnitude of both sides is the same.
- PhaseTapChanger
PhaseTapChanger Reference to the superclass object.
- stepPhaseShiftIncrement
Phase shift per step position. A positive value indicates a positive angle variation from the Terminal at the PowerTransformerEnd, where the TapChanger is located, into the transformer. The actual phase shift increment might be more accurately computed from the symmetrical or asymmetrical models or a tap step table lookup if those are available.
- xMax
The reactance depends on the tap position according to a "u" shaped curve. The maximum reactance (xMax) appears at the low and high tap positions. Depending on the “u” curve the attribute can be either higher or lower than PowerTransformerEnd.x.
- xMin
The reactance depends on the tap position according to a "u" shaped curve. The minimum reactance (xMin) appears at the mid tap position. PowerTransformerEnd.x shall be consistent with PhaseTapChangerLinear.xMin and PhaseTapChangerNonLinear.xMin. In case of inconsistency, PowerTransformerEnd.x shall be used.
-
final
case class
PhaseTapChangerNonLinear(PhaseTapChanger: PhaseTapChanger = null, voltageStepIncrement: Double = 0.0, xMax: Double = 0.0, xMin: Double = 0.0) extends Element with Product with Serializable
The non-linear phase tap changer describes the non-linear behaviour of a phase tap changer.
The non-linear phase tap changer describes the non-linear behaviour of a phase tap changer.
This is a base class for the symmetrical and asymmetrical phase tap changer models. The details of these models can be found in IEC 61970-301.
- PhaseTapChanger
PhaseTapChanger Reference to the superclass object.
- voltageStepIncrement
The voltage step increment on the out of phase winding (the PowerTransformerEnd where the TapChanger is located) specified in percent of rated voltage of the PowerTransformerEnd. A positive value means a positive voltage variation from the Terminal at the PowerTransformerEnd, where the TapChanger is located, into the transformer. When the increment is negative, the voltage decreases when the tap step increases.
- xMax
The reactance depends on the tap position according to a "u" shaped curve. The maximum reactance (xMax) appears at the low and high tap positions. Depending on the “u” curve the attribute can be either higher or lower than PowerTransformerEnd.x.
- xMin
The reactance depend on the tap position according to a "u" shaped curve. The minimum reactance (xMin) appear at the mid tap position. PowerTransformerEnd.x shall be consistent with PhaseTapChangerLinear.xMin and PhaseTapChangerNonLinear.xMin. In case of inconsistency, PowerTransformerEnd.x shall be used.
-
final
case class
PhaseTapChangerSymmetrical(PhaseTapChangerNonLinear: PhaseTapChangerNonLinear = null) extends Element with Product with Serializable
Describes a symmetrical phase shifting transformer tap model in which the voltage magnitude of both sides is the same.
Describes a symmetrical phase shifting transformer tap model in which the voltage magnitude of both sides is the same.
The difference voltage magnitude is the base in an equal-sided triangle where the sides corresponds to the primary and secondary voltages. The phase angle difference corresponds to the top angle and can be expressed as twice the arctangent of half the total difference voltage.
- PhaseTapChangerNonLinear
PhaseTapChangerNonLinear Reference to the superclass object.
-
final
case class
PhaseTapChangerTable(IdentifiedObject: IdentifiedObject = null, PhaseTapChangerTablePoint: List[String] = null, PhaseTapChangerTabular: List[String] = null) extends Element with Product with Serializable
Describes a tabular curve for how the phase angle difference and impedance varies with the tap step.
Describes a tabular curve for how the phase angle difference and impedance varies with the tap step.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- PhaseTapChangerTablePoint
PhaseTapChangerTablePoint The points of this table.
- PhaseTapChangerTabular
PhaseTapChangerTabular The phase tap changers to which this phase tap table applies.
-
final
case class
PhaseTapChangerTablePoint(TapChangerTablePoint: TapChangerTablePoint = null, angle: Double = 0.0, PhaseTapChangerTable: String = null) extends Element with Product with Serializable
Describes each tap step in the phase tap changer tabular curve.
Describes each tap step in the phase tap changer tabular curve.
- TapChangerTablePoint
TapChangerTablePoint Reference to the superclass object.
- angle
The angle difference in degrees. A positive value indicates a positive angle variation from the Terminal at the PowerTransformerEnd, where the TapChanger is located, into the transformer.
- PhaseTapChangerTable
PhaseTapChangerTable The table of this point.
-
final
case class
PhaseTapChangerTabular(PhaseTapChanger: PhaseTapChanger = null, PhaseTapChangerTable: String = null) extends Element with Product with Serializable
Describes a tap changer with a table defining the relation between the tap step and the phase angle difference across the transformer.
Describes a tap changer with a table defining the relation between the tap step and the phase angle difference across the transformer.
- PhaseTapChanger
PhaseTapChanger Reference to the superclass object.
- PhaseTapChangerTable
PhaseTapChangerTable The phase tap changer table for this phase tap changer.
-
final
case class
PhenomenonClassification(IdentifiedObject: IdentifiedObject = null, ClassificationCondition: List[String] = null, EnvironmentalDataAuthority: String = null, EnvironmentalPhenomenon: List[String] = null) extends Element with Product with Serializable
A pre-defined phenomenon classification as defined by a particular authority.
A pre-defined phenomenon classification as defined by a particular authority.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ClassificationCondition
ClassificationCondition Condition contributing to the classification of this phenomenon.
- EnvironmentalDataAuthority
EnvironmentalDataAuthority Authority defining this environmental phenomenon.
- EnvironmentalPhenomenon
EnvironmentalPhenomenon undocumented
-
final
case class
PhotoVoltaicUnit(PowerElectronicsUnit: PowerElectronicsUnit = null) extends Element with Product with Serializable
A photovoltaic device or an aggregation of such devices.
A photovoltaic device or an aggregation of such devices.
- PowerElectronicsUnit
PowerElectronicsUnit Reference to the superclass object.
-
final
case class
PinBranchGroup(GateInputPin: GateInputPin = null, kind: String = null, BranchGroup: String = null) extends Element with Product with Serializable
Value associated with branch group is used as compare.
Value associated with branch group is used as compare.
- GateInputPin
GateInputPin Reference to the superclass object.
- kind
The compare operation done on the branch group.
- BranchGroup
BranchGroup The branch group that should be used in compare.
-
final
case class
PinEquipment(GateInputPin: GateInputPin = null, kind: String = null, Equipment: String = null) extends Element with Product with Serializable
Value associated with Equipment is used as compare.
Value associated with Equipment is used as compare.
- GateInputPin
GateInputPin Reference to the superclass object.
- kind
The compare operation done on the equipment.
- Equipment
Equipment The Equipment that should be used in compare.
-
final
case class
PinGate(GateInputPin: GateInputPin = null, GateOutput: String = null) extends Element with Product with Serializable
An output from one gate represent an input to another gate.
An output from one gate represent an input to another gate.
- GateInputPin
GateInputPin Reference to the superclass object.
- GateOutput
Gate undocumented
-
final
case class
PinMeasurement(GateInputPin: GateInputPin = null, Measurement: String = null, MeasurementCalculator: String = null) extends Element with Product with Serializable
Gate input pin that is associated with a Measurement or a calculation of Measurement.
Gate input pin that is associated with a Measurement or a calculation of Measurement.
- GateInputPin
GateInputPin Reference to the superclass object.
- Measurement
Measurement The Measurement that should be used in compare.
- MeasurementCalculator
MeasurementCalculator Result of the calculation used as input to a gate.
-
final
case class
PinTerminal(GateInputPin: GateInputPin = null, kind: String = null, Terminal: String = null) extends Element with Product with Serializable
Value associated with Terminal is used as compare.
Value associated with Terminal is used as compare.
- GateInputPin
GateInputPin Reference to the superclass object.
- kind
The compare operation done on the terminal.
- Terminal
Terminal The Terminal that should be used in compare.
-
final
case class
PlannedMarket(Element: BasicElement = null, marketEndTime: String = null, marketStartTime: String = null, marketType: String = null, MarketPlan: String = null, MarketRun: List[String] = null, PlannedMarketEvent: List[String] = null) extends Element with Product with Serializable
Represent a planned market.
Represent a planned market.
For example a planned DA/HA/RT market.
- Element
Reference to the superclass object.
- marketEndTime
Market end time.
- marketStartTime
Market start time.
- marketType
Market type.
- MarketPlan
MarketPlan A market plan has a number of markets (DA, HA, RT).
- MarketRun
MarketRun A planned market could have multiple market runs for the reason that a planned market could have a rerun.
- PlannedMarketEvent
PlannedMarketEvent A planned market shall have a set of planned events
-
final
case class
PlannedMarketEvent(IdentifiedObject: IdentifiedObject = null, eventType: String = null, plannedTime: Int = 0, MarketActualEvent: List[String] = null, PlannedMarket: List[String] = null) extends Element with Product with Serializable
This class represents planned events.
This class represents planned events.
Used to model the various planned events in a market (closing time, clearing time, etc.)
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- eventType
Planned event type.
- plannedTime
This is relative time so that this attribute can be used by more than one planned market. For example the bid submission is 10am everyday.
- MarketActualEvent
MarketActualEvent All actual events that execute this planned event.
- PlannedMarket
PlannedMarket A planned market shall have a set of planned events
- final case class PlannedOutage(Outage: Outage = null, reason: String = null, FieldDispatchHistory: String = null, OutagePlan: String = null, UpdatedRatings: List[String] = null) extends Element with Product with Serializable
-
final
case class
PlannedOutageNotification(Document: Document = null, Customer: List[String] = null, SwitchingPlan: String = null) extends Element with Product with Serializable
This class will be used to generate call ahead lists for customers who will be affected by a planned outage.
This class will be used to generate call ahead lists for customers who will be affected by a planned outage.
- Document
Document Reference to the superclass object.
- Customer
Customer undocumented
- SwitchingPlan
SwitchingPlan undocumented
-
final
case class
Plant(EquipmentContainer: EquipmentContainer = null) extends Element with Product with Serializable
A Plant is a collection of equipment for purposes of generation.
A Plant is a collection of equipment for purposes of generation.
- EquipmentContainer
EquipmentContainer Reference to the superclass object.
-
final
case class
Pnode(IdentifiedObject: IdentifiedObject = null, isPublic: Boolean = false, AggregateNode: List[String] = null, CommodityDefinition: List[String] = null, DeliveryTransactionBids: List[String] = null, ExPostResults: List[String] = null, FTRs: List[String] = null, MktMeasurement: List[String] = null, OrgPnodeAllocation: List[String] = null, PnodeResults: List[String] = null, RTO: String = null, ReceiptTransactionBids: List[String] = null, RegisteredResources: List[String] = null, SinkCRRSegment: List[String] = null, SourceCRRSegment: List[String] = null, SubControlArea: String = null, Trade: List[String] = null) extends Element with Product with Serializable
A pricing node is directly associated with a connectivity node.
A pricing node is directly associated with a connectivity node.
It is a pricing location for which market participants submit their bids, offers, buy/sell CRRs, and settle.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- isPublic
If true, this Pnode is public (prices are published for DA/RT and FTR markets), otherwise it is private (location is not usable by market for bidding/FTRs/transactions).
- AggregateNode
AggregateNode undocumented
- CommodityDefinition
CommodityDefinition undocumented
- DeliveryTransactionBids
TransactionBid undocumented
- ExPostResults
ExPostPricingResults undocumented
- FTRs
FTR undocumented
- MktMeasurement
MktMeasurement Allows Measurements to be associated to Pnodes.
- OrgPnodeAllocation
OrgPnodeAllocation undocumented
- PnodeResults
PnodeResults undocumented
- RTO
RTO undocumented
- ReceiptTransactionBids
TransactionBid undocumented
- RegisteredResources
RegisteredResource A registered resource injects power at one or more connectivity nodes related to a pnode
- SinkCRRSegment
CRRSegment undocumented
- SourceCRRSegment
CRRSegment undocumented
- SubControlArea
SubControlArea undocumented
- Trade
Trade undocumented
-
final
case class
PnodeClearing(MarketFactors: MarketFactors = null, CommodityPrice: List[String] = null, PnodeResults: List[String] = null) extends Element with Product with Serializable
Pricing node clearing results posted for a given settlement period.
Pricing node clearing results posted for a given settlement period.
- MarketFactors
MarketFactors Reference to the superclass object.
- CommodityPrice
CommodityPrice undocumented
- PnodeResults
PnodeResults undocumented
-
final
case class
PnodeDistributionFactor(Element: BasicElement = null, factor: Double = 0.0, offPeak: String = null, onPeak: String = null, podLossFactor: Double = 0.0, AggregatedPnode: String = null, BidDistributionFactor: String = null, IndividualPnode: String = null) extends Element with Product with Serializable
This class allows SC to input different distribution factors for pricing node.
This class allows SC to input different distribution factors for pricing node.
- Element
Reference to the superclass object.
- factor
Used to calculate "participation" of Pnode in an AggregatePnode. For example, for regulation region this factor is 1 and total sum of all factors for a specific regulation region does not have to be 1. For pricing zone the total sum of all factors has to be 1.
- offPeak
Indication that this distribution factor is to apply during off peak.
- onPeak
Indication that this factor is to apply during Peak periods.
- podLossFactor
Point of delivery loss factor
- AggregatedPnode
AggregatedPnode undocumented
- BidDistributionFactor
BidDistributionFactor undocumented
- IndividualPnode
IndividualPnode undocumented
-
final
case class
PnodeResults(Element: BasicElement = null, congestLMP: Double = 0.0, costLMP: Double = 0.0, lossLMP: Double = 0.0, marginalClearingPrice: Double = 0.0, scheduledMW: Double = 0.0, updateTimeStamp: String = null, updateType: String = null, updateUser: String = null, Pnode: String = null, PnodeClearing: String = null) extends Element with Product with Serializable
Provides the total price, the cost component, the loss component, and the congestion component for Pnodes for the forward and real time markets.
Provides the total price, the cost component, the loss component, and the congestion component for Pnodes for the forward and real time markets.
There are several prices produced based on the run type (MPM, RUC, Pricing, or Scheduling/Dispatch).
- Element
Reference to the superclass object.
- congestLMP
Congestion component of Location Marginal Price (LMP) in monetary units per MW.
- costLMP
Cost component of Locational Marginal Pricing (LMP) in monetary units per MW.
- lossLMP
Loss component of Location Marginal Price (LMP) in monetary units per MW.
- marginalClearingPrice
Locational Marginal Price (LMP) ($/MWh)
- scheduledMW
total MW schedule at the pnode
- updateTimeStamp
undocumented
- updateType
undocumented
- updateUser
undocumented
- Pnode
Pnode undocumented
- PnodeClearing
PnodeClearing undocumented
-
final
case class
Point(Element: BasicElement = null, position: Int = 0, quality: String = null, quantity: Double = 0.0, secondaryQuantity: Double = 0.0, AceTariffType: List[String] = null, FlowDirection: List[String] = null, Period: String = null, Price: List[String] = null, Quantity: List[String] = null, Reason: List[String] = null, TimeSeries: List[String] = null) extends Element with Product with Serializable
An identification of a set of values beeing adressed within a specific interval of time.
An identification of a set of values beeing adressed within a specific interval of time.
- Element
Reference to the superclass object.
- position
A sequential value representing the relative position within a given time interval.
- quality
The quality of the information being provided. This quality may be estimated, not available, as provided, etc.
- quantity
Principal quantity identified for a point.
- secondaryQuantity
Secondary quantity identified for a point.
- AceTariffType
AceTariffType undocumented
- FlowDirection
FlowDirection undocumented
- Period
Period undocumented
- Price
Price undocumented
- Quantity
Quantity undocumented
- Reason
Reason undocumented
- TimeSeries
TimeSeries undocumented
-
final
case class
PointOfSale(IdentifiedObject: IdentifiedObject = null, location: String = null, CashierShifts: List[String] = null) extends Element with Product with Serializable
Logical point where transactions take place with operational interaction between cashier and the payment system; in certain cases the point of sale interacts directly with the end customer, in which case the cashier might not be a real person: for example a self-service kiosk or over the internet.
Logical point where transactions take place with operational interaction between cashier and the payment system; in certain cases the point of sale interacts directly with the end customer, in which case the cashier might not be a real person: for example a self-service kiosk or over the internet.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- location
Local description for where this point of sale is physically located.
- CashierShifts
CashierShift All shifts this point of sale operated in.
-
final
case class
Pole(Structure: Structure = null, baseKind: String = null, breastBlock: Boolean = false, classification: String = null, construction: String = null, diameter: Double = 0.0, jpaReference: String = null, len: Double = 0.0, preservativeKind: String = null, speciesType: String = null, treatedDateTime: String = null, treatmentKind: String = null, Streetlights: List[String] = null) extends Element with Product with Serializable
Pole asset.
Pole asset.
- Structure
Structure Reference to the superclass object.
- baseKind
Kind of base for this pole.
- breastBlock
True if a block of material has been attached to base of pole in ground for stability. This technique is used primarily when anchors can not be used.
- classification
Pole class: 1, 2, 3, 4, 5, 6, 7, H1, H2, Other, Unknown.
- construction
The framing structure mounted on the pole.
- diameter
Diameter of the pole.
- jpaReference
Joint pole agreement reference number.
- len
Length of the pole (inclusive of any section of the pole that may be underground post-installation).
- preservativeKind
Kind of preservative for this pole.
- speciesType
Pole species. Aluminum, Aluminum Davit, Concrete, Fiberglass, Galvanized Davit, Galvanized, Steel Davit Primed, Steel Davit, Steel Standard Primed, Steel, Truncated, Wood-Treated, Wood-Hard, Wood-Salt Treated, Wood-Soft, Wood, Other, Unknown.
- treatedDateTime
Date and time pole was last treated with preservative.
- treatmentKind
Kind of treatment for this pole.
- Streetlights
Streetlight All streetlights attached to this pole.
-
final
case class
PositionPoint(Element: BasicElement = null, groupNumber: Int = 0, sequenceNumber: Int = 0, xPosition: String = null, yPosition: String = null, zPosition: String = null, Location: String = null) extends Element with Product with Serializable
Set of spatial coordinates that determine a point, defined in the coordinate system specified in 'Location.
Set of spatial coordinates that determine a point, defined in the coordinate system specified in 'Location.
CoordinateSystem'. Use a single position point instance to describe a point-oriented location. Use a sequence of position points to describe a line-oriented object (physical location of non-point oriented objects like cables or lines), or area of an object (like a substation or a geographical zone - in this case, have first and last position point with the same values).
- Element
Reference to the superclass object.
- groupNumber
Zero-relative sequence number of this group within a series of points; used when there is a need to express disjoint groups of points that are considered to be part of a single location.
- sequenceNumber
Zero-relative sequence number of this point within a series of points.
- xPosition
X axis position.
- yPosition
Y axis position.
- zPosition
(if applicable) Z axis position.
- Location
Location Location described by this position point.
-
final
case class
PostLineSensor(Sensor: Sensor = null) extends Element with Product with Serializable
A sensor used mainly in overhead distribution networks as the source of both current and voltage measurements.
A sensor used mainly in overhead distribution networks as the source of both current and voltage measurements.
- Sensor
Sensor Reference to the superclass object.
-
final
case class
PotentialTransformer(Sensor: Sensor = null, accuracyClass: String = null, nominalRatio: Double = 0.0, ptClass: String = null, type: String = null) extends Element with Product with Serializable
Instrument transformer (also known as Voltage Transformer) used to measure electrical qualities of the circuit that is being protected and/or monitored.
Instrument transformer (also known as Voltage Transformer) used to measure electrical qualities of the circuit that is being protected and/or monitored.
Typically used as voltage transducer for the purpose of metering, protection, or sometimes auxiliary substation supply. A typical secondary voltage rating would be 120V.
- Sensor
Sensor Reference to the superclass object.
- accuracyClass
PT accuracy classification.
- nominalRatio
Nominal ratio between the primary and secondary voltage.
- ptClass
Potential transformer (PT) classification covering burden.
- type
Potential transformer construction type.
-
final
case class
PotentialTransformerInfo(AssetInfo: AssetInfo = null, accuracyClass: String = null, nominalRatio: String = null, primaryRatio: String = null, ptClass: String = null, ratedVoltage: Double = 0.0, secondaryRatio: String = null, tertiaryRatio: String = null) extends Element with Product with Serializable
Properties of potential transformer asset.
Properties of potential transformer asset.
- AssetInfo
AssetInfo Reference to the superclass object.
- accuracyClass
undocumented
- nominalRatio
undocumented
- primaryRatio
Ratio for the primary winding tap changer.
- ptClass
undocumented
- ratedVoltage
Rated voltage on the primary side.
- secondaryRatio
Ratio for the secondary winding tap changer.
- tertiaryRatio
Ratio for the tertiary winding tap changer.
-
final
case class
PowerCutZone(PowerSystemResource: PowerSystemResource = null, cutLevel1: Double = 0.0, cutLevel2: Double = 0.0, EnergyConsumers: List[String] = null) extends Element with Product with Serializable
An area or zone of the power system which is used for load shedding purposes.
An area or zone of the power system which is used for load shedding purposes.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- cutLevel1
First level (amount) of load to cut as a percentage of total zone load.
- cutLevel2
Second level (amount) of load to cut as a percentage of total zone load.
- EnergyConsumers
EnergyConsumer Energy consumer is assigned to the power cut zone.
-
final
case class
PowerElectronicsConnection(RegulatingCondEq: RegulatingCondEq = null, maxIFault: Double = 0.0, maxQ: Double = 0.0, minQ: Double = 0.0, p: Double = 0.0, q: Double = 0.0, r: Double = 0.0, r0: Double = 0.0, ratedS: Double = 0.0, ratedU: Double = 0.0, rn: Double = 0.0, x: Double = 0.0, x0: Double = 0.0, xn: Double = 0.0, PowerElectronicsConnectionPhase: List[String] = null, PowerElectronicsUnit: List[String] = null, WindTurbineType3or4Dynamics: String = null) extends Element with Product with Serializable
A connection to the AC network for energy production or consumption that uses power electronics rather than rotating machines.
A connection to the AC network for energy production or consumption that uses power electronics rather than rotating machines.
- RegulatingCondEq
RegulatingCondEq Reference to the superclass object.
- maxIFault
Maximum fault current this device will contribute, in per-unit of rated current, before the converter protection will trip or bypass.
- maxQ
Maximum reactive power limit. This is the maximum (nameplate) limit for the unit.
- minQ
Minimum reactive power limit for the unit. This is the minimum (nameplate) limit for the unit.
- p
Active power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution.
- q
Reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution.
- r
Equivalent resistance (RG) of generator. RG is considered for the calculation of all currents, except for the calculation of the peak current ip. Used for short circuit data exchange according to IEC 60909.
- r0
Zero sequence resistance of the synchronous machine.
- ratedS
Nameplate apparent power rating for the unit. The attribute shall have a positive value.
- ratedU
Rated voltage (nameplate data, Ur in IEC 60909-0). It is primarily used for short circuit data exchange according to IEC 60909. The attribute shall be a positive value.
- rn
Negative sequence Thevenin resistance.
- x
Positive sequence Thevenin reactance.
- x0
Zero sequence Thevenin reactance.
- xn
Negative sequence Thevenin reactance.
- PowerElectronicsConnectionPhase
PowerElectronicsConnectionPhase The individual phases models for the power electronics connection.
- PowerElectronicsUnit
PowerElectronicsUnit An AC network connection may have several power electronics units connecting through it.
- WindTurbineType3or4Dynamics
WindTurbineType3or4Dynamics The wind turbine type 3 or type 4 dynamics model associated with this power electronics connection.
-
final
case class
PowerElectronicsConnectionPhase(PowerSystemResource: PowerSystemResource = null, p: Double = 0.0, phase: String = null, q: Double = 0.0, PowerElectronicsConnection: String = null) extends Element with Product with Serializable
A single phase of a power electronics connection.
A single phase of a power electronics connection.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- p
Active power injection. Load sign convention is used, i.e. positive sign means flow into the equipment from the network.
- phase
Phase of this energy producer component. If the energy producer is wye connected, the connection is from the indicated phase to the central ground or neutral point. If the energy producer is delta connected, the phase indicates an energy producer connected from the indicated phase to the next logical non-neutral phase.
- q
Reactive power injection. Load sign convention is used, i.e. positive sign means flow into the equipment from the network.
- PowerElectronicsConnection
PowerElectronicsConnection Power electronics connection of this power electronics connection phase.
-
final
case class
PowerElectronicsUnit(Equipment: Equipment = null, maxP: Double = 0.0, minP: Double = 0.0, PowerElectronicsConnection: String = null) extends Element with Product with Serializable
A generating unit or battery or aggregation that connects to the AC network using power electronics rather than rotating machines.
A generating unit or battery or aggregation that connects to the AC network using power electronics rather than rotating machines.
- Equipment
Equipment Reference to the superclass object.
- maxP
Maximum active power limit. This is the maximum (nameplate) limit for the unit.
- minP
Minimum active power limit. This is the minimum (nameplate) limit for the unit.
- PowerElectronicsConnection
PowerElectronicsConnection A power electronics unit has a connection to the AC network.
-
final
case class
PowerElectronicsWindUnit(PowerElectronicsUnit: PowerElectronicsUnit = null) extends Element with Product with Serializable
A wind generating unit that connects to the AC network with power electronics rather than rotating machines or an aggregation of such units.
A wind generating unit that connects to the AC network with power electronics rather than rotating machines or an aggregation of such units.
- PowerElectronicsUnit
PowerElectronicsUnit Reference to the superclass object.
-
final
case class
PowerQualityPricing(Document: Document = null, emergencyHighVoltLimit: Double = 0.0, emergencyLowVoltLimit: Double = 0.0, normalHighVoltLimit: Double = 0.0, normalLowVoltLimit: Double = 0.0, powerFactorMin: Double = 0.0, valueUninterruptedServiceEnergy: Double = 0.0, valueUninterruptedServiceP: Double = 0.0, voltImbalanceViolCost: Double = 0.0, voltLimitViolCost: Double = 0.0) extends Element with Product with Serializable
Pricing can be based on power quality.
Pricing can be based on power quality.
- Document
Document Reference to the superclass object.
- emergencyHighVoltLimit
Emergency high voltage limit.
- emergencyLowVoltLimit
Emergency low voltage limit.
- normalHighVoltLimit
Normal high voltage limit.
- normalLowVoltLimit
Normal low voltage limit.
- powerFactorMin
Threshold minimum power factor for this PricingStructure, specified in instances where a special charge is levied if the actual power factor for a Service falls below the value specified here.
- valueUninterruptedServiceEnergy
Value of uninterrupted service (Cost per energy).
- valueUninterruptedServiceP
Value of uninterrupted service (Cost per active power).
- voltImbalanceViolCost
Voltage imbalance violation cost (Cost per unit Voltage).
- voltLimitViolCost
Voltage limit violation cost (Cost per unit Voltage).
-
final
case class
PowerSystemProjectLifecycleToBeDeleted(Element: BasicElement = null, cancelled: String = null, committed: String = null, inBuild: String = null, inPlan: String = null) extends Element with Product with Serializable
Represent the base lifecycle of a functional model change that could be a construction of new elements.
Represent the base lifecycle of a functional model change that could be a construction of new elements.
- Element
Reference to the superclass object.
- cancelled
The date the Power System Project is in cancelled stage.
- committed
The date Power System Project is in committed stage.
- inBuild
The date Power System Project is in build stage.
- inPlan
The date Power System Project is in planning stage.
-
final
case class
PowerSystemResource(IdentifiedObject: IdentifiedObject = null, AssetDatasheet: String = null, Assets: List[String] = null, Clearances: List[String] = null, ConfigurationEvent: List[String] = null, Controls: List[String] = null, GenericAction: List[String] = null, Location: String = null, Measurements: List[String] = null, OperatingShare: List[String] = null, OperationalTags: List[String] = null, PSREvents: List[String] = null, PSRType: String = null, ReportingGroup: List[String] = null, VerificationAction: List[String] = null) extends Element with Product with Serializable
A power system resource (PSR) can be an item of equipment such as a switch, an equipment container containing many individual items of equipment such as a substation, or an organisational entity such as sub-control area.
A power system resource (PSR) can be an item of equipment such as a switch, an equipment container containing many individual items of equipment such as a substation, or an organisational entity such as sub-control area.
Power system resources can have measurements associated.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- AssetDatasheet
AssetInfo Datasheet information for this power system resource.
- Assets
Asset All assets represented by this power system resource. For example, multiple conductor assets are electrically modelled as a single AC line segment.
- Clearances
ClearanceDocument All clearances applicable to this power system resource.
- ConfigurationEvent
ConfigurationEvent undocumented
- Controls
Control The controller outputs used to actually govern a regulating device, e.g. the magnetization of a synchronous machine or capacitor bank breaker actuator.
- GenericAction
GenericAction undocumented
- Location
Location Location of this power system resource.
- Measurements
Measurement The measurements associated with this power system resource.
- OperatingShare
OperatingShare The operating shares of this power system resource.
- OperationalTags
OperationalTag All operational tags placed on this power system resource.
- PSREvents
PSREvent All events associated with this power system resource.
- PSRType
PSRType Custom classification for this power system resource.
- ReportingGroup
ReportingGroup Reporting groups to which this power system resource belongs.
- VerificationAction
VerificationAction undocumented
-
final
case class
PowerSystemStabilizerDynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null, ExcitationSystemDynamics: String = null, RemoteInputSignal: List[String] = null) extends Element with Product with Serializable
Power system stabilizer function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
Power system stabilizer function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- ExcitationSystemDynamics
ExcitationSystemDynamics Excitation system model with which this power system stabilizer model is associated.
- RemoteInputSignal
RemoteInputSignal Remote input signal used by this power system stabilizer model.
-
final
case class
PowerSystemStabilizerUserDefined(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
<font color="#0f0f0f">Power system stabilizer</font> function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
<font color="#0f0f0f">Power system stabilizer</font> function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
PowerTransformer(ConductingEquipment: ConductingEquipment = null, beforeShCircuitHighestOperatingCurrent: Double = 0.0, beforeShCircuitHighestOperatingVoltage: Double = 0.0, beforeShortCircuitAnglePf: Double = 0.0, highSideMinOperatingU: Double = 0.0, isPartOfGeneratorUnit: Boolean = false, operationalValuesConsidered: Boolean = false, vectorGroup: String = null, PowerTransformerEnd: List[String] = null, TransformerTanks: List[String] = null) extends Element with Product with Serializable
An electrical device consisting of two or more coupled windings, with or without a magnetic core, for introducing mutual coupling between electric circuits.
An electrical device consisting of two or more coupled windings, with or without a magnetic core, for introducing mutual coupling between electric circuits.
Transformers can be used to control voltage and phase shift (active power flow). A power transformer may be composed of separate transformer tanks that need not be identical. A power transformer can be modelled with or without tanks and is intended for use in both balanced and unbalanced representations. A power transformer typically has two terminals, but may have one (grounding), three or more terminals. The inherited association ConductingEquipment.BaseVoltage should not be used. The association from TransformerEnd to BaseVoltage should be used instead.
- ConductingEquipment
ConductingEquipment Reference to the superclass object.
- beforeShCircuitHighestOperatingCurrent
The highest operating current (Ib in IEC 60909-0) before short circuit (depends on network configuration and relevant reliability philosophy). It is used for calculation of the impedance correction factor KT defined in IEC 60909-0.
- beforeShCircuitHighestOperatingVoltage
The highest operating voltage (Ub in IEC 60909-0) before short circuit. It is used for calculation of the impedance correction factor KT defined in IEC 60909-0. This is worst case voltage on the low side winding (3.7.1 of IEC 60909:2001). Used to define operating conditions.
- beforeShortCircuitAnglePf
The angle of power factor before short circuit (phib in IEC 60909-0). It is used for calculation of the impedance correction factor KT defined in IEC 60909-0. This is the worst case power factor. Used to define operating conditions.
- highSideMinOperatingU
The minimum operating voltage (uQmin in IEC 60909-0) at the high voltage side (Q side) of the unit transformer of the power station unit. A value well established from long-term operating experience of the system. It is used for calculation of the impedance correction factor KG defined in IEC 60909-0.
- isPartOfGeneratorUnit
Indicates whether the machine is part of a power station unit. Used for short circuit data exchange according to IEC 60909. It has an impact on how the correction factors are calculated for transformers, since the transformer is not necessarily part of a synchronous machine and generating unit. It is not always possible to derive this information from the model. This is why the attribute is necessary.
- operationalValuesConsidered
It is used to define if the data (other attributes related to short circuit data exchange) defines long term operational conditions or not. Used for short circuit data exchange according to IEC 60909.
- vectorGroup
Vector group of the transformer for protective relaying, e.g., Dyn1. For unbalanced transformers, this may not be simply determined from the constituent winding connections and phase angle displacements. The vectorGroup string consists of the following components in the order listed: high voltage winding connection, mid voltage winding connection (for three winding transformers), phase displacement clock number from 0 to 11, low voltage winding connection phase displacement clock number from 0 to 11. The winding connections are D (delta), Y (wye), YN (wye with neutral), Z (zigzag), ZN (zigzag with neutral), A (auto transformer). Upper case means the high voltage, lower case mid or low. The high voltage winding always has clock position 0 and is not included in the vector group string. Some examples: YNy0 (two winding wye to wye with no phase displacement), YNd11 (two winding wye to delta with 330 degrees phase displacement), YNyn0d5 (three winding transformer wye with neutral high voltage, wye with neutral mid voltage and no phase displacement, delta low voltage with 150 degrees displacement). Phase displacement is defined as the angular difference between the phasors representing the voltages between the neutral point (real or imaginary) and the corresponding terminals of two windings, a positive sequence voltage system being applied to the high-voltage terminals, following each other in alphabetical sequence if they are lettered, or in numerical sequence if they are numbered: the phasors are assumed to rotate in a counter-clockwise sense.
- PowerTransformerEnd
PowerTransformerEnd The ends of this power transformer.
- TransformerTanks
TransformerTank All transformers that belong to this bank.
-
final
case class
PowerTransformerEnd(TransformerEnd: TransformerEnd = null, b: Double = 0.0, b0: Double = 0.0, connectionKind: String = null, g: Double = 0.0, g0: Double = 0.0, phaseAngleClock: Int = 0, r: Double = 0.0, r0: Double = 0.0, ratedS: Double = 0.0, ratedU: Double = 0.0, x: Double = 0.0, x0: Double = 0.0, PowerTransformer: String = null) extends Element with Product with Serializable
A PowerTransformerEnd is associated with each Terminal of a PowerTransformer.
A PowerTransformerEnd is associated with each Terminal of a PowerTransformer.
The impedance values r, r0, x, and x0 of a PowerTransformerEnd represents a star equivalent as follows. 1) for a two Terminal PowerTransformer the high voltage (TransformerEnd.endNumber=1) PowerTransformerEnd has non zero values on r, r0, x, and x0 while the low voltage (TransformerEnd.endNumber=2) PowerTransformerEnd has zero values for r, r0, x, and x0. Parameters are always provided, even if the PowerTransformerEnds have the same rated voltage. In this case, the parameters are provided at the PowerTransformerEnd which has TransformerEnd.endNumber equal to 1. 2) for a three Terminal PowerTransformer the three PowerTransformerEnds represent a star equivalent with each leg in the star represented by r, r0, x, and x0 values. 3) For a three Terminal transformer each PowerTransformerEnd shall have g, g0, b and b0 values corresponding to the no load losses distributed on the three PowerTransformerEnds. The total no load loss shunt impedances may also be placed at one of the PowerTransformerEnds, preferably the end numbered 1, having the shunt values on end 1. This is the preferred way. 4) for a PowerTransformer with more than three Terminals the PowerTransformerEnd impedance values cannot be used. Instead use the TransformerMeshImpedance or split the transformer into multiple PowerTransformers. Each PowerTransformerEnd must be contained by a PowerTransformer. Because a PowerTransformerEnd (or any other object) can not be contained by more than one parent, a PowerTransformerEnd can not have an association to an EquipmentContainer (Substation, VoltageLevel, etc).
- TransformerEnd
TransformerEnd Reference to the superclass object.
- b
Magnetizing branch susceptance (B mag). The value can be positive or negative.
- b0
Zero sequence magnetizing branch susceptance.
- connectionKind
Kind of connection.
- g
Magnetizing branch conductance.
- g0
Zero sequence magnetizing branch conductance (star-model).
- phaseAngleClock
Terminal voltage phase angle displacement where 360 degrees are represented with clock hours. The valid values are 0 to 11. For example, for the secondary side end of a transformer with vector group code of 'Dyn11', specify the connection kind as wye with neutral and specify the phase angle of the clock as 11. The clock value of the transformer end number specified as 1, is assumed to be zero. Note the transformer end number is not assumed to be the same as the terminal sequence number.
- r
Resistance (star-model) of the transformer end. The attribute shall be equal to or greater than zero for non-equivalent transformers.
- r0
Zero sequence series resistance (star-model) of the transformer end.
- ratedS
Normal apparent power rating. The attribute shall be a positive value. For a two-winding transformer the values for the high and low voltage sides shall be identical.
- ratedU
Rated voltage: phase-phase for three-phase windings, and either phase-phase or phase-neutral for single-phase windings. A high voltage side, as given by TransformerEnd.endNumber, shall have a ratedU that is greater than or equal to ratedU for the lower voltage sides. The attribute shall be a positive value.
- x
Positive sequence series reactance (star-model) of the transformer end.
- x0
Zero sequence series reactance of the transformer end.
- PowerTransformer
PowerTransformer The power transformer of this power transformer end.
-
final
case class
PowerTransformerInfo(AssetInfo: AssetInfo = null, TransformerTankInfos: List[String] = null) extends Element with Product with Serializable
Set of power transformer data, from an equipment library.
Set of power transformer data, from an equipment library.
- AssetInfo
AssetInfo Reference to the superclass object.
- TransformerTankInfos
TransformerTankInfo Data for all the tanks described by this power transformer data.
-
final
case class
Price(Element: BasicElement = null, amount: Double = 0.0, category: String = null, direction: String = null, Domain: List[String] = null, Point: String = null, TimeSeries: List[String] = null) extends Element with Product with Serializable
The cost corresponding to a specific measure and expressed in a currency.
The cost corresponding to a specific measure and expressed in a currency.
- Element
Reference to the superclass object.
- amount
A number of monetary units specified in a unit of currency.
- category
The category of a price to be used in a price calculation. The price category is mutually agreed between System Operators.
- direction
The direction indicates whether a System Operator pays the Market Parties or inverse.
- Domain
Domain undocumented
- Point
Point undocumented
- TimeSeries
TimeSeries undocumented
-
final
case class
PriceDescriptor(Element: BasicElement = null, marketType: String = null, priceType: String = null, CommodityPrice: List[String] = null) extends Element with Product with Serializable
The price of a Commodity during a given time interval may change over time.
The price of a Commodity during a given time interval may change over time.
For example, a price may be forecasted a year ahead, a month ahead, a day ahead, an hour ahead, and in real time; this is defined using the MarketType. Additionally a price may have one or more components. For example, a locational marginal energy price may be the arithmetic sum of the system price, the congestion price, and the loss price. The priceType enumeration is used determine if the price is the complete price (priceType="total") or one of potentially many constituent components.
- Element
Reference to the superclass object.
- marketType
The time frame for the price, using the standard conventions associated with the MarketType enumeration.
- priceType
The "kind" of price being described. In general, the priceType will either be "total" to signify that the price is the price paid to buy or sell the commodity, sometimes referred to as an "all-in" price, or one of potentially many components.
- CommodityPrice
CommodityPrice undocumented
-
final
case class
PricingStructure(Document: Document = null, code: String = null, dailyCeilingUsage: Int = 0, dailyEstimatedUsage: Int = 0, dailyFloorUsage: Int = 0, revenueKind: String = null, taxExemption: Boolean = false, CustomerAgreements: List[String] = null, ServiceCategory: String = null, Tariffs: List[String] = null, Transactions: List[String] = null, UsagePoints: List[String] = null) extends Element with Product with Serializable
Grouping of pricing components and prices used in the creation of customer charges and the eligibility criteria under which these terms may be offered to a customer.
Grouping of pricing components and prices used in the creation of customer charges and the eligibility criteria under which these terms may be offered to a customer.
The reasons for grouping include state, customer classification, site characteristics, classification (i.e. fee price structure, deposit price structure, electric service price structure, etc.) and accounting requirements.
- Document
Document Reference to the superclass object.
- code
Unique user-allocated key for this pricing structure, used by company representatives to identify the correct price structure for allocating to a customer. For rate schedules it is often prefixed by a state code.
- dailyCeilingUsage
Absolute maximum valid non-demand usage quantity used in validating a customer's billed non-demand usage.
- dailyEstimatedUsage
Used in place of actual computed estimated average when history of usage is not available, and typically manually entered by customer accounting.
- dailyFloorUsage
Absolute minimum valid non-demand usage quantity used in validating a customer's billed non-demand usage.
- revenueKind
(accounting) Kind of revenue, often used to determine the grace period allowed, before collection actions are taken on a customer (grace periods vary between revenue classes).
- taxExemption
True if this pricing structure is not taxable.
- CustomerAgreements
CustomerAgreement All customer agreements with this pricing structure.
- ServiceCategory
ServiceCategory Service category to which this pricing structure applies.
- Tariffs
Tariff All tariffs used by this pricing structure.
- Transactions
Transaction All transactions applying this pricing structure.
- UsagePoints
UsagePoint All service delivery points (with prepayment meter running as a stand-alone device, with no CustomerAgreement or Customer) to which this pricing structure applies.
-
final
case class
PrimeMover(PowerSystemResource: PowerSystemResource = null, primeMoverRating: Double = 0.0, SynchronousMachines: List[String] = null) extends Element with Product with Serializable
The machine used to develop mechanical energy used to drive a generator.
The machine used to develop mechanical energy used to drive a generator.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- primeMoverRating
Rating of prime mover.
- SynchronousMachines
SynchronousMachine Synchronous machines this Prime mover drives.
-
final
case class
Priority(Element: BasicElement = null, justification: String = null, rank: Int = 0, type: String = null) extends Element with Product with Serializable
Priority definition.
Priority definition.
- Element
Reference to the superclass object.
- justification
Justification for 'rank'.
- rank
Priority level; usually, lower number means high priority, but the details are provided in 'type'.
- type
Type describing 'rank'; e.g., high, emergency, etc.
-
final
case class
Procedure(Document: Document = null, instruction: String = null, kind: String = null, sequenceNumber: String = null, Assets: List[String] = null, CompatibleUnits: List[String] = null, Limits: List[String] = null, Measurements: List[String] = null, ProcedureDataSets: List[String] = null) extends Element with Product with Serializable
Documented procedure for various types of work or work tasks on assets.
Documented procedure for various types of work or work tasks on assets.
- Document
Document Reference to the superclass object.
- instruction
Textual description of this procedure.
- kind
Kind of procedure.
- sequenceNumber
Sequence number in a sequence of procedures being performed.
- Assets
Asset All assets to which this procedure applies.
- CompatibleUnits
CompatibleUnit undocumented
- Limits
Limit undocumented
- Measurements
Measurement Document containing this measurement.
- ProcedureDataSets
ProcedureDataSet All data sets captured by this procedure.
-
final
case class
ProcedureDataSet(Document: Document = null, completedDateTime: String = null, Asset: String = null, MeasurementValue: List[String] = null, Procedure: String = null, Properties: List[String] = null, TransformerObservations: List[String] = null, WorkTask: String = null) extends Element with Product with Serializable
A data set recorded each time a procedure is executed.
A data set recorded each time a procedure is executed.
Observed results are captured in associated measurement values and/or values for properties relevant to the type of procedure performed.
- Document
Document Reference to the superclass object.
- completedDateTime
Date and time procedure was completed.
- Asset
Asset Asset to which this procedure data set applies.
- MeasurementValue
MeasurementValue undocumented
- Procedure
Procedure Procedure capturing this data set.
- Properties
UserAttribute UserAttributes used to specify further properties of this procedure data set. Use 'name' to specify what kind of property it is, and 'value.value' attribute for the actual value.
- TransformerObservations
TransformerObservation undocumented
- WorkTask
WorkTask Work task that created this procedure data set.
-
final
case class
Process(IdentifiedObject: IdentifiedObject = null, classificationType: String = null, processType: String = null, MarketDocument: List[String] = null) extends Element with Product with Serializable
The formal specification of a set of business transactions having the same business goal.
The formal specification of a set of business transactions having the same business goal.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- classificationType
The classification mechanism used to group a set of objects together within a business process. The grouping may be of a detailed or a summary nature.
- processType
The kind of business process.
- MarketDocument
MarketDocument undocumented
-
final
case class
ProductAssetModel(IdentifiedObject: IdentifiedObject = null, catalogueNumber: String = null, corporateStandardKind: String = null, drawingNumber: String = null, instructionManual: String = null, modelNumber: String = null, modelVersion: String = null, overallLength: Double = 0.0, styleNumber: String = null, usageKind: String = null, weightTotal: Double = 0.0, Asset: List[String] = null, AssetInfo: String = null, AssetModelCatalogueItems: List[String] = null, CatalogAssetType: String = null, Manufacturer: String = null, OperationalRestrictions: List[String] = null) extends Element with Product with Serializable
Asset model by a specific manufacturer.
Asset model by a specific manufacturer.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- catalogueNumber
Catalogue number for asset model.
- corporateStandardKind
Kind of corporate standard for this asset model.
- drawingNumber
Drawing number for asset model.
- instructionManual
Reference manual or instruction book for this asset model.
- modelNumber
Manufacturer's model number.
- modelVersion
Version number for product model, which indicates vintage of the product.
- overallLength
Overall length of this asset model.
- styleNumber
Style number of asset model.
- usageKind
Intended usage for this asset model.
- weightTotal
Total manufactured weight of asset.
- Asset
Asset An asset of this model.
- AssetInfo
AssetInfo Asset information (nameplate) for this product asset model.
- AssetModelCatalogueItems
AssetModelCatalogueItem undocumented
- CatalogAssetType
CatalogAssetType Catalog asset type to which this product asset model conforms.
- Manufacturer
Manufacturer Manufacturer of this asset model.
- OperationalRestrictions
OperationalRestriction All operational restrictions applying to this asset model.
-
final
case class
ProductBid(IdentifiedObject: IdentifiedObject = null, Bid: String = null, BidDistributionFactor: List[String] = null, BidHourlyProductSchedule: List[String] = null, BidSchedule: List[String] = null, BidSelfSched: List[String] = null, MarketProduct: String = null) extends Element with Product with Serializable
Component of a bid that pertains to one market product.
Component of a bid that pertains to one market product.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- Bid
Bid A bid comprises one or more product bids of market products
- BidDistributionFactor
BidDistributionFactor undocumented
- BidHourlyProductSchedule
BidHourlyProductSchedule undocumented
- BidSchedule
BidPriceSchedule undocumented
- BidSelfSched
BidSelfSched undocumented
- MarketProduct
MarketProduct undocumented
-
final
case class
Profile(IdentifiedObject: IdentifiedObject = null, ProfileDatas: List[String] = null) extends Element with Product with Serializable
A profile is a simpler curve type.
A profile is a simpler curve type.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ProfileDatas
ProfileData A profile has profile data associated with it.
-
final
case class
Profile2(IdentifiedObject: IdentifiedObject = null, DataSet: List[String] = null) extends Element with Product with Serializable
Describes the existence of a profile.
Describes the existence of a profile.
The MRID is usually defined as a static value by the document or artifact that defines the contents of the profile and the rules for using the profile.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- DataSet
DataSet The data sets that make use of the profile.
-
final
case class
ProfileData(Element: BasicElement = null, bidPrice: Double = 0.0, capacityLevel: Double = 0.0, energyLevel: Double = 0.0, minimumLevel: Double = 0.0, sequenceNumber: Int = 0, startDateTime: String = null, stopDateTime: String = null, Profile: List[String] = null) extends Element with Product with Serializable
Data for profile.
Data for profile.
- Element
Reference to the superclass object.
- bidPrice
Bid price associated with contract
- capacityLevel
Capacity level for the profile, in MW.
- energyLevel
Energy level for the profile, in MWH.
- minimumLevel
Minimum MW value of contract
- sequenceNumber
Sequence to provide item numbering for the profile. { greater than or equal to 1 }
- startDateTime
Start date/time for this profile.
- stopDateTime
Stop date/time for this profile.
- Profile
Profile A profile has profile data associated with it.
-
final
case class
Project(WorkDocument: WorkDocument = null, budget: Double = 0.0, BusinessCase: String = null, ErpProjectAccounting: String = null, ParentProject: String = null, SubProjects: List[String] = null, Works: List[String] = null) extends Element with Product with Serializable
A collection of related work.
A collection of related work.
For construction projects and maintenance projects, multiple phases may be performed.
- WorkDocument
WorkDocument Reference to the superclass object.
- budget
Overall project budget.
- BusinessCase
BusinessCase undocumented
- ErpProjectAccounting
ErpProjectAccounting undocumented
- ParentProject
Project undocumented
- SubProjects
Project undocumented
- Works
Work undocumented
-
final
case class
ProjectAlternative(NetworkModelProjectRelationship: NetworkModelProjectRelationship = null) extends Element with Product with Serializable
Project B is an alternative to project A.
Project B is an alternative to project A.
Project A is the primary alternative. Multiple project alternatives should not be selected into a single network study case.
- NetworkModelProjectRelationship
NetworkModelProjectRelationship Reference to the superclass object.
-
final
case class
ProjectDependency(NetworkModelProjectRelationship: NetworkModelProjectRelationship = null) extends Element with Product with Serializable
Project A change sets should be applied before Project B during case creation.
Project A change sets should be applied before Project B during case creation.
- NetworkModelProjectRelationship
NetworkModelProjectRelationship Reference to the superclass object.
-
final
case class
PropertyOrganisationRole(OrganisationRole: OrganisationRole = null, LandProperty: List[String] = null) extends Element with Product with Serializable
Role an organisation plays with respect to property (for example, the organisation may be the owner, renter, occupier, taxiing authority, etc.).
Role an organisation plays with respect to property (for example, the organisation may be the owner, renter, occupier, taxiing authority, etc.).
- OrganisationRole
OrganisationRole Reference to the superclass object.
- LandProperty
LandProperty undocumented
-
final
case class
PropertyUnit(WorkIdentifiedObject: WorkIdentifiedObject = null, accountingUsage: String = null, activityCode: String = null, propertyAccount: String = null, status: String = null, CUMaterialItems: List[String] = null, CompatibleUnits: List[String] = null, WorkCostDetails: List[String] = null) extends Element with Product with Serializable
Unit of property for reporting purposes.
Unit of property for reporting purposes.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- accountingUsage
A code that identifies appropriate type of property accounts such as distribution, streetlgihts, communications.
- activityCode
Activity code identifies a specific and distinguishable work action.
- propertyAccount
Used for property record accounting. For example, in the USA, this would be a FERC account.
- status
undocumented
- CUMaterialItems
CUMaterialItem undocumented
- CompatibleUnits
CompatibleUnit undocumented
- WorkCostDetails
WorkCostDetail undocumented
- final case class ProportionalDistributionComponent(EnergyComponent: EnergyComponent = null, distributionFactor: Double = 0.0) extends Element with Product with Serializable
-
final
case class
ProprietaryParameterDynamics(Element: BasicElement = null, booleanParameterValue: Boolean = false, floatParameterValue: Double = 0.0, integerParameterValue: Int = 0, parameterNumber: Int = 0, AsynchronousMachineUserDefined: String = null, CSCUserDefined: String = null, DiscontinuousExcitationControlUserDefined: String = null, ExcitationSystemUserDefined: String = null, LoadUserDefined: String = null, MechanicalLoadUserDefined: String = null, OverexcitationLimiterUserDefined: String = null, PFVArControllerType1UserDefined: String = null, PFVArControllerType2UserDefined: String = null, PowerSystemStabilizerUserDefined: String = null, SVCUserDefined: String = null, SynchronousMachineUserDefined: String = null, TurbineGovernorUserDefined: String = null, TurbineLoadControllerUserDefined: String = null, UnderexcitationLimiterUserDefined: String = null, VSCUserDefined: String = null, VoltageAdjusterUserDefined: String = null, VoltageCompensatorUserDefined: String = null, WindPlantUserDefined: String = null, WindType1or2UserDefined: String = null, WindType3or4UserDefined: String = null) extends Element with Product with Serializable
Supports definition of one or more parameters of several different datatypes for use by proprietary user-defined models.
Supports definition of one or more parameters of several different datatypes for use by proprietary user-defined models.
This class does not inherit from IdentifiedObject since it is not intended that a single instance of it be referenced by more than one proprietary user-defined model instance.
- Element
Reference to the superclass object.
- booleanParameterValue
Boolean parameter value. If this attribute is populated, integerParameterValue and floatParameterValue will not be.
- floatParameterValue
Floating point parameter value. If this attribute is populated, booleanParameterValue and integerParameterValue will not be.
- integerParameterValue
Integer parameter value. If this attribute is populated, booleanParameterValue and floatParameterValue will not be.
- parameterNumber
Sequence number of the parameter among the set of parameters associated with the related proprietary user-defined model.
- AsynchronousMachineUserDefined
AsynchronousMachineUserDefined Proprietary user-defined model with which this parameter is associated.
- CSCUserDefined
CSCUserDefined Proprietary user-defined model with which this parameter is associated.
- DiscontinuousExcitationControlUserDefined
DiscontinuousExcitationControlUserDefined Proprietary user-defined model with which this parameter is associated.
- ExcitationSystemUserDefined
ExcitationSystemUserDefined Proprietary user-defined model with which this parameter is associated.
- LoadUserDefined
LoadUserDefined Proprietary user-defined model with which this parameter is associated.
- MechanicalLoadUserDefined
MechanicalLoadUserDefined Proprietary user-defined model with which this parameter is associated.
- OverexcitationLimiterUserDefined
OverexcitationLimiterUserDefined Proprietary user-defined model with which this parameter is associated.
- PFVArControllerType1UserDefined
PFVArControllerType1UserDefined Proprietary user-defined model with which this parameter is associated.
- PFVArControllerType2UserDefined
PFVArControllerType2UserDefined Proprietary user-defined model with which this parameter is associated.
- PowerSystemStabilizerUserDefined
PowerSystemStabilizerUserDefined Proprietary user-defined model with which this parameter is associated.
- SVCUserDefined
SVCUserDefined Proprietary user-defined model with which this parameter is associated.
- SynchronousMachineUserDefined
SynchronousMachineUserDefined Proprietary user-defined model with which this parameter is associated.
- TurbineGovernorUserDefined
TurbineGovernorUserDefined Proprietary user-defined model with which this parameter is associated.
- TurbineLoadControllerUserDefined
TurbineLoadControllerUserDefined Proprietary user-defined model with which this parameter is associated.
- UnderexcitationLimiterUserDefined
UnderexcitationLimiterUserDefined Proprietary user-defined model with which this parameter is associated.
- VSCUserDefined
VSCUserDefined Proprietary user-defined model with which this parameter is associated.
- VoltageAdjusterUserDefined
VoltageAdjusterUserDefined Proprietary user-defined model with which this parameter is associated.
- VoltageCompensatorUserDefined
VoltageCompensatorUserDefined Proprietary user-defined model with which this parameter is associated.
- WindPlantUserDefined
WindPlantUserDefined Proprietary user-defined model with which this parameter is associated.
- WindType1or2UserDefined
WindType1or2UserDefined Proprietary user-defined model with which this parameter is associated.
- WindType3or4UserDefined
WindType3or4UserDefined Proprietary user-defined model with which this parameter is associated.
-
final
case class
ProtectedSwitch(Switch: Switch = null, breakingCapacity: Double = 0.0, OperatedByProtectionEquipment: List[String] = null, RecloseSequences: List[String] = null) extends Element with Product with Serializable
A ProtectedSwitch is a switching device that can be operated by ProtectionEquipment.
A ProtectedSwitch is a switching device that can be operated by ProtectionEquipment.
- Switch
Switch Reference to the superclass object.
- breakingCapacity
The maximum fault current a breaking device can break safely under prescribed conditions of use.
- OperatedByProtectionEquipment
ProtectionEquipment Protection equipments that operate this ProtectedSwitch.
- RecloseSequences
RecloseSequence A breaker may have zero or more automatic reclosures after a trip occurs.
-
final
case class
ProtectionEquipment(Equipment: Equipment = null, highLimit: Double = 0.0, lowLimit: Double = 0.0, powerDirectionFlag: Boolean = false, relayDelayTime: Double = 0.0, unitMultiplier: String = null, unitSymbol: String = null, ConductingEquipments: List[String] = null, ProtectedSwitches: List[String] = null, ProtectiveAction: List[String] = null) extends Element with Product with Serializable
An electrical device designed to respond to input conditions in a prescribed manner and after specified conditions are met to cause contact operation or similar abrupt change in associated electric control circuits, or simply to display the detected condition.
An electrical device designed to respond to input conditions in a prescribed manner and after specified conditions are met to cause contact operation or similar abrupt change in associated electric control circuits, or simply to display the detected condition.
Protection equipment is associated with conducting equipment and usually operate circuit breakers.
- Equipment
Equipment Reference to the superclass object.
- highLimit
The maximum allowable value.
- lowLimit
The minimum allowable value.
- powerDirectionFlag
Direction same as positive active power flow value.
- relayDelayTime
The time delay from detection of abnormal conditions to relay operation.
- unitMultiplier
The unit multiplier of the value.
- unitSymbol
The unit of measure of the value.
- ConductingEquipments
ConductingEquipment Protection equipment may be used to protect specific conducting equipment.
- ProtectedSwitches
ProtectedSwitch Protected switches operated by this ProtectionEquipment.
- ProtectiveAction
ProtectiveAction Protective action can emulate the action done by one or more protection equipment. In a node breaker model were protective equipment is model this association will be used.
-
final
case class
ProtectionEquipmentInfo(AssetInfo: AssetInfo = null, groundTrip: Double = 0.0, phaseTrip: Double = 0.0) extends Element with Product with Serializable
Properties of protection equipment asset.
Properties of protection equipment asset.
- AssetInfo
AssetInfo Reference to the superclass object.
- groundTrip
Actual ground trip for this type of relay, if applicable.
- phaseTrip
Actual phase trip for this type of relay, if applicable.
-
final
case class
ProtectiveAction(IdentifiedObject: IdentifiedObject = null, enabled: Boolean = false, normalEnabled: Boolean = false, GateComCondition: String = null, GateEnabledCondition: String = null, ProtectionEquipment: String = null, ProtectiveActionCollection: String = null) extends Element with Product with Serializable
A protective action for supporting the integrity of the power system.
A protective action for supporting the integrity of the power system.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- enabled
The status of the class set by operation or by signal. Optional field that will override other status fields.
- normalEnabled
The default/normal value used when other active signal/values are missing.
- GateComCondition
Gate undocumented
- GateEnabledCondition
Gate Association to a Gate that through a gate logic and input pin defines enabling of the ProtectiveAction.
- ProtectionEquipment
ProtectionEquipment undocumented
- ProtectiveActionCollection
ProtectiveActionCollection undocumented
-
final
case class
ProtectiveActionAdjustment(ProtectiveAction: ProtectiveAction = null, byPercentage: Double = 0.0, byValue: Double = 0.0, kind: String = null, reduce: Boolean = false, setValue: Double = 0.0, ConductingEquipment: String = null, DCConductingEquipment: String = null, Measurement: String = null) extends Element with Product with Serializable
Protective actions on non-switching equipment.
Protective actions on non-switching equipment.
The operating condition is adjusted.
- ProtectiveAction
ProtectiveAction Reference to the superclass object.
- byPercentage
The adjustment is given in percent of the active value.
- byValue
The adjustment is given in value of the active value.
- kind
Defines the kind of adjustment that should be done. With this value the correct attribute containing the value needs to be used.
- reduce
If true, the adjusted value is an reduction. Other wise it is an increase in the value.
- setValue
The adjustment is given by a new active value.
- ConductingEquipment
ConductingEquipment ConductingEquipment whose operating condition is changed when this protective action adjustment gets activated.
- DCConductingEquipment
DCConductingEquipment The operating condition to the Conducting Equipment is changed when protective action adjustment is activated.
- Measurement
Measurement The measurement is used to control the operation of an equipment.
-
final
case class
ProtectiveActionCollection(IdentifiedObject: IdentifiedObject = null, ProtectiveAction: List[String] = null, StageTrigger: List[String] = null) extends Element with Product with Serializable
A collection of protective actions to protect the integrity of the power system.
A collection of protective actions to protect the integrity of the power system.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ProtectiveAction
ProtectiveAction Set of ProtectiveAction belonging to a ProtectiveActionCollection.
- StageTrigger
StageTrigger When condition to the StageTrigger is met, the actions in the ProtectiveActionCollection are activated/triggered.
-
final
case class
ProtectiveActionEquipment(ProtectiveAction: ProtectiveAction = null, inService: Boolean = false, Equipment: String = null) extends Element with Product with Serializable
Protective action to put an Equipment in-service/out-of-service.
Protective action to put an Equipment in-service/out-of-service.
- ProtectiveAction
ProtectiveAction Reference to the superclass object.
- inService
If true the equipment is put in-service, otherwise out-of-service.
- Equipment
Equipment undocumented
-
final
case class
ProtectiveActionRegulation(ProtectiveAction: ProtectiveAction = null, isRegulating: Boolean = false, targetValue: Double = 0.0, RegulatingControl: String = null) extends Element with Product with Serializable
Protective action to change regulation to Equipment.
Protective action to change regulation to Equipment.
- ProtectiveAction
ProtectiveAction Reference to the superclass object.
- isRegulating
If true the regulator is put in-service, otherwise out-of-service (no regulation).
- targetValue
The target value specified the new case input for the regulator. The value has the units appropriate to the mode attribute. The protective action does not change the mode attribute.
- RegulatingControl
RegulatingControl undocumented
-
final
case class
ProvidedBilateralPoint(IdentifiedObject: IdentifiedObject = null, BilateralExchangeActor: String = null, IOPoint: String = null) extends Element with Product with Serializable
Allows declaration of ICCP points to be provided through a Bilateral Table agreement.
Allows declaration of ICCP points to be provided through a Bilateral Table agreement.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- BilateralExchangeActor
BilateralExchangeActor Remote peer that will receive ICCP information in a Bilateral table.
- IOPoint
IOPoint Measurement or control for the bilateral ICCP point.
-
final
case class
Pss1(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, kf: Double = 0.0, komega: Double = 0.0, kpe: Double = 0.0, ks: Double = 0.0, pmin: Double = 0.0, t10: Double = 0.0, t5: Double = 0.0, t6: Double = 0.0, t7: Double = 0.0, t8: Double = 0.0, t9: Double = 0.0, tpe: Double = 0.0, vadat: Boolean = false, vsmn: Double = 0.0, vsmx: Double = 0.0) extends Element with Product with Serializable
Italian PSS with three inputs (speed, frequency, power).
Italian PSS with three inputs (speed, frequency, power).
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- kf
Frequency power input gain (KF). Typical value = 5.
- komega
Shaft speed power input gain (Komega). Typical value = 0.
- kpe
Electric power input gain (KPE). Typical value = 0,3.
- ks
PSS gain (Ks). Typical value = 1.
- pmin
Minimum power PSS enabling (Pmin). Typical value = 0,25.
- t10
Lead/lag time constant (T10) (>= 0). Typical value = 0.
- t5
Washout (T5) (>= 0). Typical value = 3,5.
- t6
Filter time constant (T6) (>= 0). Typical value = 0.
- t7
Lead/lag time constant (T7) (>= 0). If = 0, both blocks are bypassed. Typical value = 0.
- t8
Lead/lag time constant (T8) (>= 0). Typical value = 0.
- t9
Lead/lag time constant (T9) (>= 0). If = 0, both blocks are bypassed. Typical value = 0.
- tpe
Electric power filter time constant (TPE) (>= 0). Typical value = 0,05.
- vadat
<font color="#0f0f0f">Signal selector (VADAT).</font> <font color="#0f0f0f">true = closed (generator power is greater than Pmin)</font> <font color="#0f0f0f">false = open (Pe is smaller than Pmin).</font> <font color="#0f0f0f">Typical value = true.</font>
- vsmn
Stabilizer output maximum limit (VSMN). Typical value = -0,06.
- vsmx
Stabilizer output minimum limit (VSMX). Typical value = 0,06.
-
final
case class
Pss1A(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, a1: Double = 0.0, a2: Double = 0.0, a3: Double = 0.0, a4: Double = 0.0, a5: Double = 0.0, a6: Double = 0.0, a7: Double = 0.0, a8: Double = 0.0, inputSignalType: String = null, kd: Boolean = false, ks: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, t5: Double = 0.0, t6: Double = 0.0, tdelay: Double = 0.0, vcl: Double = 0.0, vcu: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
Single input power system stabilizer.
Single input power system stabilizer.
It is a modified version in order to allow representation of various vendors' implementations on PSS type 1A.
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- a1
Notch filter parameter (A1).
- a2
Notch filter parameter (A2).
- a3
Notch filter parameter (A3).
- a4
Notch filter parameter (A4).
- a5
Notch filter parameter (A5).
- a6
Notch filter parameter (A6).
- a7
Notch filter parameter (A7).
- a8
Notch filter parameter (A8).
- inputSignalType
Type of input signal (rotorAngularFrequencyDeviation, busFrequencyDeviation, generatorElectricalPower, generatorAcceleratingPower, busVoltage, or busVoltageDerivative).
- kd
Selector (Kd). true = e-sTdelay used false = e-sTdelay not used.
- ks
Stabilizer gain (Ks).
- t1
Lead/lag time constant (T1) (>= 0).
- t2
Lead/lag time constant (T2) (>= 0).
- t3
Lead/lag time constant (T3) (>= 0).
- t4
Lead/lag time constant (T4) (>= 0).
- t5
Washout time constant (T5) (>= 0).
- t6
Transducer time constant (T6) (>= 0).
- tdelay
Time constant (Tdelay) (>= 0).
- vcl
Stabilizer input cutoff threshold (Vcl).
- vcu
Stabilizer input cutoff threshold (Vcu).
- vrmax
Maximum stabilizer output (Vrmax) (> Pss1A.vrmin).
- vrmin
Minimum stabilizer output (Vrmin) (< Pss1A.vrmax).
-
final
case class
Pss2B(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, a: Double = 0.0, ks1: Double = 0.0, ks2: Double = 0.0, ks3: Double = 0.0, ks4: Double = 0.0, m: Int = 0, n: Int = 0, t1: Double = 0.0, t10: Double = 0.0, t11: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, t6: Double = 0.0, t7: Double = 0.0, t8: Double = 0.0, t9: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tw1: Double = 0.0, tw2: Double = 0.0, tw3: Double = 0.0, tw4: Double = 0.0, vsi1max: Double = 0.0, vsi1min: Double = 0.0, vsi2max: Double = 0.0, vsi2min: Double = 0.0, vstmax: Double = 0.0, vstmin: Double = 0.0) extends Element with Product with Serializable
Modified IEEE PSS2B.
Modified IEEE PSS2B.
Extra lead/lag (or rate) block added at end (up to 4 lead/lags total).
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- a
Numerator constant (a). Typical value = 1.
- ks1
Stabilizer gain (Ks1). Typical value = 12.
- ks2
Gain on signal #2 (Ks2). Typical value = 0,2.
- ks3
Gain on signal #2 input before ramp-tracking filter (Ks3). Typical value = 1.
- ks4
Gain on signal #2 input after ramp-tracking filter (Ks4). Typical value = 1.
- m
Denominator order of ramp tracking filter (m). Typical value = 5.
- n
Order of ramp tracking filter (n). Typical value = 1.
- t1
Lead/lag time constant (T1) (>= 0). Typical value = 0,12.
- t10
Lead/lag time constant (T10) (>= 0). Typical value = 0.
- t11
Lead/lag time constant (T11) (>= 0). Typical value = 0.
- t2
Lead/lag time constant (T2) (>= 0). Typical value = 0,02.
- t3
Lead/lag time constant (T3) (>= 0). Typical value = 0,3.
- t4
Lead/lag time constant (T4) (>= 0). Typical value = 0,02.
- t6
Time constant on signal #1 (T6) (>= 0). Typical value = 0.
- t7
Time constant on signal #2 (T7) (>= 0). Typical value = 2.
- t8
Lead of ramp tracking filter (T8) (>= 0). Typical value = 0,2.
- t9
Lag of ramp tracking filter (T9) (>= 0). Typical value = 0,1.
- ta
Lead constant (Ta) (>= 0). Typical value = 0.
- tb
Lag time constant (Tb) (>= 0). Typical value = 0.
- tw1
First washout on signal #1 (Tw1) (>= 0). Typical value = 2.
- tw2
Second washout on signal #1 (Tw2) (>= 0). Typical value = 2.
- tw3
First washout on signal #2 (Tw3) (>= 0). Typical value = 2.
- tw4
Second washout on signal #2 (Tw4) (>= 0). Typical value = 0.
- vsi1max
Input signal #1 maximum limit (Vsi1max) (> Pss2B.vsi1min). Typical value = 2.
- vsi1min
Input signal #1 minimum limit (Vsi1min) (< Pss2B.vsi1max). Typical value = -2.
- vsi2max
Input signal #2 maximum limit (Vsi2max) (> Pss2B.vsi2min). Typical value = 2.
- vsi2min
Input signal #2 minimum limit (Vsi2min) (< Pss2B.vsi2max). Typical value = -2.
- vstmax
Stabilizer output maximum limit (Vstmax) (> Pss2B.vstmin). Typical value = 0,1.
- vstmin
Stabilizer output minimum limit (Vstmin) (< Pss2B.vstmax). Typical value = -0,1.
-
final
case class
Pss2ST(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, inputSignal1Type: String = null, inputSignal2Type: String = null, k1: Double = 0.0, k2: Double = 0.0, lsmax: Double = 0.0, lsmin: Double = 0.0, t1: Double = 0.0, t10: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, t5: Double = 0.0, t6: Double = 0.0, t7: Double = 0.0, t8: Double = 0.0, t9: Double = 0.0, vcl: Double = 0.0, vcu: Double = 0.0) extends Element with Product with Serializable
PTI microprocessor-based stabilizer type 1.
PTI microprocessor-based stabilizer type 1.
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- inputSignal1Type
Type of input signal #1 (rotorAngularFrequencyDeviation, busFrequencyDeviation, generatorElectricalPower, generatorAcceleratingPower, busVoltage, or busVoltageDerivative - shall be different than Pss2ST.inputSignal2Type). Typical value = rotorAngularFrequencyDeviation.
- inputSignal2Type
Type of input signal #2 (rotorAngularFrequencyDeviation, busFrequencyDeviation, generatorElectricalPower, generatorAcceleratingPower, busVoltage, or busVoltageDerivative - shall be different than Pss2ST.inputSignal1Type). Typical value = busVoltageDerivative.
- k1
Gain (K1).
- k2
Gain (K2).
- lsmax
Limiter (LSMAX) (> Pss2ST.lsmin).
- lsmin
Limiter (LSMIN) (< Pss2ST.lsmax).
- t1
Time constant (T1) (>= 0).
- t10
Time constant (T10) (>= 0).
- t2
Time constant (T2) (>= 0).
- t3
Time constant (T3) (>= 0).
- t4
Time constant (T4) (>= 0).
- t5
Time constant (T5) (>= 0).
- t6
Time constant (T6) (>= 0).
- t7
Time constant (T7) (>= 0).
- t8
Time constant (T8) (>= 0).
- t9
Time constant (T9) (>= 0).
- vcl
Cutoff limiter (VCL).
- vcu
Cutoff limiter (VCU).
-
final
case class
Pss5(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, ctw2: Boolean = false, deadband: Double = 0.0, isfreq: Boolean = false, kf: Double = 0.0, kpe: Double = 0.0, kpss: Double = 0.0, pmin: Double = 0.0, tl1: Double = 0.0, tl2: Double = 0.0, tl3: Double = 0.0, tl4: Double = 0.0, tpe: Double = 0.0, tw1: Double = 0.0, tw2: Double = 0.0, vadat: Boolean = false, vsmn: Double = 0.0, vsmx: Double = 0.0) extends Element with Product with Serializable
Detailed Italian PSS.
Detailed Italian PSS.
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- ctw2
Selector for second washout enabling (CTW2). true = second washout filter is bypassed false = second washout filter in use. Typical value = true.
- deadband
Stabilizer output deadband (DEADBAND). Typical value = 0.
- isfreq
Selector for frequency/shaft speed input (isFreq). true = speed (same meaning as InputSignaKind.rotorSpeed) false = frequency (same meaning as InputSignalKind.busFrequency). Typical value = true (same meaning as InputSignalKind.rotorSpeed).
- kf
Frequency/shaft speed input gain (KF). Typical value = 5.
- kpe
Electric power input gain (KPE). Typical value = 0,3.
- kpss
PSS gain (KPSS). Typical value = 1.
- pmin
Minimum power PSS enabling (Pmin). Typical value = 0,25.
- tl1
Lead/lag time constant (TL1) (>= 0). Typical value = 0.
- tl2
Lead/lag time constant (TL2) (>= 0). If = 0, both blocks are bypassed. Typical value = 0.
- tl3
Lead/lag time constant (TL3) (>= 0). Typical value = 0.
- tl4
Lead/lag time constant (TL4) (>= 0). If = 0, both blocks are bypassed. Typical value = 0.
- tpe
Electric power filter time constant (TPE) (>= 0). Typical value = 0,05.
- tw1
First washout (TW1) (>= 0). Typical value = 3,5.
- tw2
Second washout (TW2) (>= 0). Typical value = 0.
- vadat
<font color="#0f0f0f">Signal selector (VadAtt).</font> <font color="#0f0f0f">true = closed (generator power is greater than Pmin)</font> <font color="#0f0f0f">false = open (Pe is smaller than Pmin).</font> <font color="#0f0f0f">Typical value = true.</font>
- vsmn
Stabilizer output maximum limit (VSMN). Typical value = -0,1.
- vsmx
Stabilizer output minimum limit (VSMX). Typical value = 0,1.
-
final
case class
PssELIN2(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, apss: Double = 0.0, ks1: Double = 0.0, ks2: Double = 0.0, ppss: Double = 0.0, psslim: Double = 0.0, ts1: Double = 0.0, ts2: Double = 0.0, ts3: Double = 0.0, ts4: Double = 0.0, ts5: Double = 0.0, ts6: Double = 0.0) extends Element with Product with Serializable
Power system stabilizer typically associated with ExcELIN2 (though PssIEEE2B or Pss2B can also be used).
Power system stabilizer typically associated with ExcELIN2 (though PssIEEE2B or Pss2B can also be used).
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- apss
Coefficient (a_PSS). Typical value = 0,1.
- ks1
Gain (Ks1). Typical value = 1.
- ks2
Gain (Ks2). Typical value = 0,1.
- ppss
Coefficient (p_PSS) (>= 0 and <= 4). Typical value = 0,1.
- psslim
PSS limiter (psslim). Typical value = 0,1.
- ts1
Time constant (Ts1) (>= 0). Typical value = 0.
- ts2
Time constant (Ts2) (>= 0). Typical value = 1.
- ts3
Time constant (Ts3) (>= 0). Typical value = 1.
- ts4
Time constant (Ts4) (>= 0). Typical value = 0,1.
- ts5
Time constant (Ts5) (>= 0). Typical value = 0.
- ts6
Time constant (Ts6) (>= 0). Typical value = 1.
-
final
case class
PssIEEE1A(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, a1: Double = 0.0, a2: Double = 0.0, inputSignalType: String = null, ks: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, t5: Double = 0.0, t6: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type PSS1A power system stabilizer model.
IEEE 421.5-2005 type PSS1A power system stabilizer model.
PSS1A is the generalized form of a PSS with a single input signal. Reference: IEEE 1A 421.5-2005, 8.1.
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- a1
PSS signal conditioning frequency filter constant (A1). Typical value = 0,061.
- a2
PSS signal conditioning frequency filter constant (A2). Typical value = 0,0017.
- inputSignalType
Type of input signal (rotorAngularFrequencyDeviation, generatorElectricalPower, or busFrequencyDeviation). Typical value = rotorAngularFrequencyDeviation.
- ks
Stabilizer gain (Ks). Typical value = 5.
- t1
Lead/lag time constant (T1) (>= 0). Typical value = 0,3.
- t2
Lead/lag time constant (T2) (>= 0). Typical value = 0,03.
- t3
Lead/lag time constant (T3) (>= 0). Typical value = 0,3.
- t4
Lead/lag time constant (T4) (>= 0). Typical value = 0,03.
- t5
Washout time constant (T5) (>= 0). Typical value = 10.
- t6
Transducer time constant (T6) (>= 0). Typical value = 0,01.
- vrmax
Maximum stabilizer output (Vrmax) (> PssIEEE1A.vrmin). Typical value = 0,05.
- vrmin
Minimum stabilizer output (Vrmin) (< PssIEEE1A.vrmax). Typical value = -0,05.
-
final
case class
PssIEEE2B(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, inputSignal1Type: String = null, inputSignal2Type: String = null, ks1: Double = 0.0, ks2: Double = 0.0, ks3: Double = 0.0, m: Int = 0, n: Int = 0, t1: Double = 0.0, t10: Double = 0.0, t11: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, t6: Double = 0.0, t7: Double = 0.0, t8: Double = 0.0, t9: Double = 0.0, tw1: Double = 0.0, tw2: Double = 0.0, tw3: Double = 0.0, tw4: Double = 0.0, vsi1max: Double = 0.0, vsi1min: Double = 0.0, vsi2max: Double = 0.0, vsi2min: Double = 0.0, vstmax: Double = 0.0, vstmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type PSS2B power system stabilizer model.
IEEE 421.5-2005 type PSS2B power system stabilizer model.
This stabilizer model is designed to represent a variety of dual-input stabilizers, which normally use combinations of power and speed or frequency to derive the stabilizing signal. Reference: IEEE 2B 421.5-2005, 8.2.
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- inputSignal1Type
Type of input signal #1 (rotorAngularFrequencyDeviation, busFrequencyDeviation). Typical value = rotorAngularFrequencyDeviation.
- inputSignal2Type
Type of input signal #2 (generatorElectricalPower). Typical value = generatorElectricalPower.
- ks1
Stabilizer gain (Ks1). Typical value = 12.
- ks2
Gain on signal #2 (Ks2). Typical value = 0,2.
- ks3
Gain on signal #2 input before ramp-tracking filter (Ks3). Typical value = 1.
- m
Denominator order of ramp tracking filter (M). Typical value = 5.
- n
Order of ramp tracking filter (N). Typical value = 1.
- t1
Lead/lag time constant (T1) (>= 0). Typical value = 0,12.
- t10
Lead/lag time constant (T10) (>= 0). Typical value = 0.
- t11
Lead/lag time constant (T11) (>= 0). Typical value = 0.
- t2
Lead/lag time constant (T2) (>= 0). Typical value = 0,02.
- t3
Lead/lag time constant (T3) (>= 0). Typical value = 0,3.
- t4
Lead/lag time constant (T4) (>= 0). Typical value = 0,02.
- t6
Time constant on signal #1 (T6) (>= 0). Typical value = 0.
- t7
Time constant on signal #2 (T7) (>= 0). Typical value = 2.
- t8
Lead of ramp tracking filter (T8) (>= 0). Typical value = 0,2.
- t9
Lag of ramp tracking filter (T9) (>= 0). Typical value = 0,1.
- tw1
First washout on signal #1 (Tw1) (>= 0). Typical value = 2.
- tw2
Second washout on signal #1 (Tw2) (>= 0). Typical value = 2.
- tw3
First washout on signal #2 (Tw3) (>= 0). Typical value = 2.
- tw4
Second washout on signal #2 (Tw4) (>= 0). Typical value = 0.
- vsi1max
Input signal #1 maximum limit (Vsi1max) (> PssIEEE2B.vsi1min). Typical value = 2.
- vsi1min
Input signal #1 minimum limit (Vsi1min) (< PssIEEE2B.vsi1max). Typical value = -2.
- vsi2max
Input signal #2 maximum limit (Vsi2max) (> PssIEEE2B.vsi2min). Typical value = 2.
- vsi2min
Input signal #2 minimum limit (Vsi2min) (< PssIEEE2B.vsi2max). Typical value = -2.
- vstmax
Stabilizer output maximum limit (Vstmax) (> PssIEEE2B.vstmin). Typical value = 0,1.
- vstmin
Stabilizer output minimum limit (Vstmin) (< PssIEEE2B.vstmax). Typical value = -0,1.
-
final
case class
PssIEEE3B(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, a1: Double = 0.0, a2: Double = 0.0, a3: Double = 0.0, a4: Double = 0.0, a5: Double = 0.0, a6: Double = 0.0, a7: Double = 0.0, a8: Double = 0.0, ks1: Double = 0.0, ks2: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, tw1: Double = 0.0, tw2: Double = 0.0, tw3: Double = 0.0, vstmax: Double = 0.0, vstmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type PSS3B power system stabilizer model.
IEEE 421.5-2005 type PSS3B power system stabilizer model.
The PSS model PSS3B has dual inputs of electrical power and rotor angular frequency deviation. The signals are used to derive an equivalent mechanical power signal. This model has 2 input signals. They have the following fixed types (expressed in terms of InputSignalKind values): the first one is of rotorAngleFrequencyDeviation type and the second one is of generatorElectricalPower type. Reference: IEEE 3B 421.5-2005, 8.3.
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- a1
Notch filter parameter (A1). Typical value = 0,359.
- a2
Notch filter parameter (A2). Typical value = 0,586.
- a3
Notch filter parameter (A3). Typical value = 0,429.
- a4
Notch filter parameter (A4). Typical value = 0,564.
- a5
Notch filter parameter (A5). Typical value = 0,001.
- a6
Notch filter parameter (A6). Typical value = 0.
- a7
Notch filter parameter (A7). Typical value = 0,031.
- a8
Notch filter parameter (A8). Typical value = 0.
- ks1
Gain on signal # 1 (Ks1). Typical value = -0,602.
- ks2
Gain on signal # 2 (Ks2). Typical value = 30,12.
- t1
Transducer time constant (T1) (>= 0). Typical value = 0,012.
- t2
Transducer time constant (T2) (>= 0). Typical value = 0,012.
- tw1
Washout time constant (Tw1) (>= 0). Typical value = 0,3.
- tw2
Washout time constant (Tw2) (>= 0). Typical value = 0,3.
- tw3
Washout time constant (Tw3) (>= 0). Typical value = 0,6.
- vstmax
Stabilizer output maximum limit (Vstmax) (> PssIEEE3B.vstmin). Typical value = 0,1.
- vstmin
Stabilizer output minimum limit (Vstmin) (< PssIEEE3B.vstmax). Typical value = -0,1.
-
final
case class
PssIEEE4B(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, bwh1: Double = 0.0, bwh2: Double = 0.0, bwl1: Double = 0.0, bwl2: Double = 0.0, kh: Double = 0.0, kh1: Double = 0.0, kh11: Double = 0.0, kh17: Double = 0.0, kh2: Double = 0.0, ki: Double = 0.0, ki1: Double = 0.0, ki11: Double = 0.0, ki17: Double = 0.0, ki2: Double = 0.0, kl: Double = 0.0, kl1: Double = 0.0, kl11: Double = 0.0, kl17: Double = 0.0, kl2: Double = 0.0, omeganh1: Double = 0.0, omeganh2: Double = 0.0, omeganl1: Double = 0.0, omeganl2: Double = 0.0, th1: Double = 0.0, th10: Double = 0.0, th11: Double = 0.0, th12: Double = 0.0, th2: Double = 0.0, th3: Double = 0.0, th4: Double = 0.0, th5: Double = 0.0, th6: Double = 0.0, th7: Double = 0.0, th8: Double = 0.0, th9: Double = 0.0, ti1: Double = 0.0, ti10: Double = 0.0, ti11: Double = 0.0, ti12: Double = 0.0, ti2: Double = 0.0, ti3: Double = 0.0, ti4: Double = 0.0, ti5: Double = 0.0, ti6: Double = 0.0, ti7: Double = 0.0, ti8: Double = 0.0, ti9: Double = 0.0, tl1: Double = 0.0, tl10: Double = 0.0, tl11: Double = 0.0, tl12: Double = 0.0, tl2: Double = 0.0, tl3: Double = 0.0, tl4: Double = 0.0, tl5: Double = 0.0, tl6: Double = 0.0, tl7: Double = 0.0, tl8: Double = 0.0, tl9: Double = 0.0, vhmax: Double = 0.0, vhmin: Double = 0.0, vimax: Double = 0.0, vimin: Double = 0.0, vlmax: Double = 0.0, vlmin: Double = 0.0, vstmax: Double = 0.0, vstmin: Double = 0.0) extends Element with Product with Serializable
IEEE 421.5-2005 type PSS4B power system stabilizer.
IEEE 421.5-2005 type PSS4B power system stabilizer.
The PSS4B model represents a structure based on multiple working frequency bands. Three separate bands, respectively dedicated to the low-, intermediate- and high-frequency modes of oscillations, are used in this delta omega (speed input) PSS. There is an error in the in IEEE 421.5-2005 PSS4B model: the Pe input should read –Pe. This implies that the input Pe needs to be multiplied by -1. Reference: IEEE 4B 421.5-2005, 8.4. Parameter details: This model has 2 input signals. They have the following fixed types (expressed in terms of InputSignalKind values): the first one is of rotorAngleFrequencyDeviation type and the second one is of generatorElectricalPower type.
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- bwh1
Notch filter 1 (high-frequency band): three dB bandwidth (Bwi).
- bwh2
Notch filter 2 (high-frequency band): three dB bandwidth (Bwi).
- bwl1
Notch filter 1 (low-frequency band): three dB bandwidth (Bwi).
- bwl2
Notch filter 2 (low-frequency band): three dB bandwidth (Bwi).
- kh
High band gain (KH). Typical value = 120.
- kh1
High band differential filter gain (KH1). Typical value = 66.
- kh11
High band first lead-lag blocks coefficient (KH11). Typical value = 1.
- kh17
High band first lead-lag blocks coefficient (KH17). Typical value = 1.
- kh2
High band differential filter gain (KH2). Typical value = 66.
- ki
Intermediate band gain (KI). Typical value = 30.
- ki1
Intermediate band differential filter gain (KI1). Typical value = 66.
- ki11
Intermediate band first lead-lag blocks coefficient (KI11). Typical value = 1.
- ki17
Intermediate band first lead-lag blocks coefficient (KI17). Typical value = 1.
- ki2
Intermediate band differential filter gain (KI2). Typical value = 66.
- kl
Low band gain (KL). Typical value = 7.5.
- kl1
Low band differential filter gain (KL1). Typical value = 66.
- kl11
Low band first lead-lag blocks coefficient (KL11). Typical value = 1.
- kl17
Low band first lead-lag blocks coefficient (KL17). Typical value = 1.
- kl2
Low band differential filter gain (KL2). Typical value = 66.
- omeganh1
Notch filter 1 (high-frequency band): filter frequency (omegani).
- omeganh2
Notch filter 2 (high-frequency band): filter frequency (omegani).
- omeganl1
Notch filter 1 (low-frequency band): filter frequency (omegani).
- omeganl2
Notch filter 2 (low-frequency band): filter frequency (omegani).
- th1
High band time constant (TH1) (>= 0). Typical value = 0,01513.
- th10
High band time constant (TH10) (>= 0). Typical value = 0.
- th11
High band time constant (TH11) (>= 0). Typical value = 0.
- th12
High band time constant (TH12) (>= 0). Typical value = 0.
- th2
High band time constant (TH2) (>= 0). Typical value = 0,01816.
- th3
High band time constant (TH3) (>= 0). Typical value = 0.
- th4
High band time constant (TH4) (>= 0). Typical value = 0.
- th5
High band time constant (TH5) (>= 0). Typical value = 0.
- th6
High band time constant (TH6) (>= 0). Typical value = 0.
- th7
High band time constant (TH7) (>= 0). Typical value = 0,01816.
- th8
High band time constant (TH8) (>= 0). Typical value = 0,02179.
- th9
High band time constant (TH9) (>= 0). Typical value = 0.
- ti1
Intermediate band time constant (TI1) (>= 0). Typical value = 0,173.
- ti10
Intermediate band time constant (TI10) (>= 0). Typical value = 0.
- ti11
Intermediate band time constant (TI11) (>= 0). Typical value = 0.
- ti12
Intermediate band time constant (TI12) (>= 0). Typical value = 0.
- ti2
Intermediate band time constant (TI2) (>= 0). Typical value = 0,2075.
- ti3
Intermediate band time constant (TI3) (>= 0). Typical value = 0.
- ti4
Intermediate band time constant (TI4) (>= 0). Typical value = 0.
- ti5
Intermediate band time constant (TI5) (>= 0). Typical value = 0.
- ti6
Intermediate band time constant (TI6) (>= 0). Typical value = 0.
- ti7
Intermediate band time constant (TI7) (>= 0). Typical value = 0,2075.
- ti8
Intermediate band time constant (TI8) (>= 0). Typical value = 0,2491.
- ti9
Intermediate band time constant (TI9) (>= 0). Typical value = 0.
- tl1
Low band time constant (TL1) (>= 0). Typical value = 1,73.
- tl10
Low band time constant (TL10) (>= 0). Typical value = 0.
- tl11
Low band time constant (TL11) (>= 0). Typical value = 0.
- tl12
Low band time constant (TL12) (>= 0). Typical value = 0.
- tl2
Low band time constant (TL2) (>= 0). Typical value = 2,075.
- tl3
Low band time constant (TL3) (>= 0). Typical value = 0.
- tl4
Low band time constant (TL4) (>= 0). Typical value = 0.
- tl5
Low band time constant (TL5) (>= 0). Typical value = 0.
- tl6
Low band time constant (TL6) (>= 0). Typical value = 0.
- tl7
Low band time constant (TL7) (>= 0). Typical value = 2,075.
- tl8
Low band time constant (TL8) (>= 0). Typical value = 2,491.
- tl9
Low band time constant (TL9) (>= 0). Typical value = 0.
- vhmax
High band output maximum limit (VHmax) (> PssIEEE4B.vhmin). Typical value = 0,6.
- vhmin
High band output minimum limit (VHmin) (< PssIEEE4V.vhmax). Typical value = -0,6.
- vimax
Intermediate band output maximum limit (VImax) (> PssIEEE4B.vimin). Typical value = 0,6.
- vimin
Intermediate band output minimum limit (VImin) (< PssIEEE4B.vimax). Typical value = -0,6.
- vlmax
Low band output maximum limit (VLmax) (> PssIEEE4B.vlmin). Typical value = 0,075.
- vlmin
Low band output minimum limit (VLmin) (< PssIEEE4B.vlmax). Typical value = -0,075.
- vstmax
PSS output maximum limit (VSTmax) (> PssIEEE4B.vstmin). Typical value = 0,15.
- vstmin
PSS output minimum limit (VSTmin) (< PssIEEE4B.vstmax). Typical value = -0,15.
-
final
case class
PssPTIST1(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, dtc: Double = 0.0, dtf: Double = 0.0, dtp: Double = 0.0, k: Double = 0.0, m: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, tf: Double = 0.0, tp: Double = 0.0) extends Element with Product with Serializable
PTI microprocessor-based stabilizer type 1.
PTI microprocessor-based stabilizer type 1.
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- dtc
Time step related to activation of controls (deltatc) (>= 0). Typical value = 0,025.
- dtf
Time step frequency calculation (deltatf) (>= 0). Typical value = 0,025.
- dtp
Time step active power calculation (deltatp) (>= 0). Typical value = 0,0125.
- k
Gain (K). Typical value = 9.
- m
(M). M = 2 x H. Typical value = 5.
- t1
Time constant (T1) (>= 0). Typical value = 0,3.
- t2
Time constant (T2) (>= 0). Typical value = 1.
- t3
Time constant (T3) (>= 0). Typical value = 0,2.
- t4
Time constant (T4) (>= 0). Typical value = 0,05.
- tf
Time constant (Tf) (>= 0). Typical value = 0,2.
- tp
Time constant (Tp) (>= 0). Typical value = 0,2.
-
final
case class
PssPTIST3(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, a0: Double = 0.0, a1: Double = 0.0, a2: Double = 0.0, a3: Double = 0.0, a4: Double = 0.0, a5: Double = 0.0, al: Double = 0.0, athres: Double = 0.0, b0: Double = 0.0, b1: Double = 0.0, b2: Double = 0.0, b3: Double = 0.0, b4: Double = 0.0, b5: Double = 0.0, dl: Double = 0.0, dtc: Double = 0.0, dtf: Double = 0.0, dtp: Double = 0.0, isw: Boolean = false, k: Double = 0.0, lthres: Double = 0.0, m: Double = 0.0, nav: Double = 0.0, ncl: Double = 0.0, ncr: Double = 0.0, pmin: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, t5: Double = 0.0, t6: Double = 0.0, tf: Double = 0.0, tp: Double = 0.0) extends Element with Product with Serializable
PTI microprocessor-based stabilizer type 3.
PTI microprocessor-based stabilizer type 3.
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- a0
Filter coefficient (A0).
- a1
Limiter (Al).
- a2
Filter coefficient (A2).
- a3
Filter coefficient (A3).
- a4
Filter coefficient (A4).
- a5
Filter coefficient (A5).
- al
Limiter (Al).
- athres
Threshold value above which output averaging will be bypassed (Athres). Typical value = 0,005.
- b0
Filter coefficient (B0).
- b1
Filter coefficient (B1).
- b2
Filter coefficient (B2).
- b3
Filter coefficient (B3).
- b4
Filter coefficient (B4).
- b5
Filter coefficient (B5).
- dl
Limiter (Dl).
- dtc
Time step related to activation of controls (deltatc) (>= 0). Typical value = 0,025 (0,03 for 50 Hz).
- dtf
Time step frequency calculation (deltatf) (>= 0). Typical value = 0,025 (0,03 for 50 Hz).
- dtp
Time step active power calculation (deltatp) (>= 0). Typical value = 0,0125 (0,015 for 50 Hz).
- isw
Digital/analogue output switch (Isw). true = produce analogue output false = convert to digital output, using tap selection table.
- k
Gain (K). Typical value = 9.
- lthres
Threshold value (Lthres).
- m
(M). M = 2 x H. Typical value = 5.
- nav
Number of control outputs to average (NAV) (1 <= NAV <= 16). Typical value = 4.
- ncl
Number of counts at limit to active limit function (NCL) (> 0).
- ncr
Number of counts until reset after limit function is triggered (NCR).
- pmin
(Pmin).
- t1
Time constant (T1) (>= 0). Typical value = 0,3.
- t2
Time constant (T2) (>= 0). Typical value = 1.
- t3
Time constant (T3) (>= 0). Typical value = 0,2.
- t4
Time constant (T4) (>= 0). Typical value = 0,05.
- t5
Time constant (T5) (>= 0).
- t6
Time constant (T6) (>= 0).
- tf
Time constant (Tf) (>= 0). Typical value = 0,2.
- tp
Time constant (Tp) (>= 0). Typical value = 0,2.
-
final
case class
PssRQB(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, kdpm: Double = 0.0, ki2: Double = 0.0, ki3: Double = 0.0, ki4: Double = 0.0, sibv: Double = 0.0, t4f: Double = 0.0, t4m: Double = 0.0, t4mom: Double = 0.0, tomd: Double = 0.0, tomsl: Double = 0.0) extends Element with Product with Serializable
Power system stabilizer type RQB.
Power system stabilizer type RQB.
This power system stabilizer is intended to be used together with excitation system type ExcRQB, which is primarily used in nuclear or thermal generating units.
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- kdpm
Lead lag gain (KDPM). Typical value = 0,185.
- ki2
Speed input gain (Ki2). Typical value = 3,43.
- ki3
Electrical power input gain (Ki3). Typical value = -11,45.
- ki4
Mechanical power input gain (Ki4). Typical value = 11,86.
- sibv
Speed deadband (SIBV). Typical value = 0,006.
- t4f
Lead lag time constant (T4F) (>= 0). Typical value = 0,045.
- t4m
Input time constant (T4M) (>= 0). Typical value = 5.
- t4mom
Speed time constant (T4MOM) (>= 0). Typical value = 1,27.
- tomd
Speed delay (TOMD) (>= 0). Typical value = 0,02.
- tomsl
Speed time constant (TOMSL) (>= 0). Typical value = 0,04.
-
final
case class
PssSB4(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, kx: Double = 0.0, ta: Double = 0.0, tb: Double = 0.0, tc: Double = 0.0, td: Double = 0.0, te: Double = 0.0, tt: Double = 0.0, tx1: Double = 0.0, tx2: Double = 0.0, vsmax: Double = 0.0, vsmin: Double = 0.0) extends Element with Product with Serializable
Power sensitive stabilizer model.
Power sensitive stabilizer model.
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- kx
Gain (Kx). Typical value = 2,7.
- ta
Time constant (Ta) (>= 0). Typical value = 0,37.
- tb
Time constant (Tb) (>= 0). Typical value = 0,37.
- tc
Time constant (Tc) (>= 0). Typical value = 0,035.
- td
Time constant (Td) (>= 0). Typical value = 0,0.
- te
Time constant (Te) (>= 0). Typical value = 0,0169.
- tt
Time constant (Tt) (>= 0). Typical value = 0,18.
- tx1
Reset time constant (Tx1) (>= 0). Typical value = 0,035.
- tx2
Time constant (Tx2) (>= 0). Typical value = 5,0.
- vsmax
Limiter (Vsmax) (> PssSB4.vsmin). Typical value = 0,062.
- vsmin
Limiter (Vsmin) (< PssSB4.vsmax). Typical value = -0,062.
-
final
case class
PssSH(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, k: Double = 0.0, k0: Double = 0.0, k1: Double = 0.0, k2: Double = 0.0, k3: Double = 0.0, k4: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, td: Double = 0.0, vsmax: Double = 0.0, vsmin: Double = 0.0) extends Element with Product with Serializable
SiemensTM “H infinity” power system stabilizer with generator electrical power input.
SiemensTM “H infinity” power system stabilizer with generator electrical power input. [Footnote: Siemens "H infinity" power system stabilizers are an example of suitable products available commercially.
This information is given for the convenience of users of this document and does not constitute an endorsement by IEC of these products.]
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- k
Main gain (K). Typical value = 1.
- k0
Gain 0 (K0). Typical value = 0,012.
- k1
Gain 1 (K1). Typical value = 0,488.
- k2
Gain 2 (K2). Typical value = 0,064.
- k3
Gain 3 (K3). Typical value = 0,224.
- k4
Gain 4 (K4). Typical value = 0,1.
- t1
Time constant 1 (T1) (> 0). Typical value = 0,076.
- t2
Time constant 2 (T2) (> 0). Typical value = 0,086.
- t3
Time constant 3 (T3) (> 0). Typical value = 1,068.
- t4
Time constant 4 (T4) (> 0). Typical value = 1,913.
- td
Input time constant (Td) (>= 0). Typical value = 10.
- vsmax
Output maximum limit (Vsmax) (> PssSH.vsmin). Typical value = 0,1.
- vsmin
Output minimum limit (Vsmin) (< PssSH.vsmax). Typical value = -0,1.
-
final
case class
PssSK(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, k1: Double = 0.0, k2: Double = 0.0, k3: Double = 0.0, t1: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, t5: Double = 0.0, t6: Double = 0.0, vsmax: Double = 0.0, vsmin: Double = 0.0) extends Element with Product with Serializable
Slovakian PSS with three inputs.
Slovakian PSS with three inputs.
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- k1
Gain P (K1). Typical value = -0,3.
- k2
Gain fE (K2). Typical value = -0,15.
- k3
Gain If (K3). Typical value = 10.
- t1
Denominator time constant (T1) (> 0,005). Typical value = 0,3.
- t2
Filter time constant (T2) (> 0,005). Typical value = 0,35.
- t3
Denominator time constant (T3) (> 0,005). Typical value = 0,22.
- t4
Filter time constant (T4) (> 0,005). Typical value = 0,02.
- t5
Denominator time constant (T5) (> 0,005). Typical value = 0,02.
- t6
Filter time constant (T6) (> 0,005). Typical value = 0,02.
- vsmax
Stabilizer output maximum limit (VSMAX) (> PssSK.vsmin). Typical value = 0,4.
- vsmin
Stabilizer output minimum limit (VSMIN) (< PssSK.vsmax). Typical value = -0.4.
-
final
case class
PssSTAB2A(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, hlim: Double = 0.0, k2: Double = 0.0, k3: Double = 0.0, k4: Double = 0.0, k5: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t5: Double = 0.0) extends Element with Product with Serializable
Power system stabilizer part of an ABB excitation system.
Power system stabilizer part of an ABB excitation system. [Footnote: ABB excitation systems are an example of suitable products available commercially.
This information is given for the convenience of users of this document and does not constitute an endorsement by IEC of these products.]
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- hlim
Stabilizer output limiter (HLIM). Typical value = 0,5.
- k2
Gain (K2). Typical value = 1,0.
- k3
Gain (K3). Typical value = 0,25.
- k4
Gain (K4). Typical value = 0,075.
- k5
Gain (K5). Typical value = 2,5.
- t2
Time constant (T2). Typical value = 4,0.
- t3
Time constant (T3). Typical value = 2,0.
- t5
Time constant (T5). Typical value = 4,5.
-
final
case class
PssWECC(PowerSystemStabilizerDynamics: PowerSystemStabilizerDynamics = null, inputSignal1Type: String = null, inputSignal2Type: String = null, k1: Double = 0.0, k2: Double = 0.0, t1: Double = 0.0, t10: Double = 0.0, t2: Double = 0.0, t3: Double = 0.0, t4: Double = 0.0, t5: Double = 0.0, t6: Double = 0.0, t7: Double = 0.0, t8: Double = 0.0, t9: Double = 0.0, vcl: Double = 0.0, vcu: Double = 0.0, vsmax: Double = 0.0, vsmin: Double = 0.0) extends Element with Product with Serializable
Dual input power system stabilizer, based on IEEE type 2, with modified output limiter defined by WECC (Western Electricity Coordinating Council, USA).
Dual input power system stabilizer, based on IEEE type 2, with modified output limiter defined by WECC (Western Electricity Coordinating Council, USA).
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Reference to the superclass object.
- inputSignal1Type
Type of input signal #1 (rotorAngularFrequencyDeviation, busFrequencyDeviation, generatorElectricalPower, generatorAcceleratingPower, busVoltage, or busVoltageDerivative - shall be different than PssWECC.inputSignal2Type). Typical value = rotorAngularFrequencyDeviation.
- inputSignal2Type
Type of input signal #2 (rotorAngularFrequencyDeviation, busFrequencyDeviation, generatorElectricalPower, generatorAcceleratingPower, busVoltage, busVoltageDerivative - shall be different than PssWECC.inputSignal1Type). Typical value = busVoltageDerivative.
- k1
Input signal 1 gain (K1). Typical value = 1,13.
- k2
Input signal 2 gain (K2). Typical value = 0,0.
- t1
Input signal 1 transducer time constant (T1) (>= 0). Typical value = 0,037.
- t10
Lag time constant (T10) (>= 0). Typical value = 0.
- t2
Input signal 2 transducer time constant (T2) (>= 0). Typical value = 0,0.
- t3
Stabilizer washout time constant (T3) (>= 0). Typical value = 9,5.
- t4
Stabilizer washout time lag constant (T4) (>= 0). Typical value = 9,5.
- t5
Lead time constant (T5) (>= 0). Typical value = 1,7.
- t6
Lag time constant (T6) (>= 0). Typical value = 1,5.
- t7
Lead time constant (T7) (>= 0). Typical value = 1,7.
- t8
Lag time constant (T8) (>= 0). Typical value = 1,5.
- t9
Lead time constant (T9) (>= 0). Typical value = 0.
- vcl
Minimum value for voltage compensator output (VCL). Typical value = 0.
- vcu
Maximum value for voltage compensator output (VCU). Typical value = 0.
- vsmax
Maximum output signal (Vsmax) (> PssWECC.vsmin). Typical value = 0,05.
- vsmin
Minimum output signal (Vsmin) (< PssWECC.vsmax). Typical value = -0,05.
-
final
case class
PublicX509Certificate(Element: BasicElement = null, issuerName: String = null, serialNumber: String = null, ISOUpperLayer: String = null, TCPAccessPoint: String = null) extends Element with Product with Serializable
Used to convey information that will allow matching in order to determine which certificate to use.
Used to convey information that will allow matching in order to determine which certificate to use.
Actual certificates are exchanged externally to the CIM exchange.
- Element
Reference to the superclass object.
- issuerName
Represents the CA that issued the certificate. Defined to be per X.509.
- serialNumber
Is the serial number of the certificate per X.509 definition.
- ISOUpperLayer
ISOUpperLayer Application layer used with the certificate for mutual authentication.
- TCPAccessPoint
TCPAccessPoint The association allows a certificate to be bound for use by TLS.
-
final
case class
PumpingCostSchedule(BidHourlyProductSchedule: BidHourlyProductSchedule = null, value: Double = 0.0) extends Element with Product with Serializable
The operating cost of a Pump Storage Hydro Unit operating as a hydro pump.
The operating cost of a Pump Storage Hydro Unit operating as a hydro pump.
This schedule is assocated with the hourly parameters in a resource bid associated with a specific product within the bid.
- BidHourlyProductSchedule
BidHourlyProductSchedule Reference to the superclass object.
- value
undocumented
-
final
case class
PumpingLevelSchedule(BidHourlyProductSchedule: BidHourlyProductSchedule = null, value: Double = 0.0) extends Element with Product with Serializable
The fixed operating level of a Pump Storage Hydro Unit operating as a hydro pump.
The fixed operating level of a Pump Storage Hydro Unit operating as a hydro pump.
Associated with the energy market product type.
This schedule is assocated with the hourly parameters in a resource bid associated with a specific product within the bid.
- BidHourlyProductSchedule
BidHourlyProductSchedule Reference to the superclass object.
- value
undocumented
-
final
case class
PumpingShutDownCostSchedule(BidHourlyProductSchedule: BidHourlyProductSchedule = null, value: Double = 0.0) extends Element with Product with Serializable
The cost to shutdown a Pump Storage Hydro Unit (in pump mode) or a pump.
The cost to shutdown a Pump Storage Hydro Unit (in pump mode) or a pump.
This schedule is assocated with the hourly parameters in a resource bid associated with a specific product within the bid.
- BidHourlyProductSchedule
BidHourlyProductSchedule Reference to the superclass object.
- value
undocumented
- final case class Qlimiter(Element: BasicElement = null, Delay: String = null, VSCtype1: String = null) extends Element with Product with Serializable
- final case class Qmode(Element: BasicElement = null, Delay: String = null, VSCtype1: String = null) extends Element with Product with Serializable
- final case class Qregulator(Element: BasicElement = null, Delay: String = null, HVDClookUpTable: List[String] = null, VSCtype1: String = null) extends Element with Product with Serializable
-
final
case class
QualificationRequirement(WorkIdentifiedObject: WorkIdentifiedObject = null, qualificationID: String = null, CULaborItems: List[String] = null, Skills: List[String] = null, Specifications: List[String] = null, WorkTasks: List[String] = null) extends Element with Product with Serializable
Certain skills are required and must be certified in order for a person (typically a member of a crew) to be qualified to work on types of equipment.
Certain skills are required and must be certified in order for a person (typically a member of a crew) to be qualified to work on types of equipment.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- qualificationID
Qualification identifier.
- CULaborItems
CULaborItem undocumented
- Skills
Skill undocumented
- Specifications
Specification undocumented
- WorkTasks
OldWorkTask undocumented
-
final
case class
Quality61850(Element: BasicElement = null, badReference: Boolean = false, estimatorReplaced: Boolean = false, failure: Boolean = false, oldData: Boolean = false, operatorBlocked: Boolean = false, oscillatory: Boolean = false, outOfRange: Boolean = false, overFlow: Boolean = false, source: String = null, suspect: Boolean = false, test: Boolean = false, validity: String = null) extends Element with Product with Serializable
Quality flags in this class are as defined in IEC 61850, except for estimatorReplaced, which has been included in this class for convenience.
Quality flags in this class are as defined in IEC 61850, except for estimatorReplaced, which has been included in this class for convenience.
- Element
Reference to the superclass object.
- badReference
Measurement value may be incorrect due to a reference being out of calibration.
- estimatorReplaced
Value has been replaced by State Estimator. estimatorReplaced is not an IEC61850 quality bit but has been put in this class for convenience.
- failure
This identifier indicates that a supervision function has detected an internal or external failure, e.g. communication failure.
- oldData
Measurement value is old and possibly invalid, as it has not been successfully updated during a specified time interval.
- operatorBlocked
Measurement value is blocked and hence unavailable for transmission.
- oscillatory
To prevent some overload of the communication it is sensible to detect and suppress oscillating (fast changing) binary inputs. If a signal changes in a defined time twice in the same direction (from 0 to 1 or from 1 to 0) then oscillation is detected and the detail quality identifier "oscillatory" is set. If it is detected a configured numbers of transient changes could be passed by. In this time the validity status "questionable" is set. If after this defined numbers of changes the signal is still in the oscillating state the value shall be set either to the opposite state of the previous stable value or to a defined default value. In this case the validity status "questionable" is reset and "invalid" is set as long as the signal is oscillating. If it is configured such that no transient changes should be passed by then the validity status "invalid" is set immediately in addition to the detail quality identifier "oscillatory" (used for status information only).
- outOfRange
Measurement value is beyond a predefined range of value.
- overFlow
Measurement value is beyond the capability of being represented properly. For example, a counter value overflows from maximum count back to a value of zero.
- source
Source gives information related to the origin of a value. The value may be acquired from the process, defaulted or substituted.
- suspect
A correlation function has detected that the value is not consistent with other values. Typically set by a network State Estimator.
- test
Measurement value is transmitted for test purposes.
- validity
Validity of the measurement value.
-
final
case class
Quantity(Element: BasicElement = null, quality: String = null, quantity: Double = 0.0, type: String = null, Detail_Quantity: List[String] = null, Domain: List[String] = null, Point: List[String] = null, TimeSeries: List[String] = null) extends Element with Product with Serializable
Description of quantities needed in the data exchange.
Description of quantities needed in the data exchange.
The type of the quantity is described either by the role of the association or the type attribute. The quality attribute provides the information about the quality of the quantity (measured, estimated, etc.).
- Element
Reference to the superclass object.
- quality
The quality of the information being provided. This quality may be estimated, not available, as provided, etc.
- quantity
The quantity value. The association role provides the information about what is expressed.
- type
The description of the type of the quantity.
- Detail_Quantity
Quantity Additional information related to the associated quantity.
- Domain
Domain undocumented
- Point
Point undocumented
- TimeSeries
TimeSeries undocumented
-
final
case class
RMRDetermination(Element: BasicElement = null, Bid: String = null, MitigatedBidClearing: List[String] = null) extends Element with Product with Serializable
Indicates whether unit is a reliablity must run unit: required to be on to satisfy Grid Code Reliablitiy criteria, load demand, or voltage support.
Indicates whether unit is a reliablity must run unit: required to be on to satisfy Grid Code Reliablitiy criteria, load demand, or voltage support.
- Element
Reference to the superclass object.
- Bid
Bid undocumented
- MitigatedBidClearing
MitigatedBidClearing undocumented
-
final
case class
RMRHeatRateCurve(Curve: Curve = null, RegisteredGenerator: String = null) extends Element with Product with Serializable
Model to support processing of reliability must run units.
Model to support processing of reliability must run units.
- Curve
Curve Reference to the superclass object.
- RegisteredGenerator
RegisteredGenerator undocumented
-
final
case class
RMROperatorInput(MarketFactors: MarketFactors = null, manuallySchedRMRMw: Double = 0.0, updateTimeStamp: String = null, updateType: String = null, updateUser: String = null, RegisteredResource: String = null) extends Element with Product with Serializable
RMR Operator's entry of the RMR requirement per market interval.
RMR Operator's entry of the RMR requirement per market interval.
- MarketFactors
MarketFactors Reference to the superclass object.
- manuallySchedRMRMw
The lower of the original pre-dispatch or the AC run schedule (Also known as the RMR Reguirement) becomes the pre-dispatch value.
- updateTimeStamp
undocumented
- updateType
undocumented
- updateUser
undocumented
- RegisteredResource
RegisteredResource undocumented
-
final
case class
RMRStartUpCostCurve(Curve: Curve = null, RegisteredGenerator: String = null) extends Element with Product with Serializable
Model to support processing of reliability must run units.
Model to support processing of reliability must run units.
- Curve
Curve Reference to the superclass object.
- RegisteredGenerator
RegisteredGenerator undocumented
-
final
case class
RMRStartUpEnergyCurve(Curve: Curve = null, RegisteredGenerator: String = null) extends Element with Product with Serializable
Model to support processing of reliability must run units.
Model to support processing of reliability must run units.
- Curve
Curve Reference to the superclass object.
- RegisteredGenerator
RegisteredGenerator undocumented
-
final
case class
RMRStartUpFuelCurve(Curve: Curve = null, RegisteredGenerator: String = null) extends Element with Product with Serializable
Model to support processing of reliability must run units.
Model to support processing of reliability must run units.
- Curve
Curve Reference to the superclass object.
- RegisteredGenerator
RegisteredGenerator undocumented
-
final
case class
RMRStartUpTimeCurve(Curve: Curve = null, RegisteredGenerator: String = null) extends Element with Product with Serializable
Model to support processing of reliability must run units.
Model to support processing of reliability must run units.
- Curve
Curve Reference to the superclass object.
- RegisteredGenerator
RegisteredGenerator undocumented
-
final
case class
RTO(MarketParticipant: MarketParticipant = null, AdjacentCASet: List[String] = null, AggregateNode: List[String] = null, CommodityDefinition: List[String] = null, EnergyMarkets: List[String] = null, FuelRegion: List[String] = null, HostControlArea: List[String] = null, LocalReliabilityArea: List[String] = null, MSSAggregation: List[String] = null, MktConnectivityNode: List[String] = null, Pnodes: List[String] = null, ResourceGroupReqs: List[String] = null, SecurityConstraints: List[String] = null, SecurityConstraintsLinear: List[String] = null, SubControlArea: List[String] = null, TransmissionContractRight: List[String] = null, TransmissionRightChain: List[String] = null) extends Element with Product with Serializable
Regional transmission operator.
Regional transmission operator.
- MarketParticipant
MarketParticipant Reference to the superclass object.
- AdjacentCASet
AdjacentCASet undocumented
- AggregateNode
AggregateNode undocumented
- CommodityDefinition
CommodityDefinition undocumented
- EnergyMarkets
EnergyMarket undocumented
- FuelRegion
FuelRegion undocumented
- HostControlArea
HostControlArea undocumented
- LocalReliabilityArea
LocalReliabilityArea undocumented
- MSSAggregation
MSSAggregation undocumented
- MktConnectivityNode
MktConnectivityNode undocumented
- Pnodes
Pnode undocumented
- ResourceGroupReqs
ResourceGroupReq undocumented
- SecurityConstraints
SecurityConstraints undocumented
- SecurityConstraintsLinear
SecurityConstraintSum undocumented
- SubControlArea
SubControlArea undocumented
- TransmissionContractRight
ContractRight undocumented
- TransmissionRightChain
TransmissionRightChain undocumented
-
final
case class
RUCAwardInstruction(Element: BasicElement = null, clearedPrice: Double = 0.0, marketProductType: String = null, updateTimeStamp: String = null, updateType: String = null, updateUser: String = null, ClearingResourceAward: List[String] = null, RUCAward: Double = 0.0, RUCCapacity: Double = 0.0, RUCSchedule: Double = 0.0, RegisteredResource: String = null) extends Element with Product with Serializable
This class models the information about the RUC awards.
This class models the information about the RUC awards.
- Element
Reference to the superclass object.
- clearedPrice
Marginal Price ($/MW) for the commodity (Regulation Up, Regulation Down, Spinning Reserve, or Non-spinning reserve) for pricing run.
- marketProductType
major product type may include the following but not limited to: Energy Regulation Up Regulation Dn Spinning Reserve Non-Spinning Reserve Operating Reserve
- updateTimeStamp
undocumented
- updateType
undocumented
- updateUser
undocumented
- ClearingResourceAward
ResourceAwardClearing undocumented
- RUCAward
The RUC Award of a resource is the portion of the RUC Capacity that is not under RA or RMR contracts. The RUC Award of a resource is the portion of the RUC Capacity that is eligible for RUC Availability payment.
- RUCCapacity
The RUC Capacity of a resource is the difference between (i) the RUC Schedule and (ii) the higher of the DA Schedule and the Minimum Load.
- RUCSchedule
The RUC Schedule of a resource is its output level that balances the load forecast used in RUC. The RUC Schedule in RUC is similar to the DA Schedule in DAM.
- RegisteredResource
RegisteredResource undocumented
-
final
case class
RUCZone(AggregateNode: AggregateNode = null, LossClearingResults: List[String] = null) extends Element with Product with Serializable
A specialized class of type AggregatedNode type.
A specialized class of type AggregatedNode type.
Defines RUC Zones. A forecast region represents a collection of Nodes for which the Market operator has developed sufficient historical demand and relevant weather data to perform a demand forecast for such area. The Market Operator may further adjust this forecast to ensure that the Reliability Unit Commitment produces adequate local capacity procurement.
- AggregateNode
AggregateNode Reference to the superclass object.
- LossClearingResults
LossClearingResults undocumented
-
final
case class
RaiseLowerCommand(AnalogControl: AnalogControl = null, ValueAliasSet: String = null) extends Element with Product with Serializable
An analog control that increases or decreases a set point value with pulses.
An analog control that increases or decreases a set point value with pulses.
Unless otherwise specified, one pulse moves the set point by one.
- AnalogControl
AnalogControl Reference to the superclass object.
- ValueAliasSet
ValueAliasSet The ValueAliasSet used for translation of a Control value to a name.
-
final
case class
RampRateCurve(Curve: Curve = null, condition: String = null, constraintRampType: String = null, rampRateType: String = null, GeneratingBid: String = null, InterTieBid: String = null, LoadBid: String = null, RegisteredResource: List[String] = null) extends Element with Product with Serializable
Ramp rate as a function of resource MW output.
Ramp rate as a function of resource MW output.
- Curve
Curve Reference to the superclass object.
- condition
condition for the ramp rate
- constraintRampType
The condition that identifies whether a Generating Resource should be constrained from Ancillary Service provision if its Schedule or Dispatch change across Trading Hours or Trading Intervals requires more than a specified fraction of the duration of the Trading Hour or Trading Interval. Valid values are Fast/Slow
- rampRateType
How ramp rate is applied (e.g. raise or lower, as when applied to a generation resource)
- GeneratingBid
GeneratingBid undocumented
- InterTieBid
InterTieBid undocumented
- LoadBid
LoadBid undocumented
- RegisteredResource
RegisteredResource undocumented
-
final
case class
Ratio(Element: BasicElement = null, denominator: Double = 0.0, numerator: Double = 0.0) extends Element with Product with Serializable
Fraction specified explicitly with a numerator and denominator, which can be used to calculate the quotient.
Fraction specified explicitly with a numerator and denominator, which can be used to calculate the quotient.
- Element
Reference to the superclass object.
- denominator
The part of a fraction that is below the line and that functions as the divisor of the numerator.
- numerator
The part of a fraction that is above the line and signifies the number to be divided by the denominator.
-
final
case class
RatioTapChanger(TapChanger: TapChanger = null, stepVoltageIncrement: Double = 0.0, tculControlMode: String = null, RatioTapChangerTable: String = null, TransformerEnd: String = null) extends Element with Product with Serializable
A tap changer that changes the voltage ratio impacting the voltage magnitude but not the phase angle across the transformer.
A tap changer that changes the voltage ratio impacting the voltage magnitude but not the phase angle across the transformer.
Angle sign convention (general): Positive value indicates a positive phase shift from the winding where the tap is located to the other winding (for a two-winding transformer).
- TapChanger
TapChanger Reference to the superclass object.
- stepVoltageIncrement
Tap step increment, in per cent of rated voltage of the power transformer end, per step position. When the increment is negative, the voltage decreases when the tap step increases.
- tculControlMode
Specifies the regulation control mode (voltage or reactive) of the RatioTapChanger.
- RatioTapChangerTable
RatioTapChangerTable The tap ratio table for this ratio tap changer.
- TransformerEnd
TransformerEnd Transformer end to which this ratio tap changer belongs.
-
final
case class
RatioTapChangerTable(IdentifiedObject: IdentifiedObject = null, RatioTapChanger: List[String] = null, RatioTapChangerTablePoint: List[String] = null) extends Element with Product with Serializable
Describes a curve for how the voltage magnitude and impedance varies with the tap step.
Describes a curve for how the voltage magnitude and impedance varies with the tap step.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- RatioTapChanger
RatioTapChanger The ratio tap changer of this tap ratio table.
- RatioTapChangerTablePoint
RatioTapChangerTablePoint Points of this table.
-
final
case class
RatioTapChangerTablePoint(TapChangerTablePoint: TapChangerTablePoint = null, RatioTapChangerTable: String = null) extends Element with Product with Serializable
Describes each tap step in the ratio tap changer tabular curve.
Describes each tap step in the ratio tap changer tabular curve.
- TapChangerTablePoint
TapChangerTablePoint Reference to the superclass object.
- RatioTapChangerTable
RatioTapChangerTable Table of this point.
-
final
case class
RationalNumber(Element: BasicElement = null, denominator: Int = 0, numerator: Int = 0) extends Element with Product with Serializable
Rational number = 'numerator' / 'denominator'.
Rational number = 'numerator' / 'denominator'.
- Element
Reference to the superclass object.
- denominator
Denominator. Value 1 indicates the number is a simple integer.
- numerator
Numerator.
-
final
case class
ReactiveCapabilityCurve(Curve: Curve = null, coolantTemperature: Double = 0.0, hydrogenPressure: Double = 0.0, EquivalentInjection: List[String] = null, InitiallyUsedBySynchronousMachines: List[String] = null, SynchronousMachines: List[String] = null) extends Element with Product with Serializable
Reactive power rating envelope versus the synchronous machine's active power, in both the generating and motoring modes.
Reactive power rating envelope versus the synchronous machine's active power, in both the generating and motoring modes.
For each active power value there is a corresponding high and low reactive power limit value. Typically there will be a separate curve for each coolant condition, such as hydrogen pressure. The Y1 axis values represent reactive minimum and the Y2 axis values represent reactive maximum.
- Curve
Curve Reference to the superclass object.
- coolantTemperature
The machine's coolant temperature (e.g., ambient air or stator circulating water).
- hydrogenPressure
The hydrogen coolant pressure.
- EquivalentInjection
EquivalentInjection The equivalent injection using this reactive capability curve.
- InitiallyUsedBySynchronousMachines
SynchronousMachine Synchronous machines using this curve as default.
- SynchronousMachines
SynchronousMachine Synchronous machines using this curve.
-
final
case class
Reading(BaseReading: BaseReading = null, position: Int = 0, reason: String = null, valueMissing: Boolean = false, MeterReadings: List[String] = null, ReadingType: String = null) extends Element with Product with Serializable
Specific value measured by a meter or other asset, or calculated by a system.
Specific value measured by a meter or other asset, or calculated by a system.
Each Reading is associated with a specific ReadingType.
- BaseReading
BaseReading Reference to the superclass object.
- position
A sequential value representing the relative position within a given time interval.
- reason
Reason for this reading being taken.
- valueMissing
The indication of whether or not the quantity of this reading is missing.
- MeterReadings
MeterReading All meter readings (sets of values) containing this reading value.
- ReadingType
ReadingType Type information for this reading value.
-
final
case class
ReadingInterharmonic(Element: BasicElement = null, denominator: Int = 0, numerator: Int = 0) extends Element with Product with Serializable
Interharmonics are represented as a rational number 'numerator' / 'denominator', and harmonics are represented using the same mechanism and identified by 'denominator'=1.
Interharmonics are represented as a rational number 'numerator' / 'denominator', and harmonics are represented using the same mechanism and identified by 'denominator'=1.
- Element
Reference to the superclass object.
- denominator
Interharmonic denominator. Value 0 means not applicable. Value 2 is used in combination with 'numerator'=1 to represent interharmonic 1/2. Finally, value 1 indicates the harmonic of the order specified with 'numerator'.
- numerator
Interharmonic numerator. Value 0 means not applicable. Value 1 is used in combination with 'denominator'=2 to represent interharmonic 1/2, and with 'denominator'=1 it represents fundamental frequency. Finally, values greater than 1 indicate the harmonic of that order (e.g., 'numerator'=5 is the fifth harmonic).
-
final
case class
ReadingQuality(Element: BasicElement = null, comment: String = null, source: String = null, timeStamp: String = null, Reading: String = null, ReadingQualityType: String = null) extends Element with Product with Serializable
Quality of a specific reading value or interval reading value.
Quality of a specific reading value or interval reading value.
Note that more than one quality may be applicable to a given reading. Typically not used unless problems or unusual conditions occur (i.e., quality for each reading is assumed to be good unless stated otherwise in associated reading quality type). It can also be used with the corresponding reading quality type to indicate that the validation has been performed and succeeded.
- Element
Reference to the superclass object.
- comment
Elaboration on the quality code.
- source
System acting as the source of the quality code.
- timeStamp
Date and time at which the quality code was assigned or ascertained.
- Reading
BaseReading Reading value to which this quality applies.
- ReadingQualityType
ReadingQualityType Type of this reading quality.
-
final
case class
ReadingQualityType(IdentifiedObject: IdentifiedObject = null, category: String = null, subCategory: String = null, systemId: String = null, ReadingQualities: List[String] = null) extends Element with Product with Serializable
Detailed description for a quality of a reading value, produced by an end device or a system.
Detailed description for a quality of a reading value, produced by an end device or a system.
Values in attributes allow for creation of the recommended codes to be used for identifying reading value quality codes as follows: <systemId>.<category>.<subCategory>.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- category
High-level nature of the reading value quality.
- subCategory
More specific nature of the reading value quality, as a further sub-categorisation of 'category'.
- systemId
Identification of the system which has declared the issue with the data or provided commentary on the data.
- ReadingQualities
ReadingQuality All reading qualities of this type.
-
final
case class
ReadingType(IdentifiedObject: IdentifiedObject = null, accumulation: String = null, aggregate: String = null, argument: String = null, commodity: String = null, consumptionTier: Int = 0, cpp: Int = 0, currency: String = null, flowDirection: String = null, interharmonic: String = null, macroPeriod: String = null, measurementKind: String = null, measuringPeriod: String = null, multiplier: String = null, phases: String = null, tou: Int = 0, unit: String = null, Channel: String = null, ConsumptionTariffIntervals: List[String] = null, IntervalBlocks: List[String] = null, MetrologyRequirements: List[String] = null, PendingCalculation: String = null, Readings: List[String] = null) extends Element with Product with Serializable
Detailed description for a type of a reading value.
Detailed description for a type of a reading value.
Values in attributes allow for the creation of recommended codes to be used for identifying reading value types as follows: <macroPeriod>.<aggregate>.<measuringPeriod>.<accumulation>.<flowDirection>.<commodity>.<measurementKind>.<interharmonic.numerator>.<interharmonic.denominator>.<argument.numerator>.<argument.denominator>.<tou>.<cpp>.<consumptionTier>.<phases>.<multiplier>.<unit>.<currency>.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- accumulation
Accumulation behaviour of a reading over time, usually 'measuringPeriod', to be used with individual endpoints (as opposed to 'macroPeriod' and 'aggregate' that are used to describe aggregations of data from individual endpoints).
- aggregate
Salient attribute of the reading data aggregated from individual endpoints. This is mainly used to define a mathematical operation carried out over 'macroPeriod', but may also be used to describe an attribute of the data when the 'macroPeriod' is not defined.
- argument
RationalNumber Argument used to introduce numbers into the unit of measure description where they are needed (e.g., 4 where the measure needs an argument such as CEMI(n=4)). Most arguments used in practice however will be integers (i.e., 'denominator'=1). Value 0 in 'numerator' and 'denominator' means not applicable.
- commodity
Commodity being measured.
- consumptionTier
In case of common flat-rate pricing for power, in which all purchases are at a given rate, 'consumptionTier'=0. Otherwise, the value indicates the consumption tier, which can be used in conjunction with TOU or CPP pricing. Consumption tier pricing refers to the method of billing in which a certain "block" of energy is purchased/sold at one price, after which the next block of energy is purchased at another price, and so on, all throughout a defined period. At the start of the defined period, consumption is initially zero, and any usage is measured against the first consumption tier ('consumptionTier'=1). If this block of energy is consumed before the end of the period, energy consumption moves to be reconed against the second consumption tier ('consumptionTier'=2), and so on. At the end of the defined period, the consumption accumulator is reset, and usage within the 'consumptionTier'=1 restarts.
- cpp
Critical peak period (CPP) bucket the reading value is attributed to. Value 0 means not applicable. Even though CPP is usually considered a specialised form of time of use 'tou', this attribute is defined explicitly for flexibility.
- currency
Metering-specific currency.
- flowDirection
Flow direction for a reading where the direction of flow of the commodity is important (for electricity measurements this includes current, energy, power, and demand).
- interharmonic
ReadingInterharmonic Indication of a "harmonic" or "interharmonic" basis for the measurement. Value 0 in 'numerator' and 'denominator' means not applicable.
- macroPeriod
Time period of interest that reflects how the reading is viewed or captured over a long period of time.
- measurementKind
Identifies "what" is being measured, as refinement of 'commodity'. When combined with 'unit', it provides detail to the unit of measure. For example, 'energy' with a unit of measure of 'kWh' indicates to the user that active energy is being measured, while with 'kVAh' or 'kVArh', it indicates apparent energy and reactive energy, respectively. 'power' can be combined in a similar way with various power units of measure: Distortion power ('distortionVoltAmperes') with 'kVA' is different from 'power' with 'kVA'.
- measuringPeriod
Time attribute inherent or fundamental to the reading value (as opposed to 'macroPeriod' that supplies an "adjective" to describe aspects of a time period with regard to the measurement). It refers to the way the value was originally measured and not to the frequency at which it is reported or presented. For example, an hourly interval of consumption data would have value 'hourly' as an attribute. However in the case of an hourly sampled voltage value, the meterReadings schema would carry the 'hourly' interval size information. It is common for meters to report demand in a form that is measured over the course of a portion of an hour, while enterprise applications however commonly assume the demand (in kW or kVAr) normalised to 1 hour. The system that receives readings directly from the meter therefore shall perform this transformation before publishing readings for use by the other enterprise systems. The scalar used is chosen based on the block size (not any sub-interval size).
- multiplier
Metering-specific multiplier.
- phases
Metering-specific phase code.
- tou
Time of use (TOU) bucket the reading value is attributed to. Value 0 means not applicable.
- unit
Metering-specific unit.
- Channel
Channel Channel reporting/collecting register values with this type information.
- ConsumptionTariffIntervals
ConsumptionTariffInterval All tariff intervals with consumption described by this reading type.
- IntervalBlocks
IntervalBlock All blocks containing interval reading values with this type information.
- MetrologyRequirements
MetrologyRequirement All metrology requirements that require this reading type to be collected.
- PendingCalculation
PendingCalculation Pending calculation that produced this reading type.
- Readings
Reading All reading values with this type information.
-
final
case class
Reason(Element: BasicElement = null, code: String = null, text: String = null, MarketDocument: List[String] = null, Period: List[String] = null, Point: List[String] = null, RegisteredResource: List[String] = null, TimeSeries: List[String] = null) extends Element with Product with Serializable
The motivation of an act.
The motivation of an act.
- Element
Reference to the superclass object.
- code
The motivation of an act in coded form.
- text
The textual explanation corresponding to the reason code.
- MarketDocument
MarketDocument undocumented
- Period
Period undocumented
- Point
Point undocumented
- RegisteredResource
RegisteredResource undocumented
- TimeSeries
TimeSeries undocumented
-
final
case class
Receipt(IdentifiedObject: IdentifiedObject = null, isBankable: Boolean = false, line: String = null, CashierShift: String = null, Tenders: List[String] = null, Transactions: List[String] = null, VendorShift: String = null) extends Element with Product with Serializable
Record of total receipted payment from customer.
Record of total receipted payment from customer.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- isBankable
True if this receipted payment is manually bankable, otherwise it is an electronic funds transfer.
- line
LineDetail Receipted amount with rounding, date and note.
- CashierShift
CashierShift Cashier shift during which this receipt was recorded.
- Tenders
Tender All payments received in the form of tenders recorded by this receipt.
- Transactions
Transaction All transactions recorded for this receipted payment.
- VendorShift
VendorShift Vendor shift during which this receipt was recorded.
-
final
case class
RecloseSequence(IdentifiedObject: IdentifiedObject = null, recloseDelay: Double = 0.0, recloseStep: Int = 0, ProtectedSwitch: String = null) extends Element with Product with Serializable
A reclose sequence (open and close) is defined for each possible reclosure of a breaker.
A reclose sequence (open and close) is defined for each possible reclosure of a breaker.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- recloseDelay
Indicates the time lapse before the reclose step will execute a reclose.
- recloseStep
Indicates the ordinal position of the reclose step relative to other steps in the sequence.
- ProtectedSwitch
ProtectedSwitch A breaker may have zero or more automatic reclosures after a trip occurs.
-
final
case class
Recloser(ProtectedSwitch: ProtectedSwitch = null) extends Element with Product with Serializable
Pole-mounted fault interrupter with built-in phase and ground relays, current transformer (CT), and supplemental controls.
Pole-mounted fault interrupter with built-in phase and ground relays, current transformer (CT), and supplemental controls.
- ProtectedSwitch
ProtectedSwitch Reference to the superclass object.
-
final
case class
RecloserInfo(OldSwitchInfo: OldSwitchInfo = null, groundTripCapable: Boolean = false, groundTripNormalEnabled: Boolean = false, groundTripRating: Double = 0.0, phaseTripRating: Double = 0.0, recloseLockoutCount: Int = 0) extends Element with Product with Serializable
Properties of recloser assets.
Properties of recloser assets.
- OldSwitchInfo
OldSwitchInfo Reference to the superclass object.
- groundTripCapable
True if device has ground trip capability.
- groundTripNormalEnabled
True if normal status of ground trip is enabled.
- groundTripRating
Ground trip rating.
- phaseTripRating
Phase trip rating.
- recloseLockoutCount
Total number of phase reclose operations.
-
final
case class
Reconditioning(IdentifiedObject: IdentifiedObject = null, dateTime: String = null, Asset: String = null, PowerRatings: List[String] = null, TransformerObservations: List[String] = null) extends Element with Product with Serializable
Reconditioning information for an asset.
Reconditioning information for an asset.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- dateTime
Date and time this reconditioning (or a major overhaul) has been performed.
- Asset
Asset undocumented
- PowerRatings
CoolingPowerRating undocumented
- TransformerObservations
TransformerObservation undocumented
-
final
case class
RedLine(IdentifiedObject: IdentifiedObject = null, status: String = null) extends Element with Product with Serializable
This class is used for handling the accompanying annotations, time stamp, author, etc.
This class is used for handling the accompanying annotations, time stamp, author, etc. of designs, drawings and maps.
A red line can be associated with any Location object.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- status
undocumented
-
final
case class
Register(IdentifiedObject: IdentifiedObject = null, isVirtual: Boolean = false, leftDigitCount: Int = 0, rightDigitCount: Int = 0, touTier: String = null, touTierName: String = null, Channels: List[String] = null, EndDeviceFunction: String = null, Usage_Point: String = null) extends Element with Product with Serializable
A device that indicates or records units of the commodity or other quantity measured.
A device that indicates or records units of the commodity or other quantity measured.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- isVirtual
If true, the data it produces is calculated or measured by a device other than a physical end device/meter. Otherwise, any data streams it produces are measured by the hardware of the end device/meter itself.
- leftDigitCount
Number of digits (dials on a mechanical meter) to the left of the decimal place; default is normally 5.
- rightDigitCount
Number of digits (dials on a mechanical meter) to the right of the decimal place.
- touTier
Clock time interval for register to beging/cease accumulating time of usage (e.g., start at 8:00 am, stop at 5:00 pm).
- touTierName
Name used for the time of use tier (also known as bin or bucket). For example, "peak", "off-peak", "TOU Category A", etc.
- Channels
Channel All channels that collect/report values from this register.
- EndDeviceFunction
EndDeviceFunction End device function metering quantities displayed by this register.
- Usage_Point
UsagePoint undocumented
-
final
case class
RegisteredControllableLoad(Element: BasicElement = null, maxBaseLoad: Double = 0.0, maxDeploymentTime: Double = 0.0, maxLoadRedTimesPerDay: Int = 0, maxLoadReduction: Double = 0.0, maxReductionTime: Double = 0.0, maxWeeklyDeployment: Int = 0, minLoadReduction: Double = 0.0, minLoadReductionCost: Double = 0.0, minLoadReductionInterval: Double = 0.0, minReductionTime: Double = 0.0, minTimeBetLoadRed: Double = 0.0, reqNoticeTime: Double = 0.0) extends Element with Product with Serializable
Temporary holding for load reduction attributes removed from RegisteredLoad.
Temporary holding for load reduction attributes removed from RegisteredLoad.
Use for future use case when developing the RegisteredDistributedResource specialized classes.
- Element
Reference to the superclass object.
- maxBaseLoad
Maximum Base Load (MW), per Participating Load Resource
- maxDeploymentTime
Maximum Deployment time (seconds)
- maxLoadRedTimesPerDay
Maximum Number of Daily Load Curtailments
- maxLoadReduction
maximum load reduction
- maxReductionTime
Maxiimum Load Reduction Time (min), per Participating Load Resource
- maxWeeklyDeployment
Maximum weekly deployments
- minLoadReduction
Minimum MW for a load reduction (e.g., MW rating of a discrete pump. This attribute may be used also in the LoadBid class. The reason that the attribute is also modeled in this class is that it is resource attribute and needs to be persistently stored.
- minLoadReductionCost
minimum load reduction cost. Single number for the load
- minLoadReductionInterval
Shortest period load reduction shall be maintained before load can be restored to normal levels. This attribute may be used also in the LoadBid class. The reason that the attribute is also modeled in this class is that it is resource attribute and needs to be persistently stored.
- minReductionTime
Minimum Load Reduction Time (min), per Participating Load Resource
- minTimeBetLoadRed
Shortest time that load shall be left at normal levels before a new load reduction. This attribute may be used also in the LoadBid class. The reason that the attribute is also modeled in this class is that it is resource attribute and needs to be persistently stored.
- reqNoticeTime
Time period that is required from an order to reduce a load to the time that it takes to get to the minimum load reduction. This attribute may be used also in the LoadBid class. The reason that the attribute is also modeled in this class is that it is resource attribute and needs to be persistently stored.
-
final
case class
RegisteredDistributedResource(RegisteredResource: RegisteredResource = null, distributedResourceType: String = null, ResourcePerformanceRatings: List[String] = null, ResponseMethods: List[String] = null) extends Element with Product with Serializable
A registered resource that represents a distributed energy resource, such as a micro-generator, fuel cell, photo-voltaic energy source, etc.
A registered resource that represents a distributed energy resource, such as a micro-generator, fuel cell, photo-voltaic energy source, etc.
- RegisteredResource
RegisteredResource Reference to the superclass object.
- distributedResourceType
The type of resource. Examples include: fuel cell, flywheel, photovoltaic, micro-turbine, CHP (combined heat power), V2G (vehicle to grid), DES (distributed energy storage), and others.
- ResourcePerformanceRatings
ResourcePerformanceRating undocumented
- ResponseMethods
ResponseMethod undocumented
-
final
case class
RegisteredGenerator(RegisteredResource: RegisteredResource = null, capacityFactor: Double = 0.0, coldStartTime: Double = 0.0, combinedCycleOperatingMode: String = null, commericialOperationDate: String = null, constrainedOutputFlag: String = null, energyDownRampRate: Double = 0.0, energyUpRampRate: Double = 0.0, extremeLongStart: String = null, fuelSource: String = null, highControlLimit: Double = 0.0, hotIntTime: Double = 0.0, hotStartTime: Double = 0.0, intColdTime: Double = 0.0, intStartTime: Double = 0.0, loadFollowingDownMSS: String = null, loadFollowingUpMSS: String = null, lowControlLImit: Double = 0.0, maxDependableCap: Double = 0.0, maxMinLoadCost: Double = 0.0, maxPumpingLevel: Double = 0.0, maxShutdownTime: String = null, maxStartUpsPerDay: Int = 0, maxWeeklyEnergy: Double = 0.0, maxWeeklyStarts: Int = 0, maximumAllowableSpinningReserve: Double = 0.0, maximumOperatingLimit: Double = 0.0, minLoadCost: Double = 0.0, minimumLoadCostBasis: String = null, minimumLoadFuelCost: Double = 0.0, minimumOperatingLimit: Double = 0.0, mustOfferRA: String = null, nameplateCapacity: Double = 0.0, operatingMaintenanceCost: Double = 0.0, pumpMinDownTime: Double = 0.0, pumpMinUpTime: Double = 0.0, pumpShutdownCost: Double = 0.0, pumpShutdownTime: Int = 0, pumpingCost: Double = 0.0, pumpingFactor: Double = 0.0, quickStartFlag: String = null, rampCurveType: String = null, regulationDownRampRate: Double = 0.0, regulationFlag: String = null, regulationUpRampRate: Double = 0.0, resourceSubType: String = null, riverSystem: String = null, spinRampRate: Double = 0.0, startUpCostBasis: String = null, syncCondCapable: String = null, unitType: String = null, useLimitFlag: String = null, variableEnergyResource: String = null, AuxillaryObject: List[String] = null, EnergyPriceIndex: String = null, FuelCostCurve: String = null, FuelRegion: String = null, GeneratingBids: List[String] = null, LocalReliabilityArea: String = null, MktHeatRateCurve: String = null, RMNRFlag: String = null, RMRFlag: String = null, RMRHeatRateCurve: String = null, RMRManualIndicator: String = null, RMRStartUpCostCurve: String = null, RMRStartUpEnergyCurve: String = null, RMRStartUpFuelCurve: String = null, RMRStartUpTimeCurve: String = null, RMTFlag: String = null, RegulatingLimit: String = null, StartUpCostCurves: List[String] = null, StartUpEnergyCurve: String = null, StartUpFuelCurve: String = null, StartUpTimeCurve: String = null, Trade: List[String] = null, UnitInitialConditions: List[String] = null) extends Element with Product with Serializable
Model of a generator that is registered to participate in the market.
Model of a generator that is registered to participate in the market.
- RegisteredResource
RegisteredResource Reference to the superclass object.
- capacityFactor
The ratio of actual energy produced by resource divided by the maximum potential energy if the resource is fully utilized. As an example, wind farms.
- coldStartTime
Cold start time.
- combinedCycleOperatingMode
Combined Cycle operating mode.
- commericialOperationDate
undocumented
- constrainedOutputFlag
Constrained Output Generator (COG) Indicator (Yes/No), per Generating Resource
- energyDownRampRate
Response rate in MW per minute for ramping energy down.
- energyUpRampRate
Response rate in MW per minute for ramping energy up.
- extremeLongStart
Some long-start up time units may need to receive start up instruction before DA market results are available. Long-Start resources may be either physical resources within the control with start-up times greater than 18 hours or the long-start contractual inter-tie commitment that shall be completed by 6 am one-day ahead. Therefore, there is a need for a process to determine the commitment of such resources before the DA market.
- fuelSource
Values: Natural Gas Based Resource, Non Natural Gas Based Resource "NG" - Natural-Gas-Based Resource - a Resource that is powered by Natural Gas "NNG" - Non-Natural-Gas-Based Resource - a Resouce that is powered by some other fuel than Natural Gas
- highControlLimit
High limit for secondary (AGC) control
- hotIntTime
Hot-to-intermediate time (Seasonal)
- hotStartTime
Hot start time.
- intColdTime
Intermediate-to-cold time (Seasonal)
- intStartTime
Intermediate start time.
- loadFollowingDownMSS
Certifies resources for use in MSS Load Following Down
- loadFollowingUpMSS
Certifies resources for use in MSS Load Following Up
- lowControlLImit
Low limit for secondary (AGC) control
- maxDependableCap
Maximum Dependable Capacity (MNDC). Maximun Net Dependable Capacity is used in association with an RMR contract.
- maxMinLoadCost
The registered maximum Minimum Load Cost of a Generating Resource registered with a Cost Basis of "Bid Cost".
- maxPumpingLevel
max pumping level of a hydro pump unit
- maxShutdownTime
Maximum time this device can be shut down.
- maxStartUpsPerDay
maximum start ups per day
- maxWeeklyEnergy
Maximum weekly Energy (Seasonal)
- maxWeeklyStarts
Maximum weekly starts (seasonal parameter)
- maximumAllowableSpinningReserve
Maximum allowable spinning reserve. Spinning reserve will never be considered greater than this value regardless of the current operating point.
- maximumOperatingLimit
This is the maximum operating MW limit the dispatcher can enter for this unit
- minLoadCost
minimum load cost. Value is (currency/hr)
- minimumLoadCostBasis
The cost basis for minimum load.
- minimumLoadFuelCost
The cost for the fuel required to get a Generating Resource to operate at the minimum load level
- minimumOperatingLimit
This is the minimum operating MW limit the dispatcher can enter for this unit.
- mustOfferRA
Flag to indicate that this unit is a resource adequacy resource and must offer.
- nameplateCapacity
MW value stated on the nameplate of the Generator -- the value it potentially could provide.
- operatingMaintenanceCost
The portion of the Operating Cost of a Generating Resource that is not related to fuel cost.
- pumpMinDownTime
The minimum down time for the pump in a pump storage unit.
- pumpMinUpTime
The minimum up time aspect for the pump in a pump storage unit
- pumpShutdownCost
The cost to shutdown a pump during the pump aspect of a pump storage unit.
- pumpShutdownTime
The shutdown time (minutes) of the pump aspect of a pump storage unit.
- pumpingCost
undocumented
- pumpingFactor
Pumping factor for pump storage units, conversion factor between generating and pumping.
- quickStartFlag
Quick start flag (Yes/No). Identifies the registered generator as a quick start unit. A quick start unit is a unit that has the ability to be available for load within a 30 minute period.
- rampCurveType
Ramp curve type. Identifies the type of curve which may be a fixed, static or dynamic.
- regulationDownRampRate
Regulation down response rate in MW per minute
- regulationFlag
Specifies if the unit is regulating or not regulating or expected to be regulating but is not.
- regulationUpRampRate
Regulation up response rate in MW per minute.
- resourceSubType
Unit sub type used by Settlements or scheduling application. Application use of the unit sub type may define the necessary types as applicable.
- riverSystem
River System the Resource is tied to.
- spinRampRate
Response rate in MW per minute for spinning reserve.
- startUpCostBasis
The cost basis for start up.
- syncCondCapable
Is the Resource Synchronous Condenser capable Resource?
- unitType
Generating unit type: Combined Cycle, Gas Turbine, Hydro Turbine, Other, Photovoltaic, Hydro Pump-Turbine, Reciprocating Engine, Steam Turbine, Synchronous Condenser, Wind Turbine
- useLimitFlag
Use limit flag: indicates if the use-limited resource is fully scheduled (or has some slack for real-time dispatch) (Y/N)
- variableEnergyResource
Provides an indication that this resource is intending to participate in an intermittent resource program.
- AuxillaryObject
AuxiliaryObject undocumented
- EnergyPriceIndex
EnergyPriceIndex undocumented
- FuelCostCurve
FuelCostCurve undocumented
- FuelRegion
FuelRegion undocumented
- GeneratingBids
GeneratingBid undocumented
- LocalReliabilityArea
LocalReliabilityArea undocumented
- MktHeatRateCurve
MktHeatRateCurve undocumented
- RMNRFlag
Reliability must not run (RMNR) flag: indicated whether the RMR unit is set as an RMNR in the current market
- RMRFlag
Reliability must run (RMR) flag: indicates whether the unit is RMR; Indicates whether the unit is RMR: N' - not an RMR unit '1' - RMR Condition 1 unit '2' - RMR Condition 2 unit
- RMRHeatRateCurve
RMRHeatRateCurve undocumented
- RMRManualIndicator
Indicates the RMR Manual pre-determination status [Y/N]
- RMRStartUpCostCurve
RMRStartUpCostCurve undocumented
- RMRStartUpEnergyCurve
RMRStartUpEnergyCurve undocumented
- RMRStartUpFuelCurve
RMRStartUpFuelCurve undocumented
- RMRStartUpTimeCurve
RMRStartUpTimeCurve undocumented
- RMTFlag
Reliability must take (RMT) flag (Yes/No): indicates whether the unit is RMT
- RegulatingLimit
RegulatingLimit undocumented
- StartUpCostCurves
StartUpCostCurve undocumented
- StartUpEnergyCurve
StartUpEnergyCurve undocumented
- StartUpFuelCurve
StartUpFuelCurve undocumented
- StartUpTimeCurve
StartUpTimeCurve undocumented
- Trade
Trade undocumented
- UnitInitialConditions
UnitInitialConditions undocumented
-
final
case class
RegisteredInterTie(RegisteredResource: RegisteredResource = null, direction: String = null, energyProductType: String = null, isDCTie: String = null, isDynamicInterchange: String = null, minHourlyBlockLimit: Int = 0, Flowgate: String = null, InterTieBid: String = null, InterTieDispatchResponse: List[String] = null, InterchangeSchedule: List[String] = null, WheelingCounterParty: List[String] = null) extends Element with Product with Serializable
This class represents the inter tie resource.
This class represents the inter tie resource.
- RegisteredResource
RegisteredResource Reference to the superclass object.
- direction
Indicates the direction (export/import) of an InterTie resource.
- energyProductType
Under each major product type, the commodity type can be applied to further specify the type.
- isDCTie
Flag to indicated whether this Inter-tie is a DC Tie.
- isDynamicInterchange
Specifies whether the inter-tie resource is registered for the dynamic interchange.
- minHourlyBlockLimit
The registered upper bound of minimum hourly block for an Inter-Tie Resource.
- Flowgate
Flowgate undocumented
- InterTieBid
InterTieBid undocumented
- InterTieDispatchResponse
InterTieDispatchResponse undocumented
- InterchangeSchedule
InterchangeSchedule undocumented
- WheelingCounterParty
WheelingCounterParty undocumented
-
final
case class
RegisteredLoad(RegisteredResource: RegisteredResource = null, blockLoadTransfer: Boolean = false, dynamicallyScheduledLoadResource: Boolean = false, dynamicallyScheduledQualification: Boolean = false, AuxillaryObject: List[String] = null, LoadBids: List[String] = null) extends Element with Product with Serializable
Model of a load that is registered to participate in the market.
Model of a load that is registered to participate in the market.
RegisteredLoad is used to model any load that is served by the wholesale market directly. RegisteredLoads may be dispatchable or non-dispatchable and may or may not have bid curves. Examples of RegisteredLoads would include: distribution company load, energy retailer load, large bulk power system connected facility load.
Loads that are served indirectly, for example - through an energy retailer or a vertical utility, should be modeled as RegisteredDistributedResources. Examples of RegisteredDistributedResources would include: distribution level storage, distribution level generation and distribution level demand response.
- RegisteredResource
RegisteredResource Reference to the superclass object.
- blockLoadTransfer
Emergency operating procedure - Flag to indicate that the Resource is Block Load pseudo resource.
- dynamicallyScheduledLoadResource
Flag to indicate that a Load Resource is part of a DSR Load
- dynamicallyScheduledQualification
Qualification status (used for DSR qualification).
- AuxillaryObject
AuxiliaryObject undocumented
- LoadBids
LoadBid undocumented
-
final
case class
RegisteredResource(PowerSystemResource: PowerSystemResource = null, commercialOpDate: String = null, contingencyAvailFlag: String = null, dispatchable: Boolean = false, flexibleOfferFlag: String = null, hourlyPredispatch: String = null, isAggregatedRes: String = null, lastModified: String = null, marketParticipationFlag: String = null, maxBaseSelfSchedQty_1: Double = 0.0, maxOnTime: Double = 0.0, minDispatchTime: Double = 0.0, minOffTime: Double = 0.0, minOnTime: Double = 0.0, mustOfferFlag: String = null, nonMarket: String = null, pointOfDeliveryFlag: String = null, priceSetFlagDA: String = null, priceSetFlagRT: String = null, registrationStatus: String = null, resourceAdequacyFlag: String = null, ACAFlag: String = null, ASSPOptimizationFlag: String = null, AdjacentCASet: String = null, AggregateNode: String = null, AllocationResultValues: List[String] = null, Commitments: List[String] = null, ContractDistributionFactor: List[String] = null, ControlAreaDesignation: List[String] = null, DefaultBid: String = null, DispatchInstReply: List[String] = null, Domain: List[String] = null, DopInstruction: List[String] = null, DotInstruction: List[String] = null, ECAFlag: String = null, EnergyMarkets: List[String] = null, ExPostResourceResults: List[String] = null, ExpectedEnergyValues: List[String] = null, ForbiddenRegion: List[String] = null, FormerReference: List[String] = null, HostControlArea: String = null, Instructions: List[String] = null, InterTie: List[String] = null, IntermittentResourceEligibility: List[String] = null, LMPMFlag: String = null, LoadFollowingInst: List[String] = null, LoadFollowingOperatorInput: List[String] = null, MPMResourceStatus: List[String] = null, MPMTestThreshold: List[String] = null, MarketObjectStatus: List[String] = null, MarketParticipant: String = null, MktConnectivityNode: String = null, OrgResOwnership: List[String] = null, Pnode: String = null, RMROperatorInput: List[String] = null, RUCAwardInstruction: List[String] = null, RampRateCurve: List[String] = null, Reason: List[String] = null, ResourceAncillaryServiceQualification: List[String] = null, ResourceAwardInstruction: List[String] = null, ResourceCapacity: List[String] = null, ResourceCertification: List[String] = null, ResourceDispatchResults: List[String] = null, ResourceGroups: List[String] = null, ResourceLoadFollowingInst: List[String] = null, ResourceVerifiableCosts: String = null, SMPMFlag: String = null, SubControlArea: List[String] = null, SubstitutionResourceList: List[String] = null, TimeSeries: List[String] = null) extends Element with Product with Serializable
A resource that is registered through the market participant registration system.
A resource that is registered through the market participant registration system.
Examples include generating unit, load, and non-physical generator or load.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- commercialOpDate
Resource Commercial Operation Date.
- contingencyAvailFlag
Contingent operating reserve availiability (Yes/No). Resource is availiable to participate with capacity in contingency dispatch.
- dispatchable
Dispatchable: indicates whether the resource is dispatchable. This implies that the resource intends to submit Energy bids/offers or Ancillary Services bids/offers, or self-provided schedules.
- flexibleOfferFlag
Flexible offer flag (Y/N).
- hourlyPredispatch
Indicates need to dispatch before the start of the operating hour. Only relevant in Real-Time Market. Applies to generation, intertie and participating load resource. Value (Y/N).
- isAggregatedRes
A flag to indicate if a resource is an aggregated resource.
- lastModified
Indication of the last time this item was modified/versioned.
- marketParticipationFlag
Market Participation flag: indicates whether the resource participate in the market.
- maxBaseSelfSchedQty_1
Maximum base self schedule quantity.
- maxOnTime
Maximum on time after start up.
- minDispatchTime
Minimum number of consecutive hours a resource shall be dispatched if bid is accepted.
- minOffTime
Minimum off time after shut down.
- minOnTime
Minimum on time after start up.
- mustOfferFlag
Must offer flag: indicates whether the unit is subject to the must offer provisions (Y/N).
- nonMarket
Flag to indicate that the Resource is not participating in the Market Operations.
- pointOfDeliveryFlag
Indication that the registered resource is a Point of Delivery (YES) resource which implies there is a POD Loss Factor.
- priceSetFlagDA
Price setting flag: indicates whether a resource is capable of setting the Market Clearing Price (Y) for the DA market, and if not, indicates whether the resource shall submit bids for energy at $ 0 (S) or not (N). Initially in the RegisteredGenerator class. It was moved to the RegisteredResource class for the participating load dispatch purpose.
- priceSetFlagRT
Price setting flag: indicates whether a resource is capable of setting the Market Clearing Price (Y) for the RT market, and if not, indicates whether the resource shall submit bids for energy at $ 0 (S) or not (N). Initially in the RegisteredGenerator class. It was moved to the RegisteredResource class for the participating load dispatch purpose.
- registrationStatus
Registration Status of resource - Active, Mothballed, Planned, or Decommissioned.
- resourceAdequacyFlag
Indication that this resource participates in the resource adequacy function.
- ACAFlag
Indication that this resource is associated with an Adjacent Control Area.
- ASSPOptimizationFlag
Indication that the resource participates in the optimization process by default.
- AdjacentCASet
AdjacentCASet undocumented
- AggregateNode
AggregateNode An AggregateNode may be associated with up to many RegisteredResources.
- AllocationResultValues
AllocationResultValues undocumented
- Commitments
Commitments undocumented
- ContractDistributionFactor
ContractDistributionFactor undocumented
- ControlAreaDesignation
ControlAreaDesignation undocumented
- DefaultBid
DefaultBid undocumented
- DispatchInstReply
DispatchInstReply undocumented
- Domain
Domain undocumented
- DopInstruction
DopInstruction undocumented
- DotInstruction
DotInstruction undocumented
- ECAFlag
Indication that this resource is associated with an Embedded Control area.
- EnergyMarkets
EnergyMarket undocumented
- ExPostResourceResults
ExPostResourceResults undocumented
- ExpectedEnergyValues
ExpectedEnergyValues undocumented
- ForbiddenRegion
ForbiddenRegion undocumented
- FormerReference
FormerReference undocumented
- HostControlArea
HostControlArea undocumented
- Instructions
Instructions undocumented
- InterTie
SchedulingPoint undocumented
- IntermittentResourceEligibility
IntermittentResourceEligibility undocumented
- LMPMFlag
LMPM flag: indicates whether the resource is subject to the LMPM test (Yes/No).
- LoadFollowingInst
LoadFollowingInst undocumented
- LoadFollowingOperatorInput
LoadFollowingOperatorInput undocumented
- MPMResourceStatus
MPMResourceStatus undocumented
- MPMTestThreshold
MPMTestThreshold undocumented
- MarketObjectStatus
MarketObjectStatus undocumented
- MarketParticipant
MarketParticipant undocumented
- MktConnectivityNode
MktConnectivityNode undocumented
- OrgResOwnership
OrgResOwnership undocumented
- Pnode
Pnode A registered resource injects power at one or more connectivity nodes related to a pnode
- RMROperatorInput
RMROperatorInput undocumented
- RUCAwardInstruction
RUCAwardInstruction undocumented
- RampRateCurve
RampRateCurve undocumented
- Reason
Reason undocumented
- ResourceAncillaryServiceQualification
ResourceCertification RegisteredResources are qualified for resource ancillary service types (which include market product types as well as other types such as BlackStart) by the association to the class ResourceAncillaryServiceQualification.
- ResourceAwardInstruction
ResourceAwardInstruction undocumented
- ResourceCapacity
ResourceCapacity undocumented
- ResourceCertification
ResourceCertification2 undocumented
- ResourceDispatchResults
ResourceDispatchResults undocumented
- ResourceGroups
ResourceGroup undocumented
- ResourceLoadFollowingInst
ResourceLoadFollowingInst undocumented
- ResourceVerifiableCosts
ResourceVerifiableCosts undocumented
- SMPMFlag
SMPM flag: indicates whether the resource is subject to the SMPM test (Yes/No).
- SubControlArea
SubControlArea undocumented
- SubstitutionResourceList
SubstitutionResourceList undocumented
- TimeSeries
TimeSeries undocumented
-
final
case class
RegularIntervalSchedule(BasicIntervalSchedule: BasicIntervalSchedule = null, endTime: String = null, timeStep: Double = 0.0, TimePoints: List[String] = null) extends Element with Product with Serializable
The schedule has time points where the time between them is constant.
The schedule has time points where the time between them is constant.
- BasicIntervalSchedule
BasicIntervalSchedule Reference to the superclass object.
- endTime
The time for the last time point. The value can be a time of day, not a specific date.
- timeStep
The time between each pair of subsequent regular time points in sequence order.
- TimePoints
RegularTimePoint The regular interval time point data values that define this schedule.
-
final
case class
RegularTimePoint(Element: BasicElement = null, sequenceNumber: Int = 0, value1: Double = 0.0, value2: Double = 0.0, IntervalSchedule: String = null) extends Element with Product with Serializable
Time point for a schedule where the time between the consecutive points is constant.
Time point for a schedule where the time between the consecutive points is constant.
- Element
Reference to the superclass object.
- sequenceNumber
The position of the regular time point in the sequence. Note that time points don't have to be sequential, i.e. time points may be omitted. The actual time for a RegularTimePoint is computed by multiplying the associated regular interval schedule's time step with the regular time point sequence number and adding the associated schedules start time. To specify values for the start time, use sequence number 0. The sequence number cannot be negative.
- value1
The first value at the time. The meaning of the value is defined by the derived type of the associated schedule.
- value2
The second value at the time. The meaning of the value is defined by the derived type of the associated schedule.
- IntervalSchedule
RegularIntervalSchedule Regular interval schedule containing this time point.
-
final
case class
RegulatingCondEq(EnergyConnection: EnergyConnection = null, controlEnabled: Boolean = false, RegulatingControl: String = null) extends Element with Product with Serializable
A type of conducting equipment that can regulate a quantity (i.e.
A type of conducting equipment that can regulate a quantity (i.e. voltage or flow) at a specific point in the network.
- EnergyConnection
EnergyConnection Reference to the superclass object.
- controlEnabled
Specifies the regulation status of the equipment. True is regulating, false is not regulating.
- RegulatingControl
RegulatingControl The regulating control scheme in which this equipment participates.
-
final
case class
RegulatingControl(PowerSystemResource: PowerSystemResource = null, discrete: Boolean = false, enabled: Boolean = false, maxAllowedTargetValue: Double = 0.0, minAllowedTargetValue: Double = 0.0, mode: String = null, monitoredPhase: String = null, targetDeadband: Double = 0.0, targetValue: Double = 0.0, targetValueUnitMultiplier: String = null, ProtectiveActionRegulation: List[String] = null, RegulatingCondEq: List[String] = null, RegulationSchedule: List[String] = null, Terminal: String = null) extends Element with Product with Serializable
Specifies a set of equipment that works together to control a power system quantity such as voltage or flow.
Specifies a set of equipment that works together to control a power system quantity such as voltage or flow.
Remote bus voltage control is possible by specifying the controlled terminal located at some place remote from the controlling equipment. The specified terminal shall be associated with the connectivity node of the controlled point. The most specific subtype of RegulatingControl shall be used in case such equipment participate in the control, e.g. TapChangerControl for tap changers. For flow control, load sign convention is used, i.e. positive sign means flow out from a TopologicalNode (bus) into the conducting equipment. The attribute minAllowedTargetValue and maxAllowedTargetValue are required in the following cases: - For a power generating module operated in power factor control mode to specify maximum and minimum power factor values; - Whenever it is necessary to have an off center target voltage for the tap changer regulator. For instance, due to long cables to off shore wind farms and the need to have a simpler setup at the off shore transformer platform, the voltage is controlled from the land at the connection point for the off shore wind farm. Since there usually is a voltage rise along the cable, there is typical and overvoltage of up 3-4 kV compared to the on shore station. Thus in normal operation the tap changer on the on shore station is operated with a target set point, which is in the lower parts of the dead band. The attributes minAllowedTargetValue and maxAllowedTargetValue are not related to the attribute targetDeadband and thus they are not treated as an alternative of the targetDeadband. They are needed due to limitations in the local substation controller. The attribute targetDeadband is used to prevent the power flow from move the tap position in circles (hunting) that is to be used regardless of the attributes minAllowedTargetValue and maxAllowedTargetValue.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- discrete
The regulation is performed in a discrete mode. This applies to equipment with discrete controls, e.g. tap changers and shunt compensators.
- enabled
The flag tells if regulation is enabled.
- maxAllowedTargetValue
Maximum allowed target value (RegulatingControl.targetValue).
- minAllowedTargetValue
Minimum allowed target value (RegulatingControl.targetValue).
- mode
The regulating control mode presently available. This specification allows for determining the kind of regulation without need for obtaining the units from a schedule.
- monitoredPhase
Phase voltage controlling this regulator, measured at regulator location.
- targetDeadband
This is a deadband used with discrete control to avoid excessive update of controls like tap changers and shunt compensator banks while regulating. The units of those appropriate for the mode. The attribute shall be a positive value or zero. If RegulatingControl.discrete is set to "false", the RegulatingControl.targetDeadband is to be ignored. Note that for instance, if the targetValue is 100 kV and the targetDeadband is 2 kV the range is from 99 to 101 kV.
- targetValue
The target value specified for case input. This value can be used for the target value without the use of schedules. The value has the units appropriate to the mode attribute.
- targetValueUnitMultiplier
Specify the multiplier for used for the targetValue.
- ProtectiveActionRegulation
ProtectiveActionRegulation Enable/disable a regulating control or set new target value.
- RegulatingCondEq
RegulatingCondEq The equipment that participates in this regulating control scheme.
- RegulationSchedule
RegulationSchedule Schedule for this regulating control.
- Terminal
Terminal The terminal associated with this regulating control. The terminal is associated instead of a node, since the terminal could connect into either a topological node or a connectivity node. Sometimes it is useful to model regulation at a terminal of a bus bar object.
-
final
case class
RegulatingLimit(IdentifiedObject: IdentifiedObject = null, highLimit: Double = 0.0, lowLimit: Double = 0.0, RegisteredGenerator: String = null) extends Element with Product with Serializable
This class represents the physical characteristic of a generator regarding the regulating limit.
This class represents the physical characteristic of a generator regarding the regulating limit.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- highLimit
undocumented
- lowLimit
undocumented
- RegisteredGenerator
RegisteredGenerator undocumented
-
final
case class
Regulation(WorkDocument: WorkDocument = null, referenceNumber: String = null) extends Element with Product with Serializable
Special requirements and/or regulations may pertain to certain types of assets or work.
Special requirements and/or regulations may pertain to certain types of assets or work.
For example, fire protection and scaffolding.
- WorkDocument
WorkDocument Reference to the superclass object.
- referenceNumber
External reference to regulation, if applicable.
-
final
case class
RegulationSchedule(SeasonDayTypeSchedule: SeasonDayTypeSchedule = null, RegulatingControl: String = null, VoltageControlZones: List[String] = null) extends Element with Product with Serializable
A pre-established pattern over time for a controlled variable, e.g., busbar voltage.
A pre-established pattern over time for a controlled variable, e.g., busbar voltage.
- SeasonDayTypeSchedule
SeasonDayTypeSchedule Reference to the superclass object.
- RegulatingControl
RegulatingControl Regulating controls that have this schedule.
- VoltageControlZones
VoltageControlZone A VoltageControlZone may have a voltage regulation schedule.
-
final
case class
RelativeDisplacement(Element: BasicElement = null, displacement: Double = 0.0, kind: String = null) extends Element with Product with Serializable
Vertical displacement relative to either sealevel, ground or the center of the earth.
Vertical displacement relative to either sealevel, ground or the center of the earth.
- Element
Reference to the superclass object.
- displacement
undocumented
- kind
undocumented
-
final
case class
ReliabilityInfo(IdentifiedObject: IdentifiedObject = null, mTTR: Double = 0.0, momFailureRate: Double = 0.0, Assets: List[String] = null, Specification: String = null) extends Element with Product with Serializable
Information regarding the experienced and expected reliability of a specific asset, type of asset, or asset model.
Information regarding the experienced and expected reliability of a specific asset, type of asset, or asset model.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- mTTR
Mean time to repair (MTTR - hours).
- momFailureRate
Momentary failure rate (temporary failures/kft-year).
- Assets
Asset undocumented
- Specification
Specification undocumented
-
final
case class
RemedialActionScheme(PowerSystemResource: PowerSystemResource = null, armed: Boolean = false, kind: String = null, normalArmed: Boolean = false, GateArmed: String = null, Stage: List[String] = null, TriggerCondition: List[String] = null) extends Element with Product with Serializable
Remedial Action Scheme (RAS), Special Protection Schemes (SPS), System Protection Schemes (SPS) or System Integrity Protection Schemes (SIPS).
Remedial Action Scheme (RAS), Special Protection Schemes (SPS), System Protection Schemes (SPS) or System Integrity Protection Schemes (SIPS).
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- armed
The status of the class set by operation or by signal. Optional field that will override other status fields.
- kind
Kind of Remedial Action Scheme (RAS).
- normalArmed
The default/normal value used when other active signal/values are missing.
- GateArmed
Gate Gate that through a gate logic and input pin defines arming of the Remedial Action Schemes (RAS).
- Stage
Stage A Remedial Action Scheme (RAS) consist of one or more stage that are trigger and execute protection action.
- TriggerCondition
TriggerCondition Triggering of the Remedial Action Schemes (RAS).
-
final
case class
RemoteConnectDisconnectInfo(Element: BasicElement = null, armedTimeout: Double = 0.0, customerVoltageLimit: Double = 0.0, energyLimit: Double = 0.0, energyUsageStartDateTime: String = null, energyUsageWarning: Double = 0.0, isArmConnect: Boolean = false, isArmDisconnect: Boolean = false, isEnergyLimiting: Boolean = false, needsPowerLimitCheck: Boolean = false, needsVoltageLimitCheck: Boolean = false, powerLimit: Double = 0.0, usePushbutton: Boolean = false) extends Element with Product with Serializable
Details of remote connect and disconnect function.
Details of remote connect and disconnect function.
- Element
Reference to the superclass object.
- armedTimeout
Setting of the timeout elapsed time.
- customerVoltageLimit
Voltage limit on customer side of RCD switch above which the connect should not be made.
- energyLimit
Limit of energy before disconnect.
- energyUsageStartDateTime
Start date and time to accumulate energy for energy usage limiting.
- energyUsageWarning
Warning energy limit, used to trigger event code that energy usage is nearing limit.
- isArmConnect
True if the RCD switch has to be armed before a connect action can be initiated.
- isArmDisconnect
True if the RCD switch has to be armed before a disconnect action can be initiated.
- isEnergyLimiting
True if the energy usage is limited and the customer will be disconnected if they go over the limit.
- needsPowerLimitCheck
True if load limit has to be checked to issue an immediate disconnect (after a connect) if load is over the limit.
- needsVoltageLimitCheck
True if voltage limit has to be checked to prevent connect if voltage is over the limit.
- powerLimit
Load limit above which the connect should either not take place or should cause an immediate disconnect.
- usePushbutton
True if pushbutton has to be used for connect.
-
final
case class
RemoteControl(RemotePoint: RemotePoint = null, actuatorMaximum: Double = 0.0, actuatorMinimum: Double = 0.0, remoteControlled: Boolean = false, Control: String = null) extends Element with Product with Serializable
Remote controls are outputs that are sent by the remote unit to actuators in the process.
Remote controls are outputs that are sent by the remote unit to actuators in the process.
- RemotePoint
RemotePoint Reference to the superclass object.
- actuatorMaximum
The maximum set point value accepted by the remote control point.
- actuatorMinimum
The minimum set point value accepted by the remote control point.
- remoteControlled
Set to true if the actuator is remotely controlled.
- Control
Control The Control for the RemoteControl point.
-
final
case class
RemoteInputSignal(IdentifiedObject: IdentifiedObject = null, remoteSignalType: String = null, DiscontinuousExcitationControlDynamics: String = null, PFVArControllerType1Dynamics: String = null, PowerSystemStabilizerDynamics: String = null, Terminal: String = null, UnderexcitationLimiterDynamics: String = null, VoltageCompensatorDynamics: String = null, WindPlantDynamics: String = null, WindTurbineType1or2Dynamics: String = null, WindTurbineType3or4Dynamics: String = null) extends Element with Product with Serializable
Supports connection to a terminal associated with a remote bus from which an input signal of a specific type is coming.
Supports connection to a terminal associated with a remote bus from which an input signal of a specific type is coming.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- remoteSignalType
Type of input signal.
- DiscontinuousExcitationControlDynamics
DiscontinuousExcitationControlDynamics Discontinuous excitation control model using this remote input signal.
- PFVArControllerType1Dynamics
PFVArControllerType1Dynamics Power factor or VAr controller type 1 model using this remote input signal.
- PowerSystemStabilizerDynamics
PowerSystemStabilizerDynamics Power system stabilizer model using this remote input signal.
- Terminal
Terminal Remote terminal with which this input signal is associated.
- UnderexcitationLimiterDynamics
UnderexcitationLimiterDynamics Underexcitation limiter model using this remote input signal.
- VoltageCompensatorDynamics
VoltageCompensatorDynamics Voltage compensator model using this remote input signal.
- WindPlantDynamics
WindPlantDynamics The wind plant using the remote signal.
- WindTurbineType1or2Dynamics
WindTurbineType1or2Dynamics Wind generator type 1 or type 2 model using this remote input signal.
- WindTurbineType3or4Dynamics
WindTurbineType3or4Dynamics Wind turbine type 3 or type 4 models using this remote input signal.
-
final
case class
RemotePoint(IdentifiedObject: IdentifiedObject = null, RemoteUnit: String = null) extends Element with Product with Serializable
For an RTU, remote points correspond to telemetered values or control outputs.
For an RTU, remote points correspond to telemetered values or control outputs.
Other units (e.g. control centres) usually also contain calculated values.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- RemoteUnit
RemoteUnit Remote unit this point belongs to.
-
final
case class
RemoteSource(RemotePoint: RemotePoint = null, deadband: Double = 0.0, scanInterval: Double = 0.0, sensorMaximum: Double = 0.0, sensorMinimum: Double = 0.0, MeasurementValue: String = null) extends Element with Product with Serializable
Remote sources are state variables that are telemetered or calculated within the remote unit.
Remote sources are state variables that are telemetered or calculated within the remote unit.
- RemotePoint
RemotePoint Reference to the superclass object.
- deadband
The smallest change in value to be reported.
- scanInterval
The time interval between scans.
- sensorMaximum
The maximum value the telemetry item can return.
- sensorMinimum
The minimum value the telemetry item can return.
- MeasurementValue
MeasurementValue Link to the physical telemetered point associated with this measurement.
-
final
case class
RemoteUnit(PowerSystemResource: PowerSystemResource = null, remoteUnitType: String = null, CommunicationLinks: List[String] = null, RemotePoints: List[String] = null) extends Element with Product with Serializable
A remote unit can be an RTU, IED, substation control system, control centre, etc.
A remote unit can be an RTU, IED, substation control system, control centre, etc.
The communication with the remote unit can be through various standard protocols (e.g. IEC 61870, IEC 61850) or non standard protocols (e.g. DNP, RP570, etc.). A remote unit contains remote data points that might be telemetered, collected or calculated. The RemoteUnit class inherits PowerSystemResource. The intention is to allow RemoteUnits to have Measurements. These Measurements can be used to model unit status as operational, out of service, unit failure, etc.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- remoteUnitType
Type of remote unit.
- CommunicationLinks
CommunicationLink RTUs may be attached to communication links.
- RemotePoints
RemotePoint Remote points this Remote unit contains.
-
final
case class
RepairItem(Element: BasicElement = null, breakerRepairItem: String = null, transformerRepairItem: String = null, RepairWorkTask: List[String] = null) extends Element with Product with Serializable
Asset component to be repaired or problem area to be corrected.
Asset component to be repaired or problem area to be corrected.
- Element
Reference to the superclass object.
- breakerRepairItem
Breaker component or problem area which is the focus of this maintenance work task (for work tasks related to breakers only).
- transformerRepairItem
Transformer component or problem area which is the focus of this maintenance work task (for work tasks related to transformers only).
- RepairWorkTask
RepairWorkTask Repair work task under which breaker item of this type is repaired.
-
final
case class
RepairWorkTask(WorkTask: WorkTask = null, emergency: Boolean = false, BreakerRepairItem: List[String] = null) extends Element with Product with Serializable
Work task for asset repair.
Work task for asset repair.
Costs associated with this are considered corrective maintenance (CM) costs.
- WorkTask
WorkTask Reference to the superclass object.
- emergency
Repair work is emergency.
- BreakerRepairItem
RepairItem Type of breaker item to be repaird by this repair work task.
-
final
case class
ReportingCapability(Element: BasicElement = null, reportingIntervalPeriod: Int = 0, reportingIntervalType: String = null, reportingMethod: String = null, EnvironmentalAnalog: List[String] = null, EnvironmentalMonitoringStation: String = null) extends Element with Product with Serializable
<font color="#0f0f0f">Definition of one set of reporting capabilities for this monitoring station.
<font color="#0f0f0f">Definition of one set of reporting capabilities for this monitoring station.
The associated EnvironmentalValueSets describe the maximum range of possible environmental values the station is capable of returning. This attribute is intended primarily to assist a utility in managing its stations. </font>
- Element
Reference to the superclass object.
- reportingIntervalPeriod
Number of units of time making up reporting period.
- reportingIntervalType
Unit of time in which reporting period is expressed.
- reportingMethod
Indicates how the weather station reports observations.
- EnvironmentalAnalog
EnvironmentalAnalog One of the environmental value sets expressing one of the reporting capabilities.
- EnvironmentalMonitoringStation
EnvironmentalMonitoringStation The environmental monitoring station to which this set of reporting capabilities belong.
-
final
case class
ReportingGroup(IdentifiedObject: IdentifiedObject = null, BusNameMarker: List[String] = null, PowerSystemResource: List[String] = null, ReportingSuperGroup: String = null, TopologicalNode: List[String] = null) extends Element with Product with Serializable
A reporting group is used for various ad-hoc groupings used for reporting.
A reporting group is used for various ad-hoc groupings used for reporting.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- BusNameMarker
BusNameMarker The bus name markers that belong to this reporting group.
- PowerSystemResource
PowerSystemResource Power system resources which belong to this reporting group.
- ReportingSuperGroup
ReportingSuperGroup Reporting super group to which this reporting group belongs.
- TopologicalNode
TopologicalNode The topological nodes that belong to the reporting group.
-
final
case class
ReportingSuperGroup(IdentifiedObject: IdentifiedObject = null, ReportingGroup: List[String] = null) extends Element with Product with Serializable
A reporting super group, groups reporting groups for a higher level report.
A reporting super group, groups reporting groups for a higher level report.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ReportingGroup
ReportingGroup Reporting groups that are grouped under this super group.
-
final
case class
ReserveDemandCurve(Curve: Curve = null, reqMaxMW: Double = 0.0, reserveRequirementType: String = null, ASRequirements: String = null, MarketRegion: String = null) extends Element with Product with Serializable
Reserve demand curve.
Reserve demand curve.
Models maximum quantities of reserve required per Market Region and models a reserve demand curve for the minimum quantities of reserve. The ReserveDemandCurve is a relationship between unit operating reserve price in $/MWhr (Y-axis) and unit reserves in MW (X-axis).
- Curve
Curve Reference to the superclass object.
- reqMaxMW
Region requirement maximum limit
- reserveRequirementType
Reserve requirement type that the max and curve apply to. For example, operating reserve, regulation and contingency.
- ASRequirements
ASRequirements undocumented
- MarketRegion
MarketRegion undocumented
-
final
case class
ReserveReq(ResourceGroupReq: ResourceGroupReq = null, MarketProduct: String = null, ReserveReqCurve: String = null, SensitivityPriceCurve: String = null) extends Element with Product with Serializable
Requirements for minimum amount of reserve and/or regulation to be supplied by a set of qualified resources.
Requirements for minimum amount of reserve and/or regulation to be supplied by a set of qualified resources.
- ResourceGroupReq
ResourceGroupReq Reference to the superclass object.
- MarketProduct
MarketProduct Market product associated with reserve requirement must be a reserve or regulation product.
- ReserveReqCurve
ReserveReqCurve undocumented
- SensitivityPriceCurve
SensitivityPriceCurve undocumented
-
final
case class
ReserveReqCurve(Curve: Curve = null, ReserveReq: String = null) extends Element with Product with Serializable
A curve relating reserve requirement versus time, showing the values of a specific reserve requirement for each unit of the period covered.
A curve relating reserve requirement versus time, showing the values of a specific reserve requirement for each unit of the period covered.
The curve can be based on "absolute" time or on "normalized' time. X is time, typically expressed in absolute time Y1 is reserve requirement, typically expressed in MW
- Curve
Curve Reference to the superclass object.
- ReserveReq
ReserveReq undocumented
-
final
case class
Reservoir(PowerSystemResource: PowerSystemResource = null, activeStorageCapacity: Double = 0.0, energyStorageRating: Double = 0.0, fullSupplyLevel: Double = 0.0, grossCapacity: Double = 0.0, normalMinOperateLevel: Double = 0.0, riverOutletWorks: String = null, spillTravelDelay: Double = 0.0, spillWayGateType: String = null, spillwayCapacity: Double = 0.0, spillwayCrestLength: Double = 0.0, spillwayCrestLevel: Double = 0.0, HydroPowerPlants: List[String] = null, InflowForecasts: List[String] = null, LevelVsVolumeCurves: List[String] = null, SpillsFromReservoir: String = null, SpillsIntoReservoirs: List[String] = null, TargetLevelSchedule: String = null, UpstreamFromHydroPowerPlants: List[String] = null) extends Element with Product with Serializable
A water storage facility within a hydro system, including: ponds, lakes, lagoons, and rivers.
A water storage facility within a hydro system, including: ponds, lakes, lagoons, and rivers.
The storage is usually behind some type of dam.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- activeStorageCapacity
Storage volume between the full supply level and the normal minimum operating level.
- energyStorageRating
The reservoir's energy storage rating in energy for given head conditions.
- fullSupplyLevel
Full supply level, above which water will spill. This can be the spillway crest level or the top of closed gates.
- grossCapacity
Total capacity of reservoir.
- normalMinOperateLevel
Normal minimum operating level below which the penstocks will draw air.
- riverOutletWorks
River outlet works for riparian right releases or other purposes.
- spillTravelDelay
The spillway water travel delay to the next downstream reservoir.
- spillWayGateType
Type of spillway gate, including parameters.
- spillwayCapacity
The flow capacity of the spillway in cubic meters per second.
- spillwayCrestLength
The length of the spillway crest.
- spillwayCrestLevel
Spillway crest level above which water will spill.
- HydroPowerPlants
HydroPowerPlant Generators discharge water to or pumps are supplied water from a downstream reservoir.
- InflowForecasts
InflowForecast A reservoir may have a "natural" inflow forecast.
- LevelVsVolumeCurves
LevelVsVolumeCurve A reservoir may have a level versus volume relationship.
- SpillsFromReservoir
Reservoir A reservoir may spill into a downstream reservoir.
- SpillsIntoReservoirs
Reservoir A reservoir may spill into a downstream reservoir.
- TargetLevelSchedule
TargetLevelSchedule A reservoir may have a water level target schedule.
- UpstreamFromHydroPowerPlants
HydroPowerPlant Generators are supplied water from or pumps discharge water to an upstream reservoir.
-
final
case class
ResourceAwardClearing(MarketFactors: MarketFactors = null, contingencyActive: String = null, dispatchMode: String = null, RUCAwardInstruction: List[String] = null, ResourceAwardInstruction: List[String] = null) extends Element with Product with Serializable
Models details of bid and offer market clearing.
Models details of bid and offer market clearing.
Class indicates whether a contingency is active and whether the automatic dispatching system is active for this interval of the market solution.
- MarketFactors
MarketFactors Reference to the superclass object.
- contingencyActive
Indication that the system is currently operating in a contingency mode.
- dispatchMode
undocumented
- RUCAwardInstruction
RUCAwardInstruction undocumented
- ResourceAwardInstruction
ResourceAwardInstruction undocumented
-
final
case class
ResourceAwardInstruction(Element: BasicElement = null, awardMW: Double = 0.0, clearedMW: Double = 0.0, clearedPrice: Double = 0.0, congestLMP: Double = 0.0, costLMP: Double = 0.0, dispatcherAddedMW: Double = 0.0, economicMax: Double = 0.0, economicMin: Double = 0.0, effRegulationDownLimit: Double = 0.0, effRegulationUpLimit: Double = 0.0, lmp: Double = 0.0, lossLMP: Double = 0.0, manuallyBlocked: String = null, marginalResourceIndicator: String = null, mustRunInd: Boolean = false, noLoadCost: Double = 0.0, optimalBidCost: Double = 0.0, optimalBidPay: Double = 0.0, optimalMargin: Double = 0.0, overrideTimeStamp: String = null, overrideValue: Double = 0.0, selfSchedMW: Double = 0.0, startUpCost: Double = 0.0, status: String = null, totalRevenue: Double = 0.0, updateTimeStamp: String = null, updateType: String = null, updateUser: String = null, ClearingResourceAward: List[String] = null, MarketProduct: String = null, RegisteredResource: String = null, SelfScheduleBreakdown: List[String] = null) extends Element with Product with Serializable
Model of market results, instruction for resource.
Model of market results, instruction for resource.
Contains details of award as attributes.
- Element
Reference to the superclass object.
- awardMW
For DA Energy: Not Applicable; For DA AS: DA AS market award; For RT Energy: Not Applicable; For RT AS: RT AS market award (excluding DA AS market or self-proviison awards)
- clearedMW
For DA Energy: Total Schedule = DA market schedule + DA self-schedule award; For DA AS: DA Ancillary Service Awards = DA AS market award + DA AS self-provision award; For RT Energy: Total Schedule = RT market schedule + RT self-schedule award; For RT AS: RT Ancillary Service Awards = RT AS self-provision award + RT AS market award + DA AS market award + DA AS self-provision award;
- clearedPrice
Marginal Price ($/MW) for the commodity (Regulation Up, Regulation Down, Spinning Reserve, or Non-spinning reserve) for pricing run.
- congestLMP
Congestion component of Location Marginal Price (LMP) in monetary units per MW.
- costLMP
Cost component of Locational Marginal Pricing (LMP) in monetary units per MW.
- dispatcherAddedMW
The tier2 mw added by dispatcher action Market results of the synchronized reserve market
- economicMax
Unit max output for dispatch; bid in economic maximum
- economicMin
Unit min output for dispatch; bid in economic minimum
- effRegulationDownLimit
Effective Regulation Down Limit (MW)
- effRegulationUpLimit
Effective Regulation Up Limit
- lmp
Locational marginal price value
- lossLMP
Loss component of Location Marginal Price (LMP) in monetary units per MW.
- manuallyBlocked
Indicates if an award was manually blocked (Y/N). Valid for Spinning and Non-spinning.
- marginalResourceIndicator
Indicator (Yes / No) that this resource set the price for this dispatch / schedule.
- mustRunInd
Identifes if the unit was set to must run by the market participant responsible for bidding in the unit
- noLoadCost
Unit no-load cost in case of energy commodity
- optimalBidCost
Optimal Bid cost
- optimalBidPay
Optimal Bid production payment based on LMP
- optimalMargin
Optimal Bid production margin
- overrideTimeStamp
Time the manual data entry occured.
- overrideValue
Provides the ability for the grid operator to override items, such as spin capacity requirements, prior to running the algorithm. This value is market product based (spin, non-spin, reg up, reg down, or RUC).
- selfSchedMW
For DA Energy: DA total self-schedule award; For DA AS: DA AS self-provision award; For RT Energy: RT total self-schedule award; For RT AS: RT AS self-provision award (excluding DA AS market or self-provision awards)
- startUpCost
Unit start up cost in case of energy commodity
- status
In or out status of resource
- totalRevenue
Total bid revenue (startup_cost + no_load_cost + bid_pay)
- updateTimeStamp
undocumented
- updateType
undocumented
- updateUser
undocumented
- ClearingResourceAward
ResourceAwardClearing undocumented
- MarketProduct
MarketProduct undocumented
- RegisteredResource
RegisteredResource undocumented
- SelfScheduleBreakdown
SelfScheduleBreakdown undocumented
-
final
case class
ResourceBid(Bid: Bid = null, aggregationFlag: Int = 0, bidStatus: String = null, commodityType: String = null, contingencyAvailFlag: String = null, createdISO: String = null, energyMaxDay: Double = 0.0, energyMinDay: Double = 0.0, marketSepFlag: String = null, minDispatchTime: Int = 0, resourceLoadingType: Int = 0, shutDownsMaxDay: Int = 0, shutDownsMaxWeek: Int = 0, startUpsMaxDay: Int = 0, startUpsMaxWeek: Int = 0, virtual: Boolean = false, BidError: List[String] = null) extends Element with Product with Serializable
Energy bid for generation, load, or virtual type for the whole of the market-trading period (i.e., one day in day ahead market or one hour in the real time market).
Energy bid for generation, load, or virtual type for the whole of the market-trading period (i.e., one day in day ahead market or one hour in the real time market).
- Bid
Bid Reference to the superclass object.
- aggregationFlag
Aggregation flag 0: individual resource level 1: Aggregated node location 2: Aggregated price location)
- bidStatus
undocumented
- commodityType
Energy product (commodity) type: 'En' - Energy 'Ru' - Regulation Up 'Rd' - Regulation Dn 'Sr' - Spinning Reserve 'Nr' - Non-Spinning Reserve 'Or' - Operating Reserve
- contingencyAvailFlag
contingent operating reserve availiability (Yes/No). Resource is availiable to participate with capacity only in contingency dispatch.
- createdISO
A Yes indicates that this bid was created by the ISO.
- energyMaxDay
Maximum amount of energy per day which can be produced during the trading period in MWh
- energyMinDay
Minimum amount of energy per day which has to be produced during the trading period in MWh
- marketSepFlag
Market Separation Flag 'Y' - Enforce market separation constraints for this bid 'N' - Don't enforce market separation constraints for this bid.
- minDispatchTime
minimum number of consecutive hours a resource shall be dispatched if bid is accepted
- resourceLoadingType
Resource loading curve type 1 - step-wise continuous loading 2 - piece-wise linear continuous loading 3 - block loading
- shutDownsMaxDay
Maximum number of shutdowns per day.
- shutDownsMaxWeek
Maximum number of shutdowns per week.
- startUpsMaxDay
Maximum number of startups per day.
- startUpsMaxWeek
Maximum number of startups per week.
- virtual
True if bid is virtual. Bid is assumed to be non-virtual if attribute is absent
- BidError
BidError undocumented
-
final
case class
ResourceCapacity(Element: BasicElement = null, capacityType: String = null, defaultCapacity: Double = 0.0, maximumCapacity: Double = 0.0, minimumCapacity: Double = 0.0, unitSymbol: String = null, RegisteredResource: List[String] = null) extends Element with Product with Serializable
This class model the various capacities of a resource.
This class model the various capacities of a resource.
A resource may have numbers of capacities related to operating, ancillary services, energy trade and so forth. Capacities may be defined for active power or reactive power.
- Element
Reference to the superclass object.
- capacityType
capacity type The types are but not limited to: Regulation Up Regulation Dn Spinning Reserve Non-Spinning Reserve FOO capacity MOO capacity
- defaultCapacity
default capacity
- maximumCapacity
maximum capacity
- minimumCapacity
minimum capacity
- unitSymbol
Unit selection for the capacity values.
- RegisteredResource
RegisteredResource undocumented
-
final
case class
ResourceCertification(Element: BasicElement = null, market: String = null, qualificationFlag: String = null, type: String = null, RegisteredResource: String = null) extends Element with Product with Serializable
Specifies certification for a resource to participate in a specific markets.
Specifies certification for a resource to participate in a specific markets.
- Element
Reference to the superclass object.
- market
market type
- qualificationFlag
Status of the qualification ('Y' = Active, 'N' = Inactive)
- type
Type of service based on ResourceAncillaryServiceType enumeration
- RegisteredResource
RegisteredResource RegisteredResources are qualified for resource ancillary service types (which include market product types as well as other types such as BlackStart) by the association to the class ResourceAncillaryServiceQualification.
-
final
case class
ResourceCertification2(Element: BasicElement = null, certifiedDAM: String = null, certifiedNonspinDAM: String = null, certifiedNonspinDAMMw: Double = 0.0, certifiedNonspinRTM: String = null, certifiedNonspinRTMMw: Double = 0.0, certifiedPIRP: String = null, certifiedRTM: String = null, certifiedRUC: String = null, certifiedRegulation: String = null, certifiedRegulationMw: Double = 0.0, certifiedReplaceAS: String = null, certifiedSpin: String = null, certifiedSpinMw: Double = 0.0, RegisteredResource: List[String] = null) extends Element with Product with Serializable
This class represent the resource certification for a specific product type.
This class represent the resource certification for a specific product type.
For example, a resource is certified for Non-Spinning reserve for RTM.
- Element
Reference to the superclass object.
- certifiedDAM
undocumented
- certifiedNonspinDAM
undocumented
- certifiedNonspinDAMMw
undocumented
- certifiedNonspinRTM
undocumented
- certifiedNonspinRTMMw
undocumented
- certifiedPIRP
undocumented
- certifiedRTM
undocumented
- certifiedRUC
undocumented
- certifiedRegulation
undocumented
- certifiedRegulationMw
undocumented
- certifiedReplaceAS
undocumented
- certifiedSpin
undocumented
- certifiedSpinMw
undocumented
- RegisteredResource
RegisteredResource undocumented
-
final
case class
ResourceClearing(MarketFactors: MarketFactors = null, ResourceDispatchResults: List[String] = null, ResourceLoadFollowingInst: List[String] = null) extends Element with Product with Serializable
Model of market results, including cleaing result of resources.
Model of market results, including cleaing result of resources.
Associated with ResourceDispatchResults.
- MarketFactors
MarketFactors Reference to the superclass object.
- ResourceDispatchResults
ResourceDispatchResults undocumented
- ResourceLoadFollowingInst
ResourceLoadFollowingInst undocumented
- final case class ResourceDeploymentStatus(Element: BasicElement = null, acceptComments: String = null, acceptStatus: String = null, resourceResponseMW: Double = 0.0, InstructionClearing: String = null) extends Element with Product with Serializable
-
final
case class
ResourceDispatchResults(Element: BasicElement = null, blockedDispatch: String = null, blockedPublishDOP: String = null, contingencyFlag: String = null, limitIndicator: String = null, lowerLimit: Double = 0.0, maxRampRate: Double = 0.0, operatingLimitHigh: Double = 0.0, operatingLimitLow: Double = 0.0, penaltyDispatchIndicator: String = null, regulatingLimitHigh: Double = 0.0, regulatingLimitLow: Double = 0.0, resourceStatus: String = null, totalSchedule: Double = 0.0, updateTimeStamp: String = null, updateType: String = null, updateUser: String = null, upperLimit: Double = 0.0, RegisteredResource: String = null, ResourceClearing: String = null) extends Element with Product with Serializable
The ResourceDispatchResults class provides market results that can be provided to a SC.
The ResourceDispatchResults class provides market results that can be provided to a SC.
The specific data provided consists of several indicators such as contingency flags, blocked start up, and RMR dispatch. It also provides the projected overall and the regulating status of the resource.
- Element
Reference to the superclass object.
- blockedDispatch
Blocked Dispatch Indicator (Yes/No)
- blockedPublishDOP
Block sending DOP to ADS (Y/N)
- contingencyFlag
Contingent Operating Reserve Indicator (Yes/No). Resource participating with AS capacity in contingency dispatch.
- limitIndicator
indicate which limit is the constraints
- lowerLimit
resource energy ramping lower limit
- maxRampRate
maximum ramp rate
- operatingLimitHigh
The upper operating limit incorporating any derate used by the RTD for the Binding Interval.
- operatingLimitLow
The lower operating limit incorporating any derate used by the RTD for the Binding Interval.
- penaltyDispatchIndicator
Penalty Dispatch Indicator (Yes / No) indicating an un-economic adjustment.
- regulatingLimitHigh
The upper regulating limit incorporating any derate used by the RTD for the Binding Interval.
- regulatingLimitLow
The lower regulating limit incorporating any derate used by the RTD for the Binding Interval.
- resourceStatus
Unit Commitment Status (On/Off/Starting)
- totalSchedule
Resource total upward schedule. total schedule = En + all AS per resource per interval
- updateTimeStamp
undocumented
- updateType
undocumented
- updateUser
undocumented
- upperLimit
resource energy ramping upper limit
- RegisteredResource
RegisteredResource undocumented
- ResourceClearing
ResourceClearing undocumented
-
final
case class
ResourceGroup(IdentifiedObject: IdentifiedObject = null, status: String = null, type: String = null, RegisteredResources: List[String] = null, ResourceGroupReqs: List[String] = null) extends Element with Product with Serializable
A logical grouping of resources that are used to model location of types of requirements for ancillary services such as spinning reserve zones, regulation zones, etc.
A logical grouping of resources that are used to model location of types of requirements for ancillary services such as spinning reserve zones, regulation zones, etc.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- status
Status of this group.
- type
Type of this group.
- RegisteredResources
RegisteredResource undocumented
- ResourceGroupReqs
ResourceGroupReq undocumented
-
final
case class
ResourceGroupReq(IdentifiedObject: IdentifiedObject = null, RTOs: List[String] = null, ResourceGroup: String = null) extends Element with Product with Serializable
Ancillary service requirements for a market.
Ancillary service requirements for a market.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- RTOs
RTO undocumented
- ResourceGroup
ResourceGroup undocumented
-
final
case class
ResourceLoadFollowingInst(Element: BasicElement = null, calcLoadFollowingMW: Double = 0.0, dispWindowHighLimt: Double = 0.0, dispWindowLowLimt: Double = 0.0, instructionID: String = null, intervalStartTime: String = null, RegisteredResource: String = null, ResourceClearing: String = null) extends Element with Product with Serializable
Model of market clearing results for resources that bid to follow load.
Model of market clearing results for resources that bid to follow load.
- Element
Reference to the superclass object.
- calcLoadFollowingMW
weighted average for RTPD and RTCD and same for RTID
- dispWindowHighLimt
undocumented
- dispWindowLowLimt
undocumented
- instructionID
Unique instruction id per instruction, assigned by the SC and provided to ADS. ADS passes through.
- intervalStartTime
The start of the time interval for which requirement is defined.
- RegisteredResource
RegisteredResource undocumented
- ResourceClearing
ResourceClearing undocumented
-
final
case class
ResourceOperationMaintenanceCost(Curve: Curve = null, gasPercentAboveLowSustainedLimit: Double = 0.0, oilPercentAboveLowSustainedLimit: Double = 0.0, omCostColdStartup: Double = 0.0, omCostHotStartup: Double = 0.0, omCostIntermediateStartup: Double = 0.0, omCostLowSustainedLimit: Double = 0.0, solidfuelPercentAboveLowSustainedLimit: Double = 0.0, ResourceVerifiableCosts: String = null) extends Element with Product with Serializable
To model the Operation and Maintenance (O and M) costs of a generation resource.
To model the Operation and Maintenance (O and M) costs of a generation resource.
- Curve
Curve Reference to the superclass object.
- gasPercentAboveLowSustainedLimit
Percentage of Fuel Index Price (gas) for operating above Low Sustained Limit (LSL)
- oilPercentAboveLowSustainedLimit
Percentage of Fuel Oil Price (FOP) for operating above Low Sustained Limit (LSL)
- omCostColdStartup
Verifiable O&M Cost ($), Cold Startup
- omCostHotStartup
Verifiable O&M Cost ($), Hot Startup
- omCostIntermediateStartup
Verifiable O&M Cost ($), Intermediate Startup
- omCostLowSustainedLimit
Verifiable O&M Cost ($/MWh), LSL
- solidfuelPercentAboveLowSustainedLimit
Percentage of Solid Fuel for operating above Low Sustained Limit (LSL)
- ResourceVerifiableCosts
ResourceVerifiableCosts undocumented
-
final
case class
ResourcePerformanceEvaluation(IdentifiedObject: IdentifiedObject = null, effectiveEndTime: String = null, effectiveStartTime: String = null, evaluationDescription: String = null, evaluationValue: String = null, DemandResponseActualEvent: String = null, ResorcePerformanceGlobalFactor: List[String] = null, ResourcePerformanceTimeSeriesFactors: List[String] = null) extends Element with Product with Serializable
Represents an the performance evaluation of a resource deployment.
Represents an the performance evaluation of a resource deployment.
Every resource deployment may have many performance evaluations, using different evaluation metrics or algorithms, or produced by different evaluation authorities.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- effectiveEndTime
undocumented
- effectiveStartTime
undocumented
- evaluationDescription
Description of the performance evaluation, e.g. the rating classification used (any is allowed), why the evaluation was performed, anything that describes the demand response performance evaluation.
- evaluationValue
The value of the performance. as a String, any rating scheme is supported (e.g. "1","2","3" or "low", "medium", "high"). The rating scheme is described in the performanceValueDescription attribute.
- DemandResponseActualEvent
DistributedResourceActualEvent undocumented
- ResorcePerformanceGlobalFactor
ResourcePerformanceGlobalFactor undocumented
- ResourcePerformanceTimeSeriesFactors
ResourcePerformanceTimeSeriesFactor undocumented
-
final
case class
ResourcePerformanceGlobalFactor(IdentifiedObject: IdentifiedObject = null, factorDescription: String = null, factorValue: String = null, ResourcePerformanceEvaluation: List[String] = null) extends Element with Product with Serializable
Global factors are property/value pairs that are used to adjust resource performance values.
Global factors are property/value pairs that are used to adjust resource performance values.
Example include scale factors (e.g. scale a baseline up or down), adders (positive or negative), etc.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- factorDescription
Description (name) of the property (factor).
- factorValue
Value of the property (factor).
- ResourcePerformanceEvaluation
ResourcePerformanceEvaluation undocumented
-
final
case class
ResourcePerformanceRating(IdentifiedObject: IdentifiedObject = null, effectiveEndTime: String = null, effectiveStartTime: String = null, ratingDescription: String = null, ratingType: String = null, ratingValue: String = null, RegisteredResource: String = null) extends Element with Product with Serializable
Rating of a resource for its demand response performance.
Rating of a resource for its demand response performance. e.g. given a set on monthly resource demand response performance evaluations, the resource may be rated with excellent, average, or poor performance for the sample set.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- effectiveEndTime
starting date time that the rating is valid for
- effectiveStartTime
ending date time that the rating is valid for
- ratingDescription
the resource's demand response rating description
- ratingType
the type of performance rating, e.g. which market or product the rating is for
- ratingValue
the resource's demand response rating
- RegisteredResource
RegisteredDistributedResource undocumented
-
final
case class
ResourcePerformanceTimeSeriesFactor(RegularIntervalSchedule: RegularIntervalSchedule = null, timeSeriesDataType: String = null, timeSeriesDescription: String = null, value1Description: String = null, value2Description: String = null, ResourcePerformanceEvaluation: String = null) extends Element with Product with Serializable
Represents the performance of a resource as time series data for a specified time period, time interval, and evaluation criteria.
Represents the performance of a resource as time series data for a specified time period, time interval, and evaluation criteria.
- RegularIntervalSchedule
RegularIntervalSchedule Reference to the superclass object.
- timeSeriesDataType
Type of the time series data, e.g. baseline data, meter read data, computed performance data.
- timeSeriesDescription
Optional description of the time series data, e.g. baseline data, meter read data, computed performance data.
- value1Description
Description for the value1 contained within the TimeSeriesFactor.
- value2Description
Description for the value2 contained within the TimeSeriesFactor.
- ResourcePerformanceEvaluation
ResourcePerformanceEvaluation undocumented
-
final
case class
ResourceStartupCost(Element: BasicElement = null, fuelColdStartup: Double = 0.0, fuelHotStartup: Double = 0.0, fuelIntermediateStartup: Double = 0.0, fuelLowSustainedLimit: Double = 0.0, gasPercentColdStartup: Double = 0.0, gasPercentHotStartup: Double = 0.0, gasPercentIntermediateStartup: Double = 0.0, gasPercentLowSustainedLimit: Double = 0.0, oilPercentColdStartup: Double = 0.0, oilPercentHotStartup: Double = 0.0, oilPercentIntermediateStartup: Double = 0.0, oilPercentLowSustainedLimit: Double = 0.0, solidfuelPercentColdStartup: Double = 0.0, solidfuelPercentHotStartup: Double = 0.0, solidfuelPercentIntermediateStartup: Double = 0.0, solidfuelPercentLowSustainedLimit: Double = 0.0, ResourceVerifiableCosts: String = null) extends Element with Product with Serializable
To model the startup costs of a generation resource.
To model the startup costs of a generation resource.
- Element
Reference to the superclass object.
- fuelColdStartup
Verifiable Cold Start Up Fuel (MMBtu per start)
- fuelHotStartup
Verifiable Hot Start Up Fuel (MMBtu per start)
- fuelIntermediateStartup
Verifiable Intermediate Start Up Fuel (MMBtu per start)
- fuelLowSustainedLimit
Minimum-Energy fuel, MMBtu/MWh
- gasPercentColdStartup
Percentage of Fuel Index Price (gas) for cold startup
- gasPercentHotStartup
Percentage of Fuel Index Price (gas) for hot startup
- gasPercentIntermediateStartup
Percentage of Fuel Index Price (gas) for intermediate startup
- gasPercentLowSustainedLimit
Percentage of FIP (gas) for operating at LSL
- oilPercentColdStartup
Percentage of Fuel Oil Price (FOP) for cold startup
- oilPercentHotStartup
Percentage of Fuel Oil Price (FOP) for hot startup
- oilPercentIntermediateStartup
Percentage of Fuel Oil Price (FOP) for intermediate startup
- oilPercentLowSustainedLimit
Percentage of FOP (oil) for operating at LSL
- solidfuelPercentColdStartup
Percentage of Solid Fuel for cold startup
- solidfuelPercentHotStartup
Percentage of Solid Fuel for hot startup
- solidfuelPercentIntermediateStartup
Percentage of Solid Fuel for intermedite startup
- solidfuelPercentLowSustainedLimit
Percentage of Solid Fuel for operating at LSL
- ResourceVerifiableCosts
ResourceVerifiableCosts undocumented
-
final
case class
ResourceVerifiableCosts(Element: BasicElement = null, MktHeatRateCurve: String = null, RegisteredResource: String = null, ResourceOperationMaintenanceCost: String = null, ResourceStartupCost: List[String] = null) extends Element with Product with Serializable
This class is defined to describe the verifiable costs associated with a generation resource.
This class is defined to describe the verifiable costs associated with a generation resource.
- Element
Reference to the superclass object.
- MktHeatRateCurve
MktHeatRateCurve undocumented
- RegisteredResource
RegisteredResource undocumented
- ResourceOperationMaintenanceCost
ResourceOperationMaintenanceCost undocumented
- ResourceStartupCost
ResourceStartupCost undocumented
-
final
case class
ResponseMethod(IdentifiedObject: IdentifiedObject = null, activePower: Double = 0.0, activePowerUOM: String = null, method: String = null, siteMultiplier: Int = 0, RegisteredResource: String = null) extends Element with Product with Serializable
Specifies a category of energy usage that the demand response applies for; e.g.
Specifies a category of energy usage that the demand response applies for; e.g. energy from lighting, HVAC, other.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- activePower
The active power value for the demand adjustment type. This supports requests to be made to a resource for some amount of active power provided by a particular response method, as specified by the method attribute (e.g. lighting, HVAC, wall mounted air conditioners, etc.).
- activePowerUOM
The unit of measure of active power, e.g. kiloWatts (kW), megaWatts (mW), etc.
- method
The response method (e.g. lighting, HVAC, wall mounted air conditioners, etc.).
- siteMultiplier
This value provides for scaling of a response method's active power. For example, a response method of air conditioning could utilize a small amount of active power from each air conditioning unit (e.g. 0.1 kiloWatt), but the site multiplier could be used to produce a the total active power adjustment by multiplying the response method active power by this value (e.g. a building with 100 window air conditioning units, so 100 * 0.1 kW = 10 kW).
- RegisteredResource
RegisteredDistributedResource undocumented
-
final
case class
RightOfWay(Agreement: Agreement = null, propertyData: String = null, LandProperties: List[String] = null) extends Element with Product with Serializable
A right-of-way (ROW) is for land where it is lawful to use for a public road, an electric power line, etc.
A right-of-way (ROW) is for land where it is lawful to use for a public road, an electric power line, etc.
Note that the association to Location, Asset, Organisation, etc. for the Grant is inherited from Agreement, a type of Document.
- Agreement
Agreement Reference to the superclass object.
- propertyData
Property related information that describes the ROW's land parcel. For example, it may be a deed book number, deed book page number, and parcel number.
- LandProperties
LandProperty All land properties this right of way applies to.
-
final
case class
RiskScore(AggregateScore: AggregateScore = null, kind: String = null, AssetHealthScore: List[String] = null) extends Element with Product with Serializable
Score that is indicative of the risk associated with one or more assets.
Score that is indicative of the risk associated with one or more assets.
- AggregateScore
AggregateScore Reference to the superclass object.
- kind
The risk kind, such as CustomerRisk, FinancialRisk, SafetyRisk, etc.
- AssetHealthScore
HealthScore Individual health score associated with this risk score.
-
final
case class
Role(IdentifiedObject: IdentifiedObject = null, status: String = null, type: String = null) extends Element with Product with Serializable
Enumeration of potential roles that might be played by one object relative to another.
Enumeration of potential roles that might be played by one object relative to another.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- status
undocumented
- type
Type of role.
-
final
case class
RotatingMachine(RegulatingCondEq: RegulatingCondEq = null, p: Double = 0.0, q: Double = 0.0, ratedPowerFactor: Double = 0.0, ratedS: Double = 0.0, ratedU: Double = 0.0, GeneratingUnit: String = null, HydroPump: String = null) extends Element with Product with Serializable
A rotating machine which may be used as a generator or motor.
A rotating machine which may be used as a generator or motor.
- RegulatingCondEq
RegulatingCondEq Reference to the superclass object.
- p
Active power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution.
- q
Reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution.
- ratedPowerFactor
Power factor (nameplate data). It is primarily used for short circuit data exchange according to IEC 60909. The attribute cannot be a negative value.
- ratedS
Nameplate apparent power rating for the unit. The attribute shall have a positive value.
- ratedU
Rated voltage (nameplate data, Ur in IEC 60909-0). It is primarily used for short circuit data exchange according to IEC 60909. The attribute shall be a positive value.
- GeneratingUnit
GeneratingUnit A synchronous machine may operate as a generator and as such becomes a member of a generating unit.
- HydroPump
HydroPump The synchronous machine drives the turbine which moves the water from a low elevation to a higher elevation. The direction of machine rotation for pumping may or may not be the same as for generating.
-
final
case class
RotatingMachineDynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null, damping: Double = 0.0, inertia: Double = 0.0, saturationFactor: Double = 0.0, saturationFactor120: Double = 0.0, statorLeakageReactance: Double = 0.0, statorResistance: Double = 0.0) extends Element with Product with Serializable
Abstract parent class for all synchronous and asynchronous machine standard models.
Abstract parent class for all synchronous and asynchronous machine standard models.
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- damping
Damping torque coefficient (D) (>= 0). A proportionality constant that, when multiplied by the angular velocity of the rotor poles with respect to the magnetic field (frequency), results in the damping torque. This value is often zero when the sources of damping torques (generator damper windings, load damping effects, etc.) are modelled in detail. Typical value = 0.
- inertia
Inertia constant of generator or motor and mechanical load (H) (> 0). This is the specification for the stored energy in the rotating mass when operating at rated speed. For a generator, this includes the generator plus all other elements (turbine, exciter) on the same shaft and has units of MW x s. For a motor, it includes the motor plus its mechanical load. Conventional units are PU on the generator MVA base, usually expressed as MW x s / MVA or just s. This value is used in the accelerating power reference frame for operator training simulator solutions. Typical value = 3.
- saturationFactor
Saturation factor at rated terminal voltage (S1) (>= 0). Not used by simplified model. Defined by defined by S(E1) in the SynchronousMachineSaturationParameters diagram. Typical value = 0,02.
- saturationFactor120
Saturation factor at 120% of rated terminal voltage (S12) (>= RotatingMachineDynamics.saturationFactor). Not used by the simplified model, defined by S(E2) in the SynchronousMachineSaturationParameters diagram. Typical value = 0,12.
- statorLeakageReactance
Stator leakage reactance (Xl) (>= 0). Typical value = 0,15.
- statorResistance
Stator (armature) resistance (Rs) (>= 0). Typical value = 0,005.
-
final
case class
Route(IdentifiedObject: IdentifiedObject = null, status: String = null, type: String = null, Crews: List[String] = null, Locations: List[String] = null) extends Element with Product with Serializable
Route that is followed, for example by service crews.
Route that is followed, for example by service crews.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- status
undocumented
- type
Classification by utility's work management standards and practices.
- Crews
OldCrew undocumented
- Locations
Location undocumented
-
final
case class
SCADAInformation(Element: BasicElement = null, timeStamp: String = null) extends Element with Product with Serializable
Contains information about the update from SCADA.
Contains information about the update from SCADA.
- Element
Reference to the superclass object.
- timeStamp
time of the update from SCADA
-
final
case class
SVC(ShuntCompensator: ShuntCompensator = null, capacitiveRating: Double = 0.0, inductiveRating: Double = 0.0) extends Element with Product with Serializable
SVC asset allows the capacitive and inductive ratings for each phase to be specified individually if required.
SVC asset allows the capacitive and inductive ratings for each phase to be specified individually if required.
- ShuntCompensator
ShuntCompensator Reference to the superclass object.
- capacitiveRating
Maximum capacitive reactive power.
- inductiveRating
Maximum inductive reactive power.
-
final
case class
SVCUserDefined(StaticVarCompensatorDynamics: StaticVarCompensatorDynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Static var compensator (SVC) function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
Static var compensator (SVC) function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
- StaticVarCompensatorDynamics
StaticVarCompensatorDynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
SafetyDocument(Document: Document = null, issuedDateTime: String = null, releasedDateTime: String = null, IssuedBySupervisor: String = null, IssuedToSupervisor: String = null, ReleasedBySupervisor: String = null, ReleasedToSupervisor: String = null, SwitchingPlan: String = null) extends Element with Product with Serializable
Document restricting or authorising works on electrical equipment (for example a permit to work, sanction for test, limitation of access, or certificate of isolation), defined based upon organisational practices.
Document restricting or authorising works on electrical equipment (for example a permit to work, sanction for test, limitation of access, or certificate of isolation), defined based upon organisational practices.
- Document
Document Reference to the superclass object.
- issuedDateTime
Date and time this safety document has been issued.
- releasedDateTime
Date and time this safety document has been released.
- IssuedBySupervisor
OperationsSafetySupervisor Supervisor that issued this safety document.
- IssuedToSupervisor
FieldSafetySupervisor Supervisor to whom this safety document is issued.
- ReleasedBySupervisor
FieldSafetySupervisor Supervisor that released this safety document.
- ReleasedToSupervisor
OperationsSafetySupervisor Supervisor to which this safety document is released.
- SwitchingPlan
SwitchingPlan Switching plan to which this safety document applies.
- final case class ScheduledActivePowerLimitValue(ScheduledLimitValue: ScheduledLimitValue = null, value: Double = 0.0) extends Element with Product with Serializable
-
final
case class
ScheduledApparentPowerLimitValue(ScheduledLimitValue: ScheduledLimitValue = null, value: Double = 0.0) extends Element with Product with Serializable
A time scheduled value for apparent power limit.
A time scheduled value for apparent power limit.
- ScheduledLimitValue
ScheduledLimitValue Reference to the superclass object.
- value
The apparent power limit value for the scheduled time.
-
final
case class
ScheduledCurrentLimitValue(ScheduledLimitValue: ScheduledLimitValue = null, value: Double = 0.0) extends Element with Product with Serializable
A current limit that is scheduled.
A current limit that is scheduled.
- ScheduledLimitValue
ScheduledLimitValue Reference to the superclass object.
- value
The current flow limit value applicable at the scheduled time.
-
final
case class
ScheduledEvent(IdentifiedObject: IdentifiedObject = null, duration: Double = 0.0, status: String = null, type: String = null, Assets: List[String] = null, ScheduledEventData: String = null) extends Element with Product with Serializable
An event to trigger one or more activities, such as reading a meter, recalculating a bill, requesting work, when generating units must be scheduled for maintenance, when a transformer is scheduled to be refurbished, etc.
An event to trigger one or more activities, such as reading a meter, recalculating a bill, requesting work, when generating units must be scheduled for maintenance, when a transformer is scheduled to be refurbished, etc.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- duration
Duration of the scheduled event, for example, the time to ramp between values.
- status
Status undocumented
- type
Type of scheduled event.
- Assets
Asset undocumented
- ScheduledEventData
ScheduledEventData Specification for this scheduled event.
-
final
case class
ScheduledEventData(Element: BasicElement = null, estimatedWindow: String = null, requestedWindow: String = null, status: String = null, InspectionDataSet: String = null, ScheduledEvents: List[String] = null) extends Element with Product with Serializable
Schedule parameters for an activity that is to occur, is occurring, or has completed.
Schedule parameters for an activity that is to occur, is occurring, or has completed.
- Element
Reference to the superclass object.
- estimatedWindow
Estimated date and time for activity execution (with earliest possibility of activity initiation and latest possibility of activity completion).
- requestedWindow
Requested date and time interval for activity execution.
- status
Status undocumented
- InspectionDataSet
InspectionDataSet undocumented
- ScheduledEvents
ScheduledEvent All scheduled events with this specification.
- final case class ScheduledLimitDependency(LimitDependency: LimitDependency = null, ScheduledLimitValues: List[String] = null) extends Element with Product with Serializable
-
final
case class
ScheduledLimitValue(IdentifiedObject: IdentifiedObject = null, ScheduledLimitDependency: String = null, Season: String = null) extends Element with Product with Serializable
A limit that is applicable during a scheduled time period.
A limit that is applicable during a scheduled time period.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ScheduledLimitDependency
ScheduledLimitDependency undocumented
- Season
Season The season for which the scheduled limits applies. If not specified, then applicable ot any season.
-
final
case class
ScheduledVoltageLimitValue(ScheduledLimitValue: ScheduledLimitValue = null, value: Double = 0.0) extends Element with Product with Serializable
A voltage limit value for a scheduled time.
A voltage limit value for a scheduled time.
- ScheduledLimitValue
ScheduledLimitValue Reference to the superclass object.
- value
The voltage limit value for the scheduled time.
-
final
case class
SchedulingCoordinator(MarketParticipant: MarketParticipant = null, creditFlag: String = null, creditStartEffectiveDate: String = null, lastModified: String = null, qualificationStatus: String = null, scid: String = null, FromSCTrade: List[String] = null, LoadRatio: String = null, MarketParticipant_attr: String = null, SubmitFromSCTrade: List[String] = null, SubmitToSCTrade: List[String] = null, ToSCTrade: List[String] = null, TransmissionContractRight: List[String] = null) extends Element with Product with Serializable
Market participants could be represented by Scheduling Coordinators (SCs) that are registered with the RTO/ISO.
Market participants could be represented by Scheduling Coordinators (SCs) that are registered with the RTO/ISO.
One participant could register multiple SCs with the RTO/ISO. Many market participants can do business with the RTO/ISO using a single SC. One SC could schedule multiple generators. A load scheduling point could be used by multiple SCs. Each SC could schedule load at multiple scheduling points. An inter-tie scheduling point can be used by multiple SCs. Each SC can schedule interchange at multiple inter-tie scheduling points.
- MarketParticipant
MarketParticipant Reference to the superclass object.
- creditFlag
Flag to indicate creditworthiness (Y, N)
- creditStartEffectiveDate
Date that the scheduling coordinator becomes creditworthy.
- lastModified
Indication of the last time this scheduling coordinator information was modified.
- qualificationStatus
Scheduling coordinator qualification status, Qualified, Not Qualified, or Disqualified.
- scid
This is the short name or Scheduling Coordinator ID field.
- FromSCTrade
Trade undocumented
- LoadRatio
LoadRatio undocumented
- MarketParticipant_attr
MarketParticipant undocumented
- SubmitFromSCTrade
Trade undocumented
- SubmitToSCTrade
Trade undocumented
- ToSCTrade
Trade undocumented
- TransmissionContractRight
ContractRight undocumented
-
final
case class
SchedulingCoordinatorUser(Element: BasicElement = null, loginID: String = null, loginRole: String = null) extends Element with Product with Serializable
Describing users of a Scheduling Coordinator.
Describing users of a Scheduling Coordinator.
- Element
Reference to the superclass object.
- loginID
Login ID
- loginRole
Assigned roles (these are roles with either Read or Read/Write privileges on different Market Systems)
-
final
case class
SchedulingPoint(IdentifiedObject: IdentifiedObject = null, Flowgate: String = null, InterchangeSchedule: List[String] = null, RegisteredResource: List[String] = null) extends Element with Product with Serializable
Connection to other organizations at the boundary of the ISO/RTO.
Connection to other organizations at the boundary of the ISO/RTO.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- Flowgate
Flowgate undocumented
- InterchangeSchedule
InterchangeSchedule undocumented
- RegisteredResource
RegisteredResource undocumented
-
final
case class
Seal(IdentifiedObject: IdentifiedObject = null, appliedDateTime: String = null, condition: String = null, kind: String = null, sealNumber: String = null, AssetContainer: String = null) extends Element with Product with Serializable
Physically controls access to AssetContainers.
Physically controls access to AssetContainers.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- appliedDateTime
Date and time this seal has been applied.
- condition
Condition of seal.
- kind
Kind of seal.
- sealNumber
(reserved word) Seal number.
- AssetContainer
AssetContainer Asset container to which this seal is applied.
-
final
case class
Season(IdentifiedObject: IdentifiedObject = null, endDate: String = null, startDate: String = null, ScheduledLimits: List[String] = null, SeasonDayTypeSchedules: List[String] = null) extends Element with Product with Serializable
A specified time period of the year.
A specified time period of the year.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- endDate
Date season ends.
- startDate
Date season starts.
- ScheduledLimits
ScheduledLimitValue The scheduled limits associated with the season.
- SeasonDayTypeSchedules
SeasonDayTypeSchedule Schedules that use this Season.
-
final
case class
SeasonDayTypeSchedule(RegularIntervalSchedule: RegularIntervalSchedule = null, DayType: String = null, Season: String = null) extends Element with Product with Serializable
A time schedule covering a 24 hour period, with curve data for a specific type of season and day.
A time schedule covering a 24 hour period, with curve data for a specific type of season and day.
- RegularIntervalSchedule
RegularIntervalSchedule Reference to the superclass object.
- DayType
DayType DayType for the Schedule.
- Season
Season Season for the Schedule.
-
final
case class
Sectionaliser(Switch: Switch = null) extends Element with Product with Serializable
Automatic switch that will lock open to isolate a faulted section.
Automatic switch that will lock open to isolate a faulted section.
It may, or may not, have load breaking capability. Its primary purpose is to provide fault sectionalising at locations where the fault current is either too high, or too low, for proper coordination of fuses.
- Switch
Switch Reference to the superclass object.
-
final
case class
SecurityConstraintSum(MarketFactors: MarketFactors = null, BaseCaseConstraintLimit: String = null, ConstraintTerms: List[String] = null, ContingencyConstraintLimits: List[String] = null, DefaultConstraintLimit: String = null, RTO: String = null) extends Element with Product with Serializable
Typically provided by RTO systems, constraints identified in both base case and critical contingency cases have to be transferred.
Typically provided by RTO systems, constraints identified in both base case and critical contingency cases have to be transferred.
A constraint has N (>=1) constraint terms. A term is represented by an instance of TerminalConstraintTerm. The constraint expression is: minValue <= c1*x1 + c2*x2 + .... cn*xn + k <= maxValue where: - cn is ConstraintTerm.factor - xn is the flow at the terminal Flow into the associated equipment is positive for the purpose of ConnectivityNode NodeConstraintTerm.
k is SecurityConstraintsLinear.resourceMW. The units of k are assumed to be same as the units of the flows, xn. The constants, cn, are dimensionless. With these conventions, cn and k are all positive for a typical constraint such as "weighted sum of generation shall be less than limit". Furthermore, cn are all 1.0 for a case such as "interface flow shall be less than limit", assuming the terminals are chosen on the importing side of the interface.
- MarketFactors
MarketFactors Reference to the superclass object.
- BaseCaseConstraintLimit
BaseCaseConstraintLimit undocumented
- ConstraintTerms
ConstraintTerm undocumented
- ContingencyConstraintLimits
ContingencyConstraintLimit undocumented
- DefaultConstraintLimit
DefaultConstraintLimit undocumented
- RTO
RTO undocumented
-
final
case class
SecurityConstraints(IdentifiedObject: IdentifiedObject = null, actualMW: Double = 0.0, maxMW: Double = 0.0, minMW: Double = 0.0, Flowgate: String = null, GeneratingBid: String = null, RTO: String = null) extends Element with Product with Serializable
Typical for regional transmission operators (RTOs), these constraints include transmission as well as generation group constraints identified in both base case and critical contingency cases.
Typical for regional transmission operators (RTOs), these constraints include transmission as well as generation group constraints identified in both base case and critical contingency cases.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- actualMW
Actual branch or group of branches MW flow (only for transmission constraints)
- maxMW
Maximum MW limit
- minMW
Minimum MW limit (only for transmission constraints).
- Flowgate
Flowgate undocumented
- GeneratingBid
GeneratingBid undocumented
- RTO
RTO undocumented
-
final
case class
SecurityConstraintsClearing(MarketFactors: MarketFactors = null, mwFlow: Double = 0.0, mwLimit: Double = 0.0, shadowPrice: Double = 0.0) extends Element with Product with Serializable
Binding security constrained clearing results posted for a given settlement period.
Binding security constrained clearing results posted for a given settlement period.
- MarketFactors
MarketFactors Reference to the superclass object.
- mwFlow
Optimal MW flow
- mwLimit
Binding MW limit.
- shadowPrice
Security constraint shadow price.
-
final
case class
SelfScheduleBreakdown(Element: BasicElement = null, selfSchedMW: Double = 0.0, selfSchedType: String = null, ResourceAwardInstruction: String = null) extends Element with Product with Serializable
Model of Self Schedules Results.
Model of Self Schedules Results.
Includes self schedule MW,and type of self schedule for each self schedule type included in total self schedule MW value found in ResourceAwardInstruction.
- Element
Reference to the superclass object.
- selfSchedMW
Cleared value for the specific self schedule type listed.
- selfSchedType
Self schedule breakdown type.
- ResourceAwardInstruction
ResourceAwardInstruction undocumented
-
final
case class
SensitivityPriceCurve(Curve: Curve = null, ReserveReq: String = null) extends Element with Product with Serializable
Optionally, this curve expresses elasticity of the associated requirement.
Optionally, this curve expresses elasticity of the associated requirement.
For example, used to reduce requirements when clearing price exceeds reasonable values when the supply quantity becomes scarce. For example, a single point value of $1000/MW for a spinning reserve will cause a reduction in the required spinning reserve. X axis is constrained quantity (e.g., MW) Y1 axis is money per constrained quantity
- Curve
Curve Reference to the superclass object.
- ReserveReq
ReserveReq undocumented
-
final
case class
Sensor(AuxiliaryEquipment: AuxiliaryEquipment = null) extends Element with Product with Serializable
This class describe devices that transform a measured quantity into signals that can be presented at displays, used in control or be recorded.
This class describe devices that transform a measured quantity into signals that can be presented at displays, used in control or be recorded.
- AuxiliaryEquipment
AuxiliaryEquipment Reference to the superclass object.
-
final
case class
Series(TimeSeries: TimeSeries = null, lastUpdateDate: String = null, methodType: String = null, registrationDate: String = null, SelfSeries: List[String] = null, Series_attr: List[String] = null) extends Element with Product with Serializable
A set of similar physical or conceptual objects defined for the same period or point of time.
A set of similar physical or conceptual objects defined for the same period or point of time.
- TimeSeries
TimeSeries Reference to the superclass object.
- lastUpdateDate
The date of the last update related to this market object.
- methodType
Type of method used in the business process related to this Series, e.g. metering method.
- registrationDate
For a market object, the date of registration of a contract, e.g. the date of change of supplier for a customer.
- SelfSeries
Series undocumented
- Series_attr
Series undocumented
-
final
case class
SeriesCompensator(ConductingEquipment: ConductingEquipment = null, r: Double = 0.0, r0: Double = 0.0, varistorPresent: Boolean = false, varistorRatedCurrent: Double = 0.0, varistorVoltageThreshold: Double = 0.0, x: Double = 0.0, x0: Double = 0.0) extends Element with Product with Serializable
A Series Compensator is a series capacitor or reactor or an AC transmission line without charging susceptance.
A Series Compensator is a series capacitor or reactor or an AC transmission line without charging susceptance.
It is a two terminal device.
- ConductingEquipment
ConductingEquipment Reference to the superclass object.
- r
Positive sequence resistance.
- r0
Zero sequence resistance.
- varistorPresent
Describe if a metal oxide varistor (mov) for over voltage protection is configured in parallel with the series compensator. It is used for short circuit calculations.
- varistorRatedCurrent
The maximum current the varistor is designed to handle at specified duration. It is used for short circuit calculations and exchanged only if SeriesCompensator.varistorPresent is true. The attribute shall be a positive value.
- varistorVoltageThreshold
The dc voltage at which the varistor starts conducting. It is used for short circuit calculations and exchanged only if SeriesCompensator.varistorPresent is true.
- x
Positive sequence reactance.
- x0
Zero sequence reactance.
-
final
case class
SeriesEquipmentDependentLimit(LimitDependency: LimitDependency = null, EquipmentLimitSeriesComponent: List[String] = null) extends Element with Product with Serializable
Limit based on most restrictive series equipment limit.
Limit based on most restrictive series equipment limit.
A specification of of equipment that determines the calculated operational limit values based upon other equipment and their ratings. The most restrictive limit connected in series within the group is used. The physical connection based on switch status for example may also impact which elements in the group are considered. Any equipment in the group that are presently connected in series with the equipment of the directly associated operational limit are used. This provides a means to indicate which potentially series equipment limits are considered for a computed operational limit. The operational limit of the same operational limit type is assumed to be used from the grouped equipment. It is also possible to make assumptions or calculations regarding how flow might split if the equipment is not simply in series.
- LimitDependency
LimitDependency Reference to the superclass object.
- EquipmentLimitSeriesComponent
EquipmentLimitSeriesComponent Equipment linkages that participates in the limit calculation.
-
final
case class
ServiceCategory(IdentifiedObject: IdentifiedObject = null, kind: String = null, ConfigurationEvents: List[String] = null, CustomerAgreements: List[String] = null, PricingStructures: List[String] = null, UsagePoints: List[String] = null) extends Element with Product with Serializable
Category of service provided to the customer.
Category of service provided to the customer.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- kind
Kind of service.
- ConfigurationEvents
ConfigurationEvent All configuration events created for this service category.
- CustomerAgreements
CustomerAgreement All customer agreements with this service category.
- PricingStructures
PricingStructure All pricing structures applicable to this service category.
- UsagePoints
UsagePoint All usage points that deliver this category of service.
-
final
case class
ServiceGuarantee(Document: Document = null, applicationPeriod: String = null, automaticPay: Boolean = false, payAmount: Double = 0.0, serviceRequirement: String = null) extends Element with Product with Serializable
A service guarantee, often imposed by a regulator, defines conditions that, if not satisfied, will result in the utility making a monetary payment to the customer.
A service guarantee, often imposed by a regulator, defines conditions that, if not satisfied, will result in the utility making a monetary payment to the customer.
Note that guarantee's identifier is in the 'name' attribute and the status of the guarantee is in the 'Status.status' attribute. Example service requirements include: 1) If power is not restored within 24 hours, customers can claim $50 for residential customers or $100 for commercial and industrial customers. In addition for each extra period of 12 hours the customer's supply has not been activated, the customer can claim $25. 2) If a customer has a question about their electricity bill, the utility will investigate and respond to the inquiry within 15 working days. If utility fails to meet its guarantee, utility will automatically pay the customer $50.
- Document
Document Reference to the superclass object.
- applicationPeriod
Period in which this service guantee applies.
- automaticPay
True if utility must autmatically pay the specified amount whenever the condition is not satisified, otherwise customer must make a claim to receive payment.
- payAmount
Amount to be paid by the service provider to the customer for each violation of the 'serviceRequirement'.
- serviceRequirement
Explanation of the requirement and conditions for satisfying it.
-
final
case class
ServiceLocation(WorkLocation: WorkLocation = null, accessMethod: String = null, needsInspection: Boolean = false, siteAccessProblem: String = null, CustomerAgreements: List[String] = null, EndDevices: List[String] = null, TroubleTicket: List[String] = null, UsagePoints: List[String] = null) extends Element with Product with Serializable
A real estate location, commonly referred to as premises.
A real estate location, commonly referred to as premises.
- WorkLocation
WorkLocation Reference to the superclass object.
- accessMethod
Method for the service person to access this service location. For example, a description of where to obtain a key if the facility is unmanned and secured.
- needsInspection
True if inspection is needed of facilities at this service location. This could be requested by a customer, due to suspected tampering, environmental concerns (e.g., a fire in the vicinity), or to correct incompatible data.
- siteAccessProblem
Problems previously encountered when visiting or performing work on this location. Examples include: bad dog, violent customer, verbally abusive occupant, obstructions, safety hazards, etc.
- CustomerAgreements
CustomerAgreement All customer agreements regulating this service location.
- EndDevices
EndDevice All end devices that measure the service delivered to this service location.
- TroubleTicket
TroubleTicket undocumented
- UsagePoints
UsagePoint All usage points delivering service (of the same type) to this service location.
-
final
case class
ServiceMultiplier(IdentifiedObject: IdentifiedObject = null, kind: String = null, value: Double = 0.0, UsagePoint: String = null) extends Element with Product with Serializable
Multiplier applied at the usage point.
Multiplier applied at the usage point.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- kind
Kind of multiplier.
- value
Multiplier value.
- UsagePoint
UsagePoint Usage point applying this multiplier.
-
final
case class
ServicePoint(IdentifiedObject: IdentifiedObject = null, PODTransmissionPath: List[String] = null, PORTransmissionPath: List[String] = null, SinkReservation: List[String] = null, SourceReservation: List[String] = null) extends Element with Product with Serializable
The defined termination points of a transmission path.
The defined termination points of a transmission path.
Service points are defined from the viewpoint of the transmission service. Each service point is contained within (or on the boundary of) an interchange area. A service point is source or destination of a transaction.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- PODTransmissionPath
TransmissionPath A transmission path has a "point-of-delivery" service point
- PORTransmissionPath
TransmissionPath A transmission path has a "point-of-receipt" service point
- SinkReservation
TransmissionReservation undocumented
- SourceReservation
TransmissionReservation undocumented
-
final
case class
ServicePointOutageSummary(Element: BasicElement = null, criticalCount: Int = 0, totalCount: Int = 0) extends Element with Product with Serializable
Summary counts of service points affected by an outage.
Summary counts of service points affected by an outage.
These counts are sometimes referred to as total and critical customer count.
- Element
Reference to the superclass object.
- criticalCount
Number of critical service (delivery) points affected by an outage.
- totalCount
Number of all service (delivery) points affected by an outage.
-
final
case class
ServiceSupplier(OrganisationRole: OrganisationRole = null, issuerIdentificationNumber: String = null, kind: String = null, BankAccounts: List[String] = null, CustomerAgreements: List[String] = null, UsagePoints: List[String] = null) extends Element with Product with Serializable
Organisation that provides services to customers.
Organisation that provides services to customers.
- OrganisationRole
OrganisationRole Reference to the superclass object.
- issuerIdentificationNumber
Unique transaction reference prefix number issued to an entity by the International Organization for Standardization for the purpose of tagging onto electronic financial transactions, as defined in ISO/IEC 7812-1 and ISO/IEC 7812-2.
- kind
Kind of supplier.
- BankAccounts
BankAccount All BackAccounts this ServiceSupplier owns.
- CustomerAgreements
CustomerAgreement All customer agreements of this service supplier.
- UsagePoints
UsagePoint All usage points this service supplier utilises to deliver a service.
-
final
case class
SetPoint(AnalogControl: AnalogControl = null, normalValue: Double = 0.0, value: Double = 0.0) extends Element with Product with Serializable
An analog control that issues a set point value.
An analog control that issues a set point value.
- AnalogControl
AnalogControl Reference to the superclass object.
- normalValue
Normal value for Control.value e.g. used for percentage scaling.
- value
The value representing the actuator output.
-
final
case class
Settlement(Document: Document = null, tradeDate: String = null, EnergyMarket: String = null, MajorChargeGroup: List[String] = null, MarketInvoiceLineItem: List[String] = null, MarketLedgerEntry: List[String] = null) extends Element with Product with Serializable
Specifies a settlement run.
Specifies a settlement run.
- Document
Document Reference to the superclass object.
- tradeDate
The trade date on which the settlement is run.
- EnergyMarket
EnergyMarket undocumented
- MajorChargeGroup
MajorChargeGroup undocumented
- MarketInvoiceLineItem
MarketInvoiceLineItem undocumented
- MarketLedgerEntry
MarketLedgerEntry undocumented
-
final
case class
Shift(IdentifiedObject: IdentifiedObject = null, activityInterval: String = null, receiptsGrandTotalBankable: Double = 0.0, receiptsGrandTotalNonBankable: Double = 0.0, receiptsGrandTotalRounding: Double = 0.0, transactionsGrandTotal: Double = 0.0, transactionsGrandTotalRounding: Double = 0.0) extends Element with Product with Serializable
Generally referring to a period of operation or work performed.
Generally referring to a period of operation or work performed.
Whether the shift is open/closed can be derived from attributes 'activityInterval.start' and 'activityInterval.end'. The grand total for receipts (i.e., cumulative total of all actual receipted amounts during this shift; bankable + non-bankable; excludes rounding error totals) can be derived from receipt: =sum('Receipt.receiptAmount'); includes bankable and non-bankable receipts. It also has to be reconciled against: =sum('receiptsGrandTotalBankable' + 'receiptsGrandTotalNonBankable') and against receipt summary: =sum('ReceiptSummary.receiptsTotal'). The attributes with "GrandTotal" defined in this class may need to be used when the source data is periodically flushed from the system and then these cannot be derived.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- activityInterval
Interval for activity of this shift.
- receiptsGrandTotalBankable
Total of amounts receipted during this shift that can be manually banked (cash and cheques for example). Values are obtained from Receipt attributes: =sum(Receipt.receiptAmount) for all Receipt.bankable = true.
- receiptsGrandTotalNonBankable
Total of amounts receipted during this shift that cannot be manually banked (card payments for example). Values are obtained from Receipt attributes: =sum(Receipt.receiptAmount) for all Receipt.bankable = false.
- receiptsGrandTotalRounding
Cumulative amount in error due to process rounding not reflected in receiptsGrandTotal. Values are obtained from Receipt attributes: =sum(Receipt.receiptRounding).
- transactionsGrandTotal
Cumulative total of transacted amounts during this shift. Values are obtained from transaction: =sum('Transaction.transactionAmount'). It also has to be reconciled against transaction summary: =sum('TransactionSummary.transactionsTotal').
- transactionsGrandTotalRounding
Cumulative amount in error due to process rounding not reflected in transactionsGandTotal. Values are obtained from Transaction attributes: =sum(Transaction.transactionRounding).
-
final
case class
ShiftPattern(WorkIdentifiedObject: WorkIdentifiedObject = null, assignmentType: String = null, cycleCount: Int = 0, status: String = null, validityInterval: String = null, Crews: List[String] = null) extends Element with Product with Serializable
The patterns of shifts worked by people or crews.
The patterns of shifts worked by people or crews.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- assignmentType
Type of assignement intended to be worked on this shift, for example, temporary, standard, etc.
- cycleCount
Number of cycles for a temporary shift.
- status
undocumented
- validityInterval
Date and time interval for which this shift pattern is valid (when it became effective and when it expires).
- Crews
OldCrew undocumented
-
final
case class
ShortCircuitTest(TransformerTest: TransformerTest = null, current: Double = 0.0, energisedEndStep: Int = 0, groundedEndStep: Int = 0, leakageImpedance: Double = 0.0, leakageImpedanceZero: Double = 0.0, loss: Double = 0.0, lossZero: Double = 0.0, power: Double = 0.0, voltage: Double = 0.0, EnergisedEnd: String = null, GroundedEnds: List[String] = null) extends Element with Product with Serializable
Short-circuit test results determine mesh impedance parameters.
Short-circuit test results determine mesh impedance parameters.
They include load losses and leakage impedances. For three-phase windings, the excitation can be a positive sequence (the default) or a zero sequence. There shall be at least one grounded winding.
- TransformerTest
TransformerTest Reference to the superclass object.
- current
Short circuit current..
- energisedEndStep
Tap step number for the energised end of the test pair.
- groundedEndStep
Tap step number for the grounded end of the test pair.
- leakageImpedance
Leakage impedance measured from a positive-sequence or single-phase short-circuit test.
- leakageImpedanceZero
Leakage impedance measured from a zero-sequence short-circuit test.
- loss
Load losses from a positive-sequence or single-phase short-circuit test.
- lossZero
Load losses from a zero-sequence short-circuit test.
- power
Short circuit apparent power.
- voltage
Short circuit voltage..
- EnergisedEnd
TransformerEndInfo Transformer end that voltage is applied to in this short-circuit test. The test voltage is chosen to induce rated current in the energised end.
- GroundedEnds
TransformerEndInfo All ends short-circuited in this short-circuit test.
-
final
case class
ShuntCompensator(RegulatingCondEq: RegulatingCondEq = null, aVRDelay: Double = 0.0, grounded: Boolean = false, maximumSections: Int = 0, nomU: Double = 0.0, normalSections: Int = 0, phaseConnection: String = null, sections: Double = 0.0, switchOnCount: Int = 0, switchOnDate: String = null, voltageSensitivity: Double = 0.0, ShuntCompensatorAction: String = null, ShuntCompensatorPhase: List[String] = null, SvShuntCompensatorSections: List[String] = null) extends Element with Product with Serializable
A shunt capacitor or reactor or switchable bank of shunt capacitors or reactors.
A shunt capacitor or reactor or switchable bank of shunt capacitors or reactors.
A section of a shunt compensator is an individual capacitor or reactor. A negative value for reactivePerSection indicates that the compensator is a reactor. ShuntCompensator is a single terminal device. Ground is implied.
- RegulatingCondEq
RegulatingCondEq Reference to the superclass object.
- aVRDelay
An automatic voltage regulation delay (AVRDelay) which is the time delay from a change in voltage to when the capacitor is allowed to change state. This filters out temporary changes in voltage.
- grounded
Used for Yn and Zn connections. True if the neutral is solidly grounded.
- maximumSections
The maximum number of sections that may be switched in.
- nomU
The voltage at which the nominal reactive power may be calculated. This should normally be within 10% of the voltage at which the capacitor is connected to the network.
- normalSections
The normal number of sections switched in. The value shall be between zero and ShuntCompensator.maximumSections.
- phaseConnection
The type of phase connection, such as wye or delta.
- sections
Shunt compensator sections in use. Starting value for steady state solution. The attribute shall be a positive value or zero. Non integer values are allowed to support continuous variables. The reasons for continuous value are to support study cases where no discrete shunt compensators has yet been designed, a solutions where a narrow voltage band force the sections to oscillate or accommodate for a continuous solution as input. For LinearShuntConpensator the value shall be between zero and ShuntCompensator.maximumSections. At value zero the shunt compensator conductance and admittance is zero. Linear interpolation of conductance and admittance between the previous and next integer section is applied in case of non-integer values. For NonlinearShuntCompensator-s shall only be set to one of the NonlinearShuntCompenstorPoint.sectionNumber. There is no interpolation between NonlinearShuntCompenstorPoint-s.
- switchOnCount
The switch on count since the capacitor count was last reset or initialized.
- switchOnDate
The date and time when the capacitor bank was last switched on.
- voltageSensitivity
Voltage sensitivity required for the device to regulate the bus voltage, in voltage/reactive power.
- ShuntCompensatorAction
ShuntCompensatorAction undocumented
- ShuntCompensatorPhase
ShuntCompensatorPhase The individual phases models for the shunt compensator.
- SvShuntCompensatorSections
SvShuntCompensatorSections The state for the number of shunt compensator sections in service.
- final case class ShuntCompensatorAction(SwitchingAction: SwitchingAction = null, kind: String = null, ShuntCompensator: String = null) extends Element with Product with Serializable
-
final
case class
ShuntCompensatorControl(RegulatingControl: RegulatingControl = null, branchDirect: Int = 0, cellSize: Double = 0.0, controlKind: String = null, highVoltageOverride: Double = 0.0, localControlKind: String = null, localOffLevel: String = null, localOnLevel: String = null, localOverride: Boolean = false, lowVoltageOverride: Double = 0.0, maxSwitchOperationCount: Int = 0, normalOpen: Boolean = false, regBranch: String = null, regBranchEnd: Int = 0, regBranchKind: String = null, sensingPhaseCode: String = null, switchOperationCycle: Double = 0.0, vRegLineLine: Boolean = false, ShuntCompensatorInfo: String = null) extends Element with Product with Serializable
Distribution capacitor bank control settings.
Distribution capacitor bank control settings.
- RegulatingControl
RegulatingControl Reference to the superclass object.
- branchDirect
For VAR, amp, or power factor locally controlled shunt impedances, the flow direction: in, out.
- cellSize
The size of the individual units that make up the bank.
- controlKind
Kind of control (if any).
- highVoltageOverride
For locally controlled shunt impedances which have a voltage override feature, the high voltage override value. If the voltage is above this value, the shunt impedance will be turned off regardless of the other local controller settings.
- localControlKind
Kind of local controller.
- localOffLevel
Upper control setting.
- localOnLevel
Lower control setting.
- localOverride
True if the locally controlled capacitor has voltage override capability.
- lowVoltageOverride
For locally controlled shunt impedances which have a voltage override feature, the low voltage override value. If the voltage is below this value, the shunt impedance will be turned on regardless of the other local controller settings.
- maxSwitchOperationCount
IdmsShuntImpedanceData.maxNumSwitchOps.
- normalOpen
True if open is normal status for a fixed capacitor bank, otherwise normal status is closed.
- regBranch
For VAR, amp, or power factor locally controlled shunt impedances, the index of the regulation branch.
- regBranchEnd
For VAR, amp, or power factor locally controlled shunt impedances, the end of the branch that is regulated. The field has the following values: from side, to side, and tertiary (only if the branch is a transformer).
- regBranchKind
(For VAR, amp, or power factor locally controlled shunt impedances) Kind of regulation branch.
- sensingPhaseCode
Phases that are measured for controlling the device.
- switchOperationCycle
Time interval between consecutive switching operations.
- vRegLineLine
True if regulated voltages are measured line to line, otherwise they are measured line to ground.
- ShuntCompensatorInfo
ShuntCompensatorInfo undocumented
-
final
case class
ShuntCompensatorDynamicData(Element: BasicElement = null, connectionStatus: Int = 0, desiredVoltage: Double = 0.0, mVARInjection: Double = 0.0, stepPosition: Int = 0, voltageRegulationStatus: Boolean = false, MktShuntCompensator: String = null) extends Element with Product with Serializable
Optimal Power Flow or State Estimator Filter Bank Data for OTS.
Optimal Power Flow or State Estimator Filter Bank Data for OTS.
This is used for RealTime, Study and Maintenance Users.
- Element
Reference to the superclass object.
- connectionStatus
The current status for the Voltage Control Capacitor 1= Connected 0 = Disconnected
- desiredVoltage
The desired voltage for the Voltage Control Capacitor
- mVARInjection
The injection of reactive power of the filter bank in the NA solution or VCS reactive power production
- stepPosition
Voltage control capacitor step position
- voltageRegulationStatus
Indicator if the voltage control this is regulating True = Yes, False = No
- MktShuntCompensator
MktShuntCompensator undocumented
-
final
case class
ShuntCompensatorInfo(AssetInfo: AssetInfo = null, maxPowerLoss: Double = 0.0, ratedCurrent: Double = 0.0, ratedReactivePower: Double = 0.0, ratedVoltage: Double = 0.0, ShuntCompensatorControl: String = null) extends Element with Product with Serializable
Properties of shunt capacitor, shunt reactor or switchable bank of shunt capacitor or reactor assets.
Properties of shunt capacitor, shunt reactor or switchable bank of shunt capacitor or reactor assets.
- AssetInfo
AssetInfo Reference to the superclass object.
- maxPowerLoss
Maximum allowed apparent power loss.
- ratedCurrent
Rated current.
- ratedReactivePower
Rated reactive power.
- ratedVoltage
Rated voltage.
- ShuntCompensatorControl
ShuntCompensatorControl undocumented
-
final
case class
ShuntCompensatorPhase(PowerSystemResource: PowerSystemResource = null, maximumSections: Int = 0, normalSections: Int = 0, phase: String = null, sections: Double = 0.0, ShuntCompensator: String = null) extends Element with Product with Serializable
Single phase of a multi-phase shunt compensator when its attributes might be different per phase.
Single phase of a multi-phase shunt compensator when its attributes might be different per phase.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- maximumSections
The maximum number of sections that may be switched in for this phase.
- normalSections
For the capacitor phase, the normal number of sections switched in. The value shall be between zero and ShuntCompensatorPhase.maximumSections.
- phase
Phase of this shunt compensator component. If the shunt compensator is wye connected, the connection is from the indicated phase to the central ground or neutral point. If the shunt compensator is delta connected, the phase indicates a shunt compensator connected from the indicated phase to the next logical non-neutral phase.
- sections
Shunt compensator sections in use. Starting value for steady state solution. The attribute shall be a positive value or zero. Non integer values are allowed to support continuous variables. The reasons for continuous value are to support study cases where no discrete shunt compensators has yet been designed, a solutions where a narrow voltage band force the sections to oscillate or accommodate for a continuous solution as input. For LinearShuntConpensator the value shall be between zero and ShuntCompensatorPhase.maximumSections. At value zero the shunt compensator conductance and admittance is zero. Linear interpolation of conductance and admittance between the previous and next integer section is applied in case of non-integer values. For NonlinearShuntCompensator-s shall only be set to one of the NonlinearShuntCompenstorPhasePoint.sectionNumber. There is no interpolation between NonlinearShuntCompenstorPhasePoint-s.
- ShuntCompensator
ShuntCompensator Shunt compensator of this shunt compensator phase.
-
final
case class
ShutdownCurve(Curve: Curve = null, shutdownCost: Double = 0.0, shutdownDate: String = null, ThermalGeneratingUnit: String = null) extends Element with Product with Serializable
Relationship between the rate in gross active power/minute (Y-axis) at which a unit should be shutdown and its present gross MW output (X-axis).
Relationship between the rate in gross active power/minute (Y-axis) at which a unit should be shutdown and its present gross MW output (X-axis).
- Curve
Curve Reference to the superclass object.
- shutdownCost
Fixed shutdown cost.
- shutdownDate
The date and time of the most recent generating unit shutdown.
- ThermalGeneratingUnit
ThermalGeneratingUnit A thermal generating unit may have a shutdown curve.
-
final
case class
SimpleEndDeviceFunction(EndDeviceFunction: EndDeviceFunction = null, kind: String = null) extends Element with Product with Serializable
Simple end device function distinguished by 'kind'.
Simple end device function distinguished by 'kind'.
Use this class for instances that cannot be represented by another end device function specialisations.
- EndDeviceFunction
EndDeviceFunction Reference to the superclass object.
- kind
Kind of this function.
-
final
case class
Skill(Document: Document = null, certificationPeriod: String = null, effectiveDateTime: String = null, level: String = null, Crafts: List[String] = null, ErpPerson: String = null, QualificationRequirements: List[String] = null) extends Element with Product with Serializable
Proficiency level of a craft, which is required to operate or maintain a particular type of asset and/or perform certain types of work.
Proficiency level of a craft, which is required to operate or maintain a particular type of asset and/or perform certain types of work.
- Document
Document Reference to the superclass object.
- certificationPeriod
Interval between the certification and its expiry.
- effectiveDateTime
Date and time the skill became effective.
- level
Level of skill for a Craft.
- Crafts
Craft undocumented
- ErpPerson
OldPerson undocumented
- QualificationRequirements
QualificationRequirement undocumented
-
final
case class
SolarGeneratingUnit(GeneratingUnit: GeneratingUnit = null) extends Element with Product with Serializable
A solar thermal generating unit, connected to the grid by means of a rotating machine.
A solar thermal generating unit, connected to the grid by means of a rotating machine.
This class does not represent photovoltaic (PV) generation.
- GeneratingUnit
GeneratingUnit Reference to the superclass object.
-
final
case class
SpaceAnalog(EnvironmentalAnalog: EnvironmentalAnalog = null, kind: String = null) extends Element with Product with Serializable
Analog (float) measuring a space (extra-terrestrial) condition.
Analog (float) measuring a space (extra-terrestrial) condition.
- EnvironmentalAnalog
EnvironmentalAnalog Reference to the superclass object.
- kind
Kind of space analog.
-
final
case class
SpacePhenomenon(EnvironmentalPhenomenon: EnvironmentalPhenomenon = null) extends Element with Product with Serializable
An extra-terrestrial phenomenon.
An extra-terrestrial phenomenon.
- EnvironmentalPhenomenon
EnvironmentalPhenomenon Reference to the superclass object.
-
final
case class
Specification(Document: Document = null, AssetProperites: List[String] = null, AssetPropertyCurves: List[String] = null, DimensionsInfos: List[String] = null, Mediums: List[String] = null, QualificationRequirements: List[String] = null, Ratings: List[String] = null, ReliabilityInfos: List[String] = null) extends Element with Product with Serializable
Specification can be used for various purposes relative to an asset, a logical device (PowerSystemResource), location, etc.
Specification can be used for various purposes relative to an asset, a logical device (PowerSystemResource), location, etc.
Examples include documents supplied by manufacturers such as asset installation instructions, asset maintenance instructions, etc.
- Document
Document Reference to the superclass object.
- AssetProperites
UserAttribute UserAttributes used to specify further properties of the asset covered with this specification. Use 'name' to specify what kind of property it is, and 'value.value' attribute for the actual value.
- AssetPropertyCurves
AssetPropertyCurve undocumented
- DimensionsInfos
DimensionsInfo undocumented
- Mediums
Medium undocumented
- QualificationRequirements
QualificationRequirement undocumented
- Ratings
UserAttribute UserAttributes used to specify ratings of the asset covered by this specification. Ratings also can be used to set the initial value of operational measurement limits. Use 'name' to specify what kind of rating it is (e.g., voltage, current), and 'value' attribute for the actual value and unit information of the rating.
- ReliabilityInfos
ReliabilityInfo undocumented
-
final
case class
Specimen(IdentifiedObject: IdentifiedObject = null, ambientTemperatureAtSampling: Double = 0.0, humidityAtSampling: Double = 0.0, specimenID: String = null, specimenSampleDateTime: String = null, specimenToLabDateTime: String = null, AssetTestSampleTaker: String = null, LabTestDataSet: List[String] = null) extends Element with Product with Serializable
Sample or specimen of a material (fluid or solid).
Sample or specimen of a material (fluid or solid).
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ambientTemperatureAtSampling
Operating ambient temperature (in °C).
- humidityAtSampling
Operating ambient humidity (in percent).
- specimenID
Identifier of specimen used in inspection or test.
- specimenSampleDateTime
Date and time sample specimen taken.
- specimenToLabDateTime
Date and time the specimen was received by the lab.
- AssetTestSampleTaker
AssetTestSampleTaker Test sampler taker who gathered this specimen.
- LabTestDataSet
LabTestDataSet Results from lab testing done on specimen.
-
final
case class
Stage(IdentifiedObject: IdentifiedObject = null, priority: Int = 0, RemedialActionScheme: String = null, StageTrigger: List[String] = null) extends Element with Product with Serializable
Stage of a remedial action scheme.
Stage of a remedial action scheme.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- priority
The priority of the stage. 0 = don t care (default) 1 = highest priority. 2 is less than 1 and so on. A stage with higher priority needs be activated before a lower stage can be activated.
- RemedialActionScheme
RemedialActionScheme undocumented
- StageTrigger
StageTrigger A Stage consist of one or more StageTrigger.
-
final
case class
StageTrigger(IdentifiedObject: IdentifiedObject = null, armed: Boolean = false, normalArmed: Boolean = false, priority: Int = 0, GateArmed: String = null, GateComCondition: String = null, GateTrigger: String = null, ProtectiveActionCollection: String = null, Stage: String = null) extends Element with Product with Serializable
Condition that is triggered either by TriggerCondition of by gate condition within a stage and has remedial action-s.
Condition that is triggered either by TriggerCondition of by gate condition within a stage and has remedial action-s.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- armed
The status of the class set by operation or by signal. Optional field that will override other status fields.
- normalArmed
The default/normal value used when other active signal/values are missing.
- priority
Priority of trigger. 0 = don t care (default) 1 = highest priority. 2 is less than 1 and so on. A trigger with the highest priority will trigger first.
- GateArmed
Gate Association to a Gate that through a gate logic and input pin defines arming of the StageTrigger.
- GateComCondition
Gate For the StageTrigger to active the set of protective actions the condition for communication needs to be met (true).
- GateTrigger
Gate The Gate result that trigger the StageTrigger and thereby executing the a set of protective actions.
- ProtectiveActionCollection
ProtectiveActionCollection undocumented
- Stage
Stage undocumented
-
final
case class
StandardIndustryCode(Document: Document = null, code: String = null, CustomerAgreements: List[String] = null) extends Element with Product with Serializable
The Standard Industrial Classification (SIC) are the codes that identify the type of products/service an industry is involved in, and used for statutory reporting purposes.
The Standard Industrial Classification (SIC) are the codes that identify the type of products/service an industry is involved in, and used for statutory reporting purposes.
For example, in the USA these codes are located by the federal government, and then published in a book entitled "The Standard Industrial Classification Manual". The codes are arranged in a hierarchical structure. Note that Residential Service Agreements are not classified according to the SIC codes.
- Document
Document Reference to the superclass object.
- code
Standard alphanumeric code assigned to a particular product/service within an industry.
- CustomerAgreements
CustomerAgreement undocumented
-
final
case class
StartIgnFuelCurve(Curve: Curve = null, ignitionFuelType: String = null, StartupModel: String = null) extends Element with Product with Serializable
The quantity of ignition fuel (Y-axis) used to restart and repay the auxiliary power consumed versus the number of hours (X-axis) the unit was off line.
The quantity of ignition fuel (Y-axis) used to restart and repay the auxiliary power consumed versus the number of hours (X-axis) the unit was off line.
- Curve
Curve Reference to the superclass object.
- ignitionFuelType
Type of ignition fuel.
- StartupModel
StartupModel The unit's startup model may have a startup ignition fuel curve.
-
final
case class
StartMainFuelCurve(Curve: Curve = null, mainFuelType: String = null, StartupModel: String = null) extends Element with Product with Serializable
The quantity of main fuel (Y-axis) used to restart and repay the auxiliary power consumed versus the number of hours (X-axis) the unit was off line.
The quantity of main fuel (Y-axis) used to restart and repay the auxiliary power consumed versus the number of hours (X-axis) the unit was off line.
- Curve
Curve Reference to the superclass object.
- mainFuelType
Type of main fuel.
- StartupModel
StartupModel The unit's startup model may have a startup main fuel curve.
-
final
case class
StartRampCurve(Curve: Curve = null, hotStandbyRamp: Double = 0.0, StartupModel: String = null) extends Element with Product with Serializable
Rate in gross active power per minute (Y-axis) at which a unit can be loaded versus the number of hours (X-axis) the unit was off line.
Rate in gross active power per minute (Y-axis) at which a unit can be loaded versus the number of hours (X-axis) the unit was off line.
- Curve
Curve Reference to the superclass object.
- hotStandbyRamp
The startup ramp rate in gross for a unit that is on hot standby.
- StartupModel
StartupModel The unit's startup model may have a startup ramp curve.
-
final
case class
StartUpCostCurve(Curve: Curve = null, GeneratingBid: List[String] = null, RegisteredGenerators: List[String] = null) extends Element with Product with Serializable
Startup costs and time as a function of down time.
Startup costs and time as a function of down time.
Relationship between unit startup cost (Y1-axis) vs. unit elapsed down time (X-axis).
- Curve
Curve Reference to the superclass object.
- GeneratingBid
GeneratingBid undocumented
- RegisteredGenerators
RegisteredGenerator undocumented
-
final
case class
StartUpEnergyCurve(Curve: Curve = null, RegisteredGenerator: String = null) extends Element with Product with Serializable
The energy consumption of a generating resource to complete a start-up from the StartUpEnergyCurve.
The energy consumption of a generating resource to complete a start-up from the StartUpEnergyCurve.
Definition of the StartUpEnergyCurve includes, xvalue as the cooling time and y1value as the MW value.
- Curve
Curve Reference to the superclass object.
- RegisteredGenerator
RegisteredGenerator undocumented
-
final
case class
StartUpFuelCurve(Curve: Curve = null, RegisteredGenerator: String = null) extends Element with Product with Serializable
The fuel consumption of a Generating Resource to complete a Start-Up.(x=cooling time) Form Startup Fuel Curve.
The fuel consumption of a Generating Resource to complete a Start-Up.(x=cooling time) Form Startup Fuel Curve. xAxisData -> cooling time, y1AxisData -> MBtu.
- Curve
Curve Reference to the superclass object.
- RegisteredGenerator
RegisteredGenerator undocumented
-
final
case class
StartUpTimeCurve(Curve: Curve = null, GeneratingBid: List[String] = null, RegisteredGenerator: String = null) extends Element with Product with Serializable
Startup time curve as a function of down time, where time is specified in minutes.
Startup time curve as a function of down time, where time is specified in minutes.
Relationship between unit startup time (Y1-axis) vs. unit elapsed down time (X-axis).
- Curve
Curve Reference to the superclass object.
- GeneratingBid
GeneratingBid undocumented
- RegisteredGenerator
RegisteredGenerator undocumented
-
final
case class
StartupModel(IdentifiedObject: IdentifiedObject = null, fixedMaintCost: Double = 0.0, hotStandbyHeat: Double = 0.0, incrementalMaintCost: Double = 0.0, minimumDownTime: Double = 0.0, minimumRunTime: Double = 0.0, riskFactorCost: Double = 0.0, startupCost: Double = 0.0, startupDate: String = null, startupPriority: Int = 0, stbyAuxP: Double = 0.0, StartIgnFuelCurve: String = null, StartMainFuelCurve: String = null, StartRampCurve: String = null, ThermalGeneratingUnit: String = null) extends Element with Product with Serializable
Unit start up characteristics depending on how long the unit has been off line.
Unit start up characteristics depending on how long the unit has been off line.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- fixedMaintCost
Fixed maintenance cost.
- hotStandbyHeat
The amount of heat input per time unit required for hot standby operation.
- incrementalMaintCost
Incremental maintenance cost.
- minimumDownTime
The minimum number of hours the unit must be down before restart.
- minimumRunTime
The minimum number of hours the unit must be operating before being allowed to shut down.
- riskFactorCost
The opportunity cost associated with the return in monetary unit. This represents the restart's "share" of the unit depreciation and risk of an event which would damage the unit.
- startupCost
Total miscellaneous start up costs.
- startupDate
The date and time of the most recent generating unit startup.
- startupPriority
Startup priority within control area where lower numbers indicate higher priorities. More than one unit in an area may be assigned the same priority.
- stbyAuxP
The unit's auxiliary active power consumption to maintain standby mode.
- StartIgnFuelCurve
StartIgnFuelCurve The unit's startup model may have a startup ignition fuel curve.
- StartMainFuelCurve
StartMainFuelCurve The unit's startup model may have a startup main fuel curve.
- StartRampCurve
StartRampCurve The unit's startup model may have a startup ramp curve.
- ThermalGeneratingUnit
ThermalGeneratingUnit A thermal generating unit may have a startup model.
-
final
case class
StateVariable(Element: BasicElement = null) extends Element with Product with Serializable
An abstract class for state variables.
An abstract class for state variables.
- Element
Reference to the superclass object.
-
final
case class
StaticVarCompensator(RegulatingCondEq: RegulatingCondEq = null, capacitiveRating: Double = 0.0, inductiveRating: Double = 0.0, q: Double = 0.0, sVCControlMode: String = null, slope: Double = 0.0, voltageSetPoint: Double = 0.0, StaticVarCompensatorDynamics: String = null) extends Element with Product with Serializable
A facility for providing variable and controllable shunt reactive power.
A facility for providing variable and controllable shunt reactive power.
The SVC typically consists of a stepdown transformer, filter, thyristor-controlled reactor, and thyristor-switched capacitor arms.
The SVC may operate in fixed MVar output mode or in voltage control mode. When in voltage control mode, the output of the SVC will be proportional to the deviation of voltage at the controlled bus from the voltage setpoint. The SVC characteristic slope defines the proportion. If the voltage at the controlled bus is equal to the voltage setpoint, the SVC MVar output is zero.
- RegulatingCondEq
RegulatingCondEq Reference to the superclass object.
- capacitiveRating
Capacitive reactance at maximum capacitive reactive power. Shall always be positive.
- inductiveRating
Inductive reactance at maximum inductive reactive power. Shall always be negative.
- q
Reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution.
- sVCControlMode
SVC control mode.
- slope
The characteristics slope of an SVC defines how the reactive power output changes in proportion to the difference between the regulated bus voltage and the voltage setpoint. The attribute shall be a positive value or zero.
- voltageSetPoint
The reactive power output of the SVC is proportional to the difference between the voltage at the regulated bus and the voltage setpoint. When the regulated bus voltage is equal to the voltage setpoint, the reactive power output is zero.
- StaticVarCompensatorDynamics
StaticVarCompensatorDynamics Static Var Compensator dynamics model used to describe dynamic behaviour of this Static Var Compensator.
-
final
case class
StaticVarCompensatorDynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null, StaticVarCompensator: String = null) extends Element with Product with Serializable
Static var compensator whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
Static var compensator whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- StaticVarCompensator
StaticVarCompensator Static Var Compensator to which Static Var Compensator dynamics model applies.
-
final
case class
StationSupply(EnergyConsumer: EnergyConsumer = null) extends Element with Product with Serializable
Station supply with load derived from the station output.
Station supply with load derived from the station output.
- EnergyConsumer
EnergyConsumer Reference to the superclass object.
-
final
case class
StatisticalCalculation(IdentifiedObject: IdentifiedObject = null, calculationMode: String = null, calculationTechnique: String = null, CalculationMethodOrder: List[String] = null) extends Element with Product with Serializable
Description of statistical calculation performed.
Description of statistical calculation performed.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- calculationMode
Calculation mode.
- calculationTechnique
Kind of statistical calculation, specifying how the measurement value is calculated.
- CalculationMethodOrder
CalculationMethodOrder The order in which this statistical calculation is done.
-
final
case class
Status(Element: BasicElement = null, dateTime: String = null, reason: String = null, remark: String = null, value: String = null) extends Element with Product with Serializable
Current status information relevant to an entity.
Current status information relevant to an entity.
- Element
Reference to the superclass object.
- dateTime
Date and time for which status 'value' applies.
- reason
Reason code or explanation for why an object went to the current status 'value'.
- remark
Pertinent information regarding the current 'value', as free form text.
- value
Status value at 'dateTime'; prior status changes may have been kept in instances of activity records associated with the object to which this status applies.
-
final
case class
SteamSendoutSchedule(RegularIntervalSchedule: RegularIntervalSchedule = null, CogenerationPlant: String = null) extends Element with Product with Serializable
The cogeneration plant's steam sendout schedule in volume per time unit.
The cogeneration plant's steam sendout schedule in volume per time unit.
- RegularIntervalSchedule
RegularIntervalSchedule Reference to the superclass object.
- CogenerationPlant
CogenerationPlant A cogeneration plant has a steam sendout schedule.
-
final
case class
SteamSupply(PowerSystemResource: PowerSystemResource = null, steamSupplyRating: Double = 0.0, SteamTurbines: List[String] = null) extends Element with Product with Serializable
Steam supply for steam turbine.
Steam supply for steam turbine.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- steamSupplyRating
Rating of steam supply.
- SteamTurbines
SteamTurbine Steam turbines may have steam supplied by a steam supply.
-
final
case class
SteamTurbine(PrimeMover: PrimeMover = null, crossoverTC: Double = 0.0, reheater1TC: Double = 0.0, reheater2TC: Double = 0.0, shaft1PowerHP: Double = 0.0, shaft1PowerIP: Double = 0.0, shaft1PowerLP1: Double = 0.0, shaft1PowerLP2: Double = 0.0, shaft2PowerHP: Double = 0.0, shaft2PowerIP: Double = 0.0, shaft2PowerLP1: Double = 0.0, shaft2PowerLP2: Double = 0.0, steamChestTC: Double = 0.0, SteamSupplys: List[String] = null) extends Element with Product with Serializable
Steam turbine.
Steam turbine.
- PrimeMover
PrimeMover Reference to the superclass object.
- crossoverTC
Crossover time constant.
- reheater1TC
First reheater time constant.
- reheater2TC
Second reheater time constant.
- shaft1PowerHP
Fraction of power from shaft 1 high pressure turbine output.
- shaft1PowerIP
Fraction of power from shaft 1 intermediate pressure turbine output.
- shaft1PowerLP1
Fraction of power from shaft 1 first low pressure turbine output.
- shaft1PowerLP2
Fraction of power from shaft 1 second low pressure turbine output.
- shaft2PowerHP
Fraction of power from shaft 2 high pressure turbine output.
- shaft2PowerIP
Fraction of power from shaft 2 intermediate pressure turbine output.
- shaft2PowerLP1
Fraction of power from shaft 2 first low pressure turbine output.
- shaft2PowerLP2
Fraction of power from shaft 2 second low pressure turbine output.
- steamChestTC
Steam chest time constant.
- SteamSupplys
SteamSupply Steam turbines may have steam supplied by a steam supply.
-
final
case class
StreetAddress(Element: BasicElement = null, language: String = null, poBox: String = null, postalCode: String = null, status: String = null, streetDetail: String = null, townDetail: String = null) extends Element with Product with Serializable
General purpose street and postal address information.
General purpose street and postal address information.
- Element
Reference to the superclass object.
- language
The language in which the address is specified, using ISO 639-1 two digit language code.
- poBox
Post office box.
- postalCode
Postal code for the address.
- status
Status Status of this address.
- streetDetail
StreetDetail Street detail.
- townDetail
TownDetail Town detail.
-
final
case class
StreetDetail(Element: BasicElement = null, addressGeneral: String = null, addressGeneral2: String = null, addressGeneral3: String = null, buildingName: String = null, code: String = null, floorIdentification: String = null, name: String = null, number: String = null, prefix: String = null, suffix: String = null, suiteNumber: String = null, type: String = null, withinTownLimits: Boolean = false) extends Element with Product with Serializable
Street details, in the context of address.
Street details, in the context of address.
- Element
Reference to the superclass object.
- addressGeneral
First line of a free form address or some additional address information (for example a mail stop).
- addressGeneral2
(if applicable) Second line of a free form address.
- addressGeneral3
(if applicable) Third line of a free form address.
- buildingName
(if applicable) In certain cases the physical location of the place of interest does not have a direct point of entry from the street, but may be located inside a larger structure such as a building, complex, office block, apartment, etc.
- code
(if applicable) Utilities often make use of external reference systems, such as those of the town-planner's department or surveyor general's mapping system, that allocate global reference codes to streets.
- floorIdentification
The identification by name or number, expressed as text, of the floor in the building as part of this address.
- name
Name of the street.
- number
Designator of the specific location on the street.
- prefix
Prefix to the street name. For example: North, South, East, West.
- suffix
Suffix to the street name. For example: North, South, East, West.
- suiteNumber
Number of the apartment or suite.
- type
Type of street. Examples include: street, circle, boulevard, avenue, road, drive, etc.
- withinTownLimits
True if this street is within the legal geographical boundaries of the specified town (default).
-
final
case class
Streetlight(Asset: Asset = null, armLength: Double = 0.0, lampKind: String = null, lightRating: Double = 0.0, Pole: String = null) extends Element with Product with Serializable
Streetlight asset.
-
final
case class
StringMeasurement(Measurement: Measurement = null, StringMeasurementValues: List[String] = null) extends Element with Product with Serializable
StringMeasurement represents a measurement with values of type string.
StringMeasurement represents a measurement with values of type string.
- Measurement
Measurement Reference to the superclass object.
- StringMeasurementValues
StringMeasurementValue The values connected to this measurement.
-
final
case class
StringMeasurementValue(MeasurementValue: MeasurementValue = null, value: String = null, StringMeasurement: String = null) extends Element with Product with Serializable
StringMeasurementValue represents a measurement value of type string.
StringMeasurementValue represents a measurement value of type string.
- MeasurementValue
MeasurementValue Reference to the superclass object.
- value
The value to supervise.
- StringMeasurement
StringMeasurement Measurement to which this value is connected.
-
final
case class
StringQuantity(Element: BasicElement = null, multiplier: String = null, unit: String = null, value: String = null) extends Element with Product with Serializable
Quantity with string value (when it is not important whether it is an integral or a floating point number) and associated unit information.
Quantity with string value (when it is not important whether it is an integral or a floating point number) and associated unit information.
- Element
Reference to the superclass object.
- multiplier
Unit multiplier of this quantity.
- unit
Unit of this quantity.
- value
Value of this quantity.
-
final
case class
Structure(AssetContainer: AssetContainer = null, fumigantAppliedDate: String = null, fumigantName: String = null, height: Double = 0.0, materialKind: String = null, ratedVoltage: Double = 0.0, removeWeed: Boolean = false, weedRemovedDate: String = null, StructureSupports: List[String] = null, WireSpacingInfos: List[String] = null) extends Element with Product with Serializable
Construction holding assets such as conductors, transformers, switchgear, etc.
Construction holding assets such as conductors, transformers, switchgear, etc.
Where applicable, number of conductors can be derived from the number of associated wire spacing instances.
- AssetContainer
AssetContainer Reference to the superclass object.
- fumigantAppliedDate
Date fumigant was last applied.
- fumigantName
Name of fumigant.
- height
Visible height of structure above ground level for overhead construction (e.g., Pole or Tower) or below ground level for an underground vault, manhole, etc. Refer to associated DimensionPropertiesInfo for other types of dimensions.
- materialKind
Material this structure is made of.
- ratedVoltage
Maximum rated voltage of the equipment that can be mounted on/contained within the structure.
- removeWeed
True if weeds are to be removed around asset.
- weedRemovedDate
Date weed were last removed.
- StructureSupports
StructureSupport Structure support for this structure.
- WireSpacingInfos
WireSpacingInfo undocumented
-
final
case class
StructureSupport(Asset: Asset = null, anchorKind: String = null, anchorRodCount: Int = 0, anchorRodLength: Double = 0.0, direction: Double = 0.0, kind: String = null, len: Double = 0.0, size1: String = null, SecuredStructure: String = null) extends Element with Product with Serializable
Support for structure assets.
Support for structure assets.
- Asset
Asset Reference to the superclass object.
- anchorKind
(if anchor) Kind of anchor.
- anchorRodCount
(if anchor) Number of rods used.
- anchorRodLength
(if anchor) Length of rod used.
- direction
Direction of this support structure.
- kind
Kind of structure support.
- len
Length of this support structure.
- size1
Size of this support structure.
- SecuredStructure
Structure The secured structure supported by this structure support.
-
final
case class
SubControlArea(PowerSystemResource: PowerSystemResource = null, areaShortName: String = null, constantCoefficient: Double = 0.0, embeddedControlArea: String = null, internalCA: String = null, linearCoefficient: Double = 0.0, localCA: String = null, maxSelfSchedMW: Double = 0.0, minSelfSchedMW: Double = 0.0, quadraticCoefficient: Double = 0.0, AdjacentCASet: String = null, AggregateNode: List[String] = null, AreaReserveSpecification: String = null, BidSelfSched: List[String] = null, CnodeDistributionFactor: List[String] = null, ControlAreaDesignation: List[String] = null, ExPostLossResults: List[String] = null, Export_EnergyTransactions: List[String] = null, From_Flowgate: List[String] = null, GeneralClearingResults: List[String] = null, HostControlArea: String = null, Import_EnergyTransactions: List[String] = null, InadvertentAccount: List[String] = null, LossClearingResults: List[String] = null, Pnode: List[String] = null, RTO: String = null, Receive_DynamicSchedules: List[String] = null, RegisteredResource: List[String] = null, Send_DynamicSchedules: List[String] = null, SideA_TieLines: List[String] = null, SideB_TieLines: List[String] = null, To_Flowgate: List[String] = null) extends Element with Product with Serializable
An area defined for the purpose of tracking interchange with surrounding areas via tie points; may or may not serve as a control area.
An area defined for the purpose of tracking interchange with surrounding areas via tie points; may or may not serve as a control area.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- areaShortName
Market area short name, which is the regulation zone. It references AGC regulation zone name.
- constantCoefficient
Loss estimate constant coefficient
- embeddedControlArea
Used in conjunction with the InternalCA flag. If the InternalCA flag is YES, this flag does not apply. If the InternaCA flag is NO, this flag provides an indication of AdjacentCA (NO) or Embedded CA (YES).
- internalCA
A Yes/No indication that this control area is contained internal to the system.
- linearCoefficient
Loss estimate linear coefficient
- localCA
Indication that this control area is the local control area.
- maxSelfSchedMW
Maximum amount of self schedule MWs allowed for an embedded control area.
- minSelfSchedMW
Minimum amount of self schedule MW allowed for an embedded control area.
- quadraticCoefficient
Loss estimate quadratic coefficient
- AdjacentCASet
AdjacentCASet undocumented
- AggregateNode
AggregateNode undocumented
- AreaReserveSpecification
AreaReserveSpec undocumented
- BidSelfSched
BidSelfSched undocumented
- CnodeDistributionFactor
CnodeDistributionFactor undocumented
- ControlAreaDesignation
ControlAreaDesignation undocumented
- ExPostLossResults
ExPostLossResults undocumented
- Export_EnergyTransactions
EnergyTransaction Energy is transferred between interchange areas
- From_Flowgate
Flowgate undocumented
- GeneralClearingResults
GeneralClearingResults undocumented
- HostControlArea
HostControlArea The interchange area may operate as a control area
- Import_EnergyTransactions
EnergyTransaction Energy is transferred between interchange areas
- InadvertentAccount
InadvertentAccount A control area can have one or more net inadvertent interchange accounts
- LossClearingResults
LossClearingResults undocumented
- Pnode
Pnode undocumented
- RTO
RTO undocumented
- Receive_DynamicSchedules
DynamicSchedule A control area can receive dynamic schedules from other control areas
- RegisteredResource
RegisteredResource undocumented
- Send_DynamicSchedules
DynamicSchedule A control area can send dynamic schedules to other control areas
- SideA_TieLines
TieLine The SubControlArea is on the A side of a collection of metered points which define the SubControlArea's boundary for a ControlAreaOperator or CustomerConsumer.
- SideB_TieLines
TieLine The SubControlArea is on the B side of a collection of metered points which define the SubControlArea's boundary for a ControlAreaOperator or CustomerConsumer.
- To_Flowgate
Flowgate undocumented
-
final
case class
SubGeographicalRegion(IdentifiedObject: IdentifiedObject = null, DCLines: List[String] = null, Lines: List[String] = null, Region: String = null, Substations: List[String] = null) extends Element with Product with Serializable
A subset of a geographical region of a power system network model.
A subset of a geographical region of a power system network model.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- DCLines
DCLine The DC lines in this sub-geographical region.
- Lines
Line The lines within the sub-geographical region.
- Region
GeographicalRegion The geographical region which this sub-geographical region is within.
- Substations
Substation The substations in this sub-geographical region.
-
final
case class
SubLoadArea(EnergyArea: EnergyArea = null, LoadArea: String = null, LoadGroups: List[String] = null) extends Element with Product with Serializable
The class is the second level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling.
The class is the second level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling.
- EnergyArea
EnergyArea Reference to the superclass object.
- LoadArea
LoadArea The LoadArea where the SubLoadArea belongs.
- LoadGroups
LoadGroup The Loadgroups in the SubLoadArea.
-
final
case class
Subcritical(FossilSteamSupply: FossilSteamSupply = null) extends Element with Product with Serializable
Once-through subcritical boiler.
Once-through subcritical boiler.
- FossilSteamSupply
FossilSteamSupply Reference to the superclass object.
-
final
case class
SubscribePowerCurve(Curve: Curve = null) extends Element with Product with Serializable
Price curve for specifying the cost of energy (X) at points in time (y1) according to a prcing structure, which is based on a tariff.
Price curve for specifying the cost of energy (X) at points in time (y1) according to a prcing structure, which is based on a tariff.
- Curve
Curve Reference to the superclass object.
-
final
case class
Substation(EquipmentContainer: EquipmentContainer = null, Bays: List[String] = null, DCConverterUnit: List[String] = null, NamingFeeder: String = null, NormalEnergizedFeeder: List[String] = null, NormalEnergizingFeeder: List[String] = null, Region: String = null, VoltageLevels: List[String] = null) extends Element with Product with Serializable
A collection of equipment for purposes other than generation or utilization, through which electric energy in bulk is passed for the purposes of switching or modifying its characteristics.
A collection of equipment for purposes other than generation or utilization, through which electric energy in bulk is passed for the purposes of switching or modifying its characteristics.
- EquipmentContainer
EquipmentContainer Reference to the superclass object.
- Bays
Bay Bays contained in the substation.
- DCConverterUnit
DCConverterUnit The DC converter unit belonging of the substation.
- NamingFeeder
Feeder The primary feeder that normally energizes the secondary substation. Used for naming purposes. Either this association or the substation to subgeographical region should be used for hierarchical containment specification.
- NormalEnergizedFeeder
Feeder The normal energized feeders of the substation. Also used for naming purposes.
- NormalEnergizingFeeder
Feeder The feeders that potentially energize the downstream substation. Should be consistent with the associations that describe the naming hierarchy.
- Region
SubGeographicalRegion The SubGeographicalRegion containing the substation.
- VoltageLevels
VoltageLevel The voltage levels within this substation.
-
final
case class
SubstitutionResourceList(Element: BasicElement = null, precedence: Int = 0, RegisteredResource: String = null, TransmissionContractRight: String = null) extends Element with Product with Serializable
List of resources that can be substituted for within the bounds of a Contract definition.
List of resources that can be substituted for within the bounds of a Contract definition.
This class has a precedence and a resource.
- Element
Reference to the superclass object.
- precedence
An indicator of the order a resource should be substituted. The lower the number the higher the precedence.
- RegisteredResource
RegisteredResource undocumented
- TransmissionContractRight
ContractRight undocumented
-
final
case class
Supercritical(FossilSteamSupply: FossilSteamSupply = null) extends Element with Product with Serializable
Once-through supercritical boiler.
Once-through supercritical boiler.
- FossilSteamSupply
FossilSteamSupply Reference to the superclass object.
-
final
case class
SurgeArrester(AuxiliaryEquipment: AuxiliaryEquipment = null) extends Element with Product with Serializable
Shunt device, installed on the network, usually in the proximity of electrical equipment in order to protect the said equipment against transient voltage transients caused by lightning or switching activity.
Shunt device, installed on the network, usually in the proximity of electrical equipment in order to protect the said equipment against transient voltage transients caused by lightning or switching activity.
- AuxiliaryEquipment
AuxiliaryEquipment Reference to the superclass object.
-
final
case class
SurgeArresterInfo(AssetInfo: AssetInfo = null, continuousOperatingVoltage: Double = 0.0, isPolymer: Boolean = false, lightningImpulseDischargeVoltage: Double = 0.0, lineDischargeClass: Int = 0, nominalDischargeCurrent: Double = 0.0, pressureReliefClass: Double = 0.0, ratedVoltage: Double = 0.0, steepFrontDischargeVoltage: Double = 0.0, switchingImpulseDischargeVoltage: Double = 0.0) extends Element with Product with Serializable
Properties of surge arrester.
Properties of surge arrester.
- AssetInfo
AssetInfo Reference to the superclass object.
- continuousOperatingVoltage
Maximum continuous power frequency voltage allowed on the surge arrester.
- isPolymer
If true, the arrester has a polymer housing, porcelain otherwise.
- lightningImpulseDischargeVoltage
Residual voltage during an 8x20 microsecond current impulse at the nominal discharge current level.
- lineDischargeClass
Determines the arrester energy discharge capability. Choices are limited to 0 (none) through 5 (highest) by IEC 60099. Classes 1..3 require a 10-kA nominal discharge current. Classes 4..5 require a 20-kA nominal discharge current. Lower nominal discharge currents must use class 0.
- nominalDischargeCurrent
The lightning discharge current used to classify the arrester. Choices are limited to 1.5, 2.5, 5, 10, and 20 kA by IEC 60099.
- pressureReliefClass
Fault current level at which all parts of the failed arrester lie within a circle prescribed by IEC 60099.
- ratedVoltage
The temporary overvoltage (TOV) level at power frequency that the surge arrester withstands for 10 seconds.
- steepFrontDischargeVoltage
Residual voltage during a current impulse with front time of 1 microsecond, and magnitude equal to the nominal discharge current level.
- switchingImpulseDischargeVoltage
Residual voltage during a current impulse with front time of at least 30 microseconds, and magnitude specified in IEC 60099 for the line discharge class. Does not apply to line discharge class 0.
-
final
case class
SvInjection(StateVariable: StateVariable = null, pInjection: Double = 0.0, phase: String = null, qInjection: Double = 0.0, TopologicalNode: String = null) extends Element with Product with Serializable
The SvInjection reports the calculated bus injection minus the sum of the terminal flows.
The SvInjection reports the calculated bus injection minus the sum of the terminal flows.
The terminal flow is positive out from the bus (load sign convention) and bus injection has positive flow into the bus. SvInjection may have the remainder after state estimation or slack after power flow calculation.
- StateVariable
StateVariable Reference to the superclass object.
- pInjection
The active power mismatch between calculated injection and initial injection. Positive sign means injection into the TopologicalNode (bus).
- phase
The terminal phase at which the connection is applied. If missing, the injection is assumed to be balanced among non-neutral phases.
- qInjection
The reactive power mismatch between calculated injection and initial injection. Positive sign means injection into the TopologicalNode (bus).
- TopologicalNode
TopologicalNode The topological node associated with the flow injection state variable.
-
final
case class
SvPowerFlow(StateVariable: StateVariable = null, p: Double = 0.0, phase: String = null, q: Double = 0.0, Terminal: String = null) extends Element with Product with Serializable
State variable for power flow.
State variable for power flow.
Load convention is used for flow direction. This means flow out from the TopologicalNode into the equipment is positive.
- StateVariable
StateVariable Reference to the superclass object.
- p
The active power flow. Load sign convention is used, i.e. positive sign means flow out from a TopologicalNode (bus) into the conducting equipment.
- phase
The individual phase of the flow. If unspecified, then assumed to be balanced among phases.
- q
The reactive power flow. Load sign convention is used, i.e. positive sign means flow out from a TopologicalNode (bus) into the conducting equipment.
- Terminal
Terminal The terminal associated with the power flow state variable.
-
final
case class
SvShuntCompensatorSections(StateVariable: StateVariable = null, phase: String = null, sections: Double = 0.0, ShuntCompensator: String = null) extends Element with Product with Serializable
State variable for the number of sections in service for a shunt compensator.
State variable for the number of sections in service for a shunt compensator.
- StateVariable
StateVariable Reference to the superclass object.
- phase
The terminal phase at which the connection is applied. If missing, the injection is assumed to be balanced among non-neutral phases.
- sections
The number of sections in service as a continuous variable. The attribute shall be a positive value or zero. To get integer value scale with ShuntCompensator.bPerSection.
- ShuntCompensator
ShuntCompensator The shunt compensator for which the state applies.
-
final
case class
SvStatus(StateVariable: StateVariable = null, inService: Boolean = false, phase: String = null, ConductingEquipment: String = null) extends Element with Product with Serializable
State variable for status.
State variable for status.
- StateVariable
StateVariable Reference to the superclass object.
- inService
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.
- phase
The individual phase status. If the attribute is unspecified, then three phase model is assumed.
- ConductingEquipment
ConductingEquipment The conducting equipment associated with the status state variable.
-
final
case class
SvSwitch(StateVariable: StateVariable = null, open: Boolean = false, phase: String = null, Switch: String = null) extends Element with Product with Serializable
State variable for switch.
State variable for switch.
- StateVariable
StateVariable Reference to the superclass object.
- open
The attribute tells if the computed state of the switch is considered open.
- phase
The terminal phase at which the connection is applied. If missing, the injection is assumed to be balanced among non-neutral phases.
- Switch
Switch The switch associated with the switch state.
-
final
case class
SvTapStep(StateVariable: StateVariable = null, position: Double = 0.0, TapChanger: String = null) extends Element with Product with Serializable
State variable for transformer tap step.
State variable for transformer tap step.
- StateVariable
StateVariable Reference to the superclass object.
- position
The floating point tap position. This is not the tap ratio, but rather the tap step position as defined by the related tap changer model and normally is constrained to be within the range of minimum and maximum tap positions.
- TapChanger
TapChanger The tap changer associated with the tap step state.
-
final
case class
SvVoltage(StateVariable: StateVariable = null, angle: Double = 0.0, phase: String = null, v: Double = 0.0, TopologicalNode: String = null) extends Element with Product with Serializable
State variable for voltage.
State variable for voltage.
- StateVariable
StateVariable Reference to the superclass object.
- angle
The voltage angle of the topological node complex voltage with respect to system reference.
- phase
If specified the voltage is the line to ground voltage of the individual phase. If unspecified, then the voltage is assumed balanced.
- v
The voltage magnitude at the topological node. The attribute shall be a positive value.
- TopologicalNode
TopologicalNode The topological node associated with the voltage state.
-
final
case class
Switch(ConductingEquipment: ConductingEquipment = null, locked: Boolean = false, normalOpen: Boolean = false, open: Boolean = false, ratedCurrent: Double = 0.0, retained: Boolean = false, switchOnCount: Int = 0, switchOnDate: String = null, CompositeSwitch: String = null, ConnectDisconnectFunctions: List[String] = null, SvSwitch: List[String] = null, SwitchAction: String = null, SwitchPhase: List[String] = null, SwitchSchedules: List[String] = null) extends Element with Product with Serializable
A generic device designed to close, or open, or both, one or more electric circuits.
A generic device designed to close, or open, or both, one or more electric circuits.
All switches are two terminal devices including grounding switches. The ACDCTerminal.connected at the two sides of the switch shall not be considered for assessing switch connectivity, i.e. only Switch.open, .normalOpen and .locked are relevant.
- ConductingEquipment
ConductingEquipment Reference to the superclass object.
- locked
If true, the switch is locked. The resulting switch state is a combination of locked and Switch.open attributes as follows:
- locked=true and Switch.open=true. The resulting state is open and locked;
- locked=false and Switch.open=true. The resulting state is open;
- locked=false and Switch.open=false. The resulting state is closed.
- normalOpen
The attribute is used in cases when no Measurement for the status value is present. If the Switch has a status measurement the Discrete.normalValue is expected to match with the Switch.normalOpen.
- open
The attribute tells if the switch is considered open when used as input to topology processing.
- ratedCurrent
The maximum continuous current carrying capacity in amps governed by the device material and construction. The attribute shall be a positive value.
- retained
Branch is retained in the topological solution. The flow through retained switches will normally be calculated in power flow.
- switchOnCount
The switch on count since the switch was last reset or initialized.
- switchOnDate
The date and time when the switch was last switched on.
- CompositeSwitch
CompositeSwitch Composite switch to which this Switch belongs.
- ConnectDisconnectFunctions
ConnectDisconnectFunction undocumented
- SvSwitch
SvSwitch The switch state associated with the switch.
- SwitchAction
SwitchAction Action changing status of this switch.
- SwitchPhase
SwitchPhase The individual switch phases for the switch.
- SwitchSchedules
SwitchSchedule A Switch can be associated with SwitchSchedules.
-
final
case class
SwitchAction(SwitchingAction: SwitchingAction = null, kind: String = null, OperatedSwitch: String = null, PlannedOutage: String = null) extends Element with Product with Serializable
Action on switch as a switching step.
Action on switch as a switching step.
- SwitchingAction
SwitchingAction Reference to the superclass object.
- kind
Switching action to perform.
- OperatedSwitch
Switch Switch that is the object of this switch action.
- PlannedOutage
Outage Planned outage for whose scope this switch action applies.
-
final
case class
SwitchInfo(AssetInfo: AssetInfo = null, breakingCapacity: Double = 0.0, gasWeightPerTank: Double = 0.0, isSinglePhase: Boolean = false, isUnganged: Boolean = false, lowPressureAlarm: Double = 0.0, lowPressureLockOut: Double = 0.0, oilVolumePerTank: Double = 0.0, ratedCurrent: Double = 0.0, ratedFrequency: Double = 0.0, ratedImpulseWithstandVoltage: Double = 0.0, ratedInterruptingTime: Double = 0.0, ratedVoltage: Double = 0.0) extends Element with Product with Serializable
<was Switch data.>
<was Switch data.>
Switch datasheet information.
- AssetInfo
AssetInfo Reference to the superclass object.
- breakingCapacity
The maximum fault current a breaking device can break safely under prescribed conditions of use.
- gasWeightPerTank
Weight of gas in each tank of SF6 dead tank breaker.
- isSinglePhase
If true, it is a single phase switch.
- isUnganged
If true, the switch is not ganged (i.e., a switch phase may be operated separately from other phases).
- lowPressureAlarm
Gas or air pressure at or below which a low pressure alarm is generated.
- lowPressureLockOut
Gas or air pressure below which the breaker will not open.
- oilVolumePerTank
Volume of oil in each tank of bulk oil breaker.
- ratedCurrent
Rated current.
- ratedFrequency
Frequency for which switch is rated.
- ratedImpulseWithstandVoltage
Rated impulse withstand voltage, also known as BIL (Basic Impulse Level).
- ratedInterruptingTime
Switch rated interrupting time in seconds.
- ratedVoltage
Rated voltage.
-
final
case class
SwitchOperationSummary(IdentifiedObject: IdentifiedObject = null, lifetimeFaultOperations: Int = 0, lifetimeMotorStarts: Int = 0, lifetimeTotalOperations: Int = 0, mostRecentFaultOperationDate: String = null, mostRecentMotorStartDate: String = null, mostRecentOperationDate: String = null, Breaker: String = null) extends Element with Product with Serializable
Up-to-date, of-record summary of switch operation information, distilled from a variety of sources (real-time data or real-time data historian, field inspections, etc.) of use to asset health analytics.
Up-to-date, of-record summary of switch operation information, distilled from a variety of sources (real-time data or real-time data historian, field inspections, etc.) of use to asset health analytics.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- lifetimeFaultOperations
Total breaker fault operations to date.
- lifetimeMotorStarts
Total motor starts to date.
- lifetimeTotalOperations
Total breaker operations to date (including fault and non-fault).
- mostRecentFaultOperationDate
Date of most recent breaker fault operation.
- mostRecentMotorStartDate
Date of most recent motor start.
- mostRecentOperationDate
Date of most recent breaker operation (fault or non-fault).
- Breaker
Asset Breaker asset to which this operation information applies.
-
final
case class
SwitchPhase(PowerSystemResource: PowerSystemResource = null, closed: Boolean = false, normalOpen: Boolean = false, phaseSide1: String = null, phaseSide2: String = null, ratedCurrent: Double = 0.0, Switch: String = null) extends Element with Product with Serializable
Single phase of a multi-phase switch when its attributes might be different per phase.
Single phase of a multi-phase switch when its attributes might be different per phase.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- closed
The attribute tells if the switch is considered closed when used as input to topology processing.
- normalOpen
Used in cases when no Measurement for the status value is present. If the SwitchPhase has a status measurement the Discrete.normalValue is expected to match with this value.
- phaseSide1
Phase of this SwitchPhase on the side with terminal sequence number equal to 1. Should be a phase contained in that terminal’s phases attribute.
- phaseSide2
Phase of this SwitchPhase on the side with terminal sequence number equal to 2. Should be a phase contained in that terminal’s Terminal.phases attribute.
- ratedCurrent
The maximum continuous current carrying capacity in amps governed by the device material and construction. The attribute shall be a positive value.
- Switch
Switch The switch of the switch phase.
-
final
case class
SwitchSchedule(SeasonDayTypeSchedule: SeasonDayTypeSchedule = null, Switch: String = null) extends Element with Product with Serializable
A schedule of switch positions.
A schedule of switch positions.
If RegularTimePoint.value1 is 0, the switch is open. If 1, the switch is closed.
- SeasonDayTypeSchedule
SeasonDayTypeSchedule Reference to the superclass object.
- Switch
Switch A SwitchSchedule is associated with a Switch.
-
final
case class
SwitchStatus(Element: BasicElement = null, switchStatus: String = null, MktSwitch: String = null) extends Element with Product with Serializable
Optimal Power Flow or State Estimator Circuit Breaker Status.
Optimal Power Flow or State Estimator Circuit Breaker Status.
- Element
Reference to the superclass object.
- switchStatus
Circuit Breaker Status (closed or open) of the circuit breaker from the power flow.
- MktSwitch
MktSwitch undocumented
-
final
case class
SwitchingAction(IdentifiedObject: IdentifiedObject = null, executedDateTime: String = null, issuedDateTime: String = null, phases: String = null, plannedDateTime: String = null, Crew: List[String] = null, Operator: String = null, SwitchingEvent: String = null, SwitchingPlan: String = null, SwitchingStep: String = null) extends Element with Product with Serializable
Atomic switching action.
Atomic switching action.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- executedDateTime
Actual date and time of this switching step.
- issuedDateTime
Date and time when the crew was given the instruction to execute the action; not applicable if the action is performed by operator remote control.
- phases
Phases of the Switching Action
- plannedDateTime
Planned date and time of this switching step.
- Crew
Crew undocumented
- Operator
Operator Operator responsible for this switching step.
- SwitchingEvent
SwitchingEvent undocumented
- SwitchingPlan
SwitchingPlan undocumented
- SwitchingStep
SwitchingStep undocumented
-
final
case class
SwitchingEvent(ActivityRecord: ActivityRecord = null, SwitchingAction: String = null) extends Element with Product with Serializable
Event indicating the completion (success or fail) of any switching action (jumper action, cut action, tag action, etc).
Event indicating the completion (success or fail) of any switching action (jumper action, cut action, tag action, etc).
The switching action may or may not be a consequential event in response to a request to complete the action.
- ActivityRecord
ActivityRecord Reference to the superclass object.
- SwitchingAction
SwitchingAction undocumented
-
final
case class
SwitchingOrder(Document: Document = null, comment: String = null, plannedExecutionInterval: String = null, Location: List[String] = null, SwitchingPlan: String = null) extends Element with Product with Serializable
Transmits a switching plan to a crew in order for the plan to be executed.
Transmits a switching plan to a crew in order for the plan to be executed.
- Document
Document Reference to the superclass object.
- comment
Free-form comment associated with the switching order.
- plannedExecutionInterval
The planned start and end time for the switching order.
- Location
Location undocumented
- SwitchingPlan
SwitchingPlan undocumented
-
final
case class
SwitchingPlan(Document: Document = null, approvedDateTime: String = null, cancelledDateTime: String = null, plannedPeriod: String = null, purpose: String = null, rank: Int = 0, Outage: String = null, OutagePlan: String = null, PlannedOutageNotification: String = null, SafetyDocuments: List[String] = null, SwitchingAction: List[String] = null, SwitchingOrder: String = null, SwitchingPlanRequest: String = null, SwitchingStepGroups: List[String] = null, WorkTasks: List[String] = null) extends Element with Product with Serializable
A sequence of grouped or atomic steps intended to: - de-energise equipment or part of the network for safe work, and/or
A sequence of grouped or atomic steps intended to: - de-energise equipment or part of the network for safe work, and/or
- bring back in service previously de-energised equipment or part of the network.
- Document
Document Reference to the superclass object.
- approvedDateTime
The date and time the switching plan was approved
- cancelledDateTime
Date and Time the switching plan was cancelled.
- plannedPeriod
the planned start and end times for the switching plan.
- purpose
Purpose of this plan, such as whether it is to move the state from normal to some abnormal condition, or to restore the normal state after an abnormal condition, or to perform some kind of optimisation such as correction of overload, voltage control, etc.
- rank
Ranking in comparison to other switching plans.
- Outage
Outage Outage that will be activated or eliminated when this switching plan gets executed.
- OutagePlan
OutagePlan The outage plan for which the switching plan is defined.
- PlannedOutageNotification
PlannedOutageNotification undocumented
- SafetyDocuments
SafetyDocument All safety documents applicable to this swtiching plan.
- SwitchingAction
SwitchingAction undocumented
- SwitchingOrder
SwitchingOrder undocumented
- SwitchingPlanRequest
SwitchingPlanRequest undocumented
- SwitchingStepGroups
SwitchingStepGroup All groups of switching steps within this switching plan.
- WorkTasks
WorkTask All work tasks to execute this switching plan.
-
final
case class
SwitchingPlanRequest(Document: Document = null, comment: String = null, equipmentToBeIsolated: String = null, forwardSwitchingDateTimeInterval: String = null, groundingPoints: String = null, isolationArea: String = null, isolationPoints: String = null, outageDateTimeInterval: String = null, purpose: String = null, reverseSwitchingDateTimeInterval: String = null, switchingRequestDetails: String = null, RequestingOrganization: String = null, SwitchingPlan: List[String] = null) extends Element with Product with Serializable
A document used to request that a switching plan be created for a particular purpose.
A document used to request that a switching plan be created for a particular purpose.
- Document
Document Reference to the superclass object.
- comment
Free-form text to describe the request
- equipmentToBeIsolated
free-form list of the equipment to be isolated by the switching
- forwardSwitchingDateTimeInterval
undocumented
- groundingPoints
free-form list of equipment to be grounded or other actions to be taken in order to accomplish the required grounding.
- isolationArea
free-form description of the area to be isolated by the switching
- isolationPoints
free-form list of equipment to be operated or other actions to be taken in order to accomplish the required isolation.
- outageDateTimeInterval
The window of time during which one or more customers will be de-energized during execution of the switching plan.
- purpose
undocumented
- reverseSwitchingDateTimeInterval
undocumented
- switchingRequestDetails
undocumented
- RequestingOrganization
Organisation undocumented
- SwitchingPlan
SwitchingPlan undocumented
-
final
case class
SwitchingStep(Element: BasicElement = null, isFreeSequence: Boolean = false, sequenceNumber: Int = 0, subStepSequenceNumber: Int = 0, SwitchingAction: String = null, SwitchingStepGroup: String = null) extends Element with Product with Serializable
Atomic switching step; can be part of a switching step group, or part of a switching plan.
Atomic switching step; can be part of a switching step group, or part of a switching plan.
- Element
Reference to the superclass object.
- isFreeSequence
For a step, if isFreeSequence is set to false or is not specified, all of the steps in the group must be executed in the order defined by the sequenceNumber attribute. The sequenceNumber for a step has a different meaning when there are two or more sequential steps that have the isFreeSequence attribute set to true. Execution must still be performed in sequenceNumber order until a set of two or more steps that have isFreeSequence set to true is encountered. In this case, these steps can be executed in any sequence, until a step is encountered that has isFreeSequence set to false. All of the steps preceding this step must be executed before the step can be executed.
- sequenceNumber
Order of this activity in the sequence of activities within the switching plan.
- subStepSequenceNumber
Supports compound switching steps that are made up of several sub steps.
- SwitchingAction
SwitchingAction undocumented
- SwitchingStepGroup
SwitchingStepGroup undocumented
-
final
case class
SwitchingStepGroup(Element: BasicElement = null, description: String = null, isFreeSequence: Boolean = false, purpose: String = null, sequenceNumber: Int = 0, SwitchingPlan: String = null, SwitchingStep: List[String] = null) extends Element with Product with Serializable
A logical step, grouping atomic switching steps that are important to distinguish when they may change topology (e.g.
A logical step, grouping atomic switching steps that are important to distinguish when they may change topology (e.g. placing a jumper between two cuts).
- Element
Reference to the superclass object.
- description
Descriptive information concerning the switching step group.
- isFreeSequence
If true, the sequence number serves for presentation purposes only, and the activity itself may be executed at any time.
- purpose
Describes the overall purpose of the steps in this switching step group.
- sequenceNumber
Order of this activity in the sequence of activities within the switching plan.
- SwitchingPlan
SwitchingPlan Switching plan to which this group belongs.
- SwitchingStep
SwitchingStep undocumented
-
final
case class
SynchrocheckRelay(ProtectionEquipment: ProtectionEquipment = null, maxAngleDiff: Double = 0.0, maxFreqDiff: Double = 0.0, maxVoltDiff: Double = 0.0) extends Element with Product with Serializable
A device that operates when two AC circuits are within the desired limits of frequency, phase angle, and voltage, to permit or to cause the paralleling of these two circuits.
A device that operates when two AC circuits are within the desired limits of frequency, phase angle, and voltage, to permit or to cause the paralleling of these two circuits.
Used to prevent the paralleling of non-synchronous topological islands.
- ProtectionEquipment
ProtectionEquipment Reference to the superclass object.
- maxAngleDiff
The maximum allowable voltage vector phase angle difference across the open device.
- maxFreqDiff
The maximum allowable frequency difference across the open device.
- maxVoltDiff
The maximum allowable difference voltage across the open device.
-
final
case class
SynchronousMachine(RotatingMachine: RotatingMachine = null, aVRToManualLag: Double = 0.0, aVRToManualLead: Double = 0.0, baseQ: Double = 0.0, condenserP: Double = 0.0, coolantCondition: Double = 0.0, coolantType: String = null, earthing: Boolean = false, earthingStarPointR: Double = 0.0, earthingStarPointX: Double = 0.0, ikk: Double = 0.0, manualToAVR: Double = 0.0, maxQ: Double = 0.0, maxU: Double = 0.0, minQ: Double = 0.0, minU: Double = 0.0, mu: Double = 0.0, operatingMode: String = null, qPercent: Double = 0.0, r: Double = 0.0, r0: Double = 0.0, r2: Double = 0.0, referencePriority: Int = 0, satDirectSubtransX: Double = 0.0, satDirectSyncX: Double = 0.0, satDirectTransX: Double = 0.0, shortCircuitRotorType: String = null, type: String = null, voltageRegulationRange: Double = 0.0, x0: Double = 0.0, x2: Double = 0.0, InitialReactiveCapabilityCurve: String = null, PrimeMovers: List[String] = null, ReactiveCapabilityCurves: List[String] = null, SynchronousMachineDynamics: String = null) extends Element with Product with Serializable
An electromechanical device that operates with shaft rotating synchronously with the network.
An electromechanical device that operates with shaft rotating synchronously with the network.
It is a single machine operating either as a generator or synchronous condenser or pump.
- RotatingMachine
RotatingMachine Reference to the superclass object.
- aVRToManualLag
Time delay required when switching from Automatic Voltage Regulation (AVR) to Manual for a lagging MVAr violation.
- aVRToManualLead
Time delay required when switching from Automatic Voltage Regulation (AVR) to Manual for a leading MVAr violation.
- baseQ
Default base reactive power value. This value represents the initial reactive power that can be used by any application function.
- condenserP
Active power consumed when in condenser mode operation.
- coolantCondition
Temperature or pressure of coolant medium.
- coolantType
Method of cooling the machine.
- earthing
Indicates whether or not the generator is earthed. Used for short circuit data exchange according to IEC 60909.
- earthingStarPointR
Generator star point earthing resistance (Re). Used for short circuit data exchange according to IEC 60909.
- earthingStarPointX
Generator star point earthing reactance (Xe). Used for short circuit data exchange according to IEC 60909.
- ikk
Steady-state short-circuit current (in A for the profile) of generator with compound excitation during 3-phase short circuit.
- Ikk=0: Generator with no compound excitation.
- Ikk<>0: Generator with compound excitation. Ikk is used to calculate the minimum steady-state short-circuit current for generators with compound excitation. (4.6.1.2 in IEC 60909-0:2001). Used only for single fed short circuit on a generator. (4.3.4.2. in IEC 60909-0:2001).
- manualToAVR
Time delay required when switching from Manual to Automatic Voltage Regulation. This value is used in the accelerating power reference frame for powerflow solutions.
- maxQ
Maximum reactive power limit. This is the maximum (nameplate) limit for the unit.
- maxU
Maximum voltage limit for the unit.
- minQ
Minimum reactive power limit for the unit.
- minU
Minimum voltage limit for the unit.
- mu
Factor to calculate the breaking current (Section 4.5.2.1 in IEC 60909-0). Used only for single fed short circuit on a generator (Section 4.3.4.2. in IEC 60909-0).
- operatingMode
Current mode of operation.
- qPercent
Part of the coordinated reactive control that comes from this machine. The attribute is used as a participation factor not necessarily summing up to 100% for the participating devices in the control.
- r
Equivalent resistance (RG) of generator. RG is considered for the calculation of all currents, except for the calculation of the peak current ip. Used for short circuit data exchange according to IEC 60909.
- r0
Zero sequence resistance of the synchronous machine.
- r2
Negative sequence resistance.
- referencePriority
Priority of unit for use as powerflow voltage phase angle reference bus selection. 0 = don t care (default) 1 = highest priority. 2 is less than 1 and so on.
- satDirectSubtransX
Direct-axis subtransient reactance saturated, also known as Xd"sat.
- satDirectSyncX
Direct-axes saturated synchronous reactance (xdsat); reciprocal of short-circuit ration. Used for short circuit data exchange, only for single fed short circuit on a generator. (4.3.4.2. in IEC 60909-0:2001).
- satDirectTransX
Saturated Direct-axis transient reactance. The attribute is primarily used for short circuit calculations according to ANSI.
- shortCircuitRotorType
Type of rotor, used by short circuit applications, only for single fed short circuit according to IEC 60909.
- type
Modes that this synchronous machine can operate in.
- voltageRegulationRange
Range of generator voltage regulation (PG in IEC 60909-0) used for calculation of the impedance correction factor KG defined in IEC 60909-0. This attribute is used to describe the operating voltage of the generating unit.
- x0
Zero sequence reactance of the synchronous machine.
- x2
Negative sequence reactance.
- InitialReactiveCapabilityCurve
ReactiveCapabilityCurve The default reactive capability curve for use by a synchronous machine.
- PrimeMovers
PrimeMover Prime movers that drive this SynchronousMachine.
- ReactiveCapabilityCurves
ReactiveCapabilityCurve All available reactive capability curves for this synchronous machine.
- SynchronousMachineDynamics
SynchronousMachineDynamics Synchronous machine dynamics model used to describe dynamic behaviour of this synchronous machine.
-
final
case class
SynchronousMachineDetailed(SynchronousMachineDynamics: SynchronousMachineDynamics = null, efdBaseRatio: Double = 0.0, ifdBaseType: String = null, saturationFactor120QAxis: Double = 0.0, saturationFactorQAxis: Double = 0.0) extends Element with Product with Serializable
All synchronous machine detailed types use a subset of the same data parameters and input/output variables.
All synchronous machine detailed types use a subset of the same data parameters and input/output variables.
The several variations differ in the following ways: - the number of equivalent windings that are included; - the way in which saturation is incorporated into the model; - whether or not “subtransient saliency” (X''q not = X''d) is represented. It is not necessary for each simulation tool to have separate models for each of the model types. The same model can often be used for several types by alternative logic within the model. Also, differences in saturation representation might not result in significant model performance differences so model substitutions are often acceptable.
- SynchronousMachineDynamics
SynchronousMachineDynamics Reference to the superclass object.
- efdBaseRatio
Ratio (exciter voltage/generator voltage) of Efd bases of exciter and generator models (> 0). Typical value = 1.
- ifdBaseType
Excitation base system mode. It should be equal to the value of WLMDV given by the user. WLMDV is the PU ratio between the field voltage and the excitation current: Efd = WLMDV x Ifd. Typical value = ifag.
- saturationFactor120QAxis
Quadrature-axis saturation factor at 120% of rated terminal voltage (S12q) (>= SynchonousMachineDetailed.saturationFactorQAxis). Typical value = 0,12.
- saturationFactorQAxis
Quadrature-axis saturation factor at rated terminal voltage (S1q) (>= 0). Typical value = 0,02.
-
final
case class
SynchronousMachineDynamics(RotatingMachineDynamics: RotatingMachineDynamics = null, CrossCompoundTurbineGovernorDyanmics: String = null, CrossCompoundTurbineGovernorDynamics: String = null, ExcitationSystemDynamics: String = null, GenICompensationForGenJ: List[String] = null, MechanicalLoadDynamics: String = null, SynchronousMachine: String = null, TurbineGovernorDynamics: List[String] = null) extends Element with Product with Serializable
Synchronous machine whose behaviour is described by reference to a standard model expressed in one of the following forms: - simplified (or classical), where a group of generators or motors is not modelled in detail; - detailed, in equivalent circuit form; - detailed, in time constant reactance form; or <font color="#0f0f0f">- by definition of a user-defined model.</font> <font color="#0f0f0f">It is a common practice to represent small generators by a negative load rather than by a dynamic generator model when performing dynamics simulations.
Synchronous machine whose behaviour is described by reference to a standard model expressed in one of the following forms: - simplified (or classical), where a group of generators or motors is not modelled in detail; - detailed, in equivalent circuit form; - detailed, in time constant reactance form; or <font color="#0f0f0f">- by definition of a user-defined model.</font> <font color="#0f0f0f">It is a common practice to represent small generators by a negative load rather than by a dynamic generator model when performing dynamics simulations.
In this case, a SynchronousMachine in the static model is not represented by anything in the dynamics model, instead it is treated as an ordinary load.</font> <font color="#0f0f0f">Parameter details:</font>
- <font color="#0f0f0f">Synchronous machine parameters such as Xl, Xd, Xp etc. are actually used as inductances in the models,</font> but are commonly referred to as reactances since, at nominal frequency, the PU values are the same. However, some references use the symbol L instead of X.
- RotatingMachineDynamics
RotatingMachineDynamics Reference to the superclass object.
- CrossCompoundTurbineGovernorDyanmics
CrossCompoundTurbineGovernorDynamics The cross-compound turbine governor with which this high-pressure synchronous machine is associated.
- CrossCompoundTurbineGovernorDynamics
CrossCompoundTurbineGovernorDynamics The cross-compound turbine governor with which this low-pressure synchronous machine is associated.
- ExcitationSystemDynamics
ExcitationSystemDynamics Excitation system model associated with this synchronous machine model.
- GenICompensationForGenJ
GenICompensationForGenJ Compensation of voltage compensator's generator for current flow out of this generator.
- MechanicalLoadDynamics
MechanicalLoadDynamics Mechanical load model associated with this synchronous machine model.
- SynchronousMachine
SynchronousMachine Synchronous machine to which synchronous machine dynamics model applies.
- TurbineGovernorDynamics
TurbineGovernorDynamics Turbine-governor model associated with this synchronous machine model. Multiplicity of greater than one is intended to support hydro units that have multiple turbines on one generator.
-
final
case class
SynchronousMachineEquivalentCircuit(SynchronousMachineDetailed: SynchronousMachineDetailed = null, r1d: Double = 0.0, r1q: Double = 0.0, r2q: Double = 0.0, rfd: Double = 0.0, x1d: Double = 0.0, x1q: Double = 0.0, x2q: Double = 0.0, xad: Double = 0.0, xaq: Double = 0.0, xf1d: Double = 0.0, xfd: Double = 0.0) extends Element with Product with Serializable
The electrical equations for all variations of the synchronous models are based on the SynchronousEquivalentCircuit diagram for the direct- and quadrature- axes.
The electrical equations for all variations of the synchronous models are based on the SynchronousEquivalentCircuit diagram for the direct- and quadrature- axes.
Equations for conversion between equivalent circuit and time constant reactance forms: Xd = Xad + Xl X’d = Xl + Xad x Xfd / (Xad + Xfd) X”d = Xl + Xad x Xfd x X1d / (Xad x Xfd + Xad x X1d + Xfd x X1d) Xq = Xaq + Xl X’q = Xl + Xaq x X1q / (Xaq + X1q) X”q = Xl + Xaq x X1q x X2q / (Xaq x X1q + Xaq x X2q + X1q x X2q) T’do = (Xad + Xfd) / (omega0 x Rfd) T”do = (Xad x Xfd + Xad x X1d + Xfd x X1d) / (omega0 x R1d x (Xad + Xfd) T’qo = (Xaq + X1q) / (omega0 x R1q) T”qo = (Xaq x X1q + Xaq x X2q + X1q x X2q) / (omega0 x R2q x (Xaq + X1q) Same equations using CIM attributes from SynchronousMachineTimeConstantReactance class on left of "=" and SynchronousMachineEquivalentCircuit class on right (except as noted): xDirectSync = xad + RotatingMachineDynamics.statorLeakageReactance xDirectTrans = RotatingMachineDynamics.statorLeakageReactance + xad x xfd / (xad + xfd) xDirectSubtrans = RotatingMachineDynamics.statorLeakageReactance + xad x xfd x x1d / (xad x xfd + xad x x1d + xfd x x1d) xQuadSync = xaq + RotatingMachineDynamics.statorLeakageReactance xQuadTrans = RotatingMachineDynamics.statorLeakageReactance + xaq x x1q / (xaq+ x1q) xQuadSubtrans = RotatingMachineDynamics.statorLeakageReactance + xaq x x1q x x2q / (xaq x x1q + xaq x x2q + x1q x x2q) tpdo = (xad + xfd) / (2 x pi x nominal frequency x rfd) tppdo = (xad x xfd + xad x x1d + xfd x x1d) / (2 x pi x nominal frequency x r1d x (xad + xfd) tpqo = (xaq + x1q) / (2 x pi x nominal frequency x r1q) tppqo = (xaq x x1q + xaq x x2q + x1q x x2q) / (2 x pi x nominal frequency x r2q x (xaq + x1q) These are only valid for a simplified model where "Canay" reactance is zero.
- SynchronousMachineDetailed
SynchronousMachineDetailed Reference to the superclass object.
- r1d
Direct-axis damper 1 winding resistance.
- r1q
Quadrature-axis damper 1 winding resistance.
- r2q
Quadrature-axis damper 2 winding resistance.
- rfd
Field winding resistance.
- x1d
Direct-axis damper 1 winding leakage reactance.
- x1q
Quadrature-axis damper 1 winding leakage reactance.
- x2q
Quadrature-axis damper 2 winding leakage reactance.
- xad
Direct-axis mutual reactance.
- xaq
Quadrature-axis mutual reactance.
- xf1d
Differential mutual (“Canay”) reactance.
- xfd
Field winding leakage reactance.
-
final
case class
SynchronousMachineSimplified(SynchronousMachineDynamics: SynchronousMachineDynamics = null) extends Element with Product with Serializable
The simplified model represents a synchronous generator as a constant internal voltage behind an impedance (Rs + jXp) as shown in the Simplified diagram.
The simplified model represents a synchronous generator as a constant internal voltage behind an impedance (Rs + jXp) as shown in the Simplified diagram.
Since internal voltage is held constant, there is no Efd input and any excitation system model will be ignored. There is also no Ifd output. This model should not be used for representing a real generator except, perhaps, small generators whose response is insignificant. The parameters used for the simplified model include: - RotatingMachineDynamics.damping (D); - RotatingMachineDynamics.inertia (H); - RotatingMachineDynamics.statorLeakageReactance (used to exchange jXp for SynchronousMachineSimplified); - RotatingMachineDynamics.statorResistance (Rs).
- SynchronousMachineDynamics
SynchronousMachineDynamics Reference to the superclass object.
-
final
case class
SynchronousMachineTimeConstantReactance(SynchronousMachineDetailed: SynchronousMachineDetailed = null, ks: Double = 0.0, modelType: String = null, rotorType: String = null, tc: Double = 0.0, tpdo: Double = 0.0, tppdo: Double = 0.0, tppqo: Double = 0.0, tpqo: Double = 0.0, xDirectSubtrans: Double = 0.0, xDirectSync: Double = 0.0, xDirectTrans: Double = 0.0, xQuadSubtrans: Double = 0.0, xQuadSync: Double = 0.0, xQuadTrans: Double = 0.0) extends Element with Product with Serializable
Synchronous machine detailed modelling types are defined by the combination of the attributes SynchronousMachineTimeConstantReactance.modelType and SynchronousMachineTimeConstantReactance.rotorType.
Synchronous machine detailed modelling types are defined by the combination of the attributes SynchronousMachineTimeConstantReactance.modelType and SynchronousMachineTimeConstantReactance.rotorType.
Parameter details:
- The “p” in the time-related attribute names is a substitution for a “prime” in the usual parameter notation, e.g. tpdo refers to T'do.
- The parameters used for models expressed in time constant reactance form include:
- RotatingMachine.ratedS (MVAbase); - RotatingMachineDynamics.damping (D); - RotatingMachineDynamics.inertia (H); - RotatingMachineDynamics.saturationFactor (S1); - RotatingMachineDynamics.saturationFactor120 (S12); - RotatingMachineDynamics.statorLeakageReactance (Xl); - RotatingMachineDynamics.statorResistance (Rs); - SynchronousMachineTimeConstantReactance.ks (Ks); - SynchronousMachineDetailed.saturationFactorQAxis (S1q); - SynchronousMachineDetailed.saturationFactor120QAxis (S12q); - SynchronousMachineDetailed.efdBaseRatio; - SynchronousMachineDetailed.ifdBaseType; - .xDirectSync (Xd); - .xDirectTrans (X'd); - .xDirectSubtrans (X''d); - .xQuadSync (Xq); - .xQuadTrans (X'q); - .xQuadSubtrans (X''q); - .tpdo (T'do); - .tppdo (T''do); - .tpqo (T'qo); - .tppqo (T''qo); - .tc.
- SynchronousMachineDetailed
SynchronousMachineDetailed Reference to the superclass object.
- ks
Saturation loading correction factor (Ks) (>= 0). Used only by type J model. Typical value = 0.
- modelType
Type of synchronous machine model used in dynamic simulation applications.
- rotorType
Type of rotor on physical machine.
- tc
Damping time constant for “Canay” reactance (>= 0). Typical value = 0.
- tpdo
Direct-axis transient rotor time constant (T'do) (> SynchronousMachineTimeConstantReactance.tppdo). Typical value = 5.
- tppdo
Direct-axis subtransient rotor time constant (T''do) (> 0). Typical value = 0,03.
- tppqo
Quadrature-axis subtransient rotor time constant (T''qo) (> 0). Typical value = 0,03.
- tpqo
Quadrature-axis transient rotor time constant (T'qo) (> SynchronousMachineTimeConstantReactance.tppqo). Typical value = 0,5.
- xDirectSubtrans
Direct-axis subtransient reactance (unsaturated) (X''d) (> RotatingMachineDynamics.statorLeakageReactance). Typical value = 0,2.
- xDirectSync
Direct-axis synchronous reactance (Xd) (>= SynchronousMachineTimeConstantReactance.xDirectTrans). The quotient of a sustained value of that AC component of armature voltage that is produced by the total direct-axis flux due to direct-axis armature current and the value of the AC component of this current, the machine running at rated speed. Typical value = 1,8.
- xDirectTrans
Direct-axis transient reactance (unsaturated) (X'd) (>= SynchronousMachineTimeConstantReactance.xDirectSubtrans). Typical value = 0,5.
- xQuadSubtrans
Quadrature-axis subtransient reactance (X''q) (> RotatingMachineDynamics.statorLeakageReactance). Typical value = 0,2.
- xQuadSync
Quadrature-axis synchronous reactance (Xq) (>= SynchronousMachineTimeConstantReactance.xQuadTrans). The ratio of the component of reactive armature voltage, due to the quadrature-axis component of armature current, to this component of current, under steady state conditions and at rated frequency. Typical value = 1,6.
- xQuadTrans
Quadrature-axis transient reactance (X'q) (>= SynchronousMachineTimeConstantReactance.xQuadSubtrans). Typical value = 0,3.
-
final
case class
SynchronousMachineUserDefined(SynchronousMachineDynamics: SynchronousMachineDynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Synchronous machine whose dynamic behaviour is described by a user-defined model.
Synchronous machine whose dynamic behaviour is described by a user-defined model.
- SynchronousMachineDynamics
SynchronousMachineDynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
SysLoadDistributionFactor(Element: BasicElement = null, factor: Double = 0.0, DistributionFactorSet: List[String] = null, HostControlArea: String = null, MktConnectivityNode: String = null) extends Element with Product with Serializable
This class models the system distribution factors.
This class models the system distribution factors.
This class needs to be used along with the HostControlArea and the ConnectivityNode to show the distribution of each individual party.
- Element
Reference to the superclass object.
- factor
Used to calculate load "participation" of a connectivity node in an host control area
- DistributionFactorSet
DistributionFactorSet undocumented
- HostControlArea
HostControlArea undocumented
- MktConnectivityNode
MktConnectivityNode undocumented
-
final
case class
TACArea(IdentifiedObject: IdentifiedObject = null, AggregatedPnode: List[String] = null, AreaLoadCurve: List[String] = null) extends Element with Product with Serializable
Transmission Access Charge Area.
Transmission Access Charge Area.
Charges assessed, on behalf of the Participating Transmission Owner, to parties who require access to the controlled grid.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- AggregatedPnode
AggregatedPnode undocumented
- AreaLoadCurve
AreaLoadCurve undocumented
-
final
case class
TAPPIStandard(Element: BasicElement = null, standardEdition: String = null, standardNumber: String = null) extends Element with Product with Serializable
Standard published by TAPPI.
Standard published by TAPPI.
- Element
Reference to the superclass object.
- standardEdition
Edition of TAPPI standard.
- standardNumber
TAPPI standard number.
-
final
case class
TASE2BilateralTable(BilateralExchangeAgreement: BilateralExchangeAgreement = null, bilateralTableID: String = null, bilateralTableVersion: String = null, tase2version: String = null, ICCPInformationMessage: List[String] = null) extends Element with Product with Serializable
This class describe the sending (providing) side in a bilateral ICCP data exchange.
This class describe the sending (providing) side in a bilateral ICCP data exchange.
Hence the ICCP bilateral (table) descriptions are created by exchanging ICCP Provider data between the parties.
- BilateralExchangeAgreement
BilateralExchangeAgreement Reference to the superclass object.
- bilateralTableID
Specifies the version of the Bilateral Table configuration that is being exchanged.
- bilateralTableVersion
The Version attribute identifies a unique version of the Bilateral Table. If any changes are made to a Bilateral Table, then a new unique value for this attribute shall be generated.
- tase2version
Specifies the version of the TASE.2 that is needed to access the Bilateral Table information via TASE.2. In order for a link to be established, both sides must have the same value.
- ICCPInformationMessage
ICCPInformationMessage Informational message to be included in a Bilateral Table agreement.
-
final
case class
TCPAccessPoint(IPAccessPoint: IPAccessPoint = null, keepAliveTime: Int = 0, port: Int = 0, PublicX509Certificate: List[String] = null) extends Element with Product with Serializable
Allows addressing and behavioural information regarding the use of TCP by ICCP links.
Allows addressing and behavioural information regarding the use of TCP by ICCP links.
- IPAccessPoint
IPAccessPoint Reference to the superclass object.
- keepAliveTime
Indicates the default interval at which TCP will check if the TCP connection is still valid.
- port
This value is only needed to be specified for called nodes (e.g. those that respond to a TCP. Open request). This value specifies the TCP port to be used. Well known and "registered" ports are preferred and can be found at: http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml For IEC 60870-6 TASE.2 (e.g. ICCP) and IEC 61850, the value used shall be 102 for non-TLS protected exchanges. The value shall be 3782 for TLS transported ICCP and 61850 exchanges.
- PublicX509Certificate
PublicX509Certificate Is the Public Certificate used for mutual authentication between peers.
-
final
case class
TREntitlement(Element: BasicElement = null, entitlement: Double = 0.0, startOperatingDate: String = null, TransmissionContractRight: String = null) extends Element with Product with Serializable
A Transmission Right(TR) can be a chain of TR's or on individual.
A Transmission Right(TR) can be a chain of TR's or on individual.
When a transmission right is not a chain, this is formally the ETC/TOR Entitlement for each ETC/TOR contract with the inclusion of CVR(Converted Rights) as an ETC. This is the sum of all entitlements on all related transmission interfaces for the same TR.
When TR is a chain, its entitlement is the minimum of all entitlements for the individual TRs in the chain.
- Element
Reference to the superclass object.
- entitlement
The entitlement
- startOperatingDate
Operating date and hour when the entitlement applies
- TransmissionContractRight
ContractRight undocumented
-
final
case class
TagAction(SwitchingAction: SwitchingAction = null, kind: String = null, OperationalTag: String = null) extends Element with Product with Serializable
Action on operation tag as a switching step.
Action on operation tag as a switching step.
- SwitchingAction
SwitchingAction Reference to the superclass object.
- kind
Kind of tag action.
- OperationalTag
OperationalTag Tag associated with this tag action.
-
final
case class
TailbayLossCurve(Curve: Curve = null, HydroGeneratingUnit: String = null) extends Element with Product with Serializable
Relationship between tailbay head loss height (Y-axis) and the total discharge into the power station's tailbay volume per time unit (X-axis) .
Relationship between tailbay head loss height (Y-axis) and the total discharge into the power station's tailbay volume per time unit (X-axis) .
There could be more than one curve depending on the level of the tailbay reservoir or river level.
- Curve
Curve Reference to the superclass object.
- HydroGeneratingUnit
HydroGeneratingUnit A hydro generating unit has a tailbay loss curve.
-
final
case class
TapChanger(PowerSystemResource: PowerSystemResource = null, controlEnabled: Boolean = false, highStep: Int = 0, initialDelay: Double = 0.0, lowStep: Int = 0, ltcFlag: Boolean = false, neutralStep: Int = 0, neutralU: Double = 0.0, normalStep: Int = 0, step: Double = 0.0, subsequentDelay: Double = 0.0, SvTapStep: String = null, TapChangerControl: String = null, TapSchedules: List[String] = null) extends Element with Product with Serializable
Mechanism for changing transformer winding tap positions.
Mechanism for changing transformer winding tap positions.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- controlEnabled
Specifies the regulation status of the equipment. True is regulating, false is not regulating.
- highStep
Highest possible tap step position, advance from neutral. The attribute shall be greater than lowStep.
- initialDelay
For an LTC, the delay for initial tap changer operation (first step change).
- lowStep
Lowest possible tap step position, retard from neutral.
- ltcFlag
Specifies whether or not a TapChanger has load tap changing capabilities.
- neutralStep
The neutral tap step position for this winding. The attribute shall be equal to or greater than lowStep and equal or less than highStep. It is the step position where the voltage is neutralU when the other terminals of the transformer are at the ratedU. If there are other tap changers on the transformer those taps are kept constant at their neutralStep.
- neutralU
Voltage at which the winding operates at the neutral tap setting. It is the voltage at the terminal of the PowerTransformerEnd associated with the tap changer when all tap changers on the transformer are at their neutralStep position. Normally neutralU of the tap changer is the same as ratedU of the PowerTransformerEnd, but it can differ in special cases such as when the tapping mechanism is separate from the winding more common on lower voltage transformers. This attribute is not relevant for PhaseTapChangerAsymmetrical, PhaseTapChangerSymmetrical and PhaseTapChangerLinear.
- normalStep
The tap step position used in "normal" network operation for this winding. For a "Fixed" tap changer indicates the current physical tap setting. The attribute shall be equal to or greater than lowStep and equal to or less than highStep.
- step
Tap changer position. Starting step for a steady state solution. Non integer values are allowed to support continuous tap variables. The reasons for continuous value are to support study cases where no discrete tap changer has yet been designed, a solution where a narrow voltage band forces the tap step to oscillate or to accommodate for a continuous solution as input. The attribute shall be equal to or greater than lowStep and equal to or less than highStep.
- subsequentDelay
For an LTC, the delay for subsequent tap changer operation (second and later step changes).
- SvTapStep
SvTapStep The tap step state associated with the tap changer.
- TapChangerControl
TapChangerControl The regulating control scheme in which this tap changer participates.
- TapSchedules
TapSchedule A TapChanger can have TapSchedules.
-
final
case class
TapChangerControl(RegulatingControl: RegulatingControl = null, limitVoltage: Double = 0.0, lineDropCompensation: Boolean = false, lineDropR: Double = 0.0, lineDropX: Double = 0.0, reverseLineDropR: Double = 0.0, reverseLineDropX: Double = 0.0, TapChanger: List[String] = null) extends Element with Product with Serializable
Describes behaviour specific to tap changers, e.g.
Describes behaviour specific to tap changers, e.g. how the voltage at the end of a line varies with the load level and compensation of the voltage drop by tap adjustment.
- RegulatingControl
RegulatingControl Reference to the superclass object.
- limitVoltage
Maximum allowed regulated voltage on the PT secondary, regardless of line drop compensation. Sometimes referred to as first-house protection.
- lineDropCompensation
If true, the line drop compensation is to be applied.
- lineDropR
Line drop compensator resistance setting for normal (forward) power flow.
- lineDropX
Line drop compensator reactance setting for normal (forward) power flow.
- reverseLineDropR
Line drop compensator resistance setting for reverse power flow.
- reverseLineDropX
Line drop compensator reactance setting for reverse power flow.
- TapChanger
TapChanger The tap changers that participates in this regulating tap control scheme.
-
final
case class
TapChangerDynamicData(Element: BasicElement = null, angleRegulationStatus: Boolean = false, desiredMW: Double = 0.0, desiredVoltage: Double = 0.0, maximumAngle: Double = 0.0, minimumAngle: Double = 0.0, solvedAngle: Double = 0.0, tapPosition: Double = 0.0, voltageRegulationStatus: Boolean = false, MktTapChanger: String = null) extends Element with Product with Serializable
Optimal Power Flow or State Estimator Phase Shifter Data.
Optimal Power Flow or State Estimator Phase Shifter Data.
This is used for RealTime, Study and Maintenance Users. SE Solution Phase Shifter Measurements from the last run of SE.
- Element
Reference to the superclass object.
- angleRegulationStatus
True means the phase shifter is regulating.
- desiredMW
Phase Shifter Desired MW. The active power regulation setpoint of the phase shifter
- desiredVoltage
The desired voltage for the LTC
- maximumAngle
The maximum phase angle shift of the phase shifter
- minimumAngle
The minimum phase angle shift of the phase shifter
- solvedAngle
Phase Shifter Angle. The solved phase angle shift of the phase shifter
- tapPosition
Tap position of the phase shifter, high-side tap position of the transformer, or low-side tap position of the transformer
- voltageRegulationStatus
Indicator if the LTC transformer is regulating True = Yes, False = No
- MktTapChanger
MktTapChanger undocumented
-
final
case class
TapChangerInfo(AssetInfo: AssetInfo = null, bil: Double = 0.0, ctRating: Double = 0.0, ctRatio: Double = 0.0, frequency: Double = 0.0, highStep: Int = 0, isTcul: Boolean = false, lowStep: Int = 0, neutralStep: Int = 0, neutralU: Double = 0.0, ptRatio: Double = 0.0, ratedApparentPower: Double = 0.0, ratedCurrent: Double = 0.0, ratedVoltage: Double = 0.0, stepPhaseIncrement: Double = 0.0, stepVoltageIncrement: Double = 0.0) extends Element with Product with Serializable
Tap changer data.
Tap changer data.
- AssetInfo
AssetInfo Reference to the superclass object.
- bil
Basic Insulation Level (BIL) expressed as the impulse crest voltage of a nominal wave, typically 1.2 X 50 microsecond. This is a measure of the ability of the insulation to withstand very high voltage surges.
- ctRating
Built-in current transformer primary rating.
- ctRatio
Built-in current transducer ratio.
- frequency
Frequency at which the ratings apply.
- highStep
Highest possible tap step position, advance from neutral.
- isTcul
Whether this tap changer has under load tap changing capabilities.
- lowStep
Lowest possible tap step position, retard from neutral.
- neutralStep
The neutral tap step position for the winding.
- neutralU
Voltage at which the winding operates at the neutral tap setting.
- ptRatio
Built-in voltage transducer ratio.
- ratedApparentPower
Rated apparent power.
- ratedCurrent
Rated current.
- ratedVoltage
Rated voltage.
- stepPhaseIncrement
Phase shift per step position.
- stepVoltageIncrement
Tap step increment, in per cent of rated voltage, per step position.
-
final
case class
TapChangerTablePoint(Element: BasicElement = null, b: Double = 0.0, g: Double = 0.0, r: Double = 0.0, ratio: Double = 0.0, step: Int = 0, x: Double = 0.0) extends Element with Product with Serializable
Describes each tap step in the tabular curve.
Describes each tap step in the tabular curve.
- Element
Reference to the superclass object.
- b
The magnetizing branch susceptance deviation as a percentage of nominal value. The actual susceptance is calculated as follows: calculated magnetizing susceptance = b(nominal) * (1 + b(from this class)/100). The b(nominal) is defined as the static magnetizing susceptance on the associated power transformer end or ends. This model assumes the star impedance (pi model) form.
- g
The magnetizing branch conductance deviation as a percentage of nominal value. The actual conductance is calculated as follows: calculated magnetizing conductance = g(nominal) * (1 + g(from this class)/100). The g(nominal) is defined as the static magnetizing conductance on the associated power transformer end or ends. This model assumes the star impedance (pi model) form.
- r
The resistance deviation as a percentage of nominal value. The actual reactance is calculated as follows: calculated resistance = r(nominal) * (1 + r(from this class)/100). The r(nominal) is defined as the static resistance on the associated power transformer end or ends. This model assumes the star impedance (pi model) form.
- ratio
The voltage at the tap step divided by rated voltage of the transformer end having the tap changer. Hence this is a value close to one. For example, if the ratio at step 1 is 1.01, and the rated voltage of the transformer end is 110kV, then the voltage obtained by setting the tap changer to step 1 to is 111.1kV.
- step
The tap step.
- x
The series reactance deviation as a percentage of nominal value. The actual reactance is calculated as follows: calculated reactance = x(nominal) * (1 + x(from this class)/100). The x(nominal) is defined as the static series reactance on the associated power transformer end or ends. This model assumes the star impedance (pi model) form.
-
final
case class
TapSchedule(SeasonDayTypeSchedule: SeasonDayTypeSchedule = null, TapChanger: String = null) extends Element with Product with Serializable
A pre-established pattern over time for a tap step.
A pre-established pattern over time for a tap step.
- SeasonDayTypeSchedule
SeasonDayTypeSchedule Reference to the superclass object.
- TapChanger
TapChanger A TapSchedule is associated with a TapChanger.
-
final
case class
TapeShieldCableInfo(CableInfo: CableInfo = null, tapeLap: Double = 0.0, tapeThickness: Double = 0.0) extends Element with Product with Serializable
Tape shield cable data.
Tape shield cable data.
- CableInfo
CableInfo Reference to the superclass object.
- tapeLap
Percentage of the tape shield width that overlaps in each wrap, typically 10% to 25%.
- tapeThickness
Thickness of the tape shield, before wrapping.
-
final
case class
TargetLevelSchedule(Curve: Curve = null, highLevelLimit: Double = 0.0, lowLevelLimit: Double = 0.0, Reservoir: String = null) extends Element with Product with Serializable
Reservoir water level targets from advanced studies or "rule curves".
Reservoir water level targets from advanced studies or "rule curves".
Typically in one hour increments for up to 10 days.
- Curve
Curve Reference to the superclass object.
- highLevelLimit
High target level limit, above which the reservoir operation will be penalized.
- lowLevelLimit
Low target level limit, below which the reservoir operation will be penalized.
- Reservoir
Reservoir A reservoir may have a water level target schedule.
-
final
case class
Tariff(Document: Document = null, endDate: String = null, startDate: String = null, PricingStructures: List[String] = null, TariffProfiles: List[String] = null) extends Element with Product with Serializable
Document, approved by the responsible regulatory agency, listing the terms and conditions, including a schedule of prices, under which utility services will be provided.
Document, approved by the responsible regulatory agency, listing the terms and conditions, including a schedule of prices, under which utility services will be provided.
It has a unique number within the state or province. For rate schedules it is frequently allocated by the affiliated Public utilities commission (PUC).
- Document
Document Reference to the superclass object.
- endDate
(if tariff became inactive) Date tariff was terminated.
- startDate
Date tariff was activated.
- PricingStructures
PricingStructure All pricing structures using this tariff.
- TariffProfiles
TariffProfile All tariff profiles using this tariff.
-
final
case class
TariffProfile(Document: Document = null, tariffCycle: String = null, ConsumptionTariffIntervals: List[String] = null, Tariffs: List[String] = null, TimeTariffIntervals: List[String] = null) extends Element with Product with Serializable
A schedule of charges; structure associated with Tariff that allows the definition of complex tarif structures such as step and time of use when used in conjunction with TimeTariffInterval and Charge.
A schedule of charges; structure associated with Tariff that allows the definition of complex tarif structures such as step and time of use when used in conjunction with TimeTariffInterval and Charge.
Inherited 'status.value' is defined in the context of the utility's business rules, for example: active, inactive, etc.
- Document
Document Reference to the superclass object.
- tariffCycle
The frequency at which the tariff charge schedule is repeated. Examples are: once off on a specified date and time; hourly; daily; weekly; monthly; 3-monthly; 6-monthly; 12-monthly; etc. At the end of each cycle, the business rules are reset to start from the beginning again.
- ConsumptionTariffIntervals
ConsumptionTariffInterval All consumption tariff intervals used to define this tariff profile.
- Tariffs
Tariff All tariffs defined by this tariff profile.
- TimeTariffIntervals
TimeTariffInterval All time tariff intervals used to define this tariff profile.
-
final
case class
TelephoneNumber(Element: BasicElement = null, areaCode: String = null, cityCode: String = null, countryCode: String = null, dialOut: String = null, extension: String = null, internationalPrefix: String = null, ituPhone: String = null, localNumber: String = null) extends Element with Product with Serializable
Telephone number.
Telephone number.
- Element
Reference to the superclass object.
- areaCode
(if applicable) Area or region code.
- cityCode
City code.
- countryCode
Country code.
- dialOut
(if applicable) Dial out code, for instance to call outside an enterprise.
- extension
(if applicable) Extension for this telephone number.
- internationalPrefix
(if applicable) Prefix used when calling an international number.
- ituPhone
Phone number according to ITU E.164.
- localNumber
Main (local) part of this telephone number.
-
final
case class
TemperatureDependentLimitPoint(Element: BasicElement = null, limitPercent: Double = 0.0, temperature: Double = 0.0, TemperatureDependentLimitTable: String = null) extends Element with Product with Serializable
A point on a table of limit verses temperature.
A point on a table of limit verses temperature.
- Element
Reference to the superclass object.
- limitPercent
The scaling of the operational limit in percent.
- temperature
The temperature of the table point.
- TemperatureDependentLimitTable
TemperatureDependentLimitTable undocumented
-
final
case class
TemperatureDependentLimitTable(EnvironmentalDependentLimit: EnvironmentalDependentLimit = null, TemperatureLimitTablePoint: List[String] = null) extends Element with Product with Serializable
This is a table lookup that provides limit values corresponding to a temperature input.
This is a table lookup that provides limit values corresponding to a temperature input.
- EnvironmentalDependentLimit
EnvironmentalDependentLimit Reference to the superclass object.
- TemperatureLimitTablePoint
TemperatureDependentLimitPoint undocumented
-
final
case class
TemperaturePolynomialLimit(EnvironmentalDependentLimit: EnvironmentalDependentLimit = null, coefficient0: Double = 0.0, coefficient1: Double = 0.0, coefficient2: Double = 0.0, coefficient3: Double = 0.0, coefficient4: Double = 0.0) extends Element with Product with Serializable
This describes the coefficients of a polynomial function that has temperature as input and calculates limit values as output.
This describes the coefficients of a polynomial function that has temperature as input and calculates limit values as output.
- EnvironmentalDependentLimit
EnvironmentalDependentLimit Reference to the superclass object.
- coefficient0
The polinomial coefficent of power 0.
- coefficient1
The polinomial coefficent of power 1.
- coefficient2
The polinomial coefficent of power 2.
- coefficient3
The polinomial coefficent of power 3.
- coefficient4
The polinomial coefficent of power 4.
-
final
case class
TenMinAuxiliaryData(Element: BasicElement = null, intervalStartTime: String = null, updateTimeStamp: String = null, updateUser: String = null, AuxillaryData: List[String] = null) extends Element with Product with Serializable
Models 10-Minutes Auxiliary Data.
Models 10-Minutes Auxiliary Data.
- Element
Reference to the superclass object.
- intervalStartTime
undocumented
- updateTimeStamp
undocumented
- updateUser
undocumented
- AuxillaryData
AuxiliaryValues undocumented
-
final
case class
Tender(IdentifiedObject: IdentifiedObject = null, amount: Double = 0.0, change: Double = 0.0, kind: String = null, Card: String = null, Cheque: String = null, Receipt: String = null) extends Element with Product with Serializable
Tender is what is "offered" by the customer towards making a payment and is often more than the required payment (hence the need for 'change').
Tender is what is "offered" by the customer towards making a payment and is often more than the required payment (hence the need for 'change').
The payment is thus that part of the Tender that goes towards settlement of a particular transaction. Tender is modelled as an aggregation of Cheque and Card. Both these tender types can exist in a single tender bid thus 'accountHolderName' has to exist separately in each of Cheque and Card as each could have a different account holder name.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- amount
Amount tendered by customer.
- change
Difference between amount tendered by customer and the amount charged by point of sale.
- kind
Kind of tender from customer.
- Card
Card Card used to tender payment.
- Cheque
Cheque Cheque used to tender payment.
- Receipt
Receipt Receipt that recorded this receiving of a payment in the form of tenders.
-
final
case class
Terminal(ACDCTerminal: ACDCTerminal = null, phases: String = null, AuxiliaryEquipment: List[String] = null, BranchGroupTerminal: List[String] = null, Bushing: String = null, Circuit: String = null, ConductingEquipment: String = null, ConnectivityNode: String = null, ConverterDCSides: List[String] = null, EquipmentFaults: List[String] = null, HasFirstMutualCoupling: List[String] = null, HasSecondMutualCoupling: List[String] = null, NormalHeadFeeder: String = null, PinTerminal: List[String] = null, RegulatingControl: List[String] = null, RemoteInputSignal: List[String] = null, SvPowerFlow: List[String] = null, TieFlow: List[String] = null, TopologicalNode: String = null, TransformerEnd: List[String] = null) extends Element with Product with Serializable
An AC electrical connection point to a piece of conducting equipment.
An AC electrical connection point to a piece of conducting equipment.
Terminals are connected at physical connection points called connectivity nodes.
- ACDCTerminal
ACDCTerminal Reference to the superclass object.
- phases
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, GroundSwitch, 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.
- AuxiliaryEquipment
AuxiliaryEquipment The auxiliary equipment connected to the terminal.
- BranchGroupTerminal
BranchGroupTerminal The directed branch group terminals for which this terminal is monitored.
- Bushing
Bushing undocumented
- Circuit
Circuit undocumented
- ConductingEquipment
ConductingEquipment The conducting equipment of the terminal. Conducting equipment have terminals that may be connected to other conducting equipment terminals via connectivity nodes or topological nodes.
- ConnectivityNode
ConnectivityNode The connectivity node to which this terminal connects with zero impedance.
- ConverterDCSides
ACDCConverter All converters' DC sides linked to this point of common coupling terminal.
- EquipmentFaults
EquipmentFault The equipment faults at this terminal.
- HasFirstMutualCoupling
MutualCoupling Mutual couplings associated with the branch as the first branch.
- HasSecondMutualCoupling
MutualCoupling Mutual couplings with the branch associated as the first branch.
- NormalHeadFeeder
Feeder The feeder that this terminal normally feeds. Only specified for the terminals at head of feeders.
- PinTerminal
PinTerminal undocumented
- RegulatingControl
RegulatingControl The controls regulating this terminal.
- RemoteInputSignal
RemoteInputSignal Input signal coming from this terminal.
- SvPowerFlow
SvPowerFlow The power flow state variable associated with the terminal.
- TieFlow
TieFlow The control area tie flows to which this terminal associates.
- TopologicalNode
TopologicalNode The topological node associated with the terminal. This can be used as an alternative to the connectivity node path to topological node, thus making it unnecessary to model connectivity nodes in some cases. Note that the if connectivity nodes are in the model, this association would probably not be used as an input specification.
- TransformerEnd
TransformerEnd All transformer ends connected at this terminal.
-
final
case class
TerminalConstraintTerm(ConstraintTerm: ConstraintTerm = null, MktTerminal: String = null) extends Element with Product with Serializable
A constraint term associated with a specific terminal on a physical piece of equipment.
A constraint term associated with a specific terminal on a physical piece of equipment.
- ConstraintTerm
ConstraintTerm Reference to the superclass object.
- MktTerminal
MktTerminal undocumented
-
final
case class
TestDataSet(ProcedureDataSet: ProcedureDataSet = null, conclusion: String = null, specimenID: String = null, specimenToLabDateTime: String = null) extends Element with Product with Serializable
Test results, usually obtained by a lab or other independent organisation.
Test results, usually obtained by a lab or other independent organisation.
- ProcedureDataSet
ProcedureDataSet Reference to the superclass object.
- conclusion
Conclusion drawn from test results.
- specimenID
Identifier of specimen used in inspection or test.
- specimenToLabDateTime
Date and time the specimen was received by the lab.
-
final
case class
TestStandard(IdentifiedObject: IdentifiedObject = null, testMethod: String = null, testStandardASTM: String = null, testStandardCIGRE: String = null, testStandardDIN: String = null, testStandardDoble: String = null, testStandardEPA: String = null, testStandardIEC: String = null, testStandardIEEE: String = null, testStandardISO: String = null, testStandardLaborelec: String = null, testStandardTAPPI: String = null, testStandardUKMinistryOfDefence: String = null, testStandardWEP: String = null, testVariant: String = null, AssetAnalog: List[String] = null, AssetDiscrete: List[String] = null, AssetString: List[String] = null) extends Element with Product with Serializable
The precise standard used in executing a lab test, including the standard, and standard version, test method and variant, if needed.
The precise standard used in executing a lab test, including the standard, and standard version, test method and variant, if needed.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- testMethod
Identification of test method used if multiple methods specified by test standard.
- testStandardASTM
ASTMStandard Which ASTM standard used to determine analog value result. Applies only if ASTM standard used.
- testStandardCIGRE
CIGREStandard Which CIGRE standard used to determine analog value result. Applies only if CIGRE standard used.
- testStandardDIN
DINStandard Which DIN standard used to determine analog value result. Applies only if DIN standard used.
- testStandardDoble
DobleStandard Which Doble standard used to determine analog value result. Applies only if Doble standard used.
- testStandardEPA
EPAStandard Which EPA standard used to determine analog value result. Applies only if EPA standard used.
- testStandardIEC
IECStandard Which IEC standard used to determine analog value result. Applies only if IEC standard used.
- testStandardIEEE
IEEEStandard Which IEEE standard used to determine analog value result. Applies only if IEEE standard used.
- testStandardISO
ISOStandard Which ISO standard used to determine analog value result. Applies only if ISO standard used.
- testStandardLaborelec
LaborelecStandard Which Laborelec standard used to determine analog value result. Applies only if Laborelec standard used.
- testStandardTAPPI
TAPPIStandard Which TAPPI standard used to determine analog value result. Applies only if TAPPI standard used.
- testStandardUKMinistryOfDefence
UKMinistryOfDefenceStandard Which UK Ministry of Defence standard used to determine analog value result. Applies only if UK Ministry of Defence standard used.
- testStandardWEP
WEPStandard Which WEP standard used to determine analog value result. Applies only if WEP standard used.
- testVariant
Identification of variant of test method or standard if one is specified by the standard.
- AssetAnalog
AssetAnalog An asset health analog related to this lab test standard.
- AssetDiscrete
AssetDiscrete An asset health discrete related to this lab test standard.
- AssetString
AssetStringMeasurement An asset health string related to this lab test standard.
-
final
case class
TextDiagramObject(DiagramObject: DiagramObject = null, text: String = null) extends Element with Product with Serializable
A diagram object for placing free-text or text derived from an associated domain object.
A diagram object for placing free-text or text derived from an associated domain object.
- DiagramObject
DiagramObject Reference to the superclass object.
- text
The text that is displayed by this text diagram object.
-
final
case class
ThermalGeneratingUnit(GeneratingUnit: GeneratingUnit = null, oMCost: Double = 0.0, CAESPlant: String = null, CogenerationPlant: String = null, CombinedCyclePlant: String = null, EmissionCurves: List[String] = null, EmmissionAccounts: List[String] = null, FossilFuels: List[String] = null, FuelAllocationSchedules: List[String] = null, HeatInputCurve: String = null, HeatRateCurve: String = null, IncrementalHeatRateCurve: String = null, ShutdownCurve: String = null, StartupModel: String = null) extends Element with Product with Serializable
A generating unit whose prime mover could be a steam turbine, combustion turbine, or diesel engine.
A generating unit whose prime mover could be a steam turbine, combustion turbine, or diesel engine.
- GeneratingUnit
GeneratingUnit Reference to the superclass object.
- oMCost
Operating and maintenance cost for the thermal unit.
- CAESPlant
CAESPlant A thermal generating unit may be a member of a compressed air energy storage plant.
- CogenerationPlant
CogenerationPlant A thermal generating unit may be a member of a cogeneration plant.
- CombinedCyclePlant
CombinedCyclePlant A thermal generating unit may be a member of a combined cycle plant.
- EmissionCurves
EmissionCurve A thermal generating unit may have one or more emission curves.
- EmmissionAccounts
EmissionAccount A thermal generating unit may have one or more emission allowance accounts.
- FossilFuels
FossilFuel A thermal generating unit may have one or more fossil fuels.
- FuelAllocationSchedules
FuelAllocationSchedule A thermal generating unit may have one or more fuel allocation schedules.
- HeatInputCurve
HeatInputCurve A thermal generating unit may have a heat input curve.
- HeatRateCurve
HeatRateCurve A thermal generating unit may have a heat rate curve.
- IncrementalHeatRateCurve
IncrementalHeatRateCurve A thermal generating unit may have an incremental heat rate curve.
- ShutdownCurve
ShutdownCurve A thermal generating unit may have a shutdown curve.
- StartupModel
StartupModel A thermal generating unit may have a startup model.
-
final
case class
TieFlow(IdentifiedObject: IdentifiedObject = null, positiveFlowIn: Boolean = false, AltTieMeas: List[String] = null, ControlArea: String = null, Terminal: String = null) extends Element with Product with Serializable
Defines the structure (in terms of location and direction) of the net interchange constraint for a control area.
Defines the structure (in terms of location and direction) of the net interchange constraint for a control area.
This constraint may be used by either AGC or power flow.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- positiveFlowIn
Specifies the sign of the tie flow associated with a control area. True if positive flow into the terminal (load convention) is also positive flow into the control area. See the description of ControlArea for further explanation of how TieFlow.positiveFlowIn is used.
- AltTieMeas
AltTieMeas The primary and alternate tie flow measurements associated with the tie flow.
- ControlArea
ControlArea The control area of the tie flows.
- Terminal
Terminal The terminal to which this tie flow belongs.
- final case class TieLine(IdentifiedObject: IdentifiedObject = null, EnergyTransaction: String = null, ParentOfA: List[String] = null, ParentOfB: String = null, SideA_SubControlArea: String = null, SideB_SubControlArea: String = null) extends Element with Product with Serializable
-
final
case class
TiePoint(IdentifiedObject: IdentifiedObject = null, tiePointMWRating: Double = 0.0, ByMktMeasurement: List[String] = null, ForMktMeasurement: List[String] = null) extends Element with Product with Serializable
Site of an interface between interchange areas.
Site of an interface between interchange areas.
The tie point can be a network branch (e.g., transmission line or transformer) or a switching device. For transmission lines, the interchange area boundary is usually at a designated point such as the middle of the line. Line end metering is then corrected for line losses.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- tiePointMWRating
The MW rating of the tie point.
- ByMktMeasurement
MktMeasurement A measurement is made on the B side of a tie point
- ForMktMeasurement
MktMeasurement A measurement is made on the A side of a tie point
-
final
case class
TimeInterval(Element: BasicElement = null, end: String = null, start: String = null) extends Element with Product with Serializable
Interval between two times.
Interval between two times.
- Element
Reference to the superclass object.
- end
End time of this interval.
- start
Start time of this interval.
-
final
case class
TimePoint(IdentifiedObject: IdentifiedObject = null, dateTime: String = null, relativeTimeInterval: Double = 0.0, sequenceNumber: Int = 0, status: String = null, window: String = null, TimeSchedule: String = null) extends Element with Product with Serializable
A point in time within a sequence of points in time relative to a time schedule.
A point in time within a sequence of points in time relative to a time schedule.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- dateTime
Absolute date and time for this time point. For calendar-based time point, it is typically manually entered, while for interval-based or sequence-based time point it is derived.
- relativeTimeInterval
(if interval-based) A point in time relative to scheduled start time in 'TimeSchedule.scheduleInterval.start'.
- sequenceNumber
(if sequence-based) Relative sequence number for this time point.
- status
Status Status of this time point.
- window
Interval defining the window of time that this time point is valid (for example, seasonal, only on weekends, not on weekends, only 8:00 am to 5:00 pm, etc.).
- TimeSchedule
TimeSchedule Time schedule owning this time point.
-
final
case class
TimeSchedule(Document: Document = null, disabled: Boolean = false, offset: Double = 0.0, recurrencePattern: String = null, recurrencePeriod: Double = 0.0, scheduleInterval: String = null, TimePoints: List[String] = null) extends Element with Product with Serializable
Description of anything that changes through time.
Description of anything that changes through time.
Time schedule is used to perform a single-valued function of time. Use inherited 'type' attribute to give additional information on this schedule, such as: periodic (hourly, daily, weekly, monthly, etc.), day of the month, by date, calendar (specific times and dates).
- Document
Document Reference to the superclass object.
- disabled
True if this schedule is deactivated (disabled).
- offset
The offset from midnight (i.e., 0 h, 0 min, 0 s) for the periodic time points to begin. For example, for an interval meter that is set up for five minute intervals ('recurrencePeriod'=300=5 min), setting 'offset'=120=2 min would result in scheduled events to read the meter executing at 2 min, 7 min, 12 min, 17 min, 22 min, 27 min, 32 min, 37 min, 42 min, 47 min, 52 min, and 57 min past each hour.
- recurrencePattern
Interval at which the scheduled action repeats (e.g., first Monday of every month, last day of the month, etc.).
- recurrencePeriod
Duration between time points, from the beginning of one period to the beginning of the next period. Note that a device like a meter may have multiple interval periods (e.g., 1 min, 5 min, 15 min, 30 min, or 60 min).
- scheduleInterval
Schedule date and time interval.
- TimePoints
TimePoint Sequence of time points belonging to this time schedule.
-
final
case class
TimeSeries(IdentifiedObject: IdentifiedObject = null, businessType: String = null, cancelledTS: String = null, curveType: String = null, objectAggregation: String = null, product: String = null, version: String = null, AttributeInstanceComponent: List[String] = null, Auction: List[String] = null, ConstraintDuration: List[String] = null, DateAndOrTime: List[String] = null, Domain: List[String] = null, EnvironmentalMonitoringStation: List[String] = null, FlowDirection: List[String] = null, MarketDocument: List[String] = null, MarketEvaluationPoint: List[String] = null, MarketObjectStatus: List[String] = null, MarketParticipant: List[String] = null, MktPSRType: List[String] = null, Period: List[String] = null, Point: List[String] = null, Price: List[String] = null, Quantity: List[String] = null, Reason: List[String] = null, RegisteredResource: List[String] = null, Unit: List[String] = null) extends Element with Product with Serializable
A set of regular time-ordered measurements or values of quantitative nature of an individual or collective phenomenon taken at successive, in most cases equidistant, periods / points of time.
A set of regular time-ordered measurements or values of quantitative nature of an individual or collective phenomenon taken at successive, in most cases equidistant, periods / points of time.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- businessType
The identification of the nature of the time series.
- cancelledTS
An indicator stating that the TimeSeries, identified by the mRID, is cancelled as well as all the values sent in a previous version of the TimeSeries in a previous document.
- curveType
The coded representation of the type of curve being described.
- objectAggregation
Identification of the object that is the common denominator used to aggregate a time series.
- product
The type of the product such as Power, energy, reactive power, transport capacity that is the subject of the time series.
- version
Version of the time series.
- AttributeInstanceComponent
AttributeInstanceComponent undocumented
- Auction
Auction undocumented
- ConstraintDuration
ConstraintDuration undocumented
- DateAndOrTime
DateAndOrTime undocumented
- Domain
Domain undocumented
- EnvironmentalMonitoringStation
EnvironmentalMonitoringStation undocumented
- FlowDirection
FlowDirection undocumented
- MarketDocument
MarketDocument undocumented
- MarketEvaluationPoint
MarketEvaluationPoint undocumented
- MarketObjectStatus
MarketObjectStatus undocumented
- MarketParticipant
MarketParticipant undocumented
- MktPSRType
MktPSRType undocumented
- Period
Period undocumented
- Point
Point undocumented
- Price
Price undocumented
- Quantity
Quantity undocumented
- Reason
Reason undocumented
- RegisteredResource
RegisteredResource undocumented
- Unit
Unit_ undocumented
-
final
case class
TimeTariffInterval(Element: BasicElement = null, sequenceNumber: Int = 0, startTime: String = null, Charges: List[String] = null, ConsumptionTariffIntervals: List[String] = null, TariffProfiles: List[String] = null) extends Element with Product with Serializable
One of a sequence of time intervals defined in terms of real time.
One of a sequence of time intervals defined in terms of real time.
It is typically used in association with TariffProfile to define the intervals in a time of use tariff structure, where startDateTime simultaneously determines the starting point of this interval and the ending point of the previous interval.
- Element
Reference to the superclass object.
- sequenceNumber
A sequential reference that defines the identity of this interval and its relative position with respect to other intervals in a sequence of intervals.
- startTime
A real time marker that defines the starting time (typically it is the time of day) for this interval. The interval extends to the start of the next interval or until it is reset to the start of the first interval by TariffProfile.tariffCycle.
- Charges
Charge All charges used to define this time tariff interval.
- ConsumptionTariffIntervals
ConsumptionTariffInterval All consumption tariff intervals that introduce variation in this time of use tariff interval; allows to express e.g., peak hour prices that are different with different consumption blocks.
- TariffProfiles
TariffProfile All tariff profiles defined by this time tariff interval.
-
final
case class
Tool(WorkAsset: WorkAsset = null, lastCalibrationDate: String = null) extends Element with Product with Serializable
Tool asset.
Tool asset.
- WorkAsset
WorkAsset Reference to the superclass object.
- lastCalibrationDate
(if applicable) Date the tool was last calibrated.
-
final
case class
TopologicalIsland(IdentifiedObject: IdentifiedObject = null, AngleRefTopologicalNode: String = null, TopologicalNodes: List[String] = null) extends Element with Product with Serializable
An electrically connected subset of the network.
An electrically connected subset of the network.
Topological islands can change as the current network state changes, e.g. due to: - disconnect switches or breakers changing state in a SCADA/EMS. - manual creation, change or deletion of topological nodes in a planning tool. Only energised TopologicalNode-s shall be part of the topological island.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- AngleRefTopologicalNode
TopologicalNode The angle reference for the island. Normally there is one TopologicalNode that is selected as the angle reference for each island. Other reference schemes exist, so the association is typically optional.
- TopologicalNodes
TopologicalNode A topological node belongs to a topological island.
-
final
case class
TopologicalNode(IdentifiedObject: IdentifiedObject = null, pInjection: Double = 0.0, qInjection: Double = 0.0, AngleRefTopologicalIsland: String = null, BaseVoltage: String = null, BusNameMarker: List[String] = null, ConnectivityNodeContainer: String = null, ConnectivityNodes: List[String] = null, ReportingGroup: String = null, SvInjection: List[String] = null, SvVoltage: List[String] = null, Terminal: List[String] = null, TopologicalIsland: String = null) extends Element with Product with Serializable
For a detailed substation model a topological node is a set of connectivity nodes that, in the current network state, are connected together through any type of closed switches, including jumpers.
For a detailed substation model a topological node is a set of connectivity nodes that, in the current network state, are connected together through any type of closed switches, including jumpers.
Topological nodes change as the current network state changes (i.e., switches, breakers, etc. change state). For a planning model, switch statuses are not used to form topological nodes. Instead they are manually created or deleted in a model builder tool. Topological nodes maintained this way are also called "busses".
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- pInjection
The active power injected into the bus at this location in addition to injections from equipment. Positive sign means injection into the TopologicalNode (bus). Starting value for a steady state solution.
- qInjection
The reactive power injected into the bus at this location in addition to injections from equipment. Positive sign means injection into the TopologicalNode (bus). Starting value for a steady state solution.
- AngleRefTopologicalIsland
TopologicalIsland The island for which the node is an angle reference. Normally there is one angle reference node for each island.
- BaseVoltage
BaseVoltage The base voltage of the topological node.
- BusNameMarker
BusNameMarker BusnameMarkers that may refer to a pre defined TopologicalNode.
- ConnectivityNodeContainer
ConnectivityNodeContainer The connectivity node container to which the topological node belongs.
- ConnectivityNodes
ConnectivityNode The connectivity nodes combine together to form this topological node. May depend on the current state of switches in the network.
- ReportingGroup
ReportingGroup The reporting group to which the topological node belongs.
- SvInjection
SvInjection The injection flows state variables associated with the topological node.
- SvVoltage
SvVoltage The state voltage associated with the topological node.
- Terminal
Terminal The terminals associated with the topological node. This can be used as an alternative to the connectivity node path to terminal, thus making it unnecessary to model connectivity nodes in some cases. Note that if connectivity nodes are in the model, this association would probably not be used as an input specification.
- TopologicalIsland
TopologicalIsland A topological node belongs to a topological island.
-
final
case class
Tornado(AtmosphericPhenomenon: AtmosphericPhenomenon = null, fScale: String = null, width: Double = 0.0) extends Element with Product with Serializable
A tornado, a violent destructive whirling wind accompanied by a funnel-shaped cloud that progresses in a narrow path over the land.
A tornado, a violent destructive whirling wind accompanied by a funnel-shaped cloud that progresses in a narrow path over the land.
- AtmosphericPhenomenon
AtmosphericPhenomenon Reference to the superclass object.
- fScale
Fujita scale (referred to as EF-scale starting in 2007) for the tornado.
- width
Width of the tornado during the time interval.
-
final
case class
Tower(Structure: Structure = null, constructionKind: String = null) extends Element with Product with Serializable
Tower asset.
Tower asset.
Dimensions of the Tower are specified in associated DimensionsInfo class. When used for planning purposes, a transmission tower carrying two 3-phase circuits will have 2 instances of Connection, each of which will have 3 MountingPoint instances, one for each phase all with coordinates relative to a common origin on the tower. (It may also have a 3rd Connection with a single MountingPoint for the Neutral line).
- Structure
Structure Reference to the superclass object.
- constructionKind
Construction structure on the tower.
-
final
case class
TownDetail(Element: BasicElement = null, code: String = null, country: String = null, name: String = null, section: String = null, stateOrProvince: String = null) extends Element with Product with Serializable
Town details, in the context of address.
Town details, in the context of address.
- Element
Reference to the superclass object.
- code
Town code.
- country
Name of the country.
- name
Town name.
- section
Town section. For example, it is common for there to be 36 sections per township.
- stateOrProvince
Name of the state or province.
-
final
case class
Trade(IdentifiedObject: IdentifiedObject = null, adjustedTradeQuantity: Double = 0.0, counterTradeQuantity: Double = 0.0, dependOnTradeName: String = null, lastModified: String = null, marketType: String = null, startTime: String = null, stopTime: String = null, submitFromSchedulingCoordinator: String = null, submitFromTimeStamp: String = null, submitFromUser: String = null, submitToSchedulingCoordinator: String = null, submitToTimeStamp: String = null, submitToUser_1: String = null, tradeQuantity: Double = 0.0, tradeStatus: String = null, updateTimeStamp: String = null, updateUser: String = null, ActionRequest: String = null, From_SC: String = null, Pnode: String = null, RegisteredGenerator: String = null, To_SC: String = null, TradeError: List[String] = null, TradeProduct: String = null) extends Element with Product with Serializable
Inter Scheduling Coordinator Trades to model financial trades which may impact settlement.
Inter Scheduling Coordinator Trades to model financial trades which may impact settlement.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- adjustedTradeQuantity
The validated and current market accepted trade amount of a physical energy trade.
- counterTradeQuantity
MW quantity submitted by counter SC for the same trade
- dependOnTradeName
The Depend On IST Name points to the unique IST Name in the chain of physical energy trades.
- lastModified
Time and date the trade was last modified.
- marketType
undocumented
- startTime
Start time and date for which trade applies.
- stopTime
Stop time and date for which trade is applicable.
- submitFromSchedulingCoordinator
SchedulingCoordinator undocumented
- submitFromTimeStamp
Timestamp of submittal of submit From Scheduling Coordinator Trade to Market Participant Bid Submittal
- submitFromUser
Userid of the submit From Scheduling Coordinator trade
- submitToSchedulingCoordinator
SchedulingCoordinator undocumented
- submitToTimeStamp
Timestamp of submittal of submit To Scheduling Coordinator Trade to Market Participant Bid Submittal
- submitToUser_1
Userid of the submit To Scheduling Coordinator trade
- tradeQuantity
tradeQuantity: If tradeType = IST, The amount of an Energy Trade. If tradeType = AST, The amount of an Ancillary Service Obligation Trade. If tradeType = UCT, The amount of a Unit Commitment Obligation Trade.
- tradeStatus
Resulting status of the trade following the rule engine processing.
- updateTimeStamp
undocumented
- updateUser
undocumented
- ActionRequest
ActionRequest undocumented
- From_SC
SchedulingCoordinator undocumented
- Pnode
Pnode undocumented
- RegisteredGenerator
RegisteredGenerator undocumented
- To_SC
SchedulingCoordinator undocumented
- TradeError
TradeError undocumented
- TradeProduct
TradeProduct undocumented
-
final
case class
TradeError(IdentifiedObject: IdentifiedObject = null, endTime: String = null, errMessage: String = null, errPriority: Int = 0, logTimeStamp: String = null, ruleID: Int = 0, startTime: String = null, Trade: String = null) extends Element with Product with Serializable
Trade error and warning messages associated with the rule engine processing of the submitted trade.
Trade error and warning messages associated with the rule engine processing of the submitted trade.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- endTime
hour wihthin the trade for which the error applies
- errMessage
error message
- errPriority
Priority number for the error message
- logTimeStamp
Timestamp of logged error/warning message
- ruleID
Rule identifier which triggered the error/warning message
- startTime
hour wihthin the trade for which the error applies
- Trade
Trade undocumented
-
final
case class
TradeProduct(Element: BasicElement = null, tradeProductType: String = null, tradeType: String = null, Trade: List[String] = null) extends Element with Product with Serializable
TradeType TradeProduct IST (InterSC Trade) PHY (Physical Energy Trade) IST APN (Energy Trades at Aggregated Pricing Nodes) IST CPT (Converted Physical Energy Trade) AST (Ancilliary Services Trade) RUT (Regulation Up Trade) AST RDT (Regulation Down Trade) AST SRT (Spinning Reserve Trade) AST NRT (Non-Spinning Reserve Trade)
TradeType TradeProduct IST (InterSC Trade) PHY (Physical Energy Trade) IST APN (Energy Trades at Aggregated Pricing Nodes) IST CPT (Converted Physical Energy Trade) AST (Ancilliary Services Trade) RUT (Regulation Up Trade) AST RDT (Regulation Down Trade) AST SRT (Spinning Reserve Trade) AST NRT (Non-Spinning Reserve Trade)
UCT (Unit Commitment Trade) null
- Element
Reference to the superclass object.
- tradeProductType
PHY (Physical Energy Trade); APN (Energy Trades at Aggregated Pricing Nodes); CPT (Converted Physical Energy Trade); RUT (Regulation Up Trade); RDT (Regulation Down Trade); SRT (Spinning Reserve Trade); NRT (Non-Spinning Reserve Trade)
- tradeType
IST - InterSC Trade; AST - Ancilliary Services Trade; UCT - Unit Commitment Trade
- Trade
Trade undocumented
-
final
case class
TradingHubPrice(Element: BasicElement = null, intervalStartTime: String = null, marketType: String = null, updateTimeStamp: String = null, updateUser: String = null, TradingHubValues: List[String] = null) extends Element with Product with Serializable
Models prices at Trading Hubs, interval based.
Models prices at Trading Hubs, interval based.
- Element
Reference to the superclass object.
- intervalStartTime
undocumented
- marketType
undocumented
- updateTimeStamp
undocumented
- updateUser
undocumented
- TradingHubValues
TradingHubValues undocumented
-
final
case class
TradingHubValues(Element: BasicElement = null, price: Double = 0.0, AggregatedPnode: String = null, TradingHubPrice: String = null) extends Element with Product with Serializable
Models prices at Trading Hubs.
Models prices at Trading Hubs.
- Element
Reference to the superclass object.
- price
Utilizes the Market type. For DA, the price is hourly. For RTM the price is a 5 minute price.
- AggregatedPnode
AggregatedPnode undocumented
- TradingHubPrice
TradingHubPrice undocumented
-
final
case class
Transaction(IdentifiedObject: IdentifiedObject = null, diverseReference: String = null, donorReference: String = null, kind: String = null, line: String = null, receiverReference: String = null, reversedId: String = null, serviceUnitsEnergy: Double = 0.0, serviceUnitsError: Double = 0.0, AuxiliaryAccount: String = null, CashierShift: String = null, CustomerAccount: String = null, Meter: String = null, PricingStructure: String = null, Receipt: String = null, UserAttributes: List[String] = null, VendorShift: String = null) extends Element with Product with Serializable
The record of details of payment for service or token sale.
The record of details of payment for service or token sale.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- diverseReference
Formal reference for use with diverse payment (traffic fine for example).
- donorReference
Reference to the entity that is the source of 'amount' (for example: customer for token purchase; or supplier for free issue token).
- kind
Kind of transaction.
- line
LineDetail Transaction amount, rounding, date and note for this transaction line.
- receiverReference
Reference to the entity that is the recipient of 'amount' (for example, supplier for service charge payment; or tax receiver for VAT).
- reversedId
(if 'kind' is transactionReversal) Reference to the original transaction that is being reversed by this transaction.
- serviceUnitsEnergy
Actual amount of service units that is being paid for.
- serviceUnitsError
Number of service units not reflected in 'serviceUnitsEnergy' due to process rounding or truncating errors.
- AuxiliaryAccount
AuxiliaryAccount Auxiliary account for this payment transaction.
- CashierShift
CashierShift Cashier shift during which this transaction was recorded.
- CustomerAccount
CustomerAccount Customer account for this payment transaction.
- Meter
Meter Meter for this vending transaction.
- PricingStructure
PricingStructure Pricing structure applicable for this transaction.
- Receipt
Receipt The receipted payment for which this transaction has been recorded.
- UserAttributes
UserAttribute All snapshots of meter parameters recorded at the time of this transaction. Use 'name' and 'value.value' attributes to specify name and value of a parameter from meter.
- VendorShift
VendorShift Vendor shift during which this transaction was recorded.
-
final
case class
TransactionBid(Bid: Bid = null, demandTransaction: Boolean = false, dispatchable: Boolean = false, payCongestion: Boolean = false, Delivery_Pnode: String = null, EnergyProfiles: List[String] = null, Receipt_Pnode: String = null, TransactionBidResults: List[String] = null, TransmissionReservation: String = null) extends Element with Product with Serializable
Bilateral or scheduled transactions for energy and ancillary services considered by market clearing process.
Bilateral or scheduled transactions for energy and ancillary services considered by market clearing process.
- Bid
Bid Reference to the superclass object.
- demandTransaction
Set true if this is a demand transaction.
- dispatchable
Set true if this is a dispatchable transaction.
- payCongestion
Set true if this is a willing to pay transaction. This flag is used to determine whether a schedule is willing-to-pay-congestion or not.
- Delivery_Pnode
Pnode undocumented
- EnergyProfiles
EnergyProfile undocumented
- Receipt_Pnode
Pnode undocumented
- TransactionBidResults
TransactionBidResults undocumented
- TransmissionReservation
TransmissionReservation undocumented
-
final
case class
TransactionBidClearing(MarketFactors: MarketFactors = null, TransactionBidResults: List[String] = null) extends Element with Product with Serializable
Contains the intervals relavent for the associated TransactionBidResults.
Contains the intervals relavent for the associated TransactionBidResults.
For example, Day Ahead cleared results for the transaction bids for each interval of the market day.
- MarketFactors
MarketFactors Reference to the superclass object.
- TransactionBidResults
TransactionBidResults undocumented
-
final
case class
TransactionBidResults(IdentifiedObject: IdentifiedObject = null, clearedMW: Double = 0.0, clearedPrice: Double = 0.0, TransactionBid: String = null, TransactionBidClearing: String = null) extends Element with Product with Serializable
Contains the cleared results for each TransactionBid submitted to and accepted by the market.
Contains the cleared results for each TransactionBid submitted to and accepted by the market.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- clearedMW
The market transaction megawatt
- clearedPrice
The price of the market transaction
- TransactionBid
TransactionBid undocumented
- TransactionBidClearing
TransactionBidClearing undocumented
-
final
case class
Transactor(IdentifiedObject: IdentifiedObject = null, MerchantAccounts: List[String] = null) extends Element with Product with Serializable
The entity that ultimately executes the transaction and which is in control of the process; typically this is embodied in secure software running on a server that may employ secure hardware encryption devices for secure transaction processing.
The entity that ultimately executes the transaction and which is in control of the process; typically this is embodied in secure software running on a server that may employ secure hardware encryption devices for secure transaction processing.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- MerchantAccounts
MerchantAccount All merchant accounts registered with this transactor.
-
final
case class
TransferInterface(IdentifiedObject: IdentifiedObject = null, HostControlArea: String = null, TransferInterfaceSolution: String = null) extends Element with Product with Serializable
A Transfer Interface is made up of branches such as transmission lines and transformers.
A Transfer Interface is made up of branches such as transmission lines and transformers.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- HostControlArea
HostControlArea undocumented
- TransferInterfaceSolution
TransferInterfaceSolution undocumented
-
final
case class
TransferInterfaceSolution(Element: BasicElement = null, interfaceMargin: Double = 0.0, postTransferMW: Double = 0.0, transferLimit: Double = 0.0, MktContingencyB: String = null, TransferInterface: String = null, _MktContingencyA: String = null) extends Element with Product with Serializable
TNA Interface Definitions from OPF for VSA.
TNA Interface Definitions from OPF for VSA.
- Element
Reference to the superclass object.
- interfaceMargin
The margin for the interface
- postTransferMW
Post Transfer MW for step
- transferLimit
Transfer Interface + Limit Attribute Usage: The absoloute of the maximum flow on the transfer interface. This is a positive MW value.
- MktContingencyB
MktContingency undocumented
- TransferInterface
TransferInterface undocumented
- _MktContingencyA
MktContingency undocumented
-
final
case class
TransformerCoreAdmittance(IdentifiedObject: IdentifiedObject = null, b: Double = 0.0, b0: Double = 0.0, g: Double = 0.0, g0: Double = 0.0, TransformerEnd: List[String] = null, TransformerEndInfo: String = null) extends Element with Product with Serializable
The transformer core admittance.
The transformer core admittance.
Used to specify the core admittance of a transformer in a manner that can be shared among power transformers.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- b
Magnetizing branch susceptance (B mag). The value can be positive or negative.
- b0
Zero sequence magnetizing branch susceptance.
- g
Magnetizing branch conductance (G mag).
- g0
Zero sequence magnetizing branch conductance.
- TransformerEnd
TransformerEnd All transformer ends having this core admittance.
- TransformerEndInfo
TransformerEndInfo Transformer end datasheet used to calculate this core admittance.
-
final
case class
TransformerEnd(IdentifiedObject: IdentifiedObject = null, bmagSat: Double = 0.0, endNumber: Int = 0, grounded: Boolean = false, magBaseU: Double = 0.0, magSatFlux: Double = 0.0, rground: Double = 0.0, xground: Double = 0.0, BaseVoltage: String = null, CoreAdmittance: String = null, FromMeshImpedance: List[String] = null, FromWindingInsulations: List[String] = null, PhaseTapChanger: String = null, RatioTapChanger: String = null, StarImpedance: String = null, Terminal: String = null, ToMeshImpedance: List[String] = null, ToWindingInsulations: List[String] = null) extends Element with Product with Serializable
A conducting connection point of a power transformer.
A conducting connection point of a power transformer.
It corresponds to a physical transformer winding terminal. In earlier CIM versions, the TransformerWinding class served a similar purpose, but this class is more flexible because it associates to terminal but is not a specialization of ConductingEquipment.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- bmagSat
Core shunt magnetizing susceptance in the saturation region.
- endNumber
Number for this transformer end, corresponding to the end's order in the power transformer vector group or phase angle clock number. Highest voltage winding should be 1. Each end within a power transformer should have a unique subsequent end number. Note the transformer end number need not match the terminal sequence number.
- grounded
(for Yn and Zn connections) True if the neutral is solidly grounded.
- magBaseU
The reference voltage at which the magnetizing saturation measurements were made.
- magSatFlux
Core magnetizing saturation curve knee flux level.
- rground
(for Yn and Zn connections) Resistance part of neutral impedance where 'grounded' is true.
- xground
(for Yn and Zn connections) Reactive part of neutral impedance where 'grounded' is true.
- BaseVoltage
BaseVoltage Base voltage of the transformer end. This is essential for PU calculation.
- CoreAdmittance
TransformerCoreAdmittance Core admittance of this transformer end, representing magnetising current and core losses. The full values of the transformer should be supplied for one transformer end only.
- FromMeshImpedance
TransformerMeshImpedance All mesh impedances between this 'to' and other 'from' transformer ends.
- FromWindingInsulations
WindingInsulation undocumented
- PhaseTapChanger
PhaseTapChanger Phase tap changer associated with this transformer end.
- RatioTapChanger
RatioTapChanger Ratio tap changer associated with this transformer end.
- StarImpedance
TransformerStarImpedance (accurate for 2- or 3-winding transformers only) Pi-model impedances of this transformer end. By convention, for a two winding transformer, the full values of the transformer should be entered on the high voltage end (endNumber=1).
- Terminal
Terminal Terminal of the power transformer to which this transformer end belongs.
- ToMeshImpedance
TransformerMeshImpedance All mesh impedances between this 'from' and other 'to' transformer ends.
- ToWindingInsulations
WindingInsulation undocumented
-
final
case class
TransformerEndInfo(AssetInfo: AssetInfo = null, connectionKind: String = null, emergencyS: Double = 0.0, endNumber: Int = 0, insulationU: Double = 0.0, phaseAngleClock: Int = 0, r: Double = 0.0, ratedS: Double = 0.0, ratedU: Double = 0.0, shortTermS: Double = 0.0, CoreAdmittance: String = null, EnergisedEndNoLoadTests: List[String] = null, EnergisedEndOpenCircuitTests: List[String] = null, EnergisedEndShortCircuitTests: List[String] = null, FromMeshImpedances: List[String] = null, GroundedEndShortCircuitTests: List[String] = null, OpenEndOpenCircuitTests: List[String] = null, ToMeshImpedances: List[String] = null, TransformerStarImpedance: String = null, TransformerTankInfo: String = null) extends Element with Product with Serializable
Transformer end data.
Transformer end data.
- AssetInfo
AssetInfo Reference to the superclass object.
- connectionKind
Kind of connection.
- emergencyS
Apparent power that the winding can carry under emergency conditions (also called long-term emergency power).
- endNumber
Number for this transformer end, corresponding to the end's order in the PowerTransformer.vectorGroup attribute. Highest voltage winding should be 1.
- insulationU
Basic insulation level voltage rating.
- phaseAngleClock
Winding phase angle where 360 degrees are represented with clock hours, so the valid values are {0, ..., 11}. For example, to express the second winding in code 'Dyn11', set attributes as follows: 'endNumber'=2, 'connectionKind' = Yn and 'phaseAngleClock' = 11.
- r
DC resistance.
- ratedS
Normal apparent power rating.
- ratedU
Rated voltage: phase-phase for three-phase windings, and either phase-phase or phase-neutral for single-phase windings.
- shortTermS
Apparent power that this winding can carry for a short period of time (in emergency).
- CoreAdmittance
TransformerCoreAdmittance Core admittance calculated from this transformer end datasheet, representing magnetising current and core losses. The full values of the transformer should be supplied for one transformer end info only.
- EnergisedEndNoLoadTests
NoLoadTest All no-load test measurements in which this transformer end was energised.
- EnergisedEndOpenCircuitTests
OpenCircuitTest All open-circuit test measurements in which this transformer end was excited.
- EnergisedEndShortCircuitTests
ShortCircuitTest All short-circuit test measurements in which this transformer end was energised.
- FromMeshImpedances
TransformerMeshImpedance All mesh impedances between this 'to' and other 'from' transformer ends.
- GroundedEndShortCircuitTests
ShortCircuitTest All short-circuit test measurements in which this transformer end was short-circuited.
- OpenEndOpenCircuitTests
OpenCircuitTest All open-circuit test measurements in which this transformer end was not excited.
- ToMeshImpedances
TransformerMeshImpedance All mesh impedances between this 'from' and other 'to' transformer ends.
- TransformerStarImpedance
TransformerStarImpedance Transformer star impedance calculated from this transformer end datasheet.
- TransformerTankInfo
TransformerTankInfo Transformer tank data that this end description is part of.
-
final
case class
TransformerMeshImpedance(IdentifiedObject: IdentifiedObject = null, r: Double = 0.0, r0: Double = 0.0, x: Double = 0.0, x0: Double = 0.0, FromTransformerEnd: String = null, FromTransformerEndInfo: String = null, ToTransformerEnd: List[String] = null, ToTransformerEndInfos: List[String] = null) extends Element with Product with Serializable
Transformer mesh impedance (Delta-model) between transformer ends.
Transformer mesh impedance (Delta-model) between transformer ends.
The typical case is that this class describes the impedance between two transformer ends pair-wise, i.e. the cardinalities at both transformer end associations are 1. However, in cases where two or more transformer ends are modelled the cardinalities are larger than 1.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- r
Resistance between the 'from' and the 'to' end, seen from the 'from' end.
- r0
Zero-sequence resistance between the 'from' and the 'to' end, seen from the 'from' end.
- x
Reactance between the 'from' and the 'to' end, seen from the 'from' end.
- x0
Zero-sequence reactance between the 'from' and the 'to' end, seen from the 'from' end.
- FromTransformerEnd
TransformerEnd From end this mesh impedance is connected to. It determines the voltage reference.
- FromTransformerEndInfo
TransformerEndInfo 'from' transformer end datasheet this mesh impedance is calculated from. It determines the voltage reference.
- ToTransformerEnd
TransformerEnd All transformer ends this mesh impedance is connected to.
- ToTransformerEndInfos
TransformerEndInfo All 'to' transformer end datasheets this mesh impedance for 'from' transformer end is calculated from.
-
final
case class
TransformerObservation(IdentifiedObject: IdentifiedObject = null, bushingTemp: Double = 0.0, dga: String = null, freqResp: String = null, furfuralDP: String = null, hotSpotTemp: Double = 0.0, oilColor: String = null, oilDielectricStrength: Double = 0.0, oilIFT: String = null, oilLevel: String = null, oilNeutralizationNumber: String = null, pumpVibration: String = null, status: String = null, topOilTemp: Double = 0.0, waterContent: String = null, BushingInsultationPFs: List[String] = null, ProcedureDataSets: List[String] = null, Reconditioning: String = null, Transformer: String = null, WindingInsulationPFs: List[String] = null) extends Element with Product with Serializable
Common information captured during transformer inspections and/or diagnostics.
Common information captured during transformer inspections and/or diagnostics.
Note that some properties may be measured through other means and therefore have measurement values in addition to the observed values recorded here.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- bushingTemp
Bushing temperature.
- dga
Dissolved Gas Analysis. Typical values are: Acceptable, Overheating, Corona, Sparking, Arcing.
- freqResp
Frequency Response Analysis. Typical values are: acceptable, slight movement, significant movement, failed, near failure. A graphic of the response diagram, which is a type of document, may be associated with this analysis through the recursive document relationship of the ProcedureDataSet.
- furfuralDP
Overall measure of furfural in oil and mechanical strength of paper. DP, the degree of polymerization, is the strength of the paper. Furfural is a measure of furfural compounds, often expressed in parts per million.
- hotSpotTemp
Hotspot oil temperature.
- oilColor
Oil Quality Analysis-Color.
- oilDielectricStrength
Oil Quality Analysis-Dielectric Strength.
- oilIFT
Oil Quality Analysis- inter facial tension (IFT) - number-Dynes/CM.
- oilLevel
The level of oil in the transformer.
- oilNeutralizationNumber
Oil Quality Analysis-Neutralization Number - Number - Mg KOH.
- pumpVibration
Pump vibration, with typical values being: nominal, high.
- status
undocumented
- topOilTemp
Top oil temperature.
- waterContent
Water Content expressed in parts per million.
- BushingInsultationPFs
BushingInsulationPF undocumented
- ProcedureDataSets
ProcedureDataSet undocumented
- Reconditioning
Reconditioning undocumented
- Transformer
TransformerTank undocumented
- WindingInsulationPFs
WindingInsulation undocumented
-
final
case class
TransformerStarImpedance(IdentifiedObject: IdentifiedObject = null, r: Double = 0.0, r0: Double = 0.0, x: Double = 0.0, x0: Double = 0.0, TransformerEnd: List[String] = null, TransformerEndInfo: String = null) extends Element with Product with Serializable
Transformer star impedance (Pi-model) that accurately reflects impedance for transformers with 2 or 3 windings.
Transformer star impedance (Pi-model) that accurately reflects impedance for transformers with 2 or 3 windings.
For transformers with 4 or more windings, TransformerMeshImpedance class shall be used. For transmission networks use PowerTransformerEnd impedances (r, r0, x, x0, b, b0, g and g0).
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- r
Resistance of the transformer end.
- r0
Zero sequence series resistance of the transformer end.
- x
Positive sequence series reactance of the transformer end.
- x0
Zero sequence series reactance of the transformer end.
- TransformerEnd
TransformerEnd All transformer ends having this star impedance.
- TransformerEndInfo
TransformerEndInfo Transformer end datasheet used to calculate this transformer star impedance.
-
final
case class
TransformerTank(Equipment: Equipment = null, PowerTransformer: String = null, TransformerObservations: List[String] = null, TransformerTankEnds: List[String] = null) extends Element with Product with Serializable
An assembly of two or more coupled windings that transform electrical power between voltage levels.
An assembly of two or more coupled windings that transform electrical power between voltage levels.
These windings are bound on a common core and placed in the same tank. Transformer tank can be used to model both single-phase and 3-phase transformers.
- Equipment
Equipment Reference to the superclass object.
- PowerTransformer
PowerTransformer Bank this transformer belongs to.
- TransformerObservations
TransformerObservation undocumented
- TransformerTankEnds
TransformerTankEnd All windings of this transformer.
-
final
case class
TransformerTankEnd(TransformerEnd: TransformerEnd = null, phases: String = null, TransformerTank: String = null) extends Element with Product with Serializable
Transformer tank end represents an individual winding for unbalanced models or for transformer tanks connected into a bank (and bank is modelled with the PowerTransformer).
Transformer tank end represents an individual winding for unbalanced models or for transformer tanks connected into a bank (and bank is modelled with the PowerTransformer).
- TransformerEnd
TransformerEnd Reference to the superclass object.
- phases
Describes the phases carried by a conducting equipment.
- TransformerTank
TransformerTank Transformer this winding belongs to.
-
final
case class
TransformerTankInfo(AssetInfo: AssetInfo = null, PowerTransformerInfo: String = null, TransformerEndInfos: List[String] = null) extends Element with Product with Serializable
Set of transformer tank data, from an equipment library.
Set of transformer tank data, from an equipment library.
- AssetInfo
AssetInfo Reference to the superclass object.
- PowerTransformerInfo
PowerTransformerInfo Power transformer data that this tank description is part of.
- TransformerEndInfos
TransformerEndInfo Data for all the ends described by this transformer tank data.
-
final
case class
TransformerTest(IdentifiedObject: IdentifiedObject = null, basePower: Double = 0.0, temperature: Double = 0.0) extends Element with Product with Serializable
Test result for transformer ends, such as short-circuit, open-circuit (excitation) or no-load test.
Test result for transformer ends, such as short-circuit, open-circuit (excitation) or no-load test.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- basePower
Base power at which the tests are conducted, usually equal to the rateds of one of the involved transformer ends.
- temperature
Temperature at which the test is conducted.
-
final
case class
TransmissionCapacity(Element: BasicElement = null, capacityBenefitMargin: Double = 0.0, operationalTransmissionCapacity: Double = 0.0, startOperatingDate: String = null, totalTransmissionCapacity: Double = 0.0, Flowgate: String = null, GenericConstraints: String = null, OTC15min_emergency: Double = 0.0, OTCemergency: Double = 0.0, POD: String = null, POR: String = null) extends Element with Product with Serializable
This class models the transmission (either a transmission interface or a POR/POD pair) capacity including Total Transfer Capacity (TTC), Operating Transfer Capacity (OTC), and Capacity Benefit Margin (CBM).
This class models the transmission (either a transmission interface or a POR/POD pair) capacity including Total Transfer Capacity (TTC), Operating Transfer Capacity (OTC), and Capacity Benefit Margin (CBM).
- Element
Reference to the superclass object.
- capacityBenefitMargin
Capacity Benefit Margin (CBM) is used by Markets to calculate the transmission interface limits. This number could be manually or procedurally determined. The CBM is defined per transmission interface (branch group).
- operationalTransmissionCapacity
The Operational Transmission Capacity (OTC) is the transmission capacity under the operating condition during a specific time period, incorporating the effects of derates and current settings of operation controls. The OTCs for all transmission interface (branch group) are always provided regardless of outage or switching conditions.
- startOperatingDate
Operating date & hour when the entitlement applies
- totalTransmissionCapacity
Total Transmission Capacity
- Flowgate
Flowgate undocumented
- GenericConstraints
GenericConstraints undocumented
- OTC15min_emergency
The Operational Transmission Capacity (OTC) 15 minute Emergency Limit
- OTCemergency
The Operational Transmission Capacity (OTC) Emergency Limit.
- POD
point of delivery
- POR
point of receipt
-
final
case class
TransmissionCorridor(PowerSystemResource: PowerSystemResource = null, ContainedIn: List[String] = null, TransmissionRightOfWays: List[String] = null) extends Element with Product with Serializable
A corridor containing one or more rights of way
A corridor containing one or more rights of way
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- ContainedIn
TransmissionPath A TransmissionPath is contained in a TransmissionCorridor.
- TransmissionRightOfWays
TransmissionRightOfWay A transmission right-of-way is a member of a transmission corridor
-
final
case class
TransmissionInterfaceRightEntitlement(Element: BasicElement = null, entitlement: Double = 0.0, startOperatingDate: String = null, ContractRight: String = null, Flowgate: String = null, POD: String = null, POR: String = null) extends Element with Product with Serializable
This is formally called the branch group ETC/TOR entitlement with the inclusion of CVR as ETC.
This is formally called the branch group ETC/TOR entitlement with the inclusion of CVR as ETC.
This could be also used to represent the TR entitlement on a POR/POD.
- Element
Reference to the superclass object.
- entitlement
the entitlement
- startOperatingDate
Operating date and hour when the entitlement applies
- ContractRight
ContractRight undocumented
- Flowgate
Flowgate undocumented
- POD
point of delivery
- POR
point of receipt
-
final
case class
TransmissionPath(IdentifiedObject: IdentifiedObject = null, availTransferCapability: Double = 0.0, parallelPathFlag: Boolean = false, totalTransferCapability: Double = 0.0, DeliveryPoint: String = null, For: String = null, LocatedOn: List[String] = null, PointOfReceipt: String = null, TransmissionReservation: List[String] = null) extends Element with Product with Serializable
An electrical connection, link, or line consisting of one or more parallel transmission elements between two areas of the interconnected electric systems, or portions thereof.
An electrical connection, link, or line consisting of one or more parallel transmission elements between two areas of the interconnected electric systems, or portions thereof.
TransmissionCorridor and TransmissionRightOfWay refer to legal aspects. The TransmissionPath refers to the segments between a TransmissionProvider's ServicePoints.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- availTransferCapability
The available transmission capability of a transmission path for the reference direction.
- parallelPathFlag
Flag which indicates if the transmission path is also a designated interconnection "parallel path".
- totalTransferCapability
The total transmission capability of a transmission path in the reference direction.
- DeliveryPoint
ServicePoint A transmission path has a "point-of-delivery" service point
- For
TransmissionCorridor A TransmissionPath is contained in a TransmissionCorridor.
- LocatedOn
TransmissionProduct A transmission product is located on a transmission path.
- PointOfReceipt
ServicePoint A transmission path has a "point-of-receipt" service point
- TransmissionReservation
TransmissionReservation undocumented
- final case class TransmissionProduct(IdentifiedObject: IdentifiedObject = null, transmissionProductType: String = null, LocationFor: List[String] = null, TransmissionProvider: String = null) extends Element with Product with Serializable
-
final
case class
TransmissionProvider(Organisation: Organisation = null, For: List[String] = null, TransmissionProducts: List[String] = null) extends Element with Product with Serializable
Provider of the transmission capacity (interconnecting wires between Generation and Consumption) required to fulfill and Energy Transaction's energy exchange.
Provider of the transmission capacity (interconnecting wires between Generation and Consumption) required to fulfill and Energy Transaction's energy exchange.
Posts information for transmission paths and AvailableTransmissionCapacities on a reservation node. Buys and sells its products and services on the same reservation node.
- Organisation
Organisation Reference to the superclass object.
- For
LossProfile Part of the LossProfile for an EnergyTransaction may be a loss for a TransmissionProvider. If so, the TransmissionProvider must be one of the participating entities in the EnergyTransaction.
- TransmissionProducts
TransmissionProduct A TransmissionProvider offers a TransmissionProduct.
-
final
case class
TransmissionReservation(Element: BasicElement = null, EnergyTransaction: String = null, Sink: String = null, Source: String = null, TransactionBid: String = null, TransmissionPath: String = null) extends Element with Product with Serializable
A transmission reservation is obtained from the OASIS system to reserve transmission for a specified time period, transmission path and transmission product.
A transmission reservation is obtained from the OASIS system to reserve transmission for a specified time period, transmission path and transmission product.
- Element
Reference to the superclass object.
- EnergyTransaction
EnergyTransaction undocumented
- Sink
ServicePoint undocumented
- Source
ServicePoint undocumented
- TransactionBid
TransactionBid undocumented
- TransmissionPath
TransmissionPath undocumented
-
final
case class
TransmissionRightChain(IdentifiedObject: IdentifiedObject = null, Chain_ContractRight: String = null, Ind_ContractRight: List[String] = null, RTO: String = null) extends Element with Product with Serializable
Allows chaining of TransmissionContractRights.
Allows chaining of TransmissionContractRights.
Many individual contract rights can be included in the definition of a TransmissionRightChain. A TransmissionRightChain is also defined as a TransmissionContractRight itself.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- Chain_ContractRight
ContractRight undocumented
- Ind_ContractRight
ContractRight undocumented
- RTO
RTO undocumented
-
final
case class
TransmissionRightOfWay(PowerSystemResource: PowerSystemResource = null, MktLine: List[String] = null, TransmissionCorridor: String = null) extends Element with Product with Serializable
A collection of transmission lines that are close proximity to each other.
A collection of transmission lines that are close proximity to each other.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- MktLine
MktLine undocumented
- TransmissionCorridor
TransmissionCorridor A transmission right-of-way is a member of a transmission corridor
-
final
case class
TriggerCondition(IdentifiedObject: IdentifiedObject = null, GateTrigger: String = null, RemedialActionScheme: String = null) extends Element with Product with Serializable
A conditions that can trigger remedial actions.
A conditions that can trigger remedial actions.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- GateTrigger
Gate The resulting Gate that is the condition for the Trigger.
- RemedialActionScheme
RemedialActionScheme undocumented
-
final
case class
TropicalCycloneAustralia(Cyclone: Cyclone = null, category: Int = 0) extends Element with Product with Serializable
A tropical cyclone, a subtype of cyclone that forms to the east of 90°E in the Southern Hemisphere whose intensity is measured by the Australian tropical cyclone intensity scale.
A tropical cyclone, a subtype of cyclone that forms to the east of 90°E in the Southern Hemisphere whose intensity is measured by the Australian tropical cyclone intensity scale.
- Cyclone
Cyclone Reference to the superclass object.
- category
Strength of tropical cyclone during the time interval, based on Australian Bureau of Meteorology Category System where: 1 - tropical cyclone, with typical gusts over flat land 90-125 km/h 2 - tropical cyclone, with typical gusts over flat land 125-164 km/h 3 - severe tropical cyclone, with typical gusts over flat land 165-224 km/h 4 - severe tropical cyclone, with typical gusts over flat land 225-279 km/h 5 - severe tropical cyclone, with typical gusts over flat land greater than 280 km/h.
-
final
case class
TroubleOrder(Document: Document = null, comment: String = null, plannedExecutionInterval: String = null, Incident: String = null, Location: String = null, TroubleTicket: List[String] = null, UnplannedOutage: String = null, WorkTask: List[String] = null) extends Element with Product with Serializable
Trouble order sends an incident to a crew to initiate a response to an unplanned outage.
Trouble order sends an incident to a crew to initiate a response to an unplanned outage.
- Document
Document Reference to the superclass object.
- comment
Free-form comment associated with the trouble order.
- plannedExecutionInterval
The planned start and end time for the trouble order.
- Incident
Incident undocumented
- Location
Location undocumented
- TroubleTicket
TroubleTicket undocumented
- UnplannedOutage
UnplannedOutage undocumented
- WorkTask
WorkTask undocumented
- final case class TroubleTicket(Document: Document = null, comment: String = null, dateTimeOfReport: String = null, firstResponderStatus: String = null, multiplePremises: Boolean = false, reportingKind: String = null, resolvedDateTime: String = null, troubleCode: String = null, Customer: String = null, Incident: String = null, IncidentHazard: List[String] = null, Notification: List[String] = null, ServiceLocation: String = null, TroubleOrder: String = null, UnplannedOutage: String = null) extends Element with Product with Serializable
-
final
case class
Tsunami(HydrosphericPhenomenon: HydrosphericPhenomenon = null, intensity: Int = 0, magnitude: Double = 0.0) extends Element with Product with Serializable
A tsunami (tidal wave), a long high sea wave caused by an earthquake, submarine landslide, or other disturbance.
A tsunami (tidal wave), a long high sea wave caused by an earthquake, submarine landslide, or other disturbance.
- HydrosphericPhenomenon
HydrosphericPhenomenon Reference to the superclass object.
- intensity
Tsunami intensity on the Papadopoulos-Imamura tsunami intensity scale. Possible values are 1-12, corresponding to I-XII.
- magnitude
Tsunami magnitude in the Tsunami Magnitude Scale (Mt). Is greater than zero.
-
final
case class
TurbLCFB1(TurbineLoadControllerDynamics: TurbineLoadControllerDynamics = null, db: Double = 0.0, emax: Double = 0.0, fb: Double = 0.0, fbf: Boolean = false, irmax: Double = 0.0, ki: Double = 0.0, kp: Double = 0.0, mwbase: Double = 0.0, pbf: Boolean = false, pmwset: Double = 0.0, speedReferenceGovernor: Boolean = false, tpelec: Double = 0.0) extends Element with Product with Serializable
Turbine load controller model developed by WECC.
Turbine load controller model developed by WECC.
This model represents a supervisory turbine load controller that acts to maintain turbine power at a set value by continuous adjustment of the turbine governor speed-load reference. This model is intended to represent slow reset 'outer loop' controllers managing the action of the turbine governor.
- TurbineLoadControllerDynamics
TurbineLoadControllerDynamics Reference to the superclass object.
- db
Controller deadband (db). Typical value = 0.
- emax
Maximum control error (Emax) (see parameter detail 4). Typical value = 0,02.
- fb
Frequency bias gain (Fb). Typical value = 0.
- fbf
Frequency bias flag (Fbf). true = enable frequency bias false = disable frequency bias. Typical value = false.
- irmax
Maximum turbine speed/load reference bias (Irmax) (see parameter detail 3). Typical value = 0.
- ki
Integral gain (Ki). Typical value = 0.
- kp
Proportional gain (Kp). Typical value = 0.
- mwbase
Base for power values (MWbase) (> 0). Unit = MW.
- pbf
Power controller flag (Pbf). true = enable load controller false = disable load controller. Typical value = false.
- pmwset
Power controller setpoint (Pmwset) (see parameter detail 1). Unit = MW. Typical value = 0.
- speedReferenceGovernor
Type of turbine governor reference (Type). true = speed reference governor false = load reference governor. Typical value = true.
- tpelec
Power transducer time constant (Tpelec) (>= 0). Typical value = 0.
-
final
case class
TurbineGovernorDynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null, AsynchronousMachineDynamics: String = null, SynchronousMachineDynamics: String = null, TurbineLoadControllerDynamics: String = null) extends Element with Product with Serializable
Turbine-governor function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
Turbine-governor function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- AsynchronousMachineDynamics
AsynchronousMachineDynamics Asynchronous machine model with which this turbine-governor model is associated. TurbineGovernorDynamics shall have either an association to SynchronousMachineDynamics or to AsynchronousMachineDynamics.
- SynchronousMachineDynamics
SynchronousMachineDynamics Synchronous machine model with which this turbine-governor model is associated. TurbineGovernorDynamics shall have either an association to SynchronousMachineDynamics or to AsynchronousMachineDynamics.
- TurbineLoadControllerDynamics
TurbineLoadControllerDynamics Turbine load controller providing input to this turbine-governor.
-
final
case class
TurbineGovernorUserDefined(TurbineGovernorDynamics: TurbineGovernorDynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Turbine-governor function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
Turbine-governor function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
- TurbineGovernorDynamics
TurbineGovernorDynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
TurbineLoadControllerDynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null, TurbineGovernorDynamics: String = null) extends Element with Product with Serializable
Turbine load controller function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
Turbine load controller function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- TurbineGovernorDynamics
TurbineGovernorDynamics Turbine-governor controlled by this turbine load controller.
-
final
case class
TurbineLoadControllerUserDefined(TurbineLoadControllerDynamics: TurbineLoadControllerDynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Turbine load controller function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
Turbine load controller function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
- TurbineLoadControllerDynamics
TurbineLoadControllerDynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
TypeAssetCatalogue(IdentifiedObject: IdentifiedObject = null, status: String = null, TypeAssets: List[String] = null) extends Element with Product with Serializable
Catalogue of generic types of assets (TypeAsset) that may be used for design purposes.
Catalogue of generic types of assets (TypeAsset) that may be used for design purposes.
It is not associated with a particular manufacturer.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- status
undocumented
- TypeAssets
CatalogAssetType undocumented
-
final
case class
TypeMaterial(WorkDocument: WorkDocument = null, costType: String = null, estUnitCost: Double = 0.0, quantity: String = null, stockItem: Boolean = false, CUMaterialItems: List[String] = null, ErpIssueInventories: List[String] = null, ErpReqLineItems: List[String] = null, MaterialItems: List[String] = null) extends Element with Product with Serializable
Documentation for a generic material item that may be used for design, work and other purposes.
Documentation for a generic material item that may be used for design, work and other purposes.
Any number of MaterialItems manufactured by various vendors may be used to perform this TypeMaterial. Note that class analagous to "AssetModel" is not used for material items. This is because in some cases, for example, a utility sets up a Master material record for a 3 inch long half inch diameter steel bolt and they do not necessarily care what specific supplier is providing the material item. As different vendors are used to supply the part, the Stock Code of the material item can stay the same. In other cases, each time the vendor changes, a new stock code is set up so they can track material used by vendor. Therefore a Material Item "Model" is not typically needed.
- WorkDocument
WorkDocument Reference to the superclass object.
- costType
The type of cost to which this Material Item belongs.
- estUnitCost
The estimated unit cost of this type of material, either for a unit cost or cost per unit length. Cost is for material or asset only and does not include labor to install/construct or configure it.
- quantity
The value, unit of measure, and multiplier for the quantity.
- stockItem
True if item is a stock item (default).
- CUMaterialItems
CUMaterialItem undocumented
- ErpIssueInventories
ErpIssueInventory undocumented
- ErpReqLineItems
ErpReqLineItem undocumented
- MaterialItems
MaterialItem undocumented
-
final
case class
UKMinistryOfDefenceStandard(Element: BasicElement = null, standardEdition: String = null, standardNumber: String = null) extends Element with Product with Serializable
Standard published by United Kingdom Ministry of Defence.
Standard published by United Kingdom Ministry of Defence.
- Element
Reference to the superclass object.
- standardEdition
Edition of UK Ministry of Defence standard.
- standardNumber
UK Ministry of Defence standard number.
- final case class Umode(Element: BasicElement = null, Delay: String = null, VSCtype1: String = null) extends Element with Product with Serializable
- final case class UnavailabilityScheduleDependency(IdentifiedObject: IdentifiedObject = null, UnavailabilityScheduleDependsOn: String = null, UnavailabilityScheduleImpacts: String = null) extends Element with Product with Serializable
-
final
case class
UnavailabilitySwitchAction(IdentifiedObject: IdentifiedObject = null, open: Boolean = false) extends Element with Product with Serializable
Relevant switching action for supporting the availability (or unavailability) plans.
Relevant switching action for supporting the availability (or unavailability) plans.
This could open or close a switch that is not directly connected to the unavailable equipment .
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- open
The switch is to be open during the scheduled period.
-
final
case class
UnavailablitySchedule(IdentifiedObject: IdentifiedObject = null, DependsOn: List[String] = null, Impacts: List[String] = null) extends Element with Product with Serializable
A schedule of unavailability for one or more specified equipment that need to follow the same scheduling periods.
A schedule of unavailability for one or more specified equipment that need to follow the same scheduling periods.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- DependsOn
UnavailabilityScheduleDependency undocumented
- Impacts
UnavailabilityScheduleDependency undocumented
-
final
case class
UnderexcLim2Simplified(UnderexcitationLimiterDynamics: UnderexcitationLimiterDynamics = null, kui: Double = 0.0, p0: Double = 0.0, p1: Double = 0.0, q0: Double = 0.0, q1: Double = 0.0, vuimax: Double = 0.0, vuimin: Double = 0.0) extends Element with Product with Serializable
Simplified type UEL2 underexcitation limiter.
Simplified type UEL2 underexcitation limiter.
This model can be derived from UnderexcLimIEEE2. The limit characteristic (look –up table) is a single straight-line, the same as UnderexcLimIEEE2 (see Figure 10.4 (p 32), IEEE 421.5-2005 Section 10.2).
- UnderexcitationLimiterDynamics
UnderexcitationLimiterDynamics Reference to the superclass object.
- kui
Gain Under excitation limiter (KUI). Typical value = 0,1.
- p0
Segment P initial point (P0). Typical value = 0.
- p1
Segment P end point (P1). Typical value = 1.
- q0
Segment Q initial point (Q0). Typical value = -0,31.
- q1
Segment Q end point (Q1). Typical value = -0,1.
- vuimax
Maximum error signal (VUIMAX) (> UnderexcLim2Simplified.vuimin). Typical value = 1.
- vuimin
Minimum error signal (VUIMIN) (< UnderexcLim2Simplified.vuimax). Typical value = 0.
-
final
case class
UnderexcLimIEEE1(UnderexcitationLimiterDynamics: UnderexcitationLimiterDynamics = null, kuc: Double = 0.0, kuf: Double = 0.0, kui: Double = 0.0, kul: Double = 0.0, kur: Double = 0.0, tu1: Double = 0.0, tu2: Double = 0.0, tu3: Double = 0.0, tu4: Double = 0.0, vucmax: Double = 0.0, vuimax: Double = 0.0, vuimin: Double = 0.0, vulmax: Double = 0.0, vulmin: Double = 0.0, vurmax: Double = 0.0) extends Element with Product with Serializable
Type UEL1 model which has a circular limit boundary when plotted in terms of machine reactive power vs.
Type UEL1 model which has a circular limit boundary when plotted in terms of machine reactive power vs. real power output.
Reference: IEEE UEL1 421.5-2005, 10.1.
- UnderexcitationLimiterDynamics
UnderexcitationLimiterDynamics Reference to the superclass object.
- kuc
UEL centre setting (KUC). Typical value = 1,38.
- kuf
UEL excitation system stabilizer gain (KUF). Typical value = 3,3.
- kui
UEL integral gain (KUI). Typical value = 0.
- kul
UEL proportional gain (KUL). Typical value = 100.
- kur
UEL radius setting (KUR). Typical value = 1,95.
- tu1
UEL lead time constant (TU1) (>= 0). Typical value = 0.
- tu2
UEL lag time constant (TU2) (>= 0). Typical value = 0,05.
- tu3
UEL lead time constant (TU3) (>= 0). Typical value = 0.
- tu4
UEL lag time constant (TU4) (>= 0). Typical value = 0.
- vucmax
UEL maximum limit for operating point phasor magnitude (VUCMAX). Typical value = 5,8.
- vuimax
UEL integrator output maximum limit (VUIMAX) (> UnderexcLimIEEE1.vuimin).
- vuimin
UEL integrator output minimum limit (VUIMIN) (< UnderexcLimIEEE1.vuimax).
- vulmax
UEL output maximum limit (VULMAX) (> UnderexcLimIEEE1.vulmin). Typical value = 18.
- vulmin
UEL output minimum limit (VULMIN) (< UnderexcLimIEEE1.vulmax). Typical value = -18.
- vurmax
UEL maximum limit for radius phasor magnitude (VURMAX). Typical value = 5,8.
-
final
case class
UnderexcLimIEEE2(UnderexcitationLimiterDynamics: UnderexcitationLimiterDynamics = null, k1: Double = 0.0, k2: Double = 0.0, kfb: Double = 0.0, kuf: Double = 0.0, kui: Double = 0.0, kul: Double = 0.0, p0: Double = 0.0, p1: Double = 0.0, p10: Double = 0.0, p2: Double = 0.0, p3: Double = 0.0, p4: Double = 0.0, p5: Double = 0.0, p6: Double = 0.0, p7: Double = 0.0, p8: Double = 0.0, p9: Double = 0.0, q0: Double = 0.0, q1: Double = 0.0, q10: Double = 0.0, q2: Double = 0.0, q3: Double = 0.0, q4: Double = 0.0, q5: Double = 0.0, q6: Double = 0.0, q7: Double = 0.0, q8: Double = 0.0, q9: Double = 0.0, tu1: Double = 0.0, tu2: Double = 0.0, tu3: Double = 0.0, tu4: Double = 0.0, tul: Double = 0.0, tup: Double = 0.0, tuq: Double = 0.0, tuv: Double = 0.0, vuimax: Double = 0.0, vuimin: Double = 0.0, vulmax: Double = 0.0, vulmin: Double = 0.0) extends Element with Product with Serializable
Type UEL2 underexcitation limiter which has either a straight-line or multi-segment characteristic when plotted in terms of machine reactive power output vs.
Type UEL2 underexcitation limiter which has either a straight-line or multi-segment characteristic when plotted in terms of machine reactive power output vs. real power output.
Reference: IEEE UEL2 421.5-2005, 10.2 (limit characteristic lookup table shown in Figure 10.4 (p 32)).
- UnderexcitationLimiterDynamics
UnderexcitationLimiterDynamics Reference to the superclass object.
- k1
UEL terminal voltage exponent applied to real power input to UEL limit look-up table (k1). Typical value = 2.
- k2
UEL terminal voltage exponent applied to reactive power output from UEL limit look-up table (k2). Typical value = 2.
- kfb
Gain associated with optional integrator feedback input signal to UEL (KFB). Typical value = 0.
- kuf
UEL excitation system stabilizer gain (KUF). Typical value = 0.
- kui
UEL integral gain (KUI). Typical value = 0,5.
- kul
UEL proportional gain (KUL). Typical value = 0,8.
- p0
Real power values for endpoints (P0). Typical value = 0.
- p1
Real power values for endpoints (P1). Typical value = 0,3.
- p10
Real power values for endpoints (P10).
- p2
Real power values for endpoints (P2). Typical value = 0,6.
- p3
Real power values for endpoints (P3). Typical value = 0,9.
- p4
Real power values for endpoints (P4). Typical value = 1,02.
- p5
Real power values for endpoints (P5).
- p6
Real power values for endpoints (P6).
- p7
Real power values for endpoints (P7).
- p8
Real power values for endpoints (P8).
- p9
Real power values for endpoints (P9).
- q0
Reactive power values for endpoints (Q0). Typical value = -0,31.
- q1
Reactive power values for endpoints (Q1). Typical value = -0,31.
- q10
Reactive power values for endpoints (Q10).
- q2
Reactive power values for endpoints (Q2). Typical value = -0,28.
- q3
Reactive power values for endpoints (Q3). Typical value = -0,21.
- q4
Reactive power values for endpoints (Q4). Typical value = 0.
- q5
Reactive power values for endpoints (Q5).
- q6
Reactive power values for endpoints (Q6).
- q7
Reactive power values for endpoints (Q7).
- q8
Reactive power values for endpoints (Q8).
- q9
Reactive power values for endpoints (Q9).
- tu1
UEL lead time constant (TU1) (>= 0). Typical value = 0.
- tu2
UEL lag time constant (TU2) (>= 0). Typical value = 0.
- tu3
UEL lead time constant (TU3) (>= 0). Typical value = 0.
- tu4
UEL lag time constant (TU4) (>= 0). Typical value = 0.
- tul
Time constant associated with optional integrator feedback input signal to UEL (TUL) (>= 0). Typical value = 0.
- tup
Real power filter time constant (TUP) (>= 0). Typical value = 5.
- tuq
Reactive power filter time constant (TUQ) (>= 0). Typical value = 0.
- tuv
Voltage filter time constant (TUV) (>= 0). Typical value = 5.
- vuimax
UEL integrator output maximum limit (VUIMAX) (> UnderexcLimIEEE2.vuimin). Typical value = 0,25.
- vuimin
UEL integrator output minimum limit (VUIMIN) (< UnderexcLimIEEE2.vuimax). Typical value = 0.
- vulmax
UEL output maximum limit (VULMAX) (> UnderexcLimIEEE2.vulmin). Typical value = 0,25.
- vulmin
UEL output minimum limit (VULMIN) (< UnderexcLimIEEE2.vulmax). Typical value = 0.
-
final
case class
UnderexcLimX1(UnderexcitationLimiterDynamics: UnderexcitationLimiterDynamics = null, k: Double = 0.0, kf2: Double = 0.0, km: Double = 0.0, melmax: Double = 0.0, tf2: Double = 0.0, tm: Double = 0.0) extends Element with Product with Serializable
<font color="#0f0f0f">Allis-Chalmers minimum excitation limiter.</font>
<font color="#0f0f0f">Allis-Chalmers minimum excitation limiter.</font>
- UnderexcitationLimiterDynamics
UnderexcitationLimiterDynamics Reference to the superclass object.
- k
Minimum excitation limit slope (K) (> 0).
- kf2
Differential gain (KF2).
- km
Minimum excitation limit gain (KM).
- melmax
Minimum excitation limit value (MELMAX).
- tf2
Differential time constant (TF2) (>= 0).
- tm
Minimum excitation limit time constant (TM) (>= 0).
-
final
case class
UnderexcLimX2(UnderexcitationLimiterDynamics: UnderexcitationLimiterDynamics = null, kf2: Double = 0.0, km: Double = 0.0, melmax: Double = 0.0, qo: Double = 0.0, r: Double = 0.0, tf2: Double = 0.0, tm: Double = 0.0) extends Element with Product with Serializable
<font color="#0f0f0f">Westinghouse minimum excitation limiter.</font>
<font color="#0f0f0f">Westinghouse minimum excitation limiter.</font>
- UnderexcitationLimiterDynamics
UnderexcitationLimiterDynamics Reference to the superclass object.
- kf2
Differential gain (KF2).
- km
Minimum excitation limit gain (KM).
- melmax
Minimum excitation limit value (MELMAX).
- qo
Excitation centre setting (QO).
- r
Excitation radius (R).
- tf2
Differential time constant (TF2) (>= 0).
- tm
Minimum excitation limit time constant (TM) (>= 0).
-
final
case class
UnderexcitationLimiterDynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null, ExcitationSystemDynamics: String = null, RemoteInputSignal: String = null) extends Element with Product with Serializable
Underexcitation limiter function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
Underexcitation limiter function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- ExcitationSystemDynamics
ExcitationSystemDynamics Excitation system model with which this underexcitation limiter model is associated.
- RemoteInputSignal
RemoteInputSignal Remote input signal used by this underexcitation limiter model.
-
final
case class
UnderexcitationLimiterUserDefined(UnderexcitationLimiterDynamics: UnderexcitationLimiterDynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Underexcitation limiter function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
Underexcitation limiter function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
- UnderexcitationLimiterDynamics
UnderexcitationLimiterDynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
UndergroundStructure(Structure: Structure = null, hasVentilation: Boolean = false, kind: String = null, material: String = null, sealingWarrantyExpiresDate: String = null) extends Element with Product with Serializable
Underground structure.
Underground structure.
- Structure
Structure Reference to the superclass object.
- hasVentilation
True if vault is ventilating.
- kind
True if vault is ventilating.
- material
Primary material of underground structure.
- sealingWarrantyExpiresDate
Date sealing warranty expires.
-
final
case class
UnitInitialConditions(IdentifiedObject: IdentifiedObject = null, cumEnergy: Double = 0.0, cumStatusChanges: Int = 0, numberOfStartups: Int = 0, onlineStatus: Boolean = false, resourceMW: Double = 0.0, resourceStatus: Int = 0, statusDate: String = null, timeInStatus: Double = 0.0, timeInterval: String = null, GeneratingUnit: String = null) extends Element with Product with Serializable
Resource status at the end of a given clearing period.
Resource status at the end of a given clearing period.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- cumEnergy
Cumulative energy production over trading period.
- cumStatusChanges
Cumulative number of status changes of the resource.
- numberOfStartups
Number of start ups in the Operating Day until the end of previous hour.
- onlineStatus
'true' if the GeneratingUnit is currently On-Line
- resourceMW
Resource MW output at the end of previous clearing period.
- resourceStatus
Resource status at the end of previous clearing period: 0 - off-line 1 - on-line production 2 - in shutdown process 3 - in startup process
- statusDate
Time and date for resourceStatus
- timeInStatus
Time in market trading intervals the resource is in the state as of the end of the previous clearing period.
- timeInterval
Time interval
- GeneratingUnit
RegisteredGenerator undocumented
-
final
case class
Unit_(Element: BasicElement = null, name: String = null, AceTariffType: List[String] = null, TimeSeries: List[String] = null) extends Element with Product with Serializable
The identification of the unit name for the time series quantities.
The identification of the unit name for the time series quantities.
- Element
Reference to the superclass object.
- name
The coded representation of the unit.
- AceTariffType
AceTariffType undocumented
- TimeSeries
TimeSeries undocumented
-
case class
Unknown(Element: Element = null, guts: String, line: Int, start: Long, end: Long) extends Element with Product with Serializable
Unknown element.
Unknown element.
Default parsed element, when no other more specific class applies.
- Element
Reference to the superclass object.
- guts
Internal contents of the XML element with the unrecognized name.
- line
The line number on which the unknown XML element starts, in Spark this is relative to the split being processed.
- start
The starting character position of the unknown XML element, in Spark this is relative to the split being processed.
- end
The ending character position of the unknown XML element, in Spark this is relative to the split being processed.
-
final
case class
UnplannedOutage(Outage: Outage = null, cause: String = null, causeKind: String = null, reportedStartTime: String = null, FieldDispatchHistory: String = null, Incident: List[String] = null, TroubleOrder: List[String] = null, TroubleTicket: List[String] = null) extends Element with Product with Serializable
Document describing the consequence of an unplanned outage in a part of the electrical network.
Document describing the consequence of an unplanned outage in a part of the electrical network.
For the purposes of this model, an unplanned outage refers to a state where energy is not delivered; such as, customers out of service, a street light is not served, etc. A unplanned outage may be created upon: - impacts the SAIDI calculation - a breaker trip, - a fault indicator status change, - a meter event indicating customer outage, - a reception of one or more customer trouble calls, or - an operator command, reflecting information obtained from the field crew. Outage restoration may be performed using a switching plan which complements the outage information with detailed switching activities, including the relationship to the crew and work.
- Outage
Outage Reference to the superclass object.
- cause
The cause of this outage. This is the cause that is used to present to external entities. That is, the cause is weather, equipment failure, etc. Note: At present, this is a free text; could be replaced with a separate associated class in case we have multiple causes (e.g. OutageCauseType, inheriting from IdentifiedObject).
- causeKind
undocumented
- reportedStartTime
The earliest start time of the Outage - as reported by some system or individual
- FieldDispatchHistory
FieldDispatchHistory undocumented
- Incident
Incident undocumented
- TroubleOrder
TroubleOrder undocumented
- TroubleTicket
TroubleTicket undocumented
-
final
case class
Usage(WorkIdentifiedObject: WorkIdentifiedObject = null, status: String = null, WorkTask: String = null) extends Element with Product with Serializable
The way material and assets are used to perform a certain type of work task.
The way material and assets are used to perform a certain type of work task.
The way is described in text in the inheritied description attribute.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- status
undocumented
- WorkTask
OldWorkTask undocumented
-
final
case class
UsagePoint(IdentifiedObject: IdentifiedObject = null, amiBillingReady: String = null, checkBilling: Boolean = false, connectionCategory: String = null, connectionState: String = null, disconnectionMethod: String = null, estimatedLoad: Double = 0.0, grounded: Boolean = false, isSdp: Boolean = false, isVirtual: Boolean = false, minimalUsageExpected: Boolean = false, nominalServiceVoltage: Double = 0.0, outageRegion: String = null, phaseCode: String = null, phaseCount: Int = 0, physicalConnectionCapacity: String = null, ratedCurrent: Double = 0.0, ratedPower: Double = 0.0, readCycle: String = null, readRoute: String = null, serviceDeliveryRemark: String = null, servicePriority: String = null, ConfigurationEvents: List[String] = null, CustomerAgreement: String = null, EndDeviceControls: List[String] = null, EndDeviceEvents: List[String] = null, EndDevices: List[String] = null, EnvironmentalMonitoringStation: String = null, Equipments: List[String] = null, MeterReadings: List[String] = null, MeterServiceWorkTasks: List[String] = null, MetrologyRequirements: List[String] = null, Outage: List[String] = null, PricingStructures: List[String] = null, Register: List[String] = null, ServiceCategory: String = null, ServiceLocation: String = null, ServiceMultipliers: List[String] = null, ServiceSupplier: String = null, UsagePointGroups: List[String] = null, UsagePointLocation: String = null) extends Element with Product with Serializable
Logical or physical point in the network to which readings or events may be attributed.
Logical or physical point in the network to which readings or events may be attributed.
Used at the place where a physical or virtual meter may be located; however, it is not required that a meter be present.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- amiBillingReady
Tracks the lifecycle of the metering installation at a usage point with respect to readiness for billing via advanced metering infrastructure reads.
- checkBilling
True if as a result of an inspection or otherwise, there is a reason to suspect that a previous billing may have been performed with erroneous data. Value should be reset once this potential discrepancy has been resolved.
- connectionCategory
A code used to specify the connection category, e.g., low voltage or low pressure, where the usage point is defined.
- connectionState
State of the usage point with respect to connection to the network.
- disconnectionMethod
Is an indication of how the usage point is physically connected or disconnected.
- estimatedLoad
Estimated load.
- grounded
True if grounded.
- isSdp
If true, this usage point is a service delivery point, i.e., a usage point where the ownership of the service changes hands.
- isVirtual
If true, this usage point is virtual, i.e., no physical location exists in the network where a meter could be located to collect the meter readings. For example, one may define a virtual usage point to serve as an aggregation of usage for all of a company's premises distributed widely across the distribution territory. Otherwise, the usage point is physical, i.e., there is a logical point in the network where a meter could be located to collect meter readings.
- minimalUsageExpected
If true, minimal or zero usage is expected at this usage point for situations such as premises vacancy, logical or physical disconnect. It is used for readings validation and estimation.
- nominalServiceVoltage
Nominal service voltage.
- outageRegion
Outage region in which this usage point is located.
- phaseCode
Phase code. Number of wires and specific nominal phases can be deduced from enumeration literal values. For example, ABCN is three-phase, four-wire, s12n (splitSecondary12N) is single-phase, three-wire, and s1n and s2n are single-phase, two-wire.
- phaseCount
Number of potential phases the Usage Point supports, typically 0, 1 or 3.
- physicalConnectionCapacity
Quantitative information about the maximum physical capacity of the connection for the usage point.
- ratedCurrent
Current flow that this usage point is configured to deliver.
- ratedPower
Active power that this usage point is configured to deliver.
- readCycle
Cycle day on which the meter for this usage point will normally be read. Usually correlated with the billing cycle.
- readRoute
Identifier of the route to which this usage point is assigned for purposes of meter reading. Typically used to configure hand held meter reading systems prior to collection of reads.
- serviceDeliveryRemark
Remarks about this usage point, for example the reason for it being rated with a non-nominal priority.
- servicePriority
Priority of service for this usage point. Note that usage points at the same service location can have different priorities.
- ConfigurationEvents
ConfigurationEvent All configuration events created for this usage point.
- CustomerAgreement
CustomerAgreement Customer agreement regulating this service delivery point.
- EndDeviceControls
EndDeviceControl All end device controls sending commands to this usage point.
- EndDeviceEvents
EndDeviceEvent All end device events reported for this usage point.
- EndDevices
EndDevice All end devices at this usage point.
- EnvironmentalMonitoringStation
EnvironmentalMonitoringStation undocumented
- Equipments
Equipment All equipment connecting this usage point to the electrical grid.
- MeterReadings
MeterReading All meter readings obtained from this usage point.
- MeterServiceWorkTasks
MeterWorkTask All meter service work tasks at this usage point.
- MetrologyRequirements
MetrologyRequirement All metrology requirements for this usage point.
- Outage
Outage All outages at this usage point.
- PricingStructures
PricingStructure All pricing structures applicable to this service delivery point (with prepayment meter running as a stand-alone device, with no CustomerAgreement or Customer).
- Register
Register undocumented
- ServiceCategory
ServiceCategory Service category delivered by this usage point.
- ServiceLocation
ServiceLocation Service location where the service delivered by this usage point is consumed.
- ServiceMultipliers
ServiceMultiplier All multipliers applied at this usage point.
- ServiceSupplier
ServiceSupplier ServiceSupplier (utility) utilising this usage point to deliver a service.
- UsagePointGroups
UsagePointGroup All groups to which this usage point belongs.
- UsagePointLocation
UsagePointLocation Location of this usage point.
-
final
case class
UsagePointGroup(IdentifiedObject: IdentifiedObject = null, type: String = null, DemandResponsePrograms: List[String] = null, EndDeviceControls: List[String] = null, UsagePoints: List[String] = null) extends Element with Product with Serializable
Abstraction for management of group communications within a two-way AMR system or the data for a group of related usage points.
Abstraction for management of group communications within a two-way AMR system or the data for a group of related usage points.
Commands can be issued to all of the usage points that belong to a usage point group using a defined group address and the underlying AMR communication infrastructure.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- type
Type of this group.
- DemandResponsePrograms
DemandResponseProgram All demand response programs this usage point group is enrolled in.
- EndDeviceControls
EndDeviceControl All end device controls sending commands to this usage point group.
- UsagePoints
UsagePoint All usage points in this group.
-
final
case class
UsagePointLocation(Location: Location = null, accessMethod: String = null, remark: String = null, siteAccessProblem: String = null, UsagePoints: List[String] = null) extends Element with Product with Serializable
Location of an individual usage point.
Location of an individual usage point.
- Location
Location Reference to the superclass object.
- accessMethod
Method for the service person to access this usage point location. For example, a description of where to obtain a key if the facility is unmanned and secured.
- remark
Remarks about this location.
- siteAccessProblem
Problems previously encountered when visiting or performing work at this location. Examples include: bad dog, violent customer, verbally abusive occupant, obstructions, safety hazards, etc.
- UsagePoints
UsagePoint All usage points at this location.
-
final
case class
UserAttribute(Element: BasicElement = null, name: String = null, sequenceNumber: Int = 0, value: String = null, ErpInvoiceLineItems: List[String] = null, ErpLedgerEntries: List[String] = null, ProcedureDataSets: List[String] = null, PropertySpecification: String = null, RatingSpecification: String = null, Transaction: String = null) extends Element with Product with Serializable
Generic name-value pair class, with optional sequence number and units for value; can be used to model parts of information exchange when concrete types are not known in advance.
Generic name-value pair class, with optional sequence number and units for value; can be used to model parts of information exchange when concrete types are not known in advance.
- Element
Reference to the superclass object.
- name
Name of an attribute.
- sequenceNumber
Sequence number for this attribute in a list of attributes.
- value
Value of an attribute, including unit information.
- ErpInvoiceLineItems
ErpInvoiceLineItem undocumented
- ErpLedgerEntries
ErpLedgerEntry undocumented
- ProcedureDataSets
ProcedureDataSet undocumented
- PropertySpecification
Specification undocumented
- RatingSpecification
Specification undocumented
- Transaction
Transaction Transaction for which this snapshot has been recorded.
-
final
case class
VAdjIEEE(VoltageAdjusterDynamics: VoltageAdjusterDynamics = null, adjslew: Double = 0.0, taoff: Double = 0.0, taon: Double = 0.0, vadjf: Double = 0.0, vadjmax: Double = 0.0, vadjmin: Double = 0.0) extends Element with Product with Serializable
IEEE voltage adjuster which is used to represent the voltage adjuster in either a power factor or VAr control system.
IEEE voltage adjuster which is used to represent the voltage adjuster in either a power factor or VAr control system.
Reference: IEEE 421.5-2005, 11.1.
- VoltageAdjusterDynamics
VoltageAdjusterDynamics Reference to the superclass object.
- adjslew
Rate at which output of adjuster changes (ADJ_SLEW). Unit = s / PU. Typical value = 300.
- taoff
Time that adjuster pulses are off (TAOFF) (>= 0). Typical value = 0,5.
- taon
Time that adjuster pulses are on (TAON) (>= 0). Typical value = 0,1.
- vadjf
Set high to provide a continuous raise or lower (VADJF).
- vadjmax
Maximum output of the adjuster (VADJMAX) (> VAdjIEEE.vadjmin). Typical value = 1,1.
- vadjmin
Minimum output of the adjuster (VADJMIN) (< VAdjIEEE.vadjmax). Typical value = 0,9.
-
final
case class
VCompIEEEType1(VoltageCompensatorDynamics: VoltageCompensatorDynamics = null, rc: Double = 0.0, tr: Double = 0.0, xc: Double = 0.0) extends Element with Product with Serializable
<font color="#0f0f0f">Terminal voltage transducer and load compensator as defined in IEEE 421.5-2005, 4.
<font color="#0f0f0f">Terminal voltage transducer and load compensator as defined in IEEE 421.5-2005, 4.
This model is common to all excitation system models described in the IEEE Standard. </font> <font color="#0f0f0f">Parameter details:</font>
- <font color="#0f0f0f">If Rc and Xc are set to zero, the l</font>oad compensation is not employed and the behaviour is as a simple sensing circuit.
- If all parameters (Rc, Xc and Tr) are set to zero, the standard model VCompIEEEType1 is bypassed.
Reference: IEEE 421.5-2005 4.
- VoltageCompensatorDynamics
VoltageCompensatorDynamics Reference to the superclass object.
- rc
<font color="#0f0f0f">Resistive component of compensation of a generator (Rc) (>= 0).</font>
- tr
<font color="#0f0f0f">Time constant which is used for the combined voltage sensing and compensation signal (Tr) (>= 0).</font>
- xc
<font color="#0f0f0f">Reactive component of compensation of a generator (Xc) (>= 0).</font>
-
final
case class
VCompIEEEType2(VoltageCompensatorDynamics: VoltageCompensatorDynamics = null, tr: Double = 0.0, GenICompensationForGenJ: List[String] = null) extends Element with Product with Serializable
<font color="#0f0f0f">Terminal voltage transducer and load compensator as defined in IEEE 421.5-2005, 4.
<font color="#0f0f0f">Terminal voltage transducer and load compensator as defined in IEEE 421.5-2005, 4.
This model is designed to cover the following types of compensation: </font>
- <font color="#0f0f0f">reactive droop;</font>
- <font color="#0f0f0f">transformer-drop or line-drop compensation;</font>
- <font color="#0f0f0f">reactive differential compensation known also as cross-current compensation.</font>
<font color="#0f0f0f">Reference: IEEE 421.5-2005, 4.</font>
- VoltageCompensatorDynamics
VoltageCompensatorDynamics Reference to the superclass object.
- tr
<font color="#0f0f0f">Time constant which is used for the combined voltage sensing and compensation signal (Tr) (>= 0).</font>
- GenICompensationForGenJ
GenICompensationForGenJ Compensation of this voltage compensator's generator for current flow out of another generator.
- final case class VDCOL(Element: BasicElement = null) extends Element with Product with Serializable
-
final
case class
VSCDynamics(HVDCDynamics: HVDCDynamics = null, VsConverter: String = null) extends Element with Product with Serializable
VSC function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
VSC function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
- HVDCDynamics
HVDCDynamics Reference to the superclass object.
- VsConverter
VsConverter Voltage source converter to which voltage source converter dynamics model applies.
-
final
case class
VSCUserDefined(VSCDynamics: VSCDynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Voltage source converter (VSC) function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
Voltage source converter (VSC) function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
- VSCDynamics
VSCDynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
- final case class VSCtype1(VSCDynamics: VSCDynamics = null, BlockingFunction: String = null, DCvoltageControl: String = null, PFmodel: String = null, Pcontrol: String = null, Qlimiter: String = null, Qmode: String = null, Qregulator: String = null, Umode: String = null) extends Element with Product with Serializable
-
final
case class
ValueAliasSet(IdentifiedObject: IdentifiedObject = null, Commands: List[String] = null, Discretes: List[String] = null, RaiseLowerCommands: List[String] = null, Values: List[String] = null) extends Element with Product with Serializable
Describes the translation of a set of values into a name and is intendend to facilitate custom translations.
Describes the translation of a set of values into a name and is intendend to facilitate custom translations.
Each ValueAliasSet has a name, description etc. A specific Measurement may represent a discrete state like Open, Closed, Intermediate etc. This requires a translation from the MeasurementValue.value number to a string, e.g. 0->"Invalid", 1->"Open", 2->"Closed", 3->"Intermediate". Each ValueToAlias member in ValueAliasSet.Value describe a mapping for one particular value to a name.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- Commands
Command The Commands using the set for translation.
- Discretes
Discrete The Measurements using the set for translation.
- RaiseLowerCommands
RaiseLowerCommand The Commands using the set for translation.
- Values
ValueToAlias The ValueToAlias mappings included in the set.
-
final
case class
ValueToAlias(IdentifiedObject: IdentifiedObject = null, value: Int = 0, ValueAliasSet: String = null) extends Element with Product with Serializable
Describes the translation of one particular value into a name, e.g.
Describes the translation of one particular value into a name, e.g. 1 as "Open".
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- value
The value that is mapped.
- ValueAliasSet
ValueAliasSet The ValueAliasSet having the ValueToAlias mappings.
-
final
case class
Vehicle(WorkAsset: WorkAsset = null, odometerReadDateTime: String = null, odometerReading: Double = 0.0, usageKind: String = null) extends Element with Product with Serializable
Vehicle asset.
Vehicle asset.
- WorkAsset
WorkAsset Reference to the superclass object.
- odometerReadDateTime
Date and time the last odometer reading was recorded.
- odometerReading
Odometer reading of this vehicle as of the 'odometerReadingDateTime'. Refer to associated ActivityRecords for earlier readings.
- usageKind
Kind of usage of the vehicle.
-
final
case class
Vendor(IdentifiedObject: IdentifiedObject = null, VendorShifts: List[String] = null) extends Element with Product with Serializable
The entity that owns the point of sale and contracts with the cashier to receipt payments and vend tokens using the payment system.
The entity that owns the point of sale and contracts with the cashier to receipt payments and vend tokens using the payment system.
The vendor has a private contract with and is managed by the merchant which is a type of organisation. The vendor is accountable to the merchant for revenue collected, and the merchant is in turn accountable to the supplier.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- VendorShifts
VendorShift All vendor shifts opened and owned by this vendor.
-
final
case class
VendorShift(Shift: Shift = null, merchantDebitAmount: Double = 0.0, posted: Boolean = false, MerchantAccount: String = null, Receipts: List[String] = null, Transactions: List[String] = null, Vendor: String = null) extends Element with Product with Serializable
The operating shift for a vendor during which the vendor may transact against the merchant's account.
The operating shift for a vendor during which the vendor may transact against the merchant's account.
It aggregates transactions and receipts during the shift and periodically debits a merchant account. The totals in vendor shift should always be the sum of totals aggregated in all cashier shifts that were open under the particular vendor shift.
- Shift
Shift Reference to the superclass object.
- merchantDebitAmount
The amount that is to be debited from the merchant account for this vendor shift. This amount reflects the sum(PaymentTransaction.transactionAmount).
- posted
If true, merchantDebitAmount has been debited from MerchantAccount; typically happens at the end of VendorShift when it closes.
- MerchantAccount
MerchantAccount Merchant account this vendor shift periodically debits (based on aggregated transactions).
- Receipts
Receipt All receipts recorded during this vendor shift.
- Transactions
Transaction All transactions recorded during this vendor shift.
- Vendor
Vendor Vendor that opens and owns this vendor shift.
-
final
case class
VerificationAction(SwitchingAction: SwitchingAction = null, verificationCondition: String = null, PowerSystemResource: String = null) extends Element with Product with Serializable
Verification of a switch position or other condition as a switching step
Verification of a switch position or other condition as a switching step
- SwitchingAction
SwitchingAction Reference to the superclass object.
- verificationCondition
freeform description of the condition to be verified
- PowerSystemResource
PowerSystemResource undocumented
-
final
case class
Version(Element: BasicElement = null, date: String = null, major: Int = 0, minor: Int = 0, revision: Int = 0) extends Element with Product with Serializable
This is the version for a group of devices or objects.
This is the version for a group of devices or objects.
This could be used to track the version for any group of objects or devices over time. For example, for a DERGroup, the requesting system may want to get the details of a specific version of a DERGroup.
- Element
Reference to the superclass object.
- date
date of this version
- major
major release level for this version
- minor
minor release level for this version
- revision
revision level for this version
-
final
case class
ViolationLimit(Limit: Limit = null, enforced: Boolean = false, Flowgate: String = null, MktMeasurement: String = null) extends Element with Product with Serializable
A type of limit that indicates if it is enforced and, through association, the organisation responsible for setting the limit.
A type of limit that indicates if it is enforced and, through association, the organisation responsible for setting the limit.
- Limit
Limit Reference to the superclass object.
- enforced
True if limit is enforced.
- Flowgate
Flowgate undocumented
- MktMeasurement
MktMeasurement undocumented
-
final
case class
VisibilityLayer(IdentifiedObject: IdentifiedObject = null, drawingOrder: Int = 0, VisibleObjects: List[String] = null) extends Element with Product with Serializable
Layers are typically used for grouping diagram objects according to themes and scales.
Layers are typically used for grouping diagram objects according to themes and scales.
Themes are used to display or hide certain information (e.g., lakes, borders), while scales are used for hiding or displaying information depending on the current zoom level (hide text when it is too small to be read, or when it exceeds the screen size). This is also called de-cluttering. CIM based graphics exchange supports an m:n relationship between diagram objects and layers. The importing system shall convert an m:n case into an appropriate 1:n representation if the importing system does not support m:n.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- drawingOrder
The drawing order for this layer. The higher the number, the later the layer and the objects within it are rendered.
- VisibleObjects
DiagramObject A visibility layer can contain one or more diagram objects.
-
final
case class
VolcanicAshCloud(AtmosphericPhenomenon: AtmosphericPhenomenon = null, density: Double = 0.0, particleSize: Double = 0.0) extends Element with Product with Serializable
An ash cloud formed as a result of a volcanic eruption.
An ash cloud formed as a result of a volcanic eruption.
- AtmosphericPhenomenon
AtmosphericPhenomenon Reference to the superclass object.
- density
Particulate density of the ash cloud during the time interval.
- particleSize
The diameter of the particles during the time interval.
-
final
case class
VoltageAdjusterDynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null, PFVArControllerType1Dynamics: String = null) extends Element with Product with Serializable
Voltage adjuster function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
Voltage adjuster function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- PFVArControllerType1Dynamics
PFVArControllerType1Dynamics Power factor or VAr controller type 1 model with which this voltage adjuster is associated.
-
final
case class
VoltageAdjusterUserDefined(VoltageAdjusterDynamics: VoltageAdjusterDynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
<font color="#0f0f0f">Voltage adjuster</font> function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
<font color="#0f0f0f">Voltage adjuster</font> function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
- VoltageAdjusterDynamics
VoltageAdjusterDynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
VoltageCompensatorDynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null, ExcitationSystemDynamics: String = null, RemoteInputSignal: String = null) extends Element with Product with Serializable
Voltage compensator function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
Voltage compensator function block whose behaviour is described by reference to a standard model <font color="#0f0f0f">or by definition of a user-defined model.</font>
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- ExcitationSystemDynamics
ExcitationSystemDynamics Excitation system model with which this voltage compensator is associated.
- RemoteInputSignal
RemoteInputSignal Remote input signal used by this voltage compensator model.
-
final
case class
VoltageCompensatorUserDefined(VoltageCompensatorDynamics: VoltageCompensatorDynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Voltage compensator function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
Voltage compensator function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
- VoltageCompensatorDynamics
VoltageCompensatorDynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
VoltageControlZone(PowerSystemResource: PowerSystemResource = null, BusbarSection: String = null, RegulationSchedule: String = null) extends Element with Product with Serializable
An area of the power system network which is defined for secondary voltage control purposes.
An area of the power system network which is defined for secondary voltage control purposes.
A voltage control zone consists of a collection of substations with a designated bus bar section whose voltage will be controlled.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- BusbarSection
BusbarSection A VoltageControlZone is controlled by a designated BusbarSection.
- RegulationSchedule
RegulationSchedule A VoltageControlZone may have a voltage regulation schedule.
-
final
case class
VoltageLevel(EquipmentContainer: EquipmentContainer = null, highVoltageLimit: Double = 0.0, lowVoltageLimit: Double = 0.0, BaseVoltage: String = null, Bays: List[String] = null, Substation: String = null) extends Element with Product with Serializable
A collection of equipment at one common system voltage forming a switchgear.
A collection of equipment at one common system voltage forming a switchgear.
The equipment typically consists of breakers, busbars, instrumentation, control, regulation and protection devices as well as assemblies of all these.
- EquipmentContainer
EquipmentContainer Reference to the superclass object.
- highVoltageLimit
The bus bar's high voltage limit. The limit applies to all equipment and nodes contained in a given VoltageLevel. It is not required that it is exchanged in pair with lowVoltageLimit. It is preferable to use operational VoltageLimit, which prevails, if present.
- lowVoltageLimit
The bus bar's low voltage limit. The limit applies to all equipment and nodes contained in a given VoltageLevel. It is not required that it is exchanged in pair with highVoltageLimit. It is preferable to use operational VoltageLimit, which prevails, if present.
- BaseVoltage
BaseVoltage The base voltage used for all equipment within the voltage level.
- Bays
Bay The bays within this voltage level.
- Substation
Substation The substation of the voltage level.
-
final
case class
VoltageLimit(OperationalLimit: OperationalLimit = null, normalValue: Double = 0.0, value: Double = 0.0) extends Element with Product with Serializable
Operational limit applied to voltage.
Operational limit applied to voltage.
The use of operational VoltageLimit is preferred instead of limits defined at VoltageLevel. The operational VoltageLimits are used, if present.
- OperationalLimit
OperationalLimit Reference to the superclass object.
- normalValue
The normal limit on voltage. High or low limit nature of the limit depends upon the properties of the operational limit type. The attribute shall be a positive value or zero.
- value
Limit on voltage. High or low limit nature of the limit depends upon the properties of the operational limit type. The attribute shall be a positive value or zero.
-
final
case class
VsCapabilityCurve(Curve: Curve = null, VsConverterDCSides: List[String] = null) extends Element with Product with Serializable
The P-Q capability curve for a voltage source converter, with P on X-axis and Qmin and Qmax on Y1-axis and Y2-axis.
The P-Q capability curve for a voltage source converter, with P on X-axis and Qmin and Qmax on Y1-axis and Y2-axis.
- Curve
Curve Reference to the superclass object.
- VsConverterDCSides
VsConverter All converters with this capability curve.
-
final
case class
VsConverter(ACDCConverter: ACDCConverter = null, delta: Double = 0.0, droop: Double = 0.0, droopCompensation: Double = 0.0, maxModulationIndex: Double = 0.0, maxValveCurrent: Double = 0.0, pPccControl: String = null, qPccControl: String = null, qShare: Double = 0.0, targetPWMfactor: Double = 0.0, targetPhasePcc: Double = 0.0, targetPowerFactorPcc: Double = 0.0, targetQpcc: Double = 0.0, targetUpcc: Double = 0.0, uv: Double = 0.0, CapabilityCurve: String = null, VSCDynamics: String = null) extends Element with Product with Serializable
DC side of the voltage source converter (VSC).
DC side of the voltage source converter (VSC).
- ACDCConverter
ACDCConverter Reference to the superclass object.
- delta
Angle between VsConverter.uv and ACDCConverter.uc. It is converter’s state variable used in power flow. The attribute shall be a positive value or zero.
- droop
Droop constant. The pu value is obtained as D [kV/MW] x Sb / Ubdc. The attribute shall be a positive value.
- droopCompensation
Compensation constant. Used to compensate for voltage drop when controlling voltage at a distant bus. The attribute shall be a positive value.
- maxModulationIndex
The maximum quotient between the AC converter voltage (Uc) and DC voltage (Ud). A factor typically less than 1. It is converter’s configuration data used in power flow.
- maxValveCurrent
The maximum current through a valve. It is converter’s configuration data.
- pPccControl
Kind of control of real power and/or DC voltage.
- qPccControl
Kind of reactive power control.
- qShare
Reactive power sharing factor among parallel converters on Uac control. The attribute shall be a positive value or zero.
- targetPWMfactor
Magnitude of pulse-modulation factor. The attribute shall be a positive value.
- targetPhasePcc
Phase target at AC side, at point of common coupling. The attribute shall be a positive value.
- targetPowerFactorPcc
Power factor target at the AC side, at point of common coupling. The attribute shall be a positive value.
- targetQpcc
Reactive power injection target in AC grid, at point of common coupling. Load sign convention is used, i.e. positive sign means flow out from a node.
- targetUpcc
Voltage target in AC grid, at point of common coupling. The attribute shall be a positive value.
- uv
Line-to-line voltage on the valve side of the converter transformer. It is converter’s state variable, result from power flow. The attribute shall be a positive value.
- CapabilityCurve
VsCapabilityCurve Capability curve of this converter.
- VSCDynamics
VSCDynamics Voltage source converter dynamics model used to describe dynamic behaviour of this converter.
-
final
case class
WEPStandard(Element: BasicElement = null, standardEdition: String = null, standardNumber: String = null) extends Element with Product with Serializable
Standard published by Westinghouse - a WEP (Westinghouse Engineering Procedure).
Standard published by Westinghouse - a WEP (Westinghouse Engineering Procedure).
- Element
Reference to the superclass object.
- standardEdition
Edition of WEP standard.
- standardNumber
WEP standard number.
-
final
case class
WaveTrap(AuxiliaryEquipment: AuxiliaryEquipment = null) extends Element with Product with Serializable
Line traps are devices that impede high frequency power line carrier signals yet present a negligible impedance at the main power frequency.
Line traps are devices that impede high frequency power line carrier signals yet present a negligible impedance at the main power frequency.
- AuxiliaryEquipment
AuxiliaryEquipment Reference to the superclass object.
-
final
case class
WeatherStation(PowerSystemResource: PowerSystemResource = null, Equipment: List[String] = null) extends Element with Product with Serializable
This represents a source of ambient temperature.
This represents a source of ambient temperature.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- Equipment
Equipment undocumented
-
final
case class
WheelingCounterParty(IdentifiedObject: IdentifiedObject = null, RegisteredInterTie: List[String] = null) extends Element with Product with Serializable
Counter party in a wheeling transaction.
Counter party in a wheeling transaction.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- RegisteredInterTie
RegisteredInterTie undocumented
-
final
case class
WheelingReferenceSchedule(BidHourlySchedule: BidHourlySchedule = null, value: String = null) extends Element with Product with Serializable
A unique identifier of a wheeling transaction.
A unique identifier of a wheeling transaction.
A wheeling transaction is a balanced Energy exchange among Supply and Demand Resources.
This schedule is assocated with the hourly parameters in a resource bid.
- BidHourlySchedule
BidHourlySchedule Reference to the superclass object.
- value
undocumented
-
final
case class
Whirlpool(HydrosphericPhenomenon: HydrosphericPhenomenon = null) extends Element with Product with Serializable
A whirlpool, a rapidly rotating mass of water in a river or sea into which objects may be drawn, typically caused by the meeting of conflicting currents.
A whirlpool, a rapidly rotating mass of water in a river or sea into which objects may be drawn, typically caused by the meeting of conflicting currents.
- HydrosphericPhenomenon
HydrosphericPhenomenon Reference to the superclass object.
-
final
case class
WindAeroConstIEC(IdentifiedObject: IdentifiedObject = null, WindGenTurbineType1aIEC: String = null) extends Element with Product with Serializable
Constant aerodynamic torque model which assumes that the aerodynamic torque is constant.
Constant aerodynamic torque model which assumes that the aerodynamic torque is constant.
Reference: IEC 61400-27-1:2015, 5.6.1.1.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- WindGenTurbineType1aIEC
WindGenTurbineType1aIEC Wind turbine type 1A model with which this wind aerodynamic model is associated.
-
final
case class
WindAeroOneDimIEC(IdentifiedObject: IdentifiedObject = null, ka: Double = 0.0, thetaomega: Double = 0.0, WindTurbineType3IEC: String = null) extends Element with Product with Serializable
One-dimensional aerodynamic model.
One-dimensional aerodynamic model.
Reference: IEC 61400-27-1:2015, 5.6.1.2.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- ka
Aerodynamic gain (ka). It is a type-dependent parameter.
- thetaomega
Initial pitch angle (thetaomega0). It is a case-dependent parameter.
- WindTurbineType3IEC
WindTurbineType3IEC Wind turbine type 3 model with which this wind aerodynamic model is associated.
-
final
case class
WindAeroTwoDimIEC(IdentifiedObject: IdentifiedObject = null, dpomega: Double = 0.0, dptheta: Double = 0.0, dpv1: Double = 0.0, omegazero: Double = 0.0, pavail: Double = 0.0, thetav2: Double = 0.0, thetazero: Double = 0.0, WindTurbineType3IEC: String = null) extends Element with Product with Serializable
Two-dimensional aerodynamic model.
Two-dimensional aerodynamic model.
Reference: IEC 61400-27-1:2015, 5.6.1.3.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- dpomega
Partial derivative of aerodynamic power with respect to changes in WTR speed (dpomega). It is a type-dependent parameter.
- dptheta
Partial derivative of aerodynamic power with respect to changes in pitch angle (dptheta). It is a type-dependent parameter.
- dpv1
Partial derivative (dpv1). It is a type-dependent parameter.
- omegazero
Rotor speed if the wind turbine is not derated (omega0). It is a type-dependent parameter.
- pavail
Available aerodynamic power (pavail). It is a case-dependent parameter.
- thetav2
Blade angle at twice rated wind speed (thetav2). It is a type-dependent parameter.
- thetazero
Pitch angle if the wind turbine is not derated (theta0). It is a case-dependent parameter.
- WindTurbineType3IEC
WindTurbineType3IEC Wind turbine type 3 model with which this wind aerodynamic model is associated.
-
final
case class
WindContCurrLimIEC(IdentifiedObject: IdentifiedObject = null, imax: Double = 0.0, imaxdip: Double = 0.0, kpqu: Double = 0.0, mdfslim: Boolean = false, mqpri: Boolean = false, tufiltcl: Double = 0.0, upqumax: Double = 0.0, WindDynamicsLookupTable: List[String] = null, WindTurbineType3or4IEC: String = null) extends Element with Product with Serializable
Current limitation model.
Current limitation model.
The current limitation model combines the physical limits and the control limits. Reference: IEC 61400-27-1:2015, 5.6.5.8.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- imax
Maximum continuous current at the wind turbine terminals (imax). It is a type-dependent parameter.
- imaxdip
Maximum current during voltage dip at the wind turbine terminals (imaxdip). It is a project-dependent parameter.
- kpqu
Partial derivative of reactive current limit (Kpqu) versus voltage. It is a type-dependent parameter.
- mdfslim
Limitation of type 3 stator current (MDFSLim). MDFSLim = 1 for wind turbines type 4. It is a type-dependent parameter. false= total current limitation (0 in the IEC model) true=stator current limitation (1 in the IEC model).
- mqpri
Prioritisation of Q control during UVRT (Mqpri). It is a project-dependent parameter. true = reactive power priority (1 in the IEC model) false = active power priority (0 in the IEC model).
- tufiltcl
Voltage measurement filter time constant (Tufiltcl) (>= 0). It is a type-dependent parameter.
- upqumax
Wind turbine voltage in the operation point where zero reactive current can be delivered (upqumax). It is a type-dependent parameter.
- WindDynamicsLookupTable
WindDynamicsLookupTable The wind dynamics lookup table associated with this current control limitation model.
- WindTurbineType3or4IEC
WindTurbineType3or4IEC Wind turbine type 3 or type 4 model with which this wind control current limitation model is associated.
-
final
case class
WindContPType3IEC(IdentifiedObject: IdentifiedObject = null, dpmax: Double = 0.0, dprefmax: Double = 0.0, dprefmin: Double = 0.0, dthetamax: Double = 0.0, dthetamaxuvrt: Double = 0.0, kdtd: Double = 0.0, kip: Double = 0.0, kpp: Double = 0.0, mpuvrt: Boolean = false, omegadtd: Double = 0.0, omegaoffset: Double = 0.0, pdtdmax: Double = 0.0, tdvs: Double = 0.0, thetaemin: Double = 0.0, thetauscale: Double = 0.0, tomegafiltp3: Double = 0.0, tomegaref: Double = 0.0, tpfiltp3: Double = 0.0, tpord: Double = 0.0, tufiltp3: Double = 0.0, udvs: Double = 0.0, updip: Double = 0.0, zeta: Double = 0.0, WindDynamicsLookupTable: List[String] = null, WindTurbineType3IEC: String = null) extends Element with Product with Serializable
P control model type 3.
P control model type 3.
Reference: IEC 61400-27-1:2015, 5.6.5.4.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- dpmax
Maximum wind turbine power ramp rate (dpmax). It is a type-dependent parameter.
- dprefmax
Maximum ramp rate of wind turbine reference power (dprefmax). It is a project-dependent parameter.
- dprefmin
Minimum ramp rate of wind turbine reference power (dprefmin). It is a project-dependent parameter.
- dthetamax
Ramp limitation of torque, required in some grid codes (dtmax). It is a project-dependent parameter.
- dthetamaxuvrt
Limitation of torque rise rate during UVRT (dthetamaxUVRT). It is a project-dependent parameter.
- kdtd
Gain for active drive train damping (KDTD). It is a type-dependent parameter.
- kip
PI controller integration parameter (KIp). It is a type-dependent parameter.
- kpp
PI controller proportional gain (KPp). It is a type-dependent parameter.
- mpuvrt
Enable UVRT power control mode (MpUVRT). It is a project-dependent parameter. true = voltage control (1 in the IEC model) false = reactive power control (0 in the IEC model).
- omegadtd
Active drive train damping frequency (omegaDTD). It can be calculated from two mass model parameters. It is a type-dependent parameter.
- omegaoffset
Offset to reference value that limits controller action during rotor speed changes (omegaoffset). It is a case-dependent parameter.
- pdtdmax
Maximum active drive train damping power (pDTDmax). It is a type-dependent parameter.
- tdvs
Time delay after deep voltage sags (TDVS) (>= 0). It is a project-dependent parameter.
- thetaemin
Minimum electrical generator torque (temin). It is a type-dependent parameter.
- thetauscale
Voltage scaling factor of reset-torque (tuscale). It is a project-dependent parameter.
- tomegafiltp3
Filter time constant for generator speed measurement (Tomegafiltp3) (>= 0). It is a type-dependent parameter.
- tomegaref
Time constant in speed reference filter (Tomega,ref) (>= 0). It is a type-dependent parameter.
- tpfiltp3
Filter time constant for power measurement (Tpfiltp3) (>= 0). It is a type-dependent parameter.
- tpord
Time constant in power order lag (Tpord). It is a type-dependent parameter.
- tufiltp3
Filter time constant for voltage measurement (Tufiltp3) (>= 0). It is a type-dependent parameter.
- udvs
Voltage limit for hold UVRT status after deep voltage sags (uDVS). It is a project-dependent parameter.
- updip
Voltage dip threshold for P-control (uPdip). Part of turbine control, often different (e.g 0.8) from converter thresholds. It is a project-dependent parameter.
- zeta
Coefficient for active drive train damping (zeta). It is a type-dependent parameter.
- WindDynamicsLookupTable
WindDynamicsLookupTable The wind dynamics lookup table associated with this P control type 3 model.
- WindTurbineType3IEC
WindTurbineType3IEC Wind turbine type 3 model with which this wind control P type 3 model is associated.
-
final
case class
WindContPType4aIEC(IdentifiedObject: IdentifiedObject = null, dpmaxp4a: Double = 0.0, tpordp4a: Double = 0.0, tufiltp4a: Double = 0.0, WindTurbineType4aIEC: String = null) extends Element with Product with Serializable
P control model type 4A.
P control model type 4A.
Reference: IEC 61400-27-1:2015, 5.6.5.5.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- dpmaxp4a
Maximum wind turbine power ramp rate (dpmaxp4A). It is a project-dependent parameter.
- tpordp4a
Time constant in power order lag (Tpordp4A) (>= 0). It is a type-dependent parameter.
- tufiltp4a
Voltage measurement filter time constant (Tufiltp4A) (>= 0). It is a type-dependent parameter.
- WindTurbineType4aIEC
WindTurbineType4aIEC Wind turbine type 4A model with which this wind control P type 4A model is associated.
-
final
case class
WindContPType4bIEC(IdentifiedObject: IdentifiedObject = null, dpmaxp4b: Double = 0.0, tpaero: Double = 0.0, tpordp4b: Double = 0.0, tufiltp4b: Double = 0.0, WindTurbineType4bIEC: String = null) extends Element with Product with Serializable
P control model type 4B.
P control model type 4B.
Reference: IEC 61400-27-1:2015, 5.6.5.6.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- dpmaxp4b
Maximum wind turbine power ramp rate (dpmaxp4B). It is a project-dependent parameter.
- tpaero
Time constant in aerodynamic power response (Tpaero) (>= 0). It is a type-dependent parameter.
- tpordp4b
Time constant in power order lag (Tpordp4B) (>= 0). It is a type-dependent parameter.
- tufiltp4b
Voltage measurement filter time constant (Tufiltp4B) (>= 0). It is a type-dependent parameter.
- WindTurbineType4bIEC
WindTurbineType4bIEC Wind turbine type 4B model with which this wind control P type 4B model is associated.
-
final
case class
WindContPitchAngleIEC(IdentifiedObject: IdentifiedObject = null, dthetamax: Double = 0.0, dthetamin: Double = 0.0, kic: Double = 0.0, kiomega: Double = 0.0, kpc: Double = 0.0, kpomega: Double = 0.0, kpx: Double = 0.0, thetamax: Double = 0.0, thetamin: Double = 0.0, ttheta: Double = 0.0, WindTurbineType3IEC: String = null) extends Element with Product with Serializable
Pitch angle control model.
Pitch angle control model.
Reference: IEC 61400-27-1:2015, 5.6.5.2.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- dthetamax
Maximum pitch positive ramp rate (dthetamax) (> WindContPitchAngleIEC.dthetamin). It is a type-dependent parameter. Unit = degrees / s.
- dthetamin
Maximum pitch negative ramp rate (dthetamin) (< WindContPitchAngleIEC.dthetamax). It is a type-dependent parameter. Unit = degrees / s.
- kic
Power PI controller integration gain (KIc). It is a type-dependent parameter.
- kiomega
Speed PI controller integration gain (KIomega). It is a type-dependent parameter.
- kpc
Power PI controller proportional gain (KPc). It is a type-dependent parameter.
- kpomega
Speed PI controller proportional gain (KPomega). It is a type-dependent parameter.
- kpx
Pitch cross coupling gain (KPX). It is a type-dependent parameter.
- thetamax
Maximum pitch angle (thetamax) (> WindContPitchAngleIEC.thetamin). It is a type-dependent parameter.
- thetamin
Minimum pitch angle (thetamin) (< WindContPitchAngleIEC.thetamax). It is a type-dependent parameter.
- ttheta
Pitch time constant (ttheta) (>= 0). It is a type-dependent parameter.
- WindTurbineType3IEC
WindTurbineType3IEC Wind turbine type 3 model with which this pitch control model is associated.
-
final
case class
WindContQIEC(IdentifiedObject: IdentifiedObject = null, iqh1: Double = 0.0, iqmax: Double = 0.0, iqmin: Double = 0.0, iqpost: Double = 0.0, kiq: Double = 0.0, kiu: Double = 0.0, kpq: Double = 0.0, kpu: Double = 0.0, kqv: Double = 0.0, rdroop: Double = 0.0, tpfiltq: Double = 0.0, tpost: Double = 0.0, tqord: Double = 0.0, tufiltq: Double = 0.0, udb1: Double = 0.0, udb2: Double = 0.0, umax: Double = 0.0, umin: Double = 0.0, uqdip: Double = 0.0, uref0: Double = 0.0, windQcontrolModesType: String = null, windUVRTQcontrolModesType: String = null, xdroop: Double = 0.0, WindTurbineType3or4IEC: String = null) extends Element with Product with Serializable
Q control model.
Q control model.
Reference: IEC 61400-27-1:2015, 5.6.5.7.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- iqh1
Maximum reactive current injection during dip (iqh1). It is a type-dependent parameter.
- iqmax
Maximum reactive current injection (iqmax) (> WindContQIEC.iqmin). It is a type-dependent parameter.
- iqmin
Minimum reactive current injection (iqmin) (< WindContQIEC.iqmax). It is a type-dependent parameter.
- iqpost
Post fault reactive current injection (iqpost). It is a project-dependent parameter.
- kiq
Reactive power PI controller integration gain (KI,q). It is a type-dependent parameter.
- kiu
Voltage PI controller integration gain (KI,u). It is a type-dependent parameter.
- kpq
Reactive power PI controller proportional gain (KP,q). It is a type-dependent parameter.
- kpu
Voltage PI controller proportional gain (KP,u). It is a type-dependent parameter.
- kqv
Voltage scaling factor for UVRT current (Kqv). It is a project-dependent parameter.
- rdroop
Resistive component of voltage drop impedance (rdroop) (>= 0). It is a project-dependent parameter.
- tpfiltq
Power measurement filter time constant (Tpfiltq) (>= 0). It is a type-dependent parameter.
- tpost
Length of time period where post fault reactive power is injected (Tpost) (>= 0). It is a project-dependent parameter.
- tqord
Time constant in reactive power order lag (Tqord) (>= 0). It is a type-dependent parameter.
- tufiltq
Voltage measurement filter time constant (Tufiltq) (>= 0). It is a type-dependent parameter.
- udb1
Voltage deadband lower limit (udb1). It is a type-dependent parameter.
- udb2
Voltage deadband upper limit (udb2). It is a type-dependent parameter.
- umax
Maximum voltage in voltage PI controller integral term (umax) (> WindContQIEC.umin). It is a type-dependent parameter.
- umin
Minimum voltage in voltage PI controller integral term (umin) (< WindContQIEC.umax). It is a type-dependent parameter.
- uqdip
Voltage threshold for UVRT detection in Q control (uqdip). It is a type-dependent parameter.
- uref0
User-defined bias in voltage reference (uref0). It is a case-dependent parameter.
- windQcontrolModesType
Types of general wind turbine Q control modes (MqG). It is a project-dependent parameter.
- windUVRTQcontrolModesType
Types of UVRT Q control modes (MqUVRT). It is a project-dependent parameter.
- xdroop
Inductive component of voltage drop impedance (xdroop) (>= 0). It is a project-dependent parameter.
- WindTurbineType3or4IEC
WindTurbineType3or4IEC Wind turbine type 3 or type 4 model with which this reactive control model is associated.
-
final
case class
WindContQLimIEC(IdentifiedObject: IdentifiedObject = null, qmax: Double = 0.0, qmin: Double = 0.0, WindTurbineType3or4IEC: String = null) extends Element with Product with Serializable
Constant Q limitation model.
Constant Q limitation model.
Reference: IEC 61400-27-1:2015, 5.6.5.9.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- qmax
Maximum reactive power (qmax) (> WindContQLimIEC.qmin). It is a type-dependent parameter.
- qmin
Minimum reactive power (qmin) (< WindContQLimIEC.qmax). It is a type-dependent parameter.
- WindTurbineType3or4IEC
WindTurbineType3or4IEC Wind generator type 3 or type 4 model with which this constant Q limitation model is associated.
-
final
case class
WindContQPQULimIEC(IdentifiedObject: IdentifiedObject = null, tpfiltql: Double = 0.0, tufiltql: Double = 0.0, WindDynamicsLookupTable: List[String] = null, WindTurbineType3or4IEC: String = null) extends Element with Product with Serializable
QP and QU limitation model.
QP and QU limitation model.
Reference: IEC 61400-27-1:2015, 5.6.5.10.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- tpfiltql
Power measurement filter time constant for Q capacity (Tpfiltql) (>= 0). It is a type-dependent parameter.
- tufiltql
Voltage measurement filter time constant for Q capacity (Tufiltql) (>= 0). It is a type-dependent parameter.
- WindDynamicsLookupTable
WindDynamicsLookupTable The wind dynamics lookup table associated with this QP and QU limitation model.
- WindTurbineType3or4IEC
WindTurbineType3or4IEC Wind generator type 3 or type 4 model with which this QP and QU limitation model is associated.
-
final
case class
WindContRotorRIEC(IdentifiedObject: IdentifiedObject = null, kirr: Double = 0.0, komegafilt: Double = 0.0, kpfilt: Double = 0.0, kprr: Double = 0.0, rmax: Double = 0.0, rmin: Double = 0.0, tomegafiltrr: Double = 0.0, tpfiltrr: Double = 0.0, WindDynamicsLookupTable: List[String] = null, WindGenTurbineType2IEC: String = null) extends Element with Product with Serializable
Rotor resistance control model.
Rotor resistance control model.
Reference: IEC 61400-27-1:2015, 5.6.5.3.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- kirr
Integral gain in rotor resistance PI controller (KIrr). It is a type-dependent parameter.
- komegafilt
Filter gain for generator speed measurement (Komegafilt). It is a type-dependent parameter.
- kpfilt
Filter gain for power measurement (Kpfilt). It is a type-dependent parameter.
- kprr
Proportional gain in rotor resistance PI controller (KPrr). It is a type-dependent parameter.
- rmax
Maximum rotor resistance (rmax) (> WindContRotorRIEC.rmin). It is a type-dependent parameter.
- rmin
Minimum rotor resistance (rmin) (< WindContRotorRIEC.rmax). It is a type-dependent parameter.
- tomegafiltrr
Filter time constant for generator speed measurement (Tomegafiltrr) (>= 0). It is a type-dependent parameter.
- tpfiltrr
Filter time constant for power measurement (Tpfiltrr) (>= 0). It is a type-dependent parameter.
- WindDynamicsLookupTable
WindDynamicsLookupTable The wind dynamics lookup table associated with this rotor resistance control model.
- WindGenTurbineType2IEC
WindGenTurbineType2IEC Wind turbine type 2 model with whitch this wind control rotor resistance model is associated.
-
final
case class
WindDynamicsLookupTable(IdentifiedObject: IdentifiedObject = null, input: Double = 0.0, lookupTableFunctionType: String = null, output: Double = 0.0, sequence: Int = 0, WindContCurrLimIEC: String = null, WindContPType3IEC: String = null, WindContQPQULimIEC: String = null, WindContRotorRIEC: String = null, WindGenType3bIEC: String = null, WindPitchContPowerIEC: String = null, WindPlantFreqPcontrolIEC: String = null, WindPlantReactiveControlIEC: String = null, WindProtectionIEC: String = null) extends Element with Product with Serializable
Look up table for the purpose of wind standard models.
Look up table for the purpose of wind standard models.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- input
Input value (x) for the lookup table function.
- lookupTableFunctionType
Type of the lookup table function.
- output
Output value (y) for the lookup table function.
- sequence
Sequence numbers of the pairs of the input (x) and the output (y) of the lookup table function.
- WindContCurrLimIEC
WindContCurrLimIEC The current control limitation model with which this wind dynamics lookup table is associated.
- WindContPType3IEC
WindContPType3IEC The P control type 3 model with which this wind dynamics lookup table is associated.
- WindContQPQULimIEC
WindContQPQULimIEC The QP and QU limitation model with which this wind dynamics lookup table is associated.
- WindContRotorRIEC
WindContRotorRIEC The rotor resistance control model with which this wind dynamics lookup table is associated.
- WindGenType3bIEC
WindGenType3bIEC The generator type 3B model with which this wind dynamics lookup table is associated.
- WindPitchContPowerIEC
WindPitchContPowerIEC The pitch control power model with which this wind dynamics lookup table is associated.
- WindPlantFreqPcontrolIEC
WindPlantFreqPcontrolIEC The frequency and active power wind plant control model with which this wind dynamics lookup table is associated.
- WindPlantReactiveControlIEC
WindPlantReactiveControlIEC The voltage and reactive power wind plant control model with which this wind dynamics lookup table is associated.
- WindProtectionIEC
WindProtectionIEC The grid protection model with which this wind dynamics lookup table is associated.
-
final
case class
WindGenTurbineType1aIEC(WindTurbineType1or2IEC: WindTurbineType1or2IEC = null, WindAeroConstIEC: String = null) extends Element with Product with Serializable
Wind turbine IEC type 1A.
Wind turbine IEC type 1A.
Reference: IEC 61400-27-1:2015, 5.5.2.2.
- WindTurbineType1or2IEC
WindTurbineType1or2IEC Reference to the superclass object.
- WindAeroConstIEC
WindAeroConstIEC Wind aerodynamic model associated with this wind turbine type 1A model.
-
final
case class
WindGenTurbineType1bIEC(WindTurbineType1or2IEC: WindTurbineType1or2IEC = null, WindPitchContPowerIEC: String = null) extends Element with Product with Serializable
Wind turbine IEC type 1B.
Wind turbine IEC type 1B.
Reference: IEC 61400-27-1:2015, 5.5.2.3.
- WindTurbineType1or2IEC
WindTurbineType1or2IEC Reference to the superclass object.
- WindPitchContPowerIEC
WindPitchContPowerIEC Pitch control power model associated with this wind turbine type 1B model.
-
final
case class
WindGenTurbineType2IEC(WindTurbineType1or2IEC: WindTurbineType1or2IEC = null, WindContRotorRIEC: String = null, WindPitchContPowerIEC: String = null) extends Element with Product with Serializable
Wind turbine IEC type 2.
Wind turbine IEC type 2.
Reference: IEC 61400-27-1:2015, 5.5.3.
- WindTurbineType1or2IEC
WindTurbineType1or2IEC Reference to the superclass object.
- WindContRotorRIEC
WindContRotorRIEC Wind control rotor resistance model associated with wind turbine type 2 model.
- WindPitchContPowerIEC
WindPitchContPowerIEC Pitch control power model associated with this wind turbine type 2 model.
-
final
case class
WindGenType3IEC(IdentifiedObject: IdentifiedObject = null, dipmax: Double = 0.0, diqmax: Double = 0.0, xs: Double = 0.0, WindTurbineType3IEC: String = null) extends Element with Product with Serializable
Parent class supporting relationships to IEC wind turbines type 3 generator models of IEC type 3A and 3B.
Parent class supporting relationships to IEC wind turbines type 3 generator models of IEC type 3A and 3B.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- dipmax
Maximum active current ramp rate (dipmax). It is a project-dependent parameter.
- diqmax
Maximum reactive current ramp rate (diqmax). It is a project-dependent parameter.
- xs
Electromagnetic transient reactance (xS). It is a type-dependent parameter.
- WindTurbineType3IEC
WindTurbineType3IEC Wind turbine type 3 model with which this wind generator type 3 is associated.
-
final
case class
WindGenType3aIEC(WindGenType3IEC: WindGenType3IEC = null, kpc: Double = 0.0, tic: Double = 0.0, WindTurbineType4IEC: String = null) extends Element with Product with Serializable
IEC type 3A generator set model.
IEC type 3A generator set model.
Reference: IEC 61400-27-1:2015, 5.6.3.2.
- WindGenType3IEC
WindGenType3IEC Reference to the superclass object.
- kpc
Current PI controller proportional gain (KPc). It is a type-dependent parameter.
- tic
Current PI controller integration time constant (TIc) (>= 0). It is a type-dependent parameter.
- WindTurbineType4IEC
WindTurbineType4IEC Wind turbine type 4 model with which this wind generator type 3A model is associated.
-
final
case class
WindGenType3bIEC(WindGenType3IEC: WindGenType3IEC = null, mwtcwp: Boolean = false, tg: Double = 0.0, two: Double = 0.0, WindDynamicsLookupTable: List[String] = null) extends Element with Product with Serializable
IEC type 3B generator set model.
IEC type 3B generator set model.
Reference: IEC 61400-27-1:2015, 5.6.3.3.
- WindGenType3IEC
WindGenType3IEC Reference to the superclass object.
- mwtcwp
Crowbar control mode (MWTcwp). It is a case-dependent parameter. true = 1 in the IEC model false = 0 in the IEC model.
- tg
Current generation time constant (Tg) (>= 0). It is a type-dependent parameter.
- two
Time constant for crowbar washout filter (Two) (>= 0). It is a case-dependent parameter.
- WindDynamicsLookupTable
WindDynamicsLookupTable The wind dynamics lookup table associated with this generator type 3B model.
-
final
case class
WindGenType4IEC(IdentifiedObject: IdentifiedObject = null, dipmax: Double = 0.0, diqmax: Double = 0.0, diqmin: Double = 0.0, tg: Double = 0.0, WindTurbineType4aIEC: String = null, WindTurbineType4bIEC: String = null) extends Element with Product with Serializable
IEC type 4 generator set model.
IEC type 4 generator set model.
Reference: IEC 61400-27-1:2015, 5.6.3.4.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- dipmax
Maximum active current ramp rate (dipmax). It is a project-dependent parameter.
- diqmax
Maximum reactive current ramp rate (diqmax). It is a project-dependent parameter.
- diqmin
Minimum reactive current ramp rate (diqmin). It is a project-dependent parameter.
- tg
Time constant (Tg) (>= 0). It is a type-dependent parameter.
- WindTurbineType4aIEC
WindTurbineType4aIEC Wind turbine type 4A model with which this wind generator type 4 model is associated.
- WindTurbineType4bIEC
WindTurbineType4bIEC Wind turbine type 4B model with which this wind generator type 4 model is associated.
-
final
case class
WindGeneratingUnit(GeneratingUnit: GeneratingUnit = null, windGenUnitType: String = null) extends Element with Product with Serializable
A wind driven generating unit, connected to the grid by means of a rotating machine.
A wind driven generating unit, connected to the grid by means of a rotating machine.
May be used to represent a single turbine or an aggregation.
- GeneratingUnit
GeneratingUnit Reference to the superclass object.
- windGenUnitType
The kind of wind generating unit.
-
final
case class
WindMechIEC(IdentifiedObject: IdentifiedObject = null, cdrt: Double = 0.0, hgen: Double = 0.0, hwtr: Double = 0.0, kdrt: Double = 0.0, WindTurbineType1or2IEC: String = null, WindTurbineType3IEC: String = null, WindTurbineType4bIEC: String = null) extends Element with Product with Serializable
Two mass model.
Two mass model.
Reference: IEC 61400-27-1:2015, 5.6.2.1.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- cdrt
Drive train damping (cdrt). It is a type-dependent parameter.
- hgen
Inertia constant of generator (Hgen) (>= 0). It is a type-dependent parameter.
- hwtr
Inertia constant of wind turbine rotor (HWTR) (>= 0). It is a type-dependent parameter.
- kdrt
Drive train stiffness (kdrt). It is a type-dependent parameter.
- WindTurbineType1or2IEC
WindTurbineType1or2IEC Wind generator type 1 or type 2 model with which this wind mechanical model is associated.
- WindTurbineType3IEC
WindTurbineType3IEC Wind turbine type 3 model with which this wind mechanical model is associated.
- WindTurbineType4bIEC
WindTurbineType4bIEC Wind turbine type 4B model with which this wind mechanical model is associated.
-
final
case class
WindPitchContPowerIEC(IdentifiedObject: IdentifiedObject = null, dpmax: Double = 0.0, dpmin: Double = 0.0, pmin: Double = 0.0, pset: Double = 0.0, t1: Double = 0.0, tr: Double = 0.0, uuvrt: Double = 0.0, WindDynamicsLookupTable: List[String] = null, WindGenTurbineType1bIEC: String = null, WindGenTurbineType2IEC: String = null) extends Element with Product with Serializable
Pitch control power model.
Pitch control power model.
Reference: IEC 61400-27-1:2015, 5.6.5.1.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- dpmax
Rate limit for increasing power (dpmax) (> WindPitchContPowerIEC.dpmin). It is a type-dependent parameter.
- dpmin
Rate limit for decreasing power (dpmin) (< WindPitchContPowerIEC.dpmax). It is a type-dependent parameter.
- pmin
Minimum power setting (pmin). It is a type-dependent parameter.
- pset
If pinit < pset then power will be ramped down to pmin. It is (pset) in the IEC 61400-27-1:2015. It is a type-dependent parameter.
- t1
Lag time constant (T1) (>= 0). It is a type-dependent parameter.
- tr
Voltage measurement time constant (Tr) (>= 0). It is a type-dependent parameter.
- uuvrt
Dip detection threshold (uUVRT). It is a type-dependent parameter.
- WindDynamicsLookupTable
WindDynamicsLookupTable The wind dynamics lookup table associated with this pitch control power model.
- WindGenTurbineType1bIEC
WindGenTurbineType1bIEC Wind turbine type 1B model with which this pitch control power model is associated.
- WindGenTurbineType2IEC
WindGenTurbineType2IEC Wind turbine type 2 model with which this pitch control power model is associated.
-
final
case class
WindPlantDynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null, RemoteInputSignal: String = null, WindTurbineType3or4Dynamics: List[String] = null) extends Element with Product with Serializable
Parent class supporting relationships to wind turbines type 3 and type 4 and wind plant IEC and user-defined wind plants including their control models.
Parent class supporting relationships to wind turbines type 3 and type 4 and wind plant IEC and user-defined wind plants including their control models.
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- RemoteInputSignal
RemoteInputSignal The remote signal with which this power plant is associated.
- WindTurbineType3or4Dynamics
WindTurbineType3or4Dynamics The wind turbine type 3 or type 4 associated with this wind plant.
-
final
case class
WindPlantFreqPcontrolIEC(IdentifiedObject: IdentifiedObject = null, dprefmax: Double = 0.0, dprefmin: Double = 0.0, dpwprefmax: Double = 0.0, dpwprefmin: Double = 0.0, kiwpp: Double = 0.0, kiwppmax: Double = 0.0, kiwppmin: Double = 0.0, kpwpp: Double = 0.0, kwppref: Double = 0.0, prefmax: Double = 0.0, prefmin: Double = 0.0, tpft: Double = 0.0, tpfv: Double = 0.0, twpffiltp: Double = 0.0, twppfiltp: Double = 0.0, WindDynamicsLookupTable: List[String] = null, WindPlantIEC: String = null) extends Element with Product with Serializable
Frequency and active power controller model.
Frequency and active power controller model.
Reference: IEC 61400-27-1:2015, Annex D.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- dprefmax
Maximum ramp rate of pWTref request from the plant controller to the wind turbines (dprefmax) (> WindPlantFreqPcontrolIEC.dprefmin). It is a case-dependent parameter.
- dprefmin
Minimum (negative) ramp rate of pWTref request from the plant controller to the wind turbines (dprefmin) (< WindPlantFreqPcontrolIEC.dprefmax). It is a project-dependent parameter.
- dpwprefmax
Maximum positive ramp rate for wind plant power reference (dpWPrefmax) (> WindPlantFreqPcontrolIEC.dpwprefmin). It is a project-dependent parameter.
- dpwprefmin
Maximum negative ramp rate for wind plant power reference (dpWPrefmin) (< WindPlantFreqPcontrolIEC.dpwprefmax). It is a project-dependent parameter.
- kiwpp
Plant P controller integral gain (KIWPp). It is a project-dependent parameter.
- kiwppmax
Maximum PI integrator term (KIWPpmax) (> WindPlantFreqPcontrolIEC.kiwppmin). It is a project-dependent parameter.
- kiwppmin
Minimum PI integrator term (KIWPpmin) (< WindPlantFreqPcontrolIEC.kiwppmax). It is a project-dependent parameter.
- kpwpp
Plant P controller proportional gain (KPWPp). It is a project-dependent parameter.
- kwppref
Power reference gain (KWPpref). It is a project-dependent parameter.
- prefmax
Maximum pWTref request from the plant controller to the wind turbines (prefmax) (> WindPlantFreqPcontrolIEC.prefmin). It is a project-dependent parameter.
- prefmin
Minimum pWTref request from the plant controller to the wind turbines (prefmin) (< WindPlantFreqPcontrolIEC.prefmax). It is a project-dependent parameter.
- tpft
Lead time constant in reference value transfer function (Tpft) (>= 0). It is a project-dependent parameter.
- tpfv
Lag time constant in reference value transfer function (Tpfv) (>= 0). It is a project-dependent parameter.
- twpffiltp
Filter time constant for frequency measurement (TWPffiltp) (>= 0). It is a project-dependent parameter.
- twppfiltp
Filter time constant for active power measurement (TWPpfiltp) (>= 0). It is a project-dependent parameter.
- WindDynamicsLookupTable
WindDynamicsLookupTable The wind dynamics lookup table associated with this frequency and active power wind plant model.
- WindPlantIEC
WindPlantIEC Wind plant model with which this wind plant frequency and active power control is associated.
-
final
case class
WindPlantIEC(WindPlantDynamics: WindPlantDynamics = null, WindPlantFreqPcontrolIEC: String = null, WindPlantReactiveControlIEC: String = null) extends Element with Product with Serializable
Simplified IEC type plant level model.
Simplified IEC type plant level model.
Reference: IEC 61400-27-1:2015, Annex D.
- WindPlantDynamics
WindPlantDynamics Reference to the superclass object.
- WindPlantFreqPcontrolIEC
WindPlantFreqPcontrolIEC Wind plant frequency and active power control model associated with this wind plant.
- WindPlantReactiveControlIEC
WindPlantReactiveControlIEC Wind plant model with which this wind reactive control is associated.
-
final
case class
WindPlantReactiveControlIEC(IdentifiedObject: IdentifiedObject = null, dxrefmax: Double = 0.0, dxrefmin: Double = 0.0, kiwpx: Double = 0.0, kiwpxmax: Double = 0.0, kiwpxmin: Double = 0.0, kpwpx: Double = 0.0, kwpqref: Double = 0.0, kwpqu: Double = 0.0, tuqfilt: Double = 0.0, twppfiltq: Double = 0.0, twpqfiltq: Double = 0.0, twpufiltq: Double = 0.0, txft: Double = 0.0, txfv: Double = 0.0, uwpqdip: Double = 0.0, windPlantQcontrolModesType: String = null, xrefmax: Double = 0.0, xrefmin: Double = 0.0, WindDynamicsLookupTable: List[String] = null, WindPlantIEC: String = null) extends Element with Product with Serializable
Simplified plant voltage and reactive power control model for use with type 3 and type 4 wind turbine models.
Simplified plant voltage and reactive power control model for use with type 3 and type 4 wind turbine models.
Reference: IEC 61400-27-1:2015, Annex D.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- dxrefmax
Maximum positive ramp rate for wind turbine reactive power/voltage reference (dxrefmax) (> WindPlantReactiveControlIEC.dxrefmin). It is a project-dependent parameter.
- dxrefmin
Maximum negative ramp rate for wind turbine reactive power/voltage reference (dxrefmin) (< WindPlantReactiveControlIEC.dxrefmax). It is a project-dependent parameter.
- kiwpx
Plant Q controller integral gain (KIWPx). It is a project-dependent parameter.
- kiwpxmax
Maximum reactive power/voltage reference from integration (KIWPxmax) (> WindPlantReactiveControlIEC.kiwpxmin). It is a project-dependent parameter.
- kiwpxmin
Minimum reactive power/voltage reference from integration (KIWPxmin) (< WindPlantReactiveControlIEC.kiwpxmax). It is a project-dependent parameter.
- kpwpx
Plant Q controller proportional gain (KPWPx). It is a project-dependent parameter.
- kwpqref
Reactive power reference gain (KWPqref). It is a project-dependent parameter.
- kwpqu
Plant voltage control droop (KWPqu). It is a project-dependent parameter.
- tuqfilt
Filter time constant for voltage-dependent reactive power (Tuqfilt) (>= 0). It is a project-dependent parameter.
- twppfiltq
Filter time constant for active power measurement (TWPpfiltq) (>= 0). It is a project-dependent parameter.
- twpqfiltq
Filter time constant for reactive power measurement (TWPqfiltq) (>= 0). It is a project-dependent parameter.
- twpufiltq
Filter time constant for voltage measurement (TWPufiltq) (>= 0). It is a project-dependent parameter.
- txft
Lead time constant in reference value transfer function (Txft) (>= 0). It is a project-dependent parameter.
- txfv
Lag time constant in reference value transfer function (Txfv) (>= 0). It is a project-dependent parameter.
- uwpqdip
Voltage threshold for UVRT detection in Q control (uWPqdip). It is a project-dependent parameter.
- windPlantQcontrolModesType
Reactive power/voltage controller mode (MWPqmode). It is a case-dependent parameter.
- xrefmax
Maximum xWTref (qWTref or delta uWTref) request from the plant controller (xrefmax) (> WindPlantReactiveControlIEC.xrefmin). It is a case-dependent parameter.
- xrefmin
Minimum xWTref (qWTref or delta uWTref) request from the plant controller (xrefmin) (< WindPlantReactiveControlIEC.xrefmax). It is a project-dependent parameter.
- WindDynamicsLookupTable
WindDynamicsLookupTable The wind dynamics lookup table associated with this voltage and reactive power wind plant model.
- WindPlantIEC
WindPlantIEC Wind plant reactive control model associated with this wind plant.
-
final
case class
WindPlantUserDefined(WindPlantDynamics: WindPlantDynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Wind plant function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
Wind plant function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
- WindPlantDynamics
WindPlantDynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
WindProtectionIEC(IdentifiedObject: IdentifiedObject = null, dfimax: Double = 0.0, fover: Double = 0.0, funder: Double = 0.0, mzc: Boolean = false, tfma: Double = 0.0, uover: Double = 0.0, uunder: Double = 0.0, WindDynamicsLookupTable: List[String] = null, WindTurbineType1or2IEC: String = null, WindTurbineType3or4IEC: String = null) extends Element with Product with Serializable
The grid protection model includes protection against over- and under-voltage, and against over- and under-frequency.
The grid protection model includes protection against over- and under-voltage, and against over- and under-frequency.
Reference: IEC 61400-27-1:2015, 5.6.6.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- dfimax
Maximum rate of change of frequency (dFmax). It is a type-dependent parameter.
- fover
Wind turbine over frequency protection activation threshold (fover). It is a project-dependent parameter.
- funder
Wind turbine under frequency protection activation threshold (funder). It is a project-dependent parameter.
- mzc
Zero crossing measurement mode (Mzc). It is a type-dependent parameter. true = WT protection system uses zero crossings to detect frequency (1 in the IEC model) false = WT protection system does not use zero crossings to detect frequency (0 in the IEC model).
- tfma
Time interval of moving average window (TfMA) (>= 0). It is a type-dependent parameter.
- uover
Wind turbine over voltage protection activation threshold (uover). It is a project-dependent parameter.
- uunder
Wind turbine under voltage protection activation threshold (uunder). It is a project-dependent parameter.
- WindDynamicsLookupTable
WindDynamicsLookupTable The wind dynamics lookup table associated with this grid protection model.
- WindTurbineType1or2IEC
WindTurbineType1or2IEC Wind generator type 1 or type 2 model with which this wind turbine protection model is associated.
- WindTurbineType3or4IEC
WindTurbineType3or4IEC Wind generator type 3 or type 4 model with which this wind turbine protection model is associated.
-
final
case class
WindRefFrameRotIEC(IdentifiedObject: IdentifiedObject = null, tpll: Double = 0.0, upll1: Double = 0.0, upll2: Double = 0.0, WindTurbineType3or4IEC: String = null) extends Element with Product with Serializable
Reference frame rotation model.
Reference frame rotation model.
Reference: IEC 61400-27-1:2015, 5.6.3.5.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- tpll
Time constant for PLL first order filter model (TPLL) (>= 0). It is a type-dependent parameter.
- upll1
Voltage below which the angle of the voltage is filtered and possibly also frozen (uPLL1). It is a type-dependent parameter.
- upll2
Voltage (uPLL2) below which the angle of the voltage is frozen if uPLL2 is smaller or equal to uPLL1 . It is a type-dependent parameter.
- WindTurbineType3or4IEC
WindTurbineType3or4IEC Wind turbine type 3 or type 4 model with which this reference frame rotation model is associated.
-
final
case class
WindTurbineType1or2Dynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null, AsynchronousMachineDynamics: String = null, RemoteInputSignal: String = null) extends Element with Product with Serializable
Parent class supporting relationships to wind turbines type 1 and type 2 and their control models.
Parent class supporting relationships to wind turbines type 1 and type 2 and their control models.
Generator model for wind turbine of type 1 or type 2 is a standard asynchronous generator model.
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- AsynchronousMachineDynamics
AsynchronousMachineDynamics Asynchronous machine model with which this wind generator type 1 or type 2 model is associated.
- RemoteInputSignal
RemoteInputSignal Remote input signal used by this wind generator type 1 or type 2 model.
-
final
case class
WindTurbineType1or2IEC(WindTurbineType1or2Dynamics: WindTurbineType1or2Dynamics = null, WindMechIEC: String = null, WindProtectionIEC: String = null) extends Element with Product with Serializable
Parent class supporting relationships to IEC wind turbines type 1 and type 2 including their control models.
Parent class supporting relationships to IEC wind turbines type 1 and type 2 including their control models.
Generator model for wind turbine of IEC type 1 or type 2 is a standard asynchronous generator model. Reference: IEC 61400-27-1:2015, 5.5.2 and 5.5.3.
- WindTurbineType1or2Dynamics
WindTurbineType1or2Dynamics Reference to the superclass object.
- WindMechIEC
WindMechIEC Wind mechanical model associated with this wind generator type 1 or type 2 model.
- WindProtectionIEC
WindProtectionIEC Wind turbune protection model associated with this wind generator type 1 or type 2 model.
-
final
case class
WindTurbineType3IEC(WindTurbineType3or4IEC: WindTurbineType3or4IEC = null, WindAeroOneDimIEC: String = null, WindAeroTwoDimIEC: String = null, WindContPType3IEC: String = null, WindContPitchAngleIEC: String = null, WindGenType3IEC: String = null, WindMechIEC: String = null) extends Element with Product with Serializable
Parent class supporting relationships to IEC wind turbines type 3 including their control models.
Parent class supporting relationships to IEC wind turbines type 3 including their control models.
- WindTurbineType3or4IEC
WindTurbineType3or4IEC Reference to the superclass object.
- WindAeroOneDimIEC
WindAeroOneDimIEC Wind aerodynamic model associated with this wind generator type 3 model.
- WindAeroTwoDimIEC
WindAeroTwoDimIEC Wind aerodynamic model associated with this wind turbine type 3 model.
- WindContPType3IEC
WindContPType3IEC Wind control P type 3 model associated with this wind turbine type 3 model.
- WindContPitchAngleIEC
WindContPitchAngleIEC Wind control pitch angle model associated with this wind turbine type 3.
- WindGenType3IEC
WindGenType3IEC Wind generator type 3 model associated with this wind turbine type 3 model.
- WindMechIEC
WindMechIEC Wind mechanical model associated with this wind turbine type 3 model.
-
final
case class
WindTurbineType3or4Dynamics(DynamicsFunctionBlock: DynamicsFunctionBlock = null, PowerElectronicsConnection: String = null, RemoteInputSignal: String = null, WindPlantDynamics: String = null) extends Element with Product with Serializable
Parent class supporting relationships to wind turbines type 3 and type 4 and wind plant including their control models.
Parent class supporting relationships to wind turbines type 3 and type 4 and wind plant including their control models.
- DynamicsFunctionBlock
DynamicsFunctionBlock Reference to the superclass object.
- PowerElectronicsConnection
PowerElectronicsConnection The power electronics connection associated with this wind turbine type 3 or type 4 dynamics model.
- RemoteInputSignal
RemoteInputSignal Remote input signal used by these wind turbine type 3 or type 4 models.
- WindPlantDynamics
WindPlantDynamics The wind plant with which the wind turbines type 3 or type 4 are associated.
-
final
case class
WindTurbineType3or4IEC(WindTurbineType3or4Dynamics: WindTurbineType3or4Dynamics = null, WIndContQIEC: String = null, WindContCurrLimIEC: String = null, WindContQLimIEC: String = null, WindContQPQULimIEC: String = null, WindProtectionIEC: String = null, WindRefFrameRotIEC: String = null) extends Element with Product with Serializable
Parent class supporting relationships to IEC wind turbines type 3 and type 4 including their control models.
Parent class supporting relationships to IEC wind turbines type 3 and type 4 including their control models.
- WindTurbineType3or4Dynamics
WindTurbineType3or4Dynamics Reference to the superclass object.
- WIndContQIEC
WindContQIEC Wind control Q model associated with this wind turbine type 3 or type 4 model.
- WindContCurrLimIEC
WindContCurrLimIEC Wind control current limitation model associated with this wind turbine type 3 or type 4 model.
- WindContQLimIEC
WindContQLimIEC Constant Q limitation model associated with this wind generator type 3 or type 4 model.
- WindContQPQULimIEC
WindContQPQULimIEC QP and QU limitation model associated with this wind generator type 3 or type 4 model.
- WindProtectionIEC
WindProtectionIEC Wind turbune protection model associated with this wind generator type 3 or type 4 model.
- WindRefFrameRotIEC
WindRefFrameRotIEC Reference frame rotation model associated with this wind turbine type 3 or type 4 model.
-
final
case class
WindTurbineType4IEC(WindTurbineType3or4IEC: WindTurbineType3or4IEC = null, WindGenType3aIEC: String = null) extends Element with Product with Serializable
Parent class supporting relationships to IEC wind turbines type 4 including their control models.
Parent class supporting relationships to IEC wind turbines type 4 including their control models.
- WindTurbineType3or4IEC
WindTurbineType3or4IEC Reference to the superclass object.
- WindGenType3aIEC
WindGenType3aIEC Wind generator type 3A model associated with this wind turbine type 4 model.
-
final
case class
WindTurbineType4aIEC(WindTurbineType4IEC: WindTurbineType4IEC = null, WindContPType4aIEC: String = null, WindGenType4IEC: String = null) extends Element with Product with Serializable
Wind turbine IEC type 4A.
Wind turbine IEC type 4A.
Reference: IEC 61400-27-1:2015, 5.5.5.2.
- WindTurbineType4IEC
WindTurbineType4IEC Reference to the superclass object.
- WindContPType4aIEC
WindContPType4aIEC Wind control P type 4A model associated with this wind turbine type 4A model.
- WindGenType4IEC
WindGenType4IEC Wind generator type 4 model associated with this wind turbine type 4A model.
-
final
case class
WindTurbineType4bIEC(WindTurbineType4IEC: WindTurbineType4IEC = null, WindContPType4bIEC: String = null, WindGenType4IEC: String = null, WindMechIEC: String = null) extends Element with Product with Serializable
Wind turbine IEC type 4B.
Wind turbine IEC type 4B.
Reference: IEC 61400-27-1:2015, 5.5.5.3.
- WindTurbineType4IEC
WindTurbineType4IEC Reference to the superclass object.
- WindContPType4bIEC
WindContPType4bIEC Wind control P type 4B model associated with this wind turbine type 4B model.
- WindGenType4IEC
WindGenType4IEC Wind generator type 4 model associated with this wind turbine type 4B model.
- WindMechIEC
WindMechIEC Wind mechanical model associated with this wind turbine type 4B model.
-
final
case class
WindType1or2UserDefined(WindTurbineType1or2Dynamics: WindTurbineType1or2Dynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Wind type 1 or type 2 function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
Wind type 1 or type 2 function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
- WindTurbineType1or2Dynamics
WindTurbineType1or2Dynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
WindType3or4UserDefined(WindTurbineType3or4Dynamics: WindTurbineType3or4Dynamics = null, proprietary: Boolean = false, ProprietaryParameterDynamics: List[String] = null) extends Element with Product with Serializable
Wind type 3 or type 4 function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
Wind type 3 or type 4 function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>
- WindTurbineType3or4Dynamics
WindTurbineType3or4Dynamics Reference to the superclass object.
- proprietary
Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals.
- ProprietaryParameterDynamics
ProprietaryParameterDynamics Parameter of this proprietary user-defined model.
-
final
case class
WindingInsulation(IdentifiedObject: IdentifiedObject = null, insulationPFStatus: String = null, insulationResistance: String = null, leakageReactance: Double = 0.0, status: String = null, FromWinding: String = null, ToWinding: String = null, TransformerObservation: String = null) extends Element with Product with Serializable
Winding insulation condition as a result of a test.
Winding insulation condition as a result of a test.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- insulationPFStatus
Status of Winding Insulation Power Factor as of statusDate: Acceptable, Minor Deterioration or Moisture Absorption, Major Deterioration or Moisture Absorption, Failed.
- insulationResistance
For testType, status of Winding Insulation Resistance as of statusDate. Typical values are: Acceptable, Questionable, Failed.
- leakageReactance
As of statusDate, the leakage reactance measured at the "from" winding with the "to" winding short-circuited and all other windings open-circuited.
- status
undocumented
- FromWinding
TransformerEnd undocumented
- ToWinding
TransformerEnd undocumented
- TransformerObservation
TransformerObservation undocumented
-
final
case class
WireAssemblyInfo(AssetInfo: AssetInfo = null, PerLengthLineParameter: List[String] = null, WirePhaseInfo: List[String] = null) extends Element with Product with Serializable
Describes the construction of a multi-conductor wire.<-NOTE: period missing.
Describes the construction of a multi-conductor wire.<-NOTE: period missing.
- AssetInfo
AssetInfo Reference to the superclass object.
- PerLengthLineParameter
PerLengthLineParameter Per length line parameter associated with this wire assembly.
- WirePhaseInfo
WirePhaseInfo Wire phase information associated with this wire assembly.
-
final
case class
WireInfo(AssetInfo: AssetInfo = null, coreRadius: Double = 0.0, coreStrandCount: Int = 0, gmr: Double = 0.0, insulated: Boolean = false, insulationMaterial: String = null, insulationThickness: Double = 0.0, material: String = null, rAC25: Double = 0.0, rAC50: Double = 0.0, rAC75: Double = 0.0, rDC20: Double = 0.0, radius: Double = 0.0, ratedCurrent: Double = 0.0, sizeDescription: String = null, strandCount: Int = 0, ACLineSegmentPhase: List[String] = null, WirePhaseInfo: List[String] = null) extends Element with Product with Serializable
Wire data that can be specified per line segment phase, or for the line segment as a whole in case its phases all have the same wire characteristics.
Wire data that can be specified per line segment phase, or for the line segment as a whole in case its phases all have the same wire characteristics.
- AssetInfo
AssetInfo Reference to the superclass object.
- coreRadius
(if there is a different core material) Radius of the central core.
- coreStrandCount
(if used) Number of strands in the steel core.
- gmr
Geometric mean radius. If we replace the conductor by a thin walled tube of radius GMR, then its reactance is identical to the reactance of the actual conductor.
- insulated
True if conductor is insulated.
- insulationMaterial
(if insulated conductor) Material used for insulation.
- insulationThickness
(if insulated conductor) Thickness of the insulation.
- material
Conductor material.
- rAC25
AC resistance per unit length of the conductor at 25 °C.
- rAC50
AC resistance per unit length of the conductor at 50 °C.
- rAC75
AC resistance per unit length of the conductor at 75 °C.
- rDC20
DC resistance per unit length of the conductor at 20 °C.
- radius
Outside radius of the wire.
- ratedCurrent
Current carrying capacity of the wire under stated thermal conditions.
- sizeDescription
Describes the wire gauge or cross section (e.g., 4/0, #2, 336.5).
- strandCount
Number of strands in the conductor.
- ACLineSegmentPhase
ACLineSegmentPhase undocumented
- WirePhaseInfo
WirePhaseInfo Wire phase information associated with this wire information.
-
final
case class
WirePhaseInfo(Element: BasicElement = null, phaseInfo: String = null, WireAssemblyInfo: String = null, WireInfo: String = null, WirePosition: String = null) extends Element with Product with Serializable
Information on a wire carrying a single phase.
Information on a wire carrying a single phase.
- Element
Reference to the superclass object.
- phaseInfo
Phase information.
- WireAssemblyInfo
WireAssemblyInfo Wire assembly information using this wire phase information.
- WireInfo
WireInfo Wire information contributing to this wire phase information.
- WirePosition
WirePosition Wire position with this wire phase information.
-
final
case class
WirePosition(IdentifiedObject: IdentifiedObject = null, sequenceNumber: Int = 0, xCoord: Double = 0.0, yCoord: Double = 0.0, WirePhaseInfo: List[String] = null, WireSpacingInfo: String = null) extends Element with Product with Serializable
Identification, spacing and configuration of the wires of a conductor with respect to a structure.
Identification, spacing and configuration of the wires of a conductor with respect to a structure.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- sequenceNumber
Numbering for wires on a WireSpacingInfo. Neutrals should be numbered last.
- xCoord
Signed horizontal distance from the wire at this position to a common reference point.
- yCoord
Signed vertical distance from the wire at this position: above ground (positive value) or burial depth below ground (negative value).
- WirePhaseInfo
WirePhaseInfo Wire phase information for this wire position.
- WireSpacingInfo
WireSpacingInfo Wire spacing data this wire position belongs to.
-
final
case class
WireSegment(Conductor: Conductor = null, WireSegmentPhases: List[String] = null) extends Element with Product with Serializable
A two terminal and power conducting device of negligible impedance and length represented as zero impedance device that can be used to connect auxiliary equipment to its terminals.
A two terminal and power conducting device of negligible impedance and length represented as zero impedance device that can be used to connect auxiliary equipment to its terminals.
- Conductor
Conductor Reference to the superclass object.
- WireSegmentPhases
WireSegmentPhase The wire segment phases which belong to the wire segment.
-
final
case class
WireSegmentPhase(PowerSystemResource: PowerSystemResource = null, phase: String = null, sequenceNumber: Int = 0, WireSegment: String = null) extends Element with Product with Serializable
Represents a single wire of an alternating current wire segment.
Represents a single wire of an alternating current wire segment.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- phase
The phase connection of the wire at both ends.
- sequenceNumber
Number designation for this wire segment phase. Each wire segment phase within a wire segment should have a unique sequence number.
- WireSegment
WireSegment The wire segment to which the phase belongs.
-
final
case class
WireSpacingInfo(AssetInfo: AssetInfo = null, isCable: Boolean = false, phaseWireCount: Int = 0, phaseWireSpacing: Double = 0.0, usage: String = null, ACLineSegment: List[String] = null, DuctBank: String = null, Structures: List[String] = null, WirePositions: List[String] = null) extends Element with Product with Serializable
Wire spacing data that associates multiple wire positions with the line segment, and allows to calculate line segment impedances.
Wire spacing data that associates multiple wire positions with the line segment, and allows to calculate line segment impedances.
Number of phases can be derived from the number of associated wire positions whose phase is not neutral.
- AssetInfo
AssetInfo Reference to the superclass object.
- isCable
If true, this spacing data describes a cable.
- phaseWireCount
Number of wire sub-conductors in the symmetrical bundle (typically between 1 and 4).
- phaseWireSpacing
Distance between wire sub-conductors in a symmetrical bundle.
- usage
Usage of the associated wires.
- ACLineSegment
ACLineSegment undocumented
- DuctBank
DuctBank undocumented
- Structures
Structure undocumented
- WirePositions
WirePosition All positions of single wires (phase or neutral) making the conductor.
-
final
case class
Work(BaseWork: BaseWork = null, requestDateTime: String = null, workOrderNumber: String = null, Appointments: List[String] = null, BusinessCase: String = null, Customers: List[String] = null, Designs: List[String] = null, ErpProjectAccounting: String = null, Incidents: List[String] = null, Project: String = null, WorkBillingInfo: String = null, WorkCostDetails: List[String] = null, WorkFlowSteps: List[String] = null, WorkTasks: List[String] = null) extends Element with Product with Serializable
Document used to request, initiate, track and record work.
Document used to request, initiate, track and record work.
- BaseWork
BaseWork Reference to the superclass object.
- requestDateTime
Date and time work was requested.
- workOrderNumber
Work order number (or other unique identifying information) for this work.
- Appointments
Appointment All appointments for this work.
- BusinessCase
BusinessCase undocumented
- Customers
Customer All the customers for which this work is performed.
- Designs
Design undocumented
- ErpProjectAccounting
ErpProjectAccounting undocumented
- Incidents
Incident All incidents being addressed by this work.
- Project
Project undocumented
- WorkBillingInfo
WorkBillingInfo undocumented
- WorkCostDetails
WorkCostDetail undocumented
- WorkFlowSteps
WorkFlowStep undocumented
- WorkTasks
WorkTask All tasks in this work.
-
final
case class
WorkActivityRecord(ActivityRecord: ActivityRecord = null, percentComplete: Double = 0.0, BaseWork: String = null) extends Element with Product with Serializable
Records information about the status of work or work task at a point in time.
Records information about the status of work or work task at a point in time.
- ActivityRecord
ActivityRecord Reference to the superclass object.
- percentComplete
Estimated percentage of completion of this individual work task or overall work order.
- BaseWork
BaseWork Base work that this activity record tracks.
-
final
case class
WorkAsset(Asset: Asset = null, CUWorkEquipmentAsset: String = null, Crew: String = null) extends Element with Product with Serializable
Asset used to perform work.
Asset used to perform work.
- Asset
Asset Reference to the superclass object.
- CUWorkEquipmentAsset
CUWorkEquipmentItem undocumented
- Crew
Crew Crew using this work asset.
-
final
case class
WorkBillingInfo(Document: Document = null, costEstimate: Double = 0.0, deposit: Double = 0.0, discount: Double = 0.0, dueDateTime: String = null, issueDateTime: String = null, receivedDateTime: String = null, workPrice: Double = 0.0, CustomerAccount: String = null, ErpLineItems: List[String] = null, Works: List[String] = null) extends Element with Product with Serializable
Billing information for work performed for the customer.
Billing information for work performed for the customer.
The history of Work Billing Info, Invoices, and Payments is to be maintained in associated ActivityRecords.
- Document
Document Reference to the superclass object.
- costEstimate
Estimated cost for work.
- deposit
Amount of price on deposit.
- discount
Discount from standard price.
- dueDateTime
Date and time by which payment for bill is expected from client.
- issueDateTime
Date and time bill was issued to client.
- receivedDateTime
Date payment was received from client.
- workPrice
Amount of bill.
- CustomerAccount
CustomerAccount undocumented
- ErpLineItems
ErpInvoiceLineItem undocumented
- Works
Work undocumented
-
final
case class
WorkCostDetail(WorkDocument: WorkDocument = null, amount: Double = 0.0, isDebit: Boolean = false, transactionDateTime: String = null, ContractorItems: List[String] = null, CostType: String = null, Design: String = null, ErpProjectAccounting: String = null, LaborItems: List[String] = null, MiscCostItems: List[String] = null, OverheadCost: String = null, PropertyUnits: List[String] = null, WorkCostSummary: String = null, WorkTask: String = null, Works: List[String] = null) extends Element with Product with Serializable
A collection of all of the individual cost items collected from multiple sources.
A collection of all of the individual cost items collected from multiple sources.
- WorkDocument
WorkDocument Reference to the superclass object.
- amount
Amount in designated currency for work, either a total or an individual element. As defined in the attribute "type," multiple instances are applicable to each work for: planned cost, actual cost, authorized cost, budgeted cost, forecasted cost, other.
- isDebit
True if 'amount' is a debit, false if it is a credit.
- transactionDateTime
Date and time that 'amount' is posted to the work.
- ContractorItems
ContractorItem undocumented
- CostType
CostType undocumented
- Design
Design undocumented
- ErpProjectAccounting
ErpProjectAccounting undocumented
- LaborItems
LaborItem undocumented
- MiscCostItems
MiscCostItem undocumented
- OverheadCost
OverheadCost undocumented
- PropertyUnits
PropertyUnit undocumented
- WorkCostSummary
WorkCostSummary undocumented
- WorkTask
OldWorkTask undocumented
- Works
Work undocumented
-
final
case class
WorkCostSummary(WorkDocument: WorkDocument = null, WorkCostDetail: String = null) extends Element with Product with Serializable
A roll up by cost type for the entire cost of a work order.
A roll up by cost type for the entire cost of a work order.
For example, total labor.
- WorkDocument
WorkDocument Reference to the superclass object.
- WorkCostDetail
WorkCostDetail undocumented
-
final
case class
WorkDocument(Document: Document = null) extends Element with Product with Serializable
Shadow class for Document, to isolate subclassing from this package.
Shadow class for Document, to isolate subclassing from this package.
If any subclass gets normative and needs inheritance, it will inherit directly from Document.
- Document
Document Reference to the superclass object.
-
final
case class
WorkFlowStep(WorkIdentifiedObject: WorkIdentifiedObject = null, sequenceNumber: Int = 0, status: String = null, Work: String = null, WorkTasks: List[String] = null) extends Element with Product with Serializable
A pre-defined set of work steps for a given type of work.
A pre-defined set of work steps for a given type of work.
- WorkIdentifiedObject
WorkIdentifiedObject Reference to the superclass object.
- sequenceNumber
Used to define dependencies of each work flow step, which is for the instance of WorkTask associated with a given instance of WorkFlow.
- status
undocumented
- Work
Work undocumented
- WorkTasks
OldWorkTask undocumented
-
final
case class
WorkIdentifiedObject(IdentifiedObject: IdentifiedObject = null) extends Element with Product with Serializable
Shadow class for IdentifiedObject, to isolate subclassing from this package.
Shadow class for IdentifiedObject, to isolate subclassing from this package.
If any subclass gets normative and needs inheritance, it will inherit directly from IdentifiedObject.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
-
final
case class
WorkLocation(Location: Location = null, BaseWorks: List[String] = null, DesignLocations: List[String] = null, OneCallRequest: String = null) extends Element with Product with Serializable
Information about a particular location for various forms of work.
Information about a particular location for various forms of work.
- Location
Location Reference to the superclass object.
- BaseWorks
BaseWork All works/tasks at this location.
- DesignLocations
DesignLocation undocumented
- OneCallRequest
OneCallRequest undocumented
-
final
case class
WorkTask(BaseWork: BaseWork = null, completedDateTime: String = null, contractorCost: Double = 0.0, crewETA: String = null, estimatedCompletionTime: String = null, instruction: String = null, laborCost: Double = 0.0, laborHours: Double = 0.0, materiallCost: Double = 0.0, schedOverride: String = null, startedDateTime: String = null, taskKind: String = null, toolCost: Double = 0.0, Assets: List[String] = null, Crews: List[String] = null, MaterialItems: List[String] = null, OldAsset: List[String] = null, ProcedureDataSet: List[String] = null, SwitchingPlan: String = null, TroubleOrder: String = null, Work: String = null) extends Element with Product with Serializable
A task within a set of work.
A task within a set of work.
- BaseWork
BaseWork Reference to the superclass object.
- completedDateTime
Date and time work task was completed.
- contractorCost
Total contractor costs associated with the work task.
- crewETA
Estimated time of arrival, so that customer or police/fire department can be informed when the crew will arrive.
- estimatedCompletionTime
Time and Date when the work task will be completed.
- instruction
Instructions for performing this task.
- laborCost
Total labor costs associated with the work task.
- laborHours
Hours of labor expended under work task.
- materiallCost
Total material costs associated with the work task.
- schedOverride
If specified, override schedule and perform this task in accordance with instructions specified here.
- startedDateTime
Date and time work task was started.
- taskKind
Kind of work.
- toolCost
Total tool costs associated with the work task.
- Assets
Asset All assets on which this non-replacement work task is performed.
- Crews
Crew All crews participating in this work task.
- MaterialItems
MaterialItem undocumented
- OldAsset
Asset Old asset replaced by this work task.
- ProcedureDataSet
ProcedureDataSet Procedure data set associated with this work task.
- SwitchingPlan
SwitchingPlan Switching plan executed by this work task.
- TroubleOrder
TroubleOrder undocumented
- Work
Work Work this task belongs to.
-
final
case class
WorkTimeSchedule(TimeSchedule: TimeSchedule = null, kind: String = null, BaseWork: String = null) extends Element with Product with Serializable
Time schedule specific to work.
Time schedule specific to work.
- TimeSchedule
TimeSchedule Reference to the superclass object.
- kind
WorkTimeScheduleKind Kind of this work schedule.
- BaseWork
BaseWork Time schedule for this work or work task.
-
final
case class
WorkTimeScheduleKind(Element: BasicElement = null, actual: String = null, earliest: String = null, estimate: String = null, immediate: String = null, latest: String = null, request: String = null) extends Element with Product with Serializable
Kind of work schedule.
Kind of work schedule.
- Element
Reference to the superclass object.
- actual
Actual work time schedule.
- earliest
Earliest work time schedule.
- estimate
Estimate work time schedule.
- immediate
??.
- latest
Latest work time schedule.
- request
Request work time schedule.
-
final
case class
Zone(Location: Location = null, kind: String = null) extends Element with Product with Serializable
Area divided off from other areas.
Area divided off from other areas.
It may be part of the electrical network, a land area where special restrictions apply, weather areas, etc. For weather, it is an area where a set of relatively homogenous weather measurements apply.
- Location
Location Reference to the superclass object.
- kind
Kind of this zone.
Value Members
- object ACDCConverter extends CIMParseable[ACDCConverter] with Serializable
- object ACDCConverterDCTerminal extends CIMParseable[ACDCConverterDCTerminal] with Serializable
- object ACDCConverterDCTerminalSerializer extends CIMSerializer[ACDCConverterDCTerminal]
- object ACDCConverterSerializer extends CIMSerializer[ACDCConverter]
- object ACDCTerminal extends CIMParseable[ACDCTerminal] with Serializable
- object ACDCTerminalSerializer extends CIMSerializer[ACDCTerminal]
- object ACLineSegment extends CIMParseable[ACLineSegment] with Serializable
- object ACLineSegmentPhase extends CIMParseable[ACLineSegmentPhase] with Serializable
- object ACLineSegmentPhaseSerializer extends CIMSerializer[ACLineSegmentPhase]
- object ACLineSegmentSerializer extends CIMSerializer[ACLineSegment]
- object ASRequirements extends CIMParseable[ASRequirements] with Serializable
- object ASRequirementsSerializer extends CIMSerializer[ASRequirements]
- object ASTMStandard extends CIMParseable[ASTMStandard] with Serializable
- object ASTMStandardSerializer extends CIMSerializer[ASTMStandard]
- object AcceptanceTest extends CIMParseable[AcceptanceTest] with Serializable
- object AcceptanceTestSerializer extends CIMSerializer[AcceptanceTest]
- object AccessPermit extends CIMParseable[AccessPermit] with Serializable
- object AccessPermitSerializer extends CIMSerializer[AccessPermit]
- object AccountMovement extends CIMParseable[AccountMovement] with Serializable
- object AccountMovementSerializer extends CIMSerializer[AccountMovement]
- object AccountNotification extends CIMParseable[AccountNotification] with Serializable
- object AccountNotificationSerializer extends CIMSerializer[AccountNotification]
- object AccountingUnit extends CIMParseable[AccountingUnit] with Serializable
- object AccountingUnitSerializer extends CIMSerializer[AccountingUnit]
- object Accumulator extends CIMParseable[Accumulator] with Serializable
- object AccumulatorLimit extends CIMParseable[AccumulatorLimit] with Serializable
- object AccumulatorLimitSerializer extends CIMSerializer[AccumulatorLimit]
- object AccumulatorLimitSet extends CIMParseable[AccumulatorLimitSet] with Serializable
- object AccumulatorLimitSetSerializer extends CIMSerializer[AccumulatorLimitSet]
- object AccumulatorReset extends CIMParseable[AccumulatorReset] with Serializable
- object AccumulatorResetSerializer extends CIMSerializer[AccumulatorReset]
- object AccumulatorSerializer extends CIMSerializer[Accumulator]
- object AccumulatorValue extends CIMParseable[AccumulatorValue] with Serializable
- object AccumulatorValueSerializer extends CIMSerializer[AccumulatorValue]
- object AceTariffType extends CIMParseable[AceTariffType] with Serializable
- object AceTariffTypeSerializer extends CIMSerializer[AceTariffType]
- object ActionRequest extends CIMParseable[ActionRequest] with Serializable
- object ActionRequestSerializer extends CIMSerializer[ActionRequest]
- object ActivePowerLimit extends CIMParseable[ActivePowerLimit] with Serializable
- object ActivePowerLimitSerializer extends CIMSerializer[ActivePowerLimit]
- object ActivityRecord extends CIMParseable[ActivityRecord] with Serializable
- object ActivityRecordSerializer extends CIMSerializer[ActivityRecord]
- object AdjacentCASet extends CIMParseable[AdjacentCASet] with Serializable
- object AdjacentCASetSerializer extends CIMSerializer[AdjacentCASet]
- object AggregateNode extends CIMParseable[AggregateNode] with Serializable
- object AggregateNodeSerializer extends CIMSerializer[AggregateNode]
- object AggregateScore extends CIMParseable[AggregateScore] with Serializable
- object AggregateScoreSerializer extends CIMSerializer[AggregateScore]
- object AggregatedPnode extends CIMParseable[AggregatedPnode] with Serializable
- object AggregatedPnodeSerializer extends CIMSerializer[AggregatedPnode]
- object Agreement extends CIMParseable[Agreement] with Serializable
- object AgreementSerializer extends CIMSerializer[Agreement]
- object AirCompressor extends CIMParseable[AirCompressor] with Serializable
- object AirCompressorSerializer extends CIMSerializer[AirCompressor]
- object AlertTypeList extends CIMParseable[AlertTypeList] with Serializable
- object AlertTypeListSerializer extends CIMSerializer[AlertTypeList]
- object AllocationResult extends CIMParseable[AllocationResult] with Serializable
- object AllocationResultSerializer extends CIMSerializer[AllocationResult]
- object AllocationResultValues extends CIMParseable[AllocationResultValues] with Serializable
- object AllocationResultValuesSerializer extends CIMSerializer[AllocationResultValues]
- object AltGeneratingUnitMeas extends CIMParseable[AltGeneratingUnitMeas] with Serializable
- object AltGeneratingUnitMeasSerializer extends CIMSerializer[AltGeneratingUnitMeas]
- object AltTieMeas extends CIMParseable[AltTieMeas] with Serializable
- object AltTieMeasSerializer extends CIMSerializer[AltTieMeas]
- object AlternateModel extends CIMParseable[AlternateModel] with Serializable
- object AlternateModelGroup extends CIMParseable[AlternateModelGroup] with Serializable
- object AlternateModelGroupSerializer extends CIMSerializer[AlternateModelGroup]
- object AlternateModelSerializer extends CIMSerializer[AlternateModel]
- object Analog extends CIMParseable[Analog] with Serializable
- object AnalogControl extends CIMParseable[AnalogControl] with Serializable
- object AnalogControlSerializer extends CIMSerializer[AnalogControl]
- object AnalogLimit extends CIMParseable[AnalogLimit] with Serializable
- object AnalogLimitSerializer extends CIMSerializer[AnalogLimit]
- object AnalogLimitSet extends CIMParseable[AnalogLimitSet] with Serializable
- object AnalogLimitSetSerializer extends CIMSerializer[AnalogLimitSet]
- object AnalogMeasurementValueQuality extends CIMParseable[AnalogMeasurementValueQuality] with Serializable
- object AnalogMeasurementValueQualitySerializer extends CIMSerializer[AnalogMeasurementValueQuality]
- object AnalogSerializer extends CIMSerializer[Analog]
- object AnalogValue extends CIMParseable[AnalogValue] with Serializable
- object AnalogValueSerializer extends CIMSerializer[AnalogValue]
- object Analytic extends CIMParseable[Analytic] with Serializable
- object AnalyticScore extends CIMParseable[AnalyticScore] with Serializable
- object AnalyticScoreSerializer extends CIMSerializer[AnalyticScore]
- object AnalyticSerializer extends CIMSerializer[Analytic]
- object AncillaryServiceClearing extends CIMParseable[AncillaryServiceClearing] with Serializable
- object AncillaryServiceClearingSerializer extends CIMSerializer[AncillaryServiceClearing]
- object AnnotatedProjectDependency extends CIMParseable[AnnotatedProjectDependency] with Serializable
- object AnnotatedProjectDependencySerializer extends CIMSerializer[AnnotatedProjectDependency]
- object ApparentPowerLimit extends CIMParseable[ApparentPowerLimit] with Serializable
- object ApparentPowerLimitSerializer extends CIMSerializer[ApparentPowerLimit]
- object Appointment extends CIMParseable[Appointment] with Serializable
- object AppointmentSerializer extends CIMSerializer[Appointment]
- object Approver extends CIMParseable[Approver] with Serializable
- object ApproverSerializer extends CIMSerializer[Approver]
- object AreaLoadBid extends CIMParseable[AreaLoadBid] with Serializable
- object AreaLoadBidSerializer extends CIMSerializer[AreaLoadBid]
- object AreaLoadCurve extends CIMParseable[AreaLoadCurve] with Serializable
- object AreaLoadCurveSerializer extends CIMSerializer[AreaLoadCurve]
- object AreaReserveSpec extends CIMParseable[AreaReserveSpec] with Serializable
- object AreaReserveSpecSerializer extends CIMSerializer[AreaReserveSpec]
- object AssemblyDescription extends CIMParseable[AssemblyDescription] with Serializable
- object AssemblyDescriptionSerializer extends CIMSerializer[AssemblyDescription]
- object AssemblyManifest extends CIMParseable[AssemblyManifest] with Serializable
- object AssemblyManifestSerializer extends CIMSerializer[AssemblyManifest]
- object Asset extends CIMParseable[Asset] with Serializable
- object AssetAnalog extends CIMParseable[AssetAnalog] with Serializable
- object AssetAnalogSerializer extends CIMSerializer[AssetAnalog]
- object AssetContainer extends CIMParseable[AssetContainer] with Serializable
- object AssetContainerSerializer extends CIMSerializer[AssetContainer]
- object AssetDeployment extends CIMParseable[AssetDeployment] with Serializable
- object AssetDeploymentSerializer extends CIMSerializer[AssetDeployment]
- object AssetDiscrete extends CIMParseable[AssetDiscrete] with Serializable
- object AssetDiscreteSerializer extends CIMSerializer[AssetDiscrete]
- object AssetFunction extends CIMParseable[AssetFunction] with Serializable
- object AssetFunctionSerializer extends CIMSerializer[AssetFunction]
- object AssetGroup extends CIMParseable[AssetGroup] with Serializable
- object AssetGroupSerializer extends CIMSerializer[AssetGroup]
- object AssetHealthEvent extends CIMParseable[AssetHealthEvent] with Serializable
- object AssetHealthEventSerializer extends CIMSerializer[AssetHealthEvent]
- object AssetInfo extends CIMParseable[AssetInfo] with Serializable
- object AssetInfoSerializer extends CIMSerializer[AssetInfo]
- object AssetLocationHazard extends CIMParseable[AssetLocationHazard] with Serializable
- object AssetLocationHazardSerializer extends CIMSerializer[AssetLocationHazard]
- object AssetModelCatalogue extends CIMParseable[AssetModelCatalogue] with Serializable
- object AssetModelCatalogueItem extends CIMParseable[AssetModelCatalogueItem] with Serializable
- object AssetModelCatalogueItemSerializer extends CIMSerializer[AssetModelCatalogueItem]
- object AssetModelCatalogueSerializer extends CIMSerializer[AssetModelCatalogue]
- object AssetOrganisationRole extends CIMParseable[AssetOrganisationRole] with Serializable
- object AssetOrganisationRoleSerializer extends CIMSerializer[AssetOrganisationRole]
- object AssetOwner extends CIMParseable[AssetOwner] with Serializable
- object AssetOwnerSerializer extends CIMSerializer[AssetOwner]
- object AssetPropertyCurve extends CIMParseable[AssetPropertyCurve] with Serializable
- object AssetPropertyCurveSerializer extends CIMSerializer[AssetPropertyCurve]
- object AssetSerializer extends CIMSerializer[Asset]
- object AssetStringMeasurement extends CIMParseable[AssetStringMeasurement] with Serializable
- object AssetStringMeasurementSerializer extends CIMSerializer[AssetStringMeasurement]
- object AssetTemperaturePressureAnalog extends CIMParseable[AssetTemperaturePressureAnalog] with Serializable
- object AssetTemperaturePressureAnalogSerializer extends CIMSerializer[AssetTemperaturePressureAnalog]
- object AssetTestLab extends CIMParseable[AssetTestLab] with Serializable
- object AssetTestLabSerializer extends CIMSerializer[AssetTestLab]
- object AssetTestSampleTaker extends CIMParseable[AssetTestSampleTaker] with Serializable
- object AssetTestSampleTakerSerializer extends CIMSerializer[AssetTestSampleTaker]
- object AssetUser extends CIMParseable[AssetUser] with Serializable
- object AssetUserSerializer extends CIMSerializer[AssetUser]
- object Assignment extends CIMParseable[Assignment] with Serializable
- object AssignmentSerializer extends CIMSerializer[Assignment]
- object AsynchronousMachine extends CIMParseable[AsynchronousMachine] with Serializable
- object AsynchronousMachineDynamics extends CIMParseable[AsynchronousMachineDynamics] with Serializable
- object AsynchronousMachineDynamicsSerializer extends CIMSerializer[AsynchronousMachineDynamics]
- object AsynchronousMachineEquivalentCircuit extends CIMParseable[AsynchronousMachineEquivalentCircuit] with Serializable
- object AsynchronousMachineEquivalentCircuitSerializer extends CIMSerializer[AsynchronousMachineEquivalentCircuit]
- object AsynchronousMachineSerializer extends CIMSerializer[AsynchronousMachine]
- object AsynchronousMachineTimeConstantReactance extends CIMParseable[AsynchronousMachineTimeConstantReactance] with Serializable
- object AsynchronousMachineTimeConstantReactanceSerializer extends CIMSerializer[AsynchronousMachineTimeConstantReactance]
- object AsynchronousMachineUserDefined extends CIMParseable[AsynchronousMachineUserDefined] with Serializable
- object AsynchronousMachineUserDefinedSerializer extends CIMSerializer[AsynchronousMachineUserDefined]
- object AtmosphericAnalog extends CIMParseable[AtmosphericAnalog] with Serializable
- object AtmosphericAnalogSerializer extends CIMSerializer[AtmosphericAnalog]
- object AtmosphericPhenomenon extends CIMParseable[AtmosphericPhenomenon] with Serializable
- object AtmosphericPhenomenonSerializer extends CIMSerializer[AtmosphericPhenomenon]
- object AttributeInstanceComponent extends CIMParseable[AttributeInstanceComponent] with Serializable
- object AttributeInstanceComponentSerializer extends CIMSerializer[AttributeInstanceComponent]
- object AttributeProperty extends CIMParseable[AttributeProperty] with Serializable
- object AttributePropertySerializer extends CIMSerializer[AttributeProperty]
- object Auction extends CIMParseable[Auction] with Serializable
- object AuctionSerializer extends CIMSerializer[Auction]
- object Author extends CIMParseable[Author] with Serializable
- object AuthorSerializer extends CIMSerializer[Author]
- object AuxiliaryAccount extends CIMParseable[AuxiliaryAccount] with Serializable
- object AuxiliaryAccountSerializer extends CIMSerializer[AuxiliaryAccount]
- object AuxiliaryAgreement extends CIMParseable[AuxiliaryAgreement] with Serializable
- object AuxiliaryAgreementSerializer extends CIMSerializer[AuxiliaryAgreement]
- object AuxiliaryCost extends CIMParseable[AuxiliaryCost] with Serializable
- object AuxiliaryCostSerializer extends CIMSerializer[AuxiliaryCost]
- object AuxiliaryEquipment extends CIMParseable[AuxiliaryEquipment] with Serializable
- object AuxiliaryEquipmentSerializer extends CIMSerializer[AuxiliaryEquipment]
- object AuxiliaryObject extends CIMParseable[AuxiliaryObject] with Serializable
- object AuxiliaryObjectSerializer extends CIMSerializer[AuxiliaryObject]
- object AuxiliaryValues extends CIMParseable[AuxiliaryValues] with Serializable
- object AuxiliaryValuesSerializer extends CIMSerializer[AuxiliaryValues]
- object AvailablityPlan extends CIMParseable[AvailablityPlan] with Serializable
- object AvailablityPlanSerializer extends CIMSerializer[AvailablityPlan]
- object BWRSteamSupply extends CIMParseable[BWRSteamSupply] with Serializable
- object BWRSteamSupplySerializer extends CIMSerializer[BWRSteamSupply]
- object Bank extends CIMParseable[Bank] with Serializable
- object BankAccount extends CIMParseable[BankAccount] with Serializable
- object BankAccountDetail extends CIMParseable[BankAccountDetail] with Serializable
- object BankAccountDetailSerializer extends CIMSerializer[BankAccountDetail]
- object BankAccountSerializer extends CIMSerializer[BankAccount]
- object BankSerializer extends CIMSerializer[Bank]
- object BaseCaseConstraintLimit extends CIMParseable[BaseCaseConstraintLimit] with Serializable
- object BaseCaseConstraintLimitSerializer extends CIMSerializer[BaseCaseConstraintLimit]
- object BaseFrequency extends CIMParseable[BaseFrequency] with Serializable
- object BaseFrequencySerializer extends CIMSerializer[BaseFrequency]
- object BasePower extends CIMParseable[BasePower] with Serializable
- object BasePowerSerializer extends CIMSerializer[BasePower]
- object BaseReading extends CIMParseable[BaseReading] with Serializable
- object BaseReadingSerializer extends CIMSerializer[BaseReading]
- object BaseVoltage extends CIMParseable[BaseVoltage] with Serializable
- object BaseVoltageSerializer extends CIMSerializer[BaseVoltage]
- object BaseWork extends CIMParseable[BaseWork] with Serializable
- object BaseWorkSerializer extends CIMSerializer[BaseWork]
- object BasicElement extends CIMParser with Serializable
- object BasicElementSerializer extends CIMSerializer[BasicElement]
- object BasicIntervalSchedule extends CIMParseable[BasicIntervalSchedule] with Serializable
- object BasicIntervalScheduleSerializer extends CIMSerializer[BasicIntervalSchedule]
- object BatteryUnit extends CIMParseable[BatteryUnit] with Serializable
- object BatteryUnitSerializer extends CIMSerializer[BatteryUnit]
- object Bay extends CIMParseable[Bay] with Serializable
- object BaySerializer extends CIMSerializer[Bay]
- object Bid extends CIMParseable[Bid] with Serializable
- object BidDistributionFactor extends CIMParseable[BidDistributionFactor] with Serializable
- object BidDistributionFactorSerializer extends CIMSerializer[BidDistributionFactor]
- object BidError extends CIMParseable[BidError] with Serializable
- object BidErrorSerializer extends CIMSerializer[BidError]
- object BidHourlyProductSchedule extends CIMParseable[BidHourlyProductSchedule] with Serializable
- object BidHourlyProductScheduleSerializer extends CIMSerializer[BidHourlyProductSchedule]
- object BidHourlySchedule extends CIMParseable[BidHourlySchedule] with Serializable
- object BidHourlyScheduleSerializer extends CIMSerializer[BidHourlySchedule]
- object BidPriceCap extends CIMParseable[BidPriceCap] with Serializable
- object BidPriceCapSerializer extends CIMSerializer[BidPriceCap]
- object BidPriceCurve extends CIMParseable[BidPriceCurve] with Serializable
- object BidPriceCurveSerializer extends CIMSerializer[BidPriceCurve]
- object BidPriceSchedule extends CIMParseable[BidPriceSchedule] with Serializable
- object BidPriceScheduleSerializer extends CIMSerializer[BidPriceSchedule]
- object BidSelfSched extends CIMParseable[BidSelfSched] with Serializable
- object BidSelfSchedSerializer extends CIMSerializer[BidSelfSched]
- object BidSerializer extends CIMSerializer[Bid]
- object BidSet extends CIMParseable[BidSet] with Serializable
- object BidSetSerializer extends CIMSerializer[BidSet]
- object BidTimeSeries extends CIMParseable[BidTimeSeries] with Serializable
- object BidTimeSeriesSerializer extends CIMSerializer[BidTimeSeries]
- object BilateralExchangeActor extends CIMParseable[BilateralExchangeActor] with Serializable
- object BilateralExchangeActorSerializer extends CIMSerializer[BilateralExchangeActor]
- object BilateralExchangeAgreement extends CIMParseable[BilateralExchangeAgreement] with Serializable
- object BilateralExchangeAgreementSerializer extends CIMSerializer[BilateralExchangeAgreement]
- object BilateralTransaction extends CIMParseable[BilateralTransaction] with Serializable
- object BilateralTransactionSerializer extends CIMSerializer[BilateralTransaction]
- object BillDeterminant extends CIMParseable[BillDeterminant] with Serializable
- object BillDeterminantSerializer extends CIMSerializer[BillDeterminant]
- object BlockDispatchComponent extends CIMParseable[BlockDispatchComponent] with Serializable
- object BlockDispatchComponentSerializer extends CIMSerializer[BlockDispatchComponent]
- object BlockDispatchInstruction extends CIMParseable[BlockDispatchInstruction] with Serializable
- object BlockDispatchInstructionSerializer extends CIMSerializer[BlockDispatchInstruction]
- object BlockDispatchOrder extends CIMParseable[BlockDispatchOrder] with Serializable
- object BlockDispatchOrderSerializer extends CIMSerializer[BlockDispatchOrder]
- object BlockingFunction extends CIMParseable[BlockingFunction] with Serializable
- object BlockingFunctionSerializer extends CIMSerializer[BlockingFunction]
- object BranchEndFlow extends CIMParseable[BranchEndFlow] with Serializable
- object BranchEndFlowSerializer extends CIMSerializer[BranchEndFlow]
- object BranchGroup extends CIMParseable[BranchGroup] with Serializable
- object BranchGroupSerializer extends CIMSerializer[BranchGroup]
- object BranchGroupTerminal extends CIMParseable[BranchGroupTerminal] with Serializable
- object BranchGroupTerminalSerializer extends CIMSerializer[BranchGroupTerminal]
- object Breaker extends CIMParseable[Breaker] with Serializable
- object BreakerInfo extends CIMParseable[BreakerInfo] with Serializable
- object BreakerInfoSerializer extends CIMSerializer[BreakerInfo]
- object BreakerSerializer extends CIMSerializer[Breaker]
- object BusNameMarker extends CIMParseable[BusNameMarker] with Serializable
- object BusNameMarkerSerializer extends CIMSerializer[BusNameMarker]
- object BusbarSection extends CIMParseable[BusbarSection] with Serializable
- object BusbarSectionInfo extends CIMParseable[BusbarSectionInfo] with Serializable
- object BusbarSectionInfoSerializer extends CIMSerializer[BusbarSectionInfo]
- object BusbarSectionSerializer extends CIMSerializer[BusbarSection]
- object Bushing extends CIMParseable[Bushing] with Serializable
- object BushingInfo extends CIMParseable[BushingInfo] with Serializable
- object BushingInfoSerializer extends CIMSerializer[BushingInfo]
- object BushingInsulationPF extends CIMParseable[BushingInsulationPF] with Serializable
- object BushingInsulationPFSerializer extends CIMSerializer[BushingInsulationPF]
- object BushingSerializer extends CIMSerializer[Bushing]
- object BusinessCase extends CIMParseable[BusinessCase] with Serializable
- object BusinessCaseSerializer extends CIMSerializer[BusinessCase]
- object BusinessPlan extends CIMParseable[BusinessPlan] with Serializable
- object BusinessPlanSerializer extends CIMSerializer[BusinessPlan]
- object BusinessRole extends CIMParseable[BusinessRole] with Serializable
- object BusinessRoleSerializer extends CIMSerializer[BusinessRole]
- object CAESPlant extends CIMParseable[CAESPlant] with Serializable
- object CAESPlantSerializer extends CIMSerializer[CAESPlant]
- object CCAinverter extends CIMParseable[CCAinverter] with Serializable
- object CCAinverterSerializer extends CIMSerializer[CCAinverter]
- object CCArectifierControl extends CIMParseable[CCArectifierControl] with Serializable
- object CCArectifierControlSerializer extends CIMSerializer[CCArectifierControl]
- object CIGREStandard extends CIMParseable[CIGREStandard] with Serializable
- object CIGREStandardSerializer extends CIMSerializer[CIGREStandard]
- object CRRMarket extends CIMParseable[CRRMarket] with Serializable
- object CRRMarketSerializer extends CIMSerializer[CRRMarket]
- object CRROrgRole extends CIMParseable[CRROrgRole] with Serializable
- object CRROrgRoleSerializer extends CIMSerializer[CRROrgRole]
- object CRRSegment extends CIMParseable[CRRSegment] with Serializable
- object CRRSegmentSerializer extends CIMSerializer[CRRSegment]
- object CSCDynamics extends CIMParseable[CSCDynamics] with Serializable
- object CSCDynamicsSerializer extends CIMSerializer[CSCDynamics]
- object CSCUserDefined extends CIMParseable[CSCUserDefined] with Serializable
- object CSCUserDefinedSerializer extends CIMSerializer[CSCUserDefined]
- object CSCtype1 extends CIMParseable[CSCtype1] with Serializable
- object CSCtype1Serializer extends CIMSerializer[CSCtype1]
- object CTTempActivePowerCurve extends CIMParseable[CTTempActivePowerCurve] with Serializable
- object CTTempActivePowerCurveSerializer extends CIMSerializer[CTTempActivePowerCurve]
- object CUAllowableAction extends CIMParseable[CUAllowableAction] with Serializable
- object CUAllowableActionSerializer extends CIMSerializer[CUAllowableAction]
- object CUContractorItem extends CIMParseable[CUContractorItem] with Serializable
- object CUContractorItemSerializer extends CIMSerializer[CUContractorItem]
- object CUGroup extends CIMParseable[CUGroup] with Serializable
- object CUGroupSerializer extends CIMSerializer[CUGroup]
- object CULaborCode extends CIMParseable[CULaborCode] with Serializable
- object CULaborCodeSerializer extends CIMSerializer[CULaborCode]
- object CULaborItem extends CIMParseable[CULaborItem] with Serializable
- object CULaborItemSerializer extends CIMSerializer[CULaborItem]
- object CUMaterialItem extends CIMParseable[CUMaterialItem] with Serializable
- object CUMaterialItemSerializer extends CIMSerializer[CUMaterialItem]
- object CUWorkEquipmentItem extends CIMParseable[CUWorkEquipmentItem] with Serializable
- object CUWorkEquipmentItemSerializer extends CIMSerializer[CUWorkEquipmentItem]
- object Cabinet extends CIMParseable[Cabinet] with Serializable
- object CabinetSerializer extends CIMSerializer[Cabinet]
- object CableInfo extends CIMParseable[CableInfo] with Serializable
- object CableInfoSerializer extends CIMSerializer[CableInfo]
- object CalculationMethodHierarchy extends CIMParseable[CalculationMethodHierarchy] with Serializable
- object CalculationMethodHierarchySerializer extends CIMSerializer[CalculationMethodHierarchy]
- object CalculationMethodOrder extends CIMParseable[CalculationMethodOrder] with Serializable
- object CalculationMethodOrderSerializer extends CIMSerializer[CalculationMethodOrder]
- object Capability extends CIMParseable[Capability] with Serializable
- object CapabilitySerializer extends CIMSerializer[Capability]
- object Card extends CIMParseable[Card] with Serializable
- object CardSerializer extends CIMSerializer[Card]
- object Cashier extends CIMParseable[Cashier] with Serializable
- object CashierSerializer extends CIMSerializer[Cashier]
- object CashierShift extends CIMParseable[CashierShift] with Serializable
- object CashierShiftSerializer extends CIMSerializer[CashierShift]
- object CatalogAssetType extends CIMParseable[CatalogAssetType] with Serializable
- object CatalogAssetTypeSerializer extends CIMSerializer[CatalogAssetType]
- object ChangeSet extends CIMParseable[ChangeSet] with Serializable
- object ChangeSetMember extends CIMParseable[ChangeSetMember] with Serializable
- object ChangeSetMemberSerializer extends CIMSerializer[ChangeSetMember]
- object ChangeSetSerializer extends CIMSerializer[ChangeSet]
- object Channel extends CIMParseable[Channel] with Serializable
- object ChannelSerializer extends CIMSerializer[Channel]
- object Charge extends CIMParseable[Charge] with Serializable
- object ChargeComponent extends CIMParseable[ChargeComponent] with Serializable
- object ChargeComponentSerializer extends CIMSerializer[ChargeComponent]
- object ChargeGroup extends CIMParseable[ChargeGroup] with Serializable
- object ChargeGroupSerializer extends CIMSerializer[ChargeGroup]
- object ChargeProfile extends CIMParseable[ChargeProfile] with Serializable
- object ChargeProfileData extends CIMParseable[ChargeProfileData] with Serializable
- object ChargeProfileDataSerializer extends CIMSerializer[ChargeProfileData]
- object ChargeProfileSerializer extends CIMSerializer[ChargeProfile]
- object ChargeSerializer extends CIMSerializer[Charge]
- object ChargeType extends CIMParseable[ChargeType] with Serializable
- object ChargeTypeSerializer extends CIMSerializer[ChargeType]
- object Cheque extends CIMParseable[Cheque] with Serializable
- object ChequeSerializer extends CIMSerializer[Cheque]
- object Circuit extends CIMParseable[Circuit] with Serializable
- object CircuitSerializer extends CIMSerializer[Circuit]
- object Clamp extends CIMParseable[Clamp] with Serializable
- object ClampAction extends CIMParseable[ClampAction] with Serializable
- object ClampActionSerializer extends CIMSerializer[ClampAction]
- object ClampSerializer extends CIMSerializer[Clamp]
- object ClassificationCondition extends CIMParseable[ClassificationCondition] with Serializable
- object ClassificationConditionSerializer extends CIMSerializer[ClassificationCondition]
- object ClearanceAction extends CIMParseable[ClearanceAction] with Serializable
- object ClearanceActionSerializer extends CIMSerializer[ClearanceAction]
- object ClearanceDocument extends CIMParseable[ClearanceDocument] with Serializable
- object ClearanceDocumentSerializer extends CIMSerializer[ClearanceDocument]
- object CloudCondition extends CIMParseable[CloudCondition] with Serializable
- object CloudConditionSerializer extends CIMSerializer[CloudCondition]
- object CnodeDistributionFactor extends CIMParseable[CnodeDistributionFactor] with Serializable
- object CnodeDistributionFactorSerializer extends CIMSerializer[CnodeDistributionFactor]
- object CogenerationPlant extends CIMParseable[CogenerationPlant] with Serializable
- object CogenerationPlantSerializer extends CIMSerializer[CogenerationPlant]
- object ComFunction extends CIMParseable[ComFunction] with Serializable
- object ComFunctionSerializer extends CIMSerializer[ComFunction]
- object ComMedia extends CIMParseable[ComMedia] with Serializable
- object ComMediaSerializer extends CIMSerializer[ComMedia]
- object ComModule extends CIMParseable[ComModule] with Serializable
- object ComModuleSerializer extends CIMSerializer[ComModule]
- object CombinedCycleConfiguration extends CIMParseable[CombinedCycleConfiguration] with Serializable
- object CombinedCycleConfigurationMember extends CIMParseable[CombinedCycleConfigurationMember] with Serializable
- object CombinedCycleConfigurationMemberSerializer extends CIMSerializer[CombinedCycleConfigurationMember]
- object CombinedCycleConfigurationSerializer extends CIMSerializer[CombinedCycleConfiguration]
- object CombinedCycleLogicalConfiguration extends CIMParseable[CombinedCycleLogicalConfiguration] with Serializable
- object CombinedCycleLogicalConfigurationSerializer extends CIMSerializer[CombinedCycleLogicalConfiguration]
- object CombinedCyclePlant extends CIMParseable[CombinedCyclePlant] with Serializable
- object CombinedCyclePlantSerializer extends CIMSerializer[CombinedCyclePlant]
- object CombinedCycleTransitionState extends CIMParseable[CombinedCycleTransitionState] with Serializable
- object CombinedCycleTransitionStateSerializer extends CIMSerializer[CombinedCycleTransitionState]
- object CombustionTurbine extends CIMParseable[CombustionTurbine] with Serializable
- object CombustionTurbineSerializer extends CIMSerializer[CombustionTurbine]
- object Command extends CIMParseable[Command] with Serializable
- object CommandSerializer extends CIMSerializer[Command]
- object CommitmentClearing extends CIMParseable[CommitmentClearing] with Serializable
- object CommitmentClearingSerializer extends CIMSerializer[CommitmentClearing]
- object Commitments extends CIMParseable[Commitments] with Serializable
- object CommitmentsSerializer extends CIMSerializer[Commitments]
- object CommodityDefinition extends CIMParseable[CommodityDefinition] with Serializable
- object CommodityDefinitionSerializer extends CIMSerializer[CommodityDefinition]
- object CommodityPrice extends CIMParseable[CommodityPrice] with Serializable
- object CommodityPriceSerializer extends CIMSerializer[CommodityPrice]
- object CommunicationLink extends CIMParseable[CommunicationLink] with Serializable
- object CommunicationLinkSerializer extends CIMSerializer[CommunicationLink]
- object CompatibleUnit extends CIMParseable[CompatibleUnit] with Serializable
- object CompatibleUnitSerializer extends CIMSerializer[CompatibleUnit]
- object CompleteModelToBeDeleted extends CIMParseable[CompleteModelToBeDeleted] with Serializable
- object CompleteModelToBeDeletedSerializer extends CIMSerializer[CompleteModelToBeDeleted]
- object ComplianceEvent extends CIMParseable[ComplianceEvent] with Serializable
- object ComplianceEventSerializer extends CIMSerializer[ComplianceEvent]
- object CompositeSwitch extends CIMParseable[CompositeSwitch] with Serializable
- object CompositeSwitchInfo extends CIMParseable[CompositeSwitchInfo] with Serializable
- object CompositeSwitchInfoSerializer extends CIMSerializer[CompositeSwitchInfo]
- object CompositeSwitchSerializer extends CIMSerializer[CompositeSwitch]
- object ConcentricNeutralCableInfo extends CIMParseable[ConcentricNeutralCableInfo] with Serializable
- object ConcentricNeutralCableInfoSerializer extends CIMSerializer[ConcentricNeutralCableInfo]
- object ConditionFactor extends CIMParseable[ConditionFactor] with Serializable
- object ConditionFactorSerializer extends CIMSerializer[ConditionFactor]
- object ConductingEquipment extends CIMParseable[ConductingEquipment] with Serializable
- object ConductingEquipmentSerializer extends CIMSerializer[ConductingEquipment]
- object Conductor extends CIMParseable[Conductor] with Serializable
- object ConductorSerializer extends CIMSerializer[Conductor]
- object ConfigurationEvent extends CIMParseable[ConfigurationEvent] with Serializable
- object ConfigurationEventSerializer extends CIMSerializer[ConfigurationEvent]
- object ConformLoad extends CIMParseable[ConformLoad] with Serializable
- object ConformLoadGroup extends CIMParseable[ConformLoadGroup] with Serializable
- object ConformLoadGroupSerializer extends CIMSerializer[ConformLoadGroup]
- object ConformLoadSchedule extends CIMParseable[ConformLoadSchedule] with Serializable
- object ConformLoadScheduleSerializer extends CIMSerializer[ConformLoadSchedule]
- object ConformLoadSerializer extends CIMSerializer[ConformLoad]
- object CongestionArea extends CIMParseable[CongestionArea] with Serializable
- object CongestionAreaSerializer extends CIMSerializer[CongestionArea]
- object CongestionRevenueRight extends CIMParseable[CongestionRevenueRight] with Serializable
- object CongestionRevenueRightSerializer extends CIMSerializer[CongestionRevenueRight]
- object ConnectDisconnectFunction extends CIMParseable[ConnectDisconnectFunction] with Serializable
- object ConnectDisconnectFunctionSerializer extends CIMSerializer[ConnectDisconnectFunction]
- object ConnectivityNode extends CIMParseable[ConnectivityNode] with Serializable
- object ConnectivityNodeContainer extends CIMParseable[ConnectivityNodeContainer] with Serializable
- object ConnectivityNodeContainerSerializer extends CIMSerializer[ConnectivityNodeContainer]
- object ConnectivityNodeSerializer extends CIMSerializer[ConnectivityNode]
- object Connector extends CIMParseable[Connector] with Serializable
- object ConnectorSerializer extends CIMSerializer[Connector]
- object ConstraintClearing extends CIMParseable[ConstraintClearing] with Serializable
- object ConstraintClearingSerializer extends CIMSerializer[ConstraintClearing]
- object ConstraintDuration extends CIMParseable[ConstraintDuration] with Serializable
- object ConstraintDurationSerializer extends CIMSerializer[ConstraintDuration]
- object ConstraintResults extends CIMParseable[ConstraintResults] with Serializable
- object ConstraintResultsSerializer extends CIMSerializer[ConstraintResults]
- object ConstraintTerm extends CIMParseable[ConstraintTerm] with Serializable
- object ConstraintTermSerializer extends CIMSerializer[ConstraintTerm]
- object ConsumptionTariffInterval extends CIMParseable[ConsumptionTariffInterval] with Serializable
- object ConsumptionTariffIntervalSerializer extends CIMSerializer[ConsumptionTariffInterval]
- object Contingency extends CIMParseable[Contingency] with Serializable
- object ContingencyConstraintLimit extends CIMParseable[ContingencyConstraintLimit] with Serializable
- object ContingencyConstraintLimitSerializer extends CIMSerializer[ContingencyConstraintLimit]
- object ContingencyElement extends CIMParseable[ContingencyElement] with Serializable
- object ContingencyElementSerializer extends CIMSerializer[ContingencyElement]
- object ContingencyEquipment extends CIMParseable[ContingencyEquipment] with Serializable
- object ContingencyEquipmentSerializer extends CIMSerializer[ContingencyEquipment]
- object ContingencySerializer extends CIMSerializer[Contingency]
- object ContractDistributionFactor extends CIMParseable[ContractDistributionFactor] with Serializable
- object ContractDistributionFactorSerializer extends CIMSerializer[ContractDistributionFactor]
- object ContractRight extends CIMParseable[ContractRight] with Serializable
- object ContractRightSerializer extends CIMSerializer[ContractRight]
- object ContractorItem extends CIMParseable[ContractorItem] with Serializable
- object ContractorItemSerializer extends CIMSerializer[ContractorItem]
- object Control extends CIMParseable[Control] with Serializable
- object ControlAction extends CIMParseable[ControlAction] with Serializable
- object ControlActionSerializer extends CIMSerializer[ControlAction]
- object ControlArea extends CIMParseable[ControlArea] with Serializable
- object ControlAreaDesignation extends CIMParseable[ControlAreaDesignation] with Serializable
- object ControlAreaDesignationSerializer extends CIMSerializer[ControlAreaDesignation]
- object ControlAreaGeneratingUnit extends CIMParseable[ControlAreaGeneratingUnit] with Serializable
- object ControlAreaGeneratingUnitSerializer extends CIMSerializer[ControlAreaGeneratingUnit]
- object ControlAreaOperator extends CIMParseable[ControlAreaOperator] with Serializable
- object ControlAreaOperatorSerializer extends CIMSerializer[ControlAreaOperator]
- object ControlAreaSerializer extends CIMSerializer[ControlArea]
- object ControlAreaSolutionData extends CIMParseable[ControlAreaSolutionData] with Serializable
- object ControlAreaSolutionDataSerializer extends CIMSerializer[ControlAreaSolutionData]
- object ControlSerializer extends CIMSerializer[Control]
- object ControlledAppliance extends CIMParseable[ControlledAppliance] with Serializable
- object ControlledApplianceSerializer extends CIMSerializer[ControlledAppliance]
- object CoolingPowerRating extends CIMParseable[CoolingPowerRating] with Serializable
- object CoolingPowerRatingSerializer extends CIMSerializer[CoolingPowerRating]
- object CoordinateSystem extends CIMParseable[CoordinateSystem] with Serializable
- object CoordinateSystemSerializer extends CIMSerializer[CoordinateSystem]
- object CostType extends CIMParseable[CostType] with Serializable
- object CostTypeSerializer extends CIMSerializer[CostType]
- object Craft extends CIMParseable[Craft] with Serializable
- object CraftSerializer extends CIMSerializer[Craft]
- object Crew extends CIMParseable[Crew] with Serializable
- object CrewMember extends CIMParseable[CrewMember] with Serializable
- object CrewMemberSerializer extends CIMSerializer[CrewMember]
- object CrewSerializer extends CIMSerializer[Crew]
- object CrewType extends CIMParseable[CrewType] with Serializable
- object CrewTypeSerializer extends CIMSerializer[CrewType]
- object CrossCompoundTurbineGovernorDynamics extends CIMParseable[CrossCompoundTurbineGovernorDynamics] with Serializable
- object CrossCompoundTurbineGovernorDynamicsSerializer extends CIMSerializer[CrossCompoundTurbineGovernorDynamics]
- object CsConverter extends CIMParseable[CsConverter] with Serializable
- object CsConverterSerializer extends CIMSerializer[CsConverter]
- object CurrentEmergencyScheduledInterchange extends CIMParseable[CurrentEmergencyScheduledInterchange] with Serializable
- object CurrentEmergencyScheduledInterchangeSerializer extends CIMSerializer[CurrentEmergencyScheduledInterchange]
- object CurrentLimit extends CIMParseable[CurrentLimit] with Serializable
- object CurrentLimitSerializer extends CIMSerializer[CurrentLimit]
- object CurrentRelay extends CIMParseable[CurrentRelay] with Serializable
- object CurrentRelaySerializer extends CIMSerializer[CurrentRelay]
- object CurrentScheduledInterchange extends CIMParseable[CurrentScheduledInterchange] with Serializable
- object CurrentScheduledInterchangeSerializer extends CIMSerializer[CurrentScheduledInterchange]
- object CurrentState extends CIMParseable[CurrentState] with Serializable
- object CurrentStateSerializer extends CIMSerializer[CurrentState]
- object CurrentTransformer extends CIMParseable[CurrentTransformer] with Serializable
- object CurrentTransformerInfo extends CIMParseable[CurrentTransformerInfo] with Serializable
- object CurrentTransformerInfoSerializer extends CIMSerializer[CurrentTransformerInfo]
- object CurrentTransformerSerializer extends CIMSerializer[CurrentTransformer]
- object CurtailmentProfile extends CIMParseable[CurtailmentProfile] with Serializable
- object CurtailmentProfileSerializer extends CIMSerializer[CurtailmentProfile]
- object Curve extends CIMParseable[Curve] with Serializable
- object CurveData extends CIMParseable[CurveData] with Serializable
- object CurveDataSerializer extends CIMSerializer[CurveData]
- object CurveSerializer extends CIMSerializer[Curve]
- object Customer extends CIMParseable[Customer] with Serializable
- object CustomerAccount extends CIMParseable[CustomerAccount] with Serializable
- object CustomerAccountSerializer extends CIMSerializer[CustomerAccount]
- object CustomerAgreement extends CIMParseable[CustomerAgreement] with Serializable
- object CustomerAgreementSerializer extends CIMSerializer[CustomerAgreement]
- object CustomerBillingInfo extends CIMParseable[CustomerBillingInfo] with Serializable
- object CustomerBillingInfoSerializer extends CIMSerializer[CustomerBillingInfo]
- object CustomerConsumer extends CIMParseable[CustomerConsumer] with Serializable
- object CustomerConsumerSerializer extends CIMSerializer[CustomerConsumer]
- object CustomerNotification extends CIMParseable[CustomerNotification] with Serializable
- object CustomerNotificationSerializer extends CIMSerializer[CustomerNotification]
- object CustomerSerializer extends CIMSerializer[Customer]
- object Cut extends CIMParseable[Cut] with Serializable
- object CutAction extends CIMParseable[CutAction] with Serializable
- object CutActionSerializer extends CIMSerializer[CutAction]
- object CutSerializer extends CIMSerializer[Cut]
- object Cyclone extends CIMParseable[Cyclone] with Serializable
- object CycloneSerializer extends CIMSerializer[Cyclone]
- object DCBaseTerminal extends CIMParseable[DCBaseTerminal] with Serializable
- object DCBaseTerminalSerializer extends CIMSerializer[DCBaseTerminal]
- object DCBreaker extends CIMParseable[DCBreaker] with Serializable
- object DCBreakerSerializer extends CIMSerializer[DCBreaker]
- object DCBusbar extends CIMParseable[DCBusbar] with Serializable
- object DCBusbarSerializer extends CIMSerializer[DCBusbar]
- object DCChopper extends CIMParseable[DCChopper] with Serializable
- object DCChopperSerializer extends CIMSerializer[DCChopper]
- object DCConductingEquipment extends CIMParseable[DCConductingEquipment] with Serializable
- object DCConductingEquipmentSerializer extends CIMSerializer[DCConductingEquipment]
- object DCConverterUnit extends CIMParseable[DCConverterUnit] with Serializable
- object DCConverterUnitSerializer extends CIMSerializer[DCConverterUnit]
- object DCDisconnector extends CIMParseable[DCDisconnector] with Serializable
- object DCDisconnectorSerializer extends CIMSerializer[DCDisconnector]
- object DCEquipmentContainer extends CIMParseable[DCEquipmentContainer] with Serializable
- object DCEquipmentContainerSerializer extends CIMSerializer[DCEquipmentContainer]
- object DCGround extends CIMParseable[DCGround] with Serializable
- object DCGroundSerializer extends CIMSerializer[DCGround]
- object DCLine extends CIMParseable[DCLine] with Serializable
- object DCLineSegment extends CIMParseable[DCLineSegment] with Serializable
- object DCLineSegmentSerializer extends CIMSerializer[DCLineSegment]
- object DCLineSerializer extends CIMSerializer[DCLine]
- object DCNode extends CIMParseable[DCNode] with Serializable
- object DCNodeSerializer extends CIMSerializer[DCNode]
- object DCSeriesDevice extends CIMParseable[DCSeriesDevice] with Serializable
- object DCSeriesDeviceSerializer extends CIMSerializer[DCSeriesDevice]
- object DCShunt extends CIMParseable[DCShunt] with Serializable
- object DCShuntSerializer extends CIMSerializer[DCShunt]
- object DCSwitch extends CIMParseable[DCSwitch] with Serializable
- object DCSwitchSerializer extends CIMSerializer[DCSwitch]
- object DCTerminal extends CIMParseable[DCTerminal] with Serializable
- object DCTerminalSerializer extends CIMSerializer[DCTerminal]
- object DCTopologicalIsland extends CIMParseable[DCTopologicalIsland] with Serializable
- object DCTopologicalIslandSerializer extends CIMSerializer[DCTopologicalIsland]
- object DCTopologicalNode extends CIMParseable[DCTopologicalNode] with Serializable
- object DCTopologicalNodeSerializer extends CIMSerializer[DCTopologicalNode]
- object DCvoltageControl extends CIMParseable[DCvoltageControl] with Serializable
- object DCvoltageControlSerializer extends CIMSerializer[DCvoltageControl]
- object DERCurveData extends CIMParseable[DERCurveData] with Serializable
- object DERCurveDataSerializer extends CIMSerializer[DERCurveData]
- object DERFunction extends CIMParseable[DERFunction] with Serializable
- object DERFunctionSerializer extends CIMSerializer[DERFunction]
- object DERGroupDispatch extends CIMParseable[DERGroupDispatch] with Serializable
- object DERGroupDispatchSerializer extends CIMSerializer[DERGroupDispatch]
- object DERGroupForecast extends CIMParseable[DERGroupForecast] with Serializable
- object DERGroupForecastSerializer extends CIMSerializer[DERGroupForecast]
- object DERMonitorableParameter extends CIMParseable[DERMonitorableParameter] with Serializable
- object DERMonitorableParameterSerializer extends CIMSerializer[DERMonitorableParameter]
- object DINStandard extends CIMParseable[DINStandard] with Serializable
- object DINStandardSerializer extends CIMSerializer[DINStandard]
- object DataSet extends CIMParseable[DataSet] with Serializable
- object DataSetSerializer extends CIMSerializer[DataSet]
- object DatasetArg extends CIMParseable[DatasetArg] with Serializable
- object DatasetArgDescription extends CIMParseable[DatasetArgDescription] with Serializable
- object DatasetArgDescriptionSerializer extends CIMSerializer[DatasetArgDescription]
- object DatasetArgSerializer extends CIMSerializer[DatasetArg]
- object DateAndOrTime extends CIMParseable[DateAndOrTime] with Serializable
- object DateAndOrTimeSerializer extends CIMSerializer[DateAndOrTime]
- object DateInterval extends CIMParseable[DateInterval] with Serializable
- object DateIntervalSerializer extends CIMSerializer[DateInterval]
- object DateTimeInterval extends CIMParseable[DateTimeInterval] with Serializable
- object DateTimeIntervalSerializer extends CIMSerializer[DateTimeInterval]
- object DayType extends CIMParseable[DayType] with Serializable
- object DayTypeSerializer extends CIMSerializer[DayType]
- object DecimalQuantity extends CIMParseable[DecimalQuantity] with Serializable
- object DecimalQuantitySerializer extends CIMSerializer[DecimalQuantity]
- object DefaultBid extends CIMParseable[DefaultBid] with Serializable
- object DefaultBidCurve extends CIMParseable[DefaultBidCurve] with Serializable
- object DefaultBidCurveData extends CIMParseable[DefaultBidCurveData] with Serializable
- object DefaultBidCurveDataSerializer extends CIMSerializer[DefaultBidCurveData]
- object DefaultBidCurveSerializer extends CIMSerializer[DefaultBidCurve]
- object DefaultBidSerializer extends CIMSerializer[DefaultBid]
- object DefaultConstraintLimit extends CIMParseable[DefaultConstraintLimit] with Serializable
- object DefaultConstraintLimitSerializer extends CIMSerializer[DefaultConstraintLimit]
- object Delay extends CIMParseable[Delay] with Serializable
- object DelaySerializer extends CIMSerializer[Delay]
- object DemandResponseProgram extends CIMParseable[DemandResponseProgram] with Serializable
- object DemandResponseProgramSerializer extends CIMSerializer[DemandResponseProgram]
- object DeploymentDate extends CIMParseable[DeploymentDate] with Serializable
- object DeploymentDateSerializer extends CIMSerializer[DeploymentDate]
- object Design extends CIMParseable[Design] with Serializable
- object DesignLocation extends CIMParseable[DesignLocation] with Serializable
- object DesignLocationCU extends CIMParseable[DesignLocationCU] with Serializable
- object DesignLocationCUSerializer extends CIMSerializer[DesignLocationCU]
- object DesignLocationSerializer extends CIMSerializer[DesignLocation]
- object DesignSerializer extends CIMSerializer[Design]
- object DiagnosisDataSet extends CIMParseable[DiagnosisDataSet] with Serializable
- object DiagnosisDataSetSerializer extends CIMSerializer[DiagnosisDataSet]
- object Diagram extends CIMParseable[Diagram] with Serializable
- object DiagramObject extends CIMParseable[DiagramObject] with Serializable
- object DiagramObjectGluePoint extends CIMParseable[DiagramObjectGluePoint] with Serializable
- object DiagramObjectGluePointSerializer extends CIMSerializer[DiagramObjectGluePoint]
- object DiagramObjectPoint extends CIMParseable[DiagramObjectPoint] with Serializable
- object DiagramObjectPointSerializer extends CIMSerializer[DiagramObjectPoint]
- object DiagramObjectSerializer extends CIMSerializer[DiagramObject]
- object DiagramObjectStyle extends CIMParseable[DiagramObjectStyle] with Serializable
- object DiagramObjectStyleSerializer extends CIMSerializer[DiagramObjectStyle]
- object DiagramSerializer extends CIMSerializer[Diagram]
- object DiagramStyle extends CIMParseable[DiagramStyle] with Serializable
- object DiagramStyleSerializer extends CIMSerializer[DiagramStyle]
- object DifferentialModel extends CIMParseable[DifferentialModel] with Serializable
- object DifferentialModelSerializer extends CIMSerializer[DifferentialModel]
- object DimensionsInfo extends CIMParseable[DimensionsInfo] with Serializable
- object DimensionsInfoSerializer extends CIMSerializer[DimensionsInfo]
- object DiscExcContIEEEDEC1A extends CIMParseable[DiscExcContIEEEDEC1A] with Serializable
- object DiscExcContIEEEDEC1ASerializer extends CIMSerializer[DiscExcContIEEEDEC1A]
- object DiscExcContIEEEDEC2A extends CIMParseable[DiscExcContIEEEDEC2A] with Serializable
- object DiscExcContIEEEDEC2ASerializer extends CIMSerializer[DiscExcContIEEEDEC2A]
- object DiscExcContIEEEDEC3A extends CIMParseable[DiscExcContIEEEDEC3A] with Serializable
- object DiscExcContIEEEDEC3ASerializer extends CIMSerializer[DiscExcContIEEEDEC3A]
- object DisconnectingCircuitBreaker extends CIMParseable[DisconnectingCircuitBreaker] with Serializable
- object DisconnectingCircuitBreakerSerializer extends CIMSerializer[DisconnectingCircuitBreaker]
- object Disconnector extends CIMParseable[Disconnector] with Serializable
- object DisconnectorSerializer extends CIMSerializer[Disconnector]
- object DiscontinuousExcitationControlDynamics extends CIMParseable[DiscontinuousExcitationControlDynamics] with Serializable
- object DiscontinuousExcitationControlDynamicsSerializer extends CIMSerializer[DiscontinuousExcitationControlDynamics]
- object DiscontinuousExcitationControlUserDefined extends CIMParseable[DiscontinuousExcitationControlUserDefined] with Serializable
- object DiscontinuousExcitationControlUserDefinedSerializer extends CIMSerializer[DiscontinuousExcitationControlUserDefined]
- object Discrete extends CIMParseable[Discrete] with Serializable
- object DiscreteMeasurementValueQuality extends CIMParseable[DiscreteMeasurementValueQuality] with Serializable
- object DiscreteMeasurementValueQualitySerializer extends CIMSerializer[DiscreteMeasurementValueQuality]
- object DiscreteSerializer extends CIMSerializer[Discrete]
- object DiscreteValue extends CIMParseable[DiscreteValue] with Serializable
- object DiscreteValueSerializer extends CIMSerializer[DiscreteValue]
- object DispatchInstReply extends CIMParseable[DispatchInstReply] with Serializable
- object DispatchInstReplySerializer extends CIMSerializer[DispatchInstReply]
- object DispatchSchedule extends CIMParseable[DispatchSchedule] with Serializable
- object DispatchScheduleSerializer extends CIMSerializer[DispatchSchedule]
- object DispatchablePowerCapability extends CIMParseable[DispatchablePowerCapability] with Serializable
- object DispatchablePowerCapabilitySerializer extends CIMSerializer[DispatchablePowerCapability]
- object DistributedResourceActualEvent extends CIMParseable[DistributedResourceActualEvent] with Serializable
- object DistributedResourceActualEventSerializer extends CIMSerializer[DistributedResourceActualEvent]
- object DistributionFactorSet extends CIMParseable[DistributionFactorSet] with Serializable
- object DistributionFactorSetSerializer extends CIMSerializer[DistributionFactorSet]
- object DobleStandard extends CIMParseable[DobleStandard] with Serializable
- object DobleStandardSerializer extends CIMSerializer[DobleStandard]
- object Document extends CIMParseable[Document] with Serializable
- object DocumentOrganisationRole extends CIMParseable[DocumentOrganisationRole] with Serializable
- object DocumentOrganisationRoleSerializer extends CIMSerializer[DocumentOrganisationRole]
- object DocumentPersonRole extends CIMParseable[DocumentPersonRole] with Serializable
- object DocumentPersonRoleSerializer extends CIMSerializer[DocumentPersonRole]
- object DocumentSerializer extends CIMSerializer[Document]
- object Domain extends CIMParseable[Domain] with Serializable
- object DomainSerializer extends CIMSerializer[Domain]
- object DopInstruction extends CIMParseable[DopInstruction] with Serializable
- object DopInstructionSerializer extends CIMSerializer[DopInstruction]
- object DotInstruction extends CIMParseable[DotInstruction] with Serializable
- object DotInstructionSerializer extends CIMSerializer[DotInstruction]
- object DrumBoiler extends CIMParseable[DrumBoiler] with Serializable
- object DrumBoilerSerializer extends CIMSerializer[DrumBoiler]
- object DuctBank extends CIMParseable[DuctBank] with Serializable
- object DuctBankSerializer extends CIMSerializer[DuctBank]
- object Due extends CIMParseable[Due] with Serializable
- object DueSerializer extends CIMSerializer[Due]
- object DynamicSchedule extends CIMParseable[DynamicSchedule] with Serializable
- object DynamicScheduleSerializer extends CIMSerializer[DynamicSchedule]
- object DynamicsFunctionBlock extends CIMParseable[DynamicsFunctionBlock] with Serializable
- object DynamicsFunctionBlockSerializer extends CIMSerializer[DynamicsFunctionBlock]
- object EPAStandard extends CIMParseable[EPAStandard] with Serializable
- object EPAStandardSerializer extends CIMSerializer[EPAStandard]
- object EarthFaultCompensator extends CIMParseable[EarthFaultCompensator] with Serializable
- object EarthFaultCompensatorSerializer extends CIMSerializer[EarthFaultCompensator]
- object Earthquake extends CIMParseable[Earthquake] with Serializable
- object EarthquakeSerializer extends CIMSerializer[Earthquake]
- object Editor extends CIMParseable[Editor] with Serializable
- object EditorSerializer extends CIMSerializer[Editor]
- object ElectronicAddress extends CIMParseable[ElectronicAddress] with Serializable
- object ElectronicAddressSerializer extends CIMSerializer[ElectronicAddress]
- object EmissionAccount extends CIMParseable[EmissionAccount] with Serializable
- object EmissionAccountSerializer extends CIMSerializer[EmissionAccount]
- object EmissionCurve extends CIMParseable[EmissionCurve] with Serializable
- object EmissionCurveSerializer extends CIMSerializer[EmissionCurve]
- object EndDevice extends CIMParseable[EndDevice] with Serializable
- object EndDeviceAction extends CIMParseable[EndDeviceAction] with Serializable
- object EndDeviceActionSerializer extends CIMSerializer[EndDeviceAction]
- object EndDeviceCapability extends CIMParseable[EndDeviceCapability] with Serializable
- object EndDeviceCapabilitySerializer extends CIMSerializer[EndDeviceCapability]
- object EndDeviceControl extends CIMParseable[EndDeviceControl] with Serializable
- object EndDeviceControlSerializer extends CIMSerializer[EndDeviceControl]
- object EndDeviceControlType extends CIMParseable[EndDeviceControlType] with Serializable
- object EndDeviceControlTypeSerializer extends CIMSerializer[EndDeviceControlType]
- object EndDeviceEvent extends CIMParseable[EndDeviceEvent] with Serializable
- object EndDeviceEventDetail extends CIMParseable[EndDeviceEventDetail] with Serializable
- object EndDeviceEventDetailSerializer extends CIMSerializer[EndDeviceEventDetail]
- object EndDeviceEventSerializer extends CIMSerializer[EndDeviceEvent]
- object EndDeviceEventType extends CIMParseable[EndDeviceEventType] with Serializable
- object EndDeviceEventTypeSerializer extends CIMSerializer[EndDeviceEventType]
- object EndDeviceFunction extends CIMParseable[EndDeviceFunction] with Serializable
- object EndDeviceFunctionSerializer extends CIMSerializer[EndDeviceFunction]
- object EndDeviceGroup extends CIMParseable[EndDeviceGroup] with Serializable
- object EndDeviceGroupSerializer extends CIMSerializer[EndDeviceGroup]
- object EndDeviceInfo extends CIMParseable[EndDeviceInfo] with Serializable
- object EndDeviceInfoSerializer extends CIMSerializer[EndDeviceInfo]
- object EndDeviceSerializer extends CIMSerializer[EndDevice]
- object EndDeviceTiming extends CIMParseable[EndDeviceTiming] with Serializable
- object EndDeviceTimingSerializer extends CIMSerializer[EndDeviceTiming]
- object EnergyArea extends CIMParseable[EnergyArea] with Serializable
- object EnergyAreaSerializer extends CIMSerializer[EnergyArea]
- object EnergyComponent extends CIMParseable[EnergyComponent] with Serializable
- object EnergyComponentSerializer extends CIMSerializer[EnergyComponent]
- object EnergyConnection extends CIMParseable[EnergyConnection] with Serializable
- object EnergyConnectionSerializer extends CIMSerializer[EnergyConnection]
- object EnergyConsumer extends CIMParseable[EnergyConsumer] with Serializable
- object EnergyConsumerAction extends CIMParseable[EnergyConsumerAction] with Serializable
- object EnergyConsumerActionSerializer extends CIMSerializer[EnergyConsumerAction]
- object EnergyConsumerPhase extends CIMParseable[EnergyConsumerPhase] with Serializable
- object EnergyConsumerPhaseSerializer extends CIMSerializer[EnergyConsumerPhase]
- object EnergyConsumerSerializer extends CIMSerializer[EnergyConsumer]
- object EnergyGroup extends CIMParseable[EnergyGroup] with Serializable
- object EnergyGroupSerializer extends CIMSerializer[EnergyGroup]
- object EnergyMarket extends CIMParseable[EnergyMarket] with Serializable
- object EnergyMarketSerializer extends CIMSerializer[EnergyMarket]
- object EnergyPriceCurve extends CIMParseable[EnergyPriceCurve] with Serializable
- object EnergyPriceCurveSerializer extends CIMSerializer[EnergyPriceCurve]
- object EnergyPriceIndex extends CIMParseable[EnergyPriceIndex] with Serializable
- object EnergyPriceIndexSerializer extends CIMSerializer[EnergyPriceIndex]
- object EnergyProduct extends CIMParseable[EnergyProduct] with Serializable
- object EnergyProductSerializer extends CIMSerializer[EnergyProduct]
- object EnergyProfile extends CIMParseable[EnergyProfile] with Serializable
- object EnergyProfileSerializer extends CIMSerializer[EnergyProfile]
- object EnergySchedulingType extends CIMParseable[EnergySchedulingType] with Serializable
- object EnergySchedulingTypeSerializer extends CIMSerializer[EnergySchedulingType]
- object EnergySource extends CIMParseable[EnergySource] with Serializable
- object EnergySourceAction extends CIMParseable[EnergySourceAction] with Serializable
- object EnergySourceActionSerializer extends CIMSerializer[EnergySourceAction]
- object EnergySourcePhase extends CIMParseable[EnergySourcePhase] with Serializable
- object EnergySourcePhaseSerializer extends CIMSerializer[EnergySourcePhase]
- object EnergySourceSerializer extends CIMSerializer[EnergySource]
- object EnergyTransaction extends CIMParseable[EnergyTransaction] with Serializable
- object EnergyTransactionSerializer extends CIMSerializer[EnergyTransaction]
- object EnergyTypeReference extends CIMParseable[EnergyTypeReference] with Serializable
- object EnergyTypeReferenceSerializer extends CIMSerializer[EnergyTypeReference]
- object EnvironmentalAlert extends CIMParseable[EnvironmentalAlert] with Serializable
- object EnvironmentalAlertSerializer extends CIMSerializer[EnvironmentalAlert]
- object EnvironmentalAnalog extends CIMParseable[EnvironmentalAnalog] with Serializable
- object EnvironmentalAnalogSerializer extends CIMSerializer[EnvironmentalAnalog]
- object EnvironmentalCodedValue extends CIMParseable[EnvironmentalCodedValue] with Serializable
- object EnvironmentalCodedValueSerializer extends CIMSerializer[EnvironmentalCodedValue]
- object EnvironmentalDataAuthority extends CIMParseable[EnvironmentalDataAuthority] with Serializable
- object EnvironmentalDataAuthoritySerializer extends CIMSerializer[EnvironmentalDataAuthority]
- object EnvironmentalDataProvider extends CIMParseable[EnvironmentalDataProvider] with Serializable
- object EnvironmentalDataProviderSerializer extends CIMSerializer[EnvironmentalDataProvider]
- object EnvironmentalDependentLimit extends CIMParseable[EnvironmentalDependentLimit] with Serializable
- object EnvironmentalDependentLimitSerializer extends CIMSerializer[EnvironmentalDependentLimit]
- object EnvironmentalDiscrete extends CIMParseable[EnvironmentalDiscrete] with Serializable
- object EnvironmentalDiscreteSerializer extends CIMSerializer[EnvironmentalDiscrete]
- object EnvironmentalEvent extends CIMParseable[EnvironmentalEvent] with Serializable
- object EnvironmentalEventSerializer extends CIMSerializer[EnvironmentalEvent]
- object EnvironmentalInformation extends CIMParseable[EnvironmentalInformation] with Serializable
- object EnvironmentalInformationSerializer extends CIMSerializer[EnvironmentalInformation]
- object EnvironmentalLocationType extends CIMParseable[EnvironmentalLocationType] with Serializable
- object EnvironmentalLocationTypeSerializer extends CIMSerializer[EnvironmentalLocationType]
- object EnvironmentalMonitoringStation extends CIMParseable[EnvironmentalMonitoringStation] with Serializable
- object EnvironmentalMonitoringStationSerializer extends CIMSerializer[EnvironmentalMonitoringStation]
- object EnvironmentalPhenomenon extends CIMParseable[EnvironmentalPhenomenon] with Serializable
- object EnvironmentalPhenomenonSerializer extends CIMSerializer[EnvironmentalPhenomenon]
- object EnvironmentalStringMeasurement extends CIMParseable[EnvironmentalStringMeasurement] with Serializable
- object EnvironmentalStringMeasurementSerializer extends CIMSerializer[EnvironmentalStringMeasurement]
- object Equipment extends CIMParseable[Equipment] with Serializable
- object EquipmentContainer extends CIMParseable[EquipmentContainer] with Serializable
- object EquipmentContainerSerializer extends CIMSerializer[EquipmentContainer]
- object EquipmentFault extends CIMParseable[EquipmentFault] with Serializable
- object EquipmentFaultSerializer extends CIMSerializer[EquipmentFault]
- object EquipmentLimitSeriesComponent extends CIMParseable[EquipmentLimitSeriesComponent] with Serializable
- object EquipmentLimitSeriesComponentSerializer extends CIMSerializer[EquipmentLimitSeriesComponent]
- object EquipmentSerializer extends CIMSerializer[Equipment]
- object EquipmentUnavailabilitySchedule extends CIMParseable[EquipmentUnavailabilitySchedule] with Serializable
- object EquipmentUnavailabilityScheduleSerializer extends CIMSerializer[EquipmentUnavailabilitySchedule]
- object EquivalentBranch extends CIMParseable[EquivalentBranch] with Serializable
- object EquivalentBranchSerializer extends CIMSerializer[EquivalentBranch]
- object EquivalentEquipment extends CIMParseable[EquivalentEquipment] with Serializable
- object EquivalentEquipmentSerializer extends CIMSerializer[EquivalentEquipment]
- object EquivalentInjection extends CIMParseable[EquivalentInjection] with Serializable
- object EquivalentInjectionSerializer extends CIMSerializer[EquivalentInjection]
- object EquivalentNetwork extends CIMParseable[EquivalentNetwork] with Serializable
- object EquivalentNetworkSerializer extends CIMSerializer[EquivalentNetwork]
- object EquivalentShunt extends CIMParseable[EquivalentShunt] with Serializable
- object EquivalentShuntSerializer extends CIMSerializer[EquivalentShunt]
- object ErpBOM extends CIMParseable[ErpBOM] with Serializable
- object ErpBOMSerializer extends CIMSerializer[ErpBOM]
- object ErpBankAccount extends CIMParseable[ErpBankAccount] with Serializable
- object ErpBankAccountSerializer extends CIMSerializer[ErpBankAccount]
- object ErpBomItemData extends CIMParseable[ErpBomItemData] with Serializable
- object ErpBomItemDataSerializer extends CIMSerializer[ErpBomItemData]
- object ErpChartOfAccounts extends CIMParseable[ErpChartOfAccounts] with Serializable
- object ErpChartOfAccountsSerializer extends CIMSerializer[ErpChartOfAccounts]
- object ErpCompetency extends CIMParseable[ErpCompetency] with Serializable
- object ErpCompetencySerializer extends CIMSerializer[ErpCompetency]
- object ErpDocument extends CIMParseable[ErpDocument] with Serializable
- object ErpDocumentSerializer extends CIMSerializer[ErpDocument]
- object ErpEngChangeOrder extends CIMParseable[ErpEngChangeOrder] with Serializable
- object ErpEngChangeOrderSerializer extends CIMSerializer[ErpEngChangeOrder]
- object ErpIdentifiedObject extends CIMParseable[ErpIdentifiedObject] with Serializable
- object ErpIdentifiedObjectSerializer extends CIMSerializer[ErpIdentifiedObject]
- object ErpInventory extends CIMParseable[ErpInventory] with Serializable
- object ErpInventoryCount extends CIMParseable[ErpInventoryCount] with Serializable
- object ErpInventoryCountSerializer extends CIMSerializer[ErpInventoryCount]
- object ErpInventorySerializer extends CIMSerializer[ErpInventory]
- object ErpInvoice extends CIMParseable[ErpInvoice] with Serializable
- object ErpInvoiceLineItem extends CIMParseable[ErpInvoiceLineItem] with Serializable
- object ErpInvoiceLineItemSerializer extends CIMSerializer[ErpInvoiceLineItem]
- object ErpInvoiceSerializer extends CIMSerializer[ErpInvoice]
- object ErpIssueInventory extends CIMParseable[ErpIssueInventory] with Serializable
- object ErpIssueInventorySerializer extends CIMSerializer[ErpIssueInventory]
- object ErpItemMaster extends CIMParseable[ErpItemMaster] with Serializable
- object ErpItemMasterSerializer extends CIMSerializer[ErpItemMaster]
- object ErpJournal extends CIMParseable[ErpJournal] with Serializable
- object ErpJournalEntry extends CIMParseable[ErpJournalEntry] with Serializable
- object ErpJournalEntrySerializer extends CIMSerializer[ErpJournalEntry]
- object ErpJournalSerializer extends CIMSerializer[ErpJournal]
- object ErpLedBudLineItem extends CIMParseable[ErpLedBudLineItem] with Serializable
- object ErpLedBudLineItemSerializer extends CIMSerializer[ErpLedBudLineItem]
- object ErpLedger extends CIMParseable[ErpLedger] with Serializable
- object ErpLedgerBudget extends CIMParseable[ErpLedgerBudget] with Serializable
- object ErpLedgerBudgetSerializer extends CIMSerializer[ErpLedgerBudget]
- object ErpLedgerEntry extends CIMParseable[ErpLedgerEntry] with Serializable
- object ErpLedgerEntrySerializer extends CIMSerializer[ErpLedgerEntry]
- object ErpLedgerSerializer extends CIMSerializer[ErpLedger]
- object ErpPOLineItem extends CIMParseable[ErpPOLineItem] with Serializable
- object ErpPOLineItemSerializer extends CIMSerializer[ErpPOLineItem]
- object ErpPayable extends CIMParseable[ErpPayable] with Serializable
- object ErpPayableLineItem extends CIMParseable[ErpPayableLineItem] with Serializable
- object ErpPayableLineItemSerializer extends CIMSerializer[ErpPayableLineItem]
- object ErpPayableSerializer extends CIMSerializer[ErpPayable]
- object ErpPayment extends CIMParseable[ErpPayment] with Serializable
- object ErpPaymentSerializer extends CIMSerializer[ErpPayment]
- object ErpPersonnel extends CIMParseable[ErpPersonnel] with Serializable
- object ErpPersonnelSerializer extends CIMSerializer[ErpPersonnel]
- object ErpProjectAccounting extends CIMParseable[ErpProjectAccounting] with Serializable
- object ErpProjectAccountingSerializer extends CIMSerializer[ErpProjectAccounting]
- object ErpPurchaseOrder extends CIMParseable[ErpPurchaseOrder] with Serializable
- object ErpPurchaseOrderSerializer extends CIMSerializer[ErpPurchaseOrder]
- object ErpQuote extends CIMParseable[ErpQuote] with Serializable
- object ErpQuoteLineItem extends CIMParseable[ErpQuoteLineItem] with Serializable
- object ErpQuoteLineItemSerializer extends CIMSerializer[ErpQuoteLineItem]
- object ErpQuoteSerializer extends CIMSerializer[ErpQuote]
- object ErpRecDelvLineItem extends CIMParseable[ErpRecDelvLineItem] with Serializable
- object ErpRecDelvLineItemSerializer extends CIMSerializer[ErpRecDelvLineItem]
- object ErpRecLineItem extends CIMParseable[ErpRecLineItem] with Serializable
- object ErpRecLineItemSerializer extends CIMSerializer[ErpRecLineItem]
- object ErpReceivable extends CIMParseable[ErpReceivable] with Serializable
- object ErpReceivableSerializer extends CIMSerializer[ErpReceivable]
- object ErpReceiveDelivery extends CIMParseable[ErpReceiveDelivery] with Serializable
- object ErpReceiveDeliverySerializer extends CIMSerializer[ErpReceiveDelivery]
- object ErpReqLineItem extends CIMParseable[ErpReqLineItem] with Serializable
- object ErpReqLineItemSerializer extends CIMSerializer[ErpReqLineItem]
- object ErpRequisition extends CIMParseable[ErpRequisition] with Serializable
- object ErpRequisitionSerializer extends CIMSerializer[ErpRequisition]
- object ErpSalesOrder extends CIMParseable[ErpSalesOrder] with Serializable
- object ErpSalesOrderSerializer extends CIMSerializer[ErpSalesOrder]
- object ErpSiteLevelData extends CIMParseable[ErpSiteLevelData] with Serializable
- object ErpSiteLevelDataSerializer extends CIMSerializer[ErpSiteLevelData]
- object ErpTimeEntry extends CIMParseable[ErpTimeEntry] with Serializable
- object ErpTimeEntrySerializer extends CIMSerializer[ErpTimeEntry]
- object ErpTimeSheet extends CIMParseable[ErpTimeSheet] with Serializable
- object ErpTimeSheetSerializer extends CIMSerializer[ErpTimeSheet]
- object EstimatedRestorationTime extends CIMParseable[EstimatedRestorationTime] with Serializable
- object EstimatedRestorationTimeSerializer extends CIMSerializer[EstimatedRestorationTime]
- object ExPostLoss extends CIMParseable[ExPostLoss] with Serializable
- object ExPostLossResults extends CIMParseable[ExPostLossResults] with Serializable
- object ExPostLossResultsSerializer extends CIMSerializer[ExPostLossResults]
- object ExPostLossSerializer extends CIMSerializer[ExPostLoss]
- object ExPostMarketRegion extends CIMParseable[ExPostMarketRegion] with Serializable
- object ExPostMarketRegionResults extends CIMParseable[ExPostMarketRegionResults] with Serializable
- object ExPostMarketRegionResultsSerializer extends CIMSerializer[ExPostMarketRegionResults]
- object ExPostMarketRegionSerializer extends CIMSerializer[ExPostMarketRegion]
- object ExPostPricing extends CIMParseable[ExPostPricing] with Serializable
- object ExPostPricingResults extends CIMParseable[ExPostPricingResults] with Serializable
- object ExPostPricingResultsSerializer extends CIMSerializer[ExPostPricingResults]
- object ExPostPricingSerializer extends CIMSerializer[ExPostPricing]
- object ExPostResource extends CIMParseable[ExPostResource] with Serializable
- object ExPostResourceResults extends CIMParseable[ExPostResourceResults] with Serializable
- object ExPostResourceResultsSerializer extends CIMSerializer[ExPostResourceResults]
- object ExPostResourceSerializer extends CIMSerializer[ExPostResource]
- object ExcAC1A extends CIMParseable[ExcAC1A] with Serializable
- object ExcAC1ASerializer extends CIMSerializer[ExcAC1A]
- object ExcAC2A extends CIMParseable[ExcAC2A] with Serializable
- object ExcAC2ASerializer extends CIMSerializer[ExcAC2A]
- object ExcAC3A extends CIMParseable[ExcAC3A] with Serializable
- object ExcAC3ASerializer extends CIMSerializer[ExcAC3A]
- object ExcAC4A extends CIMParseable[ExcAC4A] with Serializable
- object ExcAC4ASerializer extends CIMSerializer[ExcAC4A]
- object ExcAC5A extends CIMParseable[ExcAC5A] with Serializable
- object ExcAC5ASerializer extends CIMSerializer[ExcAC5A]
- object ExcAC6A extends CIMParseable[ExcAC6A] with Serializable
- object ExcAC6ASerializer extends CIMSerializer[ExcAC6A]
- object ExcAC8B extends CIMParseable[ExcAC8B] with Serializable
- object ExcAC8BSerializer extends CIMSerializer[ExcAC8B]
- object ExcANS extends CIMParseable[ExcANS] with Serializable
- object ExcANSSerializer extends CIMSerializer[ExcANS]
- object ExcAVR1 extends CIMParseable[ExcAVR1] with Serializable
- object ExcAVR1Serializer extends CIMSerializer[ExcAVR1]
- object ExcAVR2 extends CIMParseable[ExcAVR2] with Serializable
- object ExcAVR2Serializer extends CIMSerializer[ExcAVR2]
- object ExcAVR3 extends CIMParseable[ExcAVR3] with Serializable
- object ExcAVR3Serializer extends CIMSerializer[ExcAVR3]
- object ExcAVR4 extends CIMParseable[ExcAVR4] with Serializable
- object ExcAVR4Serializer extends CIMSerializer[ExcAVR4]
- object ExcAVR5 extends CIMParseable[ExcAVR5] with Serializable
- object ExcAVR5Serializer extends CIMSerializer[ExcAVR5]
- object ExcAVR7 extends CIMParseable[ExcAVR7] with Serializable
- object ExcAVR7Serializer extends CIMSerializer[ExcAVR7]
- object ExcBBC extends CIMParseable[ExcBBC] with Serializable
- object ExcBBCSerializer extends CIMSerializer[ExcBBC]
- object ExcCZ extends CIMParseable[ExcCZ] with Serializable
- object ExcCZSerializer extends CIMSerializer[ExcCZ]
- object ExcDC1A extends CIMParseable[ExcDC1A] with Serializable
- object ExcDC1ASerializer extends CIMSerializer[ExcDC1A]
- object ExcDC2A extends CIMParseable[ExcDC2A] with Serializable
- object ExcDC2ASerializer extends CIMSerializer[ExcDC2A]
- object ExcDC3A extends CIMParseable[ExcDC3A] with Serializable
- object ExcDC3A1 extends CIMParseable[ExcDC3A1] with Serializable
- object ExcDC3A1Serializer extends CIMSerializer[ExcDC3A1]
- object ExcDC3ASerializer extends CIMSerializer[ExcDC3A]
- object ExcELIN1 extends CIMParseable[ExcELIN1] with Serializable
- object ExcELIN1Serializer extends CIMSerializer[ExcELIN1]
- object ExcELIN2 extends CIMParseable[ExcELIN2] with Serializable
- object ExcELIN2Serializer extends CIMSerializer[ExcELIN2]
- object ExcHU extends CIMParseable[ExcHU] with Serializable
- object ExcHUSerializer extends CIMSerializer[ExcHU]
- object ExcIEEEAC1A extends CIMParseable[ExcIEEEAC1A] with Serializable
- object ExcIEEEAC1ASerializer extends CIMSerializer[ExcIEEEAC1A]
- object ExcIEEEAC2A extends CIMParseable[ExcIEEEAC2A] with Serializable
- object ExcIEEEAC2ASerializer extends CIMSerializer[ExcIEEEAC2A]
- object ExcIEEEAC3A extends CIMParseable[ExcIEEEAC3A] with Serializable
- object ExcIEEEAC3ASerializer extends CIMSerializer[ExcIEEEAC3A]
- object ExcIEEEAC4A extends CIMParseable[ExcIEEEAC4A] with Serializable
- object ExcIEEEAC4ASerializer extends CIMSerializer[ExcIEEEAC4A]
- object ExcIEEEAC5A extends CIMParseable[ExcIEEEAC5A] with Serializable
- object ExcIEEEAC5ASerializer extends CIMSerializer[ExcIEEEAC5A]
- object ExcIEEEAC6A extends CIMParseable[ExcIEEEAC6A] with Serializable
- object ExcIEEEAC6ASerializer extends CIMSerializer[ExcIEEEAC6A]
- object ExcIEEEAC7B extends CIMParseable[ExcIEEEAC7B] with Serializable
- object ExcIEEEAC7BSerializer extends CIMSerializer[ExcIEEEAC7B]
- object ExcIEEEAC8B extends CIMParseable[ExcIEEEAC8B] with Serializable
- object ExcIEEEAC8BSerializer extends CIMSerializer[ExcIEEEAC8B]
- object ExcIEEEDC1A extends CIMParseable[ExcIEEEDC1A] with Serializable
- object ExcIEEEDC1ASerializer extends CIMSerializer[ExcIEEEDC1A]
- object ExcIEEEDC2A extends CIMParseable[ExcIEEEDC2A] with Serializable
- object ExcIEEEDC2ASerializer extends CIMSerializer[ExcIEEEDC2A]
- object ExcIEEEDC3A extends CIMParseable[ExcIEEEDC3A] with Serializable
- object ExcIEEEDC3ASerializer extends CIMSerializer[ExcIEEEDC3A]
- object ExcIEEEDC4B extends CIMParseable[ExcIEEEDC4B] with Serializable
- object ExcIEEEDC4BSerializer extends CIMSerializer[ExcIEEEDC4B]
- object ExcIEEEST1A extends CIMParseable[ExcIEEEST1A] with Serializable
- object ExcIEEEST1ASerializer extends CIMSerializer[ExcIEEEST1A]
- object ExcIEEEST2A extends CIMParseable[ExcIEEEST2A] with Serializable
- object ExcIEEEST2ASerializer extends CIMSerializer[ExcIEEEST2A]
- object ExcIEEEST3A extends CIMParseable[ExcIEEEST3A] with Serializable
- object ExcIEEEST3ASerializer extends CIMSerializer[ExcIEEEST3A]
- object ExcIEEEST4B extends CIMParseable[ExcIEEEST4B] with Serializable
- object ExcIEEEST4BSerializer extends CIMSerializer[ExcIEEEST4B]
- object ExcIEEEST5B extends CIMParseable[ExcIEEEST5B] with Serializable
- object ExcIEEEST5BSerializer extends CIMSerializer[ExcIEEEST5B]
- object ExcIEEEST6B extends CIMParseable[ExcIEEEST6B] with Serializable
- object ExcIEEEST6BSerializer extends CIMSerializer[ExcIEEEST6B]
- object ExcIEEEST7B extends CIMParseable[ExcIEEEST7B] with Serializable
- object ExcIEEEST7BSerializer extends CIMSerializer[ExcIEEEST7B]
- object ExcNI extends CIMParseable[ExcNI] with Serializable
- object ExcNISerializer extends CIMSerializer[ExcNI]
- object ExcOEX3T extends CIMParseable[ExcOEX3T] with Serializable
- object ExcOEX3TSerializer extends CIMSerializer[ExcOEX3T]
- object ExcPIC extends CIMParseable[ExcPIC] with Serializable
- object ExcPICSerializer extends CIMSerializer[ExcPIC]
- object ExcREXS extends CIMParseable[ExcREXS] with Serializable
- object ExcREXSSerializer extends CIMSerializer[ExcREXS]
- object ExcRQB extends CIMParseable[ExcRQB] with Serializable
- object ExcRQBSerializer extends CIMSerializer[ExcRQB]
- object ExcSCRX extends CIMParseable[ExcSCRX] with Serializable
- object ExcSCRXSerializer extends CIMSerializer[ExcSCRX]
- object ExcSEXS extends CIMParseable[ExcSEXS] with Serializable
- object ExcSEXSSerializer extends CIMSerializer[ExcSEXS]
- object ExcSK extends CIMParseable[ExcSK] with Serializable
- object ExcSKSerializer extends CIMSerializer[ExcSK]
- object ExcST1A extends CIMParseable[ExcST1A] with Serializable
- object ExcST1ASerializer extends CIMSerializer[ExcST1A]
- object ExcST2A extends CIMParseable[ExcST2A] with Serializable
- object ExcST2ASerializer extends CIMSerializer[ExcST2A]
- object ExcST3A extends CIMParseable[ExcST3A] with Serializable
- object ExcST3ASerializer extends CIMSerializer[ExcST3A]
- object ExcST4B extends CIMParseable[ExcST4B] with Serializable
- object ExcST4BSerializer extends CIMSerializer[ExcST4B]
- object ExcST6B extends CIMParseable[ExcST6B] with Serializable
- object ExcST6BSerializer extends CIMSerializer[ExcST6B]
- object ExcST7B extends CIMParseable[ExcST7B] with Serializable
- object ExcST7BSerializer extends CIMSerializer[ExcST7B]
- object ExcitationSystemDynamics extends CIMParseable[ExcitationSystemDynamics] with Serializable
- object ExcitationSystemDynamicsSerializer extends CIMSerializer[ExcitationSystemDynamics]
- object ExcitationSystemUserDefined extends CIMParseable[ExcitationSystemUserDefined] with Serializable
- object ExcitationSystemUserDefinedSerializer extends CIMSerializer[ExcitationSystemUserDefined]
- object ExpectedEnergy extends CIMParseable[ExpectedEnergy] with Serializable
- object ExpectedEnergySerializer extends CIMSerializer[ExpectedEnergy]
- object ExpectedEnergyValues extends CIMParseable[ExpectedEnergyValues] with Serializable
- object ExpectedEnergyValuesSerializer extends CIMSerializer[ExpectedEnergyValues]
- object ExtensionItem extends CIMParseable[ExtensionItem] with Serializable
- object ExtensionItemSerializer extends CIMSerializer[ExtensionItem]
- object ExtensionsList extends CIMParseable[ExtensionsList] with Serializable
- object ExtensionsListSerializer extends CIMSerializer[ExtensionsList]
- object ExternalCustomerAgreement extends CIMParseable[ExternalCustomerAgreement] with Serializable
- object ExternalCustomerAgreementSerializer extends CIMSerializer[ExternalCustomerAgreement]
- object ExternalNetworkInjection extends CIMParseable[ExternalNetworkInjection] with Serializable
- object ExternalNetworkInjectionSerializer extends CIMSerializer[ExternalNetworkInjection]
- object FACTSDevice extends CIMParseable[FACTSDevice] with Serializable
- object FACTSDeviceSerializer extends CIMSerializer[FACTSDevice]
- object FTR extends CIMParseable[FTR] with Serializable
- object FTRSerializer extends CIMSerializer[FTR]
- object Facility extends CIMParseable[Facility] with Serializable
- object FacilitySerializer extends CIMSerializer[Facility]
- object FailureEvent extends CIMParseable[FailureEvent] with Serializable
- object FailureEventSerializer extends CIMSerializer[FailureEvent]
- object Fault extends CIMParseable[Fault] with Serializable
- object FaultCauseType extends CIMParseable[FaultCauseType] with Serializable
- object FaultCauseTypeSerializer extends CIMSerializer[FaultCauseType]
- object FaultImpedance extends CIMParseable[FaultImpedance] with Serializable
- object FaultImpedanceSerializer extends CIMSerializer[FaultImpedance]
- object FaultIndicator extends CIMParseable[FaultIndicator] with Serializable
- object FaultIndicatorInfo extends CIMParseable[FaultIndicatorInfo] with Serializable
- object FaultIndicatorInfoSerializer extends CIMSerializer[FaultIndicatorInfo]
- object FaultIndicatorSerializer extends CIMSerializer[FaultIndicator]
- object FaultSerializer extends CIMSerializer[Fault]
- object Feeder extends CIMParseable[Feeder] with Serializable
- object FeederSerializer extends CIMSerializer[Feeder]
- object FieldDispatchHistory extends CIMParseable[FieldDispatchHistory] with Serializable
- object FieldDispatchHistorySerializer extends CIMSerializer[FieldDispatchHistory]
- object FieldDispatchStep extends CIMParseable[FieldDispatchStep] with Serializable
- object FieldDispatchStepSerializer extends CIMSerializer[FieldDispatchStep]
- object FieldSafetySupervisor extends CIMParseable[FieldSafetySupervisor] with Serializable
- object FieldSafetySupervisorSerializer extends CIMSerializer[FieldSafetySupervisor]
- object FinancialInfo extends CIMParseable[FinancialInfo] with Serializable
- object FinancialInfoSerializer extends CIMSerializer[FinancialInfo]
- object Fire extends CIMParseable[Fire] with Serializable
- object FireSerializer extends CIMSerializer[Fire]
- object FiveMinAuxiliaryData extends CIMParseable[FiveMinAuxiliaryData] with Serializable
- object FiveMinAuxiliaryDataSerializer extends CIMSerializer[FiveMinAuxiliaryData]
- object FloatQuantity extends CIMParseable[FloatQuantity] with Serializable
- object FloatQuantitySerializer extends CIMSerializer[FloatQuantity]
- object Flood extends CIMParseable[Flood] with Serializable
- object FloodSerializer extends CIMSerializer[Flood]
- object FlowDirection extends CIMParseable[FlowDirection] with Serializable
- object FlowDirectionSerializer extends CIMSerializer[FlowDirection]
- object Flowgate extends CIMParseable[Flowgate] with Serializable
- object FlowgatePartner extends CIMParseable[FlowgatePartner] with Serializable
- object FlowgatePartnerSerializer extends CIMSerializer[FlowgatePartner]
- object FlowgateRelief extends CIMParseable[FlowgateRelief] with Serializable
- object FlowgateReliefSerializer extends CIMSerializer[FlowgateRelief]
- object FlowgateSerializer extends CIMSerializer[Flowgate]
- object FlowgateValue extends CIMParseable[FlowgateValue] with Serializable
- object FlowgateValueSerializer extends CIMSerializer[FlowgateValue]
- object ForbiddenRegion extends CIMParseable[ForbiddenRegion] with Serializable
- object ForbiddenRegionSerializer extends CIMSerializer[ForbiddenRegion]
- object Forecast extends CIMParseable[Forecast] with Serializable
- object ForecastSerializer extends CIMSerializer[Forecast]
- object FormerReference extends CIMParseable[FormerReference] with Serializable
- object FormerReferenceSerializer extends CIMSerializer[FormerReference]
- object FossilFuel extends CIMParseable[FossilFuel] with Serializable
- object FossilFuelSerializer extends CIMSerializer[FossilFuel]
- object FossilSteamSupply extends CIMParseable[FossilSteamSupply] with Serializable
- object FossilSteamSupplySerializer extends CIMSerializer[FossilSteamSupply]
- object FrameworkPart extends CIMParseable[FrameworkPart] with Serializable
- object FrameworkPartSerializer extends CIMSerializer[FrameworkPart]
- object FrequencyConverter extends CIMParseable[FrequencyConverter] with Serializable
- object FrequencyConverterSerializer extends CIMSerializer[FrequencyConverter]
- object FuelAllocationSchedule extends CIMParseable[FuelAllocationSchedule] with Serializable
- object FuelAllocationScheduleSerializer extends CIMSerializer[FuelAllocationSchedule]
- object FuelCostCurve extends CIMParseable[FuelCostCurve] with Serializable
- object FuelCostCurveSerializer extends CIMSerializer[FuelCostCurve]
- object FuelRegion extends CIMParseable[FuelRegion] with Serializable
- object FuelRegionSerializer extends CIMSerializer[FuelRegion]
- object Fuse extends CIMParseable[Fuse] with Serializable
- object FuseSerializer extends CIMSerializer[Fuse]
- object GasPrice extends CIMParseable[GasPrice] with Serializable
- object GasPriceSerializer extends CIMSerializer[GasPrice]
- object Gate extends CIMParseable[Gate] with Serializable
- object GateInputPin extends CIMParseable[GateInputPin] with Serializable
- object GateInputPinSerializer extends CIMSerializer[GateInputPin]
- object GateSerializer extends CIMSerializer[Gate]
- object GenDistributionFactor extends CIMParseable[GenDistributionFactor] with Serializable
- object GenDistributionFactorSerializer extends CIMSerializer[GenDistributionFactor]
- object GenICompensationForGenJ extends CIMParseable[GenICompensationForGenJ] with Serializable
- object GenICompensationForGenJSerializer extends CIMSerializer[GenICompensationForGenJ]
- object GenUnitOpCostCurve extends CIMParseable[GenUnitOpCostCurve] with Serializable
- object GenUnitOpCostCurveSerializer extends CIMSerializer[GenUnitOpCostCurve]
- object GenUnitOpSchedule extends CIMParseable[GenUnitOpSchedule] with Serializable
- object GenUnitOpScheduleSerializer extends CIMSerializer[GenUnitOpSchedule]
- object GeneralClearing extends CIMParseable[GeneralClearing] with Serializable
- object GeneralClearingResults extends CIMParseable[GeneralClearingResults] with Serializable
- object GeneralClearingResultsSerializer extends CIMSerializer[GeneralClearingResults]
- object GeneralClearingSerializer extends CIMSerializer[GeneralClearing]
- object GeneratingBid extends CIMParseable[GeneratingBid] with Serializable
- object GeneratingBidSerializer extends CIMSerializer[GeneratingBid]
- object GeneratingUnit extends CIMParseable[GeneratingUnit] with Serializable
- object GeneratingUnitDynamicValues extends CIMParseable[GeneratingUnitDynamicValues] with Serializable
- object GeneratingUnitDynamicValuesSerializer extends CIMSerializer[GeneratingUnitDynamicValues]
- object GeneratingUnitSerializer extends CIMSerializer[GeneratingUnit]
- object GenerationProvider extends CIMParseable[GenerationProvider] with Serializable
- object GenerationProviderSerializer extends CIMSerializer[GenerationProvider]
- object GeneratorTypeAsset extends CIMParseable[GeneratorTypeAsset] with Serializable
- object GeneratorTypeAssetSerializer extends CIMSerializer[GeneratorTypeAsset]
- object GenericAction extends CIMParseable[GenericAction] with Serializable
- object GenericActionSerializer extends CIMSerializer[GenericAction]
- object GenericConstraints extends CIMParseable[GenericConstraints] with Serializable
- object GenericConstraintsSerializer extends CIMSerializer[GenericConstraints]
- object GenericDataSetVersion extends CIMParseable[GenericDataSetVersion] with Serializable
- object GenericDataSetVersionSerializer extends CIMSerializer[GenericDataSetVersion]
- object GeographicalRegion extends CIMParseable[GeographicalRegion] with Serializable
- object GeographicalRegionSerializer extends CIMSerializer[GeographicalRegion]
- object GeosphericAnalog extends CIMParseable[GeosphericAnalog] with Serializable
- object GeosphericAnalogSerializer extends CIMSerializer[GeosphericAnalog]
- object GeosphericPhenomenon extends CIMParseable[GeosphericPhenomenon] with Serializable
- object GeosphericPhenomenonSerializer extends CIMSerializer[GeosphericPhenomenon]
- object GovCT1 extends CIMParseable[GovCT1] with Serializable
- object GovCT1Serializer extends CIMSerializer[GovCT1]
- object GovCT2 extends CIMParseable[GovCT2] with Serializable
- object GovCT2Serializer extends CIMSerializer[GovCT2]
- object GovGAST extends CIMParseable[GovGAST] with Serializable
- object GovGAST1 extends CIMParseable[GovGAST1] with Serializable
- object GovGAST1Serializer extends CIMSerializer[GovGAST1]
- object GovGAST2 extends CIMParseable[GovGAST2] with Serializable
- object GovGAST2Serializer extends CIMSerializer[GovGAST2]
- object GovGAST3 extends CIMParseable[GovGAST3] with Serializable
- object GovGAST3Serializer extends CIMSerializer[GovGAST3]
- object GovGAST4 extends CIMParseable[GovGAST4] with Serializable
- object GovGAST4Serializer extends CIMSerializer[GovGAST4]
- object GovGASTSerializer extends CIMSerializer[GovGAST]
- object GovGASTWD extends CIMParseable[GovGASTWD] with Serializable
- object GovGASTWDSerializer extends CIMSerializer[GovGASTWD]
- object GovHydro1 extends CIMParseable[GovHydro1] with Serializable
- object GovHydro1Serializer extends CIMSerializer[GovHydro1]
- object GovHydro2 extends CIMParseable[GovHydro2] with Serializable
- object GovHydro2Serializer extends CIMSerializer[GovHydro2]
- object GovHydro3 extends CIMParseable[GovHydro3] with Serializable
- object GovHydro3Serializer extends CIMSerializer[GovHydro3]
- object GovHydro4 extends CIMParseable[GovHydro4] with Serializable
- object GovHydro4Serializer extends CIMSerializer[GovHydro4]
- object GovHydroDD extends CIMParseable[GovHydroDD] with Serializable
- object GovHydroDDSerializer extends CIMSerializer[GovHydroDD]
- object GovHydroFrancis extends CIMParseable[GovHydroFrancis] with Serializable
- object GovHydroFrancisSerializer extends CIMSerializer[GovHydroFrancis]
- object GovHydroIEEE0 extends CIMParseable[GovHydroIEEE0] with Serializable
- object GovHydroIEEE0Serializer extends CIMSerializer[GovHydroIEEE0]
- object GovHydroIEEE2 extends CIMParseable[GovHydroIEEE2] with Serializable
- object GovHydroIEEE2Serializer extends CIMSerializer[GovHydroIEEE2]
- object GovHydroPID extends CIMParseable[GovHydroPID] with Serializable
- object GovHydroPID2 extends CIMParseable[GovHydroPID2] with Serializable
- object GovHydroPID2Serializer extends CIMSerializer[GovHydroPID2]
- object GovHydroPIDSerializer extends CIMSerializer[GovHydroPID]
- object GovHydroPelton extends CIMParseable[GovHydroPelton] with Serializable
- object GovHydroPeltonSerializer extends CIMSerializer[GovHydroPelton]
- object GovHydroR extends CIMParseable[GovHydroR] with Serializable
- object GovHydroRSerializer extends CIMSerializer[GovHydroR]
- object GovHydroWEH extends CIMParseable[GovHydroWEH] with Serializable
- object GovHydroWEHSerializer extends CIMSerializer[GovHydroWEH]
- object GovHydroWPID extends CIMParseable[GovHydroWPID] with Serializable
- object GovHydroWPIDSerializer extends CIMSerializer[GovHydroWPID]
- object GovSteam0 extends CIMParseable[GovSteam0] with Serializable
- object GovSteam0Serializer extends CIMSerializer[GovSteam0]
- object GovSteam1 extends CIMParseable[GovSteam1] with Serializable
- object GovSteam1Serializer extends CIMSerializer[GovSteam1]
- object GovSteam2 extends CIMParseable[GovSteam2] with Serializable
- object GovSteam2Serializer extends CIMSerializer[GovSteam2]
- object GovSteamBB extends CIMParseable[GovSteamBB] with Serializable
- object GovSteamBBSerializer extends CIMSerializer[GovSteamBB]
- object GovSteamCC extends CIMParseable[GovSteamCC] with Serializable
- object GovSteamCCSerializer extends CIMSerializer[GovSteamCC]
- object GovSteamEU extends CIMParseable[GovSteamEU] with Serializable
- object GovSteamEUSerializer extends CIMSerializer[GovSteamEU]
- object GovSteamFV2 extends CIMParseable[GovSteamFV2] with Serializable
- object GovSteamFV2Serializer extends CIMSerializer[GovSteamFV2]
- object GovSteamFV3 extends CIMParseable[GovSteamFV3] with Serializable
- object GovSteamFV3Serializer extends CIMSerializer[GovSteamFV3]
- object GovSteamFV4 extends CIMParseable[GovSteamFV4] with Serializable
- object GovSteamFV4Serializer extends CIMSerializer[GovSteamFV4]
- object GovSteamIEEE1 extends CIMParseable[GovSteamIEEE1] with Serializable
- object GovSteamIEEE1Serializer extends CIMSerializer[GovSteamIEEE1]
- object GovSteamSGO extends CIMParseable[GovSteamSGO] with Serializable
- object GovSteamSGOSerializer extends CIMSerializer[GovSteamSGO]
- object GrossToNetActivePowerCurve extends CIMParseable[GrossToNetActivePowerCurve] with Serializable
- object GrossToNetActivePowerCurveSerializer extends CIMSerializer[GrossToNetActivePowerCurve]
- object Ground extends CIMParseable[Ground] with Serializable
- object GroundAction extends CIMParseable[GroundAction] with Serializable
- object GroundActionSerializer extends CIMSerializer[GroundAction]
- object GroundDisconnector extends CIMParseable[GroundDisconnector] with Serializable
- object GroundDisconnectorSerializer extends CIMSerializer[GroundDisconnector]
- object GroundSerializer extends CIMSerializer[Ground]
- object GroundingImpedance extends CIMParseable[GroundingImpedance] with Serializable
- object GroundingImpedanceSerializer extends CIMSerializer[GroundingImpedance]
- object HVDCDynamics extends CIMParseable[HVDCDynamics] with Serializable
- object HVDCDynamicsSerializer extends CIMSerializer[HVDCDynamics]
- object HVDCLookUpTable extends CIMParseable[HVDCLookUpTable] with Serializable
- object HVDCLookUpTableSerializer extends CIMSerializer[HVDCLookUpTable]
- object Hazard extends CIMParseable[Hazard] with Serializable
- object HazardSerializer extends CIMSerializer[Hazard]
- object HealthScore extends CIMParseable[HealthScore] with Serializable
- object HealthScoreSerializer extends CIMSerializer[HealthScore]
- object HeatInputCurve extends CIMParseable[HeatInputCurve] with Serializable
- object HeatInputCurveSerializer extends CIMSerializer[HeatInputCurve]
- object HeatRateCurve extends CIMParseable[HeatRateCurve] with Serializable
- object HeatRateCurveSerializer extends CIMSerializer[HeatRateCurve]
- object HeatRecoveryBoiler extends CIMParseable[HeatRecoveryBoiler] with Serializable
- object HeatRecoveryBoilerSerializer extends CIMSerializer[HeatRecoveryBoiler]
- object HostControlArea extends CIMParseable[HostControlArea] with Serializable
- object HostControlAreaSerializer extends CIMSerializer[HostControlArea]
- object HourlyPreDispatchSchedule extends CIMParseable[HourlyPreDispatchSchedule] with Serializable
- object HourlyPreDispatchScheduleSerializer extends CIMSerializer[HourlyPreDispatchSchedule]
- object Hurricane extends CIMParseable[Hurricane] with Serializable
- object HurricaneSerializer extends CIMSerializer[Hurricane]
- object HydroGeneratingEfficiencyCurve extends CIMParseable[HydroGeneratingEfficiencyCurve] with Serializable
- object HydroGeneratingEfficiencyCurveSerializer extends CIMSerializer[HydroGeneratingEfficiencyCurve]
- object HydroGeneratingUnit extends CIMParseable[HydroGeneratingUnit] with Serializable
- object HydroGeneratingUnitSerializer extends CIMSerializer[HydroGeneratingUnit]
- object HydroPowerPlant extends CIMParseable[HydroPowerPlant] with Serializable
- object HydroPowerPlantSerializer extends CIMSerializer[HydroPowerPlant]
- object HydroPump extends CIMParseable[HydroPump] with Serializable
- object HydroPumpOpSchedule extends CIMParseable[HydroPumpOpSchedule] with Serializable
- object HydroPumpOpScheduleSerializer extends CIMSerializer[HydroPumpOpSchedule]
- object HydroPumpSerializer extends CIMSerializer[HydroPump]
- object HydroTurbine extends CIMParseable[HydroTurbine] with Serializable
- object HydroTurbineSerializer extends CIMSerializer[HydroTurbine]
- object HydrosphericAnalog extends CIMParseable[HydrosphericAnalog] with Serializable
- object HydrosphericAnalogSerializer extends CIMSerializer[HydrosphericAnalog]
- object HydrosphericPhenomenon extends CIMParseable[HydrosphericPhenomenon] with Serializable
- object HydrosphericPhenomenonSerializer extends CIMSerializer[HydrosphericPhenomenon]
- object ICCPInformationMessage extends CIMParseable[ICCPInformationMessage] with Serializable
- object ICCPInformationMessageSerializer extends CIMSerializer[ICCPInformationMessage]
- object ICCPProvidedPoint extends CIMParseable[ICCPProvidedPoint] with Serializable
- object ICCPProvidedPointSerializer extends CIMSerializer[ICCPProvidedPoint]
- object ICCPVCC extends CIMParseable[ICCPVCC] with Serializable
- object ICCPVCCSerializer extends CIMSerializer[ICCPVCC]
- object ICCPVirtualControlCentre extends CIMParseable[ICCPVirtualControlCentre] with Serializable
- object ICCPVirtualControlCentreSerializer extends CIMSerializer[ICCPVirtualControlCentre]
- object IEC61968CIMVersion extends CIMParseable[IEC61968CIMVersion] with Serializable
- object IEC61968CIMVersionSerializer extends CIMSerializer[IEC61968CIMVersion]
- object IEC61970CIMVersion extends CIMParseable[IEC61970CIMVersion] with Serializable
- object IEC61970CIMVersionSerializer extends CIMSerializer[IEC61970CIMVersion]
- object IEC62325CIMVersion extends CIMParseable[IEC62325CIMVersion] with Serializable
- object IEC62325CIMVersionSerializer extends CIMSerializer[IEC62325CIMVersion]
- object IECStandard extends CIMParseable[IECStandard] with Serializable
- object IECStandardSerializer extends CIMSerializer[IECStandard]
- object IEEEStandard extends CIMParseable[IEEEStandard] with Serializable
- object IEEEStandardSerializer extends CIMSerializer[IEEEStandard]
- object IOPoint extends CIMParseable[IOPoint] with Serializable
- object IOPointSerializer extends CIMSerializer[IOPoint]
- object IOPointSource extends CIMParseable[IOPointSource] with Serializable
- object IOPointSourceSerializer extends CIMSerializer[IOPointSource]
- object IPAccessPoint extends CIMParseable[IPAccessPoint] with Serializable
- object IPAccessPointSerializer extends CIMSerializer[IPAccessPoint]
- object ISOStandard extends CIMParseable[ISOStandard] with Serializable
- object ISOStandardSerializer extends CIMSerializer[ISOStandard]
- object ISOUpperLayer extends CIMParseable[ISOUpperLayer] with Serializable
- object ISOUpperLayerSerializer extends CIMSerializer[ISOUpperLayer]
- object IdcInverterControl extends CIMParseable[IdcInverterControl] with Serializable
- object IdcInverterControlSerializer extends CIMSerializer[IdcInverterControl]
- object IdentifiedObject extends CIMParseable[IdentifiedObject] with Serializable
- object IdentifiedObjectSerializer extends CIMSerializer[IdentifiedObject]
- object IgnAngleContInverter extends CIMParseable[IgnAngleContInverter] with Serializable
- object IgnAngleContInverterSerializer extends CIMSerializer[IgnAngleContInverter]
- object InUseDate extends CIMParseable[InUseDate] with Serializable
- object InUseDateSerializer extends CIMSerializer[InUseDate]
- object InadvertentAccount extends CIMParseable[InadvertentAccount] with Serializable
- object InadvertentAccountSerializer extends CIMSerializer[InadvertentAccount]
- object Incident extends CIMParseable[Incident] with Serializable
- object IncidentHazard extends CIMParseable[IncidentHazard] with Serializable
- object IncidentHazardSerializer extends CIMSerializer[IncidentHazard]
- object IncidentSerializer extends CIMSerializer[Incident]
- object IncrementalDatasetArg extends CIMParseable[IncrementalDatasetArg] with Serializable
- object IncrementalDatasetArgDescription extends CIMParseable[IncrementalDatasetArgDescription] with Serializable
- object IncrementalDatasetArgDescriptionSerializer extends CIMSerializer[IncrementalDatasetArgDescription]
- object IncrementalDatasetArgSerializer extends CIMSerializer[IncrementalDatasetArg]
- object IncrementalHeatRateCurve extends CIMParseable[IncrementalHeatRateCurve] with Serializable
- object IncrementalHeatRateCurveSerializer extends CIMSerializer[IncrementalHeatRateCurve]
- object IndividualPnode extends CIMParseable[IndividualPnode] with Serializable
- object IndividualPnodeSerializer extends CIMSerializer[IndividualPnode]
- object InflowForecast extends CIMParseable[InflowForecast] with Serializable
- object InflowForecastSerializer extends CIMSerializer[InflowForecast]
- object InfoQuestion extends CIMParseable[InfoQuestion] with Serializable
- object InfoQuestionSerializer extends CIMSerializer[InfoQuestion]
- object InspectionAnalog extends CIMParseable[InspectionAnalog] with Serializable
- object InspectionAnalogSerializer extends CIMSerializer[InspectionAnalog]
- object InspectionDataSet extends CIMParseable[InspectionDataSet] with Serializable
- object InspectionDataSetSerializer extends CIMSerializer[InspectionDataSet]
- object InspectionDiscrete extends CIMParseable[InspectionDiscrete] with Serializable
- object InspectionDiscreteSerializer extends CIMSerializer[InspectionDiscrete]
- object InstanceSet extends CIMParseable[InstanceSet] with Serializable
- object InstanceSetSerializer extends CIMSerializer[InstanceSet]
- object InstructionClearing extends CIMParseable[InstructionClearing] with Serializable
- object InstructionClearingDOP extends CIMParseable[InstructionClearingDOP] with Serializable
- object InstructionClearingDOPSerializer extends CIMSerializer[InstructionClearingDOP]
- object InstructionClearingDOT extends CIMParseable[InstructionClearingDOT] with Serializable
- object InstructionClearingDOTSerializer extends CIMSerializer[InstructionClearingDOT]
- object InstructionClearingSerializer extends CIMSerializer[InstructionClearing]
- object Instructions extends CIMParseable[Instructions] with Serializable
- object InstructionsSerializer extends CIMSerializer[Instructions]
- object IntSchedAgreement extends CIMParseable[IntSchedAgreement] with Serializable
- object IntSchedAgreementSerializer extends CIMSerializer[IntSchedAgreement]
- object IntegerQuantity extends CIMParseable[IntegerQuantity] with Serializable
- object IntegerQuantitySerializer extends CIMSerializer[IntegerQuantity]
- object InterTieBid extends CIMParseable[InterTieBid] with Serializable
- object InterTieBidSerializer extends CIMSerializer[InterTieBid]
- object InterTieClearing extends CIMParseable[InterTieClearing] with Serializable
- object InterTieClearingSerializer extends CIMSerializer[InterTieClearing]
- object InterTieDispatchResponse extends CIMParseable[InterTieDispatchResponse] with Serializable
- object InterTieDispatchResponseSerializer extends CIMSerializer[InterTieDispatchResponse]
- object InterTieResults extends CIMParseable[InterTieResults] with Serializable
- object InterTieResultsSerializer extends CIMSerializer[InterTieResults]
- object InterchangeETCData extends CIMParseable[InterchangeETCData] with Serializable
- object InterchangeETCDataSerializer extends CIMSerializer[InterchangeETCData]
- object InterchangeSchedule extends CIMParseable[InterchangeSchedule] with Serializable
- object InterchangeScheduleSerializer extends CIMSerializer[InterchangeSchedule]
- object IntermittentResourceEligibility extends CIMParseable[IntermittentResourceEligibility] with Serializable
- object IntermittentResourceEligibilitySerializer extends CIMSerializer[IntermittentResourceEligibility]
- object InternalControlArea extends CIMParseable[InternalControlArea] with Serializable
- object InternalControlAreaSerializer extends CIMSerializer[InternalControlArea]
- object InternalLocation extends CIMParseable[InternalLocation] with Serializable
- object InternalLocationSerializer extends CIMSerializer[InternalLocation]
- object InterrupterUnit extends CIMParseable[InterrupterUnit] with Serializable
- object InterrupterUnitInfo extends CIMParseable[InterrupterUnitInfo] with Serializable
- object InterrupterUnitInfoSerializer extends CIMSerializer[InterrupterUnitInfo]
- object InterrupterUnitSerializer extends CIMSerializer[InterrupterUnit]
- object IntervalBlock extends CIMParseable[IntervalBlock] with Serializable
- object IntervalBlockSerializer extends CIMSerializer[IntervalBlock]
- object IntervalReading extends CIMParseable[IntervalReading] with Serializable
- object IntervalReadingSerializer extends CIMSerializer[IntervalReading]
- object IrregularIntervalSchedule extends CIMParseable[IrregularIntervalSchedule] with Serializable
- object IrregularIntervalScheduleSerializer extends CIMSerializer[IrregularIntervalSchedule]
- object IrregularTimePoint extends CIMParseable[IrregularTimePoint] with Serializable
- object IrregularTimePointSerializer extends CIMSerializer[IrregularTimePoint]
- object Issuer extends CIMParseable[Issuer] with Serializable
- object IssuerSerializer extends CIMSerializer[Issuer]
- object Joint extends CIMParseable[Joint] with Serializable
- object JointSerializer extends CIMSerializer[Joint]
- object Jumper extends CIMParseable[Jumper] with Serializable
- object JumperAction extends CIMParseable[JumperAction] with Serializable
- object JumperActionSerializer extends CIMSerializer[JumperAction]
- object JumperSerializer extends CIMSerializer[Jumper]
- object Junction extends CIMParseable[Junction] with Serializable
- object JunctionSerializer extends CIMSerializer[Junction]
- object LabTestDataSet extends CIMParseable[LabTestDataSet] with Serializable
- object LabTestDataSetSerializer extends CIMSerializer[LabTestDataSet]
- object LaborItem extends CIMParseable[LaborItem] with Serializable
- object LaborItemSerializer extends CIMSerializer[LaborItem]
- object LaborelecStandard extends CIMParseable[LaborelecStandard] with Serializable
- object LaborelecStandardSerializer extends CIMSerializer[LaborelecStandard]
- object LandProperty extends CIMParseable[LandProperty] with Serializable
- object LandPropertySerializer extends CIMSerializer[LandProperty]
- object Landslide extends CIMParseable[Landslide] with Serializable
- object LandslideSerializer extends CIMSerializer[Landslide]
- object LevelVsVolumeCurve extends CIMParseable[LevelVsVolumeCurve] with Serializable
- object LevelVsVolumeCurveSerializer extends CIMSerializer[LevelVsVolumeCurve]
- object LifecycleDate extends CIMParseable[LifecycleDate] with Serializable
- object LifecycleDateSerializer extends CIMSerializer[LifecycleDate]
- object LightningStrike extends CIMParseable[LightningStrike] with Serializable
- object LightningStrikeSerializer extends CIMSerializer[LightningStrike]
- object Limit extends CIMParseable[Limit] with Serializable
- object LimitDependency extends CIMParseable[LimitDependency] with Serializable
- object LimitDependencySerializer extends CIMSerializer[LimitDependency]
- object LimitScalingLimit extends CIMParseable[LimitScalingLimit] with Serializable
- object LimitScalingLimitSerializer extends CIMSerializer[LimitScalingLimit]
- object LimitSerializer extends CIMSerializer[Limit]
- object LimitSet extends CIMParseable[LimitSet] with Serializable
- object LimitSetSerializer extends CIMSerializer[LimitSet]
- object Line extends CIMParseable[Line] with Serializable
- object LineDetail extends CIMParseable[LineDetail] with Serializable
- object LineDetailSerializer extends CIMSerializer[LineDetail]
- object LineFault extends CIMParseable[LineFault] with Serializable
- object LineFaultSerializer extends CIMSerializer[LineFault]
- object LineSerializer extends CIMSerializer[Line]
- object LinearShuntCompensator extends CIMParseable[LinearShuntCompensator] with Serializable
- object LinearShuntCompensatorPhase extends CIMParseable[LinearShuntCompensatorPhase] with Serializable
- object LinearShuntCompensatorPhaseSerializer extends CIMSerializer[LinearShuntCompensatorPhase]
- object LinearShuntCompensatorSerializer extends CIMSerializer[LinearShuntCompensator]
- object LoadAggregate extends CIMParseable[LoadAggregate] with Serializable
- object LoadAggregateSerializer extends CIMSerializer[LoadAggregate]
- object LoadAggregationPoint extends CIMParseable[LoadAggregationPoint] with Serializable
- object LoadAggregationPointSerializer extends CIMSerializer[LoadAggregationPoint]
- object LoadArea extends CIMParseable[LoadArea] with Serializable
- object LoadAreaSerializer extends CIMSerializer[LoadArea]
- object LoadBid extends CIMParseable[LoadBid] with Serializable
- object LoadBidSerializer extends CIMSerializer[LoadBid]
- object LoadBreakSwitch extends CIMParseable[LoadBreakSwitch] with Serializable
- object LoadBreakSwitchSerializer extends CIMSerializer[LoadBreakSwitch]
- object LoadComposite extends CIMParseable[LoadComposite] with Serializable
- object LoadCompositeSerializer extends CIMSerializer[LoadComposite]
- object LoadDistributionFactor extends CIMParseable[LoadDistributionFactor] with Serializable
- object LoadDistributionFactorSerializer extends CIMSerializer[LoadDistributionFactor]
- object LoadDynamics extends CIMParseable[LoadDynamics] with Serializable
- object LoadDynamicsSerializer extends CIMSerializer[LoadDynamics]
- object LoadFollowingInst extends CIMParseable[LoadFollowingInst] with Serializable
- object LoadFollowingInstSerializer extends CIMSerializer[LoadFollowingInst]
- object LoadFollowingOperatorInput extends CIMParseable[LoadFollowingOperatorInput] with Serializable
- object LoadFollowingOperatorInputSerializer extends CIMSerializer[LoadFollowingOperatorInput]
- object LoadGenericNonLinear extends CIMParseable[LoadGenericNonLinear] with Serializable
- object LoadGenericNonLinearSerializer extends CIMSerializer[LoadGenericNonLinear]
- object LoadGroup extends CIMParseable[LoadGroup] with Serializable
- object LoadGroupSerializer extends CIMSerializer[LoadGroup]
- object LoadModelPartVersion extends CIMParseable[LoadModelPartVersion] with Serializable
- object LoadModelPartVersionSerializer extends CIMSerializer[LoadModelPartVersion]
- object LoadMotor extends CIMParseable[LoadMotor] with Serializable
- object LoadMotorSerializer extends CIMSerializer[LoadMotor]
- object LoadRatio extends CIMParseable[LoadRatio] with Serializable
- object LoadRatioSerializer extends CIMSerializer[LoadRatio]
- object LoadReductionPriceCurve extends CIMParseable[LoadReductionPriceCurve] with Serializable
- object LoadReductionPriceCurveSerializer extends CIMSerializer[LoadReductionPriceCurve]
- object LoadReductionTimeCurve extends CIMParseable[LoadReductionTimeCurve] with Serializable
- object LoadReductionTimeCurveSerializer extends CIMSerializer[LoadReductionTimeCurve]
- object LoadResponseCharacteristic extends CIMParseable[LoadResponseCharacteristic] with Serializable
- object LoadResponseCharacteristicSerializer extends CIMSerializer[LoadResponseCharacteristic]
- object LoadStatic extends CIMParseable[LoadStatic] with Serializable
- object LoadStaticSerializer extends CIMSerializer[LoadStatic]
- object LoadUserDefined extends CIMParseable[LoadUserDefined] with Serializable
- object LoadUserDefinedSerializer extends CIMSerializer[LoadUserDefined]
- object LocalReliabilityArea extends CIMParseable[LocalReliabilityArea] with Serializable
- object LocalReliabilityAreaSerializer extends CIMSerializer[LocalReliabilityArea]
- object Location extends CIMParseable[Location] with Serializable
- object LocationGrant extends CIMParseable[LocationGrant] with Serializable
- object LocationGrantSerializer extends CIMSerializer[LocationGrant]
- object LocationSerializer extends CIMSerializer[Location]
- object LossClearing extends CIMParseable[LossClearing] with Serializable
- object LossClearingResults extends CIMParseable[LossClearingResults] with Serializable
- object LossClearingResultsSerializer extends CIMSerializer[LossClearingResults]
- object LossClearingSerializer extends CIMSerializer[LossClearing]
- object LossProfile extends CIMParseable[LossProfile] with Serializable
- object LossProfileSerializer extends CIMSerializer[LossProfile]
- object LossSensitivity extends CIMParseable[LossSensitivity] with Serializable
- object LossSensitivitySerializer extends CIMSerializer[LossSensitivity]
- object MPMClearing extends CIMParseable[MPMClearing] with Serializable
- object MPMClearingSerializer extends CIMSerializer[MPMClearing]
- object MPMResourceStatus extends CIMParseable[MPMResourceStatus] with Serializable
- object MPMResourceStatusSerializer extends CIMSerializer[MPMResourceStatus]
- object MPMTestCategory extends CIMParseable[MPMTestCategory] with Serializable
- object MPMTestCategorySerializer extends CIMSerializer[MPMTestCategory]
- object MPMTestResults extends CIMParseable[MPMTestResults] with Serializable
- object MPMTestResultsSerializer extends CIMSerializer[MPMTestResults]
- object MPMTestThreshold extends CIMParseable[MPMTestThreshold] with Serializable
- object MPMTestThresholdSerializer extends CIMSerializer[MPMTestThreshold]
- object MSSAggregation extends CIMParseable[MSSAggregation] with Serializable
- object MSSAggregationSerializer extends CIMSerializer[MSSAggregation]
- object MSSZone extends CIMParseable[MSSZone] with Serializable
- object MSSZoneSerializer extends CIMSerializer[MSSZone]
- object MWLimitSchedule extends CIMParseable[MWLimitSchedule] with Serializable
- object MWLimitScheduleSerializer extends CIMSerializer[MWLimitSchedule]
- object MagneticStorm extends CIMParseable[MagneticStorm] with Serializable
- object MagneticStormSerializer extends CIMSerializer[MagneticStorm]
- object Maintainer extends CIMParseable[Maintainer] with Serializable
- object MaintainerSerializer extends CIMSerializer[Maintainer]
- object MaintenanceDataSet extends CIMParseable[MaintenanceDataSet] with Serializable
- object MaintenanceDataSetSerializer extends CIMSerializer[MaintenanceDataSet]
- object MaintenanceLocation extends CIMParseable[MaintenanceLocation] with Serializable
- object MaintenanceLocationSerializer extends CIMSerializer[MaintenanceLocation]
- object MaintenanceWorkTask extends CIMParseable[MaintenanceWorkTask] with Serializable
- object MaintenanceWorkTaskSerializer extends CIMSerializer[MaintenanceWorkTask]
- object MajorChargeGroup extends CIMParseable[MajorChargeGroup] with Serializable
- object MajorChargeGroupSerializer extends CIMSerializer[MajorChargeGroup]
- object Manufacturer extends CIMParseable[Manufacturer] with Serializable
- object ManufacturerSerializer extends CIMSerializer[Manufacturer]
- object Market extends CIMParseable[Market] with Serializable
- object MarketActualEvent extends CIMParseable[MarketActualEvent] with Serializable
- object MarketActualEventSerializer extends CIMSerializer[MarketActualEvent]
- object MarketAgreement extends CIMParseable[MarketAgreement] with Serializable
- object MarketAgreementSerializer extends CIMSerializer[MarketAgreement]
- object MarketCaseClearing extends CIMParseable[MarketCaseClearing] with Serializable
- object MarketCaseClearingSerializer extends CIMSerializer[MarketCaseClearing]
- object MarketDocument extends CIMParseable[MarketDocument] with Serializable
- object MarketDocumentSerializer extends CIMSerializer[MarketDocument]
- object MarketEvaluationPoint extends CIMParseable[MarketEvaluationPoint] with Serializable
- object MarketEvaluationPointSerializer extends CIMSerializer[MarketEvaluationPoint]
- object MarketFactors extends CIMParseable[MarketFactors] with Serializable
- object MarketFactorsSerializer extends CIMSerializer[MarketFactors]
- object MarketInvoice extends CIMParseable[MarketInvoice] with Serializable
- object MarketInvoiceLineItem extends CIMParseable[MarketInvoiceLineItem] with Serializable
- object MarketInvoiceLineItemSerializer extends CIMSerializer[MarketInvoiceLineItem]
- object MarketInvoiceSerializer extends CIMSerializer[MarketInvoice]
- object MarketLedger extends CIMParseable[MarketLedger] with Serializable
- object MarketLedgerEntry extends CIMParseable[MarketLedgerEntry] with Serializable
- object MarketLedgerEntrySerializer extends CIMSerializer[MarketLedgerEntry]
- object MarketLedgerSerializer extends CIMSerializer[MarketLedger]
- object MarketObjectStatus extends CIMParseable[MarketObjectStatus] with Serializable
- object MarketObjectStatusSerializer extends CIMSerializer[MarketObjectStatus]
- object MarketParticipant extends CIMParseable[MarketParticipant] with Serializable
- object MarketParticipantSerializer extends CIMSerializer[MarketParticipant]
- object MarketPerson extends CIMParseable[MarketPerson] with Serializable
- object MarketPersonSerializer extends CIMSerializer[MarketPerson]
- object MarketPlan extends CIMParseable[MarketPlan] with Serializable
- object MarketPlanSerializer extends CIMSerializer[MarketPlan]
- object MarketProduct extends CIMParseable[MarketProduct] with Serializable
- object MarketProductSerializer extends CIMSerializer[MarketProduct]
- object MarketQualificationRequirement extends CIMParseable[MarketQualificationRequirement] with Serializable
- object MarketQualificationRequirementSerializer extends CIMSerializer[MarketQualificationRequirement]
- object MarketRegion extends CIMParseable[MarketRegion] with Serializable
- object MarketRegionResults extends CIMParseable[MarketRegionResults] with Serializable
- object MarketRegionResultsSerializer extends CIMSerializer[MarketRegionResults]
- object MarketRegionSerializer extends CIMSerializer[MarketRegion]
- object MarketResults extends CIMParseable[MarketResults] with Serializable
- object MarketResultsSerializer extends CIMSerializer[MarketResults]
- object MarketRole extends CIMParseable[MarketRole] with Serializable
- object MarketRoleSerializer extends CIMSerializer[MarketRole]
- object MarketRun extends CIMParseable[MarketRun] with Serializable
- object MarketRunSerializer extends CIMSerializer[MarketRun]
- object MarketScheduledEvent extends CIMParseable[MarketScheduledEvent] with Serializable
- object MarketScheduledEventSerializer extends CIMSerializer[MarketScheduledEvent]
- object MarketSerializer extends CIMSerializer[Market]
- object MarketSkill extends CIMParseable[MarketSkill] with Serializable
- object MarketSkillSerializer extends CIMSerializer[MarketSkill]
- object MarketStatement extends CIMParseable[MarketStatement] with Serializable
- object MarketStatementLineItem extends CIMParseable[MarketStatementLineItem] with Serializable
- object MarketStatementLineItemSerializer extends CIMSerializer[MarketStatementLineItem]
- object MarketStatementSerializer extends CIMSerializer[MarketStatement]
- object Marketer extends CIMParseable[Marketer] with Serializable
- object MarketerSerializer extends CIMSerializer[Marketer]
- object MaterialItem extends CIMParseable[MaterialItem] with Serializable
- object MaterialItemSerializer extends CIMSerializer[MaterialItem]
- object MaxStartUpCostCurve extends CIMParseable[MaxStartUpCostCurve] with Serializable
- object MaxStartUpCostCurveSerializer extends CIMSerializer[MaxStartUpCostCurve]
- object Measurement extends CIMParseable[Measurement] with Serializable
- object MeasurementAction extends CIMParseable[MeasurementAction] with Serializable
- object MeasurementActionSerializer extends CIMSerializer[MeasurementAction]
- object MeasurementCalculator extends CIMParseable[MeasurementCalculator] with Serializable
- object MeasurementCalculatorInput extends CIMParseable[MeasurementCalculatorInput] with Serializable
- object MeasurementCalculatorInputSerializer extends CIMSerializer[MeasurementCalculatorInput]
- object MeasurementCalculatorSerializer extends CIMSerializer[MeasurementCalculator]
- object MeasurementSerializer extends CIMSerializer[Measurement]
- object MeasurementValue extends CIMParseable[MeasurementValue] with Serializable
- object MeasurementValueQuality extends CIMParseable[MeasurementValueQuality] with Serializable
- object MeasurementValueQualitySerializer extends CIMSerializer[MeasurementValueQuality]
- object MeasurementValueSerializer extends CIMSerializer[MeasurementValue]
- object MeasurementValueSource extends CIMParseable[MeasurementValueSource] with Serializable
- object MeasurementValueSourceSerializer extends CIMSerializer[MeasurementValueSource]
- object MechLoad1 extends CIMParseable[MechLoad1] with Serializable
- object MechLoad1Serializer extends CIMSerializer[MechLoad1]
- object MechanicalLoadDynamics extends CIMParseable[MechanicalLoadDynamics] with Serializable
- object MechanicalLoadDynamicsSerializer extends CIMSerializer[MechanicalLoadDynamics]
- object MechanicalLoadUserDefined extends CIMParseable[MechanicalLoadUserDefined] with Serializable
- object MechanicalLoadUserDefinedSerializer extends CIMSerializer[MechanicalLoadUserDefined]
- object Medium extends CIMParseable[Medium] with Serializable
- object MediumSerializer extends CIMSerializer[Medium]
- object MerchantAccount extends CIMParseable[MerchantAccount] with Serializable
- object MerchantAccountSerializer extends CIMSerializer[MerchantAccount]
- object MerchantAgreement extends CIMParseable[MerchantAgreement] with Serializable
- object MerchantAgreementSerializer extends CIMSerializer[MerchantAgreement]
- object Meter extends CIMParseable[Meter] with Serializable
- object MeterMultiplier extends CIMParseable[MeterMultiplier] with Serializable
- object MeterMultiplierSerializer extends CIMSerializer[MeterMultiplier]
- object MeterReading extends CIMParseable[MeterReading] with Serializable
- object MeterReadingSerializer extends CIMSerializer[MeterReading]
- object MeterSerializer extends CIMSerializer[Meter]
- object MeterWorkTask extends CIMParseable[MeterWorkTask] with Serializable
- object MeterWorkTaskSerializer extends CIMSerializer[MeterWorkTask]
- object MeteredSubSystem extends CIMParseable[MeteredSubSystem] with Serializable
- object MeteredSubSystemSerializer extends CIMSerializer[MeteredSubSystem]
- object MetrologyRequirement extends CIMParseable[MetrologyRequirement] with Serializable
- object MetrologyRequirementSerializer extends CIMSerializer[MetrologyRequirement]
- object MiscCostItem extends CIMParseable[MiscCostItem] with Serializable
- object MiscCostItemSerializer extends CIMSerializer[MiscCostItem]
- object MitigatedBid extends CIMParseable[MitigatedBid] with Serializable
- object MitigatedBidClearing extends CIMParseable[MitigatedBidClearing] with Serializable
- object MitigatedBidClearingSerializer extends CIMSerializer[MitigatedBidClearing]
- object MitigatedBidSegment extends CIMParseable[MitigatedBidSegment] with Serializable
- object MitigatedBidSegmentSerializer extends CIMSerializer[MitigatedBidSegment]
- object MitigatedBidSerializer extends CIMSerializer[MitigatedBid]
- object MktACLineSegment extends CIMParseable[MktACLineSegment] with Serializable
- object MktACLineSegmentSerializer extends CIMSerializer[MktACLineSegment]
- object MktActivityRecord extends CIMParseable[MktActivityRecord] with Serializable
- object MktActivityRecordSerializer extends CIMSerializer[MktActivityRecord]
- object MktAnalogLimit extends CIMParseable[MktAnalogLimit] with Serializable
- object MktAnalogLimitSerializer extends CIMSerializer[MktAnalogLimit]
- object MktAnalogLimitSet extends CIMParseable[MktAnalogLimitSet] with Serializable
- object MktAnalogLimitSetSerializer extends CIMSerializer[MktAnalogLimitSet]
- object MktCombinedCyclePlant extends CIMParseable[MktCombinedCyclePlant] with Serializable
- object MktCombinedCyclePlantSerializer extends CIMSerializer[MktCombinedCyclePlant]
- object MktConductingEquipment extends CIMParseable[MktConductingEquipment] with Serializable
- object MktConductingEquipmentSerializer extends CIMSerializer[MktConductingEquipment]
- object MktConnectivityNode extends CIMParseable[MktConnectivityNode] with Serializable
- object MktConnectivityNodeSerializer extends CIMSerializer[MktConnectivityNode]
- object MktContingency extends CIMParseable[MktContingency] with Serializable
- object MktContingencySerializer extends CIMSerializer[MktContingency]
- object MktControlArea extends CIMParseable[MktControlArea] with Serializable
- object MktControlAreaSerializer extends CIMSerializer[MktControlArea]
- object MktGeneratingUnit extends CIMParseable[MktGeneratingUnit] with Serializable
- object MktGeneratingUnitSerializer extends CIMSerializer[MktGeneratingUnit]
- object MktHeatRateCurve extends CIMParseable[MktHeatRateCurve] with Serializable
- object MktHeatRateCurveSerializer extends CIMSerializer[MktHeatRateCurve]
- object MktLine extends CIMParseable[MktLine] with Serializable
- object MktLineSerializer extends CIMSerializer[MktLine]
- object MktMeasurement extends CIMParseable[MktMeasurement] with Serializable
- object MktMeasurementSerializer extends CIMSerializer[MktMeasurement]
- object MktPSRType extends CIMParseable[MktPSRType] with Serializable
- object MktPSRTypeSerializer extends CIMSerializer[MktPSRType]
- object MktPowerTransformer extends CIMParseable[MktPowerTransformer] with Serializable
- object MktPowerTransformerSerializer extends CIMSerializer[MktPowerTransformer]
- object MktSeriesCompensator extends CIMParseable[MktSeriesCompensator] with Serializable
- object MktSeriesCompensatorSerializer extends CIMSerializer[MktSeriesCompensator]
- object MktShuntCompensator extends CIMParseable[MktShuntCompensator] with Serializable
- object MktShuntCompensatorSerializer extends CIMSerializer[MktShuntCompensator]
- object MktSwitch extends CIMParseable[MktSwitch] with Serializable
- object MktSwitchSerializer extends CIMSerializer[MktSwitch]
- object MktTapChanger extends CIMParseable[MktTapChanger] with Serializable
- object MktTapChangerSerializer extends CIMSerializer[MktTapChanger]
- object MktTerminal extends CIMParseable[MktTerminal] with Serializable
- object MktTerminalSerializer extends CIMSerializer[MktTerminal]
- object MktThermalGeneratingUnit extends CIMParseable[MktThermalGeneratingUnit] with Serializable
- object MktThermalGeneratingUnitSerializer extends CIMSerializer[MktThermalGeneratingUnit]
- object MktUserAttribute extends CIMParseable[MktUserAttribute] with Serializable
- object MktUserAttributeSerializer extends CIMSerializer[MktUserAttribute]
- object ModelAuthority extends CIMParseable[ModelAuthority] with Serializable
- object ModelAuthoritySerializer extends CIMSerializer[ModelAuthority]
- object ModelAuthoritySet extends CIMParseable[ModelAuthoritySet] with Serializable
- object ModelAuthoritySetSerializer extends CIMSerializer[ModelAuthoritySet]
- object ModelFrameType extends CIMParseable[ModelFrameType] with Serializable
- object ModelFrameTypeSerializer extends CIMSerializer[ModelFrameType]
- object ModelOperation extends CIMParseable[ModelOperation] with Serializable
- object ModelOperationArg extends CIMParseable[ModelOperationArg] with Serializable
- object ModelOperationArgDescription extends CIMParseable[ModelOperationArgDescription] with Serializable
- object ModelOperationArgDescriptionSerializer extends CIMSerializer[ModelOperationArgDescription]
- object ModelOperationArgSerializer extends CIMSerializer[ModelOperationArg]
- object ModelOperationDescription extends CIMParseable[ModelOperationDescription] with Serializable
- object ModelOperationDescriptionSerializer extends CIMSerializer[ModelOperationDescription]
- object ModelOperationSequence extends CIMParseable[ModelOperationSequence] with Serializable
- object ModelOperationSequenceSerializer extends CIMSerializer[ModelOperationSequence]
- object ModelOperationSerializer extends CIMSerializer[ModelOperation]
- object ModelPartSpecification extends CIMParseable[ModelPartSpecification] with Serializable
- object ModelPartSpecificationSerializer extends CIMSerializer[ModelPartSpecification]
- object ModelPartVersion extends CIMParseable[ModelPartVersion] with Serializable
- object ModelPartVersionSerializer extends CIMSerializer[ModelPartVersion]
- object ModelToBeDeleted extends CIMParseable[ModelToBeDeleted] with Serializable
- object ModelToBeDeletedSerializer extends CIMSerializer[ModelToBeDeleted]
- object MonthDayInterval extends CIMParseable[MonthDayInterval] with Serializable
- object MonthDayIntervalSerializer extends CIMSerializer[MonthDayInterval]
- object MutualCoupling extends CIMParseable[MutualCoupling] with Serializable
- object MutualCouplingSerializer extends CIMSerializer[MutualCoupling]
- object Name extends CIMParseable[Name] with Serializable
- object NameSerializer extends CIMSerializer[Name]
- object NameType extends CIMParseable[NameType] with Serializable
- object NameTypeAuthority extends CIMParseable[NameTypeAuthority] with Serializable
- object NameTypeAuthoritySerializer extends CIMSerializer[NameTypeAuthority]
- object NameTypeSerializer extends CIMSerializer[NameType]
- object NetworkBoundary extends CIMParseable[NetworkBoundary] with Serializable
- object NetworkBoundarySerializer extends CIMSerializer[NetworkBoundary]
- object NetworkFrame extends CIMParseable[NetworkFrame] with Serializable
- object NetworkFrameSerializer extends CIMSerializer[NetworkFrame]
- object NetworkModelCaseDefinition extends CIMParseable[NetworkModelCaseDefinition] with Serializable
- object NetworkModelCaseDefinitionSerializer extends CIMSerializer[NetworkModelCaseDefinition]
- object NetworkModelProject extends CIMParseable[NetworkModelProject] with Serializable
- object NetworkModelProject2 extends CIMParseable[NetworkModelProject2] with Serializable
- object NetworkModelProject2Serializer extends CIMSerializer[NetworkModelProject2]
- object NetworkModelProjectChange extends CIMParseable[NetworkModelProjectChange] with Serializable
- object NetworkModelProjectChangeSerializer extends CIMSerializer[NetworkModelProjectChange]
- object NetworkModelProjectChangeVersion extends CIMParseable[NetworkModelProjectChangeVersion] with Serializable
- object NetworkModelProjectChangeVersionSerializer extends CIMSerializer[NetworkModelProjectChangeVersion]
- object NetworkModelProjectCollection extends CIMParseable[NetworkModelProjectCollection] with Serializable
- object NetworkModelProjectCollectionSerializer extends CIMSerializer[NetworkModelProjectCollection]
- object NetworkModelProjectComponent extends CIMParseable[NetworkModelProjectComponent] with Serializable
- object NetworkModelProjectComponent2 extends CIMParseable[NetworkModelProjectComponent2] with Serializable
- object NetworkModelProjectComponent2Serializer extends CIMSerializer[NetworkModelProjectComponent2]
- object NetworkModelProjectComponentSerializer extends CIMSerializer[NetworkModelProjectComponent]
- object NetworkModelProjectDocument extends CIMParseable[NetworkModelProjectDocument] with Serializable
- object NetworkModelProjectDocumentSerializer extends CIMSerializer[NetworkModelProjectDocument]
- object NetworkModelProjectRelationship extends CIMParseable[NetworkModelProjectRelationship] with Serializable
- object NetworkModelProjectRelationshipSerializer extends CIMSerializer[NetworkModelProjectRelationship]
- object NetworkModelProjectSerializer extends CIMSerializer[NetworkModelProject]
- object NetworkModelProjectStage extends CIMParseable[NetworkModelProjectStage] with Serializable
- object NetworkModelProjectStageSerializer extends CIMSerializer[NetworkModelProjectStage]
- object NetworkModelProjectState extends CIMParseable[NetworkModelProjectState] with Serializable
- object NetworkModelProjectStateSerializer extends CIMSerializer[NetworkModelProjectState]
- object NoLoadTest extends CIMParseable[NoLoadTest] with Serializable
- object NoLoadTestSerializer extends CIMSerializer[NoLoadTest]
- object NodeConstraintTerm extends CIMParseable[NodeConstraintTerm] with Serializable
- object NodeConstraintTermSerializer extends CIMSerializer[NodeConstraintTerm]
- object NonConformLoad extends CIMParseable[NonConformLoad] with Serializable
- object NonConformLoadGroup extends CIMParseable[NonConformLoadGroup] with Serializable
- object NonConformLoadGroupSerializer extends CIMSerializer[NonConformLoadGroup]
- object NonConformLoadSchedule extends CIMParseable[NonConformLoadSchedule] with Serializable
- object NonConformLoadScheduleSerializer extends CIMSerializer[NonConformLoadSchedule]
- object NonConformLoadSerializer extends CIMSerializer[NonConformLoad]
- object NonStandardItem extends CIMParseable[NonStandardItem] with Serializable
- object NonStandardItemSerializer extends CIMSerializer[NonStandardItem]
- object NonlinearShuntCompensator extends CIMParseable[NonlinearShuntCompensator] with Serializable
- object NonlinearShuntCompensatorPhase extends CIMParseable[NonlinearShuntCompensatorPhase] with Serializable
- object NonlinearShuntCompensatorPhasePoint extends CIMParseable[NonlinearShuntCompensatorPhasePoint] with Serializable
- object NonlinearShuntCompensatorPhasePointSerializer extends CIMSerializer[NonlinearShuntCompensatorPhasePoint]
- object NonlinearShuntCompensatorPhaseSerializer extends CIMSerializer[NonlinearShuntCompensatorPhase]
- object NonlinearShuntCompensatorPoint extends CIMParseable[NonlinearShuntCompensatorPoint] with Serializable
- object NonlinearShuntCompensatorPointSerializer extends CIMSerializer[NonlinearShuntCompensatorPoint]
- object NonlinearShuntCompensatorSerializer extends CIMSerializer[NonlinearShuntCompensator]
- object NotificationTimeCurve extends CIMParseable[NotificationTimeCurve] with Serializable
- object NotificationTimeCurveSerializer extends CIMSerializer[NotificationTimeCurve]
- object NuclearGeneratingUnit extends CIMParseable[NuclearGeneratingUnit] with Serializable
- object NuclearGeneratingUnitSerializer extends CIMSerializer[NuclearGeneratingUnit]
- object ObjectCreation extends CIMParseable[ObjectCreation] with Serializable
- object ObjectCreationSerializer extends CIMSerializer[ObjectCreation]
- object ObjectDeletion extends CIMParseable[ObjectDeletion] with Serializable
- object ObjectDeletionSerializer extends CIMSerializer[ObjectDeletion]
- object ObjectModification extends CIMParseable[ObjectModification] with Serializable
- object ObjectModificationSerializer extends CIMSerializer[ObjectModification]
- object ObjectReverseModification extends CIMParseable[ObjectReverseModification] with Serializable
- object ObjectReverseModificationSerializer extends CIMSerializer[ObjectReverseModification]
- object Observation extends CIMParseable[Observation] with Serializable
- object ObservationSerializer extends CIMSerializer[Observation]
- object OilAnalysisFluidAnalog extends CIMParseable[OilAnalysisFluidAnalog] with Serializable
- object OilAnalysisFluidAnalogSerializer extends CIMSerializer[OilAnalysisFluidAnalog]
- object OilAnalysisFluidDiscrete extends CIMParseable[OilAnalysisFluidDiscrete] with Serializable
- object OilAnalysisFluidDiscreteSerializer extends CIMSerializer[OilAnalysisFluidDiscrete]
- object OilAnalysisGasAnalog extends CIMParseable[OilAnalysisGasAnalog] with Serializable
- object OilAnalysisGasAnalogSerializer extends CIMSerializer[OilAnalysisGasAnalog]
- object OilAnalysisMetalsAnalog extends CIMParseable[OilAnalysisMetalsAnalog] with Serializable
- object OilAnalysisMetalsAnalogSerializer extends CIMSerializer[OilAnalysisMetalsAnalog]
- object OilAnalysisMoistureAnalog extends CIMParseable[OilAnalysisMoistureAnalog] with Serializable
- object OilAnalysisMoistureAnalogSerializer extends CIMSerializer[OilAnalysisMoistureAnalog]
- object OilAnalysisPCBAnalog extends CIMParseable[OilAnalysisPCBAnalog] with Serializable
- object OilAnalysisPCBAnalogSerializer extends CIMSerializer[OilAnalysisPCBAnalog]
- object OilAnalysisPCBDiscrete extends CIMParseable[OilAnalysisPCBDiscrete] with Serializable
- object OilAnalysisPCBDiscreteSerializer extends CIMSerializer[OilAnalysisPCBDiscrete]
- object OilAnalysisPaperAnalog extends CIMParseable[OilAnalysisPaperAnalog] with Serializable
- object OilAnalysisPaperAnalogSerializer extends CIMSerializer[OilAnalysisPaperAnalog]
- object OilAnalysisParticleAnalog extends CIMParseable[OilAnalysisParticleAnalog] with Serializable
- object OilAnalysisParticleAnalogSerializer extends CIMSerializer[OilAnalysisParticleAnalog]
- object OilAnalysisParticleDiscrete extends CIMParseable[OilAnalysisParticleDiscrete] with Serializable
- object OilAnalysisParticleDiscreteSerializer extends CIMSerializer[OilAnalysisParticleDiscrete]
- object OilPrice extends CIMParseable[OilPrice] with Serializable
- object OilPriceSerializer extends CIMSerializer[OilPrice]
- object OilSpecimen extends CIMParseable[OilSpecimen] with Serializable
- object OilSpecimenSerializer extends CIMSerializer[OilSpecimen]
- object OldCrew extends CIMParseable[OldCrew] with Serializable
- object OldCrewSerializer extends CIMSerializer[OldCrew]
- object OldPerson extends CIMParseable[OldPerson] with Serializable
- object OldPersonSerializer extends CIMSerializer[OldPerson]
- object OldSwitchInfo extends CIMParseable[OldSwitchInfo] with Serializable
- object OldSwitchInfoSerializer extends CIMSerializer[OldSwitchInfo]
- object OldTransformerEndInfo extends CIMParseable[OldTransformerEndInfo] with Serializable
- object OldTransformerEndInfoSerializer extends CIMSerializer[OldTransformerEndInfo]
- object OldTransformerTankInfo extends CIMParseable[OldTransformerTankInfo] with Serializable
- object OldTransformerTankInfoSerializer extends CIMSerializer[OldTransformerTankInfo]
- object OldWorkTask extends CIMParseable[OldWorkTask] with Serializable
- object OldWorkTaskSerializer extends CIMSerializer[OldWorkTask]
- object OneCallRequest extends CIMParseable[OneCallRequest] with Serializable
- object OneCallRequestSerializer extends CIMSerializer[OneCallRequest]
- object OpenAccessProduct extends CIMParseable[OpenAccessProduct] with Serializable
- object OpenAccessProductSerializer extends CIMSerializer[OpenAccessProduct]
- object OpenCircuitTest extends CIMParseable[OpenCircuitTest] with Serializable
- object OpenCircuitTestSerializer extends CIMSerializer[OpenCircuitTest]
- object OpenTieSchedule extends CIMParseable[OpenTieSchedule] with Serializable
- object OpenTieScheduleSerializer extends CIMSerializer[OpenTieSchedule]
- object OperatingMechanism extends CIMParseable[OperatingMechanism] with Serializable
- object OperatingMechanismInfo extends CIMParseable[OperatingMechanismInfo] with Serializable
- object OperatingMechanismInfoSerializer extends CIMSerializer[OperatingMechanismInfo]
- object OperatingMechanismSerializer extends CIMSerializer[OperatingMechanism]
- object OperatingParticipant extends CIMParseable[OperatingParticipant] with Serializable
- object OperatingParticipantSerializer extends CIMSerializer[OperatingParticipant]
- object OperatingShare extends CIMParseable[OperatingShare] with Serializable
- object OperatingShareSerializer extends CIMSerializer[OperatingShare]
- object Operation extends CIMParseable[Operation] with Serializable
- object OperationPersonRole extends CIMParseable[OperationPersonRole] with Serializable
- object OperationPersonRoleSerializer extends CIMSerializer[OperationPersonRole]
- object OperationSerializer extends CIMSerializer[Operation]
- object OperationalLimit extends CIMParseable[OperationalLimit] with Serializable
- object OperationalLimitSerializer extends CIMSerializer[OperationalLimit]
- object OperationalLimitSet extends CIMParseable[OperationalLimitSet] with Serializable
- object OperationalLimitSetSerializer extends CIMSerializer[OperationalLimitSet]
- object OperationalLimitType extends CIMParseable[OperationalLimitType] with Serializable
- object OperationalLimitTypeSerializer extends CIMSerializer[OperationalLimitType]
- object OperationalRestriction extends CIMParseable[OperationalRestriction] with Serializable
- object OperationalRestrictionSerializer extends CIMSerializer[OperationalRestriction]
- object OperationalTag extends CIMParseable[OperationalTag] with Serializable
- object OperationalTagSerializer extends CIMSerializer[OperationalTag]
- object OperationalUpdatedRating extends CIMParseable[OperationalUpdatedRating] with Serializable
- object OperationalUpdatedRatingSerializer extends CIMSerializer[OperationalUpdatedRating]
- object OperationsSafetySupervisor extends CIMParseable[OperationsSafetySupervisor] with Serializable
- object OperationsSafetySupervisorSerializer extends CIMSerializer[OperationsSafetySupervisor]
- object OperatonalLimitTypeScaling extends CIMParseable[OperatonalLimitTypeScaling] with Serializable
- object OperatonalLimitTypeScalingSerializer extends CIMSerializer[OperatonalLimitTypeScaling]
- object Operator extends CIMParseable[Operator] with Serializable
- object OperatorSerializer extends CIMSerializer[Operator]
- object OrgOrgRole extends CIMParseable[OrgOrgRole] with Serializable
- object OrgOrgRoleSerializer extends CIMSerializer[OrgOrgRole]
- object OrgPnodeAllocation extends CIMParseable[OrgPnodeAllocation] with Serializable
- object OrgPnodeAllocationSerializer extends CIMSerializer[OrgPnodeAllocation]
- object OrgResOwnership extends CIMParseable[OrgResOwnership] with Serializable
- object OrgResOwnershipSerializer extends CIMSerializer[OrgResOwnership]
- object Organisation extends CIMParseable[Organisation] with Serializable
- object OrganisationRole extends CIMParseable[OrganisationRole] with Serializable
- object OrganisationRoleSerializer extends CIMSerializer[OrganisationRole]
- object OrganisationSerializer extends CIMSerializer[Organisation]
- object Outage extends CIMParseable[Outage] with Serializable
- object OutageArea extends CIMParseable[OutageArea] with Serializable
- object OutageAreaSerializer extends CIMSerializer[OutageArea]
- object OutageOrder extends CIMParseable[OutageOrder] with Serializable
- object OutageOrderSerializer extends CIMSerializer[OutageOrder]
- object OutagePlan extends CIMParseable[OutagePlan] with Serializable
- object OutagePlanSerializer extends CIMSerializer[OutagePlan]
- object OutageSerializer extends CIMSerializer[Outage]
- object OverexcLim2 extends CIMParseable[OverexcLim2] with Serializable
- object OverexcLim2Serializer extends CIMSerializer[OverexcLim2]
- object OverexcLimIEEE extends CIMParseable[OverexcLimIEEE] with Serializable
- object OverexcLimIEEESerializer extends CIMSerializer[OverexcLimIEEE]
- object OverexcLimX1 extends CIMParseable[OverexcLimX1] with Serializable
- object OverexcLimX1Serializer extends CIMSerializer[OverexcLimX1]
- object OverexcLimX2 extends CIMParseable[OverexcLimX2] with Serializable
- object OverexcLimX2Serializer extends CIMSerializer[OverexcLimX2]
- object OverexcitationLimiterDynamics extends CIMParseable[OverexcitationLimiterDynamics] with Serializable
- object OverexcitationLimiterDynamicsSerializer extends CIMSerializer[OverexcitationLimiterDynamics]
- object OverexcitationLimiterUserDefined extends CIMParseable[OverexcitationLimiterUserDefined] with Serializable
- object OverexcitationLimiterUserDefinedSerializer extends CIMSerializer[OverexcitationLimiterUserDefined]
- object OverheadCost extends CIMParseable[OverheadCost] with Serializable
- object OverheadCostSerializer extends CIMSerializer[OverheadCost]
- object OverheadWireInfo extends CIMParseable[OverheadWireInfo] with Serializable
- object OverheadWireInfoSerializer extends CIMSerializer[OverheadWireInfo]
- object Ownership extends CIMParseable[Ownership] with Serializable
- object OwnershipSerializer extends CIMSerializer[Ownership]
- object PFVArControllerType1Dynamics extends CIMParseable[PFVArControllerType1Dynamics] with Serializable
- object PFVArControllerType1DynamicsSerializer extends CIMSerializer[PFVArControllerType1Dynamics]
- object PFVArControllerType1UserDefined extends CIMParseable[PFVArControllerType1UserDefined] with Serializable
- object PFVArControllerType1UserDefinedSerializer extends CIMSerializer[PFVArControllerType1UserDefined]
- object PFVArControllerType2Dynamics extends CIMParseable[PFVArControllerType2Dynamics] with Serializable
- object PFVArControllerType2DynamicsSerializer extends CIMSerializer[PFVArControllerType2Dynamics]
- object PFVArControllerType2UserDefined extends CIMParseable[PFVArControllerType2UserDefined] with Serializable
- object PFVArControllerType2UserDefinedSerializer extends CIMSerializer[PFVArControllerType2UserDefined]
- object PFVArType1IEEEPFController extends CIMParseable[PFVArType1IEEEPFController] with Serializable
- object PFVArType1IEEEPFControllerSerializer extends CIMSerializer[PFVArType1IEEEPFController]
- object PFVArType1IEEEVArController extends CIMParseable[PFVArType1IEEEVArController] with Serializable
- object PFVArType1IEEEVArControllerSerializer extends CIMSerializer[PFVArType1IEEEVArController]
- object PFVArType2Common1 extends CIMParseable[PFVArType2Common1] with Serializable
- object PFVArType2Common1Serializer extends CIMSerializer[PFVArType2Common1]
- object PFVArType2IEEEPFController extends CIMParseable[PFVArType2IEEEPFController] with Serializable
- object PFVArType2IEEEPFControllerSerializer extends CIMSerializer[PFVArType2IEEEPFController]
- object PFVArType2IEEEVArController extends CIMParseable[PFVArType2IEEEVArController] with Serializable
- object PFVArType2IEEEVArControllerSerializer extends CIMSerializer[PFVArType2IEEEVArController]
- object PFmode extends CIMParseable[PFmode] with Serializable
- object PFmodeSerializer extends CIMSerializer[PFmode]
- object PSREvent extends CIMParseable[PSREvent] with Serializable
- object PSREventSerializer extends CIMSerializer[PSREvent]
- object PSRType extends CIMParseable[PSRType] with Serializable
- object PSRTypeSerializer extends CIMSerializer[PSRType]
- object PWRSteamSupply extends CIMParseable[PWRSteamSupply] with Serializable
- object PWRSteamSupplySerializer extends CIMSerializer[PWRSteamSupply]
- object PackageDependenciesCIMVersion extends CIMParseable[PackageDependenciesCIMVersion] with Serializable
- object PackageDependenciesCIMVersionSerializer extends CIMSerializer[PackageDependenciesCIMVersion]
- object PanDemandResponse extends CIMParseable[PanDemandResponse] with Serializable
- object PanDemandResponseSerializer extends CIMSerializer[PanDemandResponse]
- object PanDisplay extends CIMParseable[PanDisplay] with Serializable
- object PanDisplaySerializer extends CIMSerializer[PanDisplay]
- object PanPricing extends CIMParseable[PanPricing] with Serializable
- object PanPricingDetail extends CIMParseable[PanPricingDetail] with Serializable
- object PanPricingDetailSerializer extends CIMSerializer[PanPricingDetail]
- object PanPricingSerializer extends CIMSerializer[PanPricing]
- object ParentOrganization extends CIMParseable[ParentOrganization] with Serializable
- object ParentOrganizationSerializer extends CIMSerializer[ParentOrganization]
- object Participation extends CIMParseable[Participation] with Serializable
- object ParticipationSerializer extends CIMSerializer[Participation]
- object PassThroughBill extends CIMParseable[PassThroughBill] with Serializable
- object PassThroughBillSerializer extends CIMSerializer[PassThroughBill]
- object Pcontrol extends CIMParseable[Pcontrol] with Serializable
- object PcontrolSerializer extends CIMSerializer[Pcontrol]
- object PendingCalculation extends CIMParseable[PendingCalculation] with Serializable
- object PendingCalculationSerializer extends CIMSerializer[PendingCalculation]
- object PenstockLossCurve extends CIMParseable[PenstockLossCurve] with Serializable
- object PenstockLossCurveSerializer extends CIMSerializer[PenstockLossCurve]
- object PerLengthDCLineParameter extends CIMParseable[PerLengthDCLineParameter] with Serializable
- object PerLengthDCLineParameterSerializer extends CIMSerializer[PerLengthDCLineParameter]
- object PerLengthImpedance extends CIMParseable[PerLengthImpedance] with Serializable
- object PerLengthImpedanceSerializer extends CIMSerializer[PerLengthImpedance]
- object PerLengthLineParameter extends CIMParseable[PerLengthLineParameter] with Serializable
- object PerLengthLineParameterSerializer extends CIMSerializer[PerLengthLineParameter]
- object PerLengthPhaseImpedance extends CIMParseable[PerLengthPhaseImpedance] with Serializable
- object PerLengthPhaseImpedanceSerializer extends CIMSerializer[PerLengthPhaseImpedance]
- object PerLengthSequenceImpedance extends CIMParseable[PerLengthSequenceImpedance] with Serializable
- object PerLengthSequenceImpedanceSerializer extends CIMSerializer[PerLengthSequenceImpedance]
- object Period extends CIMParseable[Period] with Serializable
- object PeriodSerializer extends CIMSerializer[Period]
- object PeriodicStatisticalCalculation extends CIMParseable[PeriodicStatisticalCalculation] with Serializable
- object PeriodicStatisticalCalculationSerializer extends CIMSerializer[PeriodicStatisticalCalculation]
- object Person extends CIMParseable[Person] with Serializable
- object PersonOrganisationRole extends CIMParseable[PersonOrganisationRole] with Serializable
- object PersonOrganisationRoleSerializer extends CIMSerializer[PersonOrganisationRole]
- object PersonPropertyRole extends CIMParseable[PersonPropertyRole] with Serializable
- object PersonPropertyRoleSerializer extends CIMSerializer[PersonPropertyRole]
- object PersonRole extends CIMParseable[PersonRole] with Serializable
- object PersonRoleSerializer extends CIMSerializer[PersonRole]
- object PersonSerializer extends CIMSerializer[Person]
- object PetersenCoil extends CIMParseable[PetersenCoil] with Serializable
- object PetersenCoilSerializer extends CIMSerializer[PetersenCoil]
- object PhaseImpedanceData extends CIMParseable[PhaseImpedanceData] with Serializable
- object PhaseImpedanceDataSerializer extends CIMSerializer[PhaseImpedanceData]
- object PhaseTapChanger extends CIMParseable[PhaseTapChanger] with Serializable
- object PhaseTapChangerAsymmetrical extends CIMParseable[PhaseTapChangerAsymmetrical] with Serializable
- object PhaseTapChangerAsymmetricalSerializer extends CIMSerializer[PhaseTapChangerAsymmetrical]
- object PhaseTapChangerLinear extends CIMParseable[PhaseTapChangerLinear] with Serializable
- object PhaseTapChangerLinearSerializer extends CIMSerializer[PhaseTapChangerLinear]
- object PhaseTapChangerNonLinear extends CIMParseable[PhaseTapChangerNonLinear] with Serializable
- object PhaseTapChangerNonLinearSerializer extends CIMSerializer[PhaseTapChangerNonLinear]
- object PhaseTapChangerSerializer extends CIMSerializer[PhaseTapChanger]
- object PhaseTapChangerSymmetrical extends CIMParseable[PhaseTapChangerSymmetrical] with Serializable
- object PhaseTapChangerSymmetricalSerializer extends CIMSerializer[PhaseTapChangerSymmetrical]
- object PhaseTapChangerTable extends CIMParseable[PhaseTapChangerTable] with Serializable
- object PhaseTapChangerTablePoint extends CIMParseable[PhaseTapChangerTablePoint] with Serializable
- object PhaseTapChangerTablePointSerializer extends CIMSerializer[PhaseTapChangerTablePoint]
- object PhaseTapChangerTableSerializer extends CIMSerializer[PhaseTapChangerTable]
- object PhaseTapChangerTabular extends CIMParseable[PhaseTapChangerTabular] with Serializable
- object PhaseTapChangerTabularSerializer extends CIMSerializer[PhaseTapChangerTabular]
- object PhenomenonClassification extends CIMParseable[PhenomenonClassification] with Serializable
- object PhenomenonClassificationSerializer extends CIMSerializer[PhenomenonClassification]
- object PhotoVoltaicUnit extends CIMParseable[PhotoVoltaicUnit] with Serializable
- object PhotoVoltaicUnitSerializer extends CIMSerializer[PhotoVoltaicUnit]
- object PinBranchGroup extends CIMParseable[PinBranchGroup] with Serializable
- object PinBranchGroupSerializer extends CIMSerializer[PinBranchGroup]
- object PinEquipment extends CIMParseable[PinEquipment] with Serializable
- object PinEquipmentSerializer extends CIMSerializer[PinEquipment]
- object PinGate extends CIMParseable[PinGate] with Serializable
- object PinGateSerializer extends CIMSerializer[PinGate]
- object PinMeasurement extends CIMParseable[PinMeasurement] with Serializable
- object PinMeasurementSerializer extends CIMSerializer[PinMeasurement]
- object PinTerminal extends CIMParseable[PinTerminal] with Serializable
- object PinTerminalSerializer extends CIMSerializer[PinTerminal]
- object PlannedMarket extends CIMParseable[PlannedMarket] with Serializable
- object PlannedMarketEvent extends CIMParseable[PlannedMarketEvent] with Serializable
- object PlannedMarketEventSerializer extends CIMSerializer[PlannedMarketEvent]
- object PlannedMarketSerializer extends CIMSerializer[PlannedMarket]
- object PlannedOutage extends CIMParseable[PlannedOutage] with Serializable
- object PlannedOutageNotification extends CIMParseable[PlannedOutageNotification] with Serializable
- object PlannedOutageNotificationSerializer extends CIMSerializer[PlannedOutageNotification]
- object PlannedOutageSerializer extends CIMSerializer[PlannedOutage]
- object Plant extends CIMParseable[Plant] with Serializable
- object PlantSerializer extends CIMSerializer[Plant]
- object Pnode extends CIMParseable[Pnode] with Serializable
- object PnodeClearing extends CIMParseable[PnodeClearing] with Serializable
- object PnodeClearingSerializer extends CIMSerializer[PnodeClearing]
- object PnodeDistributionFactor extends CIMParseable[PnodeDistributionFactor] with Serializable
- object PnodeDistributionFactorSerializer extends CIMSerializer[PnodeDistributionFactor]
- object PnodeResults extends CIMParseable[PnodeResults] with Serializable
- object PnodeResultsSerializer extends CIMSerializer[PnodeResults]
- object PnodeSerializer extends CIMSerializer[Pnode]
- object Point extends CIMParseable[Point] with Serializable
- object PointOfSale extends CIMParseable[PointOfSale] with Serializable
- object PointOfSaleSerializer extends CIMSerializer[PointOfSale]
- object PointSerializer extends CIMSerializer[Point]
- object Pole extends CIMParseable[Pole] with Serializable
- object PoleSerializer extends CIMSerializer[Pole]
- object PositionPoint extends CIMParseable[PositionPoint] with Serializable
- object PositionPointSerializer extends CIMSerializer[PositionPoint]
- object PostLineSensor extends CIMParseable[PostLineSensor] with Serializable
- object PostLineSensorSerializer extends CIMSerializer[PostLineSensor]
- object PotentialTransformer extends CIMParseable[PotentialTransformer] with Serializable
- object PotentialTransformerInfo extends CIMParseable[PotentialTransformerInfo] with Serializable
- object PotentialTransformerInfoSerializer extends CIMSerializer[PotentialTransformerInfo]
- object PotentialTransformerSerializer extends CIMSerializer[PotentialTransformer]
- object PowerCutZone extends CIMParseable[PowerCutZone] with Serializable
- object PowerCutZoneSerializer extends CIMSerializer[PowerCutZone]
- object PowerElectronicsConnection extends CIMParseable[PowerElectronicsConnection] with Serializable
- object PowerElectronicsConnectionPhase extends CIMParseable[PowerElectronicsConnectionPhase] with Serializable
- object PowerElectronicsConnectionPhaseSerializer extends CIMSerializer[PowerElectronicsConnectionPhase]
- object PowerElectronicsConnectionSerializer extends CIMSerializer[PowerElectronicsConnection]
- object PowerElectronicsUnit extends CIMParseable[PowerElectronicsUnit] with Serializable
- object PowerElectronicsUnitSerializer extends CIMSerializer[PowerElectronicsUnit]
- object PowerElectronicsWindUnit extends CIMParseable[PowerElectronicsWindUnit] with Serializable
- object PowerElectronicsWindUnitSerializer extends CIMSerializer[PowerElectronicsWindUnit]
- object PowerQualityPricing extends CIMParseable[PowerQualityPricing] with Serializable
- object PowerQualityPricingSerializer extends CIMSerializer[PowerQualityPricing]
- object PowerSystemProjectLifecycleToBeDeleted extends CIMParseable[PowerSystemProjectLifecycleToBeDeleted] with Serializable
- object PowerSystemProjectLifecycleToBeDeletedSerializer extends CIMSerializer[PowerSystemProjectLifecycleToBeDeleted]
- object PowerSystemResource extends CIMParseable[PowerSystemResource] with Serializable
- object PowerSystemResourceSerializer extends CIMSerializer[PowerSystemResource]
- object PowerSystemStabilizerDynamics extends CIMParseable[PowerSystemStabilizerDynamics] with Serializable
- object PowerSystemStabilizerDynamicsSerializer extends CIMSerializer[PowerSystemStabilizerDynamics]
- object PowerSystemStabilizerUserDefined extends CIMParseable[PowerSystemStabilizerUserDefined] with Serializable
- object PowerSystemStabilizerUserDefinedSerializer extends CIMSerializer[PowerSystemStabilizerUserDefined]
- object PowerTransformer extends CIMParseable[PowerTransformer] with Serializable
- object PowerTransformerEnd extends CIMParseable[PowerTransformerEnd] with Serializable
- object PowerTransformerEndSerializer extends CIMSerializer[PowerTransformerEnd]
- object PowerTransformerInfo extends CIMParseable[PowerTransformerInfo] with Serializable
- object PowerTransformerInfoSerializer extends CIMSerializer[PowerTransformerInfo]
- object PowerTransformerSerializer extends CIMSerializer[PowerTransformer]
- object Price extends CIMParseable[Price] with Serializable
- object PriceDescriptor extends CIMParseable[PriceDescriptor] with Serializable
- object PriceDescriptorSerializer extends CIMSerializer[PriceDescriptor]
- object PriceSerializer extends CIMSerializer[Price]
- object PricingStructure extends CIMParseable[PricingStructure] with Serializable
- object PricingStructureSerializer extends CIMSerializer[PricingStructure]
- object PrimeMover extends CIMParseable[PrimeMover] with Serializable
- object PrimeMoverSerializer extends CIMSerializer[PrimeMover]
- object Priority extends CIMParseable[Priority] with Serializable
- object PrioritySerializer extends CIMSerializer[Priority]
- object Procedure extends CIMParseable[Procedure] with Serializable
- object ProcedureDataSet extends CIMParseable[ProcedureDataSet] with Serializable
- object ProcedureDataSetSerializer extends CIMSerializer[ProcedureDataSet]
- object ProcedureSerializer extends CIMSerializer[Procedure]
- object Process extends CIMParseable[Process] with Serializable
- object ProcessSerializer extends CIMSerializer[Process]
- object ProductAssetModel extends CIMParseable[ProductAssetModel] with Serializable
- object ProductAssetModelSerializer extends CIMSerializer[ProductAssetModel]
- object ProductBid extends CIMParseable[ProductBid] with Serializable
- object ProductBidSerializer extends CIMSerializer[ProductBid]
- object Profile extends CIMParseable[Profile] with Serializable
- object Profile2 extends CIMParseable[Profile2] with Serializable
- object Profile2Serializer extends CIMSerializer[Profile2]
- object ProfileData extends CIMParseable[ProfileData] with Serializable
- object ProfileDataSerializer extends CIMSerializer[ProfileData]
- object ProfileSerializer extends CIMSerializer[Profile]
- object Project extends CIMParseable[Project] with Serializable
- object ProjectAlternative extends CIMParseable[ProjectAlternative] with Serializable
- object ProjectAlternativeSerializer extends CIMSerializer[ProjectAlternative]
- object ProjectDependency extends CIMParseable[ProjectDependency] with Serializable
- object ProjectDependencySerializer extends CIMSerializer[ProjectDependency]
- object ProjectSerializer extends CIMSerializer[Project]
- object PropertyOrganisationRole extends CIMParseable[PropertyOrganisationRole] with Serializable
- object PropertyOrganisationRoleSerializer extends CIMSerializer[PropertyOrganisationRole]
- object PropertyUnit extends CIMParseable[PropertyUnit] with Serializable
- object PropertyUnitSerializer extends CIMSerializer[PropertyUnit]
- object ProportionalDistributionComponent extends CIMParseable[ProportionalDistributionComponent] with Serializable
- object ProportionalDistributionComponentSerializer extends CIMSerializer[ProportionalDistributionComponent]
- object ProprietaryParameterDynamics extends CIMParseable[ProprietaryParameterDynamics] with Serializable
- object ProprietaryParameterDynamicsSerializer extends CIMSerializer[ProprietaryParameterDynamics]
- object ProtectedSwitch extends CIMParseable[ProtectedSwitch] with Serializable
- object ProtectedSwitchSerializer extends CIMSerializer[ProtectedSwitch]
- object ProtectionEquipment extends CIMParseable[ProtectionEquipment] with Serializable
- object ProtectionEquipmentInfo extends CIMParseable[ProtectionEquipmentInfo] with Serializable
- object ProtectionEquipmentInfoSerializer extends CIMSerializer[ProtectionEquipmentInfo]
- object ProtectionEquipmentSerializer extends CIMSerializer[ProtectionEquipment]
- object ProtectiveAction extends CIMParseable[ProtectiveAction] with Serializable
- object ProtectiveActionAdjustment extends CIMParseable[ProtectiveActionAdjustment] with Serializable
- object ProtectiveActionAdjustmentSerializer extends CIMSerializer[ProtectiveActionAdjustment]
- object ProtectiveActionCollection extends CIMParseable[ProtectiveActionCollection] with Serializable
- object ProtectiveActionCollectionSerializer extends CIMSerializer[ProtectiveActionCollection]
- object ProtectiveActionEquipment extends CIMParseable[ProtectiveActionEquipment] with Serializable
- object ProtectiveActionEquipmentSerializer extends CIMSerializer[ProtectiveActionEquipment]
- object ProtectiveActionRegulation extends CIMParseable[ProtectiveActionRegulation] with Serializable
- object ProtectiveActionRegulationSerializer extends CIMSerializer[ProtectiveActionRegulation]
- object ProtectiveActionSerializer extends CIMSerializer[ProtectiveAction]
- object ProvidedBilateralPoint extends CIMParseable[ProvidedBilateralPoint] with Serializable
- object ProvidedBilateralPointSerializer extends CIMSerializer[ProvidedBilateralPoint]
- object Pss1 extends CIMParseable[Pss1] with Serializable
- object Pss1A extends CIMParseable[Pss1A] with Serializable
- object Pss1ASerializer extends CIMSerializer[Pss1A]
- object Pss1Serializer extends CIMSerializer[Pss1]
- object Pss2B extends CIMParseable[Pss2B] with Serializable
- object Pss2BSerializer extends CIMSerializer[Pss2B]
- object Pss2ST extends CIMParseable[Pss2ST] with Serializable
- object Pss2STSerializer extends CIMSerializer[Pss2ST]
- object Pss5 extends CIMParseable[Pss5] with Serializable
- object Pss5Serializer extends CIMSerializer[Pss5]
- object PssELIN2 extends CIMParseable[PssELIN2] with Serializable
- object PssELIN2Serializer extends CIMSerializer[PssELIN2]
- object PssIEEE1A extends CIMParseable[PssIEEE1A] with Serializable
- object PssIEEE1ASerializer extends CIMSerializer[PssIEEE1A]
- object PssIEEE2B extends CIMParseable[PssIEEE2B] with Serializable
- object PssIEEE2BSerializer extends CIMSerializer[PssIEEE2B]
- object PssIEEE3B extends CIMParseable[PssIEEE3B] with Serializable
- object PssIEEE3BSerializer extends CIMSerializer[PssIEEE3B]
- object PssIEEE4B extends CIMParseable[PssIEEE4B] with Serializable
- object PssIEEE4BSerializer extends CIMSerializer[PssIEEE4B]
- object PssPTIST1 extends CIMParseable[PssPTIST1] with Serializable
- object PssPTIST1Serializer extends CIMSerializer[PssPTIST1]
- object PssPTIST3 extends CIMParseable[PssPTIST3] with Serializable
- object PssPTIST3Serializer extends CIMSerializer[PssPTIST3]
- object PssRQB extends CIMParseable[PssRQB] with Serializable
- object PssRQBSerializer extends CIMSerializer[PssRQB]
- object PssSB4 extends CIMParseable[PssSB4] with Serializable
- object PssSB4Serializer extends CIMSerializer[PssSB4]
- object PssSH extends CIMParseable[PssSH] with Serializable
- object PssSHSerializer extends CIMSerializer[PssSH]
- object PssSK extends CIMParseable[PssSK] with Serializable
- object PssSKSerializer extends CIMSerializer[PssSK]
- object PssSTAB2A extends CIMParseable[PssSTAB2A] with Serializable
- object PssSTAB2ASerializer extends CIMSerializer[PssSTAB2A]
- object PssWECC extends CIMParseable[PssWECC] with Serializable
- object PssWECCSerializer extends CIMSerializer[PssWECC]
- object PublicX509Certificate extends CIMParseable[PublicX509Certificate] with Serializable
- object PublicX509CertificateSerializer extends CIMSerializer[PublicX509Certificate]
- object PumpingCostSchedule extends CIMParseable[PumpingCostSchedule] with Serializable
- object PumpingCostScheduleSerializer extends CIMSerializer[PumpingCostSchedule]
- object PumpingLevelSchedule extends CIMParseable[PumpingLevelSchedule] with Serializable
- object PumpingLevelScheduleSerializer extends CIMSerializer[PumpingLevelSchedule]
- object PumpingShutDownCostSchedule extends CIMParseable[PumpingShutDownCostSchedule] with Serializable
- object PumpingShutDownCostScheduleSerializer extends CIMSerializer[PumpingShutDownCostSchedule]
- object Qlimiter extends CIMParseable[Qlimiter] with Serializable
- object QlimiterSerializer extends CIMSerializer[Qlimiter]
- object Qmode extends CIMParseable[Qmode] with Serializable
- object QmodeSerializer extends CIMSerializer[Qmode]
- object Qregulator extends CIMParseable[Qregulator] with Serializable
- object QregulatorSerializer extends CIMSerializer[Qregulator]
- object QualificationRequirement extends CIMParseable[QualificationRequirement] with Serializable
- object QualificationRequirementSerializer extends CIMSerializer[QualificationRequirement]
- object Quality61850 extends CIMParseable[Quality61850] with Serializable
- object Quality61850Serializer extends CIMSerializer[Quality61850]
- object Quantity extends CIMParseable[Quantity] with Serializable
- object QuantitySerializer extends CIMSerializer[Quantity]
- object RMRDetermination extends CIMParseable[RMRDetermination] with Serializable
- object RMRDeterminationSerializer extends CIMSerializer[RMRDetermination]
- object RMRHeatRateCurve extends CIMParseable[RMRHeatRateCurve] with Serializable
- object RMRHeatRateCurveSerializer extends CIMSerializer[RMRHeatRateCurve]
- object RMROperatorInput extends CIMParseable[RMROperatorInput] with Serializable
- object RMROperatorInputSerializer extends CIMSerializer[RMROperatorInput]
- object RMRStartUpCostCurve extends CIMParseable[RMRStartUpCostCurve] with Serializable
- object RMRStartUpCostCurveSerializer extends CIMSerializer[RMRStartUpCostCurve]
- object RMRStartUpEnergyCurve extends CIMParseable[RMRStartUpEnergyCurve] with Serializable
- object RMRStartUpEnergyCurveSerializer extends CIMSerializer[RMRStartUpEnergyCurve]
- object RMRStartUpFuelCurve extends CIMParseable[RMRStartUpFuelCurve] with Serializable
- object RMRStartUpFuelCurveSerializer extends CIMSerializer[RMRStartUpFuelCurve]
- object RMRStartUpTimeCurve extends CIMParseable[RMRStartUpTimeCurve] with Serializable
- object RMRStartUpTimeCurveSerializer extends CIMSerializer[RMRStartUpTimeCurve]
- object RTO extends CIMParseable[RTO] with Serializable
- object RTOSerializer extends CIMSerializer[RTO]
- object RUCAwardInstruction extends CIMParseable[RUCAwardInstruction] with Serializable
- object RUCAwardInstructionSerializer extends CIMSerializer[RUCAwardInstruction]
- object RUCZone extends CIMParseable[RUCZone] with Serializable
- object RUCZoneSerializer extends CIMSerializer[RUCZone]
- object RaiseLowerCommand extends CIMParseable[RaiseLowerCommand] with Serializable
- object RaiseLowerCommandSerializer extends CIMSerializer[RaiseLowerCommand]
- object RampRateCurve extends CIMParseable[RampRateCurve] with Serializable
- object RampRateCurveSerializer extends CIMSerializer[RampRateCurve]
- object Ratio extends CIMParseable[Ratio] with Serializable
- object RatioSerializer extends CIMSerializer[Ratio]
- object RatioTapChanger extends CIMParseable[RatioTapChanger] with Serializable
- object RatioTapChangerSerializer extends CIMSerializer[RatioTapChanger]
- object RatioTapChangerTable extends CIMParseable[RatioTapChangerTable] with Serializable
- object RatioTapChangerTablePoint extends CIMParseable[RatioTapChangerTablePoint] with Serializable
- object RatioTapChangerTablePointSerializer extends CIMSerializer[RatioTapChangerTablePoint]
- object RatioTapChangerTableSerializer extends CIMSerializer[RatioTapChangerTable]
- object RationalNumber extends CIMParseable[RationalNumber] with Serializable
- object RationalNumberSerializer extends CIMSerializer[RationalNumber]
- object ReactiveCapabilityCurve extends CIMParseable[ReactiveCapabilityCurve] with Serializable
- object ReactiveCapabilityCurveSerializer extends CIMSerializer[ReactiveCapabilityCurve]
- object Reading extends CIMParseable[Reading] with Serializable
- object ReadingInterharmonic extends CIMParseable[ReadingInterharmonic] with Serializable
- object ReadingInterharmonicSerializer extends CIMSerializer[ReadingInterharmonic]
- object ReadingQuality extends CIMParseable[ReadingQuality] with Serializable
- object ReadingQualitySerializer extends CIMSerializer[ReadingQuality]
- object ReadingQualityType extends CIMParseable[ReadingQualityType] with Serializable
- object ReadingQualityTypeSerializer extends CIMSerializer[ReadingQualityType]
- object ReadingSerializer extends CIMSerializer[Reading]
- object ReadingType extends CIMParseable[ReadingType] with Serializable
- object ReadingTypeSerializer extends CIMSerializer[ReadingType]
- object Reason extends CIMParseable[Reason] with Serializable
- object ReasonSerializer extends CIMSerializer[Reason]
- object Receipt extends CIMParseable[Receipt] with Serializable
- object ReceiptSerializer extends CIMSerializer[Receipt]
- object RecloseSequence extends CIMParseable[RecloseSequence] with Serializable
- object RecloseSequenceSerializer extends CIMSerializer[RecloseSequence]
- object Recloser extends CIMParseable[Recloser] with Serializable
- object RecloserInfo extends CIMParseable[RecloserInfo] with Serializable
- object RecloserInfoSerializer extends CIMSerializer[RecloserInfo]
- object RecloserSerializer extends CIMSerializer[Recloser]
- object Reconditioning extends CIMParseable[Reconditioning] with Serializable
- object ReconditioningSerializer extends CIMSerializer[Reconditioning]
- object RedLine extends CIMParseable[RedLine] with Serializable
- object RedLineSerializer extends CIMSerializer[RedLine]
- object Register extends CIMParseable[Register] with Serializable
- object RegisterSerializer extends CIMSerializer[Register]
- object RegisteredControllableLoad extends CIMParseable[RegisteredControllableLoad] with Serializable
- object RegisteredControllableLoadSerializer extends CIMSerializer[RegisteredControllableLoad]
- object RegisteredDistributedResource extends CIMParseable[RegisteredDistributedResource] with Serializable
- object RegisteredDistributedResourceSerializer extends CIMSerializer[RegisteredDistributedResource]
- object RegisteredGenerator extends CIMParseable[RegisteredGenerator] with Serializable
- object RegisteredGeneratorSerializer extends CIMSerializer[RegisteredGenerator]
- object RegisteredInterTie extends CIMParseable[RegisteredInterTie] with Serializable
- object RegisteredInterTieSerializer extends CIMSerializer[RegisteredInterTie]
- object RegisteredLoad extends CIMParseable[RegisteredLoad] with Serializable
- object RegisteredLoadSerializer extends CIMSerializer[RegisteredLoad]
- object RegisteredResource extends CIMParseable[RegisteredResource] with Serializable
- object RegisteredResourceSerializer extends CIMSerializer[RegisteredResource]
- object RegularIntervalSchedule extends CIMParseable[RegularIntervalSchedule] with Serializable
- object RegularIntervalScheduleSerializer extends CIMSerializer[RegularIntervalSchedule]
- object RegularTimePoint extends CIMParseable[RegularTimePoint] with Serializable
- object RegularTimePointSerializer extends CIMSerializer[RegularTimePoint]
- object RegulatingCondEq extends CIMParseable[RegulatingCondEq] with Serializable
- object RegulatingCondEqSerializer extends CIMSerializer[RegulatingCondEq]
- object RegulatingControl extends CIMParseable[RegulatingControl] with Serializable
- object RegulatingControlSerializer extends CIMSerializer[RegulatingControl]
- object RegulatingLimit extends CIMParseable[RegulatingLimit] with Serializable
- object RegulatingLimitSerializer extends CIMSerializer[RegulatingLimit]
- object Regulation extends CIMParseable[Regulation] with Serializable
- object RegulationSchedule extends CIMParseable[RegulationSchedule] with Serializable
- object RegulationScheduleSerializer extends CIMSerializer[RegulationSchedule]
- object RegulationSerializer extends CIMSerializer[Regulation]
- object RelativeDisplacement extends CIMParseable[RelativeDisplacement] with Serializable
- object RelativeDisplacementSerializer extends CIMSerializer[RelativeDisplacement]
- object ReliabilityInfo extends CIMParseable[ReliabilityInfo] with Serializable
- object ReliabilityInfoSerializer extends CIMSerializer[ReliabilityInfo]
- object RemedialActionScheme extends CIMParseable[RemedialActionScheme] with Serializable
- object RemedialActionSchemeSerializer extends CIMSerializer[RemedialActionScheme]
- object RemoteConnectDisconnectInfo extends CIMParseable[RemoteConnectDisconnectInfo] with Serializable
- object RemoteConnectDisconnectInfoSerializer extends CIMSerializer[RemoteConnectDisconnectInfo]
- object RemoteControl extends CIMParseable[RemoteControl] with Serializable
- object RemoteControlSerializer extends CIMSerializer[RemoteControl]
- object RemoteInputSignal extends CIMParseable[RemoteInputSignal] with Serializable
- object RemoteInputSignalSerializer extends CIMSerializer[RemoteInputSignal]
- object RemotePoint extends CIMParseable[RemotePoint] with Serializable
- object RemotePointSerializer extends CIMSerializer[RemotePoint]
- object RemoteSource extends CIMParseable[RemoteSource] with Serializable
- object RemoteSourceSerializer extends CIMSerializer[RemoteSource]
- object RemoteUnit extends CIMParseable[RemoteUnit] with Serializable
- object RemoteUnitSerializer extends CIMSerializer[RemoteUnit]
- object RepairItem extends CIMParseable[RepairItem] with Serializable
- object RepairItemSerializer extends CIMSerializer[RepairItem]
- object RepairWorkTask extends CIMParseable[RepairWorkTask] with Serializable
- object RepairWorkTaskSerializer extends CIMSerializer[RepairWorkTask]
- object ReportingCapability extends CIMParseable[ReportingCapability] with Serializable
- object ReportingCapabilitySerializer extends CIMSerializer[ReportingCapability]
- object ReportingGroup extends CIMParseable[ReportingGroup] with Serializable
- object ReportingGroupSerializer extends CIMSerializer[ReportingGroup]
- object ReportingSuperGroup extends CIMParseable[ReportingSuperGroup] with Serializable
- object ReportingSuperGroupSerializer extends CIMSerializer[ReportingSuperGroup]
- object ReserveDemandCurve extends CIMParseable[ReserveDemandCurve] with Serializable
- object ReserveDemandCurveSerializer extends CIMSerializer[ReserveDemandCurve]
- object ReserveReq extends CIMParseable[ReserveReq] with Serializable
- object ReserveReqCurve extends CIMParseable[ReserveReqCurve] with Serializable
- object ReserveReqCurveSerializer extends CIMSerializer[ReserveReqCurve]
- object ReserveReqSerializer extends CIMSerializer[ReserveReq]
- object Reservoir extends CIMParseable[Reservoir] with Serializable
- object ReservoirSerializer extends CIMSerializer[Reservoir]
- object ResourceAwardClearing extends CIMParseable[ResourceAwardClearing] with Serializable
- object ResourceAwardClearingSerializer extends CIMSerializer[ResourceAwardClearing]
- object ResourceAwardInstruction extends CIMParseable[ResourceAwardInstruction] with Serializable
- object ResourceAwardInstructionSerializer extends CIMSerializer[ResourceAwardInstruction]
- object ResourceBid extends CIMParseable[ResourceBid] with Serializable
- object ResourceBidSerializer extends CIMSerializer[ResourceBid]
- object ResourceCapacity extends CIMParseable[ResourceCapacity] with Serializable
- object ResourceCapacitySerializer extends CIMSerializer[ResourceCapacity]
- object ResourceCertification extends CIMParseable[ResourceCertification] with Serializable
- object ResourceCertification2 extends CIMParseable[ResourceCertification2] with Serializable
- object ResourceCertification2Serializer extends CIMSerializer[ResourceCertification2]
- object ResourceCertificationSerializer extends CIMSerializer[ResourceCertification]
- object ResourceClearing extends CIMParseable[ResourceClearing] with Serializable
- object ResourceClearingSerializer extends CIMSerializer[ResourceClearing]
- object ResourceDeploymentStatus extends CIMParseable[ResourceDeploymentStatus] with Serializable
- object ResourceDeploymentStatusSerializer extends CIMSerializer[ResourceDeploymentStatus]
- object ResourceDispatchResults extends CIMParseable[ResourceDispatchResults] with Serializable
- object ResourceDispatchResultsSerializer extends CIMSerializer[ResourceDispatchResults]
- object ResourceGroup extends CIMParseable[ResourceGroup] with Serializable
- object ResourceGroupReq extends CIMParseable[ResourceGroupReq] with Serializable
- object ResourceGroupReqSerializer extends CIMSerializer[ResourceGroupReq]
- object ResourceGroupSerializer extends CIMSerializer[ResourceGroup]
- object ResourceLoadFollowingInst extends CIMParseable[ResourceLoadFollowingInst] with Serializable
- object ResourceLoadFollowingInstSerializer extends CIMSerializer[ResourceLoadFollowingInst]
- object ResourceOperationMaintenanceCost extends CIMParseable[ResourceOperationMaintenanceCost] with Serializable
- object ResourceOperationMaintenanceCostSerializer extends CIMSerializer[ResourceOperationMaintenanceCost]
- object ResourcePerformanceEvaluation extends CIMParseable[ResourcePerformanceEvaluation] with Serializable
- object ResourcePerformanceEvaluationSerializer extends CIMSerializer[ResourcePerformanceEvaluation]
- object ResourcePerformanceGlobalFactor extends CIMParseable[ResourcePerformanceGlobalFactor] with Serializable
- object ResourcePerformanceGlobalFactorSerializer extends CIMSerializer[ResourcePerformanceGlobalFactor]
- object ResourcePerformanceRating extends CIMParseable[ResourcePerformanceRating] with Serializable
- object ResourcePerformanceRatingSerializer extends CIMSerializer[ResourcePerformanceRating]
- object ResourcePerformanceTimeSeriesFactor extends CIMParseable[ResourcePerformanceTimeSeriesFactor] with Serializable
- object ResourcePerformanceTimeSeriesFactorSerializer extends CIMSerializer[ResourcePerformanceTimeSeriesFactor]
- object ResourceStartupCost extends CIMParseable[ResourceStartupCost] with Serializable
- object ResourceStartupCostSerializer extends CIMSerializer[ResourceStartupCost]
- object ResourceVerifiableCosts extends CIMParseable[ResourceVerifiableCosts] with Serializable
- object ResourceVerifiableCostsSerializer extends CIMSerializer[ResourceVerifiableCosts]
- object ResponseMethod extends CIMParseable[ResponseMethod] with Serializable
- object ResponseMethodSerializer extends CIMSerializer[ResponseMethod]
- object RightOfWay extends CIMParseable[RightOfWay] with Serializable
- object RightOfWaySerializer extends CIMSerializer[RightOfWay]
- object RiskScore extends CIMParseable[RiskScore] with Serializable
- object RiskScoreSerializer extends CIMSerializer[RiskScore]
- object Role extends CIMParseable[Role] with Serializable
- object RoleSerializer extends CIMSerializer[Role]
- object RotatingMachine extends CIMParseable[RotatingMachine] with Serializable
- object RotatingMachineDynamics extends CIMParseable[RotatingMachineDynamics] with Serializable
- object RotatingMachineDynamicsSerializer extends CIMSerializer[RotatingMachineDynamics]
- object RotatingMachineSerializer extends CIMSerializer[RotatingMachine]
- object Route extends CIMParseable[Route] with Serializable
- object RouteSerializer extends CIMSerializer[Route]
- object SCADAInformation extends CIMParseable[SCADAInformation] with Serializable
- object SCADAInformationSerializer extends CIMSerializer[SCADAInformation]
- object SVC extends CIMParseable[SVC] with Serializable
- object SVCSerializer extends CIMSerializer[SVC]
- object SVCUserDefined extends CIMParseable[SVCUserDefined] with Serializable
- object SVCUserDefinedSerializer extends CIMSerializer[SVCUserDefined]
- object SafetyDocument extends CIMParseable[SafetyDocument] with Serializable
- object SafetyDocumentSerializer extends CIMSerializer[SafetyDocument]
- object ScheduledActivePowerLimitValue extends CIMParseable[ScheduledActivePowerLimitValue] with Serializable
- object ScheduledActivePowerLimitValueSerializer extends CIMSerializer[ScheduledActivePowerLimitValue]
- object ScheduledApparentPowerLimitValue extends CIMParseable[ScheduledApparentPowerLimitValue] with Serializable
- object ScheduledApparentPowerLimitValueSerializer extends CIMSerializer[ScheduledApparentPowerLimitValue]
- object ScheduledCurrentLimitValue extends CIMParseable[ScheduledCurrentLimitValue] with Serializable
- object ScheduledCurrentLimitValueSerializer extends CIMSerializer[ScheduledCurrentLimitValue]
- object ScheduledEvent extends CIMParseable[ScheduledEvent] with Serializable
- object ScheduledEventData extends CIMParseable[ScheduledEventData] with Serializable
- object ScheduledEventDataSerializer extends CIMSerializer[ScheduledEventData]
- object ScheduledEventSerializer extends CIMSerializer[ScheduledEvent]
- object ScheduledLimitDependency extends CIMParseable[ScheduledLimitDependency] with Serializable
- object ScheduledLimitDependencySerializer extends CIMSerializer[ScheduledLimitDependency]
- object ScheduledLimitValue extends CIMParseable[ScheduledLimitValue] with Serializable
- object ScheduledLimitValueSerializer extends CIMSerializer[ScheduledLimitValue]
- object ScheduledVoltageLimitValue extends CIMParseable[ScheduledVoltageLimitValue] with Serializable
- object ScheduledVoltageLimitValueSerializer extends CIMSerializer[ScheduledVoltageLimitValue]
- object SchedulingCoordinator extends CIMParseable[SchedulingCoordinator] with Serializable
- object SchedulingCoordinatorSerializer extends CIMSerializer[SchedulingCoordinator]
- object SchedulingCoordinatorUser extends CIMParseable[SchedulingCoordinatorUser] with Serializable
- object SchedulingCoordinatorUserSerializer extends CIMSerializer[SchedulingCoordinatorUser]
- object SchedulingPoint extends CIMParseable[SchedulingPoint] with Serializable
- object SchedulingPointSerializer extends CIMSerializer[SchedulingPoint]
- object Seal extends CIMParseable[Seal] with Serializable
- object SealSerializer extends CIMSerializer[Seal]
- object Season extends CIMParseable[Season] with Serializable
- object SeasonDayTypeSchedule extends CIMParseable[SeasonDayTypeSchedule] with Serializable
- object SeasonDayTypeScheduleSerializer extends CIMSerializer[SeasonDayTypeSchedule]
- object SeasonSerializer extends CIMSerializer[Season]
- object Sectionaliser extends CIMParseable[Sectionaliser] with Serializable
- object SectionaliserSerializer extends CIMSerializer[Sectionaliser]
- object SecurityConstraintSum extends CIMParseable[SecurityConstraintSum] with Serializable
- object SecurityConstraintSumSerializer extends CIMSerializer[SecurityConstraintSum]
- object SecurityConstraints extends CIMParseable[SecurityConstraints] with Serializable
- object SecurityConstraintsClearing extends CIMParseable[SecurityConstraintsClearing] with Serializable
- object SecurityConstraintsClearingSerializer extends CIMSerializer[SecurityConstraintsClearing]
- object SecurityConstraintsSerializer extends CIMSerializer[SecurityConstraints]
- object SelfScheduleBreakdown extends CIMParseable[SelfScheduleBreakdown] with Serializable
- object SelfScheduleBreakdownSerializer extends CIMSerializer[SelfScheduleBreakdown]
- object SensitivityPriceCurve extends CIMParseable[SensitivityPriceCurve] with Serializable
- object SensitivityPriceCurveSerializer extends CIMSerializer[SensitivityPriceCurve]
- object Sensor extends CIMParseable[Sensor] with Serializable
- object SensorSerializer extends CIMSerializer[Sensor]
- object Series extends CIMParseable[Series] with Serializable
- object SeriesCompensator extends CIMParseable[SeriesCompensator] with Serializable
- object SeriesCompensatorSerializer extends CIMSerializer[SeriesCompensator]
- object SeriesEquipmentDependentLimit extends CIMParseable[SeriesEquipmentDependentLimit] with Serializable
- object SeriesEquipmentDependentLimitSerializer extends CIMSerializer[SeriesEquipmentDependentLimit]
- object SeriesSerializer extends CIMSerializer[Series]
- object ServiceCategory extends CIMParseable[ServiceCategory] with Serializable
- object ServiceCategorySerializer extends CIMSerializer[ServiceCategory]
- object ServiceGuarantee extends CIMParseable[ServiceGuarantee] with Serializable
- object ServiceGuaranteeSerializer extends CIMSerializer[ServiceGuarantee]
- object ServiceLocation extends CIMParseable[ServiceLocation] with Serializable
- object ServiceLocationSerializer extends CIMSerializer[ServiceLocation]
- object ServiceMultiplier extends CIMParseable[ServiceMultiplier] with Serializable
- object ServiceMultiplierSerializer extends CIMSerializer[ServiceMultiplier]
- object ServicePoint extends CIMParseable[ServicePoint] with Serializable
- object ServicePointOutageSummary extends CIMParseable[ServicePointOutageSummary] with Serializable
- object ServicePointOutageSummarySerializer extends CIMSerializer[ServicePointOutageSummary]
- object ServicePointSerializer extends CIMSerializer[ServicePoint]
- object ServiceSupplier extends CIMParseable[ServiceSupplier] with Serializable
- object ServiceSupplierSerializer extends CIMSerializer[ServiceSupplier]
- object SetPoint extends CIMParseable[SetPoint] with Serializable
- object SetPointSerializer extends CIMSerializer[SetPoint]
- object Settlement extends CIMParseable[Settlement] with Serializable
- object SettlementSerializer extends CIMSerializer[Settlement]
- object Shift extends CIMParseable[Shift] with Serializable
- object ShiftPattern extends CIMParseable[ShiftPattern] with Serializable
- object ShiftPatternSerializer extends CIMSerializer[ShiftPattern]
- object ShiftSerializer extends CIMSerializer[Shift]
- object ShortCircuitTest extends CIMParseable[ShortCircuitTest] with Serializable
- object ShortCircuitTestSerializer extends CIMSerializer[ShortCircuitTest]
- object ShuntCompensator extends CIMParseable[ShuntCompensator] with Serializable
- object ShuntCompensatorAction extends CIMParseable[ShuntCompensatorAction] with Serializable
- object ShuntCompensatorActionSerializer extends CIMSerializer[ShuntCompensatorAction]
- object ShuntCompensatorControl extends CIMParseable[ShuntCompensatorControl] with Serializable
- object ShuntCompensatorControlSerializer extends CIMSerializer[ShuntCompensatorControl]
- object ShuntCompensatorDynamicData extends CIMParseable[ShuntCompensatorDynamicData] with Serializable
- object ShuntCompensatorDynamicDataSerializer extends CIMSerializer[ShuntCompensatorDynamicData]
- object ShuntCompensatorInfo extends CIMParseable[ShuntCompensatorInfo] with Serializable
- object ShuntCompensatorInfoSerializer extends CIMSerializer[ShuntCompensatorInfo]
- object ShuntCompensatorPhase extends CIMParseable[ShuntCompensatorPhase] with Serializable
- object ShuntCompensatorPhaseSerializer extends CIMSerializer[ShuntCompensatorPhase]
- object ShuntCompensatorSerializer extends CIMSerializer[ShuntCompensator]
- object ShutdownCurve extends CIMParseable[ShutdownCurve] with Serializable
- object ShutdownCurveSerializer extends CIMSerializer[ShutdownCurve]
- object SimpleEndDeviceFunction extends CIMParseable[SimpleEndDeviceFunction] with Serializable
- object SimpleEndDeviceFunctionSerializer extends CIMSerializer[SimpleEndDeviceFunction]
- object Skill extends CIMParseable[Skill] with Serializable
- object SkillSerializer extends CIMSerializer[Skill]
- object SolarGeneratingUnit extends CIMParseable[SolarGeneratingUnit] with Serializable
- object SolarGeneratingUnitSerializer extends CIMSerializer[SolarGeneratingUnit]
- object SpaceAnalog extends CIMParseable[SpaceAnalog] with Serializable
- object SpaceAnalogSerializer extends CIMSerializer[SpaceAnalog]
- object SpacePhenomenon extends CIMParseable[SpacePhenomenon] with Serializable
- object SpacePhenomenonSerializer extends CIMSerializer[SpacePhenomenon]
- object Specification extends CIMParseable[Specification] with Serializable
- object SpecificationSerializer extends CIMSerializer[Specification]
- object Specimen extends CIMParseable[Specimen] with Serializable
- object SpecimenSerializer extends CIMSerializer[Specimen]
- object Stage extends CIMParseable[Stage] with Serializable
- object StageSerializer extends CIMSerializer[Stage]
- object StageTrigger extends CIMParseable[StageTrigger] with Serializable
- object StageTriggerSerializer extends CIMSerializer[StageTrigger]
- object StandardIndustryCode extends CIMParseable[StandardIndustryCode] with Serializable
- object StandardIndustryCodeSerializer extends CIMSerializer[StandardIndustryCode]
- object StartIgnFuelCurve extends CIMParseable[StartIgnFuelCurve] with Serializable
- object StartIgnFuelCurveSerializer extends CIMSerializer[StartIgnFuelCurve]
- object StartMainFuelCurve extends CIMParseable[StartMainFuelCurve] with Serializable
- object StartMainFuelCurveSerializer extends CIMSerializer[StartMainFuelCurve]
- object StartRampCurve extends CIMParseable[StartRampCurve] with Serializable
- object StartRampCurveSerializer extends CIMSerializer[StartRampCurve]
- object StartUpCostCurve extends CIMParseable[StartUpCostCurve] with Serializable
- object StartUpCostCurveSerializer extends CIMSerializer[StartUpCostCurve]
- object StartUpEnergyCurve extends CIMParseable[StartUpEnergyCurve] with Serializable
- object StartUpEnergyCurveSerializer extends CIMSerializer[StartUpEnergyCurve]
- object StartUpFuelCurve extends CIMParseable[StartUpFuelCurve] with Serializable
- object StartUpFuelCurveSerializer extends CIMSerializer[StartUpFuelCurve]
- object StartUpTimeCurve extends CIMParseable[StartUpTimeCurve] with Serializable
- object StartUpTimeCurveSerializer extends CIMSerializer[StartUpTimeCurve]
- object StartupModel extends CIMParseable[StartupModel] with Serializable
- object StartupModelSerializer extends CIMSerializer[StartupModel]
- object StateVariable extends CIMParseable[StateVariable] with Serializable
- object StateVariableSerializer extends CIMSerializer[StateVariable]
- object StaticVarCompensator extends CIMParseable[StaticVarCompensator] with Serializable
- object StaticVarCompensatorDynamics extends CIMParseable[StaticVarCompensatorDynamics] with Serializable
- object StaticVarCompensatorDynamicsSerializer extends CIMSerializer[StaticVarCompensatorDynamics]
- object StaticVarCompensatorSerializer extends CIMSerializer[StaticVarCompensator]
- object StationSupply extends CIMParseable[StationSupply] with Serializable
- object StationSupplySerializer extends CIMSerializer[StationSupply]
- object StatisticalCalculation extends CIMParseable[StatisticalCalculation] with Serializable
- object StatisticalCalculationSerializer extends CIMSerializer[StatisticalCalculation]
- object Status extends CIMParseable[Status] with Serializable
- object StatusSerializer extends CIMSerializer[Status]
- object SteamSendoutSchedule extends CIMParseable[SteamSendoutSchedule] with Serializable
- object SteamSendoutScheduleSerializer extends CIMSerializer[SteamSendoutSchedule]
- object SteamSupply extends CIMParseable[SteamSupply] with Serializable
- object SteamSupplySerializer extends CIMSerializer[SteamSupply]
- object SteamTurbine extends CIMParseable[SteamTurbine] with Serializable
- object SteamTurbineSerializer extends CIMSerializer[SteamTurbine]
- object StreetAddress extends CIMParseable[StreetAddress] with Serializable
- object StreetAddressSerializer extends CIMSerializer[StreetAddress]
- object StreetDetail extends CIMParseable[StreetDetail] with Serializable
- object StreetDetailSerializer extends CIMSerializer[StreetDetail]
- object Streetlight extends CIMParseable[Streetlight] with Serializable
- object StreetlightSerializer extends CIMSerializer[Streetlight]
- object StringMeasurement extends CIMParseable[StringMeasurement] with Serializable
- object StringMeasurementSerializer extends CIMSerializer[StringMeasurement]
- object StringMeasurementValue extends CIMParseable[StringMeasurementValue] with Serializable
- object StringMeasurementValueSerializer extends CIMSerializer[StringMeasurementValue]
- object StringQuantity extends CIMParseable[StringQuantity] with Serializable
- object StringQuantitySerializer extends CIMSerializer[StringQuantity]
- object Structure extends CIMParseable[Structure] with Serializable
- object StructureSerializer extends CIMSerializer[Structure]
- object StructureSupport extends CIMParseable[StructureSupport] with Serializable
- object StructureSupportSerializer extends CIMSerializer[StructureSupport]
- object SubControlArea extends CIMParseable[SubControlArea] with Serializable
- object SubControlAreaSerializer extends CIMSerializer[SubControlArea]
- object SubGeographicalRegion extends CIMParseable[SubGeographicalRegion] with Serializable
- object SubGeographicalRegionSerializer extends CIMSerializer[SubGeographicalRegion]
- object SubLoadArea extends CIMParseable[SubLoadArea] with Serializable
- object SubLoadAreaSerializer extends CIMSerializer[SubLoadArea]
- object Subcritical extends CIMParseable[Subcritical] with Serializable
- object SubcriticalSerializer extends CIMSerializer[Subcritical]
- object SubscribePowerCurve extends CIMParseable[SubscribePowerCurve] with Serializable
- object SubscribePowerCurveSerializer extends CIMSerializer[SubscribePowerCurve]
- object Substation extends CIMParseable[Substation] with Serializable
- object SubstationSerializer extends CIMSerializer[Substation]
- object SubstitutionResourceList extends CIMParseable[SubstitutionResourceList] with Serializable
- object SubstitutionResourceListSerializer extends CIMSerializer[SubstitutionResourceList]
- object Supercritical extends CIMParseable[Supercritical] with Serializable
- object SupercriticalSerializer extends CIMSerializer[Supercritical]
- object SurgeArrester extends CIMParseable[SurgeArrester] with Serializable
- object SurgeArresterInfo extends CIMParseable[SurgeArresterInfo] with Serializable
- object SurgeArresterInfoSerializer extends CIMSerializer[SurgeArresterInfo]
- object SurgeArresterSerializer extends CIMSerializer[SurgeArrester]
- object SvInjection extends CIMParseable[SvInjection] with Serializable
- object SvInjectionSerializer extends CIMSerializer[SvInjection]
- object SvPowerFlow extends CIMParseable[SvPowerFlow] with Serializable
- object SvPowerFlowSerializer extends CIMSerializer[SvPowerFlow]
- object SvShuntCompensatorSections extends CIMParseable[SvShuntCompensatorSections] with Serializable
- object SvShuntCompensatorSectionsSerializer extends CIMSerializer[SvShuntCompensatorSections]
- object SvStatus extends CIMParseable[SvStatus] with Serializable
- object SvStatusSerializer extends CIMSerializer[SvStatus]
- object SvSwitch extends CIMParseable[SvSwitch] with Serializable
- object SvSwitchSerializer extends CIMSerializer[SvSwitch]
- object SvTapStep extends CIMParseable[SvTapStep] with Serializable
- object SvTapStepSerializer extends CIMSerializer[SvTapStep]
- object SvVoltage extends CIMParseable[SvVoltage] with Serializable
- object SvVoltageSerializer extends CIMSerializer[SvVoltage]
- object Switch extends CIMParseable[Switch] with Serializable
- object SwitchAction extends CIMParseable[SwitchAction] with Serializable
- object SwitchActionSerializer extends CIMSerializer[SwitchAction]
- object SwitchInfo extends CIMParseable[SwitchInfo] with Serializable
- object SwitchInfoSerializer extends CIMSerializer[SwitchInfo]
- object SwitchOperationSummary extends CIMParseable[SwitchOperationSummary] with Serializable
- object SwitchOperationSummarySerializer extends CIMSerializer[SwitchOperationSummary]
- object SwitchPhase extends CIMParseable[SwitchPhase] with Serializable
- object SwitchPhaseSerializer extends CIMSerializer[SwitchPhase]
- object SwitchSchedule extends CIMParseable[SwitchSchedule] with Serializable
- object SwitchScheduleSerializer extends CIMSerializer[SwitchSchedule]
- object SwitchSerializer extends CIMSerializer[Switch]
- object SwitchStatus extends CIMParseable[SwitchStatus] with Serializable
- object SwitchStatusSerializer extends CIMSerializer[SwitchStatus]
- object SwitchingAction extends CIMParseable[SwitchingAction] with Serializable
- object SwitchingActionSerializer extends CIMSerializer[SwitchingAction]
- object SwitchingEvent extends CIMParseable[SwitchingEvent] with Serializable
- object SwitchingEventSerializer extends CIMSerializer[SwitchingEvent]
- object SwitchingOrder extends CIMParseable[SwitchingOrder] with Serializable
- object SwitchingOrderSerializer extends CIMSerializer[SwitchingOrder]
- object SwitchingPlan extends CIMParseable[SwitchingPlan] with Serializable
- object SwitchingPlanRequest extends CIMParseable[SwitchingPlanRequest] with Serializable
- object SwitchingPlanRequestSerializer extends CIMSerializer[SwitchingPlanRequest]
- object SwitchingPlanSerializer extends CIMSerializer[SwitchingPlan]
- object SwitchingStep extends CIMParseable[SwitchingStep] with Serializable
- object SwitchingStepGroup extends CIMParseable[SwitchingStepGroup] with Serializable
- object SwitchingStepGroupSerializer extends CIMSerializer[SwitchingStepGroup]
- object SwitchingStepSerializer extends CIMSerializer[SwitchingStep]
- object SynchrocheckRelay extends CIMParseable[SynchrocheckRelay] with Serializable
- object SynchrocheckRelaySerializer extends CIMSerializer[SynchrocheckRelay]
- object SynchronousMachine extends CIMParseable[SynchronousMachine] with Serializable
- object SynchronousMachineDetailed extends CIMParseable[SynchronousMachineDetailed] with Serializable
- object SynchronousMachineDetailedSerializer extends CIMSerializer[SynchronousMachineDetailed]
- object SynchronousMachineDynamics extends CIMParseable[SynchronousMachineDynamics] with Serializable
- object SynchronousMachineDynamicsSerializer extends CIMSerializer[SynchronousMachineDynamics]
- object SynchronousMachineEquivalentCircuit extends CIMParseable[SynchronousMachineEquivalentCircuit] with Serializable
- object SynchronousMachineEquivalentCircuitSerializer extends CIMSerializer[SynchronousMachineEquivalentCircuit]
- object SynchronousMachineSerializer extends CIMSerializer[SynchronousMachine]
- object SynchronousMachineSimplified extends CIMParseable[SynchronousMachineSimplified] with Serializable
- object SynchronousMachineSimplifiedSerializer extends CIMSerializer[SynchronousMachineSimplified]
- object SynchronousMachineTimeConstantReactance extends CIMParseable[SynchronousMachineTimeConstantReactance] with Serializable
- object SynchronousMachineTimeConstantReactanceSerializer extends CIMSerializer[SynchronousMachineTimeConstantReactance]
- object SynchronousMachineUserDefined extends CIMParseable[SynchronousMachineUserDefined] with Serializable
- object SynchronousMachineUserDefinedSerializer extends CIMSerializer[SynchronousMachineUserDefined]
- object SysLoadDistributionFactor extends CIMParseable[SysLoadDistributionFactor] with Serializable
- object SysLoadDistributionFactorSerializer extends CIMSerializer[SysLoadDistributionFactor]
- object TACArea extends CIMParseable[TACArea] with Serializable
- object TACAreaSerializer extends CIMSerializer[TACArea]
- object TAPPIStandard extends CIMParseable[TAPPIStandard] with Serializable
- object TAPPIStandardSerializer extends CIMSerializer[TAPPIStandard]
- object TASE2BilateralTable extends CIMParseable[TASE2BilateralTable] with Serializable
- object TASE2BilateralTableSerializer extends CIMSerializer[TASE2BilateralTable]
- object TCPAccessPoint extends CIMParseable[TCPAccessPoint] with Serializable
- object TCPAccessPointSerializer extends CIMSerializer[TCPAccessPoint]
- object TREntitlement extends CIMParseable[TREntitlement] with Serializable
- object TREntitlementSerializer extends CIMSerializer[TREntitlement]
- object TagAction extends CIMParseable[TagAction] with Serializable
- object TagActionSerializer extends CIMSerializer[TagAction]
- object TailbayLossCurve extends CIMParseable[TailbayLossCurve] with Serializable
- object TailbayLossCurveSerializer extends CIMSerializer[TailbayLossCurve]
- object TapChanger extends CIMParseable[TapChanger] with Serializable
- object TapChangerControl extends CIMParseable[TapChangerControl] with Serializable
- object TapChangerControlSerializer extends CIMSerializer[TapChangerControl]
- object TapChangerDynamicData extends CIMParseable[TapChangerDynamicData] with Serializable
- object TapChangerDynamicDataSerializer extends CIMSerializer[TapChangerDynamicData]
- object TapChangerInfo extends CIMParseable[TapChangerInfo] with Serializable
- object TapChangerInfoSerializer extends CIMSerializer[TapChangerInfo]
- object TapChangerSerializer extends CIMSerializer[TapChanger]
- object TapChangerTablePoint extends CIMParseable[TapChangerTablePoint] with Serializable
- object TapChangerTablePointSerializer extends CIMSerializer[TapChangerTablePoint]
- object TapSchedule extends CIMParseable[TapSchedule] with Serializable
- object TapScheduleSerializer extends CIMSerializer[TapSchedule]
- object TapeShieldCableInfo extends CIMParseable[TapeShieldCableInfo] with Serializable
- object TapeShieldCableInfoSerializer extends CIMSerializer[TapeShieldCableInfo]
- object TargetLevelSchedule extends CIMParseable[TargetLevelSchedule] with Serializable
- object TargetLevelScheduleSerializer extends CIMSerializer[TargetLevelSchedule]
- object Tariff extends CIMParseable[Tariff] with Serializable
- object TariffProfile extends CIMParseable[TariffProfile] with Serializable
- object TariffProfileSerializer extends CIMSerializer[TariffProfile]
- object TariffSerializer extends CIMSerializer[Tariff]
- object TelephoneNumber extends CIMParseable[TelephoneNumber] with Serializable
- object TelephoneNumberSerializer extends CIMSerializer[TelephoneNumber]
- object TemperatureDependentLimitPoint extends CIMParseable[TemperatureDependentLimitPoint] with Serializable
- object TemperatureDependentLimitPointSerializer extends CIMSerializer[TemperatureDependentLimitPoint]
- object TemperatureDependentLimitTable extends CIMParseable[TemperatureDependentLimitTable] with Serializable
- object TemperatureDependentLimitTableSerializer extends CIMSerializer[TemperatureDependentLimitTable]
- object TemperaturePolynomialLimit extends CIMParseable[TemperaturePolynomialLimit] with Serializable
- object TemperaturePolynomialLimitSerializer extends CIMSerializer[TemperaturePolynomialLimit]
- object TenMinAuxiliaryData extends CIMParseable[TenMinAuxiliaryData] with Serializable
- object TenMinAuxiliaryDataSerializer extends CIMSerializer[TenMinAuxiliaryData]
- object Tender extends CIMParseable[Tender] with Serializable
- object TenderSerializer extends CIMSerializer[Tender]
- object Terminal extends CIMParseable[Terminal] with Serializable
- object TerminalConstraintTerm extends CIMParseable[TerminalConstraintTerm] with Serializable
- object TerminalConstraintTermSerializer extends CIMSerializer[TerminalConstraintTerm]
- object TerminalSerializer extends CIMSerializer[Terminal]
- object TestDataSet extends CIMParseable[TestDataSet] with Serializable
- object TestDataSetSerializer extends CIMSerializer[TestDataSet]
- object TestStandard extends CIMParseable[TestStandard] with Serializable
- object TestStandardSerializer extends CIMSerializer[TestStandard]
- object TextDiagramObject extends CIMParseable[TextDiagramObject] with Serializable
- object TextDiagramObjectSerializer extends CIMSerializer[TextDiagramObject]
- object ThermalGeneratingUnit extends CIMParseable[ThermalGeneratingUnit] with Serializable
- object ThermalGeneratingUnitSerializer extends CIMSerializer[ThermalGeneratingUnit]
- object TieFlow extends CIMParseable[TieFlow] with Serializable
- object TieFlowSerializer extends CIMSerializer[TieFlow]
- object TieLine extends CIMParseable[TieLine] with Serializable
- object TieLineSerializer extends CIMSerializer[TieLine]
- object TiePoint extends CIMParseable[TiePoint] with Serializable
- object TiePointSerializer extends CIMSerializer[TiePoint]
- object TimeInterval extends CIMParseable[TimeInterval] with Serializable
- object TimeIntervalSerializer extends CIMSerializer[TimeInterval]
- object TimePoint extends CIMParseable[TimePoint] with Serializable
- object TimePointSerializer extends CIMSerializer[TimePoint]
- object TimeSchedule extends CIMParseable[TimeSchedule] with Serializable
- object TimeScheduleSerializer extends CIMSerializer[TimeSchedule]
- object TimeSeries extends CIMParseable[TimeSeries] with Serializable
- object TimeSeriesSerializer extends CIMSerializer[TimeSeries]
- object TimeTariffInterval extends CIMParseable[TimeTariffInterval] with Serializable
- object TimeTariffIntervalSerializer extends CIMSerializer[TimeTariffInterval]
- object Tool extends CIMParseable[Tool] with Serializable
- object ToolSerializer extends CIMSerializer[Tool]
- object TopologicalIsland extends CIMParseable[TopologicalIsland] with Serializable
- object TopologicalIslandSerializer extends CIMSerializer[TopologicalIsland]
- object TopologicalNode extends CIMParseable[TopologicalNode] with Serializable
- object TopologicalNodeSerializer extends CIMSerializer[TopologicalNode]
- object Tornado extends CIMParseable[Tornado] with Serializable
- object TornadoSerializer extends CIMSerializer[Tornado]
- object Tower extends CIMParseable[Tower] with Serializable
- object TowerSerializer extends CIMSerializer[Tower]
- object TownDetail extends CIMParseable[TownDetail] with Serializable
- object TownDetailSerializer extends CIMSerializer[TownDetail]
- object Trade extends CIMParseable[Trade] with Serializable
- object TradeError extends CIMParseable[TradeError] with Serializable
- object TradeErrorSerializer extends CIMSerializer[TradeError]
- object TradeProduct extends CIMParseable[TradeProduct] with Serializable
- object TradeProductSerializer extends CIMSerializer[TradeProduct]
- object TradeSerializer extends CIMSerializer[Trade]
- object TradingHubPrice extends CIMParseable[TradingHubPrice] with Serializable
- object TradingHubPriceSerializer extends CIMSerializer[TradingHubPrice]
- object TradingHubValues extends CIMParseable[TradingHubValues] with Serializable
- object TradingHubValuesSerializer extends CIMSerializer[TradingHubValues]
- object Transaction extends CIMParseable[Transaction] with Serializable
- object TransactionBid extends CIMParseable[TransactionBid] with Serializable
- object TransactionBidClearing extends CIMParseable[TransactionBidClearing] with Serializable
- object TransactionBidClearingSerializer extends CIMSerializer[TransactionBidClearing]
- object TransactionBidResults extends CIMParseable[TransactionBidResults] with Serializable
- object TransactionBidResultsSerializer extends CIMSerializer[TransactionBidResults]
- object TransactionBidSerializer extends CIMSerializer[TransactionBid]
- object TransactionSerializer extends CIMSerializer[Transaction]
- object Transactor extends CIMParseable[Transactor] with Serializable
- object TransactorSerializer extends CIMSerializer[Transactor]
- object TransferInterface extends CIMParseable[TransferInterface] with Serializable
- object TransferInterfaceSerializer extends CIMSerializer[TransferInterface]
- object TransferInterfaceSolution extends CIMParseable[TransferInterfaceSolution] with Serializable
- object TransferInterfaceSolutionSerializer extends CIMSerializer[TransferInterfaceSolution]
- object TransformerCoreAdmittance extends CIMParseable[TransformerCoreAdmittance] with Serializable
- object TransformerCoreAdmittanceSerializer extends CIMSerializer[TransformerCoreAdmittance]
- object TransformerEnd extends CIMParseable[TransformerEnd] with Serializable
- object TransformerEndInfo extends CIMParseable[TransformerEndInfo] with Serializable
- object TransformerEndInfoSerializer extends CIMSerializer[TransformerEndInfo]
- object TransformerEndSerializer extends CIMSerializer[TransformerEnd]
- object TransformerMeshImpedance extends CIMParseable[TransformerMeshImpedance] with Serializable
- object TransformerMeshImpedanceSerializer extends CIMSerializer[TransformerMeshImpedance]
- object TransformerObservation extends CIMParseable[TransformerObservation] with Serializable
- object TransformerObservationSerializer extends CIMSerializer[TransformerObservation]
- object TransformerStarImpedance extends CIMParseable[TransformerStarImpedance] with Serializable
- object TransformerStarImpedanceSerializer extends CIMSerializer[TransformerStarImpedance]
- object TransformerTank extends CIMParseable[TransformerTank] with Serializable
- object TransformerTankEnd extends CIMParseable[TransformerTankEnd] with Serializable
- object TransformerTankEndSerializer extends CIMSerializer[TransformerTankEnd]
- object TransformerTankInfo extends CIMParseable[TransformerTankInfo] with Serializable
- object TransformerTankInfoSerializer extends CIMSerializer[TransformerTankInfo]
- object TransformerTankSerializer extends CIMSerializer[TransformerTank]
- object TransformerTest extends CIMParseable[TransformerTest] with Serializable
- object TransformerTestSerializer extends CIMSerializer[TransformerTest]
- object TransmissionCapacity extends CIMParseable[TransmissionCapacity] with Serializable
- object TransmissionCapacitySerializer extends CIMSerializer[TransmissionCapacity]
- object TransmissionCorridor extends CIMParseable[TransmissionCorridor] with Serializable
- object TransmissionCorridorSerializer extends CIMSerializer[TransmissionCorridor]
- object TransmissionInterfaceRightEntitlement extends CIMParseable[TransmissionInterfaceRightEntitlement] with Serializable
- object TransmissionInterfaceRightEntitlementSerializer extends CIMSerializer[TransmissionInterfaceRightEntitlement]
- object TransmissionPath extends CIMParseable[TransmissionPath] with Serializable
- object TransmissionPathSerializer extends CIMSerializer[TransmissionPath]
- object TransmissionProduct extends CIMParseable[TransmissionProduct] with Serializable
- object TransmissionProductSerializer extends CIMSerializer[TransmissionProduct]
- object TransmissionProvider extends CIMParseable[TransmissionProvider] with Serializable
- object TransmissionProviderSerializer extends CIMSerializer[TransmissionProvider]
- object TransmissionReservation extends CIMParseable[TransmissionReservation] with Serializable
- object TransmissionReservationSerializer extends CIMSerializer[TransmissionReservation]
- object TransmissionRightChain extends CIMParseable[TransmissionRightChain] with Serializable
- object TransmissionRightChainSerializer extends CIMSerializer[TransmissionRightChain]
- object TransmissionRightOfWay extends CIMParseable[TransmissionRightOfWay] with Serializable
- object TransmissionRightOfWaySerializer extends CIMSerializer[TransmissionRightOfWay]
- object TriggerCondition extends CIMParseable[TriggerCondition] with Serializable
- object TriggerConditionSerializer extends CIMSerializer[TriggerCondition]
- object TropicalCycloneAustralia extends CIMParseable[TropicalCycloneAustralia] with Serializable
- object TropicalCycloneAustraliaSerializer extends CIMSerializer[TropicalCycloneAustralia]
- object TroubleOrder extends CIMParseable[TroubleOrder] with Serializable
- object TroubleOrderSerializer extends CIMSerializer[TroubleOrder]
- object TroubleTicket extends CIMParseable[TroubleTicket] with Serializable
- object TroubleTicketSerializer extends CIMSerializer[TroubleTicket]
- object Tsunami extends CIMParseable[Tsunami] with Serializable
- object TsunamiSerializer extends CIMSerializer[Tsunami]
- object TurbLCFB1 extends CIMParseable[TurbLCFB1] with Serializable
- object TurbLCFB1Serializer extends CIMSerializer[TurbLCFB1]
- object TurbineGovernorDynamics extends CIMParseable[TurbineGovernorDynamics] with Serializable
- object TurbineGovernorDynamicsSerializer extends CIMSerializer[TurbineGovernorDynamics]
- object TurbineGovernorUserDefined extends CIMParseable[TurbineGovernorUserDefined] with Serializable
- object TurbineGovernorUserDefinedSerializer extends CIMSerializer[TurbineGovernorUserDefined]
- object TurbineLoadControllerDynamics extends CIMParseable[TurbineLoadControllerDynamics] with Serializable
- object TurbineLoadControllerDynamicsSerializer extends CIMSerializer[TurbineLoadControllerDynamics]
- object TurbineLoadControllerUserDefined extends CIMParseable[TurbineLoadControllerUserDefined] with Serializable
- object TurbineLoadControllerUserDefinedSerializer extends CIMSerializer[TurbineLoadControllerUserDefined]
- object TypeAssetCatalogue extends CIMParseable[TypeAssetCatalogue] with Serializable
- object TypeAssetCatalogueSerializer extends CIMSerializer[TypeAssetCatalogue]
- object TypeMaterial extends CIMParseable[TypeMaterial] with Serializable
- object TypeMaterialSerializer extends CIMSerializer[TypeMaterial]
- object UKMinistryOfDefenceStandard extends CIMParseable[UKMinistryOfDefenceStandard] with Serializable
- object UKMinistryOfDefenceStandardSerializer extends CIMSerializer[UKMinistryOfDefenceStandard]
- object Umode extends CIMParseable[Umode] with Serializable
- object UmodeSerializer extends CIMSerializer[Umode]
- object UnavailabilityScheduleDependency extends CIMParseable[UnavailabilityScheduleDependency] with Serializable
- object UnavailabilityScheduleDependencySerializer extends CIMSerializer[UnavailabilityScheduleDependency]
- object UnavailabilitySwitchAction extends CIMParseable[UnavailabilitySwitchAction] with Serializable
- object UnavailabilitySwitchActionSerializer extends CIMSerializer[UnavailabilitySwitchAction]
- object UnavailablitySchedule extends CIMParseable[UnavailablitySchedule] with Serializable
- object UnavailablityScheduleSerializer extends CIMSerializer[UnavailablitySchedule]
- object UnderexcLim2Simplified extends CIMParseable[UnderexcLim2Simplified] with Serializable
- object UnderexcLim2SimplifiedSerializer extends CIMSerializer[UnderexcLim2Simplified]
- object UnderexcLimIEEE1 extends CIMParseable[UnderexcLimIEEE1] with Serializable
- object UnderexcLimIEEE1Serializer extends CIMSerializer[UnderexcLimIEEE1]
- object UnderexcLimIEEE2 extends CIMParseable[UnderexcLimIEEE2] with Serializable
- object UnderexcLimIEEE2Serializer extends CIMSerializer[UnderexcLimIEEE2]
- object UnderexcLimX1 extends CIMParseable[UnderexcLimX1] with Serializable
- object UnderexcLimX1Serializer extends CIMSerializer[UnderexcLimX1]
- object UnderexcLimX2 extends CIMParseable[UnderexcLimX2] with Serializable
- object UnderexcLimX2Serializer extends CIMSerializer[UnderexcLimX2]
- object UnderexcitationLimiterDynamics extends CIMParseable[UnderexcitationLimiterDynamics] with Serializable
- object UnderexcitationLimiterDynamicsSerializer extends CIMSerializer[UnderexcitationLimiterDynamics]
- object UnderexcitationLimiterUserDefined extends CIMParseable[UnderexcitationLimiterUserDefined] with Serializable
- object UnderexcitationLimiterUserDefinedSerializer extends CIMSerializer[UnderexcitationLimiterUserDefined]
- object UndergroundStructure extends CIMParseable[UndergroundStructure] with Serializable
- object UndergroundStructureSerializer extends CIMSerializer[UndergroundStructure]
- object UnitInitialConditions extends CIMParseable[UnitInitialConditions] with Serializable
- object UnitInitialConditionsSerializer extends CIMSerializer[UnitInitialConditions]
- object Unit_ extends CIMParseable[Unit_] with Serializable
- object Unit_Serializer extends CIMSerializer[Unit_]
- object Unknown extends CIMParseable[Unknown] with Serializable
- object UnknownSerializer extends CIMSerializer[Unknown]
- object UnplannedOutage extends CIMParseable[UnplannedOutage] with Serializable
- object UnplannedOutageSerializer extends CIMSerializer[UnplannedOutage]
- object Usage extends CIMParseable[Usage] with Serializable
- object UsagePoint extends CIMParseable[UsagePoint] with Serializable
- object UsagePointGroup extends CIMParseable[UsagePointGroup] with Serializable
- object UsagePointGroupSerializer extends CIMSerializer[UsagePointGroup]
- object UsagePointLocation extends CIMParseable[UsagePointLocation] with Serializable
- object UsagePointLocationSerializer extends CIMSerializer[UsagePointLocation]
- object UsagePointSerializer extends CIMSerializer[UsagePoint]
- object UsageSerializer extends CIMSerializer[Usage]
- object UserAttribute extends CIMParseable[UserAttribute] with Serializable
- object UserAttributeSerializer extends CIMSerializer[UserAttribute]
- object VAdjIEEE extends CIMParseable[VAdjIEEE] with Serializable
- object VAdjIEEESerializer extends CIMSerializer[VAdjIEEE]
- object VCompIEEEType1 extends CIMParseable[VCompIEEEType1] with Serializable
- object VCompIEEEType1Serializer extends CIMSerializer[VCompIEEEType1]
- object VCompIEEEType2 extends CIMParseable[VCompIEEEType2] with Serializable
- object VCompIEEEType2Serializer extends CIMSerializer[VCompIEEEType2]
- object VDCOL extends CIMParseable[VDCOL] with Serializable
- object VDCOLSerializer extends CIMSerializer[VDCOL]
- object VSCDynamics extends CIMParseable[VSCDynamics] with Serializable
- object VSCDynamicsSerializer extends CIMSerializer[VSCDynamics]
- object VSCUserDefined extends CIMParseable[VSCUserDefined] with Serializable
- object VSCUserDefinedSerializer extends CIMSerializer[VSCUserDefined]
- object VSCtype1 extends CIMParseable[VSCtype1] with Serializable
- object VSCtype1Serializer extends CIMSerializer[VSCtype1]
- object ValueAliasSet extends CIMParseable[ValueAliasSet] with Serializable
- object ValueAliasSetSerializer extends CIMSerializer[ValueAliasSet]
- object ValueToAlias extends CIMParseable[ValueToAlias] with Serializable
- object ValueToAliasSerializer extends CIMSerializer[ValueToAlias]
- object Vehicle extends CIMParseable[Vehicle] with Serializable
- object VehicleSerializer extends CIMSerializer[Vehicle]
- object Vendor extends CIMParseable[Vendor] with Serializable
- object VendorSerializer extends CIMSerializer[Vendor]
- object VendorShift extends CIMParseable[VendorShift] with Serializable
- object VendorShiftSerializer extends CIMSerializer[VendorShift]
- object VerificationAction extends CIMParseable[VerificationAction] with Serializable
- object VerificationActionSerializer extends CIMSerializer[VerificationAction]
- object Version extends CIMParseable[Version] with Serializable
- object VersionSerializer extends CIMSerializer[Version]
- object ViolationLimit extends CIMParseable[ViolationLimit] with Serializable
- object ViolationLimitSerializer extends CIMSerializer[ViolationLimit]
- object VisibilityLayer extends CIMParseable[VisibilityLayer] with Serializable
- object VisibilityLayerSerializer extends CIMSerializer[VisibilityLayer]
- object VolcanicAshCloud extends CIMParseable[VolcanicAshCloud] with Serializable
- object VolcanicAshCloudSerializer extends CIMSerializer[VolcanicAshCloud]
- object VoltageAdjusterDynamics extends CIMParseable[VoltageAdjusterDynamics] with Serializable
- object VoltageAdjusterDynamicsSerializer extends CIMSerializer[VoltageAdjusterDynamics]
- object VoltageAdjusterUserDefined extends CIMParseable[VoltageAdjusterUserDefined] with Serializable
- object VoltageAdjusterUserDefinedSerializer extends CIMSerializer[VoltageAdjusterUserDefined]
- object VoltageCompensatorDynamics extends CIMParseable[VoltageCompensatorDynamics] with Serializable
- object VoltageCompensatorDynamicsSerializer extends CIMSerializer[VoltageCompensatorDynamics]
- object VoltageCompensatorUserDefined extends CIMParseable[VoltageCompensatorUserDefined] with Serializable
- object VoltageCompensatorUserDefinedSerializer extends CIMSerializer[VoltageCompensatorUserDefined]
- object VoltageControlZone extends CIMParseable[VoltageControlZone] with Serializable
- object VoltageControlZoneSerializer extends CIMSerializer[VoltageControlZone]
- object VoltageLevel extends CIMParseable[VoltageLevel] with Serializable
- object VoltageLevelSerializer extends CIMSerializer[VoltageLevel]
- object VoltageLimit extends CIMParseable[VoltageLimit] with Serializable
- object VoltageLimitSerializer extends CIMSerializer[VoltageLimit]
- object VsCapabilityCurve extends CIMParseable[VsCapabilityCurve] with Serializable
- object VsCapabilityCurveSerializer extends CIMSerializer[VsCapabilityCurve]
- object VsConverter extends CIMParseable[VsConverter] with Serializable
- object VsConverterSerializer extends CIMSerializer[VsConverter]
- object WEPStandard extends CIMParseable[WEPStandard] with Serializable
- object WEPStandardSerializer extends CIMSerializer[WEPStandard]
- object WaveTrap extends CIMParseable[WaveTrap] with Serializable
- object WaveTrapSerializer extends CIMSerializer[WaveTrap]
- object WeatherStation extends CIMParseable[WeatherStation] with Serializable
- object WeatherStationSerializer extends CIMSerializer[WeatherStation]
- object WheelingCounterParty extends CIMParseable[WheelingCounterParty] with Serializable
- object WheelingCounterPartySerializer extends CIMSerializer[WheelingCounterParty]
- object WheelingReferenceSchedule extends CIMParseable[WheelingReferenceSchedule] with Serializable
- object WheelingReferenceScheduleSerializer extends CIMSerializer[WheelingReferenceSchedule]
- object Whirlpool extends CIMParseable[Whirlpool] with Serializable
- object WhirlpoolSerializer extends CIMSerializer[Whirlpool]
- object WindAeroConstIEC extends CIMParseable[WindAeroConstIEC] with Serializable
- object WindAeroConstIECSerializer extends CIMSerializer[WindAeroConstIEC]
- object WindAeroOneDimIEC extends CIMParseable[WindAeroOneDimIEC] with Serializable
- object WindAeroOneDimIECSerializer extends CIMSerializer[WindAeroOneDimIEC]
- object WindAeroTwoDimIEC extends CIMParseable[WindAeroTwoDimIEC] with Serializable
- object WindAeroTwoDimIECSerializer extends CIMSerializer[WindAeroTwoDimIEC]
- object WindContCurrLimIEC extends CIMParseable[WindContCurrLimIEC] with Serializable
- object WindContCurrLimIECSerializer extends CIMSerializer[WindContCurrLimIEC]
- object WindContPType3IEC extends CIMParseable[WindContPType3IEC] with Serializable
- object WindContPType3IECSerializer extends CIMSerializer[WindContPType3IEC]
- object WindContPType4aIEC extends CIMParseable[WindContPType4aIEC] with Serializable
- object WindContPType4aIECSerializer extends CIMSerializer[WindContPType4aIEC]
- object WindContPType4bIEC extends CIMParseable[WindContPType4bIEC] with Serializable
- object WindContPType4bIECSerializer extends CIMSerializer[WindContPType4bIEC]
- object WindContPitchAngleIEC extends CIMParseable[WindContPitchAngleIEC] with Serializable
- object WindContPitchAngleIECSerializer extends CIMSerializer[WindContPitchAngleIEC]
- object WindContQIEC extends CIMParseable[WindContQIEC] with Serializable
- object WindContQIECSerializer extends CIMSerializer[WindContQIEC]
- object WindContQLimIEC extends CIMParseable[WindContQLimIEC] with Serializable
- object WindContQLimIECSerializer extends CIMSerializer[WindContQLimIEC]
- object WindContQPQULimIEC extends CIMParseable[WindContQPQULimIEC] with Serializable
- object WindContQPQULimIECSerializer extends CIMSerializer[WindContQPQULimIEC]
- object WindContRotorRIEC extends CIMParseable[WindContRotorRIEC] with Serializable
- object WindContRotorRIECSerializer extends CIMSerializer[WindContRotorRIEC]
- object WindDynamicsLookupTable extends CIMParseable[WindDynamicsLookupTable] with Serializable
- object WindDynamicsLookupTableSerializer extends CIMSerializer[WindDynamicsLookupTable]
- object WindGenTurbineType1aIEC extends CIMParseable[WindGenTurbineType1aIEC] with Serializable
- object WindGenTurbineType1aIECSerializer extends CIMSerializer[WindGenTurbineType1aIEC]
- object WindGenTurbineType1bIEC extends CIMParseable[WindGenTurbineType1bIEC] with Serializable
- object WindGenTurbineType1bIECSerializer extends CIMSerializer[WindGenTurbineType1bIEC]
- object WindGenTurbineType2IEC extends CIMParseable[WindGenTurbineType2IEC] with Serializable
- object WindGenTurbineType2IECSerializer extends CIMSerializer[WindGenTurbineType2IEC]
- object WindGenType3IEC extends CIMParseable[WindGenType3IEC] with Serializable
- object WindGenType3IECSerializer extends CIMSerializer[WindGenType3IEC]
- object WindGenType3aIEC extends CIMParseable[WindGenType3aIEC] with Serializable
- object WindGenType3aIECSerializer extends CIMSerializer[WindGenType3aIEC]
- object WindGenType3bIEC extends CIMParseable[WindGenType3bIEC] with Serializable
- object WindGenType3bIECSerializer extends CIMSerializer[WindGenType3bIEC]
- object WindGenType4IEC extends CIMParseable[WindGenType4IEC] with Serializable
- object WindGenType4IECSerializer extends CIMSerializer[WindGenType4IEC]
- object WindGeneratingUnit extends CIMParseable[WindGeneratingUnit] with Serializable
- object WindGeneratingUnitSerializer extends CIMSerializer[WindGeneratingUnit]
- object WindMechIEC extends CIMParseable[WindMechIEC] with Serializable
- object WindMechIECSerializer extends CIMSerializer[WindMechIEC]
- object WindPitchContPowerIEC extends CIMParseable[WindPitchContPowerIEC] with Serializable
- object WindPitchContPowerIECSerializer extends CIMSerializer[WindPitchContPowerIEC]
- object WindPlantDynamics extends CIMParseable[WindPlantDynamics] with Serializable
- object WindPlantDynamicsSerializer extends CIMSerializer[WindPlantDynamics]
- object WindPlantFreqPcontrolIEC extends CIMParseable[WindPlantFreqPcontrolIEC] with Serializable
- object WindPlantFreqPcontrolIECSerializer extends CIMSerializer[WindPlantFreqPcontrolIEC]
- object WindPlantIEC extends CIMParseable[WindPlantIEC] with Serializable
- object WindPlantIECSerializer extends CIMSerializer[WindPlantIEC]
- object WindPlantReactiveControlIEC extends CIMParseable[WindPlantReactiveControlIEC] with Serializable
- object WindPlantReactiveControlIECSerializer extends CIMSerializer[WindPlantReactiveControlIEC]
- object WindPlantUserDefined extends CIMParseable[WindPlantUserDefined] with Serializable
- object WindPlantUserDefinedSerializer extends CIMSerializer[WindPlantUserDefined]
- object WindProtectionIEC extends CIMParseable[WindProtectionIEC] with Serializable
- object WindProtectionIECSerializer extends CIMSerializer[WindProtectionIEC]
- object WindRefFrameRotIEC extends CIMParseable[WindRefFrameRotIEC] with Serializable
- object WindRefFrameRotIECSerializer extends CIMSerializer[WindRefFrameRotIEC]
- object WindTurbineType1or2Dynamics extends CIMParseable[WindTurbineType1or2Dynamics] with Serializable
- object WindTurbineType1or2DynamicsSerializer extends CIMSerializer[WindTurbineType1or2Dynamics]
- object WindTurbineType1or2IEC extends CIMParseable[WindTurbineType1or2IEC] with Serializable
- object WindTurbineType1or2IECSerializer extends CIMSerializer[WindTurbineType1or2IEC]
- object WindTurbineType3IEC extends CIMParseable[WindTurbineType3IEC] with Serializable
- object WindTurbineType3IECSerializer extends CIMSerializer[WindTurbineType3IEC]
- object WindTurbineType3or4Dynamics extends CIMParseable[WindTurbineType3or4Dynamics] with Serializable
- object WindTurbineType3or4DynamicsSerializer extends CIMSerializer[WindTurbineType3or4Dynamics]
- object WindTurbineType3or4IEC extends CIMParseable[WindTurbineType3or4IEC] with Serializable
- object WindTurbineType3or4IECSerializer extends CIMSerializer[WindTurbineType3or4IEC]
- object WindTurbineType4IEC extends CIMParseable[WindTurbineType4IEC] with Serializable
- object WindTurbineType4IECSerializer extends CIMSerializer[WindTurbineType4IEC]
- object WindTurbineType4aIEC extends CIMParseable[WindTurbineType4aIEC] with Serializable
- object WindTurbineType4aIECSerializer extends CIMSerializer[WindTurbineType4aIEC]
- object WindTurbineType4bIEC extends CIMParseable[WindTurbineType4bIEC] with Serializable
- object WindTurbineType4bIECSerializer extends CIMSerializer[WindTurbineType4bIEC]
- object WindType1or2UserDefined extends CIMParseable[WindType1or2UserDefined] with Serializable
- object WindType1or2UserDefinedSerializer extends CIMSerializer[WindType1or2UserDefined]
- object WindType3or4UserDefined extends CIMParseable[WindType3or4UserDefined] with Serializable
- object WindType3or4UserDefinedSerializer extends CIMSerializer[WindType3or4UserDefined]
- object WindingInsulation extends CIMParseable[WindingInsulation] with Serializable
- object WindingInsulationSerializer extends CIMSerializer[WindingInsulation]
- object WireAssemblyInfo extends CIMParseable[WireAssemblyInfo] with Serializable
- object WireAssemblyInfoSerializer extends CIMSerializer[WireAssemblyInfo]
- object WireInfo extends CIMParseable[WireInfo] with Serializable
- object WireInfoSerializer extends CIMSerializer[WireInfo]
- object WirePhaseInfo extends CIMParseable[WirePhaseInfo] with Serializable
- object WirePhaseInfoSerializer extends CIMSerializer[WirePhaseInfo]
- object WirePosition extends CIMParseable[WirePosition] with Serializable
- object WirePositionSerializer extends CIMSerializer[WirePosition]
- object WireSegment extends CIMParseable[WireSegment] with Serializable
- object WireSegmentPhase extends CIMParseable[WireSegmentPhase] with Serializable
- object WireSegmentPhaseSerializer extends CIMSerializer[WireSegmentPhase]
- object WireSegmentSerializer extends CIMSerializer[WireSegment]
- object WireSpacingInfo extends CIMParseable[WireSpacingInfo] with Serializable
- object WireSpacingInfoSerializer extends CIMSerializer[WireSpacingInfo]
- object Work extends CIMParseable[Work] with Serializable
- object WorkActivityRecord extends CIMParseable[WorkActivityRecord] with Serializable
- object WorkActivityRecordSerializer extends CIMSerializer[WorkActivityRecord]
- object WorkAsset extends CIMParseable[WorkAsset] with Serializable
- object WorkAssetSerializer extends CIMSerializer[WorkAsset]
- object WorkBillingInfo extends CIMParseable[WorkBillingInfo] with Serializable
- object WorkBillingInfoSerializer extends CIMSerializer[WorkBillingInfo]
- object WorkCostDetail extends CIMParseable[WorkCostDetail] with Serializable
- object WorkCostDetailSerializer extends CIMSerializer[WorkCostDetail]
- object WorkCostSummary extends CIMParseable[WorkCostSummary] with Serializable
- object WorkCostSummarySerializer extends CIMSerializer[WorkCostSummary]
- object WorkDocument extends CIMParseable[WorkDocument] with Serializable
- object WorkDocumentSerializer extends CIMSerializer[WorkDocument]
- object WorkFlowStep extends CIMParseable[WorkFlowStep] with Serializable
- object WorkFlowStepSerializer extends CIMSerializer[WorkFlowStep]
- object WorkIdentifiedObject extends CIMParseable[WorkIdentifiedObject] with Serializable
- object WorkIdentifiedObjectSerializer extends CIMSerializer[WorkIdentifiedObject]
- object WorkLocation extends CIMParseable[WorkLocation] with Serializable
- object WorkLocationSerializer extends CIMSerializer[WorkLocation]
- object WorkSerializer extends CIMSerializer[Work]
- object WorkTask extends CIMParseable[WorkTask] with Serializable
- object WorkTaskSerializer extends CIMSerializer[WorkTask]
- object WorkTimeSchedule extends CIMParseable[WorkTimeSchedule] with Serializable
- object WorkTimeScheduleKind extends CIMParseable[WorkTimeScheduleKind] with Serializable
- object WorkTimeScheduleKindSerializer extends CIMSerializer[WorkTimeScheduleKind]
- object WorkTimeScheduleSerializer extends CIMSerializer[WorkTimeSchedule]
- object Zone extends CIMParseable[Zone] with Serializable
- object ZoneSerializer extends CIMSerializer[Zone]