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

#include <Stream.h>

Inherits cinder::Noncopyable.

Inherited by cinder::IStreamCinder [virtual], and cinder::OStream [virtual].

Public Types

enum  Endianness { STREAM_BIG_ENDIAN, STREAM_LITTLE_ENDIAN }
 

Public Member Functions

virtual ~StreamBase ()
 
const fs::path & getFileName () const
 
void setFileName (const fs::path &aFileName)
 
bool getDeleteOnDestroy () const
 
void setDeleteOnDestroy (bool enable=true)
 
virtual off_t tell () const =0
 
virtual void seekAbsolute (off_t absoluteOffset)=0
 
virtual void seekRelative (off_t relativeOffset)=0
 

Static Public Member Functions

static uint8_t getNativeEndianness ()
 

Protected Member Functions

 StreamBase ()
 

Protected Attributes

fs::path mFileName
 
bool mDeleteOnDestroy
 

Member Enumeration Documentation

Enumerator
STREAM_BIG_ENDIAN 
STREAM_LITTLE_ENDIAN 

Constructor & Destructor Documentation

virtual cinder::StreamBase::~StreamBase ( )
virtual
cinder::StreamBase::StreamBase ( )
protected

Member Function Documentation

static uint8_t cinder::StreamBase::getNativeEndianness ( )
static

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

const fs::path& cinder::StreamBase::getFileName ( ) const

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)

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

bool cinder::StreamBase::getDeleteOnDestroy ( ) const

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)

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.

virtual off_t cinder::StreamBase::tell ( ) const
pure virtual

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

Implemented in cinder::OStreamMem, cinder::IStreamMem, cinder::IoStreamFile, cinder::OStreamFile, cinder::IStreamFile, and cinder::IStreamUrl.

virtual void cinder::StreamBase::seekAbsolute ( off_t  absoluteOffset)
pure virtual

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

Implemented in cinder::OStreamMem, cinder::IStreamMem, cinder::IoStreamFile, cinder::OStreamFile, cinder::IStreamFile, and cinder::IStreamUrl.

virtual void cinder::StreamBase::seekRelative ( off_t  relativeOffset)
pure virtual

Moves the current position of the stream by relativeOffset bytes.

Implemented in cinder::OStreamMem, cinder::IStreamMem, cinder::IoStreamFile, cinder::OStreamFile, cinder::IStreamFile, and cinder::IStreamUrl.

Member Data Documentation

fs::path cinder::StreamBase::mFileName
protected
bool cinder::StreamBase::mDeleteOnDestroy
protected

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