Grabber interface for PCL 1.x device drivers.
More...
#include <pcl/io/grabber.h>
|
| 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 , template< typename > class FunctionT> |
boost::signals2::connection | registerCallback (const FunctionT< 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...
|
|
|
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_ |
|
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 59 of file grabber.h.
◆ Grabber() [1/3]
pcl::Grabber::Grabber |
( |
| ) |
|
|
default |
◆ Grabber() [2/3]
pcl::Grabber::Grabber |
( |
const Grabber & |
| ) |
|
|
delete |
No copy ctor since Grabber can't be copied.
◆ Grabber() [3/3]
pcl::Grabber::Grabber |
( |
Grabber && |
| ) |
|
|
default |
◆ ~Grabber()
virtual pcl::Grabber::~Grabber |
( |
| ) |
|
|
inlinevirtualdefaultnoexcept |
◆ block_signal()
template<typename T >
void pcl::Grabber::block_signal |
|
protected |
◆ block_signals()
void pcl::Grabber::block_signals |
( |
| ) |
|
|
inlineprotected |
◆ createSignal()
template<typename T >
boost::signals2::signal< T > * pcl::Grabber::createSignal |
|
protected |
◆ disconnect_all_slots()
template<typename T >
void pcl::Grabber::disconnect_all_slots |
|
protected |
◆ find_signal()
template<typename T >
boost::signals2::signal< T > * pcl::Grabber::find_signal |
|
protectednoexcept |
◆ getFramesPerSecond()
virtual float pcl::Grabber::getFramesPerSecond |
( |
| ) |
const |
|
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()
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::HDLGrabber, pcl::OpenNIGrabber, pcl::ONIGrabber, pcl::RealSense2Grabber, pcl::PCDGrabberBase, pcl::ImageGrabberBase, pcl::StereoGrabberBase, pcl::RobotEyeGrabber, pcl::DinastGrabber, pcl::VLPGrabber, pcl::RealSenseGrabber, pcl::EnsensoGrabber, pcl::DavidSDKGrabber, and pcl::DepthSenseGrabber.
◆ isRunning()
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::HDLGrabber, pcl::OpenNIGrabber, pcl::ONIGrabber, pcl::PCDGrabberBase, pcl::ImageGrabberBase, pcl::RealSense2Grabber, pcl::StereoGrabberBase, pcl::RobotEyeGrabber, pcl::DinastGrabber, pcl::RealSenseGrabber, pcl::EnsensoGrabber, pcl::DavidSDKGrabber, and pcl::DepthSenseGrabber.
◆ num_slots()
template<typename T >
int pcl::Grabber::num_slots |
|
protectednoexcept |
◆ operator=() [1/2]
No copy assign operator since Grabber can't be copied.
◆ operator=() [2/2]
◆ providesCallback()
template<typename T >
bool pcl::Grabber::providesCallback |
|
noexcept |
indicates whether a signal with given parameter-type exists or not
- Returns
- true if signal exists, false otherwise
Definition at line 324 of file grabber.h.
◆ registerCallback() [1/2]
template<typename T , template< typename > class FunctionT>
boost::signals2::connection pcl::Grabber::registerCallback |
( |
const FunctionT< T > & |
callback | ) |
|
|
inline |
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.
- Deprecated:
- Scheduled for removal in version 1 . 12 : "please assign the callback to a std::function."
Definition at line 108 of file grabber.h.
◆ registerCallback() [2/2]
template<typename T >
boost::signals2::connection pcl::Grabber::registerCallback |
( |
const std::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 303 of file grabber.h.
◆ signalsChanged()
virtual void pcl::Grabber::signalsChanged |
( |
| ) |
|
|
inlineprotectedvirtual |
◆ start()
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::HDLGrabber, pcl::OpenNIGrabber, pcl::ONIGrabber, pcl::DinastGrabber, pcl::RealSense2Grabber, pcl::PCDGrabberBase, pcl::ImageGrabberBase, pcl::StereoGrabberBase, pcl::RobotEyeGrabber, pcl::RealSenseGrabber, pcl::EnsensoGrabber, pcl::DavidSDKGrabber, and pcl::DepthSenseGrabber.
◆ stop()
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::HDLGrabber, pcl::OpenNIGrabber, pcl::ONIGrabber, pcl::DinastGrabber, pcl::RealSense2Grabber, pcl::PCDGrabberBase, pcl::ImageGrabberBase, pcl::StereoGrabberBase, pcl::RobotEyeGrabber, pcl::RealSenseGrabber, pcl::EnsensoGrabber, pcl::DavidSDKGrabber, and pcl::DepthSenseGrabber.
◆ toggle()
bool pcl::Grabber::toggle |
( |
| ) |
|
|
inline |
For devices that are streaming, stopped streams are started and running stream are stopped.
For triggered devices, the behavior is not defined.
- Returns
- true if grabber is running / streaming. False otherwise.
Definition at line 189 of file grabber.h.
◆ unblock_signal()
template<typename T >
void pcl::Grabber::unblock_signal |
|
protected |
◆ unblock_signals()
void pcl::Grabber::unblock_signals |
( |
| ) |
|
|
inlineprotected |
◆ connections_
std::map<std::string, std::vector<boost::signals2::connection> > pcl::Grabber::connections_ |
|
protected |
◆ shared_connections_
std::map<std::string, std::vector<boost::signals2::shared_connection_block> > pcl::Grabber::shared_connections_ |
|
protected |
◆ signals_
std::map<std::string, std::unique_ptr<boost::signals2::signal_base> > pcl::Grabber::signals_ |
|
protected |
The documentation for this class was generated from the following file: