Public Member Functions | Private Attributes
alvar::CaptureDevice Class Reference

CaptureDevice holder for camera information. More...

#include <CaptureDevice.h>

List of all members.

Public Member Functions

 CaptureDevice (const std::string captureType, const std::string id, const std::string description="")
 Constructor.
std::string captureType () const
 The type of capture backend.
std::string description () const
 The description of the camera.
std::string id () const
 The id of the camera.
std::string uniqueName () const
 A unique name consisting of the capture type and the id.
 ~CaptureDevice ()
 Destructor.

Private Attributes

std::string mCaptureType
std::string mDescription
std::string mId

Detailed Description

CaptureDevice holder for camera information.

CaptureDevice contains the desired backend, the id and description of the camera.

Examples:
SampleMarkerDetector.cpp.

Definition at line 44 of file CaptureDevice.h.


Constructor & Destructor Documentation

alvar::CaptureDevice::CaptureDevice ( const std::string  captureType,
const std::string  id,
const std::string  description = "" 
)

Constructor.

Parameters:
captureTypeThe type of capture backend.
idThe id of the camera.
descriptionA human readable description of the camera.

Definition at line 30 of file CaptureDevice.cpp.

Destructor.

Definition at line 37 of file CaptureDevice.cpp.


Member Function Documentation

std::string alvar::CaptureDevice::captureType ( ) const
std::string alvar::CaptureDevice::description ( ) const

The description of the camera.

Definition at line 51 of file CaptureDevice.cpp.

std::string alvar::CaptureDevice::id ( ) const

The id of the camera.

Definition at line 46 of file CaptureDevice.cpp.

std::string alvar::CaptureDevice::uniqueName ( ) const

A unique name consisting of the capture type and the id.

Definition at line 56 of file CaptureDevice.cpp.


Member Data Documentation

std::string alvar::CaptureDevice::mCaptureType [private]

Definition at line 82 of file CaptureDevice.h.

std::string alvar::CaptureDevice::mDescription [private]

Definition at line 84 of file CaptureDevice.h.

std::string alvar::CaptureDevice::mId [private]

Definition at line 83 of file CaptureDevice.h.


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


ar_track_alvar
Author(s): Scott Niekum
autogenerated on Sat Dec 28 2013 16:46:16