#include <VehicleTypes.h>

Inheritance diagram for VehicleTypes:

Classes
struct	MavCmdAckHandlerInfo_s
	Callback info bundle for sendMavCommandWithHandler. More...

Public Types
enum	MavCmdResultFailureCode_t { MavCmdResultCommandResultOnly , MavCmdResultFailureNoResponseToCommand , MavCmdResultFailureDuplicateCommand }

enum	RequestMessageResultHandlerFailureCode_t { RequestMessageNoFailure , RequestMessageFailureCommandError , RequestMessageFailureCommandNotAcked , RequestMessageFailureMessageNotReceived , RequestMessageFailureDuplicate }

typedef void(*	MavCmdProgressHandler) (void *progressHandlerData, int compId, const mavlink_command_ack_t &ack)
	Callback for sendMavCommandWithHandler which handles MAV_RESULT_IN_PROGRESS acks.

typedef void(*	MavCmdResultHandler) (void *resultHandlerData, int compId, const mavlink_command_ack_t &ack, MavCmdResultFailureCode_t failureCode)
	Callback for sendMavCommandWithHandler which handles all non-IN_PROGRESS acks.

typedef struct VehicleTypes::MavCmdAckHandlerInfo_s	MavCmdAckHandlerInfo_t
	Callback info bundle for sendMavCommandWithHandler.

typedef void(*	RequestMessageResultHandler) (void *resultHandlerData, MAV_RESULT commandResult, RequestMessageResultHandlerFailureCode_t failureCode, const mavlink_message_t &message)
	Callback for requestMessage — delivered when the ack/message pair resolves or a failure occurs.

Static Public Attributes
static const int	versionNotSetValue = -1

Detailed Description

Definition at line 15 of file VehicleTypes.h.

Member Typedef Documentation

◆ MavCmdAckHandlerInfo_t

typedef struct VehicleTypes::MavCmdAckHandlerInfo_s VehicleTypes::MavCmdAckHandlerInfo_t

Callback info bundle for sendMavCommandWithHandler.

◆ MavCmdProgressHandler

typedef void(* VehicleTypes::MavCmdProgressHandler) (void *progressHandlerData, int compId, const mavlink_command_ack_t &ack)

Callback for sendMavCommandWithHandler which handles MAV_RESULT_IN_PROGRESS acks.

Definition at line 34 of file VehicleTypes.h.

◆ MavCmdResultHandler

typedef void(* VehicleTypes::MavCmdResultHandler) (void *resultHandlerData, int compId, const mavlink_command_ack_t &ack, MavCmdResultFailureCode_t failureCode)

Callback for sendMavCommandWithHandler which handles all non-IN_PROGRESS acks.

Definition at line 37 of file VehicleTypes.h.

◆ RequestMessageResultHandler

typedef void(* VehicleTypes::RequestMessageResultHandler) (void *resultHandlerData, MAV_RESULT commandResult, RequestMessageResultHandlerFailureCode_t failureCode, const mavlink_message_t &message)

Callback for requestMessage — delivered when the ack/message pair resolves or a failure occurs.

Definition at line 48 of file VehicleTypes.h.

Member Enumeration Documentation

◆ MavCmdResultFailureCode_t

enum VehicleTypes::MavCmdResultFailureCode_t

Enumerator
MavCmdResultCommandResultOnly	commandResult specifies full success/fail info
MavCmdResultFailureNoResponseToCommand	No response from vehicle to command.
MavCmdResultFailureDuplicateCommand	Unable to send command since duplicate is already being waited on for response.

Definition at line 17 of file VehicleTypes.h.

◆ RequestMessageResultHandlerFailureCode_t

enum VehicleTypes::RequestMessageResultHandlerFailureCode_t

Enumerator
RequestMessageNoFailure
RequestMessageFailureCommandError
RequestMessageFailureCommandNotAcked
RequestMessageFailureMessageNotReceived
RequestMessageFailureDuplicate	Exact duplicate request already active or queued for this component/message id.

Definition at line 23 of file VehicleTypes.h.

Member Data Documentation

◆ versionNotSetValue

const int VehicleTypes::versionNotSetValue = -1

static

Definition at line 31 of file VehicleTypes.h.

Referenced by ArduCopterFirmwarePlugin::remapParamNameHigestMinorVersionNumber(), ArduPlaneFirmwarePlugin::remapParamNameHigestMinorVersionNumber(), ArduRoverFirmwarePlugin::remapParamNameHigestMinorVersionNumber(), ArduSubFirmwarePlugin::remapParamNameHigestMinorVersionNumber(), and FirmwarePlugin::remapParamNameHigestMinorVersionNumber().

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

src/Vehicle/VehicleTypes.h

Classes

Public Types

Static Public Attributes