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

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

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

Public Member Functions

 GyroscopeDataMessage ()
 Constructs a GyroscopeDataMessage object. More...
 
DateTime timestamp () const
 Returns the GyroscopeDataMessage data message's timestamp field's current value. More...
 
quint16 timestampMs () const
 Returns the GyroscopeDataMessage data message's timestampMs field's current value. More...
 
quint16 sampleTimeOffset () const
 Returns the GyroscopeDataMessage data message's sampleTimeOffset field's current value. More...
 
quint16 gyroX () const
 Returns the GyroscopeDataMessage data message's gyroX field's current value. More...
 
quint16 gyroY () const
 Returns the GyroscopeDataMessage data message's gyroY field's current value. More...
 
quint16 gyroZ () const
 Returns the GyroscopeDataMessage data message's gyroZ field's current value. More...
 
float calibratedGyroX () const
 Returns the GyroscopeDataMessage data message's calibratedGyroX field's current value. More...
 
float calibratedGyroY () const
 Returns the GyroscopeDataMessage data message's calibratedGyroY field's current value. More...
 
float calibratedGyroZ () const
 Returns the GyroscopeDataMessage data message's calibratedGyroZ 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 setSampleTimeOffset (const quint16 sampleTimeOffset)
 Sets the sampleTimeOffset field to sampleTimeOffset. More...
 
void setGyroX (const quint16 gyroX)
 Sets the gyroX field to gyroX. More...
 
void setGyroY (const quint16 gyroY)
 Sets the gyroY field to gyroY. More...
 
void setGyroZ (const quint16 gyroZ)
 Sets the gyroZ field to gyroZ. More...
 
void setCalibratedGyroX (const float calibratedGyroX)
 Sets the calibratedGyroX field to calibratedGyroX. More...
 
void setCalibratedGyroY (const float calibratedGyroY)
 Sets the calibratedGyroY field to calibratedGyroY. More...
 
void setCalibratedGyroZ (const float calibratedGyroZ)
 Sets the calibratedGyroZ field to calibratedGyroZ. 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

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

See also
DataMessage

Definition at line 39 of file gyroscopedatamessage.h.

Constructor & Destructor Documentation

◆ GyroscopeDataMessage() [1/2]

GyroscopeDataMessage::GyroscopeDataMessage ( )

Constructs a GyroscopeDataMessage 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 gyroscopedatamessage.cpp.

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

◆ GyroscopeDataMessage() [2/2]

GyroscopeDataMessage::GyroscopeDataMessage ( GyroscopeDataMessagePrivate *const  d)
explicitprotected

Constructs a GyroscopeDataMessage object with private implementation d.

Parameters
dPointer to private implementation.

Definition at line 64 of file gyroscopedatamessage.cpp.

65 {
66 
67 }

Member Function Documentation

◆ calibratedGyroX()

float GyroscopeDataMessage::calibratedGyroX ( ) const

Returns the GyroscopeDataMessage data message's calibratedGyroX field's current value.

Calibrated gyro reading

Returns
the calibratedGyroX field value.

Definition at line 159 of file gyroscopedatamessage.cpp.

160 {
161  Q_D(const GyroscopeDataMessage);
162  return d->calibratedGyroX;
163 }
The GyroscopeDataMessage class represents a FIT GyroscopeDataMessage data message.

Referenced by setCalibratedGyroX().

Here is the caller graph for this function:

◆ calibratedGyroY()

float GyroscopeDataMessage::calibratedGyroY ( ) const

Returns the GyroscopeDataMessage data message's calibratedGyroY field's current value.

Calibrated gyro reading

Returns
the calibratedGyroY field value.

Definition at line 172 of file gyroscopedatamessage.cpp.

173 {
174  Q_D(const GyroscopeDataMessage);
175  return d->calibratedGyroY;
176 }

Referenced by setCalibratedGyroY().

Here is the caller graph for this function:

◆ calibratedGyroZ()

float GyroscopeDataMessage::calibratedGyroZ ( ) const

Returns the GyroscopeDataMessage data message's calibratedGyroZ field's current value.

Calibrated gyro reading

Returns
the calibratedGyroZ field value.

Definition at line 185 of file gyroscopedatamessage.cpp.

186 {
187  Q_D(const GyroscopeDataMessage);
188  return d->calibratedGyroZ;
189 }

Referenced by setCalibratedGyroZ().

Here is the caller graph for this function:

◆ gyroX()

quint16 GyroscopeDataMessage::gyroX ( ) const

Returns the GyroscopeDataMessage data message's gyroX field's current value.

These are the raw ADC reading. Maximum number of samples is 30 in each message. The samples may span across seconds. A conversion will need to be done on this data once read.

Returns
the gyroX field value.

Definition at line 118 of file gyroscopedatamessage.cpp.

119 {
120  Q_D(const GyroscopeDataMessage);
121  return d->gyroX;
122 }

Referenced by setGyroX().

Here is the caller graph for this function:

◆ gyroY()

quint16 GyroscopeDataMessage::gyroY ( ) const

Returns the GyroscopeDataMessage data message's gyroY field's current value.

These are the raw ADC reading. Maximum number of samples is 30 in each message. The samples may span across seconds. A conversion will need to be done on this data once read.

Returns
the gyroY field value.

Definition at line 132 of file gyroscopedatamessage.cpp.

133 {
134  Q_D(const GyroscopeDataMessage);
135  return d->gyroY;
136 }

Referenced by setGyroY().

Here is the caller graph for this function:

◆ gyroZ()

quint16 GyroscopeDataMessage::gyroZ ( ) const

Returns the GyroscopeDataMessage data message's gyroZ field's current value.

These are the raw ADC reading. Maximum number of samples is 30 in each message. The samples may span across seconds. A conversion will need to be done on this data once read.

Returns
the gyroZ field value.

Definition at line 146 of file gyroscopedatamessage.cpp.

147 {
148  Q_D(const GyroscopeDataMessage);
149  return d->gyroZ;
150 }

Referenced by setGyroZ().

Here is the caller graph for this function:

◆ sampleTimeOffset()

quint16 GyroscopeDataMessage::sampleTimeOffset ( ) const

Returns the GyroscopeDataMessage data message's sampleTimeOffset field's current value.

Each time in the array describes the time at which the gyro sample with the corrosponding index was taken. Limited to 30 samples in each message. The samples may span across seconds. Array size must match the number of samples in gyro_x and gyro_y and gyro_z

Returns
the sampleTimeOffset field value.

Definition at line 104 of file gyroscopedatamessage.cpp.

105 {
106  Q_D(const GyroscopeDataMessage);
107  return d->sampleTimeOffset;
108 }

Referenced by setSampleTimeOffset().

Here is the caller graph for this function:

◆ setCalibratedGyroX()

void GyroscopeDataMessage::setCalibratedGyroX ( const float  calibratedGyroX)

Sets the calibratedGyroX field to calibratedGyroX.

Parameters
calibratedGyroXThe field value to set.

Definition at line 256 of file gyroscopedatamessage.cpp.

257 {
259  d->calibratedGyroX = calibratedGyroX;
260 }
float calibratedGyroX() const
Returns the GyroscopeDataMessage data message's calibratedGyroX field's current value.

References calibratedGyroX().

Here is the call graph for this function:

◆ setCalibratedGyroY()

void GyroscopeDataMessage::setCalibratedGyroY ( const float  calibratedGyroY)

Sets the calibratedGyroY field to calibratedGyroY.

Parameters
calibratedGyroYThe field value to set.

Definition at line 266 of file gyroscopedatamessage.cpp.

267 {
269  d->calibratedGyroY = calibratedGyroY;
270 }
float calibratedGyroY() const
Returns the GyroscopeDataMessage data message's calibratedGyroY field's current value.

References calibratedGyroY().

Here is the call graph for this function:

◆ setCalibratedGyroZ()

void GyroscopeDataMessage::setCalibratedGyroZ ( const float  calibratedGyroZ)

Sets the calibratedGyroZ field to calibratedGyroZ.

Parameters
calibratedGyroZThe field value to set.

Definition at line 276 of file gyroscopedatamessage.cpp.

277 {
279  d->calibratedGyroZ = calibratedGyroZ;
280 }
float calibratedGyroZ() const
Returns the GyroscopeDataMessage data message's calibratedGyroZ field's current value.

References calibratedGyroZ().

Here is the call graph for this function:

◆ setGyroX()

void GyroscopeDataMessage::setGyroX ( const quint16  gyroX)

Sets the gyroX field to gyroX.

Parameters
gyroXThe field value to set.

Definition at line 226 of file gyroscopedatamessage.cpp.

227 {
229  d->gyroX = gyroX;
230 }
quint16 gyroX() const
Returns the GyroscopeDataMessage data message's gyroX field's current value.

References gyroX().

Here is the call graph for this function:

◆ setGyroY()

void GyroscopeDataMessage::setGyroY ( const quint16  gyroY)

Sets the gyroY field to gyroY.

Parameters
gyroYThe field value to set.

Definition at line 236 of file gyroscopedatamessage.cpp.

237 {
239  d->gyroY = gyroY;
240 }
quint16 gyroY() const
Returns the GyroscopeDataMessage data message's gyroY field's current value.

References gyroY().

Here is the call graph for this function:

◆ setGyroZ()

void GyroscopeDataMessage::setGyroZ ( const quint16  gyroZ)

Sets the gyroZ field to gyroZ.

Parameters
gyroZThe field value to set.

Definition at line 246 of file gyroscopedatamessage.cpp.

247 {
249  d->gyroZ = gyroZ;
250 }
quint16 gyroZ() const
Returns the GyroscopeDataMessage data message's gyroZ field's current value.

References gyroZ().

Here is the call graph for this function:

◆ setSampleTimeOffset()

void GyroscopeDataMessage::setSampleTimeOffset ( const quint16  sampleTimeOffset)

Sets the sampleTimeOffset field to sampleTimeOffset.

Parameters
sampleTimeOffsetThe field value to set.

Definition at line 216 of file gyroscopedatamessage.cpp.

217 {
219  d->sampleTimeOffset = sampleTimeOffset;
220 }
quint16 sampleTimeOffset() const
Returns the GyroscopeDataMessage data message's sampleTimeOffset field's current value.

References sampleTimeOffset().

Here is the call graph for this function:

◆ setTimestamp()

void GyroscopeDataMessage::setTimestamp ( const DateTime  timestamp)

Sets the timestamp field to timestamp.

Parameters
timestampThe field value to set.

Definition at line 196 of file gyroscopedatamessage.cpp.

197 {
199  d->timestamp = timestamp;
200 }
DateTime timestamp() const
Returns the GyroscopeDataMessage data message's timestamp field's current value.

References timestamp().

Here is the call graph for this function:

◆ setTimestampMs()

void GyroscopeDataMessage::setTimestampMs ( const quint16  timestampMs)

Sets the timestampMs field to timestampMs.

Parameters
timestampMsThe field value to set.

Definition at line 206 of file gyroscopedatamessage.cpp.

207 {
209  d->timestampMs = timestampMs;
210 }
quint16 timestampMs() const
Returns the GyroscopeDataMessage data message's timestampMs field's current value.

References timestampMs().

Here is the call graph for this function:

◆ timestamp()

DateTime GyroscopeDataMessage::timestamp ( ) const

Returns the GyroscopeDataMessage 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 gyroscopedatamessage.cpp.

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

Referenced by setTimestamp().

Here is the caller graph for this function:

◆ timestampMs()

quint16 GyroscopeDataMessage::timestampMs ( ) const

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

Millisecond part of the timestamp.

Returns
the timestampMs field value.

Definition at line 89 of file gyroscopedatamessage.cpp.

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