Class: Loadshape

A Loadshape object in OpenDSS.

URI: dss:Loadshape

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

      Loadshape : csvfile

      Loadshape : dblfile

      Loadshape : hour

      Loadshape : Interpolation

      Loadshape : interval

      Loadshape : like

      Loadshape : mean

      Loadshape : MemoryMapping

      Loadshape : minterval

      Loadshape : Mode

      Loadshape : mult

      Loadshape : name

      Loadshape : npts

      Loadshape : Pbase

      Loadshape : Pmax

      Loadshape : Pmult

      Loadshape : PQCSVFile

      Loadshape : Qbase

      Loadshape : Qmax

      Loadshape : qmult

      Loadshape : sinterval

      Loadshape : sngfile

      Loadshape : stddev

      Loadshape : UseActual

Class Properties

Property	Value
Class URI	dss:Loadshape

Slots

Name	Cardinality and Range	Description	Inheritance
name	1 String	Object name	direct
npts	0..1 Integer	Max number of points to expect in load shape vectors	direct
interval	0..1 Float	Time interval for fixed interval data, hrs	direct
mult	0..1 Integer	Array of multiplier values for active power (P) or other key value (such as p...	direct
hour	0..1 String	Array of hour values	direct
mean	0..1 Float	Mean of the active power multipliers	direct
stddev	0..1 Float	Standard deviation of active power multipliers	direct
csvfile	0..1 Integer	Switch input of active power load curve data to a CSV text file containing (h...	direct
sngfile	0..1 Integer	Switch input of active power load curve data to a binary file of singles cont...	direct
dblfile	0..1 Integer	Switch input of active power load curve data to a binary file of doubles cont...	direct
action	0..1 Float	{NORMALIZE	DblSave
qmult	0..1 Float	Array of multiplier values for reactive power (Q)	direct
UseActual	0..1 Boolean	{Yes	No*
Pmax	0..1 Float	kW value at the time of max power	direct
Qmax	0..1 Float	kvar value at the time of max kW power	direct
sinterval	0..1 String	Specify fixed interval in SECONDS	direct
minterval	0..1 String	Specify fixed interval in MINUTES	direct
Pbase	0..1 String	Base P value for normalization	direct
Qbase	0..1 String	Base Q value for normalization	direct
Pmult	0..1 String	Synonym for "mult"	direct
PQCSVFile	0..1 Float	Switch input to a CSV text file containing (active, reactive) power (P, Q) mu...	direct
MemoryMapping	0..1 Boolean	{Yes	No*
Mode	0..1 Float	{carryover	default} carryover will initialize generator dispatch from lates...
Interpolation	0..1 String	{AVG*	EDGE} Defines the interpolation method used for connecting distant do...
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:Loadshape
native	dss:Loadshape

LinkML Source

Direct

name: Loadshape
description: A Loadshape 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/general/loadshape
    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
  npts:
    name: npts
    annotations:
      order:
        tag: order
        value: 1
    description: Max number of points to expect in load shape vectors
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    domain_of:
    - Growthshape
    - Loadshape
    - Priceshape
    - TccCurve
    - Tshape
    - Xycurve
    range: integer
    required: false
  interval:
    name: interval
    annotations:
      order:
        tag: order
        value: 2
    description: Time interval for fixed interval data, hrs
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    domain_of:
    - Loadshape
    - Priceshape
    - Tshape
    range: float
    required: false
  mult:
    name: mult
    annotations:
      order:
        tag: order
        value: 3
    description: Array of multiplier values for active power (P) or other key value
      (such as pu V for Vsource)
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    domain_of:
    - Growthshape
    - Loadshape
    range: integer
    required: false
  hour:
    name: hour
    annotations:
      order:
        tag: order
        value: 4
    description: Array of hour values
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    domain_of:
    - Loadshape
    - Priceshape
    - Tshape
    range: string
    required: false
  mean:
    name: mean
    annotations:
      order:
        tag: order
        value: 5
    description: Mean of the active power multipliers
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    domain_of:
    - Loadshape
    - Priceshape
    - Tshape
    range: float
    required: false
  stddev:
    name: stddev
    annotations:
      order:
        tag: order
        value: 6
    description: Standard deviation of active power multipliers
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    domain_of:
    - Loadshape
    - Priceshape
    - Tshape
    range: float
    required: false
  csvfile:
    name: csvfile
    annotations:
      order:
        tag: order
        value: 7
    description: Switch input of active power load curve data to a CSV text file containing
      (hour, mult) points, or simply (mult) values for fixed time interval data, one
      per line
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    domain_of:
    - Growthshape
    - Loadshape
    - Priceshape
    - Tshape
    - Xycurve
    range: integer
    required: false
  sngfile:
    name: sngfile
    annotations:
      order:
        tag: order
        value: 8
    description: Switch input of active power load curve data to a binary file of
      singles containing (hour, mult) points, or simply (mult) values for fixed time
      interval data, packed one after another
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    domain_of:
    - Growthshape
    - Loadshape
    - Priceshape
    - Tshape
    - Xycurve
    range: integer
    required: false
  dblfile:
    name: dblfile
    annotations:
      order:
        tag: order
        value: 9
    description: Switch input of active power load curve data to a binary file of
      doubles containing (hour, mult) points, or simply (mult) values for fixed time
      interval data, packed one after another
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    domain_of:
    - Growthshape
    - Loadshape
    - Priceshape
    - Tshape
    - Xycurve
    range: integer
    required: false
  action:
    name: action
    annotations:
      order:
        tag: order
        value: 10
    description: '{NORMALIZE | DblSave | SngSave} After defining load curve data,
      setting action=normalize will modify the multipliers so that the peak is 1'
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    domain_of:
    - Relay
    - Loadshape
    - Priceshape
    - Tshape
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    range: float
    required: false
  qmult:
    name: qmult
    annotations:
      order:
        tag: order
        value: 11
    description: Array of multiplier values for reactive power (Q)
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    domain_of:
    - Loadshape
    range: float
    required: false
  UseActual:
    name: UseActual
    annotations:
      order:
        tag: order
        value: 12
    description: '{Yes | No* | True | False*} If true, signifies to Load, Generator,
      Vsource, or other objects to use the return value as the actual kW, kvar, kV,
      or other value rather than a multiplier'
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    domain_of:
    - Loadshape
    range: boolean
    required: false
  Pmax:
    name: Pmax
    annotations:
      order:
        tag: order
        value: 13
    description: kW value at the time of max power
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    domain_of:
    - Loadshape
    range: float
    required: false
  Qmax:
    name: Qmax
    annotations:
      order:
        tag: order
        value: 14
    description: kvar value at the time of max kW power
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    domain_of:
    - Loadshape
    range: float
    required: false
  sinterval:
    name: sinterval
    annotations:
      order:
        tag: order
        value: 15
    description: Specify fixed interval in SECONDS
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    domain_of:
    - Loadshape
    - Priceshape
    - Tshape
    range: string
    required: false
  minterval:
    name: minterval
    annotations:
      order:
        tag: order
        value: 16
    description: Specify fixed interval in MINUTES
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    domain_of:
    - Loadshape
    - Priceshape
    - Tshape
    range: string
    required: false
  Pbase:
    name: Pbase
    annotations:
      order:
        tag: order
        value: 17
    description: Base P value for normalization
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    domain_of:
    - Loadshape
    range: string
    required: false
  Qbase:
    name: Qbase
    annotations:
      order:
        tag: order
        value: 18
    description: Base Q value for normalization
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    domain_of:
    - Loadshape
    range: string
    required: false
  Pmult:
    name: Pmult
    annotations:
      order:
        tag: order
        value: 19
    description: Synonym for "mult"
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    domain_of:
    - Loadshape
    range: string
    required: false
  PQCSVFile:
    name: PQCSVFile
    annotations:
      order:
        tag: order
        value: 20
    description: Switch input to a CSV text file containing (active, reactive) power
      (P, Q) multiplier pairs, one per row
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    domain_of:
    - Loadshape
    range: float
    required: false
  MemoryMapping:
    name: MemoryMapping
    annotations:
      order:
        tag: order
        value: 21
    description: '{Yes | No* | True | False*} Enables the memory mapping functionality
      for dealing with large amounts of load shapes'
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    domain_of:
    - Loadshape
    range: boolean
    required: false
  Mode:
    name: Mode
    annotations:
      order:
        tag: order
        value: 22
    description: '{carryover | default} carryover will initialize generator dispatch
      from latest Pgen/Qgen in memory'
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    domain_of:
    - Upfc
    - Invcontrol
    - Loadshape
    range: float
    required: false
  Interpolation:
    name: Interpolation
    annotations:
      order:
        tag: order
        value: 23
    description: '{AVG* | EDGE} Defines the interpolation method used for connecting
      distant dots within the load shape'
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    domain_of:
    - Loadshape
    range: string
    required: false
  like:
    name: like
    annotations:
      order:
        tag: order
        value: 24
    description: Make like another object, e
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    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:Loadshape

Induced

name: Loadshape
description: A Loadshape 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/general/loadshape
    identifier: true
    owner: Loadshape
    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
  npts:
    name: npts
    annotations:
      order:
        tag: order
        value: 1
    description: Max number of points to expect in load shape vectors
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    owner: Loadshape
    domain_of:
    - Growthshape
    - Loadshape
    - Priceshape
    - TccCurve
    - Tshape
    - Xycurve
    range: integer
    required: false
  interval:
    name: interval
    annotations:
      order:
        tag: order
        value: 2
    description: Time interval for fixed interval data, hrs
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    owner: Loadshape
    domain_of:
    - Loadshape
    - Priceshape
    - Tshape
    range: float
    required: false
  mult:
    name: mult
    annotations:
      order:
        tag: order
        value: 3
    description: Array of multiplier values for active power (P) or other key value
      (such as pu V for Vsource)
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    owner: Loadshape
    domain_of:
    - Growthshape
    - Loadshape
    range: integer
    required: false
  hour:
    name: hour
    annotations:
      order:
        tag: order
        value: 4
    description: Array of hour values
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    owner: Loadshape
    domain_of:
    - Loadshape
    - Priceshape
    - Tshape
    range: string
    required: false
  mean:
    name: mean
    annotations:
      order:
        tag: order
        value: 5
    description: Mean of the active power multipliers
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    owner: Loadshape
    domain_of:
    - Loadshape
    - Priceshape
    - Tshape
    range: float
    required: false
  stddev:
    name: stddev
    annotations:
      order:
        tag: order
        value: 6
    description: Standard deviation of active power multipliers
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    owner: Loadshape
    domain_of:
    - Loadshape
    - Priceshape
    - Tshape
    range: float
    required: false
  csvfile:
    name: csvfile
    annotations:
      order:
        tag: order
        value: 7
    description: Switch input of active power load curve data to a CSV text file containing
      (hour, mult) points, or simply (mult) values for fixed time interval data, one
      per line
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    owner: Loadshape
    domain_of:
    - Growthshape
    - Loadshape
    - Priceshape
    - Tshape
    - Xycurve
    range: integer
    required: false
  sngfile:
    name: sngfile
    annotations:
      order:
        tag: order
        value: 8
    description: Switch input of active power load curve data to a binary file of
      singles containing (hour, mult) points, or simply (mult) values for fixed time
      interval data, packed one after another
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    owner: Loadshape
    domain_of:
    - Growthshape
    - Loadshape
    - Priceshape
    - Tshape
    - Xycurve
    range: integer
    required: false
  dblfile:
    name: dblfile
    annotations:
      order:
        tag: order
        value: 9
    description: Switch input of active power load curve data to a binary file of
      doubles containing (hour, mult) points, or simply (mult) values for fixed time
      interval data, packed one after another
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    owner: Loadshape
    domain_of:
    - Growthshape
    - Loadshape
    - Priceshape
    - Tshape
    - Xycurve
    range: integer
    required: false
  action:
    name: action
    annotations:
      order:
        tag: order
        value: 10
    description: '{NORMALIZE | DblSave | SngSave} After defining load curve data,
      setting action=normalize will modify the multipliers so that the peak is 1'
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    owner: Loadshape
    domain_of:
    - Relay
    - Loadshape
    - Priceshape
    - Tshape
    - Energymeter
    - Fmonitor
    - Monitor
    - Sensor
    range: float
    required: false
  qmult:
    name: qmult
    annotations:
      order:
        tag: order
        value: 11
    description: Array of multiplier values for reactive power (Q)
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    owner: Loadshape
    domain_of:
    - Loadshape
    range: float
    required: false
  UseActual:
    name: UseActual
    annotations:
      order:
        tag: order
        value: 12
    description: '{Yes | No* | True | False*} If true, signifies to Load, Generator,
      Vsource, or other objects to use the return value as the actual kW, kvar, kV,
      or other value rather than a multiplier'
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    owner: Loadshape
    domain_of:
    - Loadshape
    range: boolean
    required: false
  Pmax:
    name: Pmax
    annotations:
      order:
        tag: order
        value: 13
    description: kW value at the time of max power
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    owner: Loadshape
    domain_of:
    - Loadshape
    range: float
    required: false
  Qmax:
    name: Qmax
    annotations:
      order:
        tag: order
        value: 14
    description: kvar value at the time of max kW power
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    owner: Loadshape
    domain_of:
    - Loadshape
    range: float
    required: false
  sinterval:
    name: sinterval
    annotations:
      order:
        tag: order
        value: 15
    description: Specify fixed interval in SECONDS
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    owner: Loadshape
    domain_of:
    - Loadshape
    - Priceshape
    - Tshape
    range: string
    required: false
  minterval:
    name: minterval
    annotations:
      order:
        tag: order
        value: 16
    description: Specify fixed interval in MINUTES
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    owner: Loadshape
    domain_of:
    - Loadshape
    - Priceshape
    - Tshape
    range: string
    required: false
  Pbase:
    name: Pbase
    annotations:
      order:
        tag: order
        value: 17
    description: Base P value for normalization
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    owner: Loadshape
    domain_of:
    - Loadshape
    range: string
    required: false
  Qbase:
    name: Qbase
    annotations:
      order:
        tag: order
        value: 18
    description: Base Q value for normalization
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    owner: Loadshape
    domain_of:
    - Loadshape
    range: string
    required: false
  Pmult:
    name: Pmult
    annotations:
      order:
        tag: order
        value: 19
    description: Synonym for "mult"
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    owner: Loadshape
    domain_of:
    - Loadshape
    range: string
    required: false
  PQCSVFile:
    name: PQCSVFile
    annotations:
      order:
        tag: order
        value: 20
    description: Switch input to a CSV text file containing (active, reactive) power
      (P, Q) multiplier pairs, one per row
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    owner: Loadshape
    domain_of:
    - Loadshape
    range: float
    required: false
  MemoryMapping:
    name: MemoryMapping
    annotations:
      order:
        tag: order
        value: 21
    description: '{Yes | No* | True | False*} Enables the memory mapping functionality
      for dealing with large amounts of load shapes'
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    owner: Loadshape
    domain_of:
    - Loadshape
    range: boolean
    required: false
  Mode:
    name: Mode
    annotations:
      order:
        tag: order
        value: 22
    description: '{carryover | default} carryover will initialize generator dispatch
      from latest Pgen/Qgen in memory'
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    owner: Loadshape
    domain_of:
    - Upfc
    - Invcontrol
    - Loadshape
    range: float
    required: false
  Interpolation:
    name: Interpolation
    annotations:
      order:
        tag: order
        value: 23
    description: '{AVG* | EDGE} Defines the interpolation method used for connecting
      distant dots within the load shape'
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    rank: 1000
    owner: Loadshape
    domain_of:
    - Loadshape
    range: string
    required: false
  like:
    name: like
    annotations:
      order:
        tag: order
        value: 24
    description: Make like another object, e
    from_schema: https://gridappsd.github.io/dss-graph/general/loadshape
    owner: Loadshape
    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:Loadshape