text: ////////////////////////////////////////////////////////////////////////////////
  // The following FIT Protocol software provided may be used with FIT protocol
  // devices only and remains the copyrighted property of Garmin Canada Inc.
  // The software is being provided on an "as-is" basis and as an accommodation,
  // and therefore all warranties, representations, or guarantees of any kind
  // (whether express, implied or statutory) including, without limitation,
  // warranties of merchantability, non-infringement, or fitness for a particular
  // purpose, are specifically disclaimed.
  //
  // Copyright 2018 Garmin Canada Inc.
  ////////////////////////////////////////////////////////////////////////////////
  // ****WARNING****  This file is auto-generated!  Do NOT edit this file.
  // Profile Version = 20.80Release
  // Tag = production/akw/20.80.00-0-g64ad259
  ////////////////////////////////////////////////////////////////////////////////
  
  
  #if !defined(FIT_DIVE_ALARM_MESG_HPP)
  #define FIT_DIVE_ALARM_MESG_HPP
  
  #include "fit_mesg.hpp"
  
  namespace fit
  {
  
  class DiveAlarmMesg : public Mesg
  {
  public:
      class FieldDefNum final
      {
      public:
         static const FIT_UINT8 MessageIndex = 254;
         static const FIT_UINT8 Depth = 0;
         static const FIT_UINT8 Time = 1;
         static const FIT_UINT8 Enabled = 2;
         static const FIT_UINT8 AlarmType = 3;
         static const FIT_UINT8 Sound = 4;
         static const FIT_UINT8 DiveTypes = 5;
         static const FIT_UINT8 Invalid = FIT_FIELD_NUM_INVALID;
      };
  
      DiveAlarmMesg(void) : Mesg(Profile::MESG_DIVE_ALARM)
      {
      }
  
      DiveAlarmMesg(const Mesg &mesg) : Mesg(mesg)
      {
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Checks the validity of message_index field
      // Returns FIT_TRUE if field is valid
      ///////////////////////////////////////////////////////////////////////
      FIT_BOOL IsMessageIndexValid() const
      {
          const Field* field = GetField(254);
          if( FIT_NULL == field )
          {
              return FIT_FALSE;
          }
  
          return field->IsValueValid();
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Returns message_index field
      // Comment: Index of the alarm
      ///////////////////////////////////////////////////////////////////////
      FIT_MESSAGE_INDEX GetMessageIndex(void) const
      {
          return GetFieldUINT16Value(254, 0, FIT_SUBFIELD_INDEX_MAIN_FIELD);
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Set message_index field
      // Comment: Index of the alarm
      ///////////////////////////////////////////////////////////////////////
      void SetMessageIndex(FIT_MESSAGE_INDEX messageIndex)
      {
          SetFieldUINT16Value(254, messageIndex, 0, FIT_SUBFIELD_INDEX_MAIN_FIELD);
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Checks the validity of depth field
      // Returns FIT_TRUE if field is valid
      ///////////////////////////////////////////////////////////////////////
      FIT_BOOL IsDepthValid() const
      {
          const Field* field = GetField(0);
          if( FIT_NULL == field )
          {
              return FIT_FALSE;
          }
  
          return field->IsValueValid();
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Returns depth field
      // Units: m
      ///////////////////////////////////////////////////////////////////////
      FIT_FLOAT32 GetDepth(void) const
      {
          return GetFieldFLOAT32Value(0, 0, FIT_SUBFIELD_INDEX_MAIN_FIELD);
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Set depth field
      // Units: m
      ///////////////////////////////////////////////////////////////////////
      void SetDepth(FIT_FLOAT32 depth)
      {
          SetFieldFLOAT32Value(0, depth, 0, FIT_SUBFIELD_INDEX_MAIN_FIELD);
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Checks the validity of time field
      // Returns FIT_TRUE if field is valid
      ///////////////////////////////////////////////////////////////////////
      FIT_BOOL IsTimeValid() const
      {
          const Field* field = GetField(1);
          if( FIT_NULL == field )
          {
              return FIT_FALSE;
          }
  
          return field->IsValueValid();
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Returns time field
      // Units: s
      ///////////////////////////////////////////////////////////////////////
      FIT_SINT32 GetTime(void) const
      {
          return GetFieldSINT32Value(1, 0, FIT_SUBFIELD_INDEX_MAIN_FIELD);
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Set time field
      // Units: s
      ///////////////////////////////////////////////////////////////////////
      void SetTime(FIT_SINT32 time)
      {
          SetFieldSINT32Value(1, time, 0, FIT_SUBFIELD_INDEX_MAIN_FIELD);
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Checks the validity of enabled field
      // Returns FIT_TRUE if field is valid
      ///////////////////////////////////////////////////////////////////////
      FIT_BOOL IsEnabledValid() const
      {
          const Field* field = GetField(2);
          if( FIT_NULL == field )
          {
              return FIT_FALSE;
          }
  
          return field->IsValueValid();
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Returns enabled field
      ///////////////////////////////////////////////////////////////////////
      FIT_BOOL GetEnabled(void) const
      {
          return GetFieldENUMValue(2, 0, FIT_SUBFIELD_INDEX_MAIN_FIELD);
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Set enabled field
      ///////////////////////////////////////////////////////////////////////
      void SetEnabled(FIT_BOOL enabled)
      {
          SetFieldENUMValue(2, enabled, 0, FIT_SUBFIELD_INDEX_MAIN_FIELD);
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Checks the validity of alarm_type field
      // Returns FIT_TRUE if field is valid
      ///////////////////////////////////////////////////////////////////////
      FIT_BOOL IsAlarmTypeValid() const
      {
          const Field* field = GetField(3);
          if( FIT_NULL == field )
          {
              return FIT_FALSE;
          }
  
          return field->IsValueValid();
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Returns alarm_type field
      ///////////////////////////////////////////////////////////////////////
      FIT_DIVE_ALARM_TYPE GetAlarmType(void) const
      {
          return GetFieldENUMValue(3, 0, FIT_SUBFIELD_INDEX_MAIN_FIELD);
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Set alarm_type field
      ///////////////////////////////////////////////////////////////////////
      void SetAlarmType(FIT_DIVE_ALARM_TYPE alarmType)
      {
          SetFieldENUMValue(3, alarmType, 0, FIT_SUBFIELD_INDEX_MAIN_FIELD);
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Checks the validity of sound field
      // Returns FIT_TRUE if field is valid
      ///////////////////////////////////////////////////////////////////////
      FIT_BOOL IsSoundValid() const
      {
          const Field* field = GetField(4);
          if( FIT_NULL == field )
          {
              return FIT_FALSE;
          }
  
          return field->IsValueValid();
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Returns sound field
      ///////////////////////////////////////////////////////////////////////
      FIT_TONE GetSound(void) const
      {
          return GetFieldENUMValue(4, 0, FIT_SUBFIELD_INDEX_MAIN_FIELD);
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Set sound field
      ///////////////////////////////////////////////////////////////////////
      void SetSound(FIT_TONE sound)
      {
          SetFieldENUMValue(4, sound, 0, FIT_SUBFIELD_INDEX_MAIN_FIELD);
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Returns number of dive_types
      ///////////////////////////////////////////////////////////////////////
      FIT_UINT8 GetNumDiveTypes(void) const
      {
          return GetFieldNumValues(5, FIT_SUBFIELD_INDEX_MAIN_FIELD);
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Checks the validity of dive_types field
      // Returns FIT_TRUE if field is valid
      ///////////////////////////////////////////////////////////////////////
      FIT_BOOL IsDiveTypesValid(FIT_UINT8 index) const
      {
          const Field* field = GetField(5);
          if( FIT_NULL == field )
          {
              return FIT_FALSE;
          }
  
          return field->IsValueValid(index);
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Returns dive_types field
      ///////////////////////////////////////////////////////////////////////
      FIT_SUB_SPORT GetDiveTypes(FIT_UINT8 index) const
      {
          return GetFieldENUMValue(5, index, FIT_SUBFIELD_INDEX_MAIN_FIELD);
      }
  
      ///////////////////////////////////////////////////////////////////////
      // Set dive_types field
      ///////////////////////////////////////////////////////////////////////
      void SetDiveTypes(FIT_UINT8 index, FIT_SUB_SPORT diveTypes)
      {
          SetFieldENUMValue(5, diveTypes, index, FIT_SUBFIELD_INDEX_MAIN_FIELD);
      }
  
  };
  
  } // namespace fit
  
  #endif // !defined(FIT_DIVE_ALARM_MESG_HPP)
  