workoutmessage.cpp

Go to the documentation of this file.

/*
    Copyright 2021 Paul Colby
 
    This file is part of QtFit.
 
    QtFit is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    QtFit is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public License
    along with QtFit.  If not, see <http://www.gnu.org/licenses/>.
*/
 
/*!
 * \file
 * \note This file is automatcially generated. Any changes here are likely to be overwritten.
 */
 
/*!
 * \file
 * Defines the WorkoutMessage, and WorkoutMessagePrivate classes.
 */
 
#include "workoutmessage.h"
#include "workoutmessage_p.h"
 
#include <QDebug>
#include <QtEndian>
 
QTFIT_BEGIN_NAMESPACE
 
/*!
 * \class WorkoutMessage
 *
 * The WorkoutMessage class represents a FIT WorkoutMessage data message.
 *
 * \sa DataMessage
 */
 
/*!
 * Constructs a WorkoutMessage object.
 *
 * Typically, instances of this class will be returned by FitStreamReader::readNext, but this
 * constructor may be used, along with the relevant setter methods, to create a valid message.
 */
WorkoutMessage::WorkoutMessage() : AbstractDataMessage(new WorkoutMessagePrivate(this))
{
 
}
 
/*!
 * \internal
 *
 * Constructs a WorkoutMessage object with private implementation \a d.
 *
 * \param d Pointer to private implementation.
 */
WorkoutMessage::WorkoutMessage(WorkoutMessagePrivate * const d) : AbstractDataMessage(d)
{
 
}
 
/*!
 * Returns the WorkoutMessage data message's \c sport field's current value.
 *
 * \return the \c sport field value.
 */
Sport WorkoutMessage::sport() const
{
    Q_D(const WorkoutMessage);
    return d->sport;
}
 
/*!
 * Returns the WorkoutMessage data message's \c capabilities field's current value.
 *
 * \return the \c capabilities field value.
 */
WorkoutCapabilities WorkoutMessage::capabilities() const
{
    Q_D(const WorkoutMessage);
    return d->capabilities;
}
 
/*!
 * Returns the WorkoutMessage data message's \c numValidSteps field's current value.
 *
 * number of valid steps
 *
 * \return the \c numValidSteps field value.
 */
quint16 WorkoutMessage::numValidSteps() const
{
    Q_D(const WorkoutMessage);
    return d->numValidSteps;
}
 
/*!
 * Returns the WorkoutMessage data message's \c wktName field's current value.
 *
 * \return the \c wktName field value.
 */
QString WorkoutMessage::wktName() const
{
    Q_D(const WorkoutMessage);
    return d->wktName;
}
 
/*!
 * Returns the WorkoutMessage data message's \c subSport field's current value.
 *
 * \return the \c subSport field value.
 */
SubSport WorkoutMessage::subSport() const
{
    Q_D(const WorkoutMessage);
    return d->subSport;
}
 
/*!
 * Returns the WorkoutMessage data message's \c poolLength field's current value.
 *
 * \return the \c poolLength field value.
 */
quint16 WorkoutMessage::poolLength() const
{
    Q_D(const WorkoutMessage);
    return d->poolLength;
}
 
/*!
 * Returns the WorkoutMessage data message's \c poolLengthUnit field's current value.
 *
 * \return the \c poolLengthUnit field value.
 */
DisplayMeasure WorkoutMessage::poolLengthUnit() const
{
    Q_D(const WorkoutMessage);
    return d->poolLengthUnit;
}
 
/*!
 * Sets the \c sport field to \a sport.
 *
 * \param sport The field value to set.
 */
void WorkoutMessage::setSport(const Sport sport)
{
    Q_D(WorkoutMessage);
    d->sport = sport;
}
/*!
 * Sets the \c capabilities field to \a capabilities.
 *
 * \param capabilities The field value to set.
 */
void WorkoutMessage::setCapabilities(const WorkoutCapabilities capabilities)
{
    Q_D(WorkoutMessage);
    d->capabilities = capabilities;
}
/*!
 * Sets the \c numValidSteps field to \a numValidSteps.
 *
 * \param numValidSteps The field value to set.
 */
void WorkoutMessage::setNumValidSteps(const quint16 numValidSteps)
{
    Q_D(WorkoutMessage);
    d->numValidSteps = numValidSteps;
}
/*!
 * Sets the \c wktName field to \a wktName.
 *
 * \param wktName The field value to set.
 */
void WorkoutMessage::setWktName(const QString wktName)
{
    Q_D(WorkoutMessage);
    d->wktName = wktName;
}
/*!
 * Sets the \c subSport field to \a subSport.
 *
 * \param subSport The field value to set.
 */
void WorkoutMessage::setSubSport(const SubSport subSport)
{
    Q_D(WorkoutMessage);
    d->subSport = subSport;
}
/*!
 * Sets the \c poolLength field to \a poolLength.
 *
 * \param poolLength The field value to set.
 */
void WorkoutMessage::setPoolLength(const quint16 poolLength)
{
    Q_D(WorkoutMessage);
    d->poolLength = poolLength;
}
/*!
 * Sets the \c poolLengthUnit field to \a poolLengthUnit.
 *
 * \param poolLengthUnit The field value to set.
 */
void WorkoutMessage::setPoolLengthUnit(const DisplayMeasure poolLengthUnit)
{
    Q_D(WorkoutMessage);
    d->poolLengthUnit = poolLengthUnit;
}
 
/// \cond internal
 
/*!
 * \internal
 *
 * \class WorkoutMessagePrivate
 *
 * The WorkoutMessagePrivate class provides private implementation for the WorkoutMessage.
 *
 * \sa WorkoutMessage
 */
 
/*!
 * \internal
 *
 * Constructs a WorkoutMessagePrivate object with public implementation \a q.
 *
 * \param q Pointer to public implementaton.
 */
WorkoutMessagePrivate::WorkoutMessagePrivate(WorkoutMessage * const q)
  : AbstractDataMessagePrivate(q)
  , sport(static_cast<Sport>(-1))
  , capabilities(static_cast<WorkoutCapabilities>(-1))
  , numValidSteps(0xFFFF)
  , subSport(static_cast<SubSport>(-1))
  , poolLength(0xFFFF)
  , poolLengthUnit(static_cast<DisplayMeasure>(-1))
{
    globalMessageNumber = MesgNum::Workout;
}
 
/*!
 * \internal
 *
 * Destroys the WorkoutMessagePrivate object.
 */
WorkoutMessagePrivate::~WorkoutMessagePrivate()
{
 
}
 
bool WorkoutMessagePrivate::setField(
    const int fieldId, const QByteArray &data, const FitBaseType baseType, const bool bigEndian)
{
    switch (fieldId) {
    case 4: // See Profile.xlsx::Messages:workout.sport
        if (!verify(data, baseType, 1, FitBaseType::Enum, "workout.sport")) return false;
        this->sport = static_cast<Sport>(data.at(0));
        break;
    case 5: // See Profile.xlsx::Messages:workout.capabilities
        if (!verify(data, baseType, 4, FitBaseType::Uint32z, "workout.capabilities")) return false;
        this->capabilities = static_cast<WorkoutCapabilities>(bigEndian ? qFromBigEndian<quint32>(data) : qFromLittleEndian<quint32>(data));
        break;
    case 6: // See Profile.xlsx::Messages:workout.numValidSteps
        if (!verify(data, baseType, 2, FitBaseType::Uint16, "workout.numValidSteps")) return false;
        this->numValidSteps = static_cast<quint16>(bigEndian ? qFromBigEndian<quint16>(data) : qFromLittleEndian<quint16>(data));
        break;
    case 8: // See Profile.xlsx::Messages:workout.wktName
        if (!verify(data, baseType, 1, FitBaseType::String, "workout.wktName")) return false;
        this->wktName = QString::fromUtf8(data);
        break;
    case 11: // See Profile.xlsx::Messages:workout.subSport
        if (!verify(data, baseType, 1, FitBaseType::Enum, "workout.subSport")) return false;
        this->subSport = static_cast<SubSport>(data.at(0));
        break;
    case 14: // See Profile.xlsx::Messages:workout.poolLength
        if (!verify(data, baseType, 2, FitBaseType::Uint16, "workout.poolLength")) return false;
        this->poolLength = static_cast<quint16>(bigEndian ? qFromBigEndian<quint16>(data) : qFromLittleEndian<quint16>(data));
        break;
    case 15: // See Profile.xlsx::Messages:workout.poolLengthUnit
        if (!verify(data, baseType, 1, FitBaseType::Enum, "workout.poolLengthUnit")) return false;
        this->poolLengthUnit = static_cast<DisplayMeasure>(data.at(0));
        break;
    default:
        qWarning() << "ignoring unknown workout message field number" << fieldId << bigEndian;
        // Fall through to return true, as its still 'safe' to continue parsing data messages.
    }
    return true;
}
 
/// \endcond
 
QTFIT_END_NAMESPACE