CGUIStreamingException Class Reference

Base class for all streaming exceptions. More...

#include <GUIStreamingException.h>

Inheritance diagram for CGUIStreamingException:

Public Member Functions
	CGUIStreamingException (const CGUIStreamingException &kSource)
	CGUIStreamingException (const eC_String &kStreamingFilePath, eC_UInt uiLineNo, const eC_String &kExpectedTag="", const eC_String &kActualTag="")
	~CGUIStreamingException ()
CGUIStreamingException &	operator= (const CGUIStreamingException &kSource)
virtual eC_String	Report () const
void	SetLineNo (const eC_UInt uiLine)
void	SetStreamingFilePath (const eC_String &kPath)
Public Member Functions inherited from CGUIException
	CGUIException ()
virtual	~CGUIException ()
virtual eC_String	Report () const

Protected Member Functions
eC_String	ReportCommonMessage () const

Detailed Description

Base class for all streaming exceptions.

Has attributes to store a filename, expected tag, read tag and line number.

Constructor & Destructor Documentation

CGUIStreamingException() [1/2]

CGUIStreamingException::CGUIStreamingException	(	const eC_String &	kStreamingFilePath,
		eC_UInt	uiLineNo,
		const eC_String &	kExpectedTag = "",
		const eC_String &	kActualTag = ""
	)

Constructor.

Parameters

kStreamingFilePath	The streaming file path. If unknown at construction time, it can be set later (see SetStreamingFilePath()).
uiLineNo	The line in the streaming file where the error occurred.
kExpectedTag	The expected tag that should have been read.
kActualTag	The tag that actually was read from the file.

~CGUIStreamingException()

CGUIStreamingException::~CGUIStreamingException

(

)

Destructor.

CGUIStreamingException() [2/2]

CGUIStreamingException::CGUIStreamingException

(

const CGUIStreamingException &

kSource

)

Copy-constructor.

Parameters

kSource

Source object to be copied.

Member Function Documentation

operator=()

CGUIStreamingException & CGUIStreamingException::operator=

(

const CGUIStreamingException &

kSource

)

Operator= method.

Parameters

kSource

Source object to be copied.

Returns

This instance.

Report()

virtual eC_String CGUIStreamingException::Report ( ) const

virtual

Report the message of the exception.

Returns

Formatted message of the exception.

Reimplemented from CGUIException.

ReportCommonMessage()

eC_String CGUIStreamingException::ReportCommonMessage ( ) const

protected

Report the common message about the streaming exception.

Returns

The message

SetLineNo()

void CGUIStreamingException::SetLineNo ( const eC_UInt  uiLine )

inline

Set the line number in which the exception occurred.

Parameters

uiLine

SetStreamingFilePath()

void CGUIStreamingException::SetStreamingFilePath ( const eC_String &  kPath )

inline

Set the path which was read while the exception occurred.

Parameters

kPath

---

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

• GUIStreamingException.h