Point Cloud Library (PCL)  1.6.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
pcl::Grabber Class Reference

Grabber interface for PCL 1.x device drivers. More...

#include <pcl/io/grabber.h>

Inheritance diagram for pcl::Grabber:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 Grabber ()
 Constructor.
virtual ~Grabber () throw ()
 virtual desctructor.
template<typename T >
boost::signals2::connection registerCallback (const boost::function< T > &callback)
 registers a callback function/method to a signal with the corresponding signature
template<typename T >
bool providesCallback () const
 indicates whether a signal with given parameter-type exists or not
virtual void start ()=0
 For devices that are streaming, the streams are started by calling this method.
virtual void stop ()=0
 For devices that are streaming, the streams are stopped.
virtual std::string getName () const =0
 returns the name of the concrete subclass.
virtual bool isRunning () const =0
 Indicates whether the grabber is streaming or not.
virtual float getFramesPerSecond () const =0
 returns fps.

Detailed Description

Grabber interface for PCL 1.x device drivers.

Author:
Suat Gedikli <gedikli@willowgarage.com>

Definition at line 59 of file grabber.h.


Constructor & Destructor Documentation

pcl::Grabber::Grabber ( ) [inline]

Constructor.

Definition at line 64 of file grabber.h.

pcl::Grabber::~Grabber ( ) throw () [inline, virtual]

virtual desctructor.

Definition at line 144 of file grabber.h.


Member Function Documentation

virtual float pcl::Grabber::getFramesPerSecond ( ) const [pure virtual]

returns fps.

0 if trigger based.

Implemented in pcl::PCDGrabberBase.

virtual std::string pcl::Grabber::getName ( ) const [pure virtual]

returns the name of the concrete subclass.

Returns:
the name of the concrete driver.

Implemented in pcl::PCDGrabberBase.

virtual bool pcl::Grabber::isRunning ( ) const [pure virtual]

Indicates whether the grabber is streaming or not.

This value is not defined for triggered devices.

Returns:
true if grabber is running / streaming. False otherwise.

Implemented in pcl::PCDGrabberBase.

template<typename T >
bool pcl::Grabber::providesCallback ( ) const

indicates whether a signal with given parameter-type exists or not

Returns:
true if signal exists, false otherwise

Definition at line 265 of file grabber.h.

template<typename T >
boost::signals2::connection pcl::Grabber::registerCallback ( const boost::function< T > &  callback)

registers a callback function/method to a signal with the corresponding signature

Parameters:
[in]callback,:the callback function/method
Returns:
Connection object, that can be used to disconnect the callback method from the signal again.

Definition at line 236 of file grabber.h.

virtual void pcl::Grabber::start ( ) [pure virtual]

For devices that are streaming, the streams are started by calling this method.

Trigger-based devices, just trigger the device once for each call of start.

Implemented in pcl::PCDGrabberBase.

virtual void pcl::Grabber::stop ( ) [pure virtual]

For devices that are streaming, the streams are stopped.

This method has no effect for triggered devices.

Implemented in pcl::PCDGrabberBase.


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