Firmware
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vmount::InputBase Class Referenceabstract

class InputBase Base class for all driver input classes More...

#include <input.h>

Inheritance diagram for vmount::InputBase:
vmount::InputMavlinkCmdMount vmount::InputMavlinkROI vmount::InputRC vmount::InputTest

Public Member Functions

virtual int update (unsigned int timeout_ms, ControlData **control_data, bool already_active)
 Wait for an input update, with a timeout. More...
 
virtual void print_status ()=0
 report status to stdout
 

Protected Member Functions

virtual int update_impl (unsigned int timeout_ms, ControlData **control_data, bool already_active)=0
 
virtual int initialize ()
 
void control_data_set_lon_lat (double lon, double lat, float altitude, float roll_angle=0.f, float pitch_fixed_angle=-10.f)
 

Protected Attributes

ControlData _control_data
 

Detailed Description

class InputBase Base class for all driver input classes

Member Function Documentation

§ update()

int vmount::InputBase::update ( unsigned int  timeout_ms,
ControlData **  control_data,
bool  already_active 
)
virtual

Wait for an input update, with a timeout.

Parameters
timeout_mstimeout in ms
control_dataunchanged on error. On success it is nullptr if no new data is available, otherwise set to an object. If it is set, the returned object will not be changed for subsequent calls to update() that return no new data (in other words: if (some) control_data values change, non-null will be returned).
already_activetrue if the mode was already active last time, false if it was not and "major" change is necessary such as big stick movement for RC.
Returns
0 on success, <0 otherwise

Reimplemented in vmount::InputTest.


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