IValueDefinition describes the type and properties of values held by an IComponentDataItem. More...
#include <hydrocouple.h>
Public Member Functions | |
| virtual | ~IValueDefinition ()=default |
| ~IValueDefinition destructor | |
| virtual ValueKind | valueKind () const =0 |
| How values of this definition behave under regridding and aggregation. | |
| virtual std::string | standardName () const =0 |
| The CF standard name of the quantity these values measure. | |
| virtual std::string | conceptURI () const =0 |
| An absolute URI naming the quantity in a published vocabulary. | |
| virtual double | missingValue () const =0 |
| The value representing that data is missing. | |
| virtual double | defaultValue () const =0 |
| Gets the default value for this value definition. | |
Public Member Functions inherited from HydroCouple::IDescription | |
| virtual | ~IDescription ()=default |
| IDescription::~IDescription is a virtual destructor. | |
| virtual const std::string & | caption () const =0 |
| Gets caption for the entity. | |
| virtual void | setCaption (const std::string &caption)=0 |
| Sets caption for the entity. | |
| virtual const std::string & | description () const =0 |
| Gets additional descriptive information for the entity. | |
| virtual void | setDescription (const std::string &description)=0 |
| Gets additional descriptive information for the entity. | |
Public Member Functions inherited from HydroCouple::IPropertyChanged | |
| virtual | ~IPropertyChanged ()=default |
| IPropertyChanged::~IPropertyChanged is a virtual destructor. | |
Public Member Functions inherited from HydroCouple::ISignal< std::string > | |
| virtual | ~ISignal ()=default |
| ISignal::~ISignal is a virtual destructor. | |
| virtual void | connect (const std::shared_ptr< ISlot< Args... > > &slot)=0 |
| connect is used to connect a slot to the signal. | |
| virtual void | disconnect (const std::shared_ptr< ISlot< Args... > > &slot)=0 |
| disconnect is used to disconnect a slot from the signal. | |
| virtual void | blockSignals (bool block)=0 |
| blockSignals is used to block signals from being emitted. | |
Additional Inherited Members | |
Protected Member Functions inherited from HydroCouple::ISignal< std::string > | |
| virtual void | emit (Args... args)=0 |
| emit is used to emit the signal. | |
IValueDefinition describes the type and properties of values held by an IComponentDataItem.
This interface is not meant to be implemented directly. Instead, implement either IQuality or IQuantity or a custom derived value definition interface. The element type of the values is reported by the owning item's IComponentDataItem::dataKind(), not here.
|
virtualdefault |
~IValueDefinition destructor
|
nodiscardpure virtual |
An absolute URI naming the quantity in a published vocabulary.
Whatever vocabulary the component's community uses — a CSDMS Standard Name, a QUDT QuantityKind, a SWEET or HY_Features concept. An empty string means not declared.
Matching. Two definitions name the same quantity when their concept URIs are equal, or — when either is undeclared — when their standard names are equal; captions never decide it. Two different declared names do not by themselves make a connection wrong (one model's outflow is another's inflow), so a validator reports the difference as a warning, not an error.
|
nodiscardpure virtual |
Gets the default value for this value definition.
Meaningful for numeric DataKinds only; for String and Opaque kinds the returned value must be ignored.
|
nodiscardpure virtual |
The value representing that data is missing.
Meaningful for numeric DataKinds only; for String and Opaque kinds the returned value must be ignored (missing entries are represented by empty values).
|
nodiscardpure virtual |
The CF standard name of the quantity these values measure.
An entry of the CF Standard Name Table (for example "water_volume_transport_in_river_channel"), the vocabulary NetCDF and UGRID persistence already writes as standard_name. An empty string means not declared. A definition must not invent a name outside the table; a quantity the table does not cover is identified by conceptURI() alone.
|
nodiscardpure virtual |
How values of this definition behave under regridding and aggregation.
Returning ValueKind::Unknown is legal and means an adapter that needs the distinction must refuse the exchange rather than assume.