Click or drag to resize

Monitors Class

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

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

Inheritance Hierarchy

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

The Monitors type exposes the following members.

Public methodMonitors
Initializes a new instance of the Monitors class
Public propertyAllNames
Array of strings with all Monitor names in the circuit.
Public propertyByteStream
Byte Array containing monitor stream values. Make sure a "save" is done first (standard solution modes do this automatically)
Public propertyCount
Number of Monitor objects in active circuit.
Public propertydblFreq
Array of doubles containing frequency values for harmonics mode solutions; Empty for time mode solutions (use dblHour)
Public propertydblHour
Array of doubles containing time value in hours for time-sampled monitor values; Empty if frequency-sampled values for harmonics solution (see dblFreq)
Public propertyElement
Full object name of element being monitored.
Public propertyFileName
Name of CSV file associated with active Monitor.
Public propertyFileVersion
Monitor File Version (integer)
Public propertyFirst
Sets the first Monitor active. Returns 0 if no more.
Public propertyHeader
Header string; Array of strings containing Channel names
Public propertyidx
Get/set active Monitor by index; index is 1-based: 1..count
Public propertyMode
Set Monitor mode (bitmask integer - see DSS Help)
Public propertyName
Sets the active Monitor by Name.
Public propertyNext
Sets the next Monitor active. Returns 0 if no more.
Public propertyNumChannels
Number of Channels in the active Monitor
Public propertyRecordSize
Size of each record in ByteStream (Integer). Same as NumChannels.
Public propertySampleCount
Number of Samples in Monitor at Present
Public propertyTerminal
Terminal number of element being monitored.
Public methodChannel
Array of float64 for the specified channel (usage: MyArray = DSSMonitor.Channel(i)). A Save or SaveAll should be executed first. Done automatically by most standard solution modes. Channels start at index 1.
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 methodProcess
Public methodProcessAll
Public methodReset
Public methodResetAll
Public methodSample
Public methodSampleAll
Public methodSave
Public methodSaveAll
Public methodShow
Public methodToString (Inherited from Object.)
Protected fieldapiutil (Inherited from ContextState.)
Protected fieldctx (Inherited from ContextState.)
See Also