DoubleParameter Class Reference

#include <DoubleParameter.hpp>

Inheritance diagram for DoubleParameter:

[legend]

Collaboration diagram for DoubleParameter:

[legend]

List of all members.

Public Types
enum	Type { Double, Integer, String, Enum }
Public Member Functions
void	get (IdentifierSet &I)
	Does not add other identifiers.
void	set (const real_t d)
void	set (const int i)
void	set (const char *c)
	operator real_t & ()
	operator real_t () const
void	reset ()
const std::string	typeName () const
	DoubleParameter (const DoubleParameter &dp)
	DoubleParameter (const real_t d, const char *label)
	~DoubleParameter ()
void	set (const std::string &s)
const Type &	type () const
const char *	label () const
Protected Attributes
Type	__type
Private Member Functions
std::ostream &	put (std::ostream &os) const
Private Attributes
const real_t	__defaultDoubleValue
real_t	__realValue
Friends
std::ostream &	operator<< (std::ostream &os, const Parameter &P)

---

Detailed Description

class DoubleParameter This is the base describes Double Parameters.

Author:

Stéphane Del Pino.

Definition at line 35 of file DoubleParameter.hpp.

---

Member Enumeration Documentation

enum Parameter::Type [inherited]

Enumerator:

Double
Integer
String
Enum

Definition at line 41 of file Parameter.hpp.

            {
    Double,
    Integer,
    String,
    Enum
  };

---

Constructor & Destructor Documentation

DoubleParameter::DoubleParameter

(

const DoubleParameter &

dp

)

[inline]

Definition at line 93 of file DoubleParameter.hpp.

    : Parameter(dp),
      __defaultDoubleValue(dp.__defaultDoubleValue),
      __realValue(dp.__realValue)
  {
    ;
  }  

DoubleParameter::DoubleParameter	(	const real_t	d,
		const char *	label
	)			[inline]

Definition at line 101 of file DoubleParameter.hpp.

    : Parameter(Parameter::Double, label),
      __defaultDoubleValue(d),
      __realValue(d)
  {
    ;
  }

DoubleParameter::~DoubleParameter

(

)

[inline]

Definition at line 109 of file DoubleParameter.hpp.

  {
    ;
  }

---

Member Function Documentation

std::ostream& DoubleParameter::put

(

std::ostream &

os

)

const [inline, private, virtual]

Implements Parameter.

Definition at line 42 of file DoubleParameter.hpp.

References __realValue.

  {
    os << __realValue;
    return os;
  }

void DoubleParameter::get

(

IdentifierSet &

I

)

[inline, virtual]

Does not add other identifiers.

Implements Parameter.

Definition at line 50 of file DoubleParameter.hpp.

  {
    ;
  }

void DoubleParameter::set

(

const real_t

d

)

[inline, virtual]

Implements Parameter.

Definition at line 55 of file DoubleParameter.hpp.

References __realValue.

  {
    __realValue = d;
  }

void DoubleParameter::set

(

const int

i

)

[inline, virtual]

Implements Parameter.

Definition at line 60 of file DoubleParameter.hpp.

References __realValue.

  {
    __realValue = (real_t)(i);
  }

void DoubleParameter::set

(

const char *

c

)

[inline, virtual]

Implements Parameter.

Definition at line 65 of file DoubleParameter.hpp.

References ErrorHandler::normal, and stringify().

  {
    throw ErrorHandler(__FILE__,__LINE__,
                       "cannot assignate the string '"+stringify(c)
                       +"' to a real_t parameter\n",
                       ErrorHandler::normal);
  }

Here is the call graph for this function:

DoubleParameter::operator real_t &

(

)

[inline]

Definition at line 73 of file DoubleParameter.hpp.

References __realValue.

  {
    return __realValue;
  }

DoubleParameter::operator real_t

(

)

const [inline]

Definition at line 78 of file DoubleParameter.hpp.

References __realValue.

  {
    return __realValue;
  }

void DoubleParameter::reset

(

)

[inline, virtual]

Implements Parameter.

Definition at line 83 of file DoubleParameter.hpp.

References __defaultDoubleValue, and __realValue.

  {
    __realValue = __defaultDoubleValue;
  }

const std::string DoubleParameter::typeName

(

)

const [inline, virtual]

Implements Parameter.

Definition at line 88 of file DoubleParameter.hpp.

  {
    return "real";
  }

void Parameter::set

(

const std::string &

s

)

[inline, inherited]

Definition at line 67 of file Parameter.hpp.

                               {
    set(s.c_str());
  }

const Type& Parameter::type

(

)

const [inline, inherited]

Definition at line 74 of file Parameter.hpp.

References Parameter::__type.

  {
    return __type;
  }

const char * Parameter::label

(

)

const [inherited]

Definition at line 26 of file Parameter.cpp.

References Parameter::__label.

{
  return __label;
}

---

Friends And Related Function Documentation

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

Definition at line 79 of file Parameter.hpp.

  {
    return P.put(os);
  }

---

Member Data Documentation

const real_t DoubleParameter::__defaultDoubleValue [private]

Definition at line 39 of file DoubleParameter.hpp.

Referenced by reset().

real_t DoubleParameter::__realValue [private]

Definition at line 40 of file DoubleParameter.hpp.

Referenced by operator real_t(), operator real_t &(), put(), reset(), and set().

Type Parameter::__type [protected, inherited]

Definition at line 49 of file Parameter.hpp.

Referenced by Parameter::type().

---

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

• DoubleParameter.hpp