CGUIStreamingControlException Class Reference

Indicates an error while streaming a control. More...

#include <GUIStreamingControlException.h>

Inheritance diagram for CGUIStreamingControlException:

Public Member Functions
	CGUIStreamingControlException (const CGUIStreamingControlException &kSource)
	CGUIStreamingControlException (const CGUIStreamingException &kSource)
	CGUIStreamingControlException (const eC_String &kStreamingFilePath, eC_UInt uiLineNo, const eC_String &kExpectedTag="", const eC_String &kActualTag="", CGUIObject *pkObj=NULL)
	~CGUIStreamingControlException ()
CGUIObject *	GetGUIObject () const
CGUIStreamingControlException &	operator= (const CGUIStreamingControlException &kSource)
void	SetGUIObject (CGUIObject *pkObj)
Public Member Functions inherited from CGUIStreamingException
	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

Additional Inherited Members
Protected Member Functions inherited from CGUIStreamingException
eC_String	ReportCommonMessage () const

Detailed Description

Indicates an error while streaming a control.

In addition to its base class, this exception carries an object pointer.

Constructor & Destructor Documentation

CGUIStreamingControlException() [1/3]

CGUIStreamingControlException::CGUIStreamingControlException	(	const eC_String &	kStreamingFilePath,
		eC_UInt	uiLineNo,
		const eC_String &	kExpectedTag = "",
		const eC_String &	kActualTag = "",
		CGUIObject *	pkObj = NULL
	)

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.
pkObj	Pointer to a GUI object.

~CGUIStreamingControlException()

CGUIStreamingControlException::~CGUIStreamingControlException

(

)

Destructor.

CGUIStreamingControlException() [2/3]

CGUIStreamingControlException::CGUIStreamingControlException

(

const CGUIStreamingControlException &

kSource

)

Copy-constructor.

Parameters

kSource

Source object to be copied.

CGUIStreamingControlException() [3/3]

CGUIStreamingControlException::CGUIStreamingControlException

(

const CGUIStreamingException &

kSource

)

Constructs a streaming control exception from a base streaming exception.

Parameters

kSource

Source object to be copied.

Member Function Documentation

GetGUIObject()

CGUIObject * CGUIStreamingControlException::GetGUIObject ( ) const

inline

Returns the pointer set by SetGUIObject().

Returns

Pointer to a GUI object.

operator=()

CGUIStreamingControlException & CGUIStreamingControlException::operator=

(

const CGUIStreamingControlException &

kSource

)

Operator= method.

Parameters

kSource

Source object to be copied.

Returns

This instance.

SetGUIObject()

void CGUIStreamingControlException::SetGUIObject ( CGUIObject *  pkObj )

inline

Sets the object pointer.

Parameters

pkObj

Pointer to a GUI object.

---

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

• GUIStreamingControlException.h