API Reference

The parametric library API consists of the following parts:

All functions and types provided by the library reside in namespace parametric.

Data Processor API

class GtObject : public QObject

The GtObject class The GtObject is the base datamodel class for all datamodel objects in GTlab.

For correct functionality of the datamodel structure all objects should be inherit from GtObject.

Subclassed by GtAbstractAccessDataConnection, GtAbstractExporter, GtAbstractImporter, GtAbstractProcessItem, GtAbstractPropertyItem, GtAbstractSettings, GtDatamodelModule, GtExternalizedObject, GtLabel, GtLabelContainer, GtMdiItem, GtObjectGroup, GtPackage, GtPerspective, GtPostTemplate, GtPostTemplateItem, GtPostTemplatePath, GtProcessComponent, GtProcessConnectionItem, GtProcessRunnerCommand, GtProcessRunnerNotification, GtProcessRunnerResponse, GtProject, GtPropertyConnection, GtScaleProperty, GtSession, GtState, GtStateContainer, GtStateGroup, GtStateHandler, GtStringContainer, GtStringMapContainer, gt::process_runner::MementoDiffPayload, gt::process_runner::ProcessComponentStatePayload

Public Types

enum ObjectFlag

Flags to describe objects state and otions.

Values:

enumerator HasOwnChanges

the object has changes

enumerator HasChildChanges

at least one child of the object has changes

enumerator NewlyCreated

the object is newly created

enumerator UserDeletable

the object can be deleted in the GUI via the context menu

enumerator UserRenamable

the object can be renamed in the GUI via the context menu

enumerator DefaultComponent

the component is a default component. This means it is checked while recreation if the object can be restored or otherwise is initialized again.

enumerator UserHidden

the object is not shown in the explorer widget in the GUI

Public Functions

explicit GtObject(GtObject *parent = nullptr)

GtObject Constructor sets basic flag for newly creation, sets a new uuid for the object and sets the parent.

Parameters:

parent – is the object in the hierarchy of the datamodel which is the level over the object and its owner. If the parent is deleted the object is deleted aswell.

GtObject::ObjectFlags objectFlags() const

objectFlags

Returns:

the flags which are set for the object. These can be used to describe its state (e.g. HasOwnChanges) or its options in the user interface (e.g. UserRenamable)

bool isDummy() const

Returns true if object is a dummy. Otherwise false is returned. A dummy object is an object which cannot be recreated while starting GTlab A typical situation would be if the object was created as a specific datamodel class of a module which is not active in the current running GTlab application. To be safe not to loose information the given information are stored in a dummy object.

Returns:

True if object is a dummy.

bool hasDummyChildren() const

Returns true if object has children of type dummy. Otherwise false is returned. For more information about dummy objects see the description of “isDummy”.

Returns:

True if object has children of type dummy.

bool hasDummyParents() const

Returns true if any parent object is of type dummy. Otherwise false is returned. For more information about dummy objects see the description of “isDummy”.

Returns:

True if any parent object is of type dummy.

GtObjectMemento toMemento(bool clone = true) const

Creates a memento of the internal object state.

Parameters:

clone –

Returns:

void fromMemento(const GtObjectMemento &memento)

fromMemento

Parameters:

memento –

bool applyDiff(GtObjectMementoDiff &diff)

applyDiff

Parameters:

diff –

Returns:

bool revertDiff(GtObjectMementoDiff &diff)

revertDiff

Parameters:

diff –

Returns:

GtObject *copy() const

copy A second object is creaated which is nearly identical to the object. Only the uuid is a new one.

Returns:

a copy of the object.

GtObject *clone() const

clone A second object is creaated which is identical to the object. Even the uuid is the same.

Returns:

a clone of the object.

bool appendChild(GtObject *c)

appendChild - appends the object as child. Relationship to the old parent of the child object is destroyed

Parameters:

c – child object

Returns:

whether object has been appended or not

bool appendChildren(const QList<GtObject*> &list)

appendChildren - appends multiple objects as children. Relationship to the old parents of the children objects are destroyed

Parameters:

list – of the GtObjects.

Returns:

true in case of success.

void disconnectFromParent()

Disconnects all data changed signals/slots and set parent to nullptr.

QString uuid() const

Returns uuid of object. Uuid means universal unique identifier. Each object has a uuid to identfy it even if the names of objects are identical.

Returns:

UUID

void setUuid(const QString &val)

Sets new uuid for object.

Parameters:

val – - new uuid to use

void newUuid(bool renewChildUUIDs = false)

Generates new object uuid uses this for the object.

Parameters:

renewChildUUIDs – - if this option is set (default is false) the uuids of all child elemts are renewed, too.

QString calcHash() const

Calculates object specific hash.

Returns:

Object specific hash.

bool isDefault() const

Returns true if is default flag is active. Otherwise false is returned.

Returns:

Is default flag state.

void setDefault(bool val)

setDefault Sets the isDefault flag

Parameters:

val – New is default flag state.

bool isUserHidden() const

Returns true if user hidden flag is active. Otherwise false is returned.

Returns:

User hidden flag state.

void setUserHidden(bool val)

Sets user hidden flag by given value.

Parameters:

val – New user hidden flag state.

bool isRenamable() const

Returns true if is renamable flag is active. Otherwise false is returned.

Returns:

Is renamable flag state.

bool isDeletable() const

Returns true if object is user deletable and not default, otherwise returns false.

Returns:

Deletable flag

void setFactory(GtAbstractObjectFactory *factory)

setFactory

Parameters:

factory –

int childNumber() const

Returns the position index from the parent child list.

Returns:

position index. Returns -1 if the obejct does not have a parent

QObject *parent()

Reimplemented from QObject. Returns the parent with const correctness.

Returns:

parent object

GtObject *parentObject()

Returns the parent automatically casted to GtObject. Returns Nullptr if no parent exists or parent is not a GtObject.

Returns:

parent object

QStringList labelIds() const

Returns all label identification strings stored in results of object and all child objects.

Returns:

List of label identification strings.

bool hasChanges() const

hasChanges

Returns:

bool hasChildChanged() const

hasChildChanged

Returns:

bool newlyCreated() const

newlyCreated

Returns:

void acceptChanges()

acceptChanges

void acceptChangesRecursively()

acceptChangesRecursively

void debugObjectTree(int indent = 0)

debugObjectTree

Parameters:

indent –

const QList<GtAbstractProperty*> &properties()

Returns list of root properties.

Returns:

List of root properties.

QList<GtAbstractProperty*> fullPropertyList()

Returns list of all property and sub property items. List does not contain duplicates.

Returns:

List of all properties.

GtAbstractProperty *findProperty(const QString &id)

findProperty

Parameters:

id –

Returns:

GtAbstractProperty *findPropertyByName(const QString &name)

findPropertyByName

Parameters:

name – to use to search property

Returns:

pointer to abstract property or nullptr if the property could not be found

GtPropertyStructContainer *findPropertyContainer(const QString &id)

Returns a dynamic sie property given its “id”.

Parameters:

id – The id

Returns:

A pointer to the property or nullptr, if it cannot be found

template<typename T = GtAbstractProperty*, gt::trait::enable_if_ptr_base_of<GtAbstractProperty, T> = true>
inline QList<T> propertiesByType()

propertiesByType

Returns:

all properties of type T

template<typename T = GtObject*, gt::trait::enable_if_ptr_derived_of_qobject<T> = true>
inline int childCount(const QString &name = {}) const

Returns child count.

Parameters:

name – - optional string parameter to caount only children with the given name.

Returns:

number of direct children of the given template class

template<typename T = GtObject*, gt::trait::enable_if_ptr_derived_of_qobject<T> = true>
inline T findParent(const QString &name = {})

findParent

Parameters:

name – - optional string to define object by name

Returns:

first parent obejct of the given template class

template<typename T = GtObject*, gt::trait::enable_if_ptr_derived_of_qobject<T> = true>
inline T findRoot(T last = nullptr)

findRoot

Parameters:

last –

Returns:

template<class T = GtObject*, gt::trait::enable_if_ptr_derived_of_qobject<T> = true>
inline QList<T> findDirectChildren(const QString &name = {})

findDirectChildren

Parameters:

name – - optional string to search child with given name

Returns:

returns list of pointers to children of the template class

template<typename T = GtObject*, gt::trait::enable_if_ptr_derived_of_qobject<T> = true>
inline QList<T> findChildren(const QString &name = {})

findChildren

Parameters:

name – - optional string to search child with given name

Returns:

returns list of pointers to children of the template class

template<typename T = GtObject*, gt::trait::enable_if_ptr_derived_of_qobject<T> = true>
inline T findDirectChild(const QString &name = {})

findDirectChild

Parameters:

name – - optional string to search child with given name

Returns:

return pointer to first child of the template class

template<typename T = GtObject*, gt::trait::enable_if_ptr_derived_of_qobject<T> = true>
inline T findChild(const QString &name = {})

findChild

Parameters:

name – - optional string to search child with given name

Returns:

return pointer to first child of the template class

template<typename T = GtObject*, gt::trait::enable_if_ptr_derived_of_qobject<T> = true, gt::trait::enable_if_ptr_not_const<T> = true>
inline bool insertChild(int pos, T obj)

insertChild

Parameters:

• pos – - position to insert child to. Is not allowed to be negative

• obj – - object to insert as child

Returns:

bool value to show success

GtObject *getObjectByUuid(const QString &objectUUID)

getObjectByUuid Searches for an object with the uuid. The functions checks the object itself and all children if one of them has an identical uuid to the given argument.

Parameters:

uuid –

Returns:

the pointer to the found object with the given uuid, if no object was found return nullptr.

GtObject *getDirectChildByUuid(const QString &objectUUID)

getDirectChildByUuid

Parameters:

objectUUID –

Returns:

GtObject *getObjectByPath(const QString &objectPath)

getObjectByPath

Parameters:

objectPath –

Returns:

GtObject *getObjectByPath(QStringList &objectPath)

getObjectByPath

Parameters:

objectPath –

Returns:

QString objectPath() const

objectPath

Returns:

void setFlag(GtObject::ObjectFlag flag, bool enable = true)

setFlag

Parameters:

enable –

GtAbstractObjectFactory *factory() const

factory

Returns:

Signals

void dataChanged(GtObject*)

dataChanged

void dataChanged(GtObject*, GtAbstractProperty*)

dataChanged

void childAppended(GtObject *child, GtObject *parent)

childAppended

Parameters:

• child –

• parent –

struct Impl

Public Members

QString uuid

Object specific uuid.

GtObject::ObjectFlags objectFlags

Object flags.

GtAbstractObjectFactory *factory

factory

QList<GtAbstractProperty*> properties

object properties

std::vector<std::reference_wrapper<GtPropertyStructContainer>> propertyContainer

dynamic size properties

bool m_isDummy = {false}

A dummy object is not known by the factory but can store properties as mementos to avoid losing data for unknown objects

DummyData dummyData

only used, if object isDummy TODO: use a variant here

class GtAbstractProperty : public QObject

The GtAbstractProperty class.

Subclassed by GtProperty< double >, GtProperty< QVector< double > >, GtProperty< QString >, GtProperty< int >, GtProperty< QVariant >, GtProperty< bool >, GtProperty< ParamType >

Public Functions

virtual QVariant valueToVariant(const QString &unit, bool *success = 0) const = 0

valueAsVariant

Returns:

QVariant valueToVariant() const

valueToVariant

Returns:

template<typename T>
inline T value() const

Gets and cast the value into type T.

Returns:

The value of type T

bool setValueFromVariant(const QVariant &val)

setValueFromVariant

Parameters:

val –

Returns:

virtual bool setValueFromVariant(const QVariant &val, const QString &unit) = 0

setValueFromVariant

Parameters:

• val –

• unit –

• success –

Returns:

virtual QString brief() const

Retrieves the brief description of the parameter.

Returns:

virtual QString siUnit() const

Retrieves the SI unit of the parameter.

Returns:

virtual QString unitCategoryToString() const

Retrieves the unit category of the parameter as string.

Returns:

GtUnit::Category unitCategory() const

Retrieves the unit category of the parameter.

Returns:

GtAbstractProperty::PropertyCategory category() const

category

Returns:

void setCategory(GtAbstractProperty::PropertyCategory cat)

setCategory

Parameters:

cat –

void setCategory(const QString &cat)

setCategory

Parameters:

cat –

QString categoryToString()

categoryToString

Parameters:

cat –

Returns:

virtual const QList<GtAbstractProperty*> &properties() const

properties

Returns:

const QList<GtAbstractProperty*> &fullProperties() const

fullProperties

Returns:

virtual void registerSubProperty(GtAbstractProperty &property)

registerSubProperty

Parameters:

property –

void insertSubProperty(GtAbstractProperty &property, int index)

insertSubProperty

Parameters:

property –

bool isReadOnly()

isReadOnly

Returns:

void setReadOnly(bool val)

setReadOnly

Parameters:

val –

bool isActive() const

Returns the is active flag. This flag is only relevant for properties that are optional.

Returns:

Returns whether the property is active or not

void setActive(bool val)

Setter for the is active flag. This flag is only relevant for properties that are optional.

Parameters:

val –

bool isHidden() const

Returns true if property is marked as hidden.

Returns:

Returns whether property is hidden or not.

void hide(bool val = true)

Marks the property as hidden.

Parameters:

val – New hiden indicator.

bool isOptional() const

isOptional

Returns:

void setOptional(bool val)

Sets optional flag of the property. If val = true property is set inactive.

Parameters:

val –

int propertyCount() const

Returns number of sub properties.

Returns:

GtAbstractProperty *findProperty(const QString &id)

findProperty

Parameters:

id –

Returns:

bool isValid() const

Returns false if identification string is empty, otherwise returns true.

Returns:

Property validation.

const QString &ident() const

Returns identification string of property.

Returns:

Identification string.

bool storeToMemento() const

Determines, whether the property will be serialized to project files / memento.

Returns:

True, if the property should be serialized (default behaviour)

void setStoreToMemento(bool store)

Can be used to disable memento storage.

Parameters:

store – If store is false, the property won’t be serialized

virtual void revert()

revert

void propertyConnect(GtPropertyConnection *connection)

Connects property by given connection.

Parameters:

Property – connection.

void clearConnection()

Clears connection.

bool isConnected()

Returns true if property is connected, otherwise returns false.

Returns:

Whether property is connected or not.

Signals

void changed()

changed

void subPropChanged(GtAbstractProperty *p)

This is triggered if any of the sub properties is changed.

class GtObjectLinkProperty : public GtProperty<QString>

The GtObjectLinkProperty class.

Public Functions

GtObjectLinkProperty(const QString &ident, const QString &name, const QString &brief, const QString &uuid, GtObject *obj, QStringList allowedClasses, bool linkFromSuperClassesEnabled = false)

Constructor.

Parameters:

• ident – Memento identification string.

• name – Visible property identification string.

• brief – Property description.

• uuid – Initial uuid.

• obj – Source object.

• allowedClasses – List of allowed classes.

• linkFromSuperClassesEnabled – mode if objects of classes which inherit allowed classes should be allowed classes too

GtObjectLinkProperty(const QString &ident, const QString &name, const QString &brief, GtObject *obj, const QStringList &allowedClasses, bool linkFromSuperClassesEnabled = false)

Constructor.

The initial value is an empty string

Parameters:

• ident – Memento identification string.

• name – Visible property identification string.

• brief – Property description.

• obj – Source object.

• allowedClasses – List of allowed classes.

• linkFromSuperClassesEnabled – mode if objects of classes which inherit allowed classes should be allowed classes too

virtual QVariant valueToVariant(const QString &unit, bool *success = nullptr) const override

Overloaded function to convert internal property value to QVariant. Value is converted based on given unit.

Parameters:

• unit – Unit into which the value is to be converted.

• success – Whether conversion was successfull or not.

Returns:

Value as QVariant

virtual bool setValueFromVariant(const QVariant &val, const QString &unit) override

Overloaded function to set internal property value from given QVariant. Value of QVariant is converted based on given unit.

Parameters:

• val – New value in form of QVariant.

• unit – Unit of the input value.

• success – Whether the value could be set or not

Returns:

GtObject *linkedObject(GtObject *root = nullptr)

linkedObject

Returns:

GtObject *object() const

object

Returns:

QString linkedObjectUUID() const

linkedObjectUUID

Returns:

const QStringList &allowedClasses() const

allowedClasses

Returns:

void setAllowedClasses(QStringList allowedClasses)

Sets the list of allowed classes.

Parameters:

allowedClasses – Allowed classes

bool linkFromSuperClass() const

linkFromSuperClass

Returns:

true if classes which inherit allowed classes should be allowed, too

bool isAllowed(const QString &className) const

Returns true if the class name is allowed to be stored within this property. It will check super class as well if enabled.

Parameters:

className – Class to check

Returns:

True if the class is allowed

inline bool isAllowed(const GtObject &object) const

Overlaod that accepts a GtObject*.

Parameters:

object – Object to check

Returns:

True if the class is allowed

class GtObjectPathProperty : public GtProperty<QString>

The GtObjectPathProperty class.

Public Functions

GtObjectPathProperty(const QString &ident, const QString &name, const QString &brief, const QString &path, GtObject *obj, const QStringList &allowedClasses)

Constructor.

Parameters:

• ident – Property memento identification string.

• name – Property display identification string.

• brief – Property description.

• uuid – Path to object.

• obj – Parent object.

• allowedClasses – List of allowed class names.

virtual QVariant valueToVariant(const QString &unit, bool *success = nullptr) const override

valueToVariant

Returns:

virtual bool setValueFromVariant(const QVariant &val, const QString &unit) override

setValueFromVariant

Parameters:

val –

Returns:

GtObject *linkedObject(GtObject *root = nullptr)

Returns object based on stored object path. Returns null pointer if path is empty or invalid.

Parameters:

root – Root objectt for search.

Returns:

linked object.

GtObject *object()

Returns stored root object.

Returns:

Root object.

const QStringList &allowedClasses()

Returns allowed object classes.

Returns:

List of allowed object classes.

GtObjectPath path() const

Returns object path.

Returns:

Object path.

Module Interfaces

class GtModuleInterface

Main interface that must be implemented by a module in order for it to be recognized by the framework. All pure virtual functions must be implemented according to the specifications. This concerns especially the module identification string, the module version and the module description. A main() method is not required. Detailed information: https://gtlab.readthedocs.io/en/latest/modules/interfaces.html.

Public Functions

inline virtual ~GtModuleInterface()

Virtual destructor to keep compilers happy

virtual QString ident() const = 0

By implementing this function, the module passes its identification string to the framework. The module can be uniquely identified within the framework via the string. NOTE: This id should usually be specified only once and should not be modified afterwards. Subsequent changes to the id could lead to inconsistent data and undefined behavior.

Returns:

identification string of module

virtual GtVersionNumber version() = 0

By implementing this function, the module passes its current version number to the framework. The version number is used within the framework for identification. In this way, incompatible data sets or module updates can be detected by the framework. NOTE: Each time the module is adapted, the version number should be incremented. Otherwise, unwanted behavior may occur, e.g. inconsistent data, framework crashes.

Returns:

current version number of module

virtual QString description() const = 0

By implementing this function, the module passes a short description to the framework. The description is for information to the framework user only and has no effect on the functionality. NOTE: A description can significantly help the user to understand what functionalities the respective module provides to the framework.

Returns:

description of the module.

inline virtual MetaInformation metaInformation() const

By implementing this function, the module passes the name of the author to the framework. The authors name is for information to the framework user only and has no effect on the functionality. NOTE: A reference to the author can significantly help the user to know where a module is developed and who to contact.

Returns:

name of the author of the module.

inline virtual QList<gt::VersionUpgradeRoutine> upgradeRoutines() const

In some cases, it is necessary to upgrade the data stored in the project when the module version is updated. This function can be used to add your own update routines to the framework.

Returns:

List of all upgrade routines of the module.

inline virtual QList<gt::SharedFunction> sharedFunctions() const

Returns the functions that the module likes to share.

A shared function is a special kind of function that can be used by other modules or the core framework without the need to compile against this modules. This is possible since a shared function of type InterfaceFunction has a fixed function signature: QVariantList sharedFunction(const QVariantList&).

Reimplement sharedFunctions, if like to share generally useful functions with others.

Returns:

inline virtual QList<GtCommandLineFunction> commandLineFunctions() const

Returns the commandline functions that the module offers for the GTlab batcj application.

Reimplement commandLineFunctions, if like to add a command to the console application

inline virtual void onLoad()

Is called directly after loading the module. It can be used to interact with the loading process of the modules.

inline virtual void init()

Initializes module. Called on application startup.

struct MetaInformation

struct to keep metainformation of the module

class GtDatamodelInterface

The GtDatamodelInterface class.

Public Functions

inline virtual ~GtDatamodelInterface()

Virtual destructor to keep compilers happy

virtual QMetaObject package() = 0

Returns static meta objects of datamodel package.

Returns:

package meta object

inline virtual QList<QMetaObject> data()

Returns static meta objects of datamodel classes.

Returns:

list including meta objects

virtual bool standAlone() = 0

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.

Returns:

Stand alone indicator.

class GtProcessInterface

The GtProcessInterface class.

Public Functions

inline virtual ~GtProcessInterface()

Virtual destructor to keep compilers happy

inline virtual QList<GtCalculatorData> calculators()

Returns static meta objects of calculator classes.

Returns:

list including meta objects

inline virtual QList<GtTaskData> tasks()

Returns static meta objects of task classes.

Returns:

list including meta objects

class GtMdiInterface

The GtMdiInterface class.

Public Functions

inline virtual ~GtMdiInterface()

Virtual destructor to keep compilers happy

inline virtual QList<QMetaObject> mdiItems()

Returns static meta objects of mdi item classes.

Returns:

list including meta objects

inline virtual QList<QMetaObject> dockWidgets()

Returns static meta objects of dockwidget classes.

Returns:

list including meta objects

inline virtual QMap<const char*, QMetaObject> uiItems()

uiItems

Returns:

inline virtual QList<QMetaObject> postItems()

postItems

Returns:

inline virtual QList<QMetaObject> postPlots()

postPlots

Returns:

class GtPropertyInterface

The GtPropertyInterface class.

Public Functions

inline virtual ~GtPropertyInterface()

Virtual destructor to keep compilers happy.

inline virtual QMap<const char*, QMetaObject> propertyItems()

Returns static meta objects of property item classes.

Returns:

list of meta objects of property item classes.

class GtImporterInterface

Public Functions

inline virtual ~GtImporterInterface()

Virtual destructor to keep compilers happy.

inline virtual QList<QMetaObject> importer() const

Returns static meta objects of importer classes.

Returns:

List including meta objects of importer classes.

class GtExporterInterface

The GtExporterInterface class.

Public Functions

inline virtual ~GtExporterInterface()

Virtual destructor to keep compilers happy.

inline virtual QList<QMetaObject> exporter() const

Returns static meta objects of exporter classes.

Returns:

List including meta objects of exporter classes.

class GtCollectionInterface

The GtCollectionInterface class.

Public Functions

inline virtual ~GtCollectionInterface()

Virtual destructor to keep compilers happy.

virtual QIcon collectionIcon() const = 0

Returns collection specific icon.

Returns:

Collection spezific icon.

virtual QString collectionId() const = 0

Returns identification string of collection. Same id is used to generate access point data within the netowrk interface.

Returns:

Identification string of collection.

virtual QMetaObject collectionSettings() const = 0

Returns meta object of GtAbstractCollectionSettings class.

Returns:

Meta object of GtAbstractCollectionSettings class.

inline virtual QMap<QString, QMetaType::Type> collectionStructure() const

Returns structure of collection items.

Returns:

Sturcture of collection items.

class GtNetworkInterface

The GtNetworkInterface class.

Public Functions

inline virtual ~GtNetworkInterface()

Virtual destructor to keep compilers happy.

virtual QString accessId() = 0

Returns identification string of access point.

Returns:

Identification string of access point.

virtual QMetaObject accessConnection() = 0

Returns meta object of GtAbstractAccessDataConnection class.

Returns:

Meta object of GtAbstractAccessDataConnection class.

class GtCalculatorExecInterface

The GtCalculatorExecInterface class.

Public Functions

inline virtual ~GtCalculatorExecInterface()

Virtual destructor to keep compilers happy.

virtual QString executorId() = 0

Returns executor identification string .

Returns:

Executor identification string.

virtual QString executorDescription() = 0

Returns executor description.

Returns:

Executor description.

virtual QMetaObject executor() = 0

Returns meta object of executor.

Returns:

Meta object of executor.

inline virtual QList<GtAbstractProperty*> executorSettings()

Returns list of executor settings.

Returns:

Executor settings.