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

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

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

Public Member Functions

 VideoTitleMessage ()
 Constructs a VideoTitleMessage object. More...
 
MessageIndex messageIndex () const
 Returns the VideoTitleMessage data message's messageIndex field's current value. More...
 
quint16 messageCount () const
 Returns the VideoTitleMessage data message's messageCount field's current value. More...
 
QString text () const
 Returns the VideoTitleMessage 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...
 

Protected Member Functions

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

See also
DataMessage

Definition at line 39 of file videotitlemessage.h.

Constructor & Destructor Documentation

◆ VideoTitleMessage() [1/2]

VideoTitleMessage::VideoTitleMessage ( )

Constructs a VideoTitleMessage 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 videotitlemessage.cpp.

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

◆ VideoTitleMessage() [2/2]

VideoTitleMessage::VideoTitleMessage ( VideoTitleMessagePrivate *const  d)
explicitprotected

Constructs a VideoTitleMessage object with private implementation d.

Parameters
dPointer to private implementation.

Definition at line 64 of file videotitlemessage.cpp.

65 {
66 
67 }

Member Function Documentation

◆ messageCount()

quint16 VideoTitleMessage::messageCount ( ) const

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

Total number of title parts

Returns
the messageCount field value.

Definition at line 89 of file videotitlemessage.cpp.

90 {
91  Q_D(const VideoTitleMessage);
92  return d->messageCount;
93 }
The VideoTitleMessage class represents a FIT VideoTitleMessage data message.

Referenced by setMessageCount().

Here is the caller graph for this function:

◆ messageIndex()

MessageIndex VideoTitleMessage::messageIndex ( ) const

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

Long titles will be split into multiple parts

Returns
the messageIndex field value.

Definition at line 76 of file videotitlemessage.cpp.

77 {
78  Q_D(const VideoTitleMessage);
79  return d->messageIndex;
80 }

Referenced by setMessageIndex().

Here is the caller graph for this function:

◆ setMessageCount()

void VideoTitleMessage::setMessageCount ( const quint16  messageCount)

Sets the messageCount field to messageCount.

Parameters
messageCountThe field value to set.

Definition at line 121 of file videotitlemessage.cpp.

122 {
123  Q_D(VideoTitleMessage);
124  d->messageCount = messageCount;
125 }
quint16 messageCount() const
Returns the VideoTitleMessage data message's messageCount field's current value.

References messageCount().

Here is the call graph for this function:

◆ setMessageIndex()

void VideoTitleMessage::setMessageIndex ( const MessageIndex  messageIndex)

Sets the messageIndex field to messageIndex.

Parameters
messageIndexThe field value to set.

Definition at line 111 of file videotitlemessage.cpp.

112 {
113  Q_D(VideoTitleMessage);
114  d->messageIndex = messageIndex;
115 }
MessageIndex messageIndex() const
Returns the VideoTitleMessage data message's messageIndex field's current value.

References messageIndex().

Here is the call graph for this function:

◆ setText()

void VideoTitleMessage::setText ( const QString  text)

Sets the text field to text.

Parameters
textThe field value to set.

Definition at line 131 of file videotitlemessage.cpp.

132 {
133  Q_D(VideoTitleMessage);
134  d->text = text;
135 }
QString text() const
Returns the VideoTitleMessage data message's text field's current value.

References text().

Here is the call graph for this function:

◆ text()

QString VideoTitleMessage::text ( ) const

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

Returns
the text field value.

Definition at line 100 of file videotitlemessage.cpp.

101 {
102  Q_D(const VideoTitleMessage);
103  return d->text;
104 }

Referenced by setText().

Here is the caller graph for this function:

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