dronecode_sdk::FollowMe Class Reference

#include: follow_me.h


This class enables vehicle tracking of a specified target (typically a ground station carried by a user).

The API is used to supply both the position(s) for the target and the relative follow position of the vehicle. Applications must get target position information from the underlying platform (or some other source).

See Also:

Data Structures

struct Config

struct TargetLocation

Public Types

Type Description
enum Result Results of FollowMe operations.

Public Member Functions

Type Name Description
  FollowMe (System & system) Constructor. Creates the plugin for a specific System.
  ~FollowMe () Destructor (internal use only).
  FollowMe (const FollowMe &)=delete Copy constructor (object is not copyable).
const Config & get_config () const Gets current FollowMe configuration.
Result set_config (const Config & config) Applies FollowMe configuration by sending it to system.
bool is_active () const Checks whether FollowMe is active.
void set_target_location (const TargetLocation & location) Sets location of the moving target.
const TargetLocation & get_last_location () const Returns the last location of the target.
FollowMe::Result start () const Starts FollowMe mode.
FollowMe::Result stop () const Stops FollowMe mode.
const FollowMe & operator= (const FollowMe &)=delete Equality operator (object is not copyable).

Static Public Member Functions

Type Name Description
std::string result_str (Result result) Returns English string for FollowMe error codes.

Constructor & Destructor Documentation

FollowMe()

dronecode_sdk::FollowMe::FollowMe(System &system)

Constructor. Creates the plugin for a specific System.

The plugin is typically created as shown below:

auto follow_me = std::make_shared<FollowMe>(system);

Parameters

  • System& system - The specific system associated with this plugin.

~FollowMe()

dronecode_sdk::FollowMe::~FollowMe()

Destructor (internal use only).

FollowMe()

dronecode_sdk::FollowMe::FollowMe(const FollowMe &)=delete

Copy constructor (object is not copyable).

Parameters

Member Enumeration Documentation

enum Result

Results of FollowMe operations.

Value Description
SUCCESS Request succeeded.
NO_SYSTEM No system connected.
CONNECTION_ERROR Connection error.
BUSY Vehicle busy.
COMMAND_DENIED Command denied.
TIMEOUT Request timeout.
NOT_ACTIVE FollowMe is not activated.
SET_CONFIG_FAILED Failed to set FollowMe configuration.
UNKNOWN Unknown error.

See Also:

Member Function Documentation

get_config()

const Config& dronecode_sdk::FollowMe::get_config() const

Gets current FollowMe configuration.

Returns

 const Config & - Current FollowMe configuration.

See Also:

set_config()

Result dronecode_sdk::FollowMe::set_config(const Config &config)

Applies FollowMe configuration by sending it to system.

Parameters

Returns

Result - FollowMe::Result::SUCCESS if configuration is applied successfully, FollowMe::Result::SET_CONFIG_FAILED on failure. In case of failure, last configuration is preserved.

See Also:

is_active()

bool dronecode_sdk::FollowMe::is_active() const

Checks whether FollowMe is active.

Returns

 bool - true if FollowMe is active, false otherwise.

set_target_location()

void dronecode_sdk::FollowMe::set_target_location(const TargetLocation &location)

Sets location of the moving target.

An app can obtain the location of the moving target from Location framework of the underlying platform.

The following links provide information about location services on different platforms:

Parameters

See Also:

get_last_location()

const TargetLocation& dronecode_sdk::FollowMe::get_last_location() const

Returns the last location of the target.

Returns

 const TargetLocation & - Last location of the target.

See Also:

start()

FollowMe::Result dronecode_sdk::FollowMe::start() const

Starts FollowMe mode.

Returns

FollowMe::Result - FollowMe::Result::SUCCESS if succeeded, error otherwise.

stop()

FollowMe::Result dronecode_sdk::FollowMe::stop() const

Stops FollowMe mode.

Returns

FollowMe::Result - FollowMe::Result::SUCCESS if succeeded, error otherwise. See FollowMe::Result for error codes.

operator=()

const FollowMe& dronecode_sdk::FollowMe::operator=(const FollowMe &)=delete

Equality operator (object is not copyable).

Parameters

Returns

 const FollowMe & -

result_str()

static std::string dronecode_sdk::FollowMe::result_str(Result result)

Returns English string for FollowMe error codes.

Parameters

Returns

 std::string - Returns std::string describing error code.

© Dronecode 2017. License: CC BY 4.0            Updated: 2018-07-12 03:09:32

results matching ""

    No results matching ""