Parameter Class Reference

#include <Parameter.hpp>

Inheritance diagram for Parameter:

[legend]

List of all members.

Public Types
enum	Type { Double, Integer, String, Enum }
Public Member Functions
virtual void	get (IdentifierSet &I)=0
virtual void	reset ()=0
virtual void	set (const real_t d)=0
virtual void	set (const int i)=0
virtual void	set (const char *)=0
void	set (const std::string &s)
virtual const std::string	typeName () const =0
const Type &	type () const
const char *	label () const
	Parameter (const Parameter &pv)
	Parameter (const Parameter::Type t, const char *label)
virtual	~Parameter ()
Protected Attributes
Type	__type
Private Member Functions
virtual std::ostream &	put (std::ostream &) const =0
Private Attributes
const char *	__label
const char *	__description
Friends
std::ostream &	operator<< (std::ostream &os, const Parameter &P)

---

Detailed Description

Defines the association of a keyword and its value.

Author:

Stephane Del Pino

Definition at line 38 of file Parameter.hpp.

---

Member Enumeration Documentation

enum Parameter::Type

Enumerator:

Double
Integer
String
Enum

Definition at line 41 of file Parameter.hpp.

            {
    Double,
    Integer,
    String,
    Enum
  };

---

Constructor & Destructor Documentation

Parameter::Parameter

(

const Parameter &

pv

)

[inline]

Definition at line 87 of file Parameter.hpp.

    : __type(pv.__type),
      __label(pv.__label)
  {
    ;
  }

Parameter::Parameter	(	const Parameter::Type	t,
		const char *	label
	)			[inline]

Definition at line 94 of file Parameter.hpp.

    : __type(t),
      __label(label)
  {
    ;
  }

virtual Parameter::~Parameter

(

)

[inline, virtual]

Definition at line 101 of file Parameter.hpp.

  {
    ;
  }

---

Member Function Documentation

virtual std::ostream& Parameter::put

(

std::ostream &

)

const [private, pure virtual]

Implemented in DoubleParameter, EnumParameter< EnumType >, IntegerParameter, and StringParameter.

virtual void Parameter::get

(

IdentifierSet &

I

)

[pure virtual]

Implemented in DoubleParameter, EnumParameter< EnumType >, IntegerParameter, and StringParameter.

virtual void Parameter::reset

(

)

[pure virtual]

Implemented in DoubleParameter, EnumParameter< EnumType >, IntegerParameter, and StringParameter.

virtual void Parameter::set

(

const real_t

d

)

[pure virtual]

Implemented in DoubleParameter, EnumParameter< EnumType >, IntegerParameter, and StringParameter.

virtual void Parameter::set

(

const int

i

)

[pure virtual]

Implemented in DoubleParameter, EnumParameter< EnumType >, IntegerParameter, and StringParameter.

virtual void Parameter::set

(

const char *

)

[pure virtual]

Implemented in DoubleParameter, EnumParameter< EnumType >, IntegerParameter, and StringParameter.

void Parameter::set

(

const std::string &

s

)

[inline]

Definition at line 67 of file Parameter.hpp.

                               {
    set(s.c_str());
  }

virtual const std::string Parameter::typeName

(

)

const [pure virtual]

Implemented in DoubleParameter, EnumParameter< EnumType >, IntegerParameter, and StringParameter.

const Type& Parameter::type

(

)

const [inline]

Definition at line 74 of file Parameter.hpp.

References __type.

  {
    return __type;
  }

const char * Parameter::label

(

)

const

Definition at line 26 of file Parameter.cpp.

References __label.

{
  return __label;
}

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const Parameter &	P
	)			[friend]

Definition at line 79 of file Parameter.hpp.

  {
    return P.put(os);
  }

---

Member Data Documentation

Type Parameter::__type [protected]

Definition at line 49 of file Parameter.hpp.

Referenced by type().

const char* Parameter::__label [private]

Definition at line 52 of file Parameter.hpp.

Referenced by label().

const char* Parameter::__description [private]

Definition at line 54 of file Parameter.hpp.

---

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

• Parameter.hpp
• Parameter.cpp