ParametrizableObject Class Reference

#include <ParametrizableObject.hpp>

Inheritance diagram for ParametrizableObject:

[legend]

List of all members.

Public Member Functions
void	get (IdentifierSet &I)
void	reset ()
const ReferenceCounting < Parameter >	get (const char *parameterName) const
	ParametrizableObject ()
	Constructs a ParametrizableObject.
virtual	~ParametrizableObject ()
Protected Member Functions
void	add (ReferenceCounting< Parameter > p)
template<typename EnumType>
void	get (const char *label, EnumType &e) const
void	get (const char *label, real_t &d) const
void	get (const char *label, int &i) const
void	get (const char *label, std::string &s) const
Private Types
typedef std::map< const char *, ReferenceCounting < Parameter >, StringEquality >	ParameterList
Private Member Functions
virtual std::ostream &	put (std::ostream &os) const =0
Private Attributes
ParameterList	__parameters
Friends
std::ostream &	operator<< (std::ostream &os, const ParametrizableObject &P)
	Writes the ParametrizableObject.

---

Detailed Description

This class defines objects that can be parametrized and the default values of parameters.

Author:

Stéphane Del Pino.

Definition at line 42 of file ParametrizableObject.hpp.

---

Member Typedef Documentation

typedef std::map<const char*, ReferenceCounting<Parameter>, StringEquality> ParametrizableObject::ParameterList [private]

Definition at line 49 of file ParametrizableObject.hpp.

---

Constructor & Destructor Documentation

ParametrizableObject::ParametrizableObject

(

)

[inline]

Constructs a ParametrizableObject.

Constructs a ParametrizableObject with a given Parameter p and gives the id of the Parametrizable object.

Definition at line 136 of file ParametrizableObject.hpp.

  {
    ;
  }

virtual ParametrizableObject::~ParametrizableObject

(

)

[inline, virtual]

Definition at line 141 of file ParametrizableObject.hpp.

  {
    ;
  }

---

Member Function Documentation

virtual std::ostream& ParametrizableObject::put

(

std::ostream &

os

)

const [private, pure virtual]

Implemented in BiConjugateGradientOptions, BiConjugateGradientStabilizedOptions, ConjugateGradientOptions, FGMRESOptions, GMRESOptions, MultiGridOptions, EliminatedFictitiousDomainOptions, FatBoundaryOptions, KrylovSolverOptions, MemoryManagerOptions, PenalizedFictitousDomainOptions, and SolverDriverOptions.

Referenced by operator<<().

void ParametrizableObject::get

(

IdentifierSet &

I

)

[inline]

Definition at line 54 of file ParametrizableObject.hpp.

References __parameters.

  {
    for (ParameterList::iterator i = __parameters.begin();
         i != __parameters.end(); ++i)
      {
        (*(*i).second).get(I);
        I.insert((*i).first);
      }
  }

void ParametrizableObject::add

(

ReferenceCounting< Parameter >

p

)

[inline, protected]

Definition at line 65 of file ParametrizableObject.hpp.

References __parameters.

  {
    __parameters[(*p).label()] = p;
  }

template<typename EnumType>

void ParametrizableObject::get	(	const char *	label,
		EnumType &	e
	)			const [inline, protected]

Definition at line 71 of file ParametrizableObject.hpp.

References Parameter::Enum.

  {
    ReferenceCounting<Parameter> p = get(label);
    if((*p).type() == Parameter::Enum) {
      e = dynamic_cast<const EnumParameter<EnumType>&>(*p);
      return;
    }
  }

void ParametrizableObject::get	(	const char *	label,
		real_t &	d
	)			const [inline, protected]

Definition at line 80 of file ParametrizableObject.hpp.

References Parameter::Double.

  {
    ReferenceCounting<Parameter> p = get(label);
    if((*p).type() == Parameter::Double) {
      d = dynamic_cast<const DoubleParameter&>(*p);
      return;
    }      
  }

void ParametrizableObject::get	(	const char *	label,
		int &	i
	)			const [inline, protected]

Definition at line 89 of file ParametrizableObject.hpp.

References Parameter::Integer.

  {
    ReferenceCounting<Parameter> p = get(label);
    if((*p).type() == Parameter::Integer) {
      i = dynamic_cast<const IntegerParameter&>(*p);
      return;
    }      
  }

void ParametrizableObject::get	(	const char *	label,
		std::string &	s
	)			const [inline, protected]

Definition at line 98 of file ParametrizableObject.hpp.

References Parameter::String.

  {
    ReferenceCounting<Parameter> p = get(label);
    if((*p).type() == Parameter::String) {
      s = dynamic_cast<const StringParameter&>(*p);
      return;
    }      
  }

void ParametrizableObject::reset

(

)

[inline]

Definition at line 109 of file ParametrizableObject.hpp.

References __parameters.

  {
    for (ParameterList::iterator i = __parameters.begin();
         i != __parameters.end(); ++i) {
      (*(*i).second).reset();
    }
  }

const ReferenceCounting<Parameter> ParametrizableObject::get

(

const char *

parameterName

)

const [inline]

Definition at line 117 of file ParametrizableObject.hpp.

References __parameters, ErrorHandler::normal, and stringify().

  {
    ParameterList::const_iterator i = __parameters.find(parameterName);
    if (i != __parameters.end()) {
      return (*i).second;
    } else {
      throw ErrorHandler(__FILE__,__LINE__,
                         stringify(parameterName)+" not found",
                         ErrorHandler::normal);
      return 0;
    }
  }

Here is the call graph for this function:

---

Friends And Related Function Documentation

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

Writes the ParametrizableObject.

Definition at line 22 of file ParametrizableObject.cpp.

{
  os  << P.put(os);
  return os;
}

---

Member Data Documentation

ParameterList ParametrizableObject::__parameters [private]

Definition at line 51 of file ParametrizableObject.hpp.

Referenced by add(), get(), and reset().

---

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

• ParametrizableObject.hpp