Packages

A high-performance Elixir library for decoding Garmin .fit files using a C++ NIF.

Current section

Files

Jump to
fit_decoder c_src fit_sdk cpp fit_exercise_title_mesg.hpp
Raw

c_src/fit_sdk/cpp/fit_exercise_title_mesg.hpp

/////////////////////////////////////////////////////////////////////////////////////////////
// Copyright 2025 Garmin International, Inc.
// Licensed under the Flexible and Interoperable Data Transfer (FIT) Protocol License; you
// may not use this file except in compliance with the Flexible and Interoperable Data
// Transfer (FIT) Protocol License.
/////////////////////////////////////////////////////////////////////////////////////////////
// ****WARNING**** This file is auto-generated! Do NOT edit this file.
// Profile Version = 21.171.0Release
// Tag = production/release/21.171.0-0-g57fed75
/////////////////////////////////////////////////////////////////////////////////////////////
#if !defined(FIT_EXERCISE_TITLE_MESG_HPP)
#define FIT_EXERCISE_TITLE_MESG_HPP
#include "fit_mesg.hpp"
namespace fit
{
class ExerciseTitleMesg : public Mesg
{
public:
class FieldDefNum final
{
public:
static const FIT_UINT8 MessageIndex = 254;
static const FIT_UINT8 ExerciseCategory = 0;
static const FIT_UINT8 ExerciseName = 1;
static const FIT_UINT8 WktStepName = 2;
static const FIT_UINT8 Invalid = FIT_FIELD_NUM_INVALID;
};
ExerciseTitleMesg(void) : Mesg(Profile::MESG_EXERCISE_TITLE)
{
}
ExerciseTitleMesg(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
///////////////////////////////////////////////////////////////////////
FIT_MESSAGE_INDEX GetMessageIndex(void) const
{
return GetFieldUINT16Value(254, 0, FIT_SUBFIELD_INDEX_MAIN_FIELD);
}
///////////////////////////////////////////////////////////////////////
// Set message_index field
///////////////////////////////////////////////////////////////////////
void SetMessageIndex(FIT_MESSAGE_INDEX messageIndex)
{
SetFieldUINT16Value(254, messageIndex, 0, FIT_SUBFIELD_INDEX_MAIN_FIELD);
}
///////////////////////////////////////////////////////////////////////
// Checks the validity of exercise_category field
// Returns FIT_TRUE if field is valid
///////////////////////////////////////////////////////////////////////
FIT_BOOL IsExerciseCategoryValid() const
{
const Field* field = GetField(0);
if( FIT_NULL == field )
{
return FIT_FALSE;
}
return field->IsValueValid();
}
///////////////////////////////////////////////////////////////////////
// Returns exercise_category field
///////////////////////////////////////////////////////////////////////
FIT_EXERCISE_CATEGORY GetExerciseCategory(void) const
{
return GetFieldUINT16Value(0, 0, FIT_SUBFIELD_INDEX_MAIN_FIELD);
}
///////////////////////////////////////////////////////////////////////
// Set exercise_category field
///////////////////////////////////////////////////////////////////////
void SetExerciseCategory(FIT_EXERCISE_CATEGORY exerciseCategory)
{
SetFieldUINT16Value(0, exerciseCategory, 0, FIT_SUBFIELD_INDEX_MAIN_FIELD);
}
///////////////////////////////////////////////////////////////////////
// Checks the validity of exercise_name field
// Returns FIT_TRUE if field is valid
///////////////////////////////////////////////////////////////////////
FIT_BOOL IsExerciseNameValid() const
{
const Field* field = GetField(1);
if( FIT_NULL == field )
{
return FIT_FALSE;
}
return field->IsValueValid();
}
///////////////////////////////////////////////////////////////////////
// Returns exercise_name field
///////////////////////////////////////////////////////////////////////
FIT_UINT16 GetExerciseName(void) const
{
return GetFieldUINT16Value(1, 0, FIT_SUBFIELD_INDEX_MAIN_FIELD);
}
///////////////////////////////////////////////////////////////////////
// Set exercise_name field
///////////////////////////////////////////////////////////////////////
void SetExerciseName(FIT_UINT16 exerciseName)
{
SetFieldUINT16Value(1, exerciseName, 0, FIT_SUBFIELD_INDEX_MAIN_FIELD);
}
///////////////////////////////////////////////////////////////////////
// Returns number of wkt_step_name
///////////////////////////////////////////////////////////////////////
FIT_UINT8 GetNumWktStepName(void) const
{
return GetFieldNumValues(2, FIT_SUBFIELD_INDEX_MAIN_FIELD);
}
///////////////////////////////////////////////////////////////////////
// Checks the validity of wkt_step_name field
// Returns FIT_TRUE if field is valid
///////////////////////////////////////////////////////////////////////
FIT_BOOL IsWktStepNameValid(FIT_UINT8 index) const
{
const Field* field = GetField(2);
if( FIT_NULL == field )
{
return FIT_FALSE;
}
return field->IsValueValid(index);
}
///////////////////////////////////////////////////////////////////////
// Returns wkt_step_name field
///////////////////////////////////////////////////////////////////////
FIT_WSTRING GetWktStepName(FIT_UINT8 index) const
{
return GetFieldSTRINGValue(2, index, FIT_SUBFIELD_INDEX_MAIN_FIELD);
}
///////////////////////////////////////////////////////////////////////
// Set wkt_step_name field
///////////////////////////////////////////////////////////////////////
void SetWktStepName(FIT_UINT8 index, FIT_WSTRING wktStepName)
{
SetFieldSTRINGValue(2, wktStepName, index);
}
};
} // namespace fit
#endif // !defined(FIT_EXERCISE_TITLE_MESG_HPP)