C++ Instrument Catalog
Namespaces | Classes | Typedefs | Enumerations | Functions
MTL::Instrument Namespace Reference

Namespaces

 MFC3045Types
 
 PT2026Types
 

Classes

class  CMFC3045Instrument
 MFC3045 instrument class. More...
 
class  CParsedResourceList
 
class  CPT2026Instrument
 PT2026 instrument class. More...
 
class  CResourceList
 
class  CUSBRemoteBox
 
class  CVISABuffer
 
class  CVISABufferParser
 
class  CVISAInstrument
 VISA instrument class. More...
 
class  CVISAResourceManager
 VISA Resource Manager class. More...
 
struct  sParsedResource
 
struct  sSerialPortSettings
 
class  VISAResourceInfo
 

Typedefs

typedef std::string tResourceName
 
typedef ViUInt16 tInterfaceNumber
 

Enumerations

enum  eInterfaceType {
  eInterfaceType::GPIB = VI_INTF_GPIB, eInterfaceType::VXI = VI_INTF_VXI, eInterfaceType::GPIB_VXI = VI_INTF_GPIB_VXI, eInterfaceType::ASRL = VI_INTF_ASRL,
  eInterfaceType::PXI = VI_INTF_PXI, eInterfaceType::TCPIP = VI_INTF_TCPIP, eInterfaceType::USB = VI_INTF_USB
}
 
enum  eResourceClass {
  eResourceClass::INSTR = 0, eResourceClass::MEMACC, eResourceClass::INTFC, eResourceClass::BACKPLANE,
  eResourceClass::SERVANT, eResourceClass::SOCKET, eResourceClass::RAW
}
 
enum  eOpenAccessMode { eOpenAccessMode::NoLock = VI_NO_LOCK, eOpenAccessMode::ExclusiveLock = VI_EXCLUSIVE_LOCK, eOpenAccessMode::LoadConfig = VI_LOAD_CONFIG }
 
enum  eEventMechanism { eEventMechanism::Queue = VI_QUEUE, eEventMechanism::Handle = VI_HNDLR, eEventMechanism::Suspendedhandler = VI_SUSPEND_HNDLR, eEventMechanism::All = VI_ALL_MECH }
 
enum  eEventType : unsigned long {
  eEventType::ServiceRequest = VI_EVENT_SERVICE_REQ, eEventType::Trig = VI_EVENT_TRIG, eEventType::Clear = VI_EVENT_CLEAR, eEventType::IOCompletion = VI_EVENT_IO_COMPLETION,
  eEventType::Exception = VI_EVENT_EXCEPTION, eEventType::GPIB_CIC = VI_EVENT_GPIB_CIC, eEventType::GPIB_TALK = VI_EVENT_GPIB_TALK, eEventType::GPIB_LISTEN = VI_EVENT_GPIB_LISTEN,
  eEventType::VXI_VME_SYSFAIL = VI_EVENT_VXI_VME_SYSFAIL, eEventType::VXI_VME_SYSRESET = VI_EVENT_VXI_VME_SYSRESET, eEventType::VXI_SIGP = VI_EVENT_VXI_SIGP, eEventType::VXI_VME_INTR = VI_EVENT_VXI_VME_INTR,
  eEventType::PXI_INTR = VI_EVENT_PXI_INTR, eEventType::TCPIP_CONNECT = VI_EVENT_TCPIP_CONNECT, eEventType::USB_INTR = VI_EVENT_USB_INTR, eEventType::ALL = VI_ALL_ENABLED_EVENTS
}
 
enum  eTriggerProtocol {
  eTriggerProtocol::Default = VI_TRIG_PROT_DEFAULT, eTriggerProtocol::VXI_Default = VI_TRIG_PROT_DEFAULT, eTriggerProtocol::VXI_On = VI_TRIG_PROT_ON, eTriggerProtocol::VXI_Off = VI_TRIG_PROT_OFF,
  eTriggerProtocol::VXI_Sync = VI_TRIG_PROT_SYNC, eTriggerProtocol::PXI_Reserve = VI_TRIG_PROT_RESERVE, eTriggerProtocol::PXI_Unreserve = VI_TRIG_PROT_UNRESERVE
}
 
enum  eSerialBaudrate {
  eSerialBaudrate::k110 = 110, eSerialBaudrate::k300 = 300, eSerialBaudrate::k600 = 600, eSerialBaudrate::k1200 = 1200,
  eSerialBaudrate::k2400 = 2400, eSerialBaudrate::k4800 = 4800, eSerialBaudrate::k9600 = 9600, eSerialBaudrate::k14400 = 14400,
  eSerialBaudrate::k19200 = 19200, eSerialBaudrate::k28800 = 28800, eSerialBaudrate::k38400 = 38400, eSerialBaudrate::k57600 = 57600,
  eSerialBaudrate::k115200 = 115200, eSerialBaudrate::k230400 = 230400, eSerialBaudrate::k460800 = 460800, eSerialBaudrate::k921600 = 921600
}
 
enum  eSerialDataBits { eSerialDataBits::k7 = 7, eSerialDataBits::k8 = 8 }
 
enum  eSerialParity {
  eSerialParity::kNone = VI_ASRL_PAR_NONE, eSerialParity::kOdd = VI_ASRL_PAR_ODD, eSerialParity::kEven = VI_ASRL_PAR_EVEN, eSerialParity::kMark = VI_ASRL_PAR_MARK,
  eSerialParity::kSpace = VI_ASRL_PAR_SPACE
}
 
enum  eSerialStopBits { eSerialStopBits::k1 = VI_ASRL_STOP_ONE, eSerialStopBits::k1_5 = VI_ASRL_STOP_ONE5, eSerialStopBits::k2 = VI_ASRL_STOP_TWO }
 
enum  eSerialHandshake { eSerialHandshake::kNone = VI_ASRL_FLOW_NONE, eSerialHandshake::kXonXoff = VI_ASRL_FLOW_XON_XOFF, eSerialHandshake::kHardware = VI_ASRL_FLOW_RTS_CTS, eSerialHandshake::kHardAndSoft = (VI_ASRL_FLOW_XON_XOFF | VI_ASRL_FLOW_RTS_CTS) }
 
enum  eSerialTermMode { eSerialTermMode::kEndNone = VI_ASRL_END_NONE, eSerialTermMode::kEndLast = VI_ASRL_END_LAST_BIT, eSerialTermMode::kEndTermChar = VI_ASRL_END_TERMCHAR, eSerialTermMode::kEndBreak = VI_ASRL_END_BREAK }
 

Functions

std::string StatusDescription (ViSession Session, ViStatus Status)
 Return user-readable description of the given status code. More...
 

Typedef Documentation

◆ tInterfaceNumber

Definition at line 67 of file VISAInstrumentTypes.h.

◆ tResourceName

typedef std::string MTL::Instrument::tResourceName

Definition at line 21 of file VISAInstrumentTypes.h.

Enumeration Type Documentation

◆ eEventMechanism

Enumerator
Queue 
Handle 
Suspendedhandler 
All 

Definition at line 88 of file VISAInstrumentTypes.h.

◆ eEventType

enum MTL::Instrument::eEventType : unsigned long
strong
Enumerator
ServiceRequest 
Trig 
Clear 
IOCompletion 
Exception 
GPIB_CIC 
GPIB_TALK 
GPIB_LISTEN 
VXI_VME_SYSFAIL 
VXI_VME_SYSRESET 
VXI_SIGP 
VXI_VME_INTR 
PXI_INTR 
TCPIP_CONNECT 
USB_INTR 
ALL 

Definition at line 95 of file VISAInstrumentTypes.h.

◆ eInterfaceType

Enumerator
GPIB 
VXI 
GPIB_VXI 
ASRL 
PXI 
TCPIP 
USB 

Definition at line 57 of file VISAInstrumentTypes.h.

◆ eOpenAccessMode

Enumerator
NoLock 
ExclusiveLock 
LoadConfig 

Definition at line 79 of file VISAInstrumentTypes.h.

◆ eResourceClass

Enumerator
INSTR 
MEMACC 
INTFC 
BACKPLANE 
SERVANT 
SOCKET 
RAW 

Definition at line 69 of file VISAInstrumentTypes.h.

◆ eSerialBaudrate

Enumerator
k110 
k300 
k600 
k1200 
k2400 
k4800 
k9600 
k14400 
k19200 
k28800 
k38400 
k57600 
k115200 
k230400 
k460800 
k921600 

Definition at line 124 of file VISAInstrumentTypes.h.

◆ eSerialDataBits

Enumerator
k7 
k8 

Definition at line 142 of file VISAInstrumentTypes.h.

◆ eSerialHandshake

Enumerator
kNone 
kXonXoff 
kHardware 
kHardAndSoft 

Definition at line 159 of file VISAInstrumentTypes.h.

◆ eSerialParity

Enumerator
kNone 
kOdd 
kEven 
kMark 
kSpace 

Definition at line 146 of file VISAInstrumentTypes.h.

◆ eSerialStopBits

Enumerator
k1 
k1_5 
k2 

Definition at line 154 of file VISAInstrumentTypes.h.

◆ eSerialTermMode

Enumerator
kEndNone 
kEndLast 
kEndTermChar 
kEndBreak 

Definition at line 166 of file VISAInstrumentTypes.h.

◆ eTriggerProtocol

Enumerator
Default 
VXI_Default 
VXI_On 
VXI_Off 
VXI_Sync 
PXI_Reserve 
PXI_Unreserve 

Definition at line 114 of file VISAInstrumentTypes.h.

Function Documentation

◆ StatusDescription()

std::string MTL::Instrument::StatusDescription ( ViSession  Session,
ViStatus  Status 
)

Return user-readable description of the given status code.

Parameters
[in]SessionVISA session.
[in]StatusStatus code to be described.
Returns
String with description of given status code.

Definition at line 40 of file VISAInstrument.cpp.