Mezzanine::XML::XPathVariableSet Class Reference

A set of XPath variables. More...

#include <xpathvariableset.h>

Public Member Functions
	XPathVariableSet ()
	Default Constructor, Blanks any XPathVariable it contains.
	~XPathVariableSet ()
	Default Deconstructor, Deletes any XPathVariable it contains.
XPathVariable *	Add (const Char8 *Name, XPathValueType Type)
	Add a new variable or get the existing one, if the Types match. More...
XPathVariable *	Get (const Char8 *Name)
	Get the named XPathVariable. More...
const XPathVariable *	Get (const Char8 *Name) const
	Get the named XPathVariable. More...
bool	Set (const Char8 *Name, bool Value)
	Set contained variable Value; no Type conversion is performed. More...
bool	Set (const Char8 *Name, double Value)
	Set contained variable Value; no Type conversion is performed. More...
bool	Set (const Char8 *Name, const Char8 *Value)
	Set contained variable Value; no Type conversion is performed. More...
bool	Set (const Char8 *Name, const XPathNodeSet &Value)
	Set contained variable Value; no Type conversion is performed. More...

Detailed Description

A set of XPath variables.

Definition at line 76 of file xpathvariableset.h.

Member Function Documentation

XPathVariable* Mezzanine::XML::XPathVariableSet::Add	(	const Char8 *	Name,
		XPathValueType	Type
	)

Add a new variable or get the existing one, if the Types match.

Returns

A pointer to the XPathVariable you referenced or just created.

Parameters

Name	The name of variable to add.
Type	The Type of the new value to add as an XPathValueType.

XPathVariable* Mezzanine::XML::XPathVariableSet::Get

(

const Char8 *

Name

)

Get the named XPathVariable.

Returns

A pointer to the specified XPathVariable.

Parameters

Name	The name of the XPathVariable you want.

const XPathVariable* Mezzanine::XML::XPathVariableSet::Get

(

const Char8 *

Name

)

const

Get the named XPathVariable.

Parameters

Name	The name of the XPathVariable you want.

Returns

A pointer to the specified XPathVariable.

Note

The non-const version is available to scripting languages.

bool Mezzanine::XML::XPathVariableSet::Set	(	const Char8 *	Name,
		bool	Value
	)

Set contained variable Value; no Type conversion is performed.

Parameters

Name	The name of variable to change.
Value	The value to attempt to put into the named variable.

Returns

True is return, false is returned if there is no such variable or on Type mismatch error.

bool Mezzanine::XML::XPathVariableSet::Set	(	const Char8 *	Name,
		double	Value
	)

Set contained variable Value; no Type conversion is performed.

Parameters

Name	The name of variable to change.
Value	The value to attempt to put into the named variable.

Returns

True is return, false is returned if there is no such variable or on Type mismatch error.

bool Mezzanine::XML::XPathVariableSet::Set	(	const Char8 *	Name,
		const Char8 *	Value
	)

Set contained variable Value; no Type conversion is performed.

Parameters

Name	The name of variable to change.
Value	The value to attempt to put into the named variable.

Returns

True is return, false is returned if there is no such variable or on Type mismatch error.

bool Mezzanine::XML::XPathVariableSet::Set	(	const Char8 *	Name,
		const XPathNodeSet &	Value
	)

Set contained variable Value; no Type conversion is performed.

Parameters

Name	The name of variable to change.
Value	The value to attempt to put into the named variable.

Returns

True is return, false is returned if there is no such variable or on Type mismatch error.

---

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

• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/XML/xpathvariableset.h