alvar::CaptureDevice Class Reference

CaptureDevice holder for camera information. More...

#include <CaptureDevice.h>

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

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

CaptureDevice()

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

Constructor.

Parameters

captureType	The type of capture backend.
id	The id of the camera.
description	A human readable description of the camera.

Definition at line 30 of file CaptureDevice.cpp.

~CaptureDevice()

alvar::CaptureDevice::~CaptureDevice

(

)

Destructor.

Definition at line 37 of file CaptureDevice.cpp.

Member Function Documentation

captureType()

std::string alvar::CaptureDevice::captureType

(

)

const

The type of capture backend.

Examples:

SampleCamCalib.cpp, SampleCvTestbed.cpp, SampleIntegralImage.cpp, SampleLabeling.cpp, SampleMarkerDetector.cpp, SampleMarkerHide.cpp, SampleMarkerlessDetector.cpp, SampleMultiMarker.cpp, SampleMultiMarkerBundle.cpp, SamplePointcloud.cpp, and SampleTrack.cpp.

Definition at line 41 of file CaptureDevice.cpp.

description()

std::string alvar::CaptureDevice::description

(

)

const

The description of the camera.

Definition at line 51 of file CaptureDevice.cpp.

id()

std::string alvar::CaptureDevice::id

(

)

const

The id of the camera.

Definition at line 46 of file CaptureDevice.cpp.

uniqueName()

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

mCaptureType

std::string alvar::CaptureDevice::mCaptureType

private

Definition at line 82 of file CaptureDevice.h.

mDescription

std::string alvar::CaptureDevice::mDescription

private

Definition at line 84 of file CaptureDevice.h.

mId

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:

• CaptureDevice.h
• CaptureDevice.cpp