DSS C-API and dss.hpp
DSS C-API and dss.hpp expose a customized and extended implementation of OpenDSS to C and C++.
dss_capi.h File Reference
#include <stdint.h>
#include <stddef.h>
Include dependency graph for dss_capi.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define DSS_CAPI_VERSION   "0.12.1"
 
#define DSS_CAPI_DLL
 

Typedefs

typedef int32_t(* dss_callback_plot_t) (void *ctx, char *jsonParams)
 Function types for plotting and writing/message callbacks. More...
 
typedef int32_t(* dss_callback_message_t) (void *ctx, char *messageStr, int32_t messageType)
 

Enumerations

enum  MonitorModes {
  MonitorModes_VI = 0x00000000 , MonitorModes_Power = 0x00000001 , MonitorModes_Taps = 0x00000002 , MonitorModes_States = 0x00000003 ,
  MonitorModes_Sequence = 0x00000010 , MonitorModes_Magnitude = 0x00000020 , MonitorModes_PosOnly = 0x00000040
}
 
enum  SolveModes {
  SolveModes_SnapShot = 0 , SolveModes_Daily = 1 , SolveModes_Yearly = 2 , SolveModes_Monte1 = 3 ,
  SolveModes_LD1 = 4 , SolveModes_PeakDay = 5 , SolveModes_DutyCycle = 6 , SolveModes_Direct = 7 ,
  SolveModes_MonteFault = 8 , SolveModes_FaultStudy = 9 , SolveModes_Monte2 = 10 , SolveModes_Monte3 = 11 ,
  SolveModes_LD2 = 12 , SolveModes_AutoAdd = 13 , SolveModes_Dynamic = 14 , SolveModes_Harmonic = 15
}
 
enum  SolutionLoadModels { SolutionLoadModels_PowerFlow = 1 , SolutionLoadModels_Admittance = 2 }
 
enum  SolutionAlgorithms { SolutionAlgorithms_NormalSolve = 0 , SolutionAlgorithms_NewtonSolve = 1 }
 
enum  ControlModes {
  ControlModes_Static = 0 , ControlModes_Event = 1 , ControlModes_Time = 2 , ControlModes_Multirate = 3 ,
  ControlModes_ControlOff = -1
}
 
enum  CktModels { CktModels_Multiphase = 0 , CktModels_PositiveSeq = 1 }
 
enum  RandomModes { RandomModes_Gaussian = 1 , RandomModes_Uniform = 2 , RandomModes_LogNormal = 3 }
 
enum  AutoAddTypes { AutoAddTypes_AddGen = 1 , AutoAddTypes_AddCap = 2 }
 
enum  CapControlModes {
  CapControlModes_Current = 0 , CapControlModes_Voltage = 1 , CapControlModes_KVAR = 2 , CapControlModes_Time = 3 ,
  CapControlModes_PF = 4
}
 
enum  ActionCodes {
  ActionCodes_none = 0 , ActionCodes_Open = 1 , ActionCodes_Close = 2 , ActionCodes_Reset = 3 ,
  ActionCodes_Lock = 4 , ActionCodes_Unlock = 5 , ActionCodes_TapUp = 6 , ActionCodes_TapDown = 7
}
 
enum  GeneratorStatus { GeneratorStatus_Variable = 0 , GeneratorStatus_Fixed = 1 }
 
enum  LoadStatus { LoadStatus_Variable = 0 , LoadStatus_Fixed = 1 , LoadStatus_Exempt = 2 }
 
enum  LoadModels {
  LoadModels_ConstPQ = 1 , LoadModels_ConstZ = 2 , LoadModels_Motor = 3 , LoadModels_CVR = 4 ,
  LoadModels_ConstI = 5 , LoadModels_ConstPFixedQ = 6 , LoadModels_ConstPFixedX = 7 , LoadModels_ZIPV = 8
}
 
enum  LineUnits {
  LineUnits_none = 0 , LineUnits_Miles = 1 , LineUnits_kFt = 2 , LineUnits_km = 3 ,
  LineUnits_meter = 4 , LineUnits_ft = 5 , LineUnits_inch = 6 , LineUnits_cm = 7 ,
  LineUnits_mm = 8 , LineUnits_Maxnum = 9
}
 
enum  YMatrixModes { YMatrixModes_SeriesOnly = 1 , YMatrixModes_WholeMatrix = 2 }
 
enum  StorageStates { StorageStates_Charging = -1 , StorageStates_Idling = 0 , StorageStates_Discharging = 1 }
 
enum  DSSMessageType {
  DSSMessageType_Error = -1 , DSSMessageType_General = 0 , DSSMessageType_Info = 1 , DSSMessageType_Help = 2 ,
  DSSMessageType_Progress = 3 , DSSMessageType_ProgressCaption = 4 , DSSMessageType_ProgressFormCaption = 5 , DSSMessageType_ProgressPercent = 6 ,
  DSSMessageType_FireOffEditor = 7
}
 EXPERIMENTAL: For message/write callbacks.
 
enum  DSSJSONFlags {
  DSSJSONFlags_Full = 0x00000001 , DSSJSONFlags_SkipRedundant = 0x00000002 , DSSJSONFlags_EnumAsInt = 0x00000004 , DSSJSONFlags_FullNames = 0x00000008 ,
  DSSJSONFlags_Pretty = 0x00000010 , DSSJSONFlags_ExcludeDisabled = 0x00000020 , DSSJSONFlags_State = 0x00000040 , DSSJSONFlags_Debug = 0x00000080
}
 
enum  BatchOperation { BatchOperation_Set = 0 , BatchOperation_Multiply = 1 , BatchOperation_Increment = 2 }
 
enum  SolverOptions {
  SolverOptions_ReuseNothing = 0 , SolverOptions_ReuseCompressedMatrix = 1 , SolverOptions_ReuseSymbolicFactorization = 2 , SolverOptions_ReuseNumericFactorization = 3 ,
  SolverOptions_AlwaysResetYPrimInvalid = 0x10000000
}
 The values themselves are subject to change in future versions, use this enum for easier upgrades. More...
 

Functions

DSS_CAPI_DLL void DSS_ResetStringBuffer (void)
 
DSS_CAPI_DLL void DSS_Dispose_PByte (int8_t **p)
 
DSS_CAPI_DLL void DSS_Dispose_PDouble (double **p)
 
DSS_CAPI_DLL void DSS_Dispose_PInteger (int32_t **p)
 
DSS_CAPI_DLL void DSS_Dispose_PPAnsiChar (char ***p, int32_t cnt)
 
DSS_CAPI_DLL char * DSS_Get_PAnsiChar (void *p, int32_t index)
 
DSS_CAPI_DLL void DSS_DisposeGRData (void)
 Dispose temporary buffer data in the global result (GR) pointers.
 
DSS_CAPI_DLL void DSS_GetGRPointers (char ****DataPtr_PPAnsiChar, double ***DataPtr_PDouble, int32_t ***DataPtr_PInteger, int8_t ***DataPtr_PByte, int32_t **CountPtr_PPAnsiChar, int32_t **CountPtr_PDouble, int32_t **CountPtr_PInteger, int32_t **CountPtr_PByte)
 Get references to the global result (GR) pointers, used in the *_GR variations of most getter functions. More...
 
DSS_CAPI_DLL double * DSS_GR_DataPtr_PDouble (void)
 Functions to get the current GR pointers individually, used in MATLAB.
 
DSS_CAPI_DLL int32_t * DSS_GR_DataPtr_PInteger (void)
 
DSS_CAPI_DLL int8_t * DSS_GR_DataPtr_PByte (void)
 
DSS_CAPI_DLL int32_t * DSS_GR_CountPtr_PDouble (void)
 
DSS_CAPI_DLL int32_t * DSS_GR_CountPtr_PInteger (void)
 
DSS_CAPI_DLL int32_t * DSS_GR_CountPtr_PByte (void)
 
DSS_CAPI_DLL void DSS_RegisterPlotCallback (dss_callback_plot_t cb)
 
DSS_CAPI_DLL void DSS_RegisterMessageCallback (dss_callback_message_t cb)
 
DSS_CAPI_DLL void DSS_NewCircuit (const char *Value)
 
DSS_CAPI_DLL void ActiveClass_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings consisting of all element names in the active class.
 
DSS_CAPI_DLL void ActiveClass_Get_AllNames_GR (void)
 Same as ActiveClass_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t ActiveClass_Get_First (void)
 Sets first element in the active class to be the active DSS object. More...
 
DSS_CAPI_DLL int32_t ActiveClass_Get_Next (void)
 Sets next element in active class to be the active DSS object. More...
 
DSS_CAPI_DLL char * ActiveClass_Get_Name (void)
 Name of the Active Element of the Active Class.
 
DSS_CAPI_DLL void ActiveClass_Set_Name (const char *Value)
 
DSS_CAPI_DLL int32_t ActiveClass_Get_NumElements (void)
 Number of elements in this class. More...
 
DSS_CAPI_DLL char * ActiveClass_Get_ActiveClassName (void)
 Returns name of active class.
 
DSS_CAPI_DLL int32_t ActiveClass_Get_Count (void)
 Number of elements in Active Class. More...
 
DSS_CAPI_DLL char * ActiveClass_Get_ActiveClassParent (void)
 Use this property (Read only) for getting the name of the parent class' name of the active class.
 
DSS_CAPI_DLL char * ActiveClass_ToJSON (int32_t options)
 Returns the data (as a list) of all elements from the active class as a JSON-encoded string. More...
 
DSS_CAPI_DLL char * Bus_Get_Name (void)
 Name of Bus.
 
DSS_CAPI_DLL int32_t Bus_Get_NumNodes (void)
 Number of Nodes this bus.
 
DSS_CAPI_DLL void Bus_Get_SeqVoltages (double **ResultPtr, int32_t *ResultCount)
 Double Array of sequence voltages at this bus.
 
DSS_CAPI_DLL void Bus_Get_SeqVoltages_GR (void)
 Same as Bus_Get_SeqVoltages but using the global buffer interface for results.
 
DSS_CAPI_DLL void Bus_Get_Voltages (double **ResultPtr, int32_t *ResultCount)
 Complex array of voltages at this bus.
 
DSS_CAPI_DLL void Bus_Get_Voltages_GR (void)
 Same as Bus_Get_Voltages but using the global buffer interface for results.
 
DSS_CAPI_DLL void Bus_Get_Nodes (int32_t **ResultPtr, int32_t *ResultCount)
 Integer Array of Node Numbers defined at the bus in same order as the voltages.
 
DSS_CAPI_DLL void Bus_Get_Nodes_GR (void)
 Same as Bus_Get_Nodes but using the global buffer interface for results.
 
DSS_CAPI_DLL void Bus_Get_Isc (double **ResultPtr, int32_t *ResultCount)
 Short circuit currents at bus; Complex Array.
 
DSS_CAPI_DLL void Bus_Get_Isc_GR (void)
 Same as Bus_Get_Isc but using the global buffer interface for results.
 
DSS_CAPI_DLL void Bus_Get_Voc (double **ResultPtr, int32_t *ResultCount)
 Open circuit voltage; Complex array.
 
DSS_CAPI_DLL void Bus_Get_Voc_GR (void)
 Same as Bus_Get_Voc but using the global buffer interface for results.
 
DSS_CAPI_DLL double Bus_Get_kVBase (void)
 Base voltage at bus in kV.
 
DSS_CAPI_DLL void Bus_Get_puVoltages (double **ResultPtr, int32_t *ResultCount)
 Complex Array of pu voltages at the bus.
 
DSS_CAPI_DLL void Bus_Get_puVoltages_GR (void)
 Same as Bus_Get_puVoltages but using the global buffer interface for results.
 
DSS_CAPI_DLL void Bus_Get_Zsc0 (double **ResultPtr, int32_t *ResultCount)
 Complex Zero-Sequence short circuit impedance at bus.
 
DSS_CAPI_DLL void Bus_Get_Zsc0_GR (void)
 Same as Bus_Get_Zsc0 but using the global buffer interface for results.
 
DSS_CAPI_DLL void Bus_Get_Zsc1 (double **ResultPtr, int32_t *ResultCount)
 Complex Positive-Sequence short circuit impedance at bus.
 
DSS_CAPI_DLL void Bus_Get_Zsc1_GR (void)
 Same as Bus_Get_Zsc1 but using the global buffer interface for results.
 
DSS_CAPI_DLL void Bus_Get_ZscMatrix (double **ResultPtr, int32_t *ResultCount)
 Complex array of Zsc matrix at bus. More...
 
DSS_CAPI_DLL void Bus_Get_ZscMatrix_GR (void)
 Same as Bus_Get_ZscMatrix but using the global buffer interface for results.
 
DSS_CAPI_DLL uint16_t Bus_ZscRefresh (void)
 
DSS_CAPI_DLL void Bus_Get_YscMatrix (double **ResultPtr, int32_t *ResultCount)
 Complex array of Ysc matrix at bus. More...
 
DSS_CAPI_DLL void Bus_Get_YscMatrix_GR (void)
 Same as Bus_Get_YscMatrix but using the global buffer interface for results.
 
DSS_CAPI_DLL uint16_t Bus_Get_Coorddefined (void)
 False=0 else True. More...
 
DSS_CAPI_DLL double Bus_Get_x (void)
 X Coordinate for bus (double)
 
DSS_CAPI_DLL void Bus_Set_x (double Value)
 X Coordinate for bus (double)
 
DSS_CAPI_DLL double Bus_Get_y (void)
 Y coordinate for bus(double)
 
DSS_CAPI_DLL void Bus_Set_y (double Value)
 Y coordinate for bus(double)
 
DSS_CAPI_DLL double Bus_Get_Distance (void)
 Distance from energymeter (if non-zero)
 
DSS_CAPI_DLL int32_t Bus_GetUniqueNodeNumber (int32_t StartNumber)
 
DSS_CAPI_DLL void Bus_Get_CplxSeqVoltages (double **ResultPtr, int32_t *ResultCount)
 Complex Double array of Sequence Voltages (0, 1, 2) at this Bus.
 
DSS_CAPI_DLL void Bus_Get_CplxSeqVoltages_GR (void)
 Same as Bus_Get_CplxSeqVoltages but using the global buffer interface for results.
 
DSS_CAPI_DLL double Bus_Get_Int_Duration (void)
 Average interruption duration, hr.
 
DSS_CAPI_DLL double Bus_Get_Lambda (void)
 Accumulated failure rate downstream from this bus; faults per year.
 
DSS_CAPI_DLL double Bus_Get_Cust_Duration (void)
 Accumulated customer outage durations.
 
DSS_CAPI_DLL double Bus_Get_Cust_Interrupts (void)
 Annual number of customer-interruptions from this bus.
 
DSS_CAPI_DLL int32_t Bus_Get_N_Customers (void)
 Total numbers of customers served downline from this bus.
 
DSS_CAPI_DLL double Bus_Get_N_interrupts (void)
 Number of interruptions this bus per year.
 
DSS_CAPI_DLL void Bus_Get_puVLL (double **ResultPtr, int32_t *ResultCount)
 Returns Complex array of pu L-L voltages for 2- and 3-phase buses. More...
 
DSS_CAPI_DLL void Bus_Get_puVLL_GR (void)
 Same as Bus_Get_puVLL but using the global buffer interface for results.
 
DSS_CAPI_DLL void Bus_Get_VLL (double **ResultPtr, int32_t *ResultCount)
 For 2- and 3-phase buses, returns array of complex numbers represetin L-L voltages in volts. More...
 
DSS_CAPI_DLL void Bus_Get_VLL_GR (void)
 Same as Bus_Get_VLL but using the global buffer interface for results.
 
DSS_CAPI_DLL void Bus_Get_puVmagAngle (double **ResultPtr, int32_t *ResultCount)
 Array of doubles containig voltage magnitude, angle pairs in per unit.
 
DSS_CAPI_DLL void Bus_Get_puVmagAngle_GR (void)
 Same as Bus_Get_puVmagAngle but using the global buffer interface for results.
 
DSS_CAPI_DLL void Bus_Get_VMagAngle (double **ResultPtr, int32_t *ResultCount)
 Array of doubles containing voltages in Magnitude (VLN), angle (deg)
 
DSS_CAPI_DLL void Bus_Get_VMagAngle_GR (void)
 Same as Bus_Get_VMagAngle but using the global buffer interface for results.
 
DSS_CAPI_DLL double Bus_Get_TotalMiles (void)
 Total length of line downline from this bus, in miles. More...
 
DSS_CAPI_DLL int32_t Bus_Get_SectionID (void)
 Integer ID of the feeder section in which this bus is located.
 
DSS_CAPI_DLL void Bus_Get_LineList (char ***ResultPtr, int32_t *ResultCount)
 Array of strings: Full Names of LINE elements connected to the active bus.
 
DSS_CAPI_DLL void Bus_Get_LineList_GR (void)
 Same as Bus_Get_LineList but using the global buffer interface for results.
 
DSS_CAPI_DLL void Bus_Get_LoadList (char ***ResultPtr, int32_t *ResultCount)
 Array of strings: Full Names of LOAD elements connected to the active bus.
 
DSS_CAPI_DLL void Bus_Get_LoadList_GR (void)
 Same as Bus_Get_LineList but using the global buffer interface for results.
 
DSS_CAPI_DLL void Bus_Get_ZSC012Matrix (double **ResultPtr, int32_t *ResultCount)
 Array of 18 doubles (9 complex values) containing the complete 012 Zsc matrix.
 
DSS_CAPI_DLL void Bus_Get_ZSC012Matrix_GR (void)
 Same as Bus_Get_ZSC012Matrix but using the global buffer interface for results.
 
DSS_CAPI_DLL void Bus_Get_AllPCEatBus (char ***ResultPtr, int32_t *ResultCount)
 Returns an array with the names of all PCE connected to the active bus

 
DSS_CAPI_DLL void Bus_Get_AllPDEatBus (char ***ResultPtr, int32_t *ResultCount)
 Returns an array with the names of all PDE connected to the active bus.
 
DSS_CAPI_DLL void Capacitors_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings with all Capacitor names in the circuit.
 
DSS_CAPI_DLL void Capacitors_Get_AllNames_GR (void)
 Same as Capacitors_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Capacitors_Get_First (void)
 Sets the first Capacitor active. More...
 
DSS_CAPI_DLL uint16_t Capacitors_Get_IsDelta (void)
 Delta connection or wye?
 
DSS_CAPI_DLL double Capacitors_Get_kV (void)
 Bank kV rating. More...
 
DSS_CAPI_DLL double Capacitors_Get_kvar (void)
 Total bank KVAR, distributed equally among phases and steps.
 
DSS_CAPI_DLL char * Capacitors_Get_Name (void)
 Sets the active Capacitor by Name.
 
DSS_CAPI_DLL int32_t Capacitors_Get_Next (void)
 Sets the next Capacitor active. More...
 
DSS_CAPI_DLL int32_t Capacitors_Get_NumSteps (void)
 Number of steps (default 1) for distributing and switching the total bank kVAR.
 
DSS_CAPI_DLL void Capacitors_Set_IsDelta (uint16_t Value)
 Delta connection or wye?
 
DSS_CAPI_DLL void Capacitors_Set_kV (double Value)
 Bank kV rating. More...
 
DSS_CAPI_DLL void Capacitors_Set_kvar (double Value)
 Total bank KVAR, distributed equally among phases and steps.
 
DSS_CAPI_DLL void Capacitors_Set_Name (const char *Value)
 Sets the active Capacitor by Name.
 
DSS_CAPI_DLL void Capacitors_Set_NumSteps (int32_t Value)
 Number of steps (default 1) for distributing and switching the total bank kVAR.
 
DSS_CAPI_DLL int32_t Capacitors_Get_Count (void)
 Number of Capacitor objects in active circuit.
 
DSS_CAPI_DLL uint16_t Capacitors_AddStep (void)
 
DSS_CAPI_DLL uint16_t Capacitors_SubtractStep (void)
 
DSS_CAPI_DLL int32_t Capacitors_Get_AvailableSteps (void)
 Number of Steps available in cap bank to be switched ON.
 
DSS_CAPI_DLL void Capacitors_Get_States (int32_t **ResultPtr, int32_t *ResultCount)
 A array of integer [0..numsteps-1] indicating state of each step. More...
 
DSS_CAPI_DLL void Capacitors_Get_States_GR (void)
 Same as Capacitors_Get_States but using the global buffer interface for results.
 
DSS_CAPI_DLL void Capacitors_Set_States (int32_t *ValuePtr, int32_t ValueCount)
 Array of integer [0..numSteps-1] indicating the state of each step.
 
DSS_CAPI_DLL void Capacitors_Open (void)
 
DSS_CAPI_DLL void Capacitors_Close (void)
 
DSS_CAPI_DLL void CapControls_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings with all CapControl names.
 
DSS_CAPI_DLL void CapControls_Get_AllNames_GR (void)
 Same as CapControls_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL char * CapControls_Get_Capacitor (void)
 Name of the Capacitor that is controlled.
 
DSS_CAPI_DLL double CapControls_Get_CTratio (void)
 Transducer ratio from pirmary current to control current.
 
DSS_CAPI_DLL double CapControls_Get_DeadTime (void)
 
DSS_CAPI_DLL double CapControls_Get_Delay (void)
 Time delay [s] to switch on after arming. More...
 
DSS_CAPI_DLL double CapControls_Get_DelayOff (void)
 Time delay [s] before swithcing off a step. More...
 
DSS_CAPI_DLL int32_t CapControls_Get_First (void)
 Sets the first CapControl as active. More...
 
DSS_CAPI_DLL int32_t CapControls_Get_Mode (void)
 Type of automatic controller.
 
DSS_CAPI_DLL char * CapControls_Get_MonitoredObj (void)
 Full name of the element that PT and CT are connected to.
 
DSS_CAPI_DLL int32_t CapControls_Get_MonitoredTerm (void)
 Terminal number on the element that PT and CT are connected to.
 
DSS_CAPI_DLL char * CapControls_Get_Name (void)
 Sets a CapControl active by name.
 
DSS_CAPI_DLL int32_t CapControls_Get_Next (void)
 Gets the next CapControl in the circut. More...
 
DSS_CAPI_DLL double CapControls_Get_OFFSetting (void)
 Threshold to switch off a step. More...
 
DSS_CAPI_DLL double CapControls_Get_ONSetting (void)
 Threshold to arm or switch on a step. More...
 
DSS_CAPI_DLL double CapControls_Get_PTratio (void)
 Transducer ratio from primary feeder to control voltage.
 
DSS_CAPI_DLL uint16_t CapControls_Get_UseVoltOverride (void)
 Enables Vmin and Vmax to override the control Mode.
 
DSS_CAPI_DLL double CapControls_Get_Vmax (void)
 With VoltOverride, swtich off whenever PT voltage exceeds this level.
 
DSS_CAPI_DLL double CapControls_Get_Vmin (void)
 With VoltOverride, switch ON whenever PT voltage drops below this level.
 
DSS_CAPI_DLL void CapControls_Set_Capacitor (const char *Value)
 Name of the Capacitor that is controlled.
 
DSS_CAPI_DLL void CapControls_Set_CTratio (double Value)
 Transducer ratio from pirmary current to control current.
 
DSS_CAPI_DLL void CapControls_Set_DeadTime (double Value)
 
DSS_CAPI_DLL void CapControls_Set_Delay (double Value)
 Time delay [s] to switch on after arming. More...
 
DSS_CAPI_DLL void CapControls_Set_DelayOff (double Value)
 Time delay [s] before swithcing off a step. More...
 
DSS_CAPI_DLL void CapControls_Set_Mode (int32_t Value)
 Type of automatic controller.
 
DSS_CAPI_DLL void CapControls_Set_MonitoredObj (const char *Value)
 Full name of the element that PT and CT are connected to.
 
DSS_CAPI_DLL void CapControls_Set_MonitoredTerm (int32_t Value)
 Terminal number on the element that PT and CT are connected to.
 
DSS_CAPI_DLL void CapControls_Set_Name (const char *Value)
 Sets a CapControl active by name.
 
DSS_CAPI_DLL void CapControls_Set_OFFSetting (double Value)
 Threshold to switch off a step. More...
 
DSS_CAPI_DLL void CapControls_Set_ONSetting (double Value)
 Threshold to arm or switch on a step. More...
 
DSS_CAPI_DLL void CapControls_Set_PTratio (double Value)
 Transducer ratio from primary feeder to control voltage.
 
DSS_CAPI_DLL void CapControls_Set_UseVoltOverride (uint16_t Value)
 Enables Vmin and Vmax to override the control Mode.
 
DSS_CAPI_DLL void CapControls_Set_Vmax (double Value)
 With VoltOverride, swtich off whenever PT voltage exceeds this level.
 
DSS_CAPI_DLL void CapControls_Set_Vmin (double Value)
 With VoltOverride, switch ON whenever PT voltage drops below this level.
 
DSS_CAPI_DLL int32_t CapControls_Get_Count (void)
 Number of CapControls in Active Circuit.
 
DSS_CAPI_DLL void CapControls_Reset (void)
 
DSS_CAPI_DLL char * Circuit_Get_Name (void)
 Name of the active circuit.
 
DSS_CAPI_DLL int32_t Circuit_Get_NumBuses (void)
 Total number of Buses in the circuit.
 
DSS_CAPI_DLL int32_t Circuit_Get_NumCktElements (void)
 Number of CktElements in the circuit.
 
DSS_CAPI_DLL int32_t Circuit_Get_NumNodes (void)
 Total number of nodes in the circuit.
 
DSS_CAPI_DLL void Circuit_Get_LineLosses (double **ResultPtr, int32_t *ResultCount)
 Complex total line losses in the circuit.
 
DSS_CAPI_DLL void Circuit_Get_LineLosses_GR (void)
 Same as Circuit_Get_LineLosses but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_Get_Losses (double **ResultPtr, int32_t *ResultCount)
 Total losses in active circuit, complex number (two-element array of double).
 
DSS_CAPI_DLL void Circuit_Get_Losses_GR (void)
 Same as Circuit_Get_Losses but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_Get_AllBusVmag (double **ResultPtr, int32_t *ResultCount)
 Array of magnitudes (doubles) of voltages at all buses.
 
DSS_CAPI_DLL void Circuit_Get_AllBusVmag_GR (void)
 Same as Circuit_Get_AllBusVmag but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_Get_AllBusVolts (double **ResultPtr, int32_t *ResultCount)
 Complex array of all bus, node voltages from most recent solution.
 
DSS_CAPI_DLL void Circuit_Get_AllBusVolts_GR (void)
 Same as Circuit_Get_AllBusVolts but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_Get_AllElementNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings containing Full Name of all elements.
 
DSS_CAPI_DLL void Circuit_Get_AllElementNames_GR (void)
 Same as Circuit_Get_AllElementNames but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_Get_SubstationLosses (double **ResultPtr, int32_t *ResultCount)
 Complex losses in all transformers designated to substations.
 
DSS_CAPI_DLL void Circuit_Get_SubstationLosses_GR (void)
 Same as Circuit_Get_SubstationLosses but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_Get_TotalPower (double **ResultPtr, int32_t *ResultCount)
 Total power, kW delivered to the circuit.
 
DSS_CAPI_DLL void Circuit_Get_TotalPower_GR (void)
 Same as Circuit_Get_TotalPower but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_Disable (const char *Name)
 
DSS_CAPI_DLL void Circuit_Enable (const char *Name)
 
DSS_CAPI_DLL int32_t Circuit_FirstPCElement (void)
 
DSS_CAPI_DLL int32_t Circuit_FirstPDElement (void)
 
DSS_CAPI_DLL int32_t Circuit_NextPCElement (void)
 
DSS_CAPI_DLL int32_t Circuit_NextPDElement (void)
 
DSS_CAPI_DLL void Circuit_Get_AllBusNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings containing names of all buses in circuit (see AllNodeNames).
 
DSS_CAPI_DLL void Circuit_Get_AllBusNames_GR (void)
 Same as Circuit_Get_AllBusNames but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_Get_AllElementLosses (double **ResultPtr, int32_t *ResultCount)
 Array of total losses (complex) in each circuit element.
 
DSS_CAPI_DLL void Circuit_Get_AllElementLosses_GR (void)
 Same as Circuit_Get_AllElementLosses but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_Sample (void)
 
DSS_CAPI_DLL void Circuit_SaveSample (void)
 
DSS_CAPI_DLL int32_t Circuit_SetActiveElement (const char *FullName)
 
DSS_CAPI_DLL double Circuit_Capacity (double Start, double Increment)
 
DSS_CAPI_DLL void Circuit_Get_AllBusVmagPu (double **ResultPtr, int32_t *ResultCount)
 Double Array of all bus voltages (each node) magnitudes in Per unit.
 
DSS_CAPI_DLL void Circuit_Get_AllBusVmagPu_GR (void)
 Same as Circuit_Get_AllBusVmagPu but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Circuit_SetActiveBus (const char *BusName)
 
DSS_CAPI_DLL int32_t Circuit_SetActiveBusi (int32_t BusIndex)
 
DSS_CAPI_DLL void Circuit_Get_AllNodeNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings containing full name of each node in system in same order as returned by AllBusVolts, etc.
 
DSS_CAPI_DLL void Circuit_Get_AllNodeNames_GR (void)
 Same as Circuit_Get_AllNodeNames but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_Get_SystemY (double **ResultPtr, int32_t *ResultCount)
 System Y matrix (after a solution has been performed)
 
DSS_CAPI_DLL void Circuit_Get_SystemY_GR (void)
 Same as Circuit_Get_SystemY but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_Get_AllBusDistances (double **ResultPtr, int32_t *ResultCount)
 Returns distance from each bus to parent EnergyMeter. More...
 
DSS_CAPI_DLL void Circuit_Get_AllBusDistances_GR (void)
 Same as Circuit_Get_AllBusDistances but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_Get_AllNodeDistances (double **ResultPtr, int32_t *ResultCount)
 Returns an array of distances from parent EnergyMeter for each Node. More...
 
DSS_CAPI_DLL void Circuit_Get_AllNodeDistances_GR (void)
 Same as Circuit_Get_AllNodeDistances but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_Get_AllNodeDistancesByPhase (double **ResultPtr, int32_t *ResultCount, int32_t Phase)
 Returns an array of doubles representing the distances to parent EnergyMeter. More...
 
DSS_CAPI_DLL void Circuit_Get_AllNodeDistancesByPhase_GR (int32_t Phase)
 Same as Circuit_Get_AllNodeDistancesByPhase but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_Get_AllNodeVmagByPhase (double **ResultPtr, int32_t *ResultCount, int32_t Phase)
 Returns Array of doubles represent voltage magnitudes for nodes on the specified phase.
 
DSS_CAPI_DLL void Circuit_Get_AllNodeVmagByPhase_GR (int32_t Phase)
 Same as Circuit_Get_AllNodeVmagByPhase but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_Get_AllNodeVmagPUByPhase (double **ResultPtr, int32_t *ResultCount, int32_t Phase)
 Returns array of per unit voltage magnitudes for each node by phase.
 
DSS_CAPI_DLL void Circuit_Get_AllNodeVmagPUByPhase_GR (int32_t Phase)
 Same as Circuit_Get_AllNodeVmagPUByPhase but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_Get_AllNodeNamesByPhase (char ***ResultPtr, int32_t *ResultCount, int32_t Phase)
 Return array of strings of the node names for the By Phase criteria. More...
 
DSS_CAPI_DLL void Circuit_Get_AllNodeNamesByPhase_GR (int32_t Phase)
 Same as Circuit_Get_AllNodeNamesByPhase but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Circuit_SetActiveClass (const char *ClassName)
 
DSS_CAPI_DLL int32_t Circuit_FirstElement (void)
 
DSS_CAPI_DLL int32_t Circuit_NextElement (void)
 
DSS_CAPI_DLL void Circuit_UpdateStorage (void)
 
DSS_CAPI_DLL int32_t Circuit_Get_ParentPDElement (void)
 Sets Parent PD element, if any, to be the active circuit element and returns index>0; Returns 0 if it fails or not applicable.
 
DSS_CAPI_DLL void Circuit_EndOfTimeStepUpdate (void)
 
DSS_CAPI_DLL void Circuit_Get_YNodeOrder (char ***ResultPtr, int32_t *ResultCount)
 Array of strings containing the names of the nodes in the same order as the Y matrix.
 
DSS_CAPI_DLL void Circuit_Get_YNodeOrder_GR (void)
 Same as Circuit_Get_YNodeOrder but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_Get_YCurrents (double **ResultPtr, int32_t *ResultCount)
 Array of doubles containing complex injection currents for the present solution. More...
 
DSS_CAPI_DLL void Circuit_Get_YCurrents_GR (void)
 Same as Circuit_Get_YCurrents but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_Get_YNodeVarray (double **ResultPtr, int32_t *ResultCount)
 Complex array of actual node voltages in same order as SystemY matrix.
 
DSS_CAPI_DLL void Circuit_Get_YNodeVarray_GR (void)
 Same as Circuit_Get_YNodeVarray but using the global buffer interface for results.
 
DSS_CAPI_DLL void Circuit_SetCktElementName (const char *Value)
 
DSS_CAPI_DLL void Circuit_SetCktElementIndex (int32_t Value)
 
DSS_CAPI_DLL void CktElement_Get_BusNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings. More...
 
DSS_CAPI_DLL void CktElement_Get_BusNames_GR (void)
 Same as CktElement_Get_BusNames but using the global buffer interface for results.
 
DSS_CAPI_DLL char * CktElement_Get_Name (void)
 Full Name of Active Circuit Element.
 
DSS_CAPI_DLL int32_t CktElement_Get_NumConductors (void)
 Number of Conductors per Terminal.
 
DSS_CAPI_DLL int32_t CktElement_Get_NumPhases (void)
 Number of Phases.
 
DSS_CAPI_DLL int32_t CktElement_Get_NumTerminals (void)
 Number of Terminals this Circuit Element.
 
DSS_CAPI_DLL void CktElement_Set_BusNames (const char **ValuePtr, int32_t ValueCount)
 Array of strings. More...
 
DSS_CAPI_DLL void CktElement_Get_Currents (double **ResultPtr, int32_t *ResultCount)
 Complex array of currents into each conductor of each terminal.
 
DSS_CAPI_DLL void CktElement_Get_Currents_GR (void)
 Same as CktElement_Get_Currents but using the global buffer interface for results.
 
DSS_CAPI_DLL void CktElement_Get_Voltages (double **ResultPtr, int32_t *ResultCount)
 Complex array of voltages at terminals.
 
DSS_CAPI_DLL void CktElement_Get_Voltages_GR (void)
 Same as CktElement_Get_Voltages but using the global buffer interface for results.
 
DSS_CAPI_DLL double CktElement_Get_EmergAmps (void)
 Emergency Ampere Rating for PD elements.
 
DSS_CAPI_DLL uint16_t CktElement_Get_Enabled (void)
 Boolean indicating that element is currently in the circuit.
 
DSS_CAPI_DLL void CktElement_Get_Losses (double **ResultPtr, int32_t *ResultCount)
 Total losses in the element: two-element complex array, in VA.
 
DSS_CAPI_DLL void CktElement_Get_Losses_GR (void)
 Same as CktElement_Get_Losses but using the global buffer interface for results.
 
DSS_CAPI_DLL double CktElement_Get_NormalAmps (void)
 Normal ampere rating for PD Elements.
 
DSS_CAPI_DLL void CktElement_Get_PhaseLosses (double **ResultPtr, int32_t *ResultCount)
 Complex array of losses by phase.
 
DSS_CAPI_DLL void CktElement_Get_PhaseLosses_GR (void)
 Same as CktElement_Get_PhaseLosses but using the global buffer interface for results.
 
DSS_CAPI_DLL void CktElement_Get_Powers (double **ResultPtr, int32_t *ResultCount)
 Complex array of powers into each conductor of each terminal.
 
DSS_CAPI_DLL void CktElement_Get_Powers_GR (void)
 Same as CktElement_Get_Powers but using the global buffer interface for results.
 
DSS_CAPI_DLL void CktElement_Get_SeqCurrents (double **ResultPtr, int32_t *ResultCount)
 Double array of symmetrical component currents into each 3-phase terminal.
 
DSS_CAPI_DLL void CktElement_Get_SeqCurrents_GR (void)
 Same as CktElement_Get_SeqCurrents but using the global buffer interface for results.
 
DSS_CAPI_DLL void CktElement_Get_SeqPowers (double **ResultPtr, int32_t *ResultCount)
 Double array of sequence powers into each 3-phase teminal.
 
DSS_CAPI_DLL void CktElement_Get_SeqPowers_GR (void)
 Same as CktElement_Get_SeqPowers but using the global buffer interface for results.
 
DSS_CAPI_DLL void CktElement_Get_SeqVoltages (double **ResultPtr, int32_t *ResultCount)
 Double array of symmetrical component voltages at each 3-phase terminal.
 
DSS_CAPI_DLL void CktElement_Get_SeqVoltages_GR (void)
 Same as CktElement_Get_SeqVoltages but using the global buffer interface for results.
 
DSS_CAPI_DLL void CktElement_Close (int32_t Term, int32_t Phs)
 
DSS_CAPI_DLL void CktElement_Open (int32_t Term, int32_t Phs)
 
DSS_CAPI_DLL void CktElement_Set_EmergAmps (double Value)
 Emergency Ampere Rating.
 
DSS_CAPI_DLL void CktElement_Set_Enabled (uint16_t Value)
 Boolean indicating that element is currently in the circuit.
 
DSS_CAPI_DLL void CktElement_Set_NormalAmps (double Value)
 Normal ampere rating.
 
DSS_CAPI_DLL uint16_t CktElement_IsOpen (int32_t Term, int32_t Phs)
 
DSS_CAPI_DLL void CktElement_Get_AllPropertyNames (char ***ResultPtr, int32_t *ResultCount)
 Array containing all property names of the active device.
 
DSS_CAPI_DLL void CktElement_Get_AllPropertyNames_GR (void)
 Same as CktElement_Get_AllPropertyNames but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t CktElement_Get_NumProperties (void)
 Number of Properties this Circuit Element.
 
DSS_CAPI_DLL void CktElement_Get_Residuals (double **ResultPtr, int32_t *ResultCount)
 Residual currents for each terminal: (mag, angle)
 
DSS_CAPI_DLL void CktElement_Get_Residuals_GR (void)
 Same as CktElement_Get_Residuals but using the global buffer interface for results.
 
DSS_CAPI_DLL void CktElement_Get_Yprim (double **ResultPtr, int32_t *ResultCount)
 YPrim matrix, column order, complex numbers (paired)
 
DSS_CAPI_DLL void CktElement_Get_Yprim_GR (void)
 Same as CktElement_Get_Yprim but using the global buffer interface for results.
 
DSS_CAPI_DLL char * CktElement_Get_DisplayName (void)
 Display name of the object (not necessarily unique)
 
DSS_CAPI_DLL char * CktElement_Get_GUID (void)
 globally unique identifier for this object
 
DSS_CAPI_DLL int32_t CktElement_Get_Handle (void)
 Pointer to this object.
 
DSS_CAPI_DLL void CktElement_Set_DisplayName (const char *Value)
 Display name of the object (not necessarily unique)
 
DSS_CAPI_DLL char * CktElement_Get_Controller (int32_t idx)
 Full name of the i-th controller attached to this element. More...
 
DSS_CAPI_DLL char * CktElement_Get_EnergyMeter (void)
 Name of the Energy Meter this element is assigned to.
 
DSS_CAPI_DLL uint16_t CktElement_Get_HasVoltControl (void)
 This element has a CapControl or RegControl attached.
 
DSS_CAPI_DLL uint16_t CktElement_Get_HasSwitchControl (void)
 This element has a SwtControl attached.
 
DSS_CAPI_DLL void CktElement_Get_CplxSeqVoltages (double **ResultPtr, int32_t *ResultCount)
 Complex double array of Sequence Voltage for all terminals of active circuit element.
 
DSS_CAPI_DLL void CktElement_Get_CplxSeqVoltages_GR (void)
 Same as CktElement_Get_CplxSeqVoltages but using the global buffer interface for results.
 
DSS_CAPI_DLL void CktElement_Get_CplxSeqCurrents (double **ResultPtr, int32_t *ResultCount)
 Complex double array of Sequence Currents for all conductors of all terminals of active circuit element.
 
DSS_CAPI_DLL void CktElement_Get_CplxSeqCurrents_GR (void)
 Same as CktElement_Get_CplxSeqCurrents but using the global buffer interface for results.
 
DSS_CAPI_DLL void CktElement_Get_AllVariableNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings listing all the published variable names, if a PCElement. More...
 
DSS_CAPI_DLL void CktElement_Get_AllVariableNames_GR (void)
 Same as CktElement_Get_AllVariableNames but using the global buffer interface for results.
 
DSS_CAPI_DLL void CktElement_Get_AllVariableValues (double **ResultPtr, int32_t *ResultCount)
 Array of doubles. More...
 
DSS_CAPI_DLL void CktElement_Get_AllVariableValues_GR (void)
 Same as CktElement_Get_AllVariableValues but using the global buffer interface for results.
 
DSS_CAPI_DLL double CktElement_Get_Variable (const char *MyVarName, int32_t *Code)
 For PCElement, set/get the value of a variable by name. More...
 
DSS_CAPI_DLL void CktElement_Set_Variable (const char *MyVarName, int32_t *Code, double Value)
 
DSS_CAPI_DLL double CktElement_Get_Variablei (int32_t Idx, int32_t *Code)
 For PCElement, set/get the value of a variable by integer index.
 
DSS_CAPI_DLL void CktElement_Set_Variablei (int32_t Idx, int32_t *Code, double Value)
 
DSS_CAPI_DLL void CktElement_Get_NodeOrder (int32_t **ResultPtr, int32_t *ResultCount)
 Array of integer containing the node numbers (representing phases, for example) for each conductor of each terminal. More...
 
DSS_CAPI_DLL void CktElement_Get_NodeOrder_GR (void)
 Same as CktElement_Get_NodeOrder but using the global buffer interface for results.
 
DSS_CAPI_DLL uint16_t CktElement_Get_HasOCPDevice (void)
 True if a recloser, relay, or fuse controlling this ckt element. More...
 
DSS_CAPI_DLL int32_t CktElement_Get_NumControls (void)
 Number of controls connected to this device. More...
 
DSS_CAPI_DLL int32_t CktElement_Get_OCPDevIndex (void)
 Index into Controller list of OCP Device controlling this CktElement.
 
DSS_CAPI_DLL int32_t CktElement_Get_OCPDevType (void)
 0=None; 1=Fuse; 2=Recloser; 3=Relay; Type of OCP controller device
 
DSS_CAPI_DLL void CktElement_Get_CurrentsMagAng (double **ResultPtr, int32_t *ResultCount)
 Currents in magnitude, angle format as a array of doubles.
 
DSS_CAPI_DLL void CktElement_Get_CurrentsMagAng_GR (void)
 Same as CktElement_Get_CurrentsMagAng but using the global buffer interface for results.
 
DSS_CAPI_DLL void CktElement_Get_VoltagesMagAng (double **ResultPtr, int32_t *ResultCount)
 Voltages at each conductor in magnitude, angle form as array of doubles.
 
DSS_CAPI_DLL void CktElement_Get_VoltagesMagAng_GR (void)
 Same as CktElement_Get_VoltagesMagAng but using the global buffer interface for results.
 
DSS_CAPI_DLL uint16_t CktElement_Get_IsIsolated (void)
 Returns true if the current active element is isolated. More...
 
DSS_CAPI_DLL void CktElement_Get_TotalPowers (double **ResultPtr, int32_t *ResultCount)
 Returns the total powers (complex) at ALL terminals of the active circuit element.
 
DSS_CAPI_DLL void CktElement_Get_TotalPowers_GR (void)
 Same as CktElement_Get_TotalPowers but using the global buffer interface for results.
 
DSS_CAPI_DLL void CmathLib_Get_cmplx (double **ResultPtr, int32_t *ResultCount, double RealPart, double ImagPart)
 Convert real and imaginary doubles to Array of doubles.
 
DSS_CAPI_DLL void CmathLib_Get_cmplx_GR (double RealPart, double ImagPart)
 Same as CmathLib_Get_cmplx but using the global buffer interface for results.
 
DSS_CAPI_DLL double CmathLib_Get_cabs (double realpart, double imagpart)
 Return abs value of complex number given in real and imag doubles.
 
DSS_CAPI_DLL double CmathLib_Get_cdang (double RealPart, double ImagPart)
 Returns the angle, in degrees, of a complex number specified as two doubles: Realpart and imagpart.
 
DSS_CAPI_DLL void CmathLib_Get_ctopolardeg (double **ResultPtr, int32_t *ResultCount, double RealPart, double ImagPart)
 Convert complex number to magnitude and angle, degrees. More...
 
DSS_CAPI_DLL void CmathLib_Get_ctopolardeg_GR (double RealPart, double ImagPart)
 Same as CmathLib_Get_ctopolardeg but using the global buffer interface for results.
 
DSS_CAPI_DLL void CmathLib_Get_pdegtocomplex (double **ResultPtr, int32_t *ResultCount, double magnitude, double angle)
 Convert magnitude, angle in degrees to a complex number. More...
 
DSS_CAPI_DLL void CmathLib_Get_pdegtocomplex_GR (double magnitude, double angle)
 Same as CmathLib_Get_pdegtocomplex but using the global buffer interface for results.
 
DSS_CAPI_DLL void CmathLib_Get_cmul (double **ResultPtr, int32_t *ResultCount, double a1, double b1, double a2, double b2)
 Multiply two complex numbers: (a1, b1) * (a2, b2). More...
 
DSS_CAPI_DLL void CmathLib_Get_cmul_GR (double a1, double b1, double a2, double b2)
 Same as CmathLib_Get_cmul but using the global buffer interface for results.
 
DSS_CAPI_DLL void CmathLib_Get_cdiv (double **ResultPtr, int32_t *ResultCount, double a1, double b1, double a2, double b2)
 Divide two complex number: (a1, b1)/(a2, b2). More...
 
DSS_CAPI_DLL void CmathLib_Get_cdiv_GR (double a1, double b1, double a2, double b2)
 Same as CmathLib_Get_cdiv but using the global buffer interface for results.
 
DSS_CAPI_DLL void CtrlQueue_ClearQueue (void)
 
DSS_CAPI_DLL void CtrlQueue_Delete (int32_t ActionHandle)
 
DSS_CAPI_DLL int32_t CtrlQueue_Get_ActionCode (void)
 Code for the active action. More...
 
DSS_CAPI_DLL int32_t CtrlQueue_Get_DeviceHandle (void)
 Handle (User defined) to device that must act on the pending action.
 
DSS_CAPI_DLL int32_t CtrlQueue_Get_NumActions (void)
 Number of Actions on the current actionlist (that have been popped off the control queue by CheckControlActions)
 
DSS_CAPI_DLL int32_t CtrlQueue_Push (int32_t Hour, double Seconds, int32_t ActionCode, int32_t DeviceHandle)
 Push a control action onto the DSS control queue by time, action code, and device handle (user defined). More...
 
DSS_CAPI_DLL void CtrlQueue_Show (void)
 
DSS_CAPI_DLL void CtrlQueue_ClearActions (void)
 
DSS_CAPI_DLL int32_t CtrlQueue_Get_PopAction (void)
 Pops next action off the action list and makes it the active action. More...
 
DSS_CAPI_DLL void CtrlQueue_Set_Action (int32_t Param1)
 Set the active action by index.
 
DSS_CAPI_DLL int32_t CtrlQueue_Get_QueueSize (void)
 Number of items on the OpenDSS control Queue.
 
DSS_CAPI_DLL void CtrlQueue_DoAllQueue (void)
 
DSS_CAPI_DLL void CtrlQueue_Get_Queue (char ***ResultPtr, int32_t *ResultCount)
 Array of strings containing the entire queue in CSV format.
 
DSS_CAPI_DLL void CtrlQueue_Get_Queue_GR (void)
 Same as CtrlQueue_Get_Queue but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t DSS_Get_NumCircuits (void)
 Number of Circuits currently defined.
 
DSS_CAPI_DLL void DSS_ClearAll (void)
 
DSS_CAPI_DLL char * DSS_Get_Version (void)
 Get version string for the DSS.
 
DSS_CAPI_DLL uint16_t DSS_Start (int32_t code)
 Runs potential initialization of internal structures of the DSS engine. More...
 
DSS_CAPI_DLL void DSS_Get_Classes (char ***ResultPtr, int32_t *ResultCount)
 List of DSS intrinsic classes (names of the classes)
 
DSS_CAPI_DLL void DSS_Get_Classes_GR (void)
 Same as DSS_Get_Classes but using the global buffer interface for results.
 
DSS_CAPI_DLL void DSS_Get_UserClasses (char ***ResultPtr, int32_t *ResultCount)
 List of user-defined classes.
 
DSS_CAPI_DLL void DSS_Get_UserClasses_GR (void)
 Same as DSS_Get_UserClasses but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t DSS_Get_NumClasses (void)
 Number of DSS intrinsic classes.
 
DSS_CAPI_DLL int32_t DSS_Get_NumUserClasses (void)
 Number of user-defined classes.
 
DSS_CAPI_DLL char * DSS_Get_DataPath (void)
 DSS Data File Path. More...
 
DSS_CAPI_DLL void DSS_Set_DataPath (const char *Value)
 DSS Data File Path. More...
 
DSS_CAPI_DLL void DSS_Reset (void)
 
DSS_CAPI_DLL char * DSS_Get_DefaultEditor (void)
 Returns the path name for the default text editor.
 
DSS_CAPI_DLL int32_t DSS_SetActiveClass (const char *ClassName)
 
DSS_CAPI_DLL uint16_t DSS_Get_AllowForms (void)
 
DSS_CAPI_DLL void DSS_Set_AllowForms (uint16_t Value)
 
DSS_CAPI_DLL uint16_t DSS_Get_AllowEditor (void)
 Sets/gets the AllowEditor mode. More...
 
DSS_CAPI_DLL void DSS_Set_AllowEditor (uint16_t Value)
 
DSS_CAPI_DLL uint16_t DSS_Get_LegacyModels (void)
 If enabled, the legacy/deprecated models for PVSystem, InvControl, Storage and StorageControl are used. More...
 
DSS_CAPI_DLL void DSS_Set_LegacyModels (uint16_t Value)
 
DSS_CAPI_DLL uint16_t DSS_Get_AllowDOScmd (void)
 If enabled, the DOScmd command is allowed. More...
 
DSS_CAPI_DLL void DSS_Set_AllowDOScmd (uint16_t Value)
 
DSS_CAPI_DLL uint16_t DSS_Get_AllowChangeDir (void)
 If disabled, the engine will not change the active working directory during execution. More...
 
DSS_CAPI_DLL void DSS_Set_AllowChangeDir (uint16_t Value)
 
DSS_CAPI_DLL uint16_t DSS_Get_COMErrorResults (void)
 If enabled, in case of errors or empty arrays, the API returns arrays with values compatible with the official OpenDSS COM interface. More...
 
DSS_CAPI_DLL void DSS_Set_COMErrorResults (uint16_t Value)
 
DSS_CAPI_DLL void DSSElement_Get_AllPropertyNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings containing the names of all properties for the active DSS object.
 
DSS_CAPI_DLL void DSSElement_Get_AllPropertyNames_GR (void)
 Same as DSSElement_Get_AllPropertyNames but using the global buffer interface for results.
 
DSS_CAPI_DLL char * DSSElement_Get_Name (void)
 Full Name of Active DSS Object (general element or circuit element).
 
DSS_CAPI_DLL int32_t DSSElement_Get_NumProperties (void)
 Number of Properties for the active DSS object.
 
DSS_CAPI_DLL char * DSSElement_ToJSON (int32_t options)
 Returns the properties of the active DSS object as a JSON-encoded string. More...
 
DSS_CAPI_DLL void DSSimComs_BusVoltagepu (double **ResultPtr, int32_t *ResultCount, size_t Index)
 
DSS_CAPI_DLL void DSSimComs_BusVoltagepu_GR (size_t Index)
 Same as DSSimComs_BusVoltagepu but using the global buffer interface for results.
 
DSS_CAPI_DLL void DSSimComs_BusVoltage (double **ResultPtr, int32_t *ResultCount, size_t Index)
 
DSS_CAPI_DLL void DSSimComs_BusVoltage_GR (size_t Index)
 Same as DSSimComs_BusVoltage but using the global buffer interface for results.
 
DSS_CAPI_DLL void DSSProgress_Close (void)
 
DSS_CAPI_DLL void DSSProgress_Set_Caption (const char *Value)
 Caption to appear on the bottom of the DSS Progress form.
 
DSS_CAPI_DLL void DSSProgress_Set_PctProgress (int32_t Value)
 Percent progress to indicate [0..100].
 
DSS_CAPI_DLL void DSSProgress_Show (void)
 
DSS_CAPI_DLL char * DSSProperty_Get_Description (void)
 Description of the property.
 
DSS_CAPI_DLL char * DSSProperty_Get_Name (void)
 Name of Property.
 
DSS_CAPI_DLL char * DSSProperty_Get_Val (void)
 
DSS_CAPI_DLL void DSSProperty_Set_Val (const char *Value)
 
DSS_CAPI_DLL void DSSProperty_Set_Name (const char *Value)
 
DSS_CAPI_DLL void DSSProperty_Set_Index (int32_t Value)
 
DSS_CAPI_DLL char * DSS_Executive_Get_Command (int32_t i)
 Get i-th command.
 
DSS_CAPI_DLL int32_t DSS_Executive_Get_NumCommands (void)
 Number of DSS Executive Commands.
 
DSS_CAPI_DLL int32_t DSS_Executive_Get_NumOptions (void)
 Number of DSS Executive Options.
 
DSS_CAPI_DLL char * DSS_Executive_Get_Option (int32_t i)
 Get i-th option.
 
DSS_CAPI_DLL char * DSS_Executive_Get_CommandHelp (int32_t i)
 Get help string for i-th command.
 
DSS_CAPI_DLL char * DSS_Executive_Get_OptionHelp (int32_t i)
 Get help string for i-th option.
 
DSS_CAPI_DLL char * DSS_Executive_Get_OptionValue (int32_t i)
 Get present value of i-th option.
 
DSS_CAPI_DLL char * Error_Get_Description (void)
 Description of error for last operation.
 
DSS_CAPI_DLL int32_t Error_Get_Number (void)
 Error Number (returns current value and then resets to zero)
 
DSS_CAPI_DLL int32_t * Error_Get_NumberPtr (void)
 Integer pointer to the Error Number. More...
 
DSS_CAPI_DLL void Fuses_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings containing names of all Fuses in the circuit.
 
DSS_CAPI_DLL void Fuses_Get_AllNames_GR (void)
 Same as Fuses_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Fuses_Get_Count (void)
 Number of Fuse elements in the circuit.
 
DSS_CAPI_DLL int32_t Fuses_Get_First (void)
 Set the first Fuse to be the active fuse. More...
 
DSS_CAPI_DLL char * Fuses_Get_Name (void)
 Get the name of the active Fuse element.
 
DSS_CAPI_DLL int32_t Fuses_Get_Next (void)
 Advance the active Fuse element pointer to the next fuse. More...
 
DSS_CAPI_DLL void Fuses_Set_Name (const char *Value)
 Set the active Fuse element by name.
 
DSS_CAPI_DLL char * Fuses_Get_MonitoredObj (void)
 Full name of the circuit element to which the fuse is connected.
 
DSS_CAPI_DLL int32_t Fuses_Get_MonitoredTerm (void)
 Terminal number to which the fuse is connected.
 
DSS_CAPI_DLL char * Fuses_Get_SwitchedObj (void)
 Full name of the circuit element switch that the fuse controls. More...
 
DSS_CAPI_DLL void Fuses_Set_MonitoredObj (const char *Value)
 Full name of the circuit element to which the fuse is connected.
 
DSS_CAPI_DLL void Fuses_Set_MonitoredTerm (int32_t Value)
 Number of the terminal to which the fuse is connected.
 
DSS_CAPI_DLL void Fuses_Set_SwitchedObj (const char *Value)
 Full name of the circuit element switch that the fuse controls. More...
 
DSS_CAPI_DLL int32_t Fuses_Get_SwitchedTerm (void)
 Number of the terminal containing the switch controlled by the fuse.
 
DSS_CAPI_DLL void Fuses_Set_SwitchedTerm (int32_t Value)
 Number of the terminal of the controlled element containing the switch controlled by the fuse.
 
DSS_CAPI_DLL char * Fuses_Get_TCCcurve (void)
 Name of the TCCcurve object that determines fuse blowing.
 
DSS_CAPI_DLL void Fuses_Set_TCCcurve (const char *Value)
 Name of the TCCcurve object that determines fuse blowing.
 
DSS_CAPI_DLL double Fuses_Get_RatedCurrent (void)
 Multiplier or actual amps for the TCCcurve object. More...
 
DSS_CAPI_DLL void Fuses_Set_RatedCurrent (double Value)
 Multiplier or actual fuse amps for the TCC curve. More...
 
DSS_CAPI_DLL double Fuses_Get_Delay (void)
 A fixed delay time in seconds added to the fuse blowing time determined by the TCC curve. More...
 
DSS_CAPI_DLL void Fuses_Open (void)
 Manual opening of all phases of the fuse.
 
DSS_CAPI_DLL void Fuses_Close (void)
 Close all phases of the fuse.
 
DSS_CAPI_DLL void Fuses_Set_Delay (double Value)
 Fixed delay time in seconds added to the fuse blowing time to represent fuse clear or other delay.
 
DSS_CAPI_DLL uint16_t Fuses_IsBlown (void)
 Current state of the fuses. More...
 
DSS_CAPI_DLL int32_t Fuses_Get_idx (void)
 Get/set active fuse by index into the list of fuses. More...
 
DSS_CAPI_DLL void Fuses_Set_idx (int32_t Value)
 Set Fuse active by index into the list of fuses. More...
 
DSS_CAPI_DLL void Fuses_Reset (void)
 Reset fuse to normal state.
 
DSS_CAPI_DLL void Fuses_Get_State (char ***ResultPtr, int32_t *ResultCount)
 Array of strings ('open' or 'closed') indicating the state of each phase of the fuse.
 
DSS_CAPI_DLL void Fuses_Set_State (const char **ValuePtr, int32_t ValueCount)
 Array of strings ('open' or 'closed') indicating the state of each phase of the fuse.
 
DSS_CAPI_DLL void Fuses_Get_NormalState (char ***ResultPtr, int32_t *ResultCount)
 Array of strings ('open' or 'closed') indicating the normal state of each phase of the fuse.
 
DSS_CAPI_DLL void Fuses_Set_NormalState (const char **ValuePtr, int32_t ValueCount)
 Array of strings ('open' or 'closed') indicating the normal state of each phase of the fuse.
 
DSS_CAPI_DLL int32_t Fuses_Get_NumPhases (void)
 Number of phases, this fuse.
 
DSS_CAPI_DLL void Generators_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of names of all Generator objects.
 
DSS_CAPI_DLL void Generators_Get_AllNames_GR (void)
 Same as Generators_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Generators_Get_First (void)
 Sets first Generator to be active. More...
 
DSS_CAPI_DLL char * Generators_Get_Name (void)
 Sets a generator active by name.
 
DSS_CAPI_DLL int32_t Generators_Get_Next (void)
 Sets next Generator to be active. More...
 
DSS_CAPI_DLL void Generators_Get_RegisterNames (char ***ResultPtr, int32_t *ResultCount)
 Array of Names of all generator energy meter registers.
 
DSS_CAPI_DLL void Generators_Get_RegisterNames_GR (void)
 Same as Generators_Get_RegisterNames but using the global buffer interface for results.
 
DSS_CAPI_DLL void Generators_Get_RegisterValues (double **ResultPtr, int32_t *ResultCount)
 Array of values in generator energy meter registers.
 
DSS_CAPI_DLL void Generators_Get_RegisterValues_GR (void)
 Same as Generators_Get_RegisterValues but using the global buffer interface for results.
 
DSS_CAPI_DLL uint16_t Generators_Get_ForcedON (void)
 Indicates whether the generator is forced ON regardles of other dispatch criteria.
 
DSS_CAPI_DLL void Generators_Set_ForcedON (uint16_t Value)
 Indicates whether the generator is forced ON regardles of other dispatch criteria.
 
DSS_CAPI_DLL void Generators_Set_Name (const char *Value)
 Sets a generator active by name.
 
DSS_CAPI_DLL double Generators_Get_kV (void)
 Voltage base for the active generator, kV.
 
DSS_CAPI_DLL double Generators_Get_kvar (void)
 kvar output for the active generator. More...
 
DSS_CAPI_DLL double Generators_Get_kW (void)
 kW output for the active generator. More...
 
DSS_CAPI_DLL double Generators_Get_PF (void)
 Power factor (pos. More...
 
DSS_CAPI_DLL int32_t Generators_Get_Phases (void)
 Number of phases.
 
DSS_CAPI_DLL void Generators_Set_kV (double Value)
 Voltage base for the active generator, kV.
 
DSS_CAPI_DLL void Generators_Set_kvar (double Value)
 kvar output for the active generator. More...
 
DSS_CAPI_DLL void Generators_Set_kW (double Value)
 kW output for the active generator. More...
 
DSS_CAPI_DLL void Generators_Set_PF (double Value)
 Power factor (pos. More...
 
DSS_CAPI_DLL void Generators_Set_Phases (int32_t Value)
 Number of phases.
 
DSS_CAPI_DLL int32_t Generators_Get_Count (void)
 Number of Generator Objects in Active Circuit.
 
DSS_CAPI_DLL int32_t Generators_Get_idx (void)
 Get/Set active Generator by index into generators list. More...
 
DSS_CAPI_DLL void Generators_Set_idx (int32_t Value)
 Get/Set active Generator by index into generators list. More...
 
DSS_CAPI_DLL int32_t Generators_Get_Model (void)
 Generator Model.
 
DSS_CAPI_DLL void Generators_Set_Model (int32_t Value)
 Generator Model.
 
DSS_CAPI_DLL double Generators_Get_kVArated (void)
 kVA rating of the generator
 
DSS_CAPI_DLL void Generators_Set_kVArated (double Value)
 KVA Rating of the generator.
 
DSS_CAPI_DLL double Generators_Get_Vmaxpu (void)
 vmaxpu for Generator model
 
DSS_CAPI_DLL double Generators_Get_Vminpu (void)
 Vminpu for Generator model.
 
DSS_CAPI_DLL void Generators_Set_Vmaxpu (double Value)
 Vmaxpu for generator model.
 
DSS_CAPI_DLL void Generators_Set_Vminpu (double Value)
 Vminpu for Generator model.
 
DSS_CAPI_DLL char * Generators_Get_daily (void)
 Name of the loadshape for a daily generation profile. More...
 
DSS_CAPI_DLL void Generators_Set_daily (const char *Value)
 
DSS_CAPI_DLL char * Generators_Get_duty (void)
 Name of the loadshape for a duty cycle simulation. More...
 
DSS_CAPI_DLL void Generators_Set_duty (const char *Value)
 
DSS_CAPI_DLL char * Generators_Get_Yearly (void)
 Name of yearly loadshape. More...
 
DSS_CAPI_DLL void Generators_Set_Yearly (const char *Value)
 
DSS_CAPI_DLL int32_t Generators_Get_Status (void)
 Response to dispatch multipliers: Fixed=1 (dispatch multipliers do not apply), Variable=0 (follows curves). More...
 
DSS_CAPI_DLL void Generators_Set_Status (int32_t Value)
 
DSS_CAPI_DLL uint16_t Generators_Get_IsDelta (void)
 Generator connection. More...
 
DSS_CAPI_DLL void Generators_Set_IsDelta (uint16_t Value)
 
DSS_CAPI_DLL double Generators_Get_kva (void)
 kVA rating of electrical machine. More...
 
DSS_CAPI_DLL void Generators_Set_kva (double Value)
 
DSS_CAPI_DLL int32_t Generators_Get_Class_ (void)
 An arbitrary integer number representing the class of Generator so that Generator values may be segregated by class. More...
 
DSS_CAPI_DLL void Generators_Set_Class_ (int32_t Value)
 
DSS_CAPI_DLL char * Generators_Get_Bus1 (void)
 Bus to which the Generator is connected. More...
 
DSS_CAPI_DLL void Generators_Set_Bus1 (const char *Value)
 
DSS_CAPI_DLL void GICSources_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Names of all GICSource Objects.
 
DSS_CAPI_DLL void GICSources_Get_AllNames_GR (void)
 Same as GICSources_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t GICSources_Get_Count (void)
 Number of GICSource objects in Active Circuit.
 
DSS_CAPI_DLL int32_t GICSources_Get_First (void)
 Invoking this property sets the first element active. More...
 
DSS_CAPI_DLL int32_t GICSources_Get_Next (void)
 Invoking this property advances to the next GICSource element active. More...
 
DSS_CAPI_DLL char * GICSources_Get_Name (void)
 Specify the name of the GICSource element to set it active.
 
DSS_CAPI_DLL void GICSources_Set_Name (const char *Value)
 Specify the name of the GICSource element to set it active.
 
DSS_CAPI_DLL int32_t GICSources_Get_Phases (void)
 Number of Phases, this GICSource element.
 
DSS_CAPI_DLL void GICSources_Set_Phases (int32_t Value)
 Number of Phases, this GICSource element.
 
DSS_CAPI_DLL char * GICSources_Get_Bus1 (void)
 First bus name of GICSource (Created name)
 
DSS_CAPI_DLL char * GICSources_Get_Bus2 (void)
 Second bus name.
 
DSS_CAPI_DLL double GICSources_Get_EN (void)
 Northward E Field V/km.
 
DSS_CAPI_DLL void GICSources_Set_EN (double Value)
 Northward E Field V/km.
 
DSS_CAPI_DLL double GICSources_Get_EE (void)
 Eastward E Field, V/km.
 
DSS_CAPI_DLL void GICSources_Set_EE (double Value)
 Eastward E Field, V/km.
 
DSS_CAPI_DLL double GICSources_Get_Lat1 (void)
 Latitude of Bus1 (degrees)
 
DSS_CAPI_DLL void GICSources_Set_Lat1 (double Value)
 Latitude of Bus1 (degrees)
 
DSS_CAPI_DLL double GICSources_Get_Lat2 (void)
 Latitude of Bus2 (degrees)
 
DSS_CAPI_DLL void GICSources_Set_Lat2 (double Value)
 Latitude of Bus2 (degrees)
 
DSS_CAPI_DLL double GICSources_Get_Lon1 (void)
 Longitude of Bus1 (Degrees)
 
DSS_CAPI_DLL void GICSources_Set_Lon1 (double Value)
 Longitude of Bus1 (Degrees)
 
DSS_CAPI_DLL double GICSources_Get_Lon2 (void)
 Longitude of Bus2 (Degrees)
 
DSS_CAPI_DLL void GICSources_Set_Lon2 (double Value)
 Longitude of Bus2 (Degrees)
 
DSS_CAPI_DLL double GICSources_Get_Volts (void)
 Specify dc voltage directly.
 
DSS_CAPI_DLL void GICSources_Set_Volts (double Value)
 Specify dc voltage directly.
 
DSS_CAPI_DLL void ISources_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings containing names of all ISOURCE elements.
 
DSS_CAPI_DLL void ISources_Get_AllNames_GR (void)
 Same as ISources_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t ISources_Get_Count (void)
 Count: Number of ISOURCE elements.
 
DSS_CAPI_DLL int32_t ISources_Get_First (void)
 Set the First ISOURCE to be active; returns Zero if none.
 
DSS_CAPI_DLL int32_t ISources_Get_Next (void)
 Sets the next ISOURCE element to be the active one. More...
 
DSS_CAPI_DLL char * ISources_Get_Name (void)
 Get name of active ISOURCE.
 
DSS_CAPI_DLL void ISources_Set_Name (const char *Value)
 Set Active ISOURCE by name.
 
DSS_CAPI_DLL double ISources_Get_Amps (void)
 Get the magnitude of the ISOURCE in amps.
 
DSS_CAPI_DLL void ISources_Set_Amps (double Value)
 Set the magnitude of the ISOURCE, amps.
 
DSS_CAPI_DLL double ISources_Get_AngleDeg (void)
 Phase angle for ISOURCE, degrees.
 
DSS_CAPI_DLL double ISources_Get_Frequency (void)
 The present frequency of the ISOURCE, Hz.
 
DSS_CAPI_DLL void ISources_Set_AngleDeg (double Value)
 Phase angle for ISOURCE, degrees.
 
DSS_CAPI_DLL void ISources_Set_Frequency (double Value)
 Set the present frequency for the ISOURCE.
 
DSS_CAPI_DLL int32_t LineCodes_Get_Count (void)
 Number of LineCodes.
 
DSS_CAPI_DLL int32_t LineCodes_Get_First (void)
 
DSS_CAPI_DLL int32_t LineCodes_Get_Next (void)
 
DSS_CAPI_DLL char * LineCodes_Get_Name (void)
 Name of active LineCode.
 
DSS_CAPI_DLL void LineCodes_Set_Name (const char *Value)
 
DSS_CAPI_DLL uint16_t LineCodes_Get_IsZ1Z0 (void)
 Flag denoting whether impedance data were entered in symmetrical components.
 
DSS_CAPI_DLL int32_t LineCodes_Get_Units (void)
 
DSS_CAPI_DLL void LineCodes_Set_Units (int32_t Value)
 
DSS_CAPI_DLL int32_t LineCodes_Get_Phases (void)
 Number of Phases.
 
DSS_CAPI_DLL void LineCodes_Set_Phases (int32_t Value)
 Number of Phases.
 
DSS_CAPI_DLL double LineCodes_Get_R1 (void)
 Positive-sequence resistance ohms per unit length.
 
DSS_CAPI_DLL void LineCodes_Set_R1 (double Value)
 
DSS_CAPI_DLL double LineCodes_Get_X1 (void)
 Posiive-sequence reactance, ohms per unit length.
 
DSS_CAPI_DLL void LineCodes_Set_X1 (double Value)
 
DSS_CAPI_DLL double LineCodes_Get_R0 (void)
 Zero-Sequence Resistance, ohms per unit length.
 
DSS_CAPI_DLL double LineCodes_Get_X0 (void)
 Zero Sequence Reactance, Ohms per unit length.
 
DSS_CAPI_DLL void LineCodes_Set_R0 (double Value)
 
DSS_CAPI_DLL void LineCodes_Set_X0 (double Value)
 
DSS_CAPI_DLL double LineCodes_Get_C0 (void)
 Zero-sequence capacitance, nF per unit length.
 
DSS_CAPI_DLL double LineCodes_Get_C1 (void)
 Positive-sequence capacitance, nF per unit length.
 
DSS_CAPI_DLL void LineCodes_Set_C0 (double Value)
 
DSS_CAPI_DLL void LineCodes_Set_C1 (double Value)
 
DSS_CAPI_DLL void LineCodes_Get_Cmatrix (double **ResultPtr, int32_t *ResultCount)
 Capacitance matrix, nF per unit length.
 
DSS_CAPI_DLL void LineCodes_Get_Cmatrix_GR (void)
 Same as LineCodes_Get_Cmatrix but using the global buffer interface for results.
 
DSS_CAPI_DLL void LineCodes_Get_Rmatrix (double **ResultPtr, int32_t *ResultCount)
 Resistance matrix, ohms per unit length.
 
DSS_CAPI_DLL void LineCodes_Get_Rmatrix_GR (void)
 Same as LineCodes_Get_Rmatrix but using the global buffer interface for results.
 
DSS_CAPI_DLL void LineCodes_Get_Xmatrix (double **ResultPtr, int32_t *ResultCount)
 Reactance matrix, ohms per unit length.
 
DSS_CAPI_DLL void LineCodes_Get_Xmatrix_GR (void)
 Same as LineCodes_Get_Xmatrix but using the global buffer interface for results.
 
DSS_CAPI_DLL void LineCodes_Set_Cmatrix (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL void LineCodes_Set_Rmatrix (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL void LineCodes_Set_Xmatrix (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL double LineCodes_Get_NormAmps (void)
 Normal Ampere rating.
 
DSS_CAPI_DLL void LineCodes_Set_NormAmps (double Value)
 
DSS_CAPI_DLL double LineCodes_Get_EmergAmps (void)
 Emergency ampere rating.
 
DSS_CAPI_DLL void LineCodes_Set_EmergAmps (double Value)
 
DSS_CAPI_DLL void LineCodes_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings with names of all devices.
 
DSS_CAPI_DLL void LineCodes_Get_AllNames_GR (void)
 Same as LineCodes_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL void Lines_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Names of all Line Objects.
 
DSS_CAPI_DLL void Lines_Get_AllNames_GR (void)
 Same as Lines_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL char * Lines_Get_Bus1 (void)
 Name of bus for terminal 1.
 
DSS_CAPI_DLL char * Lines_Get_Bus2 (void)
 Name of bus for terminal 2.
 
DSS_CAPI_DLL int32_t Lines_Get_First (void)
 Invoking this property sets the first element active. More...
 
DSS_CAPI_DLL double Lines_Get_Length (void)
 Length of line section in units compatible with the LineCode definition.
 
DSS_CAPI_DLL char * Lines_Get_LineCode (void)
 Name of LineCode object that defines the impedances.
 
DSS_CAPI_DLL char * Lines_Get_Name (void)
 Specify the name of the Line element to set it active.
 
DSS_CAPI_DLL int32_t Lines_Get_Next (void)
 Invoking this property advances to the next Line element active. More...
 
DSS_CAPI_DLL int32_t Lines_Get_Phases (void)
 Number of Phases, this Line element.
 
DSS_CAPI_DLL double Lines_Get_R1 (void)
 Positive Sequence resistance, ohms per unit length.
 
DSS_CAPI_DLL double Lines_Get_X1 (void)
 Positive Sequence reactance, ohms per unit length.
 
DSS_CAPI_DLL int32_t Lines_New (const char *Name)
 
DSS_CAPI_DLL void Lines_Set_Bus1 (const char *Value)
 Name of bus for terminal 1.
 
DSS_CAPI_DLL void Lines_Set_Bus2 (const char *Value)
 Name of bus for terminal 2.
 
DSS_CAPI_DLL void Lines_Set_Length (double Value)
 Length of line section in units compatible with the LineCode definition.
 
DSS_CAPI_DLL void Lines_Set_LineCode (const char *Value)
 Name of LineCode object that defines the impedances.
 
DSS_CAPI_DLL void Lines_Set_Name (const char *Value)
 Specify the name of the Line element to set it active.
 
DSS_CAPI_DLL void Lines_Set_Phases (int32_t Value)
 Number of Phases, this Line element.
 
DSS_CAPI_DLL void Lines_Set_R1 (double Value)
 Positive Sequence resistance, ohms per unit length.
 
DSS_CAPI_DLL void Lines_Set_X1 (double Value)
 Positive Sequence reactance, ohms per unit length.
 
DSS_CAPI_DLL double Lines_Get_C0 (void)
 Zero Sequence capacitance, nanofarads per unit length.
 
DSS_CAPI_DLL double Lines_Get_C1 (void)
 Positive Sequence capacitance, nanofarads per unit length.
 
DSS_CAPI_DLL void Lines_Get_Cmatrix (double **ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void Lines_Get_Cmatrix_GR (void)
 Same as Lines_Get_Cmatrix but using the global buffer interface for results.
 
DSS_CAPI_DLL double Lines_Get_R0 (void)
 Zero Sequence resistance, ohms per unit length.
 
DSS_CAPI_DLL void Lines_Get_Rmatrix (double **ResultPtr, int32_t *ResultCount)
 Resistance matrix (full), ohms per unit length. More...
 
DSS_CAPI_DLL void Lines_Get_Rmatrix_GR (void)
 Same as Lines_Get_Rmatrix but using the global buffer interface for results.
 
DSS_CAPI_DLL double Lines_Get_X0 (void)
 Zero Sequence reactance ohms per unit length.
 
DSS_CAPI_DLL void Lines_Get_Xmatrix (double **ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void Lines_Get_Xmatrix_GR (void)
 Same as Lines_Get_Xmatrix but using the global buffer interface for results.
 
DSS_CAPI_DLL void Lines_Set_C0 (double Value)
 Zero Sequence capacitance, nanofarads per unit length.
 
DSS_CAPI_DLL void Lines_Set_C1 (double Value)
 Positive Sequence capacitance, nanofarads per unit length.
 
DSS_CAPI_DLL void Lines_Set_Cmatrix (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL void Lines_Set_R0 (double Value)
 Zero Sequence resistance, ohms per unit length.
 
DSS_CAPI_DLL void Lines_Set_Rmatrix (double *ValuePtr, int32_t ValueCount)
 Resistance matrix (full), ohms per unit length. More...
 
DSS_CAPI_DLL void Lines_Set_X0 (double Value)
 Zero Sequence reactance ohms per unit length.
 
DSS_CAPI_DLL void Lines_Set_Xmatrix (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL double Lines_Get_EmergAmps (void)
 Emergency (maximum) ampere rating of Line.
 
DSS_CAPI_DLL double Lines_Get_NormAmps (void)
 Normal ampere rating of Line.
 
DSS_CAPI_DLL void Lines_Set_EmergAmps (double Value)
 Emergency (maximum) ampere rating of Line.
 
DSS_CAPI_DLL void Lines_Set_NormAmps (double Value)
 Normal ampere rating of Line.
 
DSS_CAPI_DLL char * Lines_Get_Geometry (void)
 Line geometry code.
 
DSS_CAPI_DLL void Lines_Set_Geometry (const char *Value)
 Line geometry code.
 
DSS_CAPI_DLL double Lines_Get_Rg (void)
 Earth return resistance value used to compute line impedances at power frequency.
 
DSS_CAPI_DLL double Lines_Get_Rho (void)
 Earth Resistivity, m-ohms.
 
DSS_CAPI_DLL double Lines_Get_Xg (void)
 Earth return reactance value used to compute line impedances at power frequency.
 
DSS_CAPI_DLL void Lines_Set_Rg (double Value)
 Earth return resistance value used to compute line impedances at power frequency.
 
DSS_CAPI_DLL void Lines_Set_Rho (double Value)
 Earth Resistivity, m-ohms.
 
DSS_CAPI_DLL void Lines_Set_Xg (double Value)
 Earth return reactance value used to compute line impedances at power frequency.
 
DSS_CAPI_DLL void Lines_Get_Yprim (double **ResultPtr, int32_t *ResultCount)
 Yprimitive: Does Nothing at present on Put; Dangerous.
 
DSS_CAPI_DLL void Lines_Get_Yprim_GR (void)
 Same as Lines_Get_Yprim but using the global buffer interface for results.
 
DSS_CAPI_DLL void Lines_Set_Yprim (double *ValuePtr, int32_t ValueCount)
 Yprimitive: Does Nothing at present on Put; Dangerous.
 
DSS_CAPI_DLL int32_t Lines_Get_NumCust (void)
 Number of customers on this line section.
 
DSS_CAPI_DLL int32_t Lines_Get_TotalCust (void)
 Total Number of customers served from this line section.
 
DSS_CAPI_DLL int32_t Lines_Get_Parent (void)
 Sets Parent of the active Line to be the active line. More...
 
DSS_CAPI_DLL int32_t Lines_Get_Count (void)
 Number of Line objects in Active Circuit.
 
DSS_CAPI_DLL char * Lines_Get_Spacing (void)
 Line spacing code.
 
DSS_CAPI_DLL void Lines_Set_Spacing (const char *Value)
 Line spacing code.
 
DSS_CAPI_DLL int32_t Lines_Get_Units (void)
 
DSS_CAPI_DLL void Lines_Set_Units (int32_t Value)
 
DSS_CAPI_DLL double Lines_Get_SeasonRating (void)
 Delivers the rating for the current season (in Amps) if the "SeasonalRatings" option is active.
 
DSS_CAPI_DLL uint16_t Lines_Get_IsSwitch (void)
 Sets/gets the Line element switch status. More...
 
DSS_CAPI_DLL void Lines_Set_IsSwitch (uint16_t Value)
 
DSS_CAPI_DLL void Loads_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings containing all Load names.
 
DSS_CAPI_DLL void Loads_Get_AllNames_GR (void)
 Same as Loads_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Loads_Get_First (void)
 Set first Load element to be active; returns 0 if none.
 
DSS_CAPI_DLL int32_t Loads_Get_idx (void)
 
DSS_CAPI_DLL char * Loads_Get_Name (void)
 Set active load by name.
 
DSS_CAPI_DLL int32_t Loads_Get_Next (void)
 Sets next Load element to be active; returns 0 of none else index of active load.
 
DSS_CAPI_DLL void Loads_Set_idx (int32_t Value)
 
DSS_CAPI_DLL void Loads_Set_Name (const char *Value)
 Set active load by name.
 
DSS_CAPI_DLL double Loads_Get_kV (void)
 Set kV rating for active Load. More...
 
DSS_CAPI_DLL double Loads_Get_kvar (void)
 Set kvar for active Load. More...
 
DSS_CAPI_DLL double Loads_Get_kW (void)
 Set kW for active Load. More...
 
DSS_CAPI_DLL double Loads_Get_PF (void)
 Set Power Factor for Active Load. More...
 
DSS_CAPI_DLL void Loads_Set_kV (double Value)
 Set kV rating for active Load. More...
 
DSS_CAPI_DLL void Loads_Set_kvar (double Value)
 Set kvar for active Load. More...
 
DSS_CAPI_DLL void Loads_Set_kW (double Value)
 Set kW for active Load. More...
 
DSS_CAPI_DLL void Loads_Set_PF (double Value)
 Set Power Factor for Active Load. More...
 
DSS_CAPI_DLL int32_t Loads_Get_Count (void)
 Number of Load objects in active circuit.
 
DSS_CAPI_DLL double Loads_Get_AllocationFactor (void)
 Factor for allocating loads by connected xfkva.
 
DSS_CAPI_DLL double Loads_Get_Cfactor (void)
 Factor relates average to peak kw. More...
 
DSS_CAPI_DLL int32_t Loads_Get_Class_ (void)
 
DSS_CAPI_DLL char * Loads_Get_CVRcurve (void)
 Name of a loadshape with both Mult and Qmult, for CVR factors as a function of time.
 
DSS_CAPI_DLL double Loads_Get_CVRvars (void)
 Percent reduction in Q for percent reduction in V. More...
 
DSS_CAPI_DLL double Loads_Get_CVRwatts (void)
 Percent reduction in P for percent reduction in V. More...
 
DSS_CAPI_DLL char * Loads_Get_daily (void)
 Name of the loadshape for a daily load profile.
 
DSS_CAPI_DLL char * Loads_Get_duty (void)
 Name of the loadshape for a duty cycle simulation.
 
DSS_CAPI_DLL char * Loads_Get_Growth (void)
 Name of the growthshape curve for yearly load growth factors.
 
DSS_CAPI_DLL uint16_t Loads_Get_IsDelta (void)
 Delta loads are connected line-to-line.
 
DSS_CAPI_DLL double Loads_Get_kva (void)
 Base load kva. More...
 
DSS_CAPI_DLL double Loads_Get_kwh (void)
 kwh billed for this period. More...
 
DSS_CAPI_DLL double Loads_Get_kwhdays (void)
 Length of kwh billing period for average demand calculation. More...
 
DSS_CAPI_DLL int32_t Loads_Get_Model (void)
 The Load Model defines variation of P and Q with voltage.
 
DSS_CAPI_DLL int32_t Loads_Get_NumCust (void)
 Number of customers in this load, defaults to one.
 
DSS_CAPI_DLL double Loads_Get_PctMean (void)
 Average percent of nominal load in Monte Carlo studies; only if no loadshape defined for this load.
 
DSS_CAPI_DLL double Loads_Get_PctStdDev (void)
 Percent standard deviation for Monte Carlo load studies; if there is no loadshape assigned to this load.
 
DSS_CAPI_DLL double Loads_Get_Rneut (void)
 Neutral resistance for wye-connected loads.
 
DSS_CAPI_DLL char * Loads_Get_Spectrum (void)
 Name of harmonic current spectrrum shape.
 
DSS_CAPI_DLL int32_t Loads_Get_Status (void)
 Response to load multipliers: Fixed (growth only), Exempt (no LD curve), Variable (all).
 
DSS_CAPI_DLL double Loads_Get_Vmaxpu (void)
 Maximum per-unit voltage to use the load model. More...
 
DSS_CAPI_DLL double Loads_Get_Vminemerg (void)
 Minimum voltage for unserved energy (UE) evaluation.
 
DSS_CAPI_DLL double Loads_Get_Vminnorm (void)
 Minimum voltage for energy exceeding normal (EEN) evaluations.
 
DSS_CAPI_DLL double Loads_Get_Vminpu (void)
 Minimum voltage to apply the load model. More...
 
DSS_CAPI_DLL double Loads_Get_xfkVA (void)
 Rated service transformer kVA for load allocation, using AllocationFactor. More...
 
DSS_CAPI_DLL double Loads_Get_Xneut (void)
 Neutral reactance for wye-connected loads.
 
DSS_CAPI_DLL char * Loads_Get_Yearly (void)
 Name of yearly duration loadshape.
 
DSS_CAPI_DLL void Loads_Set_AllocationFactor (double Value)
 
DSS_CAPI_DLL void Loads_Set_Cfactor (double Value)
 
DSS_CAPI_DLL void Loads_Set_Class_ (int32_t Value)
 
DSS_CAPI_DLL void Loads_Set_CVRcurve (const char *Value)
 
DSS_CAPI_DLL void Loads_Set_CVRvars (double Value)
 
DSS_CAPI_DLL void Loads_Set_CVRwatts (double Value)
 
DSS_CAPI_DLL void Loads_Set_daily (const char *Value)
 
DSS_CAPI_DLL void Loads_Set_duty (const char *Value)
 
DSS_CAPI_DLL void Loads_Set_Growth (const char *Value)
 
DSS_CAPI_DLL void Loads_Set_IsDelta (uint16_t Value)
 
DSS_CAPI_DLL void Loads_Set_kva (double Value)
 
DSS_CAPI_DLL void Loads_Set_kwh (double Value)
 
DSS_CAPI_DLL void Loads_Set_kwhdays (double Value)
 
DSS_CAPI_DLL void Loads_Set_Model (int32_t Value)
 
DSS_CAPI_DLL void Loads_Set_NumCust (int32_t Value)
 
DSS_CAPI_DLL void Loads_Set_PctMean (double Value)
 
DSS_CAPI_DLL void Loads_Set_PctStdDev (double Value)
 
DSS_CAPI_DLL void Loads_Set_Rneut (double Value)
 
DSS_CAPI_DLL void Loads_Set_Spectrum (const char *Value)
 
DSS_CAPI_DLL void Loads_Set_Status (int32_t Value)
 
DSS_CAPI_DLL void Loads_Set_Vmaxpu (double Value)
 
DSS_CAPI_DLL void Loads_Set_Vminemerg (double Value)
 
DSS_CAPI_DLL void Loads_Set_Vminnorm (double Value)
 
DSS_CAPI_DLL void Loads_Set_Vminpu (double Value)
 
DSS_CAPI_DLL void Loads_Set_xfkVA (double Value)
 
DSS_CAPI_DLL void Loads_Set_Xneut (double Value)
 
DSS_CAPI_DLL void Loads_Set_Yearly (const char *Value)
 
DSS_CAPI_DLL void Loads_Get_ZIPV (double **ResultPtr, int32_t *ResultCount)
 Array of 7 doubles with values for ZIPV property of the LOAD object.
 
DSS_CAPI_DLL void Loads_Get_ZIPV_GR (void)
 Same as Loads_Get_ZIPV but using the global buffer interface for results.
 
DSS_CAPI_DLL void Loads_Set_ZIPV (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL double Loads_Get_pctSeriesRL (void)
 
DSS_CAPI_DLL void Loads_Set_pctSeriesRL (double Value)
 Percent of Load that is modeled as series R-L for harmonics studies.
 
DSS_CAPI_DLL double Loads_Get_RelWeight (void)
 Relative Weighting factor for the active LOAD.
 
DSS_CAPI_DLL void Loads_Set_RelWeight (double Value)
 Relative Weighting factor for the active LOAD.
 
DSS_CAPI_DLL char * Loads_Get_Sensor (void)
 Name of the sensor monitoring this load.
 
DSS_CAPI_DLL char * LoadShapes_Get_Name (void)
 Get the Name of the active Loadshape.
 
DSS_CAPI_DLL void LoadShapes_Set_Name (const char *Value)
 Set the active Loadshape by name.
 
DSS_CAPI_DLL int32_t LoadShapes_Get_Count (void)
 Number of Loadshape objects currently defined in Loadshape collection.
 
DSS_CAPI_DLL int32_t LoadShapes_Get_First (void)
 Set the first loadshape active and return integer index of the loadshape. More...
 
DSS_CAPI_DLL int32_t LoadShapes_Get_Next (void)
 Advance active Loadshape to the next on in the collection. More...
 
DSS_CAPI_DLL void LoadShapes_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings containing names of all Loadshape objects currently defined.
 
DSS_CAPI_DLL void LoadShapes_Get_AllNames_GR (void)
 Same as LoadShapes_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t LoadShapes_Get_Npts (void)
 Get Number of points in active Loadshape.
 
DSS_CAPI_DLL void LoadShapes_Get_Pmult (double **ResultPtr, int32_t *ResultCount)
 Array of Doubles for the P multiplier in the Loadshape.
 
DSS_CAPI_DLL void LoadShapes_Get_Pmult_GR (void)
 Same as LoadShapes_Get_Pmult but using the global buffer interface for results.
 
DSS_CAPI_DLL void LoadShapes_Get_Qmult (double **ResultPtr, int32_t *ResultCount)
 Array of doubles containing the Q multipliers.
 
DSS_CAPI_DLL void LoadShapes_Get_Qmult_GR (void)
 Same as LoadShapes_Get_Qmult but using the global buffer interface for results.
 
DSS_CAPI_DLL void LoadShapes_Set_Npts (int32_t Value)
 Set number of points to allocate for active Loadshape.
 
DSS_CAPI_DLL void LoadShapes_Set_Pmult (double *ValuePtr, int32_t ValueCount)
 Array of doubles containing the P array for the Loadshape.
 
DSS_CAPI_DLL void LoadShapes_Set_Qmult (double *ValuePtr, int32_t ValueCount)
 Array of doubles containing the Q multipliers.
 
DSS_CAPI_DLL void LoadShapes_Normalize (void)
 
DSS_CAPI_DLL void LoadShapes_Get_TimeArray (double **ResultPtr, int32_t *ResultCount)
 Time array in hours correscponding to P and Q multipliers when the Interval=0.
 
DSS_CAPI_DLL void LoadShapes_Get_TimeArray_GR (void)
 Same as LoadShapes_Get_TimeArray but using the global buffer interface for results.
 
DSS_CAPI_DLL void LoadShapes_Set_TimeArray (double *ValuePtr, int32_t ValueCount)
 Time array in hours correscponding to P and Q multipliers when the Interval=0.
 
DSS_CAPI_DLL double LoadShapes_Get_HrInterval (void)
 Fixed interval time value, hours.
 
DSS_CAPI_DLL double LoadShapes_Get_MinInterval (void)
 Fixed Interval time value, in minutes.
 
DSS_CAPI_DLL double LoadShapes_Get_SInterval (void)
 Fixed interval data time interval, seconds.
 
DSS_CAPI_DLL void LoadShapes_Set_SInterval (double Value)
 Fixed interval data time interval, seconds.
 
DSS_CAPI_DLL void LoadShapes_Set_HrInterval (double Value)
 Fixed interval time value, hours.
 
DSS_CAPI_DLL void LoadShapes_Set_MinInterval (double Value)
 Fixed Interval time value, in minutes.
 
DSS_CAPI_DLL int32_t LoadShapes_New (const char *Name)
 
DSS_CAPI_DLL double LoadShapes_Get_PBase (void)
 
DSS_CAPI_DLL double LoadShapes_Get_Qbase (void)
 Base for normalizing Q curve. More...
 
DSS_CAPI_DLL void LoadShapes_Set_PBase (double Value)
 
DSS_CAPI_DLL void LoadShapes_Set_Qbase (double Value)
 Base for normalizing Q curve. More...
 
DSS_CAPI_DLL uint16_t LoadShapes_Get_UseActual (void)
 T/F flag to let Loads know to use the actual value in the curve rather than use the value as a multiplier.
 
DSS_CAPI_DLL void LoadShapes_Set_UseActual (uint16_t Value)
 T/F flag to let Loads know to use the actual value in the curve rather than use the value as a multiplier.
 
DSS_CAPI_DLL void Meters_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of all energy Meter names.
 
DSS_CAPI_DLL void Meters_Get_AllNames_GR (void)
 Same as Meters_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Meters_Get_First (void)
 Set the first energy Meter active. More...
 
DSS_CAPI_DLL char * Meters_Get_Name (void)
 Get/Set the active meter name.
 
DSS_CAPI_DLL int32_t Meters_Get_Next (void)
 Sets the next energy Meter active. More...
 
DSS_CAPI_DLL void Meters_Get_RegisterNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings containing the names of the registers.
 
DSS_CAPI_DLL void Meters_Get_RegisterNames_GR (void)
 Same as Meters_Get_RegisterNames but using the global buffer interface for results.
 
DSS_CAPI_DLL void Meters_Get_RegisterValues (double **ResultPtr, int32_t *ResultCount)
 Array of all the values contained in the Meter registers for the active Meter.
 
DSS_CAPI_DLL void Meters_Get_RegisterValues_GR (void)
 Same as Meters_Get_RegisterValues but using the global buffer interface for results.
 
DSS_CAPI_DLL void Meters_Reset (void)
 
DSS_CAPI_DLL void Meters_ResetAll (void)
 
DSS_CAPI_DLL void Meters_Sample (void)
 
DSS_CAPI_DLL void Meters_Save (void)
 
DSS_CAPI_DLL void Meters_Set_Name (const char *Value)
 Set a meter to be active by name.
 
DSS_CAPI_DLL void Meters_Get_Totals (double **ResultPtr, int32_t *ResultCount)
 Totals of all registers of all meters.
 
DSS_CAPI_DLL void Meters_Get_Totals_GR (void)
 Same as Meters_Get_Totals but using the global buffer interface for results.
 
DSS_CAPI_DLL void Meters_Get_Peakcurrent (double **ResultPtr, int32_t *ResultCount)
 Array of doubles to set values of Peak Current property.
 
DSS_CAPI_DLL void Meters_Get_Peakcurrent_GR (void)
 Same as Meters_Get_Peakcurrent but using the global buffer interface for results.
 
DSS_CAPI_DLL void Meters_Set_Peakcurrent (double *ValuePtr, int32_t ValueCount)
 Array of doubles to set values of Peak Current property.
 
DSS_CAPI_DLL void Meters_Get_CalcCurrent (double **ResultPtr, int32_t *ResultCount)
 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.
 
DSS_CAPI_DLL void Meters_Get_CalcCurrent_GR (void)
 Same as Meters_Get_CalcCurrent but using the global buffer interface for results.
 
DSS_CAPI_DLL void Meters_Set_CalcCurrent (double *ValuePtr, int32_t ValueCount)
 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.
 
DSS_CAPI_DLL void Meters_Get_AllocFactors (double **ResultPtr, int32_t *ResultCount)
 Array of doubles: set the phase allocation factors for the active meter.
 
DSS_CAPI_DLL void Meters_Get_AllocFactors_GR (void)
 Same as Meters_Get_AllocFactors but using the global buffer interface for results.
 
DSS_CAPI_DLL void Meters_Set_AllocFactors (double *ValuePtr, int32_t ValueCount)
 Array of doubles: set the phase allocation factors for the active meter.
 
DSS_CAPI_DLL char * Meters_Get_MeteredElement (void)
 Set Name of metered element.
 
DSS_CAPI_DLL int32_t Meters_Get_MeteredTerminal (void)
 set Number of Metered Terminal
 
DSS_CAPI_DLL void Meters_Set_MeteredElement (const char *Value)
 Set Name of metered element.
 
DSS_CAPI_DLL void Meters_Set_MeteredTerminal (int32_t Value)
 set Number of Metered Terminal
 
DSS_CAPI_DLL uint16_t Meters_Get_DIFilesAreOpen (void)
 Global Flag in the DSS to indicate if Demand Interval (DI) files have been properly opened.
 
DSS_CAPI_DLL void Meters_CloseAllDIFiles (void)
 
DSS_CAPI_DLL void Meters_OpenAllDIFiles (void)
 
DSS_CAPI_DLL void Meters_SampleAll (void)
 
DSS_CAPI_DLL void Meters_SaveAll (void)
 
DSS_CAPI_DLL void Meters_Get_AllEndElements (char ***ResultPtr, int32_t *ResultCount)
 Array of names of all zone end elements.
 
DSS_CAPI_DLL void Meters_Get_AllEndElements_GR (void)
 Same as Meters_Get_AllEndElements but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Meters_Get_CountEndElements (void)
 Number of zone end elements in the active meter zone.
 
DSS_CAPI_DLL int32_t Meters_Get_Count (void)
 Number of Energy Meters in the Active Circuit.
 
DSS_CAPI_DLL void Meters_Get_AllBranchesInZone (char ***ResultPtr, int32_t *ResultCount)
 Wide string list of all branches in zone of the active energymeter object.
 
DSS_CAPI_DLL void Meters_Get_AllBranchesInZone_GR (void)
 Same as Meters_Get_AllBranchesInZone but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Meters_Get_CountBranches (void)
 Number of branches in Active energymeter zone. More...
 
DSS_CAPI_DLL double Meters_Get_SAIFI (void)
 Returns SAIFI for this meter's Zone. More...
 
DSS_CAPI_DLL int32_t Meters_Get_SequenceIndex (void)
 Get/set Index into Meter's SequenceList that contains branch pointers in lexical order. More...
 
DSS_CAPI_DLL void Meters_Set_SequenceIndex (int32_t Value)
 Get/set Index into Meter's SequenceList that contains branch pointers in lexical order. More...
 
DSS_CAPI_DLL double Meters_Get_SAIFIKW (void)
 SAIFI based on kW rather than number of customers. More...
 
DSS_CAPI_DLL void Meters_DoReliabilityCalc (uint16_t AssumeRestoration)
 
DSS_CAPI_DLL int32_t Meters_Get_SeqListSize (void)
 Size of Sequence List.
 
DSS_CAPI_DLL int32_t Meters_Get_TotalCustomers (void)
 Total Number of customers in this zone (downline from the EnergyMeter)
 
DSS_CAPI_DLL double Meters_Get_SAIDI (void)
 SAIDI for this meter's zone. More...
 
DSS_CAPI_DLL double Meters_Get_CustInterrupts (void)
 Total customer interruptions for this Meter zone based on reliability calcs.
 
DSS_CAPI_DLL int32_t Meters_Get_NumSections (void)
 Number of feeder sections in this meter's zone.
 
DSS_CAPI_DLL void Meters_SetActiveSection (int32_t SectIdx)
 
DSS_CAPI_DLL double Meters_Get_AvgRepairTime (void)
 Average Repair time in this section of the meter zone.
 
DSS_CAPI_DLL double Meters_Get_FaultRateXRepairHrs (void)
 Sum of Fault Rate time Repair Hrs in this section of the meter zone.
 
DSS_CAPI_DLL int32_t Meters_Get_NumSectionBranches (void)
 Number of branches (lines) in this section.
 
DSS_CAPI_DLL int32_t Meters_Get_NumSectionCustomers (void)
 Number of Customers in the active section.
 
DSS_CAPI_DLL int32_t Meters_Get_OCPDeviceType (void)
 Type of OCP device. More...
 
DSS_CAPI_DLL double Meters_Get_SumBranchFltRates (void)
 Sum of the branch fault rates in this section of the meter's zone.
 
DSS_CAPI_DLL int32_t Meters_Get_SectSeqIdx (void)
 SequenceIndex of the branch at the head of this section.
 
DSS_CAPI_DLL int32_t Meters_Get_SectTotalCust (void)
 Total Customers downline from this section.
 
DSS_CAPI_DLL void Meters_Get_ZonePCE (char ***ResultPtr, int32_t *ResultCount)
 Returns the list of all PCE within the area covered by the energy meter.
 
DSS_CAPI_DLL void Monitors_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of all Monitor Names.
 
DSS_CAPI_DLL void Monitors_Get_AllNames_GR (void)
 Same as Monitors_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL char * Monitors_Get_FileName (void)
 Name of CSV file associated with active Monitor.
 
DSS_CAPI_DLL int32_t Monitors_Get_First (void)
 Sets the first Monitor active. More...
 
DSS_CAPI_DLL int32_t Monitors_Get_Mode (void)
 Set Monitor mode (bitmask integer - see DSS Help)
 
DSS_CAPI_DLL char * Monitors_Get_Name (void)
 Sets the active Monitor object by name.
 
DSS_CAPI_DLL int32_t Monitors_Get_Next (void)
 Sets next monitor active. More...
 
DSS_CAPI_DLL void Monitors_Reset (void)
 
DSS_CAPI_DLL void Monitors_ResetAll (void)
 
DSS_CAPI_DLL void Monitors_Sample (void)
 
DSS_CAPI_DLL void Monitors_Save (void)
 
DSS_CAPI_DLL void Monitors_Set_Mode (int32_t Value)
 Set Monitor mode (bitmask integer - see DSS Help)
 
DSS_CAPI_DLL void Monitors_Show (void)
 
DSS_CAPI_DLL void Monitors_Set_Name (const char *Value)
 Sets the active Monitor object by name.
 
DSS_CAPI_DLL void Monitors_Get_ByteStream (int8_t **ResultPtr, int32_t *ResultCount)
 Byte Array containing monitor stream values. More...
 
DSS_CAPI_DLL void Monitors_Get_ByteStream_GR (void)
 Same as Monitors_Get_ByteStream but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Monitors_Get_SampleCount (void)
 Number of Samples in Monitor at Present.
 
DSS_CAPI_DLL void Monitors_SampleAll (void)
 
DSS_CAPI_DLL void Monitors_SaveAll (void)
 
DSS_CAPI_DLL int32_t Monitors_Get_Count (void)
 Number of Monitors.
 
DSS_CAPI_DLL void Monitors_Process (void)
 
DSS_CAPI_DLL void Monitors_ProcessAll (void)
 
DSS_CAPI_DLL void Monitors_Get_Channel (double **ResultPtr, int32_t *ResultCount, int32_t Index)
 Array of doubles for the specified channel (usage: MyArray = DSSMonitor.Channel(i)) A Save or SaveAll should be executed first. More...
 
DSS_CAPI_DLL void Monitors_Get_Channel_GR (int32_t Index)
 Same as Monitors_Get_Channel but using the global buffer interface for results.
 
DSS_CAPI_DLL void Monitors_Get_dblFreq (double **ResultPtr, int32_t *ResultCount)
 Array of doubles containing frequency values for harmonics mode solutions; Empty for time mode solutions (use dblHour)
 
DSS_CAPI_DLL void Monitors_Get_dblFreq_GR (void)
 Same as Monitors_Get_dblFreq but using the global buffer interface for results.
 
DSS_CAPI_DLL void Monitors_Get_dblHour (double **ResultPtr, int32_t *ResultCount)
 Array of doubles containgin time value in hours for time-sampled monitor values; Empty if frequency-sampled values for harmonics solution (see dblFreq)
 
DSS_CAPI_DLL void Monitors_Get_dblHour_GR (void)
 Same as Monitors_Get_dblHour but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Monitors_Get_FileVersion (void)
 Monitor File Version (integer)
 
DSS_CAPI_DLL void Monitors_Get_Header (char ***ResultPtr, int32_t *ResultCount)
 Header string; Array of strings containing Channel names.
 
DSS_CAPI_DLL void Monitors_Get_Header_GR (void)
 Same as Monitors_Get_Header but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Monitors_Get_NumChannels (void)
 Number of Channels in the active Monitor.
 
DSS_CAPI_DLL int32_t Monitors_Get_RecordSize (void)
 Size of each record in ByteStream (Integer). More...
 
DSS_CAPI_DLL char * Monitors_Get_Element (void)
 Full object name of element being monitored.
 
DSS_CAPI_DLL void Monitors_Set_Element (const char *Value)
 Full object name of element being monitored.
 
DSS_CAPI_DLL int32_t Monitors_Get_Terminal (void)
 Terminal number of element being monitored.
 
DSS_CAPI_DLL void Monitors_Set_Terminal (int32_t Value)
 Terminal number of element being monitored.
 
DSS_CAPI_DLL int32_t Parallel_Get_NumCPUs (void)
 Delivers the number of CPUs on the current PC.
 
DSS_CAPI_DLL int32_t Parallel_Get_NumCores (void)
 Delivers the number of Cores of the local PC.
 
DSS_CAPI_DLL int32_t Parallel_Get_ActiveActor (void)
 Gets the ID of the Active Actor.
 
DSS_CAPI_DLL void Parallel_Set_ActiveActor (int32_t Value)
 Sets the Active Actor.
 
DSS_CAPI_DLL void Parallel_CreateActor (void)
 
DSS_CAPI_DLL int32_t Parallel_Get_ActorCPU (void)
 Gets the CPU of the Active Actor.
 
DSS_CAPI_DLL void Parallel_Set_ActorCPU (int32_t Value)
 Sets the CPU for the Active Actor.
 
DSS_CAPI_DLL int32_t Parallel_Get_NumOfActors (void)
 Gets the number of Actors created.
 
DSS_CAPI_DLL void Parallel_Wait (void)
 
DSS_CAPI_DLL void Parallel_Get_ActorProgress (int32_t **ResultPtr, int32_t *ResultCount)
 Gets the progress of all existing actors in pct.
 
DSS_CAPI_DLL void Parallel_Get_ActorProgress_GR (void)
 Same as Parallel_Get_ActorProgress but using the global buffer interface for results.
 
DSS_CAPI_DLL void Parallel_Get_ActorStatus (int32_t **ResultPtr, int32_t *ResultCount)
 Gets the status of each actor.
 
DSS_CAPI_DLL void Parallel_Get_ActorStatus_GR (void)
 Same as Parallel_Get_ActorStatus but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Parallel_Get_ActiveParallel (void)
 Sets ON/OFF (1/0) Parallel features of the Engine.
 
DSS_CAPI_DLL void Parallel_Set_ActiveParallel (int32_t Value)
 Delivers if the Parallel features of the Engine are Active.
 
DSS_CAPI_DLL int32_t Parallel_Get_ConcatenateReports (void)
 Reads the values of the ConcatenateReports option (1=enabled, 0=disabled)
 
DSS_CAPI_DLL void Parallel_Set_ConcatenateReports (int32_t Value)
 Enable/Disable (1/0) the ConcatenateReports option for extracting monitors data.
 
DSS_CAPI_DLL char * Parser_Get_CmdString (void)
 String to be parsed. More...
 
DSS_CAPI_DLL void Parser_Set_CmdString (const char *Value)
 String to be parsed. More...
 
DSS_CAPI_DLL char * Parser_Get_NextParam (void)
 Get next token and return tag name (before = sign) if any. More...
 
DSS_CAPI_DLL uint16_t Parser_Get_AutoIncrement (void)
 Default is FALSE. More...
 
DSS_CAPI_DLL void Parser_Set_AutoIncrement (uint16_t Value)
 Default is FALSE. More...
 
DSS_CAPI_DLL double Parser_Get_DblValue (void)
 Return next parameter as a double.
 
DSS_CAPI_DLL int32_t Parser_Get_IntValue (void)
 Return next parameter as a long integer.
 
DSS_CAPI_DLL char * Parser_Get_StrValue (void)
 Return next parameter as a string.
 
DSS_CAPI_DLL char * Parser_Get_WhiteSpace (void)
 Get the characters used for White space in the command string. More...
 
DSS_CAPI_DLL void Parser_Set_WhiteSpace (const char *Value)
 Set the characters used for White space in the command string. More...
 
DSS_CAPI_DLL char * Parser_Get_BeginQuote (void)
 Get String containing the the characters for Quoting in OpenDSS scripts. More...
 
DSS_CAPI_DLL char * Parser_Get_EndQuote (void)
 String containing characters, in order, that match the beginning quote characters in BeginQuote. More...
 
DSS_CAPI_DLL void Parser_Set_BeginQuote (const char *Value)
 Set String containing the the characters for Quoting in OpenDSS scripts. More...
 
DSS_CAPI_DLL void Parser_Set_EndQuote (const char *Value)
 String containing characters, in order, that match the beginning quote characters in BeginQuote. More...
 
DSS_CAPI_DLL char * Parser_Get_Delimiters (void)
 String defining hard delimiters used to separate token on the command string. More...
 
DSS_CAPI_DLL void Parser_Set_Delimiters (const char *Value)
 String defining hard delimiters used to separate token on the command string. More...
 
DSS_CAPI_DLL void Parser_ResetDelimiters (void)
 
DSS_CAPI_DLL void Parser_Get_Vector (double **ResultPtr, int32_t *ResultCount, int32_t ExpectedSize)
 Returns token as array of doubles. More...
 
DSS_CAPI_DLL void Parser_Get_Vector_GR (int32_t ExpectedSize)
 Same as Parser_Get_Vector but using the global buffer interface for results.
 
DSS_CAPI_DLL void Parser_Get_Matrix (double **ResultPtr, int32_t *ResultCount, int32_t ExpectedOrder)
 Use this property to parse a Matrix token in OpenDSS format. More...
 
DSS_CAPI_DLL void Parser_Get_Matrix_GR (int32_t ExpectedOrder)
 Same as Parser_Get_Matrix but using the global buffer interface for results.
 
DSS_CAPI_DLL void Parser_Get_SymMatrix (double **ResultPtr, int32_t *ResultCount, int32_t ExpectedOrder)
 Use this property to parse a matrix token specified in lower triangle form. More...
 
DSS_CAPI_DLL void Parser_Get_SymMatrix_GR (int32_t ExpectedOrder)
 Same as Parser_Get_SymMatrix but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t PDElements_Get_Count (void)
 Number of PD elements (including disabled elements)
 
DSS_CAPI_DLL double PDElements_Get_FaultRate (void)
 Get/Set Number of failures per year. More...
 
DSS_CAPI_DLL int32_t PDElements_Get_First (void)
 Set the first enabled PD element to be the active element. More...
 
DSS_CAPI_DLL uint16_t PDElements_Get_IsShunt (void)
 Boolean indicating of PD element should be treated as a shunt element rather than a series element. More...
 
DSS_CAPI_DLL int32_t PDElements_Get_Next (void)
 Advance to the next PD element in the circuit. More...
 
DSS_CAPI_DLL double PDElements_Get_pctPermanent (void)
 Get/Set percent of faults that are permanent (require repair). More...
 
DSS_CAPI_DLL void PDElements_Set_FaultRate (double Value)
 
DSS_CAPI_DLL void PDElements_Set_pctPermanent (double Value)
 
DSS_CAPI_DLL char * PDElements_Get_Name (void)
 Get/Set name of active PD Element. More...
 
DSS_CAPI_DLL void PDElements_Set_Name (const char *Value)
 
DSS_CAPI_DLL double PDElements_Get_AccumulatedL (void)
 accummulated failure rate for this branch on downline
 
DSS_CAPI_DLL double PDElements_Get_Lambda (void)
 Failure rate for this branch. More...
 
DSS_CAPI_DLL int32_t PDElements_Get_Numcustomers (void)
 Number of customers, this branch.
 
DSS_CAPI_DLL int32_t PDElements_Get_ParentPDElement (void)
 Sets the parent PD element to be the active circuit element. More...
 
DSS_CAPI_DLL double PDElements_Get_RepairTime (void)
 Average repair time for this element in hours.
 
DSS_CAPI_DLL int32_t PDElements_Get_Totalcustomers (void)
 Total number of customers from this branch to the end of the zone.
 
DSS_CAPI_DLL int32_t PDElements_Get_FromTerminal (void)
 Number of the terminal of active PD element that is on the "from" side. More...
 
DSS_CAPI_DLL double PDElements_Get_TotalMiles (void)
 Total miles of line from this element to the end of the zone. More...
 
DSS_CAPI_DLL int32_t PDElements_Get_SectionID (void)
 Integer ID of the feeder section that this PDElement branch is part of.
 
DSS_CAPI_DLL void PDElements_Set_RepairTime (double Value)
 Average repair time for this element in hours.
 
DSS_CAPI_DLL void PDElements_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings consisting of all PD element names. More...
 
DSS_CAPI_DLL void PDElements_Get_AllNames_GR (void)
 Same as PDElements_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL void PDElements_Get_AllMaxCurrents (double **ResultPtr, int32_t *ResultCount, uint16_t AllNodes)
 Array of doubles with the maximum current across the conductors, for each PD element. More...
 
DSS_CAPI_DLL void PDElements_Get_AllMaxCurrents_GR (uint16_t AllNodes)
 Same as PDElements_Get_AllMaxCurrents but using the global buffer interface for results.
 
DSS_CAPI_DLL void PDElements_Get_AllPctNorm (double **ResultPtr, int32_t *ResultCount, uint16_t AllNodes)
 Array of doubles with the maximum current across the conductors as a percentage of the Normal Ampere Rating, for each PD element. More...
 
DSS_CAPI_DLL void PDElements_Get_AllPctNorm_GR (uint16_t AllNodes)
 Same as PDElements_Get_AllPctNorm but using the global buffer interface for results.
 
DSS_CAPI_DLL void PDElements_Get_AllPctEmerg (double **ResultPtr, int32_t *ResultCount, uint16_t AllNodes)
 Array of doubles with the maximum current across the conductors as a percentage of the Emergency Ampere Rating, for each PD element. More...
 
DSS_CAPI_DLL void PDElements_Get_AllPctEmerg_GR (uint16_t AllNodes)
 Same as PDElements_Get_AllPctEmerg but using the global buffer interface for results.
 
DSS_CAPI_DLL void PDElements_Get_AllCurrents (double **ResultPtr, int32_t *ResultCount)
 Complex array of currents for all conductors, all terminals, for each PD element. More...
 
DSS_CAPI_DLL void PDElements_Get_AllCurrents_GR (void)
 Same as PDElements_Get_AllCurrents but using the global buffer interface for results.
 
DSS_CAPI_DLL void PDElements_Get_AllCurrentsMagAng (double **ResultPtr, int32_t *ResultCount)
 Complex array (magnitude and angle format) of currents for all conductors, all terminals, for each PD element. More...
 
DSS_CAPI_DLL void PDElements_Get_AllCurrentsMagAng_GR (void)
 Same as PDElements_Get_AllCurrentsMagAng but using the global buffer interface for results.
 
DSS_CAPI_DLL void PDElements_Get_AllCplxSeqCurrents (double **ResultPtr, int32_t *ResultCount)
 Complex double array of Sequence Currents for all conductors of all terminals, for each PD elements. More...
 
DSS_CAPI_DLL void PDElements_Get_AllCplxSeqCurrents_GR (void)
 Same as PDElements_Get_AllCplxSeqCurrents but using the global buffer interface for results.
 
DSS_CAPI_DLL void PDElements_Get_AllSeqCurrents (double **ResultPtr, int32_t *ResultCount)
 Double array of the symmetrical component currents into each 3-phase terminal, for each PD element. More...
 
DSS_CAPI_DLL void PDElements_Get_AllSeqCurrents_GR (void)
 Same as PDElements_Get_AllSeqCurrents but using the global buffer interface for results.
 
DSS_CAPI_DLL void PDElements_Get_AllPowers (double **ResultPtr, int32_t *ResultCount)
 Complex array of powers into each conductor of each terminal, for each PD element. More...
 
DSS_CAPI_DLL void PDElements_Get_AllPowers_GR (void)
 Same as PDElements_Get_AllPowers but using the global buffer interface for results.
 
DSS_CAPI_DLL void PDElements_Get_AllSeqPowers (double **ResultPtr, int32_t *ResultCount)
 Double array of sequence powers into each 3-phase teminal, for each PD element. More...
 
DSS_CAPI_DLL void PDElements_Get_AllSeqPowers_GR (void)
 Same as PDElements_Get_AllSeqPowers but using the global buffer interface for results.
 
DSS_CAPI_DLL void PDElements_Get_AllNumPhases (int32_t **ResultPtr, int32_t *ResultCount)
 Integer array listing the number of phases of all PD elements. More...
 
DSS_CAPI_DLL void PDElements_Get_AllNumPhases_GR (void)
 Same as PDElements_Get_AllNumPhases but using the global buffer interface for results.
 
DSS_CAPI_DLL void PDElements_Get_AllNumConductors (int32_t **ResultPtr, int32_t *ResultCount)
 Integer array listing the number of conductors of all PD elements. More...
 
DSS_CAPI_DLL void PDElements_Get_AllNumConductors_GR (void)
 Same as PDElements_Get_AllNumConductors but using the global buffer interface for results.
 
DSS_CAPI_DLL void PDElements_Get_AllNumTerminals (int32_t **ResultPtr, int32_t *ResultCount)
 Integer array listing the number of terminals of all PD elements. More...
 
DSS_CAPI_DLL void PDElements_Get_AllNumTerminals_GR (void)
 Same as PDElements_Get_AllNumTerminals but using the global buffer interface for results.
 
DSS_CAPI_DLL void PVSystems_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings with all PVSystem names.
 
DSS_CAPI_DLL void PVSystems_Get_AllNames_GR (void)
 Same as PVSystems_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL void PVSystems_Get_RegisterNames (char ***ResultPtr, int32_t *ResultCount)
 Array of PVSYSTEM energy meter register names.
 
DSS_CAPI_DLL void PVSystems_Get_RegisterNames_GR (void)
 Same as PVSystems_Get_RegisterNames but using the global buffer interface for results.
 
DSS_CAPI_DLL void PVSystems_Get_RegisterValues (double **ResultPtr, int32_t *ResultCount)
 Array of doubles containing values in PVSystem registers.
 
DSS_CAPI_DLL void PVSystems_Get_RegisterValues_GR (void)
 Same as PVSystems_Get_RegisterValues but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t PVSystems_Get_First (void)
 Set first PVSystem active; returns 0 if none.
 
DSS_CAPI_DLL int32_t PVSystems_Get_Next (void)
 Sets next PVSystem active; returns 0 if no more.
 
DSS_CAPI_DLL int32_t PVSystems_Get_Count (void)
 Number of PVSystems.
 
DSS_CAPI_DLL int32_t PVSystems_Get_idx (void)
 Get/set active PVSystem by index; 1..Count.
 
DSS_CAPI_DLL void PVSystems_Set_idx (int32_t Value)
 Get/Set Active PVSystem by index: 1. More...
 
DSS_CAPI_DLL char * PVSystems_Get_Name (void)
 Get the name of the active PVSystem.
 
DSS_CAPI_DLL void PVSystems_Set_Name (const char *Value)
 Set the name of the active PVSystem.
 
DSS_CAPI_DLL double PVSystems_Get_Irradiance (void)
 Get the present value of the Irradiance property in kW/sq-m.
 
DSS_CAPI_DLL void PVSystems_Set_Irradiance (double Value)
 Set the present Irradiance value in kW/sq-m.
 
DSS_CAPI_DLL double PVSystems_Get_kvar (void)
 Get kvar value.
 
DSS_CAPI_DLL double PVSystems_Get_kVArated (void)
 Get Rated kVA of the PVSystem.
 
DSS_CAPI_DLL double PVSystems_Get_kW (void)
 get kW output
 
DSS_CAPI_DLL double PVSystems_Get_PF (void)
 Get Power factor.
 
DSS_CAPI_DLL void PVSystems_Set_kVArated (double Value)
 Set kva rated.
 
DSS_CAPI_DLL void PVSystems_Set_PF (double Value)
 Set PF.
 
DSS_CAPI_DLL void PVSystems_Set_kvar (double Value)
 Set kvar output value.
 
DSS_CAPI_DLL char * PVSystems_Get_daily (void)
 Name of the dispatch shape to use for daily simulations. More...
 
DSS_CAPI_DLL void PVSystems_Set_daily (const char *Value)
 
DSS_CAPI_DLL char * PVSystems_Get_duty (void)
 Name of the load shape to use for duty cycle dispatch simulations such as for solar ramp rate studies. More...
 
DSS_CAPI_DLL void PVSystems_Set_duty (const char *Value)
 
DSS_CAPI_DLL char * PVSystems_Get_yearly (void)
 Dispatch shape to use for yearly simulations. More...
 
DSS_CAPI_DLL void PVSystems_Set_yearly (const char *Value)
 
DSS_CAPI_DLL char * PVSystems_Get_Tdaily (void)
 Temperature shape to use for daily simulations. More...
 
DSS_CAPI_DLL void PVSystems_Set_Tdaily (const char *Value)
 
DSS_CAPI_DLL char * PVSystems_Get_Tduty (void)
 Temperature shape to use for duty cycle dispatch simulations such as for solar ramp rate studies. More...
 
DSS_CAPI_DLL void PVSystems_Set_Tduty (const char *Value)
 
DSS_CAPI_DLL char * PVSystems_Get_Tyearly (void)
 Temperature shape to use for yearly simulations. More...
 
DSS_CAPI_DLL void PVSystems_Set_Tyearly (const char *Value)
 
DSS_CAPI_DLL double PVSystems_Get_Pmpp (void)
 Gets/sets the rated max power of the PV array for 1.0 kW/sq-m irradiance and a user-selected array temperature of the active PVSystem.
 
DSS_CAPI_DLL void PVSystems_Set_Pmpp (double Value)
 
DSS_CAPI_DLL double PVSystems_Get_IrradianceNow (void)
 Returns the current irradiance value for the active PVSystem. More...
 
DSS_CAPI_DLL char * PVSystems_Get_Sensor (void)
 Name of the sensor monitoring this PVSystem element.
 
DSS_CAPI_DLL void Reclosers_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings with names of all Reclosers in Active Circuit.
 
DSS_CAPI_DLL void Reclosers_Get_AllNames_GR (void)
 Same as Reclosers_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Reclosers_Get_Count (void)
 Number of Reclosers in active circuit.
 
DSS_CAPI_DLL int32_t Reclosers_Get_First (void)
 Set First Recloser to be Active Ckt Element. More...
 
DSS_CAPI_DLL char * Reclosers_Get_Name (void)
 Get Name of active Recloser or set the active Recloser by name.
 
DSS_CAPI_DLL int32_t Reclosers_Get_Next (void)
 Iterate to the next recloser in the circuit. More...
 
DSS_CAPI_DLL void Reclosers_Set_Name (const char *Value)
 
DSS_CAPI_DLL int32_t Reclosers_Get_MonitoredTerm (void)
 Terminal number of Monitored object for the Recloser.
 
DSS_CAPI_DLL void Reclosers_Set_MonitoredTerm (int32_t Value)
 
DSS_CAPI_DLL char * Reclosers_Get_SwitchedObj (void)
 Full name of the circuit element that is being switched by the Recloser.
 
DSS_CAPI_DLL void Reclosers_Set_SwitchedObj (const char *Value)
 
DSS_CAPI_DLL char * Reclosers_Get_MonitoredObj (void)
 Full name of object this Recloser is monitoring.
 
DSS_CAPI_DLL int32_t Reclosers_Get_SwitchedTerm (void)
 Terminal number of the controlled device being switched by the Recloser.
 
DSS_CAPI_DLL void Reclosers_Set_MonitoredObj (const char *Value)
 Set monitored object by full name.
 
DSS_CAPI_DLL void Reclosers_Set_SwitchedTerm (int32_t Value)
 
DSS_CAPI_DLL int32_t Reclosers_Get_NumFast (void)
 Number of fast shots.
 
DSS_CAPI_DLL void Reclosers_Get_RecloseIntervals (double **ResultPtr, int32_t *ResultCount)
 Array of Doubles: reclose intervals, s, between shots.
 
DSS_CAPI_DLL void Reclosers_Get_RecloseIntervals_GR (void)
 Same as Reclosers_Get_RecloseIntervals but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Reclosers_Get_Shots (void)
 Number of shots to lockout (fast + delayed)
 
DSS_CAPI_DLL void Reclosers_Set_NumFast (int32_t Value)
 
DSS_CAPI_DLL void Reclosers_Set_Shots (int32_t Value)
 
DSS_CAPI_DLL double Reclosers_Get_PhaseTrip (void)
 Phase trip curve multiplier or actual amps.
 
DSS_CAPI_DLL void Reclosers_Set_PhaseTrip (double Value)
 Phase Trip multiplier or actual amps.
 
DSS_CAPI_DLL double Reclosers_Get_GroundInst (void)
 Ground (3I0) instantaneous trip setting - curve multipler or actual amps.
 
DSS_CAPI_DLL double Reclosers_Get_GroundTrip (void)
 Ground (3I0) trip multiplier or actual amps.
 
DSS_CAPI_DLL double Reclosers_Get_PhaseInst (void)
 Phase instantaneous curve multipler or actual amps.
 
DSS_CAPI_DLL void Reclosers_Set_GroundInst (double Value)
 Ground (3I0) trip instantaneous multiplier or actual amps.
 
DSS_CAPI_DLL void Reclosers_Set_GroundTrip (double Value)
 
DSS_CAPI_DLL void Reclosers_Set_PhaseInst (double Value)
 
DSS_CAPI_DLL void Reclosers_Close (void)
 Close the switched object controlled by the recloser. More...
 
DSS_CAPI_DLL void Reclosers_Open (void)
 Open recloser's controlled element and lock out the recloser.
 
DSS_CAPI_DLL void Reclosers_Reset (void)
 Reset recloser to normal state. More...
 
DSS_CAPI_DLL int32_t Reclosers_Get_idx (void)
 Get/Set the active Recloser by index into the recloser list. More...
 
DSS_CAPI_DLL void Reclosers_Set_idx (int32_t Value)
 Get/Set the Active Recloser by index into the recloser list. More...
 
DSS_CAPI_DLL int32_t Reclosers_Get_State (void)
 Get/Set present state of recloser. More...
 
DSS_CAPI_DLL void Reclosers_Set_State (int32_t Value)
 Get/Set present state of recloser. More...
 
DSS_CAPI_DLL int32_t Reclosers_Get_NormalState (void)
 Get/set normal state (ActionCodes.Open=1, ActionCodes.Close=2) of the recloser.
 
DSS_CAPI_DLL void Reclosers_Set_NormalState (int32_t Value)
 Get/set normal state (ActionCodes.Open=1, ActionCodes.Close=2) of the recloser.
 
DSS_CAPI_DLL void RegControls_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings containing all RegControl names.
 
DSS_CAPI_DLL void RegControls_Get_AllNames_GR (void)
 Same as RegControls_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL double RegControls_Get_CTPrimary (void)
 CT primary ampere rating (secondary is 0.2 amperes)
 
DSS_CAPI_DLL double RegControls_Get_Delay (void)
 Time delay [s] after arming before the first tap change. More...
 
DSS_CAPI_DLL int32_t RegControls_Get_First (void)
 Sets the first RegControl active. More...
 
DSS_CAPI_DLL double RegControls_Get_ForwardBand (void)
 Regulation bandwidth in forward direciton, centered on Vreg.
 
DSS_CAPI_DLL double RegControls_Get_ForwardR (void)
 LDC R setting in Volts.
 
DSS_CAPI_DLL double RegControls_Get_ForwardVreg (void)
 Target voltage in the forward direction, on PT secondary base.
 
DSS_CAPI_DLL double RegControls_Get_ForwardX (void)
 LDC X setting in Volts.
 
DSS_CAPI_DLL uint16_t RegControls_Get_IsInverseTime (void)
 Time delay is inversely adjusted, proportional to the amount of voltage outside the regulating band.
 
DSS_CAPI_DLL uint16_t RegControls_Get_IsReversible (void)
 Regulator can use different settings in the reverse direction. More...
 
DSS_CAPI_DLL int32_t RegControls_Get_MaxTapChange (void)
 Maximum tap change per iteration in STATIC solution mode. More...
 
DSS_CAPI_DLL char * RegControls_Get_MonitoredBus (void)
 Name of a remote regulated bus, in lieu of LDC settings.
 
DSS_CAPI_DLL char * RegControls_Get_Name (void)
 Get/set Active RegControl name.
 
DSS_CAPI_DLL int32_t RegControls_Get_Next (void)
 Sets the next RegControl active. More...
 
DSS_CAPI_DLL double RegControls_Get_PTratio (void)
 PT ratio for voltage control settings.
 
DSS_CAPI_DLL double RegControls_Get_ReverseBand (void)
 Bandwidth in reverse direction, centered on reverse Vreg.
 
DSS_CAPI_DLL double RegControls_Get_ReverseR (void)
 Reverse LDC R setting in Volts.
 
DSS_CAPI_DLL double RegControls_Get_ReverseVreg (void)
 Target voltage in the revese direction, on PT secondary base.
 
DSS_CAPI_DLL double RegControls_Get_ReverseX (void)
 Reverse LDC X setting in volts.
 
DSS_CAPI_DLL double RegControls_Get_TapDelay (void)
 Time delay [s] for subsequent tap changes in a set. More...
 
DSS_CAPI_DLL int32_t RegControls_Get_TapWinding (void)
 Tapped winding number.
 
DSS_CAPI_DLL char * RegControls_Get_Transformer (void)
 Name of the transformer this regulator controls.
 
DSS_CAPI_DLL double RegControls_Get_VoltageLimit (void)
 First house voltage limit on PT secondary base. More...
 
DSS_CAPI_DLL int32_t RegControls_Get_Winding (void)
 Winding number for PT and CT connections.
 
DSS_CAPI_DLL int32_t RegControls_Get_TapNumber (void)
 
DSS_CAPI_DLL void RegControls_Set_CTPrimary (double Value)
 CT primary ampere rating (secondary is 0.2 amperes)
 
DSS_CAPI_DLL void RegControls_Set_Delay (double Value)
 Time delay [s] after arming before the first tap change. More...
 
DSS_CAPI_DLL void RegControls_Set_ForwardBand (double Value)
 Regulation bandwidth in forward direciton, centered on Vreg.
 
DSS_CAPI_DLL void RegControls_Set_ForwardR (double Value)
 LDC R setting in Volts.
 
DSS_CAPI_DLL void RegControls_Set_ForwardVreg (double Value)
 Target voltage in the forward direction, on PT secondary base.
 
DSS_CAPI_DLL void RegControls_Set_ForwardX (double Value)
 LDC X setting in Volts.
 
DSS_CAPI_DLL void RegControls_Set_IsInverseTime (uint16_t Value)
 Time delay is inversely adjusted, proportional to the amount of voltage outside the regulating band.
 
DSS_CAPI_DLL void RegControls_Set_IsReversible (uint16_t Value)
 Regulator can use different settings in the reverse direction. More...
 
DSS_CAPI_DLL void RegControls_Set_MaxTapChange (int32_t Value)
 Maximum tap change per iteration in STATIC solution mode. More...
 
DSS_CAPI_DLL void RegControls_Set_MonitoredBus (const char *Value)
 Name of a remote regulated bus, in lieu of LDC settings.
 
DSS_CAPI_DLL void RegControls_Set_Name (const char *Value)
 Sets a RegControl active by name.
 
DSS_CAPI_DLL void RegControls_Set_PTratio (double Value)
 PT ratio for voltage control settings.
 
DSS_CAPI_DLL void RegControls_Set_ReverseBand (double Value)
 Bandwidth in reverse direction, centered on reverse Vreg.
 
DSS_CAPI_DLL void RegControls_Set_ReverseR (double Value)
 Reverse LDC R setting in Volts.
 
DSS_CAPI_DLL void RegControls_Set_ReverseVreg (double Value)
 Target voltage in the revese direction, on PT secondary base.
 
DSS_CAPI_DLL void RegControls_Set_ReverseX (double Value)
 Reverse LDC X setting in volts.
 
DSS_CAPI_DLL void RegControls_Set_TapDelay (double Value)
 Time delay [s] for subsequent tap changes in a set. More...
 
DSS_CAPI_DLL void RegControls_Set_TapWinding (int32_t Value)
 Tapped winding number.
 
DSS_CAPI_DLL void RegControls_Set_Transformer (const char *Value)
 Name of the transformer this regulator controls.
 
DSS_CAPI_DLL void RegControls_Set_VoltageLimit (double Value)
 First house voltage limit on PT secondary base. More...
 
DSS_CAPI_DLL void RegControls_Set_Winding (int32_t Value)
 Winding number for PT and CT connections.
 
DSS_CAPI_DLL void RegControls_Set_TapNumber (int32_t Value)
 Integer number of the tap that the controlled transformer winding is currentliy on.
 
DSS_CAPI_DLL int32_t RegControls_Get_Count (void)
 Number of RegControl objects in Active Circuit.
 
DSS_CAPI_DLL void RegControls_Reset (void)
 
DSS_CAPI_DLL void Relays_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings containing names of all Relay elements.
 
DSS_CAPI_DLL void Relays_Get_AllNames_GR (void)
 Same as Relays_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Relays_Get_Count (void)
 Number of Relays in circuit.
 
DSS_CAPI_DLL int32_t Relays_Get_First (void)
 Set First Relay active. More...
 
DSS_CAPI_DLL char * Relays_Get_Name (void)
 Get name of active relay.
 
DSS_CAPI_DLL int32_t Relays_Get_Next (void)
 Advance to next Relay object. More...
 
DSS_CAPI_DLL void Relays_Set_Name (const char *Value)
 Set Relay active by name.
 
DSS_CAPI_DLL char * Relays_Get_MonitoredObj (void)
 Full name of object this Relay is monitoring.
 
DSS_CAPI_DLL void Relays_Set_MonitoredObj (const char *Value)
 
DSS_CAPI_DLL int32_t Relays_Get_MonitoredTerm (void)
 Number of terminal of monitored element that this Relay is monitoring.
 
DSS_CAPI_DLL char * Relays_Get_SwitchedObj (void)
 Full name of element that will be switched when relay trips.
 
DSS_CAPI_DLL void Relays_Set_MonitoredTerm (int32_t Value)
 
DSS_CAPI_DLL void Relays_Set_SwitchedObj (const char *Value)
 
DSS_CAPI_DLL int32_t Relays_Get_SwitchedTerm (void)
 
DSS_CAPI_DLL void Relays_Set_SwitchedTerm (int32_t Value)
 Terminal number of the switched object that will be opened when the relay trips.
 
DSS_CAPI_DLL int32_t Relays_Get_idx (void)
 Get/Set active Relay by index into the Relay list. More...
 
DSS_CAPI_DLL void Relays_Set_idx (int32_t Value)
 Get/Set Relay active by index into relay list. More...
 
DSS_CAPI_DLL void Relays_Open (void)
 Open relay's controlled element and lock out the relay.
 
DSS_CAPI_DLL void Relays_Close (void)
 Close the switched object controlled by the relay. More...
 
DSS_CAPI_DLL void Relays_Reset (void)
 Reset relay to normal state. More...
 
DSS_CAPI_DLL int32_t Relays_Get_State (void)
 Get/Set present state of relay. More...
 
DSS_CAPI_DLL void Relays_Set_State (int32_t Value)
 Get/Set present state of relay. More...
 
DSS_CAPI_DLL int32_t Relays_Get_NormalState (void)
 Get/set normal state of relay.
 
DSS_CAPI_DLL void Relays_Set_NormalState (int32_t Value)
 Get/set normal state of relay.
 
DSS_CAPI_DLL void Sensors_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of Sensor names.
 
DSS_CAPI_DLL void Sensors_Get_AllNames_GR (void)
 Same as Sensors_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Sensors_Get_Count (void)
 Number of Sensors in Active Circuit.
 
DSS_CAPI_DLL void Sensors_Get_Currents (double **ResultPtr, int32_t *ResultCount)
 Array of doubles for the line current measurements; don't use with kWS and kVARS.
 
DSS_CAPI_DLL void Sensors_Get_Currents_GR (void)
 Same as Sensors_Get_Currents but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Sensors_Get_First (void)
 Sets the first sensor active. More...
 
DSS_CAPI_DLL uint16_t Sensors_Get_IsDelta (void)
 True if measured voltages are line-line. More...
 
DSS_CAPI_DLL void Sensors_Get_kVARS (double **ResultPtr, int32_t *ResultCount)
 Array of doubles for Q measurements. More...
 
DSS_CAPI_DLL void Sensors_Get_kVARS_GR (void)
 Same as Sensors_Get_kVARS but using the global buffer interface for results.
 
DSS_CAPI_DLL void Sensors_Get_kVS (double **ResultPtr, int32_t *ResultCount)
 Array of doubles for the LL or LN (depending on Delta connection) voltage measurements.
 
DSS_CAPI_DLL void Sensors_Get_kVS_GR (void)
 Same as Sensors_Get_kVS but using the global buffer interface for results.
 
DSS_CAPI_DLL void Sensors_Get_kWS (double **ResultPtr, int32_t *ResultCount)
 Array of doubles for P measurements. More...
 
DSS_CAPI_DLL void Sensors_Get_kWS_GR (void)
 Same as Sensors_Get_kWS but using the global buffer interface for results.
 
DSS_CAPI_DLL char * Sensors_Get_MeteredElement (void)
 Full Name of the measured element.
 
DSS_CAPI_DLL int32_t Sensors_Get_MeteredTerminal (void)
 Number of the measured terminal in the measured element.
 
DSS_CAPI_DLL char * Sensors_Get_Name (void)
 Name of the active sensor.
 
DSS_CAPI_DLL int32_t Sensors_Get_Next (void)
 Sets the next Sensor active. More...
 
DSS_CAPI_DLL double Sensors_Get_PctError (void)
 Assumed percent error in the Sensor measurement. More...
 
DSS_CAPI_DLL uint16_t Sensors_Get_ReverseDelta (void)
 True if voltage measurements are 1-3, 3-2, 2-1.
 
DSS_CAPI_DLL double Sensors_Get_Weight (void)
 Weighting factor for this Sensor measurement with respect to other Sensors. More...
 
DSS_CAPI_DLL void Sensors_Reset (void)
 
DSS_CAPI_DLL void Sensors_ResetAll (void)
 
DSS_CAPI_DLL void Sensors_Set_Currents (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL void Sensors_Set_IsDelta (uint16_t Value)
 
DSS_CAPI_DLL void Sensors_Set_kVARS (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL void Sensors_Set_kVS (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL void Sensors_Set_kWS (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL void Sensors_Set_MeteredElement (const char *Value)
 
DSS_CAPI_DLL void Sensors_Set_MeteredTerminal (int32_t Value)
 
DSS_CAPI_DLL void Sensors_Set_Name (const char *Value)
 Set the active Sensor by name.
 
DSS_CAPI_DLL void Sensors_Set_PctError (double Value)
 
DSS_CAPI_DLL void Sensors_Set_ReverseDelta (uint16_t Value)
 
DSS_CAPI_DLL void Sensors_Set_Weight (double Value)
 
DSS_CAPI_DLL double Sensors_Get_kVbase (void)
 Voltage base for the sensor measurements. More...
 
DSS_CAPI_DLL void Sensors_Set_kVbase (double Value)
 
DSS_CAPI_DLL void Sensors_Get_AllocationFactor (double **ResultPtr, int32_t *ResultCount)
 Array of doubles for the allocation factors for each phase.
 
DSS_CAPI_DLL void Sensors_Get_AllocationFactor_GR (void)
 Same as Sensors_Get_AllocationFactor but using the global buffer interface for results.
 
DSS_CAPI_DLL uint16_t Settings_Get_AllowDuplicates (void)
 {True | False*} Designates whether to allow duplicate names of objects
 
DSS_CAPI_DLL char * Settings_Get_AutoBusList (void)
 List of Buses or (File=xxxx) syntax for the AutoAdd solution mode.
 
DSS_CAPI_DLL int32_t Settings_Get_CktModel (void)
 {Multiphase * | PositiveSeq} Indicate if the circuit model is positive sequence.
 
DSS_CAPI_DLL void Settings_Set_CktModel (int32_t Value)
 
DSS_CAPI_DLL double Settings_Get_EmergVmaxpu (void)
 Per Unit maximum voltage for Emergency conditions.
 
DSS_CAPI_DLL double Settings_Get_EmergVminpu (void)
 Per Unit minimum voltage for Emergency conditions.
 
DSS_CAPI_DLL double Settings_Get_NormVmaxpu (void)
 Per Unit maximum voltage for Normal conditions.
 
DSS_CAPI_DLL double Settings_Get_NormVminpu (void)
 Per Unit minimum voltage for Normal conditions.
 
DSS_CAPI_DLL uint16_t Settings_Get_ZoneLock (void)
 {True | False*} Locks Zones on energy meters to prevent rebuilding if a circuit change occurs.
 
DSS_CAPI_DLL void Settings_Set_AllocationFactors (double Value)
 Sets all load allocation factors for all loads defined by XFKVA property to this value.
 
DSS_CAPI_DLL void Settings_Set_AllowDuplicates (uint16_t Value)
 {True | False*} Designates whether to allow duplicate names of objects
 
DSS_CAPI_DLL void Settings_Set_AutoBusList (const char *Value)
 List of Buses or (File=xxxx) syntax for the AutoAdd solution mode.
 
DSS_CAPI_DLL void Settings_Set_EmergVmaxpu (double Value)
 Per Unit maximum voltage for Emergency conditions.
 
DSS_CAPI_DLL void Settings_Set_EmergVminpu (double Value)
 Per Unit minimum voltage for Emergency conditions.
 
DSS_CAPI_DLL void Settings_Set_NormVmaxpu (double Value)
 Per Unit maximum voltage for Normal conditions.
 
DSS_CAPI_DLL void Settings_Set_NormVminpu (double Value)
 Per Unit minimum voltage for Normal conditions.
 
DSS_CAPI_DLL void Settings_Set_ZoneLock (uint16_t Value)
 {True | False*} Locks Zones on energy meters to prevent rebuilding if a circuit change occurs.
 
DSS_CAPI_DLL void Settings_Get_LossRegs (int32_t **ResultPtr, int32_t *ResultCount)
 Integer array defining which energy meter registers to use for computing losses.
 
DSS_CAPI_DLL void Settings_Get_LossRegs_GR (void)
 Same as Settings_Get_LossRegs but using the global buffer interface for results.
 
DSS_CAPI_DLL double Settings_Get_LossWeight (void)
 Weighting factor applied to Loss register values.
 
DSS_CAPI_DLL uint16_t Settings_Get_Trapezoidal (void)
 {True | False *} Gets value of trapezoidal integration flag in energy meters.
 
DSS_CAPI_DLL void Settings_Get_UEregs (int32_t **ResultPtr, int32_t *ResultCount)
 Array of Integers defining energy meter registers to use for computing UE.
 
DSS_CAPI_DLL void Settings_Get_UEregs_GR (void)
 Same as Settings_Get_UEregs but using the global buffer interface for results.
 
DSS_CAPI_DLL double Settings_Get_UEweight (void)
 Weighting factor applied to UE register values.
 
DSS_CAPI_DLL void Settings_Set_LossRegs (int32_t *ValuePtr, int32_t ValueCount)
 Integer array defining which energy meter registers to use for computing losses.
 
DSS_CAPI_DLL void Settings_Set_LossWeight (double Value)
 Weighting factor applied to Loss register values.
 
DSS_CAPI_DLL void Settings_Set_Trapezoidal (uint16_t Value)
 {True | False *} Gets value of trapezoidal integration flag in energy meters.
 
DSS_CAPI_DLL void Settings_Set_UEregs (int32_t *ValuePtr, int32_t ValueCount)
 Array of Integers defining energy meter registers to use for computing UE.
 
DSS_CAPI_DLL void Settings_Set_UEweight (double Value)
 Weighting factor applied to UE register values.
 
DSS_CAPI_DLL uint16_t Settings_Get_ControlTrace (void)
 {True | False*} Denotes whether to trace the control actions to a file.
 
DSS_CAPI_DLL void Settings_Get_VoltageBases (double **ResultPtr, int32_t *ResultCount)
 Array of doubles defining the legal voltage bases in kV L-L.
 
DSS_CAPI_DLL void Settings_Get_VoltageBases_GR (void)
 Same as Settings_Get_VoltageBases but using the global buffer interface for results.
 
DSS_CAPI_DLL void Settings_Set_ControlTrace (uint16_t Value)
 {True | False*} Denotes whether to trace the control actions to a file.
 
DSS_CAPI_DLL void Settings_Set_VoltageBases (double *ValuePtr, int32_t ValueCount)
 Array of doubles defining the legal voltage bases in kV L-L.
 
DSS_CAPI_DLL char * Settings_Get_PriceCurve (void)
 Name of LoadShape object that serves as the source of price signal data for yearly simulations, etc.
 
DSS_CAPI_DLL double Settings_Get_PriceSignal (void)
 Price Signal for the Circuit.
 
DSS_CAPI_DLL void Settings_Set_PriceCurve (const char *Value)
 Name of LoadShape object that serves as the source of price signal data for yearly simulations, etc.
 
DSS_CAPI_DLL void Settings_Set_PriceSignal (double Value)
 Price Signal for the Circuit.
 
DSS_CAPI_DLL uint16_t Settings_Get_LoadsTerminalCheck (void)
 Controls whether the terminals are checked when updating the currents in Load component. More...
 
DSS_CAPI_DLL void Settings_Set_LoadsTerminalCheck (uint16_t Value)
 
DSS_CAPI_DLL int32_t Settings_Get_IterateDisabled (void)
 Controls whether First/Next iteration includes or skips disabled circuit elements. More...
 
DSS_CAPI_DLL void Settings_Set_IterateDisabled (int32_t Value)
 
DSS_CAPI_DLL double Solution_Get_Frequency (void)
 Set the Frequency for next solution.
 
DSS_CAPI_DLL int32_t Solution_Get_Hour (void)
 Set Hour for time series solutions.
 
DSS_CAPI_DLL int32_t Solution_Get_Iterations (void)
 Number of iterations taken for last solution. More...
 
DSS_CAPI_DLL double Solution_Get_LoadMult (void)
 Default load multiplier applied to all non-fixed loads.
 
DSS_CAPI_DLL int32_t Solution_Get_MaxIterations (void)
 Max allowable iterations.
 
DSS_CAPI_DLL int32_t Solution_Get_Mode (void)
 Set present solution mode (by a text code - see DSS Help)
 
DSS_CAPI_DLL int32_t Solution_Get_Number (void)
 Number of solutions to perform for Monte Carlo and time series simulations.
 
DSS_CAPI_DLL void Solution_Set_Random (int32_t Random)
 Randomization mode for random variables "Gaussian", "Uniform" or "LogNormal".
 
DSS_CAPI_DLL int32_t Solution_Get_Random (void)
 Randomization mode for random variables "Gaussian", "Uniform" or "LogNormal".
 
DSS_CAPI_DLL double Solution_Get_Seconds (void)
 Seconds from top of the hour.
 
DSS_CAPI_DLL double Solution_Get_StepSize (void)
 Time step size in sec.
 
DSS_CAPI_DLL double Solution_Get_Tolerance (void)
 Solution convergence tolerance.
 
DSS_CAPI_DLL int32_t Solution_Get_Year (void)
 Set year for planning studies.
 
DSS_CAPI_DLL void Solution_Set_Frequency (double Value)
 Set the Frequency for next solution.
 
DSS_CAPI_DLL void Solution_Set_Hour (int32_t Value)
 Set Hour for time series solutions.
 
DSS_CAPI_DLL void Solution_Set_LoadMult (double Value)
 Default load multiplier applied to all non-fixed loads.
 
DSS_CAPI_DLL void Solution_Set_MaxIterations (int32_t Value)
 Max allowable iterations.
 
DSS_CAPI_DLL void Solution_Set_Mode (int32_t Mode)
 Set present solution mode (by a text code - see DSS Help)
 
DSS_CAPI_DLL void Solution_Set_Number (int32_t Value)
 Number of solutions to perform for Monte Carlo and time series simulations.
 
DSS_CAPI_DLL void Solution_Set_Seconds (double Value)
 Seconds from top of the hour.
 
DSS_CAPI_DLL void Solution_Set_StepSize (double Value)
 Time step size in sec.
 
DSS_CAPI_DLL void Solution_Set_Tolerance (double Value)
 Solution convergence tolerance.
 
DSS_CAPI_DLL void Solution_Set_Year (int32_t Value)
 Set year for planning studies.
 
DSS_CAPI_DLL void Solution_Solve (void)
 
DSS_CAPI_DLL char * Solution_Get_ModeID (void)
 ID (text) of the present solution mode.
 
DSS_CAPI_DLL int32_t Solution_Get_LoadModel (void)
 Load Model: {PowerFlow (default) | Admittance}.
 
DSS_CAPI_DLL void Solution_Set_LoadModel (int32_t Value)
 Load Model: {PowerFlow (default) | Admittance}.
 
DSS_CAPI_DLL char * Solution_Get_LDCurve (void)
 Load-Duration Curve name for LD modes.
 
DSS_CAPI_DLL void Solution_Set_LDCurve (const char *Value)
 Load-Duration Curve name for LD modes.
 
DSS_CAPI_DLL double Solution_Get_pctGrowth (void)
 Percent default annual load growth rate.
 
DSS_CAPI_DLL void Solution_Set_pctGrowth (double Value)
 Percent default annual load growth rate.
 
DSS_CAPI_DLL int32_t Solution_Get_AddType (void)
 Type of device to add in AutoAdd Mode: {AddGen (Default) | AddCap}.
 
DSS_CAPI_DLL void Solution_Set_AddType (int32_t Value)
 
DSS_CAPI_DLL double Solution_Get_GenkW (void)
 Generator kW for AutoAdd mode.
 
DSS_CAPI_DLL void Solution_Set_GenkW (double Value)
 
DSS_CAPI_DLL double Solution_Get_GenPF (void)
 PF for generators in AutoAdd mode.
 
DSS_CAPI_DLL void Solution_Set_GenPF (double Value)
 PF for generators in AutoAdd mode.
 
DSS_CAPI_DLL double Solution_Get_Capkvar (void)
 Capacitor kvar for adding capacitors in AutoAdd mode.
 
DSS_CAPI_DLL void Solution_Set_Capkvar (double Value)
 Capacitor kvar for adding capacitors in AutoAdd mode.
 
DSS_CAPI_DLL int32_t Solution_Get_Algorithm (void)
 Base Solution algorithm: {NormalSolve | NewtonSolve}.
 
DSS_CAPI_DLL void Solution_Set_Algorithm (int32_t Value)
 Base Solution algorithm: {NormalSolve | NewtonSolve}.
 
DSS_CAPI_DLL int32_t Solution_Get_ControlMode (void)
 {Static* | Event | Time | Off} Modes for control devices (see ControlModes)
 
DSS_CAPI_DLL void Solution_Set_ControlMode (int32_t Value)
 
DSS_CAPI_DLL double Solution_Get_GenMult (void)
 Default Multiplier applied to generators (like LoadMult)
 
DSS_CAPI_DLL void Solution_Set_GenMult (double Value)
 Default Multiplier applied to generators (like LoadMult)
 
DSS_CAPI_DLL char * Solution_Get_DefaultDaily (void)
 Default daily load shape (defaults to "Default")
 
DSS_CAPI_DLL char * Solution_Get_DefaultYearly (void)
 Default Yearly load shape (defaults to "Default")
 
DSS_CAPI_DLL void Solution_Set_DefaultDaily (const char *Value)
 Default daily load shape (defaults to "Default")
 
DSS_CAPI_DLL void Solution_Set_DefaultYearly (const char *Value)
 Default Yearly load shape (defaults to "Default")
 
DSS_CAPI_DLL void Solution_Get_EventLog (char ***ResultPtr, int32_t *ResultCount)
 Array of strings containing the Event Log.
 
DSS_CAPI_DLL void Solution_Get_EventLog_GR (void)
 Same as Solution_Get_EventLog but using the global buffer interface for results.
 
DSS_CAPI_DLL double Solution_Get_dblHour (void)
 Hour as a double, including fractional part.
 
DSS_CAPI_DLL void Solution_Set_dblHour (double Value)
 Hour as a double, including fractional part.
 
DSS_CAPI_DLL void Solution_Set_StepsizeHr (double Value)
 Set Stepsize in Hr.
 
DSS_CAPI_DLL void Solution_Set_StepsizeMin (double Value)
 Set Stepsize in minutes.
 
DSS_CAPI_DLL int32_t Solution_Get_ControlIterations (void)
 Value of the control iteration counter.
 
DSS_CAPI_DLL int32_t Solution_Get_MaxControlIterations (void)
 Maximum allowable control iterations.
 
DSS_CAPI_DLL void Solution_Sample_DoControlActions (void)
 
DSS_CAPI_DLL void Solution_Set_ControlIterations (int32_t Value)
 Value of the control iteration counter.
 
DSS_CAPI_DLL void Solution_Set_MaxControlIterations (int32_t Value)
 Maximum allowable control iterations.
 
DSS_CAPI_DLL void Solution_CheckFaultStatus (void)
 
DSS_CAPI_DLL void Solution_SolveDirect (void)
 
DSS_CAPI_DLL void Solution_SolveNoControl (void)
 
DSS_CAPI_DLL void Solution_SolvePflow (void)
 
DSS_CAPI_DLL void Solution_SolvePlusControl (void)
 
DSS_CAPI_DLL void Solution_SolveSnap (void)
 
DSS_CAPI_DLL void Solution_CheckControls (void)
 
DSS_CAPI_DLL void Solution_InitSnap (void)
 
DSS_CAPI_DLL uint16_t Solution_Get_SystemYChanged (void)
 Flag that indicates if elements of the System Y have been changed by recent activity.
 
DSS_CAPI_DLL void Solution_BuildYMatrix (int32_t BuildOption, int32_t AllocateVI)
 
DSS_CAPI_DLL void Solution_DoControlActions (void)
 
DSS_CAPI_DLL void Solution_SampleControlDevices (void)
 
DSS_CAPI_DLL uint16_t Solution_Get_Converged (void)
 Flag to indicate whether the circuit solution converged.
 
DSS_CAPI_DLL void Solution_Set_Converged (uint16_t Value)
 Flag to indicate whether the circuit solution converged.
 
DSS_CAPI_DLL int32_t Solution_Get_Totaliterations (void)
 Total iterations including control iterations for most recent solution.
 
DSS_CAPI_DLL int32_t Solution_Get_MostIterationsDone (void)
 Max number of iterations required to converge at any control iteration of the most recent solution.
 
DSS_CAPI_DLL uint16_t Solution_Get_ControlActionsDone (void)
 Flag indicating the control actions are done.
 
DSS_CAPI_DLL void Solution_Set_ControlActionsDone (uint16_t Value)
 
DSS_CAPI_DLL void Solution_Cleanup (void)
 
DSS_CAPI_DLL void Solution_FinishTimeStep (void)
 
DSS_CAPI_DLL double Solution_Get_Process_Time (void)
 Gets the time required to perform the latest solution (Read only)
 
DSS_CAPI_DLL double Solution_Get_Total_Time (void)
 Gets the accumulated time of the simulation.
 
DSS_CAPI_DLL void Solution_Set_Total_Time (double Value)
 Sets the Accumulated time of the simulation.
 
DSS_CAPI_DLL double Solution_Get_Time_of_Step (void)
 Get the solution process time + sample time for time step.
 
DSS_CAPI_DLL double Solution_Get_IntervalHrs (void)
 Get/Set the Solution.IntervalHrs variable used for devices that integrate.
 
DSS_CAPI_DLL void Solution_Set_IntervalHrs (double Value)
 Get/Set the Solution.IntervalHrs variable for custom solution algorithms.
 
DSS_CAPI_DLL int32_t Solution_Get_MinIterations (void)
 Minimum number of iterations required for a power flow solution.
 
DSS_CAPI_DLL void Solution_Set_MinIterations (int32_t Value)
 Mininum number of iterations required for a power flow solution.
 
DSS_CAPI_DLL void Solution_SolveAll (void)
 Solves the circuits for all the Actors created.
 
DSS_CAPI_DLL void Solution_Get_IncMatrix (int32_t **ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void Solution_Get_IncMatrix_GR (void)
 Same as Solution_Get_IncMatrix but using the global buffer interface for results.
 
DSS_CAPI_DLL void Solution_Get_Laplacian (int32_t **ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void Solution_Get_Laplacian_GR (void)
 Same as Solution_Get_Laplacian but using the global buffer interface for results.
 
DSS_CAPI_DLL void Solution_Get_BusLevels (int32_t **ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void Solution_Get_BusLevels_GR (void)
 Same as Solution_Get_BusLevels but using the global buffer interface for results.
 
DSS_CAPI_DLL void Solution_Get_IncMatrixRows (char ***ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void Solution_Get_IncMatrixRows_GR (void)
 Same as Solution_Get_IncMatrixRows but using the global buffer interface for results.
 
DSS_CAPI_DLL void Solution_Get_IncMatrixCols (char ***ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void Solution_Get_IncMatrixCols_GR (void)
 Same as Solution_Get_IncMatrixCols but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t SwtControls_Get_Action (void)
 Open or Close the switch. More...
 
DSS_CAPI_DLL void SwtControls_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings with all SwtControl names in the active circuit.
 
DSS_CAPI_DLL void SwtControls_Get_AllNames_GR (void)
 Same as SwtControls_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL double SwtControls_Get_Delay (void)
 Time delay [s] betwen arming and opening or closing the switch. More...
 
DSS_CAPI_DLL int32_t SwtControls_Get_First (void)
 Sets the first SwtControl active. More...
 
DSS_CAPI_DLL uint16_t SwtControls_Get_IsLocked (void)
 The lock prevents both manual and automatic switch operation.
 
DSS_CAPI_DLL char * SwtControls_Get_Name (void)
 Sets a SwtControl active by Name.
 
DSS_CAPI_DLL int32_t SwtControls_Get_Next (void)
 Sets the next SwtControl active. More...
 
DSS_CAPI_DLL char * SwtControls_Get_SwitchedObj (void)
 Full name of the switched element.
 
DSS_CAPI_DLL int32_t SwtControls_Get_SwitchedTerm (void)
 Terminal number where the switch is located on the SwitchedObj.
 
DSS_CAPI_DLL void SwtControls_Set_Action (int32_t Value)
 Open or Close the switch. More...
 
DSS_CAPI_DLL void SwtControls_Set_Delay (double Value)
 Time delay [s] betwen arming and opening or closing the switch. More...
 
DSS_CAPI_DLL void SwtControls_Set_IsLocked (uint16_t Value)
 The lock prevents both manual and automatic switch operation.
 
DSS_CAPI_DLL void SwtControls_Set_Name (const char *Value)
 Sets a SwtControl active by Name.
 
DSS_CAPI_DLL void SwtControls_Set_SwitchedObj (const char *Value)
 Full name of the switched element.
 
DSS_CAPI_DLL void SwtControls_Set_SwitchedTerm (int32_t Value)
 Terminal number where the switch is located on the SwitchedObj.
 
DSS_CAPI_DLL int32_t SwtControls_Get_Count (void)
 
DSS_CAPI_DLL int32_t SwtControls_Get_NormalState (void)
 Normal state of switch (see ActionCodes) ActionOpen or ActionClose.
 
DSS_CAPI_DLL void SwtControls_Set_NormalState (int32_t Value)
 
DSS_CAPI_DLL int32_t SwtControls_Get_State (void)
 Force switch to specified state.
 
DSS_CAPI_DLL void SwtControls_Set_State (int32_t Value)
 Get Present state of switch.
 
DSS_CAPI_DLL void SwtControls_Reset (void)
 
DSS_CAPI_DLL char * Text_Get_Command (void)
 Input command string for the DSS.
 
DSS_CAPI_DLL void Text_Set_Command (const char *Value)
 Input command string for the DSS.
 
DSS_CAPI_DLL char * Text_Get_Result (void)
 Result string for the last command.
 
DSS_CAPI_DLL int32_t Topology_Get_NumLoops (void)
 Number of loops.
 
DSS_CAPI_DLL int32_t Topology_Get_ActiveBranch (void)
 Returns index of the active branch.
 
DSS_CAPI_DLL void Topology_Get_AllIsolatedBranches (char ***ResultPtr, int32_t *ResultCount)
 Array of all isolated branch names.
 
DSS_CAPI_DLL void Topology_Get_AllIsolatedBranches_GR (void)
 Same as Topology_Get_AllIsolatedBranches but using the global buffer interface for results.
 
DSS_CAPI_DLL void Topology_Get_AllLoopedPairs (char ***ResultPtr, int32_t *ResultCount)
 Array of all looped element names, by pairs.
 
DSS_CAPI_DLL void Topology_Get_AllLoopedPairs_GR (void)
 Same as Topology_Get_AllLoopedPairs but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Topology_Get_BackwardBranch (void)
 MOve back toward the source, return index of new active branch, or 0 if no more.
 
DSS_CAPI_DLL char * Topology_Get_BranchName (void)
 Name of the active branch.
 
DSS_CAPI_DLL int32_t Topology_Get_First (void)
 Sets the first branch active, returns 0 if none.
 
DSS_CAPI_DLL int32_t Topology_Get_ForwardBranch (void)
 Move forward in the tree, return index of new active branch or 0 if no more.
 
DSS_CAPI_DLL int32_t Topology_Get_LoopedBranch (void)
 Move to looped branch, return index or 0 if none.
 
DSS_CAPI_DLL int32_t Topology_Get_Next (void)
 Sets the next branch active, returns 0 if no more.
 
DSS_CAPI_DLL int32_t Topology_Get_NumIsolatedBranches (void)
 Number of isolated branches (PD elements and capacitors).
 
DSS_CAPI_DLL int32_t Topology_Get_ParallelBranch (void)
 Move to directly parallel branch, return index or 0 if none.
 
DSS_CAPI_DLL void Topology_Set_BranchName (const char *Value)
 
DSS_CAPI_DLL void Topology_Get_AllIsolatedLoads (char ***ResultPtr, int32_t *ResultCount)
 Array of all isolated load names.
 
DSS_CAPI_DLL void Topology_Get_AllIsolatedLoads_GR (void)
 Same as Topology_Get_AllIsolatedLoads but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Topology_Get_FirstLoad (void)
 First load at the active branch, return index or 0 if none.
 
DSS_CAPI_DLL int32_t Topology_Get_NextLoad (void)
 Next load at the active branch, return index or 0 if no more.
 
DSS_CAPI_DLL int32_t Topology_Get_NumIsolatedLoads (void)
 Number of isolated loads.
 
DSS_CAPI_DLL int32_t Topology_Get_ActiveLevel (void)
 Topological depth of the active branch.
 
DSS_CAPI_DLL char * Topology_Get_BusName (void)
 
DSS_CAPI_DLL void Topology_Set_BusName (const char *Value)
 Set the active branch to one containing this bus, return index or 0 if not found.
 
DSS_CAPI_DLL void Transformers_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings with all Transformer names in the active circuit.
 
DSS_CAPI_DLL void Transformers_Get_AllNames_GR (void)
 Same as Transformers_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Transformers_Get_First (void)
 Sets the first Transformer active. More...
 
DSS_CAPI_DLL uint16_t Transformers_Get_IsDelta (void)
 Active Winding delta or wye connection?
 
DSS_CAPI_DLL double Transformers_Get_kV (void)
 Active Winding kV rating. More...
 
DSS_CAPI_DLL double Transformers_Get_kVA (void)
 Active Winding kVA rating. More...
 
DSS_CAPI_DLL double Transformers_Get_MaxTap (void)
 Active Winding maximum tap in per-unit.
 
DSS_CAPI_DLL double Transformers_Get_MinTap (void)
 Active Winding minimum tap in per-unit.
 
DSS_CAPI_DLL char * Transformers_Get_Name (void)
 Sets a Transformer active by Name.
 
DSS_CAPI_DLL int32_t Transformers_Get_Next (void)
 Sets the next Transformer active. More...
 
DSS_CAPI_DLL int32_t Transformers_Get_NumTaps (void)
 Active Winding number of tap steps betwein MinTap and MaxTap.
 
DSS_CAPI_DLL int32_t Transformers_Get_NumWindings (void)
 Number of windings on this transformer. More...
 
DSS_CAPI_DLL double Transformers_Get_R (void)
 Active Winding resistance in %.
 
DSS_CAPI_DLL double Transformers_Get_Rneut (void)
 Active Winding neutral resistance [ohms] for wye connections. More...
 
DSS_CAPI_DLL double Transformers_Get_Tap (void)
 Active Winding tap in per-unit.
 
DSS_CAPI_DLL int32_t Transformers_Get_Wdg (void)
 Active Winding Number from 1..NumWindings. More...
 
DSS_CAPI_DLL char * Transformers_Get_XfmrCode (void)
 Name of an XfrmCode that supplies electircal parameters for this Transformer.
 
DSS_CAPI_DLL double Transformers_Get_Xhl (void)
 Percent reactance between windings 1 and 2, on winding 1 kVA base. More...
 
DSS_CAPI_DLL double Transformers_Get_Xht (void)
 Percent reactance between windigns 1 and 3, on winding 1 kVA base. More...
 
DSS_CAPI_DLL double Transformers_Get_Xlt (void)
 Percent reactance between windings 2 and 3, on winding 1 kVA base. More...
 
DSS_CAPI_DLL double Transformers_Get_Xneut (void)
 Active Winding neutral reactance [ohms] for wye connections.
 
DSS_CAPI_DLL void Transformers_Set_IsDelta (uint16_t Value)
 Active Winding delta or wye connection?
 
DSS_CAPI_DLL void Transformers_Set_kV (double Value)
 Active Winding kV rating. More...
 
DSS_CAPI_DLL void Transformers_Set_kVA (double Value)
 Active Winding kVA rating. More...
 
DSS_CAPI_DLL void Transformers_Set_MaxTap (double Value)
 Active Winding maximum tap in per-unit.
 
DSS_CAPI_DLL void Transformers_Set_MinTap (double Value)
 Active Winding minimum tap in per-unit.
 
DSS_CAPI_DLL void Transformers_Set_Name (const char *Value)
 Sets a Transformer active by Name.
 
DSS_CAPI_DLL void Transformers_Set_NumTaps (int32_t Value)
 Active Winding number of tap steps betwein MinTap and MaxTap.
 
DSS_CAPI_DLL void Transformers_Set_NumWindings (int32_t Value)
 Number of windings on this transformer. More...
 
DSS_CAPI_DLL void Transformers_Set_R (double Value)
 Active Winding resistance in %.
 
DSS_CAPI_DLL void Transformers_Set_Rneut (double Value)
 Active Winding neutral resistance [ohms] for wye connections. More...
 
DSS_CAPI_DLL void Transformers_Set_Tap (double Value)
 Active Winding tap in per-unit.
 
DSS_CAPI_DLL void Transformers_Set_Wdg (int32_t Value)
 Active Winding Number from 1..NumWindings. More...
 
DSS_CAPI_DLL void Transformers_Set_XfmrCode (const char *Value)
 Name of an XfrmCode that supplies electircal parameters for this Transformer.
 
DSS_CAPI_DLL void Transformers_Set_Xhl (double Value)
 Percent reactance between windings 1 and 2, on winding 1 kVA base. More...
 
DSS_CAPI_DLL void Transformers_Set_Xht (double Value)
 Percent reactance between windigns 1 and 3, on winding 1 kVA base. More...
 
DSS_CAPI_DLL void Transformers_Set_Xlt (double Value)
 Percent reactance between windings 2 and 3, on winding 1 kVA base. More...
 
DSS_CAPI_DLL void Transformers_Set_Xneut (double Value)
 Active Winding neutral reactance [ohms] for wye connections.
 
DSS_CAPI_DLL int32_t Transformers_Get_Count (void)
 
DSS_CAPI_DLL void Transformers_Get_WdgVoltages (double **ResultPtr, int32_t *ResultCount)
 Complex array of voltages for active winding.
 
DSS_CAPI_DLL void Transformers_Get_WdgVoltages_GR (void)
 Same as Transformers_Get_WdgVoltages but using the global buffer interface for results.
 
DSS_CAPI_DLL void Transformers_Get_WdgCurrents (double **ResultPtr, int32_t *ResultCount)
 All Winding currents (ph1, wdg1, wdg2,... ph2, wdg1, wdg2 ...)
 
DSS_CAPI_DLL void Transformers_Get_WdgCurrents_GR (void)
 Same as Transformers_Get_WdgCurrents but using the global buffer interface for results.
 
DSS_CAPI_DLL char * Transformers_Get_strWdgCurrents (void)
 All winding currents in CSV string form like the WdgCurrents property.
 
DSS_CAPI_DLL int32_t Transformers_Get_CoreType (void)
 Transformer Core Type: 0=shell;1 = 1-phase; 3= 3-leg; 5= 5-leg.
 
DSS_CAPI_DLL void Transformers_Set_CoreType (int32_t Value)
 
DSS_CAPI_DLL double Transformers_Get_RdcOhms (void)
 dc Resistance of active winding in ohms for GIC analysis
 
DSS_CAPI_DLL void Transformers_Set_RdcOhms (double Value)
 
DSS_CAPI_DLL void Transformers_Get_LossesByType (double **ResultPtr, int32_t *ResultCount)
 Returns a complex array of the 3 types of losses (total losses, load losses, no-load losses) for the active transformer, in VA.
 
DSS_CAPI_DLL void Transformers_Get_LossesByType_GR (void)
 Same as Transformers_Get_LossesByType but using the global buffer interface for results.
 
DSS_CAPI_DLL void Transformers_Get_AllLossesByType (double **ResultPtr, int32_t *ResultCount)
 Returns a complex array of the 3 types of losses (total losses, load losses, no-load losses) concatenated for the all transformers, in VA.
 
DSS_CAPI_DLL void Transformers_Get_AllLossesByType_GR (void)
 Same as Transformers_Get_AllLossesByType but using the global buffer interface for results.
 
DSS_CAPI_DLL void Vsources_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Names of all Vsource objects in the circuit.
 
DSS_CAPI_DLL void Vsources_Get_AllNames_GR (void)
 Same as Vsources_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t Vsources_Get_Count (void)
 Number of Vsource Object.
 
DSS_CAPI_DLL int32_t Vsources_Get_First (void)
 Sets the first VSOURCE to be active; Returns 0 if none.
 
DSS_CAPI_DLL int32_t Vsources_Get_Next (void)
 Sets the next VSOURCE object to be active; returns zero if no more.
 
DSS_CAPI_DLL char * Vsources_Get_Name (void)
 Get Active VSOURCE name.
 
DSS_CAPI_DLL void Vsources_Set_Name (const char *Value)
 Set Active VSOURCE by Name.
 
DSS_CAPI_DLL double Vsources_Get_BasekV (void)
 Source Voltage in kV.
 
DSS_CAPI_DLL double Vsources_Get_pu (void)
 Source pu voltage.
 
DSS_CAPI_DLL void Vsources_Set_BasekV (double Value)
 Source voltage in kV.
 
DSS_CAPI_DLL void Vsources_Set_pu (double Value)
 Per-unit value of source voltage based on kV.
 
DSS_CAPI_DLL double Vsources_Get_AngleDeg (void)
 Phase angle of first phase in degrees.
 
DSS_CAPI_DLL double Vsources_Get_Frequency (void)
 Source Frequency in Hz.
 
DSS_CAPI_DLL int32_t Vsources_Get_Phases (void)
 Number of Phases.
 
DSS_CAPI_DLL void Vsources_Set_AngleDeg (double Value)
 phase angle in degrees
 
DSS_CAPI_DLL void Vsources_Set_Frequency (double Value)
 Source frequency in Hz.
 
DSS_CAPI_DLL void Vsources_Set_Phases (int32_t Value)
 Number of phases.
 
DSS_CAPI_DLL void XYCurves_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of strings with all XYCurve names.
 
DSS_CAPI_DLL void XYCurves_Get_AllNames_GR (void)
 Same as XYCurves_Get_AllNames but using the global buffer interface for results.
 
DSS_CAPI_DLL int32_t XYCurves_Get_Count (void)
 Number of XYCurve Objects.
 
DSS_CAPI_DLL int32_t XYCurves_Get_First (void)
 Sets first XYcurve object active; returns 0 if none.
 
DSS_CAPI_DLL char * XYCurves_Get_Name (void)
 Name of active XYCurve Object.
 
DSS_CAPI_DLL int32_t XYCurves_Get_Next (void)
 Advances to next XYCurve object; returns 0 if no more objects of this class.
 
DSS_CAPI_DLL void XYCurves_Set_Name (const char *Value)
 Get Name of active XYCurve Object.
 
DSS_CAPI_DLL int32_t XYCurves_Get_Npts (void)
 Get/Set Number of points in X-Y curve.
 
DSS_CAPI_DLL void XYCurves_Get_Xarray (double **ResultPtr, int32_t *ResultCount)
 Get/Set X values as a Array of doubles. More...
 
DSS_CAPI_DLL void XYCurves_Get_Xarray_GR (void)
 Same as XYCurves_Get_Xarray but using the global buffer interface for results.
 
DSS_CAPI_DLL void XYCurves_Set_Npts (int32_t Value)
 Get/Set Number of Points in X-Y curve.
 
DSS_CAPI_DLL void XYCurves_Set_Xarray (double *ValuePtr, int32_t ValueCount)
 Get/Set X values as a Array of doubles. More...
 
DSS_CAPI_DLL double XYCurves_Get_x (void)
 Set X value or get interpolated value after setting Y.
 
DSS_CAPI_DLL double XYCurves_Get_y (void)
 Y value for present X or set this value then get corresponding X.
 
DSS_CAPI_DLL void XYCurves_Get_Yarray (double **ResultPtr, int32_t *ResultCount)
 Get/Set Y values in curve; Set Npts to max number expected if setting.
 
DSS_CAPI_DLL void XYCurves_Get_Yarray_GR (void)
 Same as XYCurves_Get_Yarray but using the global buffer interface for results.
 
DSS_CAPI_DLL void XYCurves_Set_x (double Value)
 
DSS_CAPI_DLL void XYCurves_Set_y (double Value)
 Set Y value or get interpolated Y value after setting X.
 
DSS_CAPI_DLL void XYCurves_Set_Yarray (double *ValuePtr, int32_t ValueCount)
 Get/Set Y values in curve; Set Npts to max number expected if setting.
 
DSS_CAPI_DLL double XYCurves_Get_Xscale (void)
 Factor to scale X values from original curve.
 
DSS_CAPI_DLL double XYCurves_Get_Xshift (void)
 Amount to shift X value from original curve.
 
DSS_CAPI_DLL double XYCurves_Get_Yscale (void)
 Factor to scale Y values from original curve.
 
DSS_CAPI_DLL double XYCurves_Get_Yshift (void)
 amount to shift Y valiue from original curve
 
DSS_CAPI_DLL void XYCurves_Set_Xscale (double Value)
 Factor to scale X values from original curve.
 
DSS_CAPI_DLL void XYCurves_Set_Xshift (double Value)
 
DSS_CAPI_DLL void XYCurves_Set_Yscale (double Value)
 Amount to scale Y values from original curve. More...
 
DSS_CAPI_DLL void XYCurves_Set_Yshift (double Value)
 
DSS_CAPI_DLL void YMatrix_GetCompressedYMatrix (uint16_t factor, uint32_t *nBus, uint32_t *nNz, int32_t **ColPtr, int32_t **RowIdxPtr, double **cValsPtr)
 
DSS_CAPI_DLL void YMatrix_ZeroInjCurr (void)
 
DSS_CAPI_DLL void YMatrix_GetSourceInjCurrents (void)
 
DSS_CAPI_DLL void YMatrix_GetPCInjCurr (void)
 
DSS_CAPI_DLL void YMatrix_BuildYMatrixD (int32_t BuildOps, int32_t AllocateVI)
 
DSS_CAPI_DLL void YMatrix_AddInAuxCurrents (int32_t SType)
 
DSS_CAPI_DLL void YMatrix_getIpointer (double **IvectorPtr)
 
DSS_CAPI_DLL void YMatrix_getVpointer (double **VvectorPtr)
 
DSS_CAPI_DLL int32_t YMatrix_SolveSystem (double *NodeVPtr)
 
DSS_CAPI_DLL void YMatrix_Set_SystemYChanged (uint16_t arg)
 
DSS_CAPI_DLL uint16_t YMatrix_Get_SystemYChanged (void)
 
DSS_CAPI_DLL void YMatrix_Set_UseAuxCurrents (uint16_t arg)
 
DSS_CAPI_DLL uint16_t YMatrix_Get_UseAuxCurrents (void)
 
DSS_CAPI_DLL double ReduceCkt_Get_Zmag (void)
 Zmag (ohms) for Reduce Option for Z of short lines.
 
DSS_CAPI_DLL void ReduceCkt_Set_Zmag (double Value)
 
DSS_CAPI_DLL uint16_t ReduceCkt_Get_KeepLoad (void)
 Keep load flag (T/F) for Reduction options that remove branches.
 
DSS_CAPI_DLL void ReduceCkt_Set_KeepLoad (uint16_t Value)
 
DSS_CAPI_DLL char * ReduceCkt_Get_EditString (void)
 Edit String for RemoveBranches functions.
 
DSS_CAPI_DLL void ReduceCkt_Set_EditString (const char *Value)
 
DSS_CAPI_DLL char * ReduceCkt_Get_StartPDElement (void)
 Start element for Remove Branch function.
 
DSS_CAPI_DLL void ReduceCkt_Set_StartPDElement (const char *Value)
 
DSS_CAPI_DLL char * ReduceCkt_Get_EnergyMeter (void)
 Name of Energymeter to use for reduction.
 
DSS_CAPI_DLL void ReduceCkt_Set_EnergyMeter (const char *Value)
 
DSS_CAPI_DLL void ReduceCkt_SaveCircuit (const char *CktName)
 Save present (reduced) circuit Filename is listed in the Text Result interface.
 
DSS_CAPI_DLL void ReduceCkt_DoDefault (void)
 Do Default Reduction algorithm.
 
DSS_CAPI_DLL void ReduceCkt_DoShortLines (void)
 Do ShortLines algorithm: Set Zmag first if you don't want the default.
 
DSS_CAPI_DLL void ReduceCkt_DoDangling (void)
 Reduce Dangling Algorithm; branches with nothing connected.
 
DSS_CAPI_DLL void ReduceCkt_DoLoopBreak (void)
 
DSS_CAPI_DLL void ReduceCkt_DoParallelLines (void)
 
DSS_CAPI_DLL void ReduceCkt_DoSwitches (void)
 
DSS_CAPI_DLL void ReduceCkt_Do1phLaterals (void)
 
DSS_CAPI_DLL void ReduceCkt_DoBranchRemove (void)
 
DSS_CAPI_DLL void Storages_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 Array of names of all Storage objects.
 
DSS_CAPI_DLL int32_t Storages_Get_First (void)
 Sets first Storage to be active. More...
 
DSS_CAPI_DLL int32_t Storages_Get_Next (void)
 Sets next Storage to be active. More...
 
DSS_CAPI_DLL int32_t Storages_Get_Count (void)
 Number of Storage Objects in Active Circuit.
 
DSS_CAPI_DLL int32_t Storages_Get_idx (void)
 Get/Set active Storage by index into Storages list. More...
 
DSS_CAPI_DLL void Storages_Set_idx (int32_t Value)
 Get/Set active Storage by index into Storages list. More...
 
DSS_CAPI_DLL char * Storages_Get_Name (void)
 Gets the name of the current active Storage object.
 
DSS_CAPI_DLL void Storages_Set_Name (const char *Value)
 Sets a Storage active by name.
 
DSS_CAPI_DLL void Storages_Get_RegisterNames (char ***ResultPtr, int32_t *ResultCount)
 Array of Names of all Storage energy meter registers.
 
DSS_CAPI_DLL void Storages_Get_RegisterValues (double **ResultPtr, int32_t *ResultCount)
 Array of values in Storage registers.
 
DSS_CAPI_DLL void Storages_Get_RegisterValues_GR (void)
 Same as Storages_Get_RegisterValues but using the global buffer interface for results.
 
DSS_CAPI_DLL double Storages_Get_puSOC (void)
 Per unit state of charge.
 
DSS_CAPI_DLL void Storages_Set_puSOC (double Value)
 Per unit state of charge.
 
DSS_CAPI_DLL int32_t Storages_Get_State (void)
 Get/set state: 0=Idling; 1=Discharging; -1=Charging;. More...
 
DSS_CAPI_DLL void Storages_Set_State (int32_t Value)
 Get/set state: 0=Idling; 1=Discharging; -1=Charging;. More...
 
DSS_CAPI_DLL int32_t CNData_Get_Count (void)
 
DSS_CAPI_DLL int32_t CNData_Get_First (void)
 
DSS_CAPI_DLL int32_t CNData_Get_Next (void)
 
DSS_CAPI_DLL char * CNData_Get_Name (void)
 
DSS_CAPI_DLL void CNData_Set_Name (const char *Value)
 
DSS_CAPI_DLL void CNData_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void CNData_Get_AllNames_GR (void)
 
DSS_CAPI_DLL double CNData_Get_Rdc (void)
 
DSS_CAPI_DLL void CNData_Set_Rdc (double Value)
 
DSS_CAPI_DLL double CNData_Get_Rac (void)
 
DSS_CAPI_DLL void CNData_Set_Rac (double Value)
 
DSS_CAPI_DLL double CNData_Get_GMRac (void)
 
DSS_CAPI_DLL void CNData_Set_GMRac (double Value)
 
DSS_CAPI_DLL int32_t CNData_Get_GMRUnits (void)
 
DSS_CAPI_DLL void CNData_Set_GMRUnits (int32_t Value)
 
DSS_CAPI_DLL double CNData_Get_Radius (void)
 
DSS_CAPI_DLL void CNData_Set_Radius (double Value)
 
DSS_CAPI_DLL int32_t CNData_Get_RadiusUnits (void)
 
DSS_CAPI_DLL void CNData_Set_RadiusUnits (int32_t Value)
 
DSS_CAPI_DLL int32_t CNData_Get_ResistanceUnits (void)
 
DSS_CAPI_DLL void CNData_Set_ResistanceUnits (int32_t Value)
 
DSS_CAPI_DLL double CNData_Get_Diameter (void)
 
DSS_CAPI_DLL void CNData_Set_Diameter (double Value)
 
DSS_CAPI_DLL double CNData_Get_NormAmps (void)
 
DSS_CAPI_DLL void CNData_Set_NormAmps (double Value)
 
DSS_CAPI_DLL double CNData_Get_EmergAmps (void)
 
DSS_CAPI_DLL void CNData_Set_EmergAmps (double Value)
 
DSS_CAPI_DLL double CNData_Get_EpsR (void)
 
DSS_CAPI_DLL void CNData_Set_EpsR (double Value)
 
DSS_CAPI_DLL double CNData_Get_InsLayer (void)
 
DSS_CAPI_DLL void CNData_Set_InsLayer (double Value)
 
DSS_CAPI_DLL double CNData_Get_DiaIns (void)
 
DSS_CAPI_DLL void CNData_Set_DiaIns (double Value)
 
DSS_CAPI_DLL double CNData_Get_DiaCable (void)
 
DSS_CAPI_DLL void CNData_Set_DiaCable (double Value)
 
DSS_CAPI_DLL int32_t CNData_Get_k (void)
 
DSS_CAPI_DLL void CNData_Set_k (int32_t Value)
 
DSS_CAPI_DLL double CNData_Get_DiaStrand (void)
 
DSS_CAPI_DLL void CNData_Set_DiaStrand (double Value)
 
DSS_CAPI_DLL double CNData_Get_GmrStrand (void)
 
DSS_CAPI_DLL void CNData_Set_GmrStrand (double Value)
 
DSS_CAPI_DLL double CNData_Get_RStrand (void)
 
DSS_CAPI_DLL void CNData_Set_RStrand (double Value)
 
DSS_CAPI_DLL int32_t LineGeometries_Get_Count (void)
 
DSS_CAPI_DLL int32_t LineGeometries_Get_First (void)
 
DSS_CAPI_DLL int32_t LineGeometries_Get_Next (void)
 
DSS_CAPI_DLL char * LineGeometries_Get_Name (void)
 
DSS_CAPI_DLL void LineGeometries_Set_Name (const char *Value)
 
DSS_CAPI_DLL int32_t LineGeometries_Get_Nconds (void)
 
DSS_CAPI_DLL void LineGeometries_Set_Nconds (int32_t Value)
 
DSS_CAPI_DLL int32_t LineGeometries_Get_Phases (void)
 
DSS_CAPI_DLL void LineGeometries_Set_Phases (int32_t Value)
 
DSS_CAPI_DLL void LineGeometries_Get_Cmatrix (double **ResultPtr, int32_t *ResultCount, double Frequency, double Length, int32_t Units)
 
DSS_CAPI_DLL void LineGeometries_Get_Cmatrix_GR (double Frequency, double Length, int32_t Units)
 
DSS_CAPI_DLL void LineGeometries_Get_Rmatrix (double **ResultPtr, int32_t *ResultCount, double Frequency, double Length, int32_t Units)
 
DSS_CAPI_DLL void LineGeometries_Get_Rmatrix_GR (double Frequency, double Length, int32_t Units)
 
DSS_CAPI_DLL void LineGeometries_Get_Xmatrix (double **ResultPtr, int32_t *ResultCount, double Frequency, double Length, int32_t Units)
 
DSS_CAPI_DLL void LineGeometries_Get_Xmatrix_GR (double Frequency, double Length, int32_t Units)
 
DSS_CAPI_DLL void LineGeometries_Get_Zmatrix (double **ResultPtr, int32_t *ResultCount, double Frequency, double Length, int32_t Units)
 
DSS_CAPI_DLL void LineGeometries_Get_Zmatrix_GR (double Frequency, double Length, int32_t Units)
 
DSS_CAPI_DLL void LineGeometries_Get_Units (int32_t **ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void LineGeometries_Get_Units_GR (void)
 
DSS_CAPI_DLL void LineGeometries_Set_Units (int32_t *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL void LineGeometries_Get_Xcoords (double **ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void LineGeometries_Get_Xcoords_GR (void)
 
DSS_CAPI_DLL void LineGeometries_Set_Xcoords (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL void LineGeometries_Get_Ycoords (double **ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void LineGeometries_Get_Ycoords_GR (void)
 
DSS_CAPI_DLL void LineGeometries_Set_Ycoords (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL void LineGeometries_Get_Conductors (char ***ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void LineGeometries_Get_Conductors_GR (void)
 
DSS_CAPI_DLL uint16_t LineGeometries_Get_Reduce (void)
 
DSS_CAPI_DLL void LineGeometries_Set_Reduce (uint16_t Value)
 
DSS_CAPI_DLL double LineGeometries_Get_RhoEarth (void)
 
DSS_CAPI_DLL void LineGeometries_Set_RhoEarth (double Value)
 
DSS_CAPI_DLL double LineGeometries_Get_NormAmps (void)
 
DSS_CAPI_DLL void LineGeometries_Set_NormAmps (double Value)
 
DSS_CAPI_DLL double LineGeometries_Get_EmergAmps (void)
 
DSS_CAPI_DLL void LineGeometries_Set_EmergAmps (double Value)
 
DSS_CAPI_DLL void LineGeometries_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void LineGeometries_Get_AllNames_GR (void)
 
DSS_CAPI_DLL int32_t LineSpacings_Get_Count (void)
 
DSS_CAPI_DLL int32_t LineSpacings_Get_First (void)
 
DSS_CAPI_DLL int32_t LineSpacings_Get_Next (void)
 
DSS_CAPI_DLL char * LineSpacings_Get_Name (void)
 
DSS_CAPI_DLL void LineSpacings_Set_Name (const char *Value)
 
DSS_CAPI_DLL int32_t LineSpacings_Get_Nconds (void)
 
DSS_CAPI_DLL void LineSpacings_Set_Nconds (int32_t Value)
 
DSS_CAPI_DLL int32_t LineSpacings_Get_Phases (void)
 
DSS_CAPI_DLL void LineSpacings_Set_Phases (int32_t Value)
 
DSS_CAPI_DLL int32_t LineSpacings_Get_Units (void)
 
DSS_CAPI_DLL void LineSpacings_Set_Units (int32_t Value)
 
DSS_CAPI_DLL void LineSpacings_Get_Xcoords (double **ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void LineSpacings_Get_Xcoords_GR (void)
 
DSS_CAPI_DLL void LineSpacings_Set_Xcoords (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL void LineSpacings_Get_Ycoords (double **ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void LineSpacings_Get_Ycoords_GR (void)
 
DSS_CAPI_DLL void LineSpacings_Set_Ycoords (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL void LineSpacings_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void LineSpacings_Get_AllNames_GR (void)
 
DSS_CAPI_DLL int32_t Loads_Get_Phases (void)
 
DSS_CAPI_DLL void Loads_Set_Phases (int32_t Integer)
 
DSS_CAPI_DLL void Reactors_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void Reactors_Get_AllNames_GR (void)
 
DSS_CAPI_DLL char * Reactors_Get_Name (void)
 
DSS_CAPI_DLL void Reactors_Set_Name (const char *Value)
 
DSS_CAPI_DLL int32_t Reactors_Get_First (void)
 
DSS_CAPI_DLL int32_t Reactors_Get_Next (void)
 
DSS_CAPI_DLL int32_t Reactors_Get_Count (void)
 
DSS_CAPI_DLL double Reactors_Get_kV (void)
 
DSS_CAPI_DLL void Reactors_Set_kV (double Value)
 
DSS_CAPI_DLL double Reactors_Get_kvar (void)
 
DSS_CAPI_DLL void Reactors_Set_kvar (double Value)
 
DSS_CAPI_DLL int32_t Reactors_Get_Phases (void)
 
DSS_CAPI_DLL void Reactors_Set_Phases (int32_t Integer)
 
DSS_CAPI_DLL uint16_t Reactors_Get_IsDelta (void)
 
DSS_CAPI_DLL void Reactors_Set_IsDelta (uint16_t Value)
 
DSS_CAPI_DLL uint16_t Reactors_Get_Parallel (void)
 
DSS_CAPI_DLL void Reactors_Set_Parallel (uint16_t Value)
 
DSS_CAPI_DLL double Reactors_Get_LmH (void)
 
DSS_CAPI_DLL void Reactors_Set_LmH (double Value)
 
DSS_CAPI_DLL char * Reactors_Get_Bus1 (void)
 
DSS_CAPI_DLL char * Reactors_Get_Bus2 (void)
 
DSS_CAPI_DLL void Reactors_Set_Bus1 (const char *Value)
 
DSS_CAPI_DLL void Reactors_Set_Bus2 (const char *Value)
 
DSS_CAPI_DLL double Reactors_Get_R (void)
 
DSS_CAPI_DLL void Reactors_Set_R (double Value)
 
DSS_CAPI_DLL double Reactors_Get_X (void)
 
DSS_CAPI_DLL void Reactors_Set_X (double Value)
 
DSS_CAPI_DLL double Reactors_Get_Rp (void)
 
DSS_CAPI_DLL void Reactors_Set_Rp (double Value)
 
DSS_CAPI_DLL char * Reactors_Get_RCurve (void)
 
DSS_CAPI_DLL void Reactors_Set_RCurve (const char *Value)
 
DSS_CAPI_DLL char * Reactors_Get_LCurve (void)
 
DSS_CAPI_DLL void Reactors_Set_LCurve (const char *Value)
 
DSS_CAPI_DLL void Reactors_Get_Rmatrix (double **ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void Reactors_Get_Rmatrix_GR (void)
 
DSS_CAPI_DLL void Reactors_Set_Rmatrix (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL void Reactors_Get_Xmatrix (double **ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void Reactors_Get_Xmatrix_GR (void)
 
DSS_CAPI_DLL void Reactors_Set_Xmatrix (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL void Reactors_Get_Z (double **ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void Reactors_Get_Z_GR (void)
 
DSS_CAPI_DLL void Reactors_Set_Z (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL void Reactors_Get_Z1 (double **ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void Reactors_Get_Z1_GR (void)
 
DSS_CAPI_DLL void Reactors_Set_Z1 (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL void Reactors_Get_Z2 (double **ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void Reactors_Get_Z2_GR (void)
 
DSS_CAPI_DLL void Reactors_Set_Z2 (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL void Reactors_Get_Z0 (double **ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void Reactors_Get_Z0_GR (void)
 
DSS_CAPI_DLL void Reactors_Set_Z0 (double *ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL int32_t Reactors_Get_SpecType (void)
 
DSS_CAPI_DLL int32_t TSData_Get_Count (void)
 
DSS_CAPI_DLL int32_t TSData_Get_First (void)
 
DSS_CAPI_DLL int32_t TSData_Get_Next (void)
 
DSS_CAPI_DLL char * TSData_Get_Name (void)
 
DSS_CAPI_DLL void TSData_Set_Name (const char *Value)
 
DSS_CAPI_DLL void TSData_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void TSData_Get_AllNames_GR (void)
 
DSS_CAPI_DLL double TSData_Get_Rdc (void)
 
DSS_CAPI_DLL void TSData_Set_Rdc (double Value)
 
DSS_CAPI_DLL double TSData_Get_Rac (void)
 
DSS_CAPI_DLL void TSData_Set_Rac (double Value)
 
DSS_CAPI_DLL double TSData_Get_GMRac (void)
 
DSS_CAPI_DLL void TSData_Set_GMRac (double Value)
 
DSS_CAPI_DLL int32_t TSData_Get_GMRUnits (void)
 
DSS_CAPI_DLL void TSData_Set_GMRUnits (int32_t Value)
 
DSS_CAPI_DLL double TSData_Get_Radius (void)
 
DSS_CAPI_DLL void TSData_Set_Radius (double Value)
 
DSS_CAPI_DLL int32_t TSData_Get_RadiusUnits (void)
 
DSS_CAPI_DLL void TSData_Set_RadiusUnits (int32_t Value)
 
DSS_CAPI_DLL int32_t TSData_Get_ResistanceUnits (void)
 
DSS_CAPI_DLL void TSData_Set_ResistanceUnits (int32_t Value)
 
DSS_CAPI_DLL double TSData_Get_Diameter (void)
 
DSS_CAPI_DLL void TSData_Set_Diameter (double Value)
 
DSS_CAPI_DLL double TSData_Get_NormAmps (void)
 
DSS_CAPI_DLL void TSData_Set_NormAmps (double Value)
 
DSS_CAPI_DLL double TSData_Get_EmergAmps (void)
 
DSS_CAPI_DLL void TSData_Set_EmergAmps (double Value)
 
DSS_CAPI_DLL double TSData_Get_EpsR (void)
 
DSS_CAPI_DLL void TSData_Set_EpsR (double Value)
 
DSS_CAPI_DLL double TSData_Get_InsLayer (void)
 
DSS_CAPI_DLL void TSData_Set_InsLayer (double Value)
 
DSS_CAPI_DLL double TSData_Get_DiaIns (void)
 
DSS_CAPI_DLL void TSData_Set_DiaIns (double Value)
 
DSS_CAPI_DLL double TSData_Get_DiaCable (void)
 
DSS_CAPI_DLL void TSData_Set_DiaCable (double Value)
 
DSS_CAPI_DLL double TSData_Get_DiaShield (void)
 
DSS_CAPI_DLL void TSData_Set_DiaShield (double Value)
 
DSS_CAPI_DLL double TSData_Get_TapeLayer (void)
 
DSS_CAPI_DLL void TSData_Set_TapeLayer (double Value)
 
DSS_CAPI_DLL double TSData_Get_TapeLap (void)
 
DSS_CAPI_DLL void TSData_Set_TapeLap (double Value)
 
DSS_CAPI_DLL int32_t WireData_Get_Count (void)
 
DSS_CAPI_DLL int32_t WireData_Get_First (void)
 
DSS_CAPI_DLL int32_t WireData_Get_Next (void)
 
DSS_CAPI_DLL char * WireData_Get_Name (void)
 
DSS_CAPI_DLL void WireData_Set_Name (const char *Value)
 
DSS_CAPI_DLL void WireData_Get_AllNames (char ***ResultPtr, int32_t *ResultCount)
 
DSS_CAPI_DLL void WireData_Get_AllNames_GR (void)
 
DSS_CAPI_DLL double WireData_Get_Rdc (void)
 
DSS_CAPI_DLL void WireData_Set_Rdc (double Value)
 
DSS_CAPI_DLL double WireData_Get_Rac (void)
 
DSS_CAPI_DLL void WireData_Set_Rac (double Value)
 
DSS_CAPI_DLL double WireData_Get_GMRac (void)
 
DSS_CAPI_DLL void WireData_Set_GMRac (double Value)
 
DSS_CAPI_DLL int32_t WireData_Get_GMRUnits (void)
 
DSS_CAPI_DLL void WireData_Set_GMRUnits (int32_t Value)
 
DSS_CAPI_DLL double WireData_Get_Radius (void)
 
DSS_CAPI_DLL void WireData_Set_Radius (double Value)
 
DSS_CAPI_DLL int32_t WireData_Get_RadiusUnits (void)
 
DSS_CAPI_DLL void WireData_Set_RadiusUnits (int32_t Value)
 
DSS_CAPI_DLL int32_t WireData_Get_ResistanceUnits (void)
 
DSS_CAPI_DLL void WireData_Set_ResistanceUnits (int32_t Value)
 
DSS_CAPI_DLL double WireData_Get_Diameter (void)
 
DSS_CAPI_DLL void WireData_Set_Diameter (double Value)
 
DSS_CAPI_DLL double WireData_Get_NormAmps (void)
 
DSS_CAPI_DLL void WireData_Set_NormAmps (double Value)
 
DSS_CAPI_DLL double WireData_Get_EmergAmps (void)
 
DSS_CAPI_DLL void WireData_Set_EmergAmps (double Value)
 
DSS_CAPI_DLL double WireData_Get_CapRadius (void)
 
DSS_CAPI_DLL void WireData_Set_CapRadius (double Value)
 
DSS_CAPI_DLL int32_t Bus_Get_Next (void)
 Set the next bus as active. More...
 
DSS_CAPI_DLL uint16_t Error_Get_EarlyAbort (void)
 Gets/sets the DSS script error-handling behavior. More...
 
DSS_CAPI_DLL void Error_Set_EarlyAbort (uint16_t Value)
 
DSS_CAPI_DLL uint16_t Error_Get_ExtendedErrors (void)
 Gets/controls the extended error behavior. More...
 
DSS_CAPI_DLL void Error_Set_ExtendedErrors (uint16_t Value)
 
DSS_CAPI_DLL int32_t CNData_Get_idx (void)
 
DSS_CAPI_DLL void CNData_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t CapControls_Get_idx (void)
 
DSS_CAPI_DLL void CapControls_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t Capacitors_Get_idx (void)
 
DSS_CAPI_DLL void Capacitors_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t GICSources_Get_idx (void)
 
DSS_CAPI_DLL void GICSources_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t ISources_Get_idx (void)
 
DSS_CAPI_DLL void ISources_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t LineCodes_Get_idx (void)
 
DSS_CAPI_DLL void LineCodes_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t LineGeometries_Get_idx (void)
 
DSS_CAPI_DLL void LineGeometries_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t LineSpacings_Get_idx (void)
 
DSS_CAPI_DLL void LineSpacings_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t Lines_Get_idx (void)
 
DSS_CAPI_DLL void Lines_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t LoadShapes_Get_idx (void)
 
DSS_CAPI_DLL void LoadShapes_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t Meters_Get_idx (void)
 
DSS_CAPI_DLL void Meters_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t Monitors_Get_idx (void)
 
DSS_CAPI_DLL void Monitors_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t Reactors_Get_idx (void)
 
DSS_CAPI_DLL void Reactors_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t RegControls_Get_idx (void)
 
DSS_CAPI_DLL void RegControls_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t Sensors_Get_idx (void)
 
DSS_CAPI_DLL void Sensors_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t SwtControls_Get_idx (void)
 
DSS_CAPI_DLL void SwtControls_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t TSData_Get_idx (void)
 
DSS_CAPI_DLL void TSData_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t Transformers_Get_idx (void)
 
DSS_CAPI_DLL void Transformers_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t Vsources_Get_idx (void)
 
DSS_CAPI_DLL void Vsources_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t WireData_Get_idx (void)
 
DSS_CAPI_DLL void WireData_Set_idx (int32_t Value)
 
DSS_CAPI_DLL int32_t XYCurves_Get_idx (void)
 
DSS_CAPI_DLL void XYCurves_Set_idx (int32_t Value)
 
DSS_CAPI_DLL void Circuit_Get_ElementLosses (double **ResultPtr, int32_t *ResultCount, int32_t *ElementsPtr, int32_t ElementsCount)
 Array of total losses (complex) in a selection of elements. More...
 
DSS_CAPI_DLL void Circuit_Get_ElementLosses_GR (int32_t *ElementsPtr, int32_t ElementsCount)
 Same as Circuit_Get_ElementLosses but using the global buffer interface for results.
 
DSS_CAPI_DLL void LoadShapes_Set_Points (int32_t Npts, void *HoursPtr, void *PMultPtr, void *QMultPtr, uint16_t ExternalMemory, uint16_t IsFloat32, int32_t Stride)
 Sets all numeric arrays for the active LoadShape. More...
 
DSS_CAPI_DLL void LoadShapes_UseFloat32 (void)
 Converts the current LoadShape data to float32/single precision. More...
 
DSS_CAPI_DLL void LoadShapes_UseFloat64 (void)
 Converts the current LoadShape data to float64/double precision. More...
 
DSS_CAPI_DLL void LoadShapes_Set_MaxP (double Value)
 kW value at the time of max power. More...
 
DSS_CAPI_DLL double LoadShapes_Get_MaxP (void)
 kW value at the time of max power. More...
 
DSS_CAPI_DLL void LoadShapes_Set_MaxQ (double Value)
 kW value at the time of max power. More...
 
DSS_CAPI_DLL double LoadShapes_Get_MaxQ (void)
 kvar value at the time of max kW power. More...
 
DSS_CAPI_DLL void CktElement_Get_NodeRef (int32_t **ResultPtr, int32_t *ResultCount)
 Array of integers, a copy of the internal NodeRef of the CktElement. More...
 
DSS_CAPI_DLL void CktElement_Get_NodeRef_GR (void)
 Same as CktElement_Get_NodeRef but using the global buffer interface for results.
 
DSS_CAPI_DLL uint16_t YMatrix_CheckConvergence (void)
 Update and return the convergence flag. More...
 
DSS_CAPI_DLL void YMatrix_SetGeneratordQdV (void)
 
DSS_CAPI_DLL uint16_t YMatrix_Get_LoadsNeedUpdating (void)
 
DSS_CAPI_DLL void YMatrix_Set_LoadsNeedUpdating (uint16_t Value)
 
DSS_CAPI_DLL uint16_t YMatrix_Get_SolutionInitialized (void)
 
DSS_CAPI_DLL void YMatrix_Set_SolutionInitialized (uint16_t Value)
 
DSS_CAPI_DLL int32_t YMatrix_Get_Iteration (void)
 
DSS_CAPI_DLL void YMatrix_Set_Iteration (int32_t Value)
 
DSS_CAPI_DLL void * YMatrix_Get_Handle (void)
 
DSS_CAPI_DLL void YMatrix_Set_SolverOptions (uint64_t opts)
 
DSS_CAPI_DLL uint64_t YMatrix_Get_SolverOptions (void)
 
DSS_CAPI_DLL void Text_CommandBlock (const char *Value)
 
DSS_CAPI_DLL void Text_CommandArray (const char **ValuePtr, int32_t ValueCount)
 
DSS_CAPI_DLL void ZIP_Open (const char *FileName)
 Opens and prepares a ZIP file to be used by the DSS text parser. More...
 
DSS_CAPI_DLL void ZIP_Redirect (const char *FileInZip)
 Runs a "Redirect" command inside the current (open) ZIP file. More...
 
DSS_CAPI_DLL uint16_t ZIP_Contains (const char *Name)
 Check if the given path name is present in the current ZIP file. More...
 
DSS_CAPI_DLL void ZIP_List (char ***ResultPtr, int32_t *ResultCount, const char *RegExp)
 List of strings consisting of all names match the regular expression provided in regexp. More...
 
DSS_CAPI_DLL void ZIP_Extract (int8_t **ResultPtr, int32_t *ResultCount, const char *FileName)
 Extracts the contents of the file "FileName" from the current (open) ZIP file. More...
 
DSS_CAPI_DLL void ZIP_Extract_GR (const char *FileName)
 
DSS_CAPI_DLL void ZIP_Close (void)
 Closes the current open ZIP file. More...
 
DSS_CAPI_DLL char * DSS_ExtractSchema (void *ctx)
 Functions for the new API. More...
 
DSS_CAPI_DLL void DSS_Dispose_String (char *S)
 
DSS_CAPI_DLL void DSS_Dispose_PPointer (void ***p)
 
DSS_CAPI_DLL void * Obj_New (void *ctx, int32_t ClsIdx, const char *Name, uint16_t Activate, uint16_t BeginEdit)
 
DSS_CAPI_DLL int32_t Obj_GetCount (void *ctx, int32_t ClsIdx)
 
DSS_CAPI_DLL void * Obj_GetHandleByName (void *ctx, int32_t ClsIdx, const char *Name)
 
DSS_CAPI_DLL void * Obj_GetHandleByIdx (void *ctx, int32_t ClsIdx, int32_t Idx)
 
DSS_CAPI_DLL uint16_t Obj_PropertySideEffects (void *obj, int32_t Index, int32_t PreviousInt)
 
DSS_CAPI_DLL void Obj_BeginEdit (void *obj)
 
DSS_CAPI_DLL void Obj_EndEdit (void *obj, int32_t NumChanges)
 
DSS_CAPI_DLL int32_t Obj_GetNumProperties (void *obj)
 
DSS_CAPI_DLL char * Obj_ToJSON (void *obj, int32_t options)
 Returns an element's data as a JSON-encoded string. More...
 
DSS_CAPI_DLL char * Batch_ToJSON (void **batch, int32_t batchSize, int32_t options)
 Returns the data (as a list) of the elements in a batch as a JSON-encoded string. More...
 
DSS_CAPI_DLL char * Obj_GetName (void *obj)
 Returns the object name (direct access, no copy is done, no disposal required by the user; read only!) More...
 
DSS_CAPI_DLL char * Obj_GetClassName (void *obj)
 Returns the object's class name (direct access, no copy is done, no disposal required by the user; read only!) More...
 
DSS_CAPI_DLL int32_t Obj_GetIdx (void *obj)
 
DSS_CAPI_DLL char * Obj_GetClassIdx (void *obj)
 
DSS_CAPI_DLL void Obj_Activate (void *obj, uint16_t AllLists)
 Activates an object. More...
 
DSS_CAPI_DLL int32_t * Obj_GetPropSeqPtr (void *obj)
 Returns the pointer to the internal property fill sequence. More...
 
DSS_CAPI_DLL double Obj_GetFloat64 (void *obj, int32_t Index)
 
DSS_CAPI_DLL int32_t Obj_GetInt32 (void *obj, int32_t Index)
 
DSS_CAPI_DLL void * Obj_GetObject (void *obj, int32_t Index)
 
DSS_CAPI_DLL char * Obj_GetString (void *obj, int32_t Index)
 
DSS_CAPI_DLL char * Obj_GetAsString (void *obj, int32_t Index)
 
DSS_CAPI_DLL void Obj_GetFloat64Array (double **ResultPtr, int32_t *ResultCount, void *obj, int32_t Index)
 
DSS_CAPI_DLL void Obj_GetInt32Array (int32_t **ResultPtr, int32_t *ResultCount, void *obj, int32_t Index)
 
DSS_CAPI_DLL void Obj_GetStringArray (char ***ResultPtr, int32_t *ResultCount, void *obj, int32_t Index)
 
DSS_CAPI_DLL void Obj_GetObjectArray (void ***ResultPtr, int32_t *ResultCount, void *obj, int32_t Index)
 
DSS_CAPI_DLL void Obj_SetAsString (void *obj, int32_t Index, const char *Value)
 
DSS_CAPI_DLL void Obj_SetFloat64 (void *obj, int32_t Index, double Value)
 
DSS_CAPI_DLL void Obj_SetInt32 (void *obj, int32_t Index, int32_t Value)
 
DSS_CAPI_DLL void Obj_SetString (void *obj, int32_t Index, const char *Value)
 
DSS_CAPI_DLL void Obj_SetObject (void *obj, int32_t Index, void *Value)
 
DSS_CAPI_DLL void Obj_SetFloat64Array (void *obj, int32_t Index, double *Value, int32_t ValueCount)
 
DSS_CAPI_DLL void Obj_SetInt32Array (void *obj, int32_t Index, int32_t *Value, int32_t ValueCount)
 
DSS_CAPI_DLL void Obj_SetStringArray (void *obj, int32_t Index, const char **Value, int32_t ValueCount)
 
DSS_CAPI_DLL void Obj_SetObjectArray (void *obj, int32_t Index, void **Value, int32_t ValueCount)
 
DSS_CAPI_DLL void Batch_Dispose (void **batch)
 
DSS_CAPI_DLL void Batch_BeginEdit (void **batch, int32_t batchSize)
 
DSS_CAPI_DLL void Batch_EndEdit (void **batch, int32_t batchSize, int32_t numEdits)
 
DSS_CAPI_DLL void Batch_GetPropSeq (int32_t **ResultPtr, int32_t *ResultCount, void **batch, int32_t batchSize)
 
DSS_CAPI_DLL void Batch_CreateFromNew (void *ctx, void ***ResultPtr, int32_t *ResultCount, int32_t clsid, const char **names, int32_t count, uint16_t BeginEdit)
 
DSS_CAPI_DLL void Batch_CreateByClass (void *ctx, void ***ResultPtr, int32_t *ResultCount, int32_t clsidx)
 
DSS_CAPI_DLL void Batch_CreateByRegExp (void *ctx, void ***ResultPtr, int32_t *ResultCount, int32_t clsidx, const char *re)
 
DSS_CAPI_DLL void Batch_CreateByIndex (void *ctx, void ***ResultPtr, int32_t *ResultCount, int32_t clsidx, int32_t *Value, int32_t ValueCount)
 
DSS_CAPI_DLL void Batch_CreateByInt32Property (void *ctx, void ***ResultPtr, int32_t *ResultCount, int32_t ClsIdx, int32_t idx, int32_t value)
 
DSS_CAPI_DLL void Batch_GetFloat64 (double **ResultPtr, int32_t *ResultCount, void **batch, int32_t batchSize, int32_t Index)
 
DSS_CAPI_DLL void Batch_GetInt32 (int32_t **ResultPtr, int32_t *ResultCount, void **batch, int32_t batchSize, int32_t Index)
 
DSS_CAPI_DLL void Batch_GetString (char ***ResultPtr, int32_t *ResultCount, void **batch, int32_t batchSize, int32_t Index)
 
DSS_CAPI_DLL void Batch_GetAsString (char ***ResultPtr, int32_t *ResultCount, void **batch, int32_t batchSize, int32_t Index)
 
DSS_CAPI_DLL void Batch_GetObject (void ***ResultPtr, int32_t *ResultCount, void **batch, int32_t batchSize, int32_t Index)
 
DSS_CAPI_DLL void Batch_Float64 (void **batch, int32_t batchSize, int32_t Index, int32_t Operation, double Value)
 
DSS_CAPI_DLL void Batch_Int32 (void **batch, int32_t batchSize, int32_t Index, int32_t Operation, int32_t Value)
 
DSS_CAPI_DLL void Batch_SetString (void **batch, int32_t batchSize, int32_t Index, const char *Value)
 
DSS_CAPI_DLL void Batch_SetObject (void **batch, int32_t batchSize, int32_t Index, const void *Value)
 
DSS_CAPI_DLL void Batch_SetFloat64Array (void **batch, int32_t batchSize, int32_t Index, double *Value)
 
DSS_CAPI_DLL void Batch_SetInt32Array (void **batch, int32_t batchSize, int32_t Index, int32_t *Value)
 
DSS_CAPI_DLL void Batch_SetStringArray (void **batch, int32_t batchSize, int32_t Index, const char **Value)
 
DSS_CAPI_DLL void Batch_SetObjectArray (void **batch, int32_t batchSize, int32_t Index, const void **Value)
 
DSS_CAPI_DLL void Batch_CreateFromNewS (void *ctx, void ***ResultPtr, int32_t *ResultCount, const char *clsname, const char **names, int32_t count, uint16_t BeginEdit)
 
DSS_CAPI_DLL void Batch_CreateByClassS (void *ctx, void ***ResultPtr, int32_t *ResultCount, const char *clsname)
 
DSS_CAPI_DLL void Batch_CreateByRegExpS (void *ctx, void ***ResultPtr, int32_t *ResultCount, const char *clsname, const char *re)
 
DSS_CAPI_DLL void Batch_CreateByIndexS (void *ctx, void ***ResultPtr, int32_t *ResultCount, const char *clsname, int32_t *Value, int32_t ValueCount)
 
DSS_CAPI_DLL void Batch_CreateByInt32PropertyS (void *ctx, void ***ResultPtr, int32_t *ResultCount, const char *clsname, const char *Name, int32_t value)
 
DSS_CAPI_DLL void Batch_GetFloat64S (double **ResultPtr, int32_t *ResultCount, void **batch, int32_t batchSize, const char *Name)
 
DSS_CAPI_DLL void Batch_GetInt32S (int32_t **ResultPtr, int32_t *ResultCount, void **batch, int32_t batchSize, const char *Name)
 
DSS_CAPI_DLL void Batch_GetStringS (char ***ResultPtr, int32_t *ResultCount, void **batch, int32_t batchSize, const char *Name)
 
DSS_CAPI_DLL void Batch_GetAsStringS (char ***ResultPtr, int32_t *ResultCount, void **batch, int32_t batchSize, const char *Name)
 
DSS_CAPI_DLL void Batch_GetObjectS (void ***ResultPtr, int32_t *ResultCount, void **batch, int32_t batchSize, const char *Name)
 
DSS_CAPI_DLL void Batch_Float64S (void **batch, int32_t batchSize, const char *Name, int32_t Operation, double Value)
 
DSS_CAPI_DLL void Batch_Int32S (void **batch, int32_t batchSize, const char *Name, int32_t Operation, int32_t Value)
 
DSS_CAPI_DLL void Batch_SetStringS (void **batch, int32_t batchSize, const char *Name, const char *Value)
 
DSS_CAPI_DLL void Batch_SetObjectS (void **batch, int32_t batchSize, const char *Name, const void *Value)
 
DSS_CAPI_DLL void Batch_SetFloat64ArrayS (void **batch, int32_t batchSize, const char *Name, double *Value)
 
DSS_CAPI_DLL void Batch_SetInt32ArrayS (void **batch, int32_t batchSize, const char *Name, int32_t *Value)
 
DSS_CAPI_DLL void Batch_SetStringArrayS (void **batch, int32_t batchSize, const char *Name, const char **Value)
 
DSS_CAPI_DLL void Batch_SetObjectArrayS (void **batch, int32_t batchSize, const char *Name, const void **Value)
 
DSS_CAPI_DLL void * DSS_BeginPascalThread (void *func, void *paramptr)
 DSS_BeginPascalThread can be used to start a new thread from the Pascal side. More...
 
DSS_CAPI_DLL void DSS_WaitPascalThread (void *handle)
 Use this function to wait for a thread started by DSS_BeginPascalThread to finish. More...
 
DSS_CAPI_DLL void DSS_SetMessagesMO (const char *Value)
 Loads the gettext MO file from the path indicated by Value, to be used for general OpenDSS messages. More...
 
DSS_CAPI_DLL void DSS_SetPropertiesMO (const char *Value)
 Loads the gettext MO file from the path indicated by Value, to be used for help of DSS properties. More...
 

Typedef Documentation

◆ dss_callback_plot_t

typedef int32_t(* dss_callback_plot_t) (void *ctx, char *jsonParams)

Function types for plotting and writing/message callbacks.

Receives a string that contains the JSON-encoded parameters.

EXPERIMENTAL

Enumeration Type Documentation

◆ ActionCodes

Enumerator
ActionCodes_none 

No action.

ActionCodes_Open 

Open a switch.

ActionCodes_Close 

Close a switch.

ActionCodes_Reset 

Reset to the shelf state (unlocked, closed for a switch)

ActionCodes_Lock 

Lock a switch, prventing both manual and automatic operation.

ActionCodes_Unlock 

Unlock a switch, permitting both manual and automatic operation.

ActionCodes_TapUp 

Move a regulator tap up.

ActionCodes_TapDown 

Move a regulator tap down.

◆ AutoAddTypes

Enumerator
AutoAddTypes_AddGen 

Solution_[Get/Set]_AddType.

Add generators in AutoAdd mode

AutoAddTypes_AddCap 

Add capacitors in AutoAdd mode.

◆ CapControlModes

Enumerator
CapControlModes_Current 

Current control, ON and OFF settings on CT secondary.

CapControlModes_Voltage 

Voltage control, ON and OFF settings on the PT secondary base.

CapControlModes_KVAR 

kVAR control, ON and OFF settings on PT / CT base

CapControlModes_Time 

Time control, ON and OFF settings are seconds from midnight.

CapControlModes_PF 

ON and OFF settings are power factor, negative for leading.

◆ CktModels

enum CktModels
Enumerator
CktModels_Multiphase 

Settings_[Get/Set]_CktModel.

Circuit model is multiphase (default)

CktModels_PositiveSeq 

Circuit model is positive sequence model only.

◆ ControlModes

Enumerator
ControlModes_Static 

Solution_[Get/Set]_ControlMode.

Control Mode option - Static

ControlModes_Event 

Control Mode Option - Event driven solution mode.

ControlModes_Time 

Control mode option - Time driven mode.

ControlModes_Multirate 

Control mode option - Multirate mode.

ControlModes_ControlOff 

Control Mode OFF.

◆ LineUnits

enum LineUnits
Enumerator
LineUnits_none 

No line length unit.

LineUnits_Miles 

Line length units in miles.

LineUnits_kFt 

Line length units are in thousand feet.

LineUnits_km 

Line length units are km.

LineUnits_meter 

Line length units are meters.

LineUnits_ft 

Line units in feet.

LineUnits_inch 

Line length units are inches.

LineUnits_cm 

Line units are cm.

LineUnits_mm 

Line length units are mm.

LineUnits_Maxnum 

Maximum number of line units constants.

◆ MonitorModes

Enumerator
MonitorModes_VI 

Monitor records Voltage and Current at the terminal (Default)

MonitorModes_Power 

Monitor records kW, kvar or kVA, angle values, etc. at the terminal to which it is connected.

MonitorModes_Taps 

For monitoring Regulator and Transformer taps.

MonitorModes_States 

For monitoring State Variables (for PC Elements only)

MonitorModes_Sequence 

Reports the monitored quantities as sequence quantities.

MonitorModes_Magnitude 

Reports the monitored quantities in Magnitude Only.

MonitorModes_PosOnly 

Reports the Positive Seq only or avg of all phases.

◆ RandomModes

Enumerator
RandomModes_Gaussian 

Solution_[Get/Set]_Random.

Gaussian

RandomModes_Uniform 

Uniform.

RandomModes_LogNormal 

Log normal.

◆ SolutionAlgorithms

Enumerator
SolutionAlgorithms_NormalSolve 

Solution_[Get/Set]_Algorithm.

Solution algorithm option - Normal solution mode

SolutionAlgorithms_NewtonSolve 

Solution algorithm option - Newton solution.

◆ SolutionLoadModels

Enumerator
SolutionLoadModels_PowerFlow 

Solution_[Get/Set]_LoadModel.

Power Flow load model option

SolutionLoadModels_Admittance 

Admittance load model option.

◆ SolveModes

enum SolveModes
Enumerator
SolveModes_SnapShot 

Solve a single snapshot power flow.

SolveModes_Daily 

Solve following Daily load shapes.

SolveModes_Yearly 

Solve following Yearly load shapes.

SolveModes_Monte1 

Monte Carlo Mode 1.

SolveModes_LD1 

Load-duration Mode 1.

SolveModes_PeakDay 

Solves for Peak Day using Daily load curve.

SolveModes_DutyCycle 

Solve following Duty Cycle load shapes.

SolveModes_Direct 

Solve direct (forced admittance model)

SolveModes_MonteFault 

Monte carlo Fault Study.

SolveModes_FaultStudy 

Fault study at all buses.

SolveModes_Monte2 

Monte Carlo Mode 2.

SolveModes_Monte3 

Monte Carlo Mode 3.

SolveModes_LD2 

Load-Duration Mode 2.

SolveModes_AutoAdd 

Auto add generators or capacitors.

SolveModes_Dynamic 

Solve for dynamics.

SolveModes_Harmonic 

Harmonic solution mode.

◆ SolverOptions

The values themselves are subject to change in future versions, use this enum for easier upgrades.

Enumerator
SolverOptions_ReuseCompressedMatrix 

Reuse only the prepared CSC matrix.

SolverOptions_ReuseSymbolicFactorization 

Reuse the symbolic factorization, implies ReuseCompressedMatrix.

SolverOptions_ReuseNumericFactorization 

Reuse the numeric factorization, implies ReuseSymbolicFactorization.

SolverOptions_AlwaysResetYPrimInvalid 

Bit flag, see CktElement.pas.

◆ StorageStates

Enumerator
StorageStates_Charging 

Storages_Set_State, Storages_Get_State.

◆ YMatrixModes

Enumerator
YMatrixModes_SeriesOnly 

Solution_BuildYMatrix, YMatrix_BuildYMatrixD.

Function Documentation

◆ ActiveClass_Get_Count()

DSS_CAPI_DLL int32_t ActiveClass_Get_Count ( void  )

Number of elements in Active Class.

Same as NumElements Property.

◆ ActiveClass_Get_First()

DSS_CAPI_DLL int32_t ActiveClass_Get_First ( void  )

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.

◆ ActiveClass_Get_Next()

DSS_CAPI_DLL int32_t ActiveClass_Get_Next ( void  )

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.

◆ ActiveClass_Get_NumElements()

DSS_CAPI_DLL int32_t ActiveClass_Get_NumElements ( void  )

Number of elements in this class.

Same as Count property.

◆ ActiveClass_ToJSON()

DSS_CAPI_DLL char * ActiveClass_ToJSON ( int32_t  options)

Returns the data (as a list) of all elements from the active class as a JSON-encoded string.

The options parameter contains bit-flags to toggle specific features. See Obj_ToJSON for more.

Additionally, the ExcludeDisabled flag can be used to excluded disabled elements from the output.

(API Extension)

◆ Batch_ToJSON()

DSS_CAPI_DLL char * Batch_ToJSON ( void **  batch,
int32_t  batchSize,
int32_t  options 
)

Returns the data (as a list) of the elements in a batch as a JSON-encoded string.

The options parameter contains bit-flags to toggle specific features. See Obj_ToJSON for more.

Additionally, the ExcludeDisabled flag can be used to excluded disabled elements from the output.

(API Extension)

◆ Bus_Get_Coorddefined()

DSS_CAPI_DLL uint16_t Bus_Get_Coorddefined ( void  )

False=0 else True.

Indicates whether a coordinate has been defined for this bus

◆ Bus_Get_Next()

DSS_CAPI_DLL int32_t Bus_Get_Next ( void  )

Set the next bus as active.

Returns -1 if no more buses, 0 otherwise.

(API Extension)

◆ Bus_Get_puVLL()

DSS_CAPI_DLL void Bus_Get_puVLL ( double **  ResultPtr,
int32_t *  ResultCount 
)

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.

◆ Bus_Get_TotalMiles()

DSS_CAPI_DLL double Bus_Get_TotalMiles ( void  )

Total length of line downline from this bus, in miles.

For recloser siting algorithm.

◆ Bus_Get_VLL()

DSS_CAPI_DLL void Bus_Get_VLL ( double **  ResultPtr,
int32_t *  ResultCount 
)

For 2- and 3-phase buses, returns array of complex numbers represetin L-L voltages in volts.

Returns -1.0 for 1-phase bus. If more than 3 phases, returns only first 3.

◆ Bus_Get_YscMatrix()

DSS_CAPI_DLL void Bus_Get_YscMatrix ( double **  ResultPtr,
int32_t *  ResultCount 
)

Complex array of Ysc matrix at bus.

Column by column.

◆ Bus_Get_ZscMatrix()

DSS_CAPI_DLL void Bus_Get_ZscMatrix ( double **  ResultPtr,
int32_t *  ResultCount 
)

Complex array of Zsc matrix at bus.

Column by column.

◆ Capacitors_Get_First()

DSS_CAPI_DLL int32_t Capacitors_Get_First ( void  )

Sets the first Capacitor active.

Returns 0 if no more.

◆ Capacitors_Get_kV()

DSS_CAPI_DLL double Capacitors_Get_kV ( void  )

Bank kV rating.

Use LL for 2 or 3 phases, or actual can rating for 1 phase.

◆ Capacitors_Get_Next()

DSS_CAPI_DLL int32_t Capacitors_Get_Next ( void  )

Sets the next Capacitor active.

Returns 0 if no more.

◆ Capacitors_Get_States()

DSS_CAPI_DLL void Capacitors_Get_States ( int32_t **  ResultPtr,
int32_t *  ResultCount 
)

A array of integer [0..numsteps-1] indicating state of each step.

If value is -1 an error has occurred.

◆ Capacitors_Set_kV()

DSS_CAPI_DLL void Capacitors_Set_kV ( double  Value)

Bank kV rating.

Use LL for 2 or 3 phases, or actual can rating for 1 phase.

◆ CapControls_Get_Delay()

DSS_CAPI_DLL double CapControls_Get_Delay ( void  )

Time delay [s] to switch on after arming.

Control may reset before actually switching.

◆ CapControls_Get_DelayOff()

DSS_CAPI_DLL double CapControls_Get_DelayOff ( void  )

Time delay [s] before swithcing off a step.

Control may reset before actually switching.

◆ CapControls_Get_First()

DSS_CAPI_DLL int32_t CapControls_Get_First ( void  )

Sets the first CapControl as active.

Return 0 if none.

◆ CapControls_Get_Next()

DSS_CAPI_DLL int32_t CapControls_Get_Next ( void  )

Gets the next CapControl in the circut.

Returns 0 if none.

◆ CapControls_Get_OFFSetting()

DSS_CAPI_DLL double CapControls_Get_OFFSetting ( void  )

Threshold to switch off a step.

See Mode for units.

◆ CapControls_Get_ONSetting()

DSS_CAPI_DLL double CapControls_Get_ONSetting ( void  )

Threshold to arm or switch on a step.

See Mode for units.

◆ CapControls_Set_Delay()

DSS_CAPI_DLL void CapControls_Set_Delay ( double  Value)

Time delay [s] to switch on after arming.

Control may reset before actually switching.

◆ CapControls_Set_DelayOff()

DSS_CAPI_DLL void CapControls_Set_DelayOff ( double  Value)

Time delay [s] before swithcing off a step.

Control may reset before actually switching.

◆ CapControls_Set_OFFSetting()

DSS_CAPI_DLL void CapControls_Set_OFFSetting ( double  Value)

Threshold to switch off a step.

See Mode for units.

◆ CapControls_Set_ONSetting()

DSS_CAPI_DLL void CapControls_Set_ONSetting ( double  Value)

Threshold to arm or switch on a step.

See Mode for units.

◆ Circuit_Get_AllBusDistances()

DSS_CAPI_DLL void Circuit_Get_AllBusDistances ( double **  ResultPtr,
int32_t *  ResultCount 
)

Returns distance from each bus to parent EnergyMeter.

Corresponds to sequence in AllBusNames.

◆ Circuit_Get_AllNodeDistances()

DSS_CAPI_DLL void Circuit_Get_AllNodeDistances ( double **  ResultPtr,
int32_t *  ResultCount 
)

Returns an array of distances from parent EnergyMeter for each Node.

Corresponds to AllBusVMag sequence.

◆ Circuit_Get_AllNodeDistancesByPhase()

DSS_CAPI_DLL void Circuit_Get_AllNodeDistancesByPhase ( double **  ResultPtr,
int32_t *  ResultCount,
int32_t  Phase 
)

Returns an array of doubles representing the distances to parent EnergyMeter.

Sequence of array corresponds to other node ByPhase properties.

◆ Circuit_Get_AllNodeNamesByPhase()

DSS_CAPI_DLL void Circuit_Get_AllNodeNamesByPhase ( char ***  ResultPtr,
int32_t *  ResultCount,
int32_t  Phase 
)

Return array of strings of the node names for the By Phase criteria.

Sequence corresponds to other ByPhase properties.

◆ Circuit_Get_ElementLosses()

DSS_CAPI_DLL void Circuit_Get_ElementLosses ( double **  ResultPtr,
int32_t *  ResultCount,
int32_t *  ElementsPtr,
int32_t  ElementsCount 
)

Array of total losses (complex) in a selection of elements.

Use the element indices (starting at 1) as parameter.

(API Extension)

◆ Circuit_Get_YCurrents()

DSS_CAPI_DLL void Circuit_Get_YCurrents ( double **  ResultPtr,
int32_t *  ResultCount 
)

Array of doubles containing complex injection currents for the present solution.

Is is the "I" vector of I=YV

◆ CktElement_Get_AllVariableNames()

DSS_CAPI_DLL void CktElement_Get_AllVariableNames ( char ***  ResultPtr,
int32_t *  ResultCount 
)

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

Otherwise, null string.

◆ CktElement_Get_AllVariableValues()

DSS_CAPI_DLL void CktElement_Get_AllVariableValues ( double **  ResultPtr,
int32_t *  ResultCount 
)

Array of doubles.

Values of state variables of active element if PC element.

◆ CktElement_Get_BusNames()

DSS_CAPI_DLL void CktElement_Get_BusNames ( char ***  ResultPtr,
int32_t *  ResultCount 
)

Array of strings.

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

◆ CktElement_Get_Controller()

DSS_CAPI_DLL char * CktElement_Get_Controller ( int32_t  idx)

Full name of the i-th controller attached to this element.

Ex: str = Controller(2). See NumControls to determine valid index range

◆ CktElement_Get_HasOCPDevice()

DSS_CAPI_DLL uint16_t CktElement_Get_HasOCPDevice ( void  )

True if a recloser, relay, or fuse controlling this ckt element.

OCP = Overcurrent Protection

◆ CktElement_Get_IsIsolated()

DSS_CAPI_DLL uint16_t CktElement_Get_IsIsolated ( void  )

Returns true if the current active element is isolated.

Note that this only fetches the current value. See also the Topology interface.

◆ CktElement_Get_NodeOrder()

DSS_CAPI_DLL void CktElement_Get_NodeOrder ( int32_t **  ResultPtr,
int32_t *  ResultCount 
)

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

Be sure to run a solution to initialize the values after the circuit is created or modified.

◆ CktElement_Get_NodeRef()

DSS_CAPI_DLL void CktElement_Get_NodeRef ( int32_t **  ResultPtr,
int32_t *  ResultCount 
)

Array of integers, a copy of the internal NodeRef of the CktElement.

(API Extension)

◆ CktElement_Get_NumControls()

DSS_CAPI_DLL int32_t CktElement_Get_NumControls ( void  )

Number of controls connected to this device.

Use to determine valid range for index into Controller array.

◆ CktElement_Get_Variable()

DSS_CAPI_DLL double CktElement_Get_Variable ( const char *  MyVarName,
int32_t *  Code 
)

For PCElement, set/get the value of a variable by name.

If Code>0 Then no variable by this name or not a PCelement.

◆ CktElement_Set_BusNames()

DSS_CAPI_DLL void CktElement_Set_BusNames ( const char **  ValuePtr,
int32_t  ValueCount 
)

Array of strings.

Set Bus definitions for each terminal is connected.

◆ CmathLib_Get_cdiv()

DSS_CAPI_DLL void CmathLib_Get_cdiv ( double **  ResultPtr,
int32_t *  ResultCount,
double  a1,
double  b1,
double  a2,
double  b2 
)

Divide two complex number: (a1, b1)/(a2, b2).

Returns array of two doubles representing complex result.

◆ CmathLib_Get_cmul()

DSS_CAPI_DLL void CmathLib_Get_cmul ( double **  ResultPtr,
int32_t *  ResultCount,
double  a1,
double  b1,
double  a2,
double  b2 
)

Multiply two complex numbers: (a1, b1) * (a2, b2).

Returns result as a array of two doubles.

◆ CmathLib_Get_ctopolardeg()

DSS_CAPI_DLL void CmathLib_Get_ctopolardeg ( double **  ResultPtr,
int32_t *  ResultCount,
double  RealPart,
double  ImagPart 
)

Convert complex number to magnitude and angle, degrees.

Returns array of two doubles.

◆ CmathLib_Get_pdegtocomplex()

DSS_CAPI_DLL void CmathLib_Get_pdegtocomplex ( double **  ResultPtr,
int32_t *  ResultCount,
double  magnitude,
double  angle 
)

Convert magnitude, angle in degrees to a complex number.

Returns Array of two doubles.

◆ CtrlQueue_Get_ActionCode()

DSS_CAPI_DLL int32_t CtrlQueue_Get_ActionCode ( void  )

Code for the active action.

Long integer code to tell the control device what to do

◆ CtrlQueue_Get_PopAction()

DSS_CAPI_DLL int32_t CtrlQueue_Get_PopAction ( void  )

Pops next action off the action list and makes it the active action.

Returns zero if none.

◆ CtrlQueue_Push()

DSS_CAPI_DLL int32_t CtrlQueue_Push ( int32_t  Hour,
double  Seconds,
int32_t  ActionCode,
int32_t  DeviceHandle 
)

Push a control action onto the DSS control queue by time, action code, and device handle (user defined).

Returns Control Queue handle.

◆ DSS_BeginPascalThread()

DSS_CAPI_DLL void * DSS_BeginPascalThread ( void *  func,
void *  paramptr 
)

DSS_BeginPascalThread can be used to start a new thread from the Pascal side.

Use this if you experience issues with your languages normal threads.

func is the address of the function that will be run in the thread. paramptr is a pointer to the data to pass as a parameter when calling func.

NOTE: this function will be removed in a future version if DSS C-API is reimplemented in another language.

(API Extension)

◆ DSS_ExtractSchema()

DSS_CAPI_DLL char * DSS_ExtractSchema ( void *  ctx)

Functions for the new API.

Extract the current properties as a JSON encoded string. WARNING: this is unstable and subject to change.

(API Extension)

◆ DSS_Get_AllowChangeDir()

DSS_CAPI_DLL uint16_t DSS_Get_AllowChangeDir ( void  )

If disabled, the engine will not change the active working directory during execution.

E.g. a "compile" command will not "chdir" to the file path.

If you have issues with long paths, enabling this might help in some scenarios.

Defaults to True (allow changes, backwards compatible) in the 0.12.x versions of DSS C-API. This might change to false in future versions.

This can also be set through the environment variable DSS_CAPI_ALLOW_CHANGE_DIR. Setting it to 0 to disallow changing the active working directory.

(API Extension)

◆ DSS_Get_AllowDOScmd()

DSS_CAPI_DLL uint16_t DSS_Get_AllowDOScmd ( void  )

If enabled, the DOScmd command is allowed.

Otherwise, an error is reported if the user tries to use it.

Defaults to False/0 (disabled state). Users should consider DOScmd deprecated on DSS Extensions.

This can also be set through the environment variable DSS_CAPI_ALLOW_DOSCMD. Setting it to 1 enables the command.

(API Extension)

◆ DSS_Get_AllowEditor()

DSS_CAPI_DLL uint16_t DSS_Get_AllowEditor ( void  )

Sets/gets the AllowEditor mode.

AllowEditor controls whether the external editor is used in commands like "Show". If you set to 0 (false), the editor is not executed. Note that other side effects, such as the creation of files, are not affected.

◆ DSS_Get_COMErrorResults()

DSS_CAPI_DLL uint16_t DSS_Get_COMErrorResults ( void  )

If enabled, in case of errors or empty arrays, the API returns arrays with values compatible with the official OpenDSS COM interface.

For example, consider the function Loads_Get_ZIPV. If there is no active circuit or active load element:

  • In the disabled state (COMErrorResults=False), the function will return "[]", an array with 0 elements.
  • In the enabled state (COMErrorResults=True), the function will return "[0.0]" instead. This should be compatible with the return value of the official COM interface.

Defaults to True/1 (enabled state) in the v0.12.x series. This will change to false in future series.

This can also be set through the environment variable DSS_CAPI_COM_DEFAULTS. Setting it to 0 disables the legacy/COM behavior. The value can be toggled through the API at any time.

(API Extension)

◆ DSS_Get_DataPath()

DSS_CAPI_DLL char * DSS_Get_DataPath ( void  )

DSS Data File Path.

Default path for reports, etc. from DSS

◆ DSS_Get_LegacyModels()

DSS_CAPI_DLL uint16_t DSS_Get_LegacyModels ( void  )

If enabled, the legacy/deprecated models for PVSystem, InvControl, Storage and StorageControl are used.

WARNING: Changing the active value runs a "Clear" command, discarding the current circuit.

Defaults to False/0 (disabled state).

This can also be set through the environment variable DSS_CAPI_LEGACY_MODELS. Setting it to 1 enables the legacy components, using the old models from the start.

(API Extension)

◆ DSS_GetGRPointers()

DSS_CAPI_DLL void DSS_GetGRPointers ( char ****  DataPtr_PPAnsiChar,
double ***  DataPtr_PDouble,
int32_t ***  DataPtr_PInteger,
int8_t ***  DataPtr_PByte,
int32_t **  CountPtr_PPAnsiChar,
int32_t **  CountPtr_PDouble,
int32_t **  CountPtr_PInteger,
int32_t **  CountPtr_PByte 
)

Get references to the global result (GR) pointers, used in the *_GR variations of most getter functions.

The returned values in the DataPtrs will contain pointers to the global variables that contains the actual pointers. The CountPtrs are not reallocated during the execution, so the returned values contain the actual pointer values.

◆ DSS_Set_DataPath()

DSS_CAPI_DLL void DSS_Set_DataPath ( const char *  Value)

DSS Data File Path.

Default path for reports, etc. from DSS

◆ DSS_SetMessagesMO()

DSS_CAPI_DLL void DSS_SetMessagesMO ( const char *  Value)

Loads the gettext MO file from the path indicated by Value, to be used for general OpenDSS messages.

On failure, messages are left as their default English versions as given in the main source-code in DSS C-API. No error is otherwise presented.

This function is not intended for the typical user.

(API Extension)

◆ DSS_SetPropertiesMO()

DSS_CAPI_DLL void DSS_SetPropertiesMO ( const char *  Value)

Loads the gettext MO file from the path indicated by Value, to be used for help of DSS properties.

On failure, the property help strings are left as "NO HELP OR DESCRIPTION AVAILABLE." No error is otherwise presented.

This function is not intended for the typical user.

(API Extension)

◆ DSS_Start()

DSS_CAPI_DLL uint16_t DSS_Start ( int32_t  code)

Runs potential initialization of internal structures of the DSS engine.

For DSS Extensions, users are required to call this function at least once per process, especially in multi-threaded applications.

Returns 0/false on failure. A failure might indicate an incompatibility between the Pascal threading system and the host process.

◆ DSS_WaitPascalThread()

DSS_CAPI_DLL void DSS_WaitPascalThread ( void *  handle)

Use this function to wait for a thread started by DSS_BeginPascalThread to finish.

NOTE: this function will be removed in a future version if DSS C-API is reimplemented in another language.

(API Extension)

◆ DSSElement_ToJSON()

DSS_CAPI_DLL char * DSSElement_ToJSON ( int32_t  options)

Returns the properties of the active DSS object as a JSON-encoded string.

The options parameter contains bit-flags to toggle specific features. See Obj_ToJSON for more.

(API Extension)

◆ Error_Get_EarlyAbort()

DSS_CAPI_DLL uint16_t Error_Get_EarlyAbort ( void  )

Gets/sets the DSS script error-handling behavior.

If a warning or error occurs and early abortion is enabled (default), the processing of the script is always halted. Otherwise, the processing of the script continues until a major error occurs or it finishes.

(API Extension)

◆ Error_Get_ExtendedErrors()

DSS_CAPI_DLL uint16_t Error_Get_ExtendedErrors ( void  )

Gets/controls the extended error behavior.

Extended errors are errors derived from checks across the API to ensure a valid state. Although many of these checks are already present in the original/official COM interface, the checks do not produce any error message. An error value can be returned by a function but this value can, for many of the functions, be a valid value. As such, the user has no means to detect an invalid API call.

Extended errors use the Error interface to provide a more clear message and should help users, especially new users, to find usage issues earlier.

The current default state is ON. For compatibility, the user can turn it off to restore the previous behavior.

(API Extension)

◆ Error_Get_NumberPtr()

DSS_CAPI_DLL int32_t * Error_Get_NumberPtr ( void  )

Integer pointer to the Error Number.

Remember to reset its value to zero after the error treatment.

◆ Fuses_Get_Delay()

DSS_CAPI_DLL double Fuses_Get_Delay ( void  )

A fixed delay time in seconds added to the fuse blowing time determined by the TCC curve.

Default is 0.

◆ Fuses_Get_First()

DSS_CAPI_DLL int32_t Fuses_Get_First ( void  )

Set the first Fuse to be the active fuse.

Returns 0 if none.

◆ Fuses_Get_idx()

DSS_CAPI_DLL int32_t Fuses_Get_idx ( void  )

Get/set active fuse by index into the list of fuses.

1 based: 1..count

◆ Fuses_Get_Next()

DSS_CAPI_DLL int32_t Fuses_Get_Next ( void  )

Advance the active Fuse element pointer to the next fuse.

Returns 0 if no more fuses.

◆ Fuses_Get_RatedCurrent()

DSS_CAPI_DLL double Fuses_Get_RatedCurrent ( void  )

Multiplier or actual amps for the TCCcurve object.

Defaults to 1.0. Multipliy current values of TCC curve by this to get actual amps.

◆ Fuses_Get_SwitchedObj()

DSS_CAPI_DLL char * Fuses_Get_SwitchedObj ( void  )

Full name of the circuit element switch that the fuse controls.

Defaults to the MonitoredObj.

◆ Fuses_IsBlown()

DSS_CAPI_DLL uint16_t Fuses_IsBlown ( void  )

Current state of the fuses.

TRUE if any fuse on any phase is blown. Else FALSE.

◆ Fuses_Set_idx()

DSS_CAPI_DLL void Fuses_Set_idx ( int32_t  Value)

Set Fuse active by index into the list of fuses.

1..count

◆ Fuses_Set_RatedCurrent()

DSS_CAPI_DLL void Fuses_Set_RatedCurrent ( double  Value)

Multiplier or actual fuse amps for the TCC curve.

Defaults to 1.0. Has to correspond to the Current axis of TCCcurve object.

◆ Fuses_Set_SwitchedObj()

DSS_CAPI_DLL void Fuses_Set_SwitchedObj ( const char *  Value)

Full name of the circuit element switch that the fuse controls.

Defaults to MonitoredObj.

◆ Generators_Get_Bus1()

DSS_CAPI_DLL char * Generators_Get_Bus1 ( void  )

Bus to which the Generator is connected.

May include specific node specification.

(API Extension)

◆ Generators_Get_Class_()

DSS_CAPI_DLL int32_t Generators_Get_Class_ ( void  )

An arbitrary integer number representing the class of Generator so that Generator values may be segregated by class.

(API Extension)

◆ Generators_Get_daily()

DSS_CAPI_DLL char * Generators_Get_daily ( void  )

Name of the loadshape for a daily generation profile.

(API Extension)

◆ Generators_Get_duty()

DSS_CAPI_DLL char * Generators_Get_duty ( void  )

Name of the loadshape for a duty cycle simulation.

(API Extension)

◆ Generators_Get_First()

DSS_CAPI_DLL int32_t Generators_Get_First ( void  )

Sets first Generator to be active.

Returns 0 if none.

◆ Generators_Get_idx()

DSS_CAPI_DLL int32_t Generators_Get_idx ( void  )

Get/Set active Generator by index into generators list.

1..Count

◆ Generators_Get_IsDelta()

DSS_CAPI_DLL uint16_t Generators_Get_IsDelta ( void  )

Generator connection.

True/1 if delta connection, False/0 if wye.

(API Extension)

◆ Generators_Get_kva()

DSS_CAPI_DLL double Generators_Get_kva ( void  )

kVA rating of electrical machine.

Applied to machine or inverter definition for Dynamics mode solutions.

(API Extension)

◆ Generators_Get_kvar()

DSS_CAPI_DLL double Generators_Get_kvar ( void  )

kvar output for the active generator.

Updates power factor based on present kW value.

◆ Generators_Get_kW()

DSS_CAPI_DLL double Generators_Get_kW ( void  )

kW output for the active generator.

kvar is updated for current power factor.

◆ Generators_Get_Next()

DSS_CAPI_DLL int32_t Generators_Get_Next ( void  )

Sets next Generator to be active.

Returns 0 if no more.

◆ Generators_Get_PF()

DSS_CAPI_DLL double Generators_Get_PF ( void  )

Power factor (pos.

= producing vars). Updates kvar based on present kW value.

◆ Generators_Get_Status()

DSS_CAPI_DLL int32_t Generators_Get_Status ( void  )

Response to dispatch multipliers: Fixed=1 (dispatch multipliers do not apply), Variable=0 (follows curves).

Related enumeration: GeneratorStatus

(API Extension)

◆ Generators_Get_Yearly()

DSS_CAPI_DLL char * Generators_Get_Yearly ( void  )

Name of yearly loadshape.

(API Extension)

◆ Generators_Set_idx()

DSS_CAPI_DLL void Generators_Set_idx ( int32_t  Value)

Get/Set active Generator by index into generators list.

1..Count

◆ Generators_Set_kvar()

DSS_CAPI_DLL void Generators_Set_kvar ( double  Value)

kvar output for the active generator.

Updates power factor based on present kW.

◆ Generators_Set_kW()

DSS_CAPI_DLL void Generators_Set_kW ( double  Value)

kW output for the active generator.

kvar is updated for current power factor

◆ Generators_Set_PF()

DSS_CAPI_DLL void Generators_Set_PF ( double  Value)

Power factor (pos.

= producing vars). Updates kvar based on present kW value.

◆ GICSources_Get_First()

DSS_CAPI_DLL int32_t GICSources_Get_First ( void  )

Invoking this property sets the first element active.

Returns 0 if no GICSources. Otherwise, index of the GICSource element.

◆ GICSources_Get_Next()

DSS_CAPI_DLL int32_t GICSources_Get_Next ( void  )

Invoking this property advances to the next GICSource element active.

Returns 0 if no more GICSources. Otherwise, index of the GICSource element.

◆ ISources_Get_Next()

DSS_CAPI_DLL int32_t ISources_Get_Next ( void  )

Sets the next ISOURCE element to be the active one.

Returns Zero if no more.

◆ Lines_Get_First()

DSS_CAPI_DLL int32_t Lines_Get_First ( void  )

Invoking this property sets the first element active.

Returns 0 if no lines. Otherwise, index of the line element.

◆ Lines_Get_IsSwitch()

DSS_CAPI_DLL uint16_t Lines_Get_IsSwitch ( void  )

Sets/gets the Line element switch status.

Setting it has side-effects to the line parameters.

◆ Lines_Get_Next()

DSS_CAPI_DLL int32_t Lines_Get_Next ( void  )

Invoking this property advances to the next Line element active.

Returns 0 if no more lines. Otherwise, index of the line element.

◆ Lines_Get_Parent()

DSS_CAPI_DLL int32_t Lines_Get_Parent ( void  )

Sets Parent of the active Line to be the active line.

Returns 0 if no parent or action fails.

◆ Lines_Get_Rmatrix()

DSS_CAPI_DLL void Lines_Get_Rmatrix ( double **  ResultPtr,
int32_t *  ResultCount 
)

Resistance matrix (full), ohms per unit length.

Array of doubles.

◆ Lines_Set_Rmatrix()

DSS_CAPI_DLL void Lines_Set_Rmatrix ( double *  ValuePtr,
int32_t  ValueCount 
)

Resistance matrix (full), ohms per unit length.

Array of doubles.

◆ Loads_Get_Cfactor()

DSS_CAPI_DLL double Loads_Get_Cfactor ( void  )

Factor relates average to peak kw.

Used for allocation with kwh and kwhdays/

◆ Loads_Get_CVRvars()

DSS_CAPI_DLL double Loads_Get_CVRvars ( void  )

Percent reduction in Q for percent reduction in V.

Must be used with LoadModelCVR.

◆ Loads_Get_CVRwatts()

DSS_CAPI_DLL double Loads_Get_CVRwatts ( void  )

Percent reduction in P for percent reduction in V.

Must be used with LoadModelCVR.

◆ Loads_Get_kV()

DSS_CAPI_DLL double Loads_Get_kV ( void  )

Set kV rating for active Load.

For 2 or more phases set Line-Line kV. Else actual kV across terminals.

◆ Loads_Get_kva()

DSS_CAPI_DLL double Loads_Get_kva ( void  )

Base load kva.

Also defined kw and kvar or pf input, or load allocation by kwh or xfkva.

◆ Loads_Get_kvar()

DSS_CAPI_DLL double Loads_Get_kvar ( void  )

Set kvar for active Load.

Updates PF based in present kW.

◆ Loads_Get_kW()

DSS_CAPI_DLL double Loads_Get_kW ( void  )

Set kW for active Load.

Updates kvar based on present PF.

◆ Loads_Get_kwh()

DSS_CAPI_DLL double Loads_Get_kwh ( void  )

kwh billed for this period.

Can be used with Cfactor for load allocation.

◆ Loads_Get_kwhdays()

DSS_CAPI_DLL double Loads_Get_kwhdays ( void  )

Length of kwh billing period for average demand calculation.

Default 30.

◆ Loads_Get_PF()

DSS_CAPI_DLL double Loads_Get_PF ( void  )

Set Power Factor for Active Load.

Specify leading PF as negative. Updates kvar based on kW value

◆ Loads_Get_Vmaxpu()

DSS_CAPI_DLL double Loads_Get_Vmaxpu ( void  )

Maximum per-unit voltage to use the load model.

Above this, constant Z applies.

◆ Loads_Get_Vminpu()

DSS_CAPI_DLL double Loads_Get_Vminpu ( void  )

Minimum voltage to apply the load model.

Below this, constant Z is used.

◆ Loads_Get_xfkVA()

DSS_CAPI_DLL double Loads_Get_xfkVA ( void  )

Rated service transformer kVA for load allocation, using AllocationFactor.

Affects kW, kvar, and pf.

◆ Loads_Set_kV()

DSS_CAPI_DLL void Loads_Set_kV ( double  Value)

Set kV rating for active Load.

For 2 or more phases set Line-Line kV. Else actual kV across terminals.

◆ Loads_Set_kvar()

DSS_CAPI_DLL void Loads_Set_kvar ( double  Value)

Set kvar for active Load.

Updates PF based on present kW.

◆ Loads_Set_kW()

DSS_CAPI_DLL void Loads_Set_kW ( double  Value)

Set kW for active Load.

Updates kvar based on present PF.

◆ Loads_Set_PF()

DSS_CAPI_DLL void Loads_Set_PF ( double  Value)

Set Power Factor for Active Load.

Specify leading PF as negative. Updates kvar based on present value of kW.

◆ LoadShapes_Get_First()

DSS_CAPI_DLL int32_t LoadShapes_Get_First ( void  )

Set the first loadshape active and return integer index of the loadshape.

Returns 0 if none.

◆ LoadShapes_Get_MaxP()

DSS_CAPI_DLL double LoadShapes_Get_MaxP ( void  )

kW value at the time of max power.

This is set automatically set upon reading in a loadshape, but for external-memory loadshapes, the user must provide the value. This property can also be used to override the value automatically computed or to retrieve the value computed.

(API Extension)

◆ LoadShapes_Get_MaxQ()

DSS_CAPI_DLL double LoadShapes_Get_MaxQ ( void  )

kvar value at the time of max kW power.

This is set automatically set upon reading in a loadshape, but for external-memory loadshapes, the user must provide the value. This property can also be used to override the value automatically computed or to retrieve the value computed.

(API Extension)

◆ LoadShapes_Get_Next()

DSS_CAPI_DLL int32_t LoadShapes_Get_Next ( void  )

Advance active Loadshape to the next on in the collection.

Returns 0 if no more loadshapes.

◆ LoadShapes_Get_Qbase()

DSS_CAPI_DLL double LoadShapes_Get_Qbase ( void  )

Base for normalizing Q curve.

If left at zero, the peak value is used.

◆ LoadShapes_Set_MaxP()

DSS_CAPI_DLL void LoadShapes_Set_MaxP ( double  Value)

kW value at the time of max power.

This is set automatically set upon reading in a loadshape, but for external-memory loadshapes, the user must provide the value. This property can also be used to override the value automatically computed or to retrieve the value computed.

(API Extension)

◆ LoadShapes_Set_MaxQ()

DSS_CAPI_DLL void LoadShapes_Set_MaxQ ( double  Value)

kW value at the time of max power.

This is set automatically set upon reading in a loadshape, but for external-memory loadshapes, the user must provide the value. This property can also be used to override the value automatically computed or to retrieve the value computed.

(API Extension)

◆ LoadShapes_Set_Points()

DSS_CAPI_DLL void LoadShapes_Set_Points ( int32_t  Npts,
void *  HoursPtr,
void *  PMultPtr,
void *  QMultPtr,
uint16_t  ExternalMemory,
uint16_t  IsFloat32,
int32_t  Stride 
)

Sets all numeric arrays for the active LoadShape.

If ExternalMemory is 0/False, the data is copied, allocating memory. If ExternalMemory is 1/True, the data is NOT copied. The caller is required to keep the pointers alive while the LoadShape is used, as well as deallocating them later.

If IsFloat32 is 0/False, the pointers are interpreted as pointers to float64/double precision numbers. Otherwise, the pointers are interpreted as pointers to float32/single precision numbers.

Stride: number of elements to skip to reach the next indexed element. Stride is only used when ExternalMemory is 1/True (ignored otherwise). For non-contiguous series and transposed data. Depending on how much that is used, a row-major matrix is preferred over a column-major one.

Remember to set MaxP and MaxQ accordingly.

(API Extension)

◆ LoadShapes_Set_Qbase()

DSS_CAPI_DLL void LoadShapes_Set_Qbase ( double  Value)

Base for normalizing Q curve.

If left at zero, the peak value is used.

◆ LoadShapes_UseFloat32()

DSS_CAPI_DLL void LoadShapes_UseFloat32 ( void  )

Converts the current LoadShape data to float32/single precision.

If there is no data or the data is already represented using float32, nothing is done.

(API Extension)

◆ LoadShapes_UseFloat64()

DSS_CAPI_DLL void LoadShapes_UseFloat64 ( void  )

Converts the current LoadShape data to float64/double precision.

If there is no data or the data is already represented using float64, nothing is done.

(API Extension)

◆ Meters_Get_CountBranches()

DSS_CAPI_DLL int32_t Meters_Get_CountBranches ( void  )

Number of branches in Active energymeter zone.

(Same as sequencelist size)

◆ Meters_Get_First()

DSS_CAPI_DLL int32_t Meters_Get_First ( void  )

Set the first energy Meter active.

Returns 0 if none.

◆ Meters_Get_Next()

DSS_CAPI_DLL int32_t Meters_Get_Next ( void  )

Sets the next energy Meter active.

Returns 0 if no more.

◆ Meters_Get_OCPDeviceType()

DSS_CAPI_DLL int32_t Meters_Get_OCPDeviceType ( void  )

Type of OCP device.

1=Fuse; 2=Recloser; 3=Relay

◆ Meters_Get_SAIDI()

DSS_CAPI_DLL double Meters_Get_SAIDI ( void  )

SAIDI for this meter's zone.

Execute DoReliabilityCalc first.

◆ Meters_Get_SAIFI()

DSS_CAPI_DLL double Meters_Get_SAIFI ( void  )

Returns SAIFI for this meter's Zone.

Execute Reliability Calc method first.

◆ Meters_Get_SAIFIKW()

DSS_CAPI_DLL double Meters_Get_SAIFIKW ( void  )

SAIFI based on kW rather than number of customers.

Get after reliability calcs.

◆ Meters_Get_SequenceIndex()

DSS_CAPI_DLL int32_t Meters_Get_SequenceIndex ( void  )

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.

◆ Meters_Set_SequenceIndex()

DSS_CAPI_DLL void Meters_Set_SequenceIndex ( int32_t  Value)

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.

◆ Monitors_Get_ByteStream()

DSS_CAPI_DLL void Monitors_Get_ByteStream ( int8_t **  ResultPtr,
int32_t *  ResultCount 
)

Byte Array containing monitor stream values.

Make sure a "save" is done first (standard solution modes do this automatically)

◆ Monitors_Get_Channel()

DSS_CAPI_DLL void Monitors_Get_Channel ( double **  ResultPtr,
int32_t *  ResultCount,
int32_t  Index 
)

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_Get_First()

DSS_CAPI_DLL int32_t Monitors_Get_First ( void  )

Sets the first Monitor active.

Returns 0 if no monitors.

◆ Monitors_Get_Next()

DSS_CAPI_DLL int32_t Monitors_Get_Next ( void  )

Sets next monitor active.

Returns 0 if no more.

◆ Monitors_Get_RecordSize()

DSS_CAPI_DLL int32_t Monitors_Get_RecordSize ( void  )

Size of each record in ByteStream (Integer).

Same as NumChannels.

◆ Obj_Activate()

DSS_CAPI_DLL void Obj_Activate ( void *  obj,
uint16_t  AllLists 
)

Activates an object.

The object is set as the current active DSSObject or CktElement, and in the list of its parent class. If AllLists is true, other internal lists of OpenDSS are also updated (implies slow/linear searches).

(API Extension)

◆ Obj_GetClassName()

DSS_CAPI_DLL char * Obj_GetClassName ( void *  obj)

Returns the object's class name (direct access, no copy is done, no disposal required by the user; read only!)

(API Extension)

◆ Obj_GetName()

DSS_CAPI_DLL char * Obj_GetName ( void *  obj)

Returns the object name (direct access, no copy is done, no disposal required by the user; read only!)

(API Extension)

◆ Obj_GetPropSeqPtr()

DSS_CAPI_DLL int32_t * Obj_GetPropSeqPtr ( void *  obj)

Returns the pointer to the internal property fill sequence.

First value (index 0) is what was previously known as "CurrentCount". Properties start at index 1.

(API Extension)

◆ Obj_ToJSON()

DSS_CAPI_DLL char * Obj_ToJSON ( void *  obj,
int32_t  options 
)

Returns an element's data as a JSON-encoded string.

The options parameter contains bit-flags to toggle specific features.

By default, only the properties explicitly set. The properties are returned in the order they are set in the input. As a reminder, OpenDSS is sensitive to the order of the properties.

The options bit-flags are available in the DSSJSONFlags enum. Values used by this function are:

  • Full: if set, all properties are returned, ordered by property index instead.
  • SkipRedundant: if used with Full, all properties except redundant and unused ones are returned.
  • EnumAsInt: enumerated properties are returned as integer values instead of strings.
  • FullNames: any element reference will use the full name ({class name}.{element name}) even if not required.
  • Pretty: more whitespace is used in the output for a "prettier" format.

    NOT IMPLEMENTED YET**:

  • State: include run-time state information
  • Debug: include debug information

Other bit-flags are reserved for future uses. Please use DSSJSONFlags enum to avoid potential conflicts.

(API Extension)

◆ Parser_Get_AutoIncrement()

DSS_CAPI_DLL uint16_t Parser_Get_AutoIncrement ( void  )

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.

◆ Parser_Get_BeginQuote()

DSS_CAPI_DLL char * Parser_Get_BeginQuote ( void  )

Get String containing the the characters for Quoting in OpenDSS scripts.

Matching pairs defined in EndQuote. Default is "'([{.

◆ Parser_Get_CmdString()

DSS_CAPI_DLL char * Parser_Get_CmdString ( void  )

String to be parsed.

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

◆ Parser_Get_Delimiters()

DSS_CAPI_DLL char * Parser_Get_Delimiters ( void  )

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.

◆ Parser_Get_EndQuote()

DSS_CAPI_DLL char * Parser_Get_EndQuote ( void  )

String containing characters, in order, that match the beginning quote characters in BeginQuote.

Default is "')]}

◆ Parser_Get_Matrix()

DSS_CAPI_DLL void Parser_Get_Matrix ( double **  ResultPtr,
int32_t *  ResultCount,
int32_t  ExpectedOrder 
)

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_Get_NextParam()

DSS_CAPI_DLL char * Parser_Get_NextParam ( void  )

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

See AutoIncrement.

◆ Parser_Get_SymMatrix()

DSS_CAPI_DLL void Parser_Get_SymMatrix ( double **  ResultPtr,
int32_t *  ResultCount,
int32_t  ExpectedOrder 
)

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

Symmetry is forced.

◆ Parser_Get_Vector()

DSS_CAPI_DLL void Parser_Get_Vector ( double **  ResultPtr,
int32_t *  ResultCount,
int32_t  ExpectedSize 
)

Returns token as array of doubles.

For parsing quoted array syntax.

◆ Parser_Get_WhiteSpace()

DSS_CAPI_DLL char * Parser_Get_WhiteSpace ( void  )

Get the characters used for White space in the command string.

Default is blank and Tab.

◆ Parser_Set_AutoIncrement()

DSS_CAPI_DLL void Parser_Set_AutoIncrement ( uint16_t  Value)

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.

◆ Parser_Set_BeginQuote()

DSS_CAPI_DLL void Parser_Set_BeginQuote ( const char *  Value)

Set String containing the the characters for Quoting in OpenDSS scripts.

Matching pairs defined in EndQuote. Default is "'([{.

◆ Parser_Set_CmdString()

DSS_CAPI_DLL void Parser_Set_CmdString ( const char *  Value)

String to be parsed.

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

◆ Parser_Set_Delimiters()

DSS_CAPI_DLL void Parser_Set_Delimiters ( const char *  Value)

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.

◆ Parser_Set_EndQuote()

DSS_CAPI_DLL void Parser_Set_EndQuote ( const char *  Value)

String containing characters, in order, that match the beginning quote characters in BeginQuote.

Default is "')]}

◆ Parser_Set_WhiteSpace()

DSS_CAPI_DLL void Parser_Set_WhiteSpace ( const char *  Value)

Set the characters used for White space in the command string.

Default is blank and Tab.

◆ PDElements_Get_AllCplxSeqCurrents()

DSS_CAPI_DLL void PDElements_Get_AllCplxSeqCurrents ( double **  ResultPtr,
int32_t *  ResultCount 
)

Complex double array of Sequence Currents for all conductors of all terminals, for each PD elements.

(API Extension)

◆ PDElements_Get_AllCurrents()

DSS_CAPI_DLL void PDElements_Get_AllCurrents ( double **  ResultPtr,
int32_t *  ResultCount 
)

Complex array of currents for all conductors, all terminals, for each PD element.

(API Extension)

◆ PDElements_Get_AllCurrentsMagAng()

DSS_CAPI_DLL void PDElements_Get_AllCurrentsMagAng ( double **  ResultPtr,
int32_t *  ResultCount 
)

Complex array (magnitude and angle format) of currents for all conductors, all terminals, for each PD element.

(API Extension)

◆ PDElements_Get_AllMaxCurrents()

DSS_CAPI_DLL void PDElements_Get_AllMaxCurrents ( double **  ResultPtr,
int32_t *  ResultCount,
uint16_t  AllNodes 
)

Array of doubles with the maximum current across the conductors, for each PD element.

By default, only the first terminal is used for the maximum current, matching the behavior of the "export capacity" command. Pass AllNodes=True to force the analysis to all terminals.

See also: https://sourceforge.net/p/electricdss/discussion/beginners/thread/da5b93ca/

(API Extension)

◆ PDElements_Get_AllNames()

DSS_CAPI_DLL void PDElements_Get_AllNames ( char ***  ResultPtr,
int32_t *  ResultCount 
)

Array of strings consisting of all PD element names.

(API Extension)

◆ PDElements_Get_AllNumConductors()

DSS_CAPI_DLL void PDElements_Get_AllNumConductors ( int32_t **  ResultPtr,
int32_t *  ResultCount 
)

Integer array listing the number of conductors of all PD elements.

(API Extension)

◆ PDElements_Get_AllNumPhases()

DSS_CAPI_DLL void PDElements_Get_AllNumPhases ( int32_t **  ResultPtr,
int32_t *  ResultCount 
)

Integer array listing the number of phases of all PD elements.

(API Extension)

◆ PDElements_Get_AllNumTerminals()

DSS_CAPI_DLL void PDElements_Get_AllNumTerminals ( int32_t **  ResultPtr,
int32_t *  ResultCount 
)

Integer array listing the number of terminals of all PD elements.

(API Extension)

◆ PDElements_Get_AllPctEmerg()

DSS_CAPI_DLL void PDElements_Get_AllPctEmerg ( double **  ResultPtr,
int32_t *  ResultCount,
uint16_t  AllNodes 
)

Array of doubles with the maximum current across the conductors as a percentage of the Emergency Ampere Rating, for each PD element.

By default, only the first terminal is used for the maximum current, matching the behavior of the "export capacity" command. Pass AllNodes=True to force the analysis to all terminals.

See also: https://sourceforge.net/p/electricdss/discussion/beginners/thread/da5b93ca/

(API Extension)

◆ PDElements_Get_AllPctNorm()

DSS_CAPI_DLL void PDElements_Get_AllPctNorm ( double **  ResultPtr,
int32_t *  ResultCount,
uint16_t  AllNodes 
)

Array of doubles with the maximum current across the conductors as a percentage of the Normal Ampere Rating, for each PD element.

By default, only the first terminal is used for the maximum current, matching the behavior of the "export capacity" command. Pass AllNodes=True to force the analysis to all terminals.

See also: https://sourceforge.net/p/electricdss/discussion/beginners/thread/da5b93ca/

(API Extension)

◆ PDElements_Get_AllPowers()

DSS_CAPI_DLL void PDElements_Get_AllPowers ( double **  ResultPtr,
int32_t *  ResultCount 
)

Complex array of powers into each conductor of each terminal, for each PD element.

(API Extension)

◆ PDElements_Get_AllSeqCurrents()

DSS_CAPI_DLL void PDElements_Get_AllSeqCurrents ( double **  ResultPtr,
int32_t *  ResultCount 
)

Double array of the symmetrical component currents into each 3-phase terminal, for each PD element.

(API Extension)

◆ PDElements_Get_AllSeqPowers()

DSS_CAPI_DLL void PDElements_Get_AllSeqPowers ( double **  ResultPtr,
int32_t *  ResultCount 
)

Double array of sequence powers into each 3-phase teminal, for each PD element.

(API Extension)

◆ PDElements_Get_FaultRate()

DSS_CAPI_DLL double PDElements_Get_FaultRate ( void  )

Get/Set Number of failures per year.

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

◆ PDElements_Get_First()

DSS_CAPI_DLL int32_t PDElements_Get_First ( void  )

Set the first enabled PD element to be the active element.

Returns 0 if none found.

◆ PDElements_Get_FromTerminal()

DSS_CAPI_DLL int32_t PDElements_Get_FromTerminal ( void  )

Number of the terminal of active PD element that is on the "from" side.

This is set after the meter zone is determined.

◆ PDElements_Get_IsShunt()

DSS_CAPI_DLL uint16_t PDElements_Get_IsShunt ( void  )

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.

◆ PDElements_Get_Lambda()

DSS_CAPI_DLL double PDElements_Get_Lambda ( void  )

Failure rate for this branch.

Faults per year including length of line.

◆ PDElements_Get_Name()

DSS_CAPI_DLL char * PDElements_Get_Name ( void  )

Get/Set name of active PD Element.

Returns null string if active element is not PDElement type.

◆ PDElements_Get_Next()

DSS_CAPI_DLL int32_t PDElements_Get_Next ( void  )

Advance to the next PD element in the circuit.

Enabled elements only. Returns 0 when no more elements.

◆ PDElements_Get_ParentPDElement()

DSS_CAPI_DLL int32_t PDElements_Get_ParentPDElement ( void  )

Sets the parent PD element to be the active circuit element.

Returns 0 if no more elements upline.

◆ PDElements_Get_pctPermanent()

DSS_CAPI_DLL double PDElements_Get_pctPermanent ( void  )

Get/Set percent of faults that are permanent (require repair).

Otherwise, fault is assumed to be transient/temporary.

◆ PDElements_Get_TotalMiles()

DSS_CAPI_DLL double PDElements_Get_TotalMiles ( void  )

Total miles of line from this element to the end of the zone.

For recloser siting algorithm.

◆ PVSystems_Get_daily()

DSS_CAPI_DLL char * PVSystems_Get_daily ( void  )

Name of the dispatch shape to use for daily simulations.

Must be previously defined as a Loadshape object of 24 hrs, typically. In the default dispatch mode, the PVSystem element uses this loadshape to trigger State changes.

◆ PVSystems_Get_duty()

DSS_CAPI_DLL char * PVSystems_Get_duty ( void  )

Name of the load shape to use for duty cycle dispatch simulations such as for solar ramp rate studies.

Must be previously defined as a Loadshape object. Typically would have time intervals of 1-5 seconds.

◆ PVSystems_Get_IrradianceNow()

DSS_CAPI_DLL double PVSystems_Get_IrradianceNow ( void  )

Returns the current irradiance value for the active PVSystem.

Use it to know what's the current irradiance value for the PV during a simulation.

◆ PVSystems_Get_Tdaily()

DSS_CAPI_DLL char * PVSystems_Get_Tdaily ( void  )

Temperature shape to use for daily simulations.

Must be previously defined as a TShape object of 24 hrs, typically. The PVSystem element uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

◆ PVSystems_Get_Tduty()

DSS_CAPI_DLL char * PVSystems_Get_Tduty ( void  )

Temperature shape to use for duty cycle dispatch simulations such as for solar ramp rate studies.

Must be previously defined as a TShape object. Typically would have time intervals of 1-5 seconds. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat. The PVSystem model uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

◆ PVSystems_Get_Tyearly()

DSS_CAPI_DLL char * PVSystems_Get_Tyearly ( void  )

Temperature shape to use for yearly simulations.

Must be previously defined as a TShape object. If this is not specified, the Daily dispatch shape, if any, is repeated during Yearly solution modes. The PVSystem element uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

◆ PVSystems_Get_yearly()

DSS_CAPI_DLL char * PVSystems_Get_yearly ( void  )

Dispatch shape to use for yearly simulations.

Must be previously defined as a Loadshape object. If this is not specified, the Daily dispatch shape, if any, is repeated during Yearly solution modes. In the default dispatch mode, the PVSystem element uses this loadshape to trigger State changes.

◆ PVSystems_Set_idx()

DSS_CAPI_DLL void PVSystems_Set_idx ( int32_t  Value)

Get/Set Active PVSystem by index: 1.

. Count

◆ Reclosers_Close()

DSS_CAPI_DLL void Reclosers_Close ( void  )

Close the switched object controlled by the recloser.

Resets recloser to first operation.

◆ Reclosers_Get_First()

DSS_CAPI_DLL int32_t Reclosers_Get_First ( void  )

Set First Recloser to be Active Ckt Element.

Returns 0 if none.

◆ Reclosers_Get_idx()

DSS_CAPI_DLL int32_t Reclosers_Get_idx ( void  )

Get/Set the active Recloser by index into the recloser list.

1..Count

◆ Reclosers_Get_Next()

DSS_CAPI_DLL int32_t Reclosers_Get_Next ( void  )

Iterate to the next recloser in the circuit.

Returns zero if no more.

◆ Reclosers_Get_State()

DSS_CAPI_DLL int32_t Reclosers_Get_State ( void  )

Get/Set present state of recloser.

If set to open (ActionCodes.Open=1), open recloser's controlled element and lock out the recloser. If set to close (ActionCodes.Close=2), close recloser's controlled element and resets recloser to first operation.

◆ Reclosers_Reset()

DSS_CAPI_DLL void Reclosers_Reset ( void  )

Reset recloser to normal state.

If open, lock out the recloser. If closed, resets recloser to first operation.

◆ Reclosers_Set_idx()

DSS_CAPI_DLL void Reclosers_Set_idx ( int32_t  Value)

Get/Set the Active Recloser by index into the recloser list.

1..Count

◆ Reclosers_Set_State()

DSS_CAPI_DLL void Reclosers_Set_State ( int32_t  Value)

Get/Set present state of recloser.

If set to open (ActionCodes.Open=1), open recloser's controlled element and lock out the recloser. If set to close (ActionCodes.Close=2), close recloser's controlled element and resets recloser to first operation.

◆ RegControls_Get_Delay()

DSS_CAPI_DLL double RegControls_Get_Delay ( void  )

Time delay [s] after arming before the first tap change.

Control may reset before actually changing taps.

◆ RegControls_Get_First()

DSS_CAPI_DLL int32_t RegControls_Get_First ( void  )

Sets the first RegControl active.

Returns 0 if none.

◆ RegControls_Get_IsReversible()

DSS_CAPI_DLL uint16_t RegControls_Get_IsReversible ( void  )

Regulator can use different settings in the reverse direction.

Usually not applicable to substation transformers.

◆ RegControls_Get_MaxTapChange()

DSS_CAPI_DLL int32_t RegControls_Get_MaxTapChange ( void  )

Maximum tap change per iteration in STATIC solution mode.

1 is more realistic, 16 is the default for a faster soluiton.

◆ RegControls_Get_Next()

DSS_CAPI_DLL int32_t RegControls_Get_Next ( void  )

Sets the next RegControl active.

Returns 0 if none.

◆ RegControls_Get_TapDelay()

DSS_CAPI_DLL double RegControls_Get_TapDelay ( void  )

Time delay [s] for subsequent tap changes in a set.

Control may reset before actually changing taps.

◆ RegControls_Get_VoltageLimit()

DSS_CAPI_DLL double RegControls_Get_VoltageLimit ( void  )

First house voltage limit on PT secondary base.

Setting to 0 disables this function.

◆ RegControls_Set_Delay()

DSS_CAPI_DLL void RegControls_Set_Delay ( double  Value)

Time delay [s] after arming before the first tap change.

Control may reset before actually changing taps.

◆ RegControls_Set_IsReversible()

DSS_CAPI_DLL void RegControls_Set_IsReversible ( uint16_t  Value)

Regulator can use different settings in the reverse direction.

Usually not applicable to substation transformers.

◆ RegControls_Set_MaxTapChange()

DSS_CAPI_DLL void RegControls_Set_MaxTapChange ( int32_t  Value)

Maximum tap change per iteration in STATIC solution mode.

1 is more realistic, 16 is the default for a faster soluiton.

◆ RegControls_Set_TapDelay()

DSS_CAPI_DLL void RegControls_Set_TapDelay ( double  Value)

Time delay [s] for subsequent tap changes in a set.

Control may reset before actually changing taps.

◆ RegControls_Set_VoltageLimit()

DSS_CAPI_DLL void RegControls_Set_VoltageLimit ( double  Value)

First house voltage limit on PT secondary base.

Setting to 0 disables this function.

◆ Relays_Close()

DSS_CAPI_DLL void Relays_Close ( void  )

Close the switched object controlled by the relay.

Resets relay to first operation.

◆ Relays_Get_First()

DSS_CAPI_DLL int32_t Relays_Get_First ( void  )

Set First Relay active.

If none, returns 0.

◆ Relays_Get_idx()

DSS_CAPI_DLL int32_t Relays_Get_idx ( void  )

Get/Set active Relay by index into the Relay list.

1..Count

◆ Relays_Get_Next()

DSS_CAPI_DLL int32_t Relays_Get_Next ( void  )

Advance to next Relay object.

Returns 0 when no more relays.

◆ Relays_Get_State()

DSS_CAPI_DLL int32_t Relays_Get_State ( void  )

Get/Set present state of relay.

If set to open (ActionCodes.Open = 1), open relay's controlled element and lock out the relay. If set to close (ActionCodes.Close = 2), close relay's controlled element and resets relay to first operation.

◆ Relays_Reset()

DSS_CAPI_DLL void Relays_Reset ( void  )

Reset relay to normal state.

If open, lock out the relay. If closed, resets relay to first operation.

◆ Relays_Set_idx()

DSS_CAPI_DLL void Relays_Set_idx ( int32_t  Value)

Get/Set Relay active by index into relay list.

1..Count

◆ Relays_Set_State()

DSS_CAPI_DLL void Relays_Set_State ( int32_t  Value)

Get/Set present state of relay.

If set to open (ActionCodes.Open = 1), open relay's controlled element and lock out the relay. If set to close (ActionCodes.Close = 2), close relay's controlled element and resets relay to first operation.

◆ Sensors_Get_First()

DSS_CAPI_DLL int32_t Sensors_Get_First ( void  )

Sets the first sensor active.

Returns 0 if none.

◆ Sensors_Get_IsDelta()

DSS_CAPI_DLL uint16_t Sensors_Get_IsDelta ( void  )

True if measured voltages are line-line.

Currents are always line currents.

◆ Sensors_Get_kVARS()

DSS_CAPI_DLL void Sensors_Get_kVARS ( double **  ResultPtr,
int32_t *  ResultCount 
)

Array of doubles for Q measurements.

Overwrites Currents with a new estimate using kWS.

◆ Sensors_Get_kVbase()

DSS_CAPI_DLL double Sensors_Get_kVbase ( void  )

Voltage base for the sensor measurements.

LL for 2 and 3-phase sensors, LN for 1-phase sensors.

◆ Sensors_Get_kWS()

DSS_CAPI_DLL void Sensors_Get_kWS ( double **  ResultPtr,
int32_t *  ResultCount 
)

Array of doubles for P measurements.

Overwrites Currents with a new estimate using kVARS.

◆ Sensors_Get_Next()

DSS_CAPI_DLL int32_t Sensors_Get_Next ( void  )

Sets the next Sensor active.

Returns 0 if no more.

◆ Sensors_Get_PctError()

DSS_CAPI_DLL double Sensors_Get_PctError ( void  )

Assumed percent error in the Sensor measurement.

Default is 1.

◆ Sensors_Get_Weight()

DSS_CAPI_DLL double Sensors_Get_Weight ( void  )

Weighting factor for this Sensor measurement with respect to other Sensors.

Default is 1.

◆ Settings_Get_IterateDisabled()

DSS_CAPI_DLL int32_t Settings_Get_IterateDisabled ( void  )

Controls whether First/Next iteration includes or skips disabled circuit elements.

The default behavior from OpenDSS is to skip those. The user can still activate the element by name or index.

The default value for IterateDisabled is 0, keeping the original behavior. Set it to 1 (or True) to include disabled elements. Other numeric values are reserved for other potential behaviors.

(API Extension)

◆ Settings_Get_LoadsTerminalCheck()

DSS_CAPI_DLL uint16_t Settings_Get_LoadsTerminalCheck ( void  )

Controls whether the terminals are checked when updating the currents in Load component.

Defaults to True. If the loads are guaranteed to have their terminals closed throughout the simulation, this can be set to False to save some time.

(API Extension)

◆ Solution_Get_Iterations()

DSS_CAPI_DLL int32_t Solution_Get_Iterations ( void  )

Number of iterations taken for last solution.

(Same as TotalIterations)

◆ Storages_Get_First()

DSS_CAPI_DLL int32_t Storages_Get_First ( void  )

Sets first Storage to be active.

Returns 0 if none.

◆ Storages_Get_idx()

DSS_CAPI_DLL int32_t Storages_Get_idx ( void  )

Get/Set active Storage by index into Storages list.

1..Count

◆ Storages_Get_Next()

DSS_CAPI_DLL int32_t Storages_Get_Next ( void  )

Sets next Storage to be active.

Returns 0 if no more.

◆ Storages_Get_State()

DSS_CAPI_DLL int32_t Storages_Get_State ( void  )

Get/set state: 0=Idling; 1=Discharging; -1=Charging;.

Related enumeration: StorageStates

◆ Storages_Set_idx()

DSS_CAPI_DLL void Storages_Set_idx ( int32_t  Value)

Get/Set active Storage by index into Storages list.

1..Count

◆ Storages_Set_State()

DSS_CAPI_DLL void Storages_Set_State ( int32_t  Value)

Get/set state: 0=Idling; 1=Discharging; -1=Charging;.

Related enumeration: StorageStates

◆ SwtControls_Get_Action()

DSS_CAPI_DLL int32_t SwtControls_Get_Action ( void  )

Open or Close the switch.

No effect if switch is locked. However, Reset removes any lock and then closes the switch (shelf state).

◆ SwtControls_Get_Delay()

DSS_CAPI_DLL double SwtControls_Get_Delay ( void  )

Time delay [s] betwen arming and opening or closing the switch.

Control may reset before actually operating the switch.

◆ SwtControls_Get_First()

DSS_CAPI_DLL int32_t SwtControls_Get_First ( void  )

Sets the first SwtControl active.

Returns 0 if no more.

◆ SwtControls_Get_Next()

DSS_CAPI_DLL int32_t SwtControls_Get_Next ( void  )

Sets the next SwtControl active.

Returns 0 if no more.

◆ SwtControls_Set_Action()

DSS_CAPI_DLL void SwtControls_Set_Action ( int32_t  Value)

Open or Close the switch.

No effect if switch is locked. However, Reset removes any lock and then closes the switch (shelf state).

◆ SwtControls_Set_Delay()

DSS_CAPI_DLL void SwtControls_Set_Delay ( double  Value)

Time delay [s] betwen arming and opening or closing the switch.

Control may reset before actually operating the switch.

◆ Transformers_Get_First()

DSS_CAPI_DLL int32_t Transformers_Get_First ( void  )

Sets the first Transformer active.

Returns 0 if no more.

◆ Transformers_Get_kV()

DSS_CAPI_DLL double Transformers_Get_kV ( void  )

Active Winding kV rating.

Phase-phase for 2 or 3 phases, actual winding kV for 1 phase transformer.

◆ Transformers_Get_kVA()

DSS_CAPI_DLL double Transformers_Get_kVA ( void  )

Active Winding kVA rating.

On winding 1, this also determines normal and emergency current ratings for all windings.

◆ Transformers_Get_Next()

DSS_CAPI_DLL int32_t Transformers_Get_Next ( void  )

Sets the next Transformer active.

Returns 0 if no more.

◆ Transformers_Get_NumWindings()

DSS_CAPI_DLL int32_t Transformers_Get_NumWindings ( void  )

Number of windings on this transformer.

Allocates memory; set or change this property first.

◆ Transformers_Get_Rneut()

DSS_CAPI_DLL double Transformers_Get_Rneut ( void  )

Active Winding neutral resistance [ohms] for wye connections.

Set less than zero for ungrounded wye.

◆ Transformers_Get_Wdg()

DSS_CAPI_DLL int32_t Transformers_Get_Wdg ( void  )

Active Winding Number from 1..NumWindings.

Update this before reading or setting a sequence of winding properties (R, Tap, kV, kVA, etc.)

◆ Transformers_Get_Xhl()

DSS_CAPI_DLL double Transformers_Get_Xhl ( void  )

Percent reactance between windings 1 and 2, on winding 1 kVA base.

Use for 2-winding or 3-winding transformers.

◆ Transformers_Get_Xht()

DSS_CAPI_DLL double Transformers_Get_Xht ( void  )

Percent reactance between windigns 1 and 3, on winding 1 kVA base.

Use for 3-winding transformers only.

◆ Transformers_Get_Xlt()

DSS_CAPI_DLL double Transformers_Get_Xlt ( void  )

Percent reactance between windings 2 and 3, on winding 1 kVA base.

Use for 3-winding transformers only.

◆ Transformers_Set_kV()

DSS_CAPI_DLL void Transformers_Set_kV ( double  Value)

Active Winding kV rating.

Phase-phase for 2 or 3 phases, actual winding kV for 1 phase transformer.

◆ Transformers_Set_kVA()

DSS_CAPI_DLL void Transformers_Set_kVA ( double  Value)

Active Winding kVA rating.

On winding 1, this also determines normal and emergency current ratings for all windings.

◆ Transformers_Set_NumWindings()

DSS_CAPI_DLL void Transformers_Set_NumWindings ( int32_t  Value)

Number of windings on this transformer.

Allocates memory; set or change this property first.

◆ Transformers_Set_Rneut()

DSS_CAPI_DLL void Transformers_Set_Rneut ( double  Value)

Active Winding neutral resistance [ohms] for wye connections.

Set less than zero for ungrounded wye.

◆ Transformers_Set_Wdg()

DSS_CAPI_DLL void Transformers_Set_Wdg ( int32_t  Value)

Active Winding Number from 1..NumWindings.

Update this before reading or setting a sequence of winding properties (R, Tap, kV, kVA, etc.)

◆ Transformers_Set_Xhl()

DSS_CAPI_DLL void Transformers_Set_Xhl ( double  Value)

Percent reactance between windings 1 and 2, on winding 1 kVA base.

Use for 2-winding or 3-winding transformers.

◆ Transformers_Set_Xht()

DSS_CAPI_DLL void Transformers_Set_Xht ( double  Value)

Percent reactance between windigns 1 and 3, on winding 1 kVA base.

Use for 3-winding transformers only.

◆ Transformers_Set_Xlt()

DSS_CAPI_DLL void Transformers_Set_Xlt ( double  Value)

Percent reactance between windings 2 and 3, on winding 1 kVA base.

Use for 3-winding transformers only.

◆ XYCurves_Get_Xarray()

DSS_CAPI_DLL void XYCurves_Get_Xarray ( double **  ResultPtr,
int32_t *  ResultCount 
)

Get/Set X values as a Array of doubles.

Set Npts to max number expected if setting

◆ XYCurves_Set_Xarray()

DSS_CAPI_DLL void XYCurves_Set_Xarray ( double *  ValuePtr,
int32_t  ValueCount 
)

Get/Set X values as a Array of doubles.

Set Npts to max number expected if setting

◆ XYCurves_Set_Yscale()

DSS_CAPI_DLL void XYCurves_Set_Yscale ( double  Value)

Amount to scale Y values from original curve.

Represents a curve shift.

◆ YMatrix_CheckConvergence()

DSS_CAPI_DLL uint16_t YMatrix_CheckConvergence ( void  )

Update and return the convergence flag.

Used for external solver loops.

◆ ZIP_Close()

DSS_CAPI_DLL void ZIP_Close ( void  )

Closes the current open ZIP file.

(API Extension)

◆ ZIP_Contains()

DSS_CAPI_DLL uint16_t ZIP_Contains ( const char *  Name)

Check if the given path name is present in the current ZIP file.

(API Extension)

◆ ZIP_Extract()

DSS_CAPI_DLL void ZIP_Extract ( int8_t **  ResultPtr,
int32_t *  ResultCount,
const char *  FileName 
)

Extracts the contents of the file "FileName" from the current (open) ZIP file.

Returns a byte-string.

(API Extension)

◆ ZIP_List()

DSS_CAPI_DLL void ZIP_List ( char ***  ResultPtr,
int32_t *  ResultCount,
const char *  RegExp 
)

List of strings consisting of all names match the regular expression provided in regexp.

If no expression is provided, all names in the current open ZIP are returned.

See https://regex.sorokin.engineer/en/latest/regular_expressions.html for information on the expression syntax and options.

(API Extension)

◆ ZIP_Open()

DSS_CAPI_DLL void ZIP_Open ( const char *  FileName)

Opens and prepares a ZIP file to be used by the DSS text parser.

Currently, the ZIP format support is limited by what is provided in the Free Pascal distribution. Besides that, the full filenames inside the ZIP must be shorter than 256 characters. The limitations should be removed in a future revision.

(API Extension)

◆ ZIP_Redirect()

DSS_CAPI_DLL void ZIP_Redirect ( const char *  FileInZip)

Runs a "Redirect" command inside the current (open) ZIP file.

In the current implementation, all files required by the script must be present inside the ZIP, using relative paths. The only exceptions are memory-mapped files.

(API Extension)