QtFit  0.1
Internal library development documentation
All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
LengthMessage Class Reference

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

Inheritance diagram for LengthMessage:
[legend]
Collaboration diagram for LengthMessage:
[legend]

Public Member Functions

 LengthMessage ()
 Constructs a LengthMessage object. More...
 
MessageIndex messageIndex () const
 Returns the LengthMessage data message's messageIndex field's current value. More...
 
DateTime timestamp () const
 Returns the LengthMessage data message's timestamp field's current value. More...
 
Event event () const
 Returns the LengthMessage data message's event field's current value. More...
 
EventType eventType () const
 Returns the LengthMessage data message's eventType field's current value. More...
 
DateTime startTime () const
 Returns the LengthMessage data message's startTime field's current value. More...
 
quint32 totalElapsedTime () const
 Returns the LengthMessage data message's totalElapsedTime field's current value. More...
 
quint32 totalTimerTime () const
 Returns the LengthMessage data message's totalTimerTime field's current value. More...
 
quint16 totalStrokes () const
 Returns the LengthMessage data message's totalStrokes field's current value. More...
 
quint16 avgSpeed () const
 Returns the LengthMessage data message's avgSpeed field's current value. More...
 
SwimStroke swimStroke () const
 Returns the LengthMessage data message's swimStroke field's current value. More...
 
quint8 avgSwimmingCadence () const
 Returns the LengthMessage data message's avgSwimmingCadence field's current value. More...
 
quint8 eventGroup () const
 Returns the LengthMessage data message's eventGroup field's current value. More...
 
quint16 totalCalories () const
 Returns the LengthMessage data message's totalCalories field's current value. More...
 
LengthType lengthType () const
 Returns the LengthMessage data message's lengthType field's current value. More...
 
quint16 playerScore () const
 Returns the LengthMessage data message's playerScore field's current value. More...
 
quint16 opponentScore () const
 Returns the LengthMessage data message's opponentScore field's current value. More...
 
quint16 strokeCount () const
 Returns the LengthMessage data message's strokeCount field's current value. More...
 
quint16 zoneCount () const
 Returns the LengthMessage data message's zoneCount field's current value. More...
 
void setMessageIndex (const MessageIndex messageIndex)
 Sets the messageIndex field to messageIndex. More...
 
void setTimestamp (const DateTime timestamp)
 Sets the timestamp field to timestamp. More...
 
void setEvent (const Event event)
 Sets the event field to event. More...
 
void setEventType (const EventType eventType)
 Sets the eventType field to eventType. More...
 
void setStartTime (const DateTime startTime)
 Sets the startTime field to startTime. More...
 
void setTotalElapsedTime (const quint32 totalElapsedTime)
 Sets the totalElapsedTime field to totalElapsedTime. More...
 
void setTotalTimerTime (const quint32 totalTimerTime)
 Sets the totalTimerTime field to totalTimerTime. More...
 
void setTotalStrokes (const quint16 totalStrokes)
 Sets the totalStrokes field to totalStrokes. More...
 
void setAvgSpeed (const quint16 avgSpeed)
 Sets the avgSpeed field to avgSpeed. More...
 
void setSwimStroke (const SwimStroke swimStroke)
 Sets the swimStroke field to swimStroke. More...
 
void setAvgSwimmingCadence (const quint8 avgSwimmingCadence)
 Sets the avgSwimmingCadence field to avgSwimmingCadence. More...
 
void setEventGroup (const quint8 eventGroup)
 Sets the eventGroup field to eventGroup. More...
 
void setTotalCalories (const quint16 totalCalories)
 Sets the totalCalories field to totalCalories. More...
 
void setLengthType (const LengthType lengthType)
 Sets the lengthType field to lengthType. More...
 
void setPlayerScore (const quint16 playerScore)
 Sets the playerScore field to playerScore. More...
 
void setOpponentScore (const quint16 opponentScore)
 Sets the opponentScore field to opponentScore. More...
 
void setStrokeCount (const quint16 strokeCount)
 Sets the strokeCount field to strokeCount. More...
 
void setZoneCount (const quint16 zoneCount)
 Sets the zoneCount field to zoneCount. 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

 LengthMessage (LengthMessagePrivate *const d)
 
- Protected Member Functions inherited from AbstractDataMessage
 AbstractDataMessage (AbstractDataMessagePrivate *const d)
 

Additional Inherited Members

- Static Public Member Functions inherited from AbstractDataMessage
static AbstractDataMessagefromData (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 LengthMessage class represents a FIT LengthMessage data message.

See also
DataMessage

Definition at line 39 of file lengthmessage.h.

Constructor & Destructor Documentation

◆ LengthMessage() [1/2]

LengthMessage::LengthMessage ( )

Constructs a LengthMessage 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 lengthmessage.cpp.

53 {
54 
55 }
The AbstractDataMessage class is the polymorphic base class for all FIT Data Message classes.

◆ LengthMessage() [2/2]

LengthMessage::LengthMessage ( LengthMessagePrivate *const  d)
explicitprotected

Constructs a LengthMessage object with private implementation d.

Parameters
dPointer to private implementation.

Definition at line 64 of file lengthmessage.cpp.

65 {
66 
67 }

Member Function Documentation

◆ avgSpeed()

quint16 LengthMessage::avgSpeed ( ) const

Returns the LengthMessage data message's avgSpeed field's current value.

Returns
the avgSpeed field value.

Definition at line 162 of file lengthmessage.cpp.

163 {
164  Q_D(const LengthMessage);
165  return d->avgSpeed;
166 }
The LengthMessage class represents a FIT LengthMessage data message.
Definition: lengthmessage.h:39

Referenced by setAvgSpeed().

Here is the caller graph for this function:

◆ avgSwimmingCadence()

quint8 LengthMessage::avgSwimmingCadence ( ) const

Returns the LengthMessage data message's avgSwimmingCadence field's current value.

Returns
the avgSwimmingCadence field value.

Definition at line 184 of file lengthmessage.cpp.

185 {
186  Q_D(const LengthMessage);
187  return d->avgSwimmingCadence;
188 }

Referenced by setAvgSwimmingCadence().

Here is the caller graph for this function:

◆ event()

Event LengthMessage::event ( ) const

Returns the LengthMessage data message's event field's current value.

Returns
the event field value.

Definition at line 96 of file lengthmessage.cpp.

97 {
98  Q_D(const LengthMessage);
99  return d->event;
100 }

Referenced by setEvent().

Here is the caller graph for this function:

◆ eventGroup()

quint8 LengthMessage::eventGroup ( ) const

Returns the LengthMessage data message's eventGroup field's current value.

Returns
the eventGroup field value.

Definition at line 195 of file lengthmessage.cpp.

196 {
197  Q_D(const LengthMessage);
198  return d->eventGroup;
199 }

Referenced by setEventGroup().

Here is the caller graph for this function:

◆ eventType()

EventType LengthMessage::eventType ( ) const

Returns the LengthMessage data message's eventType field's current value.

Returns
the eventType field value.

Definition at line 107 of file lengthmessage.cpp.

108 {
109  Q_D(const LengthMessage);
110  return d->eventType;
111 }

Referenced by setEventType().

Here is the caller graph for this function:

◆ lengthType()

LengthType LengthMessage::lengthType ( ) const

Returns the LengthMessage data message's lengthType field's current value.

Returns
the lengthType field value.

Definition at line 217 of file lengthmessage.cpp.

218 {
219  Q_D(const LengthMessage);
220  return d->lengthType;
221 }

Referenced by setLengthType().

Here is the caller graph for this function:

◆ messageIndex()

MessageIndex LengthMessage::messageIndex ( ) const

Returns the LengthMessage data message's messageIndex field's current value.

Returns
the messageIndex field value.

Definition at line 74 of file lengthmessage.cpp.

75 {
76  Q_D(const LengthMessage);
77  return d->messageIndex;
78 }

Referenced by setMessageIndex().

Here is the caller graph for this function:

◆ opponentScore()

quint16 LengthMessage::opponentScore ( ) const

Returns the LengthMessage data message's opponentScore field's current value.

Returns
the opponentScore field value.

Definition at line 239 of file lengthmessage.cpp.

240 {
241  Q_D(const LengthMessage);
242  return d->opponentScore;
243 }

Referenced by setOpponentScore().

Here is the caller graph for this function:

◆ playerScore()

quint16 LengthMessage::playerScore ( ) const

Returns the LengthMessage data message's playerScore field's current value.

Returns
the playerScore field value.

Definition at line 228 of file lengthmessage.cpp.

229 {
230  Q_D(const LengthMessage);
231  return d->playerScore;
232 }

Referenced by setPlayerScore().

Here is the caller graph for this function:

◆ setAvgSpeed()

void LengthMessage::setAvgSpeed ( const quint16  avgSpeed)

Sets the avgSpeed field to avgSpeed.

Parameters
avgSpeedThe field value to set.

Definition at line 356 of file lengthmessage.cpp.

357 {
358  Q_D(LengthMessage);
359  d->avgSpeed = avgSpeed;
360 }
quint16 avgSpeed() const
Returns the LengthMessage data message's avgSpeed field's current value.

References avgSpeed().

Here is the call graph for this function:

◆ setAvgSwimmingCadence()

void LengthMessage::setAvgSwimmingCadence ( const quint8  avgSwimmingCadence)

Sets the avgSwimmingCadence field to avgSwimmingCadence.

Parameters
avgSwimmingCadenceThe field value to set.

Definition at line 376 of file lengthmessage.cpp.

377 {
378  Q_D(LengthMessage);
379  d->avgSwimmingCadence = avgSwimmingCadence;
380 }
quint8 avgSwimmingCadence() const
Returns the LengthMessage data message's avgSwimmingCadence field's current value.

References avgSwimmingCadence().

Here is the call graph for this function:

◆ setEvent()

void LengthMessage::setEvent ( const Event  event)

Sets the event field to event.

Parameters
eventThe field value to set.

Definition at line 296 of file lengthmessage.cpp.

297 {
298  Q_D(LengthMessage);
299  d->event = event;
300 }
Event event() const
Returns the LengthMessage data message's event field's current value.

References event().

Here is the call graph for this function:

◆ setEventGroup()

void LengthMessage::setEventGroup ( const quint8  eventGroup)

Sets the eventGroup field to eventGroup.

Parameters
eventGroupThe field value to set.

Definition at line 386 of file lengthmessage.cpp.

387 {
388  Q_D(LengthMessage);
389  d->eventGroup = eventGroup;
390 }
quint8 eventGroup() const
Returns the LengthMessage data message's eventGroup field's current value.

References eventGroup().

Here is the call graph for this function:

◆ setEventType()

void LengthMessage::setEventType ( const EventType  eventType)

Sets the eventType field to eventType.

Parameters
eventTypeThe field value to set.

Definition at line 306 of file lengthmessage.cpp.

307 {
308  Q_D(LengthMessage);
309  d->eventType = eventType;
310 }
EventType eventType() const
Returns the LengthMessage data message's eventType field's current value.

References eventType().

Here is the call graph for this function:

◆ setLengthType()

void LengthMessage::setLengthType ( const LengthType  lengthType)

Sets the lengthType field to lengthType.

Parameters
lengthTypeThe field value to set.

Definition at line 406 of file lengthmessage.cpp.

407 {
408  Q_D(LengthMessage);
409  d->lengthType = lengthType;
410 }
LengthType lengthType() const
Returns the LengthMessage data message's lengthType field's current value.

References lengthType().

Here is the call graph for this function:

◆ setMessageIndex()

void LengthMessage::setMessageIndex ( const MessageIndex  messageIndex)

Sets the messageIndex field to messageIndex.

Parameters
messageIndexThe field value to set.

Definition at line 276 of file lengthmessage.cpp.

277 {
278  Q_D(LengthMessage);
279  d->messageIndex = messageIndex;
280 }
MessageIndex messageIndex() const
Returns the LengthMessage data message's messageIndex field's current value.

References messageIndex().

Here is the call graph for this function:

◆ setOpponentScore()

void LengthMessage::setOpponentScore ( const quint16  opponentScore)

Sets the opponentScore field to opponentScore.

Parameters
opponentScoreThe field value to set.

Definition at line 426 of file lengthmessage.cpp.

427 {
428  Q_D(LengthMessage);
429  d->opponentScore = opponentScore;
430 }
quint16 opponentScore() const
Returns the LengthMessage data message's opponentScore field's current value.

References opponentScore().

Here is the call graph for this function:

◆ setPlayerScore()

void LengthMessage::setPlayerScore ( const quint16  playerScore)

Sets the playerScore field to playerScore.

Parameters
playerScoreThe field value to set.

Definition at line 416 of file lengthmessage.cpp.

417 {
418  Q_D(LengthMessage);
419  d->playerScore = playerScore;
420 }
quint16 playerScore() const
Returns the LengthMessage data message's playerScore field's current value.

References playerScore().

Here is the call graph for this function:

◆ setStartTime()

void LengthMessage::setStartTime ( const DateTime  startTime)

Sets the startTime field to startTime.

Parameters
startTimeThe field value to set.

Definition at line 316 of file lengthmessage.cpp.

317 {
318  Q_D(LengthMessage);
319  d->startTime = startTime;
320 }
DateTime startTime() const
Returns the LengthMessage data message's startTime field's current value.

References startTime().

Here is the call graph for this function:

◆ setStrokeCount()

void LengthMessage::setStrokeCount ( const quint16  strokeCount)

Sets the strokeCount field to strokeCount.

Parameters
strokeCountThe field value to set.

Definition at line 436 of file lengthmessage.cpp.

437 {
438  Q_D(LengthMessage);
439  d->strokeCount = strokeCount;
440 }
quint16 strokeCount() const
Returns the LengthMessage data message's strokeCount field's current value.

References strokeCount().

Here is the call graph for this function:

◆ setSwimStroke()

void LengthMessage::setSwimStroke ( const SwimStroke  swimStroke)

Sets the swimStroke field to swimStroke.

Parameters
swimStrokeThe field value to set.

Definition at line 366 of file lengthmessage.cpp.

367 {
368  Q_D(LengthMessage);
369  d->swimStroke = swimStroke;
370 }
SwimStroke swimStroke() const
Returns the LengthMessage data message's swimStroke field's current value.

References swimStroke().

Here is the call graph for this function:

◆ setTimestamp()

void LengthMessage::setTimestamp ( const DateTime  timestamp)

Sets the timestamp field to timestamp.

Parameters
timestampThe field value to set.

Definition at line 286 of file lengthmessage.cpp.

287 {
288  Q_D(LengthMessage);
289  d->timestamp = timestamp;
290 }
DateTime timestamp() const
Returns the LengthMessage data message's timestamp field's current value.

References timestamp().

Here is the call graph for this function:

◆ setTotalCalories()

void LengthMessage::setTotalCalories ( const quint16  totalCalories)

Sets the totalCalories field to totalCalories.

Parameters
totalCaloriesThe field value to set.

Definition at line 396 of file lengthmessage.cpp.

397 {
398  Q_D(LengthMessage);
399  d->totalCalories = totalCalories;
400 }
quint16 totalCalories() const
Returns the LengthMessage data message's totalCalories field's current value.

References totalCalories().

Here is the call graph for this function:

◆ setTotalElapsedTime()

void LengthMessage::setTotalElapsedTime ( const quint32  totalElapsedTime)

Sets the totalElapsedTime field to totalElapsedTime.

Parameters
totalElapsedTimeThe field value to set.

Definition at line 326 of file lengthmessage.cpp.

327 {
328  Q_D(LengthMessage);
329  d->totalElapsedTime = totalElapsedTime;
330 }
quint32 totalElapsedTime() const
Returns the LengthMessage data message's totalElapsedTime field's current value.

References totalElapsedTime().

Here is the call graph for this function:

◆ setTotalStrokes()

void LengthMessage::setTotalStrokes ( const quint16  totalStrokes)

Sets the totalStrokes field to totalStrokes.

Parameters
totalStrokesThe field value to set.

Definition at line 346 of file lengthmessage.cpp.

347 {
348  Q_D(LengthMessage);
349  d->totalStrokes = totalStrokes;
350 }
quint16 totalStrokes() const
Returns the LengthMessage data message's totalStrokes field's current value.

References totalStrokes().

Here is the call graph for this function:

◆ setTotalTimerTime()

void LengthMessage::setTotalTimerTime ( const quint32  totalTimerTime)

Sets the totalTimerTime field to totalTimerTime.

Parameters
totalTimerTimeThe field value to set.

Definition at line 336 of file lengthmessage.cpp.

337 {
338  Q_D(LengthMessage);
339  d->totalTimerTime = totalTimerTime;
340 }
quint32 totalTimerTime() const
Returns the LengthMessage data message's totalTimerTime field's current value.

References totalTimerTime().

Here is the call graph for this function:

◆ setZoneCount()

void LengthMessage::setZoneCount ( const quint16  zoneCount)

Sets the zoneCount field to zoneCount.

Parameters
zoneCountThe field value to set.

Definition at line 446 of file lengthmessage.cpp.

447 {
448  Q_D(LengthMessage);
449  d->zoneCount = zoneCount;
450 }
quint16 zoneCount() const
Returns the LengthMessage data message's zoneCount field's current value.

References zoneCount().

Here is the call graph for this function:

◆ startTime()

DateTime LengthMessage::startTime ( ) const

Returns the LengthMessage data message's startTime field's current value.

Returns
the startTime field value.

Definition at line 118 of file lengthmessage.cpp.

119 {
120  Q_D(const LengthMessage);
121  return d->startTime;
122 }

Referenced by setStartTime().

Here is the caller graph for this function:

◆ strokeCount()

quint16 LengthMessage::strokeCount ( ) const

Returns the LengthMessage data message's strokeCount field's current value.

stroke_type enum used as the index

Returns
the strokeCount field value.

Definition at line 252 of file lengthmessage.cpp.

253 {
254  Q_D(const LengthMessage);
255  return d->strokeCount;
256 }

Referenced by setStrokeCount().

Here is the caller graph for this function:

◆ swimStroke()

SwimStroke LengthMessage::swimStroke ( ) const

Returns the LengthMessage data message's swimStroke field's current value.

Returns
the swimStroke field value.

Definition at line 173 of file lengthmessage.cpp.

174 {
175  Q_D(const LengthMessage);
176  return d->swimStroke;
177 }

Referenced by setSwimStroke().

Here is the caller graph for this function:

◆ timestamp()

DateTime LengthMessage::timestamp ( ) const

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

Returns
the timestamp field value.

Definition at line 85 of file lengthmessage.cpp.

86 {
87  Q_D(const LengthMessage);
88  return d->timestamp;
89 }

Referenced by setTimestamp().

Here is the caller graph for this function:

◆ totalCalories()

quint16 LengthMessage::totalCalories ( ) const

Returns the LengthMessage data message's totalCalories field's current value.

Returns
the totalCalories field value.

Definition at line 206 of file lengthmessage.cpp.

207 {
208  Q_D(const LengthMessage);
209  return d->totalCalories;
210 }

Referenced by setTotalCalories().

Here is the caller graph for this function:

◆ totalElapsedTime()

quint32 LengthMessage::totalElapsedTime ( ) const

Returns the LengthMessage data message's totalElapsedTime field's current value.

Returns
the totalElapsedTime field value.

Definition at line 129 of file lengthmessage.cpp.

130 {
131  Q_D(const LengthMessage);
132  return d->totalElapsedTime;
133 }

Referenced by setTotalElapsedTime().

Here is the caller graph for this function:

◆ totalStrokes()

quint16 LengthMessage::totalStrokes ( ) const

Returns the LengthMessage data message's totalStrokes field's current value.

Returns
the totalStrokes field value.

Definition at line 151 of file lengthmessage.cpp.

152 {
153  Q_D(const LengthMessage);
154  return d->totalStrokes;
155 }

Referenced by setTotalStrokes().

Here is the caller graph for this function:

◆ totalTimerTime()

quint32 LengthMessage::totalTimerTime ( ) const

Returns the LengthMessage data message's totalTimerTime field's current value.

Returns
the totalTimerTime field value.

Definition at line 140 of file lengthmessage.cpp.

141 {
142  Q_D(const LengthMessage);
143  return d->totalTimerTime;
144 }

Referenced by setTotalTimerTime().

Here is the caller graph for this function:

◆ zoneCount()

quint16 LengthMessage::zoneCount ( ) const

Returns the LengthMessage data message's zoneCount field's current value.

zone number used as the index

Returns
the zoneCount field value.

Definition at line 265 of file lengthmessage.cpp.

266 {
267  Q_D(const LengthMessage);
268  return d->zoneCount;
269 }

Referenced by setZoneCount().

Here is the caller graph for this function:

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