DJI::onboardSDK::HotPoint Class Reference

#include <DJI_HotPoint.h>

List of all members.

Classes
struct	YawRate
Public Types
enum	View {   VIEW_NORTH = 0, VIEW_SOUTH = 1, VIEW_WEST = 2, VIEW_EAST = 3,   VIEW_NEARBY = 4 }
enum	YawMode {   YAW_AUTO = 0, YAW_INSIDE = 1, YAW_OUTSIDE = 2, YAW_CUSTOM = 3,   YAW_STATIC = 4 }
typedef struct DJI::onboardSDK::HotPoint::YawRate	YawRate
Public Member Functions
HotPointData	getData () const
	HotPoint (CoreAPI *ControlAPI=0)
void	initData ()
void	pause (bool isPause, CallBack callback=0, UserData userData=0)
MissionACK	pause (bool isPause, int timer)
void	readData (CallBack callback=0, UserData userData=0)
MissionACK	readData (int timer)
void	resetYaw (CallBack callback=0, UserData userData=0)
MissionACK	resetYaw (int timer)
void	setCameraView (View view)
void	setClockwise (bool isClockwise)
void	setData (const HotPointData &value)
void	setHotPoint (float64_t longtitude, float64_t latitude, float64_t altitude)
void	setHotPoint (GPSPositionData gps)
void	setRadius (float64_t meter)
void	setYawMode (YawMode mode)
void	setYawRate (float32_t defree)
void	start (CallBack callback=0, UserData userData=0)
HotPointStartACK	start (int timer)
void	stop (CallBack callback=0, UserData userData=0)
MissionACK	stop (int timer)
void	updateRadius (float32_t meter, CallBack callback=0, UserData userData=0)
MissionACK	updateRadius (float32_t meter, int timer)
void	updateYawRate (YawRate &Data, CallBack callback=0, UserData userData=0)
MissionACK	updateYawRate (YawRate &Data, int timer)
void	updateYawRate (float32_t yawRate, bool isClockwise, CallBack callback=0, UserData userData=0)
Static Public Member Functions
static void	readCallback (CoreAPI *api, Header *protoclHeader, UserData userdata)
static void	startCallback (CoreAPI *api, Header *protocolHeader, UserData userdata=0)
Private Attributes
CoreAPI *	api
HotPointData	hotPointData

---

Detailed Description

Definition at line 22 of file DJI_HotPoint.h.

---

Member Typedef Documentation

typedef struct DJI::onboardSDK::HotPoint::YawRate DJI::onboardSDK::HotPoint::YawRate

---

Member Enumeration Documentation

enum DJI::onboardSDK::HotPoint::View

Enumerator:

VIEW_NORTH
VIEW_SOUTH
VIEW_WEST
VIEW_EAST
VIEW_NEARBY

Definition at line 33 of file DJI_HotPoint.h.

enum DJI::onboardSDK::HotPoint::YawMode

Enumerator:

YAW_AUTO
YAW_INSIDE
YAW_OUTSIDE
YAW_CUSTOM
YAW_STATIC

Definition at line 42 of file DJI_HotPoint.h.

---

Constructor & Destructor Documentation

HotPoint::HotPoint

(

CoreAPI *

ControlAPI = 0

)

Definition at line 18 of file DJI_HotPoint.cpp.

---

Member Function Documentation

HotPointData HotPoint::getData

(

)

const

Definition at line 210 of file DJI_HotPoint.cpp.

void HotPoint::initData

(

)

Definition at line 25 of file DJI_HotPoint.cpp.

void HotPoint::pause	(	bool	isPause,
		CallBack	callback = 0,
		UserData	userData = 0
	)

Definition at line 76 of file DJI_HotPoint.cpp.

MissionACK HotPoint::pause	(	bool	isPause,
		int	timer
	)

Definition at line 83 of file DJI_HotPoint.cpp.

void HotPoint::readCallback	(	CoreAPI *	api,
		Header *	protoclHeader,
		UserData	userdata
	)		[static]

Definition at line 231 of file DJI_HotPoint.cpp.

void HotPoint::readData	(	CallBack	callback = 0,
		UserData	userData = 0
	)

Definition at line 161 of file DJI_HotPoint.cpp.

MissionACK HotPoint::readData

(

int

timer

)

Definition at line 168 of file DJI_HotPoint.cpp.

void HotPoint::resetYaw	(	CallBack	callback = 0,
		UserData	userData = 0
	)

Definition at line 142 of file DJI_HotPoint.cpp.

MissionACK HotPoint::resetYaw

(

int

timer

)

Definition at line 149 of file DJI_HotPoint.cpp.

void HotPoint::setCameraView

(

HotPoint::View

view

)

Definition at line 206 of file DJI_HotPoint.cpp.

void HotPoint::setClockwise

(

bool

isClockwise

)

Definition at line 204 of file DJI_HotPoint.cpp.

void HotPoint::setData

(

const HotPointData &

value

)

Note:

data access functions

Definition at line 180 of file DJI_HotPoint.cpp.

void HotPoint::setHotPoint	(	float64_t	longtitude,
		float64_t	latitude,
		float64_t	altitude
	)

Definition at line 186 of file DJI_HotPoint.cpp.

void HotPoint::setHotPoint

(

GPSPositionData

gps

)

Definition at line 193 of file DJI_HotPoint.cpp.

void HotPoint::setRadius

(

float64_t

meter

)

Definition at line 200 of file DJI_HotPoint.cpp.

void HotPoint::setYawMode

(

HotPoint::YawMode

mode

)

Definition at line 208 of file DJI_HotPoint.cpp.

void HotPoint::setYawRate

(

float32_t

defree

)

Definition at line 202 of file DJI_HotPoint.cpp.

void HotPoint::start	(	CallBack	callback = 0,
		UserData	userData = 0
	)

Note:

API functions

Attention:

difference between set and update Set functions only change the HotPoint data in this class, Update functions will change the Mission status. In other words: drone will response update functions immediately.

Definition at line 40 of file DJI_HotPoint.cpp.

HotPointStartACK HotPoint::start

(

int

timer

)

Definition at line 46 of file DJI_HotPoint.cpp.

void HotPoint::startCallback	(	CoreAPI *	api,
		Header *	protocolHeader,
		UserData userdata	__UNUSED = 0
	)		[static]

Definition at line 212 of file DJI_HotPoint.cpp.

void HotPoint::stop	(	CallBack	callback = 0,
		UserData	userData = 0
	)

Definition at line 57 of file DJI_HotPoint.cpp.

MissionACK HotPoint::stop

(

int

timer

)

Definition at line 64 of file DJI_HotPoint.cpp.

void HotPoint::updateRadius	(	float32_t	meter,
		CallBack	callback = 0,
		UserData	userData = 0
	)

Definition at line 125 of file DJI_HotPoint.cpp.

MissionACK HotPoint::updateRadius	(	float32_t	meter,
		int	timer
	)

Definition at line 131 of file DJI_HotPoint.cpp.

void HotPoint::updateYawRate	(	HotPoint::YawRate &	Data,
		CallBack	callback = 0,
		UserData	userData = 0
	)

Definition at line 95 of file DJI_HotPoint.cpp.

MissionACK HotPoint::updateYawRate	(	HotPoint::YawRate &	Data,
		int	timer
	)

Definition at line 103 of file DJI_HotPoint.cpp.

void HotPoint::updateYawRate	(	float32_t	yawRate,
		bool	isClockwise,
		CallBack	callback = 0,
		UserData	userData = 0
	)

Definition at line 116 of file DJI_HotPoint.cpp.

---

Member Data Documentation

CoreAPI* DJI::onboardSDK::HotPoint::api [private]

Definition at line 99 of file DJI_HotPoint.h.

HotPointData DJI::onboardSDK::HotPoint::hotPointData [private]

Definition at line 100 of file DJI_HotPoint.h.

---

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

• DJI_HotPoint.h
• DJI_HotPoint.cpp