C++ Instrument Catalog
Public Member Functions | Protected Attributes | List of all members
MTL::Instrument::CVISAInstrument Class Reference

VISA instrument class. More...

#include <VISAInstrument.h>

Inheritance diagram for MTL::Instrument::CVISAInstrument:
MTL::Instrument::CMFC3045Instrument MTL::Instrument::CPT2026Instrument MTL::Instrument::CUSBRemoteBox

Public Member Functions

 CVISAInstrument (CVISAResourceManager &rRM, tResourceName Rsrc)
 
virtual ~CVISAInstrument ()
 
bool Open (eOpenAccessMode AccessMode=eOpenAccessMode::NoLock, ViUInt32 Timeout_ms=0)
 
void Close ()
 
bool IsOpen ()
 
const ViStatus & Status ()
 
const ViSession & Session ()
 
bool Write (const char *Str)
 
bool Write (const std::string &rStr)
 
bool Write (const CVISABuffer &rBuf)
 
bool Write (const ViBuf WriteBuf, ViUInt32 BuffLen)
 
bool Read (CVISABuffer &rBuf, bool Append=false)
 
bool Read (ViPBuf ReadBuf, ViUInt32 ReadLen, ViUInt32 &rRetLen)
 
bool SetTimeout (ViUInt32 Timeout)
 
bool Clear ()
 
bool ReadSTB (ViUInt16 &rSTB)
 
bool AssertTrigger (eTriggerProtocol Protocol)
 
bool LockExclusive (ViUInt32 Timeout)
 
bool LockShared (ViUInt32 Timeout, ViKeyId RequestedKey, ViChar AccessKey[])
 
bool Unlock ()
 
bool EnableEvent (eEventType Type, eEventMechanism Mechanism)
 
bool DisableEvent (eEventType Type, eEventMechanism Mechanism)
 
bool WaitOnEvent (eEventType Type, ViUInt32 Timeout)
 
bool WaitOnAllEvents (ViUInt32 Timeout)
 
bool DiscardEvents (eEventType Type, eEventMechanism Mechanism)
 
bool GetAttribute (ViAttr Attribute, void *Value)
 
bool UsbControlIn (ViInt16 bmRequestType, ViInt16 bRequest, ViUInt16 wValue, ViUInt16 wIndex, ViUInt16 wLength, ViPBuf buf, ViUInt16 &rretCnt)
 
bool UsbControlOut (ViInt16 bmRequestType, ViInt16 bRequest, ViUInt16 wValue, ViUInt16 wIndex, ViUInt16 wLength, ViBuf buf)
 
bool ConfigSerialPort (const sSerialPortSettings &rPortSettings)
 

Protected Attributes

CRecursiveMutex m_Lock
 
CVISAResourceManagerm_rRrsrcMan
 
tResourceName m_Rsrc
 
ViSession m_InstrSession
 
ViStatus m_Status
 

Detailed Description

VISA instrument class.

Definition at line 60 of file VISAInstrument.h.

Constructor & Destructor Documentation

◆ CVISAInstrument()

CVISAInstrument::CVISAInstrument ( CVISAResourceManager rRM,
tResourceName  Rsrc 
)

Definition at line 322 of file VISAInstrument.cpp.

◆ ~CVISAInstrument()

CVISAInstrument::~CVISAInstrument ( )
virtual

Definition at line 326 of file VISAInstrument.cpp.

Member Function Documentation

◆ AssertTrigger()

bool CVISAInstrument::AssertTrigger ( eTriggerProtocol  Protocol)

Definition at line 545 of file VISAInstrument.cpp.

◆ Clear()

bool CVISAInstrument::Clear ( )

Definition at line 477 of file VISAInstrument.cpp.

◆ Close()

void CVISAInstrument::Close ( )

Definition at line 356 of file VISAInstrument.cpp.

◆ ConfigSerialPort()

bool CVISAInstrument::ConfigSerialPort ( const sSerialPortSettings rPortSettings)

Definition at line 765 of file VISAInstrument.cpp.

◆ DisableEvent()

bool CVISAInstrument::DisableEvent ( eEventType  Type,
eEventMechanism  Mechanism 
)

Definition at line 628 of file VISAInstrument.cpp.

◆ DiscardEvents()

bool CVISAInstrument::DiscardEvents ( eEventType  Type,
eEventMechanism  Mechanism 
)

Definition at line 676 of file VISAInstrument.cpp.

◆ EnableEvent()

bool CVISAInstrument::EnableEvent ( eEventType  Type,
eEventMechanism  Mechanism 
)

Definition at line 612 of file VISAInstrument.cpp.

◆ GetAttribute()

bool CVISAInstrument::GetAttribute ( ViAttr  Attribute,
void *  Value 
)

Definition at line 695 of file VISAInstrument.cpp.

◆ IsOpen()

bool CVISAInstrument::IsOpen ( )

Definition at line 369 of file VISAInstrument.cpp.

◆ LockExclusive()

bool CVISAInstrument::LockExclusive ( ViUInt32  Timeout)

Definition at line 557 of file VISAInstrument.cpp.

◆ LockShared()

bool CVISAInstrument::LockShared ( ViUInt32  Timeout,
ViKeyId  RequestedKey,
ViChar  AccessKey[] 
)

Definition at line 574 of file VISAInstrument.cpp.

◆ Open()

bool CVISAInstrument::Open ( eOpenAccessMode  AccessMode = eOpenAccessMode::NoLock,
ViUInt32  Timeout_ms = 0 
)

Definition at line 335 of file VISAInstrument.cpp.

◆ Read() [1/2]

bool CVISAInstrument::Read ( CVISABuffer rBuf,
bool  Append = false 
)

Definition at line 430 of file VISAInstrument.cpp.

◆ Read() [2/2]

bool CVISAInstrument::Read ( ViPBuf  ReadBuf,
ViUInt32  ReadLen,
ViUInt32 &  rRetLen 
)

Definition at line 448 of file VISAInstrument.cpp.

◆ ReadSTB()

bool CVISAInstrument::ReadSTB ( ViUInt16 &  rSTB)

Definition at line 486 of file VISAInstrument.cpp.

◆ Session()

const ViSession & CVISAInstrument::Session ( )

Definition at line 384 of file VISAInstrument.cpp.

◆ SetTimeout()

bool CVISAInstrument::SetTimeout ( ViUInt32  Timeout)

Definition at line 468 of file VISAInstrument.cpp.

◆ Status()

const ViStatus & CVISAInstrument::Status ( )

Definition at line 378 of file VISAInstrument.cpp.

◆ Unlock()

bool CVISAInstrument::Unlock ( )

Definition at line 591 of file VISAInstrument.cpp.

◆ UsbControlIn()

bool CVISAInstrument::UsbControlIn ( ViInt16  bmRequestType,
ViInt16  bRequest,
ViUInt16  wValue,
ViUInt16  wIndex,
ViUInt16  wLength,
ViPBuf  buf,
ViUInt16 &  rretCnt 
)

Definition at line 715 of file VISAInstrument.cpp.

◆ UsbControlOut()

bool CVISAInstrument::UsbControlOut ( ViInt16  bmRequestType,
ViInt16  bRequest,
ViUInt16  wValue,
ViUInt16  wIndex,
ViUInt16  wLength,
ViBuf  buf 
)

Definition at line 739 of file VISAInstrument.cpp.

◆ WaitOnAllEvents()

bool CVISAInstrument::WaitOnAllEvents ( ViUInt32  Timeout)

Definition at line 660 of file VISAInstrument.cpp.

◆ WaitOnEvent()

bool CVISAInstrument::WaitOnEvent ( eEventType  Type,
ViUInt32  Timeout 
)

Definition at line 644 of file VISAInstrument.cpp.

◆ Write() [1/4]

bool CVISAInstrument::Write ( const char *  Str)

Definition at line 393 of file VISAInstrument.cpp.

◆ Write() [2/4]

bool CVISAInstrument::Write ( const CVISABuffer rBuf)

Definition at line 405 of file VISAInstrument.cpp.

◆ Write() [3/4]

bool CVISAInstrument::Write ( const std::string &  rStr)

Definition at line 399 of file VISAInstrument.cpp.

◆ Write() [4/4]

bool CVISAInstrument::Write ( const ViBuf  WriteBuf,
ViUInt32  BuffLen 
)

Definition at line 411 of file VISAInstrument.cpp.

Member Data Documentation

◆ m_InstrSession

ViSession MTL::Instrument::CVISAInstrument::m_InstrSession
protected

Definition at line 66 of file VISAInstrument.h.

◆ m_Lock

CRecursiveMutex MTL::Instrument::CVISAInstrument::m_Lock
mutableprotected

Definition at line 63 of file VISAInstrument.h.

◆ m_rRrsrcMan

CVISAResourceManager& MTL::Instrument::CVISAInstrument::m_rRrsrcMan
protected

Definition at line 64 of file VISAInstrument.h.

◆ m_Rsrc

tResourceName MTL::Instrument::CVISAInstrument::m_Rsrc
protected

Definition at line 65 of file VISAInstrument.h.

◆ m_Status

ViStatus MTL::Instrument::CVISAInstrument::m_Status
protected

Definition at line 67 of file VISAInstrument.h.


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