SegmentLeaderboardEntryMessage Class Reference

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

Inheritance diagram for SegmentLeaderboardEntryMessage:

Collaboration diagram for SegmentLeaderboardEntryMessage:

Public Member Functions
	SegmentLeaderboardEntryMessage ()
	Constructs a SegmentLeaderboardEntryMessage object. More...
MessageIndex	messageIndex () const
	Returns the SegmentLeaderboardEntryMessage data message's messageIndex field's current value. More...
QString	name () const
	Returns the SegmentLeaderboardEntryMessage data message's name field's current value. More...
SegmentLeaderboardType	type () const
	Returns the SegmentLeaderboardEntryMessage data message's type field's current value. More...
quint32	groupPrimaryKey () const
	Returns the SegmentLeaderboardEntryMessage data message's groupPrimaryKey field's current value. More...
quint32	activityId () const
	Returns the SegmentLeaderboardEntryMessage data message's activityId field's current value. More...
quint32	segmentTime () const
	Returns the SegmentLeaderboardEntryMessage data message's segmentTime field's current value. More...
QString	activityIdString () const
	Returns the SegmentLeaderboardEntryMessage data message's activityIdString field's current value. More...
void	setMessageIndex (const MessageIndex messageIndex)
	Sets the messageIndex field to messageIndex. More...
void	setName (const QString name)
	Sets the name field to name. More...
void	setType (const SegmentLeaderboardType type)
	Sets the type field to type. More...
void	setGroupPrimaryKey (const quint32 groupPrimaryKey)
	Sets the groupPrimaryKey field to groupPrimaryKey. More...
void	setActivityId (const quint32 activityId)
	Sets the activityId field to activityId. More...
void	setSegmentTime (const quint32 segmentTime)
	Sets the segmentTime field to segmentTime. More...
void	setActivityIdString (const QString activityIdString)
	Sets the activityIdString field to activityIdString. 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
	SegmentLeaderboardEntryMessage (SegmentLeaderboardEntryMessagePrivate *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 SegmentLeaderboardEntryMessage class represents a FIT SegmentLeaderboardEntryMessage data message.

See also

DataMessage

Definition at line 39 of file segmentleaderboardentrymessage.h.

Constructor & Destructor Documentation

SegmentLeaderboardEntryMessage() [1/2]

SegmentLeaderboardEntryMessage::SegmentLeaderboardEntryMessage

(

)

Constructs a SegmentLeaderboardEntryMessage 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 segmentleaderboardentrymessage.cpp.

                                                               : AbstractDataMessage(new SegmentLeaderboardEntryMessagePrivate(this))
{
 
}

SegmentLeaderboardEntryMessage() [2/2]

SegmentLeaderboardEntryMessage::SegmentLeaderboardEntryMessage ( SegmentLeaderboardEntryMessagePrivate *const  d )

explicitprotected

Constructs a SegmentLeaderboardEntryMessage object with private implementation d.

Parameters

d	Pointer to private implementation.

Definition at line 64 of file segmentleaderboardentrymessage.cpp.

                                                                                                              : AbstractDataMessage(d)
{
 
}

Member Function Documentation

activityId()

quint32 SegmentLeaderboardEntryMessage::activityId

(

)

const

Returns the SegmentLeaderboardEntryMessage data message's activityId field's current value.

ID of the activity associated with this leader time

Returns

the activityId field value.

Definition at line 126 of file segmentleaderboardentrymessage.cpp.

{
    Q_D(const SegmentLeaderboardEntryMessage);
    return d->activityId;
}

Referenced by setActivityId().

Here is the caller graph for this function:

activityIdString()

QString SegmentLeaderboardEntryMessage::activityIdString

(

)

const

Returns the SegmentLeaderboardEntryMessage data message's activityIdString field's current value.

String version of the activity_id. 21 characters long, express in decimal

Returns

the activityIdString field value.

Definition at line 152 of file segmentleaderboardentrymessage.cpp.

{
    Q_D(const SegmentLeaderboardEntryMessage);
    return d->activityIdString;
}

Referenced by setActivityIdString().

Here is the caller graph for this function:

groupPrimaryKey()

quint32 SegmentLeaderboardEntryMessage::groupPrimaryKey

(

)

const

Returns the SegmentLeaderboardEntryMessage data message's groupPrimaryKey field's current value.

Primary user ID of this leader

Returns

the groupPrimaryKey field value.

Definition at line 113 of file segmentleaderboardentrymessage.cpp.

{
    Q_D(const SegmentLeaderboardEntryMessage);
    return d->groupPrimaryKey;
}

Referenced by setGroupPrimaryKey().

Here is the caller graph for this function:

messageIndex()

MessageIndex SegmentLeaderboardEntryMessage::messageIndex

(

)

const

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

Returns

the messageIndex field value.

Definition at line 74 of file segmentleaderboardentrymessage.cpp.

{
    Q_D(const SegmentLeaderboardEntryMessage);
    return d->messageIndex;
}

Referenced by setMessageIndex().

Here is the caller graph for this function:

name()

QString SegmentLeaderboardEntryMessage::name

(

)

const

Returns the SegmentLeaderboardEntryMessage data message's name field's current value.

Friendly name assigned to leader

Returns

the name field value.

Definition at line 87 of file segmentleaderboardentrymessage.cpp.

{
    Q_D(const SegmentLeaderboardEntryMessage);
    return d->name;
}

Referenced by setName().

Here is the caller graph for this function:

segmentTime()

quint32 SegmentLeaderboardEntryMessage::segmentTime

(

)

const

Returns the SegmentLeaderboardEntryMessage data message's segmentTime field's current value.

Segment Time (includes pauses)

Returns

the segmentTime field value.

Definition at line 139 of file segmentleaderboardentrymessage.cpp.

{
    Q_D(const SegmentLeaderboardEntryMessage);
    return d->segmentTime;
}

Referenced by setSegmentTime().

Here is the caller graph for this function:

setActivityId()

void SegmentLeaderboardEntryMessage::setActivityId

(

const quint32

activityId

)

Sets the activityId field to activityId.

Parameters

activityId

The field value to set.

Definition at line 203 of file segmentleaderboardentrymessage.cpp.

{
    Q_D(SegmentLeaderboardEntryMessage);
    d->activityId = activityId;
}

References activityId().

Here is the call graph for this function:

setActivityIdString()

void SegmentLeaderboardEntryMessage::setActivityIdString

(

const QString

activityIdString

)

Sets the activityIdString field to activityIdString.

Parameters

activityIdString

The field value to set.

Definition at line 223 of file segmentleaderboardentrymessage.cpp.

{
    Q_D(SegmentLeaderboardEntryMessage);
    d->activityIdString = activityIdString;
}

References activityIdString().

Here is the call graph for this function:

setGroupPrimaryKey()

void SegmentLeaderboardEntryMessage::setGroupPrimaryKey

(

const quint32

groupPrimaryKey

)

Sets the groupPrimaryKey field to groupPrimaryKey.

Parameters

groupPrimaryKey

The field value to set.

Definition at line 193 of file segmentleaderboardentrymessage.cpp.

{
    Q_D(SegmentLeaderboardEntryMessage);
    d->groupPrimaryKey = groupPrimaryKey;
}

References groupPrimaryKey().

Here is the call graph for this function:

setMessageIndex()

void SegmentLeaderboardEntryMessage::setMessageIndex

(

const MessageIndex

messageIndex

)

Sets the messageIndex field to messageIndex.

Parameters

messageIndex

The field value to set.

Definition at line 163 of file segmentleaderboardentrymessage.cpp.

{
    Q_D(SegmentLeaderboardEntryMessage);
    d->messageIndex = messageIndex;
}

References messageIndex().

Here is the call graph for this function:

setName()

void SegmentLeaderboardEntryMessage::setName

(

const QString

name

)

Sets the name field to name.

Parameters

name	The field value to set.

Definition at line 173 of file segmentleaderboardentrymessage.cpp.

{
    Q_D(SegmentLeaderboardEntryMessage);
    d->name = name;
}

References name().

Here is the call graph for this function:

setSegmentTime()

void SegmentLeaderboardEntryMessage::setSegmentTime

(

const quint32

segmentTime

)

Sets the segmentTime field to segmentTime.

Parameters

segmentTime

The field value to set.

Definition at line 213 of file segmentleaderboardentrymessage.cpp.

{
    Q_D(SegmentLeaderboardEntryMessage);
    d->segmentTime = segmentTime;
}

References segmentTime().

Here is the call graph for this function:

setType()

void SegmentLeaderboardEntryMessage::setType

(

const SegmentLeaderboardType

type

)

Sets the type field to type.

Parameters

type	The field value to set.

Definition at line 183 of file segmentleaderboardentrymessage.cpp.

{
    Q_D(SegmentLeaderboardEntryMessage);
    d->type = type;
}

References type().

Here is the call graph for this function:

type()

SegmentLeaderboardType SegmentLeaderboardEntryMessage::type

(

)

const

Returns the SegmentLeaderboardEntryMessage data message's type field's current value.

Leader classification

Returns

the type field value.

Definition at line 100 of file segmentleaderboardentrymessage.cpp.

{
    Q_D(const SegmentLeaderboardEntryMessage);
    return d->type;
}

Referenced by setType().

Here is the caller graph for this function:

---

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

• segmentleaderboardentrymessage.h
• segmentleaderboardentrymessage.cpp