Nebula
Loading...
Searching...
No Matches
IO::EmbeddedMemoryStream Class Reference

#include <embeddedmemorystream.h>

Detailed Description

Implements a stream class which reads from an embedded resource.

Inherits IO::MemoryStream.

Public Member Functions

 EmbeddedMemoryStream ()
 constructor
virtual ~EmbeddedMemoryStream ()
 destructor
virtual bool CanWrite () const
 memory streams support writing
virtual bool Open ()
 open the stream
Public Member Functions inherited from IO::MemoryStream
 MemoryStream ()
 constructor
virtual ~MemoryStream ()
 destructor
virtual bool CanRead () const
 memory streams support reading
virtual bool CanSeek () const
 memory streams support seeking
virtual bool CanBeMapped () const
 memory streams are mappable
virtual void SetSize (Size s)
 set new size of the stream in bytes
virtual Size GetSize () const
 get the size of the stream in bytes
virtual Position GetPosition () const
 get the current position of the read/write cursor
virtual void Close ()
 close the stream
virtual void Write (const void *ptr, Size numBytes)
 directly write to the stream
virtual Size Read (void *ptr, Size numBytes)
 directly read from the stream
virtual void Seek (Offset offset, SeekOrigin origin)
 seek in stream
virtual bool Eof () const
 return true if end-of-stream reached
virtual void * Map ()
 map for direct memory-access
virtual void * MemoryMap ()
 map for direct memory-access
virtual void Unmap ()
 unmap a mapped stream
void * GetRawPointer () const
 get a direct "raw" pointer to the data
Public Member Functions inherited from IO::Stream
 Stream ()
 constructor
virtual ~Stream ()
 destructor
void SetURI (const URI &u)
 set stream location as URI
const URIGetURI () const
 get stream URI
void SetAccessMode (AccessMode m)
 set the access mode of the stream (default is ReadAccess)
AccessMode GetAccessMode () const
 get the access mode of the stream
void SetAccessPattern (AccessPattern p)
 set the prefered access pattern (default is Sequential)
AccessPattern GetAccessPattern () const
 get the prefered access pattern
void SetMediaType (const MediaType &t)
 set optional media type of stream content
const MediaTypeGetMediaType () const
 get optional media type
bool IsOpen () const
 return true if currently open
virtual void Flush ()
 flush unsaved data
virtual void MemoryUnmap ()
 unmap memory stream
bool IsMapped () const
 return true if stream is currently mapped to memory
Public Member Functions inherited from Core::RefCounted
 RefCounted ()
 constructor
int GetRefCount () const
 get the current refcount
void AddRef ()
 increment refcount by one
void Release ()
 decrement refcount and destroy object if refcount is zero
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
const Util::StringGetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code

Private Member Functions

 __DeclareClass (EmbeddedMemoryStream)

Additional Inherited Members

Public Types inherited from IO::Stream
enum  AccessMode { ReadAccess , WriteAccess , AppendAccess , ReadWriteAccess }
 access modes More...
enum  AccessPattern { Random , Sequential }
 access prefered pattern More...
enum  SeekOrigin { Begin , Current , End }
 seek origins More...
typedef int64_t Position
 typedefs
typedef int64_t Offset
typedef int64_t Size
Static Public Member Functions inherited from Core::RefCounted
static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA_DEBUG builds only!)
Protected Member Functions inherited from IO::MemoryStream
void Realloc (Size s)
 re-allocate the memory buffer
bool HasRoom (Size numBytes) const
 return true if there's enough space for n more bytes
void MakeRoom (Size numBytes)
 make room for at least n more bytes
Protected Member Functions inherited from Core::RefCounted
virtual ~RefCounted ()
 destructor (called when refcount reaches zero)
Protected Attributes inherited from IO::MemoryStream
Size capacity
Size size
Position position
unsigned char * buffer
Protected Attributes inherited from IO::Stream
URI uri
AccessMode accessMode
AccessPattern accessPattern
bool isOpen
bool isMapped
MediaType mediaType
Static Protected Attributes inherited from IO::MemoryStream
static const Size InitialSize = 256

Constructor & Destructor Documentation

◆ EmbeddedMemoryStream()

IO::EmbeddedMemoryStream::EmbeddedMemoryStream ( )

constructor

◆ ~EmbeddedMemoryStream()

IO::EmbeddedMemoryStream::~EmbeddedMemoryStream ( )
virtual

destructor

Member Function Documentation

◆ __DeclareClass()

IO::EmbeddedMemoryStream::__DeclareClass ( EmbeddedMemoryStream )
private

◆ CanWrite()

bool IO::EmbeddedMemoryStream::CanWrite ( ) const
virtual

memory streams support writing

Reimplemented from IO::MemoryStream.

◆ Open()

bool IO::EmbeddedMemoryStream::Open ( )
virtual

open the stream

Open the stream for reading.

Reimplemented from IO::MemoryStream.


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