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

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

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

Public Member Functions

 AviationAttitudeMessage ()
 Constructs a AviationAttitudeMessage object. More...
 
DateTime timestamp () const
 Returns the AviationAttitudeMessage data message's timestamp field's current value. More...
 
quint16 timestampMs () const
 Returns the AviationAttitudeMessage data message's timestampMs field's current value. More...
 
quint32 systemTime () const
 Returns the AviationAttitudeMessage data message's systemTime field's current value. More...
 
qint16 pitch () const
 Returns the AviationAttitudeMessage data message's pitch field's current value. More...
 
qint16 roll () const
 Returns the AviationAttitudeMessage data message's roll field's current value. More...
 
qint16 accelLateral () const
 Returns the AviationAttitudeMessage data message's accelLateral field's current value. More...
 
qint16 accelNormal () const
 Returns the AviationAttitudeMessage data message's accelNormal field's current value. More...
 
qint16 turnRate () const
 Returns the AviationAttitudeMessage data message's turnRate field's current value. More...
 
AttitudeStage stage () const
 Returns the AviationAttitudeMessage data message's stage field's current value. More...
 
quint8 attitudeStageComplete () const
 Returns the AviationAttitudeMessage data message's attitudeStageComplete field's current value. More...
 
quint16 track () const
 Returns the AviationAttitudeMessage data message's track field's current value. More...
 
AttitudeValidity validity () const
 Returns the AviationAttitudeMessage data message's validity 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 setSystemTime (const quint32 systemTime)
 Sets the systemTime field to systemTime. More...
 
void setPitch (const qint16 pitch)
 Sets the pitch field to pitch. More...
 
void setRoll (const qint16 roll)
 Sets the roll field to roll. More...
 
void setAccelLateral (const qint16 accelLateral)
 Sets the accelLateral field to accelLateral. More...
 
void setAccelNormal (const qint16 accelNormal)
 Sets the accelNormal field to accelNormal. More...
 
void setTurnRate (const qint16 turnRate)
 Sets the turnRate field to turnRate. More...
 
void setStage (const AttitudeStage stage)
 Sets the stage field to stage. More...
 
void setAttitudeStageComplete (const quint8 attitudeStageComplete)
 Sets the attitudeStageComplete field to attitudeStageComplete. More...
 
void setTrack (const quint16 track)
 Sets the track field to track. More...
 
void setValidity (const AttitudeValidity validity)
 Sets the validity field to validity. 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

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

See also
DataMessage

Definition at line 39 of file aviationattitudemessage.h.

Constructor & Destructor Documentation

◆ AviationAttitudeMessage() [1/2]

AviationAttitudeMessage::AviationAttitudeMessage ( )

Constructs a AviationAttitudeMessage 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 aviationattitudemessage.cpp.

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

◆ AviationAttitudeMessage() [2/2]

AviationAttitudeMessage::AviationAttitudeMessage ( AviationAttitudeMessagePrivate *const  d)
explicitprotected

Constructs a AviationAttitudeMessage object with private implementation d.

Parameters
dPointer to private implementation.

Definition at line 64 of file aviationattitudemessage.cpp.

65 {
66 
67 }

Member Function Documentation

◆ accelLateral()

qint16 AviationAttitudeMessage::accelLateral ( ) const

Returns the AviationAttitudeMessage data message's accelLateral field's current value.

Range -78.4 to +78.4 (-8 Gs to 8 Gs)

Returns
the accelLateral field value.

Definition at line 141 of file aviationattitudemessage.cpp.

142 {
143  Q_D(const AviationAttitudeMessage);
144  return d->accelLateral;
145 }
The AviationAttitudeMessage class represents a FIT AviationAttitudeMessage data message.

Referenced by setAccelLateral().

Here is the caller graph for this function:

◆ accelNormal()

qint16 AviationAttitudeMessage::accelNormal ( ) const

Returns the AviationAttitudeMessage data message's accelNormal field's current value.

Range -78.4 to +78.4 (-8 Gs to 8 Gs)

Returns
the accelNormal field value.

Definition at line 154 of file aviationattitudemessage.cpp.

155 {
156  Q_D(const AviationAttitudeMessage);
157  return d->accelNormal;
158 }

Referenced by setAccelNormal().

Here is the caller graph for this function:

◆ attitudeStageComplete()

quint8 AviationAttitudeMessage::attitudeStageComplete ( ) const

Returns the AviationAttitudeMessage data message's attitudeStageComplete field's current value.

The percent complete of the current attitude stage. Set to 0 for attitude stages 0, 1 and 2 and to 100 for attitude stage 3 by AHRS modules that do not support it. Range - 100

Returns
the attitudeStageComplete field value.

Definition at line 192 of file aviationattitudemessage.cpp.

193 {
194  Q_D(const AviationAttitudeMessage);
195  return d->attitudeStageComplete;
196 }

Referenced by setAttitudeStageComplete().

Here is the caller graph for this function:

◆ pitch()

qint16 AviationAttitudeMessage::pitch ( ) const

Returns the AviationAttitudeMessage data message's pitch field's current value.

Range -PI/2 to +PI/2

Returns
the pitch field value.

Definition at line 115 of file aviationattitudemessage.cpp.

116 {
117  Q_D(const AviationAttitudeMessage);
118  return d->pitch;
119 }

Referenced by setPitch().

Here is the caller graph for this function:

◆ roll()

qint16 AviationAttitudeMessage::roll ( ) const

Returns the AviationAttitudeMessage data message's roll field's current value.

Range -PI to +PI

Returns
the roll field value.

Definition at line 128 of file aviationattitudemessage.cpp.

129 {
130  Q_D(const AviationAttitudeMessage);
131  return d->roll;
132 }

Referenced by setRoll().

Here is the caller graph for this function:

◆ setAccelLateral()

void AviationAttitudeMessage::setAccelLateral ( const qint16  accelLateral)

Sets the accelLateral field to accelLateral.

Parameters
accelLateralThe field value to set.

Definition at line 277 of file aviationattitudemessage.cpp.

278 {
280  d->accelLateral = accelLateral;
281 }
qint16 accelLateral() const
Returns the AviationAttitudeMessage data message's accelLateral field's current value.

References accelLateral().

Here is the call graph for this function:

◆ setAccelNormal()

void AviationAttitudeMessage::setAccelNormal ( const qint16  accelNormal)

Sets the accelNormal field to accelNormal.

Parameters
accelNormalThe field value to set.

Definition at line 287 of file aviationattitudemessage.cpp.

288 {
290  d->accelNormal = accelNormal;
291 }
qint16 accelNormal() const
Returns the AviationAttitudeMessage data message's accelNormal field's current value.

References accelNormal().

Here is the call graph for this function:

◆ setAttitudeStageComplete()

void AviationAttitudeMessage::setAttitudeStageComplete ( const quint8  attitudeStageComplete)

Sets the attitudeStageComplete field to attitudeStageComplete.

Parameters
attitudeStageCompleteThe field value to set.

Definition at line 317 of file aviationattitudemessage.cpp.

318 {
320  d->attitudeStageComplete = attitudeStageComplete;
321 }
quint8 attitudeStageComplete() const
Returns the AviationAttitudeMessage data message's attitudeStageComplete field's current value.

References attitudeStageComplete().

Here is the call graph for this function:

◆ setPitch()

void AviationAttitudeMessage::setPitch ( const qint16  pitch)

Sets the pitch field to pitch.

Parameters
pitchThe field value to set.

Definition at line 257 of file aviationattitudemessage.cpp.

258 {
260  d->pitch = pitch;
261 }
qint16 pitch() const
Returns the AviationAttitudeMessage data message's pitch field's current value.

References pitch().

Here is the call graph for this function:

◆ setRoll()

void AviationAttitudeMessage::setRoll ( const qint16  roll)

Sets the roll field to roll.

Parameters
rollThe field value to set.

Definition at line 267 of file aviationattitudemessage.cpp.

268 {
270  d->roll = roll;
271 }
qint16 roll() const
Returns the AviationAttitudeMessage data message's roll field's current value.

References roll().

Here is the call graph for this function:

◆ setStage()

void AviationAttitudeMessage::setStage ( const AttitudeStage  stage)

Sets the stage field to stage.

Parameters
stageThe field value to set.

Definition at line 307 of file aviationattitudemessage.cpp.

308 {
310  d->stage = stage;
311 }
AttitudeStage stage() const
Returns the AviationAttitudeMessage data message's stage field's current value.

References stage().

Here is the call graph for this function:

◆ setSystemTime()

void AviationAttitudeMessage::setSystemTime ( const quint32  systemTime)

Sets the systemTime field to systemTime.

Parameters
systemTimeThe field value to set.

Definition at line 247 of file aviationattitudemessage.cpp.

248 {
250  d->systemTime = systemTime;
251 }
quint32 systemTime() const
Returns the AviationAttitudeMessage data message's systemTime field's current value.

References systemTime().

Here is the call graph for this function:

◆ setTimestamp()

void AviationAttitudeMessage::setTimestamp ( const DateTime  timestamp)

Sets the timestamp field to timestamp.

Parameters
timestampThe field value to set.

Definition at line 227 of file aviationattitudemessage.cpp.

228 {
230  d->timestamp = timestamp;
231 }
DateTime timestamp() const
Returns the AviationAttitudeMessage data message's timestamp field's current value.

References timestamp().

Here is the call graph for this function:

◆ setTimestampMs()

void AviationAttitudeMessage::setTimestampMs ( const quint16  timestampMs)

Sets the timestampMs field to timestampMs.

Parameters
timestampMsThe field value to set.

Definition at line 237 of file aviationattitudemessage.cpp.

238 {
240  d->timestampMs = timestampMs;
241 }
quint16 timestampMs() const
Returns the AviationAttitudeMessage data message's timestampMs field's current value.

References timestampMs().

Here is the call graph for this function:

◆ setTrack()

void AviationAttitudeMessage::setTrack ( const quint16  track)

Sets the track field to track.

Parameters
trackThe field value to set.

Definition at line 327 of file aviationattitudemessage.cpp.

328 {
330  d->track = track;
331 }
quint16 track() const
Returns the AviationAttitudeMessage data message's track field's current value.

References track().

Here is the call graph for this function:

◆ setTurnRate()

void AviationAttitudeMessage::setTurnRate ( const qint16  turnRate)

Sets the turnRate field to turnRate.

Parameters
turnRateThe field value to set.

Definition at line 297 of file aviationattitudemessage.cpp.

298 {
300  d->turnRate = turnRate;
301 }
qint16 turnRate() const
Returns the AviationAttitudeMessage data message's turnRate field's current value.

References turnRate().

Here is the call graph for this function:

◆ setValidity()

void AviationAttitudeMessage::setValidity ( const AttitudeValidity  validity)

Sets the validity field to validity.

Parameters
validityThe field value to set.

Definition at line 337 of file aviationattitudemessage.cpp.

338 {
340  d->validity = validity;
341 }
AttitudeValidity validity() const
Returns the AviationAttitudeMessage data message's validity field's current value.

References validity().

Here is the call graph for this function:

◆ stage()

AttitudeStage AviationAttitudeMessage::stage ( ) const

Returns the AviationAttitudeMessage data message's stage field's current value.

Returns
the stage field value.

Definition at line 178 of file aviationattitudemessage.cpp.

179 {
180  Q_D(const AviationAttitudeMessage);
181  return d->stage;
182 }

Referenced by setStage().

Here is the caller graph for this function:

◆ systemTime()

quint32 AviationAttitudeMessage::systemTime ( ) const

Returns the AviationAttitudeMessage data message's systemTime field's current value.

System time associated with sample expressed in ms.

Returns
the systemTime field value.

Definition at line 102 of file aviationattitudemessage.cpp.

103 {
104  Q_D(const AviationAttitudeMessage);
105  return d->systemTime;
106 }

Referenced by setSystemTime().

Here is the caller graph for this function:

◆ timestamp()

DateTime AviationAttitudeMessage::timestamp ( ) const

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

Timestamp message was output

Returns
the timestamp field value.

Definition at line 76 of file aviationattitudemessage.cpp.

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

Referenced by setTimestamp().

Here is the caller graph for this function:

◆ timestampMs()

quint16 AviationAttitudeMessage::timestampMs ( ) const

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

Fractional part of timestamp, added to timestamp

Returns
the timestampMs field value.

Definition at line 89 of file aviationattitudemessage.cpp.

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

Referenced by setTimestampMs().

Here is the caller graph for this function:

◆ track()

quint16 AviationAttitudeMessage::track ( ) const

Returns the AviationAttitudeMessage data message's track field's current value.

Track Angle/Heading Range 0 - 2pi

Returns
the track field value.

Definition at line 205 of file aviationattitudemessage.cpp.

206 {
207  Q_D(const AviationAttitudeMessage);
208  return d->track;
209 }

Referenced by setTrack().

Here is the caller graph for this function:

◆ turnRate()

qint16 AviationAttitudeMessage::turnRate ( ) const

Returns the AviationAttitudeMessage data message's turnRate field's current value.

Range -8.727 to +8.727 (-500 degs/sec to +500 degs/sec)

Returns
the turnRate field value.

Definition at line 167 of file aviationattitudemessage.cpp.

168 {
169  Q_D(const AviationAttitudeMessage);
170  return d->turnRate;
171 }

Referenced by setTurnRate().

Here is the caller graph for this function:

◆ validity()

AttitudeValidity AviationAttitudeMessage::validity ( ) const

Returns the AviationAttitudeMessage data message's validity field's current value.

Returns
the validity field value.

Definition at line 216 of file aviationattitudemessage.cpp.

217 {
218  Q_D(const AviationAttitudeMessage);
219  return d->validity;
220 }

Referenced by setValidity().

Here is the caller graph for this function:

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