SearchVariable Class Reference

#include <searchState.h>

List of all members.

Public Member Functions

double getConfidence () const
QString getName () const
double getRange () const
double getValue () const
bool isCircular () const
bool isFixed () const
 SearchVariable (const SearchVariable *v)
 SearchVariable (QString name, double min, double max, double maxJump, bool circular=false)
void setCircular (bool c)
void setConfidence (double c)
void setFixed (bool f)
void setJump (double j)
void setMaxJump (double mj)
void setRange (double min, double max)
void setValue (double v)

Public Attributes

double mMaxJump
double mMaxVal
double mMinVal

Private Attributes

bool mCircular
 If the variable is circular it means that max and min actually mean the same thing.
double mConfidence
 The confidence that we have in the stored value.
bool mFixed
 Flag shows that this variable is fixed at its current position and should not be changed.
QString mName
 The name of this variable; can be used to retrieve the variable.
double mValue

Detailed Description

This is a general variable that we can perform search over. It can be an eigenGrasp amplitude, wrist DOF, hand position in space etc. It just has a value, a legal range defined my a min and a max. It can also store some other information, such as the maximum "jump" allowed for this variable when doing simulated annealing, a "confidence" leve we have in the value of this variable, etc.

Definition at line 52 of file searchState.h.


Constructor & Destructor Documentation

SearchVariable::SearchVariable ( QString  name,
double  min,
double  max,
double  maxJump,
bool  circular = false 
)

Definition at line 47 of file searchState.cpp.

SearchVariable::SearchVariable ( const SearchVariable v  ) 

Definition at line 57 of file searchState.cpp.


Member Function Documentation

double SearchVariable::getConfidence (  )  const [inline]

Definition at line 84 of file searchState.h.

QString SearchVariable::getName (  )  const [inline]

Definition at line 86 of file searchState.h.

double SearchVariable::getRange (  )  const [inline]

Definition at line 81 of file searchState.h.

double SearchVariable::getValue (  )  const [inline]

Definition at line 75 of file searchState.h.

bool SearchVariable::isCircular (  )  const [inline]

Definition at line 79 of file searchState.h.

bool SearchVariable::isFixed (  )  const [inline]

Definition at line 77 of file searchState.h.

void SearchVariable::setCircular ( bool  c  )  [inline]

Definition at line 78 of file searchState.h.

void SearchVariable::setConfidence ( double  c  )  [inline]

Definition at line 85 of file searchState.h.

void SearchVariable::setFixed ( bool  f  )  [inline]

Definition at line 76 of file searchState.h.

void SearchVariable::setJump ( double  j  )  [inline]

Definition at line 83 of file searchState.h.

void SearchVariable::setMaxJump ( double  mj  )  [inline]

Definition at line 82 of file searchState.h.

void SearchVariable::setRange ( double  min,
double  max 
) [inline]

Definition at line 80 of file searchState.h.

void SearchVariable::setValue ( double  v  )  [inline]

Definition at line 74 of file searchState.h.


Member Data Documentation

bool SearchVariable::mCircular [private]

If the variable is circular it means that max and min actually mean the same thing.

For example, angles: -PI = PI

Definition at line 66 of file searchState.h.

double SearchVariable::mConfidence [private]

The confidence that we have in the stored value.

Mainly used when this variable is used as "input" to guide a search, rather than a variable that is being searched.

Definition at line 59 of file searchState.h.

bool SearchVariable::mFixed [private]

Flag shows that this variable is fixed at its current position and should not be changed.

Definition at line 63 of file searchState.h.

Definition at line 69 of file searchState.h.

Definition at line 69 of file searchState.h.

Definition at line 69 of file searchState.h.

QString SearchVariable::mName [private]

The name of this variable; can be used to retrieve the variable.

Definition at line 61 of file searchState.h.

double SearchVariable::mValue [private]

Definition at line 55 of file searchState.h.


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


graspit
Author(s):
autogenerated on Wed Jan 25 11:00:24 2012