Point Cloud Library (PCL)  1.9.1-dev
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
pcl::Grabber Class Referenceabstract

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

#include <pcl/io/grabber.h>

+ Inheritance diagram for pcl::Grabber:

Public Member Functions

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

Protected Member Functions

virtual void signalsChanged ()
 
template<typename T >
boost::signals2::signal< T > * find_signal () const
 
template<typename T >
int num_slots () const
 
template<typename T >
void disconnect_all_slots ()
 
template<typename T >
void block_signal ()
 
template<typename T >
void unblock_signal ()
 
void block_signals ()
 
void unblock_signals ()
 
template<typename T >
boost::signals2::signal< T > * createSignal ()
 

Protected Attributes

std::map< std::string, boost::signals2::signal_base * > signals_
 
std::map< std::string, std::vector< boost::signals2::connection > > connections_
 
std::map< std::string, std::vector< boost::signals2::shared_connection_block > > shared_connections_
 

Detailed Description

Grabber interface for PCL 1.x device drivers.

Author
Suat Gedikli gedik.nosp@m.li@w.nosp@m.illow.nosp@m.gara.nosp@m.ge.co.nosp@m.m

Definition at line 57 of file grabber.h.

Constructor & Destructor Documentation

pcl::Grabber::Grabber ( )
inline

Constructor.

Definition at line 62 of file grabber.h.

pcl::Grabber::~Grabber ( )
throw (
)
inlinevirtual

virtual destructor.

Definition at line 142 of file grabber.h.

Member Function Documentation

template<typename T >
void pcl::Grabber::block_signal ( )
protected

Definition at line 173 of file grabber.h.

void pcl::Grabber::block_signals ( )
inlineprotected

Definition at line 189 of file grabber.h.

template<typename T >
boost::signals2::signal< T > * pcl::Grabber::createSignal ( )
protected

Definition at line 220 of file grabber.h.

template<typename T >
void pcl::Grabber::disconnect_all_slots ( )
protected

Definition at line 161 of file grabber.h.

template<typename T >
boost::signals2::signal< T > * pcl::Grabber::find_signal ( ) const
protected

Definition at line 149 of file grabber.h.

virtual float pcl::Grabber::getFramesPerSecond ( ) const
pure virtual
virtual std::string pcl::Grabber::getName ( ) const
pure virtual
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::RealSenseGrabber, pcl::HDLGrabber, pcl::EnsensoGrabber, pcl::DavidSDKGrabber, pcl::OpenNIGrabber, pcl::ONIGrabber, pcl::PCDGrabberBase, pcl::ImageGrabberBase, pcl::DepthSenseGrabber, pcl::StereoGrabberBase, pcl::RobotEyeGrabber, and pcl::DinastGrabber.

template<typename T >
int pcl::Grabber::num_slots ( ) const
protected

Definition at line 205 of file grabber.h.

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 263 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]callbackthe callback function/method
Returns
Connection object, that can be used to disconnect the callback method from the signal again.

Definition at line 234 of file grabber.h.

virtual void pcl::Grabber::signalsChanged ( )
inlineprotectedvirtual

Reimplemented in pcl::OpenNIGrabber.

Definition at line 111 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::RealSenseGrabber, pcl::HDLGrabber, pcl::EnsensoGrabber, pcl::OpenNIGrabber, pcl::DavidSDKGrabber, pcl::PCDGrabberBase, pcl::DepthSenseGrabber, pcl::ONIGrabber, pcl::ImageGrabberBase, pcl::StereoGrabberBase, pcl::DinastGrabber, and pcl::RobotEyeGrabber.

virtual void pcl::Grabber::stop ( )
pure virtual
template<typename T >
void pcl::Grabber::unblock_signal ( )
protected

Definition at line 181 of file grabber.h.

void pcl::Grabber::unblock_signals ( )
inlineprotected

Definition at line 197 of file grabber.h.

Member Data Documentation

std::map<std::string, std::vector<boost::signals2::connection> > pcl::Grabber::connections_
protected

Definition at line 138 of file grabber.h.

std::map<std::string, std::vector<boost::signals2::shared_connection_block> > pcl::Grabber::shared_connections_
protected

Definition at line 139 of file grabber.h.

std::map<std::string, boost::signals2::signal_base*> pcl::Grabber::signals_
protected

Definition at line 137 of file grabber.h.


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