GpsMetadataMessage Class Reference

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

Inheritance diagram for GpsMetadataMessage:

Collaboration diagram for GpsMetadataMessage:

Public Member Functions
	GpsMetadataMessage ()
	Constructs a GpsMetadataMessage object. More...
DateTime	timestamp () const
	Returns the GpsMetadataMessage data message's timestamp field's current value. More...
quint16	timestampMs () const
	Returns the GpsMetadataMessage data message's timestampMs field's current value. More...
qint32	positionLat () const
	Returns the GpsMetadataMessage data message's positionLat field's current value. More...
qint32	positionLong () const
	Returns the GpsMetadataMessage data message's positionLong field's current value. More...
quint32	enhancedAltitude () const
	Returns the GpsMetadataMessage data message's enhancedAltitude field's current value. More...
quint32	enhancedSpeed () const
	Returns the GpsMetadataMessage data message's enhancedSpeed field's current value. More...
quint16	heading () const
	Returns the GpsMetadataMessage data message's heading field's current value. More...
DateTime	utcTimestamp () const
	Returns the GpsMetadataMessage data message's utcTimestamp field's current value. More...
qint16	velocity () const
	Returns the GpsMetadataMessage data message's velocity 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	setPositionLat (const qint32 positionLat)
	Sets the positionLat field to positionLat. More...
void	setPositionLong (const qint32 positionLong)
	Sets the positionLong field to positionLong. More...
void	setEnhancedAltitude (const quint32 enhancedAltitude)
	Sets the enhancedAltitude field to enhancedAltitude. More...
void	setEnhancedSpeed (const quint32 enhancedSpeed)
	Sets the enhancedSpeed field to enhancedSpeed. More...
void	setHeading (const quint16 heading)
	Sets the heading field to heading. More...
void	setUtcTimestamp (const DateTime utcTimestamp)
	Sets the utcTimestamp field to utcTimestamp. More...
void	setVelocity (const qint16 velocity)
	Sets the velocity field to velocity. More...
Public Member Functions inherited from AbstractDataMessage
	~AbstractDataMessage ()
	Destroys the AbstractDataMessage object.
MesgNum	globalMessageNumber () const
	Returns the data message's global message number. More...

Protected Member Functions
	GpsMetadataMessage (GpsMetadataMessagePrivate *const d)
Protected Member Functions inherited from AbstractDataMessage
	AbstractDataMessage (AbstractDataMessagePrivate *const d)

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...
Protected Attributes inherited from AbstractDataMessage
AbstractDataMessagePrivate *const	d_ptr
	Internal d-pointer.

Detailed Description

The GpsMetadataMessage class represents a FIT GpsMetadataMessage data message.

See also

DataMessage

Definition at line 39 of file gpsmetadatamessage.h.

Constructor & Destructor Documentation

GpsMetadataMessage() [1/2]

GpsMetadataMessage::GpsMetadataMessage

(

)

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

Definition at line 52 of file gpsmetadatamessage.cpp.

                                       : AbstractDataMessage(new GpsMetadataMessagePrivate(this))
{
 
}

GpsMetadataMessage() [2/2]

GpsMetadataMessage::GpsMetadataMessage ( GpsMetadataMessagePrivate *const  d )

explicitprotected

Constructs a GpsMetadataMessage object with private implementation d.

Parameters

d	Pointer to private implementation.

Definition at line 64 of file gpsmetadatamessage.cpp.

                                                                          : AbstractDataMessage(d)
{
 
}

Member Function Documentation

enhancedAltitude()

quint32 GpsMetadataMessage::enhancedAltitude

(

)

const

Returns the GpsMetadataMessage data message's enhancedAltitude field's current value.

Returns

the enhancedAltitude field value.

Definition at line 122 of file gpsmetadatamessage.cpp.

{
    Q_D(const GpsMetadataMessage);
    return d->enhancedAltitude;
}

Referenced by setEnhancedAltitude().

Here is the caller graph for this function:

enhancedSpeed()

quint32 GpsMetadataMessage::enhancedSpeed

(

)

const

Returns the GpsMetadataMessage data message's enhancedSpeed field's current value.

Returns

the enhancedSpeed field value.

Definition at line 133 of file gpsmetadatamessage.cpp.

{
    Q_D(const GpsMetadataMessage);
    return d->enhancedSpeed;
}

Referenced by setEnhancedSpeed().

Here is the caller graph for this function:

heading()

quint16 GpsMetadataMessage::heading

(

)

const

Returns the GpsMetadataMessage data message's heading field's current value.

Returns

the heading field value.

Definition at line 144 of file gpsmetadatamessage.cpp.

{
    Q_D(const GpsMetadataMessage);
    return d->heading;
}

Referenced by setHeading().

Here is the caller graph for this function:

positionLat()

qint32 GpsMetadataMessage::positionLat

(

)

const

Returns the GpsMetadataMessage data message's positionLat field's current value.

Returns

the positionLat field value.

Definition at line 100 of file gpsmetadatamessage.cpp.

{
    Q_D(const GpsMetadataMessage);
    return d->positionLat;
}

Referenced by setPositionLat().

Here is the caller graph for this function:

positionLong()

qint32 GpsMetadataMessage::positionLong

(

)

const

Returns the GpsMetadataMessage data message's positionLong field's current value.

Returns

the positionLong field value.

Definition at line 111 of file gpsmetadatamessage.cpp.

{
    Q_D(const GpsMetadataMessage);
    return d->positionLong;
}

Referenced by setPositionLong().

Here is the caller graph for this function:

setEnhancedAltitude()

void GpsMetadataMessage::setEnhancedAltitude

(

const quint32

enhancedAltitude

)

Sets the enhancedAltitude field to enhancedAltitude.

Parameters

enhancedAltitude

The field value to set.

Definition at line 222 of file gpsmetadatamessage.cpp.

{
    Q_D(GpsMetadataMessage);
    d->enhancedAltitude = enhancedAltitude;
}

References enhancedAltitude().

Here is the call graph for this function:

setEnhancedSpeed()

void GpsMetadataMessage::setEnhancedSpeed

(

const quint32

enhancedSpeed

)

Sets the enhancedSpeed field to enhancedSpeed.

Parameters

enhancedSpeed

The field value to set.

Definition at line 232 of file gpsmetadatamessage.cpp.

{
    Q_D(GpsMetadataMessage);
    d->enhancedSpeed = enhancedSpeed;
}

References enhancedSpeed().

Here is the call graph for this function:

setHeading()

void GpsMetadataMessage::setHeading

(

const quint16

heading

)

Sets the heading field to heading.

Parameters

heading

The field value to set.

Definition at line 242 of file gpsmetadatamessage.cpp.

{
    Q_D(GpsMetadataMessage);
    d->heading = heading;
}

References heading().

Here is the call graph for this function:

setPositionLat()

void GpsMetadataMessage::setPositionLat

(

const qint32

positionLat

)

Sets the positionLat field to positionLat.

Parameters

positionLat

The field value to set.

Definition at line 202 of file gpsmetadatamessage.cpp.

{
    Q_D(GpsMetadataMessage);
    d->positionLat = positionLat;
}

References positionLat().

Here is the call graph for this function:

setPositionLong()

void GpsMetadataMessage::setPositionLong

(

const qint32

positionLong

)

Sets the positionLong field to positionLong.

Parameters

positionLong

The field value to set.

Definition at line 212 of file gpsmetadatamessage.cpp.

{
    Q_D(GpsMetadataMessage);
    d->positionLong = positionLong;
}

References positionLong().

Here is the call graph for this function:

setTimestamp()

void GpsMetadataMessage::setTimestamp

(

const DateTime

timestamp

)

Sets the timestamp field to timestamp.

Parameters

timestamp

The field value to set.

Definition at line 182 of file gpsmetadatamessage.cpp.

{
    Q_D(GpsMetadataMessage);
    d->timestamp = timestamp;
}

References timestamp().

Here is the call graph for this function:

setTimestampMs()

void GpsMetadataMessage::setTimestampMs

(

const quint16

timestampMs

)

Sets the timestampMs field to timestampMs.

Parameters

timestampMs

The field value to set.

Definition at line 192 of file gpsmetadatamessage.cpp.

{
    Q_D(GpsMetadataMessage);
    d->timestampMs = timestampMs;
}

References timestampMs().

Here is the call graph for this function:

setUtcTimestamp()

void GpsMetadataMessage::setUtcTimestamp

(

const DateTime

utcTimestamp

)

Sets the utcTimestamp field to utcTimestamp.

Parameters

utcTimestamp

The field value to set.

Definition at line 252 of file gpsmetadatamessage.cpp.

{
    Q_D(GpsMetadataMessage);
    d->utcTimestamp = utcTimestamp;
}

References utcTimestamp().

Here is the call graph for this function:

setVelocity()

void GpsMetadataMessage::setVelocity

(

const qint16

velocity

)

Sets the velocity field to velocity.

Parameters

velocity

The field value to set.

Definition at line 262 of file gpsmetadatamessage.cpp.

{
    Q_D(GpsMetadataMessage);
    d->velocity = velocity;
}

References velocity().

Here is the call graph for this function:

timestamp()

DateTime GpsMetadataMessage::timestamp

(

)

const

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

Whole second part of the timestamp.

Returns

the timestamp field value.

Definition at line 76 of file gpsmetadatamessage.cpp.

{
    Q_D(const GpsMetadataMessage);
    return d->timestamp;
}

Referenced by setTimestamp().

Here is the caller graph for this function:

timestampMs()

quint16 GpsMetadataMessage::timestampMs

(

)

const

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

Millisecond part of the timestamp.

Returns

the timestampMs field value.

Definition at line 89 of file gpsmetadatamessage.cpp.

{
    Q_D(const GpsMetadataMessage);
    return d->timestampMs;
}

Referenced by setTimestampMs().

Here is the caller graph for this function:

utcTimestamp()

DateTime GpsMetadataMessage::utcTimestamp

(

)

const

Returns the GpsMetadataMessage data message's utcTimestamp field's current value.

Used to correlate UTC to system time if the timestamp of the message is in system time. This UTC time is derived from the GPS data.

Returns

the utcTimestamp field value.

Definition at line 158 of file gpsmetadatamessage.cpp.

{
    Q_D(const GpsMetadataMessage);
    return d->utcTimestamp;
}

Referenced by setUtcTimestamp().

Here is the caller graph for this function:

velocity()

qint16 GpsMetadataMessage::velocity

(

)

const

Returns the GpsMetadataMessage data message's velocity field's current value.

velocity[0] is lon velocity. Velocity[1] is lat velocity. Velocity[2] is altitude velocity.

Returns

the velocity field value.

Definition at line 171 of file gpsmetadatamessage.cpp.

{
    Q_D(const GpsMetadataMessage);
    return d->velocity;
}

Referenced by setVelocity().

Here is the caller graph for this function:

---

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

• gpsmetadatamessage.h
• gpsmetadatamessage.cpp