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

Set home position action. More...

#include <set_home_action.h>

Inheritance diagram for ugcs::vsm::Set_home_action:
ugcs::vsm::Action

Public Types

typedef std::shared_ptr< Set_home_actionPtr
 Pointer type.
 
typedef std::weak_ptr< Set_home_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

 Set_home_action (bool use_current_position, Wgs84_position home_position, double elevation)
 Construct set gome action explicitly. More...
 
 Set_home_action (const mavlink::ugcs::Pld_mission_item_ex &item)
 Construct set home action from Mavlink extended mission item. More...
 
 Set_home_action (const Property_list &p)
 Construct action from protobuf command.
 
- 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

bool use_current_position
 If set, current vehicle position should be set as the home/base position on the action occurrence. More...
 
Wgs84_position home_position
 Global position, that should be used as the home/base position.
 
double elevation
 Elevation in meters (i.e. More...
 
- Public Attributes inherited from ugcs::vsm::Action
int command_id = -1
 

Detailed Description

Set home position action.

Constructor & Destructor Documentation

ugcs::vsm::Set_home_action::Set_home_action ( bool  use_current_position,
Wgs84_position  home_position,
double  elevation 
)
inline

Construct set gome action explicitly.

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

Construct set home action from Mavlink extended mission item.

Parameters
itemWith command equal to mavlink::MAV_CMD::MAV_CMD_DO_SET_HOME

Member Function Documentation

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

Create an instance.

Member Data Documentation

double ugcs::vsm::Set_home_action::elevation

Elevation in meters (i.e.

terrain height) underneath the home position.

bool ugcs::vsm::Set_home_action::use_current_position

If set, current vehicle position should be set as the home/base position on the action occurrence.

Otherwise, vehicle should use home_position value.


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