mavsdk::TrackingServer Class Reference

#include: tracking_server.h

API for an onboard image tracking software.

Data Structures

struct TrackPoint

struct TrackRectangle

Public Types

Public Member Functions

Constructor & Destructor Documentation

TrackingServer()

mavsdk::TrackingServer::TrackingServer(std::shared_ptr< ServerComponent > server_component)

Constructor. Creates the plugin for a ServerComponent instance.

The plugin is typically created as shown below:

auto tracking_server = TrackingServer(server_component);

Parameters

• std::shared_ptr< ServerComponent > server_component - The ServerComponent instance associated with this server plugin.

~TrackingServer()

mavsdk::TrackingServer::~TrackingServer() override

Destructor (internal use only).

TrackingServer()

mavsdk::TrackingServer::TrackingServer(const TrackingServer &other)

Copy constructor.

Parameters

• const TrackingServer& other -

Member Typdef Documentation

typedef ResultCallback

using mavsdk::TrackingServer::ResultCallback =  std::function<void(Result)>

Callback type for asynchronous TrackingServer calls.

typedef TrackingPointCommandCallback

using mavsdk::TrackingServer::TrackingPointCommandCallback =  std::function<void(TrackPoint)>

Callback type for subscribe_tracking_point_command.

typedef TrackingPointCommandHandle

using mavsdk::TrackingServer::TrackingPointCommandHandle =  Handle<TrackPoint>

Handle type for subscribe_tracking_point_command.

typedef TrackingRectangleCommandCallback

using mavsdk::TrackingServer::TrackingRectangleCommandCallback =  std::function<void(TrackRectangle)>

Callback type for subscribe_tracking_rectangle_command.

typedef TrackingRectangleCommandHandle

using mavsdk::TrackingServer::TrackingRectangleCommandHandle =  Handle<TrackRectangle>

Handle type for subscribe_tracking_rectangle_command.

typedef TrackingOffCommandCallback

using mavsdk::TrackingServer::TrackingOffCommandCallback =  std::function<void(int32_t)>

Callback type for subscribe_tracking_off_command.

typedef TrackingOffCommandHandle

using mavsdk::TrackingServer::TrackingOffCommandHandle =  Handle<int32_t>

Handle type for subscribe_tracking_off_command.

Member Enumeration Documentation

enum CommandAnswer

Answer to respond to an incoming command.

enum Result

Possible results returned for tracking_server requests.

Member Function Documentation

set_tracking_point_status()

void mavsdk::TrackingServer::set_tracking_point_status(TrackPoint tracked_point) const

Set/update the current point tracking status.

This function is blocking.

Parameters

• TrackPoint tracked_point -

set_tracking_rectangle_status()

void mavsdk::TrackingServer::set_tracking_rectangle_status(TrackRectangle tracked_rectangle) const

Set/update the current rectangle tracking status.

This function is blocking.

Parameters

• TrackRectangle tracked_rectangle -

set_tracking_off_status()

void mavsdk::TrackingServer::set_tracking_off_status() const

Set the current tracking status to off.

This function is blocking.

subscribe_tracking_point_command()

TrackingPointCommandHandle mavsdk::TrackingServer::subscribe_tracking_point_command(const TrackingPointCommandCallback &callback)

Subscribe to incoming tracking point command.

Parameters

• const TrackingPointCommandCallback& callback -

Returns

 TrackingPointCommandHandle -

unsubscribe_tracking_point_command()

void mavsdk::TrackingServer::unsubscribe_tracking_point_command(TrackingPointCommandHandle handle)

Unsubscribe from subscribe_tracking_point_command.

Parameters

• TrackingPointCommandHandle handle -

subscribe_tracking_rectangle_command()

TrackingRectangleCommandHandle mavsdk::TrackingServer::subscribe_tracking_rectangle_command(const TrackingRectangleCommandCallback &callback)

Subscribe to incoming tracking rectangle command.

Parameters

• const TrackingRectangleCommandCallback& callback -

Returns

 TrackingRectangleCommandHandle -

unsubscribe_tracking_rectangle_command()

void mavsdk::TrackingServer::unsubscribe_tracking_rectangle_command(TrackingRectangleCommandHandle handle)

Unsubscribe from subscribe_tracking_rectangle_command.

Parameters

• TrackingRectangleCommandHandle handle -

subscribe_tracking_off_command()

TrackingOffCommandHandle mavsdk::TrackingServer::subscribe_tracking_off_command(const TrackingOffCommandCallback &callback)

Subscribe to incoming tracking off command.

Parameters

• const TrackingOffCommandCallback& callback -

Returns

 TrackingOffCommandHandle -

unsubscribe_tracking_off_command()

void mavsdk::TrackingServer::unsubscribe_tracking_off_command(TrackingOffCommandHandle handle)

Unsubscribe from subscribe_tracking_off_command.

Parameters

• TrackingOffCommandHandle handle -

respond_tracking_point_command()

Result mavsdk::TrackingServer::respond_tracking_point_command(CommandAnswer command_answer) const

Respond to an incoming tracking point command.

This function is blocking.

Parameters

• CommandAnswer command_answer -

Returns

 Result - Result of request.

respond_tracking_rectangle_command()

Result mavsdk::TrackingServer::respond_tracking_rectangle_command(CommandAnswer command_answer) const

Respond to an incoming tracking rectangle command.

This function is blocking.

Parameters

• CommandAnswer command_answer -

Returns

 Result - Result of request.

respond_tracking_off_command()

Result mavsdk::TrackingServer::respond_tracking_off_command(CommandAnswer command_answer) const

Respond to an incoming tracking off command.

This function is blocking.

Parameters

• CommandAnswer command_answer -

Returns

 Result - Result of request.

operator=()

const TrackingServer& mavsdk::TrackingServer::operator=(const TrackingServer &)=delete

Equality operator (object is not copyable).

Parameters

• const TrackingServer& -

Returns

 const TrackingServer & -