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

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

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

Public Member Functions

 AntRxMessage ()
 Constructs a AntRxMessage object. More...
 
DateTime timestamp () const
 Returns the AntRxMessage data message's timestamp field's current value. More...
 
quint16 fractionalTimestamp () const
 Returns the AntRxMessage data message's fractionalTimestamp field's current value. More...
 
quint8 mesgId () const
 Returns the AntRxMessage data message's mesgId field's current value. More...
 
quint8 mesgData () const
 Returns the AntRxMessage data message's mesgData field's current value. More...
 
quint8 channelNumber () const
 Returns the AntRxMessage data message's channelNumber field's current value. More...
 
quint8 data () const
 Returns the AntRxMessage data message's data field's current value. More...
 
void setTimestamp (const DateTime timestamp)
 Sets the timestamp field to timestamp. More...
 
void setFractionalTimestamp (const quint16 fractionalTimestamp)
 Sets the fractionalTimestamp field to fractionalTimestamp. More...
 
void setMesgId (const quint8 mesgId)
 Sets the mesgId field to mesgId. More...
 
void setMesgData (const quint8 mesgData)
 Sets the mesgData field to mesgData. More...
 
void setChannelNumber (const quint8 channelNumber)
 Sets the channelNumber field to channelNumber. More...
 
void setData (const quint8 data)
 Sets the data field to data. 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

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

See also
DataMessage

Definition at line 39 of file antrxmessage.h.

Constructor & Destructor Documentation

◆ AntRxMessage() [1/2]

AntRxMessage::AntRxMessage ( )

Constructs a AntRxMessage 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 antrxmessage.cpp.

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

◆ AntRxMessage() [2/2]

AntRxMessage::AntRxMessage ( AntRxMessagePrivate *const  d)
explicitprotected

Constructs a AntRxMessage object with private implementation d.

Parameters
dPointer to private implementation.

Definition at line 64 of file antrxmessage.cpp.

65 {
66 
67 }

Member Function Documentation

◆ channelNumber()

quint8 AntRxMessage::channelNumber ( ) const

Returns the AntRxMessage data message's channelNumber field's current value.

Returns
the channelNumber field value.

Definition at line 118 of file antrxmessage.cpp.

119 {
120  Q_D(const AntRxMessage);
121  return d->channelNumber;
122 }
The AntRxMessage class represents a FIT AntRxMessage data message.
Definition: antrxmessage.h:39

Referenced by setChannelNumber().

Here is the caller graph for this function:

◆ data()

quint8 AntRxMessage::data ( ) const

Returns the AntRxMessage data message's data field's current value.

Returns
the data field value.

Definition at line 129 of file antrxmessage.cpp.

130 {
131  Q_D(const AntRxMessage);
132  return d->data;
133 }

Referenced by setData().

Here is the caller graph for this function:

◆ fractionalTimestamp()

quint16 AntRxMessage::fractionalTimestamp ( ) const

Returns the AntRxMessage data message's fractionalTimestamp field's current value.

Returns
the fractionalTimestamp field value.

Definition at line 85 of file antrxmessage.cpp.

86 {
87  Q_D(const AntRxMessage);
88  return d->fractionalTimestamp;
89 }

Referenced by setFractionalTimestamp().

Here is the caller graph for this function:

◆ mesgData()

quint8 AntRxMessage::mesgData ( ) const

Returns the AntRxMessage data message's mesgData field's current value.

Returns
the mesgData field value.

Definition at line 107 of file antrxmessage.cpp.

108 {
109  Q_D(const AntRxMessage);
110  return d->mesgData;
111 }

Referenced by setMesgData().

Here is the caller graph for this function:

◆ mesgId()

quint8 AntRxMessage::mesgId ( ) const

Returns the AntRxMessage data message's mesgId field's current value.

Returns
the mesgId field value.

Definition at line 96 of file antrxmessage.cpp.

97 {
98  Q_D(const AntRxMessage);
99  return d->mesgId;
100 }

Referenced by setMesgId().

Here is the caller graph for this function:

◆ setChannelNumber()

void AntRxMessage::setChannelNumber ( const quint8  channelNumber)

Sets the channelNumber field to channelNumber.

Parameters
channelNumberThe field value to set.

Definition at line 180 of file antrxmessage.cpp.

181 {
182  Q_D(AntRxMessage);
183  d->channelNumber = channelNumber;
184 }
quint8 channelNumber() const
Returns the AntRxMessage data message's channelNumber field's current value.

References channelNumber().

Here is the call graph for this function:

◆ setData()

void AntRxMessage::setData ( const quint8  data)

Sets the data field to data.

Parameters
dataThe field value to set.

Definition at line 190 of file antrxmessage.cpp.

191 {
192  Q_D(AntRxMessage);
193  d->data = data;
194 }
quint8 data() const
Returns the AntRxMessage data message's data field's current value.

References data().

Here is the call graph for this function:

◆ setFractionalTimestamp()

void AntRxMessage::setFractionalTimestamp ( const quint16  fractionalTimestamp)

Sets the fractionalTimestamp field to fractionalTimestamp.

Parameters
fractionalTimestampThe field value to set.

Definition at line 150 of file antrxmessage.cpp.

151 {
152  Q_D(AntRxMessage);
153  d->fractionalTimestamp = fractionalTimestamp;
154 }
quint16 fractionalTimestamp() const
Returns the AntRxMessage data message's fractionalTimestamp field's current value.

References fractionalTimestamp().

Here is the call graph for this function:

◆ setMesgData()

void AntRxMessage::setMesgData ( const quint8  mesgData)

Sets the mesgData field to mesgData.

Parameters
mesgDataThe field value to set.

Definition at line 170 of file antrxmessage.cpp.

171 {
172  Q_D(AntRxMessage);
173  d->mesgData = mesgData;
174 }
quint8 mesgData() const
Returns the AntRxMessage data message's mesgData field's current value.

References mesgData().

Here is the call graph for this function:

◆ setMesgId()

void AntRxMessage::setMesgId ( const quint8  mesgId)

Sets the mesgId field to mesgId.

Parameters
mesgIdThe field value to set.

Definition at line 160 of file antrxmessage.cpp.

161 {
162  Q_D(AntRxMessage);
163  d->mesgId = mesgId;
164 }
quint8 mesgId() const
Returns the AntRxMessage data message's mesgId field's current value.

References mesgId().

Here is the call graph for this function:

◆ setTimestamp()

void AntRxMessage::setTimestamp ( const DateTime  timestamp)

Sets the timestamp field to timestamp.

Parameters
timestampThe field value to set.

Definition at line 140 of file antrxmessage.cpp.

141 {
142  Q_D(AntRxMessage);
143  d->timestamp = timestamp;
144 }
DateTime timestamp() const
Returns the AntRxMessage data message's timestamp field's current value.

References timestamp().

Here is the call graph for this function:

◆ timestamp()

DateTime AntRxMessage::timestamp ( ) const

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

Returns
the timestamp field value.

Definition at line 74 of file antrxmessage.cpp.

75 {
76  Q_D(const AntRxMessage);
77  return d->timestamp;
78 }

Referenced by setTimestamp().

Here is the caller graph for this function:

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