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

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

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

Public Member Functions

 CoursePointMessage ()
 Constructs a CoursePointMessage object. More...
 
MessageIndex messageIndex () const
 Returns the CoursePointMessage data message's messageIndex field's current value. More...
 
DateTime timestamp () const
 Returns the CoursePointMessage data message's timestamp field's current value. More...
 
qint32 positionLat () const
 Returns the CoursePointMessage data message's positionLat field's current value. More...
 
qint32 positionLong () const
 Returns the CoursePointMessage data message's positionLong field's current value. More...
 
quint32 distance () const
 Returns the CoursePointMessage data message's distance field's current value. More...
 
CoursePoint type () const
 Returns the CoursePointMessage data message's type field's current value. More...
 
QString name () const
 Returns the CoursePointMessage data message's name field's current value. More...
 
bool favorite () const
 Returns the CoursePointMessage data message's favorite field's current value. More...
 
void setMessageIndex (const MessageIndex messageIndex)
 Sets the messageIndex field to messageIndex. More...
 
void setTimestamp (const DateTime timestamp)
 Sets the timestamp field to timestamp. 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 setType (const CoursePoint type)
 Sets the type field to type. More...
 
void setName (const QString name)
 Sets the name field to name. More...
 
void setFavorite (const bool favorite)
 Sets the favorite field to favorite. 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

 CoursePointMessage (CoursePointMessagePrivate *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 CoursePointMessage class represents a FIT CoursePointMessage data message.

See also
DataMessage

Definition at line 39 of file coursepointmessage.h.

Constructor & Destructor Documentation

◆ CoursePointMessage() [1/2]

CoursePointMessage::CoursePointMessage ( )

Constructs a CoursePointMessage 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 coursepointmessage.cpp.

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

◆ CoursePointMessage() [2/2]

CoursePointMessage::CoursePointMessage ( CoursePointMessagePrivate *const  d)
explicitprotected

Constructs a CoursePointMessage object with private implementation d.

Parameters
dPointer to private implementation.

Definition at line 64 of file coursepointmessage.cpp.

65 {
66 
67 }

Member Function Documentation

◆ distance()

quint32 CoursePointMessage::distance ( ) const

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

Returns
the distance field value.

Definition at line 118 of file coursepointmessage.cpp.

119 {
120  Q_D(const CoursePointMessage);
121  return d->distance;
122 }
The CoursePointMessage class represents a FIT CoursePointMessage data message.

Referenced by setDistance().

Here is the caller graph for this function:

◆ favorite()

bool CoursePointMessage::favorite ( ) const

Returns the CoursePointMessage data message's favorite field's current value.

Returns
the favorite field value.

Definition at line 151 of file coursepointmessage.cpp.

152 {
153  Q_D(const CoursePointMessage);
154  return d->favorite;
155 }

Referenced by setFavorite().

Here is the caller graph for this function:

◆ messageIndex()

MessageIndex CoursePointMessage::messageIndex ( ) const

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

Returns
the messageIndex field value.

Definition at line 74 of file coursepointmessage.cpp.

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

Referenced by setMessageIndex().

Here is the caller graph for this function:

◆ name()

QString CoursePointMessage::name ( ) const

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

Returns
the name field value.

Definition at line 140 of file coursepointmessage.cpp.

141 {
142  Q_D(const CoursePointMessage);
143  return d->name;
144 }

Referenced by setName().

Here is the caller graph for this function:

◆ positionLat()

qint32 CoursePointMessage::positionLat ( ) const

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

Returns
the positionLat field value.

Definition at line 96 of file coursepointmessage.cpp.

97 {
98  Q_D(const CoursePointMessage);
99  return d->positionLat;
100 }

Referenced by setPositionLat().

Here is the caller graph for this function:

◆ positionLong()

qint32 CoursePointMessage::positionLong ( ) const

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

Returns
the positionLong field value.

Definition at line 107 of file coursepointmessage.cpp.

108 {
109  Q_D(const CoursePointMessage);
110  return d->positionLong;
111 }

Referenced by setPositionLong().

Here is the caller graph for this function:

◆ setDistance()

void CoursePointMessage::setDistance ( const quint32  distance)

Sets the distance field to distance.

Parameters
distanceThe field value to set.

Definition at line 202 of file coursepointmessage.cpp.

203 {
204  Q_D(CoursePointMessage);
205  d->distance = distance;
206 }
quint32 distance() const
Returns the CoursePointMessage data message's distance field's current value.

References distance().

Here is the call graph for this function:

◆ setFavorite()

void CoursePointMessage::setFavorite ( const bool  favorite)

Sets the favorite field to favorite.

Parameters
favoriteThe field value to set.

Definition at line 232 of file coursepointmessage.cpp.

233 {
234  Q_D(CoursePointMessage);
235  d->favorite = favorite;
236 }
bool favorite() const
Returns the CoursePointMessage data message's favorite field's current value.

References favorite().

Here is the call graph for this function:

◆ setMessageIndex()

void CoursePointMessage::setMessageIndex ( const MessageIndex  messageIndex)

Sets the messageIndex field to messageIndex.

Parameters
messageIndexThe field value to set.

Definition at line 162 of file coursepointmessage.cpp.

163 {
164  Q_D(CoursePointMessage);
165  d->messageIndex = messageIndex;
166 }
MessageIndex messageIndex() const
Returns the CoursePointMessage data message's messageIndex field's current value.

References messageIndex().

Here is the call graph for this function:

◆ setName()

void CoursePointMessage::setName ( const QString  name)

Sets the name field to name.

Parameters
nameThe field value to set.

Definition at line 222 of file coursepointmessage.cpp.

223 {
224  Q_D(CoursePointMessage);
225  d->name = name;
226 }
QString name() const
Returns the CoursePointMessage data message's name field's current value.

References name().

Here is the call graph for this function:

◆ setPositionLat()

void CoursePointMessage::setPositionLat ( const qint32  positionLat)

Sets the positionLat field to positionLat.

Parameters
positionLatThe field value to set.

Definition at line 182 of file coursepointmessage.cpp.

183 {
184  Q_D(CoursePointMessage);
185  d->positionLat = positionLat;
186 }
qint32 positionLat() const
Returns the CoursePointMessage data message's positionLat field's current value.

References positionLat().

Here is the call graph for this function:

◆ setPositionLong()

void CoursePointMessage::setPositionLong ( const qint32  positionLong)

Sets the positionLong field to positionLong.

Parameters
positionLongThe field value to set.

Definition at line 192 of file coursepointmessage.cpp.

193 {
194  Q_D(CoursePointMessage);
195  d->positionLong = positionLong;
196 }
qint32 positionLong() const
Returns the CoursePointMessage data message's positionLong field's current value.

References positionLong().

Here is the call graph for this function:

◆ setTimestamp()

void CoursePointMessage::setTimestamp ( const DateTime  timestamp)

Sets the timestamp field to timestamp.

Parameters
timestampThe field value to set.

Definition at line 172 of file coursepointmessage.cpp.

173 {
174  Q_D(CoursePointMessage);
175  d->timestamp = timestamp;
176 }
DateTime timestamp() const
Returns the CoursePointMessage data message's timestamp field's current value.

References timestamp().

Here is the call graph for this function:

◆ setType()

void CoursePointMessage::setType ( const CoursePoint  type)

Sets the type field to type.

Parameters
typeThe field value to set.

Definition at line 212 of file coursepointmessage.cpp.

213 {
214  Q_D(CoursePointMessage);
215  d->type = type;
216 }
CoursePoint type() const
Returns the CoursePointMessage data message's type field's current value.

References type().

Here is the call graph for this function:

◆ timestamp()

DateTime CoursePointMessage::timestamp ( ) const

Returns the CoursePointMessage data message's timestamp field's current value.

Returns
the timestamp field value.

Definition at line 85 of file coursepointmessage.cpp.

86 {
87  Q_D(const CoursePointMessage);
88  return d->timestamp;
89 }

Referenced by setTimestamp().

Here is the caller graph for this function:

◆ type()

CoursePoint CoursePointMessage::type ( ) const

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

Returns
the type field value.

Definition at line 129 of file coursepointmessage.cpp.

130 {
131  Q_D(const CoursePointMessage);
132  return d->type;
133 }

Referenced by setType().

Here is the caller graph for this function:

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