WorkoutMessage Class Reference

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

Inheritance diagram for WorkoutMessage:

Collaboration diagram for WorkoutMessage:

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

Protected Member Functions
	WorkoutMessage (WorkoutMessagePrivate *const d)
Protected Member Functions inherited from AbstractDataMessage
	AbstractDataMessage (AbstractDataMessagePrivate *const d)

Additional Inherited Members
Static Public Member Functions inherited from AbstractDataMessage
static AbstractDataMessage *	fromData (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 WorkoutMessage class represents a FIT WorkoutMessage data message.

See also

DataMessage

Definition at line 39 of file workoutmessage.h.

Constructor & Destructor Documentation

WorkoutMessage() [1/2]

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.

Definition at line 52 of file workoutmessage.cpp.

                               : AbstractDataMessage(new WorkoutMessagePrivate(this))
{
 
}

WorkoutMessage() [2/2]

WorkoutMessage::WorkoutMessage ( WorkoutMessagePrivate *const  d )

explicitprotected

Constructs a WorkoutMessage object with private implementation d.

Parameters

d	Pointer to private implementation.

Definition at line 64 of file workoutmessage.cpp.

                                                              : AbstractDataMessage(d)
{
 
}

Member Function Documentation

capabilities()

WorkoutCapabilities WorkoutMessage::capabilities

(

)

const

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

Returns

the capabilities field value.

Definition at line 85 of file workoutmessage.cpp.

{
    Q_D(const WorkoutMessage);
    return d->capabilities;
}

Referenced by setCapabilities().

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.

Definition at line 98 of file workoutmessage.cpp.

{
    Q_D(const WorkoutMessage);
    return d->numValidSteps;
}

Referenced by setNumValidSteps().

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.

Definition at line 131 of file workoutmessage.cpp.

{
    Q_D(const WorkoutMessage);
    return d->poolLength;
}

Referenced by setPoolLength().

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.

Definition at line 142 of file workoutmessage.cpp.

{
    Q_D(const WorkoutMessage);
    return d->poolLengthUnit;
}

Referenced by setPoolLengthUnit().

Here is the caller graph for this function:

setCapabilities()

void WorkoutMessage::setCapabilities

(

const WorkoutCapabilities

capabilities

)

Sets the capabilities field to capabilities.

Parameters

capabilities

The field value to set.

Definition at line 163 of file workoutmessage.cpp.

{
    Q_D(WorkoutMessage);
    d->capabilities = capabilities;
}

References capabilities().

Here is the call graph for this function:

setNumValidSteps()

void WorkoutMessage::setNumValidSteps

(

const quint16

numValidSteps

)

Sets the numValidSteps field to numValidSteps.

Parameters

numValidSteps

The field value to set.

Definition at line 173 of file workoutmessage.cpp.

{
    Q_D(WorkoutMessage);
    d->numValidSteps = numValidSteps;
}

References numValidSteps().

Here is the call graph for this function:

setPoolLength()

void WorkoutMessage::setPoolLength

(

const quint16

poolLength

)

Sets the poolLength field to poolLength.

Parameters

poolLength

The field value to set.

Definition at line 203 of file workoutmessage.cpp.

{
    Q_D(WorkoutMessage);
    d->poolLength = poolLength;
}

References poolLength().

Here is the call graph for this function:

setPoolLengthUnit()

void WorkoutMessage::setPoolLengthUnit

(

const DisplayMeasure

poolLengthUnit

)

Sets the poolLengthUnit field to poolLengthUnit.

Parameters

poolLengthUnit

The field value to set.

Definition at line 213 of file workoutmessage.cpp.

{
    Q_D(WorkoutMessage);
    d->poolLengthUnit = poolLengthUnit;
}

References poolLengthUnit().

Here is the call graph for this function:

setSport()

void WorkoutMessage::setSport

(

const Sport

sport

)

Sets the sport field to sport.

Parameters

sport

The field value to set.

Definition at line 153 of file workoutmessage.cpp.

{
    Q_D(WorkoutMessage);
    d->sport = sport;
}

References sport().

Here is the call graph for this function:

setSubSport()

void WorkoutMessage::setSubSport

(

const SubSport

subSport

)

Sets the subSport field to subSport.

Parameters

subSport

The field value to set.

Definition at line 193 of file workoutmessage.cpp.

{
    Q_D(WorkoutMessage);
    d->subSport = subSport;
}

References subSport().

Here is the call graph for this function:

setWktName()

void WorkoutMessage::setWktName

(

const QString

wktName

)

Sets the wktName field to wktName.

Parameters

wktName

The field value to set.

Definition at line 183 of file workoutmessage.cpp.

{
    Q_D(WorkoutMessage);
    d->wktName = wktName;
}

References wktName().

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.

Definition at line 74 of file workoutmessage.cpp.

{
    Q_D(const WorkoutMessage);
    return d->sport;
}

Referenced by setSport().

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.

Definition at line 120 of file workoutmessage.cpp.

{
    Q_D(const WorkoutMessage);
    return d->subSport;
}

Referenced by setSubSport().

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.

Definition at line 109 of file workoutmessage.cpp.

{
    Q_D(const WorkoutMessage);
    return d->wktName;
}

Referenced by setWktName().

Here is the caller graph for this function:

---

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

• workoutmessage.h
• workoutmessage.cpp