Detailed Description

A stream interface.

This class provides an interface for dealing with streaming I/O devices, such as a COM port or a USB port.

Definition at line 21 of file streaminterface.h.

#include <xSens_MT4/xcommunication/include/xsens/streaminterface.h>

Inheritance diagram for StreamInterface:

Public Member Functions
	~StreamInterface ()
	Destroy the stream interface. More...

virtual XsResultValue	setTimeout (uint32_t ms)=0
	Set the read/write timeout to ms A timeout of 0 means non-blocking operation of writeData() and readData(). More...

virtual uint32_t	getTimeout (void) const =0
	The timeout used for read/write operations. More...

virtual XsResultValue	close (void)=0
	Close the connection to the device. More...

virtual XsResultValue	flushData (void)=0
	Flush all data in the buffers to and from the device. More...

virtual bool	isOpen (void) const =0
	Returns true if the object has a connection to a device. More...

virtual XsResultValue	getLastResult (void) const =0
	Returns the last result value produced by this interface. More...

virtual XsResultValue	writeData (const XsByteArray &data, XsSize *written=nullptr)=0
	Write the data contained in data to the device. More...

virtual XsResultValue	readData (XsSize maxLength, XsByteArray &data)=0
	Read at most maxLength bytes from the device into data. More...

virtual XsResultValue	open (const XsPortInfo &portInfo, uint32_t readBufSize=XS_DEFAULT_READ_BUFFER_SIZE, uint32_t writeBufSize=XS_DEFAULT_WRITE_BUFFER_SIZE)
	Open a communication channel to the given port info. More...

virtual XsResultValue	open (const XsString &filename, bool createNew, bool readOnly)
	Open a file. More...

virtual XsResultValue	waitForData (XsSize maxLength, XsByteArray &data)
	Wait for data to arrive or a timeout to occur. More...

virtual void	cancelIo (void) const
	Cancel any pending io requests. More...

virtual XsResultValue	appendData (const XsByteArray &bdata)
	Write data to the end of the file. More...

virtual XsResultValue	closeAndDelete (void)
	Close the file and delete it. More...

virtual XsResultValue	create (const XsString &filename)
	Create an empty file. More...

virtual XsResultValue	deleteData (XsFilePos start, XsSize length)
	Delete the given data from the file. More...

virtual XsResultValue	find (const XsByteArray &needleV, XsFilePos &pos)
	Find a string of bytes in the file. More...

virtual XsFilePos	getFileSize (void) const
	Return the size of the file. More...

virtual XsResultValue	getName (XsString &filename) const
	Retrieve the filename that was last successfully opened. More...

virtual XsFilePos	getReadPosition (void) const
	Return the current read position. More...

virtual XsFilePos	getWritePosition (void) const
	Return the current write position. More...

virtual XsResultValue	insertData (XsFilePos start, const XsByteArray &data)
	Insert the given data into the file. More...

virtual bool	isReadOnly (void) const
	Return whether the file is readonly or not. More...

virtual XsResultValue	setReadPosition (XsFilePos pos)
	Set the new absolute read position. More...

virtual XsResultValue	setWritePosition (XsFilePos pos=-1)
	Set the new absolute write position. More...

Protected Member Functions
	StreamInterface ()
	Create a stream interface. More...

Constructor & Destructor Documentation

◆ ~StreamInterface()

StreamInterface::~StreamInterface ( )

inline

Destroy the stream interface.

Definition at line 26 of file streaminterface.h.

◆ StreamInterface()

StreamInterface::StreamInterface ( )

inlineprotected

Create a stream interface.

Definition at line 41 of file streaminterface.h.

Member Function Documentation

◆ appendData()

XsResultValue IoInterface::appendData ( const XsByteArray & bdata )

virtualinherited

Write data to the end of the file.

The function writes the given data to the file at the end. The current write position is also moved to the end of the file.

Parameters

bdata The byte data to append to the file

Returns: XRV_OK if the write was successful

Reimplemented in IoInterfaceFile.

Definition at line 77 of file iointerface.cpp.

References void(), and XRV_INVALIDOPERATION.

Here is the call graph for this function:

◆ cancelIo()

void IoInterface::cancelIo ( void ) const

virtualinherited

Cancel any pending io requests.

Reimplemented in SerialInterface.

Definition at line 74 of file iointerface.cpp.

◆ close()

virtual XsResultValue IoInterface::close ( void )

pure virtualinherited

Close the connection to the device.

Returns: XRV_OK if the connection was closed successfully

Implemented in SerialInterface, IoInterfaceFile, and UsbInterface.

◆ closeAndDelete()

XsResultValue IoInterface::closeAndDelete ( void )

virtualinherited

Close the file and delete it.

Returns: XRV_OK if the file was closed and deleted successfully

Reimplemented in IoInterfaceFile.

Definition at line 83 of file iointerface.cpp.

References XRV_INVALIDOPERATION.

◆ create()

XsResultValue IoInterface::create ( const XsString & filename )

virtualinherited

Create an empty file.

Parameters

filename The desired (path+)name of the file

Returns: XRV_OK if the file was created successfully

Reimplemented in IoInterfaceFile.

Definition at line 85 of file iointerface.cpp.

References void(), and XRV_INVALIDOPERATION.

Here is the call graph for this function:

◆ deleteData()

XsResultValue IoInterface::deleteData	(	XsFilePos	start,
		XsSize	length
	)

virtualinherited

Delete the given data from the file.

The function erases the given data from the file at the given write position. This operation may take a while to complete, but is faster than insertData.

The write position is not changed and the read position is checked for validity upon function exit.

Parameters

start	The offset of the first byte to delete
length	The total number of bytes to delete

Returns: XRV_OK if the data was deleted successfully

Reimplemented in IoInterfaceFile.

Definition at line 91 of file iointerface.cpp.

References void(), and XRV_INVALIDOPERATION.

Here is the call graph for this function:

◆ find()

XsResultValue IoInterface::find	(	const XsByteArray &	needleV,
		XsFilePos &	pos
	)

virtualinherited

Find a string of bytes in the file.

The function searches from the current read position until the given needle is found. If the needle is not found, XsResultValue::NOT_FOUND is returned. The function will update the seek position to the first character of the found needle.

Parameters

needleV	The byte string to find.
pos	The position where needleV was found. This will point to the first character of the found needleV.

Returns: XRV_OK if the data was found, XRV_ENDOFFILE if it wasn't found

Reimplemented in IoInterfaceFile.

Definition at line 98 of file iointerface.cpp.

References void(), and XRV_INVALIDOPERATION.

Here is the call graph for this function:

◆ flushData()

virtual XsResultValue IoInterface::flushData ( void )

pure virtualinherited

Flush all data in the buffers to and from the device.

Returns: XRV_OK if the data was flushed successfully

Implemented in SerialInterface, IoInterfaceFile, and UsbInterface.

◆ getFileSize()

XsFilePos IoInterface::getFileSize ( void ) const

virtualinherited

Return the size of the file.

Returns: The size of the file.

Reimplemented in IoInterfaceFile.

Definition at line 105 of file iointerface.cpp.

◆ getLastResult()

virtual XsResultValue IoInterface::getLastResult ( void ) const

pure virtualinherited

Returns the last result value produced by this interface.

Returns: The last result value produced by this interface.

Implemented in SerialInterface, IoInterfaceFile, and UsbInterface.

◆ getName()

XsResultValue IoInterface::getName ( XsString & filename ) const

virtualinherited

Retrieve the filename that was last successfully opened.

Parameters

filename The XsString which will contain the filename.

Returns: XRV_OK

Reimplemented in IoInterfaceFile.

Definition at line 107 of file iointerface.cpp.

References void(), and XRV_INVALIDOPERATION.

Here is the call graph for this function:

◆ getReadPosition()

XsFilePos IoInterface::getReadPosition ( void ) const

virtualinherited

Return the current read position.

Returns: The current read position.

Reimplemented in IoInterfaceFile.

Definition at line 113 of file iointerface.cpp.

◆ getTimeout()

virtual uint32_t StreamInterface::getTimeout ( void ) const

pure virtual

The timeout used for read/write operations.

Implemented in SerialInterface, and UsbInterface.

◆ getWritePosition()

XsFilePos IoInterface::getWritePosition ( void ) const

virtualinherited

Return the current write position.

Returns: The current write position.

Reimplemented in IoInterfaceFile.

Definition at line 115 of file iointerface.cpp.

◆ insertData()

XsResultValue IoInterface::insertData	(	XsFilePos	start,
		const XsByteArray &	data
	)

virtualinherited

Insert the given data into the file.

The function writes the given data to the file at the current write position. This operation may take a while to complete.

The write position is placed at the end of the inserted data.

Parameters

start	The offset in the file to write the first byte
data	The data to insert in the file

Returns: XRV_OK if the data was inserted successfully

Reimplemented in IoInterfaceFile.

Definition at line 117 of file iointerface.cpp.

References void(), and XRV_INVALIDOPERATION.

Here is the call graph for this function:

◆ isOpen()

virtual bool IoInterface::isOpen ( void ) const

pure virtualinherited

Returns true if the object has a connection to a device.

Returns: true if the object has a connection to a device

Implemented in SerialInterface, IoInterfaceFile, and UsbInterface.

◆ isReadOnly()

bool IoInterface::isReadOnly ( void ) const

virtualinherited

Return whether the file is readonly or not.

Returns: true if the file is readonly

Reimplemented in IoInterfaceFile.

Definition at line 124 of file iointerface.cpp.

◆ open() [1/2]

XsResultValue IoInterface::open	(	const XsPortInfo &	portInfo,
		uint32_t	readBufSize = `XS_DEFAULT_READ_BUFFER_SIZE`,
		uint32_t	writeBufSize = `XS_DEFAULT_WRITE_BUFFER_SIZE`
	)

virtualinherited

Open a communication channel to the given port info.

If the baudrate in portInfo is set to XBR_Invalid, the baud rate is automatically detected if possible.

Parameters

portInfo	The details of the port that should be opened. Depending on the type of interface, parts of this parameter may be ignored.
readBufSize	The size of the read buffer in bytes (if appliccable to the device)
writeBufSize	The size of the write buffer in bytes (if appliccable to the device)

Returns: XRV_OK if the device was opened successfully

Reimplemented in SerialInterface, and UsbInterface.

Definition at line 53 of file iointerface.cpp.

References void(), and XRV_INVALIDOPERATION.

Here is the call graph for this function:

◆ open() [2/2]

XsResultValue IoInterface::open	(	const XsString &	filename,
		bool	createNew,
		bool	readOnly
	)

virtualinherited

Open a file.

Parameters

filename	The name of the file to open
createNew	When true, the file will be created if it doesn't exist yet
readOnly	When true, the file will be marked as read only for IoInterfaceFile, preventing accidental writes to the file.

Returns: XRV_OK if the file was opened successfully

See also: createFile

Reimplemented in IoInterfaceFile.

Definition at line 126 of file iointerface.cpp.

References void(), and XRV_INVALIDOPERATION.

Here is the call graph for this function:

◆ readData()

virtual XsResultValue IoInterface::readData	(	XsSize	maxLength,
		XsByteArray &	data
	)

pure virtualinherited

Read at most maxLength bytes from the device into data.

Parameters

maxLength	The maximum number of bytes to read. Depending on the device type and timeout settings, the function may return with less than this number of bytes read.
data	A buffer that will contain the read data.

Returns: XRV_OK if all data was read successfully, XRV_TIMEOUT if some data was read, but not maxLength, XRV_TIMEOUTNODATA if no data was read at all.

Implemented in SerialInterface, IoInterfaceFile, and UsbInterface.

◆ setReadPosition()

XsResultValue IoInterface::setReadPosition ( XsFilePos pos )

virtualinherited

Set the new absolute read position.

The read position is checked against the filesize first.

Parameters

pos	The new read position

Returns: XRV_OK if the read position was updated successfully

Reimplemented in IoInterfaceFile.

Definition at line 135 of file iointerface.cpp.

References void(), and XRV_INVALIDOPERATION.

Here is the call graph for this function:

◆ setTimeout()

virtual XsResultValue StreamInterface::setTimeout ( uint32_t ms )

pure virtual

Set the read/write timeout to ms A timeout of 0 means non-blocking operation of writeData() and readData().

Reimplemented from IoInterface.

Implemented in SerialInterface, and UsbInterface.

◆ setWritePosition()

XsResultValue IoInterface::setWritePosition ( XsFilePos pos = -1 )

virtualinherited

Set the new absolute write position.

The write position is checked against the filesize first.

Parameters

pos	The new write position

Returns: XRV_OK if the write position was updated successfully

Reimplemented in IoInterfaceFile.

Definition at line 141 of file iointerface.cpp.

References void(), and XRV_INVALIDOPERATION.

Here is the call graph for this function:

◆ waitForData()

XsResultValue IoInterface::waitForData	(	XsSize	maxLength,
		XsByteArray &	data
	)

virtualinherited

Wait for data to arrive or a timeout to occur.

The function waits until maxLength data is available or until a timeout occurs. The function returns success if data is available or XsResultValue::TIMEOUT if a timeout occurred. A timeout value of 0 indicates that the default timeout stored in the class should be used.

Parameters

maxLength	The maximum number of bytes to read before returning
data	The buffer to put the read data in.

Returns: XRV_OK if maxLength bytes were read, XRV_TIMEOUT if less was read, XRV_TIMEOUTNODATA if nothing was read

Reimplemented in SerialInterface.

Definition at line 67 of file iointerface.cpp.

References void(), and XRV_INVALIDOPERATION.

Here is the call graph for this function:

◆ writeData()

virtual XsResultValue IoInterface::writeData	(	const XsByteArray &	data,
		XsSize *	written = `nullptr`
	)

pure virtualinherited

Write the data contained in data to the device.

Parameters

data	The data to write to the device.
written	An optional XsSize value that will receive the number of bytes that were actually written.

Returns: XRV_OK if the data was written successfully

Implemented in SerialInterface, IoInterfaceFile, and UsbInterface.

Detailed Description

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

◆ ~StreamInterface()

◆ StreamInterface()

Member Function Documentation

◆ appendData()

◆ cancelIo()

◆ close()

◆ closeAndDelete()

◆ create()

◆ deleteData()

◆ find()

◆ flushData()

◆ getFileSize()

◆ getLastResult()

◆ getName()

◆ getReadPosition()

◆ getTimeout()

◆ getWritePosition()

◆ insertData()

◆ isOpen()

◆ isReadOnly()

◆ open() [1/2]

◆ open() [2/2]

◆ readData()

◆ setReadPosition()

◆ setTimeout()

◆ setWritePosition()

◆ waitForData()

◆ writeData()