QtFit  0.1
Internal library development documentation
All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
SegmentPointMessage Class Reference

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

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

Public Member Functions

 SegmentPointMessage ()
 Constructs a SegmentPointMessage object. More...
 
MessageIndex messageIndex () const
 Returns the SegmentPointMessage data message's messageIndex field's current value. More...
 
qint32 positionLat () const
 Returns the SegmentPointMessage data message's positionLat field's current value. More...
 
qint32 positionLong () const
 Returns the SegmentPointMessage data message's positionLong field's current value. More...
 
quint32 distance () const
 Returns the SegmentPointMessage data message's distance field's current value. More...
 
quint16 altitude () const
 Returns the SegmentPointMessage data message's altitude field's current value. More...
 
quint32 leaderTime () const
 Returns the SegmentPointMessage data message's leaderTime field's current value. More...
 
void setMessageIndex (const MessageIndex messageIndex)
 Sets the messageIndex field to messageIndex. More...
 
void setPositionLat (const qint32 positionLat)
 Sets the positionLat field to positionLat. More...
 
void setPositionLong (const qint32 positionLong)
 Sets the positionLong field to positionLong. More...
 
void setDistance (const quint32 distance)
 Sets the distance field to distance. More...
 
void setAltitude (const quint16 altitude)
 Sets the altitude field to altitude. More...
 
void setLeaderTime (const quint32 leaderTime)
 Sets the leaderTime field to leaderTime. 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

 SegmentPointMessage (SegmentPointMessagePrivate *const d)
 
- Protected Member Functions inherited from AbstractDataMessage
 AbstractDataMessage (AbstractDataMessagePrivate *const d)
 

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...
 
- Protected Attributes inherited from AbstractDataMessage
AbstractDataMessagePrivate *const d_ptr
 Internal d-pointer.
 

Detailed Description

The SegmentPointMessage class represents a FIT SegmentPointMessage data message.

See also
DataMessage

Definition at line 39 of file segmentpointmessage.h.

Constructor & Destructor Documentation

◆ SegmentPointMessage() [1/2]

SegmentPointMessage::SegmentPointMessage ( )

Constructs a SegmentPointMessage 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 segmentpointmessage.cpp.

53 {
54 
55 }
The AbstractDataMessage class is the polymorphic base class for all FIT Data Message classes.

◆ SegmentPointMessage() [2/2]

SegmentPointMessage::SegmentPointMessage ( SegmentPointMessagePrivate *const  d)
explicitprotected

Constructs a SegmentPointMessage object with private implementation d.

Parameters
dPointer to private implementation.

Definition at line 64 of file segmentpointmessage.cpp.

65 {
66 
67 }

Member Function Documentation

◆ altitude()

quint16 SegmentPointMessage::altitude ( ) const

Returns the SegmentPointMessage data message's altitude field's current value.

Accumulated altitude along the segment at the described point

Returns
the altitude field value.

Definition at line 122 of file segmentpointmessage.cpp.

123 {
124  Q_D(const SegmentPointMessage);
125  return d->altitude;
126 }
The SegmentPointMessage class represents a FIT SegmentPointMessage data message.

Referenced by setAltitude().

Here is the caller graph for this function:

◆ distance()

quint32 SegmentPointMessage::distance ( ) const

Returns the SegmentPointMessage data message's distance field's current value.

Accumulated distance along the segment at the described point

Returns
the distance field value.

Definition at line 109 of file segmentpointmessage.cpp.

110 {
111  Q_D(const SegmentPointMessage);
112  return d->distance;
113 }

Referenced by setDistance().

Here is the caller graph for this function:

◆ leaderTime()

quint32 SegmentPointMessage::leaderTime ( ) const

Returns the SegmentPointMessage data message's leaderTime field's current value.

Accumualted time each leader board member required to reach the described point. This value is zero for all leader board members at the starting point of the segment.

Returns
the leaderTime field value.

Definition at line 136 of file segmentpointmessage.cpp.

137 {
138  Q_D(const SegmentPointMessage);
139  return d->leaderTime;
140 }

Referenced by setLeaderTime().

Here is the caller graph for this function:

◆ messageIndex()

MessageIndex SegmentPointMessage::messageIndex ( ) const

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

Returns
the messageIndex field value.

Definition at line 74 of file segmentpointmessage.cpp.

75 {
76  Q_D(const SegmentPointMessage);
77  return d->messageIndex;
78 }

Referenced by setMessageIndex().

Here is the caller graph for this function:

◆ positionLat()

qint32 SegmentPointMessage::positionLat ( ) const

Returns the SegmentPointMessage data message's positionLat field's current value.

Returns
the positionLat field value.

Definition at line 85 of file segmentpointmessage.cpp.

86 {
87  Q_D(const SegmentPointMessage);
88  return d->positionLat;
89 }

Referenced by setPositionLat().

Here is the caller graph for this function:

◆ positionLong()

qint32 SegmentPointMessage::positionLong ( ) const

Returns the SegmentPointMessage data message's positionLong field's current value.

Returns
the positionLong field value.

Definition at line 96 of file segmentpointmessage.cpp.

97 {
98  Q_D(const SegmentPointMessage);
99  return d->positionLong;
100 }

Referenced by setPositionLong().

Here is the caller graph for this function:

◆ setAltitude()

void SegmentPointMessage::setAltitude ( const quint16  altitude)

Sets the altitude field to altitude.

Parameters
altitudeThe field value to set.

Definition at line 187 of file segmentpointmessage.cpp.

188 {
189  Q_D(SegmentPointMessage);
190  d->altitude = altitude;
191 }
quint16 altitude() const
Returns the SegmentPointMessage data message's altitude field's current value.

References altitude().

Here is the call graph for this function:

◆ setDistance()

void SegmentPointMessage::setDistance ( const quint32  distance)

Sets the distance field to distance.

Parameters
distanceThe field value to set.

Definition at line 177 of file segmentpointmessage.cpp.

178 {
179  Q_D(SegmentPointMessage);
180  d->distance = distance;
181 }
quint32 distance() const
Returns the SegmentPointMessage data message's distance field's current value.

References distance().

Here is the call graph for this function:

◆ setLeaderTime()

void SegmentPointMessage::setLeaderTime ( const quint32  leaderTime)

Sets the leaderTime field to leaderTime.

Parameters
leaderTimeThe field value to set.

Definition at line 197 of file segmentpointmessage.cpp.

198 {
199  Q_D(SegmentPointMessage);
200  d->leaderTime = leaderTime;
201 }
quint32 leaderTime() const
Returns the SegmentPointMessage data message's leaderTime field's current value.

References leaderTime().

Here is the call graph for this function:

◆ setMessageIndex()

void SegmentPointMessage::setMessageIndex ( const MessageIndex  messageIndex)

Sets the messageIndex field to messageIndex.

Parameters
messageIndexThe field value to set.

Definition at line 147 of file segmentpointmessage.cpp.

148 {
149  Q_D(SegmentPointMessage);
150  d->messageIndex = messageIndex;
151 }
MessageIndex messageIndex() const
Returns the SegmentPointMessage data message's messageIndex field's current value.

References messageIndex().

Here is the call graph for this function:

◆ setPositionLat()

void SegmentPointMessage::setPositionLat ( const qint32  positionLat)

Sets the positionLat field to positionLat.

Parameters
positionLatThe field value to set.

Definition at line 157 of file segmentpointmessage.cpp.

158 {
159  Q_D(SegmentPointMessage);
160  d->positionLat = positionLat;
161 }
qint32 positionLat() const
Returns the SegmentPointMessage data message's positionLat field's current value.

References positionLat().

Here is the call graph for this function:

◆ setPositionLong()

void SegmentPointMessage::setPositionLong ( const qint32  positionLong)

Sets the positionLong field to positionLong.

Parameters
positionLongThe field value to set.

Definition at line 167 of file segmentpointmessage.cpp.

168 {
169  Q_D(SegmentPointMessage);
170  d->positionLong = positionLong;
171 }
qint32 positionLong() const
Returns the SegmentPointMessage data message's positionLong field's current value.

References positionLong().

Here is the call graph for this function:

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