libkovan  1
The kovan standard library
depth::DepthDriver Class Referenceabstract

#include <depth_driver.hpp>

Inheritance diagram for depth::DepthDriver:
depth::XtionDepthDriver

Public Member Functions

virtual ~DepthDriver ()
 
virtual void open ()=0
 
virtual void close ()=0
 
virtual bool isOpen () const =0
 
virtual DepthResolution depthCameraResolution () const =0
 
virtual void setDepthCameraResolution (const DepthResolution resolution)=0
 
virtual DepthImagedepthImage () const =0
 

Static Public Member Functions

static DepthDriverinstance ()
 

Constructor & Destructor Documentation

virtual depth::DepthDriver::~DepthDriver ( )
inlinevirtual

Member Function Documentation

virtual void depth::DepthDriver::close ( )
pure virtual

Closes the depth driver

Implemented in depth::XtionDepthDriver.

virtual DepthResolution depth::DepthDriver::depthCameraResolution ( ) const
pure virtual

Get the current depth camera resolution

Returns
The current depth camera resolution

Implemented in depth::XtionDepthDriver.

virtual DepthImage* depth::DepthDriver::depthImage ( ) const
pure virtual

Returns a Dept Image object containing the current depth values

Note
returns a null pointer if there is no depth image available yet.
Returns
DepthImage object

Implemented in depth::XtionDepthDriver.

static DepthDriver& depth::DepthDriver::instance ( )
static
virtual bool depth::DepthDriver::isOpen ( ) const
pure virtual

Checks if the depth driver is currently open

Returns
true if open, false otherwise

Implemented in depth::XtionDepthDriver.

virtual void depth::DepthDriver::open ( )
pure virtual

Opens the depth driver

Implemented in depth::XtionDepthDriver.

virtual void depth::DepthDriver::setDepthCameraResolution ( const DepthResolution  resolution)
pure virtual

Set the current depth camera resolution.

Parameters
resolutionNew depth camera resolution

Implemented in depth::XtionDepthDriver.


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