VSM C++ SDK
Vehicle Specific Modules SDK
ugcs::vsm::Task_attributes_action Class Reference

Task attributes action. More...

#include <task_attributes_action.h>

Inheritance diagram for ugcs::vsm::Task_attributes_action:
ugcs::vsm::Action

Public Types

enum  Emergency_action {
  GO_HOME, LAND, WAIT, CONTINUE,
  DO_NOT_CHANGE
}
 Action to perform in case of emergency. More...
 
typedef std::shared_ptr< Task_attributes_actionPtr
 Pointer type.
 
typedef std::weak_ptr< Task_attributes_actionWeak_ptr
 Pointer type.
 
- Public Types inherited from ugcs::vsm::Action
enum  Type {
  Type::MOVE, Type::WAIT, Type::PAYLOAD_STEERING, Type::TAKEOFF,
  Type::LANDING, Type::CHANGE_SPEED, Type::SET_HOME, Type::POI,
  Type::HEADING, Type::CAMERA_CONTROL, Type::CAMERA_TRIGGER, Type::PANORAMA,
  Type::TASK_ATTRIBUTES, Type::CAMERA_SERIES_BY_TIME, Type::CAMERA_SERIES_BY_DISTANCE, Type::SET_PARAMETER,
  Type::SET_SERVO, Type::REPEAT_SERVO
}
 Types of vehicle actions as part of task (mission). More...
 
typedef std::shared_ptr< ActionPtr
 Pointer type.
 
typedef std::weak_ptr< ActionWeak_ptr
 Pointer type.
 
typedef ugcs::vsm::Param_exception< Format_exception_dummy_struct,> Format_exception
 

Public Member Functions

 Task_attributes_action (double safe_altitude, Emergency_action rc_loss, Emergency_action gnss_loss, Emergency_action low_battery)
 Construct task attributes action explicitly. More...
 
 Task_attributes_action (const Property_list &params)
 Construct action from new style params. More...
 
 Task_attributes_action (const mavlink::ugcs::Pld_mission_item_ex &item)
 Construct task attributes action from Mavlink mission item. More...
 
- Public Member Functions inherited from ugcs::vsm::Action
 Action (Type type)
 Construct action of specific type. More...
 
virtual ~Action ()
 Make sure Action is polymorphic. More...
 
Type Get_type () const
 Get action type. More...
 
void Set_id (int id)
 
std::string Get_name ()
 Get human readable name of the action. More...
 
template<Type type_val>
Mapper< type_val >::type::Ptr Get_action ()
 Get pointer to specific action as determined by Get_type. More...
 

Static Public Member Functions

template<typename... Args>
static Ptr Create (Args &&...args)
 Create an instance. More...
 
- Static Public Member Functions inherited from ugcs::vsm::Action
template<typename... Args>
static Ptr Create (Args &&...args)
 Create an instance. More...
 

Public Attributes

double safe_altitude
 Safe altitude in meters (MSL). More...
 
Emergency_action rc_loss
 Type of action to perform in case of remote control loss. More...
 
Emergency_action gnss_loss
 Type of action to perform in case of GNSS signal loss (i.e. More...
 
Emergency_action low_battery
 Type of action to perform in case of low battery. More...
 
- Public Attributes inherited from ugcs::vsm::Action
int command_id = -1
 

Detailed Description

Task attributes action.

Initializes/changes task parameters, such as safety configuration and emergency actions.

Member Enumeration Documentation

Action to perform in case of emergency.

Enumerator
GO_HOME 

Return and land at the home position.

LAND 

Land at the current position.

WAIT 

Hover at the current position.

CONTINUE 

Continue the task.

DO_NOT_CHANGE 

do not change

Constructor & Destructor Documentation

ugcs::vsm::Task_attributes_action::Task_attributes_action ( double  safe_altitude,
Emergency_action  rc_loss,
Emergency_action  gnss_loss,
Emergency_action  low_battery 
)
inline

Construct task attributes action explicitly.

ugcs::vsm::Task_attributes_action::Task_attributes_action ( const Property_list params)
inline

Construct action from new style params.

ugcs::vsm::Task_attributes_action::Task_attributes_action ( const mavlink::ugcs::Pld_mission_item_ex &  item)
inline

Construct task attributes action from Mavlink mission item.

Parameters
itemWith command equal to mavlink::ugcs::MAV_CMD::MAV_CMD_DO_SET_ROUTE_ATTRIBUTES

Member Function Documentation

template<typename... Args>
static Ptr ugcs::vsm::Task_attributes_action::Create ( Args &&...  args)
inlinestatic

Create an instance.

Member Data Documentation

Emergency_action ugcs::vsm::Task_attributes_action::gnss_loss

Type of action to perform in case of GNSS signal loss (i.e.

GPS, GLONASS etc.).

Emergency_action ugcs::vsm::Task_attributes_action::low_battery

Type of action to perform in case of low battery.

Emergency_action ugcs::vsm::Task_attributes_action::rc_loss

Type of action to perform in case of remote control loss.

double ugcs::vsm::Task_attributes_action::safe_altitude

Safe altitude in meters (MSL).


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