StringParameter Class Reference

#include <StringParameter.hpp>

Inheritance diagram for StringParameter:

[legend]

Collaboration diagram for StringParameter:

[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 std::string & ()
	operator const std::string & () const
const std::string	typeName () const
	StringParameter (const StringParameter &sp)
	StringParameter (const std::string &s, const char *label)
	StringParameter (const char *c, const char *label)
	~StringParameter ()
void	set (const std::string &s)
const Type &	type () const
const char *	label () const
Protected Attributes
Type	__type
Private Member Functions
void	reset ()
std::ostream &	put (std::ostream &os) const
Private Attributes
const std::string	__defaultStringValue
std::string	__stringValue
Friends
std::ostream &	operator<< (std::ostream &os, const Parameter &P)

---

Detailed Description

This is the base describes String Parameters.

Author:

Stéphane Del Pino.

Definition at line 35 of file StringParameter.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

StringParameter::StringParameter

(

const StringParameter &

sp

)

[inline]

Definition at line 96 of file StringParameter.hpp.

    : Parameter(sp),
      __defaultStringValue(sp.__defaultStringValue),
      __stringValue(sp.__stringValue)
  {
    ;
  }

StringParameter::StringParameter	(	const std::string &	s,
		const char *	label
	)			[inline]

Definition at line 104 of file StringParameter.hpp.

    : Parameter(Parameter::String, label),
      __defaultStringValue(s),
      __stringValue(__defaultStringValue)
  {
    ;
  }

StringParameter::StringParameter	(	const char *	c,
		const char *	label
	)			[inline]

Definition at line 112 of file StringParameter.hpp.

    : Parameter(Parameter::String, label),
      __defaultStringValue(c),
      __stringValue(__defaultStringValue)
  {
    ;
  }

StringParameter::~StringParameter

(

)

[inline]

Definition at line 120 of file StringParameter.hpp.

  {
    ;
  }

---

Member Function Documentation

void StringParameter::reset

(

)

[inline, private, virtual]

Implements Parameter.

Definition at line 39 of file StringParameter.hpp.

References __defaultStringValue, and __stringValue.

  {
    __stringValue = __defaultStringValue;
  }

std::ostream& StringParameter::put

(

std::ostream &

os

)

const [inline, private, virtual]

Implements Parameter.

Definition at line 47 of file StringParameter.hpp.

References __stringValue.

  {
    os << __stringValue;
    return os;
  }

void StringParameter::get

(

IdentifierSet &

I

)

[inline, virtual]

Does not add other identifiers.

Implements Parameter.

Definition at line 55 of file StringParameter.hpp.

  {
    ;
  }

void StringParameter::set

(

const real_t

d

)

[inline, virtual]

Implements Parameter.

Definition at line 60 of file StringParameter.hpp.

References ErrorHandler::normal, and stringify().

  {
    throw ErrorHandler(__FILE__,__LINE__,
                       "cannot assignate the real value '"+stringify(d)
                       +"' to a string parameter",
                       ErrorHandler::normal);
  }

Here is the call graph for this function:

void StringParameter::set

(

const int

i

)

[inline, virtual]

Implements Parameter.

Definition at line 68 of file StringParameter.hpp.

References ErrorHandler::normal, and stringify().

  {
    throw ErrorHandler(__FILE__,__LINE__,
                       "cannot assignate the integer value '"+stringify(i)
                       +"' to a string parameter",
                       ErrorHandler::normal);
  }

Here is the call graph for this function:

void StringParameter::set

(

const char *

c

)

[inline, virtual]

Implements Parameter.

Definition at line 76 of file StringParameter.hpp.

References __stringValue.

  {
    __stringValue = c;
  }

StringParameter::operator std::string &

(

)

[inline]

Definition at line 81 of file StringParameter.hpp.

References __stringValue.

  {
    return __stringValue;
  }

StringParameter::operator const std::string &

(

)

const [inline]

Definition at line 86 of file StringParameter.hpp.

References __stringValue.

  {
    return __stringValue;
  }

const std::string StringParameter::typeName

(

)

const [inline, virtual]

Implements Parameter.

Definition at line 91 of file StringParameter.hpp.

  {
    return "string";
  }

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 std::string StringParameter::__defaultStringValue [private]

Definition at line 44 of file StringParameter.hpp.

Referenced by reset().

std::string StringParameter::__stringValue [private]

Definition at line 45 of file StringParameter.hpp.

Referenced by operator const std::string &(), operator std::string &(), 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:

• StringParameter.hpp