Class: Gendispatcher¶

A Gendispatcher object in OpenDSS.

 classDiagram
    class Gendispatcher
    click Gendispatcher href "../Gendispatcher/"
      Gendispatcher : basefreq

      Gendispatcher : Element

      Gendispatcher : enabled

      Gendispatcher : GenList

      Gendispatcher : kvarlimit

      Gendispatcher : kWBand

      Gendispatcher : kWLimit

      Gendispatcher : like

      Gendispatcher : name

      Gendispatcher : Terminal

Class Properties¶

Property	Value
Class URI	dss:Gendispatcher

Slots¶

Name	Cardinality and Range	Description	Inheritance
name	1 String	Object name	direct
Element	0..1 String	Full object name of the circuit element, typically a line or transformer, whi...	direct
Terminal	0..1 Integer	Number of the terminal of the circuit element to which the GenDispatcher cont...	direct
kWLimit	0..1 Float	kW Limit for the monitored element	direct
kWBand	0..1 Float	Bandwidth (kW) of the dead band around the target limit	direct
kvarlimit	0..1 Float	Max kvar to be delivered through the element	direct
GenList	0..1 String	Array list of generators to be dispatched	direct
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:Gendispatcher
native	dss:Gendispatcher

LinkML Source¶

Direct¶

name: Gendispatcher
description: A Gendispatcher 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/controls/gendispatcher
    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: Full object name of the circuit element, typically a line or transformer,
      which the control is monitoring
    from_schema: https://gridappsd.github.io/dss-graph/controls/gendispatcher
    domain_of:
    - Upfc
    - Espvlcontrol
    - Gendispatcher
    - Storagecontroller
    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 GenDispatcher
      control is connected
    from_schema: https://gridappsd.github.io/dss-graph/controls/gendispatcher
    domain_of:
    - Espvlcontrol
    - Gendispatcher
    - Storagecontroller
    range: integer
    required: false
  kWLimit:
    name: kWLimit
    annotations:
      order:
        tag: order
        value: 3
    description: kW Limit for the monitored element
    from_schema: https://gridappsd.github.io/dss-graph/controls/gendispatcher
    rank: 1000
    domain_of:
    - Gendispatcher
    range: float
    required: false
  kWBand:
    name: kWBand
    annotations:
      order:
        tag: order
        value: 4
    description: Bandwidth (kW) of the dead band around the target limit
    from_schema: https://gridappsd.github.io/dss-graph/controls/gendispatcher
    domain_of:
    - Espvlcontrol
    - Gendispatcher
    - Storagecontroller
    range: float
    required: false
  kvarlimit:
    name: kvarlimit
    annotations:
      order:
        tag: order
        value: 5
    description: Max kvar to be delivered through the element
    from_schema: https://gridappsd.github.io/dss-graph/controls/gendispatcher
    domain_of:
    - Espvlcontrol
    - Gendispatcher
    range: float
    required: false
  GenList:
    name: GenList
    annotations:
      order:
        tag: order
        value: 6
    description: Array list of generators to be dispatched
    from_schema: https://gridappsd.github.io/dss-graph/controls/gendispatcher
    rank: 1000
    domain_of:
    - Gendispatcher
    range: string
    required: false
  basefreq:
    name: basefreq
    annotations:
      order:
        tag: order
        value: 7
    description: Base Frequency for ratings
    from_schema: https://gridappsd.github.io/dss-graph/controls/gendispatcher
    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: 8
    description: '{Yes|No or True|False} Indicates whether this element is enabled'
    from_schema: https://gridappsd.github.io/dss-graph/controls/gendispatcher
    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: 9
    description: Make like another object, e
    from_schema: https://gridappsd.github.io/dss-graph/controls/gendispatcher
    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:Gendispatcher

Induced¶

name: Gendispatcher
description: A Gendispatcher 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/controls/gendispatcher
    identifier: true
    owner: Gendispatcher
    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: Full object name of the circuit element, typically a line or transformer,
      which the control is monitoring
    from_schema: https://gridappsd.github.io/dss-graph/controls/gendispatcher
    owner: Gendispatcher
    domain_of:
    - Upfc
    - Espvlcontrol
    - Gendispatcher
    - Storagecontroller
    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 GenDispatcher
      control is connected
    from_schema: https://gridappsd.github.io/dss-graph/controls/gendispatcher
    owner: Gendispatcher
    domain_of:
    - Espvlcontrol
    - Gendispatcher
    - Storagecontroller
    range: integer
    required: false
  kWLimit:
    name: kWLimit
    annotations:
      order:
        tag: order
        value: 3
    description: kW Limit for the monitored element
    from_schema: https://gridappsd.github.io/dss-graph/controls/gendispatcher
    rank: 1000
    owner: Gendispatcher
    domain_of:
    - Gendispatcher
    range: float
    required: false
  kWBand:
    name: kWBand
    annotations:
      order:
        tag: order
        value: 4
    description: Bandwidth (kW) of the dead band around the target limit
    from_schema: https://gridappsd.github.io/dss-graph/controls/gendispatcher
    owner: Gendispatcher
    domain_of:
    - Espvlcontrol
    - Gendispatcher
    - Storagecontroller
    range: float
    required: false
  kvarlimit:
    name: kvarlimit
    annotations:
      order:
        tag: order
        value: 5
    description: Max kvar to be delivered through the element
    from_schema: https://gridappsd.github.io/dss-graph/controls/gendispatcher
    owner: Gendispatcher
    domain_of:
    - Espvlcontrol
    - Gendispatcher
    range: float
    required: false
  GenList:
    name: GenList
    annotations:
      order:
        tag: order
        value: 6
    description: Array list of generators to be dispatched
    from_schema: https://gridappsd.github.io/dss-graph/controls/gendispatcher
    rank: 1000
    owner: Gendispatcher
    domain_of:
    - Gendispatcher
    range: string
    required: false
  basefreq:
    name: basefreq
    annotations:
      order:
        tag: order
        value: 7
    description: Base Frequency for ratings
    from_schema: https://gridappsd.github.io/dss-graph/controls/gendispatcher
    owner: Gendispatcher
    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: 8
    description: '{Yes|No or True|False} Indicates whether this element is enabled'
    from_schema: https://gridappsd.github.io/dss-graph/controls/gendispatcher
    owner: Gendispatcher
    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: 9
    description: Make like another object, e
    from_schema: https://gridappsd.github.io/dss-graph/controls/gendispatcher
    owner: Gendispatcher
    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:Gendispatcher