The MagnetometerDataMessage class represents a FIT MagnetometerDataMessage data message. More...

Inheritance diagram for MagnetometerDataMessage:

Collaboration diagram for MagnetometerDataMessage:

Public Member Functions
	MagnetometerDataMessage ()
	Constructs a MagnetometerDataMessage object. More...

DateTime	timestamp () const
	Returns the MagnetometerDataMessage data message's `timestamp` field's current value. More...

quint16	timestampMs () const
	Returns the MagnetometerDataMessage data message's `timestampMs` field's current value. More...

quint16	sampleTimeOffset () const
	Returns the MagnetometerDataMessage data message's `sampleTimeOffset` field's current value. More...

quint16	magX () const
	Returns the MagnetometerDataMessage data message's `magX` field's current value. More...

quint16	magY () const
	Returns the MagnetometerDataMessage data message's `magY` field's current value. More...

quint16	magZ () const
	Returns the MagnetometerDataMessage data message's `magZ` field's current value. More...

float	calibratedMagX () const
	Returns the MagnetometerDataMessage data message's `calibratedMagX` field's current value. More...

float	calibratedMagY () const
	Returns the MagnetometerDataMessage data message's `calibratedMagY` field's current value. More...

float	calibratedMagZ () const
	Returns the MagnetometerDataMessage data message's `calibratedMagZ` field's current value. More...

void	setTimestamp (const DateTime timestamp)
	Sets the `timestamp` field to timestamp. More...

void	setTimestampMs (const quint16 timestampMs)
	Sets the `timestampMs` field to timestampMs. More...

void	setSampleTimeOffset (const quint16 sampleTimeOffset)
	Sets the `sampleTimeOffset` field to sampleTimeOffset. More...

void	setMagX (const quint16 magX)
	Sets the `magX` field to magX. More...

void	setMagY (const quint16 magY)
	Sets the `magY` field to magY. More...

void	setMagZ (const quint16 magZ)
	Sets the `magZ` field to magZ. More...

void	setCalibratedMagX (const float calibratedMagX)
	Sets the `calibratedMagX` field to calibratedMagX. More...

void	setCalibratedMagY (const float calibratedMagY)
	Sets the `calibratedMagY` field to calibratedMagY. More...

void	setCalibratedMagZ (const float calibratedMagZ)
	Sets the `calibratedMagZ` field to calibratedMagZ. More...

Public Member Functions inherited from AbstractDataMessage
	~AbstractDataMessage ()
	Destroys the AbstractDataMessage object.

MesgNum	globalMessageNumber () const
	Returns the data message's global message number. More...

Additional Inherited Members
Static Public Member Functions inherited from AbstractDataMessage
static AbstractDataMessage *	fromData (const DataDefinition *const defn, const QByteArray &record)
	Constructs the relevant AbstractDataMessage-derived class to parse record according to defn. More...

Detailed Description

The MagnetometerDataMessage class represents a FIT MagnetometerDataMessage data message.

See also: DataMessage

Constructor & Destructor Documentation

◆ MagnetometerDataMessage()

MagnetometerDataMessage::MagnetometerDataMessage ( )

Constructs a MagnetometerDataMessage 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.

Member Function Documentation

◆ calibratedMagX()

float MagnetometerDataMessage::calibratedMagX ( ) const

Returns the MagnetometerDataMessage data message's calibratedMagX field's current value.

Calibrated Magnetometer reading

Returns: the calibratedMagX field value.

Here is the caller graph for this function:

◆ calibratedMagY()

float MagnetometerDataMessage::calibratedMagY ( ) const

Returns the MagnetometerDataMessage data message's calibratedMagY field's current value.

Calibrated Magnetometer reading

Returns: the calibratedMagY field value.

Here is the caller graph for this function:

◆ calibratedMagZ()

float MagnetometerDataMessage::calibratedMagZ ( ) const

Returns the MagnetometerDataMessage data message's calibratedMagZ field's current value.

Calibrated Magnetometer reading

Returns: the calibratedMagZ field value.

Here is the caller graph for this function:

◆ magX()

quint16 MagnetometerDataMessage::magX ( ) const

Returns the MagnetometerDataMessage data message's magX field's current value.

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.

Returns: the magX field value.

Here is the caller graph for this function:

◆ magY()

quint16 MagnetometerDataMessage::magY ( ) const

Returns the MagnetometerDataMessage data message's magY field's current value.

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.

Returns: the magY field value.

Here is the caller graph for this function:

◆ magZ()

quint16 MagnetometerDataMessage::magZ ( ) const

Returns the MagnetometerDataMessage data message's magZ field's current value.

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.

Returns: the magZ field value.

Here is the caller graph for this function:

◆ sampleTimeOffset()

quint16 MagnetometerDataMessage::sampleTimeOffset ( ) const

Returns the MagnetometerDataMessage data message's sampleTimeOffset field's current value.

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

Returns: the sampleTimeOffset field value.

Here is the caller graph for this function:

◆ setCalibratedMagX()

void MagnetometerDataMessage::setCalibratedMagX ( const float calibratedMagX )

Sets the calibratedMagX field to calibratedMagX.

Parameters

calibratedMagX The field value to set.

Here is the call graph for this function:

◆ setCalibratedMagY()

void MagnetometerDataMessage::setCalibratedMagY ( const float calibratedMagY )

Sets the calibratedMagY field to calibratedMagY.

Parameters

calibratedMagY The field value to set.

Here is the call graph for this function:

◆ setCalibratedMagZ()

void MagnetometerDataMessage::setCalibratedMagZ ( const float calibratedMagZ )

Sets the calibratedMagZ field to calibratedMagZ.

Parameters

calibratedMagZ The field value to set.

Here is the call graph for this function:

◆ setMagX()

void MagnetometerDataMessage::setMagX ( const quint16 magX )

Sets the magX field to magX.

Parameters

magX	The field value to set.

Here is the call graph for this function:

◆ setMagY()

void MagnetometerDataMessage::setMagY ( const quint16 magY )

Sets the magY field to magY.

Parameters

magY	The field value to set.

Here is the call graph for this function:

◆ setMagZ()

void MagnetometerDataMessage::setMagZ ( const quint16 magZ )

Sets the magZ field to magZ.

Parameters

magZ	The field value to set.

Here is the call graph for this function:

◆ setSampleTimeOffset()

void MagnetometerDataMessage::setSampleTimeOffset ( const quint16 sampleTimeOffset )

Sets the sampleTimeOffset field to sampleTimeOffset.

Parameters

sampleTimeOffset The field value to set.

Here is the call graph for this function:

◆ setTimestamp()

void MagnetometerDataMessage::setTimestamp ( const DateTime timestamp )

Sets the timestamp field to timestamp.

Parameters

timestamp The field value to set.

Here is the call graph for this function:

◆ setTimestampMs()

void MagnetometerDataMessage::setTimestampMs ( const quint16 timestampMs )

Sets the timestampMs field to timestampMs.

Parameters

timestampMs The field value to set.

Here is the call graph for this function:

◆ timestamp()

DateTime MagnetometerDataMessage::timestamp ( ) const

Returns the MagnetometerDataMessage data message's timestamp field's current value.

Whole second part of the timestamp

Returns: the timestamp field value.

Here is the caller graph for this function:

◆ timestampMs()

quint16 MagnetometerDataMessage::timestampMs ( ) const

Returns the MagnetometerDataMessage data message's timestampMs field's current value.

Millisecond part of the timestamp.

Returns: the timestampMs field value.

Here is the caller graph for this function:

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MagnetometerDataMessage()

Member Function Documentation

◆ calibratedMagX()

◆ calibratedMagY()

◆ calibratedMagZ()

◆ magX()

◆ magY()

◆ magZ()

◆ sampleTimeOffset()

◆ setCalibratedMagX()

◆ setCalibratedMagY()

◆ setCalibratedMagZ()

◆ setMagX()

◆ setMagY()

◆ setMagZ()

◆ setSampleTimeOffset()

◆ setTimestamp()

◆ setTimestampMs()

◆ timestamp()

◆ timestampMs()