SCIRun  5.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | List of all members
AlgorithmParameterList Class Reference

#include <AlgorithmBase.h>

Inheritance diagram for AlgorithmParameterList:
AlgorithmInterface HasId< IdType, IdGenerator > AlgorithmBase ElectrodeCoilSetupAlgorithm GenerateROIStatisticsAlgorithm SetConductivitiesToTetMeshAlgorithm SetupRHSforTDCSandTMSAlgorithm ReadMatrixAlgorithm TextToTriSurfFieldAlgorithm WriteMatrixAlgorithm AlignMeshBoundingBoxesAlgo ApplyMappingMatrixAlgo BuildMappingMatrixAlgo CalculateDistanceFieldAlgo CalculateGradientsAlgo CalculateSignedDistanceFieldAlgo CalculateVectorMagnitudesAlgo ConvertFieldBasisTypeAlgo ConvertMeshToIrregularMeshAlgo ConvertMeshToPointCloudMeshAlgo ConvertMeshToTriSurfMeshAlgo FairMeshAlgo GetDomainBoundaryAlgo GetFieldBoundaryAlgo GetFieldDataAlgo GetMeshDataAlgo GetMeshNodesAlgo InterfaceWithCleaverAlgorithm JoinFieldsAlgo MapFieldDataFromElemToNodeAlgo MapFieldDataFromElemToNodeAlgo MapFieldDataFromNodeToElemAlgo MapFieldDataFromNodeToElemAlgo MapFieldDataOntoElemsAlgo MapFieldDataOntoNodesAlgo ProjectPointsOntoMeshAlgo ReportFieldInfoAlgorithm ResampleRegularMeshAlgo ScaleFieldMeshAndDataAlgo SetFieldDataAlgo SetMeshNodesAlgo SplitFieldByDomainAlgo BuildFEMatrixAlgo BuildTDCSMatrixAlgo GetSubMatrixAlgo AddKnownsToLinearSystemAlgo AppendMatrixAlgorithm ConvertMatrixTypeAlgorithm EvaluateLinearAlgebraBinaryAlgorithm EvaluateLinearAlgebraUnaryAlgorithm ReportMatrixInfoAlgorithm SelectSubMatrixAlgorithm SolveLinearSystemAlgo SolveLinearSystemAlgorithm ObjToFieldReader MockAlgorithm SetFieldDataToConstantValueAlgo

Public Member Functions

 AlgorithmParameterList ()
 
bool set (const AlgorithmParameterName &key, const AlgorithmParameter::Value &value)
 
const AlgorithmParameterget (const AlgorithmParameterName &key) const
 
bool set_option (const AlgorithmParameterName &key, const std::string &value)
 
bool get_option (const AlgorithmParameterName &key, std::string &value) const
 
std::string get_option (const AlgorithmParameterName &key) const
 
bool check_option (const AlgorithmParameterName &key, const std::string &value) const
 
virtual bool keyNotFoundPolicy (const AlgorithmParameterName &key)
 
- Public Member Functions inherited from AlgorithmInterface
virtual ~AlgorithmInterface ()
 
virtual AlgorithmOutput run_generic (const AlgorithmInput &input) const =0
 
- Public Member Functions inherited from HasId< IdType, IdGenerator >
 HasId ()
 
IdType id () const
 

Protected Member Functions

void dumpAlgoState () const
 
void addParameter (const AlgorithmParameterName &key, const AlgorithmParameter::Value &defaultValue)
 
void add_option (const AlgorithmParameterName &key, const std::string &defval, const std::string &options)
 

Additional Inherited Members

- Public Types inherited from HasId< IdType, IdGenerator >
typedef IdType id_type
 

Detailed Description

Todo:
: link this to ModuleState via meeting discussion

Constructor & Destructor Documentation

Member Function Documentation

void add_option ( const AlgorithmParameterName key,
const std::string &  defval,
const std::string &  options 
)
protected
void addParameter ( const AlgorithmParameterName key,
const AlgorithmParameter::Value defaultValue 
)
protected
bool check_option ( const AlgorithmParameterName key,
const std::string &  value 
) const
void dumpAlgoState ( ) const
protected
const AlgorithmParameter & get ( const AlgorithmParameterName key) const
virtual

Implements AlgorithmInterface.

bool get_option ( const AlgorithmParameterName key,
std::string &  value 
) const
std::string get_option ( const AlgorithmParameterName key) const
bool keyNotFoundPolicy ( const AlgorithmParameterName key)
virtual
bool set ( const AlgorithmParameterName key,
const AlgorithmParameter::Value value 
)
virtual

Implements AlgorithmInterface.

bool set_option ( const AlgorithmParameterName key,
const std::string &  value 
)

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