Shared basics

Package: InfrastructureCoreOpenAPIModels · Depends on: None

Domain-neutral shared types: the unit convention, the function-data family, and the value shapes and supplemental attributes that carry no power semantics. Consumed by the data layer and the time series store, neither of which should inherit power-specific definitions.

Types

Type Description
ComplexNumber A complex number, given as its real and imag parts.
DataSource Records data provenance for a component’s field values: which organization or dataset the data came from, the URL it was retrieved from, and when it was retrieved.
FromTo A pair of values, one at the from end and one at the to end of a directed edge.
FromTo_ToFrom A pair of values for a directed edge, one for each orientation: from_to and to_from.
FunctionData Raw mathematical data defining a function f(x) — coefficients or point tables with no units or interpretation attached.
GeographicInfo Supplemental attribute carrying geographic information about a component as a GeoJSON object.
InOut A pair of values, one for the inbound (in) and one for the outbound (out) direction of a quantity.
LinearFunctionData Data for a linear function f(x) = proportional_term * x + constant_term.
MinMax A pair of values bounding a quantity from below (min) and from above (max).
PiecewiseLinearData Data for a piecewise linear function defined by (x, y) points and interpolated linearly between consecutive ones.
PiecewiseStepData Data for a step function, constant on each segment, defined by the x coordinates of the segment endpoints and one y value per segment.
QuadraticFunctionData Data for a quadratic function f(x) = quadratic_term * x^2 + proportional_term * x + constant_term.
SupplementalAttributeAssociation Links a supplemental attribute to the component it describes — the JSON form of a row in the store’s supplemental_attribute_associations catalog table, field-for-field.
TimeSeriesLinearFunctionData Time-series-backed variant of LinearFunctionData.
TimeSeriesPiecewiseLinearData Time-series-backed variant of PiecewiseLinearData.
TimeSeriesPiecewiseStepData Time-series-backed variant of PiecewiseStepData.
TimeSeriesQuadraticFunctionData Time-series-backed variant of QuadraticFunctionData.
UnitSystem Unit basis a stored value is expressed in.
UpDown A pair of values, one for the upward (up) and one for the downward (down) direction of a quantity.
XY_Coords A single point, given as its x and y coordinates.

Table of contents

This site uses Just the Docs, a documentation theme for Jekyll.