FEI Version of the Day
Public Types | Public Member Functions
fei::Param Class Reference

#include <fei_Param.hpp>

List of all members.

Public Types

enum  ParamType

Public Member Functions

 Param (const char *name, const char *value)
 Param (const char *name, double value)
 Param (const char *name, int value)
 Param (const char *name, const void *value)
 Param (const char *name, bool value)
 Param (const Param &src)
virtual ~Param ()
Paramoperator= (const Param &src)
const std::string & getName () const
ParamType getType () const
const std::string & getStringValue () const
double getDoubleValue () const
int getIntValue () const
bool getBoolValue () const
const void * getVoidValue () const

Detailed Description

Simple container that pairs a name with a parameter that can be one of several different primitive types. This container is used as the value-type of the class fei::ParameterSet.

Instances of fei::Param are fully defined at construction, and can not be altered later, except by assignment.

Definition at line 58 of file fei_Param.hpp.


Member Enumeration Documentation

enumeration for parameter-types

Definition at line 61 of file fei_Param.hpp.


Constructor & Destructor Documentation

fei::Param::Param ( const char *  name,
const char *  value 
)

Constructor

Definition at line 49 of file fei_Param.cpp.

fei::Param::Param ( const char *  name,
double  value 
)

Constructor

Definition at line 63 of file fei_Param.cpp.

fei::Param::Param ( const char *  name,
int  value 
)

Constructor

Definition at line 76 of file fei_Param.cpp.

fei::Param::Param ( const char *  name,
const void *  value 
)

Constructor

Definition at line 102 of file fei_Param.cpp.

fei::Param::Param ( const char *  name,
bool  value 
)

Constructor

Definition at line 89 of file fei_Param.cpp.

fei::Param::Param ( const Param src)

Copy Constructor

Definition at line 115 of file fei_Param.cpp.

fei::Param::~Param ( ) [virtual]

Destructor

Definition at line 126 of file fei_Param.cpp.


Member Function Documentation

fei::Param & fei::Param::operator= ( const Param src)

Assignment operator

Definition at line 130 of file fei_Param.cpp.

const std::string & fei::Param::getName ( ) const [inline]

Query for the name of the parameter

Definition at line 127 of file fei_Param.hpp.

fei::Param::ParamType fei::Param::getType ( ) const [inline]

Query for the type of the parameter

Definition at line 133 of file fei_Param.hpp.

const std::string & fei::Param::getStringValue ( ) const [inline]

Query for string value. Returned string is empty if getType() doesn't return Param::STRING

Definition at line 139 of file fei_Param.hpp.

double fei::Param::getDoubleValue ( ) const [inline]

Query for double value. Returned double is meaningless if getType() doesn't return Param::DOUBLE

Definition at line 145 of file fei_Param.hpp.

int fei::Param::getIntValue ( ) const [inline]

Query for int value. Returned int is meaningless if getType() doesn't return Param::INT

Definition at line 151 of file fei_Param.hpp.

bool fei::Param::getBoolValue ( ) const [inline]

Query for bool value. Returned bool is meaningless if getType() doesn't return Param::BOOL

Definition at line 157 of file fei_Param.hpp.

const void * fei::Param::getVoidValue ( ) const [inline]

Query for void-pointer value. Returned void-pointer is meaningless if getType() doesn't return Param::VOID

Definition at line 163 of file fei_Param.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends