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

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

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

Public Member Functions

 WorkoutStepMessage ()
 Constructs a WorkoutStepMessage object. More...
 
MessageIndex messageIndex () const
 Returns the WorkoutStepMessage data message's messageIndex field's current value. More...
 
QString wktStepName () const
 Returns the WorkoutStepMessage data message's wktStepName field's current value. More...
 
WktStepDuration durationType () const
 Returns the WorkoutStepMessage data message's durationType field's current value. More...
 
quint32 durationValue () const
 Returns the WorkoutStepMessage data message's durationValue field's current value. More...
 
WktStepTarget targetType () const
 Returns the WorkoutStepMessage data message's targetType field's current value. More...
 
quint32 targetValue () const
 Returns the WorkoutStepMessage data message's targetValue field's current value. More...
 
quint32 customTargetValueLow () const
 Returns the WorkoutStepMessage data message's customTargetValueLow field's current value. More...
 
quint32 customTargetValueHigh () const
 Returns the WorkoutStepMessage data message's customTargetValueHigh field's current value. More...
 
Intensity intensity () const
 Returns the WorkoutStepMessage data message's intensity field's current value. More...
 
QString notes () const
 Returns the WorkoutStepMessage data message's notes field's current value. More...
 
WorkoutEquipment equipment () const
 Returns the WorkoutStepMessage data message's equipment field's current value. More...
 
ExerciseCategory exerciseCategory () const
 Returns the WorkoutStepMessage data message's exerciseCategory field's current value. More...
 
quint16 exerciseName () const
 Returns the WorkoutStepMessage data message's exerciseName field's current value. More...
 
quint16 exerciseWeight () const
 Returns the WorkoutStepMessage data message's exerciseWeight field's current value. More...
 
FitBaseUnit weightDisplayUnit () const
 Returns the WorkoutStepMessage data message's weightDisplayUnit field's current value. More...
 
void setMessageIndex (const MessageIndex messageIndex)
 Sets the messageIndex field to messageIndex. More...
 
void setWktStepName (const QString wktStepName)
 Sets the wktStepName field to wktStepName. More...
 
void setDurationType (const WktStepDuration durationType)
 Sets the durationType field to durationType. More...
 
void setDurationValue (const quint32 durationValue)
 Sets the durationValue field to durationValue. More...
 
void setTargetType (const WktStepTarget targetType)
 Sets the targetType field to targetType. More...
 
void setTargetValue (const quint32 targetValue)
 Sets the targetValue field to targetValue. More...
 
void setCustomTargetValueLow (const quint32 customTargetValueLow)
 Sets the customTargetValueLow field to customTargetValueLow. More...
 
void setCustomTargetValueHigh (const quint32 customTargetValueHigh)
 Sets the customTargetValueHigh field to customTargetValueHigh. More...
 
void setIntensity (const Intensity intensity)
 Sets the intensity field to intensity. More...
 
void setNotes (const QString notes)
 Sets the notes field to notes. More...
 
void setEquipment (const WorkoutEquipment equipment)
 Sets the equipment field to equipment. More...
 
void setExerciseCategory (const ExerciseCategory exerciseCategory)
 Sets the exerciseCategory field to exerciseCategory. More...
 
void setExerciseName (const quint16 exerciseName)
 Sets the exerciseName field to exerciseName. More...
 
void setExerciseWeight (const quint16 exerciseWeight)
 Sets the exerciseWeight field to exerciseWeight. More...
 
void setWeightDisplayUnit (const FitBaseUnit weightDisplayUnit)
 Sets the weightDisplayUnit field to weightDisplayUnit. 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

 WorkoutStepMessage (WorkoutStepMessagePrivate *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 WorkoutStepMessage class represents a FIT WorkoutStepMessage data message.

See also
DataMessage

Definition at line 39 of file workoutstepmessage.h.

Constructor & Destructor Documentation

◆ WorkoutStepMessage() [1/2]

WorkoutStepMessage::WorkoutStepMessage ( )

Constructs a WorkoutStepMessage 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 workoutstepmessage.cpp.

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

◆ WorkoutStepMessage() [2/2]

WorkoutStepMessage::WorkoutStepMessage ( WorkoutStepMessagePrivate *const  d)
explicitprotected

Constructs a WorkoutStepMessage object with private implementation d.

Parameters
dPointer to private implementation.

Definition at line 64 of file workoutstepmessage.cpp.

65 {
66 
67 }

Member Function Documentation

◆ customTargetValueHigh()

quint32 WorkoutStepMessage::customTargetValueHigh ( ) const

Returns the WorkoutStepMessage data message's customTargetValueHigh field's current value.

Returns
the customTargetValueHigh field value.

Definition at line 151 of file workoutstepmessage.cpp.

152 {
153  Q_D(const WorkoutStepMessage);
154  return d->customTargetValueHigh;
155 }
The WorkoutStepMessage class represents a FIT WorkoutStepMessage data message.

Referenced by setCustomTargetValueHigh().

Here is the caller graph for this function:

◆ customTargetValueLow()

quint32 WorkoutStepMessage::customTargetValueLow ( ) const

Returns the WorkoutStepMessage data message's customTargetValueLow field's current value.

Returns
the customTargetValueLow field value.

Definition at line 140 of file workoutstepmessage.cpp.

141 {
142  Q_D(const WorkoutStepMessage);
143  return d->customTargetValueLow;
144 }

Referenced by setCustomTargetValueLow().

Here is the caller graph for this function:

◆ durationType()

WktStepDuration WorkoutStepMessage::durationType ( ) const

Returns the WorkoutStepMessage data message's durationType field's current value.

Returns
the durationType field value.

Definition at line 96 of file workoutstepmessage.cpp.

97 {
98  Q_D(const WorkoutStepMessage);
99  return d->durationType;
100 }

Referenced by setDurationType().

Here is the caller graph for this function:

◆ durationValue()

quint32 WorkoutStepMessage::durationValue ( ) const

Returns the WorkoutStepMessage data message's durationValue field's current value.

Returns
the durationValue field value.

Definition at line 107 of file workoutstepmessage.cpp.

108 {
109  Q_D(const WorkoutStepMessage);
110  return d->durationValue;
111 }

Referenced by setDurationValue().

Here is the caller graph for this function:

◆ equipment()

WorkoutEquipment WorkoutStepMessage::equipment ( ) const

Returns the WorkoutStepMessage data message's equipment field's current value.

Returns
the equipment field value.

Definition at line 184 of file workoutstepmessage.cpp.

185 {
186  Q_D(const WorkoutStepMessage);
187  return d->equipment;
188 }

Referenced by setEquipment().

Here is the caller graph for this function:

◆ exerciseCategory()

ExerciseCategory WorkoutStepMessage::exerciseCategory ( ) const

Returns the WorkoutStepMessage data message's exerciseCategory field's current value.

Returns
the exerciseCategory field value.

Definition at line 195 of file workoutstepmessage.cpp.

196 {
197  Q_D(const WorkoutStepMessage);
198  return d->exerciseCategory;
199 }

Referenced by setExerciseCategory().

Here is the caller graph for this function:

◆ exerciseName()

quint16 WorkoutStepMessage::exerciseName ( ) const

Returns the WorkoutStepMessage data message's exerciseName field's current value.

Returns
the exerciseName field value.

Definition at line 206 of file workoutstepmessage.cpp.

207 {
208  Q_D(const WorkoutStepMessage);
209  return d->exerciseName;
210 }

Referenced by setExerciseName().

Here is the caller graph for this function:

◆ exerciseWeight()

quint16 WorkoutStepMessage::exerciseWeight ( ) const

Returns the WorkoutStepMessage data message's exerciseWeight field's current value.

Returns
the exerciseWeight field value.

Definition at line 217 of file workoutstepmessage.cpp.

218 {
219  Q_D(const WorkoutStepMessage);
220  return d->exerciseWeight;
221 }

Referenced by setExerciseWeight().

Here is the caller graph for this function:

◆ intensity()

Intensity WorkoutStepMessage::intensity ( ) const

Returns the WorkoutStepMessage data message's intensity field's current value.

Returns
the intensity field value.

Definition at line 162 of file workoutstepmessage.cpp.

163 {
164  Q_D(const WorkoutStepMessage);
165  return d->intensity;
166 }

Referenced by setIntensity().

Here is the caller graph for this function:

◆ messageIndex()

MessageIndex WorkoutStepMessage::messageIndex ( ) const

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

Returns
the messageIndex field value.

Definition at line 74 of file workoutstepmessage.cpp.

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

Referenced by setMessageIndex().

Here is the caller graph for this function:

◆ notes()

QString WorkoutStepMessage::notes ( ) const

Returns the WorkoutStepMessage data message's notes field's current value.

Returns
the notes field value.

Definition at line 173 of file workoutstepmessage.cpp.

174 {
175  Q_D(const WorkoutStepMessage);
176  return d->notes;
177 }

Referenced by setNotes().

Here is the caller graph for this function:

◆ setCustomTargetValueHigh()

void WorkoutStepMessage::setCustomTargetValueHigh ( const quint32  customTargetValueHigh)

Sets the customTargetValueHigh field to customTargetValueHigh.

Parameters
customTargetValueHighThe field value to set.

Definition at line 309 of file workoutstepmessage.cpp.

310 {
311  Q_D(WorkoutStepMessage);
312  d->customTargetValueHigh = customTargetValueHigh;
313 }
quint32 customTargetValueHigh() const
Returns the WorkoutStepMessage data message's customTargetValueHigh field's current value.

References customTargetValueHigh().

Here is the call graph for this function:

◆ setCustomTargetValueLow()

void WorkoutStepMessage::setCustomTargetValueLow ( const quint32  customTargetValueLow)

Sets the customTargetValueLow field to customTargetValueLow.

Parameters
customTargetValueLowThe field value to set.

Definition at line 299 of file workoutstepmessage.cpp.

300 {
301  Q_D(WorkoutStepMessage);
302  d->customTargetValueLow = customTargetValueLow;
303 }
quint32 customTargetValueLow() const
Returns the WorkoutStepMessage data message's customTargetValueLow field's current value.

References customTargetValueLow().

Here is the call graph for this function:

◆ setDurationType()

void WorkoutStepMessage::setDurationType ( const WktStepDuration  durationType)

Sets the durationType field to durationType.

Parameters
durationTypeThe field value to set.

Definition at line 259 of file workoutstepmessage.cpp.

260 {
261  Q_D(WorkoutStepMessage);
262  d->durationType = durationType;
263 }
WktStepDuration durationType() const
Returns the WorkoutStepMessage data message's durationType field's current value.

References durationType().

Here is the call graph for this function:

◆ setDurationValue()

void WorkoutStepMessage::setDurationValue ( const quint32  durationValue)

Sets the durationValue field to durationValue.

Parameters
durationValueThe field value to set.

Definition at line 269 of file workoutstepmessage.cpp.

270 {
271  Q_D(WorkoutStepMessage);
272  d->durationValue = durationValue;
273 }
quint32 durationValue() const
Returns the WorkoutStepMessage data message's durationValue field's current value.

References durationValue().

Here is the call graph for this function:

◆ setEquipment()

void WorkoutStepMessage::setEquipment ( const WorkoutEquipment  equipment)

Sets the equipment field to equipment.

Parameters
equipmentThe field value to set.

Definition at line 339 of file workoutstepmessage.cpp.

340 {
341  Q_D(WorkoutStepMessage);
342  d->equipment = equipment;
343 }
WorkoutEquipment equipment() const
Returns the WorkoutStepMessage data message's equipment field's current value.

References equipment().

Here is the call graph for this function:

◆ setExerciseCategory()

void WorkoutStepMessage::setExerciseCategory ( const ExerciseCategory  exerciseCategory)

Sets the exerciseCategory field to exerciseCategory.

Parameters
exerciseCategoryThe field value to set.

Definition at line 349 of file workoutstepmessage.cpp.

350 {
351  Q_D(WorkoutStepMessage);
352  d->exerciseCategory = exerciseCategory;
353 }
ExerciseCategory exerciseCategory() const
Returns the WorkoutStepMessage data message's exerciseCategory field's current value.

References exerciseCategory().

Here is the call graph for this function:

◆ setExerciseName()

void WorkoutStepMessage::setExerciseName ( const quint16  exerciseName)

Sets the exerciseName field to exerciseName.

Parameters
exerciseNameThe field value to set.

Definition at line 359 of file workoutstepmessage.cpp.

360 {
361  Q_D(WorkoutStepMessage);
362  d->exerciseName = exerciseName;
363 }
quint16 exerciseName() const
Returns the WorkoutStepMessage data message's exerciseName field's current value.

References exerciseName().

Here is the call graph for this function:

◆ setExerciseWeight()

void WorkoutStepMessage::setExerciseWeight ( const quint16  exerciseWeight)

Sets the exerciseWeight field to exerciseWeight.

Parameters
exerciseWeightThe field value to set.

Definition at line 369 of file workoutstepmessage.cpp.

370 {
371  Q_D(WorkoutStepMessage);
372  d->exerciseWeight = exerciseWeight;
373 }
quint16 exerciseWeight() const
Returns the WorkoutStepMessage data message's exerciseWeight field's current value.

References exerciseWeight().

Here is the call graph for this function:

◆ setIntensity()

void WorkoutStepMessage::setIntensity ( const Intensity  intensity)

Sets the intensity field to intensity.

Parameters
intensityThe field value to set.

Definition at line 319 of file workoutstepmessage.cpp.

320 {
321  Q_D(WorkoutStepMessage);
322  d->intensity = intensity;
323 }
Intensity intensity() const
Returns the WorkoutStepMessage data message's intensity field's current value.

References intensity().

Here is the call graph for this function:

◆ setMessageIndex()

void WorkoutStepMessage::setMessageIndex ( const MessageIndex  messageIndex)

Sets the messageIndex field to messageIndex.

Parameters
messageIndexThe field value to set.

Definition at line 239 of file workoutstepmessage.cpp.

240 {
241  Q_D(WorkoutStepMessage);
242  d->messageIndex = messageIndex;
243 }
MessageIndex messageIndex() const
Returns the WorkoutStepMessage data message's messageIndex field's current value.

References messageIndex().

Here is the call graph for this function:

◆ setNotes()

void WorkoutStepMessage::setNotes ( const QString  notes)

Sets the notes field to notes.

Parameters
notesThe field value to set.

Definition at line 329 of file workoutstepmessage.cpp.

330 {
331  Q_D(WorkoutStepMessage);
332  d->notes = notes;
333 }
QString notes() const
Returns the WorkoutStepMessage data message's notes field's current value.

References notes().

Here is the call graph for this function:

◆ setTargetType()

void WorkoutStepMessage::setTargetType ( const WktStepTarget  targetType)

Sets the targetType field to targetType.

Parameters
targetTypeThe field value to set.

Definition at line 279 of file workoutstepmessage.cpp.

280 {
281  Q_D(WorkoutStepMessage);
282  d->targetType = targetType;
283 }
WktStepTarget targetType() const
Returns the WorkoutStepMessage data message's targetType field's current value.

References targetType().

Here is the call graph for this function:

◆ setTargetValue()

void WorkoutStepMessage::setTargetValue ( const quint32  targetValue)

Sets the targetValue field to targetValue.

Parameters
targetValueThe field value to set.

Definition at line 289 of file workoutstepmessage.cpp.

290 {
291  Q_D(WorkoutStepMessage);
292  d->targetValue = targetValue;
293 }
quint32 targetValue() const
Returns the WorkoutStepMessage data message's targetValue field's current value.

References targetValue().

Here is the call graph for this function:

◆ setWeightDisplayUnit()

void WorkoutStepMessage::setWeightDisplayUnit ( const FitBaseUnit  weightDisplayUnit)

Sets the weightDisplayUnit field to weightDisplayUnit.

Parameters
weightDisplayUnitThe field value to set.

Definition at line 379 of file workoutstepmessage.cpp.

380 {
381  Q_D(WorkoutStepMessage);
382  d->weightDisplayUnit = weightDisplayUnit;
383 }
FitBaseUnit weightDisplayUnit() const
Returns the WorkoutStepMessage data message's weightDisplayUnit field's current value.

References weightDisplayUnit().

Here is the call graph for this function:

◆ setWktStepName()

void WorkoutStepMessage::setWktStepName ( const QString  wktStepName)

Sets the wktStepName field to wktStepName.

Parameters
wktStepNameThe field value to set.

Definition at line 249 of file workoutstepmessage.cpp.

250 {
251  Q_D(WorkoutStepMessage);
252  d->wktStepName = wktStepName;
253 }
QString wktStepName() const
Returns the WorkoutStepMessage data message's wktStepName field's current value.

References wktStepName().

Here is the call graph for this function:

◆ targetType()

WktStepTarget WorkoutStepMessage::targetType ( ) const

Returns the WorkoutStepMessage data message's targetType field's current value.

Returns
the targetType field value.

Definition at line 118 of file workoutstepmessage.cpp.

119 {
120  Q_D(const WorkoutStepMessage);
121  return d->targetType;
122 }

Referenced by setTargetType().

Here is the caller graph for this function:

◆ targetValue()

quint32 WorkoutStepMessage::targetValue ( ) const

Returns the WorkoutStepMessage data message's targetValue field's current value.

Returns
the targetValue field value.

Definition at line 129 of file workoutstepmessage.cpp.

130 {
131  Q_D(const WorkoutStepMessage);
132  return d->targetValue;
133 }

Referenced by setTargetValue().

Here is the caller graph for this function:

◆ weightDisplayUnit()

FitBaseUnit WorkoutStepMessage::weightDisplayUnit ( ) const

Returns the WorkoutStepMessage data message's weightDisplayUnit field's current value.

Returns
the weightDisplayUnit field value.

Definition at line 228 of file workoutstepmessage.cpp.

229 {
230  Q_D(const WorkoutStepMessage);
231  return d->weightDisplayUnit;
232 }

Referenced by setWeightDisplayUnit().

Here is the caller graph for this function:

◆ wktStepName()

QString WorkoutStepMessage::wktStepName ( ) const

Returns the WorkoutStepMessage data message's wktStepName field's current value.

Returns
the wktStepName field value.

Definition at line 85 of file workoutstepmessage.cpp.

86 {
87  Q_D(const WorkoutStepMessage);
88  return d->wktStepName;
89 }

Referenced by setWktStepName().

Here is the caller graph for this function:

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