Cinder  0.9.1
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
cinder::OStreamMem Class Reference

#include <Stream.h>

Inherits cinder::OStream.

Public Types

enum  Endianness { STREAM_BIG_ENDIAN, STREAM_LITTLE_ENDIAN }
 

Public Member Functions

 ~OStreamMem ()
 
virtual off_t tell () const
 
virtual void seekAbsolute (off_t absoluteOffset)
 
virtual void seekRelative (off_t relativeOffset)
 
void * getBuffer ()
 
void write (const std::string &s)
 
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)
 
const fs::path & getFileName () const
 
void setFileName (const fs::path &aFileName)
 
bool getDeleteOnDestroy () const
 
void setDeleteOnDestroy (bool enable=true)
 

Static Public Member Functions

static OStreamMemRef create (size_t bufferSizeHint=4096)
 
static uint8_t getNativeEndianness ()
 

Protected Member Functions

 OStreamMem (size_t bufferSizeHint)
 
virtual void IOWrite (const void *t, size_t size)
 

Protected Attributes

void * mBuffer
 
size_t mDataSize
 
size_t mOffset
 
fs::path mFileName
 
bool mDeleteOnDestroy
 

Member Enumeration Documentation

Enumerator
STREAM_BIG_ENDIAN 
STREAM_LITTLE_ENDIAN 

Constructor & Destructor Documentation

cinder::OStreamMem::~OStreamMem ( )
cinder::OStreamMem::OStreamMem ( size_t  bufferSizeHint)
protected

Member Function Documentation

static OStreamMemRef cinder::OStreamMem::create ( size_t  bufferSizeHint = 4096)
static
virtual off_t cinder::OStreamMem::tell ( ) const
virtual

Returns the current position of the stream measured in bytes **/.

Implements cinder::StreamBase.

void cinder::OStreamMem::seekAbsolute ( off_t  absoluteOffset)
virtual

Sets the current position of the stream to byte absoluteOffset. A negative offset is relative to the end of the file.

Implements cinder::StreamBase.

void cinder::OStreamMem::seekRelative ( off_t  relativeOffset)
virtual

Moves the current position of the stream by relativeOffset bytes.

Implements cinder::StreamBase.

void* cinder::OStreamMem::getBuffer ( )
void cinder::OStreamMem::IOWrite ( const void *  t,
size_t  size 
)
protectedvirtual

Implements cinder::OStream.

void cinder::OStream::write ( const std::string &  s)
inherited

Writes null-terminated string, including terminator.

template<typename T >
void cinder::OStream::write ( t)
inherited
void cinder::OStream::write ( const Buffer buffer)
inherited
template<typename T >
void cinder::OStream::writeEndian ( t,
uint8_t  endian 
)
inherited
template<typename T >
void cinder::OStream::writeBig ( t)
inherited
template<typename T >
void cinder::OStream::writeLittle ( t)
inherited
void cinder::OStream::writeData ( const void *  src,
size_t  size 
)
inherited
static uint8_t cinder::StreamBase::getNativeEndianness ( )
staticinherited

Returns the platform's endianness as a StreamBase::Endianness.

const fs::path& 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 fs::path &  aFileName)
inherited

Sets the file name of the path from which a Stream originated when relevant. Empty string when undefined.

bool cinder::StreamBase::getDeleteOnDestroy ( ) const
inherited

Returns whether the Stream has been requested to destroy its source upon its own destruction. For example, IStreamFile will delete its source file. Ignored in some types of streams. Defaults to false.

void cinder::StreamBase::setDeleteOnDestroy ( bool  enable = true)
inherited

Sets whether the Stream has been requested to destroy its source upon its own destruction. For example, IStreamFile will delete its source file. Ignored in some types of streams. Defaults to false.

Member Data Documentation

void* cinder::OStreamMem::mBuffer
protected
size_t cinder::OStreamMem::mDataSize
protected
size_t cinder::OStreamMem::mOffset
protected
fs::path cinder::StreamBase::mFileName
protectedinherited
bool cinder::StreamBase::mDeleteOnDestroy
protectedinherited

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