py_dss_interface package¶
Submodules¶
py_dss_interface.DSS module¶
-
class
py_dss_interface.DSS.
DSSDLL
(dll_folder=None)[source]¶ Bases:
object
-
activeclass_allnames
()[source]¶ Gets a variant array of strings consisting of all element names in the active Class.
-
activeclass_count
()[source]¶ Gets the number of elements in this class. Same as NumElements Property.
-
activeclass_first
()[source]¶ Sets first element in the active class to be the active DSS object. If object is a CktElement, ActiveCktElement also points to this element. Returns 0 if none.
-
activeclass_next
()[source]¶ Sets next element in the active class to be the active DSS object. If object is a CktElement, ActiveCktElement also points to this element. Returns 0 if none.
-
activeclass_numelements
()[source]¶ Gets the number of elements in this class. Same as Count Property.
-
bus_coorddefined
()[source]¶ Returns 1 if a coordinate has been defined for this bus; otherwise, it will return 0.
-
bus_cplxseqvoltages
()[source]¶ Returns the complex double array of sequence voltages (0, 1, 2) at this bus.
-
bus_getuniquenodenumber
()[source]¶ Returns a unique node number at the active bus to avoid node collisions and adds it to the node list for the bus. The start number can be specified in the argument.
-
bus_lambda
()[source]¶ Returns the accumulated failure rate downstream from this bus; faults per year.
-
bus_n_customers
()[source]¶ Returns returns the total number of customers served down line from this bus.
-
bus_nodes
()[source]¶ Returns an integer array of node numbers defined at the bus in same order as the voltages.
-
bus_puvll
()[source]¶ Returns a variant array of complex numbers representing L-L voltages in per unit. Returns -1.0 for 1-phase bus. If more than 3 phases, returns only first 3..
-
bus_puvmagangle
()[source]¶ Returns a variant array of doubles containing voltages in per unit and angles in degrees.
-
bus_totalmiles
()[source]¶ Returns the total length of line downline from this bus, in miles. For recloser siting algorithm.
-
bus_vll
()[source]¶ For 2 and 3 phase buses, returns a variant 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.
-
bus_vmagangle
()[source]¶ Returns a variant array of doubles containing voltages in magnitude (VLN), angle (deg).
-
bus_zscrefresh
()[source]¶ Recomputes Zsc for active bus for present circuit configuration. Return 1 if the procedure was successful.
-
capacitors_allnames
()[source]¶ Gets a variant array of strings with all Capacitor names in the circuit.
-
capacitors_availablesteps
()[source]¶ Gets the number of steps available in cap bank to be switched ON.
-
capacitors_read_isdelta
()[source]¶ Gets 1 if delta connection, otherwise will return 0 for distributing and switching the total kvar.
-
capacitors_read_kv
()[source]¶ Gets the bank rating. Use LL for 2 or 3 phases, or actual can rating for 1 phase.
-
capacitors_read_kvar
()[source]¶ Gets the total bank kvar, distributed equally among phases and steps.
-
capacitors_read_numsteps
()[source]¶ Gets the number of steps (defaults 1) for distributing and switching the total bank kvar.
-
capacitors_read_states
()[source]¶ Gets a variant array of integers [0..numsteps-1] indicating the state of each step. If value is -1 and error has occurred.
-
capacitors_subtractstep
()[source]¶ Subtracts one step of the capacitor if available. If no more steps, returns 0.
-
capacitors_write_isdelta
(argument)[source]¶ Sets (Argument) 1 if delta connection, otherwise will return 0 for distributing and switching the total kvar.
-
capacitors_write_kv
(argument)[source]¶ Sets the bank rating. Use LL for 2 or 3 phases, or actual can rating for 1 phase.
-
capacitors_write_kvar
(argument)[source]¶ Sets the total bank kvar, distributed equally among phases and steps.
-
capacitors_write_numsteps
(argument)[source]¶ Sets the number of steps (defaults 1) for distributing and switching the total bank kvar.
-
capacitors_write_states
(argument)[source]¶ Sets a variant array of integers [0..numsteps-1] indicating the state of each step. If value is -1 and error has occurred.
-
capcontrols_read_deadtime
()[source]¶ Gets the time delay [s] after switching off a step. Control may reset before actually switching.
-
capcontrols_read_delay
()[source]¶ Gets the time delay [s] to switch on after arming. Control may reset before actually switching.
-
capcontrols_read_delayoff
()[source]¶ Gets the time delay [s] before switching off a step. Control may reset before actually switching.
-
capcontrols_read_monitoredobj
()[source]¶ Gets the full name of the element that PT and CT are connected to.
-
capcontrols_read_monitoredterm
()[source]¶ Gets the terminal number on the element that PT and CT are connected to.
-
capcontrols_read_onsetting
()[source]¶ Gets the threshold to arm or switch on a step. See Mode for Units.
-
capcontrols_read_ptratio
()[source]¶ Gets the transducer ratio from primary feeder to control voltage.
-
capcontrols_read_usevoltoverride
()[source]¶ Gets if Vmin and Vmax are enabled to override the control Mode.
-
capcontrols_read_vmax
()[source]¶ Gets the Vmax, this reference with VoltOverride, switch off whenever PT voltage exceeds this level.
-
capcontrols_read_vmin
()[source]¶ Gets the Vmin, this reference with VoltOverride, switch ON whenever PT voltage drops below this level.
-
capcontrols_write_deadtime
(argument)[source]¶ Sets the time delay [s] after switching off a step. Control may reset before actually switching..
-
capcontrols_write_delay
(argument)[source]¶ Sets the time delay [s] to switch on after arming. Control may reset before actually switching.
-
capcontrols_write_delayoff
(argument)[source]¶ Sets the time delay [s] before switching off a step. Control may reset before actually switching.
-
capcontrols_write_mode
(argument)[source]¶ Sets the type of automatic controller (see manual for details).
-
capcontrols_write_monitoredobj
(argument)[source]¶ Sets the full name of the element that PT and CT are connected to.
-
capcontrols_write_monitoredterm
(argument)[source]¶ Sets the terminal number on the element that PT and CT are connected to.
-
capcontrols_write_offsetting
(argument)[source]¶ Sets the threshold to switch off a step. See Mode for Units.
-
capcontrols_write_onsetting
(argument)[source]¶ Sets the threshold to arm or switch on a step. See Mode for Units.
-
capcontrols_write_ptratio
(argument)[source]¶ Sets the transducer ratio from primary feeder to control voltage.
-
capcontrols_write_usevoltoverride
(argument)[source]¶ Sets if enables Vmin and Vmax to override the control Mode.
-
capcontrols_write_vmax
(argument)[source]¶ Sets the Vmax, this reference with VoltOverride, switch off whenever PT voltage exceeds this level.
-
capcontrols_write_vmin
(argument)[source]¶ Sets the Vmin, this reference with VoltOverride, switch ON whenever PT voltage drops below this level.
-
circuit_allbusdistances
()[source]¶ Returns distance from each bus to parent EnergyMeter. Corresponds to sequence in AllBusNames. Argument2 must be 0.
-
circuit_allbusnames
()[source]¶ Returns an array of strings with the names of all the Buses of the active circuit (See AllNodeNames). Argument2 must be 0.
-
circuit_allbusvmag
()[source]¶ Returns an array of doubles (magnitude) with the node voltages from the most recent solution. Argument2 must be 0.
-
circuit_allbusvmagpu
()[source]¶ Returns an array of doubles with the voltages in per unit of the most recent solution of the active circuit. Argument2 must be 0.
-
circuit_allbusvolts
()[source]¶ Returns an array of doubles (two doubles for representing a complex number) with the node voltages from the most recent solution. Argument2 must be 0.
-
circuit_allelementlosses
()[source]¶ Returns an array of doubles (two doubles for representing a complex number) with the losses in each element of the active circuit. Argument2 must be 0.
-
circuit_allelementnames
()[source]¶ Returns an array of strings with the names of all the elements of the active circuit. Argument2 must be 0.
-
circuit_allnodedistances
()[source]¶ Returns distance from each Node to parent EnergyMeter. Corresponds to sequence in AllBusVmag. Argument2 must be 0.
-
circuit_allnodedistancesbyphase
(argument)[source]¶ Returns array of doubles representing the distances to parent EnergyMeter. Sequence of array corresponds to other node ByPhase properties. Argument2 must contain the number of the phase to return.
-
circuit_allnodenames
()[source]¶ Returns an array of strings containing full name of each node in system in same order as returned by AllBusVolts, etc. Argument2 must be 0.
-
circuit_allnodenamesbyphase
(argument)[source]¶ Returns array of strings of the node names by Phase criteria. Sequence corresponds to other ByPhase properties. Argument2 must contain the number of the phase to return.
-
circuit_allnodevmagbyphase
(argument)[source]¶ Returns array of doubles representing the voltage magnitudes for nodes on the specified phase. The phase must be specified in the Argument2.
-
circuit_allnodevmagpubyphase
(argument)[source]¶ Returns array of doubles representing the voltage magnitudes (in per unit) for nodes on the specified phase. The phase must be specified in the Argument2.
-
circuit_capacity
()[source]¶ Returns the total capacity of the active circuit. Or this parameter it is necessary to specify the start and increment of the capacity in the arguments argument1 and argument2 respectively.
-
circuit_disable
()[source]¶ Allows to disable an element of the active circuit, the element must be specified by name. As a result, this parameter will deliver the string ?Ok?.
-
circuit_enable
()[source]¶ Allows to enable an element of the active circuit, the element must be specified by name. As a result, this parameter will deliver the string ?Ok?.
-
circuit_endoftimestepupdate
()[source]¶ Calls end of time step cleanup routine in solutionalgs.pas. Returns 0.
-
circuit_firstelement
()[source]¶ Sets the first Element of the active class to be the active Element, as a result, this parameter will deliver the index of the active Element (0 if none).
-
circuit_firstpcelement
()[source]¶ Sets the first PCElement to be the active PCElement, as a result, this parameter will deliver the index of the active PCElement (ideally 1).
-
circuit_firstpdelement
()[source]¶ Sets the first PDElement to be the active PDElement, as a result, this parameter will deliver the index of the active PDElement (ideally 1).
-
circuit_linelosses
()[source]¶ Returns an array of doubles (two doubles for representing a complex number) with the total Line losses of the active circuit. Argument2 must be 0.
-
circuit_losses
()[source]¶ Returns an array of doubles (two doubles for representing a complex number) with the total losses of the active circuit. Argument2 must be 0.
-
circuit_nextelement
()[source]¶ Sets the next Element of the active class to be the active Element, as a result, this parameter will deliver the index of the active Element (0 if none).
-
circuit_nextpcelement
()[source]¶ Sets the next PCElement to be the active PCElement, as a result, this parameter will deliver the index of the active PCElement (if there is no more it will return a 0).
-
circuit_nextpdelement
()[source]¶ Sets the next PDElement to be the active PDElement, as a result, this parameter will deliver the index of the active PDElement (if there is no more it will return a 0).
-
circuit_numcktelements
()[source]¶ Will deliver the number of CktElements included in the active circuit.
-
circuit_parentpdelement
()[source]¶ Sets parent PD Element, if any, to be the active circuit element and returns index > 0 if it fails or not applicable.
-
circuit_savesample
()[source]¶ Forces all meters and monitors to save their sample buffers, returns 0.
-
circuit_setactivebus
(argument)[source]¶ Allows to activate a bus of the active circuit, the bus must be specified by name. As a result, this parameter will deliver a string with the index of the active Bus.
-
circuit_setactivebusi
(i)[source]¶ Sets active the bus specified by index, which is compatible with the index delivered by AllBusNames, returns 0 it everything ok.
-
circuit_setactiveclass
(argument)[source]¶ Allows tto activate a Class of the active circuit, the Class must be specified by name. As a result, this parameter will deliver a string with the index of the active Class.
-
circuit_setactiveelement
(argument)[source]¶ Allows to activate an element of the active circuit, the element must be specified by name. As a result, this parameter will deliver a string with the index of the active element.
-
circuit_substationlosses
()[source]¶ Returns an array of doubles (two doubles for representing a complex number) with the total transformer losses of the active circuit. Argument2 must be 0.
-
circuit_systemy
()[source]¶ Returns an array of doubles (two doubles for representing a complex number) containing the Y Bus Matrix of the system (after a solution has been performed). Argument2 must be 0.
-
circuit_totalpower
()[source]¶ Returns an array of doubles (two doubles for representing a complex number) with the total power in watts delivered to the active circuit. Argument2 must be 0.
-
circuit_updatestoraget
()[source]¶ Forces all storage classes to update. Typically done after a solution.
-
circuit_ycurrents
()[source]¶ Returns a variant array of doubles containing complex injection currents for the present solution. It is the “I” vector of I=YV. Argument2 must be 0.
-
circuit_ynodeorder
()[source]¶ Returns a variant array of strings containing the names of the nodes in the same order as the Y Matrix. Argument2 must be 0.
-
circuit_ynodevarray
()[source]¶ Returns a complex array of actual node voltages in same order as SystemY Matrix. Argument2 must be 0.
-
cktelement_allpropertynames
()[source]¶ Delivers an array of strings with the names of all the properties of the active circuit element.
-
cktelement_allvariablesnames
()[source]¶ Delivers a Variant array of strings listing all the published state variable names, if the active circuit element is a PCElement. Otherwise, null string.
-
cktelement_allvariablesvalues
()[source]¶ Delivers a Variant array of doubles listing all the values of the state variables, if the active circuit element is a PCElement. Otherwise, null string.
-
cktelement_controller
()[source]¶ Delivers the Full name of the i-th controller attached to the active circuit element. The i-th controller index must be specified in the argument arg. Ex: Str = Controller(2). See NumControls to determine valid index range.
-
cktelement_cplxseqcurrents
()[source]¶ Delivers an array of doubles with the complex of sequence currents for all terminals of the active circuit element.
-
cktelement_cplxseqvoltages
()[source]¶ Delivers an array of doubles with the complex of sequence voltages for all terminals of the active circuit element.
-
cktelement_currents
()[source]¶ Delivers an array of doubles with the currents at terminals of the active circuit element.
-
cktelement_currentsmagang
()[source]¶ Delivers the currents in magnitude, angle format as a variant array of doubles of the active circuit element.
-
cktelement_energymeter
()[source]¶ Delivers the name of the EnergyMeter linked to the active circuit element.
-
cktelement_hasswitchcontrol
()[source]¶ Returns 1 if the active DSS object has a Switch Control linked; otherwise, it will return 0.
-
cktelement_hasvoltcontrol
()[source]¶ Returns 1 if the active DSS object has a Volt Control linked; otherwise, it will return 0.
-
cktelement_isopen
()[source]¶ Return a 1 if any terminal of the active DSS object is open, otherwise, it will return a 0.
-
cktelement_losses
()[source]¶ Delivers an array of doubles with the Losses at terminals of the active circuit element.
-
cktelement_nodeorder
()[source]¶ Delivers a Variant array integers variant array of integer containing the node numbers (representing phases, for example) for each conductor of each terminal.
-
cktelement_ocpdevindex
()[source]¶ Returns the Index into Controller list of OCP Device controlling the active DSS object.
-
cktelement_ocpdevtype
()[source]¶ Returns one of the following values: 0=none; 1=Fuse; 2=Recloser; 3=Relay according to the type of active control.
-
cktelement_phaselosses
()[source]¶ Delivers an array of doubles with the Losses per phase at the terminals of the active circuit element.
-
cktelement_powers
()[source]¶ Delivers an array of doubles with the powers at terminals of the active circuit element.
-
cktelement_read_busnames
()[source]¶ Delivers an array of strings with the names of all the buses connected to the active circuit element.
-
cktelement_read_display
()[source]¶ Displays the name of the active circuit element (not necessarily unique).
-
cktelement_read_enabled
()[source]¶ Returns one of the following values: 0 if the active element is disabled or 1 if the active element is enabled.
-
cktelement_residuals
()[source]¶ Delivers an array of doubles with the residual currents (magnitude, angle) in all the nodes of the active circuit element.
-
cktelement_seqcurrents
()[source]¶ Delivers an array of doubles with the symmetrical component Currents per phase at the terminals of the active circuit element.
-
cktelement_seqpowers
()[source]¶ Delivers an array of doubles with the symmetrical component powers per phase at the terminals of the active circuit element.
-
cktelement_seqvoltages
()[source]¶ Delivers an array of doubles with the symmetrical component voltages per phase at the terminals of the active circuit element.
-
cktelement_variablei
()[source]¶ Delivers get the value of a variable by index for the active PCElement.
-
cktelement_voltages
()[source]¶ Delivers an array of doubles with the voltages at terminals of the active circuit element.
-
cktelement_voltagesmagang
()[source]¶ Delivers the voltages in magnitude, angle format as a variant array of doubles of the active circuit element.
-
cktelement_write_busnames
(argument)[source]¶ Allows to fix an array of strings with the names of all the buses connected to the active circuit element.
-
cktelement_write_display
(argument)[source]¶ Allows to modify the name of the active circuit element (not necessarily unique).
-
cktelement_write_emergamp
(argument)[source]¶ Allows to fix the Emergency ampere rating for the active PDElement. The new value must be defined in the variable ?Argument?.
-
cktelement_write_enabled
(argument)[source]¶ Returns one of the following values: 0 if the active element is disabled or 1 if the active element is enabled.
-
cktelement_write_normamps
(argument)[source]¶ Allows to fix the normal ampere rating for the active PDElement.
-
cktelement_yprim
()[source]¶ Delivers an array of doubles with the Y primitive matrix (complex) of the active circuit element.
-
cmathlib_cabs
()[source]¶ Returns the absolute value of complex number given in real (Argument1) and imaginary (Argument2) doubles.
-
cmathlib_cdang
()[source]¶ Returns the angle, in degrees, of a complex number specified as two doubles: Real part (Argument1) and imaginary part (Argument2).
-
cmathlib_cmplx
()[source]¶ Convert real (Argument1) and imaginary (Argument1) doubles to variant array of doubles.
-
cmathlib_ctopolardeg
()[source]¶ Convert complex number (Argument1 and Argument2) to magnitude and angle, degrees. Returns variant array of two doubles.
-
cmathlib_pdegtocomplex
()[source]¶ Convert magnitude, angle in degrees (Argument1 and Argument2) to a complex number. Returns variant array of two doubles.
-
ctrlqueue_actioncode
()[source]¶ Gets the code for the active action. Long integer code to tell the control device what to do.
-
ctrlqueue_ctrlqueue
()[source]¶ Delivers the control actions contained in the CtrlQueue after the latest solve command.
-
ctrlqueue_delete
()[source]¶ Deletes a control action from the DSS control queue by referencing the handle of the action (Argument).
-
ctrlqueue_devicehandle
()[source]¶ Gets the handle (user defined) to device that must act on the pending action.
-
ctrlqueue_doallqueue
()[source]¶ Forces the execution of all control actions stored at the control queue. Returns 0.
-
ctrlqueue_numactions
()[source]¶ Gets the number of actions on the current action list (that have been popped off the control queue by CheckControlActions).
-
ctrlqueue_popaction
()[source]¶ Pops next action off the action list and makes it the active action. Returns zero if none.
-
ctrlqueue_push
()[source]¶ Pushes a control action onto the DSS control queue by time, action code, and device handle. Returns Control Queue handle.
-
ctrlqueue_queuesize
()[source]¶ Delivers the size of the current control queue. Returns zero if none.
-
dss_newcircuit
(argument)[source]¶ Makes a new circuit, the name of the circuit must be specified in the Argument.
-
dsselement_allpropertynames
()[source]¶ Gets a variant array of strings containing the names of all properties for the active DSS object.
-
dsselement_name
()[source]¶ Gets the full name of the active DSS object (general element or circuit element).
-
dssproperties_name
(argument)[source]¶ Delivers the name of the active property. The index of the property must be specified in the argument. The index minimum value is 1. This value must be entered as string.
-
executive_commandhelp
()[source]¶ Gets help string for i-th command (specified in the argument as string).
-
executive_optionhelp
()[source]¶ Gets help string for i-th option (specified in the argument as string).
-
executive_optionvalue
()[source]¶ Gets present value for i-th option (specified in the argument as string).
-
fuses_allnames
()[source]¶ Gets the variant array of string containing names of all fuses in the circuit.
-
fuses_isblown
()[source]¶ Returns the current state of the fuses. TRUE (1) if any on any phase is blown. Else FALSE (0).
-
fuses_read_delay
()[source]¶ Gets the fixed delay time in seconds added to the fuse blowing time determined by the TCC curve. Default is 0.
-
fuses_read_ratedcurrent
()[source]¶ Gets the multiplier or actual amps for the TCCcurve object. Defaults to 1.0, Multiply current values of TCC curve by this to get actual amps.
-
fuses_read_switchedobj
()[source]¶ Gets the full name of the circuit element switch that the fuse controls. Defaults to the MonitoredObj.
-
fuses_read_switchedterm
()[source]¶ Gets the terminal number of the terminal containing the switch controlled by the fuse.
-
fuses_write_delay
(argument)[source]¶ Sets the fixed delay time in seconds added to the fuse blowing time determined by the TCC curve. Default is 0.
-
fuses_write_idx
(argument)[source]¶ Sets the active fuse by index into the list of fuses. 1 based: 1..count.
-
fuses_write_monitoredobj
(argument)[source]¶ Sets the name of the Monitored Object by the active fuse.
-
fuses_write_monitoredterm
(argument)[source]¶ Sets the terminal number to switch the fuse is connected.
-
fuses_write_ratedcurrent
(argument)[source]¶ Sets the multiplier or actual amps for the TCCcurve object. Defaults to 1.0, Multiply current values of TCC curve by this to get actual amps.
-
fuses_write_switchedobj
(argument)[source]¶ Sets the full name of the circuit element switch that the fuse controls. Defaults to the MonitoredObj.
-
fuses_write_switchedterm
(argument)[source]¶ Sets the terminal number of the terminal containing the switch controlled by the fuse.
-
fuses_write_tcccurve
(argument)[source]¶ Sets the name of the TCCcurve object that determines fuse blowing.
-
generators_read_forcedon
()[source]¶ Returns 1 if the generator is forced ON regardless of other dispatch criteria; otherwise, returns 0.
-
generators_read_kvar
()[source]¶ Gets the kvar output for the active generator, kW is updated for current power factor.
-
generators_read_kw
()[source]¶ Gets the kW output for the active generator, kvar is updated for current power factor.
-
generators_read_pf
()[source]¶ Gets the power factor (pos. = producing vars). Updates kvar based on present kW value.
-
generators_registernames
()[source]¶ Gets the array of names of all generator Energy Meter registers.
-
generators_write_forcedon
(argument)[source]¶ Allows to force ON regardless of other dispatch criteria. To force ON put 1 in the argument, otherwise put 0.
-
generators_write_idx
(argument)[source]¶ Sets the active generator (argument) by Index into generators list. 1..Count.
-
generators_write_kvar
(argument)[source]¶ Sets the kvar output for the active generator, kW is updated for current power factor.
-
generators_write_kw
(argument)[source]¶ Sets the kW output for the active generator, kvar is updated for current power factor.
-
generators_write_pf
(argument)[source]¶ Sets the power factor (pos. = producing vars). Updates kvar based on present kW value.
-
generators_write_phases
(argument)[source]¶ Sets the number of phases (argument) of the active generator.
-
isources_allnames
()[source]¶ Gets the variant array of string containing names of all ISources in the circuit.
-
isources_count
()[source]¶ Returns the number of Isource objects currently defined in the active circuit.
-
linecodes_allnames
()[source]¶ Gets the capacitance matrix in ohms per unit length of the active LineCode.
-
linecodes_first
()[source]¶ Sets the first element active. Returns 0 if no lines. Otherwise, index of the line element.
-
linecodes_isz1z0
()[source]¶ Gets the flag (Boolean 1/0) denoting whether the impedance data were entered in symmetrical components.
-
linecodes_next
()[source]¶ Sets the next element active. Returns 0 if no lines. Otherwise, index of the line element.
-
linecodes_read_c0
()[source]¶ Gets the Zero-sequence capacitance in ohms per unit length for the active LineCode.
-
linecodes_read_c1
()[source]¶ Gets the Positive-sequence capacitance in ohms per unit length for the active LineCode.
-
linecodes_read_cmatrix
()[source]¶ Gets the capacitance matrix in ohms per unit length of the active LineCode.
-
linecodes_read_phasess
()[source]¶ Delivers the number of phases of the active LineCode as an integer.
-
linecodes_read_r0
()[source]¶ Gets the Zero-sequence resistance in ohms per unit length for the active LineCode.
-
linecodes_read_r1
()[source]¶ Gets the Positive-sequence resistance in ohms per unit length for the active LineCode.
-
linecodes_read_rmatrix
()[source]¶ Gets the resistance matrix in ohms per unit length of the active LineCode.
-
linecodes_read_x0
()[source]¶ Gets the Zero-sequence reactance in ohms per unit length for the active LineCode.
-
linecodes_read_x1
()[source]¶ Gets the Positive-sequence reactance in ohms per unit length for the active LineCode.
-
linecodes_read_xmatrix
()[source]¶ Gets the reactance matrix in ohms per unit length of the active LineCode.
-
linecodes_write_c0
(argument)[source]¶ Sets the Zero-sequence capacitance in ohms per unit length for the active LineCode. This value must be specified in the argument as a double.
-
linecodes_write_c1
(argument)[source]¶ Sets the Positive-sequence capacitance in ohms per unit length for the active LineCode. This value must be specified in the argument as a double.
-
linecodes_write_cmatrix
(argument)[source]¶ Sets the capacitance matrix in ohms per unit length of the active LineCode. The new values must be entered as a vector of doubles using the argument.
-
linecodes_write_emergamps
(argument)[source]¶ Sets the Emergency ampere rating for the active LineCode. This value must be specified in the argument as a double.
-
linecodes_write_name
(argument)[source]¶ Sets the name of the active LineCode element. The new value must be specified in the argument as a string.
-
linecodes_write_normamps
(argument)[source]¶ Sets the normal ampere rating for the active LineCode. This value must be specified in the argument as a double.
-
linecodes_write_phasess
(argument)[source]¶ Sets the number of phases of the active LineCode. The units must be specified as an integer in the argument.
-
linecodes_write_r0
(argument)[source]¶ Sets the Zero-sequence resistance in ohms per unit length for the active LineCode. This value must be specified in the argument as a double.
-
linecodes_write_r1
(argument)[source]¶ Sets the Positive-sequence resistance in ohms per unit length for the active LineCode. This value must be specified in the argument as a double.
-
linecodes_write_rmatrix
(argument)[source]¶ Sets the resistance matrix in ohms per unit length of the active LineCode. The new values must be entered as a vector of doubles using the argument.
-
linecodes_write_units
(argument)[source]¶ Sets the units of the active LineCode. The units must be specified as an integer in the argument. Please refer to the OpenDSS User manual for more information.
-
linecodes_write_x0
(argument)[source]¶ Sets the Zero-sequence reactance in ohms per unit length for the active LineCode. This value must be specified in the argument as a double.
-
linecodes_write_x1
(argument)[source]¶ Sets the Positive-sequence reactance in ohms per unit length for the active LineCode. This value must be specified in the argument as a double.
-
linecodes_write_xmatrix
(argument)[source]¶ Sets the reactance matrix in ohms per unit length of the active LineCode. The new values must be entered as a vector of doubles using the argument.
-
lines_first
()[source]¶ Sets the first element active. Returns 0 if no lines. Otherwise, index of the line element.
-
lines_next
()[source]¶ Sets the next element active. Returns 0 if no lines. Otherwise, index of the line element.
-
lines_parent
()[source]¶ Gets the parents of the active Line to be the active Line. Return 0 if no parent or action fails.
-
lines_read_cmatrix
()[source]¶ Gets the capacitance matrix (full), nanofarads per unit length. Variant array of doubles.
-
lines_read_length
()[source]¶ Gets the length of line section in units compatible with the LineCode definition.
-
lines_read_rg
()[source]¶ Gets the earth return value used to compute line impedances at power frequency.
-
lines_read_rmatrix
()[source]¶ Gets the resistance matrix (full), ohms per unit length. Variant array of doubles.
-
lines_read_seasonrating
()[source]¶ Returns the rating for the current season (in Amps) if the SeasonalRatings option is active.
-
lines_read_xg
()[source]¶ Gets the earth return reactance value used to compute line impedances at power frequency.
-
lines_read_xmatrix
()[source]¶ Gets the reactance matrix (full), ohms per unit length. Variant array of doubles.
-
lines_write_c1
(argument)[source]¶ Sets the positive sequence capacitance, nanofarads per unit length.
-
lines_write_cmatrix
(argument)[source]¶ Sets the capacitance matrix (full), nanofarads per unit length. Variant array of doubles.
-
lines_write_length
(argument)[source]¶ Sets the length of line section in units compatible with the LineCode definition.
-
lines_write_linecode
(argument)[source]¶ Sets the name of LineCode object that defines the impedances.
-
lines_write_rg
(argument)[source]¶ Sets the earth return value used to compute line impedances at power frequency.
-
lines_write_rmatrix
(argument)[source]¶ Sets the resistance matrix (full), ohms per unit length. Variant array of doubles.
-
lines_write_units
(argument)[source]¶ Sets the units of the line (distance, check manual for details).
-
lines_write_xg
(argument)[source]¶ Sets the earth return reactance value used to compute line impedances at power frequency.
-
lines_write_xmatrix
(argument)[source]¶ Sets the reactance matrix (full), ohms per unit length. Variant array of doubles.
-
loads_allnames
()[source]¶ Allows to read the names of all the loads present in the active circuit. The result is delivered as variant, however, the content of this variant is an array of strings.
-
loads_count
()[source]¶ Returns the number of load elements within the active circuit. The parameter argument can be filled with a 0.
-
loads_first
()[source]¶ Allows to set the active load into the first load registered in the active circuit. As a result, this property will return the number 1. The parameter argument can be filled with a 0.
-
loads_next
()[source]¶ Sets the active load into the next load registered in the active circuit. As a result, this property will deliver the index of the active load. The parameter argument can be filled with a 0.
-
loads_read_allocationfactor
()[source]¶ Allows to read the AllocationFactor property of the active load. The parameter argument can be filled with a 0.
-
loads_read_cfactor
()[source]¶ Allows to read the CFactor property of the active load. The parameter argument can be filled with a 0.
-
loads_read_class
()[source]¶ Allows to read the code number used to separate loads by class or group. The parameter argument can be filled with a 0.
-
loads_read_cvrcurve
()[source]¶ Allows to read the CVRCurve property of the active load. The parameter argument can be filled with an empty string.
-
loads_read_cvrvars
()[source]¶ Allows to read the CVRvars property of the active load. The parameter argument can be filled with a 0.
-
loads_read_cvrwatts
()[source]¶ Allows to read the CVRWatts property of the active load. The parameter argument can be filled with a 0.
-
loads_read_daily
()[source]¶ Allows to read the daily property of the active load. The parameter argument can be filled with an empty string.
-
loads_read_duty
()[source]¶ Allows to read the duty property of the active load. The parameter argument can be filled with an empty string.
-
loads_read_growth
()[source]¶ Allows to read the Growth property of the active load. The parameter argument can be filled with an empty string.
-
loads_read_idx
()[source]¶ Allows to read the index of the active load. The parameter argument can be filled with a 0.
-
loads_read_isdelta
()[source]¶ Allows to read if the active load is connected in delta, if the answer is positive, this function will deliver a 1; otherwise, the answer will be 0. The parameter argument can be filled with a 0.
-
loads_read_kv
()[source]¶ Allows to read the kV property of the active load. The parameter argument can be filled with a 0.
-
loads_read_kva
()[source]¶ Allows to read the kva property of the active load. The parameter argument can be filled with a 0.
-
loads_read_kvar
()[source]¶ Allows to read the kvar property of the active load. The parameter argument can be filled with a 0.
-
loads_read_kw
()[source]¶ Allows to read the kW property of the active load. The parameter argument can be filled with a 0.
-
loads_read_kwh
()[source]¶ Allows to read the kWh property of the active load. The parameter argument can be filled with a 0.
-
loads_read_kwhdays
()[source]¶ Allows to read the kWhdays property of the active load. The parameter argument can be filled with a 0.
-
loads_read_model
()[source]¶ Allows to read the model of the active load. The parameter argument can be filled with a 0.
-
loads_read_name
()[source]¶ Allows to read the Name property of the active load. The parameter argument can be filled with an empty string.
-
loads_read_numcust
()[source]¶ Allows to read the number of customer of the active load. The parameter argument can be filled with a 0.
-
loads_read_pctmean
()[source]¶ Allows to read the PctMean property of the active load. The parameter argument can be filled with a 0.
-
loads_read_pctseriesrl
()[source]¶ allows to read the PctSeriesRL (Percent of Load that is modeled as series R-L for harmonic studies) property of the active load. The parameter argument can be filled with a 0.
-
loads_read_pctstddev
()[source]¶ Allows to read the PctStdDev property of the active load. The parameter argument can be filled with a 0.
-
loads_read_pf
()[source]¶ Allows to read the pf property of the active load. The parameter argument can be filled with a 0.
-
loads_read_relweight
()[source]¶ Allows to read the RelWeight (relative weighting factor) property of the active load. The parameter argument can be filled with a 0.
-
loads_read_rneut
()[source]¶ Allows to read the RNeut (neutral resistance for wye connected loads) property of the active load. The parameter argument can be filled with a 0.
-
loads_read_spectrum
()[source]¶ Allows to read the Spectrum property of the active load. The parameter argument can be filled with an empty string.
-
loads_read_status
()[source]¶ Allows to read Response to load multipliers: Fixed (growth only - 1), Exempt (no LD curve - 2), Variable (all - 0), of the active load. The parameter argument can be filled with a 0.
-
loads_read_vmaxpu
()[source]¶ Allows to read the VMaxpu property of the active load. The parameter argument can be filled with a 0.
-
loads_read_vminemerg
()[source]¶ Allows to read the VMinemerg property of the active load. The parameter argument can be filled with a 0.
-
loads_read_vminnorm
()[source]¶ Allows to read the VMinnorm property of the active load. The parameter argument can be filled with a 0.
-
loads_read_vminpu
()[source]¶ Allows to read the VMinpu property of the active load. The parameter argument can be filled with a 0.
-
loads_read_xfkva
()[source]¶ Allows to read the xfKVA (Rated service transformer KVA for load allocation, using Allocationfactor. Affects kW, kvar and pf.) property of the active load. The parameter argument can be filled with a 0.
-
loads_read_xneut
()[source]¶ Allows to read the Xneut property of the active load. The parameter argument can be filled with a 0.
-
loads_read_yearly
()[source]¶ Allows to read the Yearly property of the active load. The parameter argument can be filled with an empty string.
-
loads_read_zipv
()[source]¶ Allows to read the array of 7 elements (doubles) for ZIP property of the active Load object.
-
loads_write_allocationfactor
(argument)[source]¶ Allows to write the AllocationFactor property of the active load. The parameter argument must contain the new value in AllocationFactor for the desired active load. The return value will be equal to 0.
-
loads_write_cfactor
(argument)[source]¶ Allows to write the CFactor property of the active load. The parameter argument must contain the new value in CFactor for the desired active load. The return value will be equal to 0.
-
loads_write_class
(argument)[source]¶ Allows to read the code number used to separate loads by class or group. The parameter argument can be filled with a 0.
-
loads_write_cvrcurve
(argument)[source]¶ Allows to set the CVRCurve property for the active load. The parameter argument must contain the Name of the new CVRCurve to be linked to the active load. The return value will be equal to empty.
-
loads_write_cvrvars
(argument)[source]¶ Allows to write the CVRvars property of the active load. The parameter argument must contain the new value in CVRWatts for the desired active load. The return value will be equal to 0.
-
loads_write_cvrwatts
(argument)[source]¶ Allows to write the CVRWatts property of the active load. The parameter argument must contain the new value in CVRWatts for the desired active load. The return value will be equal to 0.
-
loads_write_daily
(argument)[source]¶ Allows to set the daily property for the active load. The parameter argument must contain the Name of the new daily to be linked to the active load. The return value will be equal to empty.
-
loads_write_duty
(argument)[source]¶ Allows to set the dduty property for the active load. The parameter argument must contain the Name of the new duty to be linked to the active load. The return value will be equal to empty.
-
loads_write_growth
(argument)[source]¶ Allows to set the Growth property for the active load. The parameter argument must contain the Name of the new Growth to be linked to the active load. The return value will be equal to empty.
-
loads_write_idx
(argument)[source]¶ Allows to write the index of the active load. The parameter argument must contain the index of the desired active load. The return value will be equal to 0.
-
loads_write_isdelta
(argument)[source]¶ Allows to read if the active load is connected in delta, if the answer is positive, this function will deliver a 1; otherwise, the answer will be 0. This parameter will return a 0.
-
loads_write_kv
(argument)[source]¶ Allows to write the kV property of the active load. The parameter argument must contain the new value in kV for the desired active load. The return value will be equal to 0.
-
loads_write_kva
(argument)[source]¶ Allows to write the kva property of the active load. The parameter argument must contain the new value in kva for the desired active load. The return value will be equal to 0.
-
loads_write_kvar
(argument)[source]¶ Allows to write the kvar property of the active load. The parameter argument must contain the new value in kvar for the desired active load. The return value will be equal to 0.
-
loads_write_kw
(argument)[source]¶ Allows to write the kW property of the active load. The parameter argument must contain the new value in kW for the desired active load. The return value will be equal to 0.
-
loads_write_kwh
(argument)[source]¶ Allows to write the kWh property of the active load. The parameter argument must contain the new value in kWh for the desired active load. The return value will be equal to 0.
-
loads_write_kwhdays
(argument)[source]¶ Allows to write the kWhdays property of the active load. The parameter argument must contain the new value in kWhdays for the desired active load. The return value will be equal to 0.
-
loads_write_model
(argument)[source]¶ Allows to write the model of the active load using the parameter argument. This parameter will return a 0.
-
loads_write_name
(argument)[source]¶ allows to set the active load by specifying the Name load. The parameter argument must contain the Name of the load to activate. The return value will be equal to empty.
-
loads_write_numcust
(argument)[source]¶ Allows to write the number of customers of the active load using the parameter argument. This parameter will return a 0.
-
loads_write_pctmean
(argument)[source]¶ Allows to write the PctMean property of the active load. The parameter argument must contain the new value in PctMean for the desired active load. The return value will be equal to 0.
-
loads_write_pctseriesrl
(argument)[source]¶ allows to write the PctSeriesRL (Percent of Load that is modeled as series R-L for harmonic studies) property of the active load. The parameter argument must contain the new value in PctSeriesRL for the desired active load. The return value will be equal to 0.
-
loads_write_pctstddev
(argument)[source]¶ Allows to write the PctStdDev property of the active load. The parameter argument must contain the new value in PctStdDev for the desired active load. The return value will be equal to 0.
-
loads_write_pf
(argument)[source]¶ Allows to write the pf property of the active load. The parameter argument must contain the new value in pf for the desired active load. The return value will be equal to 0.
-
loads_write_relweight
(argument)[source]¶ Allows to write the RelWeight (relative weighting factor) property of the active load. The parameter argument must contain the new value in RelWeight for the desired active load. The return value will be equal to 0.
-
loads_write_rneut
(argument)[source]¶ Allows to write the RNeut (neutral resistance for wye connected loads) property of the active load. The parameter argument must contain the new value in RNeut for the desired active load. The return value will be equal to 0.
-
loads_write_spectrum
(argument)[source]¶ Allows to set the Spectrum property for the active load. The parameter argument must contain the Name of the new Spectrum to be linked to the active load. The return value will be equal to empty.
-
loads_write_status
(argument)[source]¶ Allows to read Response to load multipliers: Fixed (growth only - 1), Exempt (no LD curve - 2), Variable (all - 0), of the active load. This parameter will return a 0.
-
loads_write_vmaxpu
(argument)[source]¶ Allows to write the VMaxpu property of the active load. The parameter argument must contain the new value in VMaxpu for the desired active load. The return value will be equal to 0.
-
loads_write_vminemerg
(argument)[source]¶ Allows to write the VMinemerg property of the active load. The parameter argument must contain the new value in VMinemerg for the desired active load. The return value will be equal to 0.
-
loads_write_vminnorm
(argument)[source]¶ Allows to write the VMinnorm property of the active load. The parameter argument must contain the new value in VMinnorm for the desired active load. The return value will be equal to 0.
-
loads_write_vminpu
(argument)[source]¶ Allows to write the VMinpu property of the active load. The parameter argument must contain the new value in VMinpu for the desired active load. The return value will be equal to 0.
-
loads_write_xfkva
(argument)[source]¶ Allows to write the xfKVA (Rated service transformer KVA for load allocation, using Allocationfactor. Affects kW, kvar and pf.) property of the active load. The parameter argument must contain the new value in xfKVA for the desired active load. The return value will be equal to 0.
-
loads_write_xneut
(argument)[source]¶ Allows to write the Xneut property of the active load. The parameter argument must contain the new value in Xneut for the desired active load. The return value will be equal to 0.
-
loads_write_yearly
(argument)[source]¶ Allows to set the Yearly property for the active load. The parameter argument must contain the Name of the new Yearly to be linked to the active load. The return value will be equal to empty.
-
loads_write_zipv
(argument)[source]¶ Allows to write the array of 7 elements (doubles) for ZIP property of the active Load object.
-
loadshapes_allnames
()[source]¶ Gets a variant array of strings containing names of all LoadShape objects currently defined.
-
loadshapes_count
()[source]¶ Returns the number of LoadShape objects currently defined in LoadShape collection.
-
loadshapes_first
()[source]¶ sets the first loadshape active and return integer index of the loadshape. Returns 0 if no more.
-
loadshapes_next
()[source]¶ Sets the next loadshape active and return integer index of the loadshape. Returns 0 if no more.
-
loadshapes_normalize
()[source]¶ Normalizes the P and Q curves based on either Pbase, Qbase or simply the peak value of the curve.
-
loadshapes_read_pbase
()[source]¶ Gets the base for normalizing P curve. If left at zero, the peak value is used.
-
loadshapes_read_pmult
()[source]¶ Gets a variant array of doubles for the P multiplier in the LoadShape.
-
loadshapes_read_qbase
()[source]¶ Gets the base for normalizing Q curve. If left at zero, the peak value is used.
-
loadshapes_read_qmult
()[source]¶ Gets a variant array of doubles for the Q multiplier in the LoadShape.
-
loadshapes_read_timearray
()[source]¶ Gets a time array in hours corresponding to P and Q multipliers when the Interval = 0.
-
loadshapes_read_useactual
()[source]¶ Gets a TRUE/FALSE (1/0) to let Loads know to use the actual value in the curve rather than use the value as a multiplier.
-
loadshapes_write_pbase
(argument)[source]¶ Sets the base for normalizing P curve. If left at zero, the peak value is used.
-
loadshapes_write_pmult
(argument)[source]¶ Sets a variant array of doubles for the P multiplier in the LoadShape.
-
loadshapes_write_qbase
(argument)[source]¶ Sets the base for normalizing Q curve. If left at zero, the peak value is used.
-
loadshapes_write_qmult
(argument)[source]¶ Sets a variant array of doubles for the Q multiplier in the LoadShape.
-
loadshapes_write_timearray
(argument)[source]¶ Sets a time array in hours corresponding to P and Q multipliers when the Interval = 0.
-
loadshapes_write_useactual
(argument)[source]¶ Sets a TRUE/FALSE (1/0 - Argument) to let Loads know to use the actual value in the curve rather than use the value as a multiplier.
-
meters_allbranchesinzone
()[source]¶ Returns a wide string list of all branches in zone of the active Energy Meter object.
-
meters_closealldifiles
()[source]¶ Closes all Demand Interval (DI) files. Necessary at the end of a run.
-
meters_countbranches
()[source]¶ Returns the number of branches in active Energy Meter zone (same as sequencelist size).
-
meters_countendelements
()[source]¶ Returns the number of zone end elements in the active meter zone.
-
meters_custinterrupts
()[source]¶ Returns the total customer interruptions for this meter zone based on reliability calcs.
-
meters_difilesareopen
()[source]¶ Returns a global flag (1=true, 0=false) to indicate if Demand Interval (DI) files have been properly opened.
-
meters_doreliabilitycalc
()[source]¶ Calculates SAIFI, etc. if the Argument is equal to 1 this parameter will assume restoration, otherwise it will not.
-
meters_faultratexrepairhrs
()[source]¶ Returns the sum of Fault Rate Time Repair Hours in this section of the meter zone.
-
meters_read_allocfactors
()[source]¶ Returns an array of doubles: allocation factors for the active Meter.
-
meters_read_calcurrent
()[source]¶ Returns the magnitude of the real part of the Calculated Current (normally determined by solution) for the meter to force some behavior on Load Allocation.
-
meters_read_meteredelement
()[source]¶ Returns the name of the metered element (considering the active Energy Meter).
-
meters_read_meteredterminal
()[source]¶ Returns the number of metered terminal by the active Energy Meter.
-
meters_read_sequenceindex
()[source]¶ Returns the index into meter’s SequenceList that contains branch pointers in lexical order. Earlier index guaranteed to be up line from later index. Sets PDElement active.
-
meters_registervalues
()[source]¶ Returns an array of values contained in the Meter registers for the active Meter.
-
meters_saifikw
()[source]¶ Returns the SAIFI based on kW rather than number of customers. Get after reliability calcs.
-
meters_sampleall
()[source]¶ Causes all Energy Meters to take a sample of the present state. Returns 0.
-
meters_save
()[source]¶ Causes active meter to save its current sample buffer to its meter stream. Then you can access the Bytestream or channel data. Most standard solution modes do this automatically.
-
meters_saveall
()[source]¶ Save all Energy Meter buffers to their respective file streams. Returns 0.
-
meters_sumbranchfltrates
()[source]¶ Returns the sum of the branch fault rates in this section of the meter’s zone.
-
meters_totalcustomers
()[source]¶ Returns the total number of customers in this zone (down line from the Energy Meter).
-
meters_write_allocfactors
(argument)[source]¶ Receives an array of doubles to set the phase allocation factors for the active Meter.
-
meters_write_calcurrent
(argument)[source]¶ Sets the magnitude of the real part of the Calculated Current (normally determined by solution) for the meter to force some behavior on Load Allocation.
-
meters_write_meteredelement
(argument)[source]¶ Sets the name of the metered element (considering the active Energy Meter).
-
meters_write_meteredterminal
(argument)[source]¶ Sets the number of metered terminal by the active Energy Meter.
-
meters_write_peakcurrent
(argument)[source]¶ Receives an array of doubles to set values of Peak Current Property.
-
meters_write_sequenceindex
(argument)[source]¶ Sets the index into meter’s SequenceList that contains branch pointers in lexical order. Earlier index guaranteed to be up line from later index. Sets PDElement active.
-
monitors_bytestream
()[source]¶ Returns a byte array containing monitor stream values. Make sure a “save” is done first (standard solution modes do this automatically).
-
monitors_channel
(argument)[source]¶ Returns a variant 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.
-
monitors_dblfreq
()[source]¶ Returns a variant array of doubles containing time values for harmonics mode solutions; empty for time mode solutions (use dblHour).
-
monitors_dblhour
()[source]¶ Returns returns a variant array of doubles containing time value in hours for the time-sampled monitor values; empty if frequency-sampled values for harmonics solution (see dblFreq).
-
monitors_header
()[source]¶ Returns the header string; Variant array of strings containing Channel Names.
-
monitors_read_element
()[source]¶ Returns the full name of element being monitored by the active Monitor.
-
monitors_save
()[source]¶ Causes active monitor to save its current sample buffer to its monitor stream. Then you can access the Bytestream or channel data. Most standard solution modes do this automatically.
-
monitors_write_element
(argument)[source]¶ Sets the full name of element being monitored by the active Monitor.
-
monitors_write_terminal
(argument)[source]¶ Sets sets the terminal number of element being monitored.
-
parallel_actorprogress
()[source]¶ Returns an array of integers containing the progress in percentage for each active actor.
-
parallel_actorstatus
()[source]¶ Returns an array of integers containing the status of each active actor. If 1, the actor is ready to receive new commands, if 0, the actor is busy performing a simulation and cannot take new ?solve? commands at this time. However, the actor is capable to deliver values while the simulation is being performed.
-
parallel_createactor
()[source]¶ Creates a new actor and sets the active actor ID as the ID for the recently created actor. If there are no more CPUs available, the system will not allow the creation of the new actor.
-
parallel_numcores
()[source]¶ Returns the number of physical cores available in the local computer. If your computer has less than 64 Cores, this number should be the number of CPUs/2. For more information, please check: https://www.howtogeek.com/194756/cpu-basics-multiple-cpus-cores-and-hyper-threading-explained/.
-
parallel_read_activeparallel
()[source]¶ Gets if the parallel features of OpenDSS-PM are active. If active, this parameter will return 1, otherwise, will return 0 and OpenDSS-PM will behave sequentially.
-
parallel_read_actorcpu
()[source]¶ Gets the ID of the CPU assigned for the execution of the active actor.
-
parallel_read_concatenatereportsl
()[source]¶ Gets the state of the ConcatenateReports property of OpenDSS-PM. If 1, means that every time the user executes a Show/Export monitor operation, the data stored on the monitors with the same name for each actor will be concatenated one after the other. Otherwise (0), to get access of each monitor the user will have to activate the actor of interest and then perform the Show/Export command on the desired monitor.
-
parallel_write_activeactor
(argument)[source]¶ Sets the ID of the active actor; this number cannot be higher than the number of existing actors.
-
parallel_write_activeparallel
(argument)[source]¶ Sets enables/disables the parallel features of OpenDSS-PM. To enable set the argument in 1, otherwise, the argument should be 0 and OpenDSS-PM will behave sequentially.
-
parallel_write_concatenatereportsl
(argument)[source]¶ Sets the state of the ConcatenateReports property of OpenDSS-PM. If 1, means that every time the user executes a Show/Export monitor operation, the data stored on the monitors with the same name for each actor will
be concatenated one after the other. Otherwise (0), to get access of each monitor the user will have to activate the actor of interest and then perform the Show/Export command on the desired monitor.
-
parser_matrix
()[source]¶ 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.
-
parser_nextparam
()[source]¶ Gets next token and return tag name (before = sign) if any. See Autoincrement.
-
parser_read_autoincrement
()[source]¶ In this parameter the default is false (0). If true (1) parser automatically advances to next token after DblValue, IntValue, or StrValue. Simpler when you don’t need to check for parameter names.
-
parser_read_beginquote
()[source]¶ Gets the string containing the characters for quoting in OpenDSS scripts. Matching pairs defined in EndQuote. Default is “([{.
-
parser_read_cmdstring
()[source]¶ Gets a string to be parsed. Loading this string resets the parser to the beginning of the line. Then parse off the tokens in sequence.
-
parser_read_delimiters
()[source]¶ Gets the string defining hard delimiters used to separate token on the command string. Default is , and =. The = separates token name from token value. These override whitespaces to separate tokens.
-
parser_read_endquote
()[source]¶ Gets the string containing the characters, in order, that match the beginning quote characters in BeginQuote. Default is “)]}.
-
parser_read_whitespace
()[source]¶ Gets the characters used for White space in the command string. Default in blank and Tab.
-
parser_symmatrix
()[source]¶ Use this property to parse a Matrix token in lower triangular form. Symmetry is forced.
-
parser_vector
()[source]¶ Returns token as variant array of doubles. For parsing quoted array syntax.
-
parser_write_autoincrement
(argument)[source]¶ In this parameter the default is false (0). If true (1) parser automatically advances to next token after DblValue, IntValue, or StrValue. Simpler when you don’t need to check for parameter names.
-
parser_write_beginquote
(argument)[source]¶ Sets the string containing the characters for quoting in OpenDSS scripts. Matching pairs defined in EndQuote. Default is “([{.
-
parser_write_cmdstring
(argument)[source]¶ Sets a string to be parsed. Loading this string resets the parser to the beginning of the line. Then parse off the tokens in sequence.
-
parser_write_delimiters
(argument)[source]¶ Sets the string defining hard delimiters used to separate token on the command string. Default is , and =. The = separates token name from token value. These override whitespace to separate tokens.
-
parser_write_endquote
(argument)[source]¶ Sets the string containing the characters, in order, that match the beginning quote characters in BeginQuote. Default is “)]}.
-
parser_write_whitespace
(argument)[source]¶ Sets the characters used for White space in the command string. Default in blank and Tab.
-
pdelements_first
()[source]¶ Sets the first enabled PD element to be the active element. Returns 0 if none found.
-
pdelements_fromterminal
()[source]¶ Gets the number of the terminal of active PD element that is on the “from” side. This is set after the meter zone is determined.
-
pdelements_isshunt
()[source]¶ Sets returns 1 if the PD element should be treated as a shunt element rather than a series element. Applies to capacitor and reactor elements in particular.
-
pdelements_lambda
()[source]¶ Gets the failure rate for this branch. Faults per year including length of line.
-
pdelements_next
()[source]¶ Sets the next enabled PD element to be the active element. Returns 0 if none found.
-
pdelements_parentpdelement
()[source]¶ Gets the parent PD element to be the active circuit element. Returns 0 if no more elements upline.
-
pdelements_read_faultrate
()[source]¶ Gets the number of failures per year. For LINE elements: Number of failures per unit length per year.
-
pdelements_read_name
()[source]¶ Gets the name of the active PDElement, returns null string if active element id not PDElement.
-
pdelements_read_pctpermanent
()[source]¶ Gets the percent of faults that are permanent (require repair). Otherwise, fault is assumed to be transient/temporary.
-
pdelements_repairtime
()[source]¶ Gets the average time to repair a permanent fault on this branch, hours.
-
pdelements_sectionid
()[source]¶ Gets the integer ID of the feeder section that this PDElement branch is part of.
-
pdelements_totalcustomers
()[source]¶ Gets the total number of customers from this branch to the end of the zone.
-
pdelements_totalmiles
()[source]¶ Gets the total miles of line from this element to the end of the zone. For recloser siting algorithm.
-
pdelements_write_faultrate
(argument)[source]¶ Sets the number of failures per year. For LINE elements: Number of failures per unit length per year.
-
pdelements_write_name
(argument)[source]¶ Sets the name of the active PDElement, returns null string if active element id not PDElement.
-
pdelements_write_pctpermanent
(argument)[source]¶ Sets the percent of faults that are permanent (require repair). Otherwise, fault is assumed to be transient/temporary.
-
pvsystems_allnames
()[source]¶ Gets the variant array of string containing names of all PVSystems in the circuit.
-
pvsystems_count
()[source]¶ Returns the number of PVSystem objects currently defined in the active circuit.
-
pvsystems_write_irradiance
(argument)[source]¶ Sets the present value of the Irradiance property in W/sq-m.
-
reclosers_allnames
()[source]¶ Gets a variant array of strings with names of all reclosers in active circuit.
-
reclosers_close
()[source]¶ Close the switched object controlled by the recloser. Resets recloser to first operation.
-
reclosers_read_groundinst
()[source]¶ Gets the ground (3I0) instantaneous trip setting - curve multiplier or actual amps.
-
reclosers_read_monitoredterm
()[source]¶ Gets the terminal number of Monitored Object for the Recloser.
-
reclosers_read_switchedobj
()[source]¶ Gets the full name of the circuit element that is being switched by this Recloser.
-
reclosers_read_switchedterm
()[source]¶ Gets the terminal of the controlled device being switched by the Recloser.
-
reclosers_recloseintervals
()[source]¶ Gets a variant array of doubles: reclose intervals (s) between shots.
-
reclosers_write_groundinst
(argument)[source]¶ Sets the ground (3I0) instantaneous trip setting - curve multiplier or actual amps.
-
reclosers_write_idx
(argument)[source]¶ Sets the active recloser by index into the recloser list. 1..Count.
-
reclosers_write_monitoredobj
(argument)[source]¶ Sets the full name of object this Recloser is monitoring.
-
reclosers_write_monitoredterm
(argument)[source]¶ Sets the terminal number of Monitored Object for the Recloser.
-
reclosers_write_phaseins
(argument)[source]¶ Sets the phase instantaneous curve multiplier or actual amps.
-
reclosers_write_switchedobj
(argument)[source]¶ Sets the full name of the circuit element that is being switched by this Recloser.
-
reclosers_write_switchedterm
(argument)[source]¶ Sets the terminal of the controlled device being switched by the Recloser.
-
regcontrols_read_delay
()[source]¶ Gets the time delay [s] after arming before the first tap change. Control may reset before actually changing taps.
-
regcontrols_read_forwardband
()[source]¶ Gets the regulation bandwidth in forward direction, centered on Vreg.
-
regcontrols_read_forwardvreg
()[source]¶ Gets the target voltage in the forward direction, on PT secondary base.
-
regcontrols_read_isinversetime
()[source]¶ Gets the inverse time feature. Time delay is inversely adjusted, proportional to the amount of voltage outside the regulator band.
-
regcontrols_read_isreversible
()[source]¶ Gets the setting in the reverse direction, usually not applicable to substation transformers.
-
regcontrols_read_maxtapchange
()[source]¶ Gets the maximum tap change per iteration in STATIC solution mode. 1 is more realistic, 16 is the default for faster solution.
-
regcontrols_read_monitoredbus
()[source]¶ Gets the name of the remote regulated bus, in lieu of LDC settings.
-
regcontrols_read_reverseband
()[source]¶ Gets the bandwidth in reverse direction, centered on reverse Vreg.
-
regcontrols_read_reversevreg
()[source]¶ Gets the target voltage in the reverse direction, on PT secondary base.
-
regcontrols_read_tapdelay
()[source]¶ Gets the time delay [s] for subsequent tap changes in a set. Control may reset before actually changing taps.
-
regcontrols_read_voltagelimit
()[source]¶ Gets the first house voltage limit on PT secondary base. Setting to 0 disables this function.
-
regcontrols_write_ctprimary
(argument)[source]¶ Sets the CT primary ampere rating (secondary is 0.2 amperes).
-
regcontrols_write_delay
(argument)[source]¶ Sets the time delay [s] after arming before the first tap change. Control may reset before actually changing taps.
-
regcontrols_write_forwardband
(argument)[source]¶ Sets the regulation bandwidth in forward direction, centered on Vreg.
-
regcontrols_write_forwardvreg
(argument)[source]¶ Sets the target voltage in the forward direction, on PT secondary base.
-
regcontrols_write_isinversetime
(argument)[source]¶ Sets the inverse time feature. Time delay is inversely adjusted, proportional to the amount of voltage outside the regulator band.
-
regcontrols_write_isreversible
(argument)[source]¶ Sets the different settings for the reverse direction (see Manual for details), usually not applicable to substation transformers.
-
regcontrols_write_maxtapchange
(argument)[source]¶ Sets the maximum tap change per iteration in STATIC solution mode. 1 is more realistic, 16 is the default for faster solution.
-
regcontrols_write_monitoredbus
(argument)[source]¶ Sets the name of the remote regulated bus, in lieu of LDC settings.
-
regcontrols_write_reverseband
(argument)[source]¶ Sets the bandwidth in reverse direction, centered on reverse Vreg.
-
regcontrols_write_reversevreg
(argument)[source]¶ Sets the target voltage in the reverse direction, on PT secondary base.
-
regcontrols_write_tapdelay
(argument)[source]¶ Sets the time delay [s] for subsequent tap changes in a set. Control may reset before actually changing taps.
-
regcontrols_write_transformer
(argument)[source]¶ Sets the name of the transformer this regulator controls.
-
regcontrols_write_voltagelimit
(argument)[source]¶ Sets the first house voltage limit on PT secondary base. Setting to 0 disables this function.
-
relays_read_monitoredterm
()[source]¶ Gets the number of terminal of monitored element that this relay is monitoring.
-
relays_read_switchedobj
()[source]¶ Gets the full name of element that will switched when relay trips.
-
relays_read_switchedterm
()[source]¶ Gets the number of terminal of the switched object that will be opened when the relay trips.
-
relays_write_monitoredobj
(argument)[source]¶ Sets the full name of the object this relay is monitoring.
-
relays_write_monitoredterm
(argument)[source]¶ Sets the number of terminal of monitored element that this relay is monitoring.
-
relays_write_switchedobj
(argument)[source]¶ Sets the full name of element that will switched when relay trips.
-
relays_write_switchedterm
(argument)[source]¶ Sets the number of terminal of the switched object that will be opened when the relay trips.
-
sensors_read_currents
()[source]¶ Gets an array of doubles for the line current measurements; don’t use with KWS and KVARS.
-
sensors_read_isdelta
()[source]¶ Returns 1 if the sensor is connected in delta; otherwise, returns 0.
-
sensors_read_kvars
()[source]¶ Gets an array of doubles for Q measurements; overwrites currents with a new estimate using KWS.
-
sensors_read_kvbase
()[source]¶ Gets the voltage base for the sensor measurements. LL for 2 and 3 - phase sensors, LN for 1-phase sensors.
-
sensors_read_kws
()[source]¶ Gets an array of doubles for P measurements; overwrites currents with a new estimate using KVARS.
-
sensors_read_meteredterminal
()[source]¶ Gets the number of the measured terminal in the measured element.
-
sensors_read_pcterror
()[source]¶ Gets the assumed percent error in the Sensor measurement. Default is 1.
-
sensors_read_reversedelta
()[source]¶ Returns 1 if voltage measurements are 1-3, 3-2, 2-1; otherwise 0.
-
sensors_read_weight
()[source]¶ Gets the weighting factor for this sensor measurement with respect to the other sensors. Default is 1.
-
sensors_write_currents
(argument)[source]¶ Sets an array of doubles for the line current measurements; don’t use with KWS and KVARS.
-
sensors_write_isdelta
(argument)[source]¶ Allows to set 1 if the sensor is connected in delta; otherwise, set 0 (argument).
-
sensors_write_kvars
(argument)[source]¶ Sets an array of doubles for Q measurements; overwrites currents with a new estimate using KWS.
-
sensors_write_kvbase
(argument)[source]¶ Sets the voltage base for the sensor measurements. LL for 2 and 3 - phase sensors, LN for 1-phase sensors.
-
sensors_write_kws
(argument)[source]¶ Sets an array of doubles for P measurements; overwrites currents with a new estimate using KVARS.
-
sensors_write_meteredterminal
(argument)[source]¶ Sets the number of the measured terminal in the measured element.
-
sensors_write_pcterror
(argument)[source]¶ Sets the assumed percent error in the Sensor measurement. Default is 1.
-
sensors_write_reversedelta
(argument)[source]¶ Allows to set 1 if voltage measurements are 1-3, 3-2, 2-1; otherwise 0.
-
sensors_write_weight
(argument)[source]¶ Sets the weighting factor for this sensor measurement with respect to the other sensors. Default is 1.
-
settings_allocationfactors
()[source]¶ Sets all load allocation factors for all loads defined by XFKVA property to this value.
-
settings_read_allowduplicates
()[source]¶ Gets if OpenDSS allows duplicate names of objects: {1 allow, 0 not allow}.
-
settings_read_autobuslist
()[source]¶ Gets the list of Buses or (File=xxxxx) syntax for the AutoAdd solution mode.
-
settings_read_cktmodel
()[source]¶ Gets {dssMultiphase* | dssPositiveSeq} Indicate if the circuit model is positive sequence.
-
settings_read_lossregs
()[source]¶ Gets the array of Integers defining Energy Meter registers to use for computing Losses.
-
settings_read_pricecurve
()[source]¶ Gets the name of LoadShape object that serves as the source of price signal data for yearly simulations, etc.
-
settings_read_trapezoidal
()[source]¶ Gets {True (1) | False (0)} value of trapezoidal integration flag in Energy Meters.
-
settings_read_ueregs
()[source]¶ Gets the array of Integers defining Energy Meter registers to use for computing UE.
-
settings_read_voltagebases
()[source]¶ Gets the array of doubles defining the legal voltage bases in kV L-L.
-
settings_read_zonelock
()[source]¶ Gets the status of Lock zones on energy meters to prevent rebuilding if a circuit change occurs: {1= true, 0= False}.
-
settings_write_allowduplicates
(argument)[source]¶ Sets if OpenDSS allows duplicate names of objects: {1 allow, 0 not allow}.
-
settings_write_autobuslist
(argument)[source]¶ Sets the list of Buses or (File=xxxxx) syntax for the AutoAdd solution mode.
-
settings_write_cktmodel
(argument)[source]¶ Sets {dssMultiphase* | dssPositiveSeq} Indicate if the circuit model is positive sequence.
-
settings_write_emergvmaxpu
(argument)[source]¶ Sets the per unit maximum voltage for Emergency conditions.
-
settings_write_emergvminpu
(argument)[source]¶ Sets the per unit minimum voltage for Emergency conditions.
-
settings_write_lossregs
(argument)[source]¶ Sets the array of Integers defining Energy Meter registers to use for computing Losses.
-
settings_write_lossweight
(argument)[source]¶ Sets the weighting factor applied to Loss register values.
-
settings_write_normvmaxpu
(argument)[source]¶ Sets the per unit maximum voltage for Normal conditions.
-
settings_write_normvminpu
(argument)[source]¶ Sets the per unit minimum voltage for Normal conditions.
-
settings_write_pricecurve
(argument)[source]¶ Sets the name of LoadShape object that serves as the source of price signal data for yearly simulations, etc.
-
settings_write_trapezoidal
(argument)[source]¶ Sets {True (1) | False (0)} value of trapezoidal integration flag in Energy Meters.
-
settings_write_ueregs
(argument)[source]¶ Sets the array of Integers defining Energy Meter registers to use for computing UE.
-
settings_write_voltagebases
(argument)[source]¶ Sets the array of doubles defining the legal voltage bases in kV L-L.
-
settings_write_zonelock
(argument)[source]¶ Sets the status of Lock zones on energy meters to prevent rebuilding if a circuit change occurs: {1= true, 0= False}.
-
solution_buildymatrix
()[source]¶ Forces building of the System Y matrix according to the argument: {1= series elements only | 2= Whole Y matrix}.
-
solution_buslevels
()[source]¶ Returns an array of integers containing BusLevels array. This array gives a numeric value to each bus to specify how far it is from the circuit?s backbone (a continuous path from the feeder head to the feeder end). It is very handy to understand the circuit?s topology.
-
solution_calcincmatrix
()[source]¶ Starts the calculation of the incidence matrix for the active actor. Please be sure that the circuits of each actor have been compiled and ready to be solved before using this command.
-
solution_calcincmatrix_0
()[source]¶ Starts the calculation of the Branch to Node incidence matrix for the active actor. Please be sure that the circuits of each actor have been compiled and ready to be solved before using this command. The difference between this command and the CalcIncMatrix is that the calculated matrix will be ordered hierarchically from the substation to the feeder end, which can be helpful for many operations. Additionally, the Bus Levels vector is calculated and the rows (PDElements) and columns (Buses) are permuted so it is easy to identify their position in the circuit.
-
solution_checkcontrols
()[source]¶ Performs the normal process for sampling and executing Control Actions and Fault Status and rebuilds Y if necessary.
-
solution_checkfaultstatus
()[source]¶ Executes status check on all fault objects defined in the circuit. Returns 0.
-
solution_docontrolactions
()[source]¶ Pops control actions off the control queue and dispatches to the proper control element.
-
solution_finishtimestep
()[source]¶ Calls cleanup, sample monitors, and increment time at end of time step.
-
solution_incmatrixcols
()[source]¶ Returns an array of strings specifying the way the cols of the incidence matrix (buses) are organized, depending on the way the Branch to node incidence matrix was calculated (CalcIncMatrix/CalcIncMatrix_O) the result could be very different.
-
solution_incmatrixrows
()[source]¶ Returns an array of strings specifying the way the rows of the incidence matrix (PDElements) are organized, depending on the way the Branch to node incidence matrix was calculated (CalcIncMatrix/CalcIncMatrix_O) the result could be very different..
-
solution_initsnap
()[source]¶ Initializes some variables for snap shot power flow. SolveSnap does this automatically.
-
solution_laplacian
()[source]¶ Returns an array of integers containing the Laplacian matrix using the incidence matrix previously calculated , this means that before calling this command the incidence matrix needs to be calculated using calcincmatrix/calcincmatrix_o. This command will return only the non-zero values in compressed coordinate format (row, col, value)..
-
solution_mostiterationsdone
()[source]¶ Returns the max number of iterations required to converge at any control iteration of the most recent solution..
-
solution_ncmatrix
()[source]¶ Returns an array of integers containing the incidence matrix (1-D). Each cell of the incidence matrix is delivered using 3 elements of the array delivered, the first is the row, the second is the column and the third is the value (1/-1). This procedure will only deliver the non-zero elements..
-
solution_processtime
()[source]¶ Retrieves the time required (microseconds) to perform the latest solution time step, this time does not include the time required for sampling meters/monitors.
-
solution_processtimetimestep
()[source]¶ Retrieves the time required (microseconds) to perform the latest solution time step including the time required for sampling meters/monitors.
-
solution_read_addtype
()[source]¶ Returns the type of device to add in AutoAdd Mode: {dssGen (default)|dssCap}.
-
solution_read_algorithm
()[source]¶ Returns the base solution algorithm: {dssNormalSolve | dssNewtonSolve}.
-
solution_read_controlactionsdone
()[source]¶ Indicates that the control actions are done: {1 done, 0 not done}.
-
solution_read_controliterations
()[source]¶ Returns the current value of the control iteration counter.
-
solution_read_controlmode
()[source]¶ Returns the mode for control devices: {dssStatic (default) | dssEvent | dssTime}.
-
solution_read_converged
()[source]¶ Indicates whether the circuit solution converged (1 converged | 0 not converged).
-
solution_read_defaultyearly
()[source]¶ Returns the default yearly load shape (defaults to “Default”).
-
solution_read_genmult
()[source]¶ Returns the default multiplier applied to generators (like LoadMult).
-
solution_read_loadmult
()[source]¶ Returns the default load multiplier applied to all non-fixed loads.
-
solution_read_maxiterations
()[source]¶ Returns the Maximum number of iterations used to solve the circuit.
-
solution_read_number
()[source]¶ Returns the number of solutions to perform for MonteCarlo and time series simulations.
-
solution_read_random
()[source]¶ Returns the randomization mode for random variables “Gaussian” o “Uniform”.
-
solution_read_totaltime
()[source]¶ Retrieves the accumulated time required (microseconds) to perform the simulation.
-
solution_samplecontroldevices
()[source]¶ Executes a sampling of all intrinsic control devices, which push control actions into the control queue.
-
solution_sampledocontrolactions
()[source]¶ Sample controls and then process the control queue for present control mode and dispatch control actions. Returns 0.
-
solution_solveall
()[source]¶ Starts the solution process for all the actors created in memory. Please be sure that the circuits of each actor have been compiled and ready to be solved before using this command.
-
solution_solvedirect
()[source]¶ Executes a direct solution from the system Y matrix, ignoring compensation currents of loads, generators (includes Yprim only).
-
solution_solvenocontrol
()[source]¶ Is similar to SolveSnap except no control actions are checked or executed.
-
solution_solvepflow
()[source]¶ Solves using present power flow method. Iterative solution rather than direct solution.
-
solution_solvepluscontrol
()[source]¶ Executes a power flow solution (SolveNoControl) plus executes a CheckControlActions that executes any pending control actions.
-
solution_systemychanged
()[source]¶ Indicates if elements of the System Y have been changed by recent activity. If changed returns 1; otherwise 0.
-
solution_totaliterations
()[source]¶ Returns the total iterations including control iterations for most recent solution.
-
solution_write_addtype
(argument)[source]¶ Modifies the type of device to add in AutoAdd Mode: {dssGen (default)|dssCap}.
-
solution_write_algorithm
(argument)[source]¶ Modifies the base solution algorithm: {dssNormalSolve | dssNewtonSolve}.
-
solution_write_controlactionsdone
(argument)[source]¶ Modifies the flag to indicate that the control actions are done: {1 done, 0 not done}.
-
solution_write_controliterations
(argument)[source]¶ Modifies the current value of the control iteration counter.
-
solution_write_controlmode
(argument)[source]¶ Modifies the mode for control devices: {dssStatic (default) | dssEvent | dssTime}.
-
solution_write_converged
(argument)[source]¶ Modifies the converged flag (1 converged | 0 not converged).
-
solution_write_defaultdaily
(argument)[source]¶ Sets the default daily load shape (defaults to “Default”).
-
solution_write_defaultyearly
(argument)[source]¶ Sets the default yearly load shape (defaults to “Default”).
-
solution_write_genmult
(argument)[source]¶ Sets the default multiplier applied to generators (like LoadMult).
-
solution_write_loadmodel
(argument)[source]¶ Modifies the Load Model: {dssPowerFlow (default)|dssAdmittance}.
-
solution_write_loadmult
(argument)[source]¶ Sets the default load multiplier applied to all non-fixed loads.
-
solution_write_maxcontroliterations
(argument)[source]¶ Modifies the maximum allowable control iterations.
-
solution_write_maxiterations
(argument)[source]¶ Modifies the Maximum number of iterations used to solve the circuit.
-
solution_write_number
(argument)[source]¶ Modifies the number of solutions to perform for MonteCarlo and time series simulations.
-
solution_write_random
(argument)[source]¶ Modifies the randomization mode for random variables “Gaussian” o “Uniform”.
-
solution_write_totaltime
(argument)[source]¶ Sets the accumulated time (microseconds) register. The new value for this register must be specified in the argument.
-
swtcontrols_allnames
()[source]¶ Gets a variant array of strings with all SwtControl names in the active circuit.
-
swtcontrols_read_action
()[source]¶ Gets the open (1) or close (2) action of the switch. No effect if switch is locked. However, reset removes any lock and then closes the switch (shelf state). 0 = none action.
-
swtcontrols_read_delay
()[source]¶ Gets the time delay [s] between arming and opening or closing the switch. Control may reset before actually operating the switch.
-
swtcontrols_read_switchedobj
()[source]¶ Gets the name of the switched object by the active SwtControl
-
swtcontrols_read_switchedterm
()[source]¶ Gets the terminal number where the switch is located on the SwitchedObj.
-
swtcontrols_write_action
(argument)[source]¶ Sets open (1) or close (2) the switch. No effect if switch is locked. However, reset removes any lock and then closes the switch (shelf state). 0 = none action (see manual for details).
-
swtcontrols_write_delay
(argument)[source]¶ Sets sets the time delay [s] between arming and opening or closing the switch. Control may reset before actually operating the switch.
-
swtcontrols_write_islocked
(argument)[source]¶ Sets the lock to prevent both manual and automatic switch operation.
-
swtcontrols_write_switchedterm
(argument)[source]¶ Sets the terminal number where the switch is located on the SwitchedObj.
-
topology_backwardbranch
()[source]¶ Moves back toward the source, return index of new active branch or 0 if no more.
-
topology_firstload
()[source]¶ Sets as active load the first load at the active branch, return index or 0 if none.
-
topology_forwardbranch
()[source]¶ Moves forward in the tree, return index of new active branch or 0 if no more.
-
topology_nextload
()[source]¶ Sets as active load the next load at the active branch, return index or 0 if none.
-
topology_numisolatedbranches
()[source]¶ Gets the number of isolated branches (PD elements and capacitors).
-
transformers_allNames
()[source]¶ Gets a variant array of strings with all Transformer names in the active circuit.
-
transformers_read_isdelta
()[source]¶ Gets the information about if the active winding is delta (1) or wye (0) connection.
-
transformers_read_kv
()[source]¶ Gets the active winding kV rating. Phase-phase for 2 or 3 phases, actual winding kV 1 phase transformer.
-
transformers_read_kva
()[source]¶ Gets the active winding kVA rating. On winding 1, this also determines normal and emergency current ratings for all windings.
-
transformers_read_numtaps
()[source]¶ Gets the active winding number of tap steps between MinTap and MaxTap.
-
transformers_read_numwindings
()[source]¶ Gets the number of windings on this transformer. Allocates memory; set or change this property first.
-
transformers_read_rneut
()[source]¶ Gets the active winding neutral resistance [ohms] for wye connections. Set less than zero ungrounded wye.
-
transformers_read_wdg
()[source]¶ Gets the active winding number from 1..NumWindings. Update this before reading or setting a sequence of winding properties (R, Tap, kV, kVA, etc.).
-
transformers_read_xfmrcode
()[source]¶ Gets the name of an XfrmCode that supplies electrical parameters for this transformer.
-
transformers_read_xhl
()[source]¶ Gets the percent reactance between windings 1 and 2, on winding 1 kVA base. Use for 2 winding or 3 winding transformers.
-
transformers_read_xht
()[source]¶ Gets the percent reactance between windings 1 and 3, on winding 1 kVA base. Use for 3 winding transformers only.
-
transformers_read_xlt
()[source]¶ Gets he percent reactance between windings 2 and 3, on winding 1 kVA base. Use for 3 winding transformers only.
-
transformers_read_xneut
()[source]¶ Gets the active winding neutral reactance [ohms] for wye connections.
-
transformers_strwdgvoltages
()[source]¶ Gets the voltages at the active winding of the active transformer in string format.
-
transformers_wdgcurrents
()[source]¶ Gets a a variant array of doubles containing the currents at the active winding on the active transformer. These currents come as complex pairs.
-
transformers_wdgvoltages
()[source]¶ Gets a variant array of doubles containing the voltages at the active winding on the active transformer. These voltages come as complex pairs.
-
transformers_write_isdelta
(argument)[source]¶ Sets the information about if the active winding is delta (1) or wye (0) connection.
-
transformers_write_kv
(argument)[source]¶ Sets the active winding kV rating. Phase-phase for 2 or 3 phases, actual winding kV 1 phase transformer.
-
transformers_write_kva
(argument)[source]¶ Sets the active winding kVA rating. On winding 1, this also determines normal and emergency current ratings for all windings.
-
transformers_write_numtaps
(argument)[source]¶ Sets the active winding number of tap steps between MinTap and MaxTap.
-
transformers_write_numwindings
(argument)[source]¶ Sets the number of windings on this transformer. Allocates memory; set or change this property first.
-
transformers_write_rneut
(argument)[source]¶ Sets the active winding neutral resistance [ohms] for wye connections. Set less than zero ungrounded wye.
-
transformers_write_wdg
(argument)[source]¶ Sets the active winding number from 1..NumWindings. Update this before reading or setting a sequence of winding properties (R, Tap, kV, kVA, etc.).
-
transformers_write_xfmrcode
(argument)[source]¶ Sets the name of an XfrmCode that supplies electrical parameters for this transformer.
-
transformers_write_xhl
(argument)[source]¶ Sets the percent reactance between windings 1 and 2, on winding 1 kVA base. Use for 2 winding or 3 winding transformers.
-
transformers_write_xht
(argument)[source]¶ Sets the percent reactance between windings 1 and 3, on winding 1 kVA base. Use for 3 winding transformers only.
-
transformers_write_xlt
(argument)[source]¶ Sets the percent reactance between windings 2 and 3, on winding 1 kVA base. Use for 3 winding transformers only.
-
transformers_write_xneut
(argument)[source]¶ Sets the active winding neutral reactance [ohms] for wye connections.
-
vsources_count
()[source]¶ Returns the number of VSource objects currently defined in the active circuit.
-
xycurves_read_xarray
()[source]¶ Gets the X values as a variant array of doubles. Set Npts to max number expected if setting.
-
xycurves_read_yarray
()[source]¶ Gets the Y values as a variant array of doubles. Set Npts to max number expected if setting..
-
xycurves_write_xarray
(argument)[source]¶ Sets the X values as a variant array of doubles specified in Argument. Set Npts to max number expected if setting.
-