SCL  1.0
Standard Control Library : Control, dynamics, physics, and simulation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
scl::CSensorSetBase Class Referenceabstract

#include <CSensorSetBase.hpp>

Collaboration diagram for scl::CSensorSetBase:
Collaboration graph
[legend]

Public Member Functions

virtual sBool sense ()=0
 
virtual sBool getSensorOutputs (Eigen::VectorXd &ret_output)=0
 
virtual sBool init ()=0
 
virtual sBool hasBeenInit ()
 
 CSensorSetBase ()
 
virtual ~CSensorSetBase ()
 

Protected Attributes

sutil::CMappedPointerList
< std::string, CSensorBase,
true > 
sensors_
 
sBool has_been_init_
 

Detailed Description

An sensor set combines a variety of potentially different sensors into a common interface that a controller can interact with. The number of sensors is not necessarily related to the degrees of freedom of the system (could be more, equal or less, or could even be video feeds etc.).

Subclasses of this class will simply organize sensors into a coherent interface, abstracting all physical details and exposing a data source for the controller.

NOTE for "Real Robots": While working with a real robot, subclass this base class and implement your driver in it.

Constructor & Destructor Documentation

scl::CSensorSetBase::CSensorSetBase ( )
inline

Default constructor. Sets stuff to NULL

virtual scl::CSensorSetBase::~CSensorSetBase ( )
inlinevirtual

Default destructor. Does nothing.

Member Function Documentation

virtual sBool scl::CSensorSetBase::getSensorOutputs ( Eigen::VectorXd &  ret_output)
pure virtual

Gets the output of the sensor. Returned in the passed variable.

virtual sBool scl::CSensorSetBase::hasBeenInit ( )
inlinevirtual

Has this sensor been initialized

virtual sBool scl::CSensorSetBase::init ( )
pure virtual

Initialize the sensor set

virtual sBool scl::CSensorSetBase::sense ( )
pure virtual

Reads the sensors. These will be translated into individual sensor commands.

Member Data Documentation

sBool scl::CSensorSetBase::has_been_init_
protected

Initialization state

sutil::CMappedPointerList<std::string, CSensorBase, true> scl::CSensorSetBase::sensors_
protected

A collection of sensors that a controller can send commands to


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