|
ngscopeclient v0.2
|


Classes | |
| struct | Logicpod |
| struct | Metadata |
Public Member Functions | |
| RSRTB2kOscilloscope (SCPITransport *transport) | |
| RSRTB2kOscilloscope (const RSRTB2kOscilloscope &rhs)=delete | |
| RSRTB2kOscilloscope & | operator= (const RSRTB2kOscilloscope &rhs)=delete |
| virtual unsigned int | GetInstrumentTypes () const override |
| Returns a bitfield describing the set of instrument types that this instrument supports. | |
| virtual uint32_t | GetInstrumentTypesForChannel (size_t i) const override |
| Returns a bitfield describing the set of instrument types that a given channel supports. | |
| virtual void | FlushConfigCache () override |
| Instruments are allowed to cache configuration settings to reduce round trip queries to the device. | |
| void | ForceHDMode (bool mode) |
| Forces 16-bit transfer mode on/off when for HD models. | |
| virtual bool | IsChannelEnabled (size_t i) override |
| Checks if a channel is enabled in hardware. | |
| virtual void | EnableChannel (size_t i) override |
| Turn a channel on, given the index. | |
| virtual bool | CanEnableChannel (size_t i) override |
| Determines if a channel can be enabled. | |
| virtual void | DisableChannel (size_t i) override |
| Turn a channel off, given the index. | |
| virtual OscilloscopeChannel::CouplingType | GetChannelCoupling (size_t i) override |
| Gets the coupling used for an input channel. | |
| virtual void | SetChannelCoupling (size_t i, OscilloscopeChannel::CouplingType type) override |
| Sets the coupling used for an input channel. | |
| virtual std::vector< OscilloscopeChannel::CouplingType > | GetAvailableCouplings (size_t i) override |
| Gets the set of legal coupling values for an input channel. | |
| virtual double | GetChannelAttenuation (size_t i) override |
| Gets the probe attenuation for an input channel. | |
| virtual void | SetChannelAttenuation (size_t i, double atten) override |
| Sets the probe attenuation used for an input channel. | |
| virtual unsigned int | GetChannelBandwidthLimit (size_t i) override |
| Gets the bandwidth limit for an input channel. | |
| virtual void | SetChannelBandwidthLimit (size_t i, unsigned int limit_mhz) override |
| Sets the bandwidth limit for an input channel. | |
| virtual float | GetChannelVoltageRange (size_t i, size_t stream) override |
| Gets the range of the current channel configuration. | |
| virtual void | SetChannelVoltageRange (size_t i, size_t stream, float range) override |
| Sets the range of the current channel configuration. | |
| virtual OscilloscopeChannel * | GetExternalTrigger () override |
| Returns the external trigger input channel, if we have one. | |
| virtual float | GetChannelOffset (size_t i, size_t stream) override |
| Gets the offset, in volts, for a given channel. | |
| virtual void | SetChannelOffset (size_t i, size_t stream, float offset) override |
| Sets the offset for a given channel. | |
| virtual std::string | GetChannelDisplayName (size_t i) override |
| Gets the hardware display name for a channel. This is an arbitrary user-selected string. | |
| 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. | |
| virtual std::vector< unsigned int > | GetChannelBandwidthLimiters (size_t i) override |
| Gets the set of available bandwidth limiters for an input channel. | |
| virtual bool | CanInvert (size_t i) override |
| Checks if a channel is capable of hardware polarity inversion. | |
| virtual void | Invert (size_t i, bool invert) override |
| Enables hardware polarity inversion for a channel, if supported. | |
| virtual bool | IsInverted (size_t i) override |
| Checks if hardware polarity inversion is enabled for a channel. | |
| virtual Oscilloscope::TriggerMode | PollTrigger () override |
| Checks the curent trigger status. | |
| virtual bool | AcquireData () override |
| Pull data from the instrument. | |
| virtual void | Start () override |
| Starts the instrument in continuous trigger mode. | |
| virtual void | StartSingleTrigger () override |
| Arms the trigger for a single acquistion. | |
| virtual void | Stop () override |
| Stops triggering. | |
| virtual void | ForceTrigger () override |
| Forces a single acquisition as soon as possible. | |
| virtual bool | IsTriggerArmed () override |
| Checks if the trigger is currently armed. | |
| virtual void | PushTrigger () override |
| Pushes changes made to m_trigger to the instrument. | |
| virtual void | PullTrigger () override |
| Updates m_trigger with any changes made from the instrument side. | |
| virtual void | EnableTriggerOutput () override |
| Enables the trigger output, configuring a shared auxiliary port for this purpose if needed. | |
| virtual std::vector< std::string > | GetTriggerTypes () override |
| Gets a list of triggers this instrument supports. | |
| virtual std::vector< uint64_t > | GetSampleRatesNonInterleaved () override |
| Get the legal sampling rates (in Hz) for this scope in all-channels mode. | |
| virtual std::vector< uint64_t > | GetSampleRatesInterleaved () override |
| Get the legal sampling rates (in Hz) for this scope in combined-channels mode. | |
| 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. | |
| virtual std::vector< uint64_t > | GetSampleDepthsInterleaved () override |
| Get the legal memory depths for this scope in combined-channels mode. | |
| virtual uint64_t | GetSampleRate () override |
| Gets the current sampling rate (in Hz) of this scope. | |
| virtual uint64_t | GetSampleDepth () override |
| Gets the current sample depth of this scope. | |
| virtual void | SetSampleDepth (uint64_t depth) override |
| Sets the sample depth of the scope. | |
| virtual void | SetSampleRate (uint64_t rate) override |
| Sets the sample rate of the scope, in Hz. | |
| virtual bool | IsInterleaving () override |
| Checks if the scope is currently combining channels. | |
| virtual bool | SetInterleaving (bool combine) override |
| Configures the scope to combine channels. | |
| virtual void | SetTriggerOffset (int64_t offset) override |
| Sets the trigger offset. | |
| virtual int64_t | GetTriggerOffset () override |
| Gets the trigger offset. | |
| virtual std::vector< WaveShape > | GetAvailableWaveformShapes (int chan) override |
| Query the set of available pre-defined waveforms for this generator. | |
| virtual bool | GetFunctionChannelActive (int chan) override |
| Returns true if the function generator channel's output is enabled. | |
| virtual void | SetFunctionChannelActive (int chan, bool on) override |
| Turns a function generator channel on or off. | |
| virtual float | GetFunctionChannelDutyCycle (int chan) override |
| Gets the duty cycle for a function generator output. | |
| virtual void | SetFunctionChannelDutyCycle (int chan, float duty) override |
| Sets the duty cycle for a function generator output. | |
| virtual float | GetFunctionChannelAmplitude (int chan) override |
| Gets the amplitude for a function generator output. | |
| virtual void | SetFunctionChannelAmplitude (int chan, float amplitude) override |
| Sets the amplitude for a function generator output. | |
| virtual float | GetFunctionChannelOffset (int chan) override |
| Gets the DC offset for a function generator output. | |
| virtual void | SetFunctionChannelOffset (int chan, float offset) override |
| Sets the DC offset for a function generator output. | |
| virtual float | GetFunctionChannelFrequency (int chan) override |
| Gets the frequency for a function generator output. | |
| virtual void | SetFunctionChannelFrequency (int chan, float hz) override |
| Sets the frequency for a function generator output. | |
| virtual WaveShape | GetFunctionChannelShape (int chan) override |
| Gets the waveform shape for a function generator output. | |
| virtual void | SetFunctionChannelShape (int chan, WaveShape shape) override |
| Sets the waveform shape for a function generator output. | |
| virtual bool | HasFunctionRiseFallTimeControls (int chan) override |
| Determines if the function generator allows control over rise/fall times. | |
| virtual OutputImpedance | GetFunctionChannelOutputImpedance (int chan) override |
| Gets the currently selected output impedance for a function generator output (if supported) | |
| virtual void | SetFunctionChannelOutputImpedance (int chan, OutputImpedance z) override |
| Sets the currently selected output impedance for a function generator output (if supported) | |
| virtual float | GetFunctionChannelRiseTime (int) override |
| Gets the rise time for a function generator output (if supported) | |
| virtual void | SetFunctionChannelRiseTime (int, float) override |
| Sets the rise time for a function generator output (if supported) | |
| virtual void | SetFunctionChannelFallTime (int, float) override |
| Sets the fall time for a function generator output (if supported) | |
| virtual float | GetFunctionChannelFallTime (int chan) override |
| Gets the fall time for a function generator output (if supported) | |
| virtual std::vector< DigitalBank > | GetDigitalBanks () override |
| Gets the digital channel banks for this instrument. | |
| virtual DigitalBank | GetDigitalBank (size_t channel) override |
| Gets the bank containing a given channel. | |
| virtual bool | IsDigitalHysteresisConfigurable () override |
| Checks if digital input hysteresis is configurable or fixed. | |
| virtual bool | IsDigitalThresholdConfigurable () override |
| Checks if digital input threshold is configurable or fixed. | |
| virtual float | GetDigitalHysteresis (size_t channel) override |
| Gets the hysteresis for a digital input. | |
| virtual float | GetDigitalThreshold (size_t channel) override |
| Gets the threshold for a digital input. | |
| virtual void | SetDigitalHysteresis (size_t channel, float level) override |
| Sets the hysteresis for a digital input. | |
| virtual void | SetDigitalThreshold (size_t channel, float level) override |
| Gets the threshold for a digital input. | |
Public Member Functions inherited from SCPIOscilloscope | |
| virtual std::string | IDPing () |
| Returns the instrument's identification string. | |
Public Member Functions inherited from Oscilloscope | |
| OscilloscopeChannel * | GetOscilloscopeChannel (size_t i) |
| Gets a channel by index. | |
| int | GetEnabledChannelCount () |
| Returns the number of enabled channels for this oscilloscope. | |
| OscilloscopeChannel * | GetOscilloscopeChannelByHwName (const std::string &name) |
| Gets a channel given the hardware name. | |
| virtual bool | CanAutoZero (size_t i) |
| Determines if a channel has a probe connected which supports the "auto zero" feature. | |
| virtual void | AutoZero (size_t i) |
| Performs an "auto zero" cycle on the attached active probe, if supported by the hardware. | |
| virtual bool | CanDegauss (size_t i) |
| Determines if a channel has a probe connected which supports the "degauss" feature. | |
| virtual bool | ShouldDegauss (size_t i) |
| Determines if a channel requires a degauss cycle (if supported) | |
| virtual void | Degauss (size_t i) |
| Performs an "degauss" cycle on the attached active probe, if supported by the hardware. | |
| virtual bool | CanAverage (size_t i) |
| Determines if the channel supports hardware averaging. | |
| virtual size_t | GetNumAverages (size_t i) |
| Returns the number of averages the channel is configured for. | |
| virtual void | SetNumAverages (size_t i, size_t navg) |
| Sets the number of hardware averages to use. | |
| virtual std::string | GetProbeName (size_t i) |
| Returns the name of the probe connected to the scope, if possible. | |
| virtual bool | HasInputMux (size_t i) |
| Checks if a channel has an input multiplexer. | |
| virtual size_t | GetInputMuxSetting (size_t i) |
| Gets the setting for a channel's input mux (if it has one) | |
| virtual std::vector< std::string > | GetInputMuxNames (size_t i) |
| Gets names for the input mux ports of a channel. | |
| virtual void | SetInputMux (size_t i, size_t select) |
| Sets the input mux for a channel. | |
| virtual bool | IsHighRateOffsetCapable (size_t i) |
| Checks if the channel supports high rate offset changes, or if the GUI should rate-limit. | |
| virtual bool | PeekTriggerArmed () |
| Checks if the trigger is armed directly on the instrument, without altering internal state or touching caches. | |
| bool | WaitForTrigger (int timeout) |
| Block until a trigger happens or a timeout elapses. | |
| void | SetTrigger (Trigger *trigger) |
| Sets a new trigger on the instrument and pushes changes. | |
| Trigger * | GetTrigger (bool sync=false) |
| Gets the current trigger. | |
| virtual bool | HasInterleavingControls () |
| Returns true if the scope has a user controllable interleaving feature, false if not. | |
| virtual bool | CanInterleave () |
| Returns true if we have no interleave conflicts, false if we have conflicts. | |
| virtual bool | IsSamplingModeAvailable (SamplingMode mode) |
| Returns true if the requested sampling mode is available with the current instrument configuration. | |
| virtual SamplingMode | GetSamplingMode () |
| Gets the current sampling mode of the instrument. | |
| virtual void | SetSamplingMode (SamplingMode mode) |
| Sets the current sampling mode of the instrument. | |
| virtual void | SetUseExternalRefclk (bool external) |
| Configures the instrument's clock source. | |
| virtual void | SetDeskewForChannel (size_t channel, int64_t skew) |
| Sets the deskew setting for a channel. | |
| virtual int64_t | GetDeskewForChannel (size_t channel) |
| Gets the deskew setting for a channel. | |
| virtual std::vector< AnalogBank > | GetAnalogBanks () |
| Gets the analog banks for this instrument. | |
| virtual AnalogBank | GetAnalogBank (size_t channel) |
| Gets the bank containing a given channel. | |
| 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. | |
| 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. | |
| virtual size_t | GetADCMode (size_t channel) |
| Gets the ADC mode for a channel. | |
| virtual void | SetADCMode (size_t channel, size_t mode) |
| Sets the ADC mode for a channel. | |
| virtual void | SetSpan (int64_t span) |
| Sets the span for frequency-domain channels. | |
| virtual int64_t | GetSpan () |
| Gets the span for frequency-domain channels. | |
| virtual void | SetCenterFrequency (size_t channel, int64_t freq) |
| Sets the center frequency for frequency-domain channels. | |
| virtual int64_t | GetCenterFrequency (size_t channel) |
| Gets the center frequency for a frequency-domain channel. | |
| virtual void | SetResolutionBandwidth (int64_t rbw) |
| Gets the resolution bandwidth for frequency-domain channels. | |
| virtual int64_t | GetResolutionBandwidth () |
| Gets the resolution bandwidth for frequency-domain channels. | |
| virtual bool | HasFrequencyControls () |
| Returns true if the instrument has at least one frequency-domain channel. | |
| virtual bool | HasResolutionBandwidth () |
| Returns true if the instrument has a resolution bandwidth setting. | |
| virtual bool | HasTimebaseControls () |
| Returns true if the instrument has at least one time-domain channel. | |
| 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. | |
| double | GetWaveformDownloadRate () |
| bool | HasPendingDiagnosticLogMessages () |
| std::string | PopPendingDiagnosticLogMessage () |
| std::map< std::string, FilterParameter * > & | GetDiagnosticsValues () |
| bool | FreeWaveformPools () |
| Free all waveforms in our pool to reclaim memory. | |
| void | AddWaveformToAnalogPool (WaveformBase *w) |
| void | AddWaveformToDigitalPool (WaveformBase *w) |
Public Member Functions inherited from Instrument | |
| virtual bool | IsOffline () |
| Checks if the instrument is currently online. | |
| 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. | |
| 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 YAML::Node | SerializeConfiguration (IDTable &table) const |
| Serializes this instrument's configuration to a YAML node. | |
| virtual void | LoadConfiguration (int version, const YAML::Node &node, IDTable &idmap) |
| Load instrument and channel configuration from a save file. | |
| 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. | |
Public Member Functions inherited from SCPIInstrument | |
| SCPIInstrument (SCPITransport *transport, bool identify=true) | |
| virtual std::string | GetTransportConnectionString () override |
| Gets the connection string for our transport. | |
| virtual std::string | GetTransportName () override |
| Gets the name of our transport. | |
| virtual std::string | GetName () const override |
| virtual std::string | GetVendor () const override |
| virtual std::string | GetSerial () const override |
| virtual std::string | GetDriverName () const =0 |
| virtual void | BackgroundProcessing () override |
| Run various background processing typically done by a second thread (e.g. InstrumentThread) | |
Public Member Functions inherited from SCPIDevice | |
| SCPIDevice (SCPITransport *transport, bool identify=true, unsigned int identify_timeout_us=5000000) | |
| SCPIDevice (const SCPIDevice &rhs)=delete | |
| SCPIDevice & | operator= (const SCPIDevice &rhs)=delete |
| SCPITransport * | GetTransport () const |
Public Member Functions inherited from FunctionGenerator | |
| virtual bool | HasFunctionDutyCycleControls (int chan) |
| Determines if the function generator allows control over duty cycles. | |
| virtual bool | HasFunctionImpedanceControls (int chan) |
| Determines if the function generator allows control over rise/fall times. | |
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 void | Convert8BitSamples (float *pout, const uint8_t *pin, float gain, float offset, size_t count) |
| Converts 8-bit ADC samples to floating point. | |
| static void | Convert8BitSamplesGeneric (float *pout, const uint8_t *pin, float gain, float offset, size_t count) |
| Generic backend for Convert8BitSamples() | |
| 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 | DoAddDriverClass (const std::string &name, CreateProcType proc) |
| static void | EnumDrivers (std::vector< std::string > &names) |
| static std::shared_ptr< Oscilloscope > | CreateOscilloscope (const std::string &driver, SCPITransport *transport) |
Static Public Member Functions inherited from SCPIInstrument | |
| static void | DoAddDriverClass (const std::string &name, GetTransportsProcType proc) |
| static std::vector< SCPIInstrumentModel > | GetSupportedModels (const std::string &driver) |
| static std::vector< SCPIInstrumentModel > | GetDriverSupportedModels () |
Static Public Member Functions inherited from SCPIFunctionGenerator | |
| static void | DoAddDriverClass (const std::string &name, GeneratorCreateProcType proc) |
| static void | EnumDrivers (std::vector< std::string > &names) |
| static std::shared_ptr< SCPIFunctionGenerator > | CreateFunctionGenerator (const 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. | |
| static WaveShape | GetShapeOfName (const std::string &name) |
| Converts a human readable name to a WaveShape. | |
| static std::string | GetNameOfImpedance (OutputImpedance imp) |
| Converts an OutputImpedance enum to a human readable name. | |
| static OutputImpedance | GetImpedanceOfName (const std::string &name) |
| Converts a human readable name to an OutputImpedance. | |
Protected Member Functions | |
| void | IdentifyHardware () |
| void | DetectOptions () |
| virtual void | AddAnalogChannels () |
| void | AddDigitalChannels () |
| void | AddExternalTriggerChannel () |
| void | AddLineTriggerChannel () |
| void | AddAwgChannel () |
| std::string | PullTriggerSourceNumber (bool noDigital) |
| void | PullTriggerSource (Trigger *trig, std::string triggerModeName, bool isUart) |
| Reads the source of a trigger from the instrument. | |
| void | PullEdgeTrigger () |
| Reads settings for an edge trigger from the instrument. | |
| void | PullLineTrigger () |
| Reads settings for a line trigger from the instrument. | |
| void | PullRiseTimeTrigger () |
| Reads settings for a rise time trigger from the instrument. | |
| void | PullRuntTrigger () |
| Reads settings for a runt-pulse trigger from the instrument. | |
| void | PullTimeoutTrigger () |
| Reads settings for a timeout trigger from the instrument. | |
| void | PullVideoTrigger () |
| Reads settings for a video trigger from the instrument. | |
| void | PullWidthTrigger () |
| Reads settings for an edge trigger from the instrument. | |
| void | GetTriggerHysteresis (Trigger *trig, std::string reply) |
| Processes the channel hystersis for an trigger. | |
| void | GetTriggerSlope (Trigger *trig, std::string reply) |
| Processes the slope for an edge or edge-derived trigger. | |
| void | GetTriggerCoupling (Trigger *trig, std::string reply) |
| Processes the coupling for an edge or edge-derived trigger. | |
| Trigger::Condition | GetCondition (std::string reply) |
| Parses a trigger condition. | |
| void | PushCondition (const std::string &path, Trigger::Condition cond) |
| Pushes settings for a trigger condition under a .Condition field. | |
| void | PushFloat (const std::string &path, float f) |
| void | PushEdgeTrigger (EdgeTrigger *trig, const std::string &trigType) |
| Pushes settings for an edge trigger to the instrument. | |
| void | PushLineTrigger (LineTrigger *trig) |
| Pushes settings for a line trigger to the instrument. | |
| void | PushRiseTimeTrigger (RSRTB2kRiseTimeTrigger *trig) |
| Pushes settings for a slew rate trigger to the instrument. | |
| void | PushRuntTrigger (RSRTB2kRuntTrigger *trig) |
| Pushes settings for a runt trigger to the instrument. | |
| void | PushTimeoutTrigger (RSRTB2kTimeoutTrigger *trig) |
| Pushes settings for a timeout trigger to the instrument. | |
| void | PushVideoTrigger (RSRTB2kVideoTrigger *trig) |
| Pushes settings for a video trigger to the instrument. | |
| void | PushWidthTrigger (RSRTB2kWidthTrigger *trig) |
| Pushes settings for a pulse width trigger to the instrument. | |
| void | BulkCheckChannelEnableState () |
| Optimized function for checking channel enable status en masse with less round trips to the scope. | |
| void | PrepareAcquisition () |
| void | SetupForAcquisition () |
| std::string | GetDigitalChannelBankName (size_t channel) |
| std::string | GetChannelName (size_t channel) |
| bool | GetActiveChannels (bool *pod1, bool *pod2, bool *chan1, bool *chan2, bool *chan3, bool *chan4) |
| size_t | ReadWaveformBlock (std::vector< uint8_t > *data, Metadata *metadata, std::function< void(float)> progress=nullptr) |
| std::vector< WaveformBase * > | ProcessAnalogWaveform (const std::vector< uint8_t > &data, size_t dataLen, time_t ttime, uint32_t sampleCount, uint32_t bytePerSample, float verticalStep, float verticalStart, float interval, 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. | |
| 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 | InitVulkanQueue (const char *debugName) |
| Initializes the Vulkan queue and command buffer. | |
| void | AddDiagnosticLog (const 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. | |
| 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. | |
Protected Attributes | |
| unsigned int | m_analogChannelCount |
| unsigned int | m_digitalChannelCount |
| unsigned int | m_analogAndDigitalChannelCount |
| size_t | m_digitalChannelBase |
| bool | m_hasLA |
| bool | m_hasDVM |
| bool | m_hasFunctionGen |
| bool | m_hasI2cTrigger |
| bool | m_hasSpiTrigger |
| bool | m_hasUartTrigger |
| bool | m_hasCanTrigger |
| bool | m_hasLinTrigger |
| unsigned int | m_maxBandwidth |
| bool | m_triggerForced |
| std::map< size_t, float > | m_channelVoltageRanges |
| std::map< size_t, float > | m_channelOffsets |
| std::map< std::string, float > | m_channelDigitalHysteresis |
| 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_memoryDepthAuto |
| bool | m_triggerOffsetValid |
| int64_t | m_triggerOffset |
| int64_t | m_triggerReference |
| 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 |
| bool | m_highDefinition |
| OscilloscopeChannel * | m_extTrigChannel |
| OscilloscopeChannel * | m_lineTrigChannel |
| 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::shared_ptr< QueueHandle > | m_queue |
| Vulkan queue for GPU waveform processing. | |
| std::unique_ptr< vk::raii::CommandPool > | m_pool |
| Vulkan command pool for GPU waveform processing. | |
| std::unique_ptr< vk::raii::CommandBuffer > | m_cmdBuf |
| Vulkan command buffer for GPU waveform processing. | |
| std::list< SequenceSet > | m_pendingWaveforms |
| std::mutex | m_pendingWaveformsMutex |
| std::recursive_mutex | m_mutex |
| HzClock | m_downloadClock |
| 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 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. | |
| 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 SCPIInstrument | |
| typedef std::vector< SCPIInstrumentModel >(* | GetTransportsProcType) () |
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 Attributes inherited from Instrument | |
| std::string | m_nickname |
| Optional user-selected nickname of the instrument. | |
Protected Types inherited from Oscilloscope | |
| typedef std::map< StreamDescriptor, WaveformBase * > | SequenceSet |
| typedef std::map< std::string, CreateProcType > | CreateMapType |
Protected Types inherited from SCPIInstrument | |
| typedef std::map< std::string, GetTransportsProcType > | GetTransportMapType |
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 SCPIInstrument | |
| static GetTransportMapType | m_getTransportProcs |
Static Protected Attributes inherited from SCPIFunctionGenerator | |
| static GeneratorCreateMapType | m_gencreateprocs |
|
overridevirtual |
Pull data from the instrument.
Implements Instrument.
Determines if a channel can be enabled.
True if the channel is available or is already enabled.
| i | Zero-based index of channel |
The default implementation always returns true.
Reimplemented from Oscilloscope.
Checks if a channel is capable of hardware polarity inversion.
| i | Zero-based index of channel |
Reimplemented from Oscilloscope.
Turn a channel off, given the index.
This function may optionally configure channel interleaving, if supported in hardware.
| i | Zero-based index of channel |
Implements Oscilloscope.
Turn a channel on, given the index.
| i | Zero-based index of channel |
Implements Oscilloscope.
|
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.
|
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.
|
overridevirtual |
Forces a single acquisition as soon as possible.
Note that PollTrigger() may not return 'triggered' immediately, due to command processing latency.
Implements Oscilloscope.
|
overridevirtual |
Gets the set of legal coupling values for an input channel.
| i | Zero-based index of channel |
Implements Oscilloscope.
|
overridevirtual |
Query the set of available pre-defined waveforms for this generator.
| chan | Channel index |
Implements FunctionGenerator.
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.
| i | Zero-based index of channel |
Implements Oscilloscope.
Gets the bandwidth limit for an input channel.
| i | Zero-based index of channel |
Implements Oscilloscope.
Gets the set of available bandwidth limiters for an input channel.
| i | Zero-based index of channel |
Reimplemented from Oscilloscope.
|
overridevirtual |
Gets the coupling used for an input channel.
| i | Zero-based index of channel |
Implements Oscilloscope.
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.
| i | Zero-based index of channel |
Reimplemented from Instrument.
Gets the offset, in volts, for a given channel.
| 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.
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.
| 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.
|
overridevirtual |
Gets the bank containing a given channel.
Reimplemented from Oscilloscope.
|
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.
Gets the hysteresis for a digital input.
Reimplemented from Oscilloscope.
Gets the threshold for a digital input.
Reimplemented from Oscilloscope.
|
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.
Returns true if the function generator channel's output is enabled.
| chan | Channel index |
Implements FunctionGenerator.
Gets the amplitude for a function generator output.
| chan | Channel index |
Implements FunctionGenerator.
Gets the duty cycle for a function generator output.
| chan | Channel index |
Reimplemented from FunctionGenerator.
Gets the fall time for a function generator output (if supported)
| chan | Channel index |
Reimplemented from FunctionGenerator.
Gets the frequency for a function generator output.
| chan | Channel index |
Implements FunctionGenerator.
Gets the DC offset for a function generator output.
| chan | Channel index |
Implements FunctionGenerator.
|
overridevirtual |
Gets the currently selected output impedance for a function generator output (if supported)
| chan | Channel index |
Reimplemented from FunctionGenerator.
Gets the rise time for a function generator output (if supported)
| chan | Channel index |
Reimplemented from FunctionGenerator.
|
overridevirtual |
Gets the waveform shape for a function generator output.
| chan | Channel index |
Implements FunctionGenerator.
Returns a bitfield describing the set of instrument types that this instrument supports.
Not all types may be available on a given channel.
Implements Instrument.
Returns a bitfield describing the set of instrument types that a given channel supports.
| i | Channel index |
Implements Instrument.
|
overridevirtual |
Implements Oscilloscope.
|
overridevirtual |
Gets the current sample depth of this scope.
Implements Oscilloscope.
Get the legal memory depths for this scope in combined-channels mode.
Implements Oscilloscope.
Get the legal memory depths for this scope in all-channels mode.
Implements Oscilloscope.
|
overridevirtual |
Gets the current sampling rate (in Hz) of this scope.
Implements Oscilloscope.
Get the legal sampling rates (in Hz) for this scope in combined-channels mode.
Implements Oscilloscope.
Get the legal sampling rates (in Hz) for this scope in all-channels mode.
Implements Oscilloscope.
|
overridevirtual |
Gets the trigger offset.
Implements Oscilloscope.
Gets a list of triggers this instrument supports.
Reimplemented from Oscilloscope.
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.
| chan | Channel index |
Implements FunctionGenerator.
Enables hardware polarity inversion for a channel, if supported.
| i | Zero-based index of channel |
| invert | True to invert, false for normal operation |
Reimplemented from Oscilloscope.
Checks if a channel is enabled in hardware.
Implements Oscilloscope.
|
overridevirtual |
Checks if digital input hysteresis is configurable or fixed.
Reimplemented from Oscilloscope.
|
overridevirtual |
Checks if digital input threshold is configurable or fixed.
Reimplemented from Oscilloscope.
|
overridevirtual |
Checks if the scope is currently combining channels.
Implements Oscilloscope.
Checks if hardware polarity inversion is enabled for a channel.
| i | Zero-based index of channel |
Reimplemented from Oscilloscope.
|
overridevirtual |
Checks if the trigger is currently armed.
Implements Oscilloscope.
|
overridevirtual |
Checks the curent trigger status.
Implements Oscilloscope.
|
overridevirtual |
Updates m_trigger with any changes made from the instrument side.
Implements Oscilloscope.
|
overridevirtual |
Pushes changes made to m_trigger to the instrument.
Implements Oscilloscope.
Sets the probe attenuation used for an input channel.
| i | Zero-based index of channel |
| atten | Attenuation factor |
Implements Oscilloscope.
|
overridevirtual |
Sets the bandwidth limit for an input channel.
| i | Zero-based index of channel |
| limit_mhz | Bandwidth limit, in MHz. Zero means "no bandwidth limit". |
Implements Oscilloscope.
|
overridevirtual |
Sets the coupling used for an input channel.
| i | Zero-based index of channel |
Implements Oscilloscope.
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.
| i | Zero-based index of channel |
| name | Name of the channel |
Reimplemented from Instrument.
|
overridevirtual |
Sets the offset for a given channel.
| 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.
|
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.
| 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.
Sets the hysteresis for a digital input.
Reimplemented from Oscilloscope.
Gets the threshold for a digital input.
Reimplemented from Oscilloscope.
Turns a function generator channel on or off.
| chan | Channel index |
| on | True to enable output, false to disable |
Implements FunctionGenerator.
Sets the amplitude for a function generator output.
| chan | Channel index |
| amplitude | Output amplitude, in Vpp |
Implements FunctionGenerator.
Sets the duty cycle for a function generator output.
| chan | Channel index |
| duty | Duty cycle, in range [0, 1] |
Reimplemented from FunctionGenerator.
Sets the fall time for a function generator output (if supported)
| chan | Channel index |
| fs | Fall time, in fs |
Reimplemented from FunctionGenerator.
Sets the frequency for a function generator output.
| chan | Channel index |
| hz | Frequency, in Hz |
Implements FunctionGenerator.
Sets the DC offset for a function generator output.
| chan | Channel index |
| amplitude | Offset, in volts |
Implements FunctionGenerator.
|
overridevirtual |
Sets the currently selected output impedance for a function generator output (if supported)
| chan | Channel index |
| z | Output impedance |
Reimplemented from FunctionGenerator.
Sets the rise time for a function generator output (if supported)
| chan | Channel index |
| fs | Rise time, in fs |
Reimplemented from FunctionGenerator.
Sets the waveform shape for a function generator output.
| chan | Channel index |
| shape | Desired output waveform |
Implements FunctionGenerator.
Configures the scope to combine channels.
This function may fail to enable channel combining if conflicts are present, check the return value!
Implements Oscilloscope.
Sets the sample depth of the scope.
Implements Oscilloscope.
Sets the sample rate of the scope, in Hz.
Implements Oscilloscope.
Sets the trigger offset.
| 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.
|
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.
|
overridevirtual |
Arms the trigger for a single acquistion.
Implements Oscilloscope.
|
overridevirtual |
Stops triggering.
Implements Oscilloscope.