The class which specifies an xml attribute with a string-type value. More...

#include <Attribute.h>

Inheritance diagram for Menge::StringAttribute:

Public Member Functions
	StringAttribute (const std::string &name, bool required, const std::string &defValue="")
	Constructor. More...

virtual bool	extract (TiXmlElement *node)
	Extracts the values for this attribute from the xml node. More...

virtual void	setDefault ()
	If defined, sets the default value for the attribute.

virtual std::string	getString ()
	Retrieve the parsed string value. More...

Public Member Functions inherited from Menge::Attribute
	Attribute (const std::string &name, bool required)
	Constructor. More...

virtual	~Attribute ()
	Destructor.

const std::string &	getName () const
	Returns a const reference to the name of the attribute. More...

bool	isRequired () const
	Reports if this attribute is required to be specified. More...

bool	isValid () const
	Reports if the attribute is valid. More...

void	clear ()
	Prepares the attribute for a parse attempt.

virtual int	getInt ()
	Retrieve the parsed int value. More...

virtual bool	getBool ()
	Retrieve the parsed boolean value. More...

virtual float	getFloat ()
	Retrieve the parsed float value. More...

virtual size_t	getSizeT ()
	Retrieve the parsed size_t value. More...

virtual FloatGenerator *	getFloatGenerator ()
	Retrieve the parsed float generator. More...

virtual Vec2DGenerator *	getVec2DGenerator ()
	Retrieve the parsed 2D float generator. More...

virtual IntGenerator *	getIntGenerator ()
	Retrieve the parsed int generator. More...

Protected Attributes
std::string	_default
	The default string value. Meaningless if _required is true.

std::string	_value
	The parsed attribute value.

Protected Attributes inherited from Menge::Attribute
std::string	_name
	The name of the xml attribute.

bool	_required
	Determines if the XML must specify this attribute.

bool	_valid
	Reports if the attribute is valid. An attribute is always valid if it is not required. Otherwise, it is only valid if it was able to be initialized from the XML.

Detailed Description

The class which specifies an xml attribute with a string-type value.

Constructor & Destructor Documentation

Menge::StringAttribute::StringAttribute	(	const std::string &	name,
		bool	required,
		const std::string &	defValue = `""`
	)

inline

Constructor.

Parameters

name	The attribute name.
required	Whether or not the attribute is required (true) or not (false).
defValue	The default value for the attribute if none is provided.

bool Menge::StringAttribute::extract ( TiXmlElement * node )

virtual

Extracts the values for this attribute from the xml node.

This is the main parsing work. It must be performed by each attribute sub-class.

Parameters

node	The XML node containing the attributes.

virtual std::string Menge::StringAttribute::getString ( )

inlinevirtual

Retrieve the parsed string value.

Exceptions

An	AttributeDefinitionException if the types are wrong.

Reimplemented from Menge::Attribute.

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