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

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

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

Public Member Functions

 WorkoutSessionMessage ()
 Constructs a WorkoutSessionMessage object. More...
 
MessageIndex messageIndex () const
 Returns the WorkoutSessionMessage data message's messageIndex field's current value. More...
 
Sport sport () const
 Returns the WorkoutSessionMessage data message's sport field's current value. More...
 
SubSport subSport () const
 Returns the WorkoutSessionMessage data message's subSport field's current value. More...
 
quint16 numValidSteps () const
 Returns the WorkoutSessionMessage data message's numValidSteps field's current value. More...
 
quint16 firstStepIndex () const
 Returns the WorkoutSessionMessage data message's firstStepIndex field's current value. More...
 
quint16 poolLength () const
 Returns the WorkoutSessionMessage data message's poolLength field's current value. More...
 
DisplayMeasure poolLengthUnit () const
 Returns the WorkoutSessionMessage data message's poolLengthUnit field's current value. More...
 
void setMessageIndex (const MessageIndex messageIndex)
 Sets the messageIndex field to messageIndex. More...
 
void setSport (const Sport sport)
 Sets the sport field to sport. More...
 
void setSubSport (const SubSport subSport)
 Sets the subSport field to subSport. More...
 
void setNumValidSteps (const quint16 numValidSteps)
 Sets the numValidSteps field to numValidSteps. More...
 
void setFirstStepIndex (const quint16 firstStepIndex)
 Sets the firstStepIndex field to firstStepIndex. More...
 
void setPoolLength (const quint16 poolLength)
 Sets the poolLength field to poolLength. More...
 
void setPoolLengthUnit (const DisplayMeasure poolLengthUnit)
 Sets the poolLengthUnit field to poolLengthUnit. 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

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

See also
DataMessage

Definition at line 39 of file workoutsessionmessage.h.

Constructor & Destructor Documentation

◆ WorkoutSessionMessage() [1/2]

WorkoutSessionMessage::WorkoutSessionMessage ( )

Constructs a WorkoutSessionMessage 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 workoutsessionmessage.cpp.

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

◆ WorkoutSessionMessage() [2/2]

WorkoutSessionMessage::WorkoutSessionMessage ( WorkoutSessionMessagePrivate *const  d)
explicitprotected

Constructs a WorkoutSessionMessage object with private implementation d.

Parameters
dPointer to private implementation.

Definition at line 64 of file workoutsessionmessage.cpp.

65 {
66 
67 }

Member Function Documentation

◆ firstStepIndex()

quint16 WorkoutSessionMessage::firstStepIndex ( ) const

Returns the WorkoutSessionMessage data message's firstStepIndex field's current value.

Returns
the firstStepIndex field value.

Definition at line 118 of file workoutsessionmessage.cpp.

119 {
120  Q_D(const WorkoutSessionMessage);
121  return d->firstStepIndex;
122 }
The WorkoutSessionMessage class represents a FIT WorkoutSessionMessage data message.

Referenced by setFirstStepIndex().

Here is the caller graph for this function:

◆ messageIndex()

MessageIndex WorkoutSessionMessage::messageIndex ( ) const

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

Returns
the messageIndex field value.

Definition at line 74 of file workoutsessionmessage.cpp.

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

Referenced by setMessageIndex().

Here is the caller graph for this function:

◆ numValidSteps()

quint16 WorkoutSessionMessage::numValidSteps ( ) const

Returns the WorkoutSessionMessage data message's numValidSteps field's current value.

Returns
the numValidSteps field value.

Definition at line 107 of file workoutsessionmessage.cpp.

108 {
109  Q_D(const WorkoutSessionMessage);
110  return d->numValidSteps;
111 }

Referenced by setNumValidSteps().

Here is the caller graph for this function:

◆ poolLength()

quint16 WorkoutSessionMessage::poolLength ( ) const

Returns the WorkoutSessionMessage data message's poolLength field's current value.

Returns
the poolLength field value.

Definition at line 129 of file workoutsessionmessage.cpp.

130 {
131  Q_D(const WorkoutSessionMessage);
132  return d->poolLength;
133 }

Referenced by setPoolLength().

Here is the caller graph for this function:

◆ poolLengthUnit()

DisplayMeasure WorkoutSessionMessage::poolLengthUnit ( ) const

Returns the WorkoutSessionMessage data message's poolLengthUnit field's current value.

Returns
the poolLengthUnit field value.

Definition at line 140 of file workoutsessionmessage.cpp.

141 {
142  Q_D(const WorkoutSessionMessage);
143  return d->poolLengthUnit;
144 }

Referenced by setPoolLengthUnit().

Here is the caller graph for this function:

◆ setFirstStepIndex()

void WorkoutSessionMessage::setFirstStepIndex ( const quint16  firstStepIndex)

Sets the firstStepIndex field to firstStepIndex.

Parameters
firstStepIndexThe field value to set.

Definition at line 191 of file workoutsessionmessage.cpp.

192 {
194  d->firstStepIndex = firstStepIndex;
195 }
quint16 firstStepIndex() const
Returns the WorkoutSessionMessage data message's firstStepIndex field's current value.

References firstStepIndex().

Here is the call graph for this function:

◆ setMessageIndex()

void WorkoutSessionMessage::setMessageIndex ( const MessageIndex  messageIndex)

Sets the messageIndex field to messageIndex.

Parameters
messageIndexThe field value to set.

Definition at line 151 of file workoutsessionmessage.cpp.

152 {
154  d->messageIndex = messageIndex;
155 }
MessageIndex messageIndex() const
Returns the WorkoutSessionMessage data message's messageIndex field's current value.

References messageIndex().

Here is the call graph for this function:

◆ setNumValidSteps()

void WorkoutSessionMessage::setNumValidSteps ( const quint16  numValidSteps)

Sets the numValidSteps field to numValidSteps.

Parameters
numValidStepsThe field value to set.

Definition at line 181 of file workoutsessionmessage.cpp.

182 {
184  d->numValidSteps = numValidSteps;
185 }
quint16 numValidSteps() const
Returns the WorkoutSessionMessage data message's numValidSteps field's current value.

References numValidSteps().

Here is the call graph for this function:

◆ setPoolLength()

void WorkoutSessionMessage::setPoolLength ( const quint16  poolLength)

Sets the poolLength field to poolLength.

Parameters
poolLengthThe field value to set.

Definition at line 201 of file workoutsessionmessage.cpp.

202 {
204  d->poolLength = poolLength;
205 }
quint16 poolLength() const
Returns the WorkoutSessionMessage data message's poolLength field's current value.

References poolLength().

Here is the call graph for this function:

◆ setPoolLengthUnit()

void WorkoutSessionMessage::setPoolLengthUnit ( const DisplayMeasure  poolLengthUnit)

Sets the poolLengthUnit field to poolLengthUnit.

Parameters
poolLengthUnitThe field value to set.

Definition at line 211 of file workoutsessionmessage.cpp.

212 {
214  d->poolLengthUnit = poolLengthUnit;
215 }
DisplayMeasure poolLengthUnit() const
Returns the WorkoutSessionMessage data message's poolLengthUnit field's current value.

References poolLengthUnit().

Here is the call graph for this function:

◆ setSport()

void WorkoutSessionMessage::setSport ( const Sport  sport)

Sets the sport field to sport.

Parameters
sportThe field value to set.

Definition at line 161 of file workoutsessionmessage.cpp.

162 {
164  d->sport = sport;
165 }
Sport sport() const
Returns the WorkoutSessionMessage data message's sport field's current value.

References sport().

Here is the call graph for this function:

◆ setSubSport()

void WorkoutSessionMessage::setSubSport ( const SubSport  subSport)

Sets the subSport field to subSport.

Parameters
subSportThe field value to set.

Definition at line 171 of file workoutsessionmessage.cpp.

172 {
174  d->subSport = subSport;
175 }
SubSport subSport() const
Returns the WorkoutSessionMessage data message's subSport field's current value.

References subSport().

Here is the call graph for this function:

◆ sport()

Sport WorkoutSessionMessage::sport ( ) const

Returns the WorkoutSessionMessage data message's sport field's current value.

Returns
the sport field value.

Definition at line 85 of file workoutsessionmessage.cpp.

86 {
87  Q_D(const WorkoutSessionMessage);
88  return d->sport;
89 }

Referenced by setSport().

Here is the caller graph for this function:

◆ subSport()

SubSport WorkoutSessionMessage::subSport ( ) const

Returns the WorkoutSessionMessage data message's subSport field's current value.

Returns
the subSport field value.

Definition at line 96 of file workoutsessionmessage.cpp.

97 {
98  Q_D(const WorkoutSessionMessage);
99  return d->subSport;
100 }

Referenced by setSubSport().

Here is the caller graph for this function:

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