annotatorcomm::InputStream Class Reference

#include <InputStream.h>

Inheritance diagram for annotatorcomm::InputStream:

annotatorcomm::ftd2xx::FTD2XXInputStream List of all members.

Public Member Functions

virtual uint32_t available ()=0 throw (IOException)
virtual int32_t read ()=0 throw (IOException)
virtual uint32_t read (uint8_t *buffer, uint32_t offset, uint32_t length)=0 throw (IOException)

Detailed Description

InputStream is an abstract class to a input stream of bytes.

Definition at line 24 of file InputStream.h.


Member Function Documentation

virtual uint32_t annotatorcomm::InputStream::available (  )  throw (IOException) [pure virtual]

Get the number of bytes available in the stream.

Returns:
bytes available
Exceptions:
IOException failure to get bytes available

Implemented in annotatorcomm::ftd2xx::FTD2XXInputStream.

virtual uint32_t annotatorcomm::InputStream::read ( uint8_t *  buffer,
uint32_t  offset,
uint32_t  length 
) throw (IOException) [pure virtual]

Read length bytes from the stream, and place them into buffer starting at offset.

Parameters:
buffer destination
offset offset into destination
length number of bytes to read
Returns:
number of bytes read
Exceptions:
IOException failure to read bytes

Implemented in annotatorcomm::ftd2xx::FTD2XXInputStream.

virtual int32_t annotatorcomm::InputStream::read (  )  throw (IOException) [pure virtual]

Read a byte from the stream.

Returns:
byte read or -1 if at the end of stream
Exceptions:
IOException failure to read byte

Implemented in annotatorcomm::ftd2xx::FTD2XXInputStream.


The documentation for this class was generated from the following file:
Generated on Tue Aug 1 11:14:11 2006 for libAnnotatorComm by  doxygen 1.4.7