Inheritance diagram for MagnovaOscilloscope:

[legend]

Collaboration diagram for MagnovaOscilloscope:

[legend]

Classes
struct	Metadata

Public Types
enum	Model { MODEL_MAGNOVA_BMO , MODEL_UNKNOWN }

enum	MemoryDepthMode { MEMORY_DEPTH_AUTO_FAST , MEMORY_DEPTH_AUTO_MAX , MEMORY_DEPTH_FIXED }

enum	CaptureMode { CAPTURE_MODE_NORMAL , CAPTURE_MODE_EXTENDED }

enum	ADCMode { ADC_MODE_8BIT = 0 , ADC_MODE_10BIT = 1 }

Public Types inherited from Oscilloscope
enum	TriggerMode { TRIGGER_MODE_RUN , TRIGGER_MODE_STOP , TRIGGER_MODE_TRIGGERED , TRIGGER_MODE_WAIT , TRIGGER_MODE_AUTO , TRIGGER_MODE_COUNT }

enum	SamplingMode { REAL_TIME , EQUIVALENT_TIME }

typedef std::pair< OscilloscopeChannel , OscilloscopeChannel >	InterleaveConflict
	Get the set of conflicting channels. More...

typedef std::vector< OscilloscopeChannel * >	AnalogBank

typedef std::vector< OscilloscopeChannel * >	DigitalBank

typedef std::shared_ptr< Oscilloscope >(*	CreateProcType) (SCPITransport *)

Public Types inherited from Instrument
enum	InstrumentTypes { INST_OSCILLOSCOPE = 0x01 , INST_DMM = 0x02 , INST_PSU = 0x04 , INST_FUNCTION = 0x08 , INST_RF_GEN = 0x10 , INST_LOAD = 0x20 , INST_BERT = 0x40 , INST_MISC = 0x80 , INST_SWITCH_MATRIX = 0x100 }

Public Types inherited from SCPIFunctionGenerator
typedef std::shared_ptr< SCPIFunctionGenerator >(*	GeneratorCreateProcType) (SCPITransport *)

Public Types inherited from FunctionGenerator
enum	WaveShape { SHAPE_SINE , SHAPE_SQUARE , SHAPE_TRIANGLE , SHAPE_PULSE , SHAPE_DC , SHAPE_NOISE , SHAPE_SAWTOOTH_UP , SHAPE_SAWTOOTH_DOWN , SHAPE_SINC , SHAPE_GAUSSIAN , SHAPE_LORENTZ , SHAPE_HALF_SINE , SHAPE_PRBS_NONSTANDARD , SHAPE_EXPONENTIAL_RISE , SHAPE_EXPONENTIAL_DECAY , SHAPE_HAVERSINE , SHAPE_CARDIAC , SHAPE_STAIRCASE_UP , SHAPE_STAIRCASE_DOWN , SHAPE_STAIRCASE_UP_DOWN , SHAPE_NEGATIVE_PULSE , SHAPE_LOG_RISE , SHAPE_LOG_DECAY , SHAPE_SQUARE_ROOT , SHAPE_CUBE_ROOT , SHAPE_QUADRATIC , SHAPE_CUBIC , SHAPE_DLORENTZ , SHAPE_GAUSSIAN_PULSE , SHAPE_HAMMING , SHAPE_HANNING , SHAPE_KAISER , SHAPE_BLACKMAN , SHAPE_GAUSSIAN_WINDOW , SHAPE_HARRIS , SHAPE_BARTLETT , SHAPE_TAN , SHAPE_COT , SHAPE_SEC , SHAPE_CSC , SHAPE_ASIN , SHAPE_ACOS , SHAPE_ATAN , SHAPE_ACOT , SHAPE_ARB }
	Predefined waveform shapes.

enum	OutputImpedance { IMPEDANCE_HIGH_Z , IMPEDANCE_50_OHM }
	Nominal output impedance for a function generator channel. More...

Public Member Functions
	MagnovaOscilloscope (SCPITransport *transport)

	MagnovaOscilloscope (const MagnovaOscilloscope &rhs)=delete

MagnovaOscilloscope &	operator= (const MagnovaOscilloscope &rhs)=delete

virtual unsigned int	GetInstrumentTypes () const override
	See what features we have. More...

virtual unsigned int	GetMeasurementTypes ()
	See what measurement capabilities we have.

virtual uint32_t	GetInstrumentTypesForChannel (size_t i) const override
	Returns a bitfield describing the set of instrument types that a given channel supports. More...

virtual void	FlushConfigCache () override
	Instruments are allowed to cache configuration settings to reduce round trip queries to the device. More...

virtual bool	IsChannelEnabled (size_t i) override
	Checks if a channel is enabled in hardware. More...

virtual void	EnableChannel (size_t i) override
	Turn a channel on, given the index. More...

virtual bool	CanEnableChannel (size_t i) override
	Determines if a channel can be enabled. More...

virtual void	DisableChannel (size_t i) override
	Turn a channel off, given the index. More...

virtual OscilloscopeChannel::CouplingType	GetChannelCoupling (size_t i) override
	Gets the coupling used for an input channel. More...

virtual void	SetChannelCoupling (size_t i, OscilloscopeChannel::CouplingType type) override
	Sets the coupling used for an input channel. More...

virtual std::vector< OscilloscopeChannel::CouplingType >	GetAvailableCouplings (size_t i) override
	Gets the set of legal coupling values for an input channel. More...

virtual double	GetChannelAttenuation (size_t i) override
	Gets the probe attenuation for an input channel. More...

virtual void	SetChannelAttenuation (size_t i, double atten) override
	Sets the probe attenuation used for an input channel. More...

virtual unsigned int	GetChannelBandwidthLimit (size_t i) override
	Gets the bandwidth limit for an input channel. More...

virtual void	SetChannelBandwidthLimit (size_t i, unsigned int limit_mhz) override
	Sets the bandwidth limit for an input channel. More...

virtual float	GetChannelVoltageRange (size_t i, size_t stream) override
	Gets the range of the current channel configuration. More...

virtual void	SetChannelVoltageRange (size_t i, size_t stream, float range) override
	Sets the range of the current channel configuration. More...

virtual OscilloscopeChannel *	GetExternalTrigger () override
	Returns the external trigger input channel, if we have one. More...

virtual float	GetChannelOffset (size_t i, size_t stream) override
	Gets the offset, in volts, for a given channel. More...

virtual void	SetChannelOffset (size_t i, size_t stream, float offset) override
	Sets the offset for a given channel. More...

virtual std::string	GetChannelDisplayName (size_t i) override
	Gets the hardware display name for a channel. This is an arbitrary user-selected string. More...

virtual void	SetChannelDisplayName (size_t i, std::string name) override
	Sets the hardware display name for a channel. This is an arbitrary user-selected string. More...

virtual std::vector< unsigned int >	GetChannelBandwidthLimiters (size_t i) override
	Gets the set of available bandwidth limiters for an input channel. More...

virtual bool	CanInvert (size_t i) override
	Checks if a channel is capable of hardware polarity inversion. More...

virtual void	Invert (size_t i, bool invert) override
	Enables hardware polarity inversion for a channel, if supported. More...

virtual bool	IsInverted (size_t i) override
	Checks if hardware polarity inversion is enabled for a channel. More...

virtual Oscilloscope::TriggerMode	PollTrigger () override
	Checks the curent trigger status. More...

virtual bool	AcquireData () override
	Pull data from the instrument. More...

virtual void	Start () override
	Starts the instrument in continuous trigger mode. More...

virtual void	StartSingleTrigger () override
	Arms the trigger for a single acquistion. More...

virtual void	Stop () override
	Stops triggering. More...

virtual void	ForceTrigger () override
	Forces a single acquisition as soon as possible. More...

virtual bool	IsTriggerArmed () override
	Checks if the trigger is currently armed. More...

virtual void	PushTrigger () override
	Pushes changes made to m_trigger to the instrument. More...

virtual void	PullTrigger () override
	Updates m_trigger with any changes made from the instrument side. More...

virtual void	EnableTriggerOutput () override
	Enables the trigger output, configuring a shared auxiliary port for this purpose if needed. More...

virtual std::vector< std::string >	GetTriggerTypes () override
	Gets a list of triggers this instrument supports. More...

Model	GetModelID ()

virtual std::vector< uint64_t >	GetSampleRatesNonInterleaved () override
	Get the legal sampling rates (in Hz) for this scope in all-channels mode. More...

virtual std::vector< uint64_t >	GetSampleRatesInterleaved () override
	Get the legal sampling rates (in Hz) for this scope in combined-channels mode. More...

virtual std::set< InterleaveConflict >	GetInterleaveConflicts () override

virtual std::vector< uint64_t >	GetSampleDepthsNonInterleaved () override
	Get the legal memory depths for this scope in all-channels mode. More...

virtual std::vector< uint64_t >	GetSampleDepthsInterleaved () override
	Get the legal memory depths for this scope in combined-channels mode. More...

virtual uint64_t	GetSampleRate () override
	Gets the current sampling rate (in Hz) of this scope. More...

virtual uint64_t	GetSampleDepth () override
	Gets the current sample depth of this scope. More...

virtual void	SetSampleDepth (uint64_t depth) override
	Sets the sample depth of the scope. More...

virtual void	SetSampleRate (uint64_t rate) override
	Sets the sample rate of the scope, in Hz. More...

virtual void	SetUseExternalRefclk (bool external) override
	Configures the instrument's clock source. More...

virtual bool	IsInterleaving () override
	Checks if the scope is currently combining channels. More...

virtual bool	SetInterleaving (bool combine) override
	Configures the scope to combine channels. More...

virtual void	SetTriggerOffset (int64_t offset) override
	Sets the trigger offset. More...

virtual int64_t	GetTriggerOffset () override
	Gets the trigger offset. More...

virtual void	SetDeskewForChannel (size_t channel, int64_t skew) override
	Sets the deskew setting for a channel. More...

virtual int64_t	GetDeskewForChannel (size_t channel) override
	Gets the deskew setting for a channel. More...

virtual std::vector< WaveShape >	GetAvailableWaveformShapes (int chan) override
	Query the set of available pre-defined waveforms for this generator. More...

virtual bool	GetFunctionChannelActive (int chan) override
	Returns true if the function generator channel's output is enabled. More...

virtual void	SetFunctionChannelActive (int chan, bool on) override
	Turns a function generator channel on or off. More...

virtual float	GetFunctionChannelDutyCycle (int chan) override
	Gets the duty cycle for a function generator output. More...

virtual void	SetFunctionChannelDutyCycle (int chan, float duty) override
	Sets the duty cycle for a function generator output. More...

virtual float	GetFunctionChannelAmplitude (int chan) override
	Gets the amplitude for a function generator output. More...

virtual void	SetFunctionChannelAmplitude (int chan, float amplitude) override
	Sets the amplitude for a function generator output. More...

virtual float	GetFunctionChannelOffset (int chan) override
	Gets the DC offset for a function generator output. More...

virtual void	SetFunctionChannelOffset (int chan, float offset) override
	Sets the DC offset for a function generator output. More...

virtual float	GetFunctionChannelFrequency (int chan) override
	Gets the frequency for a function generator output. More...

virtual void	SetFunctionChannelFrequency (int chan, float hz) override
	Sets the frequency for a function generator output. More...

virtual WaveShape	GetFunctionChannelShape (int chan) override
	Gets the waveform shape for a function generator output. More...

virtual void	SetFunctionChannelShape (int chan, WaveShape shape) override
	Sets the waveform shape for a function generator output. More...

virtual bool	HasFunctionRiseFallTimeControls (int chan) override
	Determines if the function generator allows control over rise/fall times. More...

virtual OutputImpedance	GetFunctionChannelOutputImpedance (int chan) override
	Gets the currently selected output impedance for a function generator output (if supported) More...

virtual void	SetFunctionChannelOutputImpedance (int chan, OutputImpedance z) override
	Sets the currently selected output impedance for a function generator output (if supported) More...

virtual float	GetFunctionChannelRiseTime (int) override
	Gets the rise time for a function generator output (if supported) More...

virtual void	SetFunctionChannelRiseTime (int, float) override
	Sets the rise time for a function generator output (if supported) More...

virtual void	SetFunctionChannelFallTime (int, float) override
	Sets the fall time for a function generator output (if supported) More...

virtual float	GetFunctionChannelFallTime (int chan) override
	Gets the fall time for a function generator output (if supported) More...

virtual std::vector< DigitalBank >	GetDigitalBanks () override
	Gets the digital channel banks for this instrument. More...

virtual DigitalBank	GetDigitalBank (size_t channel) override
	Gets the bank containing a given channel. More...

virtual bool	IsDigitalHysteresisConfigurable () override
	Checks if digital input hysteresis is configurable or fixed. More...

virtual bool	IsDigitalThresholdConfigurable () override
	Checks if digital input threshold is configurable or fixed. More...

virtual float	GetDigitalHysteresis (size_t channel) override
	Gets the hysteresis for a digital input. More...

virtual float	GetDigitalThreshold (size_t channel) override
	Gets the threshold for a digital input. More...

virtual void	SetDigitalHysteresis (size_t channel, float level) override
	Sets the hysteresis for a digital input. More...

virtual void	SetDigitalThreshold (size_t channel, float level) override
	Gets the threshold for a digital input. More...

virtual bool	IsADCModeConfigurable () override
	Returns true if the ADC is configurable, false if it can only run in one mode. More...

virtual std::vector< std::string >	GetADCModeNames (size_t channel) override
	Gets the names of the ADC modes for the bank a given channel is located in. More...

virtual size_t	GetADCMode (size_t channel) override
	Gets the ADC mode for a channel. More...

virtual void	SetADCMode (size_t channel, size_t mode) override
	Sets the ADC mode for a channel. More...

Public Member Functions inherited from SCPIOscilloscope
virtual std::string	IDPing ()
	Returns the instrument's identification string. More...

Public Member Functions inherited from Oscilloscope
virtual std::string	IDPing ()=0
	Returns the instrument's identification string. More...

virtual bool	IsOffline ()
	Checks if the instrument is currently online. More...

OscilloscopeChannel *	GetOscilloscopeChannel (size_t i)
	Gets a channel by index. More...

virtual bool	IsChannelEnabled (size_t i)=0
	Checks if a channel is enabled in hardware. More...

virtual void	EnableChannel (size_t i)=0
	Turn a channel on, given the index. More...

virtual bool	CanEnableChannel (size_t i)
	Determines if a channel can be enabled. More...

virtual void	DisableChannel (size_t i)=0
	Turn a channel off, given the index. More...

int	GetEnabledChannelCount ()
	Returns the number of enabled channels for this oscilloscope. More...

OscilloscopeChannel *	GetOscilloscopeChannelByHwName (const std::string &name)
	Gets a channel given the hardware name.

virtual OscilloscopeChannel::CouplingType	GetChannelCoupling (size_t i)=0
	Gets the coupling used for an input channel. More...

virtual void	SetChannelCoupling (size_t i, OscilloscopeChannel::CouplingType type)=0
	Sets the coupling used for an input channel. More...

virtual std::vector< OscilloscopeChannel::CouplingType >	GetAvailableCouplings (size_t i)=0
	Gets the set of legal coupling values for an input channel. More...

virtual double	GetChannelAttenuation (size_t i)=0
	Gets the probe attenuation for an input channel. More...

virtual void	SetChannelAttenuation (size_t i, double atten)=0
	Sets the probe attenuation used for an input channel. More...

virtual std::vector< unsigned int >	GetChannelBandwidthLimiters (size_t i)
	Gets the set of available bandwidth limiters for an input channel. More...

virtual unsigned int	GetChannelBandwidthLimit (size_t i)=0
	Gets the bandwidth limit for an input channel. More...

virtual void	SetChannelBandwidthLimit (size_t i, unsigned int limit_mhz)=0
	Sets the bandwidth limit for an input channel. More...

virtual OscilloscopeChannel *	GetExternalTrigger ()=0
	Returns the external trigger input channel, if we have one. More...

virtual float	GetChannelVoltageRange (size_t i, size_t stream)=0
	Gets the range of the current channel configuration. More...

virtual void	SetChannelVoltageRange (size_t i, size_t stream, float range)=0
	Sets the range of the current channel configuration. More...

virtual bool	CanAutoZero (size_t i)
	Determines if a channel has a probe connected which supports the "auto zero" feature. More...

virtual void	AutoZero (size_t i)
	Performs an "auto zero" cycle on the attached active probe, if supported by the hardware. More...

virtual bool	CanDegauss (size_t i)
	Determines if a channel has a probe connected which supports the "degauss" feature. More...

virtual bool	ShouldDegauss (size_t i)
	Determines if a channel requires a degauss cycle (if supported) More...

virtual void	Degauss (size_t i)
	Performs an "degauss" cycle on the attached active probe, if supported by the hardware. More...

virtual bool	CanAverage (size_t i)
	Determines if the channel supports hardware averaging. More...

virtual size_t	GetNumAverages (size_t i)
	Returns the number of averages the channel is configured for. More...

virtual void	SetNumAverages (size_t i, size_t navg)
	Sets the number of hardware averages to use. More...

virtual std::string	GetProbeName (size_t i)
	Returns the name of the probe connected to the scope, if possible. More...

virtual bool	HasInputMux (size_t i)
	Checks if a channel has an input multiplexer. More...

virtual size_t	GetInputMuxSetting (size_t i)
	Gets the setting for a channel's input mux (if it has one) More...

virtual std::vector< std::string >	GetInputMuxNames (size_t i)
	Gets names for the input mux ports of a channel. More...

virtual void	SetInputMux (size_t i, size_t select)
	Sets the input mux for a channel. More...

virtual float	GetChannelOffset (size_t i, size_t stream)=0
	Gets the offset, in volts, for a given channel. More...

virtual void	SetChannelOffset (size_t i, size_t stream, float offset)=0
	Sets the offset for a given channel. More...

virtual bool	CanInvert (size_t i)
	Checks if a channel is capable of hardware polarity inversion. More...

virtual void	Invert (size_t i, bool invert)
	Enables hardware polarity inversion for a channel, if supported. More...

virtual bool	IsInverted (size_t i)
	Checks if hardware polarity inversion is enabled for a channel. More...

virtual Oscilloscope::TriggerMode	PollTrigger ()=0
	Checks the curent trigger status. More...

virtual bool	PeekTriggerArmed ()
	Checks if the trigger is armed directly on the instrument, without altering internal state or touching caches. More...

bool	WaitForTrigger (int timeout)
	Block until a trigger happens or a timeout elapses. More...

void	SetTrigger (Trigger *trigger)
	Sets a new trigger on the instrument and pushes changes. More...

virtual void	PushTrigger ()=0
	Pushes changes made to m_trigger to the instrument. More...

Trigger *	GetTrigger (bool sync=false)
	Gets the current trigger. More...

virtual std::vector< std::string >	GetTriggerTypes ()
	Gets a list of triggers this instrument supports. More...

virtual void	PullTrigger ()=0
	Updates m_trigger with any changes made from the instrument side. More...

virtual void	Start ()=0
	Starts the instrument in continuous trigger mode. More...

virtual void	StartSingleTrigger ()=0
	Arms the trigger for a single acquistion. More...

virtual void	Stop ()=0
	Stops triggering. More...

virtual void	ForceTrigger ()=0
	Forces a single acquisition as soon as possible. More...

virtual bool	IsTriggerArmed ()=0
	Checks if the trigger is currently armed. More...

virtual void	EnableTriggerOutput ()
	Enables the trigger output, configuring a shared auxiliary port for this purpose if needed. More...

virtual std::vector< uint64_t >	GetSampleRatesNonInterleaved ()=0
	Get the legal sampling rates (in Hz) for this scope in all-channels mode. More...

virtual std::vector< uint64_t >	GetSampleRatesInterleaved ()=0
	Get the legal sampling rates (in Hz) for this scope in combined-channels mode. More...

virtual uint64_t	GetSampleRate ()=0
	Gets the current sampling rate (in Hz) of this scope. More...

virtual bool	IsInterleaving ()=0
	Checks if the scope is currently combining channels. More...

virtual bool	SetInterleaving (bool combine)=0
	Configures the scope to combine channels. More...

virtual bool	HasInterleavingControls ()
	Returns true if the scope has a user controllavble interleaving feature, false if not. More...

virtual bool	CanInterleave ()
	Returns true if we have no interleave conflicts, false if we have conflicts. More...

virtual std::set< InterleaveConflict >	GetInterleaveConflicts ()=0

virtual std::vector< uint64_t >	GetSampleDepthsNonInterleaved ()=0
	Get the legal memory depths for this scope in all-channels mode. More...

virtual std::vector< uint64_t >	GetSampleDepthsInterleaved ()=0
	Get the legal memory depths for this scope in combined-channels mode. More...

virtual uint64_t	GetSampleDepth ()=0
	Gets the current sample depth of this scope. More...

virtual void	SetSampleDepth (uint64_t depth)=0
	Sets the sample depth of the scope. More...

virtual void	SetSampleRate (uint64_t rate)=0
	Sets the sample rate of the scope, in Hz. More...

virtual bool	IsSamplingModeAvailable (SamplingMode mode)
	Returns true if the requested sampling mode is available with the current instrument configuration. More...

virtual SamplingMode	GetSamplingMode ()
	Gets the current sampling mode of the instrument. More...

virtual void	SetSamplingMode (SamplingMode mode)
	Sets the current sampling mode of the instrument. More...

virtual void	SetUseExternalRefclk (bool external)
	Configures the instrument's clock source. More...

virtual void	SetTriggerOffset (int64_t offset)=0
	Sets the trigger offset. More...

virtual int64_t	GetTriggerOffset ()=0
	Gets the trigger offset. More...

virtual void	SetDeskewForChannel (size_t channel, int64_t skew)
	Sets the deskew setting for a channel. More...

virtual int64_t	GetDeskewForChannel (size_t channel)
	Gets the deskew setting for a channel. More...

virtual std::vector< AnalogBank >	GetAnalogBanks ()
	Gets the analog banks for this instrument. More...

virtual AnalogBank	GetAnalogBank (size_t channel)
	Gets the bank containing a given channel. More...

virtual bool	IsADCModePerChannel ()
	Returns true if the ADC is a per-channel setting, false if global for the entire instrument.

virtual bool	IsADCModeConfigurable ()
	Returns true if the ADC is configurable, false if it can only run in one mode. More...

virtual std::vector< std::string >	GetADCModeNames (size_t channel)
	Gets the names of the ADC modes for the bank a given channel is located in. More...

virtual size_t	GetADCMode (size_t channel)
	Gets the ADC mode for a channel. More...

virtual void	SetADCMode (size_t channel, size_t mode)
	Sets the ADC mode for a channel. More...

virtual std::vector< DigitalBank >	GetDigitalBanks ()
	Gets the digital channel banks for this instrument. More...

virtual DigitalBank	GetDigitalBank (size_t channel)
	Gets the bank containing a given channel. More...

virtual bool	IsDigitalHysteresisConfigurable ()
	Checks if digital input hysteresis is configurable or fixed. More...

virtual bool	IsDigitalThresholdConfigurable ()
	Checks if digital input threshold is configurable or fixed. More...

virtual float	GetDigitalHysteresis (size_t channel)
	Gets the hysteresis for a digital input. More...

virtual float	GetDigitalThreshold (size_t channel)
	Gets the threshold for a digital input. More...

virtual void	SetDigitalHysteresis (size_t channel, float level)
	Sets the hysteresis for a digital input. More...

virtual void	SetDigitalThreshold (size_t channel, float level)
	Gets the threshold for a digital input. More...

virtual void	SetSpan (int64_t span)
	Sets the span for frequency-domain channels. More...

virtual int64_t	GetSpan ()
	Gets the span for frequency-domain channels. More...

virtual void	SetCenterFrequency (size_t channel, int64_t freq)
	Sets the center frequency for frequency-domain channels. More...

virtual int64_t	GetCenterFrequency (size_t channel)
	Gets the center frequency for a frequency-domain channel. More...

virtual void	SetResolutionBandwidth (int64_t rbw)
	Gets the resolution bandwidth for frequency-domain channels. More...

virtual int64_t	GetResolutionBandwidth ()
	Gets the resolution bandwidth for frequency-domain channels. More...

virtual bool	HasFrequencyControls ()
	Returns true if the instrument has at least one frequency-domain channel. More...

virtual bool	HasResolutionBandwidth ()
	Returns true if the instrument has a resolution bandwidth setting. More...

virtual bool	HasTimebaseControls ()
	Returns true if the instrument has at least one time-domain channel. More...

bool	HasPendingWaveforms ()

void	ClearPendingWaveforms ()
	Discard any pending waveforms that haven't yet been processed.

size_t	GetPendingWaveformCount ()

virtual bool	PopPendingWaveform ()
	Pops the queue of pending waveforms and updates each channel with a new waveform.

virtual bool	IsAppendingToWaveform ()
	Checks if we are appending to the existing waveform or creating a new one.

bool	HasPendingDiagnosticLogMessages ()

std::string	PopPendingDiagnosticLogMessage ()

std::map< std::string, FilterParameter * > &	GetDiagnosticsValues ()

bool	FreeWaveformPools ()
	Free all waveforms in our pool to reclaim memory. More...

void	AddWaveformToAnalogPool (WaveformBase *w)

void	AddWaveformToDigitalPool (WaveformBase *w)

Public Member Functions inherited from Instrument
virtual unsigned int	GetInstrumentTypes () const =0
	Returns a bitfield describing the set of instrument types that this instrument supports. More...

virtual std::string	GetName () const =0

virtual std::string	GetVendor () const =0

virtual std::string	GetSerial () const =0

virtual std::string	GetTransportConnectionString ()=0
	Gets the connection string for our transport. More...

virtual std::string	GetTransportName ()=0
	Gets the name of our transport. More...

virtual uint32_t	GetInstrumentTypesForChannel (size_t i) const =0
	Returns a bitfield describing the set of instrument types that a given channel supports. More...

size_t	GetChannelCount () const
	Gets the number of channels (of any type) this instrument has.

InstrumentChannel *	GetChannel (size_t i) const
	Gets a given channel on the instrument. More...

virtual std::string	GetChannelDisplayName (size_t i)
	Gets the hardware display name for a channel. This is an arbitrary user-selected string. More...

virtual void	SetChannelDisplayName (size_t i, std::string name)
	Sets the hardware display name for a channel. This is an arbitrary user-selected string. More...

InstrumentChannel *	GetChannelByDisplayName (const std::string &name)
	Gets a channel given the display name.

InstrumentChannel *	GetChannelByHwName (const std::string &name)
	Gets a channel given the hardware name.

virtual bool	AcquireData ()=0
	Pull data from the instrument. More...

virtual void	FlushConfigCache ()
	Instruments are allowed to cache configuration settings to reduce round trip queries to the device. More...

virtual YAML::Node	SerializeConfiguration (IDTable &table) const
	Serializes this instrument's configuration to a YAML node. More...

virtual void	LoadConfiguration (int version, const YAML::Node &node, IDTable &idmap)
	Load instrument and channel configuration from a save file. More...

virtual void	PreLoadConfiguration (int version, const YAML::Node &node, IDTable &idmap, ConfigWarningList &warnings)
	Parse a limited subset of instrument configuration but do not apply it. More...

Public Member Functions inherited from SCPIInstrument
	SCPIInstrument (SCPITransport *transport, bool identify=true)

virtual std::string	GetTransportConnectionString ()
	Gets the connection string for our transport. More...

virtual std::string	GetTransportName ()
	Gets the name of our transport. More...

virtual std::string	GetName () const

virtual std::string	GetVendor () const

virtual std::string	GetSerial () const

virtual std::string	GetDriverName () const =0

Public Member Functions inherited from SCPIDevice
	SCPIDevice (SCPITransport *transport, bool identify=true)

SCPITransport *	GetTransport () const

Public Member Functions inherited from FunctionGenerator
virtual bool	AcquireData () override
	Pull data from the instrument. More...

virtual bool	GetFunctionChannelActive (int chan)=0
	Returns true if the function generator channel's output is enabled. More...

virtual void	SetFunctionChannelActive (int chan, bool on)=0
	Turns a function generator channel on or off. More...

virtual bool	HasFunctionDutyCycleControls (int chan)
	Determines if the function generator allows control over duty cycles. More...

virtual float	GetFunctionChannelDutyCycle (int chan)
	Gets the duty cycle for a function generator output. More...

virtual void	SetFunctionChannelDutyCycle (int chan, float duty)
	Sets the duty cycle for a function generator output. More...

virtual float	GetFunctionChannelAmplitude (int chan)=0
	Gets the amplitude for a function generator output. More...

virtual void	SetFunctionChannelAmplitude (int chan, float amplitude)=0
	Sets the amplitude for a function generator output. More...

virtual float	GetFunctionChannelOffset (int chan)=0
	Gets the DC offset for a function generator output. More...

virtual void	SetFunctionChannelOffset (int chan, float offset)=0
	Sets the DC offset for a function generator output. More...

virtual float	GetFunctionChannelFrequency (int chan)=0
	Gets the frequency for a function generator output. More...

virtual void	SetFunctionChannelFrequency (int chan, float hz)=0
	Sets the frequency for a function generator output. More...

virtual WaveShape	GetFunctionChannelShape (int chan)=0
	Gets the waveform shape for a function generator output. More...

virtual void	SetFunctionChannelShape (int chan, WaveShape shape)=0
	Sets the waveform shape for a function generator output. More...

virtual float	GetFunctionChannelRiseTime (int chan)
	Gets the rise time for a function generator output (if supported) More...

virtual void	SetFunctionChannelRiseTime (int chan, float fs)
	Sets the rise time for a function generator output (if supported) More...

virtual float	GetFunctionChannelFallTime (int chan)
	Gets the fall time for a function generator output (if supported) More...

virtual void	SetFunctionChannelFallTime (int chan, float fs)
	Sets the fall time for a function generator output (if supported) More...

virtual bool	HasFunctionRiseFallTimeControls (int chan)=0
	Determines if the function generator allows control over rise/fall times. More...

virtual bool	HasFunctionImpedanceControls (int chan)
	Determines if the function generator allows control over rise/fall times. More...

virtual OutputImpedance	GetFunctionChannelOutputImpedance (int chan)
	Gets the currently selected output impedance for a function generator output (if supported) More...

virtual void	SetFunctionChannelOutputImpedance (int chan, OutputImpedance z)
	Sets the currently selected output impedance for a function generator output (if supported) More...

virtual std::vector< WaveShape >	GetAvailableWaveformShapes (int chan)=0
	Query the set of available pre-defined waveforms for this generator. More...

Static Public Member Functions
static void	Convert16BitSamples (float pout, const uint16_t pin, float gain, float offset, size_t count)
	Converts 16-bit ADC samples to floating point.

static void	Convert16BitSamplesGeneric (float pout, const uint16_t pin, float gain, float offset, size_t count)
	Converts raw ADC samples to floating point.

static std::string	GetDriverNameInternal ()

Static Public Member Functions inherited from Oscilloscope
static void	Convert8BitSamples (float pout, const int8_t pin, float gain, float offset, size_t count)
	Converts 8-bit ADC samples to floating point.

static void	Convert8BitSamplesGeneric (float pout, const int8_t pin, float gain, float offset, size_t count)
	Generic backend for Convert8BitSamples()

static void	ConvertUnsigned8BitSamples (float pout, const uint8_t pin, float gain, float offset, size_t count)
	Converts Unsigned 8-bit ADC samples to floating point.

static void	ConvertUnsigned8BitSamplesGeneric (float pout, const uint8_t pin, float gain, float offset, size_t count)
	Generic backend for ConvertUnsigned8BitSamples()

static void	Convert16BitSamples (float pout, const int16_t pin, float gain, float offset, size_t count)
	Converts 16-bit ADC samples to floating point.

static void	Convert16BitSamplesGeneric (float pout, const int16_t pin, float gain, float offset, size_t count)
	Converts raw ADC samples to floating point.

static void	DoAddDriverClass (std::string name, CreateProcType proc)

static void	EnumDrivers (std::vector< std::string > &names)

static std::shared_ptr< Oscilloscope >	CreateOscilloscope (std::string driver, SCPITransport *transport)

Static Public Member Functions inherited from SCPIFunctionGenerator
static void	DoAddDriverClass (std::string name, GeneratorCreateProcType proc)

static void	EnumDrivers (std::vector< std::string > &names)

static std::shared_ptr< SCPIFunctionGenerator >	CreateFunctionGenerator (std::string driver, SCPITransport *transport)

Static Public Member Functions inherited from FunctionGenerator
static std::string	GetNameOfShape (WaveShape shape)
	Converts a WaveShape enum to a human readable name. More...

static WaveShape	GetShapeOfName (const std::string &name)
	Converts a human readable name to a WaveShape. More...

static std::string	GetNameOfImpedance (OutputImpedance imp)
	Converts an OutputImpedance enum to a human readable name. More...

static OutputImpedance	GetImpedanceOfName (const std::string &name)
	Converts a human readable name to an OutputImpedance. More...

Protected Member Functions
void	IdentifyHardware ()

void	DetectBandwidth ()

void	SharedCtorInit ()

virtual void	DetectAnalogChannels ()
	Figures out how many analog channels we have, and add them to the device.

void	AddDigitalChannels (unsigned int count)
	Creates digital channels for the oscilloscope.

void	DetectOptions ()

void	ParseFirmwareVersion ()

std::optional< Metadata >	parseMetadata (const std::vector< uint8_t > &data)
	Parse metadata from the oscilloscope data. More...

void	PullDropoutTrigger ()
	Reads settings for a dropout trigger from the instrument.

void	PullEdgeTrigger ()
	Reads settings for an edge trigger from the instrument.

void	PullPulseWidthTrigger ()
	Reads settings for an edge trigger from the instrument.

void	PullRuntTrigger ()
	Reads settings for a runt-pulse trigger from the instrument.

void	PullSlewRateTrigger ()
	Reads settings for a slew rate trigger from the instrument.

void	PullUartTrigger ()
	Reads settings for a UART trigger from the instrument.

void	PullWindowTrigger ()
	Reads settings for a window trigger from the instrument.

void	PullGlitchTrigger ()
	Reads settings for a glitch trigger from the instrument.

void	PullNthEdgeBurstTrigger ()
	Reads settings for an Nth-edge-burst trigger from the instrument.

void	PullTriggerSource (Trigger *trig, std::string triggerModeName, bool isUart)
	Reads the source of a trigger from the instrument.

void	GetTriggerSlope (Trigger *trig, std::string reply)
	Processes the slope for an edge or edge-derived trigger.

Trigger::Condition	GetCondition (std::string reply)
	Parses a trigger condition.

void	PushDropoutTrigger (DropoutTrigger *trig)
	Pushes settings for a dropout trigger to the instrument.

void	PushEdgeTrigger (EdgeTrigger *trig, const std::string trigType)
	Pushes settings for an edge trigger to the instrument.

void	PushGlitchTrigger (GlitchTrigger *trig)
	Pushes settings for a glitch trigger to the instrument.

void	PushCondition (const std::string &path, Trigger::Condition cond)
	Pushes settings for a trigger condition under a .Condition field.

void	PushPatternCondition (const std::string &path, Trigger::Condition cond)

void	PushFloat (std::string path, float f)

void	PushPulseWidthTrigger (PulseWidthTrigger *trig)
	Pushes settings for a pulse width trigger to the instrument.

void	PushRuntTrigger (RuntTrigger *trig)
	Pushes settings for a runt trigger to the instrument.

void	PushSlewRateTrigger (SlewRateTrigger *trig)
	Pushes settings for a slew rate trigger to the instrument.

void	PushUartTrigger (UartTrigger *trig)
	Pushes settings for a UART trigger to the instrument.

void	PushWindowTrigger (WindowTrigger *trig)
	Pushes settings for a window trigger to the instrument.

void	PushNthEdgeBurstTrigger (NthEdgeBurstTrigger *trig)
	Pushes settings for a Nth edge burst trigger to the instrument. More...

void	BulkCheckChannelEnableState ()
	Optimized function for checking channel enable status en masse with less round trips to the scope.

unsigned int	GetActiveChannelsCount ()
	Returns the number of active analog channels and digital probes to determine Memory Depth available per channel.

double	GetTimebaseScale ()

bool	IsReducedSampleRate ()
	Returns true if the scope is in reduced sample rate.

uint64_t	GetMemoryDepthForSrate (uint64_t srate)
	Returns the memory depth for a given sample rate in auto mode.

uint64_t	GetMaxAutoMemoryDepth (uint64_t original)
	Returns the max memory depth for auto mode.

CaptureMode	GetCaptureMode ()

void	PrepareAcquisition ()

std::string	GetDigitalChannelBankName (size_t channel)

std::string	GetChannelName (size_t channel)

std::string	GetPossiblyEmptyString (const std::string &property)

size_t	ReadWaveformBlock (std::vector< uint8_t > *data, std::function< void(float)> progress=nullptr)

time_t	ExtractTimestamp (const std::string &time, double &basetime)

std::vector< WaveformBase * >	ProcessAnalogWaveform (const std::vector< uint8_t > &data, size_t datalen, uint32_t num_sequences, time_t ttime, double basetime, double *wavetime, int i)

std::vector< SparseDigitalWaveform * >	ProcessDigitalWaveform (const std::vector< uint8_t > &data, size_t datalen, uint32_t num_sequences, time_t ttime, double basetime, double *wavetime, int i)

Protected Member Functions inherited from Oscilloscope
void	ChannelsDownloadStarted ()
	Helper method called by drivers to reset all channels to "waiting to download" state.

void	ChannelsDownloadStatusUpdate (size_t ch, InstrumentChannel::DownloadState state, float progress)
	Helper method called by drivers to set one channel's download status and update its download progress. Be aware that there is a measurement on ngscopeclient UI of the time spent between the download start and the progress of the last enabled channel. This measurement is used to decide whether to display a progress bar or not. This download speed evaluation method only works if enabled channels are download sequencially in increasing numeric order or if all channels are downloaded at the same speed. More...

void	ChannelsDownloadFinished ()
	Helper method called by drivers when waveform download is finished to reset all channels to "no download" state.

void	DoSerializeConfiguration (YAML::Node &node, IDTable &table)
	Serializes this oscilloscope's configuration to a YAML node.

void	DoLoadConfiguration (int version, const YAML::Node &node, IDTable &idmap)
	Load instrument and channel configuration from a save file.

void	DoPreLoadConfiguration (int version, const YAML::Node &node, IDTable &idmap, ConfigWarningList &list)
	Validate instrument and channel configuration from a save file.

void	AddDiagnosticLog (std::string message)

UniformAnalogWaveform *	AllocateAnalogWaveform (const std::string &name)

SparseDigitalWaveform *	AllocateDigitalWaveform (const std::string &name)

Protected Member Functions inherited from SCPIInstrument
void	DoSerializeConfiguration (YAML::Node &node, IDTable &table)

Protected Member Functions inherited from FunctionGenerator
void	DoSerializeConfiguration (YAML::Node &node, IDTable &table)
	Serializes this instrument's configuration to a YAML node. More...

void	DoLoadConfiguration (int version, const YAML::Node &node, IDTable &idmap)
	Load instrument and channel configuration from a save file. More...

void	DoPreLoadConfiguration (int version, const YAML::Node &node, IDTable &idmap, ConfigWarningList &list)
	Validate instrument and channel configuration from a save file. More...

Static Protected Member Functions
static double	GetCaptureScreenDivisions (MemoryDepthMode memoryMode, CaptureMode captureMode, uint64_t srate)

Protected Attributes
unsigned int	m_analogChannelCount

unsigned int	m_digitalChannelCount

unsigned int	m_analogAndDigitalChannelCount

size_t	m_digitalChannelBase

Model	m_modelid

int	m_fwMajorVersion

int	m_fwMinorVersion

int	m_fwPatchVersion

bool	m_hasLA

bool	m_hasDVM

bool	m_hasFunctionGen

bool	m_hasI2cTrigger

bool	m_hasSpiTrigger

unsigned int	m_maxBandwidth
	Maximum bandwidth we support, in MHz.

bool	m_triggerArmed

bool	m_triggerOneShot

bool	m_triggerForced

std::map< size_t, float >	m_channelVoltageRanges

std::map< size_t, float >	m_channelOffsets

std::map< std::string, float >	m_channelDigitalThresholds

std::map< int, bool >	m_channelsEnabled

bool	m_sampleRateValid

int64_t	m_sampleRate

bool	m_memoryDepthValid

int64_t	m_memoryDepth

bool	m_captureModeValid

CaptureMode	m_captudeMode

bool	m_timebaseScaleValid

double	m_timebaseScale

MemoryDepthMode	m_memoryDepthMode

bool	m_triggerOffsetValid

int64_t	m_triggerOffset

std::map< size_t, int64_t >	m_channelDeskew

Multimeter::MeasurementTypes	m_meterMode

bool	m_meterModeValid

std::map< size_t, bool >	m_probeIsActive

std::map< size_t, bool >	m_awgEnabled

std::map< size_t, float >	m_awgDutyCycle

std::map< size_t, float >	m_awgRange

std::map< size_t, float >	m_awgOffset

std::map< size_t, float >	m_awgFrequency

std::map< size_t, float >	m_awgRiseTime

std::map< size_t, float >	m_awgFallTime

std::map< size_t, FunctionGenerator::WaveShape >	m_awgShape

std::map< size_t, FunctionGenerator::OutputImpedance >	m_awgImpedance

ADCMode	m_adcMode

bool	m_adcModeValid

int64_t	m_timeDiv

OscilloscopeChannel *	m_extTrigChannel

FunctionGeneratorChannel *	m_awgChannel

std::vector< OscilloscopeChannel * >	m_digitalChannels

Protected Attributes inherited from SCPIOscilloscope
bool	m_triggerArmed

bool	m_triggerOneShot

std::recursive_mutex	m_cacheMutex

Protected Attributes inherited from Oscilloscope
std::list< SequenceSet >	m_pendingWaveforms

std::mutex	m_pendingWaveformsMutex

std::recursive_mutex	m_mutex

std::deque< std::string >	m_diagnosticLogMessages

std::map< std::string, FilterParameter * >	m_diagnosticValues

Trigger *	m_trigger

WaveformPool	m_analogWaveformPool

WaveformPool	m_digitalWaveformPool

Protected Attributes inherited from Instrument
std::list< sigc::slot< void(YAML::Node &, IDTable &)> >	m_serializers
	List of methods which need to be called to serialize this node's configuration.

std::list< sigc::slot< void(int, const YAML::Node &, IDTable &)> >	m_loaders
	List of methods which need to be called to deserialize this node's configuration.

std::list< sigc::slot< void(int, const YAML::Node &, IDTable &, ConfigWarningList &)> >	m_preloaders
	List of methods which need to be called to pre-load this node's configuration.

std::vector< InstrumentChannel * >	m_channels
	Set of all channels on this instrument.

Protected Attributes inherited from SCPIDevice
SCPITransport *	m_transport

std::string	m_vendor

std::string	m_model

std::string	m_serial

std::string	m_fwVersion

Additional Inherited Members
Public Attributes inherited from Instrument
std::string	m_nickname
	Optional user-selected nickname of the instrument. More...

Protected Types inherited from Oscilloscope
typedef std::map< StreamDescriptor, WaveformBase * >	SequenceSet

typedef std::map< std::string, CreateProcType >	CreateMapType

Protected Types inherited from SCPIFunctionGenerator
typedef std::map< std::string, GeneratorCreateProcType >	GeneratorCreateMapType

Static Protected Attributes inherited from Oscilloscope
static CreateMapType	m_createprocs

Static Protected Attributes inherited from SCPIFunctionGenerator
static GeneratorCreateMapType	m_gencreateprocs

Member Function Documentation

◆ AcquireData()

bool MagnovaOscilloscope::AcquireData ( )

overridevirtual

Pull data from the instrument.

Returns: True if waveform was acquired, false if connection lost or other serious error

Reimplemented from FunctionGenerator.

◆ CanEnableChannel()

bool MagnovaOscilloscope::CanEnableChannel ( size_t i )

overridevirtual

Determines if a channel can be enabled.

Returns: False if the channel cannot currently be used (due to interleave conflicts or other hardware limitations).

True if the channel is available or is already enabled.

Parameters

i	Zero-based index of channel

The default implementation always returns true.

Reimplemented from Oscilloscope.

◆ CanInvert()

bool MagnovaOscilloscope::CanInvert ( size_t i )

overridevirtual

Checks if a channel is capable of hardware polarity inversion.

Parameters

i	Zero-based index of channel

Reimplemented from Oscilloscope.

◆ DisableChannel()

void MagnovaOscilloscope::DisableChannel ( size_t i )

overridevirtual

Turn a channel off, given the index.

This function may optionally configure channel interleaving, if supported in hardware.

Parameters

i	Zero-based index of channel

Implements Oscilloscope.

◆ EnableChannel()

void MagnovaOscilloscope::EnableChannel ( size_t i )

overridevirtual

Turn a channel on, given the index.

Parameters

i	Zero-based index of channel

Implements Oscilloscope.

◆ EnableTriggerOutput()

void MagnovaOscilloscope::EnableTriggerOutput ( )

overridevirtual

Enables the trigger output, configuring a shared auxiliary port for this purpose if needed.

The default implementation does nothing, and is intended for instruments where the trigger output is always enabled.

Reimplemented from Oscilloscope.

◆ FlushConfigCache()

void MagnovaOscilloscope::FlushConfigCache ( )

overridevirtual

Instruments are allowed to cache configuration settings to reduce round trip queries to the device.

In order to see updates made by the user at the front panel, the cache must be flushed.

Cache flushing is recommended to be manually triggered during interactive operation if there is no way to push updates from the scope to the driver.

In scripted/ATE environments where nobody should be touching the instrument, flushing is typically not needed.

The default implementation of this function does nothing since the base class provides no caching. If a derived class caches configuration, it should override this function to clear any cached data.

Reimplemented from Instrument.

◆ ForceTrigger()

void MagnovaOscilloscope::ForceTrigger ( )

overridevirtual

Forces a single acquisition as soon as possible.

Note that PollTrigger() may not return 'triggered' immediately, due to command processing latency.

Implements Oscilloscope.

◆ GetADCMode()

size_t MagnovaOscilloscope::GetADCMode ( size_t channel )

overridevirtual

Gets the ADC mode for a channel.

Reimplemented from Oscilloscope.

◆ GetADCModeNames()

vector< string > MagnovaOscilloscope::GetADCModeNames ( size_t channel )

overridevirtual

Gets the names of the ADC modes for the bank a given channel is located in.

ADC mode names are usually descriptive, like "12 bit, 640 Msps max" or "8 bit, 1 Gsps max"; but some instruments may use more generic

Parameters

channel Index of the channel to query modes for

Reimplemented from Oscilloscope.

◆ GetAvailableCouplings()

vector< OscilloscopeChannel::CouplingType > MagnovaOscilloscope::GetAvailableCouplings ( size_t i )

overridevirtual

Gets the set of legal coupling values for an input channel.

Parameters

i	Zero-based index of channel

Implements Oscilloscope.

◆ GetAvailableWaveformShapes()

vector< FunctionGenerator::WaveShape > MagnovaOscilloscope::GetAvailableWaveformShapes ( int chan )

overridevirtual

Query the set of available pre-defined waveforms for this generator.

Parameters

chan	Channel index

Returns: Vector of supported WaveShape's

Implements FunctionGenerator.

◆ GetChannelAttenuation()

double MagnovaOscilloscope::GetChannelAttenuation ( size_t i )

overridevirtual

Gets the probe attenuation for an input channel.

Note that this function returns attenuation, not gain. For example, a 10x probe would return 10 and not 0.1.

Parameters

i	Zero-based index of channel

Implements Oscilloscope.

◆ GetChannelBandwidthLimit()

unsigned int MagnovaOscilloscope::GetChannelBandwidthLimit ( size_t i )

overridevirtual

Gets the bandwidth limit for an input channel.

Parameters

i	Zero-based index of channel

Returns: Bandwidth limit, in MHz. Zero means "no bandwidth limit".

Implements Oscilloscope.

◆ GetChannelBandwidthLimiters()

vector< unsigned int > MagnovaOscilloscope::GetChannelBandwidthLimiters ( size_t i )

overridevirtual

Gets the set of available bandwidth limiters for an input channel.

Parameters

i	Zero-based index of channel

Reimplemented from Oscilloscope.

◆ GetChannelCoupling()

OscilloscopeChannel::CouplingType MagnovaOscilloscope::GetChannelCoupling ( size_t i )

overridevirtual

Gets the coupling used for an input channel.

Parameters

i	Zero-based index of channel

Implements Oscilloscope.

◆ GetChannelDisplayName()

string MagnovaOscilloscope::GetChannelDisplayName ( size_t i )

overridevirtual

Gets the hardware display name for a channel. This is an arbitrary user-selected string.

Some instruments allow displaying channel names in the GUI or on probes. If this is supported, the driver should override this function.

This function does not implement any caching, so calling it directly in performance critical code is not advisable. Instead, call InstrumentChannel::GetDisplayName(), which caches clientside and calls this function only on a cache miss.

The default implementation is a no-op.

Parameters

i	Zero-based index of channel

Reimplemented from Instrument.

◆ GetChannelOffset()

float MagnovaOscilloscope::GetChannelOffset	(	size_t	i,
		size_t	stream
	)

overridevirtual

Gets the offset, in volts, for a given channel.

Parameters

i	Zero-based index of channel
stream	Zero-based index of stream within channel (0 if only one stream, as is normally the case)

Implements Oscilloscope.

◆ GetChannelVoltageRange()

float MagnovaOscilloscope::GetChannelVoltageRange	(	size_t	i,
		size_t	stream
	)

overridevirtual

Gets the range of the current channel configuration.

The range is the distance, in volts, between the most negative/smallest and most positive/largest voltage which the ADC can represent using the current vertical gain configuration. This can be calculated as the number of vertical divisions times the number of volts per division.

The range does not depend on the offset.

Parameters

i	Zero-based index of channel
stream	Zero-based index of stream within channel (0 if only one stream, as is normally the case)

Implements Oscilloscope.

◆ GetDeskewForChannel()

int64_t MagnovaOscilloscope::GetDeskewForChannel ( size_t channel )

overridevirtual

Gets the deskew setting for a channel.

The default implementation returns zero, and is suitable for lower-end instruments that do not support deskew.

Reimplemented from Oscilloscope.

◆ GetDigitalBank()

Oscilloscope::DigitalBank MagnovaOscilloscope::GetDigitalBank ( size_t channel )

overridevirtual

Gets the bank containing a given channel.

Reimplemented from Oscilloscope.

◆ GetDigitalBanks()

vector< Oscilloscope::DigitalBank > MagnovaOscilloscope::GetDigitalBanks ( )

overridevirtual

Gets the digital channel banks for this instrument.

A bank is a set of one or more channels all sharing a common threshold and hysteresis setting.

Reimplemented from Oscilloscope.

◆ GetDigitalHysteresis()

float MagnovaOscilloscope::GetDigitalHysteresis ( size_t channel )

overridevirtual

Gets the hysteresis for a digital input.

Reimplemented from Oscilloscope.

◆ GetDigitalThreshold()

float MagnovaOscilloscope::GetDigitalThreshold ( size_t channel )

overridevirtual

Gets the threshold for a digital input.

Reimplemented from Oscilloscope.

◆ GetExternalTrigger()

OscilloscopeChannel * MagnovaOscilloscope::GetExternalTrigger ( )

overridevirtual

Returns the external trigger input channel, if we have one.

Note that some very high end oscilloscopes have multiple external trigger inputs. We do not currently support this.

Implements Oscilloscope.

◆ GetFunctionChannelActive()

bool MagnovaOscilloscope::GetFunctionChannelActive ( int chan )

overridevirtual

Returns true if the function generator channel's output is enabled.

Parameters

chan	Channel index

Implements FunctionGenerator.

◆ GetFunctionChannelAmplitude()

float MagnovaOscilloscope::GetFunctionChannelAmplitude ( int chan )

overridevirtual

Gets the amplitude for a function generator output.

Parameters

chan	Channel index

Returns: Amplitude, in Vpp

Implements FunctionGenerator.

◆ GetFunctionChannelDutyCycle()

float MagnovaOscilloscope::GetFunctionChannelDutyCycle ( int chan )

overridevirtual

Gets the duty cycle for a function generator output.

Parameters

chan	Channel index

Returns: Duty cycle, in range [0, 1]

Reimplemented from FunctionGenerator.

◆ GetFunctionChannelFallTime()

float MagnovaOscilloscope::GetFunctionChannelFallTime ( int chan )

overridevirtual

Gets the fall time for a function generator output (if supported)

Parameters

chan	Channel index

Returns: Fall time, in fs

Reimplemented from FunctionGenerator.

◆ GetFunctionChannelFrequency()

float MagnovaOscilloscope::GetFunctionChannelFrequency ( int chan )

overridevirtual

Gets the frequency for a function generator output.

Parameters

chan	Channel index

Returns: Frequency, in Hz

Implements FunctionGenerator.

◆ GetFunctionChannelOffset()

float MagnovaOscilloscope::GetFunctionChannelOffset ( int chan )

overridevirtual

Gets the DC offset for a function generator output.

Parameters

chan	Channel index

Returns: Offset, in volts

Implements FunctionGenerator.

◆ GetFunctionChannelOutputImpedance()

FunctionGenerator::OutputImpedance MagnovaOscilloscope::GetFunctionChannelOutputImpedance ( int chan )

overridevirtual

Gets the currently selected output impedance for a function generator output (if supported)

Parameters

chan	Channel index

Returns: Output impedance

Reimplemented from FunctionGenerator.

◆ GetFunctionChannelRiseTime()

float MagnovaOscilloscope::GetFunctionChannelRiseTime ( int chan )

overridevirtual

Gets the rise time for a function generator output (if supported)

Parameters

chan	Channel index

Returns: Rise time, in fs

Reimplemented from FunctionGenerator.

◆ GetFunctionChannelShape()

FunctionGenerator::WaveShape MagnovaOscilloscope::GetFunctionChannelShape ( int chan )

overridevirtual

Gets the waveform shape for a function generator output.

Parameters

chan	Channel index

Returns: Waveform shape

Implements FunctionGenerator.

◆ GetInstrumentTypes()

unsigned int MagnovaOscilloscope::GetInstrumentTypes ( ) const

overridevirtual

See what features we have.

Implements Instrument.

◆ GetInstrumentTypesForChannel()

uint32_t MagnovaOscilloscope::GetInstrumentTypesForChannel ( size_t i ) const

overridevirtual

Returns a bitfield describing the set of instrument types that a given channel supports.

Parameters

i	Channel index

Implements Instrument.

double MagnovaOscilloscope::GetTimebaseScale ( )

protected

Returns the timebase scale in s

◆ GetTriggerOffset()

int64_t MagnovaOscilloscope::GetTriggerOffset ( )

overridevirtual

Gets the trigger offset.

Implements Oscilloscope.

◆ GetTriggerTypes()

vector< string > MagnovaOscilloscope::GetTriggerTypes ( )

overridevirtual

Gets a list of triggers this instrument supports.

Reimplemented from Oscilloscope.

◆ HasFunctionRiseFallTimeControls()

bool MagnovaOscilloscope::HasFunctionRiseFallTimeControls ( int chan )

overridevirtual

Determines if the function generator allows control over rise/fall times.

If this function returns false, GetFunctionChannelRiseTime() and GetFunctionChannelFallTime() will always return 0, and SetFunctionChannelRiseTime() and SetFunctionChannelFallTime() are no-ops.

Parameters

chan	Channel index

Returns: True if rise/fall time control is available, false if unavailable

Implements FunctionGenerator.

◆ Invert()

void MagnovaOscilloscope::Invert	(	size_t	i,
		bool	invert
	)

overridevirtual

Enables hardware polarity inversion for a channel, if supported.

Parameters

i	Zero-based index of channel
invert	True to invert, false for normal operation

Reimplemented from Oscilloscope.

◆ IsADCModeConfigurable()

bool MagnovaOscilloscope::IsADCModeConfigurable ( )

overridevirtual

Returns true if the ADC is configurable, false if it can only run in one mode.

Reimplemented from Oscilloscope.

◆ IsChannelEnabled()

bool MagnovaOscilloscope::IsChannelEnabled ( size_t i )

overridevirtual

Checks if a channel is enabled in hardware.

Implements Oscilloscope.

◆ IsDigitalHysteresisConfigurable()

bool MagnovaOscilloscope::IsDigitalHysteresisConfigurable ( )

overridevirtual

Checks if digital input hysteresis is configurable or fixed.

Returns: true if configurable, false if fixed

Reimplemented from Oscilloscope.

◆ IsDigitalThresholdConfigurable()

bool MagnovaOscilloscope::IsDigitalThresholdConfigurable ( )

overridevirtual

Checks if digital input threshold is configurable or fixed.

Returns: true if configurable, false if fixed

Reimplemented from Oscilloscope.

◆ IsInterleaving()

bool MagnovaOscilloscope::IsInterleaving ( )

overridevirtual

Checks if the scope is currently combining channels.

Implements Oscilloscope.

◆ IsInverted()

bool MagnovaOscilloscope::IsInverted ( size_t i )

overridevirtual

Checks if hardware polarity inversion is enabled for a channel.

Parameters

i	Zero-based index of channel

Reimplemented from Oscilloscope.

◆ IsTriggerArmed()

bool MagnovaOscilloscope::IsTriggerArmed ( )

overridevirtual

Checks if the trigger is currently armed.

Implements Oscilloscope.

◆ parseMetadata()

std::optional< MagnovaOscilloscope::Metadata > MagnovaOscilloscope::parseMetadata ( const std::vector< uint8_t > & data )

protected

Parse metadata from the oscilloscope data.

Parameters

data	Raw data from oscilloscope
data_transfer_type	Data transfer type

Returns: Parsed metadata

◆ PollTrigger()

Oscilloscope::TriggerMode MagnovaOscilloscope::PollTrigger ( )

overridevirtual

Checks the curent trigger status.

Implements Oscilloscope.

◆ PullTrigger()

void MagnovaOscilloscope::PullTrigger ( )

overridevirtual

Updates m_trigger with any changes made from the instrument side.

Implements Oscilloscope.

◆ PushNthEdgeBurstTrigger()

void MagnovaOscilloscope::PushNthEdgeBurstTrigger ( NthEdgeBurstTrigger * trig )

protected

Pushes settings for a Nth edge burst trigger to the instrument.

Parameters

trig	The trigger

◆ PushTrigger()

void MagnovaOscilloscope::PushTrigger ( )

overridevirtual

Pushes changes made to m_trigger to the instrument.

Implements Oscilloscope.

◆ SetADCMode()

void MagnovaOscilloscope::SetADCMode	(	size_t	channel,
		size_t	mode
	)

overridevirtual

Sets the ADC mode for a channel.

Reimplemented from Oscilloscope.

◆ SetChannelAttenuation()

void MagnovaOscilloscope::SetChannelAttenuation	(	size_t	i,
		double	atten
	)

overridevirtual

Sets the probe attenuation used for an input channel.

Parameters

i	Zero-based index of channel
atten	Attenuation factor

Implements Oscilloscope.

◆ SetChannelBandwidthLimit()

void MagnovaOscilloscope::SetChannelBandwidthLimit	(	size_t	i,
		unsigned int	limit_mhz
	)

overridevirtual

Sets the bandwidth limit for an input channel.

Parameters

i	Zero-based index of channel
limit_mhz	Bandwidth limit, in MHz. Zero means "no bandwidth limit".

Implements Oscilloscope.

◆ SetChannelCoupling()

void MagnovaOscilloscope::SetChannelCoupling	(	size_t	i,
		OscilloscopeChannel::CouplingType	type
	)

overridevirtual

Sets the coupling used for an input channel.

Parameters

i	Zero-based index of channel

Implements Oscilloscope.

◆ SetChannelDisplayName()

void MagnovaOscilloscope::SetChannelDisplayName	(	size_t	i,
		std::string	name
	)

overridevirtual

Sets the hardware display name for a channel. This is an arbitrary user-selected string.

Some instruments allow displaying channel names in the GUI or on probes. If this is supported, the driver should override this function.

This function directly updates hardware without caching. In most cases, you should call InstrumentChannel::SetDisplayName(), which updates the clientside cache and then calls this function.

The default function returns the hardware name.

Parameters

i	Zero-based index of channel
name	Name of the channel

Reimplemented from Instrument.

◆ SetChannelOffset()

void MagnovaOscilloscope::SetChannelOffset	(	size_t	i,
		size_t	stream,
		float	offset
	)

overridevirtual

Sets the offset for a given channel.

Parameters

i	Zero-based index of channel
stream	Zero-based index of stream within channel (0 if only one stream, as is normally the case)
offset	Offset, in volts

Implements Oscilloscope.

◆ SetChannelVoltageRange()

void MagnovaOscilloscope::SetChannelVoltageRange	(	size_t	i,
		size_t	stream,
		float	range
	)

overridevirtual

Sets the range of the current channel configuration.

The range is the distance, in volts, between the most negative/smallest and most positive/largest voltage which the ADC can represent using the current vertical gain configuration. This can be calculated as the number of vertical divisions times the number of volts per division.

The range does not depend on the offset.

Parameters

i	Zero-based index of channel
stream	Zero-based index of stream within channel (0 if only one stream, as is normally the case)
range	Voltage range

Implements Oscilloscope.

◆ SetDeskewForChannel()

void MagnovaOscilloscope::SetDeskewForChannel	(	size_t	channel,
		int64_t	skew
	)

overridevirtual

Sets the deskew setting for a channel.

Parameters

channel	The channel to deskew
skew	Skew value, in femtoseconds. Negative values move the channel earlier relative to the zero point. Positive values move the channel later.

The default implementation does nothing, and is suitable for lower-end instruments that do not support deskew.

Reimplemented from Oscilloscope.

◆ SetDigitalHysteresis()

void MagnovaOscilloscope::SetDigitalHysteresis	(	size_t	channel,
		float	level
	)

overridevirtual

Sets the hysteresis for a digital input.

Reimplemented from Oscilloscope.

◆ SetDigitalThreshold()

void MagnovaOscilloscope::SetDigitalThreshold	(	size_t	channel,
		float	level
	)

overridevirtual

Gets the threshold for a digital input.

Reimplemented from Oscilloscope.

◆ SetFunctionChannelActive()

void MagnovaOscilloscope::SetFunctionChannelActive	(	int	chan,
		bool	on
	)

overridevirtual

Turns a function generator channel on or off.

Parameters

chan	Channel index
on	True to enable output, false to disable

Implements FunctionGenerator.

◆ SetFunctionChannelAmplitude()

void MagnovaOscilloscope::SetFunctionChannelAmplitude	(	int	chan,
		float	amplitude
	)

overridevirtual

Sets the amplitude for a function generator output.

Parameters

chan	Channel index
amplitude	Output amplitude, in Vpp

Implements FunctionGenerator.

◆ SetFunctionChannelDutyCycle()

void MagnovaOscilloscope::SetFunctionChannelDutyCycle	(	int	chan,
		float	duty
	)

overridevirtual

Sets the duty cycle for a function generator output.

Parameters

chan	Channel index
duty	Duty cycle, in range [0, 1]

Reimplemented from FunctionGenerator.

◆ SetFunctionChannelFallTime()

void MagnovaOscilloscope::SetFunctionChannelFallTime	(	int	chan,
		float	fs
	)

overridevirtual

Sets the fall time for a function generator output (if supported)

Parameters

chan	Channel index
fs	Fall time, in fs

Reimplemented from FunctionGenerator.

◆ SetFunctionChannelFrequency()

void MagnovaOscilloscope::SetFunctionChannelFrequency	(	int	chan,
		float	hz
	)

overridevirtual

Sets the frequency for a function generator output.

Parameters

chan	Channel index
hz	Frequency, in Hz

Implements FunctionGenerator.

◆ SetFunctionChannelOffset()

void MagnovaOscilloscope::SetFunctionChannelOffset	(	int	chan,
		float	offset
	)

overridevirtual

Sets the DC offset for a function generator output.

Parameters

chan	Channel index
amplitude	Offset, in volts

Implements FunctionGenerator.

◆ SetFunctionChannelOutputImpedance()

void MagnovaOscilloscope::SetFunctionChannelOutputImpedance	(	int	chan,
		FunctionGenerator::OutputImpedance	z
	)

overridevirtual

Sets the currently selected output impedance for a function generator output (if supported)

Parameters

chan	Channel index
z	Output impedance

Reimplemented from FunctionGenerator.

◆ SetFunctionChannelRiseTime()

void MagnovaOscilloscope::SetFunctionChannelRiseTime	(	int	chan,
		float	fs
	)

overridevirtual

Sets the rise time for a function generator output (if supported)

Parameters

chan	Channel index
fs	Rise time, in fs

Reimplemented from FunctionGenerator.

◆ SetFunctionChannelShape()

void MagnovaOscilloscope::SetFunctionChannelShape	(	int	chan,
		WaveShape	shape
	)

overridevirtual

Sets the waveform shape for a function generator output.

Parameters

chan	Channel index
shape	Desired output waveform

Implements FunctionGenerator.

◆ SetInterleaving()

bool MagnovaOscilloscope::SetInterleaving ( bool combine )

overridevirtual

Configures the scope to combine channels.

This function may fail to enable channel combining if conflicts are present, check the return value!

Returns: True if channel combining is enabled, false if not

Implements Oscilloscope.

◆ SetSampleDepth()

void MagnovaOscilloscope::SetSampleDepth ( uint64_t depth )

overridevirtual

Sets the sample depth of the scope.

Implements Oscilloscope.

◆ SetSampleRate()

void MagnovaOscilloscope::SetSampleRate ( uint64_t rate )

overridevirtual

Sets the sample rate of the scope, in Hz.

Implements Oscilloscope.

◆ SetTriggerOffset()

void MagnovaOscilloscope::SetTriggerOffset ( int64_t offset )

overridevirtual

Sets the trigger offset.

Parameters

offset Femtoseconds from the start of the capture to the trigger point. Positive values mean the trigger is within the waveform. Negative values mean there is a delay from the trigger point to the start of the waveform.

Implements Oscilloscope.

◆ SetUseExternalRefclk()

void MagnovaOscilloscope::SetUseExternalRefclk ( bool external )

overridevirtual

Configures the instrument's clock source.

Parameters

external True to use external reference False to use internal clock

The default implementation prints an "unsupported operation" warning, and is suitable for lower-end instruments that do not support external clock inputs.

Reimplemented from Oscilloscope.

◆ Start()

void MagnovaOscilloscope::Start ( )

overridevirtual

Starts the instrument in continuous trigger mode.

Most drivers will implement this as repeated calls to the "single trigger" function to avoid race conditions when the instrument triggers halfway through downloading captured waveforms.

Implements Oscilloscope.

◆ StartSingleTrigger()

void MagnovaOscilloscope::StartSingleTrigger ( )

overridevirtual

Arms the trigger for a single acquistion.

Implements Oscilloscope.

◆ Stop()

void MagnovaOscilloscope::Stop ( )

overridevirtual

Stops triggering.

Implements Oscilloscope.

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

lib/scopehal/MagnovaOscilloscope.h
lib/scopehal/MagnovaOscilloscope.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ AcquireData()

◆ CanEnableChannel()

◆ CanInvert()

◆ DisableChannel()

◆ EnableChannel()

◆ EnableTriggerOutput()

◆ FlushConfigCache()

◆ ForceTrigger()

◆ GetADCMode()

◆ GetADCModeNames()

◆ GetAvailableCouplings()

◆ GetAvailableWaveformShapes()

◆ GetChannelAttenuation()

◆ GetChannelBandwidthLimit()

◆ GetChannelBandwidthLimiters()

◆ GetChannelCoupling()

◆ GetChannelDisplayName()

◆ GetChannelOffset()

◆ GetChannelVoltageRange()

◆ GetDeskewForChannel()

◆ GetDigitalBank()

◆ GetDigitalBanks()

◆ GetDigitalHysteresis()

◆ GetDigitalThreshold()

◆ GetExternalTrigger()

◆ GetFunctionChannelActive()

◆ GetFunctionChannelAmplitude()

◆ GetFunctionChannelDutyCycle()

◆ GetFunctionChannelFallTime()

◆ GetFunctionChannelFrequency()

◆ GetFunctionChannelOffset()

◆ GetFunctionChannelOutputImpedance()

◆ GetFunctionChannelRiseTime()

◆ GetFunctionChannelShape()

◆ GetInstrumentTypes()

◆ GetInstrumentTypesForChannel()

◆ GetInterleaveConflicts()

◆ GetSampleDepth()

◆ GetSampleDepthsInterleaved()

◆ GetSampleDepthsNonInterleaved()

◆ GetSampleRate()

◆ GetSampleRatesInterleaved()

◆ GetSampleRatesNonInterleaved()

◆ GetTimebaseScale()

◆ GetTriggerOffset()

◆ GetTriggerTypes()

◆ HasFunctionRiseFallTimeControls()

◆ Invert()

◆ IsADCModeConfigurable()

◆ IsChannelEnabled()

◆ IsDigitalHysteresisConfigurable()

◆ IsDigitalThresholdConfigurable()

◆ IsInterleaving()

◆ IsInverted()

◆ IsTriggerArmed()

◆ parseMetadata()

◆ PollTrigger()

◆ PullTrigger()

◆ PushNthEdgeBurstTrigger()

◆ PushTrigger()

◆ SetADCMode()

◆ SetChannelAttenuation()

◆ SetChannelBandwidthLimit()

◆ SetChannelCoupling()

◆ SetChannelDisplayName()

◆ SetChannelOffset()

◆ SetChannelVoltageRange()

◆ SetDeskewForChannel()

◆ SetDigitalHysteresis()

◆ SetDigitalThreshold()

◆ SetFunctionChannelActive()