2.0.0-beta.1 · interface ABI 5 · namespace https://hydrocouple.org/HydroCouple/vocabulary/#
The concepts of the HydroCouple interface standard, generated from its C++ headers (which remain normative). Machine-readable: Turtle · JSON-LD.
HydroCouple::BufferDescriptor
BufferDescriptor describes a typed, possibly strided, possibly device-resident multi-dimensional array. It is the sole currency of field data exchange.
| Property | Range | Meaning |
|---|---|---|
backend | DeviceBackend | Runtime owning the device memory when space is Device/Unified. |
data | Base address of element (0, 0, ..., 0). | |
deviceId | xsd:int | Device ordinal within the backend when space is Device/Unified. |
itemSizeBytes | xsd:long | Size of one element; 0 => the kind's natural size (illegal for Opaque). |
kind | DataKind | Element type. |
queue | Opaque backend stream/queue for asynchronous transfers; nullptr => default stream, synchronous. | |
rank | xsd:int | Number of dimensions; 0 denotes a scalar. |
shape | xsd:long | Extent per dimension; length == rank. |
space | MemorySpace | Memory space holding the bytes. |
stridesBytes | xsd:long | Byte step per dimension; nullptr => C-contiguous. |
HydroCouple::DifferentialEntry
DifferentialEntry pairs one data item, in one role, with a buffer holding its tangent (forward mode) or cotangent (reverse mode).
| Property | Range | Meaning |
|---|---|---|
item | IComponentDataItem | The item this derivative belongs to. |
role | DifferentialRole | Which side of the step. |
value | BufferDescriptor | The tangent or cotangent buffer. |
HydroCouple::Distributed::ITransport::Endpoint
Endpoint identifies one participant reachable through this transport.
| Property | Range | Meaning |
|---|---|---|
address | xsd:string | Transport-specific address (empty for rank-addressed transports). |
rank | xsd:int | Participant rank for rank-addressed transports; -1 otherwise. |
HydroCouple::ErrorEntry
ErrorEntry is one diagnostic record in a component's error queue.
| Property | Range | Meaning |
|---|---|---|
code | xsd:int | Implementation-defined error code. |
message | xsd:string | Human-readable description. |
severity | Severity | Severity of this record. |
source | xsd:string | Id of the originating entity. |
HydroCouple::IAdaptedOutput
An IAdaptedOutput adds one or more data operations on top of an IOutput.
Specializes IOutput.
| Property | Range | Meaning |
|---|---|---|
adaptedOutputFactory | IAdaptedOutputFactory | IAdaptedOutputFactory that generated this IAdaptedOutput. |
adaptee | IOutput | IOutput that this IAdaptedOutput extracts content from. In the adapter design pattern, it is the item being adapted. |
arguments | IArgument | IArgument represents input parameters needed for this IAdaptedOutput. |
states | IComponentDataItem | The data items that make up the state carried from one refresh() to the next. |
HydroCouple::IAdaptedOutputFactory
IAdaptedOutputFactory is used to create instances of IAdaptedOutput.
Specializes IIdentity.
HydroCouple::IAdaptedOutputFactoryComponent
IAdaptedOutputFactoryComponent is an IAdaptedOutputFactory generated from an IAdaptedOutputFactoryComponentInfo.
Specializes IAdaptedOutputFactory.
| Property | Range | Meaning |
|---|---|---|
componentInfo | IAdaptedOutputFactoryComponentInfo | Contains the metadata about this IAdaptedOutputFactoryComponent. |
HydroCouple::IAdaptedOutputFactoryComponentInfo
IAdaptedOutputFactoryComponentInfo interface class provides information about an IAdaptedOutputFactoryComponent.
Specializes IComponentInfo.
HydroCouple::IArgument
IArgument interface class used to set the arguments for components. They can be complex or simple multi-dimensional datasets
Specializes IComponentDataItem.
| Property | Range | Meaning |
|---|---|---|
currentArgumentInputType | ArgumentInputType | Gets the current input type used for this argument. |
fileFilters | xsd:string | File type extensions that can be read by this IArgument. |
isOptional | xsd:boolean | Specifies whether the argument is optional or not. |
isReadOnly | xsd:boolean | Whether the argument's values may be changed (through initialize() or setValuesFrom()). |
role | ArgumentRole | What this argument is to the model. |
toString | xsd:string | A human-readable rendering of this argument's current value, for display and logs. serialize() is the round-trippable form. |
validComponentDataItemTypes | Gets the valid IComponentDataItem instance types that can be read by this argument. |
HydroCouple::ICheckpointableAdaptedOutput
ICheckpointableAdaptedOutput is an adapted output that can save and restore the state it carries between refreshes.
Specializes IAdaptedOutput.
HydroCouple::ICheckpointableModelComponent
ICheckpointableModelComponent is an IModelComponent that can save and restore its complete simulation state.
Specializes IModelComponent.
HydroCouple::ICloneableModelComponent
The ICloneableModelComponent class is an IModelComponent that supports deep cloning of itself and its configuration.
Specializes IModelComponent.
| Property | Range | Meaning |
|---|---|---|
clones | ICloneableModelComponent | The ICloneableModelComponent instances cloned from this instance that are still alive. |
parent | ICloneableModelComponent | Parent ICloneableModelComponent object from which current component was cloned from. |
HydroCouple::IComponentDataItem
IComponentDataItem is a fundamental unit of data for a component.
Specializes IIdentity.
| Property | Range | Meaning |
|---|---|---|
dataKind | DataKind | The element type of this data item's values. |
dimensions | IDimension | The axes of this item's index space, in storage order. |
modelComponent | IModelComponent | Gets the owner IModelComponent of this IComponentItem. For an IOutput component item this is the component responsible for providing the content of the IOutput. |
shape | xsd:long | The extent of each dimension of this data item's index space. |
valueDefinition | IValueDefinition | IValueDefinition for this IComponentDataItem defines the variable type associated with this object. |
HydroCouple::IComponentDataItemValueChanged
IComponentDataItemValueChanged interface class used to notify when the values of a IComponentDataItem change.
| Property | Range | Meaning |
|---|---|---|
componentDataItem | IComponentDataItem | Gets the IComponentDataItem that fired the event. |
count | xsd:long | Gets the extent of the hyperslab that changed. |
start | xsd:long | Gets the start index of the hyperslab that changed. |
HydroCouple::IComponentInfo
IComponentInfo interface class is a factory that provides detailed metadata about a component and creates new instances of a component.
Specializes IIdentity.
| Property | Range | Meaning |
|---|---|---|
copyright | xsd:string | Component copyright info. |
developer | xsd:string | Component developer information. |
documentation | xsd:string | Documentation associated with this component. |
email | xsd:string | Component developer email. |
iconFilePath | xsd:string | File path to Component icon. Must be specified relative to the component library. |
libraryFilePath | xsd:string | File path to Component library. |
license | xsd:string | Component license info. |
tags | xsd:string | tags used to classify this component. |
url | xsd:string | Component developer url. |
version | xsd:string | Component version info. |
HydroCouple::IComponentStatusChangeEventArgs
The IComponentStatusChangeEventArgs contains the information that will be passed when the IModelComponent fires a signal.
| Property | Range | Meaning |
|---|---|---|
component | IModelComponent | Gets the IModelComponent that fired the event. |
hasProgressMonitor | xsd:boolean | Indicates whether this event has a progress monitor. |
message | xsd:string | Gets additional information about the status change. |
percentProgress | xsd:float | Number between 0 and 100 indicating the progress made by a component in its simulation. |
previousStatus | ComponentStatus | Gets the IModelComponent's status before the status change. |
status | ComponentStatus | Gets the IModelComponent's status after the status change. |
HydroCouple::Spatial::ICrossSection
The shape of a channel at one place, as a function of stage.
| Property | Range | Meaning |
|---|---|---|
invertElevation | xsd:double | Lowest elevation in the section (positive up). |
kind | CrossSectionKind | How the producer holds this shape. |
stationCount | xsd:long | Number of survey points, or 0 when the producer holds no points. |
HydroCouple::Spatial::ICurve
A Curve is a 1-dimensional geometric object usually stored as a sequence of IPoints, with the subtype of ICurve specifying the form of the interpolation between IPoints.
Specializes IGeometry.
| Property | Range | Meaning |
|---|---|---|
endPoint | IPoint | The end IPoint of this ICurve. |
isClosed | xsd:boolean | Returns True if this ICurve is closed[startPoint() = endPoint()]. |
isRing | xsd:boolean | and this ICurve is simple(does not pass through the same Point more than once). |
length | xsd:double | The length of this ICurve in its associated ISpatialReferenceSystem. |
startPoint | IPoint | The start IPoint of this ICurve. |
HydroCouple::Temporal::IDateTime
IDateTime interface based on a Julian day
Specializes IPropertyChanged.
| Property | Range | Meaning |
|---|---|---|
julianDay | xsd:double | Date and time as a Julian day value (days since 4713 BC January 1, 12:00 UTC). |
modifiedJulianDay | xsd:double | Modified Julian day value: julianDay() - 2400000.5 (days since 1858-11-17 00:00 UTC). |
serialDate | xsd:double | Serial date number in the MATLAB `datenum` convention: days since 0000-01-00 in the proleptic Gregorian calendar, i.e. julianDay() - 1721058.5. (Excel's 1900 serial differs from this by 693960 days and is not what is meant.) |
HydroCouple::IDescription
IDescription interface class provides descriptive information on a HydroCouple object.
Specializes IPropertyChanged.
| Property | Range | Meaning |
|---|---|---|
caption | xsd:string | Gets caption for the entity. |
description | xsd:string | Gets additional descriptive information for the entity. |
HydroCouple::IDifferentiableAdaptedOutput
IDifferentiableAdaptedOutput is an adapted output that can report the derivative of its most recent refresh().
Specializes IAdaptedOutput.
| Property | Range | Meaning |
|---|---|---|
differentiableArguments | IArgument | The arguments of this adapter a derivative reaches (may be empty). |
differentiableStates | IComponentDataItem | The data items that carry state from one refresh() to the next and that the derivative follows; a subset of states(). |
HydroCouple::IDifferentiableModelComponent
IDifferentiableModelComponent is a model component that can report the derivative of its most recent step.
Specializes IModelComponent.
| Property | Range | Meaning |
|---|---|---|
differentiableArguments | IArgument | The arguments (parameters) a derivative reaches. |
differentiableInputs | IInput | The inputs a derivative reaches. Inputs not listed are treated as constant. |
differentiableOutputs | IOutput | The outputs whose derivative the component can report. |
differentiableStates | IComponentDataItem | The data items that make up the state carried from one step to the next. |
HydroCouple::IDimension
IDimension provides the properties of one axis of a data item's index space.
Specializes IIdentity.
| Property | Range | Meaning |
|---|---|---|
lengthType | LengthType | Gets the length type of the dimension. |
role | DimensionRole | What this axis means. |
HydroCouple::Distributed::IDistributedModelComponent
IDistributedModelComponent is an IModelComponent that participates in distributed execution through a transport.
Specializes IModelComponent.
| Property | Range | Meaning |
|---|---|---|
partitionCount | xsd:int | The number of partitions this component's domain is decomposed into. |
partitionRank | xsd:int | The partition this instance computes. |
transport | ITransport | The transport this component communicates through. |
HydroCouple::Spatial::IEdge
A directed edge from one vertex to another, adjacent to two faces. Based on Dani Lischinski's code from Graphics Gems IV. Original quad-edge data structure due to Guibas and Stolfi (1985). Does not inherit from geometry to reduce size. since each edge has 4 pointers.
| Property | Range | Meaning |
|---|---|---|
dest | IVertex | The destination IVertex of this IEdge. |
destNext | IEdge | The next ccw edge around (into) the destination of this edge. |
destPrev | IEdge | The next cw edge around (into) the destination of this edge. |
face | IPolygon | The target face of this edge, if dual. Otherwise null if not dual. |
index | xsd:long | Index of this edge in its owning mesh or network (IMeshView::edgeNodes() order). |
invRot | IEdge | The dual of this IEdge, directed from its left to its right. |
left | IPolygon | The left face of this edge. |
leftNext | IEdge | The ccw edge around the left face following this edge. |
leftPrev | IEdge | The ccw edge around the left face before this edge. |
orig | IVertex | The origin IVertex of this IEdge. |
origNext | IEdge | The next ccw edge around (from) the origin of this IEdge. |
origPrev | IEdge | The next cw edge around (from) the origin of this edge. |
right | IPolygon | The right face of this edge. |
rightNext | IEdge | The edge around the right face ccw following this edge. |
rightPrev | IEdge | The IEdge around the right face ccw before this IEdge. |
rot | IEdge | The dual of this edge, directed from its right to its left. |
sym | IEdge | The IEdge from the destination to the origin of this IEdge. |
HydroCouple::Spatial::IEnvelope
IEnvelope represents the minimum bounding box of a geometry.
| Property | Range | Meaning |
|---|---|---|
maxX | xsd:double | The maximum x-coordinate value for this IEnvelope. |
maxY | xsd:double | The maximum y-coordinate value for this IEnvelope. |
maxZ | xsd:double | The maximum z-coordinate value for this IEnvelope. |
minX | xsd:double | The minimum x-coordinate value for this IEnvelope. |
minY | xsd:double | The minimum y-coordinate value for this IEnvelope. |
minZ | xsd:double | The minimum z-coordinate value for this IEnvelope. |
HydroCouple::IExchangeItem
IExchangeItem the base data item the can be exchanged between components at runtime.
Specializes IComponentDataItem.
HydroCouple::Distributed::IExchangeRequest
IExchangeRequest is a handle to an asynchronous communication operation.
HydroCouple::Spatial::IGeometry
IGeometry is the root class of the geometry hierarchy.
| Property | Range | Meaning |
|---|---|---|
boundary | IGeometry | Returns the closure of the combinatorial boundary of this geometric object (Reference [1], section 3.12.2). |
convexHull | IGeometry | Returns a geometric object that represents the convex hull of this geometric object. |
coordinateDimension | xsd:int | Get the dimension of the coordinates in this object. |
dimension | xsd:int | The inherent dimension of this geometric object, which must be less than or equal to the coordinate dimension. In non - homogeneous collections, this will return the largest topological dimension of the contained objects. |
envelope | IEnvelope | The minimum bounding box for this Geometry. |
geometryType | GeometryType | Gets the geometry type of this object. |
getWKB | xsd:unsignedByte | Exports this geometric object to a specific Well-known byte Representation of Geometry. |
getWKT | xsd:string | Exports this geometric object to a specific Well-known Text Representation of Geometry. |
id | xsd:string | id of the geometry. |
index | xsd:long | index of the geometry if it is part of a collection. |
is3D | xsd:boolean | Returns true if this geometric object has z coordinate values. |
isEmpty | xsd:boolean | If true, then this geometric object represents the empty point set ∅ for the coordinate space. |
isMeasured | xsd:boolean | Returns true if this geometric object has m coordinate values. |
isSimple | xsd:boolean | Returns true if this geometric object has no anomalous geometric points, such as self intersection or self tangency. |
spatialReferenceSystem | ISpatialReferenceSystem | Spatial reference system of geometric object. |
HydroCouple::Spatial::IGeometryCollection
An IGeometryCollection is a geometric object that is a collection of some number of IGeometry objects.
Specializes IGeometry.
| Property | Range | Meaning |
|---|---|---|
geometryCount | xsd:long | The number of geometries in this IGeometryCollection |
HydroCouple::Spatial::IGeometryComponentDataItem
IGeometryComponentDataItem is an IComponentDataItem whose data is associated with a collection of IGeometry objects. This class must be implemented as an abstract class.
Specializes IComponentDataItem.
Canonical dimension ordering: the geometry dimension is dimension 0 of shape() (IDimension::DimensionRole::Entity); any additional dimensions follow.
| Property | Range | Meaning |
|---|---|---|
envelope | IEnvelope | The IEnvelope bounding all geometries of this data item. |
geometryCount | xsd:long | The number of geometries associated with this data item. |
geometryDimension | IDimension | The IDimension of the geometries (dimension 0 of shape()). |
geometryType | GeometryType | The type of the geometries this data item is associated with. |
HydroCouple::IIdBasedComponentDataItem
IIdBasedComponentDataItem is an IComponentDataItem whose data is indexed by string identifiers.
Specializes IComponentDataItem.
Canonical dimension ordering: the identifier dimension is dimension 0 of shape(); any additional dimensions follow.
| Property | Range | Meaning |
|---|---|---|
identifierDimension | IDimension | identifierDimension returns the identifier dimension of the id based component item. |
identifiers | xsd:string | Gets the identifiers associated with this id-based component data item. |
HydroCouple::IIdentity
IIdentity interface class defines a method to get the Id of an HydroCouple entity.
Specializes IDescription.
| Property | Range | Meaning |
|---|---|---|
id | xsd:string | Gets a unique identifier for the entity. |
HydroCouple::IInput
An IInput item that can accept values for an IModelComponent.
Specializes IExchangeItem.
| Property | Range | Meaning |
|---|---|---|
provider | IOutput | Gets the producer this consumer should get its values from. |
HydroCouple::Spatial::ILayeredMeshComponentDataItem
A polyhedral surface whose values are resolved into vertical layers.
Specializes IPolyhedralSurfaceComponentDataItem, ILayering.
HydroCouple::Spatial::ILayeredNetworkComponentDataItem
A network carrying a vertical profile, and optionally a channel shape, at each node or edge.
Specializes INetworkComponentDataItem, ILayering.
HydroCouple::Spatial::ILayering
Values resolved into vertical layers, whatever the plan geometry.
| Property | Range | Meaning |
|---|---|---|
layerDimension | IDimension | The IDimension of the layers (IDimension::DimensionRole::Layer). |
verticalCoordinate | IVerticalCoordinate | Where those layers are. |
HydroCouple::ILicensedComponent
ILicensedComponent is an optional side interface for components that require license validation.
HydroCouple::Spatial::ILine
The ILine class is an ILineString with exactly 2 IPoints.
Specializes ILineString.
HydroCouple::Spatial::ILineString
An ILineString is a Curve with linear interpolation between Points. Each consecutive pair of Points defines a Line segment.
Specializes ICurve.
| Property | Range | Meaning |
|---|---|---|
pointCount | xsd:long | The number of IPoints in this ILineString. |
HydroCouple::Spatial::ILinearRing
An ILinearRing is an ILineString that is both isClosed() and isSimple().
Specializes ILineString.
HydroCouple::Spatial::IMeshView
IMeshView is a bulk, structure-of-arrays view of an unstructured mesh or network: flat coordinate spans plus CSR (compressed sparse row) connectivity.
| Property | Range | Meaning |
|---|---|---|
edgeCount | xsd:long | The number of edges in the mesh. |
edgeFaces | xsd:long | The two faces of every edge: edge e separates edgeFaces()[2*e] (left, looking from edgeNodes()[2*e] toward edgeNodes()[2*e+1]) from edgeFaces()[2*e+1] (right); -1 marks the outside of the mesh, so a boundary edge has exactly one -1 [edge_face_connectivity]. |
edgeLengths | xsd:double | Length of every edge in the reference system's distance units; edgeCount() or empty. |
edgeNodes | xsd:long | Node index pairs of all edges: edge e connects edgeNodes()[2*e] and edgeNodes()[2*e + 1]. |
edgeNormalX | xsd:double | x component of every edge's unit normal, pointing from the left face to the right face as edgeFaces() orders them; edgeCount() or empty. |
edgeNormalY | xsd:double | y component of every edge's unit normal; edgeCount() or empty. |
faceAreas | xsd:double | Plan area of every face in the reference system's distance units squared; faceCount() or empty. |
faceCount | xsd:long | The number of faces (patches/cells) in the mesh; 0 for a pure network. |
faceEdgeOffsets | xsd:long | CSR row offsets into faceEdges(): the edges of face f are faceEdges()[faceEdgeOffsets()[f] ... faceEdgeOffsets()[f+1]). |
faceEdges | xsd:long | Concatenated edge indexes of all faces [face_edge_connectivity]. |
faceNodeOffsets | xsd:long | CSR row offsets into faceNodes(): the nodes of face f are faceNodes()[faceNodeOffsets()[f] ... faceNodeOffsets()[f+1]). |
faceNodes | xsd:long | Concatenated node indexes of all faces, ordered counter-clockwise per face. |
faceX | xsd:double | x coordinate of every face's representative point (centroid or circumcentre, producer's choice) [face_x]; faceCount() or empty. |
faceY | xsd:double | y coordinate of every face's representative point [face_y]; faceCount() or empty. |
nodeCount | xsd:long | The number of nodes (vertices) in the mesh. |
nodeX | xsd:double | x coordinates of all nodes; the span has nodeCount() elements. |
nodeY | xsd:double | y coordinates of all nodes; the span has nodeCount() elements. |
nodeZ | xsd:double | z coordinates of all nodes; the span has nodeCount() elements, or is empty for a 2D mesh. |
HydroCouple::IModelComponent
IModelComponent interface is the core interface in the HydroCouple standard defining a model component.
Specializes IIdentity.
| Property | Range | Meaning |
|---|---|---|
arguments | IArgument | Arguments needed to let the component do its work. An unmodifiable list of (modifiable) arguments must be returned that is to be used to get information about the arguments and to set argument values. |
capabilities | Capability | The set of optional capabilities this component supports. |
componentInfo | IModelComponentInfo | Contains the metadata about this IModelComponent instance. |
inputs | IInput | The list of consumer items for which a component can receive values. |
outputs | IOutput | The list of IOutputs for which a component can produce results. |
referenceDirectory | xsd:string | Gets the reference directory for this component instance. |
results | IComponentDataItem | List of the model's output results |
states | IComponentDataItem | The data items that make up the state carried from one update() to the next. |
status | ComponentStatus | Defines current status of the IModelComponent. See IModelComponent::ComponentStatus for the possible values. |
workflow | IWorkflowComponent | Gets the workflow that this component is part of. |
HydroCouple::IModelComponentInfo
IModelComponentInfo interface inherits from the IComponentInfo interface which provides detailed metadata about an IModelComponent. Additionally, it creates new instances of a component.
Specializes IComponentInfo.
| Property | Range | Meaning |
|---|---|---|
adaptedOutputFactories | IAdaptedOutputFactory | Gets a list of IAdaptedOutputFactories, each allowing to create IAdaptedOutput item for making outputs fit to inputs in case they do not already do so. |
HydroCouple::Spatial::IMultiCurve
An IMultiCurve is a 1-dimensional IGeometryCollection whose elements are ICurves.
Specializes IGeometryCollection.
| Property | Range | Meaning |
|---|---|---|
isClosed | xsd:boolean | closed[startPoint ( ) = endPoint ( ) for each ICurve in this IMultiCurve]. |
length | xsd:double | The Length of this IMultiCurve which is equal to the sum of the lengths of the element ICurves. |
HydroCouple::IMultiInput
The IMultiInput class is an IInput class that has multiple outputs supplying data to it.
Specializes IInput.
| Property | Range | Meaning |
|---|---|---|
providerLabels | IIdentity | The roles this multi-input's providers fill (empty when it names none). |
providers | IOutput | Gets the list of providers supplying data to this multi-input. |
HydroCouple::Spatial::IMultiLineString
An IMultiLineString is an IMultiCurve whose elements are ILineStrings.
Specializes IMultiCurve.
HydroCouple::Spatial::IMultiPoint
An IMultiPoint is a 0-dimensional IGeometryCollection.
Specializes IGeometryCollection.
HydroCouple::Spatial::IMultiPolygon
An IMultiPolygon is an IMultiSurface whose elements are IPolygons.
Specializes IMultiSurface.
HydroCouple::Spatial::IMultiSurface
A MultiSurface is a 2-dimensional GeometryCollection whose elements are Surfaces, all using coordinates from the same coordinate reference system.
Specializes IGeometryCollection.
| Property | Range | Meaning |
|---|---|---|
area | xsd:double | The area of this ISurface, as measured in the spatial reference system of this ISurface. |
centroid | IPoint | The mathematical centroid for this ISurface as an IPoint. The result is not guaranteed to be on this ISurface. Newly constructed; owned by the caller. |
pointOnSurface | IPoint | A Point guaranteed to be on this ISurface. Newly constructed; owned by the caller. |
HydroCouple::Spatial::INetwork
INetwork represents a graph structure of connected vertices and edges.
Specializes IIdentity.
| Property | Range | Meaning |
|---|---|---|
edgeCount | xsd:long | The number of edges in the network. |
meshView | IMeshView | Bulk structure-of-arrays view of this network's geometry and connectivity. |
vertexCount | xsd:long | The number of vertices in the network. |
HydroCouple::Spatial::INetworkComponentDataItem
INetworkComponentDataItem is an IComponentDataItem whose data is associated with the edges or the nodes of an INetwork.
Specializes IComponentDataItem.
Canonical dimension ordering: the entity dimension selected by location() (Node or Edge; DimensionRole::Entity) is dimension 0 of shape(); a Component dimension follows when networkDataType() is not Scalar; any additional dimensions follow that.
| Property | Range | Meaning |
|---|---|---|
entityDimension | IDimension | The IDimension of the entities (dimension 0 of shape()). |
location | MeshLocation | Which network entity (Node or Edge) this data item's values are attached to. |
network | INetwork | The INetwork this data item is associated with. |
networkDataType | SpatialDataType | The algebraic structure of the value at each entity (scalar, vector, ...). |
vectorBasis | VectorBasis | The frame of vector/tensor values; VectorBasis::Unknown is legal only when networkDataType() is Scalar or MultiScalar. |
HydroCouple::IOutput
An output exchange item that can deliver values from an IModelComponent.
Specializes IExchangeItem.
| Property | Range | Meaning |
|---|---|---|
adaptedOutputs | IAdaptedOutput | The adaptedOutputs that have this current output item as adaptee. |
consumers | IInput | Input items that will consume the values by calling the IOutput::updateValues() method. |
HydroCouple::Distributed::IPartitionedComponentDataItem
IPartitionedComponentDataItem is an IComponentDataItem whose entity dimension is decomposed across partitions, with local virtual (ghost/halo) representation of remotely owned entities.
Specializes IComponentDataItem.
| Property | Range | Meaning |
|---|---|---|
globalCount | xsd:long | The global entity count across all partitions. |
ownedGlobalIndexes | xsd:long | Global identities of the locally owned entities. |
partitionedDimension | xsd:int | Which axis of shape() is decomposed across partitions. |
synchronizationEpoch | xsd:unsignedLong | The synchronization epoch of the virtual entities. |
virtualGlobalIndexes | xsd:long | Global identities of the local virtual (ghost/halo) entities. |
virtualOwners | xsd:int | Owner partition of each virtual entity. |
HydroCouple::Spatial::IPoint
An IPoint is a 0-dimensional geometric object and represents a single location in coordinate space.
Specializes IGeometry.
| Property | Range | Meaning |
|---|---|---|
m | xsd:double | The m-coordinate value for this IPoint. Returns NIL otherwise. |
x | xsd:double | The x-coordinate value for this IPoint. |
y | xsd:double | The y-coordinate value for this IPoint. |
z | xsd:double | The z-coordinate value for this IPoint. Returns NIL otherwise. |
HydroCouple::Spatial::IPolygon
A IPolygon is a planar ISurface defined by 1 exterior boundary and 0 or more interior boundaries.
Specializes ISurface.
| Property | Range | Meaning |
|---|---|---|
edge | IEdge | An arbitrary adjacent edge for this IPolygon. |
exteriorRing | ILineString | Returns the exterior ring of this IPolygon. |
interiorRingCount | xsd:long | Returns the number of interior rings in this IPolygon. |
polyhedralSurface | IPolyhedralSurface | Gets the polyhedral surface this polygon belongs to. |
HydroCouple::Spatial::IPolyhedralSurface
An IPolyhedralSurface is a contiguous collection of polygon patches or facets stitched together along their shared boundary edges.
Specializes ISurface.
| Property | Range | Meaning |
|---|---|---|
isClosed | xsd:boolean | Checks whether this surface is closed and therefore bounds a solid. |
meshView | IMeshView | Bulk structure-of-arrays view of this surface's geometry and connectivity. |
patchCount | xsd:long | The number of polygon patches in this surface. |
vertexCount | xsd:long | The number of vertices in this surface. |
HydroCouple::Spatial::IPolyhedralSurfaceComponentDataItem
IPolyhedralSurfaceComponentDataItem is an IComponentDataItem whose data is associated with the faces (patches), edges, or nodes of an IPolyhedralSurface.
Specializes IComponentDataItem.
Canonical dimension ordering: the entity dimension selected by location() (DimensionRole::Entity) is dimension 0 of shape(); a Component dimension follows when meshDataType() is not Scalar; any additional dimensions follow that.
| Property | Range | Meaning |
|---|---|---|
entityDimension | IDimension | The IDimension of the entities (dimension 0 of shape()). |
location | MeshLocation | Which mesh entity (Node, Edge or Face; Volume for a layered item) this data item's values are attached to. |
meshDataType | SpatialDataType | The algebraic structure of the value at each entity (scalar, vector, ...). |
polyhedralSurface | IPolyhedralSurface | The IPolyhedralSurface this data item is associated with. |
vectorBasis | VectorBasis | The frame of vector/tensor values; VectorBasis::Unknown is legal only when meshDataType() is Scalar or MultiScalar. |
HydroCouple::IPropertyChanged
IPropertyChanged interface is used to emit signal/event when a property of an object changes.
HydroCouple::Distributed::IProxyModelComponent
The IProxyModelComponent class is a local stand-in for a remote IModelComponent reachable through a transport.
Specializes IDistributedModelComponent.
| Property | Range | Meaning |
|---|---|---|
isConnected | xsd:boolean | Checks whether the proxy currently holds a live connection. |
remoteEndpoint | Endpoint | The endpoint of the remote component this proxy represents. |
remoteId | xsd:string | The unique identifier of the remote component this proxy represents. |
requestTimeout | xsd:double | The timeout applied to forwarded requests. |
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.
Specializes IValueDefinition.
| Property | Range | Meaning |
|---|---|---|
categories | xsd:string | The possible category labels allowed for this IQuality. |
isOrdered | xsd:boolean | Whether categories() has a defined order (ordinal) or not (nominal). |
HydroCouple::IQuantity
IQuantity specifies values as an amount of some unit, usually as a floating point number.
Specializes IValueDefinition.
| Property | Range | Meaning |
|---|---|---|
maxValue | xsd:double | Gets the maximum allowed value for this quantity. |
minValue | xsd:double | Gets the minimum allowed value for this quantity. |
unit | IUnit | Unit of quantity. |
HydroCouple::Spatial::IRaster
A Raster spatial feature.
Specializes IIdentity.
| Property | Range | Meaning |
|---|---|---|
rasterBandCount | xsd:long | Number of raster bands. |
spatialReferenceSystem | ISpatialReferenceSystem | The ISpatialReferenceSystem represents the spatial reference system of this raster. |
xSize | xsd:long | Number of pixels in the x direction. |
ySize | xsd:long | Number of pixels in y direction. |
HydroCouple::Spatial::IRasterBand
IRasterBand is a single raster band for an IRaster.
Specializes IIdentity.
| Property | Range | Meaning |
|---|---|---|
dataType | RasterDataType | Raster data type |
noData | xsd:double | The nodata value for this IRasterBand. |
raster | IRaster | Parent IRaster of this IRasterBand |
xSize | xsd:long | Number of pixels in the x direction |
ySize | xsd:long | Number of pixels in y direction |
HydroCouple::Spatial::IRasterComponentDataItem
IRasterComponentDataItem is an IComponentDataItem whose data is associated with an IRaster.
Specializes IComponentDataItem.
Canonical dimension ordering: band is dimension 0 (DimensionRole::Band), y (row) is dimension 1 (DimensionRole::Row), x (column) is dimension 2 (DimensionRole::Column) of shape().
| Property | Range | Meaning |
|---|---|---|
bandDimension | IDimension | The IDimension of the raster bands (dimension 0 of shape()). |
raster | IRaster | The IRaster this data item is associated with. |
xDimension | IDimension | The IDimension of the raster columns (dimension 2 of shape()). |
yDimension | IDimension | The IDimension of the raster rows (dimension 1 of shape()). |
HydroCouple::Spatial::IRegularGrid2D
IRegularGrid2D represents a two-dimensional structured grid of nodes and cells.
Specializes IIdentity.
| Property | Range | Meaning |
|---|---|---|
activeCells | xsd:unsignedByte | Bulk activity mask of all cells, row-major [yCell][xCell]; nonzero means active. |
gridType | RegularGridType | Gets the type of regular grid. |
nodeXs | xsd:double | Bulk x coordinates of all nodes, row-major [yNode][xNode]. |
nodeYs | xsd:double | Bulk y coordinates of all nodes, row-major [yNode][xNode]. |
numXNodes | xsd:long | numXNodes represents the number of nodes in the x direction. |
numYNodes | xsd:long | numYNodes represents the number of nodes in the y direction. |
spatialReferenceSystem | ISpatialReferenceSystem | The ISpatialReferenceSystem represents the spatial reference system of this geometric object. |
HydroCouple::Spatial::IRegularGrid2DComponentDataItem
IRegularGrid2DComponentDataItem is an IComponentDataItem whose data is associated with the cells of an IRegularGrid2D.
Specializes IComponentDataItem.
Canonical dimension ordering: y-cell is dimension 0 (DimensionRole::Row), x-cell is dimension 1 (DimensionRole::Column) of shape(); the optional cell edge and cell vertex dimensions (DimensionRole::Other) follow.
| Property | Range | Meaning |
|---|---|---|
cellEdgeDimension | IDimension | The IDimension of the edges of a cell, when values are attached to cell edges. |
cellVertexDimension | IDimension | The IDimension of the vertices of a cell, when values are attached to cell vertices. |
grid | IRegularGrid2D | The IRegularGrid2D this data item is associated with. |
location | MeshLocation | Which grid entity the values are attached to: Face for cells, Edge for cell edges, Node for cell vertices. |
xCellDimension | IDimension | The IDimension of the cells in the x direction (dimension 1 of shape()). |
yCellDimension | IDimension | The IDimension of the cells in the y direction (dimension 0 of shape()). |
HydroCouple::Spatial::IRegularGrid3D
IRegularGrid3D represents a three-dimensional structured grid of nodes and cells.
Specializes IIdentity.
| Property | Range | Meaning |
|---|---|---|
activeCells | xsd:unsignedByte | Bulk activity mask of all cells, row-major [zCell][yCell][xCell]; nonzero means active. |
gridType | RegularGridType | Gets the type of regular grid. |
nodeXs | xsd:double | Bulk x coordinates of all nodes in a horizontal layer, row-major [yNode][xNode]. |
nodeYs | xsd:double | Bulk y coordinates of all nodes in a horizontal layer, row-major [yNode][xNode]. |
nodeZs | xsd:double | Bulk z coordinates of all nodes, row-major [zNode][yNode][xNode]. |
numXNodes | xsd:long | numXNodes represents the number of nodes in the x direction. |
numYNodes | xsd:long | numYNodes represents the number of nodes in the y direction. |
numZNodes | xsd:long | numZNodes represents the number of nodes in the z direction. |
spatialReferenceSystem | ISpatialReferenceSystem | The ISpatialReferenceSystem represents the spatial reference system of this grid. |
HydroCouple::Spatial::IRegularGrid3DComponentDataItem
IRegularGrid3DComponentDataItem is an IComponentDataItem whose data is associated with the cells of an IRegularGrid3D.
Specializes IComponentDataItem.
Canonical dimension ordering: z-cell is dimension 0 (DimensionRole::Depth), y-cell is dimension 1 (DimensionRole::Row), x-cell is dimension 2 (DimensionRole::Column) of shape(); the optional cell face and cell vertex dimensions (DimensionRole::Other) follow.
| Property | Range | Meaning |
|---|---|---|
cellFaceDimension | IDimension | The IDimension of the faces of a cell, when values are attached to cell faces. |
cellVertexDimension | IDimension | The IDimension of the vertices of a cell, when values are attached to cell vertices. |
grid | IRegularGrid3D | The IRegularGrid3D this data item is associated with. |
location | MeshLocation | Which grid entity the values are attached to: Volume for cells, Face for cell faces, Node for cell vertices. |
xCellDimension | IDimension | The IDimension of the cells in the x direction (dimension 2 of shape()). |
yCellDimension | IDimension | The IDimension of the cells in the y direction (dimension 1 of shape()). |
zCellDimension | IDimension | The IDimension of the cells in the z direction (dimension 0 of shape()). |
HydroCouple::Spatial::ISpatialReferenceSystem
ISpatialReferenceSystem describes the coordinate reference system for spatial geometric objects.
| Property | Range | Meaning |
|---|---|---|
authName | xsd:string | The Authority Specific Spatial Reference System Identifier. |
authSRID | xsd:int | Returns the Spatial Reference System ID (SRID) for a geometric object. This will normally be a foreign key to an index of reference systems stored in either the same or some other datastore. |
distanceUnits | DistanceUnits | The measurement distance units for the horizontal axes of the Spatial Reference System. |
srText | xsd:string | Well-known Text description of the Spatial Reference System. |
verticalAuthName | xsd:string | Authority of the vertical reference system (e.g. "EPSG"), or empty if undeclared. |
verticalAuthSRID | xsd:int | The authority's identifier of the vertical reference system (e.g. 5703 for NAVD88 height), or 0 if undeclared. |
verticalDistanceUnits | DistanceUnits | The measurement distance units of the vertical axis. |
verticalSrText | xsd:string | Well-known Text of the vertical reference system, or empty if undeclared. |
HydroCouple::Spatial::ISurface
A ISurface is a 2-dimensional IGeometry object.
Specializes IGeometry.
| Property | Range | Meaning |
|---|---|---|
area | xsd:double | The area of this ISurface, as measured in the spatial reference system of this ISurface. |
boundaryMultiCurve | IMultiCurve | Gets the boundary of this surface as a multi-curve. |
centroid | IPoint | The mathematical centroid for this ISurface as a Point. The result is not guaranteed to be on this ISurface. Newly constructed; owned by the caller. |
pointOnSurface | IPoint | A Point guaranteed to be on this Surface. Newly constructed; owned by the caller. |
HydroCouple::Spatial::ITIN
An ITIN is a triangulated irregular network IPolyhedralSurface consisting only of ITriangle patches.
Specializes IPolyhedralSurface.
HydroCouple::Spatial::ITINComponentDataItem
ITINComponentDataItem is an IPolyhedralSurfaceComponentDataItem whose surface is an ITIN.
Specializes IPolyhedralSurfaceComponentDataItem.
| Property | Range | Meaning |
|---|---|---|
TIN | ITIN | The ITIN this data item is associated with. |
HydroCouple::SpatioTemporal::ITimeGeometryComponentDataItem
ITimeGeometryComponentDataItem is a geometry component data item whose values also vary in time.
Specializes ITimeSeriesComponentDataItem, IGeometryComponentDataItem.
Canonical dimension ordering: time is dimension 0, the geometry dimension is dimension 1 of shape(); any additional dimensions follow.
HydroCouple::Temporal::ITimeIdBasedComponentDataItem
ITimeIdBasedComponentDataItem is an IComponentDataItem with both temporal and identifier-based dimensions for accessing multi-dimensional time-series data.
Specializes ITimeSeriesComponentDataItem.
Canonical dimension ordering: time is dimension 0 (DimensionRole::Time), the identifier dimension is dimension 1 (DimensionRole::Entity); any additional dimensions follow.
| Property | Range | Meaning |
|---|---|---|
identifierDimension | IDimension | identifierDimension associated with this data item. |
identifiers | xsd:string | identifiers associated with the identifier dimension. |
HydroCouple::SpatioTemporal::ITimeLayeredMeshComponentDataItem
A layered mesh item whose values also vary in time.
Specializes ITimeSeriesPolyhedralSurfaceComponentDataItem, ILayeredMeshComponentDataItem.
Canonical dimension ordering: time is dimension 0, the entity (face or volume) dimension is dimension 1, the layer dimension is dimension 2 of shape(); a Component dimension follows when meshDataType() is not Scalar.
HydroCouple::SpatioTemporal::ITimeLayeredNetworkComponentDataItem
A layered network item whose values also vary in time.
Specializes ITimeNetworkComponentDataItem, ILayeredNetworkComponentDataItem.
Canonical dimension ordering: time is dimension 0, the entity (node or edge) dimension is dimension 1, the layer dimension is dimension 2 of shape(); a Component dimension follows when networkDataType() is not Scalar.
HydroCouple::Temporal::ITimeModelComponent
ITimeModelComponent is an IModelComponent that advances through time during simulation and provides access to the current simulation time.
Specializes IModelComponent.
| Property | Range | Meaning |
|---|---|---|
currentDateTime | IDateTime | Gets the current date and time of the model simulation. |
nextDateTimeJulianDay | xsd:double | The time (Julian day) the next update() will advance currentDateTime() to. |
simulationPeriod | ITimeSpan | simulationPeriod of the model. |
HydroCouple::SpatioTemporal::ITimeNetworkComponentDataItem
ITimeNetworkComponentDataItem is a network component data item whose values also vary in time.
Specializes ITimeSeriesComponentDataItem, INetworkComponentDataItem.
Canonical dimension ordering: time is dimension 0, the entity dimension selected by location() is dimension 1 of shape(); a Component dimension follows when networkDataType() is not Scalar.
HydroCouple::SpatioTemporal::ITimeRegularGrid2DComponentDataItem
ITimeRegularGrid2DComponentDataItem is a 2D regular grid component data item whose values also vary in time.
Specializes ITimeSeriesComponentDataItem, IRegularGrid2DComponentDataItem.
Canonical dimension ordering: time is dimension 0, y-cell is dimension 1, x-cell is dimension 2 of shape(); the optional cell edge and cell vertex dimensions follow.
HydroCouple::SpatioTemporal::ITimeRegularGrid3DComponentDataItem
ITimeRegularGrid3DComponentDataItem is a 3D regular grid component data item whose values also vary in time.
Specializes ITimeSeriesComponentDataItem, IRegularGrid3DComponentDataItem.
Canonical dimension ordering: time is dimension 0, z-cell is dimension 1, y-cell is dimension 2, x-cell is dimension 3 of shape(); the optional cell face and cell vertex dimensions follow.
HydroCouple::Temporal::ITimeSeriesComponentDataItem
ITimeSeriesComponentDataItem is an IComponentItem with a temporal attribute.
Specializes IComponentDataItem.
Canonical dimension ordering: the time dimension is dimension 0 of shape() and reports IDimension::DimensionRole::Time; any additional dimensions follow.
| Property | Range | Meaning |
|---|---|---|
intervalLength | xsd:double | Length of the averaging or accumulation interval (days). |
timeCount | xsd:long | Gets the number of times. |
timeDimension | IDimension | Gets the IDimension of the times. |
timeExtrapolation | TimeExtrapolation | What this item does — or, for an input, accepts — outside its held range. |
timeInterpolation | TimeInterpolation | What this item does — or, for an input, accepts — between held instants. |
timeKind | TimeKind | What each value's time coordinate refers to. |
timeSpan | ITimeSpan | Gets the ITimeSpan associated with this data item. |
times | xsd:double | Bulk access to all time coordinates as Julian day values. |
HydroCouple::SpatioTemporal::ITimeSeriesPolyhedralSurfaceComponentDataItem
ITimeSeriesPolyhedralSurfaceComponentDataItem is a polyhedral surface component data item whose values also vary in time.
Specializes ITimeSeriesComponentDataItem, IPolyhedralSurfaceComponentDataItem.
Canonical dimension ordering: time is dimension 0, the entity dimension selected by location() is dimension 1 of shape(); a Component dimension follows when meshDataType() is not Scalar.
HydroCouple::SpatioTemporal::ITimeSeriesRasterComponentDataItem
ITimeSeriesRasterComponentDataItem is a raster component data item whose values also vary in time.
Specializes ITimeSeriesComponentDataItem, IRasterComponentDataItem.
Canonical dimension ordering: time is dimension 0, band is dimension 1, y (row) is dimension 2, and x (column) is dimension 3 of shape().
HydroCouple::SpatioTemporal::ITimeSeriesTINComponentDataItem
ITimeSeriesTINComponentDataItem is an ITimeSeriesPolyhedralSurfaceComponentDataItem whose surface is an ITIN.
Specializes ITimeSeriesPolyhedralSurfaceComponentDataItem.
| Property | Range | Meaning |
|---|---|---|
TIN | ITIN | The ITIN this data item is associated with. |
HydroCouple::Temporal::ITimeSpan
ITimeSpan specifies an interval of time.
Specializes IDateTime.
| Property | Range | Meaning |
|---|---|---|
duration | xsd:double | Duration of the timespan in days; non-negative. |
endJulianDay | xsd:double | End of the interval as a Julian day: julianDay() + duration(). |
HydroCouple::Distributed::ITransport
ITransport is a transport-neutral, tagged message channel between processes.
Specializes IIdentity.
| Property | Range | Meaning |
|---|---|---|
localEndpoint | Endpoint | The endpoint of the calling process on this transport. |
participantCount | xsd:int | The number of participants reachable through this transport. |
HydroCouple::Spatial::ITriangle
An ITriangle is a IPolygon with 3 distinct, non-collinear vertices and no interior boundary.
Specializes IPolygon.
| Property | Range | Meaning |
|---|---|---|
vertex1 | IVertex | The first vertex of this ITriangle. |
vertex2 | IVertex | The second vertex of this ITriangle. |
vertex3 | IVertex | The third vertex of this ITriangle. |
HydroCouple::IUIProvider
IUIProvider is an optional side interface for entities that can present a graphical editor and/or viewer.
| Property | Range | Meaning |
|---|---|---|
hasEditor | xsd:boolean | hasEditor indicates whether this entity has a UI editor. |
hasViewer | xsd:boolean | hasViewer indicates whether this entity has a UI viewer. |
HydroCouple::IUnit
IUnit interface, describing the physical unit of a IQuantity.
Specializes IDescription.
| Property | Range | Meaning |
|---|---|---|
conversionFactorToSI | xsd:double | Conversion factor to SI ('A' in: SI-value = A * quant-value + B) |
dimensions | IUnitDimensions | Fundamental dimensions of the unit. |
offsetToSI | xsd:double | OffSet to SI ('B' in: SI-value = A * quant-value + B). |
symbol | xsd:string | The unit as a UDUNITS-2 string, e.g. "m3 s-1" or "ft3/s". |
ucumCode | xsd:string | The unit as a case-sensitive UCUM code, e.g. "m3/s" or "[ft_i]3/s". |
HydroCouple::IUnitDimensions
Defines the order of dimension in each FundamentalDimension for a unit.
Specializes IDescription.
HydroCouple::IValueDefinition
IValueDefinition describes the type and properties of values held by an IComponentDataItem.
Specializes IDescription.
| Property | Range | Meaning |
|---|---|---|
conceptURI | xsd:string | An absolute URI naming the quantity in a published vocabulary. |
defaultValue | xsd:double | Gets the default value for this value definition. |
missingValue | xsd:double | The value representing that data is missing. |
standardName | xsd:string | The CF standard name of the quantity these values measure. |
valueKind | ValueKind | How values of this definition behave under regridding and aggregation. |
HydroCouple::Spatial::IVertex
The IVertex class is an IPoint of a topologically aware IGeometry
Specializes IPoint.
| Property | Range | Meaning |
|---|---|---|
edge | IEdge | An arbitrary outgoing IEdge from this vertex. |
HydroCouple::Spatial::IVerticalCoordinate
Where the layers of a layered or volumetric data item actually are.
| Property | Range | Meaning |
|---|---|---|
columnCount | xsd:long | Number of columns (plan entities) this coordinate describes. |
geometryEpoch | xsd:unsignedLong | Counter incremented every time the elevations change. |
interfaceElevations | xsd:double | All interface elevations of all columns, row-major [column][interface], top interface first within a column. |
isTimeVarying | xsd:boolean | Whether interface elevations change from step to step. |
kind | VerticalCoordinateKind | The coordinate family. |
layerCount | xsd:long | Number of layers in a column. |
HydroCouple::IWorkflowComponent
IWorkflowComponent manages the execution workflow for a set of coupled IModelComponent instances.
Specializes IIdentity.
| Property | Range | Meaning |
|---|---|---|
componentInfo | IWorkflowComponentInfo | Gets the metadata information about this workflow component. |
modelComponentLabels | IIdentity | requiredModelComponentIdentifiers returns the vector of IModelComponent identifiers that are required by this component. |
modelComponents | IModelComponent | Gets the model components managed by this workflow. |
status | WorkflowStatus | Gets the current status of the workflow component. |
HydroCouple::IWorkflowComponentInfo
IWorkflowComponentInfo provides metadata about an IWorkflowComponent and creates new instances of it.
Specializes IComponentInfo.
HydroCouple::IWorkflowComponentStatusChangeEventArgs
The IWorkflowComponentStatusChangeEventArgs contains the information that will be passed when the IWorkflowComponent fires a signal.
| Property | Range | Meaning |
|---|---|---|
hasProgressMonitor | xsd:boolean | Indicates whether this event has a progress monitor. |
message | xsd:string | Gets additional information about the status change. |
percentProgress | xsd:float | Number between 0 and 100 indicating the progress made by the workflow component. |
previousStatus | WorkflowStatus | Gets the IWorkflowComponent's status before the status change. |
status | WorkflowStatus | Gets the IWorkflowComponent's status after the status change. |
workflowComponent | IWorkflowComponent | Gets the IWorkflowComponent that fired the event. |
HydroCouple::IArgument::ArgumentInputType
Enumeration indicating the type of input for the argument.
| Value | Concept | Meaning |
|---|---|---|
| 0 | String | Enumeration indicating that the argument was read from string. |
| 1 | File | Enumeration indicating that the argument was read from a file. |
| 2 | JSON | Enumeration indicating that the argument input is in JSON format. |
| 3 | YAML | Enumeration indicating that the argument input is in YAML format. |
| 4 | XML | Enumeration indicating that the argument input is in XML format. |
| 5 | URL | Enumeration indicating that the argument was read from a URL. |
| 6 | MEMORY_OBJECT | Enumeration indicating that the argument was read from a memory object. |
HydroCouple::IArgument::ArgumentRole
What kind of thing an argument is to the model that owns it.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Configuration | How the model runs: paths, options, solver settings, output selection. |
| 1 | Parameter | A coefficient of the process equations (roughness, conductivity, rate constants). |
| 2 | InitialCondition | The state at the start of the simulation. |
| 3 | Forcing | A prescribed time-varying input that is not supplied through an IInput (a boundary time series read from file). |
| 4 | Geometry | The spatial discretization itself (a mesh, a network, a raster grid). |
HydroCouple::ByteOrder
The ByteOrder enum class indicates the byte order of serialized data.
| Value | Concept | Meaning |
|---|---|---|
| 0 | BigEndian | BigEndian serialized data byte order (most significant byte first). |
| 1 | LittleEndian | LittleEndian serialized data byte order (least significant byte first). |
HydroCouple::Capability
Capability identifies an optional behavior a component may support.
| Value | Concept | Meaning |
|---|---|---|
| 0 | DeviceBuffers | Data items can produce/accept Device/Unified BufferDescriptors. |
| 1 | PartitionedData | Component exposes IPartitionedComponentDataItem items (see hydrocoupledistributed.h). |
| 2 | DistributedExecution | Component implements IDistributedModelComponent. |
| 3 | Checkpointing | Component implements ICheckpointableModelComponent. |
| 4 | Cloneable | Component implements ICloneableModelComponent. |
| 5 | UserInterface | Component implements IUIProvider. |
| 6 | Licensing | Component implements ILicensedComponent. |
| 7 | Differentiable | Component implements IDifferentiableModelComponent. |
| 8 | LayeredData | Component exposes data items implementing Spatial::ILayering. |
| 2147483648 | VendorBase | First value of the vendor-reserved range (0x80000000). |
HydroCouple::IModelComponent::ComponentStatus
HydroCouple::ComponentStatus is an enumerator that describes the status of a component over the course of its lifetime.
| Value | Concept | Meaning | May become |
|---|---|---|---|
| 0 | Created | The IModelComponent instance has just been created. This status must and will be followed by HydroCouple::Initializing. | Initializing, Failed |
| 1 | Initializing | The IModelComponent is initializing itself. This status will end in a status change to HydroCouple::Initialized or HydroCouple::Failed. | Initialized, Failed |
| 2 | Initialized | The IModelComponent has successfully initialized itself by calling IModelComponent::initialize(). The connections between its inputs/outputs and those of other components can be established. | Initializing, Validating, Finishing, Failed |
| 3 | Validating | After links between an IModelComponent's inputs/outputs and those of other components have been established, the IModelComponent is HydroCouple::Validating whether its required input will be available when it updates itself, and whether indeed it will be able to provide the required output during this update. This Validating status will when the IModelComponent::status() changes to HydroCouple::Valid or HydroCouple::Invalid. | Valid, Invalid, Failed |
| 4 | Valid | The IModelComponent is in a HydroCouple::Valid state. When updating itself its required input will be available, and it will be able to provide the required output. | Validating, Preparing, Finishing, Failed |
| 5 | WaitingForData | The IModelComponent wants to update itself, but is not yet able to perform the actual computation, because it is still waiting for input data from other components. | Updating, Failed |
| 6 | Invalid | The IModelComponent is in an HydroCouple::Invalid state. When updating itself not all required input will be available, and/or it will not be able to provide the required output. After the user has modified the connections between the IModelComponent's inputs/outputs and those of other components, the HydroCouple::Validating state can be entered again | Validating, Finishing, Failed |
| 7 | Preparing | The IModelComponent is preparing itself for the first update() and the first IComponentDataItem::getValuesInto() call. This HydroCouple::Preparing state will end in a status change to HydroCouple::Updated or HydroCouple::Failed. | Updated, Failed |
| 8 | Updating | The IModelComponent is updating itself. It has received all required input data from other components, and is now performing the actual computation. This HydroCouple::Updating state will end in a status change to HydroCouple::Updated, HydroCouple::Done or HydroCouple::Failed. | WaitingForData, Updated, Done, Failed |
| 9 | Updated | The IModelComponent has successfully updated itself. | Updating, Checkpointing, Finishing, Failed |
| 10 | Checkpointing | The IModelComponent is saving or restoring a checkpoint of its state (see ICheckpointableModelComponent). A save returns to the status it was entered from (HydroCouple::Updated or HydroCouple::Done); a successful restore always lands in HydroCouple::Updated; a failure lands in HydroCouple::Failed. | Updated, Done, Failed |
| 11 | Done | The last update process that the IModelComponent performed was the final one. A next call to the IModelComponent::update() method will leave the IModelComponent's internal state unchanged. | Checkpointing, Finishing, Failed |
| 12 | Finishing | The IModelComponent was requested to perform the actions to be performed before it will either be disposed or re-initialized again.Typical actions would be writing the final result files, close all open files, free memory, etc. When all required actions have been performed, the status switches to HydroCouple::Created when re-initialization is possible. The status switches to HydroCouple::Finished when the IModelComponent is to be disposed | Created, Finished, Failed |
| 13 | Finished | The IModelComponent has successfully performed its finalization actions. Re-initialization of the IModelComponent instance is not possible and should not be attempted. Instead the instance should be destroyed by its owner, after its connections are dismantled (see the lifetime convention). | |
| 14 | Failed | The IModelComponent has encountered an unrecoverable error. Reachable from every status except Finished: a failure can be detected while the component rests (a proxy whose peer dies while it is Updated). Diagnostics describing the failure must be available from IModelComponent::errors(). From this state the component may be re-initialized by calling initialize() if it supports re-initialization, or finished and disposed via finish(). | Initializing, Finishing |
HydroCouple::Spatial::CrossSectionKind
How a cross-section's shape is held by whoever produced it.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Unknown | Not declared. Consumers must not assume. |
| 1 | StationElevation | Surveyed points across the section (HEC-RAS, SWMM). |
| 2 | WidthElevation | Width as a function of elevation (CE-QUAL-W2). |
| 3 | Analytic | A closed form: circular, trapezoidal, and the rest. |
HydroCouple::DataKind
DataKind identifies the element type of a typed data buffer.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Unknown | No/unknown element type. |
| 1 | Int8 | int8_t |
| 2 | UInt8 | uint8_t |
| 3 | Int16 | int16_t |
| 4 | UInt16 | uint16_t |
| 5 | Int32 | int32_t |
| 6 | UInt32 | uint32_t |
| 7 | Int64 | int64_t |
| 8 | UInt64 | uint64_t |
| 9 | Float32 | float |
| 10 | Float64 | double |
| 11 | Boolean | bool (stored one element per byte) |
| 12 | String | std::string (host memory only) |
| 13 | Opaque | Implementation-defined bytes; meaning agreed out of band, size in BufferDescriptor::itemSizeBytes. |
HydroCouple::DeviceBackend
DeviceBackend identifies the runtime that owns a device-resident buffer.
| Value | Concept | Meaning |
|---|---|---|
| 0 | None | Host memory; no device runtime involved. |
| 1 | CUDA | NVIDIA CUDA runtime. |
| 2 | HIP | AMD HIP/ROCm runtime. |
| 3 | SYCL | SYCL (any implementation). |
| 4 | LevelZero | Intel oneAPI Level Zero. |
| 5 | OpenCL | OpenCL. |
| 6 | Other | An implementation-defined runtime both endpoints agree on. |
HydroCouple::DifferentialRole
DifferentialRole says which side of a component's step a derivative buffer belongs to.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Input | An IInput of the component, as consumed by the step. |
| 1 | Argument | An IArgument of the component (a parameter of the step). |
| 2 | Output | An IOutput of the component, as produced by the step. |
| 3 | StateBefore | A state item's value at the start of the step. |
| 4 | StateAfter | The same state item's value at the end of the step. |
HydroCouple::IDimension::DimensionRole
What an axis of the index space means.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Unknown | Not declared. |
| 1 | Time | Time steps (Temporal::ITimeSeriesComponentDataItem::times()). |
| 2 | Entity | Spatial entities: geometries, mesh nodes/edges/faces, network nodes/edges, or the identifiers of an id-based item. |
| 3 | Layer | Vertical layers (Spatial::ILayering), top first. |
| 4 | Band | Raster bands. |
| 5 | Row | Raster rows / structured-grid y index. |
| 6 | Column | Raster columns / structured-grid x index. |
| 7 | Depth | Structured-grid z index (IRegularGrid3D). |
| 8 | Component | Vector or tensor components (Spatial::SpatialDataType). |
| 9 | Realization | Ensemble members. |
| 10 | Other | Declared but none of the above. |
HydroCouple::IUnit::DistanceUnits
HydroCouple::DistanceUnits are the types of units that can be used to measure distance.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Meters | Meters |
| 1 | Kilometers | Kilometers |
| 2 | Feet | Feet |
| 3 | NauticalMiles | NauticalMiles |
| 4 | Yards | Yards |
| 5 | Miles | Miles |
| 6 | Degrees | Degrees (angular; only meaningful for geographic reference systems). |
| 7 | Centimeters | Centimeters |
| 8 | Millimeters | Millimeters |
| 9 | Inches | Inches |
| 10 | Unknown | Unknown |
HydroCouple::IUnitDimensions::FundamentalUnitDimension
HydroCouple::FundamentalUnitDimension are the fundamental units that can be combined to form all types of units.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Length | Fundamental dimension for length. |
| 1 | Mass | Fundamental dimension for mass. |
| 2 | Time | Fundamental dimension for time. |
| 3 | ElectricCurrent | Fundamental dimension for electric current. |
| 4 | Temperature | Fundamental dimension for temperature. |
| 5 | AmountOfSubstance | Fundamental dimension for amount of substance. |
| 6 | LuminousIntensity | Fundamental dimension for luminous intensity. |
| 7 | Currency | Fundamental dimension for currency. |
| 8 | Unitless | Fundamental dimension for unitless quantities (all powers zero). |
| 9 | PlaneAngle | Fundamental dimension for plane angle (radian). |
HydroCouple::Spatial::IGeometry::GeometryType
The type of IGeometry.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Geometry | |
| 1 | Point | |
| 2 | LineString | |
| 3 | Polygon | |
| 17 | Triangle | |
| 4 | MultiPoint | |
| 5 | MultiLineString | |
| 6 | MultiPolygon | |
| 7 | GeometryCollection | |
| 8 | CircularString | |
| 9 | CompoundCurve | |
| 10 | CurvePolygon | |
| 11 | MultiCurve | |
| 12 | MultiSurface | |
| 13 | Curve | |
| 14 | Surface | |
| 15 | PolyhedralSurface | |
| 16 | TIN | |
| 1000 | GeometryZ | |
| 1001 | PointZ | |
| 1002 | LineStringZ | |
| 1003 | PolygonZ | |
| 1017 | TriangleZ | |
| 1004 | MultiPointZ | |
| 1005 | MultiLineStringZ | |
| 1006 | MultiPolygonZ | |
| 1007 | GeometryCollectionZ | |
| 1008 | CircularStringZ | |
| 1009 | CompoundCurveZ | |
| 1010 | CurvePolygonZ | |
| 1011 | MultiCurveZ | |
| 1012 | MultiSurfaceZ | |
| 1013 | CurveZ | |
| 1014 | SurfaceZ | |
| 1015 | PolyhedralSurfaceZ | |
| 1016 | TINZ | |
| 2000 | GeometryM | |
| 2001 | PointM | |
| 2002 | LineStringM | |
| 2003 | PolygonM | |
| 2017 | TriangleM | |
| 2004 | MultiPointM | |
| 2005 | MultiLineStringM | |
| 2006 | MultiPolygonM | |
| 2007 | GeometryCollectionM | |
| 2008 | CircularStringM | |
| 2009 | CompoundCurveM | |
| 2010 | CurvePolygonM | |
| 2011 | MultiCurveM | |
| 2012 | MultiSurfaceM | |
| 2013 | CurveM | |
| 2014 | SurfaceM | |
| 2015 | PolyhedralSurfaceM | |
| 2016 | TINM | |
| 3000 | GeometryZM | |
| 3001 | PointZM | |
| 3002 | LineStringZM | |
| 3003 | PolygonZM | |
| 3017 | TriangleZM | |
| 3004 | MultiPointZM | |
| 3005 | MultiLineStringZM | |
| 3006 | MultiPolygonZM | |
| 3007 | GeometryCollectionZM | |
| 3008 | CircularStringZM | |
| 3009 | CompoundCurveZM | |
| 3010 | CurvePolygonZM | |
| 3011 | MultiCurveZM | |
| 3012 | MultiSurfaceZM | |
| 3013 | CurveZM | |
| 3014 | SurfaceZM | |
| 3015 | PolyhedralSurfaceZM | |
| 3016 | TINZM |
HydroCouple::IDimension::LengthType
IDimension::LengthType dimension length type
| Value | Concept | Meaning |
|---|---|---|
| 0 | Static | Static length type |
| 1 | Dynamic | Dynamic length type |
HydroCouple::MemorySpace
MemorySpace identifies where a buffer's bytes physically live.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Host | Ordinary pageable host memory. |
| 1 | HostPinned | Page-locked host memory (fast staging to/from devices). |
| 2 | Device | Accelerator-resident memory addressed by (backend, deviceId). |
| 3 | Unified | Unified/managed memory accessible from host and device. |
HydroCouple::Spatial::MeshLocation
Which mesh or network entity a data item's values are attached to.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Node | Mesh nodes / network nodes (vertices). |
| 1 | Edge | Mesh edges / network edges (links, conduits, reaches). |
| 2 | Face | Mesh faces: the patches of a polyhedral surface, the triangles of a TIN. |
| 3 | Volume | Extruded cells of a layered mesh (Spatial::ILayering). |
HydroCouple::Spatial::IRaster::RasterDataType
The data type associated with a raster band.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Unknown | Unknown or unspecified type |
| 1 | Byte | Eight bit unsigned integer |
| 2 | UInt16 | Sixteen bit unsigned integer |
| 3 | Int16 | Sixteen bit signed integer |
| 4 | UInt32 | Thirty two bit unsigned integer |
| 5 | Int32 | Thirty two bit signed integer |
| 6 | Float32 | Thirty two bit floating point |
| 7 | Float64 | Sixty four bit floating point |
| 8 | CInt16 | Complex Int16 |
| 9 | CInt32 | Complex Int32 |
| 10 | CFloat32 | Complex Float32 |
| 11 | CFloat64 | Complex Float64 |
| 12 | ARGB32 | Colour: alpha, red, green, blue, one byte each, most significant byte first. |
| 13 | ARGB32_Premultiplied | Colour as ARGB32 with red, green and blue premultiplied by alpha. |
HydroCouple::Spatial::RegularGridType
The types of regular grids.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Cartesian | Cartesian grid. |
| 1 | Rectilinear | Rectilinear grid. |
| 2 | Curvilinear | Curvilinear grid. |
HydroCouple::ErrorEntry::Severity
Severity of an ErrorEntry.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Information | Informational message. |
| 1 | Warning | Recoverable anomaly. |
| 2 | Error | Operation failed; component may continue. |
| 3 | Fatal | Component is in the Failed state. |
HydroCouple::Spatial::SpatialDataType
The algebraic structure of the value at each entity: a scalar, a set of independent scalars, a vector or a tensor.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Scalar | One value per entity; no component dimension. |
| 1 | MultiScalar | Several independent scalars per entity (e.g. constituents); component dimension of that count, basis irrelevant. |
| 2 | Vector | A vector per entity; component dimension of length 2 or 3 in the order vectorBasis() defines. |
| 3 | Tensor | A rank-2 tensor per entity; component dimension holding the row-major flattening (4 or 9 entries) in the basis vectorBasis() defines. |
HydroCouple::Temporal::TimeExtrapolation
How a provider produces a value at an instant beyond the last (or before the first) it holds.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Unknown | Not declared. validate() must treat a connection whose two ends both say Unknown as an error. |
| 1 | Refuse | A query outside the held range is refused; the provider must be advanced first. |
| 2 | HoldLast | Repeat the boundary value. |
| 3 | Linear | Extend the last two values linearly. |
HydroCouple::Temporal::TimeInterpolation
How a provider produces a value at an instant that is between two it holds.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Unknown | Not declared. validate() must treat a connection whose two ends both say Unknown as an error. |
| 1 | None | Exact match required (within TIME_EQUALITY_TOLERANCE_DAYS); a query at an instant not held is refused. |
| 2 | Previous | Hold the most recent earlier value (step function). |
| 3 | Nearest | The nearer of the two neighbours. |
| 4 | Linear | Linear in time between neighbours. |
HydroCouple::Temporal::TimeKind
What a value's time coordinate refers to.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Unknown | Not declared. Consumers must not assume Instantaneous. |
| 1 | Instantaneous | A reading at the time coordinate. |
| 2 | IntervalMean | Mean over the interval ending at the time coordinate. |
| 3 | IntervalMinimum | Minimum over that interval. |
| 4 | IntervalMaximum | Maximum over that interval. |
| 5 | Accumulated | Total accumulated over that interval. |
HydroCouple::ValueKind
How a value behaves when it is regridded or aggregated.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Unknown | Not declared. Adapters must not guess; they should refuse or ask. |
| 1 | Intensive | Independent of extent — temperature, concentration, elevation. Averages. |
| 2 | Extensive | Proportional to extent — mass, volume, heat content. Sums. |
| 3 | Flux | Per unit area and time. Integrates over the area it crosses. |
| 4 | Density | Per unit volume. Integrates over the volume it fills. |
HydroCouple::Spatial::VectorBasis
The frame a vector or tensor value is expressed in.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Unknown | Not declared. Consumers must not assume. |
| 1 | Cartesian | Components along the reference system's x, y (and z) axes, in that order. |
| 2 | EastNorthUp | Components along local east, north (and up) for geographic reference systems. |
| 3 | NormalTangential | For edge/face data: component 0 normal to the entity (positive from left face to right face as IMeshView::edgeFaces() orders them), component 1 tangential, component 2 (if any) vertical. |
| 4 | AlongEntity | For network edges: one component along the edge from its first node to its second. |
HydroCouple::Spatial::VerticalCoordinateKind
The family a vertical coordinate belongs to.
| Value | Concept | Meaning |
|---|---|---|
| 0 | Unknown | Not declared. Consumers must not assume. |
| 1 | Sigma | Terrain-following; layers stretch with the free surface. |
| 2 | ZLevel | Fixed elevations; the top layer thins as the surface falls. |
| 3 | ZStar | Fixed levels rescaled by total depth. |
| 4 | Hybrid | Sigma near the surface, z below a transition depth. |
| 5 | Isopycnal | Layers of constant density. |
| 6 | DepthBelowSurface | Fixed depths measured down from the moving surface. |
HydroCouple::IWorkflowComponent::WorkflowStatus
The WorkflowStatus enum describes the status of a workflow component over the course of its lifetime.
| Value | Concept | Meaning | May become |
|---|---|---|---|
| 0 | Created | The workflow component has just been created. | Initializing, Failed |
| 1 | Initializing | The workflow component is initializing itself. | Initialized, Failed |
| 2 | Initialized | The workflow component has successfully initialized. | Initializing, Validating, Finishing, Failed |
| 3 | Validating | The workflow component is validating the composition (cross-component links, required roles). | Validated, Failed, Invalid |
| 4 | Validated | The workflow component found the composition valid and ready to prepare. | Validating, Preparing, Finishing, Failed |
| 5 | Preparing | The workflow component is preparing the composition for computation (e.g., driving IModelComponent::prepare(), building execution schedules, negotiating exchange patterns). | Prepared, Failed |
| 6 | Prepared | The workflow component has prepared the composition and can begin updating. | Updating, Finishing, Failed |
| 7 | Updating | The workflow component is performing an update step. | Updated, Paused, Done, Failed |
| 8 | Updated | The workflow component has successfully updated. | Updating, Finishing, Failed |
| 9 | Paused | The workflow component is paused at a synchronization point (see requestPause()) and can be resumed. | Updated, Finishing, Failed |
| 10 | Done | The workflow component has completed all update steps. | Finishing, Failed |
| 11 | Finishing | The workflow component is finalizing and releasing resources. | Finished, Failed |
| 12 | Finished | The workflow component has finished and cannot be restarted. | |
| 13 | Failed | The workflow component encountered an unrecoverable error. | Initializing, Finishing |
| 14 | Invalid | The workflow component found problems in the composition; fix the composition and validate() again. | Validating, Finishing, Failed |
| Property | Meaning |
|---|---|
mayTransitionTo | A legal lifecycle transition (normative: Helpers::isValidComponentStatusTransition() and isValidWorkflowStatusTransition()). |
canonicalDimensionOrdering | The order of a data item's axes, as its C++ documentation states it. |
cppName | The fully qualified C++ name the term is generated from. |