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

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

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

Public Member Functions

 ActivityMessage ()
 Constructs a ActivityMessage object. More...
 
DateTime timestamp () const
 Returns the ActivityMessage data message's timestamp field's current value. More...
 
quint32 totalTimerTime () const
 Returns the ActivityMessage data message's totalTimerTime field's current value. More...
 
quint16 numSessions () const
 Returns the ActivityMessage data message's numSessions field's current value. More...
 
Activity type () const
 Returns the ActivityMessage data message's type field's current value. More...
 
Event event () const
 Returns the ActivityMessage data message's event field's current value. More...
 
EventType eventType () const
 Returns the ActivityMessage data message's eventType field's current value. More...
 
LocalDateTime localTimestamp () const
 Returns the ActivityMessage data message's localTimestamp field's current value. More...
 
quint8 eventGroup () const
 Returns the ActivityMessage data message's eventGroup field's current value. More...
 
void setTimestamp (const DateTime timestamp)
 Sets the timestamp field to timestamp. More...
 
void setTotalTimerTime (const quint32 totalTimerTime)
 Sets the totalTimerTime field to totalTimerTime. More...
 
void setNumSessions (const quint16 numSessions)
 Sets the numSessions field to numSessions. More...
 
void setType (const Activity type)
 Sets the type field to type. More...
 
void setEvent (const Event event)
 Sets the event field to event. More...
 
void setEventType (const EventType eventType)
 Sets the eventType field to eventType. More...
 
void setLocalTimestamp (const LocalDateTime localTimestamp)
 Sets the localTimestamp field to localTimestamp. More...
 
void setEventGroup (const quint8 eventGroup)
 Sets the eventGroup field to eventGroup. 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

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

See also
DataMessage

Definition at line 39 of file activitymessage.h.

Constructor & Destructor Documentation

◆ ActivityMessage() [1/2]

ActivityMessage::ActivityMessage ( )

Constructs a ActivityMessage 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 activitymessage.cpp.

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

◆ ActivityMessage() [2/2]

ActivityMessage::ActivityMessage ( ActivityMessagePrivate *const  d)
explicitprotected

Constructs a ActivityMessage object with private implementation d.

Parameters
dPointer to private implementation.

Definition at line 64 of file activitymessage.cpp.

65 {
66 
67 }

Member Function Documentation

◆ event()

Event ActivityMessage::event ( ) const

Returns the ActivityMessage data message's event field's current value.

Returns
the event field value.

Definition at line 120 of file activitymessage.cpp.

121 {
122  Q_D(const ActivityMessage);
123  return d->event;
124 }
The ActivityMessage class represents a FIT ActivityMessage data message.

Referenced by setEvent().

Here is the caller graph for this function:

◆ eventGroup()

quint8 ActivityMessage::eventGroup ( ) const

Returns the ActivityMessage data message's eventGroup field's current value.

Returns
the eventGroup field value.

Definition at line 155 of file activitymessage.cpp.

156 {
157  Q_D(const ActivityMessage);
158  return d->eventGroup;
159 }

Referenced by setEventGroup().

Here is the caller graph for this function:

◆ eventType()

EventType ActivityMessage::eventType ( ) const

Returns the ActivityMessage data message's eventType field's current value.

Returns
the eventType field value.

Definition at line 131 of file activitymessage.cpp.

132 {
133  Q_D(const ActivityMessage);
134  return d->eventType;
135 }

Referenced by setEventType().

Here is the caller graph for this function:

◆ localTimestamp()

LocalDateTime ActivityMessage::localTimestamp ( ) const

Returns the ActivityMessage data message's localTimestamp field's current value.

timestamp epoch expressed in local time, used to convert activity timestamps to local time

Returns
the localTimestamp field value.

Definition at line 144 of file activitymessage.cpp.

145 {
146  Q_D(const ActivityMessage);
147  return d->localTimestamp;
148 }

Referenced by setLocalTimestamp().

Here is the caller graph for this function:

◆ numSessions()

quint16 ActivityMessage::numSessions ( ) const

Returns the ActivityMessage data message's numSessions field's current value.

Returns
the numSessions field value.

Definition at line 98 of file activitymessage.cpp.

99 {
100  Q_D(const ActivityMessage);
101  return d->numSessions;
102 }

Referenced by setNumSessions().

Here is the caller graph for this function:

◆ setEvent()

void ActivityMessage::setEvent ( const Event  event)

Sets the event field to event.

Parameters
eventThe field value to set.

Definition at line 206 of file activitymessage.cpp.

207 {
208  Q_D(ActivityMessage);
209  d->event = event;
210 }
Event event() const
Returns the ActivityMessage data message's event field's current value.

References event().

Here is the call graph for this function:

◆ setEventGroup()

void ActivityMessage::setEventGroup ( const quint8  eventGroup)

Sets the eventGroup field to eventGroup.

Parameters
eventGroupThe field value to set.

Definition at line 236 of file activitymessage.cpp.

237 {
238  Q_D(ActivityMessage);
239  d->eventGroup = eventGroup;
240 }
quint8 eventGroup() const
Returns the ActivityMessage data message's eventGroup field's current value.

References eventGroup().

Here is the call graph for this function:

◆ setEventType()

void ActivityMessage::setEventType ( const EventType  eventType)

Sets the eventType field to eventType.

Parameters
eventTypeThe field value to set.

Definition at line 216 of file activitymessage.cpp.

217 {
218  Q_D(ActivityMessage);
219  d->eventType = eventType;
220 }
EventType eventType() const
Returns the ActivityMessage data message's eventType field's current value.

References eventType().

Here is the call graph for this function:

◆ setLocalTimestamp()

void ActivityMessage::setLocalTimestamp ( const LocalDateTime  localTimestamp)

Sets the localTimestamp field to localTimestamp.

Parameters
localTimestampThe field value to set.

Definition at line 226 of file activitymessage.cpp.

227 {
228  Q_D(ActivityMessage);
229  d->localTimestamp = localTimestamp;
230 }
LocalDateTime localTimestamp() const
Returns the ActivityMessage data message's localTimestamp field's current value.

References localTimestamp().

Here is the call graph for this function:

◆ setNumSessions()

void ActivityMessage::setNumSessions ( const quint16  numSessions)

Sets the numSessions field to numSessions.

Parameters
numSessionsThe field value to set.

Definition at line 186 of file activitymessage.cpp.

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

References numSessions().

Here is the call graph for this function:

◆ setTimestamp()

void ActivityMessage::setTimestamp ( const DateTime  timestamp)

Sets the timestamp field to timestamp.

Parameters
timestampThe field value to set.

Definition at line 166 of file activitymessage.cpp.

167 {
168  Q_D(ActivityMessage);
169  d->timestamp = timestamp;
170 }
DateTime timestamp() const
Returns the ActivityMessage data message's timestamp field's current value.

References timestamp().

Here is the call graph for this function:

◆ setTotalTimerTime()

void ActivityMessage::setTotalTimerTime ( const quint32  totalTimerTime)

Sets the totalTimerTime field to totalTimerTime.

Parameters
totalTimerTimeThe field value to set.

Definition at line 176 of file activitymessage.cpp.

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

References totalTimerTime().

Here is the call graph for this function:

◆ setType()

void ActivityMessage::setType ( const Activity  type)

Sets the type field to type.

Parameters
typeThe field value to set.

Definition at line 196 of file activitymessage.cpp.

197 {
198  Q_D(ActivityMessage);
199  d->type = type;
200 }
Activity type() const
Returns the ActivityMessage data message's type field's current value.

References type().

Here is the call graph for this function:

◆ timestamp()

DateTime ActivityMessage::timestamp ( ) const

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

Returns
the timestamp field value.

Definition at line 74 of file activitymessage.cpp.

75 {
76  Q_D(const ActivityMessage);
77  return d->timestamp;
78 }

Referenced by setTimestamp().

Here is the caller graph for this function:

◆ totalTimerTime()

quint32 ActivityMessage::totalTimerTime ( ) const

Returns the ActivityMessage data message's totalTimerTime field's current value.

Exclude pauses

Returns
the totalTimerTime field value.

Definition at line 87 of file activitymessage.cpp.

88 {
89  Q_D(const ActivityMessage);
90  return d->totalTimerTime;
91 }

Referenced by setTotalTimerTime().

Here is the caller graph for this function:

◆ type()

Activity ActivityMessage::type ( ) const

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

Returns
the type field value.

Definition at line 109 of file activitymessage.cpp.

110 {
111  Q_D(const ActivityMessage);
112  return d->type;
113 }

Referenced by setType().

Here is the caller graph for this function:

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