rohdeschwarz  0.2.0
TCPIP socket library for Rohde & Schwarz instrument control
Public Member Functions | List of all members
rohdeschwarz::busses::visa::Visa Class Reference

#include <visa.hpp>

Inheritance diagram for rohdeschwarz::busses::visa::Visa:
rohdeschwarz::busses::Bus

Public Member Functions

 Visa (std::string resource, unsigned int connection_timeout_ms=2000)
 Constructor. More...
 
virtual ~Visa ()
 Destructor. More...
 
virtual std::string endpoint () const
 
virtual int timeout_ms () const
 
virtual bool setTimeout (int timeout_ms)
 
virtual bool readData (unsigned char *buffer, std::size_t bufferSize, std::size_t *readSize=nullptr)
 
virtual bool writeData (const unsigned char *data, std::size_t dataSize, std::size_t *writeSize=nullptr)
 
bool attribute (ViAttr name, ViAttrState *value) const
 get VISA attribute More...
 
bool setAttribute (ViAttr name, ViAttrState value)
 set VISA attribute More...
 
ViStatus status () const
 Returns current ViStatus value. More...
 
virtual std::string statusMessage () const
 Returns a human-friendly message for the current ViStatus value. More...
 
bool isError () const
 Checks if there is a visa error. More...
 
- Public Member Functions inherited from rohdeschwarz::busses::Bus
 Bus ()
 Constructor. More...
 
virtual ~Bus ()
 Destructor. More...
 
std::size_t bufferSize_B () const
 
void setBufferSize (std::size_t bytes)
 
std::vector< unsigned char > * buffer ()
 
const std::vector< unsigned char > * buffer () const
 
std::vector< unsigned char > takeData ()
 
bool readData (std::size_t *readSize=nullptr)
 

Detailed Description

Definition at line 31 of file visa.hpp.

Constructor & Destructor Documentation

◆ Visa()

Visa::Visa ( std::string  resource,
unsigned int  connection_timeout_ms = 2000 
)

Constructor.

Definition at line 9 of file visa.cpp.

◆ ~Visa()

Visa::~Visa ( )
virtual

Destructor.

Closes the instrument connection, if open.

Definition at line 37 of file visa.cpp.

Member Function Documentation

◆ attribute()

bool Visa::attribute ( ViAttr  name,
ViAttrState *  value 
) const

get VISA attribute

Definition at line 90 of file visa.cpp.

◆ endpoint()

std::string Visa::endpoint ( ) const
virtual

Implements rohdeschwarz::busses::Bus.

Definition at line 44 of file visa.cpp.

◆ isError()

bool Visa::isError ( ) const
virtual

Checks if there is a visa error.

Implements rohdeschwarz::busses::Bus.

Definition at line 132 of file visa.cpp.

◆ readData()

bool Visa::readData ( unsigned char *  buffer,
std::size_t  bufferSize,
std::size_t *  readSize = nullptr 
)
virtual

Implements rohdeschwarz::busses::Bus.

Definition at line 66 of file visa.cpp.

◆ setAttribute()

bool Visa::setAttribute ( ViAttr  name,
ViAttrState  value 
)

set VISA attribute

Definition at line 97 of file visa.cpp.

◆ setTimeout()

bool Visa::setTimeout ( int  timeout_ms)
virtual

Implements rohdeschwarz::busses::Bus.

Definition at line 60 of file visa.cpp.

◆ status()

ViStatus Visa::status ( ) const

Returns current ViStatus value.

Definition at line 104 of file visa.cpp.

◆ statusMessage()

std::string Visa::statusMessage ( ) const
virtual

Returns a human-friendly message for the current ViStatus value.

Implements rohdeschwarz::busses::Bus.

Definition at line 110 of file visa.cpp.

◆ timeout_ms()

int Visa::timeout_ms ( ) const
virtual

Implements rohdeschwarz::busses::Bus.

Definition at line 50 of file visa.cpp.

◆ writeData()

bool Visa::writeData ( const unsigned char *  data,
std::size_t  dataSize,
std::size_t *  writeSize = nullptr 
)
virtual

Implements rohdeschwarz::busses::Bus.

Definition at line 78 of file visa.cpp.


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