fieldcapabilitiesmessage.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 FieldCapabilitiesMessage, and FieldCapabilitiesMessagePrivate classes.
 */
 
#include "fieldcapabilitiesmessage.h"
#include "fieldcapabilitiesmessage_p.h"
 
#include <QDebug>
#include <QtEndian>
 
QTFIT_BEGIN_NAMESPACE
 
/*!
 * \class FieldCapabilitiesMessage
 *
 * The FieldCapabilitiesMessage class represents a FIT FieldCapabilitiesMessage data message.
 *
 * \sa DataMessage
 */
 
/*!
 * Constructs a FieldCapabilitiesMessage 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.
 */
FieldCapabilitiesMessage::FieldCapabilitiesMessage() : AbstractDataMessage(new FieldCapabilitiesMessagePrivate(this))
{
 
}
 
/*!
 * \internal
 *
 * Constructs a FieldCapabilitiesMessage object with private implementation \a d.
 *
 * \param d Pointer to private implementation.
 */
FieldCapabilitiesMessage::FieldCapabilitiesMessage(FieldCapabilitiesMessagePrivate * const d) : AbstractDataMessage(d)
{
 
}
 
/*!
 * Returns the FieldCapabilitiesMessage data message's \c messageIndex field's current value.
 *
 * \return the \c messageIndex field value.
 */
MessageIndex FieldCapabilitiesMessage::messageIndex() const
{
    Q_D(const FieldCapabilitiesMessage);
    return d->messageIndex;
}
 
/*!
 * Returns the FieldCapabilitiesMessage data message's \c file field's current value.
 *
 * \return the \c file field value.
 */
File FieldCapabilitiesMessage::file() const
{
    Q_D(const FieldCapabilitiesMessage);
    return d->file;
}
 
/*!
 * Returns the FieldCapabilitiesMessage data message's \c mesgNum field's current value.
 *
 * \return the \c mesgNum field value.
 */
MesgNum FieldCapabilitiesMessage::mesgNum() const
{
    Q_D(const FieldCapabilitiesMessage);
    return d->mesgNum;
}
 
/*!
 * Returns the FieldCapabilitiesMessage data message's \c fieldNum field's current value.
 *
 * \return the \c fieldNum field value.
 */
quint8 FieldCapabilitiesMessage::fieldNum() const
{
    Q_D(const FieldCapabilitiesMessage);
    return d->fieldNum;
}
 
/*!
 * Returns the FieldCapabilitiesMessage data message's \c count field's current value.
 *
 * \return the \c count field value.
 */
quint16 FieldCapabilitiesMessage::count() const
{
    Q_D(const FieldCapabilitiesMessage);
    return d->count;
}
 
/*!
 * Sets the \c messageIndex field to \a messageIndex.
 *
 * \param messageIndex The field value to set.
 */
void FieldCapabilitiesMessage::setMessageIndex(const MessageIndex messageIndex)
{
    Q_D(FieldCapabilitiesMessage);
    d->messageIndex = messageIndex;
}
/*!
 * Sets the \c file field to \a file.
 *
 * \param file The field value to set.
 */
void FieldCapabilitiesMessage::setFile(const File file)
{
    Q_D(FieldCapabilitiesMessage);
    d->file = file;
}
/*!
 * Sets the \c mesgNum field to \a mesgNum.
 *
 * \param mesgNum The field value to set.
 */
void FieldCapabilitiesMessage::setMesgNum(const MesgNum mesgNum)
{
    Q_D(FieldCapabilitiesMessage);
    d->mesgNum = mesgNum;
}
/*!
 * Sets the \c fieldNum field to \a fieldNum.
 *
 * \param fieldNum The field value to set.
 */
void FieldCapabilitiesMessage::setFieldNum(const quint8 fieldNum)
{
    Q_D(FieldCapabilitiesMessage);
    d->fieldNum = fieldNum;
}
/*!
 * Sets the \c count field to \a count.
 *
 * \param count The field value to set.
 */
void FieldCapabilitiesMessage::setCount(const quint16 count)
{
    Q_D(FieldCapabilitiesMessage);
    d->count = count;
}
 
/// \cond internal
 
/*!
 * \internal
 *
 * \class FieldCapabilitiesMessagePrivate
 *
 * The FieldCapabilitiesMessagePrivate class provides private implementation for the FieldCapabilitiesMessage.
 *
 * \sa FieldCapabilitiesMessage
 */
 
/*!
 * \internal
 *
 * Constructs a FieldCapabilitiesMessagePrivate object with public implementation \a q.
 *
 * \param q Pointer to public implementaton.
 */
FieldCapabilitiesMessagePrivate::FieldCapabilitiesMessagePrivate(FieldCapabilitiesMessage * const q)
  : AbstractDataMessagePrivate(q)
  , messageIndex(static_cast<MessageIndex>(-1))
  , file(static_cast<File>(-1))
  , mesgNum(static_cast<MesgNum>(-1))
  , fieldNum(0xFF)
  , count(0xFFFF)
{
    globalMessageNumber = MesgNum::FieldCapabilities;
}
 
/*!
 * \internal
 *
 * Destroys the FieldCapabilitiesMessagePrivate object.
 */
FieldCapabilitiesMessagePrivate::~FieldCapabilitiesMessagePrivate()
{
 
}
 
bool FieldCapabilitiesMessagePrivate::setField(
    const int fieldId, const QByteArray &data, const FitBaseType baseType, const bool bigEndian)
{
    switch (fieldId) {
    case 254: // See Profile.xlsx::Messages:field_capabilities.messageIndex
        if (!verify(data, baseType, 2, FitBaseType::Uint16, "field_capabilities.messageIndex")) return false;
        this->messageIndex = static_cast<MessageIndex>(bigEndian ? qFromBigEndian<quint16>(data) : qFromLittleEndian<quint16>(data));
        break;
    case 0: // See Profile.xlsx::Messages:field_capabilities.file
        if (!verify(data, baseType, 1, FitBaseType::Enum, "field_capabilities.file")) return false;
        this->file = static_cast<File>(data.at(0));
        break;
    case 1: // See Profile.xlsx::Messages:field_capabilities.mesgNum
        if (!verify(data, baseType, 2, FitBaseType::Uint16, "field_capabilities.mesgNum")) return false;
        this->mesgNum = static_cast<MesgNum>(bigEndian ? qFromBigEndian<quint16>(data) : qFromLittleEndian<quint16>(data));
        break;
    case 2: // See Profile.xlsx::Messages:field_capabilities.fieldNum
        if (!verify(data, baseType, 1, FitBaseType::Uint8, "field_capabilities.fieldNum")) return false;
        this->fieldNum = static_cast<quint8>(data.at(0));
        break;
    case 3: // See Profile.xlsx::Messages:field_capabilities.count
        if (!verify(data, baseType, 2, FitBaseType::Uint16, "field_capabilities.count")) return false;
        this->count = static_cast<quint16>(bigEndian ? qFromBigEndian<quint16>(data) : qFromLittleEndian<quint16>(data));
        break;
    default:
        qWarning() << "ignoring unknown field_capabilities 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