Package de.wuespace.telestion.extension.mavlink.message

Interface MavlinkMessage

All Superinterfaces:

de.wuespace.telestion.api.message.JsonMessage

public interface MavlinkMessage
extends de.wuespace.telestion.api.message.JsonMessage

Superclass for all MavlinkMessages.
Implementations will be created automatically by the xml2record-tool.

Field Summary

Fields inherited from interface de.wuespace.telestion.api.message.JsonMessage

logger

Method Summary

Modifier and Type	Method	Description
default MavInfo	checkAnnotation()	Checks if the necessary MavInfo-Annotation is present. If so a representing Object will be returned otherwise an AnnotationMissingException will be thrown.
default int	getCrc()	Returns the CRC_EXTRA-Byte for the MavlinkMessage declared in the MavInfo. It is used for the checksum-calculation based on the X25Checksum algorithm (also know as CRC-16-CCITT). For more information see: https://mavlink.io/en/guide/serialization.html#crc_extra
default int	getId()	Returns the id of the MavlinkMessage declared in the MavInfo. it is used to identify the message which was sent to cast the payload. For more information see: https://mavlink.io/en/guide/serialization.html

Methods inherited from interface de.wuespace.telestion.api.message.JsonMessage

className, json, toJsonBuffer, toJsonBuffer, toJsonObject, toJsonString, toJsonString

Method Details

checkAnnotation

default MavInfo checkAnnotation()

Checks if the necessary MavInfo-Annotation is present.
If so a representing Object will be returned otherwise an AnnotationMissingException will be thrown.

Implementation Node: Should not be overwritten

Returns:

MavInfo of this class if present

Throws:

AnnotationMissingException - if MavInfo is not present

getCrc

default int getCrc()

Returns the CRC_EXTRA-Byte for the MavlinkMessage declared in the MavInfo.
It is used for the checksum-calculation based on the X25Checksum algorithm (also know as CRC-16-CCITT).

For more information see:
https://mavlink.io/en/guide/serialization.html#crc_extra

Implementation Node: Should not be overwritten

Returns:

CRC_EXTRA-Byte for the MavlinkMessage

getId

default int getId()

Returns the id of the MavlinkMessage declared in the MavInfo.
it is used to identify the message which was sent to cast the payload.

For more information see:
https://mavlink.io/en/guide/serialization.html

Implementation Node: Should not be overwritten

Returns:

id of the MavlinkMessage