flight/uavobjects/inc/uavobject.h.template

   1 /**
   2  ******************************************************************************
   3  * @addtogroup UAVObjects OpenPilot UAVObjects
   4  * @{
   5  * @addtogroup $(NAME) $(NAME)
   6  * @brief $(DESCRIPTION)
   7  *
   8  * Autogenerated files and functions for $(NAME) Object
   9  *
  10  * @{
  11  *
  12  * @file       $(NAMELC).h
  13  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010-2013.
  14  * @brief      Implementation of the $(NAME) object. This file has been
  15  *             automatically generated by the UAVObjectGenerator.
  16  *
  17  * @note       Object definition file: $(XMLFILE).
  18  *             This is an automatically generated file.
  19  *             DO NOT modify manually.
  20  *
  21  * @see        The GNU Public License (GPL) Version 3
  22  *
  23  *****************************************************************************/
  24 /*
  25  * This program is free software; you can redistribute it and/or modify
  26  * it under the terms of the GNU General Public License as published by
  27  * the Free Software Foundation; either version 3 of the License, or
  28  * (at your option) any later version.
  29  *
  30  * This program is distributed in the hope that it will be useful, but
  31  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  32  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  33  * for more details.
  34  *
  35  * You should have received a copy of the GNU General Public License along
  36  * with this program; if not, write to the Free Software Foundation, Inc.,
  37  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  38  */
  39
  40 #ifndef $(NAMEUC)_H
  41 #define $(NAMEUC)_H
  42 #include <stdbool.h>
  43 $(INCLUDE)
  44 /* Object constants */
  45 #define $(NAMEUC)_OBJID $(OBJIDHEX)
  46 #define $(NAMEUC)_ISSINGLEINST $(ISSINGLEINST)
  47 #define $(NAMEUC)_ISSETTINGS $(ISSETTINGS)
  48 #define $(NAMEUC)_ISPRIORITY $(ISPRIORITY)
  49 #define $(NAMEUC)_NUMBYTES sizeof($(NAME)Data)
  50
  51 /* Generic interface functions */
  52 int32_t $(NAME)Initialize();
  53 UAVObjHandle $(NAME)Handle();
  54 void $(NAME)SetDefaults(UAVObjHandle obj, uint16_t instId);
  55
  56 $(DATAFIELDINFO)
  57
  58 $(DATASTRUCTURES)
  59 /*
  60  * Packed Object data (unaligned).
  61  * Should only be used where 4 byte alignment can be guaranteed
  62  * (eg a single instance on the heap)
  63  */
  64 typedef struct {
  65     $(DATAFIELDS)
  66 } __attribute__((packed)) $(NAME)DataPacked;
  67
  68 /*
  69  * Packed Object data.
  70  * Alignment is forced to 4 bytes so as to avoid the potential for CPU usage faults
  71  * on Cortex M4F during load/store of float UAVO fields
  72  */
  73 typedef $(NAME)DataPacked __attribute__((aligned(4))) $(NAME)Data;
  74
  75 void $(NAME)DataOverrideDefaults($(NAME)Data * data);
  76
  77 /* Typesafe Object access functions */
  78 static inline int32_t $(NAME)Get($(NAME)Data * dataOut) {
  79     return UAVObjGetData($(NAME)Handle(), dataOut);
  80 }
  81 static inline int32_t $(NAME)Set(const $(NAME)Data * dataIn) {
  82     return UAVObjSetData($(NAME)Handle(), dataIn);
  83 }
  84 static inline int32_t $(NAME)InstGet(uint16_t instId, $(NAME)Data * dataOut) {
  85     return UAVObjGetInstanceData($(NAME)Handle(), instId, dataOut);
  86 }
  87 static inline int32_t $(NAME)InstSet(uint16_t instId, const $(NAME)Data * dataIn) {
  88     return UAVObjSetInstanceData($(NAME)Handle(), instId, dataIn);
  89 }
  90 static inline int32_t $(NAME)ConnectQueue(xQueueHandle queue) {
  91     return UAVObjConnectQueue($(NAME)Handle(), queue, EV_MASK_ALL_UPDATES);
  92 }
  93 static inline int32_t $(NAME)ConnectCallback(UAVObjEventCallback cb) {
  94     return UAVObjConnectCallback($(NAME)Handle(), cb, EV_MASK_ALL_UPDATES, false);
  95 }
  96 static inline int32_t $(NAME)ConnectFastCallback(UAVObjEventCallback cb) {
  97     return UAVObjConnectCallback($(NAME)Handle(), cb, EV_MASK_ALL_UPDATES, true);
  98 }
  99 static inline uint16_t $(NAME)CreateInstance() {
 100     return UAVObjCreateInstance($(NAME)Handle());
 101 }
 102 static inline void $(NAME)RequestUpdate() {
 103     UAVObjRequestUpdate($(NAME)Handle());
 104 }
 105 static inline void $(NAME)RequestInstUpdate(uint16_t instId) {
 106     UAVObjRequestInstanceUpdate($(NAME)Handle(), instId);
 107 }
 108 static inline void $(NAME)Updated() {
 109     UAVObjUpdated($(NAME)Handle());
 110 }
 111 static inline void $(NAME)InstUpdated(uint16_t instId) {
 112     UAVObjInstanceUpdated($(NAME)Handle(), instId);
 113 }
 114 static inline void $(NAME)Logging() {
 115     UAVObjLogging($(NAME)Handle());
 116 }
 117 static inline void $(NAME)InstLogging(uint16_t instId) {
 118     UAVObjInstanceLogging($(NAME)Handle(), instId);
 119 }
 120 static inline int32_t $(NAME)GetMetadata(UAVObjMetadata * dataOut) {
 121     return UAVObjGetMetadata($(NAME)Handle(), dataOut);
 122 }
 123 static inline int32_t $(NAME)SetMetadata(const UAVObjMetadata * dataIn) {
 124     return UAVObjSetMetadata($(NAME)Handle(), dataIn);
 125 }
 126 static inline int8_t $(NAME)ReadOnly() {
 127     return UAVObjReadOnly($(NAME)Handle());
 128 }
 129
 130 /* Set/Get functions */
 131 $(SETGETFIELDSEXTERN)
 132
 133 #endif // $(NAMEUC)_H
 134
 135 /**
 136  * @}
 137  * @}
 138  */