ArduCAMStream Class Reference

Inheritance diagram for ArduCAMStream:

Public Member Functions
	ArduCAMStream (ArduCAM *cam)
virtual StreamType	getStreamType ()
	Get the stream type. More...
virtual uint16_t	readMemoryBlock (char *data, int bufSize)
	Read a block of memory. More...
virtual bool	seek (int len)
	Move read cursor. More...
virtual bool	isFinished ()
	Check if stream is finished. More...
bool	dataReady ()
size_t	available ()

Member Function Documentation

virtual StreamType ArduCAMStream::getStreamType ( )

inlinevirtual

Get the stream type.

Return values

StreamType

The stream type.

Todo:

Return value of IDataSourceStream:getStreamType base class function should be of type StreamType, e.g. eSST_User

Implements IDataSourceStream.

virtual bool ArduCAMStream::isFinished ( )

virtual

Check if stream is finished.

Return values

bool	True on success.

Implements IDataSourceStream.

virtual uint16_t ArduCAMStream::readMemoryBlock ( char *  data, int  bufSize  )

virtual

Read a block of memory.

Parameters

data	Pointer to the data to be read
bufSize	Quantity of chars to read

Return values

uint16_t

Quantity of chars read

Todo:

Should IDataSourceStream::readMemoryBlock return same data type as its bufSize param?

Implements IDataSourceStream.

virtual bool ArduCAMStream::seek ( int  len )

virtual

Move read cursor.

Parameters

len	Position within stream to move cursor to

Return values

bool	True on success.

Implements IDataSourceStream.