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

Inheritance diagram for SegmentFileMessage:

Collaboration diagram for SegmentFileMessage:

Public Member Functions
	SegmentFileMessage ()
	Constructs a SegmentFileMessage object. More...

MessageIndex	messageIndex () const
	Returns the SegmentFileMessage data message's `messageIndex` field's current value. More...

QString	fileUuid () const
	Returns the SegmentFileMessage data message's `fileUuid` field's current value. More...

bool	enabled () const
	Returns the SegmentFileMessage data message's `enabled` field's current value. More...

quint32	userProfilePrimaryKey () const
	Returns the SegmentFileMessage data message's `userProfilePrimaryKey` field's current value. More...

SegmentLeaderboardType	leaderType () const
	Returns the SegmentFileMessage data message's `leaderType` field's current value. More...

quint32	leaderGroupPrimaryKey () const
	Returns the SegmentFileMessage data message's `leaderGroupPrimaryKey` field's current value. More...

quint32	leaderActivityId () const
	Returns the SegmentFileMessage data message's `leaderActivityId` field's current value. More...

QString	leaderActivityIdString () const
	Returns the SegmentFileMessage data message's `leaderActivityIdString` field's current value. More...

quint8	defaultRaceLeader () const
	Returns the SegmentFileMessage data message's `defaultRaceLeader` field's current value. More...

void	setMessageIndex (const MessageIndex messageIndex)
	Sets the `messageIndex` field to messageIndex. More...

void	setFileUuid (const QString fileUuid)
	Sets the `fileUuid` field to fileUuid. More...

void	setEnabled (const bool enabled)
	Sets the `enabled` field to enabled. More...

void	setUserProfilePrimaryKey (const quint32 userProfilePrimaryKey)
	Sets the `userProfilePrimaryKey` field to userProfilePrimaryKey. More...

void	setLeaderType (const SegmentLeaderboardType leaderType)
	Sets the `leaderType` field to leaderType. More...

void	setLeaderGroupPrimaryKey (const quint32 leaderGroupPrimaryKey)
	Sets the `leaderGroupPrimaryKey` field to leaderGroupPrimaryKey. More...

void	setLeaderActivityId (const quint32 leaderActivityId)
	Sets the `leaderActivityId` field to leaderActivityId. More...

void	setLeaderActivityIdString (const QString leaderActivityIdString)
	Sets the `leaderActivityIdString` field to leaderActivityIdString. More...

void	setDefaultRaceLeader (const quint8 defaultRaceLeader)
	Sets the `defaultRaceLeader` field to defaultRaceLeader. 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 AbstractDataMessage *	fromData (const DataDefinition *const defn, const QByteArray &record)
	Constructs the relevant AbstractDataMessage-derived class to parse record according to defn. More...

Detailed Description

The SegmentFileMessage class represents a FIT SegmentFileMessage data message.

See also: DataMessage

Constructor & Destructor Documentation

◆ SegmentFileMessage()

SegmentFileMessage::SegmentFileMessage ( )

Constructs a SegmentFileMessage 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

◆ defaultRaceLeader()

quint8 SegmentFileMessage::defaultRaceLeader ( ) const

Returns the SegmentFileMessage data message's defaultRaceLeader field's current value.

Index for the Leader Board entry selected as the default race participant

Returns: the defaultRaceLeader field value.

Here is the caller graph for this function:

◆ enabled()

bool SegmentFileMessage::enabled ( ) const

Returns the SegmentFileMessage data message's enabled field's current value.

Enabled state of the segment file

Returns: the enabled field value.

Here is the caller graph for this function:

◆ fileUuid()

QString SegmentFileMessage::fileUuid ( ) const

Returns the SegmentFileMessage data message's fileUuid field's current value.

UUID of the segment file

Returns: the fileUuid field value.

Here is the caller graph for this function:

◆ leaderActivityId()

quint32 SegmentFileMessage::leaderActivityId ( ) const

Returns the SegmentFileMessage data message's leaderActivityId field's current value.

Activity ID of each leader in the segment file

Returns: the leaderActivityId field value.

Here is the caller graph for this function:

◆ leaderActivityIdString()

QString SegmentFileMessage::leaderActivityIdString ( ) const

Returns the SegmentFileMessage data message's leaderActivityIdString field's current value.

String version of the activity ID of each leader in the segment file. 21 characters long for each ID, express in decimal

Returns: the leaderActivityIdString field value.

Here is the caller graph for this function:

◆ leaderGroupPrimaryKey()

quint32 SegmentFileMessage::leaderGroupPrimaryKey ( ) const

Returns the SegmentFileMessage data message's leaderGroupPrimaryKey field's current value.

Group primary key of each leader in the segment file

Returns: the leaderGroupPrimaryKey field value.

Here is the caller graph for this function:

◆ leaderType()

SegmentLeaderboardType SegmentFileMessage::leaderType ( ) const

Returns the SegmentFileMessage data message's leaderType field's current value.

Leader type of each leader in the segment file

Returns: the leaderType field value.

Here is the caller graph for this function:

◆ messageIndex()

MessageIndex SegmentFileMessage::messageIndex ( ) const

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

Returns: the messageIndex field value.

Here is the caller graph for this function:

◆ setDefaultRaceLeader()

void SegmentFileMessage::setDefaultRaceLeader ( const quint8 defaultRaceLeader )

Sets the defaultRaceLeader field to defaultRaceLeader.

Parameters

defaultRaceLeader The field value to set.

Here is the call graph for this function:

◆ setEnabled()

void SegmentFileMessage::setEnabled ( const bool enabled )

Sets the enabled field to enabled.

Parameters

enabled The field value to set.

Here is the call graph for this function:

◆ setFileUuid()

void SegmentFileMessage::setFileUuid ( const QString fileUuid )

Sets the fileUuid field to fileUuid.

Parameters

fileUuid The field value to set.

Here is the call graph for this function:

◆ setLeaderActivityId()

void SegmentFileMessage::setLeaderActivityId ( const quint32 leaderActivityId )

Sets the leaderActivityId field to leaderActivityId.

Parameters

leaderActivityId The field value to set.

Here is the call graph for this function:

◆ setLeaderActivityIdString()

void SegmentFileMessage::setLeaderActivityIdString ( const QString leaderActivityIdString )

Sets the leaderActivityIdString field to leaderActivityIdString.

Parameters

leaderActivityIdString The field value to set.

Here is the call graph for this function:

◆ setLeaderGroupPrimaryKey()

void SegmentFileMessage::setLeaderGroupPrimaryKey ( const quint32 leaderGroupPrimaryKey )

Sets the leaderGroupPrimaryKey field to leaderGroupPrimaryKey.

Parameters

leaderGroupPrimaryKey The field value to set.

Here is the call graph for this function:

◆ setLeaderType()

void SegmentFileMessage::setLeaderType ( const SegmentLeaderboardType leaderType )

Sets the leaderType field to leaderType.

Parameters

leaderType The field value to set.

Here is the call graph for this function:

◆ setMessageIndex()

void SegmentFileMessage::setMessageIndex ( const MessageIndex messageIndex )

Sets the messageIndex field to messageIndex.

Parameters

messageIndex The field value to set.

Here is the call graph for this function:

◆ setUserProfilePrimaryKey()

void SegmentFileMessage::setUserProfilePrimaryKey ( const quint32 userProfilePrimaryKey )

Sets the userProfilePrimaryKey field to userProfilePrimaryKey.

Parameters

userProfilePrimaryKey The field value to set.

Here is the call graph for this function:

◆ userProfilePrimaryKey()

quint32 SegmentFileMessage::userProfilePrimaryKey ( ) const

Returns the SegmentFileMessage data message's userProfilePrimaryKey field's current value.

Primary key of the user that created the segment file

Returns: the userProfilePrimaryKey field value.

Here is the caller graph for this function:

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SegmentFileMessage()

Member Function Documentation

◆ defaultRaceLeader()

◆ enabled()

◆ fileUuid()

◆ leaderActivityId()

◆ leaderActivityIdString()

◆ leaderGroupPrimaryKey()

◆ leaderType()

◆ messageIndex()

◆ setDefaultRaceLeader()

◆ setEnabled()

◆ setFileUuid()

◆ setLeaderActivityId()

◆ setLeaderActivityIdString()

◆ setLeaderGroupPrimaryKey()

◆ setLeaderType()

◆ setMessageIndex()

◆ setUserProfilePrimaryKey()

◆ userProfilePrimaryKey()