Monitors Properties |
[This is preliminary documentation and is subject to change.]
The Monitors type exposes the following members.
| Name | Description | |
|---|---|---|
| AllNames |
Array of strings with all Monitor names in the circuit.
| |
| ByteStream |
Byte Array containing monitor stream values. Make sure a "save" is done first (standard solution modes do this automatically)
| |
| Count |
Number of Monitor objects in active circuit.
| |
| dblFreq |
Array of doubles containing frequency values for harmonics mode solutions; Empty for time mode solutions (use dblHour)
| |
| dblHour |
Array of doubles containing time value in hours for time-sampled monitor values; Empty if frequency-sampled values for harmonics solution (see dblFreq)
| |
| Element |
Full object name of element being monitored.
| |
| FileName |
Name of CSV file associated with active Monitor.
| |
| FileVersion |
Monitor File Version (integer)
| |
| First |
Sets the first Monitor active. Returns 0 if no more.
| |
| Header |
Header string; Array of strings containing Channel names
| |
| idx |
Get/set active Monitor by index; index is 1-based: 1..count
| |
| Mode |
Set Monitor mode (bitmask integer - see DSS Help)
| |
| Name |
Sets the active Monitor by Name.
| |
| Next |
Sets the next Monitor active. Returns 0 if no more.
| |
| NumChannels |
Number of Channels in the active Monitor
| |
| RecordSize |
Size of each record in ByteStream (Integer). Same as NumChannels.
| |
| SampleCount |
Number of Samples in Monitor at Present
| |
| Terminal |
Terminal number of element being monitored.
|