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

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

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

Public Member Functions

 CameraEventMessage ()
 Constructs a CameraEventMessage object. More...
 
DateTime timestamp () const
 Returns the CameraEventMessage data message's timestamp field's current value. More...
 
quint16 timestampMs () const
 Returns the CameraEventMessage data message's timestampMs field's current value. More...
 
CameraEventType cameraEventType () const
 Returns the CameraEventMessage data message's cameraEventType field's current value. More...
 
QString cameraFileUuid () const
 Returns the CameraEventMessage data message's cameraFileUuid field's current value. More...
 
CameraOrientationType cameraOrientation () const
 Returns the CameraEventMessage data message's cameraOrientation 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 setCameraEventType (const CameraEventType cameraEventType)
 Sets the cameraEventType field to cameraEventType. More...
 
void setCameraFileUuid (const QString cameraFileUuid)
 Sets the cameraFileUuid field to cameraFileUuid. More...
 
void setCameraOrientation (const CameraOrientationType cameraOrientation)
 Sets the cameraOrientation field to cameraOrientation. 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

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

See also
DataMessage

Definition at line 39 of file cameraeventmessage.h.

Constructor & Destructor Documentation

◆ CameraEventMessage() [1/2]

CameraEventMessage::CameraEventMessage ( )

Constructs a CameraEventMessage 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 cameraeventmessage.cpp.

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

◆ CameraEventMessage() [2/2]

CameraEventMessage::CameraEventMessage ( CameraEventMessagePrivate *const  d)
explicitprotected

Constructs a CameraEventMessage object with private implementation d.

Parameters
dPointer to private implementation.

Definition at line 64 of file cameraeventmessage.cpp.

65 {
66 
67 }

Member Function Documentation

◆ cameraEventType()

CameraEventType CameraEventMessage::cameraEventType ( ) const

Returns the CameraEventMessage data message's cameraEventType field's current value.

Returns
the cameraEventType field value.

Definition at line 100 of file cameraeventmessage.cpp.

101 {
102  Q_D(const CameraEventMessage);
103  return d->cameraEventType;
104 }
The CameraEventMessage class represents a FIT CameraEventMessage data message.

Referenced by setCameraEventType().

Here is the caller graph for this function:

◆ cameraFileUuid()

QString CameraEventMessage::cameraFileUuid ( ) const

Returns the CameraEventMessage data message's cameraFileUuid field's current value.

Returns
the cameraFileUuid field value.

Definition at line 111 of file cameraeventmessage.cpp.

112 {
113  Q_D(const CameraEventMessage);
114  return d->cameraFileUuid;
115 }

Referenced by setCameraFileUuid().

Here is the caller graph for this function:

◆ cameraOrientation()

CameraOrientationType CameraEventMessage::cameraOrientation ( ) const

Returns the CameraEventMessage data message's cameraOrientation field's current value.

Returns
the cameraOrientation field value.

Definition at line 122 of file cameraeventmessage.cpp.

123 {
124  Q_D(const CameraEventMessage);
125  return d->cameraOrientation;
126 }

Referenced by setCameraOrientation().

Here is the caller graph for this function:

◆ setCameraEventType()

void CameraEventMessage::setCameraEventType ( const CameraEventType  cameraEventType)

Sets the cameraEventType field to cameraEventType.

Parameters
cameraEventTypeThe field value to set.

Definition at line 153 of file cameraeventmessage.cpp.

154 {
155  Q_D(CameraEventMessage);
156  d->cameraEventType = cameraEventType;
157 }
CameraEventType cameraEventType() const
Returns the CameraEventMessage data message's cameraEventType field's current value.

References cameraEventType().

Here is the call graph for this function:

◆ setCameraFileUuid()

void CameraEventMessage::setCameraFileUuid ( const QString  cameraFileUuid)

Sets the cameraFileUuid field to cameraFileUuid.

Parameters
cameraFileUuidThe field value to set.

Definition at line 163 of file cameraeventmessage.cpp.

164 {
165  Q_D(CameraEventMessage);
166  d->cameraFileUuid = cameraFileUuid;
167 }
QString cameraFileUuid() const
Returns the CameraEventMessage data message's cameraFileUuid field's current value.

References cameraFileUuid().

Here is the call graph for this function:

◆ setCameraOrientation()

void CameraEventMessage::setCameraOrientation ( const CameraOrientationType  cameraOrientation)

Sets the cameraOrientation field to cameraOrientation.

Parameters
cameraOrientationThe field value to set.

Definition at line 173 of file cameraeventmessage.cpp.

174 {
175  Q_D(CameraEventMessage);
176  d->cameraOrientation = cameraOrientation;
177 }
CameraOrientationType cameraOrientation() const
Returns the CameraEventMessage data message's cameraOrientation field's current value.

References cameraOrientation().

Here is the call graph for this function:

◆ setTimestamp()

void CameraEventMessage::setTimestamp ( const DateTime  timestamp)

Sets the timestamp field to timestamp.

Parameters
timestampThe field value to set.

Definition at line 133 of file cameraeventmessage.cpp.

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

References timestamp().

Here is the call graph for this function:

◆ setTimestampMs()

void CameraEventMessage::setTimestampMs ( const quint16  timestampMs)

Sets the timestampMs field to timestampMs.

Parameters
timestampMsThe field value to set.

Definition at line 143 of file cameraeventmessage.cpp.

144 {
145  Q_D(CameraEventMessage);
146  d->timestampMs = timestampMs;
147 }
quint16 timestampMs() const
Returns the CameraEventMessage data message's timestampMs field's current value.

References timestampMs().

Here is the call graph for this function:

◆ timestamp()

DateTime CameraEventMessage::timestamp ( ) const

Returns the CameraEventMessage 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 cameraeventmessage.cpp.

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

Referenced by setTimestamp().

Here is the caller graph for this function:

◆ timestampMs()

quint16 CameraEventMessage::timestampMs ( ) const

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

Millisecond part of the timestamp.

Returns
the timestampMs field value.

Definition at line 89 of file cameraeventmessage.cpp.

90 {
91  Q_D(const CameraEventMessage);
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: