CameraInterface Class Reference

#include <camera_interface.h>

Collaboration diagram for CameraInterface:

Public Member Functions
	CameraInterface ()
	Constructor. More...
virtual	~CameraInterface ()=default
	Destructor. More...
virtual void	trigger (bool trigger_on_true)
	trigger the camera More...
virtual void	send_toggle_power (bool enable)
	send command to turn the camera on/off More...
virtual void	send_keep_alive (bool enable)
	send command to prevent the camera from sleeping More...
virtual void	info ()
	Display info. More...
virtual bool	has_power_control ()
	Checks if the interface has support for camera power control. More...
virtual bool	is_powered_on ()
	Checks if the camera connected to the interface is turned on. More...

Protected Member Functions
virtual void	setup ()
	setup the interface More...
void	get_pins ()
	get the hardware configuration More...

Protected Attributes
param_t	_p_pin
int	_pins [6]

Detailed Description

Definition at line 12 of file camera_interface.h.

Constructor & Destructor Documentation

CameraInterface()

CameraInterface::CameraInterface

(

)

Constructor.

Definition at line 9 of file camera_interface.cpp.

~CameraInterface()

virtual CameraInterface::~CameraInterface ( )

virtualdefault

Destructor.

Member Function Documentation

get_pins()

void CameraInterface::get_pins ( )

protected

get the hardware configuration

Definition at line 15 of file camera_interface.cpp.

References _p_pin, _pins, arraySize, param_find(), param_get(), and PARAM_INVALID.

Referenced by setup().

Here is the call graph for this function:

Here is the caller graph for this function:

has_power_control()

virtual bool CameraInterface::has_power_control ( )

inlinevirtual

Checks if the interface has support for camera power control.

Returns

true if power control is supported

Definition at line 54 of file camera_interface.h.

Referenced by CameraTrigger::Run(), CameraTrigger::start(), and CameraTrigger::status().

Here is the caller graph for this function:

info()

virtual void CameraInterface::info ( )

inlinevirtual

Display info.

Definition at line 47 of file camera_interface.h.

Referenced by CameraTrigger::status().

Here is the caller graph for this function:

is_powered_on()

virtual bool CameraInterface::is_powered_on ( )

inlinevirtual

Checks if the camera connected to the interface is turned on.

Returns

true if camera is on

Definition at line 61 of file camera_interface.h.

Referenced by CameraTrigger::Run(), CameraTrigger::start(), and CameraTrigger::status().

Here is the caller graph for this function:

send_keep_alive()

virtual void CameraInterface::send_keep_alive ( bool  enable )

inlinevirtual

send command to prevent the camera from sleeping

Parameters

enable

Definition at line 42 of file camera_interface.h.

Referenced by CameraTrigger::keep_alive_down(), and CameraTrigger::keep_alive_up().

Here is the caller graph for this function:

send_toggle_power()

virtual void CameraInterface::send_toggle_power ( bool  enable )

inlinevirtual

send command to turn the camera on/off

Parameters

enable

Definition at line 36 of file camera_interface.h.

Referenced by CameraTrigger::disengage_turn_on_off(), and CameraTrigger::engange_turn_on_off().

Here is the caller graph for this function:

setup()

virtual void CameraInterface::setup ( )

inlineprotectedvirtual

setup the interface

Definition at line 68 of file camera_interface.h.

References get_pins().

Here is the call graph for this function:

trigger()

virtual void CameraInterface::trigger ( bool  trigger_on_true )

inlinevirtual

trigger the camera

Parameters

enable

Definition at line 30 of file camera_interface.h.

Referenced by CameraTrigger::disengage(), and CameraTrigger::engage().

Here is the caller graph for this function:

Member Data Documentation

_p_pin

param_t CameraInterface::_p_pin

protected

Definition at line 75 of file camera_interface.h.

Referenced by get_pins().

_pins

int CameraInterface::_pins[6]

protected

Definition at line 77 of file camera_interface.h.

Referenced by get_pins().

---

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

• src/drivers/camera_trigger/interfaces/src/camera_interface.h
• src/drivers/camera_trigger/interfaces/src/camera_interface.cpp