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

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

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

Public Member Functions

 SetMessage ()
 Constructs a SetMessage object. More...
 
DateTime timestamp () const
 Returns the SetMessage data message's timestamp field's current value. More...
 
quint32 duration () const
 Returns the SetMessage data message's duration field's current value. More...
 
quint16 repetitions () const
 Returns the SetMessage data message's repetitions field's current value. More...
 
quint16 weight () const
 Returns the SetMessage data message's weight field's current value. More...
 
SetType setType () const
 Returns the SetMessage data message's setType field's current value. More...
 
DateTime startTime () const
 Returns the SetMessage data message's startTime field's current value. More...
 
ExerciseCategory category () const
 Returns the SetMessage data message's category field's current value. More...
 
quint16 categorySubtype () const
 Returns the SetMessage data message's categorySubtype field's current value. More...
 
FitBaseUnit weightDisplayUnit () const
 Returns the SetMessage data message's weightDisplayUnit field's current value. More...
 
MessageIndex messageIndex () const
 Returns the SetMessage data message's messageIndex field's current value. More...
 
MessageIndex wktStepIndex () const
 Returns the SetMessage data message's wktStepIndex field's current value. More...
 
void setTimestamp (const DateTime timestamp)
 Sets the timestamp field to timestamp. More...
 
void setDuration (const quint32 duration)
 Sets the duration field to duration. More...
 
void setRepetitions (const quint16 repetitions)
 Sets the repetitions field to repetitions. More...
 
void setWeight (const quint16 weight)
 Sets the weight field to weight. More...
 
void setSetType (const SetType setType)
 Sets the setType field to setType. More...
 
void setStartTime (const DateTime startTime)
 Sets the startTime field to startTime. More...
 
void setCategory (const ExerciseCategory category)
 Sets the category field to category. More...
 
void setCategorySubtype (const quint16 categorySubtype)
 Sets the categorySubtype field to categorySubtype. More...
 
void setWeightDisplayUnit (const FitBaseUnit weightDisplayUnit)
 Sets the weightDisplayUnit field to weightDisplayUnit. More...
 
void setMessageIndex (const MessageIndex messageIndex)
 Sets the messageIndex field to messageIndex. More...
 
void setWktStepIndex (const MessageIndex wktStepIndex)
 Sets the wktStepIndex field to wktStepIndex. 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

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

See also
DataMessage

Definition at line 39 of file setmessage.h.

Constructor & Destructor Documentation

◆ SetMessage() [1/2]

SetMessage::SetMessage ( )

Constructs a SetMessage 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 setmessage.cpp.

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

◆ SetMessage() [2/2]

SetMessage::SetMessage ( SetMessagePrivate *const  d)
explicitprotected

Constructs a SetMessage object with private implementation d.

Parameters
dPointer to private implementation.

Definition at line 64 of file setmessage.cpp.

65 {
66 
67 }

Member Function Documentation

◆ category()

ExerciseCategory SetMessage::category ( ) const

Returns the SetMessage data message's category field's current value.

Returns
the category field value.

Definition at line 148 of file setmessage.cpp.

149 {
150  Q_D(const SetMessage);
151  return d->category;
152 }
The SetMessage class represents a FIT SetMessage data message.
Definition: setmessage.h:39

Referenced by setCategory().

Here is the caller graph for this function:

◆ categorySubtype()

quint16 SetMessage::categorySubtype ( ) const

Returns the SetMessage data message's categorySubtype field's current value.

Based on the associated category, see [category]_exercise_names

Returns
the categorySubtype field value.

Definition at line 161 of file setmessage.cpp.

162 {
163  Q_D(const SetMessage);
164  return d->categorySubtype;
165 }

Referenced by setCategorySubtype().

Here is the caller graph for this function:

◆ duration()

quint32 SetMessage::duration ( ) const

Returns the SetMessage data message's duration field's current value.

Returns
the duration field value.

Definition at line 87 of file setmessage.cpp.

88 {
89  Q_D(const SetMessage);
90  return d->duration;
91 }

Referenced by setDuration().

Here is the caller graph for this function:

◆ messageIndex()

MessageIndex SetMessage::messageIndex ( ) const

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

Returns
the messageIndex field value.

Definition at line 183 of file setmessage.cpp.

184 {
185  Q_D(const SetMessage);
186  return d->messageIndex;
187 }

Referenced by setMessageIndex().

Here is the caller graph for this function:

◆ repetitions()

quint16 SetMessage::repetitions ( ) const

Returns the SetMessage data message's repetitions field's current value.

of repitions of the movement

Returns
the repetitions field value.

Definition at line 100 of file setmessage.cpp.

101 {
102  Q_D(const SetMessage);
103  return d->repetitions;
104 }

Referenced by setRepetitions().

Here is the caller graph for this function:

◆ setCategory()

void SetMessage::setCategory ( const ExerciseCategory  category)

Sets the category field to category.

Parameters
categoryThe field value to set.

Definition at line 265 of file setmessage.cpp.

266 {
267  Q_D(SetMessage);
268  d->category = category;
269 }
ExerciseCategory category() const
Returns the SetMessage data message's category field's current value.
Definition: setmessage.cpp:148

References category().

Here is the call graph for this function:

◆ setCategorySubtype()

void SetMessage::setCategorySubtype ( const quint16  categorySubtype)

Sets the categorySubtype field to categorySubtype.

Parameters
categorySubtypeThe field value to set.

Definition at line 275 of file setmessage.cpp.

276 {
277  Q_D(SetMessage);
278  d->categorySubtype = categorySubtype;
279 }
quint16 categorySubtype() const
Returns the SetMessage data message's categorySubtype field's current value.
Definition: setmessage.cpp:161

References categorySubtype().

Here is the call graph for this function:

◆ setDuration()

void SetMessage::setDuration ( const quint32  duration)

Sets the duration field to duration.

Parameters
durationThe field value to set.

Definition at line 215 of file setmessage.cpp.

216 {
217  Q_D(SetMessage);
218  d->duration = duration;
219 }
quint32 duration() const
Returns the SetMessage data message's duration field's current value.
Definition: setmessage.cpp:87

References duration().

Here is the call graph for this function:

◆ setMessageIndex()

void SetMessage::setMessageIndex ( const MessageIndex  messageIndex)

Sets the messageIndex field to messageIndex.

Parameters
messageIndexThe field value to set.

Definition at line 295 of file setmessage.cpp.

296 {
297  Q_D(SetMessage);
298  d->messageIndex = messageIndex;
299 }
MessageIndex messageIndex() const
Returns the SetMessage data message's messageIndex field's current value.
Definition: setmessage.cpp:183

References messageIndex().

Here is the call graph for this function:

◆ setRepetitions()

void SetMessage::setRepetitions ( const quint16  repetitions)

Sets the repetitions field to repetitions.

Parameters
repetitionsThe field value to set.

Definition at line 225 of file setmessage.cpp.

226 {
227  Q_D(SetMessage);
228  d->repetitions = repetitions;
229 }
quint16 repetitions() const
Returns the SetMessage data message's repetitions field's current value.
Definition: setmessage.cpp:100

References repetitions().

Here is the call graph for this function:

◆ setSetType()

void SetMessage::setSetType ( const SetType  setType)

Sets the setType field to setType.

Parameters
setTypeThe field value to set.

Definition at line 245 of file setmessage.cpp.

246 {
247  Q_D(SetMessage);
248  d->setType = setType;
249 }
SetType setType() const
Returns the SetMessage data message's setType field's current value.
Definition: setmessage.cpp:124

References setType().

Here is the call graph for this function:

◆ setStartTime()

void SetMessage::setStartTime ( const DateTime  startTime)

Sets the startTime field to startTime.

Parameters
startTimeThe field value to set.

Definition at line 255 of file setmessage.cpp.

256 {
257  Q_D(SetMessage);
258  d->startTime = startTime;
259 }
DateTime startTime() const
Returns the SetMessage data message's startTime field's current value.
Definition: setmessage.cpp:137

References startTime().

Here is the call graph for this function:

◆ setTimestamp()

void SetMessage::setTimestamp ( const DateTime  timestamp)

Sets the timestamp field to timestamp.

Parameters
timestampThe field value to set.

Definition at line 205 of file setmessage.cpp.

206 {
207  Q_D(SetMessage);
208  d->timestamp = timestamp;
209 }
DateTime timestamp() const
Returns the SetMessage data message's timestamp field's current value.
Definition: setmessage.cpp:76

References timestamp().

Here is the call graph for this function:

◆ setType()

SetType SetMessage::setType ( ) const

Returns the SetMessage data message's setType field's current value.

Returns
the setType field value.

Definition at line 124 of file setmessage.cpp.

125 {
126  Q_D(const SetMessage);
127  return d->setType;
128 }

Referenced by setSetType().

Here is the caller graph for this function:

◆ setWeight()

void SetMessage::setWeight ( const quint16  weight)

Sets the weight field to weight.

Parameters
weightThe field value to set.

Definition at line 235 of file setmessage.cpp.

236 {
237  Q_D(SetMessage);
238  d->weight = weight;
239 }
quint16 weight() const
Returns the SetMessage data message's weight field's current value.
Definition: setmessage.cpp:113

References weight().

Here is the call graph for this function:

◆ setWeightDisplayUnit()

void SetMessage::setWeightDisplayUnit ( const FitBaseUnit  weightDisplayUnit)

Sets the weightDisplayUnit field to weightDisplayUnit.

Parameters
weightDisplayUnitThe field value to set.

Definition at line 285 of file setmessage.cpp.

286 {
287  Q_D(SetMessage);
288  d->weightDisplayUnit = weightDisplayUnit;
289 }
FitBaseUnit weightDisplayUnit() const
Returns the SetMessage data message's weightDisplayUnit field's current value.
Definition: setmessage.cpp:172

References weightDisplayUnit().

Here is the call graph for this function:

◆ setWktStepIndex()

void SetMessage::setWktStepIndex ( const MessageIndex  wktStepIndex)

Sets the wktStepIndex field to wktStepIndex.

Parameters
wktStepIndexThe field value to set.

Definition at line 305 of file setmessage.cpp.

306 {
307  Q_D(SetMessage);
308  d->wktStepIndex = wktStepIndex;
309 }
MessageIndex wktStepIndex() const
Returns the SetMessage data message's wktStepIndex field's current value.
Definition: setmessage.cpp:194

References wktStepIndex().

Here is the call graph for this function:

◆ startTime()

DateTime SetMessage::startTime ( ) const

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

Start time of the set

Returns
the startTime field value.

Definition at line 137 of file setmessage.cpp.

138 {
139  Q_D(const SetMessage);
140  return d->startTime;
141 }

Referenced by setStartTime().

Here is the caller graph for this function:

◆ timestamp()

DateTime SetMessage::timestamp ( ) const

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

Timestamp of the set

Returns
the timestamp field value.

Definition at line 76 of file setmessage.cpp.

77 {
78  Q_D(const SetMessage);
79  return d->timestamp;
80 }

Referenced by setTimestamp().

Here is the caller graph for this function:

◆ weight()

quint16 SetMessage::weight ( ) const

Returns the SetMessage data message's weight field's current value.

Amount of weight applied for the set

Returns
the weight field value.

Definition at line 113 of file setmessage.cpp.

114 {
115  Q_D(const SetMessage);
116  return d->weight;
117 }

Referenced by setWeight().

Here is the caller graph for this function:

◆ weightDisplayUnit()

FitBaseUnit SetMessage::weightDisplayUnit ( ) const

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

Returns
the weightDisplayUnit field value.

Definition at line 172 of file setmessage.cpp.

173 {
174  Q_D(const SetMessage);
175  return d->weightDisplayUnit;
176 }

Referenced by setWeightDisplayUnit().

Here is the caller graph for this function:

◆ wktStepIndex()

MessageIndex SetMessage::wktStepIndex ( ) const

Returns the SetMessage data message's wktStepIndex field's current value.

Returns
the wktStepIndex field value.

Definition at line 194 of file setmessage.cpp.

195 {
196  Q_D(const SetMessage);
197  return d->wktStepIndex;
198 }

Referenced by setWktStepIndex().

Here is the caller graph for this function:

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