ngscopeclient 0.1-dev+51fbda87c
Public Types | Public Member Functions | Public Attributes | List of all members
Stream Class Reference

Information associated with a single stream. More...

#include <Stream.h>

Collaboration diagram for Stream:
Collaboration graph
[legend]

Public Types

enum  StreamType {
  STREAM_TYPE_ANALOG , STREAM_TYPE_DIGITAL , STREAM_TYPE_DIGITAL_BUS , STREAM_TYPE_EYE ,
  STREAM_TYPE_SPECTROGRAM , STREAM_TYPE_WATERFALL , STREAM_TYPE_CONSTELLATION , STREAM_TYPE_TRIGGER ,
  STREAM_TYPE_PROTOCOL , STREAM_TYPE_ANALOG_SCALAR , STREAM_TYPE_UNDEFINED
}
 General data type stored in a stream. More...
 
enum  { STREAM_DO_NOT_INTERPOLATE = 1 , STREAM_FILL_UNDER = 2 , STREAM_INFREQUENTLY_USED = 4 }
 

Public Member Functions

 Stream (Unit yunit, std::string name, StreamType type, uint8_t flags=0)
 

Public Attributes

Unit m_yAxisUnit
 Unit of measurement for our vertical axis.
 
std::string m_name
 Name of the stream.
 
WaveformBasem_waveform
 The current waveform (or null if nothing here)
 
double m_value
 The current value (only meaningful for analog scalar type)
 
StreamType m_stype
 General datatype stored in the stream.
 
uint8_t m_flags
 Flags that apply to this waveform. Bitfield. STREAM_DO_NOT_INTERPOLATE: hint that this stream should not be rendered with interpolation even though/if it is analog. E.g. measurement values related to discrete parts of a waveform. More...
 

Detailed Description

Information associated with a single stream.

Each channel contains one or more streams, which represent a single element of a complex-valued waveform. For example, the waveform from an RTSA might have a stream for I and a stream for Q within a single channel. The waveform from a VNA might have a stream for magnitude and another for angle data on each path.

Member Enumeration Documentation

◆ StreamType

General data type stored in a stream.

This type is always valid even if m_waveform is null.

Member Data Documentation

◆ m_flags

uint8_t Stream::m_flags

Flags that apply to this waveform. Bitfield. STREAM_DO_NOT_INTERPOLATE: hint that this stream should not be rendered with interpolation even though/if it is analog. E.g. measurement values related to discrete parts of a waveform.

STREAM_FILL_UNDER: requests that waveform be drawn with area under curve filled (e.g. histogram)

STREAM_INFREQUENTLY_USED: hint that the stream is not commonly used, and should not be automatically added to the scope display to prevent clutter


The documentation for this class was generated from the following file: