CommonEnviromentParserList Class Reference
[C++/Common/Enviroment]

The purpose of objects of this class is to maintain a list of lvalues and corresponding rvalues. More...

#include <CommonEnviromentParserList.h>

List of all members.

Public Types
typedef std::list< CommonEnviromentParseElement >	Element
typedef slist< CommonEnviromentParseElement >	Element
Public Member Functions
	CommonEnviromentParserList ()
	Ctor.
	CommonEnviromentParserList (const CommonEnviromentParserList &rhs)
	Copy ctor.
virtual	~CommonEnviromentParserList ()
	Dtor.
CommonEnviromentParserList &	operator= (const CommonEnviromentParserList &rhs)
	Copy operator.
bool	operator== (const CommonEnviromentParserList &rhs) const
	Equality operator.
bool	operator!= (const CommonEnviromentParserList &rhs) const
	The logical negation of operator==().
bool	Empty () const
	Test whether the list is empty.
int	Size () const
	Give the size of the list in CommonEnviromentParseElements.
void	Push (std::string key, double argument)
	Push a statement onto the list.
void	Push (std::string key, std::string argument)
	Push a statement onto the list.
bool	Find (std::string key) const
	Search for a given statement.
CommonEnviromentParseElement	Argument (std::string key) const
	Give a statement's argument.
Element::const_iterator	Iterator () const
	Give an iterator to the list of elements.
Element::const_iterator	Begin () const
	Give the iterator that points to the start of the list.
Element::const_iterator	End () const
	Give the iterator that points beyond the end if the list.
	CommonEnviromentParserList ()
	Ctor.
	CommonEnviromentParserList (const CommonEnviromentParserList &rhs)
	Copy ctor.
virtual	~CommonEnviromentParserList ()
	Dtor.
CommonEnviromentParserList &	operator= (const CommonEnviromentParserList &rhs)
	Copy operator.
bool	operator== (const CommonEnviromentParserList &rhs) const
	Equality operator.
bool	operator!= (const CommonEnviromentParserList &rhs) const
	The logical negation of operator==().
bool	empty () const
	Test whether the list is empty.
int	size () const
	Give the size of the list in CommonEnviromentParseElements.
void	push (string key, double argument)
	Push a statement onto the list.
void	push (string key, string argument)
	Push a statement onto the list.
bool	find (string key) const
	Search for a given statement.
CommonEnviromentParseElement	argument (string key) const
	Give a statement's argument.
Element::const_iterator	iterator () const
	Give an iterator to the list of elements.
Element::const_iterator	begin () const
	Give the iterator that points to the start of the list.
Element::const_iterator	end () const
	Give the iterator that points beyond the end if the list.

---

Detailed Description

The purpose of objects of this class is to maintain a list of lvalues and corresponding rvalues.

Definition at line 17 of file C++/Common/Enviroment/CommonEnviromentParserList.h.

---

Member Typedef Documentation

typedef std::list<CommonEnviromentParseElement> CommonEnviromentParserList::Element

Definition at line 22 of file C++/Common/Enviroment/CommonEnviromentParserList.h.

typedef slist<CommonEnviromentParseElement> CommonEnviromentParserList::Element

Definition at line 18 of file Java/Common/Enviroment/CommonEnviromentParserList.h.

---

Constructor & Destructor Documentation

CommonEnviromentParserList::CommonEnviromentParserList

(

)

Ctor.

CommonEnviromentParserList::CommonEnviromentParserList

(

const CommonEnviromentParserList &

rhs

)

Copy ctor.

virtual CommonEnviromentParserList::~CommonEnviromentParserList

(

)

[virtual]

Dtor.

CommonEnviromentParserList::CommonEnviromentParserList

(

)

Ctor.

CommonEnviromentParserList::CommonEnviromentParserList

(

const CommonEnviromentParserList &

rhs

)

Copy ctor.

virtual CommonEnviromentParserList::~CommonEnviromentParserList

(

)

[virtual]

Dtor.

---

Member Function Documentation

CommonEnviromentParserList& CommonEnviromentParserList::operator=

(

const CommonEnviromentParserList &

rhs

)

Copy operator.

Parameters:

rhs

The reference object.

bool CommonEnviromentParserList::operator==

(

const CommonEnviromentParserList &

rhs

)

const

Equality operator.

Two objects of this type are equal iff every CommonEnviromentParseElement held in each is exactly equal, their ordering is the same, and the size of the two lists is equal.

Parameters:

rhs

The reference object.

Returns:

True of this object is equal to the rhs.

bool CommonEnviromentParserList::operator!=

(

const CommonEnviromentParserList &

rhs

)

const

The logical negation of operator==().

Parameters:

rhs

The reference object.

Returns:

True of this object is not equal to the rhs.

bool CommonEnviromentParserList::Empty

(

)

const

Test whether the list is empty.

Returns:

True if the list is empty.

int CommonEnviromentParserList::Size

(

)

const

Give the size of the list in CommonEnviromentParseElements.

Returns:

The number of elements.

void CommonEnviromentParserList::Push	(	std::string	key,
		double	argument
	)

Push a statement onto the list.

This function will not replicate keys (lvalues). If this key matchs an already existing key then this function will over write the argument.

Parameters:

	key	The statement's lvalue.
	argument	The statement's rvalue.

void CommonEnviromentParserList::Push	(	std::string	key,
		std::string	argument
	)

Push a statement onto the list.

This function will not replicate keys (lvalues). If this key matchs an already existing key then this function will over write the argument.

Parameters:

	key	The statement's lvalue.
	argument	The statement's rvalue.

bool CommonEnviromentParserList::Find

(

std::string

key

)

const

Search for a given statement.

Parameters:

key

The lvalue of the statement of interest.

Returns:

If the lvalue is found return true.

CommonEnviromentParseElement CommonEnviromentParserList::Argument

(

std::string

key

)

const

Give a statement's argument.

If the statement does not exist then the results of this call are undefined.

Parameters:

key

The lvalue of the statement.

Returns:

The statement.

Element::const_iterator CommonEnviromentParserList::Iterator

(

)

const

Give an iterator to the list of elements.

The elements of the list may be visisted by this iterator.

Returns:

A list iterator pointing to nothing in particular.

Element::const_iterator CommonEnviromentParserList::Begin

(

)

const

Give the iterator that points to the start of the list.

Returns:

The begining of the list.

Element::const_iterator CommonEnviromentParserList::End

(

)

const

Give the iterator that points beyond the end if the list.

Returns:

The end of the list. This iterator does not point to a valid list element.

CommonEnviromentParserList& CommonEnviromentParserList::operator=

(

const CommonEnviromentParserList &

rhs

)

Copy operator.

Parameters:

rhs

The reference object.

bool CommonEnviromentParserList::operator==

(

const CommonEnviromentParserList &

rhs

)

const

Equality operator.

Two objects of this type are equal iff every CommonEnviromentParseElement held in each is exactly equal, their ordering is the same, and the size of the two lists is equal.

Parameters:

rhs

The reference object.

Returns:

True of this object is equal to the rhs.

bool CommonEnviromentParserList::operator!=

(

const CommonEnviromentParserList &

rhs

)

const

The logical negation of operator==().

Parameters:

rhs

The reference object.

Returns:

True of this object is not equal to the rhs.

bool CommonEnviromentParserList::empty

(

)

const

Test whether the list is empty.

Returns:

True if the list is empty.

int CommonEnviromentParserList::size

(

)

const

Give the size of the list in CommonEnviromentParseElements.

Returns:

The number of elements.

void CommonEnviromentParserList::push	(	string	key,
		double	argument
	)

Push a statement onto the list.

This function will not replicate keys (lvalues). If this key matchs an already existing key then this function will over write the argument.

Parameters:

	key	The statement's lvalue.
	argument	The statement's rvalue.

void CommonEnviromentParserList::push	(	string	key,
		string	argument
	)

Push a statement onto the list.

This function will not replicate keys (lvalues). If this key matchs an already existing key then this function will over write the argument.

Parameters:

	key	The statement's lvalue.
	argument	The statement's rvalue.

bool CommonEnviromentParserList::find

(

string

key

)

const

Search for a given statement.

Parameters:

key

The lvalue of the statement of interest.

Returns:

If the lvalue is found return true.

CommonEnviromentParseElement CommonEnviromentParserList::argument

(

string

key

)

const

Give a statement's argument.

If the statement does not exist then the results of this call are undefined.

Parameters:

key

The lvalue of the statement.

Returns:

The statement.

Element::const_iterator CommonEnviromentParserList::iterator

(

)

const

Give an iterator to the list of elements.

The elements of the list may be visisted by this iterator.

Returns:

A list iterator pointing to nothing in particular.

Element::const_iterator CommonEnviromentParserList::begin

(

)

const

Give the iterator that points to the start of the list.

Returns:

The begining of the list.

Element::const_iterator CommonEnviromentParserList::end

(

)

const

Give the iterator that points beyond the end if the list.

Returns:

The end of the list. This iterator does not point to a valid list element.

---

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

• C++/Common/Enviroment/CommonEnviromentParserList.h
• Java/Common/Enviroment/CommonEnviromentParserList.h

Generated on Sat Nov 22 12:37:35 2008 for Swath Sonar by Doxygen 1.5.1