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

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

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

Public Member Functions

 WeatherAlertMessage ()
 Constructs a WeatherAlertMessage object. More...
 
DateTime timestamp () const
 Returns the WeatherAlertMessage data message's timestamp field's current value. More...
 
QString reportId () const
 Returns the WeatherAlertMessage data message's reportId field's current value. More...
 
DateTime issueTime () const
 Returns the WeatherAlertMessage data message's issueTime field's current value. More...
 
DateTime expireTime () const
 Returns the WeatherAlertMessage data message's expireTime field's current value. More...
 
WeatherSeverity severity () const
 Returns the WeatherAlertMessage data message's severity field's current value. More...
 
WeatherSevereType type () const
 Returns the WeatherAlertMessage data message's type field's current value. More...
 
void setTimestamp (const DateTime timestamp)
 Sets the timestamp field to timestamp. More...
 
void setReportId (const QString reportId)
 Sets the reportId field to reportId. More...
 
void setIssueTime (const DateTime issueTime)
 Sets the issueTime field to issueTime. More...
 
void setExpireTime (const DateTime expireTime)
 Sets the expireTime field to expireTime. More...
 
void setSeverity (const WeatherSeverity severity)
 Sets the severity field to severity. More...
 
void setType (const WeatherSevereType type)
 Sets the type field to type. 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

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

See also
DataMessage

Definition at line 39 of file weatheralertmessage.h.

Constructor & Destructor Documentation

◆ WeatherAlertMessage() [1/2]

WeatherAlertMessage::WeatherAlertMessage ( )

Constructs a WeatherAlertMessage 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 weatheralertmessage.cpp.

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

◆ WeatherAlertMessage() [2/2]

WeatherAlertMessage::WeatherAlertMessage ( WeatherAlertMessagePrivate *const  d)
explicitprotected

Constructs a WeatherAlertMessage object with private implementation d.

Parameters
dPointer to private implementation.

Definition at line 64 of file weatheralertmessage.cpp.

65 {
66 
67 }

Member Function Documentation

◆ expireTime()

DateTime WeatherAlertMessage::expireTime ( ) const

Returns the WeatherAlertMessage data message's expireTime field's current value.

Time alert expires

Returns
the expireTime field value.

Definition at line 113 of file weatheralertmessage.cpp.

114 {
115  Q_D(const WeatherAlertMessage);
116  return d->expireTime;
117 }
The WeatherAlertMessage class represents a FIT WeatherAlertMessage data message.

Referenced by setExpireTime().

Here is the caller graph for this function:

◆ issueTime()

DateTime WeatherAlertMessage::issueTime ( ) const

Returns the WeatherAlertMessage data message's issueTime field's current value.

Time alert was issued

Returns
the issueTime field value.

Definition at line 100 of file weatheralertmessage.cpp.

101 {
102  Q_D(const WeatherAlertMessage);
103  return d->issueTime;
104 }

Referenced by setIssueTime().

Here is the caller graph for this function:

◆ reportId()

QString WeatherAlertMessage::reportId ( ) const

Returns the WeatherAlertMessage data message's reportId field's current value.

Unique identifier from GCS report ID string, length is 12

Returns
the reportId field value.

Definition at line 87 of file weatheralertmessage.cpp.

88 {
89  Q_D(const WeatherAlertMessage);
90  return d->reportId;
91 }

Referenced by setReportId().

Here is the caller graph for this function:

◆ setExpireTime()

void WeatherAlertMessage::setExpireTime ( const DateTime  expireTime)

Sets the expireTime field to expireTime.

Parameters
expireTimeThe field value to set.

Definition at line 180 of file weatheralertmessage.cpp.

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

References expireTime().

Here is the call graph for this function:

◆ setIssueTime()

void WeatherAlertMessage::setIssueTime ( const DateTime  issueTime)

Sets the issueTime field to issueTime.

Parameters
issueTimeThe field value to set.

Definition at line 170 of file weatheralertmessage.cpp.

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

References issueTime().

Here is the call graph for this function:

◆ setReportId()

void WeatherAlertMessage::setReportId ( const QString  reportId)

Sets the reportId field to reportId.

Parameters
reportIdThe field value to set.

Definition at line 160 of file weatheralertmessage.cpp.

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

References reportId().

Here is the call graph for this function:

◆ setSeverity()

void WeatherAlertMessage::setSeverity ( const WeatherSeverity  severity)

Sets the severity field to severity.

Parameters
severityThe field value to set.

Definition at line 190 of file weatheralertmessage.cpp.

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

References severity().

Here is the call graph for this function:

◆ setTimestamp()

void WeatherAlertMessage::setTimestamp ( const DateTime  timestamp)

Sets the timestamp field to timestamp.

Parameters
timestampThe field value to set.

Definition at line 150 of file weatheralertmessage.cpp.

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

References timestamp().

Here is the call graph for this function:

◆ setType()

void WeatherAlertMessage::setType ( const WeatherSevereType  type)

Sets the type field to type.

Parameters
typeThe field value to set.

Definition at line 200 of file weatheralertmessage.cpp.

201 {
202  Q_D(WeatherAlertMessage);
203  d->type = type;
204 }
WeatherSevereType type() const
Returns the WeatherAlertMessage data message's type field's current value.

References type().

Here is the call graph for this function:

◆ severity()

WeatherSeverity WeatherAlertMessage::severity ( ) const

Returns the WeatherAlertMessage data message's severity field's current value.

Warning, Watch, Advisory, Statement

Returns
the severity field value.

Definition at line 126 of file weatheralertmessage.cpp.

127 {
128  Q_D(const WeatherAlertMessage);
129  return d->severity;
130 }

Referenced by setSeverity().

Here is the caller graph for this function:

◆ timestamp()

DateTime WeatherAlertMessage::timestamp ( ) const

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

Returns
the timestamp field value.

Definition at line 74 of file weatheralertmessage.cpp.

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

Referenced by setTimestamp().

Here is the caller graph for this function:

◆ type()

WeatherSevereType WeatherAlertMessage::type ( ) const

Returns the WeatherAlertMessage data message's type field's current value.

Tornado, Severe Thunderstorm, etc.

Returns
the type field value.

Definition at line 139 of file weatheralertmessage.cpp.

140 {
141  Q_D(const WeatherAlertMessage);
142  return d->type;
143 }

Referenced by setType().

Here is the caller graph for this function:

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