Point Cloud Library (PCL)  1.8.1-dev
List of all members | Public Member Functions
pcl::StereoGrabberBase Class Referenceabstract

Base class for Stereo file grabber. More...

#include <pcl/stereo/stereo_grabber.h>

+ Inheritance 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 (const StereoGrabberBase &src)
 Copy constructor. More...
 
StereoGrabberBaseoperator= (const StereoGrabberBase &src)
 Copy operator. More...
 
virtual ~StereoGrabberBase () throw ()
 Virtual destructor. More...
 
virtual void start ()
 Starts playing the list of Stereo images if frames_per_second is > 0. More...
 
virtual void stop ()
 Stops playing the list of Stereo images if frames_per_second is > 0. More...
 
virtual void trigger ()
 Triggers a callback with new data. More...
 
virtual bool isRunning () const
 whether the grabber is started (publishing) or not. More...
 
virtual std::string getName () const
 
virtual void rewind ()
 Rewinds to the first pair of files in the list. More...
 
virtual float getFramesPerSecond () const
 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 ()
 Constructor. More...
 
virtual ~Grabber () throw ()
 virtual desctructor. 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...
 

Additional Inherited Members

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

Base class for Stereo file grabber.

Definition at line 51 of file stereo_grabber.h.

Constructor & Destructor Documentation

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_filesthe name of the the stereo (left + right) images.
[in]frames_per_secondframes per second. If 0, start() functions like a trigger, publishing the next pair in the list.
[in]repeatwhether to play files in an endless loop or not.
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]filesvector of paths to stereo (left+right) images.
[in]frames_per_secondframes per second. If 0, start() functions like a trigger, publishing the next pair in the list.
[in]repeatwhether to play files in an endless loop or not.
pcl::StereoGrabberBase::StereoGrabberBase ( const StereoGrabberBase src)
inline

Copy constructor.

Parameters
[in]srcthe Stereo Grabber base object to copy into this

Definition at line 71 of file stereo_grabber.h.

virtual pcl::StereoGrabberBase::~StereoGrabberBase ( )
throw (
)
virtual

Virtual destructor.

Member Function Documentation

virtual float pcl::StereoGrabberBase::getFramesPerSecond ( ) const
virtual

Returns the frames_per_second.

0 if grabber is trigger-based

Implements pcl::Grabber.

virtual std::string pcl::StereoGrabberBase::getName ( ) const
virtual
Returns
The name of the grabber

Implements pcl::Grabber.

bool pcl::StereoGrabberBase::isRepeatOn ( ) const

Returns whether the repeat flag is on.

virtual bool pcl::StereoGrabberBase::isRunning ( ) const
virtual

whether the grabber is started (publishing) or not.

Returns
true only if publishing.

Implements pcl::Grabber.

StereoGrabberBase& pcl::StereoGrabberBase::operator= ( const StereoGrabberBase src)
inline

Copy operator.

Parameters
[in]srcthe Stereo Grabber base object to copy into this

Definition at line 80 of file stereo_grabber.h.

virtual void pcl::StereoGrabberBase::rewind ( )
virtual

Rewinds to the first pair of files in the list.

virtual void pcl::StereoGrabberBase::start ( )
virtual

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.

virtual void pcl::StereoGrabberBase::stop ( )
virtual

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

Otherwise the method has no effect.

Implements pcl::Grabber.

virtual void pcl::StereoGrabberBase::trigger ( )
virtual

Triggers a callback with new data.


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