Public Types | Public Member Functions | Protected Attributes
alvar::CapturePlugin Class Reference

CapturePlugin interface that plugins must implement. More...

#include <CapturePlugin.h>

Inheritance diagram for alvar::CapturePlugin:
Inheritance graph
[legend]

List of all members.

Public Types

typedef std::vector
< CaptureDevice
CaptureDeviceVector
 Vector of CaptureDevices.

Public Member Functions

 CapturePlugin (const std::string &captureType)
 Constructor.
virtual CapturecreateCapture (const CaptureDevice captureDevice)=0
 Create Capture class. Transfers onwership to the caller.
virtual CaptureDeviceVector enumerateDevices ()=0
 Enumerate capture devices currently available.
virtual ~CapturePlugin ()
 Destructor.

Protected Attributes

std::string mCaptureType

Detailed Description

CapturePlugin interface that plugins must implement.

All plugins must implement the CapturePlugin interface. When the plugin is loaded, the CapturePlugin implementation will register itself with the CaptureFactory.

Definition at line 44 of file CapturePlugin.h.


Member Typedef Documentation

Vector of CaptureDevices.

Definition at line 60 of file CapturePlugin.h.


Constructor & Destructor Documentation

alvar::CapturePlugin::CapturePlugin ( const std::string &  captureType) [inline]

Constructor.

Parameters:
captureTypeA unique identifier for the capture plugin.

Definition at line 52 of file CapturePlugin.h.

virtual alvar::CapturePlugin::~CapturePlugin ( ) [inline, virtual]

Destructor.

Definition at line 60 of file CapturePlugin.h.


Member Function Documentation

virtual Capture* alvar::CapturePlugin::createCapture ( const CaptureDevice  captureDevice) [pure virtual]

Create Capture class. Transfers onwership to the caller.

Parameters:
captureDeviceInformation of which camera to create.
Returns:
A new Capture class for which the caller takes ownership.

Implemented in alvar::plugins::CapturePluginDSCapture, alvar::plugins::CapturePluginPtgrey, alvar::plugins::CapturePluginHighgui, alvar::plugins::CapturePluginCmu, and alvar::plugins::CapturePluginFile.

Enumerate capture devices currently available.

Returns:
A vector of CaptureDevice objects that are currently available.

Implemented in alvar::plugins::CapturePluginDSCapture, alvar::plugins::CapturePluginPtgrey, alvar::plugins::CapturePluginHighgui, alvar::plugins::CapturePluginCmu, and alvar::plugins::CapturePluginFile.


Member Data Documentation

std::string alvar::CapturePlugin::mCaptureType [protected]

Definition at line 83 of file CapturePlugin.h.


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


ar_track_alvar
Author(s): Scott Niekum
autogenerated on Thu Feb 16 2017 03:23:02