ACEXML_StrCharStream Class Reference

#include <StrCharStream.h>

Inheritance diagram for ACEXML_StrCharStream:

Collaboration diagram for ACEXML_StrCharStream:

Public Member Functions
	ACEXML_StrCharStream ()
	Default constructor.
virtual	~ACEXML_StrCharStream ()
	Destructor.
int	open (const ACEXML_Char *str, const ACEXML_Char *name)
	Initializing StrCharStream with str and name.
virtual int	available ()
virtual int	close ()
virtual int	determine_encoding ()
virtual int	get (ACEXML_Char &ch)
virtual int	read (ACEXML_Char *str, size_t len)
virtual int	peek ()
virtual const ACEXML_Char *	getEncoding ()
virtual const ACEXML_Char *	getSystemId ()
virtual void	rewind ()
Public Member Functions inherited from ACEXML_CharStream
virtual	~ACEXML_CharStream ()=0
virtual int	available ()=0
virtual int	close ()=0
virtual int	get (ACEXML_Char &ch)=0
virtual int	read (ACEXML_Char *str, size_t len)=0
virtual int	peek ()=0
virtual void	rewind ()=0
virtual const ACEXML_Char *	getEncoding ()=0
virtual const ACEXML_Char *	getSystemId ()=0

Private Attributes
ACEXML_Char *	start_
ACEXML_Char *	ptr_
ACEXML_Char *	end_
ACEXML_Char *	encoding_
ACEXML_Char *	name_

Detailed Description

An implementation of ACEXML_CharStream for reading input from a null-terminated ACEXML_Char string.

Constructor & Destructor Documentation

ACEXML_StrCharStream()

ACEXML_StrCharStream::ACEXML_StrCharStream

(

)

Default constructor.

~ACEXML_StrCharStream()

ACEXML_StrCharStream::~ACEXML_StrCharStream ( )

virtual

Destructor.

Member Function Documentation

available()

int ACEXML_StrCharStream::available ( )

virtual

Returns the available ACEXML_Char in the buffer. -1 if the object is not initialized properly.

Implements ACEXML_CharStream.

close()

int ACEXML_StrCharStream::close ( )

virtual

Close this stream and release all resources used by it.

Implements ACEXML_CharStream.

determine_encoding()

int ACEXML_StrCharStream::determine_encoding ( )

virtual

Determine the encoding of the file.

get()

int ACEXML_StrCharStream::get ( ACEXML_Char &  ch )

virtual

Read the next ACEXML_Char. Return -1 if we are not able to return an ACEXML_Char, 0 if EOS is reached, or 1 if succeed.

Implements ACEXML_CharStream.

getEncoding()

const ACEXML_Char * ACEXML_StrCharStream::getEncoding ( )

virtual

Implements ACEXML_CharStream.

getSystemId()

const ACEXML_Char * ACEXML_StrCharStream::getSystemId ( )

virtual

Implements ACEXML_CharStream.

open()

int ACEXML_StrCharStream::open	(	const ACEXML_Char *	str,
		const ACEXML_Char *	name
	)

Initializing StrCharStream with str and name.

peek()

int ACEXML_StrCharStream::peek ( )

virtual

Peek the next ACEXML_Char in the CharStream. Return the character if succeess, -1 if EOS is reached.

Implements ACEXML_CharStream.

read()

int ACEXML_StrCharStream::read ( ACEXML_Char *  str, size_t  len  )

virtual

Read the next batch of ACEXML_Char strings

Implements ACEXML_CharStream.

rewind()

void ACEXML_StrCharStream::rewind ( )

virtual

Resets the pointer to the beginning of the stream.

Implements ACEXML_CharStream.

Member Data Documentation

encoding_

ACEXML_Char* ACEXML_StrCharStream::encoding_

private

end_

ACEXML_Char* ACEXML_StrCharStream::end_

private

name_

ACEXML_Char* ACEXML_StrCharStream::name_

private

ptr_

ACEXML_Char* ACEXML_StrCharStream::ptr_

private

start_

ACEXML_Char* ACEXML_StrCharStream::start_

private

---

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

• StrCharStream.h
• StrCharStream.cpp