d4/d5f/extensionattributes_8h_source.html

#pragma once

#include "sdk/IComputedAttributeProvider.hpp"

#include <QObject>

#include <functional>


namespace openswmmvis

{

bool registerExtensionAttributes(QObject *layer, const QString &id,

                                 OpenSWMM::Sdk::IComputedAttributeProvider *provider,

                                 QObject *context, std::function<void(bool)> changed,

                                 QString *error = nullptr);

void unregisterExtensionAttributes(QObject *layer, const QString &id);

void refreshExtensionAttributes(QObject *layer, const QString &id);

QVector<OpenSWMM::Render::AttributeField>

extensionAttributeFields(const QObject *layer, OpenSWMMVis::SwmmCategory category);

QVariantMap extensionAttributeValues(const QObject *layer, OpenSWMMVis::SwmmCategory category,

                                     const QString &name, const QVariantMap &base);

}

IComputedAttributeProvider.hpp
Read-only model attributes contributed by an independently built extension.

OpenSWMM::Sdk::IComputedAttributeProvider
Borrowed provider of derived attributes on authored model objects.
Definition IComputedAttributeProvider.hpp:20

provider
OpenSWMM::Sdk::IComputedAttributeProvider * provider
Borrowed while context lives.
Definition extensionattributes.cpp:32

context
QPointer< QObject > context
Required provider lifetime guard.
Definition extensionattributes.cpp:31

changed
std::function< void(bool)> changed
Guarded layer refresh callback.
Definition extensionattributes.cpp:36

OpenSWMMVis::SwmmCategory
SwmmCategory
Stable ordinal categorising every SWMM-element kind that has per-kind styling, per-kind tree rows,...
Definition SwmmCategory.hpp:31

openswmmvis
Definition aquiferprovider.h:24

openswmmvis::registerExtensionAttributes
bool registerExtensionAttributes(QObject *layer, const QString &id, OpenSWMM::Sdk::IComputedAttributeProvider *provider, QObject *context, std::function< void(bool)> changed, QString *error=nullptr)
Atomically register one guarded provider on a layer.
Definition extensionattributes.cpp:49

openswmmvis::extensionAttributeFields
QVector< OpenSWMM::Render::AttributeField > extensionAttributeFields(const QObject *layer, OpenSWMMVis::SwmmCategory category)
Read validated, qualified field descriptors in deterministic provider order.
Definition extensionattributes.cpp:128

openswmmvis::unregisterExtensionAttributes
void unregisterExtensionAttributes(QObject *layer, const QString &id)
Remove a provider and notify its live layer.
Definition extensionattributes.cpp:104

openswmmvis::refreshExtensionAttributes
void refreshExtensionAttributes(QObject *layer, const QString &id)
Invalidate provider values, allowing retry after a calculation exception.
Definition extensionattributes.cpp:117

openswmmvis::extensionAttributeValues
QVariantMap extensionAttributeValues(const QObject *layer, OpenSWMMVis::SwmmCategory category, const QString &name, const QVariantMap &base)
Merge derived values into a base model-object attribute snapshot.
Definition extensionattributes.cpp:143

error
double error
Definition terrainerrorfield.cpp:42

layer
TraceAnalysisLayer * layer
Definition traceanalysislayer.cpp:162

base
int base
Definition vectorexport.cpp:212