QtFit  0.1
Native Qt library for Garmin FIT format
All Classes Files Functions Variables Typedefs Enumerations Enumerator Pages
WorkoutMessage Class Reference

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

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

Public Member Functions

 WorkoutMessage ()
 Constructs a WorkoutMessage object. More...
 
Sport sport () const
 Returns the WorkoutMessage data message's sport field's current value. More...
 
WorkoutCapabilities capabilities () const
 Returns the WorkoutMessage data message's capabilities field's current value. More...
 
quint16 numValidSteps () const
 Returns the WorkoutMessage data message's numValidSteps field's current value. More...
 
QString wktName () const
 Returns the WorkoutMessage data message's wktName field's current value. More...
 
SubSport subSport () const
 Returns the WorkoutMessage data message's subSport field's current value. More...
 
quint16 poolLength () const
 Returns the WorkoutMessage data message's poolLength field's current value. More...
 
DisplayMeasure poolLengthUnit () const
 Returns the WorkoutMessage data message's poolLengthUnit field's current value. More...
 
void setSport (const Sport sport)
 Sets the sport field to sport. More...
 
void setCapabilities (const WorkoutCapabilities capabilities)
 Sets the capabilities field to capabilities. More...
 
void setNumValidSteps (const quint16 numValidSteps)
 Sets the numValidSteps field to numValidSteps. More...
 
void setWktName (const QString wktName)
 Sets the wktName field to wktName. More...
 
void setSubSport (const SubSport subSport)
 Sets the subSport field to subSport. 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...
 

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...
 

Detailed Description

The WorkoutMessage class represents a FIT WorkoutMessage data message.

See also
DataMessage

Constructor & Destructor Documentation

◆ WorkoutMessage()

WorkoutMessage::WorkoutMessage ( )

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

Member Function Documentation

◆ capabilities()

WorkoutCapabilities WorkoutMessage::capabilities ( ) const

Returns the WorkoutMessage data message's capabilities field's current value.

Returns
the capabilities field value.
Here is the caller graph for this function:

◆ numValidSteps()

quint16 WorkoutMessage::numValidSteps ( ) const

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

number of valid steps

Returns
the numValidSteps field value.
Here is the caller graph for this function:

◆ poolLength()

quint16 WorkoutMessage::poolLength ( ) const

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

Returns
the poolLength field value.
Here is the caller graph for this function:

◆ poolLengthUnit()

DisplayMeasure WorkoutMessage::poolLengthUnit ( ) const

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

Returns
the poolLengthUnit field value.
Here is the caller graph for this function:

◆ setCapabilities()

void WorkoutMessage::setCapabilities ( const WorkoutCapabilities  capabilities)

Sets the capabilities field to capabilities.

Parameters
capabilitiesThe field value to set.
Here is the call graph for this function:

◆ setNumValidSteps()

void WorkoutMessage::setNumValidSteps ( const quint16  numValidSteps)

Sets the numValidSteps field to numValidSteps.

Parameters
numValidStepsThe field value to set.
Here is the call graph for this function:

◆ setPoolLength()

void WorkoutMessage::setPoolLength ( const quint16  poolLength)

Sets the poolLength field to poolLength.

Parameters
poolLengthThe field value to set.
Here is the call graph for this function:

◆ setPoolLengthUnit()

void WorkoutMessage::setPoolLengthUnit ( const DisplayMeasure  poolLengthUnit)

Sets the poolLengthUnit field to poolLengthUnit.

Parameters
poolLengthUnitThe field value to set.
Here is the call graph for this function:

◆ setSport()

void WorkoutMessage::setSport ( const Sport  sport)

Sets the sport field to sport.

Parameters
sportThe field value to set.
Here is the call graph for this function:

◆ setSubSport()

void WorkoutMessage::setSubSport ( const SubSport  subSport)

Sets the subSport field to subSport.

Parameters
subSportThe field value to set.
Here is the call graph for this function:

◆ setWktName()

void WorkoutMessage::setWktName ( const QString  wktName)

Sets the wktName field to wktName.

Parameters
wktNameThe field value to set.
Here is the call graph for this function:

◆ sport()

Sport WorkoutMessage::sport ( ) const

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

Returns
the sport field value.
Here is the caller graph for this function:

◆ subSport()

SubSport WorkoutMessage::subSport ( ) const

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

Returns
the subSport field value.
Here is the caller graph for this function:

◆ wktName()

QString WorkoutMessage::wktName ( ) const

Returns the WorkoutMessage data message's wktName field's current value.

Returns
the wktName field value.
Here is the caller graph for this function:

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