subsurface/core/subsurface-qt/CylinderObjectHelper.h

// SPDX-License-Identifier: GPL-2.0
#ifndef CYLINDER_QOBJECT_H
#define CYLINDER_QOBJECT_H

#include "../equipment.h"
#include <QObject>
#include <QString>

class CylinderObjectHelper {
	Q_GADGET
	Q_PROPERTY(QString description MEMBER description CONSTANT)
	Q_PROPERTY(QString size MEMBER size CONSTANT)
	Q_PROPERTY(QString workingPressure MEMBER workingPressure CONSTANT)
	Q_PROPERTY(QString startPressure MEMBER startPressure CONSTANT)
	Q_PROPERTY(QString endPressure MEMBER endPressure CONSTANT)
	Q_PROPERTY(QString gasMix MEMBER gasMix CONSTANT)
public:
	CylinderObjectHelper(const cylinder_t *cylinder = NULL);
	QString description;
	QString size;
	QString workingPressure;
	QString startPressure;
	QString endPressure;
	QString gasMix;
};

Q_DECLARE_METATYPE(CylinderObjectHelper)

#endif
Add SPDX header to remaining core files Signed-off-by: Dirk Hohndel <dirk@hohndel.org> 2017-04-27 20:24:53 +02:00			`// SPDX-License-Identifier: GPL-2.0`
Adds Cylinder helper class for cylinder info access in grantlee templates to allow grantlee to access individual fields of the cylinder_t struct rather than a string representation of the whole cylinder info using a grantlee structure like this one: <table class="table_class"> <tr> <td>Cylinder</td> <td>Start press.</td> <td>End press.</td> <td>Gas mix</td> </tr> {% for cylinderObject in dive.cylinderObjects %} <tr> <td>{{ cylinderObject.description }}</td> <td>{{ cylinderObject.startPressure }}</td> <td>{{ cylinderObject.endPressure }}</td> <td>{{ cylinderObject.gasMix }}</td> </tr> {% endfor %} </table> Signed-off-by: Tim Wootton <tim@tee-jay.org.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org> 2016-07-31 22:27:07 +01:00			`#ifndef CYLINDER_QOBJECT_H`
			`#define CYLINDER_QOBJECT_H`

Cleanup: don't include dive.h in CylinderObjectHelper.hpp This only needs the declaration of cylinder_t, which is found in equipment.h Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at> 2019-08-12 18:14:14 +02:00			`#include "../equipment.h"`
Adds Cylinder helper class for cylinder info access in grantlee templates to allow grantlee to access individual fields of the cylinder_t struct rather than a string representation of the whole cylinder info using a grantlee structure like this one: <table class="table_class"> <tr> <td>Cylinder</td> <td>Start press.</td> <td>End press.</td> <td>Gas mix</td> </tr> {% for cylinderObject in dive.cylinderObjects %} <tr> <td>{{ cylinderObject.description }}</td> <td>{{ cylinderObject.startPressure }}</td> <td>{{ cylinderObject.endPressure }}</td> <td>{{ cylinderObject.gasMix }}</td> </tr> {% endfor %} </table> Signed-off-by: Tim Wootton <tim@tee-jay.org.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org> 2016-07-31 22:27:07 +01:00			`#include <QObject>`
			`#include <QString>`

Cleanup: turn CylinderObjectHelper into value type CylinderObjectHelper is used for structured formatting of cylinder values in grantlee types. Instead of keeping a reference to a cylinder, turn it into a value type containing the formatted strings. This should be distinctly safer, as we don't risk having stale references flying around. Moreover, we don't have to use pointers but can use containers containing plain CylinderObjectHelper. Thus, no explicit memory management is needed, making the code distinctly easier to understand. Sadly, currently grantlee does not support Q_GADGET based Q_PROPERTY. Therefore a GRANTLEE_*_LOOKUP block has to be added. This can be removed in due course, as a patch to remedy this issue is in current grantlee master. Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at> 2019-08-12 18:26:42 +02:00			`class CylinderObjectHelper {`
			`Q_GADGET`
			`Q_PROPERTY(QString description MEMBER description CONSTANT)`
			`Q_PROPERTY(QString size MEMBER size CONSTANT)`
			`Q_PROPERTY(QString workingPressure MEMBER workingPressure CONSTANT)`
			`Q_PROPERTY(QString startPressure MEMBER startPressure CONSTANT)`
			`Q_PROPERTY(QString endPressure MEMBER endPressure CONSTANT)`
			`Q_PROPERTY(QString gasMix MEMBER gasMix CONSTANT)`
Adds Cylinder helper class for cylinder info access in grantlee templates to allow grantlee to access individual fields of the cylinder_t struct rather than a string representation of the whole cylinder info using a grantlee structure like this one: <table class="table_class"> <tr> <td>Cylinder</td> <td>Start press.</td> <td>End press.</td> <td>Gas mix</td> </tr> {% for cylinderObject in dive.cylinderObjects %} <tr> <td>{{ cylinderObject.description }}</td> <td>{{ cylinderObject.startPressure }}</td> <td>{{ cylinderObject.endPressure }}</td> <td>{{ cylinderObject.gasMix }}</td> </tr> {% endfor %} </table> Signed-off-by: Tim Wootton <tim@tee-jay.org.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org> 2016-07-31 22:27:07 +01:00			`public:`
Cleanup: make cylinder_t argument to CylinderObjectHelper const CylinderObjectHelper copies state from the passed in cylinder_t but does not modify it. Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at> 2019-08-13 22:30:36 +02:00			`CylinderObjectHelper(const cylinder_t *cylinder = NULL);`
Cleanup: turn CylinderObjectHelper into value type CylinderObjectHelper is used for structured formatting of cylinder values in grantlee types. Instead of keeping a reference to a cylinder, turn it into a value type containing the formatted strings. This should be distinctly safer, as we don't risk having stale references flying around. Moreover, we don't have to use pointers but can use containers containing plain CylinderObjectHelper. Thus, no explicit memory management is needed, making the code distinctly easier to understand. Sadly, currently grantlee does not support Q_GADGET based Q_PROPERTY. Therefore a GRANTLEE_*_LOOKUP block has to be added. This can be removed in due course, as a patch to remedy this issue is in current grantlee master. Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at> 2019-08-12 18:26:42 +02:00			`QString description;`
			`QString size;`
			`QString workingPressure;`
			`QString startPressure;`
			`QString endPressure;`
			`QString gasMix;`
Adds Cylinder helper class for cylinder info access in grantlee templates to allow grantlee to access individual fields of the cylinder_t struct rather than a string representation of the whole cylinder info using a grantlee structure like this one: <table class="table_class"> <tr> <td>Cylinder</td> <td>Start press.</td> <td>End press.</td> <td>Gas mix</td> </tr> {% for cylinderObject in dive.cylinderObjects %} <tr> <td>{{ cylinderObject.description }}</td> <td>{{ cylinderObject.startPressure }}</td> <td>{{ cylinderObject.endPressure }}</td> <td>{{ cylinderObject.gasMix }}</td> </tr> {% endfor %} </table> Signed-off-by: Tim Wootton <tim@tee-jay.org.uk> Signed-off-by: Dirk Hohndel <dirk@hohndel.org> 2016-07-31 22:27:07 +01:00			`};`

Cleanup: turn CylinderObjectHelper into value type CylinderObjectHelper is used for structured formatting of cylinder values in grantlee types. Instead of keeping a reference to a cylinder, turn it into a value type containing the formatted strings. This should be distinctly safer, as we don't risk having stale references flying around. Moreover, we don't have to use pointers but can use containers containing plain CylinderObjectHelper. Thus, no explicit memory management is needed, making the code distinctly easier to understand. Sadly, currently grantlee does not support Q_GADGET based Q_PROPERTY. Therefore a GRANTLEE_*_LOOKUP block has to be added. This can be removed in due course, as a patch to remedy this issue is in current grantlee master. Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at> 2019-08-12 18:26:42 +02:00			`Q_DECLARE_METATYPE(CylinderObjectHelper)`

Add SPDX header to remaining core files Signed-off-by: Dirk Hohndel <dirk@hohndel.org> 2017-04-27 20:24:53 +02:00			`#endif`