VideoDescriptionMessage Class Reference

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

Inheritance diagram for VideoDescriptionMessage:

Collaboration diagram for VideoDescriptionMessage:

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...

Protected Member Functions
	VideoDescriptionMessage (VideoDescriptionMessagePrivate *const d)
Protected Member Functions inherited from AbstractDataMessage
	AbstractDataMessage (AbstractDataMessagePrivate *const d)

Additional Inherited Members
Static Public Member Functions inherited from AbstractDataMessage
static AbstractDataMessage *	fromData (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 VideoDescriptionMessage class represents a FIT VideoDescriptionMessage data message.

See also

DataMessage

Definition at line 39 of file videodescriptionmessage.h.

Constructor & Destructor Documentation

VideoDescriptionMessage() [1/2]

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.

Definition at line 52 of file videodescriptionmessage.cpp.

                                                 : AbstractDataMessage(new VideoDescriptionMessagePrivate(this))
{
 
}

VideoDescriptionMessage() [2/2]

VideoDescriptionMessage::VideoDescriptionMessage ( VideoDescriptionMessagePrivate *const  d )

explicitprotected

Constructs a VideoDescriptionMessage object with private implementation d.

Parameters

d	Pointer to private implementation.

Definition at line 64 of file videodescriptionmessage.cpp.

                                                                                         : AbstractDataMessage(d)
{
 
}

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.

Definition at line 89 of file videodescriptionmessage.cpp.

{
    Q_D(const VideoDescriptionMessage);
    return d->messageCount;
}

Referenced by setMessageCount().

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.

Definition at line 76 of file videodescriptionmessage.cpp.

{
    Q_D(const VideoDescriptionMessage);
    return d->messageIndex;
}

Referenced by setMessageIndex().

Here is the caller graph for this function:

setMessageCount()

void VideoDescriptionMessage::setMessageCount

(

const quint16

messageCount

)

Sets the messageCount field to messageCount.

Parameters

messageCount

The field value to set.

Definition at line 121 of file videodescriptionmessage.cpp.

{
    Q_D(VideoDescriptionMessage);
    d->messageCount = messageCount;
}

References messageCount().

Here is the call graph for this function:

setMessageIndex()

void VideoDescriptionMessage::setMessageIndex

(

const MessageIndex

messageIndex

)

Sets the messageIndex field to messageIndex.

Parameters

messageIndex

The field value to set.

Definition at line 111 of file videodescriptionmessage.cpp.

{
    Q_D(VideoDescriptionMessage);
    d->messageIndex = messageIndex;
}

References messageIndex().

Here is the call graph for this function:

setText()

void VideoDescriptionMessage::setText

(

const QString

text

)

Sets the text field to text.

Parameters

text	The field value to set.

Definition at line 131 of file videodescriptionmessage.cpp.

{
    Q_D(VideoDescriptionMessage);
    d->text = text;
}

References text().

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.

Definition at line 100 of file videodescriptionmessage.cpp.

{
    Q_D(const VideoDescriptionMessage);
    return d->text;
}

Referenced by setText().

Here is the caller graph for this function:

---

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

• videodescriptionmessage.h
• videodescriptionmessage.cpp