pcl::StereoGrabberBase Class Reference

Base class for Stereo file grabber. More...

#include <pcl/stereo/stereo_grabber.h>

Inheritance diagram for pcl::StereoGrabberBase:

Collaboration diagram for pcl::StereoGrabberBase:

Public Member Functions
	StereoGrabberBase (const std::pair< std::string, std::string > &pair_files, float frames_per_second, bool repeat)
	Constructor taking just one Stereo pair. More...
	StereoGrabberBase (const std::vector< std::pair< std::string, std::string >> &files, float frames_per_second, bool repeat)
	Constructor taking a list of paths to Stereo pair files, that are played in the order they appear in the list. More...
	~StereoGrabberBase () noexcept override
	Virtual destructor. More...
void	start () override
	Starts playing the list of Stereo images if frames_per_second is > 0. More...
void	stop () override
	Stops playing the list of Stereo images if frames_per_second is > 0. More...
virtual void	trigger ()
	Triggers a callback with new data. More...
bool	isRunning () const override
	whether the grabber is started (publishing) or not. More...
std::string	getName () const override
virtual void	rewind ()
	Rewinds to the first pair of files in the list. More...
float	getFramesPerSecond () const override
	Returns the frames_per_second. More...
bool	isRepeatOn () const
	Returns whether the repeat flag is on. More...
Public Member Functions inherited from pcl::Grabber
	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...
bool	toggle ()
	For devices that are streaming, stopped streams are started and running stream are stopped. More...

Additional Inherited Members
Protected Member Functions inherited from pcl::Grabber
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 inherited from pcl::Grabber
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

Base class for Stereo file grabber.

Definition at line 51 of file stereo_grabber.h.

Constructor & Destructor Documentation

StereoGrabberBase() [1/2]

pcl::StereoGrabberBase::StereoGrabberBase	(	const std::pair< std::string, std::string > &	pair_files,
		float	frames_per_second,
		bool	repeat
	)

Constructor taking just one Stereo pair.

Parameters

[in]	pair_files	the name of the the stereo (left + right) images.
[in]	frames_per_second	frames per second. If 0, start() functions like a trigger, publishing the next pair in the list.
[in]	repeat	whether to play files in an endless loop or not.

StereoGrabberBase() [2/2]

pcl::StereoGrabberBase::StereoGrabberBase	(	const std::vector< std::pair< std::string, std::string >> &	files,
		float	frames_per_second,
		bool	repeat
	)

Constructor taking a list of paths to Stereo pair files, that are played in the order they appear in the list.

Parameters

[in]	files	vector of paths to stereo (left+right) images.
[in]	frames_per_second	frames per second. If 0, start() functions like a trigger, publishing the next pair in the list.
[in]	repeat	whether to play files in an endless loop or not.

~StereoGrabberBase()

pcl::StereoGrabberBase::~StereoGrabberBase ( )

overridenoexcept

Virtual destructor.

Member Function Documentation

getFramesPerSecond()

float pcl::StereoGrabberBase::getFramesPerSecond ( ) const

overridevirtual

Returns the frames_per_second.

0 if grabber is trigger-based

Implements pcl::Grabber.

getName()

std::string pcl::StereoGrabberBase::getName ( ) const

overridevirtual

Returns

The name of the grabber

Implements pcl::Grabber.

isRepeatOn()

bool pcl::StereoGrabberBase::isRepeatOn

(

)

const

Returns whether the repeat flag is on.

isRunning()

bool pcl::StereoGrabberBase::isRunning ( ) const

overridevirtual

whether the grabber is started (publishing) or not.

Returns

true only if publishing.

Implements pcl::Grabber.

rewind()

virtual void pcl::StereoGrabberBase::rewind ( )

virtual

Rewinds to the first pair of files in the list.

start()

void pcl::StereoGrabberBase::start ( )

overridevirtual

Starts playing the list of Stereo images if frames_per_second is > 0.

Otherwise it works as a trigger: publishes only the next pair in the list.

Implements pcl::Grabber.

stop()

void pcl::StereoGrabberBase::stop ( )

overridevirtual

Stops playing the list of Stereo images if frames_per_second is > 0.

Otherwise the method has no effect.

Implements pcl::Grabber.

trigger()

virtual void pcl::StereoGrabberBase::trigger ( )

virtual

Triggers a callback with new data.

---

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

• pcl/stereo/stereo_grabber.h