Base class for simulated instruments. More...

#include <MockInstrument.h>

Inheritance diagram for MockInstrument:

[legend]

Collaboration diagram for MockInstrument:

[legend]

Public Member Functions
	MockInstrument (const std::string &name, const std::string &vendor, const std::string &serial, const std::string &transport, const std::string &driver, const std::string &args)
	Initialize the driver.

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

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

virtual void	SetTransportConnectionString (const std::string &args)

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

void	DoSerializeConfiguration (YAML::Node &node, IDTable &table)

void	ClearWarnings (int version, const YAML::Node &node, IDTable &idmap, ConfigWarningList &warnings)

virtual void	BackgroundProcessing () override
	Run various background processing typically done by a second thread (e.g. InstrumentThread)

virtual std::string	GetDriverName () const override

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

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.

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

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.

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

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

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.

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

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

Protected Attributes
std::string	m_transportName

std::string	m_driver

std::string	m_args

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 SCPIInstrument
typedef std::vector< SCPIInstrumentModel >(*	GetTransportsProcType) ()

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 }

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

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

Protected Types inherited from SCPIInstrument
typedef std::map< std::string, GetTransportsProcType >	GetTransportMapType

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

Static Protected Attributes inherited from SCPIInstrument
static GetTransportMapType	m_getTransportProcs

Detailed Description

Base class for simulated instruments.

Member Function Documentation

◆ BackgroundProcessing()

virtual void MockInstrument::BackgroundProcessing ( )

inlineoverridevirtual

Run various background processing typically done by a second thread (e.g. InstrumentThread)

This function must be called constantly in a loop to push pending commands to the instrument, complete nonblocking IO, etc

Reimplemented from SCPIInstrument.

Reimplemented in MockPowerSupply.

◆ GetDriverName()

virtual std::string MockInstrument::GetDriverName ( ) const

inlineoverridevirtual

Implements SCPIInstrument.

◆ GetName()

string MockInstrument::GetName ( ) const

overridevirtual

Reimplemented from SCPIInstrument.

◆ GetSerial()

string MockInstrument::GetSerial ( ) const

overridevirtual

Reimplemented from SCPIInstrument.

◆ GetTransportConnectionString()

string MockInstrument::GetTransportConnectionString ( )

overridevirtual

Gets the connection string for our transport.

Reimplemented from SCPIInstrument.

◆ GetTransportName()

string MockInstrument::GetTransportName ( )

overridevirtual

Gets the name of our transport.

Reimplemented from SCPIInstrument.

◆ GetVendor()

string MockInstrument::GetVendor ( ) const

overridevirtual

Reimplemented from SCPIInstrument.

◆ IsOffline()

bool MockInstrument::IsOffline ( )

overridevirtual

Checks if the instrument is currently online.

Returns: False if the Instrument object is actively connected to a physical scope. True if working offline, a file import, etc.

Reimplemented from Instrument.

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

lib/scopehal/MockInstrument.h
lib/scopehal/MockInstrument.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ BackgroundProcessing()

◆ GetDriverName()

◆ GetName()

◆ GetSerial()

◆ GetTransportConnectionString()

◆ GetTransportName()

◆ GetVendor()

◆ IsOffline()