Click or drag to resize

LoadShapes Class

[This is preliminary documentation and is subject to change.]

[Missing <summary> documentation for "T:dss_sharp.LoadShapes"]

Inheritance Hierarchy

Namespace:  dss_sharp
Assembly:  dss_sharp (in dss_sharp.dll) Version: 1.0.0
Syntax
public class LoadShapes : ContextState

The LoadShapes type exposes the following members.

Constructors
  NameDescription
Public methodLoadShapes
Initializes a new instance of the LoadShapes class
Top
Properties
  NameDescription
Public propertyAllNames
Array of strings with all LoadShape names in the circuit.
Public propertyCount
Number of LoadShape objects in active circuit.
Public propertyFirst
Sets the first LoadShape active. Returns 0 if no more.
Public propertyHrInterval
Fixed interval time value, hours.
Public propertyidx
Get/set active LoadShape by index; index is 1-based: 1..count
Public propertyMinInterval
Fixed Interval time value, in minutes
Public propertyName
Sets the active LoadShape by Name.
Public propertyNext
Sets the next LoadShape active. Returns 0 if no more.
Public propertyNpts
Get/set Number of points in active Loadshape.
Public propertyPBase
Public propertyPmult
Array of doubles for the P multiplier in the Loadshape.
Public propertyQBase
Base for normalizing Q curve. If left at zero, the peak value is used.
Public propertyQmult
Array of doubles containing the Q multipliers.
Public propertysInterval
Public propertyTimeArray
Time array in hours correscponding to P and Q multipliers when the Interval=0.
Public propertyUseActual
Boolean flag to let Loads know to use the actual value in the curve rather than use the value as a multiplier.
Top
Methods
  NameDescription
Protected methodCheckForError (Inherited from ContextState.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetContextHandle
Returns the low-level handle of the current OpenDSS/DSS-CAPI instance.
(Inherited from ContextState.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodNew
Public methodNormalize
Public methodToString (Inherited from Object.)
Public methodUseFloat32
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)
Public methodUseFloat64
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)
Top
Fields
  NameDescription
Protected fieldapiutil (Inherited from ContextState.)
Protected fieldctx (Inherited from ContextState.)
Top
See Also