ngscopeclient v0.2.1
Loading...
Searching...
No Matches
Public Types | Static Public Member Functions | Protected Types | Static Protected Attributes | List of all members
SCPIPowerSupply Class Reference

An SCPI-based power supply. More...

#include <SCPIPowerSupply.h>

Inheritance diagram for SCPIPowerSupply:
Inheritance graph
[legend]
Collaboration diagram for SCPIPowerSupply:
Collaboration graph
[legend]

Public Types

typedef std::shared_ptr< SCPIPowerSupply >(* PowerCreateProcType) (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) ()
 

Static Public Member Functions

static void DoAddDriverClass (const std::string &name, PowerCreateProcType proc)
 
static void EnumDrivers (std::vector< std::string > &names)
 
static std::shared_ptr< SCPIPowerSupplyCreatePowerSupply (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< SCPIInstrumentModelGetSupportedModels (const std::string &driver)
 
static std::vector< SCPIInstrumentModelGetDriverSupportedModels ()
 

Protected Types

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

Static Protected Attributes

static PowerCreateMapType m_powercreateprocs
 
- Static Protected Attributes inherited from SCPIInstrument
static GetTransportMapType m_getTransportProcs
 

Additional Inherited Members

- Public Member Functions inherited from PowerSupply
virtual unsigned int GetInstrumentTypes () const override
 Returns a bitfield describing the set of instrument types that this instrument supports.
 
virtual bool SupportsSoftStart ()
 Determines if the power supply supports soft start.
 
virtual bool SupportsIndividualOutputSwitching ()
 Determines if the power supply supports switching individual output channels.
 
virtual bool SupportsMasterOutputSwitching ()
 Determines if the power supply supports ganged master switching of all outputs.
 
virtual bool SupportsOvercurrentShutdown ()
 Determines if the power supply supports shutdown rather than constant-current mode on overcurrent.
 
virtual bool SupportsVoltageCurrentControl (int chan)
 Determines if the power supply supports voltage/current control for the given channel.
 
virtual bool AcquireData () override
 Pulls data from hardware and updates our measurements.
 
virtual double GetPowerVoltageActual (int chan)=0
 
virtual double GetPowerVoltageNominal (int chan)=0
 
virtual double GetPowerCurrentActual (int chan)=0
 
virtual double GetPowerCurrentNominal (int chan)=0
 
virtual bool GetPowerChannelActive (int chan)
 
virtual bool GetPowerOvercurrentShutdownEnabled (int chan)
 
virtual void SetPowerOvercurrentShutdownEnabled (int chan, bool enable)
 
virtual bool GetPowerOvercurrentShutdownTripped (int chan)
 
virtual void SetPowerVoltage (int chan, double volts)=0
 
virtual void SetPowerCurrent (int chan, double amps)=0
 
virtual void SetPowerChannelActive (int chan, bool on)
 
virtual bool IsPowerConstantCurrent (int chan)=0
 
virtual bool GetMasterPowerEnable ()
 
virtual void SetMasterPowerEnable (bool enable)
 
virtual bool IsSoftStartEnabled (int chan)
 
virtual void SetSoftStartEnabled (int chan, bool enable)
 
virtual int64_t GetSoftStartRampTime (int chan)
 Gets the ramp time for use with soft-start mode.
 
virtual void SetSoftStartRampTime (int chan, int64_t time)
 Sets the ramp time for use with soft-start mode.
 
- Public Member Functions inherited from Instrument
virtual bool IsOffline ()
 Checks if the instrument is currently online.
 
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.
 
InstrumentChannelGetChannel (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.
 
InstrumentChannelGetChannelByDisplayName (const std::string &name)
 Gets a channel given the display name.
 
InstrumentChannelGetChannelByHwName (const std::string &name)
 Gets a channel given the hardware name.
 
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 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
 
SCPIDeviceoperator= (const SCPIDevice &rhs)=delete
 
SCPITransportGetTransport () const
 
- Public Attributes inherited from Instrument
std::string m_nickname
 Optional user-selected nickname of the instrument.
 
- Protected Member Functions inherited from PowerSupply
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.
 
- Protected Member Functions inherited from SCPIInstrument
void DoSerializeConfiguration (YAML::Node &node, IDTable &table)
 
- 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
SCPITransportm_transport
 
std::string m_vendor
 
std::string m_model
 
std::string m_serial
 
std::string m_fwVersion
 

Detailed Description

An SCPI-based power supply.


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