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

Point of interest (POI) for a vehicle. More...

#include <poi_action.h>

Inheritance diagram for ugcs::vsm::Poi_action:
ugcs::vsm::Action

Public Types

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

 Poi_action (Wgs84_position position, bool active)
 Construct POI explicitly. More...
 
 Poi_action (const mavlink::ugcs::Pld_mission_item_ex &item)
 Construct POI action from Mavlink mission item. More...
 
 Poi_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

Wgs84_position position
 Position of a a POI. More...
 
bool active
 true - POI is active and should be monitored, false - POI is not active and should not be anymore monitored. More...
 
- Public Attributes inherited from ugcs::vsm::Action
int command_id = -1
 

Detailed Description

Point of interest (POI) for a vehicle.

Constructor & Destructor Documentation

ugcs::vsm::Poi_action::Poi_action ( Wgs84_position  position,
bool  active 
)
inline

Construct POI explicitly.

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

Construct POI action from Mavlink mission item.

Exceptions
Action::Format_exceptionif mission item has wrong format.
Parameters
itemWith command equal to mavlink::MAV_CMD::MAV_CMD_NAV_ROI

Member Function Documentation

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

Create an instance.

Member Data Documentation

bool ugcs::vsm::Poi_action::active

true - POI is active and should be monitored, false - POI is not active and should not be anymore monitored.

Wgs84_position ugcs::vsm::Poi_action::position

Position of a a POI.


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