 |
HydroCouple
2.0.0
HydroCouple Interface Definitions
|
|
HydroCouple
2.0.0
HydroCouple Interface Definitions
|
Core interface definitions for the HydroCouple component-based modeling framework. More...
#include <variant>#include <string>#include <array>#include <vector>#include <span>#include <any>#include <cstdint>#include <functional>#include <list>#include <set>#include <memory>#include <typeinfo>#include <unordered_map>Go to the source code of this file.
Classes | |
| struct | HydroCouple::hydrocouple_variant_less |
| Comparator for hydrocouple_variant that enables use in ordered containers. More... | |
| class | HydroCouple::ISlot< Args > |
| ISlot interface class must be implemented by classes that want to listen to signals. More... | |
| class | HydroCouple::ISignal< Args > |
| Forward declarations. More... | |
| class | HydroCouple::IPropertyChanged |
| IPropertyChanged interface is used to emit signal/event when a property of an object changes. More... | |
| class | HydroCouple::IDescription |
| IDescription interface class provides descriptive information on a HydroCouple object. More... | |
| class | HydroCouple::IIdentity |
| IIdentity interface class defines a method to get the Id of an HydroCouple entity. More... | |
| class | HydroCouple::IComponentInfo |
| IComponentInfo interface class is a factory that provides detailed metadata about a component and creates new instances of a component. More... | |
| class | HydroCouple::IModelComponentInfo |
| IModelComponentInfo interface inherits from the IComponentInfo interface which provides detailed metadata about an IModelComponent. Additionally, it creates new instances of a component. More... | |
| class | HydroCouple::IModelComponent |
| IModelComponent interface is the core interface in the HydroCouple standard defining a model component. More... | |
| class | HydroCouple::IProxyModelComponent |
| The IProxyModelComponent class is a proxy for a remote IModelComponent that communicates via MPI or another inter-process mechanism. More... | |
| class | HydroCouple::IComponentStatusChangeEventArgs |
| The IComponentStatusChangeEventArgs contains the information that will be passed when the IModelComponent fires a signal. More... | |
| class | HydroCouple::ICloneableModelComponent |
| The ICloneableModelComponent class is an IModelComponent that supports deep cloning of itself and its configuration. More... | |
| class | HydroCouple::IValueDefinition |
| IValueDefinition describes the type and properties of values returned by IComponentDataItem::getValue() and related methods. More... | |
| class | HydroCouple::IDimension |
| IDimension provides the properties of the dimensions of a variable. More... | |
| class | HydroCouple::IQuality |
| IQuality describes qualitative data, where a value is specified as one category within a number of predefined (possible) categories. These categories can be ordered or not. More... | |
| class | HydroCouple::IUnitDimensions |
| Defines the order of dimension in each FundamentalDimension for a unit. More... | |
| class | HydroCouple::IUnit |
| IUnit interface, describing the physical unit of a IQuantity. More... | |
| class | HydroCouple::IQuantity |
| IQuantity specifies values as an amount of some unit, usually as a floating point number. More... | |
| class | HydroCouple::IComponentDataItem |
| IComponentDataItem is a fundamental unit of data for a component. More... | |
| class | HydroCouple::IComponentDataItemValueChanged |
| IComponentDataItemValueChanged interface class used to notify when the values of a IComponentDataItem change. More... | |
| class | HydroCouple::IArgument |
| IArgument interface class used to set the arguments for components. They can be complex or simple multi-dimensional datasets. More... | |
| class | HydroCouple::IExchangeItemChangeEventArgs |
| The IExchangeItemChangeEventArgs contains the information that will be passed when the IComponentItem fires the componentItemChanged signal. More... | |
| class | HydroCouple::IExchangeItem |
| IExchangeItem the base data item the can be exchanged between components at runtime. More... | |
| class | HydroCouple::IOutput |
| An output exchange item that can deliver values from an IModelComponent. More... | |
| class | HydroCouple::IAdaptedOutput |
| An IAdaptedOutput adds one or more data operations on top of an IOutput. More... | |
| class | HydroCouple::IAdaptedOutputFactory |
| IAdaptedOutputFactory is used to create instances of IAdaptedOutput. More... | |
| class | HydroCouple::IAdaptedOutputFactoryComponentInfo |
| IAdaptedOutputFactoryComponentInfo interface class provides information about an IAdaptedOutputFactoryComponent. More... | |
| class | HydroCouple::IAdaptedOutputFactoryComponent |
| IAdaptedOutputFactoryComponent is an IAdaptedOutputFactory generated from an IAdaptedOutputFactoryComponentInfo. More... | |
| class | HydroCouple::IInput |
| An IInput item that can accept values for an IModelComponent. More... | |
| class | HydroCouple::IMultiInput |
| The IMultiInput class is an IInput class that has multiple outputs supplying data to it. More... | |
| class | HydroCouple::IIdBasedComponentDataItem |
| IIdBasedComponentDataItem is an IComponentDataItem whose data is indexed by string identifiers. More... | |
| class | HydroCouple::IWorkflowComponentInfo |
| IWorkflowComponentInfo provides metadata about an IWorkflowComponent and creates new instances of it. More... | |
| class | HydroCouple::IWorkflowComponent |
| IWorkflowComponent manages the execution workflow for a set of coupled IModelComponent instances. More... | |
| class | HydroCouple::IWorkflowComponentStatusChangeEventArgs |
| The IWorkflowComponentStatusChangeEventArgs contains the information that will be passed when the IWorkflowComponent fires a signal. More... | |
Namespaces | |
| namespace | HydroCouple |
| HydroCouple namespace contains the core interface specifications for the HydroCouple component-based modeling framework interface specification. | |
Typedefs | |
| using | HydroCouple::hydrocouple_variant = std::variant< std::monostate, bool, char, int8_t, int16_t, int32_t, int64_t, uint8_t, uint16_t, uint32_t, uint64_t, float, double, long double, std::string, std::any > |
| hydrocouple_variant is a variant type that can be used to store the core value types values of different types. | |
| using | HydroCouple::hydrocouple_variant_set = std::set< hydrocouple_variant, hydrocouple_variant_less > |
| Type alias for an ordered set of hydrocouple_variant values. | |
Enumerations | |
| enum class | ByteOrder : uint8_t { BigEndian = 0 , LittleEndian = 1 } |
| The ByteOrder enum class indicates the byte order of serialized data. More... | |
Variables | |
| constexpr int | HydroCouple::HYDROCOUPLE_ABI_VERSION = 2 |
| ABI version for the HydroCouple interface. | |
Core interface definitions for the HydroCouple component-based modeling framework.
This header file contains the core interface definitions for the HydroCouple component-based modeling framework. It defines the fundamental abstractions for model components, exchange items, signals/slots, value definitions, dimensions, arguments, and workflow management.
|
strong |
1.9.8