Positive Class Reference

A general key for positive values. More...

#include "keyvalue/key/generic/Positive.h"

Inheritance diagram for Positive:

[legend]

List of all members.

Public Types
enum
typedef Traits< double, StdSingle, NoMap >	Traits_
typedef StdSingle< typename NoMap< double >::OutputType_ >	ConverterType_
typedef ConverterType_::InputType_	InputType_
typedef ConverterType_::OutputType_	OutputType_
Public Member Functions
	Positive (const string &name)
	Constructs key and sets its name.
void	checkOutput (doubleelement) const
	Compares element against the bound(s).
string	getName () const
	Gets Key's name.
void	setName (const string &name)
	Sets name.
double	map (const value::Variant &variant) const
	Performs the mapping.

---

Detailed Description

A general key for positive values.

---

Constructor & Destructor Documentation

Positive

(

const string &

name

)

[explicit]

Constructs key and sets its name.

This class is derived from Bounded<double, Geq> and set its lower bound to 0.0 at construction time.

---

Member Function Documentation

void checkOutput

(

double

element

)

const [inherited]

Compares element against the bound(s).

Parameters:

element

: Element to be checked.

Exceptions:

RuntimeError

: If element is out of bound(s).

string getName

(

)

const [inherited]

Gets Key's name.

Returns:

The Key's name.

Reimplemented from Key.

void setName

(

const string &

name

)

[inherited]

Sets name.

Parameters:

name

: The name.

double map

(

const value::Variant &

variant

)

const [inherited]

Performs the mapping.

This method retrieves the content of value::Variant and, by considering enabled lexical convertions, converts it to Output. (See LexicalToolKit documentation.)

Parameters:

variant

: A value::Variant containing the input to be mapped.

Returns:

The mapping result.