DiveAlarmMessage Class Reference

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

Inheritance diagram for DiveAlarmMessage:

Collaboration diagram for DiveAlarmMessage:

Public Member Functions
	DiveAlarmMessage ()
	Constructs a DiveAlarmMessage object. More...
MessageIndex	messageIndex () const
	Returns the DiveAlarmMessage data message's messageIndex field's current value. More...
quint32	depth () const
	Returns the DiveAlarmMessage data message's depth field's current value. More...
qint32	time () const
	Returns the DiveAlarmMessage data message's time field's current value. More...
bool	enabled () const
	Returns the DiveAlarmMessage data message's enabled field's current value. More...
DiveAlarmType	alarmType () const
	Returns the DiveAlarmMessage data message's alarmType field's current value. More...
Tone	sound () const
	Returns the DiveAlarmMessage data message's sound field's current value. More...
SubSport	diveTypes () const
	Returns the DiveAlarmMessage data message's diveTypes field's current value. More...
void	setMessageIndex (const MessageIndex messageIndex)
	Sets the messageIndex field to messageIndex. More...
void	setDepth (const quint32 depth)
	Sets the depth field to depth. More...
void	setTime (const qint32 time)
	Sets the time field to time. More...
void	setEnabled (const bool enabled)
	Sets the enabled field to enabled. More...
void	setAlarmType (const DiveAlarmType alarmType)
	Sets the alarmType field to alarmType. More...
void	setSound (const Tone sound)
	Sets the sound field to sound. More...
void	setDiveTypes (const SubSport diveTypes)
	Sets the diveTypes field to diveTypes. 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
	DiveAlarmMessage (DiveAlarmMessagePrivate *const d)
Protected Member Functions inherited from AbstractDataMessage
	AbstractDataMessage (AbstractDataMessagePrivate *const d)

Additional Inherited Members
Static Public Member Functions inherited from AbstractDataMessage
static AbstractDataMessage *	fromData (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 DiveAlarmMessage class represents a FIT DiveAlarmMessage data message.

See also

DataMessage

Definition at line 39 of file divealarmmessage.h.

Constructor & Destructor Documentation

DiveAlarmMessage() [1/2]

DiveAlarmMessage::DiveAlarmMessage

(

)

Constructs a DiveAlarmMessage 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 divealarmmessage.cpp.

                                   : AbstractDataMessage(new DiveAlarmMessagePrivate(this))
{
 
}

DiveAlarmMessage() [2/2]

DiveAlarmMessage::DiveAlarmMessage ( DiveAlarmMessagePrivate *const  d )

explicitprotected

Constructs a DiveAlarmMessage object with private implementation d.

Parameters

d	Pointer to private implementation.

Definition at line 64 of file divealarmmessage.cpp.

                                                                    : AbstractDataMessage(d)
{
 
}

Member Function Documentation

alarmType()

DiveAlarmType DiveAlarmMessage::alarmType

(

)

const

Returns the DiveAlarmMessage data message's alarmType field's current value.

Returns

the alarmType field value.

Definition at line 120 of file divealarmmessage.cpp.

{
    Q_D(const DiveAlarmMessage);
    return d->alarmType;
}

Referenced by setAlarmType().

Here is the caller graph for this function:

depth()

quint32 DiveAlarmMessage::depth

(

)

const

Returns the DiveAlarmMessage data message's depth field's current value.

Returns

the depth field value.

Definition at line 87 of file divealarmmessage.cpp.

{
    Q_D(const DiveAlarmMessage);
    return d->depth;
}

Referenced by setDepth().

Here is the caller graph for this function:

diveTypes()

SubSport DiveAlarmMessage::diveTypes

(

)

const

Returns the DiveAlarmMessage data message's diveTypes field's current value.

Returns

the diveTypes field value.

Definition at line 142 of file divealarmmessage.cpp.

{
    Q_D(const DiveAlarmMessage);
    return d->diveTypes;
}

Referenced by setDiveTypes().

Here is the caller graph for this function:

enabled()

bool DiveAlarmMessage::enabled

(

)

const

Returns the DiveAlarmMessage data message's enabled field's current value.

Returns

the enabled field value.

Definition at line 109 of file divealarmmessage.cpp.

{
    Q_D(const DiveAlarmMessage);
    return d->enabled;
}

Referenced by setEnabled().

Here is the caller graph for this function:

messageIndex()

MessageIndex DiveAlarmMessage::messageIndex

(

)

const

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

Index of the alarm

Returns

the messageIndex field value.

Definition at line 76 of file divealarmmessage.cpp.

{
    Q_D(const DiveAlarmMessage);
    return d->messageIndex;
}

Referenced by setMessageIndex().

Here is the caller graph for this function:

setAlarmType()

void DiveAlarmMessage::setAlarmType

(

const DiveAlarmType

alarmType

)

Sets the alarmType field to alarmType.

Parameters

alarmType

The field value to set.

Definition at line 193 of file divealarmmessage.cpp.

{
    Q_D(DiveAlarmMessage);
    d->alarmType = alarmType;
}

References alarmType().

Here is the call graph for this function:

setDepth()

void DiveAlarmMessage::setDepth

(

const quint32

depth

)

Sets the depth field to depth.

Parameters

depth

The field value to set.

Definition at line 163 of file divealarmmessage.cpp.

{
    Q_D(DiveAlarmMessage);
    d->depth = depth;
}

References depth().

Here is the call graph for this function:

setDiveTypes()

void DiveAlarmMessage::setDiveTypes

(

const SubSport

diveTypes

)

Sets the diveTypes field to diveTypes.

Parameters

diveTypes

The field value to set.

Definition at line 213 of file divealarmmessage.cpp.

{
    Q_D(DiveAlarmMessage);
    d->diveTypes = diveTypes;
}

References diveTypes().

Here is the call graph for this function:

setEnabled()

void DiveAlarmMessage::setEnabled

(

const bool

enabled

)

Sets the enabled field to enabled.

Parameters

enabled

The field value to set.

Definition at line 183 of file divealarmmessage.cpp.

{
    Q_D(DiveAlarmMessage);
    d->enabled = enabled;
}

References enabled().

Here is the call graph for this function:

setMessageIndex()

void DiveAlarmMessage::setMessageIndex

(

const MessageIndex

messageIndex

)

Sets the messageIndex field to messageIndex.

Parameters

messageIndex

The field value to set.

Definition at line 153 of file divealarmmessage.cpp.

{
    Q_D(DiveAlarmMessage);
    d->messageIndex = messageIndex;
}

References messageIndex().

Here is the call graph for this function:

setSound()

void DiveAlarmMessage::setSound

(

const Tone

sound

)

Sets the sound field to sound.

Parameters

sound

The field value to set.

Definition at line 203 of file divealarmmessage.cpp.

{
    Q_D(DiveAlarmMessage);
    d->sound = sound;
}

References sound().

Here is the call graph for this function:

setTime()

void DiveAlarmMessage::setTime

(

const qint32

time

)

Sets the time field to time.

Parameters

time	The field value to set.

Definition at line 173 of file divealarmmessage.cpp.

{
    Q_D(DiveAlarmMessage);
    d->time = time;
}

References time().

Here is the call graph for this function:

sound()

Tone DiveAlarmMessage::sound

(

)

const

Returns the DiveAlarmMessage data message's sound field's current value.

Returns

the sound field value.

Definition at line 131 of file divealarmmessage.cpp.

{
    Q_D(const DiveAlarmMessage);
    return d->sound;
}

Referenced by setSound().

Here is the caller graph for this function:

time()

qint32 DiveAlarmMessage::time

(

)

const

Returns the DiveAlarmMessage data message's time field's current value.

Returns

the time field value.

Definition at line 98 of file divealarmmessage.cpp.

{
    Q_D(const DiveAlarmMessage);
    return d->time;
}

Referenced by setTime().

Here is the caller graph for this function:

---

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

• divealarmmessage.h
• divealarmmessage.cpp