rohdeschwarz::busses::Bus Class Reference

#include <bus.hpp>

Inheritance diagram for rohdeschwarz::busses::Bus:

Public Member Functions
	Bus ()
	Constructor. More...
virtual	~Bus ()
	Destructor. More...
virtual std::string	endpoint () const =0
virtual int	timeout_ms () const =0
virtual bool	setTimeout (int timeout_ms)=0
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 ()
virtual bool	readData (unsigned char *buffer, std::size_t bufferSize, std::size_t *readSize=nullptr)=0
virtual bool	writeData (const unsigned char *data, std::size_t dataSize, std::size_t *writeSize=nullptr)=0
bool	readData (std::size_t *readSize=nullptr)
virtual bool	isError () const =0
virtual std::string	statusMessage () const =0

Detailed Description

Definition at line 19 of file bus.hpp.

Constructor & Destructor Documentation

Bus()

Bus::Bus

(

)

Constructor.

Definition at line 28 of file bus.cpp.

~Bus()

Bus::~Bus ( )

virtual

Destructor.

The destructor should be implemented by subclasses to close the connection, if necessary.

Definition at line 35 of file bus.cpp.

Member Function Documentation

buffer() [1/2]

std::vector< unsigned char > * Bus::buffer

(

)

Definition at line 53 of file bus.cpp.

buffer() [2/2]

const std::vector< unsigned char > * Bus::buffer

(

)

const

Definition at line 59 of file bus.cpp.

bufferSize_B()

std::size_t Bus::bufferSize_B

(

)

const

Definition at line 41 of file bus.cpp.

endpoint()

virtual std::string rohdeschwarz::busses::Bus::endpoint ( ) const

pure virtual

Implemented in rohdeschwarz::busses::visa::Visa, and rohdeschwarz::busses::socket::Socket.

isError()

virtual bool rohdeschwarz::busses::Bus::isError ( ) const

pure virtual

Implemented in rohdeschwarz::busses::visa::Visa, and rohdeschwarz::busses::socket::Socket.

readData() [1/2]

bool Bus::readData

(

std::size_t *

readSize = nullptr

)

Definition at line 73 of file bus.cpp.

readData() [2/2]

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

pure virtual

Implemented in rohdeschwarz::busses::visa::Visa, and rohdeschwarz::busses::socket::Socket.

setBufferSize()

void Bus::setBufferSize

(

std::size_t

bytes

)

Definition at line 47 of file bus.cpp.

setTimeout()

virtual bool rohdeschwarz::busses::Bus::setTimeout ( int  timeout_ms )

pure virtual

Implemented in rohdeschwarz::busses::visa::Visa, and rohdeschwarz::busses::socket::Socket.

statusMessage()

virtual std::string rohdeschwarz::busses::Bus::statusMessage ( ) const

pure virtual

Implemented in rohdeschwarz::busses::visa::Visa, and rohdeschwarz::busses::socket::Socket.

takeData()

std::vector< unsigned char > Bus::takeData

(

)

Definition at line 65 of file bus.cpp.

timeout_ms()

virtual int rohdeschwarz::busses::Bus::timeout_ms ( ) const

pure virtual

Implemented in rohdeschwarz::busses::visa::Visa, and rohdeschwarz::busses::socket::Socket.

writeData()

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

pure virtual

Implemented in rohdeschwarz::busses::visa::Visa, and rohdeschwarz::busses::socket::Socket.

---

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

• include/rohdeschwarz/busses/bus.hpp
• src/busses/bus.cpp