dronecode_sdk::Logging Class Reference

#include: logging.h


The Logging class allows log data using logger and log streaming from the vehicle.

This feature is not yet implemented.

Public Types

Type Description
enum Result Results for logging requests.
std::function< void(Result)> result_callback_t Callback type for logging requests.

Public Member Functions

Type Name Description
  Logging (System & system) Constructor. Creates the plugin for a specific System.
  ~Logging () Destructor (internal use only).
  Logging (const Logging &)=delete Copy constructor (object is not copyable).
Result start_logging () const Start logging (synchronous).
Result stop_logging () const Stop logging (synchronous).
void start_logging_async (result_callback_t callback) Start logging (asynchronous).
void stop_logging_async (result_callback_t callback) Stop logging (asynchronous).
const Logging & operator= (const Logging &)=delete Equality operator (object is not copyable).

Static Public Member Functions

Type Name Description
const char * result_str (Result result) Returns human-readable English string for Logging::Result.

Constructor & Destructor Documentation

Logging()

dronecode_sdk::Logging::Logging(System &system)

Constructor. Creates the plugin for a specific System.

The plugin is typically created as shown below:

auto logging = std::make_shared<Logging>(system);

Parameters

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

~Logging()

dronecode_sdk::Logging::~Logging()

Destructor (internal use only).

Logging()

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

Copy constructor (object is not copyable).

Parameters

Member Typdef Documentation

typedef result_callback_t

typedef std::function<void(Result)> dronecode_sdk::Logging::result_callback_t

Callback type for logging requests.

Member Enumeration Documentation

enum Result

Results for logging requests.

Value Description
SUCCESS Request succeeded.
NO_SYSTEM No system connected.
CONNECTION_ERROR Connection error.
BUSY System busy.
COMMAND_DENIED Command denied.
TIMEOUT Timeout.
UNKNOWN Unknown error.

Member Function Documentation

start_logging()

Result dronecode_sdk::Logging::start_logging() const

Start logging (synchronous).

This feature is not yet implemented.

Returns

Result - Result of request.

stop_logging()

Result dronecode_sdk::Logging::stop_logging() const

Stop logging (synchronous).

This feature is not yet implemented.

Returns

Result - Result of request.

start_logging_async()

void dronecode_sdk::Logging::start_logging_async(result_callback_t callback)

Start logging (asynchronous).

This feature is not yet implemented.

Parameters

stop_logging_async()

void dronecode_sdk::Logging::stop_logging_async(result_callback_t callback)

Stop logging (asynchronous).

This feature is not yet implemented.

Parameters

operator=()

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

Equality operator (object is not copyable).

Parameters

Returns

 const Logging & -

result_str()

static const char* dronecode_sdk::Logging::result_str(Result result)

Returns human-readable English string for Logging::Result.

Parameters

  • Result result - Enum for which string is required.

Returns

 const char * - result Human-readable string for Logging::Result.

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

results matching ""

    No results matching ""