InputEnumeration Class Reference

Reads values from UtInput to set an enumeration. More...

#include <InputEnumeration.hpp>

Classes
class	Inserter

Public Types
typedef std::pair< std::string, int >	Pair
typedef std::list< Pair >	EnumList

Public Member Functions
	InputEnumeration ()
	InputEnumeration (const InputEnumeration &aSrc)
	~InputEnumeration ()
void	Clear ()
	Remove all enumeration values. Free memory.
void	Add (int aValue, const char *aString)
	Add an enumeration to the list.
void	Add (int aValue, const std::string &aString)
	Add an enumeration to the list.
bool	ProcessInput (const std::string &aCommand, UtInput &aInput, int &aEnumValue)
Inserter	operator<< (int aEnumVal)

Detailed Description

Reads values from UtInput to set an enumeration.

Member Typedef Documentation

EnumList

typedef std::list<Pair> InputEnumeration::EnumList

Pair

typedef std::pair<std::string, int> InputEnumeration::Pair

Constructor & Destructor Documentation

InputEnumeration() [1/2]

InputEnumeration::InputEnumeration

(

)

Referenced by InputEnumeration().

InputEnumeration() [2/2]

InputEnumeration::InputEnumeration

(

const InputEnumeration &

aSrc

)

References InputEnumeration().

~InputEnumeration()

InputEnumeration::~InputEnumeration

(

)

Member Function Documentation

Add() [1/2]

void InputEnumeration::Add	(	int	aValue,
		const char *	aString )

Add an enumeration to the list.

Referenced by InputEnumeration::Inserter::operator<<(), and InputEnumeration::Inserter::operator<<().

Add() [2/2]

void InputEnumeration::Add	(	int	aValue,
		const std::string &	aString )

Add an enumeration to the list.

Clear()

void InputEnumeration::Clear

(

)

Remove all enumeration values. Free memory.

operator<<()

Inserter InputEnumeration::operator<< ( int aEnumVal )

inline

ProcessInput()

bool InputEnumeration::ProcessInput	(	const std::string &	aCommand,
		UtInput &	aInput,
		int &	aEnumValue )

Attempt to read the enumeration from aInput. Throws UtInput::BadValue if there is a problem reading the input

Returns

'true' if the value was read.

'false' if aInput.GetCommand() != aCommand.

References begin(), and end().

---

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

• InputEnumeration.hpp
• InputEnumeration.cpp