Main API (module DSS)

Command() -> String

Input command string for the DSS. (Getter)

Command(Value::String) -> String

Input command string for the DSS. (Setter)

ActiveClassName() -> String

Returns name of active class.

AllNames() -> Array{String,1}

Array of strings consisting of all element names in the active class.

Count() -> Int64

Number of elements in Active Class. Same as NumElements Property.

First() -> Int64

Sets first element in the active class to be the active DSS object. If object is a CktElement, ActiveCktELment also points to this element. Returns 0 if none.

Name(Value::String)

Name of the Active Element of the Active Class (Setter)

Name() -> String

Name of the Active Element of the Active Class (Getter)

Next() -> Int64

Sets next element in active class to be the active DSS object. If object is a CktElement, ActiveCktElement also points to this element. Returns 0 if no more.

NumElements() -> Int64

Number of elements in this class. Same as Count property.

AllowForms(Value::Bool)

Gets/sets whether text output is allowed (Setter)

AllowForms() -> Bool

Gets/sets whether text output is allowed (Getter)

Classes() -> Array{String,1}

List of DSS intrinsic classes (names of the classes)

ClearAll()

Clear All

DataPath(Value::String)

DSS Data File Path. Default path for reports, etc. from DSS (Setter)

DataPath() -> String

DSS Data File Path. Default path for reports, etc. from DSS (Getter)

DefaultEditor() -> String

Returns the path name for the default text editor.

NewCircuit(name::String) -> String

Create a new circuit

NumCircuits() -> Int64

Number of Circuits currently defined

NumClasses() -> Int64

Number of DSS intrinsic classes

NumUserClasses() -> Int64

Number of user-defined classes

Reset()

Reset

SetActiveClass(ClassName::String) -> Int64

Set the Active Class

Start(code::Int64) -> Bool

Set the start code

UserClasses() -> Array{String,1}

List of user-defined classes

Version() -> String

Get version string for the DSS.

Coorddefined() -> Bool

Indicates whether a coordinate has been defined for this bus

CplxSeqVoltages() -> Array{Complex{Float64},1}

Complex Double array of Sequence Voltages (0, 1, 2) at this Bus.

Cust_Duration() -> Float64

Accumulated customer outage durations

Cust_Interrupts() -> Float64

Annual number of customer-interruptions from this bus

Distance() -> Float64

Distance from energymeter (if non-zero)

GetUniqueNodeNumber(StartNumber::Int64) -> Int64

Get unique node number

Int_Duration() -> Float64

Average interruption duration, hr.

Isc() -> Array{Complex{Float64},1}

Short circuit currents at bus; Complex Array.

Lambda() -> Float64

Accumulated failure rate downstream from this bus; faults per year

N_Customers() -> Int64

Total numbers of customers served downline from this bus

N_interrupts() -> Float64

Number of interruptions this bus per year

Name() -> String

Name of Bus

Nodes() -> Array{Int64,1}

Integer Array of Node Numbers defined at the bus in same order as the voltages.

NumNodes() -> Int64

Number of Nodes this bus.

PuVoltage() -> Array{Complex{Float64},1}

Complex Array of pu voltages at the bus.

SectionID() -> Int64

Integer ID of the feeder section in which this bus is located.

SeqVoltages() -> Array{Float64,1}

Double Array of sequence voltages at this bus.

TotalMiles() -> Float64

Total length of line downline from this bus, in miles. For recloser siting algorithm.

VLL() -> Array{Complex{Float64},1}

For 2- and 3-phase buses, returns array of complex numbers representing L-L voltages in volts. Returns -1.0 for 1-phase bus. If more than 3 phases, returns only first 3.

VMagAngle() -> Array{Float64,1}

Variant Array of doubles containing voltages in Magnitude (VLN), angle (deg)

Voc() -> Array{Complex{Float64},1}

Open circuit voltage; Complex array.

Voltages() -> Array{Complex{Float64},1}

Complex array of voltages at this bus.

X(Value::Float64)

X Coordinate for bus (double) (Setter)

X() -> Float64

X Coordinate for bus (double) (Getter)

Y(Value::Float64)

Y coordinate for bus (double)

Y() -> Float64

Y coordinate for bus (double) (Getter)

YscMatrix() -> Array{Complex{Float64},1}

Complex array of Ysc matrix at bus. Column by column.

Zsc0() -> Complex{Float64}

Complex Zero-Sequence short circuit impedance at bus.

Zsc1() -> Complex{Float64}

Complex Positive-Sequence short circuit impedance at bus..

ZscMatrix() -> Array{Complex{Float64},1}

Complex array of Zsc matrix at bus. Column by column.

ZscRefresh() -> Bool

Check if DoZscRefresh is set

kVBase() -> Float64

Base voltage at bus in kV

puVLL() -> Array{Complex{Float64},1}

Returns Complex array of pu L-L voltages for 2- and 3-phase buses. Returns -1.0 for 1-phase bus. If more than 3 phases, returns only 3 phases.

puVmagAngle() -> Array{Float64,1}

Array of doubles containing voltage magnitude, angle pairs in per unit

AddStep() -> Bool

Check if Capacitor AddStep is set

AllNames() -> Array{String,1}

Array of strings with all Capacitor names in the circuit.

AvailableSteps() -> Int64

Number of Steps available in cap bank to be switched ON.

Close()

Close all phases of Capacitor

Count() -> Int64

Number of Capacitor objects in active circuit.

First() -> Int64

Sets the first Capacitor active. Returns 0 if no more.

IsDelta(Value::Bool)

Delta connection or wye? (Setter)

IsDelta() -> Bool

Delta connection or wye? (Getter)

Name(Value::String)

Sets the active Capacitor by Name. (Setter)

Name() -> String

Sets the active Capacitor by Name. (Getter)

Next() -> Int64

Sets the next Capacitor active. Returns 0 if no more.

NumSteps(Value::Int64)

Number of steps (default 1) for distributing and switching the total bank kVAR. (Setter)

NumSteps() -> Int64

Number of steps (default 1) for distributing and switching the total bank kVAR. (Getter)

Open()

Open all phases of Capacitor

States(Value::Any)

Array of integer [0 ..numSteps-1] indicating the state of each step. (Setter)

States() -> Array{Int64,1}

Array of integer [0..numsteps-1] indicating state of each step. If value is -1 an error has occurred. (Getter)

SubtractStep() -> Bool

Check if Capacitor SubtractStep is set

kV(Value::Float64)

Bank kV rating. Use LL for 2 or 3 phases, or actual can rating for 1 phase. (Setter)

kV() -> Float64

Bank kV rating. Use LL for 2 or 3 phases, or actual can rating for 1 phase. (Getter)

kvar(Value::Float64)

Total bank KVAR, distributed equally among phases and steps. (Setter)

kvar() -> Float64

Total bank KVAR, distributed equally among phases and steps. (Getter)

AllNames() -> Array{String,1}

Array of strings with all CapControl names.

CTRatio(Value::Float64)

Transducer ratio from pirmary current to control current. (Setter)

CTRatio() -> Float64

Transducer ratio from pirmary current to control current. (Getter)

Capacitor(Value::String)

Name of the Capacitor that is controlled. (Setter)

Capacitor() -> String

Name of the Capacitor that is controlled. (Getter)

Count() -> Int64

Number of CapControls in Active Circuit

DeadTime(Value::Float64)

Dead Time for Capacitor Control (Setter)

DeadTime() -> Float64

Dead Time for Capacitor Control (Getter)

Delay(Value::Float64)

Time delay [s] to switch on after arming. Control may reset before actually switching. (Setter)

Delay() -> Float64

Time delay [s] to switch on after arming. Control may reset before actually switching. (Getter)

DelayOff(Value::Float64)

Time delay [s] before switching off a step. Control may reset before actually switching. (Setter)

DelayOff() -> Float64

Time delay [s] before switching off a step. Control may reset before actually switching. (Getter)

First() -> Int64

Sets the first CapControl as active. Return 0 if none.

Mode(Value::Union{Int64, OpenDSSDirect.Lib.CapControlModes})

Type of automatic controller. (Setter)

Mode() -> OpenDSSDirect.Lib.CapControlModes

Type of automatic controller. (Getter)

MonitoredObj(Value::String)

Full name of the element that PT and CT are connected to. (Setter)

MonitoredObj() -> String

Full name of the element that PT and CT are connected to. (Getter)

MonitoredTerm(Value::Int64)

Terminal number on the element that PT and CT are connected to. (Setter)

MonitoredTerm() -> Int64

Terminal number on the element that PT and CT are connected to. (Getter)

Name(Value::String)

Sets a CapControl active by name. (Getter)

Name() -> String

Sets a CapControl active by name. (Getter)

Next() -> Int64

Gets the next CapControl in the circut. Returns 0 if none.

OFFSetting(Value::Int64)

Threshold to switch off a step. See Mode for units. (Setter)

OFFSetting() -> Int64

Threshold to switch off a step. See Mode for units. (Getter)

ONSetting(Value::Int64)

Threshold to arm or switch on a step. See Mode for units. (Setter)

ONSetting() -> Int64

Threshold to arm or switch on a step. See Mode for units. (Getter)

PTRatio(Value::Float64)

Transducer ratio from primary feeder to control voltage. (Setter)

PTRatio() -> Float64

Transducer ratio from primary feeder to control voltage. (Getter)

Reset()

Reset Capacitor Controls

UseVoltOverride(Value::Bool)

Enables Vmin and Vmax to override the control Mode (Setter)

UseVoltOverride() -> Bool

Enables Vmin and Vmax to override the control Mode (Getter)

Vmax(Value::Float64)

With VoltOverride, swtich off whenever PT voltage exceeds this level. (Setter)

Vmax() -> Float64

With VoltOverride, swtich off whenever PT voltage exceeds this level. (Getter)

Vmin(Value::Float64)

With VoltOverride, switch ON whenever PT voltage drops below this level. (Setter)

Vmin() -> Float64

With VoltOverride, switch ON whenever PT voltage drops below this level. (Getter)

AllBusDistances() -> Array{Float64,1}

Returns distance from each bus to parent EnergyMeter. Corresponds to sequence in AllBusNames.

AllBusMagPu() -> Array{Float64,1}

Double Array of all bus voltages (each node) magnitudes in Per unit

AllBusNames() -> Array{String,1}

Array of strings containing names of all buses in circuit (see AllNodeNames).

AllBusVMag() -> Array{Float64,1}

Array of magnitudes (doubles) of voltages at all buses

AllBusVolts() -> Array{Complex{Float64},1}

Complex array of all bus, node voltages from most recent solution

AllElementLosses() -> Array{Float64,1}

Array of total losses (complex) in each circuit element

AllElementNames() -> Array{String,1}

Array of strings containing Full Name of all elements.

AllNodeDistances() -> Array{Float64,1}

Returns an array of distances from parent EnergyMeter for each Node. Corresponds to AllBusVMag sequence.

AllNodeDistancesByPhase(Phase::Any)

Returns an array of doubles representing the distances to parent EnergyMeter. Sequence of array corresponds to other node ByPhase properties.

AllNodeNames() -> Array{String,1}

Array of strings containing full name of each node in system in same order as returned by AllBusVolts, etc.

AllNodeNamesByPhase(Phase::Any)

Return array of strings of the node names for the By Phase criteria. Sequence corresponds to other ByPhase properties.

AllNodeVmagByPhase(Phase::Any)

Returns Array of doubles represent voltage magnitudes for nodes on the specified phase.

AllNodeVmagPUByPhase(Phase::Any)

Returns array of per unit voltage magnitudes for each node by phase

Capacity(Start::Any, Increment::Any) -> Float64

Compute capacity

Disable(Name::String)

Disable circuit

Enable(Name::String)

Enable circuit

EndOfTimeStepUpdate()

Do end of time step update and cleanup

FirstElement() -> Int64

Set first element in active class to be active

FirstPCElement() -> Int64

Set first PCElement to be active

FirstPDElement() -> Int64

Set first PDElement to be active

LineLosses() -> Complex{Float64}

Complex total line losses in the circuit

Losses() -> Complex{Float64}

Total losses in active circuit, complex number (two-element array of double).

Name() -> String

Name of the active circuit.

NextElement() -> Int64

Set next element in active class to be active

NextPCElement() -> Int64

Set next PCElement to be active

NextPDElement() -> Int64

Set next PDElement to be active

NumBuses() -> Int64

Total number of Buses in the circuit.

NumCktElements() -> Int64

Number of CktElements in the circuit.

NumNodes() -> Int64

Total number of nodes in the circuit.

ParentPDElement() -> Int64

Sets Parent PD element, if any, to be the active circuit element and returns index>0; Returns 0 if it fails or not applicable.

Sample()

Sample all meters and monitors

SaveSample()

Save all all meters and monitors registers and buffers

SetActiveBus(BusName::String) -> Int64

Set active bus name

SetActiveBusi(BusIndex::Int64) -> Int64

Set active bus index

SetActiveClass(ClassName::String) -> Int64

Set active class name

SetActiveElement(FullName::String) -> Int64

Set active element full name

SubstationLosses() -> Complex{Float64}

Complex losses in all transformers designated to substations.

SystemY() -> Array{Complex{Float64},2}

System Y matrix (after a solution has been performed)

TotalPower() -> Complex{Float64}

Total power, watts delivered to the circuit

UpdateStorage()

Update storage

YCurrents() -> Array{Complex{Float64},1}

Array of doubles containing complex injection currents for the present solution. Is is the "I" vector of I=YV

YNodeOrder() -> Array{String,1}

Array of strings containing the names of the nodes in the same order as the Y matrix

YNodeVArray() -> Array{Complex{Float64},1}

Complex array of actual node voltages in same order as SystemY matrix.

AllPropertyNames() -> Array{String,1}

Array containing all property names of the active device.

AllVariableNames() -> Array{String,1}

Array of strings listing all the published variable names, if a PCElement. Otherwise, null string.

AllVariableValues() -> Array{Float64,1}

Array of doubles. Values of state variables of active element if PC element.

BusNames(Value::Array{String,1})

Array of strings. Set Bus definitions for each terminal is connected.

BusNames() -> Array{String,1}

Array of strings. Get Bus definitions to which each terminal is connected. 0-based array.

Close(Term::Int64, Phs::Int64)

Close phase of terminal for active circuit element

Controller(idx::Int64) -> String

Full name of the i-th controller attached to this element. Ex: str = Controller(2). See NumControls to determine valid index range

CplxSeqCurrents() -> Array{Complex{Float64},1}

Complex double array of Sequence Currents for all conductors of all terminals of active circuit element.

CplxSeqVoltages() -> Array{Complex{Float64},1}

Complex double array of Sequence Voltage for all terminals of active circuit element.

Currents() -> Array{Complex{Float64},1}

Complex array of currents into each conductor of each terminal

CurrentsMagAng() -> Array{Float64,2}

Currents in magnitude, angle format as a array of doubles.

DisplayName(Value::String)

Display name of the object (not necessarily unique) (Setter)

DisplayName() -> String

Display name of the object (not necessarily unique) (Getter)

EmergAmps(Value::Float64)

Emergency Ampere Rating for PD elements (Setter)

EmergAmps() -> Float64

Emergency Ampere Rating for PD elements (Getter)

Enabled(Value::Bool)

Boolean indicating that element is currently in the circuit. (Setter)

Enabled() -> Bool

Boolean indicating that element is currently in the circuit. (Getter)

EnergyMeter() -> String

Name of the Energy Meter this element is assigned to.

GUID() -> String

globally unique identifier for this object

Handle() -> Int64

Pointer to this object

HasOCPDevice() -> Bool

True if a recloser, relay, or fuse controlling this ckt element. OCP = Overcurrent Protection

HasSwitchControl() -> Bool

This element has a SwtControl attached.

HasVoltControl() -> Bool

This element has a CapControl or RegControl attached.

IsOpen(Term::Int64, Phs::Int64) -> Bool

Check if open phase of terminal for active circuit element

Losses() -> Array{Complex{Float64},1}

Total losses in the element: two-element complex array

Name() -> String

Full Name of Active Circuit Element

NodeOrder() -> Array{Int64,1}

Array of integer containing the node numbers (representing phases, for example) for each conductor of each terminal.

NormalAmps(Value::Float64)

Normal ampere rating for PD Elements (Setter)

NormalAmps() -> Float64

Normal ampere rating for PD Elements (Getter)

NumConductors() -> Int64

Number of Conductors per Terminal

NumControls() -> Int64

Number of controls connected to this device. Use to determine valid range for index into Controller array.

NumPhases() -> Int64

Number of Phases

NumProperties() -> Int64

Number of Properties this Circuit Element.

NumTerminals() -> Int64

Number of Terminals this Circuit Element

OCPDevIndex() -> Int64

Index into Controller list of OCP Device controlling this CktElement

OCPDevType() -> Int64

0=None; 1=Fuse; 2=Recloser; 3=Relay; Type of OCP controller device

Open(Term::Int64, Phs::Int64)

Open phase of terminal for active circuit element

PhaseLosses() -> Array{Complex{Float64},1}

Complex array of losses by phase

Powers() -> Array{Complex{Float64},1}

Complex array of powers into each conductor of each terminal

Residuals() -> Array{Float64,2}

Residual currents for each terminal: (mag, angle)

SeqCurrents() -> Array{Float64,1}

Double array of symmetrical component currents into each 3-phase terminal

SeqPowers() -> Array{Complex{Float64},1}

Double array of sequence powers into each 3-phase teminal

SeqVoltages() -> Array{Float64,1}

Double array of symmetrical component voltages at each 3-phase terminal

Variable(MyVarName::String, Code::Int64) -> Float64

For PCElement, get the value of a variable by name. If Code>0 Then no variable by this name or not a PCElement.

Variablei(Idx::Int64, Code::Int64) -> Float64

For PCElement, get the value of a variable by integer index.

Voltages() -> Array{Complex{Float64},1}

Complex array of voltages at terminals

VoltagesMagAng() -> Array{Float64,2}

Voltages at each conductor in magnitude, angle form as array of doubles.

YPrim() -> Array{Complex{Float64},2}

YPrim matrix, column order, complex numbers (paired)

Action(Param1::Int64)

(write-only) Set the active action by index

ActionCode() -> OpenDSSDirect.Lib.ActionCodes

Code for the active action. Long integer code to tell the control device what to do

ClearActions()

Clear actions for Control Queue

ClearQueue()

Clear queue for Control Queue

Delete(ActionHandle::Int64)

Delete action handle for Control Queue

DeviceHandle() -> Int64

Handle (User defined) to device that must act on the pending action.

DoAllQueue()

Do all actions

NumActions() -> Int64

Number of Actions on the current actionlist (that have been popped off the control queue by CheckControlActions)

PopAction() -> Int64

Pops next action off the action list and makes it the active action. Returns zero if none.

Queue() -> Array{String,1}

Array of strings containing the entire queue in CSV format

QueueSize() -> Int64

Number of items on the OpenDSS control Queue

Show()

Show queue

AllPropertyNames() -> Array{String,1}

Array of strings containing the names of all properties for the active DSS object.

Name() -> String

Full Name of Active DSS Object (general element or circuit element).

NumProperties() -> Int64

Number of Properties for the active DSS object.

Description() -> String

Description of error for last operation

Number() -> Int64

Error Number

Command(i::Int64) -> String

Get i-th command

CommandHelp(i::Int64) -> String

Get help string for i-th command

NumCommands() -> Int64

Number of DSS Executive Commands

NumOptions() -> Int64

Number of DSS Executive Options

Option(i::Int64) -> String

Get i-th option

OptionHelp(i::Int64) -> String

Get help string for i-th option

OptionValue(i::Int64) -> String

Get present value of i-th option

AllNames() -> Array{String,1}

Array of strings containing names of all Fuses in the circuit

Close()

Reset fuse

Count() -> Int64

Number of Fuse elements in the circuit

Delay(Value::Float64)

A fixed delay time in seconds added to the fuse blowing time determined by the TCC curve. Default is 0. (Setter)

Delay() -> Float64

A fixed delay time in seconds added to the fuse blowing time determined by the TCC curve. Default is 0. (Getter)

First() -> Int64

Set the first Fuse to be the active fuse. Returns 0 if none.

Idx(Value::Int64)

Active fuse by index into the list of fuses. 1 indexed based. 1..count (Setter)

Idx() -> Int64

Active fuse by index into the list of fuses. 1 indexed based. 1..count (Getter)

IsBlown() -> Bool

Check if the fuse is blown for any phase

MonitoredObj(Value::String)

Full name of the circuit element to which the fuse is connected.

MonitoredObj() -> String

Full name of the circuit element to which the fuse is connected.

MonitoredTerm(Value::Int64)

Terminal number to which the fuse is connected. (Setter)

MonitoredTerm() -> Int64

Terminal number to which the fuse is connected. (Getter)

Name(Value::String)

Name of the active Fuse element (Setter)

Name() -> String

Name of the active Fuse element (Getter)

Next() -> Int64

Advance the active Fuse element pointer to the next fuse. Returns 0 if no more fuses.

NumPhases() -> Int64

Number of phases, this fuse.

Open()

Open all phases

RatedCurrent(Value::Float64)

Multiplier or actual amps for the TCCcurve object. Defaults to 1.0. Multipliy current values of TCC curve by this to get actual amps. Has to correspond to the Current axis of TCCcurve object. (Setter)

RatedCurrent() -> Float64

Multiplier or actual amps for the TCCcurve object. Defaults to 1.0. Multipliy current values of TCC curve by this to get actual amps. Has to correspond to the Current axis of TCCcurve object. (Getter)

SwitchedObj(Value::String)

Full name of the circuit element switch that the fuse controls. Defaults to the MonitoredObj. (Setter)

SwitchedObj() -> String

Full name of the circuit element switch that the fuse controls. Defaults to the MonitoredObj. (Getter)

SwitchedTerm(Value::Int64)

Number of the terminal of the controlled element containing the switch controlled by the fuse. (Setter)

SwitchedTerm() -> Int64

Number of the terminal of the controlled element containing the switch controlled by the fuse. (Getter)

TCCCurve(Value::String)

Name of the TCCcurve object that determines fuse blowing. (Setter)

TCCCurve() -> String

Name of the TCCcurve object that determines fuse blowing. (Getter)

AllNames() -> Array{String,1}

Array of names of all Generator objects.

Count() -> Int64

Number of Generator Objects in Active Circuit

First() -> Int64

Sets first Generator to be active. Returns 0 if none.

ForcedON(Value::Bool)

Indicates whether the generator is forced ON regardles of other dispatch criteria.

ForcedON() -> Bool

Indicates whether the generator is forced ON regardles of other dispatch criteria.

Idx(Value::Int64)

Active Generator by index into generators list. 1..Count (Setter)

Idx() -> Int64

Active Generator by index into generators list. 1..Count (Getter)

Model(Value::Int64)

Generator Model

Model() -> Int64

Generator Model

Name(Value::String)

Sets a generator active by name.

Name() -> String

Sets a generator active by name.

Next() -> Int64

Sets next Generator to be active. Returns 0 if no more.

PF(Value::Float64)

Power factor (pos. = producing vars). Updates kvar based on present kW value.

PF() -> Float64

Power factor (pos. = producing vars). Updates kvar based on present kW value.

Phases(Value::Int64)

Number of phases

Phases() -> Int64

Number of phases

RegisterNames() -> Array{String,1}

Array of Names of all generator energy meter registers

RegisterValues() -> Array{Float64,1}

Array of valus in generator energy meter registers.

Vmaxpu(Value::Float64)

Vmaxpu for generator model

Vmaxpu() -> Float64

Vmaxpu for generator model

Vminpu(Value::Float64)

Vminpu for Generator model

Vminpu() -> Float64

Vminpu for Generator model

kV(Value::Float64)

Voltage base for the active generator, kV (Setter)

kV() -> Float64

Voltage base for the active generator, kV (Getter)

kVARated(Value::Float64)

kVA rating of the generator (Setter)

kVARated() -> Float64

kVA rating of the generator (Getter)

kW(Value::Float64)

kW output for the active generator. kvar is updated for current power factor. (Setter)

kW() -> Float64

kW output for the active generator. kvar is updated for current power factor. (Getter)

kvar(Value::Float64)

kvar output for the active generator. Updates power factor based on present kW value. (Setter)

kvar() -> Float64

kvar output for the active generator. Updates power factor based on present kW value. (Getter)

AllNames() -> Array{String,1}

Array of strings containing names of all ISOURCE elements.

Amps(Value::Float64)

Magnitude of the ISOURCE in amps

Amps() -> Float64

Magnitude of the ISOURCE in amps

AngleDeg(Value::Float64)

Phase angle for ISOURCE, degrees (Setter)

AngleDeg() -> Float64

Phase angle for ISOURCE, degrees (Getter)

Count() -> Int64

Count: Number of ISOURCE elements.

First() -> Int64

Set the First ISOURCE to be active; returns Zero if none.

Frequency(Value::Float64)

The present frequency of the ISOURCE, Hz (Setter)

Frequency() -> Float64

The present frequency of the ISOURCE, Hz (Getter)

Name(Value::String)

Name of Active ISOURCE (Setter)

Name() -> String

Name of Active ISOURCE (Getter)

Next() -> Int64

Sets the next ISOURCE element to be the active one. Returns Zero if no more.

AllNames() -> Array{String,1}

Array of strings with names of all devices

C0(Value::Float64)

Zero-sequence capacitance, nF per unit length (Setter)

C0() -> Float64

Zero-sequence capacitance, nF per unit length (Getter)

C1(Value::Float64)

Positive-sequence capacitance, nF per unit length (Setter)

C1() -> Float64

Positive-sequence capacitance, nF per unit length (Getter)

Cmatrix(Value::Array{Float64,1})

Capacitance matrix, nF per unit length (Setter)

Cmatrix(Value::Array{Float64,2})

Capacitance matrix, nF per unit length (Setter)

Cmatrix() -> Array{Float64,2}

Capacitance matrix, nF per unit length (Getter)

Count() -> Int64

Number of LineCodes

EmergAmps(Value::Float64)

Emergency ampere rating (Setter)

EmergAmps() -> Float64

Emergency ampere rating (Getter)

IsZ1Z0() -> Bool

Flag denoting whether impedance data were entered in symmetrical components

Name(Value::String)

Name of active LineCode (Setter)

Name() -> String

Name of active LineCode (Getter)

NormAmps(Value::Float64)

Normal Ampere rating (Setter)

NormAmps() -> Float64

Normal Ampere rating (Getter)

Phases(Value::Int64)

Number of Phases (Setter)

Phases() -> Int64

Number of Phases (Getter)

R0(Value::Float64)

Zero-Sequence Resistance, ohms per unit length (Setter)

R0() -> Float64

Zero-Sequence Resistance, ohms per unit length (Getter)

R1(Value::Float64)

Positive-sequence resistance ohms per unit length (Setter)

R1() -> Float64

Positive-sequence resistance ohms per unit length (Getter)

Rmatrix(Value::Array{Float64,1})

Resistance matrix, ohms per unit length (Setter)

Rmatrix(Value::Array{Float64,2})

Resistance matrix, ohms per unit length (Setter)

Rmatrix() -> Array{Float64,2}

Resistance matrix, ohms per unit length (Getter)

Units(Value::Union{Int64, OpenDSSDirect.Lib.LineUnits})

Units of Line Code (Setter)

Units() -> OpenDSSDirect.Lib.LineUnits

Units of Line Code (Getter)

X0(Value::Float64)

Zero Sequence Reactance, ohms per unit length (Setter)

X0() -> Float64

Zero Sequence Reactance, ohms per unit length (Getter)

X1(Value::Float64)

Positive-sequence reactance, ohms per unit length (Setter)

X1() -> Float64

Positive-sequence reactance, ohms per unit length (Getter)

Xmatrix(Value::Array{Float64,1})

Reactance matrix, ohms per unit length (Setter)

Xmatrix(Value::Array{Float64,2})

Reactance matrix, ohms per unit length (Setter)

Xmatrix() -> Array{Float64,2}

Reactance matrix, ohms per unit length (Getter)

Zmatrix(Value::Array{Complex{Float64},2})

Reactance matrix, ohms per unit length (Setter)

Zmatrix() -> Array{Complex{Float64},2}

Reactance matrix, ohms per unit length (Getter)

AllNames() -> Array{String,1}

Names of all Line Objects

Bus1(Value::String)

Name of bus for terminal 1. (Setter)

Bus1() -> String

Name of bus for terminal 1. (Getter)

Bus2(Value::String)

Name of bus for terminal 2. (Setter)

Bus2() -> String

Name of bus for terminal 2. (Getter)

C0(Value::Float64)

Zero Sequence capacitance, nanofarads per unit length. (Setter)

C0() -> Float64

Zero Sequence capacitance, nanofarads per unit length. (Getter)

C1(Value::Float64)

Positive Sequence capacitance, nanofarads per unit length. (Setter)

C1() -> Float64

Positive Sequence capacitance, nanofarads per unit length. (Getter)

CMatrix(Value::Array{Float64,1})

Capacitance matrix, nF per unit length (Setter)

CMatrix(Value::Array{Float64,2})

Capacitance matrix, nF per unit length (Setter)

CMatrix() -> Array{Float64,2}

Capacitance matrix, nF per unit length (Getter)

Count() -> Int64

Number of Line objects in Active Circuit.

EmergAmps(Value::Float64)

Emergency (maximum) ampere rating of Line. (Setter)

EmergAmps() -> Float64

Emergency (maximum) ampere rating of Line. (Getter)

First() -> Int64

Invoking this property sets the first element active. Returns 0 if no lines. Otherwise, index of the line element.

Geometry(Value::String)

Line geometry code (Setter)

Geometry() -> String

Line geometry code (Getter)

Length(Value::Float64)

Length of line section in units compatible with the LineCode definition. (Setter)

Length() -> Float64

Length of line section in units compatible with the LineCode definition. (Getter)

LineCode(Value::String)

Name of LineCode object that defines the impedances. (Setter)

LineCode() -> String

Name of LineCode object that defines the impedances. (Getter)

Name(Value::String)

Specify the name of the Line element to set it active. (Setter)

Name() -> String

Specify the name of the Line element to set it active. (Getter)

New(Name::String) -> Int64

Create new Line object

Next() -> Int64

Invoking this property advances to the next Line element active. Returns 0 if no more lines. Otherwise, index of the line element.

NormAmps(Value::Float64)

Normal ampere rating of Line. (Setter)

NormAmps() -> Float64

Normal ampere rating of Line. (Getter)

NumCust() -> Int64

Number of customers on this line section.

Parent() -> Int64

Sets Parent of the active Line to be the active line. Returns 0 if no parent or action fails.

Phases(Value::Int64)

Number of Phases, this Line element. (Setter)

Phases() -> Int64

Number of Phases, this Line element. (Getter)

R0(Value::Float64)

Zero Sequence resistance, ohms per unit length. (Setter)

R0() -> Float64

Zero Sequence resistance, ohms per unit length. (Getter)

R1(Value::Float64)

Positive Sequence resistance, ohms per unit length. (Setter)

R1() -> Float64

Positive Sequence resistance, ohms per unit length. (Getter)

RMatrix(Value::Array{Float64,1})

Resistance matrix (full), ohms per unit length. Vector of doubles. (Setter)

RMatrix(Value::Array{Float64,2})

Resistance matrix (full), ohms per unit length. Matrix of doubles. (Setter)

RMatrix() -> Array{Float64,2}

Resistance matrix (full), ohms per unit length. Matrix of doubles. (Getter)

Rg(Value::Float64)

Earth return resistance value used to compute line impedances at power frequency (Setter)

Rg() -> Float64

Earth return resistance value used to compute line impedances at power frequency (Getter)

Rho(Value::Float64)

Earth Resistivity, ohm-m (Setter)

Rho() -> Float64

Earth Resistivity, ohm-m (Getter)

Spacing(Value::String)

Line spacing code (Getter)

Spacing() -> String

Line spacing code (Getter)

TotalCust() -> Int64

Total Number of customers served from this line section.

Units(Value::Union{Int64, OpenDSSDirect.Lib.LineUnits})

Units for Line (Setter)

Units() -> OpenDSSDirect.Lib.LineUnits

Units for Line (Getter)

X0(Value::Float64)

Zero Sequence reactance ohms per unit length. (Setter)

X0() -> Float64

Zero Sequence reactance ohms per unit length. (Getter)

X1(Value::Float64)

Positive Sequence reactance, ohms per unit length. (Setter)

X1() -> Float64

Positive Sequence reactance, ohms per unit length. (Getter)

XMatrix(Value::Array{Float64,1})

Susceptance matrix, ohms per unit length. Vector of doubles. (Setter)

XMatrix(Value::Array{Float64,2})

Susceptance matrix, ohms per unit length. Matrix of doubles. (Setter)

XMatrix() -> Array{Float64,2}

Susceptance matrix, ohms per unit length. Matrix of doubles. (Getter)

Xg(Value::Float64)

Earth return reactance value used to compute line impedances at power frequency (Setter)

Xg() -> Float64

Earth return reactance value used to compute line impedances at power frequency (Getter)

Yprim(Value::Array{Complex{Float64},2})

Yprimitive: Does Nothing at present on Put; Dangerous (Setter)

Yprim() -> Array{Complex{Float64},2}

Yprimitive: Does Nothing at present on Put; Dangerous (Getter)

ZMatrix(Value::Array{Complex{Float64},2})

Impedance matrix, ohms per unit length. Matrix of doubles. (Setter)

ZMatrix() -> Array{Complex{Float64},2}

Impedance matrix, ohms per unit length. Matrix of doubles. (Getter)

AllNames() -> Array{String,1}

Array of strings containing all Load names

AllocationFactor(Value::Float64)

Factor for allocating loads by connected xfkva (Setter)

AllocationFactor() -> Float64

Factor for allocating loads by connected xfkva (Getter)

CFactor(Value::Float64)

Factor relates average to peak kw. Used for allocation with kwh and kwhdays/ (Setter)

CFactor() -> Float64

Factor relates average to peak kw. Used for allocation with kwh and kwhdays/ (Getter)

CVRCurve(Value::String)

Name of a loadshape with both Mult and Qmult, for CVR factors as a function of time. (Setter)

CVRCurve() -> String

Name of a loadshape with both Mult and Qmult, for CVR factors as a function of time. (Getter)

CVRvars(Value::Float64)

Percent reduction in Q for percent reduction in V. Must be used with dssLoadModelCVR. (Setter)

CVRvars() -> Float64

Percent reduction in Q for percent reduction in V. Must be used with dssLoadModelCVR. (Getter)

CVRwatts(Value::Float64)

Percent reduction in P for percent reduction in V. Must be used with dssLoadModelCVR. (Setter)

CVRwatts() -> Float64

Percent reduction in P for percent reduction in V. Must be used with dssLoadModelCVR. (Getter)

Class(Value::Int64)

Load Class (Setter)

Class() -> Int64

Load Class (Getter)

Count() -> Int64

Number of Load objects in active circuit.

Daily(Value::String)

Name of the loadshape for a daily load profile. (Setter)

Daily() -> String

Name of the loadshape for a daily load profile. (Getter)

Duty(Value::String)

Name of the loadshape for a duty cycle simulation. (Setter)

Duty() -> String

Name of the loadshape for a duty cycle simulation. (Getter)

First() -> Int64

Set first Load element to be active; returns 0 if none.

Growth(Value::String)

Name of the growthshape curve for yearly load growth factors. (Setter)

Growth() -> String

Name of the growthshape curve for yearly load growth factors. (Getter)

Idx(Value::Int64)

Load Index (Setter)

Idx() -> Int64

Load Index (Getter)

IsDelta(Value::Bool)

Delta loads are connected line-to-line. (Setter)

IsDelta() -> Bool

Delta loads are connected line-to-line. (Getter)

Model(Value::Union{Int64, OpenDSSDirect.Lib.LoadModels})

The Load Model defines variation of P and Q with voltage. (Setter)

Model() -> OpenDSSDirect.Lib.LoadModels

The Load Model defines variation of P and Q with voltage. (Getter)

Name(Value::String)

Set active load by name. (Setter)

Name() -> String

Set active load by name. (Getter)

Next() -> Int64

Sets next Load element to be active; returns 0 of none else index of active load.

NumCust(Value::Int64)

Number of customers in this load, defaults to one. (Setter)

NumCust() -> Int64

Number of customers in this load, defaults to one. (Getter)

PF(Value::Float64)

Power Factor for Active Load. Specify leading PF as negative. Updates kvar based on present value of kW value (Setter)

PF() -> Float64

Power Factor for Active Load. Specify leading PF as negative. Updates kvar based on present value of kW value (Getter)

PctMean(Value::Float64)

Average percent of nominal load in Monte Carlo studies; only if no loadshape defined for this load. (Setter)

PctMean() -> Float64

Average percent of nominal load in Monte Carlo studies; only if no loadshape defined for this load. (Getter)

PctStdDev(Value::Float64)

Percent standard deviation for Monte Carlo load studies; if there is no loadshape assigned to this load. (Setter)

PctStdDev() -> Float64

Percent standard deviation for Monte Carlo load studies; if there is no loadshape assigned to this load. (Getter)

RelWeighting(Value::Float64)

Relative Weighting factor for the active LOAD (Setter)

RelWeighting() -> Float64

Relative Weighting factor for the active LOAD (Getter)

Rneut(Value::Float64)

Neutral resistance for wye-connected loads. (Setter)

Rneut() -> Float64

Neutral resistance for wye-connected loads. (Getter)

Spectrum(Value::String)

Load Spectrum (Setter)

Spectrum() -> String

Load Spectrum (Getter)

Status(Value::Union{Int64, OpenDSSDirect.Lib.LoadStatus})

Response to load multipliers: Fixed (growth only), Exempt (no LD curve), Variable (all). (Setter)

Status() -> OpenDSSDirect.Lib.LoadStatus

Response to load multipliers: Fixed (growth only), Exempt (no LD curve), Variable (all). (Getter)

Vmaxpu(Value::Float64)

Maximum per-unit voltage to use the load model. Above this, constant Z applies. (Setter)

Vmaxpu() -> Float64

Maximum per-unit voltage to use the load model. Above this, constant Z applies. (Getter)

VminEmerg(Value::Float64)

Minimum voltage for unserved energy (UE) evaluation. (Setter)

VminEmerg() -> Float64

Minimum voltage for unserved energy (UE) evaluation. (Getter)

VminNorm(Value::Float64)

Minimum voltage for energy exceeding normal (EEN) evaluations. (Setter)

VminNorm() -> Float64

Minimum voltage for energy exceeding normal (EEN) evaluations. (Getter)

Vminpu(Value::Float64)

Minimum voltage to apply the load model. Below this, constant Z is used. (Setter)

Vminpu() -> Float64

Minimum voltage to apply the load model. Below this, constant Z is used. (Getter)

XfkVA(Value::Float64)

Rated service transformer kVA for load allocation, using AllocationFactor. Affects kW, kvar, and pf. (Setter)

XfkVA() -> Float64

Rated service transformer kVA for load allocation, using AllocationFactor. Affects kW, kvar, and pf. (Getter)

Xneut(Value::Float64)

Neutral reactance for wye-connected loads. (Setter)

Xneut() -> Float64

Neutral reactance for wye-connected loads. (Getter)

Yearly(Value::String)

Name of yearly duration loadshape (Setter)

Yearly() -> String

Name of yearly duration loadshape (Getter)

ZipV(Value::Array{Float64,1})

Array of 7 doubles with values for ZIPV property of the LOAD object (Setter)

ZipV() -> Array{Float64,1}

Array of 7 doubles with values for ZIPV property of the LOAD object (Getter)

kV(Value::Float64)

Set kV rating for active Load. For 2 or more phases set Line-Line kV. Else actual kV across terminals. (Setter)

kV() -> Float64

Set kV rating for active Load. For 2 or more phases set Line-Line kV. Else actual kV across terminals. (Getter)

kVABase(Value::Float64)

Base load kva. Also defined kw and kvar or pf input, or load allocation by kwh or xfkva. (Setter)

kVABase() -> Float64

Base load kva. Also defined kw and kvar or pf input, or load allocation by kwh or xfkva. (Getter)

kW(Value::Float64)

Set kW for active Load. Updates kvar based on present PF. (Setter)

kW() -> Float64

Set kW for active Load. Updates kvar based on present PF. (Getter)

kWh(Value::Float64)

kwh billed for this period. Can be used with Cfactor for load allocation. (Setter)

kWh() -> Float64

kwh billed for this period. Can be used with Cfactor for load allocation. (Getter)

kWhDays(Value::Float64)

Length of kwh billing period for average demand calculation. Default 30. (Setter)

kWhDays() -> Float64

Length of kwh billing period for average demand calculation. Default 30. (Getter)

kvar(Value::Float64)

Set kvar for active Load. Updates PF based on present kW. (Setter)

kvar() -> Float64

Set kvar for active Load. Updates PF based on present kW. (Getter)

puSeriesRL(Value::Float64)

Percent of Load that is modeled as series R-L for harmonics studies (Setter)

puSeriesRL() -> Float64

Percent of Load that is modeled as series R-L for harmonics studies (Getter)

AllNames() -> Array{String,1}

Array of strings containing names of all Loadshape objects currently defined.

Count() -> Int64

Number of Loadshape objects currently defined in Loadshape collection

First() -> Int64

Set the first loadshape active and return integer index of the loadshape. Returns 0 if none.

HrInterval(Value::Float64)

Fixed interval time value, hours.

HrInterval() -> Float64

Fixed interval time value, hours.

MinInterval(Value::Float64)

Fixed Interval time value, in minutes

MinInterval() -> Float64

Fixed Interval time value, in minutes

Name(Value::String)

Name of the active Loadshape (Setter)

Name() -> String

Name of the active Loadshape (Getter)

New(Name::Any) -> Int64

Create new Load Shape

Next() -> Int64

Advance active Loadshape to the next on in the collection. Returns 0 if no more loadshapes.

Normalize()

Normalize Load Shape

Npts(Value::Int64)

Number of points in active Loadshape. (Setter)

Npts() -> Int64

Number of points in active Loadshape. (Getter)

PBase(Value::Float64)

Base for normalizing P curve (Setter)

PBase() -> Float64

Base for normalizing P curve (Getter)

PMult(Value::Array{Float64,1})

Array of Doubles for the P multiplier in the Loadshape. (Setter)

PMult() -> Array{Float64,1}

Array of Doubles for the P multiplier in the Loadshape. (Getter)

QBase(Value::Float64)

Base for normalizing Q curve. If left at zero, the peak value is used. (Setter)

QBase() -> Float64

Base for normalizing Q curve. If left at zero, the peak value is used. (Getter)

QMult(Value::Array{Float64,1})

Array of doubles containing the Q multipliers. (Setter)

QMult() -> Array{Float64,1}

Array of doubles containing the Q multipliers. (Getter)

SInterval(Value::Float64)

Interval of active loadshape in seconds (Setter)

SInterval() -> Float64

Interval of active loadshape in seconds (Getter)

TimeArray(Value::Array{Float64,1})

Time array in hours correscponding to P and Q multipliers when the Interval=0. (Setter)

TimeArray() -> Array{Float64,1}

Time array in hours correscponding to P and Q multipliers when the Interval=0. (Getter)

UseActual(Value::Bool)

T/F flag to let Loads know to use the actual value in the curve rather than use the value as a multiplier. (Setter)

UseActual() -> Bool

T/F flag to let Loads know to use the actual value in the curve rather than use the value as a multiplier. (Getter)

AllBranchesInZone() -> Array{String,1}

Wide string list of all branches in zone of the active energymeter object.

AllEndElements() -> Array{String,1}

Array of names of all zone end elements.

AllNames() -> Array{String,1}

Array of all energy Meter names

AllocFactors(Value::Array{Float64,1})

Array of doubles: set the phase allocation factors for the active meter.

AllocFactors() -> Array{Float64,1}

Array of doubles: set the phase allocation factors for the active meter.

AvgRepairTime() -> Float64

Average Repair time in this section of the meter zone

CalcCurrent(Value::Array{Float64,1})

Set the magnitude of the real part of the Calculated Current (normally determined by solution) for the Meter to force some behavior on Load Allocation

CalcCurrent() -> Array{Float64,1}

Set the magnitude of the real part of the Calculated Current (normally determined by solution) for the Meter to force some behavior on Load Allocation

CloseAllDIFiles()

Close all DI Files

Count() -> Int64

Number of Energy Meters in the Active Circuit

CountBranches() -> Int64

Number of branches in Active energymeter zone. (Same as sequencelist size)

CountEndElements() -> Int64

Number of zone end elements in the active meter zone.

CustInterrupts() -> Float64

Total customer interruptions for this Meter zone based on reliability calcs.

DIFilesAreOpen() -> Bool

Global Flag in the DSS to indicate if Demand Interval (DI) files have been properly opened.

DoReliabilityCalc(AssumeRestoration::Bool)

Do reliability calculation

FaultRateXRepairHrs() -> Float64

Sum of Fault Rate time Repair Hrs in this section of the meter zone

First() -> Int64

Set the first energy Meter active. Returns 0 if none.

MeteredElement(Value::String)

Set Name of metered element

MeteredElement() -> String

Set Name of metered element

MeteredTerminal(Value::Int64)

set Number of Metered Terminal

MeteredTerminal() -> Int64

set Number of Metered Terminal

Name(Value::String)

(read) Get/Set the active meter name. (write) Set a meter to be active by name.

Name() -> String

(read) Get/Set the active meter name. (write) Set a meter to be active by name.

Next() -> Int64

Sets the next energy Meter active. Returns 0 if no more.

NumSectionBranches() -> Int64

Number of branches (lines) in this section

NumSectionCustomers() -> Int64

Number of Customers in the active section.

NumSections() -> Int64

Number of feeder sections in this meter's zone

OCPDeviceType() -> Int64

Type of OCP device. 1=Fuse; 2=Recloser; 3=Relay

OpenAllDIFiles()

Open all DI Files

PeakCurrent(Value::Array{Float64,1})

Array of doubles to set values of Peak Current property

PeakCurrent() -> Array{Float64,1}

Array of doubles to set values of Peak Current property

RegisterNames() -> Array{String,1}

Array of strings containing the names of the registers.

RegisterValues() -> Array{Float64,1}

Array of all the values contained in the Meter registers for the active Meter.

Reset()

Reset meter

ResetAll()

Reset all meters

SAIDI() -> Float64

SAIDI for this meter's zone. Execute DoReliabilityCalc first.

SAIFI() -> Float64

Returns SAIFI for this meter's Zone. Execute Reliability Calc method first.

SAIFIkW() -> Float64

SAIFI based on kW rather than number of customers. Get after reliability calcs.

Sample()

Sample meter

SampleAll()

Sample all meters

Save()

Save meter registers

SaveAll()

Save all meters registers

SectSeqidx() -> Int64

SequenceIndex of the branch at the head of this section

SectTotalCust() -> Int64

Total Customers downline from this section

SeqListSize() -> Int64

Size of Sequence List

SequenceList(Value::Int64)

Get/set Index into Meter's SequenceList that contains branch pointers in lexical order. Earlier index guaranteed to be upline from later index. Sets PDelement active.

SequenceList() -> Int64

Get/set Index into Meter's SequenceList that contains branch pointers in lexical order. Earlier index guaranteed to be upline from later index. Sets PDelement active.

SetActiveSection(SectIdx::Int64)

Set active section

SumBranchFltRates() -> Float64

Sum of the branch fault rates in this section of the meter's zone

TotalCustomers() -> Int64

Total Number of customers in this zone (downline from the EnergyMeter)

Totals() -> Array{Float64,1}

Totals of all registers of all meters

AllNames() -> Array{String,1}

(read-only) Array of all Monitor Names

ByteStream() -> Array{Int8,1}

(read-only) Byte Array containing monitor stream values. Make sure a "save" is done first (standard solution modes do this automatically)

Channel(Index::Int64)

(read-only) Array of doubles for the specified channel (usage: MyArray = DSSMonitor.Channel(i)) A Save or SaveAll should be executed first. Done automatically by most standard solution modes.

Count() -> Int64

(read-only) Number of Monitors

DblFreq() -> Array{Float64,1}

(read-only) Array of doubles containing frequency values for harmonics mode solutions; Empty for time mode solutions (use dblHour)

DblHour() -> Array{Float64,1}

(read-only) Array of doubles containgin time value in hours for time-sampled monitor values; Empty if frequency-sampled values for harmonics solution (see dblFreq)

Element(Value::String)

Full object name of element being monitored.

Element() -> String

Full object name of element being monitored.

FileName() -> String

(read-only) Name of CSV file associated with active Monitor.

FileVersion() -> Int64

(read-only) Monitor File Version (integer)

First() -> Int64

(read-only) Sets the first Monitor active. Returns 0 if no monitors.

Header() -> Array{String,1}

(read-only) Header string; Array of strings containing Channel names

Mode(Value::Union{Int64, OpenDSSDirect.Lib.MonitorModes})

Set Monitor mode (bitmask integer - see DSS Help)

Mode() -> OpenDSSDirect.Lib.MonitorModes

Set Monitor mode (bitmask integer - see DSS Help)

Name(Value::String)

Sets the active Monitor object by name

Name() -> String

Sets the active Monitor object by name

Next() -> Int64

(read-only) Sets next monitor active. Returns 0 if no more.

NumChannels() -> Int64

(read-only) Number of Channels in the active Monitor

RecordSize() -> Int64

(read-only) Size of each record in ByteStream (Integer). Same as NumChannels.

SampleCount() -> Int64

(read-only) Number of Samples in Monitor at Present

Terminal(Value::Int64)

Terminal number of element being monitored.

Terminal() -> Int64

Terminal number of element being monitored.

AutoIncrement(Value::Bool)

Default is FALSE. If TRUE parser automatically advances to next token after DblValue, IntValue, or StrValue. Simpler when you don't need to check for parameter names.

AutoIncrement() -> Bool

Default is FALSE. If TRUE parser automatically advances to next token after DblValue, IntValue, or StrValue. Simpler when you don't need to check for parameter names.

BeginQuote(Value::String)

String containing the the characters for Quoting in OpenDSS scripts. Matching pairs defined in EndQuote. Default is "'([{.

BeginQuote() -> String

String containing the the characters for Quoting in OpenDSS scripts. Matching pairs defined in EndQuote. Default is "'([{.

CmdString(Value::String)

String to be parsed. Loading this string resets the Parser to the beginning of the line. Then parse off the tokens in sequence.

CmdString() -> String

String to be parsed. Loading this string resets the Parser to the beginning of the line. Then parse off the tokens in sequence.

DblValue() -> Float64

Return next parameter as a double.

Delimiters(Value::String)

String defining hard delimiters used to separate token on the command string. Default is , and =. The = separates token name from token value. These override whitesspace to separate tokens.

Delimiters() -> String

String defining hard delimiters used to separate token on the command string. Default is , and =. The = separates token name from token value. These override whitesspace to separate tokens.

EndQuote(Value::String)

String containing characters, in order, that match the beginning quote characters in BeginQuote. Default is "')]} (Setter)

EndQuote() -> String

String containing characters, in order, that match the beginning quote characters in BeginQuote. Default is "')]} (Getter)

IntValue() -> Int64

Return next parameter as a long integer.

Matrix(ExpectedOrder::Any)

Use this property to parse a Matrix token in OpenDSS format. Returns square matrix of order specified. Order same as default Fortran order: column by column.

NextParam() -> String

Get next token and return tag name (before = sign) if any. See AutoIncrement.

StrValue() -> String

Return next parameter as a string

SymMatrix(ExpectedOrder::Any)

Use this property to parse a matrix token specified in lower triangle form. Symmetry is forced.

Vector(ExpectedSize::Any)

Returns token as array of doubles. For parsing quoted array syntax.

WhiteSpace(Value::String)

Characters used for White space in the command string. Default is blank and Tab. (Setter)

WhiteSpace() -> String

Characters used for White space in the command string. Default is blank and Tab. (Getter)

AccumulatedL() -> Float64

accummulated failure rate for this branch on downline

Count() -> Int64

Number of PD elements (including disabled elements)

FaultRate(Value::Float64)

Number of failures per year. For LINE elements: Number of failures per unit length per year. (Setter)

FaultRate() -> Float64

Number of failures per year. For LINE elements: Number of failures per unit length per year. (Getter)

First() -> Int64

Set the first enabled PD element to be the active element. Returns 0 if none found.

FromTerminal() -> Int64

Number of the terminal of active PD element that is on the "from" side. This is set after the meter zone is determined.

IsShunt() -> Bool

Variant boolean indicating of PD element should be treated as a shunt element rather than a series element. Applies to Capacitor and Reactor elements in particular.

Lambda() -> Float64

Failure rate for this branch. Faults per year including length of line.

Name(Value::String)

Name of active PD Element. Returns null string if active element is not PDElement type. (Setter)

Name() -> String

Name of active PD Element. Returns null string if active element is not PDElement type. (Getter)

Next() -> Int64

Advance to the next PD element in the circuit. Enabled elements only. Returns 0 when no more elements.

NumCustomers() -> Int64

Number of customers, this branch

ParentPDElement() -> Int64

Sets the parent PD element to be the active circuit element. Returns 0 if no more elements upline.

PctPermanent(Value::Float64)

Get/Set percent of faults that are permanent (require repair). Otherwise, fault is assumed to be transient/temporary. (Setter)

PctPermanent() -> Float64

Get/Set percent of faults that are permanent (require repair). Otherwise, fault is assumed to be transient/temporary. (Getter)

RepairTime(Value::Float64)

Average repair time for this element in hours (Setter)

RepairTime() -> Float64

Average repair time for this element in hours (Getter)

SectionID() -> Int64

Integer ID of the feeder section that this PDElement branch is part of

TotalCustomers() -> Int64

Total number of customers from this branch to the end of the zone

TotalMiles() -> Float64

Total miles of line from this element to the end of the zone. For recloser siting algorithm.

Caption(Value::String)

Caption to appear on the bottom of the DSS Progress form.

Close()

Close progress

PctProgress(Value::Int64)

Percent progress to indicate [0..100]

Show()

Show progress

Description() -> String

Description of the property.

Name() -> String

Name of Property

Value(argIndex_or_Name::Union{Int64, String}, Value::String)

Value of Property of Index or Name (setter)

Value(argIndex_or_Name::Union{Int64, String}) -> String

Value of Property of Index or Name (getter)

Value() -> String

Value of Property (Getter)

_setCurrentProperty(argIndex::Int64)

Sets the current DSS property based on a 1-based integer (or integer as a string) as an property index, or a string as a property name.

AllNames() -> Array{String,1}

Variant array of strings with all PVSystem names

Count() -> Int64

Number of PVSystems

First() -> Int64

Set first PVSystem active; returns 0 if none.

Idx(Value::Int64)

Active PVSystem by index; 1..Count (Setter)

Idx() -> Int64

Active PVSystem by index; 1..Count (Getter)

Irradiance(Value::Float64)

Present value of the Irradiance property in W/sq-m (Setter)

Irradiance() -> Float64

Present value of the Irradiance property in W/sq-m (Getter)

Name(Value::String)

Name of the active PVSystem (Setter)

Name() -> String

Name of the active PVSystem (Getter)

Next() -> Int64

Sets next PVSystem active; returns 0 if no more.

RegisterNames() -> Array{String,1}

Variant Array of PVSYSTEM energy meter register names

RegisterValues() -> Array{Float64,1}

Array of doubles containing values in PVSystem registers.

kVARated(Value::Float64)

Rated kVA of the PVSystem (Setter)

kVARated() -> Float64

Rated kVA of the PVSystem (Getter)

kW() -> Float64

get kW output

kvar(Value::Float64)

kvar value (Setter)

kvar() -> Float64

kvar value (Getter)

pf(Value::Float64)

Power factor (Setter)

pf() -> Float64

Power factor (Getter)

AllNames() -> Array{String,1}

Array of strings with names of all Reclosers in Active Circuit

Close()

Close recloser

Count() -> Int64

Number of Reclosers in active circuit.

First() -> Int64

Set First Recloser to be Active Ckt Element. Returns 0 if none.

GroundInst(Value::Float64)

Ground (3I0) instantaneous trip setting - instantaneous curve multipler or actual amps. (Setter)

GroundInst() -> Float64

Ground (3I0) instantaneous trip setting - instantaneous curve multipler or actual amps. (Getter)

GroundTrip(Value::Float64)

Ground (3I0) trip multiplier or actual amps (Setter)

GroundTrip() -> Float64

Ground (3I0) trip multiplier or actual amps (Getter)

Idx(Value::Int64)

Get/Set the active Recloser by index into the recloser list. 1..Count (Setter)

Idx() -> Int64

Get/Set the active Recloser by index into the recloser list. 1..Count (Getter)

MonitoredObj(Value::String)

Full name of object the Recloser is monitoring. (Setter)

MonitoredObj() -> String

Full name of object the Recloser is monitoring. (Getter)

MonitoredTerm(Value::Int64)

Terminal number of Monitored object for the Recloser (Setter)

MonitoredTerm() -> Int64

Terminal number of Monitored object for the Recloser (Getter)

Name(Value::String)

Get Name of active Recloser or set the active Recloser by name. (Setter)

Name() -> String

Get Name of active Recloser or set the active Recloser by name. (Getter)

Next() -> Int64

Iterate to the next recloser in the circuit. Returns zero if no more.

NumFast(Value::Int64)

Number of fast shots (Setter)

NumFast() -> Int64

Number of fast shots (Getter)

Open()

Open recloser

PhaseInst(Value::Float64)

Phase instantaneous curve multipler or actual amps (Setter)

PhaseInst() -> Float64

Phase instantaneous curve multipler or actual amps (Getter)

PhaseTrip(Value::Float64)

Phase trip curve multiplier or actual amps (Setter)

PhaseTrip() -> Float64

Phase trip curve multiplier or actual amps (Getter)

RecloseIntervals() -> Array{Float64,1}

Variant Array of Doubles: reclose intervals, s, between shots.

Shots(Value::Int64)

Number of shots to lockout (fast + delayed) (Setter)

Shots() -> Int64

Number of shots to lockout (fast + delayed) (Getter)

SwitchedObj(Value::String)

Full name of the circuit element that is being switched by the Recloser. (Setter)

SwitchedObj() -> String

Full name of the circuit element that is being switched by the Recloser. (Getter)

SwitchedTerm(Value::Int64)

Terminal number of the controlled device being switched by the Recloser (Setter)

SwitchedTerm() -> Int64

Terminal number of the controlled device being switched by the Recloser (Getter)

AllNames() -> Array{String,1}

Array of strings containing all RegControl names

CTPrimary(Value::Float64)

CT primary ampere rating (secondary is 0.2 amperes) (Setter)

CTPrimary() -> Float64

CT primary ampere rating (secondary is 0.2 amperes) (Getter)

Count() -> Int64

Number of RegControl objects in Active Circuit

Delay(Value::Float64)

Time delay [s] after arming before the first tap change. Control may reset before actually changing taps. (Setter)

Delay() -> Float64

Time delay [s] after arming before the first tap change. Control may reset before actually changing taps. (Getter)

First() -> Int64

Sets the first RegControl active. Returns 0 if none.

ForwardBand(Value::Float64)

Regulation bandwidth in forward direciton, centered on Vreg (Setter)

ForwardBand() -> Float64

Regulation bandwidth in forward direciton, centered on Vreg (Getter)

ForwardR(Value::Float64)

LDC R setting in Volts (Setter)

ForwardR() -> Float64

LDC R setting in Volts (Getter)

ForwardVreg(Value::Float64)

Target voltage in the forward direction, on PT secondary base. (Setter)

ForwardVreg() -> Float64

Target voltage in the forward direction, on PT secondary base. (Getter)

ForwardX(Value::Float64)

LDC X setting in Volts (Setter)

ForwardX() -> Float64

LDC X setting in Volts (Getter)

IsInverseTime(Value::Bool)

Time delay is inversely adjsuted, proportinal to the amount of voltage outside the regulating band. (Setter)

IsInverseTime() -> Bool

Time delay is inversely adjsuted, proportinal to the amount of voltage outside the regulating band. (Getter)

IsReversible(Value::Bool)

Regulator can use different settings in the reverse direction. Usually not applicable to substation transformers. (Setter)

IsReversible() -> Bool

Regulator can use different settings in the reverse direction. Usually not applicable to substation transformers. (Getter)

MaxTapChange(Value::Float64)

Maximum tap change per iteration in STATIC solution mode. 1 is more realistic, 16 is the default for a faster solution. (Setter)

MaxTapChange() -> Float64

Maximum tap change per iteration in STATIC solution mode. 1 is more realistic, 16 is the default for a faster solution. (Getter)

MonitoredBus(Value::String)

Name of a remote regulated bus, in lieu of LDC settings (Setter)

MonitoredBus() -> String

Name of a remote regulated bus, in lieu of LDC settings (Getter)

Name(Value::String)

Active RegControl name (Setter)

Name() -> String

Active RegControl name (Getter)

Next() -> Int64

Sets the next RegControl active. Returns 0 if none.

PTRatio(Value::Float64)

PT ratio for voltage control settings (Setter)

PTRatio() -> Float64

PT ratio for voltage control settings (Getter)

ReverseBand(Value::Float64)

Bandwidth in reverse direction, centered on reverse Vreg. (Setter)

ReverseBand() -> Float64

Bandwidth in reverse direction, centered on reverse Vreg. (Getter)

ReverseR(Value::Float64)

Reverse LDC R setting in Volts. (Setter)

ReverseR() -> Float64

Reverse LDC R setting in Volts. (Getter)

ReverseVreg(Value::Float64)

Target voltage in the revese direction, on PT secondary base. (Setter)

ReverseVreg() -> Float64

Target voltage in the revese direction, on PT secondary base. (Getter)

ReverseX(Value::Float64)

Reverse LDC X setting in volts. (Setter)

ReverseX() -> Float64

Reverse LDC X setting in volts. (Getter)

TapDelay(Value::Float64)

Time delay [s] for subsequent tap changes in a set. Control may reset before actually changing taps. (Setter)

TapDelay() -> Float64

Time delay [s] for subsequent tap changes in a set. Control may reset before actually changing taps. (Getter)

TapNumber(Value::Int64)

Integer number of the tap that the controlled transformer winding is currentliy on. (Setter)

TapNumber() -> Int64

Integer number of the tap that the controlled transformer winding is currentliy on. (Getter)

TapWinding(Value::Int64)

Tapped winding number (Setter)