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

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

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

Public Member Functions

 ScheduleMessage ()
 Constructs a ScheduleMessage object. More...
 
Manufacturer manufacturer () const
 Returns the ScheduleMessage data message's manufacturer field's current value. More...
 
quint16 product () const
 Returns the ScheduleMessage data message's product field's current value. More...
 
quint32z serialNumber () const
 Returns the ScheduleMessage data message's serialNumber field's current value. More...
 
DateTime timeCreated () const
 Returns the ScheduleMessage data message's timeCreated field's current value. More...
 
bool completed () const
 Returns the ScheduleMessage data message's completed field's current value. More...
 
Schedule type () const
 Returns the ScheduleMessage data message's type field's current value. More...
 
LocalDateTime scheduledTime () const
 Returns the ScheduleMessage data message's scheduledTime field's current value. More...
 
void setManufacturer (const Manufacturer manufacturer)
 Sets the manufacturer field to manufacturer. More...
 
void setProduct (const quint16 product)
 Sets the product field to product. More...
 
void setSerialNumber (const quint32z serialNumber)
 Sets the serialNumber field to serialNumber. More...
 
void setTimeCreated (const DateTime timeCreated)
 Sets the timeCreated field to timeCreated. More...
 
void setCompleted (const bool completed)
 Sets the completed field to completed. More...
 
void setType (const Schedule type)
 Sets the type field to type. More...
 
void setScheduledTime (const LocalDateTime scheduledTime)
 Sets the scheduledTime field to scheduledTime. 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 ScheduleMessage class represents a FIT ScheduleMessage data message.

See also
DataMessage

Constructor & Destructor Documentation

◆ ScheduleMessage()

ScheduleMessage::ScheduleMessage ( )

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

◆ completed()

bool ScheduleMessage::completed ( ) const

Returns the ScheduleMessage data message's completed field's current value.

TRUE if this activity has been started

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

◆ manufacturer()

Manufacturer ScheduleMessage::manufacturer ( ) const

Returns the ScheduleMessage data message's manufacturer field's current value.

Corresponds to file_id of scheduled workout / course.

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

◆ product()

quint16 ScheduleMessage::product ( ) const

Returns the ScheduleMessage data message's product field's current value.

Corresponds to file_id of scheduled workout / course.

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

◆ scheduledTime()

LocalDateTime ScheduleMessage::scheduledTime ( ) const

Returns the ScheduleMessage data message's scheduledTime field's current value.

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

◆ serialNumber()

quint32z ScheduleMessage::serialNumber ( ) const

Returns the ScheduleMessage data message's serialNumber field's current value.

Corresponds to file_id of scheduled workout / course.

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

◆ setCompleted()

void ScheduleMessage::setCompleted ( const bool  completed)

Sets the completed field to completed.

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

◆ setManufacturer()

void ScheduleMessage::setManufacturer ( const Manufacturer  manufacturer)

Sets the manufacturer field to manufacturer.

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

◆ setProduct()

void ScheduleMessage::setProduct ( const quint16  product)

Sets the product field to product.

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

◆ setScheduledTime()

void ScheduleMessage::setScheduledTime ( const LocalDateTime  scheduledTime)

Sets the scheduledTime field to scheduledTime.

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

◆ setSerialNumber()

void ScheduleMessage::setSerialNumber ( const quint32z  serialNumber)

Sets the serialNumber field to serialNumber.

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

◆ setTimeCreated()

void ScheduleMessage::setTimeCreated ( const DateTime  timeCreated)

Sets the timeCreated field to timeCreated.

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

◆ setType()

void ScheduleMessage::setType ( const Schedule  type)

Sets the type field to type.

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

◆ timeCreated()

DateTime ScheduleMessage::timeCreated ( ) const

Returns the ScheduleMessage data message's timeCreated field's current value.

Corresponds to file_id of scheduled workout / course.

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

◆ type()

Schedule ScheduleMessage::type ( ) const

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

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

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