Descriptor for a single stream coming off a channel. More...
#include <StreamDescriptor.h>
Collaboration diagram for StreamDescriptor:
Public Member Functions | |
| StreamDescriptor (InstrumentChannel *channel, size_t stream=0) | |
| bool | IsOutOfRange () |
| operator bool () const | |
| std::string | GetName () const |
| Unit | GetXAxisUnits () |
| Unit | GetYAxisUnits () |
| WaveformBase * | GetData () const |
| bool | operator== (const StreamDescriptor &rhs) const |
| bool | operator!= (const StreamDescriptor &rhs) const |
| bool | operator< (const StreamDescriptor &rhs) const |
| uint8_t | GetFlags () const |
| float | GetVoltageRange () |
| float | GetOffset () |
| void | SetVoltageRange (float v) |
| void | SetOffset (float v) |
| Stream::StreamType | GetType () |
| Get the type of stream (if connected). Returns STREAM_TYPE_ANALOG if null. | |
| float | GetScalarValue () |
Public Attributes | |
| InstrumentChannel * | m_channel |
| size_t | m_stream |
Detailed Description
Descriptor for a single stream coming off a channel.
Member Function Documentation
◆ IsOutOfRange()
|
inline |
- Returns
- True if this is an invalid stream (index greater than the highest allowed value)
The documentation for this class was generated from the following files:
- lib/scopehal/StreamDescriptor.h
- lib/scopehal/FlowGraphNode.cpp
- lib/scopehal/FlowGraphNode_inlines.h
- lib/scopehal/StreamDescriptor_inlines.h
