openModeller  Version 1.5.0
Public Member Functions | Private Attributes | List of all members
AlgParameter Class Reference

#include <AlgParameter.hh>

Collaboration diagram for AlgParameter:
Collaboration graph

Public Member Functions

 AlgParameter ()
 
 AlgParameter (std::string const id, std::string const value=0)
 
 AlgParameter (const AlgParameter &)
 
 ~AlgParameter ()
 
AlgParameter & operator= (const AlgParameter &)
 
std::string const id () const
 
void setId (std::string const id)
 
std::string const value () const
 
double valueReal ()
 
void setValue (std::string const val)
 
void setValue (double val)
 

Private Attributes

std::string _id
 
std::string _value
 

Detailed Description

Declaration of AlgParameter class.

Author
Mauro E S Muņoz (mauro.nosp@m.@cri.nosp@m.a.org.nosp@m..br)
Date
2004-04-16
Id:
AlgParameter.hh 5670 2013-02-04 15:43:08Z dbolgheroni

LICENSE INFORMATION

Copyright(c) 2004 by CRIA - Centro de Referencia em Informacao Ambiental

http://www.cria.org.br

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details:

http://www.gnu.org/copyleft/gpl.html Algorithms' parameters. A couple (id, value)

Definition at line 44 of file AlgParameter.hh.

Constructor & Destructor Documentation

AlgParameter::AlgParameter ( )

Definition at line 41 of file AlgParameter.cpp.

AlgParameter::AlgParameter ( std::string const  id,
std::string const  value = 0 
)

Definition at line 48 of file AlgParameter.cpp.

References _id, _value, id(), and value().

Here is the call graph for this function:

AlgParameter::AlgParameter ( const AlgParameter &  param)

Definition at line 54 of file AlgParameter.cpp.

References _id, and _value.

AlgParameter::~AlgParameter ( )

Definition at line 64 of file AlgParameter.cpp.

Member Function Documentation

std::string const AlgParameter::id ( ) const
inline

Returns the parameter's id.

Definition at line 56 of file AlgParameter.hh.

Referenced by RequestFile::_readParameters(), AlgParameter(), and AlgorithmImpl::setParameters().

AlgParameter & AlgParameter::operator= ( const AlgParameter &  param)

Definition at line 73 of file AlgParameter.cpp.

References _id, and _value.

void AlgParameter::setId ( std::string const  id)
inline

Set parameter's id.

Definition at line 59 of file AlgParameter.hh.

Referenced by RequestFile::_readParameters(), readParameters(), DgGarpBestSubsets::transferParametersToAlgorithm(), and GarpBestSubsets::transferParametersToAlgorithm().

void AlgParameter::setValue ( std::string const  val)
inline

Set parameter's value.

Definition at line 68 of file AlgParameter.hh.

Referenced by RequestFile::_readParameters(), readParameters(), DgGarpBestSubsets::transferParametersToAlgorithm(), and GarpBestSubsets::transferParametersToAlgorithm().

void AlgParameter::setValue ( double  val)

Definition at line 99 of file AlgParameter.cpp.

References _value.

std::string const AlgParameter::value ( ) const
inline

Returns the parameter's value.

Definition at line 62 of file AlgParameter.hh.

Referenced by AlgParameter(), and AlgorithmImpl::setParameters().

double AlgParameter::valueReal ( )

Returns the parameter's value converted to double.

Definition at line 90 of file AlgParameter.cpp.

References _value.

Member Data Documentation

std::string AlgParameter::_id
private

Definition at line 73 of file AlgParameter.hh.

Referenced by AlgParameter(), and operator=().

std::string AlgParameter::_value
private

Definition at line 74 of file AlgParameter.hh.

Referenced by AlgParameter(), operator=(), setValue(), and valueReal().

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