Descriptor for a single stream coming off a channel. More...

Collaboration diagram for StreamDescriptor:

[legend]

Public Member Functions
	StreamDescriptor (InstrumentChannel *channel, size_t stream=0)

bool	IsOutOfRange ()

	operator bool () const

void	AddSink (FlowGraphNode *node)

void	RemoveSink (FlowGraphNode *node)

const std::set< FlowGraphNode * > &	GetSinks ()

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 ()

bool	IsHighRateOffsetCapable ()

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 ()

uint64_t	GetDigitalScalarValue ()

size_t	GetDigitalWidth ()

std::string	PrettyPrintDigitalScalarHex ()

std::string	PrettyPrintDigitalScalarBinary ()

std::string	PrettyPrintDigitalScalarDecimal ()

bool	IsInverted ()

Detailed Description

Descriptor for a single stream coming off a channel.

Member Function Documentation

bool StreamDescriptor::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: