FD::ParameterSet Class Reference

#include <ParameterSet.h>

List of all members.

Public Member Functions
bool	exist (const std::string &param) const
ObjectRef	get (std::string param) const
ObjectRef	getDefault (std::string param, ObjectRef value)
void	defaultParam (std::string param, ObjectRef value)
void	add (std::string param, ObjectRef value)
void	print (std::ostream &out=std::cerr) const
void	checkUnused () const

---

Detailed Description

A ParameterSet is a data structure that holds all the parameters needed for the construction of a new node.

Author:

Jean-Marc Valin

Version:

1.0

---

Member Function Documentation

void FD::ParameterSet::add (  std::string  param, ObjectRef  value )

adding the parameters

void FD::ParameterSet::checkUnused (   )  const

check whether there are any unused (never read) parameters (unrecognized)

void FD::ParameterSet::defaultParam (  std::string  param, ObjectRef  value )

set the default parameter

bool FD::ParameterSet::exist (  const std::string &  param  )  const

Does a certain parameter exist?

ObjectRef FD::ParameterSet::get (  std::string  param  )  const

get a parameter's value

ObjectRef FD::ParameterSet::getDefault (  std::string  param, ObjectRef  value )

get the default parameter

void FD::ParameterSet::print (  std::ostream &  out = std::cerr  )  const

printing the parameters

---

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

• ParameterSet.h

---