Public Member Functions | Private Member Functions | List of all members
cISStream Class Reference

#include <ISStream.h>

Inheritance diagram for cISStream:
Inheritance graph
[legend]

Public Member Functions

 cISStream ()
 
virtual int Close ()
 
virtual int Flush ()
 
virtual long long GetBytesAvailableToRead ()
 
virtual int Read (void *buffer, int count)
 
virtual int Write (const void *buffer, int count)
 
virtual ~cISStream ()
 

Private Member Functions

 cISStream (const cISStream &copy)
 

Detailed Description

Interface to read and write data using stream interfaces

Definition at line 27 of file ISStream.h.

Constructor & Destructor Documentation

◆ cISStream() [1/2]

cISStream::cISStream ( )
inline

Constructor

Definition at line 31 of file ISStream.h.

◆ ~cISStream()

cISStream::~cISStream ( )
virtual

Destructor If this instance owns the reader and/or writer streams, they are deleted

Definition at line 20 of file ISStream.cpp.

◆ cISStream() [2/2]

cISStream::cISStream ( const cISStream copy)
private

Member Function Documentation

◆ Close()

virtual int cISStream::Close ( )
inlinevirtual

Close the stream

Returns
0 if success, otherwise an error code

Reimplemented in cISFileStream, cISTcpServer, cISSerialPort, and cISTcpClient.

Definition at line 65 of file ISStream.h.

◆ Flush()

virtual int cISStream::Flush ( )
inlinevirtual

Flush the stream

Returns
0 if success, otherwise an error code

Reimplemented in cISFileStream.

Definition at line 59 of file ISStream.h.

◆ GetBytesAvailableToRead()

virtual long long cISStream::GetBytesAvailableToRead ( )
inlinevirtual

Gets the number of bytes available to read

Returns
The number of bytes available to read or -1 if this feature is not supported

Reimplemented in cISFileStream.

Definition at line 71 of file ISStream.h.

◆ Read()

virtual int cISStream::Read ( void *  buffer,
int  count 
)
inlinevirtual

Read n bytes from the stream

Parameters
bufferthe buffer to read into
countthe max count of bytes to read
Returns
the number of bytes read, -1 if reading is not supported, 0 if no bytes available

Reimplemented in cISFileStream, cISSerialPort, and cISTcpClient.

Definition at line 45 of file ISStream.h.

◆ Write()

virtual int cISStream::Write ( const void *  buffer,
int  count 
)
inlinevirtual

Write n bytes from the stream to buffer

Parameters
bufferthe buffer to write into
countthe max count of bytes to write
Returns
the number of bytes written, -1 if writing is not supported, 0 if no bytes written

Reimplemented in cISFileStream, cISSerialPort, and cISTcpClient.

Definition at line 53 of file ISStream.h.


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


inertial_sense_ros
Author(s):
autogenerated on Sat Sep 19 2020 03:19:09