cinder::IoStream Class Reference
#include <Stream.h>
Inherits cinder::IStream, and cinder::OStream.
Inherited by cinder::IoStreamFile.
List of all members.
Public Types |
enum | Endianness { STREAM_BIG_ENDIAN,
STREAM_LITTLE_ENDIAN
} |
Public Member Functions |
| IoStream () |
virtual | ~IoStream () |
template<typename T > |
void | read (T *t) |
template<typename T > |
void | readEndian (T *t, uint8_t endian) |
template<typename T > |
void | readBig (T *t) |
template<typename T > |
void | readLittle (T *t) |
void | readFixedString (char *t, size_t maxSize, bool nullTerminate) |
void | readFixedString (std::string *t, size_t size) |
std::string | readLine () |
void | readData (void *dest, size_t size) |
virtual size_t | readDataAvailable (void *dest, size_t maxSize)=0 |
virtual off_t | size () const =0 |
virtual bool | isEof () const =0 |
const std::string & | getFileName () const |
| Returns the file name of the path from which a Stream originated when relevant. Empty string when undefined.
|
void | setFileName (const std::string &aFileName) |
| Sets the file name of the path from which a Stream originated when relevant. Empty string when undefined.
|
virtual off_t | tell () const =0 |
| Returns the current position of the stream measured in bytes **/.
|
virtual void | seekAbsolute (off_t absoluteOffset)=0 |
| Sets the current position of the stream to byte absoluteOffset. A negative offset is relative to the end of the file.
|
virtual void | seekRelative (off_t relativeOffset)=0 |
| Moves the current position of the stream by relativeOffset bytes.
|
template<typename T > |
void | write (T t) |
void | write (const Buffer &buffer) |
template<typename T > |
void | writeEndian (T t, uint8_t endian) |
template<typename T > |
void | writeBig (T t) |
template<typename T > |
void | writeLittle (T t) |
void | writeData (const void *src, size_t size) |
Static Public Member Functions |
static uint8_t | getNativeEndianness () |
Public Attributes |
return | STREAM_BIG_ENDIAN |
Protected Member Functions |
virtual void | IORead (void *t, size_t size)=0 |
virtual void | IOWrite (const void *t, size_t size)=0 |
Protected Attributes |
std::string | mFileName |
Static Protected Attributes |
static const int | MINIMUM_BUFFER_SIZE = 8 |
Member Enumeration Documentation
- Enumerator:
STREAM_BIG_ENDIAN |
|
STREAM_LITTLE_ENDIAN |
|
Constructor & Destructor Documentation
cinder::IoStream::IoStream |
( |
|
) |
|
virtual cinder::IoStream::~IoStream |
( |
|
) |
[virtual] |
Member Function Documentation
template<typename T >
void cinder::IStream::read |
( |
T * |
t |
) |
[inherited] |
template<typename T >
void cinder::IStream::readEndian |
( |
T * |
t, |
|
|
uint8_t |
endian | |
|
) |
| | [inherited] |
template<typename T >
void cinder::IStream::readBig |
( |
T * |
t |
) |
[inherited] |
template<typename T >
void cinder::IStream::readLittle |
( |
T * |
t |
) |
[inherited] |
void cinder::IStream::readFixedString |
( |
char * |
t, |
|
|
size_t |
maxSize, |
|
|
bool |
nullTerminate | |
|
) |
| | [inherited] |
void cinder::IStream::readFixedString |
( |
std::string * |
t, |
|
|
size_t |
size | |
|
) |
| | [inherited] |
std::string cinder::IStream::readLine |
( |
|
) |
[inherited] |
void cinder::IStream::readData |
( |
void * |
dest, |
|
|
size_t |
size | |
|
) |
| | [inherited] |
virtual size_t cinder::IStream::readDataAvailable |
( |
void * |
dest, |
|
|
size_t |
maxSize | |
|
) |
| | [pure virtual, inherited] |
virtual off_t cinder::IStream::size |
( |
|
) |
const [pure virtual, inherited] |
virtual bool cinder::IStream::isEof |
( |
|
) |
const [pure virtual, inherited] |
virtual void cinder::IStream::IORead |
( |
void * |
t, |
|
|
size_t |
size | |
|
) |
| | [protected, pure virtual, inherited] |
static uint8_t cinder::StreamBase::getNativeEndianness |
( |
|
) |
[static, inherited] |
const std::string& cinder::StreamBase::getFileName |
( |
|
) |
const [inherited] |
Returns the file name of the path from which a Stream originated when relevant. Empty string when undefined.
void cinder::StreamBase::setFileName |
( |
const std::string & |
aFileName |
) |
[inherited] |
Sets the file name of the path from which a Stream originated when relevant. Empty string when undefined.
virtual off_t cinder::StreamBase::tell |
( |
|
) |
const [pure virtual, inherited] |
virtual void cinder::StreamBase::seekAbsolute |
( |
off_t |
absoluteOffset |
) |
[pure virtual, inherited] |
virtual void cinder::StreamBase::seekRelative |
( |
off_t |
relativeOffset |
) |
[pure virtual, inherited] |
template<typename T >
void cinder::OStream::write |
( |
T |
t |
) |
[inherited] |
void cinder::OStream::write |
( |
const Buffer & |
buffer |
) |
[inherited] |
template<typename T >
void cinder::OStream::writeEndian |
( |
T |
t, |
|
|
uint8_t |
endian | |
|
) |
| | [inherited] |
template<typename T >
void cinder::OStream::writeBig |
( |
T |
t |
) |
[inherited] |
template<typename T >
void cinder::OStream::writeLittle |
( |
T |
t |
) |
[inherited] |
void cinder::OStream::writeData |
( |
const void * |
src, |
|
|
size_t |
size | |
|
) |
| | [inherited] |
virtual void cinder::OStream::IOWrite |
( |
const void * |
t, |
|
|
size_t |
size | |
|
) |
| | [protected, pure virtual, inherited] |
Member Data Documentation
The documentation for this class was generated from the following file: