---

CL_InputSource_MemoryGeneric Class Reference

also: CL_InputSourceProvider - Interface to open input sources with. More...

#include <inputsource_memory_generic.h>

Inheritance diagram for CL_InputSource_MemoryGeneric:

[legend]Collaboration diagram for CL_InputSource_MemoryGeneric:

[legend]List of all members.

Public Methods
	CL_InputSource_MemoryGeneric (void *data, int size, bool delete_data=false)
	CL_InputSource_MemoryGeneric (const CL_InputSource_MemoryGeneric *MG)
virtual	~CL_InputSource_MemoryGeneric ()
	also: MemoryGeneric::clone.param: MG - Pointer to the MemoryGeneric object from which to copy.
virtual void	set_system_mode ()
virtual void	set_big_endian_mode ()
virtual void	set_little_endian_mode ()
virtual int	read_int32 ()
virtual unsigned int	read_uint32 ()
	retval: The integer read.
virtual short	read_short16 ()
	retval: The unsigned integer read.
virtual unsigned short	read_ushort16 ()
	retval: The short read.
virtual char	read_char8 ()
	retval: The unsigned short read.
virtual unsigned char	read_uchar8 ()
	retval: The char read.
virtual float	read_float32 ()
	retval: The unsigned char read.
virtual bool	read_bool ()
	retval: The float read.
virtual int	read (void *data, int size)
	retval: The bool read.
virtual void	open ()
	param: data - Points to an array where the read data is stored.param: size - Number of bytes to read.retval: Num bytes actually read.
virtual void	close ()
virtual CL_InputSource*	clone () const
virtual int	tell () const
	retval: The clone of the input source.
virtual void	seek (int pos, SeekEnum seek_type)
	retval: Current position in input source.
virtual int	size () const
	param: pos - Position relative to 'seek_type'.param: seek_type - Defines what the 'pos' is relative to. Can be either seek_set, seek_cur og seek_end.
virtual std::string	read_string ()
	retval: Size of the input source.
virtual void	push_position ()
	retval: The string read.
virtual void	pop_position ()
virtual void	purge ()
Private Attributes
unsigned char*	m_data
unsigned int	m_pos
unsigned int	m_size
bool	m_delete_data

---

Detailed Description

also: CL_InputSourceProvider - Interface to open input sources with.

Definition at line 23 of file inputsource_memory_generic.h.

---

Constructor & Destructor Documentation

CL_InputSource_MemoryGeneric::CL_InputSource_MemoryGeneric ( void * data, int size, bool delete_data = false )

CL_InputSource_MemoryGeneric::CL_InputSource_MemoryGeneric ( const CL_InputSource_MemoryGeneric * MG )

CL_InputSource_MemoryGeneric::~CL_InputSource_MemoryGeneric ( ) [virtual]

also: MemoryGeneric::clone.param: MG - Pointer to the MemoryGeneric object from which to copy.

---

Member Function Documentation

virtual CL_InputSource* CL_InputSource_MemoryGeneric::clone ( ) const [virtual]

Reimplemented from CL_InputSource.

virtual void CL_InputSource_MemoryGeneric::close ( ) [virtual]

Reimplemented from CL_InputSource.

void CL_InputSource_MemoryGeneric::open ( ) [virtual]

param: data - Points to an array where the read data is stored.param: size - Number of bytes to read.retval: Num bytes actually read. Reimplemented from CL_InputSource.

virtual void CL_InputSource_MemoryGeneric::pop_position ( ) [virtual]

Reimplemented from CL_InputSource.

virtual void CL_InputSource_MemoryGeneric::purge ( ) [virtual]

void CL_InputSource_MemoryGeneric::push_position ( ) [virtual]

retval: The string read. Reimplemented from CL_InputSource.

int CL_InputSource_MemoryGeneric::read ( void * data, int size ) [virtual]

retval: The bool read. Reimplemented from CL_InputSource.

bool CL_InputSource_MemoryGeneric::read_bool ( ) [virtual]

retval: The float read.

char CL_InputSource_MemoryGeneric::read_char8 ( ) [virtual]

retval: The unsigned short read. Reimplemented from CL_InputSource.

float CL_InputSource_MemoryGeneric::read_float32 ( ) [virtual]

retval: The unsigned char read. Reimplemented from CL_InputSource.

virtual int CL_InputSource_MemoryGeneric::read_int32 ( ) [virtual]

Reimplemented from CL_InputSource.

short CL_InputSource_MemoryGeneric::read_short16 ( ) [virtual]

retval: The unsigned integer read. Reimplemented from CL_InputSource.

std::string CL_InputSource_MemoryGeneric::read_string ( ) [virtual]

retval: Size of the input source. Reimplemented from CL_InputSource.

unsigned char CL_InputSource_MemoryGeneric::read_uchar8 ( ) [virtual]

retval: The char read. Reimplemented from CL_InputSource.

unsigned int CL_InputSource_MemoryGeneric::read_uint32 ( ) [virtual]

retval: The integer read. Reimplemented from CL_InputSource.

unsigned short CL_InputSource_MemoryGeneric::read_ushort16 ( ) [virtual]

retval: The short read. Reimplemented from CL_InputSource.

void CL_InputSource_MemoryGeneric::seek ( int pos, SeekEnum seek_type ) [virtual]

retval: Current position in input source. Reimplemented from CL_InputSource.

virtual void CL_InputSource_MemoryGeneric::set_big_endian_mode ( ) [virtual]

Reimplemented from CL_InputSource.

virtual void CL_InputSource_MemoryGeneric::set_little_endian_mode ( ) [virtual]

Reimplemented from CL_InputSource.

virtual void CL_InputSource_MemoryGeneric::set_system_mode ( ) [virtual]

Reimplemented from CL_InputSource.

int CL_InputSource_MemoryGeneric::size ( ) const [virtual]

param: pos - Position relative to 'seek_type'.param: seek_type - Defines what the 'pos' is relative to. Can be either seek_set, seek_cur og seek_end. Reimplemented from CL_InputSource.

int CL_InputSource_MemoryGeneric::tell ( ) const [virtual]

retval: The clone of the input source. Reimplemented from CL_InputSource.

---

Member Data Documentation

unsigned char* CL_InputSource_MemoryGeneric::m_data [private]

Definition at line 123 of file inputsource_memory_generic.h.

bool CL_InputSource_MemoryGeneric::m_delete_data [private]

Definition at line 125 of file inputsource_memory_generic.h.

unsigned int CL_InputSource_MemoryGeneric::m_pos [private]

Definition at line 124 of file inputsource_memory_generic.h.

unsigned int CL_InputSource_MemoryGeneric::m_size [private]

Definition at line 124 of file inputsource_memory_generic.h.

---

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

• inputsource_memory_generic.h

---