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

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

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

Public Member Functions

 DiveGasMessage ()
 Constructs a DiveGasMessage object. More...
 
MessageIndex messageIndex () const
 Returns the DiveGasMessage data message's messageIndex field's current value. More...
 
quint8 heliumContent () const
 Returns the DiveGasMessage data message's heliumContent field's current value. More...
 
quint8 oxygenContent () const
 Returns the DiveGasMessage data message's oxygenContent field's current value. More...
 
DiveGasStatus status () const
 Returns the DiveGasMessage data message's status field's current value. More...
 
void setMessageIndex (const MessageIndex messageIndex)
 Sets the messageIndex field to messageIndex. More...
 
void setHeliumContent (const quint8 heliumContent)
 Sets the heliumContent field to heliumContent. More...
 
void setOxygenContent (const quint8 oxygenContent)
 Sets the oxygenContent field to oxygenContent. More...
 
void setStatus (const DiveGasStatus status)
 Sets the status field to status. 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

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

See also
DataMessage

Definition at line 39 of file divegasmessage.h.

Constructor & Destructor Documentation

◆ DiveGasMessage() [1/2]

DiveGasMessage::DiveGasMessage ( )

Constructs a DiveGasMessage 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 divegasmessage.cpp.

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

◆ DiveGasMessage() [2/2]

DiveGasMessage::DiveGasMessage ( DiveGasMessagePrivate *const  d)
explicitprotected

Constructs a DiveGasMessage object with private implementation d.

Parameters
dPointer to private implementation.

Definition at line 64 of file divegasmessage.cpp.

65 {
66 
67 }

Member Function Documentation

◆ heliumContent()

quint8 DiveGasMessage::heliumContent ( ) const

Returns the DiveGasMessage data message's heliumContent field's current value.

Returns
the heliumContent field value.

Definition at line 85 of file divegasmessage.cpp.

86 {
87  Q_D(const DiveGasMessage);
88  return d->heliumContent;
89 }
The DiveGasMessage class represents a FIT DiveGasMessage data message.

Referenced by setHeliumContent().

Here is the caller graph for this function:

◆ messageIndex()

MessageIndex DiveGasMessage::messageIndex ( ) const

Returns the DiveGasMessage data message's messageIndex field's current value.

Returns
the messageIndex field value.

Definition at line 74 of file divegasmessage.cpp.

75 {
76  Q_D(const DiveGasMessage);
77  return d->messageIndex;
78 }

Referenced by setMessageIndex().

Here is the caller graph for this function:

◆ oxygenContent()

quint8 DiveGasMessage::oxygenContent ( ) const

Returns the DiveGasMessage data message's oxygenContent field's current value.

Returns
the oxygenContent field value.

Definition at line 96 of file divegasmessage.cpp.

97 {
98  Q_D(const DiveGasMessage);
99  return d->oxygenContent;
100 }

Referenced by setOxygenContent().

Here is the caller graph for this function:

◆ setHeliumContent()

void DiveGasMessage::setHeliumContent ( const quint8  heliumContent)

Sets the heliumContent field to heliumContent.

Parameters
heliumContentThe field value to set.

Definition at line 128 of file divegasmessage.cpp.

129 {
130  Q_D(DiveGasMessage);
131  d->heliumContent = heliumContent;
132 }
quint8 heliumContent() const
Returns the DiveGasMessage data message's heliumContent field's current value.

References heliumContent().

Here is the call graph for this function:

◆ setMessageIndex()

void DiveGasMessage::setMessageIndex ( const MessageIndex  messageIndex)

Sets the messageIndex field to messageIndex.

Parameters
messageIndexThe field value to set.

Definition at line 118 of file divegasmessage.cpp.

119 {
120  Q_D(DiveGasMessage);
121  d->messageIndex = messageIndex;
122 }
MessageIndex messageIndex() const
Returns the DiveGasMessage data message's messageIndex field's current value.

References messageIndex().

Here is the call graph for this function:

◆ setOxygenContent()

void DiveGasMessage::setOxygenContent ( const quint8  oxygenContent)

Sets the oxygenContent field to oxygenContent.

Parameters
oxygenContentThe field value to set.

Definition at line 138 of file divegasmessage.cpp.

139 {
140  Q_D(DiveGasMessage);
141  d->oxygenContent = oxygenContent;
142 }
quint8 oxygenContent() const
Returns the DiveGasMessage data message's oxygenContent field's current value.

References oxygenContent().

Here is the call graph for this function:

◆ setStatus()

void DiveGasMessage::setStatus ( const DiveGasStatus  status)

Sets the status field to status.

Parameters
statusThe field value to set.

Definition at line 148 of file divegasmessage.cpp.

149 {
150  Q_D(DiveGasMessage);
151  d->status = status;
152 }
DiveGasStatus status() const
Returns the DiveGasMessage data message's status field's current value.

References status().

Here is the call graph for this function:

◆ status()

DiveGasStatus DiveGasMessage::status ( ) const

Returns the DiveGasMessage data message's status field's current value.

Returns
the status field value.

Definition at line 107 of file divegasmessage.cpp.

108 {
109  Q_D(const DiveGasMessage);
110  return d->status;
111 }

Referenced by setStatus().

Here is the caller graph for this function:

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