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

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

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

Public Member Functions

 SegmentIdMessage ()
 Constructs a SegmentIdMessage object. More...
 
QString name () const
 Returns the SegmentIdMessage data message's name field's current value. More...
 
QString uuid () const
 Returns the SegmentIdMessage data message's uuid field's current value. More...
 
Sport sport () const
 Returns the SegmentIdMessage data message's sport field's current value. More...
 
bool enabled () const
 Returns the SegmentIdMessage data message's enabled field's current value. More...
 
quint32 userProfilePrimaryKey () const
 Returns the SegmentIdMessage data message's userProfilePrimaryKey field's current value. More...
 
quint32 deviceId () const
 Returns the SegmentIdMessage data message's deviceId field's current value. More...
 
quint8 defaultRaceLeader () const
 Returns the SegmentIdMessage data message's defaultRaceLeader field's current value. More...
 
SegmentDeleteStatus deleteStatus () const
 Returns the SegmentIdMessage data message's deleteStatus field's current value. More...
 
SegmentSelectionType selectionType () const
 Returns the SegmentIdMessage data message's selectionType field's current value. More...
 
void setName (const QString name)
 Sets the name field to name. More...
 
void setUuid (const QString uuid)
 Sets the uuid field to uuid. More...
 
void setSport (const Sport sport)
 Sets the sport field to sport. 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 setDeviceId (const quint32 deviceId)
 Sets the deviceId field to deviceId. More...
 
void setDefaultRaceLeader (const quint8 defaultRaceLeader)
 Sets the defaultRaceLeader field to defaultRaceLeader. More...
 
void setDeleteStatus (const SegmentDeleteStatus deleteStatus)
 Sets the deleteStatus field to deleteStatus. More...
 
void setSelectionType (const SegmentSelectionType selectionType)
 Sets the selectionType field to selectionType. 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 SegmentIdMessage class represents a FIT SegmentIdMessage data message.

See also
DataMessage

Constructor & Destructor Documentation

◆ SegmentIdMessage()

SegmentIdMessage::SegmentIdMessage ( )

Constructs a SegmentIdMessage 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 SegmentIdMessage::defaultRaceLeader ( ) const

Returns the SegmentIdMessage 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:

◆ deleteStatus()

SegmentDeleteStatus SegmentIdMessage::deleteStatus ( ) const

Returns the SegmentIdMessage data message's deleteStatus field's current value.

Indicates if any segments should be deleted

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

◆ deviceId()

quint32 SegmentIdMessage::deviceId ( ) const

Returns the SegmentIdMessage data message's deviceId field's current value.

ID of the device that created the segment

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

◆ enabled()

bool SegmentIdMessage::enabled ( ) const

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

Segment enabled for evaluation

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

◆ name()

QString SegmentIdMessage::name ( ) const

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

Friendly name assigned to segment

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

◆ selectionType()

SegmentSelectionType SegmentIdMessage::selectionType ( ) const

Returns the SegmentIdMessage data message's selectionType field's current value.

Indicates how the segment was selected to be sent to the device

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

◆ setDefaultRaceLeader()

void SegmentIdMessage::setDefaultRaceLeader ( const quint8  defaultRaceLeader)

Sets the defaultRaceLeader field to defaultRaceLeader.

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

◆ setDeleteStatus()

void SegmentIdMessage::setDeleteStatus ( const SegmentDeleteStatus  deleteStatus)

Sets the deleteStatus field to deleteStatus.

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

◆ setDeviceId()

void SegmentIdMessage::setDeviceId ( const quint32  deviceId)

Sets the deviceId field to deviceId.

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

◆ setEnabled()

void SegmentIdMessage::setEnabled ( const bool  enabled)

Sets the enabled field to enabled.

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

◆ setName()

void SegmentIdMessage::setName ( const QString  name)

Sets the name field to name.

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

◆ setSelectionType()

void SegmentIdMessage::setSelectionType ( const SegmentSelectionType  selectionType)

Sets the selectionType field to selectionType.

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

◆ setSport()

void SegmentIdMessage::setSport ( const Sport  sport)

Sets the sport field to sport.

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

◆ setUserProfilePrimaryKey()

void SegmentIdMessage::setUserProfilePrimaryKey ( const quint32  userProfilePrimaryKey)

Sets the userProfilePrimaryKey field to userProfilePrimaryKey.

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

◆ setUuid()

void SegmentIdMessage::setUuid ( const QString  uuid)

Sets the uuid field to uuid.

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

◆ sport()

Sport SegmentIdMessage::sport ( ) const

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

Sport associated with the segment

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

◆ userProfilePrimaryKey()

quint32 SegmentIdMessage::userProfilePrimaryKey ( ) const

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

Primary key of the user that created the segment

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

◆ uuid()

QString SegmentIdMessage::uuid ( ) const

Returns the SegmentIdMessage data message's uuid field's current value.

UUID of the segment

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

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