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

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

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

Public Member Functions

 FileIdMessage ()
 Constructs a FileIdMessage object. More...
 
File type () const
 Returns the FileIdMessage data message's type field's current value. More...
 
Manufacturer manufacturer () const
 Returns the FileIdMessage data message's manufacturer field's current value. More...
 
quint16 product () const
 Returns the FileIdMessage data message's product field's current value. More...
 
quint32z serialNumber () const
 Returns the FileIdMessage data message's serialNumber field's current value. More...
 
DateTime timeCreated () const
 Returns the FileIdMessage data message's timeCreated field's current value. More...
 
quint16 number () const
 Returns the FileIdMessage data message's number field's current value. More...
 
QString productName () const
 Returns the FileIdMessage data message's productName field's current value. More...
 
void setType (const File type)
 Sets the type field to type. More...
 
void setManufacturer (const Manufacturer manufacturer)
 Sets the manufacturer field to manufacturer. More...
 
void setProduct (const quint16 product)
 Sets the product field to product. More...
 
void setSerialNumber (const quint32z serialNumber)
 Sets the serialNumber field to serialNumber. More...
 
void setTimeCreated (const DateTime timeCreated)
 Sets the timeCreated field to timeCreated. More...
 
void setNumber (const quint16 number)
 Sets the number field to number. More...
 
void setProductName (const QString productName)
 Sets the productName field to productName. 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

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

See also
DataMessage

Definition at line 39 of file fileidmessage.h.

Constructor & Destructor Documentation

◆ FileIdMessage() [1/2]

FileIdMessage::FileIdMessage ( )

Constructs a FileIdMessage 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 fileidmessage.cpp.

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

◆ FileIdMessage() [2/2]

FileIdMessage::FileIdMessage ( FileIdMessagePrivate *const  d)
explicitprotected

Constructs a FileIdMessage object with private implementation d.

Parameters
dPointer to private implementation.

Definition at line 64 of file fileidmessage.cpp.

65 {
66 
67 }

Member Function Documentation

◆ manufacturer()

Manufacturer FileIdMessage::manufacturer ( ) const

Returns the FileIdMessage data message's manufacturer field's current value.

Returns
the manufacturer field value.

Definition at line 85 of file fileidmessage.cpp.

86 {
87  Q_D(const FileIdMessage);
88  return d->manufacturer;
89 }
The FileIdMessage class represents a FIT FileIdMessage data message.
Definition: fileidmessage.h:39

Referenced by setManufacturer().

Here is the caller graph for this function:

◆ number()

quint16 FileIdMessage::number ( ) const

Returns the FileIdMessage data message's number field's current value.

Only set for files that are not created/erased.

Returns
the number field value.

Definition at line 133 of file fileidmessage.cpp.

134 {
135  Q_D(const FileIdMessage);
136  return d->number;
137 }

Referenced by setNumber().

Here is the caller graph for this function:

◆ product()

quint16 FileIdMessage::product ( ) const

Returns the FileIdMessage data message's product field's current value.

Returns
the product field value.

Definition at line 96 of file fileidmessage.cpp.

97 {
98  Q_D(const FileIdMessage);
99  return d->product;
100 }

Referenced by setProduct().

Here is the caller graph for this function:

◆ productName()

QString FileIdMessage::productName ( ) const

Returns the FileIdMessage data message's productName field's current value.

Optional free form string to indicate the devices name or model

Returns
the productName field value.

Definition at line 146 of file fileidmessage.cpp.

147 {
148  Q_D(const FileIdMessage);
149  return d->productName;
150 }

Referenced by setProductName().

Here is the caller graph for this function:

◆ serialNumber()

quint32z FileIdMessage::serialNumber ( ) const

Returns the FileIdMessage data message's serialNumber field's current value.

Returns
the serialNumber field value.

Definition at line 107 of file fileidmessage.cpp.

108 {
109  Q_D(const FileIdMessage);
110  return d->serialNumber;
111 }

Referenced by setSerialNumber().

Here is the caller graph for this function:

◆ setManufacturer()

void FileIdMessage::setManufacturer ( const Manufacturer  manufacturer)

Sets the manufacturer field to manufacturer.

Parameters
manufacturerThe field value to set.

Definition at line 167 of file fileidmessage.cpp.

168 {
169  Q_D(FileIdMessage);
170  d->manufacturer = manufacturer;
171 }
Manufacturer manufacturer() const
Returns the FileIdMessage data message's manufacturer field's current value.

References manufacturer().

Here is the call graph for this function:

◆ setNumber()

void FileIdMessage::setNumber ( const quint16  number)

Sets the number field to number.

Parameters
numberThe field value to set.

Definition at line 207 of file fileidmessage.cpp.

208 {
209  Q_D(FileIdMessage);
210  d->number = number;
211 }
quint16 number() const
Returns the FileIdMessage data message's number field's current value.

References number().

Here is the call graph for this function:

◆ setProduct()

void FileIdMessage::setProduct ( const quint16  product)

Sets the product field to product.

Parameters
productThe field value to set.

Definition at line 177 of file fileidmessage.cpp.

178 {
179  Q_D(FileIdMessage);
180  d->product = product;
181 }
quint16 product() const
Returns the FileIdMessage data message's product field's current value.

References product().

Here is the call graph for this function:

◆ setProductName()

void FileIdMessage::setProductName ( const QString  productName)

Sets the productName field to productName.

Parameters
productNameThe field value to set.

Definition at line 217 of file fileidmessage.cpp.

218 {
219  Q_D(FileIdMessage);
220  d->productName = productName;
221 }
QString productName() const
Returns the FileIdMessage data message's productName field's current value.

References productName().

Here is the call graph for this function:

◆ setSerialNumber()

void FileIdMessage::setSerialNumber ( const quint32z  serialNumber)

Sets the serialNumber field to serialNumber.

Parameters
serialNumberThe field value to set.

Definition at line 187 of file fileidmessage.cpp.

188 {
189  Q_D(FileIdMessage);
190  d->serialNumber = serialNumber;
191 }
quint32z serialNumber() const
Returns the FileIdMessage data message's serialNumber field's current value.

References serialNumber().

Here is the call graph for this function:

◆ setTimeCreated()

void FileIdMessage::setTimeCreated ( const DateTime  timeCreated)

Sets the timeCreated field to timeCreated.

Parameters
timeCreatedThe field value to set.

Definition at line 197 of file fileidmessage.cpp.

198 {
199  Q_D(FileIdMessage);
200  d->timeCreated = timeCreated;
201 }
DateTime timeCreated() const
Returns the FileIdMessage data message's timeCreated field's current value.

References timeCreated().

Here is the call graph for this function:

◆ setType()

void FileIdMessage::setType ( const File  type)

Sets the type field to type.

Parameters
typeThe field value to set.

Definition at line 157 of file fileidmessage.cpp.

158 {
159  Q_D(FileIdMessage);
160  d->type = type;
161 }
File type() const
Returns the FileIdMessage data message's type field's current value.

References type().

Here is the call graph for this function:

◆ timeCreated()

DateTime FileIdMessage::timeCreated ( ) const

Returns the FileIdMessage data message's timeCreated field's current value.

Only set for files that are can be created/erased.

Returns
the timeCreated field value.

Definition at line 120 of file fileidmessage.cpp.

121 {
122  Q_D(const FileIdMessage);
123  return d->timeCreated;
124 }

Referenced by setTimeCreated().

Here is the caller graph for this function:

◆ type()

File FileIdMessage::type ( ) const

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

Returns
the type field value.

Definition at line 74 of file fileidmessage.cpp.

75 {
76  Q_D(const FileIdMessage);
77  return d->type;
78 }

Referenced by setType().

Here is the caller graph for this function:

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