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

The purpose of this class is to encapsulate an enviroment variable. More...

#include <CommonEnviromentParseElement.h>

List of all members.

Public Types
enum	Rvalue_type { NUMERIC, ALPHA, NUMERIC, ALPHA }
enum	Rvalue_type { NUMERIC, ALPHA, NUMERIC, ALPHA }
Public Member Functions
	CommonEnviromentParseElement (std::string key, double rvalue)
	Ctor.
	CommonEnviromentParseElement (std::string key, std::string rvalue)
	Ctor.
	CommonEnviromentParseElement (const CommonEnviromentParseElement &rhs)
	Copy ctor.
virtual	~CommonEnviromentParseElement ()
	Dtor.
CommonEnviromentParseElement &	operator= (const CommonEnviromentParseElement &rhs)
	Copy operator.
bool	operator== (const CommonEnviromentParseElement &e) const
	Equality operator.
bool	operator!= (const CommonEnviromentParseElement &e) const
	Inequality operator.
Rvalue_type	Type () const
	Give the rvaluse type.
std::string	Lvalue () const
	The lvalue or name of this element.
double	Numeric () const
	The numeric value of this element.
std::string	Alpha () const
	The alpha value of this element.
	CommonEnviromentParseElement (string key, double rvalue)
	Ctor.
	CommonEnviromentParseElement (string key, string rvalue)
	Ctor.
	CommonEnviromentParseElement (const CommonEnviromentParseElement &rhs)
	Copy ctor.
virtual	~CommonEnviromentParseElement ()
	Dtor.
CommonEnviromentParseElement &	operator= (const CommonEnviromentParseElement &rhs)
	Copy operator.
bool	operator== (const CommonEnviromentParseElement &e) const
	Equality operator.
bool	operator!= (const CommonEnviromentParseElement &e) const
	Inequality operator.
Rvalue_type	type () const
	Give the rvaluse type.
string	lvalue () const
	The lvalue or name of this element.
double	numeric () const
	The numeric value of this element.
string	alpha () const
	The alpha value of this element.

---

Detailed Description

The purpose of this class is to encapsulate an enviroment variable.

Definition at line 15 of file C++/Common/Enviroment/CommonEnviromentParseElement.h.

---

Member Enumeration Documentation

enum CommonEnviromentParseElement::Rvalue_type

Enumerator:

NUMERIC
ALPHA
NUMERIC
ALPHA

Definition at line 20 of file C++/Common/Enviroment/CommonEnviromentParseElement.h.

enum CommonEnviromentParseElement::Rvalue_type

Enumerator:

NUMERIC
ALPHA
NUMERIC
ALPHA

Definition at line 16 of file Java/Common/Enviroment/CommonEnviromentParseElement.h.

---

Constructor & Destructor Documentation

CommonEnviromentParseElement::CommonEnviromentParseElement	(	std::string	key,
		double	rvalue
	)

Ctor.

Parameters:

	key	The key, name or lvalue of this element.
	rvalue	The numeric value of this element.

CommonEnviromentParseElement::CommonEnviromentParseElement	(	std::string	key,
		std::string	rvalue
	)

Ctor.

Parameters:

	key	The key, name or lvalue of this element.
	rvalue	The alpha value of this element.

CommonEnviromentParseElement::CommonEnviromentParseElement

(

const CommonEnviromentParseElement &

rhs

)

Copy ctor.

Parameters:

rhs

The right hand side element.

virtual CommonEnviromentParseElement::~CommonEnviromentParseElement

(

)

[virtual]

Dtor.

CommonEnviromentParseElement::CommonEnviromentParseElement	(	string	key,
		double	rvalue
	)

Ctor.

Parameters:

	key	The key, name or lvalue of this element.
	rvalue	The numeric value of this element.

CommonEnviromentParseElement::CommonEnviromentParseElement	(	string	key,
		string	rvalue
	)

Ctor.

Parameters:

	key	The key, name or lvalue of this element.
	rvalue	The alpha value of this element.

CommonEnviromentParseElement::CommonEnviromentParseElement

(

const CommonEnviromentParseElement &

rhs

)

Copy ctor.

Parameters:

rhs

The right hand side element.

virtual CommonEnviromentParseElement::~CommonEnviromentParseElement

(

)

[virtual]

Dtor.

---

Member Function Documentation

CommonEnviromentParseElement& CommonEnviromentParseElement::operator=

(

const CommonEnviromentParseElement &

rhs

)

Copy operator.

Parameters:

rhs

The right hand side element.

Returns:

This object.

bool CommonEnviromentParseElement::operator==

(

const CommonEnviromentParseElement &

e

)

const

Equality operator.

Parameters:

e

The element to test against this object.

Returns:

True of the keys of this object is equal to the argument.

bool CommonEnviromentParseElement::operator!=

(

const CommonEnviromentParseElement &

e

)

const

Inequality operator.

Parameters:

e

The element to test against this object.

Returns:

True of the keys of this object is not equal to the argument.

Rvalue_type CommonEnviromentParseElement::Type

(

)

const

Give the rvaluse type.

Returns:

The type of this element.

std::string CommonEnviromentParseElement::Lvalue

(

)

const

The lvalue or name of this element.

Returns:

The lvalue.

double CommonEnviromentParseElement::Numeric

(

)

const

The numeric value of this element.

Returns:

The argument.

std::string CommonEnviromentParseElement::Alpha

(

)

const

The alpha value of this element.

Returns:

The argument.

CommonEnviromentParseElement& CommonEnviromentParseElement::operator=

(

const CommonEnviromentParseElement &

rhs

)

Copy operator.

Parameters:

rhs

The right hand side element.

Returns:

This object.

bool CommonEnviromentParseElement::operator==

(

const CommonEnviromentParseElement &

e

)

const

Equality operator.

Parameters:

e

The element to test against this object.

Returns:

True of the keys of this object is equal to the argument.

bool CommonEnviromentParseElement::operator!=

(

const CommonEnviromentParseElement &

e

)

const

Inequality operator.

Parameters:

e

The element to test against this object.

Returns:

True of the keys of this object is not equal to the argument.

Rvalue_type CommonEnviromentParseElement::type

(

)

const

Give the rvaluse type.

Returns:

The type of this element.

string CommonEnviromentParseElement::lvalue

(

)

const

The lvalue or name of this element.

Returns:

The lvalue.

double CommonEnviromentParseElement::numeric

(

)

const

The numeric value of this element.

Returns:

The argument.

string CommonEnviromentParseElement::alpha

(

)

const

The alpha value of this element.

Returns:

The argument.

---

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

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

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