Class: Monitor¶

A Monitor object in OpenDSS.

 classDiagram
    class Monitor
    click Monitor href "../Monitor/"
      Monitor : action

      Monitor : basefreq

      Monitor : element

      Monitor : enabled

      Monitor : like

      Monitor : mode

      Monitor : name

      Monitor : PPolar

      Monitor : residual

      Monitor : terminal

      Monitor : VIPolar

Class Properties¶

Property	Value
Class URI	dss:Monitor

Slots¶

Name	Cardinality and Range	Description	Inheritance
name	1 String	Object name	direct
element	0..1 String	Name (Full Object name) of element to which the monitor is connected	direct
terminal	0..1 Integer	Number of the terminal of the circuit element to which the monitor is connect...	direct
mode	0..1 Integer	Bitmask integer designating the values the monitor is to capture: 0 = Voltage...	direct
action	0..1 Float	{Clear	Save
residual	0..1 Float	{Yes/True	No/False} Default = No
VIPolar	0..1 Float	{Yes/True	No/False} Default = YES
PPolar	0..1 Float	{Yes/True	No/False} Default = YES
basefreq	0..1 Float	Base Frequency for ratings	direct
enabled	0..1 Boolean	{Yes	No or True
like	0..1 String	Make like another object, e	direct

Identifier and Mapping Information¶

Schema Source¶

from schema: https://gridappsd.github.io/dss-graph/opendss

Mappings¶

Mapping Type	Mapped Value
self	dss:Monitor
native	dss:Monitor

LinkML Source¶

Direct¶

name: Monitor
description: A Monitor object in OpenDSS.
from_schema: https://gridappsd.github.io/dss-graph/opendss
attributes:
  name:
    name: name
    description: Object name. Must be unique per object type.
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    identifier: true
    domain_of:
    - Load
    - Generator
    - Generic5
    - Gicline
    - Indmach012
    - Pvsystem
    - Storage
    - Upfc
    - Vccs
    - Vsconverter
    - Windgen
    - Autotrans
    - Capacitor
    - Gictransformer
    - Line
    - Reactor
    - Transformer
    - Capcontrol
    - Espvlcontrol
    - Expcontrol
    - Fuse
    - Gendispatcher
    - Invcontrol
    - Pycontrol
    - Recloser
    - Regcontrol
    - Relay
    - Storagecontroller
    - Swtcontrol
    - Upfccontrol
    - Cndata
    - Dynamicexp
    - Growthshape
    - Linecode
    - Linegeometry
    - Linespacing
    - Loadshape
    - Priceshape
    - Spectrum
    - TccCurve
    - Tsdata
    - Tshape
    - Wiredata
    - Xfmrcode
    - Xycurve
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: string
    required: true
  element:
    name: element
    annotations:
      order:
        tag: order
        value: 1
    description: Name (Full Object name) of element to which the monitor is connected
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    domain_of:
    - Capcontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    range: string
    required: false
  terminal:
    name: terminal
    annotations:
      order:
        tag: order
        value: 2
    description: Number of the terminal of the circuit element to which the monitor
      is connected
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    domain_of:
    - Capcontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    range: integer
    required: false
  mode:
    name: mode
    annotations:
      order:
        tag: order
        value: 3
    description: 'Bitmask integer designating the values the monitor is to capture:
      0 = Voltages and currents at designated terminal1 = Powers at designated terminal2
      = Tap Position (Transformer Device only)3 = ...'
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    domain_of:
    - Fmonitor
    - Monitor
    range: integer
    required: false
  action:
    name: action
    annotations:
      order:
        tag: order
        value: 4
    description: '{Clear | Save | Take | Process}(C)lears or (S)aves current buffer'
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    domain_of:
    - Relay
    - Loadshape
    - Priceshape
    - Tshape
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    range: float
    required: false
  residual:
    name: residual
    annotations:
      order:
        tag: order
        value: 5
    description: '{Yes/True | No/False} Default = No'
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    domain_of:
    - Fmonitor
    - Monitor
    range: float
    required: false
  VIPolar:
    name: VIPolar
    annotations:
      order:
        tag: order
        value: 6
    description: '{Yes/True | No/False} Default = YES'
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    domain_of:
    - Fmonitor
    - Monitor
    range: float
    required: false
  PPolar:
    name: PPolar
    annotations:
      order:
        tag: order
        value: 7
    description: '{Yes/True | No/False} Default = YES'
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    domain_of:
    - Fmonitor
    - Monitor
    range: float
    required: false
  basefreq:
    name: basefreq
    annotations:
      order:
        tag: order
        value: 8
    description: Base Frequency for ratings
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    domain_of:
    - Load
    - Generator
    - Generic5
    - Gicline
    - Indmach012
    - Pvsystem
    - Storage
    - Upfc
    - Vccs
    - Vsconverter
    - Windgen
    - Autotrans
    - Capacitor
    - Gictransformer
    - Line
    - Reactor
    - Transformer
    - Capcontrol
    - Espvlcontrol
    - Expcontrol
    - Fuse
    - Gendispatcher
    - Invcontrol
    - Pycontrol
    - Recloser
    - Regcontrol
    - Relay
    - Storagecontroller
    - Swtcontrol
    - Upfccontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: float
    required: false
  enabled:
    name: enabled
    annotations:
      order:
        tag: order
        value: 9
    description: '{Yes|No or True|False} Indicates whether this element is enabled'
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    domain_of:
    - Load
    - Generator
    - Generic5
    - Gicline
    - Indmach012
    - Pvsystem
    - Storage
    - Upfc
    - Vccs
    - Vsconverter
    - Windgen
    - Autotrans
    - Capacitor
    - Gictransformer
    - Line
    - Reactor
    - Transformer
    - Capcontrol
    - Espvlcontrol
    - Expcontrol
    - Fuse
    - Gendispatcher
    - Invcontrol
    - Pycontrol
    - Recloser
    - Regcontrol
    - Relay
    - Storagecontroller
    - Swtcontrol
    - Upfccontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: boolean
    required: false
  like:
    name: like
    annotations:
      order:
        tag: order
        value: 10
    description: Make like another object, e
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    domain_of:
    - Load
    - Generator
    - Generic5
    - Gicline
    - Indmach012
    - Pvsystem
    - Storage
    - Upfc
    - Vccs
    - Vsconverter
    - Windgen
    - Autotrans
    - Capacitor
    - Gictransformer
    - Line
    - Reactor
    - Transformer
    - Capcontrol
    - Espvlcontrol
    - Expcontrol
    - Fuse
    - Gendispatcher
    - Invcontrol
    - Pycontrol
    - Recloser
    - Regcontrol
    - Relay
    - Storagecontroller
    - Swtcontrol
    - Upfccontrol
    - Cndata
    - Dynamicexp
    - Growthshape
    - Linecode
    - Linegeometry
    - Linespacing
    - Loadshape
    - Priceshape
    - Spectrum
    - TccCurve
    - Tsdata
    - Tshape
    - Wiredata
    - Xfmrcode
    - Xycurve
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: string
    required: false
class_uri: dss:Monitor

Induced¶

name: Monitor
description: A Monitor object in OpenDSS.
from_schema: https://gridappsd.github.io/dss-graph/opendss
attributes:
  name:
    name: name
    description: Object name. Must be unique per object type.
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    identifier: true
    owner: Monitor
    domain_of:
    - Load
    - Generator
    - Generic5
    - Gicline
    - Indmach012
    - Pvsystem
    - Storage
    - Upfc
    - Vccs
    - Vsconverter
    - Windgen
    - Autotrans
    - Capacitor
    - Gictransformer
    - Line
    - Reactor
    - Transformer
    - Capcontrol
    - Espvlcontrol
    - Expcontrol
    - Fuse
    - Gendispatcher
    - Invcontrol
    - Pycontrol
    - Recloser
    - Regcontrol
    - Relay
    - Storagecontroller
    - Swtcontrol
    - Upfccontrol
    - Cndata
    - Dynamicexp
    - Growthshape
    - Linecode
    - Linegeometry
    - Linespacing
    - Loadshape
    - Priceshape
    - Spectrum
    - TccCurve
    - Tsdata
    - Tshape
    - Wiredata
    - Xfmrcode
    - Xycurve
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: string
    required: true
  element:
    name: element
    annotations:
      order:
        tag: order
        value: 1
    description: Name (Full Object name) of element to which the monitor is connected
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    owner: Monitor
    domain_of:
    - Capcontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    range: string
    required: false
  terminal:
    name: terminal
    annotations:
      order:
        tag: order
        value: 2
    description: Number of the terminal of the circuit element to which the monitor
      is connected
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    owner: Monitor
    domain_of:
    - Capcontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    range: integer
    required: false
  mode:
    name: mode
    annotations:
      order:
        tag: order
        value: 3
    description: 'Bitmask integer designating the values the monitor is to capture:
      0 = Voltages and currents at designated terminal1 = Powers at designated terminal2
      = Tap Position (Transformer Device only)3 = ...'
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    owner: Monitor
    domain_of:
    - Fmonitor
    - Monitor
    range: integer
    required: false
  action:
    name: action
    annotations:
      order:
        tag: order
        value: 4
    description: '{Clear | Save | Take | Process}(C)lears or (S)aves current buffer'
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    owner: Monitor
    domain_of:
    - Relay
    - Loadshape
    - Priceshape
    - Tshape
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    range: float
    required: false
  residual:
    name: residual
    annotations:
      order:
        tag: order
        value: 5
    description: '{Yes/True | No/False} Default = No'
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    owner: Monitor
    domain_of:
    - Fmonitor
    - Monitor
    range: float
    required: false
  VIPolar:
    name: VIPolar
    annotations:
      order:
        tag: order
        value: 6
    description: '{Yes/True | No/False} Default = YES'
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    owner: Monitor
    domain_of:
    - Fmonitor
    - Monitor
    range: float
    required: false
  PPolar:
    name: PPolar
    annotations:
      order:
        tag: order
        value: 7
    description: '{Yes/True | No/False} Default = YES'
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    owner: Monitor
    domain_of:
    - Fmonitor
    - Monitor
    range: float
    required: false
  basefreq:
    name: basefreq
    annotations:
      order:
        tag: order
        value: 8
    description: Base Frequency for ratings
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    owner: Monitor
    domain_of:
    - Load
    - Generator
    - Generic5
    - Gicline
    - Indmach012
    - Pvsystem
    - Storage
    - Upfc
    - Vccs
    - Vsconverter
    - Windgen
    - Autotrans
    - Capacitor
    - Gictransformer
    - Line
    - Reactor
    - Transformer
    - Capcontrol
    - Espvlcontrol
    - Expcontrol
    - Fuse
    - Gendispatcher
    - Invcontrol
    - Pycontrol
    - Recloser
    - Regcontrol
    - Relay
    - Storagecontroller
    - Swtcontrol
    - Upfccontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: float
    required: false
  enabled:
    name: enabled
    annotations:
      order:
        tag: order
        value: 9
    description: '{Yes|No or True|False} Indicates whether this element is enabled'
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    owner: Monitor
    domain_of:
    - Load
    - Generator
    - Generic5
    - Gicline
    - Indmach012
    - Pvsystem
    - Storage
    - Upfc
    - Vccs
    - Vsconverter
    - Windgen
    - Autotrans
    - Capacitor
    - Gictransformer
    - Line
    - Reactor
    - Transformer
    - Capcontrol
    - Espvlcontrol
    - Expcontrol
    - Fuse
    - Gendispatcher
    - Invcontrol
    - Pycontrol
    - Recloser
    - Regcontrol
    - Relay
    - Storagecontroller
    - Swtcontrol
    - Upfccontrol
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: boolean
    required: false
  like:
    name: like
    annotations:
      order:
        tag: order
        value: 10
    description: Make like another object, e
    from_schema: https://gridappsd.github.io/dss-graph/meters/monitor
    owner: Monitor
    domain_of:
    - Load
    - Generator
    - Generic5
    - Gicline
    - Indmach012
    - Pvsystem
    - Storage
    - Upfc
    - Vccs
    - Vsconverter
    - Windgen
    - Autotrans
    - Capacitor
    - Gictransformer
    - Line
    - Reactor
    - Transformer
    - Capcontrol
    - Espvlcontrol
    - Expcontrol
    - Fuse
    - Gendispatcher
    - Invcontrol
    - Pycontrol
    - Recloser
    - Regcontrol
    - Relay
    - Storagecontroller
    - Swtcontrol
    - Upfccontrol
    - Cndata
    - Dynamicexp
    - Growthshape
    - Linecode
    - Linegeometry
    - Linespacing
    - Loadshape
    - Priceshape
    - Spectrum
    - TccCurve
    - Tsdata
    - Tshape
    - Wiredata
    - Xfmrcode
    - Xycurve
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    - Fault
    - Gicsource
    - Isource
    - Vsource
    range: string
    required: false
class_uri: dss:Monitor