Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Examples  

gadget::PositionFilter Class Reference

PositionFilter is the abstract base class that all position filters derive from. More...

#include <PositionFilter.h>

Inheritance diagram for gadget::PositionFilter:

Inheritance graph
[legend]
List of all members.

Public Methods

 PositionFilter ()
 Constructor. More...

virtual ~PositionFilter ()
 Destructor. More...

virtual bool config (jccl::ConfigElementPtr c)=0
 Configuration for the filter. More...

virtual void apply (std::vector< PositionData > &posSample)=0
 Apply the pos filter. More...


Static Public Methods

std::string getElementType ()
 Returns the string rep of the element type used to config this device. More...

Detailed Description

PositionFilter is the abstract base class that all position filters derive from.

Definition at line 52 of file PositionFilter.h.

Constructor & Destructor Documentation

gadget::PositionFilter::PositionFilter (    )  [inline]
 

Constructor.

Definition at line 59 of file PositionFilter.h. 

00060    {;}

virtual gadget::PositionFilter::~PositionFilter (    )  [inline, virtual]
 

Destructor.

Definition at line 63 of file PositionFilter.h. 

00064    {;}

Member Function Documentation

virtual bool gadget::PositionFilter::config (  jccl::ConfigElementPtr    c )  [pure virtual]
 

Configuration for the filter.

Returns:
Returns true if configured correctly

Implemented in gadget::PositionXformFilter.

virtual void gadget::PositionFilter::apply (  std::vector< PositionData > &    posSample )  [pure virtual]
 

Apply the pos filter.

Apply the filter to the posSample in place.

Parameters:
posSample  - The sample to modify in place
Postcondition:
posSample is updated with a modified version.

Implemented in gadget::PositionXformFilter.

std::string gadget::PositionFilter::getElementType (    )  [inline, static]
 

Returns the string rep of the element type used to config this device.

This string is used by the device factory to look up device drivers based up the type of element it is trying to load.

Reimplemented in gadget::PositionXformFilter.

Definition at line 83 of file PositionFilter.h. 

00084    {
00085       return std::string("UndefinedPosFilter");
00086    }

The documentation for this class was generated from the following file:
Generated on Sun May 2 14:26:52 2004 for Gadgeteer by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002