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

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

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

Public Member Functions

 GoalMessage ()
 Constructs a GoalMessage object. More...
 
MessageIndex messageIndex () const
 Returns the GoalMessage data message's messageIndex field's current value. More...
 
Sport sport () const
 Returns the GoalMessage data message's sport field's current value. More...
 
SubSport subSport () const
 Returns the GoalMessage data message's subSport field's current value. More...
 
DateTime startDate () const
 Returns the GoalMessage data message's startDate field's current value. More...
 
DateTime endDate () const
 Returns the GoalMessage data message's endDate field's current value. More...
 
Goal type () const
 Returns the GoalMessage data message's type field's current value. More...
 
quint32 value () const
 Returns the GoalMessage data message's value field's current value. More...
 
bool repeat () const
 Returns the GoalMessage data message's repeat field's current value. More...
 
quint32 targetValue () const
 Returns the GoalMessage data message's targetValue field's current value. More...
 
GoalRecurrence recurrence () const
 Returns the GoalMessage data message's recurrence field's current value. More...
 
quint16 recurrenceValue () const
 Returns the GoalMessage data message's recurrenceValue field's current value. More...
 
bool enabled () const
 Returns the GoalMessage data message's enabled field's current value. More...
 
GoalSource source () const
 Returns the GoalMessage data message's source field's current value. More...
 
void setMessageIndex (const MessageIndex messageIndex)
 Sets the messageIndex field to messageIndex. More...
 
void setSport (const Sport sport)
 Sets the sport field to sport. More...
 
void setSubSport (const SubSport subSport)
 Sets the subSport field to subSport. More...
 
void setStartDate (const DateTime startDate)
 Sets the startDate field to startDate. More...
 
void setEndDate (const DateTime endDate)
 Sets the endDate field to endDate. More...
 
void setType (const Goal type)
 Sets the type field to type. More...
 
void setValue (const quint32 value)
 Sets the value field to value. More...
 
void setRepeat (const bool repeat)
 Sets the repeat field to repeat. More...
 
void setTargetValue (const quint32 targetValue)
 Sets the targetValue field to targetValue. More...
 
void setRecurrence (const GoalRecurrence recurrence)
 Sets the recurrence field to recurrence. More...
 
void setRecurrenceValue (const quint16 recurrenceValue)
 Sets the recurrenceValue field to recurrenceValue. More...
 
void setEnabled (const bool enabled)
 Sets the enabled field to enabled. More...
 
void setSource (const GoalSource source)
 Sets the source field to source. 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 GoalMessage class represents a FIT GoalMessage data message.

See also
DataMessage

Constructor & Destructor Documentation

◆ GoalMessage()

GoalMessage::GoalMessage ( )

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

◆ enabled()

bool GoalMessage::enabled ( ) const

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

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

◆ endDate()

DateTime GoalMessage::endDate ( ) const

Returns the GoalMessage data message's endDate field's current value.

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

◆ messageIndex()

MessageIndex GoalMessage::messageIndex ( ) const

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

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

◆ recurrence()

GoalRecurrence GoalMessage::recurrence ( ) const

Returns the GoalMessage data message's recurrence field's current value.

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

◆ recurrenceValue()

quint16 GoalMessage::recurrenceValue ( ) const

Returns the GoalMessage data message's recurrenceValue field's current value.

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

◆ repeat()

bool GoalMessage::repeat ( ) const

Returns the GoalMessage data message's repeat field's current value.

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

◆ setEnabled()

void GoalMessage::setEnabled ( const bool  enabled)

Sets the enabled field to enabled.

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

◆ setEndDate()

void GoalMessage::setEndDate ( const DateTime  endDate)

Sets the endDate field to endDate.

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

◆ setMessageIndex()

void GoalMessage::setMessageIndex ( const MessageIndex  messageIndex)

Sets the messageIndex field to messageIndex.

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

◆ setRecurrence()

void GoalMessage::setRecurrence ( const GoalRecurrence  recurrence)

Sets the recurrence field to recurrence.

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

◆ setRecurrenceValue()

void GoalMessage::setRecurrenceValue ( const quint16  recurrenceValue)

Sets the recurrenceValue field to recurrenceValue.

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

◆ setRepeat()

void GoalMessage::setRepeat ( const bool  repeat)

Sets the repeat field to repeat.

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

◆ setSource()

void GoalMessage::setSource ( const GoalSource  source)

Sets the source field to source.

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

◆ setSport()

void GoalMessage::setSport ( const Sport  sport)

Sets the sport field to sport.

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

◆ setStartDate()

void GoalMessage::setStartDate ( const DateTime  startDate)

Sets the startDate field to startDate.

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

◆ setSubSport()

void GoalMessage::setSubSport ( const SubSport  subSport)

Sets the subSport field to subSport.

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

◆ setTargetValue()

void GoalMessage::setTargetValue ( const quint32  targetValue)

Sets the targetValue field to targetValue.

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

◆ setType()

void GoalMessage::setType ( const Goal  type)

Sets the type field to type.

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

◆ setValue()

void GoalMessage::setValue ( const quint32  value)

Sets the value field to value.

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

◆ source()

GoalSource GoalMessage::source ( ) const

Returns the GoalMessage data message's source field's current value.

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

◆ sport()

Sport GoalMessage::sport ( ) const

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

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

◆ startDate()

DateTime GoalMessage::startDate ( ) const

Returns the GoalMessage data message's startDate field's current value.

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

◆ subSport()

SubSport GoalMessage::subSport ( ) const

Returns the GoalMessage data message's subSport field's current value.

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

◆ targetValue()

quint32 GoalMessage::targetValue ( ) const

Returns the GoalMessage data message's targetValue field's current value.

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

◆ type()

Goal GoalMessage::type ( ) const

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

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

◆ value()

quint32 GoalMessage::value ( ) const

Returns the GoalMessage data message's value field's current value.

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

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