Inheritance diagram for MagnetometerDataMessagePrivate:

Collaboration diagram for MagnetometerDataMessagePrivate:

Public Member Functions
	MagnetometerDataMessagePrivate (MagnetometerDataMessage *const q)

virtual	~MagnetometerDataMessagePrivate ()

Public Member Functions inherited from AbstractDataMessagePrivate
	AbstractDataMessagePrivate (AbstractDataMessage *const q)

virtual	~AbstractDataMessagePrivate ()

bool	setFields (const DataDefinition *const defn, const QByteArray &record)

Public Attributes
DateTime	timestamp
	The MagnetometerDataMessage FIT message's timestamp field. More...

quint16	timestampMs
	The MagnetometerDataMessage FIT message's timestampMs field. More...

quint16	sampleTimeOffset
	The MagnetometerDataMessage FIT message's sampleTimeOffset field. More...

quint16	magX
	The MagnetometerDataMessage FIT message's magX field. More...

quint16	magY
	The MagnetometerDataMessage FIT message's magY field. More...

quint16	magZ
	The MagnetometerDataMessage FIT message's magZ field. More...

float	calibratedMagX
	The MagnetometerDataMessage FIT message's calibratedMagX field. More...

float	calibratedMagY
	The MagnetometerDataMessage FIT message's calibratedMagY field. More...

float	calibratedMagZ
	The MagnetometerDataMessage FIT message's calibratedMagZ field. More...

Public Attributes inherited from AbstractDataMessagePrivate
MesgNum	globalMessageNumber
	FIT Globla Message Number for this FIT Data Message.

Protected Member Functions
bool	setField (const int fieldId, const QByteArray &data, const FitBaseType baseType, const bool bigEndian) override

Protected Member Functions inherited from AbstractDataMessagePrivate
bool	verify (const QByteArray &data, const FitBaseType actualType, const int expectedSize, const FitBaseType expectedType, const char *messageFieldName)

Additional Inherited Members
Protected Attributes inherited from AbstractDataMessagePrivate
AbstractDataMessage *const	q_ptr
	Internal q-pointer.

Detailed Description

The MagnetometerDataMessagePrivate class provides private implementation for the MagnetometerDataMessage.

See also: MagnetometerDataMessage

Definition at line 38 of file magnetometerdatamessage_p.h.

Constructor & Destructor Documentation

◆ MagnetometerDataMessagePrivate()

MagnetometerDataMessagePrivate::MagnetometerDataMessagePrivate ( MagnetometerDataMessage *const q )

explicit

Constructs a MagnetometerDataMessagePrivate object with public implementation q.

Parameters

q	Pointer to public implementaton.

Definition at line 301 of file magnetometerdatamessage.cpp.

   : AbstractDataMessagePrivate(q)
   , timestamp(static_cast<DateTime>(-1))
   , timestampMs(0xFFFF)
   , sampleTimeOffset(0xFFFF)
   , magX(0xFFFF)
   , magY(0xFFFF)
   , magZ(0xFFFF)
   , calibratedMagX(static_cast<float>(-1))
   , calibratedMagY(static_cast<float>(-1))
   , calibratedMagZ(static_cast<float>(-1))
 {
     globalMessageNumber = MesgNum::MagnetometerData;
 }

References AbstractDataMessagePrivate::globalMessageNumber.

◆ ~MagnetometerDataMessagePrivate()

MagnetometerDataMessagePrivate::~MagnetometerDataMessagePrivate ( )

virtual

Destroys the MagnetometerDataMessagePrivate object.

Definition at line 321 of file magnetometerdatamessage.cpp.

 {
  
 }

Member Function Documentation

◆ setField()

bool MagnetometerDataMessagePrivate::setField	(	const int	fieldId,
		const QByteArray &	data,
		const FitBaseType	baseType,
		const bool	bigEndian
	)

overrideprotectedvirtual

Sets the value of the fieldId field.

Derived classes must implement this method to extract the baseType value from data, and assign the extracted value the fieldId field.

Parameters

fieldId	The field number within the given FIT data message.
data	The raw data to extract the field value from.
baseType	The FIT base type for the field.
bigEndian	Whether or not multibyte values in record are big-endian.

Returns: true if the field was set, or safely ignored; false otherwise.

Implements AbstractDataMessagePrivate.

Definition at line 326 of file magnetometerdatamessage.cpp.

 {
     switch (fieldId) {
     case 253: // See Profile.xlsx::Messages:magnetometer_data.timestamp
         if (!verify(data, baseType, 4, FitBaseType::Uint32, "magnetometer_data.timestamp")) return false;
         this->timestamp = static_cast<DateTime>(bigEndian ? qFromBigEndian<quint32>(data) : qFromLittleEndian<quint32>(data));
         break;
     case 0: // See Profile.xlsx::Messages:magnetometer_data.timestampMs
         if (!verify(data, baseType, 2, FitBaseType::Uint16, "magnetometer_data.timestampMs")) return false;
         this->timestampMs = static_cast<quint16>(bigEndian ? qFromBigEndian<quint16>(data) : qFromLittleEndian<quint16>(data));
         break;
     case 1: // See Profile.xlsx::Messages:magnetometer_data.sampleTimeOffset
         if (!verify(data, baseType, 2, FitBaseType::Uint16, "magnetometer_data.sampleTimeOffset")) return false;
         this->sampleTimeOffset = static_cast<quint16>(bigEndian ? qFromBigEndian<quint16>(data) : qFromLittleEndian<quint16>(data));
         break;
     case 2: // See Profile.xlsx::Messages:magnetometer_data.magX
         if (!verify(data, baseType, 2, FitBaseType::Uint16, "magnetometer_data.magX")) return false;
         this->magX = static_cast<quint16>(bigEndian ? qFromBigEndian<quint16>(data) : qFromLittleEndian<quint16>(data));
         break;
     case 3: // See Profile.xlsx::Messages:magnetometer_data.magY
         if (!verify(data, baseType, 2, FitBaseType::Uint16, "magnetometer_data.magY")) return false;
         this->magY = static_cast<quint16>(bigEndian ? qFromBigEndian<quint16>(data) : qFromLittleEndian<quint16>(data));
         break;
     case 4: // See Profile.xlsx::Messages:magnetometer_data.magZ
         if (!verify(data, baseType, 2, FitBaseType::Uint16, "magnetometer_data.magZ")) return false;
         this->magZ = static_cast<quint16>(bigEndian ? qFromBigEndian<quint16>(data) : qFromLittleEndian<quint16>(data));
         break;
     case 5: // See Profile.xlsx::Messages:magnetometer_data.calibratedMagX
         if (!verify(data, baseType, 4, FitBaseType::Float32, "magnetometer_data.calibratedMagX")) return false;
         #if QT_VERSION < QT_VERSION_CHECK(5, 12, 0)
         {   // Qt's from-endian functions have no float/double specialisations prior to Qt 5.12.
             const quint32 localEndian = bigEndian ? qFromBigEndian<quint32>(data) : qFromLittleEndian<quint32>(data);
             static_assert(sizeof(localEndian) == 4, "src not expected size");
             static_assert(sizeof(this->calibratedMagX) == 4, "src and dst not the same size");
             memcpy(&this->calibratedMagX, &localEndian, data.size());
         }
         #else
         this->calibratedMagX = static_cast<float>(bigEndian ? qFromBigEndian<float>(data) : qFromLittleEndian<float>(data));
         #endif
         break;
     case 6: // See Profile.xlsx::Messages:magnetometer_data.calibratedMagY
         if (!verify(data, baseType, 4, FitBaseType::Float32, "magnetometer_data.calibratedMagY")) return false;
         #if QT_VERSION < QT_VERSION_CHECK(5, 12, 0)
         {   // Qt's from-endian functions have no float/double specialisations prior to Qt 5.12.
             const quint32 localEndian = bigEndian ? qFromBigEndian<quint32>(data) : qFromLittleEndian<quint32>(data);
             static_assert(sizeof(localEndian) == 4, "src not expected size");
             static_assert(sizeof(this->calibratedMagY) == 4, "src and dst not the same size");
             memcpy(&this->calibratedMagY, &localEndian, data.size());
         }
         #else
         this->calibratedMagY = static_cast<float>(bigEndian ? qFromBigEndian<float>(data) : qFromLittleEndian<float>(data));
         #endif
         break;
     case 7: // See Profile.xlsx::Messages:magnetometer_data.calibratedMagZ
         if (!verify(data, baseType, 4, FitBaseType::Float32, "magnetometer_data.calibratedMagZ")) return false;
         #if QT_VERSION < QT_VERSION_CHECK(5, 12, 0)
         {   // Qt's from-endian functions have no float/double specialisations prior to Qt 5.12.
             const quint32 localEndian = bigEndian ? qFromBigEndian<quint32>(data) : qFromLittleEndian<quint32>(data);
             static_assert(sizeof(localEndian) == 4, "src not expected size");
             static_assert(sizeof(this->calibratedMagZ) == 4, "src and dst not the same size");
             memcpy(&this->calibratedMagZ, &localEndian, data.size());
         }
         #else
         this->calibratedMagZ = static_cast<float>(bigEndian ? qFromBigEndian<float>(data) : qFromLittleEndian<float>(data));
         #endif
         break;
     default:
         qWarning() << "ignoring unknown magnetometer_data message field number" << fieldId << bigEndian;
         // Fall through to return true, as its still 'safe' to continue parsing data messages.
     }
     return true;
 }

References AbstractDataMessagePrivate::verify().

Here is the call graph for this function:

Member Data Documentation

◆ calibratedMagX

float MagnetometerDataMessagePrivate::calibratedMagX

The MagnetometerDataMessage FIT message's calibratedMagX field.

Calibrated Magnetometer reading

Definition at line 93 of file magnetometerdatamessage_p.h.

◆ calibratedMagY

float MagnetometerDataMessagePrivate::calibratedMagY

The MagnetometerDataMessage FIT message's calibratedMagY field.

Calibrated Magnetometer reading

Definition at line 100 of file magnetometerdatamessage_p.h.

◆ calibratedMagZ

float MagnetometerDataMessagePrivate::calibratedMagZ

The MagnetometerDataMessage FIT message's calibratedMagZ field.

Calibrated Magnetometer reading

Definition at line 107 of file magnetometerdatamessage_p.h.

◆ magX

quint16 MagnetometerDataMessagePrivate::magX

The MagnetometerDataMessage FIT message's magX field.

These are the raw ADC reading. Maximum number of samples is 30 in each message. The samples may span across seconds. A conversion will need to be done on this data once read.

Definition at line 70 of file magnetometerdatamessage_p.h.

◆ magY

quint16 MagnetometerDataMessagePrivate::magY

The MagnetometerDataMessage FIT message's magY field.

These are the raw ADC reading. Maximum number of samples is 30 in each message. The samples may span across seconds. A conversion will need to be done on this data once read.

Definition at line 78 of file magnetometerdatamessage_p.h.

◆ magZ

quint16 MagnetometerDataMessagePrivate::magZ

The MagnetometerDataMessage FIT message's magZ field.

These are the raw ADC reading. Maximum number of samples is 30 in each message. The samples may span across seconds. A conversion will need to be done on this data once read.

Definition at line 86 of file magnetometerdatamessage_p.h.

◆ sampleTimeOffset

quint16 MagnetometerDataMessagePrivate::sampleTimeOffset

The MagnetometerDataMessage FIT message's sampleTimeOffset field.

Each time in the array describes the time at which the compass sample with the corrosponding index was taken. Limited to 30 samples in each message. The samples may span across seconds. Array size must match the number of samples in cmps_x and cmps_y and cmps_z

Definition at line 62 of file magnetometerdatamessage_p.h.

◆ timestamp

DateTime MagnetometerDataMessagePrivate::timestamp

The MagnetometerDataMessage FIT message's timestamp field.

Whole second part of the timestamp

Definition at line 46 of file magnetometerdatamessage_p.h.

◆ timestampMs

quint16 MagnetometerDataMessagePrivate::timestampMs

The MagnetometerDataMessage FIT message's timestampMs field.

Millisecond part of the timestamp.

Definition at line 53 of file magnetometerdatamessage_p.h.

The documentation for this class was generated from the following files:

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MagnetometerDataMessagePrivate()

◆ ~MagnetometerDataMessagePrivate()

Member Function Documentation

◆ setField()

Member Data Documentation

◆ calibratedMagX

◆ calibratedMagY

◆ calibratedMagZ

◆ magX

◆ magY

◆ magZ

◆ sampleTimeOffset

◆ timestamp

◆ timestampMs