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

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

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

Public Member Functions

 VideoDescriptionMessage ()
 Constructs a VideoDescriptionMessage object. More...
 
MessageIndex messageIndex () const
 Returns the VideoDescriptionMessage data message's messageIndex field's current value. More...
 
quint16 messageCount () const
 Returns the VideoDescriptionMessage data message's messageCount field's current value. More...
 
QString text () const
 Returns the VideoDescriptionMessage data message's text field's current value. More...
 
void setMessageIndex (const MessageIndex messageIndex)
 Sets the messageIndex field to messageIndex. More...
 
void setMessageCount (const quint16 messageCount)
 Sets the messageCount field to messageCount. More...
 
void setText (const QString text)
 Sets the text field to text. 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 VideoDescriptionMessage class represents a FIT VideoDescriptionMessage data message.

See also
DataMessage

Constructor & Destructor Documentation

◆ VideoDescriptionMessage()

VideoDescriptionMessage::VideoDescriptionMessage ( )

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

◆ messageCount()

quint16 VideoDescriptionMessage::messageCount ( ) const

Returns the VideoDescriptionMessage data message's messageCount field's current value.

Total number of description parts

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

◆ messageIndex()

MessageIndex VideoDescriptionMessage::messageIndex ( ) const

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

Long descriptions will be split into multiple parts

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

◆ setMessageCount()

void VideoDescriptionMessage::setMessageCount ( const quint16  messageCount)

Sets the messageCount field to messageCount.

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

◆ setMessageIndex()

void VideoDescriptionMessage::setMessageIndex ( const MessageIndex  messageIndex)

Sets the messageIndex field to messageIndex.

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

◆ setText()

void VideoDescriptionMessage::setText ( const QString  text)

Sets the text field to text.

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

◆ text()

QString VideoDescriptionMessage::text ( ) const

Returns the VideoDescriptionMessage data message's text field's current value.

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

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