pcl::PCDGrabberBase Class Reference

Base class for PCD file grabber. More...

#include <pcl/io/pcd_grabber.h>

Inheritance diagram for pcl::PCDGrabberBase:

Collaboration diagram for pcl::PCDGrabberBase:

List of all members.

Public Member Functions
	PCDGrabberBase (const std::string &pcd_file, float frames_per_second, bool repeat)
	Constructor taking just one PCD file or one TAR file containing multiple PCD files.
	PCDGrabberBase (const std::vector< std::string > &pcd_files, float frames_per_second, bool repeat)
	Constructor taking a list of paths to PCD files, that are played in the order they appear in the list.
	PCDGrabberBase (const PCDGrabberBase &src)
	Copy constructor.
PCDGrabberBase &	operator= (const PCDGrabberBase &src)
	Copy operator.
virtual	~PCDGrabberBase () throw ()
	Virtual destructor.
virtual void	start ()
	Starts playing the list of PCD files if frames_per_second is > 0.
virtual void	stop ()
	Stops playing the list of PCD files if frames_per_second is > 0.
virtual void	trigger ()
	Triggers a callback with new data.
virtual bool	isRunning () const
	whether the grabber is started (publishing) or not.
virtual std::string	getName () const
virtual void	rewind ()
	Rewinds to the first PCD file in the list.
virtual float	getFramesPerSecond () const
	Returns the frames_per_second.
bool	isRepeatOn () const
	Returns whether the repeat flag is on.
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

---

Detailed Description

Base class for PCD file grabber.

Definition at line 58 of file pcd_grabber.h.

---

Constructor & Destructor Documentation

pcl::PCDGrabberBase::PCDGrabberBase	(	const std::string &	pcd_file,
		float	frames_per_second,
		bool	repeat
	)

Constructor taking just one PCD file or one TAR file containing multiple PCD files.

Parameters:

[in]	pcd_file	path to the PCD file
[in]	frames_per_second	frames per second. If 0, start() functions like a trigger, publishing the next PCD in the list.
[in]	repeat	whether to play PCD file in an endless loop or not.

pcl::PCDGrabberBase::PCDGrabberBase	(	const std::vector< std::string > &	pcd_files,
		float	frames_per_second,
		bool	repeat
	)

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

Parameters:

[in]	pcd_files	vector of paths to PCD files.
[in]	frames_per_second	frames per second. If 0, start() functions like a trigger, publishing the next PCD in the list.
[in]	repeat	whether to play PCD file in an endless loop or not.

pcl::PCDGrabberBase::PCDGrabberBase

(

const PCDGrabberBase &

src

)

[inline]

Copy constructor.

Parameters:

[in]

src

the PCD Grabber base object to copy into this

Definition at line 78 of file pcd_grabber.h.

virtual pcl::PCDGrabberBase::~PCDGrabberBase

(

)

throw () [virtual]

Virtual destructor.

---

Member Function Documentation

virtual float pcl::PCDGrabberBase::getFramesPerSecond

(

)

const [virtual]

Returns the frames_per_second.

0 if grabber is trigger-based

Implements pcl::Grabber.

virtual std::string pcl::PCDGrabberBase::getName

(

)

const [virtual]

Returns:

The name of the grabber

Implements pcl::Grabber.

bool pcl::PCDGrabberBase::isRepeatOn

(

)

const

Returns whether the repeat flag is on.

virtual bool pcl::PCDGrabberBase::isRunning

(

)

const [virtual]

whether the grabber is started (publishing) or not.

Returns:

true only if publishing.

Implements pcl::Grabber.

PCDGrabberBase& pcl::PCDGrabberBase::operator=

(

const PCDGrabberBase &

src

)

[inline]

Copy operator.

Parameters:

[in]

src

the PCD Grabber base object to copy into this

Definition at line 87 of file pcd_grabber.h.

template<typename T >

bool pcl::Grabber::providesCallback

(

)

const [inherited]

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

)

[inherited]

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::PCDGrabberBase::rewind

(

)

[virtual]

Rewinds to the first PCD file in the list.

virtual void pcl::PCDGrabberBase::start

(

)

[virtual]

Starts playing the list of PCD files if frames_per_second is > 0.

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

Implements pcl::Grabber.

virtual void pcl::PCDGrabberBase::stop

(

)

[virtual]

Stops playing the list of PCD files if frames_per_second is > 0.

Otherwise the method has no effect.

Implements pcl::Grabber.

virtual void pcl::PCDGrabberBase::trigger

(

)

[virtual]

Triggers a callback with new data.

---

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

• /usr/src/RPM/BUILD/PCL-1.6.0-Source/io/include/pcl/io/pcd_grabber.h