microstrain::Connection Class Reference

Represents a type of connection. More...

#include <connection.hpp>

Inheritance diagram for microstrain::Connection:

Public Member Functions
	Connection ()
virtual	~Connection ()
virtual bool	sendToDevice (const uint8_t *data, size_t length)=0
	Sends bytes to the device. More...
virtual bool	recvFromDevice (uint8_t *buffer, size_t max_length, unsigned int wait_time_ms, size_t *length_out, EmbeddedTimestamp *timestamp_out)=0
	Receives bytes from the device. More...
virtual bool	isConnected () const =0
virtual bool	connect ()=0
virtual bool	disconnect ()=0
const char *	type () const
virtual const char *	interfaceName () const =0
virtual uint32_t	parameter () const =0

Static Public Attributes
static constexpr auto	TYPE = "None"

Protected Attributes
const char *	mType

Detailed Description

Represents a type of connection.

The following methods are pure virtual and must be implemented by a derived class:

• bool sendToDevice(const uint8_t* data, size_t length)
• bool recvFromDevice(uint8_t* buffer, size_t maxLength, unsigned int wait_time_ms, size_t* lengthOut, EmbeddedTimestamp* timestampOut)

Constructor & Destructor Documentation

Connection()

microstrain::Connection::Connection ( )

inline

~Connection()

virtual microstrain::Connection::~Connection ( )

inlinevirtual

Member Function Documentation

connect()

virtual bool microstrain::Connection::connect ( )

pure virtual

Implemented in microstrain::connections::RecordingConnection, microstrain::connections::TcpConnection, and microstrain::connections::SerialConnection.

disconnect()

virtual bool microstrain::Connection::disconnect ( )

pure virtual

Implemented in microstrain::connections::RecordingConnection, microstrain::connections::TcpConnection, and microstrain::connections::SerialConnection.

interfaceName()

virtual const char* microstrain::Connection::interfaceName ( ) const

pure virtual

Implemented in microstrain::connections::RecordingConnection, microstrain::connections::TcpConnection, and microstrain::connections::SerialConnection.

isConnected()

virtual bool microstrain::Connection::isConnected ( ) const

pure virtual

Implemented in microstrain::connections::TcpConnection, microstrain::connections::SerialConnection, and microstrain::connections::RecordingConnection.

parameter()

virtual uint32_t microstrain::Connection::parameter ( ) const

pure virtual

Implemented in microstrain::connections::RecordingConnection, microstrain::connections::TcpConnection, and microstrain::connections::SerialConnection.

recvFromDevice()

mip::Connection::recvFromDevice ( uint8_t *  buffer, size_t  max_length, unsigned int  wait_time_ms, size_t *  length_out, EmbeddedTimestamp *  timestamp_out  )

pure virtual

Receives bytes from the device.

Parameters

buffer	Buffer to store the received data in
max_length	Max number of bytes that can be read. Should be at most the length of buffer.
wait_time_ms	Time to wait for data in milliseconds.
length_out	Number of bytes actually read.
timestamp_out	Timestamp of when the data was received

Implemented in microstrain::connections::TcpConnection, microstrain::connections::RecordingConnection, and microstrain::connections::SerialConnection.

sendToDevice()

mip::Connection::sendToDevice ( const uint8_t *  data, size_t  length  )

pure virtual

Sends bytes to the device.

Parameters

data	The data to send to the device
length	Length of data in bytes

Implemented in microstrain::connections::TcpConnection, microstrain::connections::RecordingConnection, and microstrain::connections::SerialConnection.

type()

const char* microstrain::Connection::type ( ) const

inline

Member Data Documentation

mType

const char* microstrain::Connection::mType

protected

TYPE

constexpr auto microstrain::Connection::TYPE = "None"

staticconstexpr

---

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

• src/cpp/microstrain/connections/connection.hpp
• src/cpp/mip/mip_interface.cpp