Grabber interface for PCL 1.x device drivers. More...
#include <pcl/io/grabber.h>
Public Member Functions |
|
Grabber ()=default | |
Default ctor. More... |
|
Grabber (const Grabber &)=delete | |
No copy ctor since Grabber can't be copied. More... |
|
Grabber & | operator= (const Grabber &)=delete |
No copy assign operator since Grabber can't be copied. More... |
|
Grabber (Grabber &&)=default | |
Move ctor. More... |
|
Grabber & | operator= (Grabber &&)=default |
Move assign operator. More... |
|
virtual | ~Grabber () noexcept=default |
virtual destructor. More... |
|
template<typename T > | |
boost::signals2::connection | registerCallback (const std::function< T > &callback) |
registers a callback function/method to a signal with the corresponding signature More... |
|
template<typename T > | |
bool | providesCallback () const noexcept |
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... |
|
bool | toggle () |
For devices that are streaming, stopped streams are started and running stream 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 noexcept |
template<typename T > | |
int | num_slots () const noexcept |
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, std::unique_ptr< 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
Constructor & Destructor Documentation
Grabber() [1/3]
|
default |
Default ctor.
Grabber() [2/3]
Grabber() [3/3]
|
default |
Move ctor.
~Grabber()
|
inlinevirtualdefaultnoexcept |
virtual destructor.
Member Function Documentation
block_signal()
|
protected |
block_signals()
createSignal()
|
protected |
Definition at line 256 of file grabber.h.
Referenced by pcl::ImageGrabber< PointT >::ImageGrabber(), pcl::PCDGrabber< PointT >::PCDGrabber(), and pcl::StereoGrabber< PointT >::StereoGrabber().
disconnect_all_slots()
|
protected |
find_signal()
|
protectednoexcept |
getFramesPerSecond()
|
pure virtual |
returns fps.
0 if trigger based.
Implemented in pcl::HDLGrabber, pcl::OpenNIGrabber, pcl::ONIGrabber, pcl::PCDGrabberBase, pcl::ImageGrabberBase, pcl::StereoGrabberBase, pcl::RealSense2Grabber, pcl::DinastGrabber, pcl::RobotEyeGrabber, pcl::EnsensoGrabber, pcl::DavidSDKGrabber, pcl::RealSenseGrabber, and pcl::DepthSenseGrabber.
getName()
|
pure virtual |
returns the name of the concrete subclass.
- Returns
- the name of the concrete driver.
Implemented in pcl::HDLGrabber, pcl::OpenNIGrabber, pcl::ONIGrabber, pcl::RealSense2Grabber, pcl::PCDGrabberBase, pcl::ImageGrabberBase, pcl::StereoGrabberBase, pcl::RobotEyeGrabber, pcl::TimGrabber, pcl::DinastGrabber, pcl::VLPGrabber, pcl::RealSenseGrabber, pcl::EnsensoGrabber, pcl::DavidSDKGrabber, and pcl::DepthSenseGrabber.
isRunning()
|
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::HDLGrabber, pcl::OpenNIGrabber, pcl::ONIGrabber, pcl::PCDGrabberBase, pcl::ImageGrabberBase, pcl::RealSense2Grabber, pcl::StereoGrabberBase, pcl::RobotEyeGrabber, pcl::TimGrabber, pcl::DinastGrabber, pcl::RealSenseGrabber, pcl::EnsensoGrabber, pcl::DavidSDKGrabber, and pcl::DepthSenseGrabber.
num_slots()
|
protectednoexcept |
operator=() [1/2]
No copy assign operator since Grabber can't be copied.
operator=() [2/2]
providesCallback()
|
noexcept |
registerCallback()
boost::signals2::connection pcl::Grabber::registerCallback | ( | const std::function< T > & | callback | ) |
signalsChanged()
|
inlineprotectedvirtual |
Reimplemented in pcl::OpenNIGrabber, and pcl::RealSense2Grabber.
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::HDLGrabber, pcl::OpenNIGrabber, pcl::ONIGrabber, pcl::DinastGrabber, pcl::RealSense2Grabber, pcl::PCDGrabberBase, pcl::ImageGrabberBase, pcl::TimGrabber, pcl::StereoGrabberBase, pcl::RobotEyeGrabber, pcl::RealSenseGrabber, pcl::EnsensoGrabber, pcl::DavidSDKGrabber, and pcl::DepthSenseGrabber.
stop()
|
pure virtual |
For devices that are streaming, the streams are stopped.
This method has no effect for triggered devices.
Implemented in pcl::HDLGrabber, pcl::OpenNIGrabber, pcl::ONIGrabber, pcl::DinastGrabber, pcl::RealSense2Grabber, pcl::PCDGrabberBase, pcl::ImageGrabberBase, pcl::StereoGrabberBase, pcl::TimGrabber, pcl::RobotEyeGrabber, pcl::RealSenseGrabber, pcl::EnsensoGrabber, pcl::DavidSDKGrabber, and pcl::DepthSenseGrabber.
toggle()
|
inline |
unblock_signal()
|
protected |
unblock_signals()
Member Data Documentation
connections_
|
protected |
shared_connections_
|
protected |
signals_
|
protected |
The documentation for this class was generated from the following file:
- pcl/io/grabber.h
© 2009–2012, Willow Garage, Inc.
© 2012–, Open Perception, Inc.
Licensed under the BSD License.
https://pointclouds.org/documentation/classpcl_1_1_grabber.html