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

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

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

Public Member Functions

 VideoFrameMessage ()
 Constructs a VideoFrameMessage object. More...
 
DateTime timestamp () const
 Returns the VideoFrameMessage data message's timestamp field's current value. More...
 
quint16 timestampMs () const
 Returns the VideoFrameMessage data message's timestampMs field's current value. More...
 
quint32 frameNumber () const
 Returns the VideoFrameMessage data message's frameNumber field's current value. More...
 
void setTimestamp (const DateTime timestamp)
 Sets the timestamp field to timestamp. More...
 
void setTimestampMs (const quint16 timestampMs)
 Sets the timestampMs field to timestampMs. More...
 
void setFrameNumber (const quint32 frameNumber)
 Sets the frameNumber field to frameNumber. 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

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

See also
DataMessage

Definition at line 39 of file videoframemessage.h.

Constructor & Destructor Documentation

◆ VideoFrameMessage() [1/2]

VideoFrameMessage::VideoFrameMessage ( )

Constructs a VideoFrameMessage 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 videoframemessage.cpp.

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

◆ VideoFrameMessage() [2/2]

VideoFrameMessage::VideoFrameMessage ( VideoFrameMessagePrivate *const  d)
explicitprotected

Constructs a VideoFrameMessage object with private implementation d.

Parameters
dPointer to private implementation.

Definition at line 64 of file videoframemessage.cpp.

65 {
66 
67 }

Member Function Documentation

◆ frameNumber()

quint32 VideoFrameMessage::frameNumber ( ) const

Returns the VideoFrameMessage data message's frameNumber field's current value.

Number of the frame that the timestamp and timestamp_ms correlate to

Returns
the frameNumber field value.

Definition at line 102 of file videoframemessage.cpp.

103 {
104  Q_D(const VideoFrameMessage);
105  return d->frameNumber;
106 }
The VideoFrameMessage class represents a FIT VideoFrameMessage data message.

Referenced by setFrameNumber().

Here is the caller graph for this function:

◆ setFrameNumber()

void VideoFrameMessage::setFrameNumber ( const quint32  frameNumber)

Sets the frameNumber field to frameNumber.

Parameters
frameNumberThe field value to set.

Definition at line 133 of file videoframemessage.cpp.

134 {
135  Q_D(VideoFrameMessage);
136  d->frameNumber = frameNumber;
137 }
quint32 frameNumber() const
Returns the VideoFrameMessage data message's frameNumber field's current value.

References frameNumber().

Here is the call graph for this function:

◆ setTimestamp()

void VideoFrameMessage::setTimestamp ( const DateTime  timestamp)

Sets the timestamp field to timestamp.

Parameters
timestampThe field value to set.

Definition at line 113 of file videoframemessage.cpp.

114 {
115  Q_D(VideoFrameMessage);
116  d->timestamp = timestamp;
117 }
DateTime timestamp() const
Returns the VideoFrameMessage data message's timestamp field's current value.

References timestamp().

Here is the call graph for this function:

◆ setTimestampMs()

void VideoFrameMessage::setTimestampMs ( const quint16  timestampMs)

Sets the timestampMs field to timestampMs.

Parameters
timestampMsThe field value to set.

Definition at line 123 of file videoframemessage.cpp.

124 {
125  Q_D(VideoFrameMessage);
126  d->timestampMs = timestampMs;
127 }
quint16 timestampMs() const
Returns the VideoFrameMessage data message's timestampMs field's current value.

References timestampMs().

Here is the call graph for this function:

◆ timestamp()

DateTime VideoFrameMessage::timestamp ( ) const

Returns the VideoFrameMessage data message's timestamp field's current value.

Whole second part of the timestamp

Returns
the timestamp field value.

Definition at line 76 of file videoframemessage.cpp.

77 {
78  Q_D(const VideoFrameMessage);
79  return d->timestamp;
80 }

Referenced by setTimestamp().

Here is the caller graph for this function:

◆ timestampMs()

quint16 VideoFrameMessage::timestampMs ( ) const

Returns the VideoFrameMessage data message's timestampMs field's current value.

Millisecond part of the timestamp.

Returns
the timestampMs field value.

Definition at line 89 of file videoframemessage.cpp.

90 {
91  Q_D(const VideoFrameMessage);
92  return d->timestampMs;
93 }

Referenced by setTimestampMs().

Here is the caller graph for this function:

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