verve::AgentDescriptor

verve::AgentDescriptor Class Reference

A data structure used for Agent creation. More...

#include <AgentDescriptor.h>

List of all members.

Public Member Functions

VERVE_DECL AgentDescriptor ()
VERVE_DECL AgentDescriptor (const AgentDescriptor &desc)
virtual VERVE_DECL ~AgentDescriptor ()
virtual VERVE_DECL void VERVE_CALL addDiscreteSensor (unsigned int numOptions)
virtual VERVE_DECL unsigned
int VERVE_CALL 		getNumDiscreteSensors () const
virtual VERVE_DECL unsigned
int VERVE_CALL 		getDiscreteSensorNumOptions (unsigned int i) const
virtual VERVE_DECL void VERVE_CALL addContinuousSensor (bool isCircular=false)
virtual VERVE_DECL unsigned
int VERVE_CALL 		getNumContinuousSensors () const
virtual VERVE_DECL bool VERVE_CALL getContinuousSensorIsCircular (unsigned int i) const
virtual VERVE_DECL void VERVE_CALL setNumOutputs (unsigned int numOutputs)
virtual VERVE_DECL unsigned
int VERVE_CALL 		getNumOutputs () const
virtual VERVE_DECL void VERVE_CALL setContinuousSensorResolution (unsigned int resolution)
virtual VERVE_DECL unsigned
int VERVE_CALL 		getContinuousSensorResolution () const
virtual VERVE_DECL void VERVE_CALL setDynamicRBFEnabled (bool enabled)
virtual VERVE_DECL bool VERVE_CALL isDynamicRBFEnabled () const
virtual VERVE_DECL void VERVE_CALL setArchitecture (AgentArchitecture arch)
virtual VERVE_DECL AgentArchitecture
VERVE_CALL 		getArchitecture () const
virtual VERVE_DECL void VERVE_CALL setMaxNumPlanningSteps (unsigned int steps)
virtual VERVE_DECL unsigned
int VERVE_CALL 		getMaxNumPlanningSteps () const
virtual VERVE_DECL void VERVE_CALL setPlanningUncertaintyThreshold (real threshold)
virtual VERVE_DECL real VERVE_CALL getPlanningUncertaintyThreshold () const

Private Attributes

std::vector< DiscreteSensorDescriptor > mDiscreteSensors
std::vector< ContinuousSensorDescriptor > mContinuousSensors
unsigned int mNumOutputs
unsigned int mContinuousSensorResolution
bool mDynamicRBFEnabled
AgentArchitecture mAgentArchitecture
unsigned int mMaxNumPlanningSteps
real mPlanningUncertaintyThreshold

Detailed Description

A data structure used for Agent creation.

It contains data that must be specified before the Agent is created.

Definition at line 64 of file AgentDescriptor.h.

Constructor & Destructor Documentation

verve::AgentDescriptor::AgentDescriptor (   ) 
 

Definition at line 28 of file AgentDescriptor.cpp.

References verve::defaults::agentArchitecture, mAgentArchitecture, verve::defaults::maxNumPlanningSteps, mContinuousSensorResolution, mDynamicRBFEnabled, mMaxNumPlanningSteps, mNumOutputs, mPlanningUncertaintyThreshold, and verve::defaults::planningUncertaintyThreshold.

verve::AgentDescriptor::AgentDescriptor (  const AgentDescriptor &  desc  ) 
 

Definition at line 39 of file AgentDescriptor.cpp.

References getDiscreteSensorNumOptions(), getNumDiscreteSensors(), and mDiscreteSensors.

verve::AgentDescriptor::~AgentDescriptor (   )  [virtual]
 

Definition at line 67 of file AgentDescriptor.cpp.

References mContinuousSensors, and mDiscreteSensors.

Member Function Documentation

void verve::AgentDescriptor::addContinuousSensor (  bool  isCircular = false  )  [virtual]
 

Adds a new continuous sensor.

It is the user's responsibility to keep track of sensor indices for later access (e.g. the first continuous sensor added uses the index 0); indices are separate for continuous and discrete sensors, however. 'isCircular' determines whether the input range is 'circular' (i.e. it's value can wrap from -1 to +1). This is useful, for example, when an input represents an angle that can jump from -1 to +1.

Definition at line 92 of file AgentDescriptor.cpp.

References verve::ContinuousSensorDescriptor::isCircular, and mContinuousSensors.

void verve::AgentDescriptor::addDiscreteSensor (  unsigned int  numOptions  )  [virtual]
 

Adds a new discrete sensor.

It is the user's responsibility to keep track of sensor indices for later access (e.g. the first discrete sensor added uses the index 0); indices are separate for continuous and discrete sensors, however. The 'numOptions' specifies how many possible values this discrete sensor can represent. This can be used as a binary sensor if 'numOptions' = 2. 'numOptions' must be at least 1.

Definition at line 73 of file AgentDescriptor.cpp.

References mDiscreteSensors, and verve::DiscreteSensorDescriptor::numOptions.

AgentArchitecture verve::AgentDescriptor::getArchitecture (   )  const [virtual]
 

Returns the overall Agent architecture being used.

Definition at line 147 of file AgentDescriptor.cpp.

References mAgentArchitecture.

Referenced by verve::Agent::Agent(), verve::Agent::planningSequence(), and verve::Agent::update().

bool verve::AgentDescriptor::getContinuousSensorIsCircular (  unsigned int  i  )  const [virtual]
 

Returns whether the continuous sensor at the given index represents a circular data range.

Definition at line 104 of file AgentDescriptor.cpp.

References mContinuousSensors.

unsigned int verve::AgentDescriptor::getContinuousSensorResolution (   )  const [virtual]
 

Returns the resolution of the continuous sensors.

Definition at line 127 of file AgentDescriptor.cpp.

References mContinuousSensorResolution.

unsigned int verve::AgentDescriptor::getDiscreteSensorNumOptions (  unsigned int  i  )  const [virtual]
 

Returns the number of options for the discrete sensor at the given index.

Definition at line 86 of file AgentDescriptor.cpp.

References mDiscreteSensors.

Referenced by AgentDescriptor(), and verve::Observation::init().

unsigned int verve::AgentDescriptor::getMaxNumPlanningSteps (   )  const [virtual]
 

Returns the maximum number of steps to take during a planning sequence.

Definition at line 157 of file AgentDescriptor.cpp.

References mMaxNumPlanningSteps.

Referenced by verve::Agent::planningSequence().

unsigned int verve::AgentDescriptor::getNumContinuousSensors (   )  const [virtual]
 

Returns the number of continuous sensors.

Definition at line 99 of file AgentDescriptor.cpp.

References mContinuousSensors.

Referenced by verve::Agent::getNumContinuousSensors(), and verve::Observation::init().

unsigned int verve::AgentDescriptor::getNumDiscreteSensors (   )  const [virtual]
 

Returns the number of discrete sensors.

Definition at line 81 of file AgentDescriptor.cpp.

References mDiscreteSensors.

Referenced by AgentDescriptor(), verve::Agent::getNumDiscreteSensors(), and verve::Observation::init().

unsigned int verve::AgentDescriptor::getNumOutputs (   )  const [virtual]
 

Returns the number of outputs the Agent will have.

Definition at line 115 of file AgentDescriptor.cpp.

References mNumOutputs.

Referenced by verve::Agent::Agent().

real verve::AgentDescriptor::getPlanningUncertaintyThreshold (   )  const [virtual]
 

Returns the maximum amount of estimated uncertainty to tolerate before ending a planning sequence.

Definition at line 167 of file AgentDescriptor.cpp.

References mPlanningUncertaintyThreshold.

Referenced by verve::Agent::planningSequence().

bool verve::AgentDescriptor::isDynamicRBFEnabled (   )  const [virtual]
 

Returns whether the dynamic RBF feature is enabled.

Definition at line 137 of file AgentDescriptor.cpp.

References mDynamicRBFEnabled.

Referenced by verve::Agent::Agent().

void verve::AgentDescriptor::setArchitecture (  AgentArchitecture  arch  )  [virtual]
 

Sets the overall Agent architecture to use.

Definition at line 142 of file AgentDescriptor.cpp.

References mAgentArchitecture.

void verve::AgentDescriptor::setContinuousSensorResolution (  unsigned int  resolution  )  [virtual]
 

Sets the resolution of the continuous sensors.

This number represents how many radial basis functions are used across each dimension. This must be at least 1.

Definition at line 120 of file AgentDescriptor.cpp.

References mContinuousSensorResolution.

void verve::AgentDescriptor::setDynamicRBFEnabled (  bool  enabled  )  [virtual]
 

Sets whether the state space is initially filled with RBFs or if we start with none and add them dynamically as necessary.

This is a highly recommended feature.

Definition at line 132 of file AgentDescriptor.cpp.

References mDynamicRBFEnabled.

void verve::AgentDescriptor::setMaxNumPlanningSteps (  unsigned int  steps  )  [virtual]
 

Sets the maximum number of steps to take during a planning sequence.

Definition at line 152 of file AgentDescriptor.cpp.

References mMaxNumPlanningSteps.

void verve::AgentDescriptor::setNumOutputs (  unsigned int  numOutputs  )  [virtual]
 

Sets the number of outputs the Agent should have.

Definition at line 110 of file AgentDescriptor.cpp.

References mNumOutputs.

void verve::AgentDescriptor::setPlanningUncertaintyThreshold (  real  threshold  )  [virtual]
 

Sets the maximum amount of estimated uncertainty to tolerate before ending a planning sequence.

Definition at line 162 of file AgentDescriptor.cpp.

References mPlanningUncertaintyThreshold.

Member Data Documentation

AgentArchitecture verve::AgentDescriptor::mAgentArchitecture [private]
 

The overall Agent architecture to use.

Definition at line 183 of file AgentDescriptor.h.

Referenced by AgentDescriptor(), getArchitecture(), and setArchitecture().

unsigned int verve::AgentDescriptor::mContinuousSensorResolution [private]
 

Determines the resolution of the continuous sensors.

Definition at line 177 of file AgentDescriptor.h.

Referenced by AgentDescriptor(), getContinuousSensorResolution(), and setContinuousSensorResolution().

std::vector<ContinuousSensorDescriptor> verve::AgentDescriptor::mContinuousSensors [private]
 

A list of the continuous sensor descriptors.

Definition at line 171 of file AgentDescriptor.h.

Referenced by addContinuousSensor(), getContinuousSensorIsCircular(), getNumContinuousSensors(), and ~AgentDescriptor().

std::vector<DiscreteSensorDescriptor> verve::AgentDescriptor::mDiscreteSensors [private]
 

A list of the discrete sensor descriptors.

Definition at line 168 of file AgentDescriptor.h.

Referenced by addDiscreteSensor(), AgentDescriptor(), getDiscreteSensorNumOptions(), getNumDiscreteSensors(), and ~AgentDescriptor().

bool verve::AgentDescriptor::mDynamicRBFEnabled [private]
 

Determines whether the dynamic RBF feature is enabled.

Definition at line 180 of file AgentDescriptor.h.

Referenced by AgentDescriptor(), isDynamicRBFEnabled(), and setDynamicRBFEnabled().

unsigned int verve::AgentDescriptor::mMaxNumPlanningSteps [private]
 

The maximum number of steps to take during a planning sequence.

Definition at line 186 of file AgentDescriptor.h.

Referenced by AgentDescriptor(), getMaxNumPlanningSteps(), and setMaxNumPlanningSteps().

unsigned int verve::AgentDescriptor::mNumOutputs [private]
 

The number of outputs the Agent should have.

Definition at line 174 of file AgentDescriptor.h.

Referenced by AgentDescriptor(), getNumOutputs(), and setNumOutputs().

real verve::AgentDescriptor::mPlanningUncertaintyThreshold [private]
 

The maximum amount of estimated uncertainty to tolerate before ending a planning sequence.

Definition at line 190 of file AgentDescriptor.h.

Referenced by AgentDescriptor(), getPlanningUncertaintyThreshold(), and setPlanningUncertaintyThreshold().

The documentation for this class was generated from the following files:
Generated on Tue Jan 24 21:46:39 2006 for Verve by  doxygen 1.4.6-NO