Generalized MAVLink message payload. More...

#include <mavlink.h>

Inheritance diagram for ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >:

Public Types
typedef std::shared_ptr< Payload >	Ptr
	Pointer type.

typedef std::weak_ptr< Payload >	Weak_ptr
	Pointer type.

Public Types inherited from ugcs::vsm::mavlink::Payload_base
typedef std::shared_ptr < Payload_base >	Ptr
	Pointer type.

typedef std::weak_ptr < Payload_base >	Weak_ptr
	Pointer type.

Public Member Functions
	Payload ()=default
	All fields are initialized to default values. More...

	Payload (const void *buf, size_t size)
	Parse message from data buffer. More...

	Payload (Io_buffer::Ptr buffer)
	Convenience variation of previous constructor. More...

virtual size_t	Get_size_v1 () const override
	Get size of the message payload without extensions in bytes. More...

virtual size_t	Get_size_v2 () const override
	Get size of the message payload in bytes including all extensions. More...

virtual const char *	Get_name () const override
	Get message name. More...

virtual MESSAGE_ID_TYPE	Get_id () const override
	Get message id. More...

virtual uint8_t	Get_extra_byte () const override
	Get extra byte for CRC calculation. More...

virtual void	Reset () override
	Reset all fields to UgCS default values. More...

bool	operator== (const Payload &rhs) const
	Compare if data in the payload is bit-same with another payload. More...

bool	operator!= (const Payload &rhs) const
	Compare if data in the payload is not bit-same with another payload. More...

TData *	operator-> ()
	Pointer access semantics to payload. More...

const TData *	operator-> () const
	Constant pointer access semantics to payload. More...

TData &	operator* ()
	Dereference access semantics to payload. More...

const TData &	operator* () const
	Constant dereference access semantics to payload. More...

Public Member Functions inherited from ugcs::vsm::mavlink::Payload_base
Io_buffer::Ptr	Get_buffer () const
	Get Io_buffer instance which contains current content of the message. More...

std::string	Dump () const
	Dump message content in human-readable format into a string. 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::mavlink::Payload_base
template<typename... Args>
static Ptr	Create (Args &&...args)
	Create an instance. More...

Additional Inherited Members

Detailed Description

template<class TData, internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte>
class ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >

Generalized MAVLink message payload.

Parameters

TData Structure for payload data.

Constructor & Destructor Documentation

template<class TData , internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte>

ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >::Payload ( )

default

All fields are initialized to default values.

template<class TData , internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte>

ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >::Payload	(	const void *	buf,
		size_t	size
	)

inline

Parse message from data buffer.

The buffer should contain data on wire (in network byte order). Data size can be less than expected payload size. In this case reminder bytes will be set to 0. This is for mavlink2 support which allows trimming trailing zero bytes.

Parameters

buf	Pointer to data buffer.
size	Size of data available.

template<class TData , internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte>

ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >::Payload ( Io_buffer::Ptr buffer )

inline

Convenience variation of previous constructor.

Parameters

buffer Buffer with data.

Member Function Documentation

template<class TData , internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte>

template<typename... Args>

static Ptr ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >::Create ( Args &&... args )

inlinestatic

Create an instance.

template<class TData , internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte>

virtual uint8_t ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >::Get_extra_byte ( ) const

inlineoverridevirtual

Get extra byte for CRC calculation.

Implements ugcs::vsm::mavlink::Payload_base.

template<class TData , internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte>

virtual MESSAGE_ID_TYPE ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >::Get_id ( ) const

inlineoverridevirtual

Get message id.

Implements ugcs::vsm::mavlink::Payload_base.

template<class TData , internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte>

virtual const char* ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >::Get_name ( ) const

inlineoverridevirtual

Get message name.

Implements ugcs::vsm::mavlink::Payload_base.

template<class TData , internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte>

virtual size_t ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >::Get_size_v1 ( ) const

inlineoverridevirtual

Get size of the message payload without extensions in bytes.

Implements ugcs::vsm::mavlink::Payload_base.

template<class TData , internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte>

virtual size_t ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >::Get_size_v2 ( ) const

inlineoverridevirtual

Get size of the message payload in bytes including all extensions.

Implements ugcs::vsm::mavlink::Payload_base.

template<class TData , internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte>

bool ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >::operator!= ( const Payload< TData, fields, msg_name, msg_id, extra_byte > & rhs ) const

inline

Compare if data in the payload is not bit-same with another payload.

template<class TData , internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte>

TData& ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >::operator* ( )

inline

Dereference access semantics to payload.

template<class TData , internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte>

const TData& ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >::operator* ( ) const

inline

Constant dereference access semantics to payload.

template<class TData , internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte>

TData* ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >::operator-> ( )

inline

Pointer access semantics to payload.

template<class TData , internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte>

const TData* ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >::operator-> ( ) const

inline

Constant pointer access semantics to payload.

template<class TData , internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte>

bool ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >::operator== ( const Payload< TData, fields, msg_name, msg_id, extra_byte > & rhs ) const

inline

Compare if data in the payload is bit-same with another payload.

template<class TData , internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte>

virtual void ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >::Reset ( )

inlineoverridevirtual

Reset all fields to UgCS default values.

Implements ugcs::vsm::mavlink::Payload_base.

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

mavlink.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

template<class TData, internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte> class ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >

Constructor & Destructor Documentation

Member Function Documentation

template<class TData, internal::Field_descriptor * fields, const char * msg_name, MESSAGE_ID_TYPE msg_id, uint8_t extra_byte>
class ugcs::vsm::mavlink::Payload< TData, fields, msg_name, msg_id, extra_byte >