Datamodel Interface

The datamodel interface is one of the most important interfaces of the GTlab framework. It provides classes and functions for general data management (serialization, diff, etc.).

#include "gt_moduleinterface.h"
#include "gt_datamodelinterface.h"

class MyModule: public QObject, public GtModuleInterface, GtDatamodelInterface
{
    [...]

    Q_INTERFACES(GtModuleInterface)
    Q_INTERFACES(GtDatamodelInterface)

    [...]

    /**
    * @brief Returns static meta objects of datamodel package.
    * @return package meta object
    */
    QMetaObject package();

    /**
    * @brief Returns static meta objects of datamodel classes.
    * @return list including meta objects
    */
    QList<QMetaObject> data();

    /**
    * @brief Returns true if module is a stand alone module with own
    * data model structure. Otherwise module only extends the overall
    * application with additional functionalities like classes, calculators
    * or graphical user interfaces.
    * @return Stand alone indicator.
    */
    bool standAlone();

    [...]
}

Documentation on Member Functions

• QMetaObject GtDatamodelInterface::package()

Each GTlab module that implements the DataModel interface must provide a corresponding data package class. This data package enables the creation of a custom data tree within the GTlab project (see GtModuleInterface::standAlone()). Additionally, it offers functions to modify the serialization and deserialization behavior of module-specific data during project save and open procedures.

By using the GT_METADATA macro, the data package class can be transformed into a QMetaObject, facilitating integration with the Qt framework.

[...]
return GT_METADATA(MyModulePackage);;
[...]

• QList<QMetaObject> GtModuleInterface::data()

Returns list of meta objects corresponding to data model classes provided by the module.

Using the GT_METADATA macro, new class structures can be transformed into a QMetaObject.

• bool GtModuleInterface::standAlone()

[...]
QList<QMetaObject> metaData;

metaData << GT_METADATA(MyClassA);
metaData << GT_METADATA(MyClassB);

return metaData;
[...]

Returns true if the module has an independent data structure or false if the module only extends certain data structures.