The base camera class. More...

#include <camera.h>

Inheritance diagram for flyby::Camera:

[legend]

Collaboration diagram for flyby::Camera:

[legend]

Public Member Functions
	Camera ()
	The default constructor.

	Camera (const std::string &name)
	The name constructor.

void	take_picture () override
	Take a picture on the camera.

void	start_video_recording () override
	Start recording a video on the camera.

void	stop_video_recording () override
	Stop recording a video on the camera.

void	set_optical_zoom_level (int level) override
	Sets the optical zoom on the camera.

unsigned int	get_optical_zoom_level () override
	Gets the optical zoom on the camera.

std::vector< unsigned int >	get_optical_zoom_range () override
	Gets the optical zoom range on the camera.

ZoomType	get_optical_zoom_type () override
	Gets the optical zoom type on the camera.

void	set_digital_zoom_level (int level) override
	Sets the digital zoom on the camera.

unsigned int	get_digital_zoom_level () override
	Gets the digital zoom on the camera.

std::vector< unsigned int >	get_digital_zoom_range () override
	Gets the digital zoom range on the camera.

unsigned int	get_iso_level () override
	Gets the ISO level on the camera.

std::vector< unsigned int >	get_iso_range () override
	Gets the ISO range on the camera.

void	set_iso_level (unsigned int level) override
	Sets the ISO level on the camera.

unsigned int	get_shutter_speed () override
	Gets the shutter speed on the camera.

std::vector< unsigned int >	get_shutter_speed_range () override
	Gets the shutter speed range on the camera.

void	set_shutter_speed (unsigned int speed) override
	Sets the shutter speed on the camera.

ExposureProgramMode	get_exposure_program_mode () override
	Gets the exposure program mode.

void	set_exposure_program_mode (ExposureProgramMode mode) override
	Sets the exposure program mode.

float	get_aperture () override
	Gets the aperture.

std::vector< float >	get_aperture_range () override
	Gets the possible aperture values.

void	set_aperture (float aperture) override
	Sets the aperture.

std::string	get_white_balance () override
	Gets the white balance.

std::vector< std::string >	get_white_balance_options () override
	Gets the white balance options.

void	set_white_balance (std::string wb) override
	Sets the white balance.

FocusMode	get_focus_mode () override
	Gets the focus mode.

void	set_focus_mode (FocusMode mode) override
	Sets the focus mode.

unsigned int	get_focus_position () override
	Gets the focus position.

std::vector< unsigned int >	get_focus_position_range () override
	Gets the focus position range.

void	set_focus_position (unsigned int position) override
	Sets the focus position.

bool	get_zoom () const final
	Does the camera support zoom.

bool	get_gimbal () const final
	Is the camera mounted on a gimbal.

bool	get_picture () const final
	Does the camera support pictures.

bool	get_video () const final
	Does the camera support videos.

CameraType	get_type () const final
	Get the type of camera.

bool	is_recording () const final
	Get the recording status of the camera.

Protected Attributes
CameraType	m_type
	The camera type.

bool	m_picture { false }
	Can the camera take pictures.

bool	m_video { false }
	Can the camera take videos.

bool	m_zoom { false }
	Can the camera zoom.

bool	m_gimbal { false }
	Is the camera mounted on a controllable gimbal.

bool	m_is_recording { false }
	Is the camera currently recording.

Detailed Description

The base camera class.

This class is should be extended by implementing functionality that is present. For example, a camera that can take pictures should override the take_picture function to control the camera to take a picture.

Constructor & Destructor Documentation

◆ Camera()

flyby::Camera::Camera ( const std::string & name )

inlineexplicit

The name constructor.

Parameters

name	- the name of the camera

Member Function Documentation

◆ get_aperture()

float flyby::Camera::get_aperture ( )

inlineoverride

Gets the aperture.

Should be overridden if a camera should implement this capability.

Returns: The aperture

◆ get_aperture_range()

std::vector< float > flyby::Camera::get_aperture_range ( )

inlineoverride

Gets the possible aperture values.

Should be overridden if a camera should implement this capability.

Returns: The list of aperture values

◆ get_digital_zoom_level()

unsigned int flyby::Camera::get_digital_zoom_level ( )

inlineoverride

Gets the digital zoom on the camera.

Should be overridden if a camera should implement this capability.

Returns: The zoom level

◆ get_digital_zoom_range()

std::vector< unsigned int > flyby::Camera::get_digital_zoom_range ( )

inlineoverride

Gets the digital zoom range on the camera.

Should be overridden if a camera should implement this capability.

Returns: The range of zoom level

◆ get_exposure_program_mode()

ExposureProgramMode flyby::Camera::get_exposure_program_mode ( )

inlineoverride

Gets the exposure program mode.

Should be overridden if a camera should implement this capability.

Returns: The exposure program mode

◆ get_focus_mode()

FocusMode flyby::Camera::get_focus_mode ( )

inlineoverride

Gets the focus mode.

Should be overridden if a camera should implement this capability.

Returns: The focus mode

◆ get_focus_position()

unsigned int flyby::Camera::get_focus_position ( )

inlineoverride

Gets the focus position.

Should be overridden if a camera should implement this capability.

Returns: The focus position

◆ get_focus_position_range()

std::vector< unsigned int > flyby::Camera::get_focus_position_range ( )

inlineoverride

Gets the focus position range.

Should be overridden if a camera should implement this capability.

Returns: The focus position range

◆ get_gimbal()

bool flyby::Camera::get_gimbal ( ) const

inlinenodiscardfinal

Is the camera mounted on a gimbal.

Returns: True if the camera is on a gimbal

◆ get_iso_level()

unsigned int flyby::Camera::get_iso_level ( )

inlineoverride

Gets the ISO level on the camera.

Should be overridden if a camera should implement this capability.

Returns: The ISO level (implementation dependant)

◆ get_iso_range()

std::vector< unsigned int > flyby::Camera::get_iso_range ( )

inlineoverride

Gets the ISO range on the camera.

Should be overridden if a camera should implement this capability.

Returns: The ISO range (implementation dependant)

◆ get_optical_zoom_level()

unsigned int flyby::Camera::get_optical_zoom_level ( )

inlineoverride

Gets the optical zoom on the camera.

Should be overridden if a camera should implement this capability.

Returns: The zoom level

◆ get_optical_zoom_range()

std::vector< unsigned int > flyby::Camera::get_optical_zoom_range ( )

inlineoverride

Gets the optical zoom range on the camera.

Should be overridden if a camera should implement this capability.

Returns: The range of zoom level

◆ get_optical_zoom_type()

ZoomType flyby::Camera::get_optical_zoom_type ( )

inlineoverride

Gets the optical zoom type on the camera.

Should be overridden if a camera should implement this capability.

Returns: The type of zoom level.

◆ get_picture()

bool flyby::Camera::get_picture ( ) const

inlinenodiscardfinal

Does the camera support pictures.

Returns: True if the camera is supports pictures

◆ get_shutter_speed()

unsigned int flyby::Camera::get_shutter_speed ( )

inlineoverride

Gets the shutter speed on the camera.

Should be overridden if a camera should implement this capability.

Returns: The ISO level (denominator)

◆ get_shutter_speed_range()

std::vector< unsigned int > flyby::Camera::get_shutter_speed_range ( )

inlineoverride

Gets the shutter speed range on the camera.

Should be overridden if a camera should implement this capability.

Returns: The shutter speed range (denominator)

◆ get_type()

CameraType flyby::Camera::get_type ( ) const

inlinenodiscardfinal

Get the type of camera.

Returns: The Type

◆ get_video()

bool flyby::Camera::get_video ( ) const

inlinenodiscardfinal

Does the camera support videos.

Returns: True if the camera is supports videos

◆ get_white_balance()

std::string flyby::Camera::get_white_balance ( )

inlineoverride

Gets the white balance.

Should be overridden if a camera should implement this capability.

Returns: The white balance

◆ get_white_balance_options()

std::vector< std::string > flyby::Camera::get_white_balance_options ( )

inlineoverride

Gets the white balance options.

Should be overridden if a camera should implement this capability.

Returns: The white balance options

◆ get_zoom()

bool flyby::Camera::get_zoom ( ) const

inlinenodiscardfinal

Does the camera support zoom.

Returns: True if the camera implements zoom

◆ is_recording()

bool flyby::Camera::is_recording ( ) const

inlinenodiscardfinal

Get the recording status of the camera.

Returns: The recording status

◆ set_aperture()

void flyby::Camera::set_aperture ( float aperture )

inlineoverride

Sets the aperture.

Should be overridden if a camera should implement this capability.

Parameters

aperture - The aperture

◆ set_digital_zoom_level()

void flyby::Camera::set_digital_zoom_level ( int level )

inlineoverride

Sets the digital zoom on the camera.

Should be overridden if a camera should implement this capability.

Parameters

level - The zoom level

◆ set_exposure_program_mode()

void flyby::Camera::set_exposure_program_mode ( ExposureProgramMode mode )

inlineoverride

Sets the exposure program mode.

Should be overridden if a camera should implement this capability.

Parameters

mode	- The exposure program mode

◆ set_focus_mode()

void flyby::Camera::set_focus_mode ( FocusMode mode )

inlineoverride

Sets the focus mode.

Should be overridden if a camera should implement this capability.

Parameters

mode	- The focus mode

◆ set_focus_position()

void flyby::Camera::set_focus_position ( unsigned int position )

inlineoverride

Sets the focus position.

Should be overridden if a camera should implement this capability.

Parameters

position - The focus position

◆ set_iso_level()

void flyby::Camera::set_iso_level ( unsigned int level )

inlineoverride

Sets the ISO level on the camera.

Should be overridden if a camera should implement this capability.

Parameters

level - The ISO level (implementation dependant)

◆ set_optical_zoom_level()

void flyby::Camera::set_optical_zoom_level ( int level )

inlineoverride

Sets the optical zoom on the camera.

Should be overridden if a camera should implement this capability.

Parameters

level - The zoom level

◆ set_shutter_speed()

void flyby::Camera::set_shutter_speed ( unsigned int speed )

inlineoverride

Sets the shutter speed on the camera.

Should be overridden if a camera should implement this capability.

Parameters

speed - The shutter speed (denominator)

◆ set_white_balance()

void flyby::Camera::set_white_balance ( std::string wb )

inlineoverride

Sets the white balance.

Should be overridden if a camera should implement this capability.

Parameters

wb	- The white balance

◆ start_video_recording()

void flyby::Camera::start_video_recording ( )

inlineoverride

Start recording a video on the camera.

Should be overridden if a camera should implement this capability.

◆ stop_video_recording()

void flyby::Camera::stop_video_recording ( )

inlineoverride

Stop recording a video on the camera.

Should be overridden if a camera should implement this capability.

◆ take_picture()

void flyby::Camera::take_picture ( )

inlineoverride

Take a picture on the camera.

Should be overridden if a camera should implement this capability.

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

include/flyby/payload/component/camera.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Camera()

Member Function Documentation

◆ get_aperture()

◆ get_aperture_range()

◆ get_digital_zoom_level()

◆ get_digital_zoom_range()

◆ get_exposure_program_mode()

◆ get_focus_mode()

◆ get_focus_position()

◆ get_focus_position_range()

◆ get_gimbal()

◆ get_iso_level()

◆ get_iso_range()

◆ get_optical_zoom_level()

◆ get_optical_zoom_range()

◆ get_optical_zoom_type()

◆ get_picture()

◆ get_shutter_speed()

◆ get_shutter_speed_range()

◆ get_type()

◆ get_video()

◆ get_white_balance()

◆ get_white_balance_options()

◆ get_zoom()

◆ is_recording()

◆ set_aperture()

◆ set_digital_zoom_level()

◆ set_exposure_program_mode()

◆ set_focus_mode()

◆ set_focus_position()

◆ set_iso_level()

◆ set_optical_zoom_level()

◆ set_shutter_speed()

◆ set_white_balance()

◆ start_video_recording()

◆ stop_video_recording()

◆ take_picture()