dronecode_sdk Namespace Reference


Namespace for all dronecode_sdk types.

Data Structures

Enumerations

Type Description
enum ActionResult Possible results returned for commanded actions.
enum ConnectionResult Result type returned when adding a connection.

Functions

Type Name Description
const char * action_result_str (ActionResult result) Returns a human-readable English string for an ActionResult.
const char * connection_result_str (const ConnectionResult result) Returns a human-readable English string for a ConnectionResult.
bool operator== (const MissionItem & lhs, const MissionItem & rhs) Equal operator to compare two MissionItem objects.
std::ostream & operator<< (std::ostream & str, MissionItem const & mission_item) Stream operator to print infos about a MissionItem.
std::ostream & operator<< (std::ostream & str, MissionItem::CameraAction const & camera_action) Stream operator to print infos about a MissionItem::CameraAction.
bool operator== (const Telemetry::PositionVelocityNED & lhs, const Telemetry::PositionVelocityNED & rhs) Equal operator to compare two Telemetry::PositionVelocityNED objects.
bool operator== (const Telemetry::Position & lhs, const Telemetry::Position & rhs) Equal operator to compare two Telemetry::Position objects.
std::ostream & operator<< (std::ostream & str, Telemetry::Position const & position) Stream operator to print information about a Telemetry::Position.
bool operator== (const Telemetry::Health & lhs, const Telemetry::Health & rhs) Equal operator to compare two Telemetry::Health objects.
std::ostream & operator<< (std::ostream & str, Telemetry::Health const & health) Stream operator to print information about a Telemetry::Health.
bool operator== (const Telemetry::GPSInfo & lhs, const Telemetry::GPSInfo & rhs) Equal operator to compare two Telemetry::GPSInfo objects.
std::ostream & operator<< (std::ostream & str, Telemetry::GPSInfo const & gps_info) Stream operator to print information about a Telemetry::GPSInfo.
bool operator== (const Telemetry::Battery & lhs, const Telemetry::Battery & rhs) Equal operator to compare two Telemetry::Battery objects.
std::ostream & operator<< (std::ostream & str, Telemetry::Battery const & battery) Stream operator to print information about a Telemetry::Battery.
bool operator== (const Telemetry::Quaternion & lhs, const Telemetry::Quaternion & rhs) Equal operator to compare two Telemetry::Quaternion objects.
std::ostream & operator<< (std::ostream & str, Telemetry::Quaternion const & quaternion) Stream operator to print information about a Telemetry::Quaternion.
bool operator== (const Telemetry::EulerAngle & lhs, const Telemetry::EulerAngle & rhs) Equal operator to compare two Telemetry::EulerAngle objects.
std::ostream & operator<< (std::ostream & str, Telemetry::EulerAngle const & euler_angle) Stream operator to print information about a Telemetry::EulerAngle.
bool operator== (const Telemetry::GroundSpeedNED & lhs, const Telemetry::GroundSpeedNED & rhs) Equal operator to compare two Telemetry::GroundSpeedNED objects.
std::ostream & operator<< (std::ostream & str, Telemetry::GroundSpeedNED const & ground_speed) Stream operator to print information about a Telemetry::GroundSpeedNED.
bool operator== (const Telemetry::RCStatus & lhs, const Telemetry::RCStatus & rhs) Equal operator to compare two Telemetry::RCStatus objects.
std::ostream & operator<< (std::ostream & str, Telemetry::RCStatus const & rc_status) Stream operator to print information about a Telemetry::RCStatus.

Enumeration Type Documentation

enum ActionResult

#include: action_result.h

Possible results returned for commanded actions.

DronecodeSDK does not throw exceptions. Instead a result of this type will be returned when you execute actions.

Value Description
UNKNOWN Unspecified error.
SUCCESS Success. The action command was accepted by the vehicle.
NO_SYSTEM No system is connected error.
CONNECTION_ERROR Connection error.
BUSY Vehicle busy error.
COMMAND_DENIED Command refused by vehicle.
COMMAND_DENIED_LANDED_STATE_UNKNOWN Command refused because landed state is unknown.
COMMAND_DENIED_NOT_LANDED Command refused because vehicle not landed.
TIMEOUT Timeout waiting for command acknowledgement from vehicle.
VTOL_TRANSITION_SUPPORT_UNKNOWN hybrid/VTOL transition refused because VTOL support is unknown.
NO_VTOL_TRANSITION_SUPPORT Vehicle does not support hybrid/VTOL transitions.

enum ConnectionResult

#include: connection_result.h

Result type returned when adding a connection.

Note: DronecodeSDK does not throw exceptions. Instead a result of this type will be returned when you add a connection: add_udp_connection().

Value Description
SUCCESS Connection succeeded.
TIMEOUT Connection timed out.
SOCKET_ERROR Socket error.
BIND_ERROR Bind error.
SOCKET_CONNECTION_ERROR Socket connection error.
CONNECTION_ERROR Connection error.
NOT_IMPLEMENTED Connection type not implemented.
SYSTEM_NOT_CONNECTED No system is connected.
SYSTEM_BUSY System is busy.
COMMAND_DENIED Command is denied.
DESTINATION_IP_UNKNOWN Connection IP is unknown.
CONNECTIONS_EXHAUSTED Connections exhausted.
CONNECTION_URL_INVALID URL invalid.

Function Documentation

action_result_str()

#include: action_result.h
const char* dronecode_sdk::action_result_str(ActionResult result)

Returns a human-readable English string for an ActionResult.

Parameters

  • ActionResult result - The enum value for which a human readable string is required.

Returns

 const char * - Human readable string for the ActionResult.

connection_result_str()

#include: connection_result.h
const char* dronecode_sdk::connection_result_str(const ConnectionResult result)

Returns a human-readable English string for a ConnectionResult.

Parameters

  • const ConnectionResult result - The enum value for which a human readable string is required.

Returns

 const char * - Human readable string for the ConnectionResult.

operator==()

#include: mission_item.h
bool dronecode_sdk::operator==(const MissionItem &lhs, const MissionItem &rhs)

Equal operator to compare two MissionItem objects.

Parameters

Returns

 bool - true if items are equal.

operator<<()

#include: mission_item.h
std::ostream& dronecode_sdk::operator<<(std::ostream &str, MissionItem const &mission_item)

Stream operator to print infos about a MissionItem.

Parameters

  • std::ostream& str -
  • MissionItem const& mission_item -

Returns

 std::ostream & - A reference to the stream.

operator<<()

#include: mission_item.h
std::ostream& dronecode_sdk::operator<<(std::ostream &str, MissionItem::CameraAction const &camera_action)

Stream operator to print infos about a MissionItem::CameraAction.

Parameters

Returns

 std::ostream & - A reference to the stream.

operator==()

#include: telemetry.h
bool dronecode_sdk::operator==(const Telemetry::PositionVelocityNED &lhs, const Telemetry::PositionVelocityNED &rhs)

Equal operator to compare two Telemetry::PositionVelocityNED objects.

Parameters

Returns

 bool - true if items are equal.

operator==()

#include: telemetry.h
bool dronecode_sdk::operator==(const Telemetry::Position &lhs, const Telemetry::Position &rhs)

Equal operator to compare two Telemetry::Position objects.

Parameters

Returns

 bool - true if items are equal.

operator<<()

#include: telemetry.h
std::ostream& dronecode_sdk::operator<<(std::ostream &str, Telemetry::Position const &position)

Stream operator to print information about a Telemetry::Position.

Parameters

Returns

 std::ostream & - A reference to the stream.

operator==()

#include: telemetry.h
bool dronecode_sdk::operator==(const Telemetry::Health &lhs, const Telemetry::Health &rhs)

Equal operator to compare two Telemetry::Health objects.

Parameters

Returns

 bool - true if items are equal.

operator<<()

#include: telemetry.h
std::ostream& dronecode_sdk::operator<<(std::ostream &str, Telemetry::Health const &health)

Stream operator to print information about a Telemetry::Health.

Parameters

Returns

 std::ostream & - A reference to the stream.

operator==()

#include: telemetry.h
bool dronecode_sdk::operator==(const Telemetry::GPSInfo &lhs, const Telemetry::GPSInfo &rhs)

Equal operator to compare two Telemetry::GPSInfo objects.

Parameters

Returns

 bool - true if items are equal.

operator<<()

#include: telemetry.h
std::ostream& dronecode_sdk::operator<<(std::ostream &str, Telemetry::GPSInfo const &gps_info)

Stream operator to print information about a Telemetry::GPSInfo.

Parameters

Returns

 std::ostream & - A reference to the stream.

operator==()

#include: telemetry.h
bool dronecode_sdk::operator==(const Telemetry::Battery &lhs, const Telemetry::Battery &rhs)

Equal operator to compare two Telemetry::Battery objects.

Parameters

Returns

 bool - true if items are equal.

operator<<()

#include: telemetry.h
std::ostream& dronecode_sdk::operator<<(std::ostream &str, Telemetry::Battery const &battery)

Stream operator to print information about a Telemetry::Battery.

Parameters

Returns

 std::ostream & - A reference to the stream.

operator==()

#include: telemetry.h
bool dronecode_sdk::operator==(const Telemetry::Quaternion &lhs, const Telemetry::Quaternion &rhs)

Equal operator to compare two Telemetry::Quaternion objects.

Parameters

Returns

 bool - true if items are equal.

operator<<()

#include: telemetry.h
std::ostream& dronecode_sdk::operator<<(std::ostream &str, Telemetry::Quaternion const &quaternion)

Stream operator to print information about a Telemetry::Quaternion.

Parameters

Returns

 std::ostream & - A reference to the stream.

operator==()

#include: telemetry.h
bool dronecode_sdk::operator==(const Telemetry::EulerAngle &lhs, const Telemetry::EulerAngle &rhs)

Equal operator to compare two Telemetry::EulerAngle objects.

Parameters

Returns

 bool - true if items are equal.

operator<<()

#include: telemetry.h
std::ostream& dronecode_sdk::operator<<(std::ostream &str, Telemetry::EulerAngle const &euler_angle)

Stream operator to print information about a Telemetry::EulerAngle.

Parameters

Returns

 std::ostream & - A reference to the stream.

operator==()

#include: telemetry.h
bool dronecode_sdk::operator==(const Telemetry::GroundSpeedNED &lhs, const Telemetry::GroundSpeedNED &rhs)

Equal operator to compare two Telemetry::GroundSpeedNED objects.

Parameters

Returns

 bool - true if items are equal.

operator<<()

#include: telemetry.h
std::ostream& dronecode_sdk::operator<<(std::ostream &str, Telemetry::GroundSpeedNED const &ground_speed)

Stream operator to print information about a Telemetry::GroundSpeedNED.

Parameters

Returns

 std::ostream & - A reference to the stream.

operator==()

#include: telemetry.h
bool dronecode_sdk::operator==(const Telemetry::RCStatus &lhs, const Telemetry::RCStatus &rhs)

Equal operator to compare two Telemetry::RCStatus objects.

Parameters

Returns

 bool - true if items are equal.

operator<<()

#include: telemetry.h
std::ostream& dronecode_sdk::operator<<(std::ostream &str, Telemetry::RCStatus const &rc_status)

Stream operator to print information about a Telemetry::RCStatus.

Parameters

Returns

 std::ostream & - A reference to the stream.

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

results matching ""

    No results matching ""