tables
DaveML table primitives for ANSI/AIAA-S-119-2011.
Extracted from the DAVE-ML specification for simulation model exchange. Covers variable definitions, breakpoint sets, gridded and ungridded tables, function definitions, and verification check data.
Classes:
-
Bounds–Statistical limits of a parameter.
-
BpRef–Reference to a breakpoint set.
-
BreakpointDef–Definition of a breakpoint set.
-
Calculation–Calculation using MathML content markup.
-
CheckData–Check data for model verification.
-
CheckInputs–Input values for a check case.
-
CheckOutputs–Expected output values for a check case.
-
ConfidenceBound–Confidence bound for table data.
-
CorrelatesWith–Indicates correlation with another variable.
-
Correlation–Correlation between variables.
-
DataPoint–Data point in an ungridded table.
-
DataTable–Data of a gridded table as whitespace- or comma-separated values.
-
DependentVarPts–Dependent variable points for a simple function.
-
DependentVarRef–Reference to a dependent variable for a complex function.
-
Description–Textual description of an entity.
-
ExtrapolateEnum–Extrapolation method for table lookups.
-
Function–A DAVE-ML function relating independent variables to a dependent variable.
-
FunctionDefn–Definition of a complex function (table-based lookup).
-
GriddedTable–Inline gridded table.
-
GriddedTableDef–Definition of a gridded table.
-
GriddedTableRef–Reference to a gridded table.
-
IndependentVarPts–Independent variable points for a simple function.
-
IndependentVarRef–Reference to an independent variable for a complex function.
-
InternalValues–Internal variable values for a check case.
-
InterpolateEnum–Interpolation method for table lookups (ANSI/AIAA-S-119-2011).
-
NormalPDF–Normal probability distribution function.
-
Signal–Signal (input, internal, or output) in a check case.
-
StaticShot–Static check case for model verification.
-
TablesMixin–Mixin that adds optional DaveML table fields for composing into Behavior/Discipline.
-
Uncertainty–Uncertainty of a function or parameter value.
-
UncertaintyEffect–Effect type for uncertainty specification.
-
UngriddedTable–Inline ungridded table.
-
UngriddedTableDef–Definition of an ungridded table.
-
UngriddedTableRef–Reference to an ungridded table.
-
UniformPDF–Uniform probability distribution function.
-
VariableDef–Definition of a variable.
-
VariableRef–Reference to a variable.
pydantic-model
¤
Bases: BaseModel
Statistical limits of a parameter.
Show JSON schema:
{
"$defs": {
"Bounds": {
"description": "Statistical limits of a parameter.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/DataTable"
},
{
"$ref": "#/$defs/VariableDef"
},
{
"$ref": "#/$defs/VariableRef"
},
{
"type": "null"
}
],
"default": null,
"description": "The bound value or reference",
"title": "Value"
}
},
"title": "Bounds",
"type": "object"
},
"Calculation": {
"description": "Calculation using MathML content markup.",
"properties": {
"math": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The MathML content markup describing the calculation",
"title": "Math"
}
},
"title": "Calculation",
"type": "object"
},
"CorrelatesWith": {
"description": "Indicates correlation with another variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
}
},
"title": "CorrelatesWith",
"type": "object"
},
"Correlation": {
"description": "Correlation between variables.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
},
"corr_coef": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The correlation coefficient",
"title": "Corr Coef"
}
},
"title": "Correlation",
"type": "object"
},
"DataTable": {
"description": "Data of a gridded table as whitespace- or comma-separated values.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The table data as a string of comma- or whitespace-separated values",
"title": "Value"
}
},
"title": "DataTable",
"type": "object"
},
"Description": {
"description": "Textual description of an entity.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The description text",
"title": "Value"
}
},
"title": "Description",
"type": "object"
},
"NormalPDF": {
"description": "Normal probability distribution function.",
"properties": {
"num_sigmas": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The number of standard deviations",
"title": "Num Sigmas"
},
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
},
"correlates_with": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/CorrelatesWith"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlations with other variables",
"title": "Correlates With"
},
"correlation": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Correlation"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlation coefficients",
"title": "Correlation"
}
},
"title": "NormalPDF",
"type": "object"
},
"Uncertainty": {
"description": "Uncertainty of a function or parameter value.",
"properties": {
"effect": {
"anyOf": [
{
"$ref": "#/$defs/UncertaintyEffect"
},
{
"type": "null"
}
],
"default": null,
"description": "The effect of the uncertainty"
},
"normal_pdf": {
"anyOf": [
{
"$ref": "#/$defs/NormalPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The normal probability distribution function"
},
"uniform_pdf": {
"anyOf": [
{
"$ref": "#/$defs/UniformPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The uniform probability distribution function"
}
},
"title": "Uncertainty",
"type": "object"
},
"UncertaintyEffect": {
"description": "Effect type for uncertainty specification.",
"enum": [
"additive",
"multiplicative",
"percentage",
"absolute"
],
"title": "UncertaintyEffect",
"type": "string"
},
"UniformPDF": {
"description": "Uniform probability distribution function.",
"properties": {
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
}
},
"title": "UniformPDF",
"type": "object"
},
"VariableDef": {
"description": "Definition of a variable.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the variable",
"title": "Name"
},
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this variable",
"title": "Var Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the variable",
"title": "Units"
},
"axis_system": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The axis system for the variable",
"title": "Axis System"
},
"sign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The sign convention for the variable",
"title": "Sign"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An alias for the variable",
"title": "Alias"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A symbol representing the variable",
"title": "Symbol"
},
"initial_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The initial value of the variable",
"title": "Initial Value"
},
"min_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The minimum allowed value of the variable",
"title": "Min Value"
},
"max_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The maximum allowed value of the variable",
"title": "Max Value"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the variable"
},
"calculation": {
"anyOf": [
{
"$ref": "#/$defs/Calculation"
},
{
"type": "null"
}
],
"default": null,
"description": "The calculation for deriving the variable's value"
},
"is_input": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an input",
"title": "Is Input"
},
"is_control": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a control parameter",
"title": "Is Control"
},
"is_disturbance": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a disturbance input",
"title": "Is Disturbance"
},
"is_state": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state variable",
"title": "Is State"
},
"is_state_deriv": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state derivative",
"title": "Is State Deriv"
},
"is_output": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an output",
"title": "Is Output"
},
"is_std_aiaa": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a standard AIAA variable",
"title": "Is Std Aiaa"
},
"uncertainty": {
"anyOf": [
{
"$ref": "#/$defs/Uncertainty"
},
{
"type": "null"
}
],
"default": null,
"description": "The uncertainty associated with the variable"
}
},
"title": "VariableDef",
"type": "object"
},
"VariableRef": {
"description": "Reference to a variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
}
},
"title": "VariableRef",
"type": "object"
}
},
"$ref": "#/$defs/Bounds"
}
Fields:
-
value(Optional[Union[str, DataTable, VariableDef, VariableRef]])
pydantic-field
¤
value: Optional[Union[str, DataTable, VariableDef, VariableRef]] = None
The bound value or reference
pydantic-model
¤
Bases: BaseModel
Reference to a breakpoint set.
Show JSON schema:
{
"description": "Reference to a breakpoint set.",
"properties": {
"bp_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced breakpoint set",
"title": "Bp Id"
}
},
"title": "BpRef",
"type": "object"
}
Fields:
pydantic-model
¤
Bases: BaseModel
Definition of a breakpoint set.
Show JSON schema:
{
"$defs": {
"Description": {
"description": "Textual description of an entity.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The description text",
"title": "Value"
}
},
"title": "Description",
"type": "object"
}
},
"description": "Definition of a breakpoint set.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the breakpoint set",
"title": "Name"
},
"bp_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this breakpoint set",
"title": "Bp Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the breakpoints",
"title": "Units"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the breakpoint set"
},
"bp_vals": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The breakpoint values",
"title": "Bp Vals"
}
},
"title": "BreakpointDef",
"type": "object"
}
Fields:
-
name(Optional[str]) -
bp_id(Optional[str]) -
units(Optional[str]) -
description(Optional[Description]) -
bp_vals(Optional[str])
pydantic-field
¤
description: Optional[Description] = None
A description of the breakpoint set
pydantic-model
¤
Bases: BaseModel
Calculation using MathML content markup.
Show JSON schema:
{
"description": "Calculation using MathML content markup.",
"properties": {
"math": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The MathML content markup describing the calculation",
"title": "Math"
}
},
"title": "Calculation",
"type": "object"
}
Fields:
pydantic-model
¤
Bases: BaseModel
Check data for model verification.
Show JSON schema:
{
"$defs": {
"CheckInputs": {
"description": "Input values for a check case.",
"properties": {
"signal": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Signal"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The input signals for this check case",
"title": "Signal"
}
},
"title": "CheckInputs",
"type": "object"
},
"CheckOutputs": {
"description": "Expected output values for a check case.",
"properties": {
"signal": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Signal"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The output signals for this check case",
"title": "Signal"
}
},
"title": "CheckOutputs",
"type": "object"
},
"Description": {
"description": "Textual description of an entity.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The description text",
"title": "Value"
}
},
"title": "Description",
"type": "object"
},
"InternalValues": {
"description": "Internal variable values for a check case.",
"properties": {
"signal": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Signal"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The internal signals for this check case",
"title": "Signal"
}
},
"title": "InternalValues",
"type": "object"
},
"Signal": {
"description": "Signal (input, internal, or output) in a check case.",
"properties": {
"signal_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the signal",
"title": "Signal Name"
},
"signal_units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of the signal",
"title": "Signal Units"
},
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the variable associated with this signal",
"title": "Var Id"
},
"signal_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The value of the signal",
"title": "Signal Value"
},
"tol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The tolerance for this signal's value",
"title": "Tol"
}
},
"title": "Signal",
"type": "object"
},
"StaticShot": {
"description": "Static check case for model verification.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the static shot",
"title": "Name"
},
"ref_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The reference ID for this static shot",
"title": "Ref Id"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the static shot"
},
"check_inputs": {
"anyOf": [
{
"$ref": "#/$defs/CheckInputs"
},
{
"type": "null"
}
],
"default": null,
"description": "The input values for this check case"
},
"internal_values": {
"anyOf": [
{
"$ref": "#/$defs/InternalValues"
},
{
"type": "null"
}
],
"default": null,
"description": "The internal variable values for this check case"
},
"check_outputs": {
"anyOf": [
{
"$ref": "#/$defs/CheckOutputs"
},
{
"type": "null"
}
],
"default": null,
"description": "The expected output values for this check case"
}
},
"title": "StaticShot",
"type": "object"
}
},
"description": "Check data for model verification.",
"properties": {
"static_shot": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/StaticShot"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Static check cases",
"title": "Static Shot"
}
},
"title": "CheckData",
"type": "object"
}
Fields:
pydantic-model
¤
Bases: BaseModel
Input values for a check case.
Show JSON schema:
{
"$defs": {
"Signal": {
"description": "Signal (input, internal, or output) in a check case.",
"properties": {
"signal_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the signal",
"title": "Signal Name"
},
"signal_units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of the signal",
"title": "Signal Units"
},
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the variable associated with this signal",
"title": "Var Id"
},
"signal_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The value of the signal",
"title": "Signal Value"
},
"tol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The tolerance for this signal's value",
"title": "Tol"
}
},
"title": "Signal",
"type": "object"
}
},
"description": "Input values for a check case.",
"properties": {
"signal": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Signal"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The input signals for this check case",
"title": "Signal"
}
},
"title": "CheckInputs",
"type": "object"
}
Fields:
pydantic-model
¤
Bases: BaseModel
Expected output values for a check case.
Show JSON schema:
{
"$defs": {
"Signal": {
"description": "Signal (input, internal, or output) in a check case.",
"properties": {
"signal_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the signal",
"title": "Signal Name"
},
"signal_units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of the signal",
"title": "Signal Units"
},
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the variable associated with this signal",
"title": "Var Id"
},
"signal_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The value of the signal",
"title": "Signal Value"
},
"tol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The tolerance for this signal's value",
"title": "Tol"
}
},
"title": "Signal",
"type": "object"
}
},
"description": "Expected output values for a check case.",
"properties": {
"signal": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Signal"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The output signals for this check case",
"title": "Signal"
}
},
"title": "CheckOutputs",
"type": "object"
}
Fields:
pydantic-model
¤
Bases: BaseModel
Confidence bound for table data.
Show JSON schema:
{
"description": "Confidence bound for table data.",
"properties": {
"value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The value of the confidence bound",
"title": "Value"
}
},
"title": "ConfidenceBound",
"type": "object"
}
Fields:
pydantic-model
¤
Bases: BaseModel
Indicates correlation with another variable.
Show JSON schema:
{
"description": "Indicates correlation with another variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
}
},
"title": "CorrelatesWith",
"type": "object"
}
Fields:
pydantic-model
¤
Bases: BaseModel
Correlation between variables.
Show JSON schema:
{
"description": "Correlation between variables.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
},
"corr_coef": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The correlation coefficient",
"title": "Corr Coef"
}
},
"title": "Correlation",
"type": "object"
}
Fields:
pydantic-model
¤
Bases: BaseModel
Data point in an ungridded table.
Show JSON schema:
{
"description": "Data point in an ungridded table.",
"properties": {
"mod_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the modification record for this data point",
"title": "Mod Id"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The values of the data point",
"title": "Value"
}
},
"title": "DataPoint",
"type": "object"
}
Fields:
pydantic-model
¤
Bases: BaseModel
Data of a gridded table as whitespace- or comma-separated values.
Show JSON schema:
{
"description": "Data of a gridded table as whitespace- or comma-separated values.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The table data as a string of comma- or whitespace-separated values",
"title": "Value"
}
},
"title": "DataTable",
"type": "object"
}
Fields:
pydantic-model
¤
Bases: BaseModel
Dependent variable points for a simple function.
Show JSON schema:
{
"description": "Dependent variable points for a simple function.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the dependent variable",
"title": "Name"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of the dependent variable",
"title": "Units"
},
"sign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The sign convention for the dependent variable",
"title": "Sign"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The values of the dependent variable points",
"title": "Value"
}
},
"title": "DependentVarPts",
"type": "object"
}
Fields:
-
var_id(Optional[str]) -
name(Optional[str]) -
units(Optional[str]) -
sign(Optional[str]) -
value(Optional[str])
pydantic-model
¤
Bases: BaseModel
Reference to a dependent variable for a complex function.
Show JSON schema:
{
"description": "Reference to a dependent variable for a complex function.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
}
},
"title": "DependentVarRef",
"type": "object"
}
Fields:
pydantic-model
¤
Bases: BaseModel
Textual description of an entity.
Show JSON schema:
{
"description": "Textual description of an entity.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The description text",
"title": "Value"
}
},
"title": "Description",
"type": "object"
}
Fields:
Extrapolation method for table lookups.
Returned by:
pydantic-model
¤
Bases: BaseModel
A DAVE-ML function relating independent variables to a dependent variable.
Show JSON schema:
{
"$defs": {
"Bounds": {
"description": "Statistical limits of a parameter.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/DataTable"
},
{
"$ref": "#/$defs/VariableDef"
},
{
"$ref": "#/$defs/VariableRef"
},
{
"type": "null"
}
],
"default": null,
"description": "The bound value or reference",
"title": "Value"
}
},
"title": "Bounds",
"type": "object"
},
"BpRef": {
"description": "Reference to a breakpoint set.",
"properties": {
"bp_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced breakpoint set",
"title": "Bp Id"
}
},
"title": "BpRef",
"type": "object"
},
"Calculation": {
"description": "Calculation using MathML content markup.",
"properties": {
"math": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The MathML content markup describing the calculation",
"title": "Math"
}
},
"title": "Calculation",
"type": "object"
},
"ConfidenceBound": {
"description": "Confidence bound for table data.",
"properties": {
"value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The value of the confidence bound",
"title": "Value"
}
},
"title": "ConfidenceBound",
"type": "object"
},
"CorrelatesWith": {
"description": "Indicates correlation with another variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
}
},
"title": "CorrelatesWith",
"type": "object"
},
"Correlation": {
"description": "Correlation between variables.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
},
"corr_coef": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The correlation coefficient",
"title": "Corr Coef"
}
},
"title": "Correlation",
"type": "object"
},
"DataPoint": {
"description": "Data point in an ungridded table.",
"properties": {
"mod_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the modification record for this data point",
"title": "Mod Id"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The values of the data point",
"title": "Value"
}
},
"title": "DataPoint",
"type": "object"
},
"DataTable": {
"description": "Data of a gridded table as whitespace- or comma-separated values.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The table data as a string of comma- or whitespace-separated values",
"title": "Value"
}
},
"title": "DataTable",
"type": "object"
},
"DependentVarPts": {
"description": "Dependent variable points for a simple function.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the dependent variable",
"title": "Name"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of the dependent variable",
"title": "Units"
},
"sign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The sign convention for the dependent variable",
"title": "Sign"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The values of the dependent variable points",
"title": "Value"
}
},
"title": "DependentVarPts",
"type": "object"
},
"DependentVarRef": {
"description": "Reference to a dependent variable for a complex function.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
}
},
"title": "DependentVarRef",
"type": "object"
},
"Description": {
"description": "Textual description of an entity.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The description text",
"title": "Value"
}
},
"title": "Description",
"type": "object"
},
"ExtrapolateEnum": {
"description": "Extrapolation method for table lookups.",
"enum": [
"neither",
"min",
"max",
"both"
],
"title": "ExtrapolateEnum",
"type": "string"
},
"FunctionDefn": {
"description": "Definition of a complex function (table-based lookup).",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the function definition",
"title": "Name"
},
"gridded_table_ref": {
"anyOf": [
{
"$ref": "#/$defs/GriddedTableRef"
},
{
"type": "null"
}
],
"default": null,
"description": "A reference to a gridded table"
},
"gridded_table_def": {
"anyOf": [
{
"$ref": "#/$defs/GriddedTableDef"
},
{
"type": "null"
}
],
"default": null,
"description": "A gridded table definition"
},
"gridded_table": {
"anyOf": [
{
"$ref": "#/$defs/GriddedTable"
},
{
"type": "null"
}
],
"default": null,
"description": "A gridded table"
},
"ungridded_table_ref": {
"anyOf": [
{
"$ref": "#/$defs/UngriddedTableRef"
},
{
"type": "null"
}
],
"default": null,
"description": "A reference to an ungridded table"
},
"ungridded_table_def": {
"anyOf": [
{
"$ref": "#/$defs/UngriddedTableDef"
},
{
"type": "null"
}
],
"default": null,
"description": "An ungridded table definition"
},
"ungridded_table": {
"anyOf": [
{
"$ref": "#/$defs/UngriddedTable"
},
{
"type": "null"
}
],
"default": null,
"description": "An ungridded table"
}
},
"title": "FunctionDefn",
"type": "object"
},
"GriddedTable": {
"description": "Inline gridded table.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the gridded table",
"title": "Name"
},
"breakpoint_refs": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BpRef"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "References to the breakpoint sets used in this table",
"title": "Breakpoint Refs"
},
"confidence_bound": {
"anyOf": [
{
"$ref": "#/$defs/ConfidenceBound"
},
{
"type": "null"
}
],
"default": null,
"description": "The confidence bound for the table data"
},
"data_table": {
"anyOf": [
{
"$ref": "#/$defs/DataTable"
},
{
"type": "null"
}
],
"default": null,
"description": "The actual data of the gridded table"
}
},
"title": "GriddedTable",
"type": "object"
},
"GriddedTableDef": {
"description": "Definition of a gridded table.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the gridded table",
"title": "Name"
},
"gt_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this gridded table",
"title": "Gt Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the table values",
"title": "Units"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the gridded table"
},
"breakpoint_refs": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BpRef"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "References to the breakpoint sets used in this table",
"title": "Breakpoint Refs"
},
"uncertainty": {
"anyOf": [
{
"$ref": "#/$defs/Uncertainty"
},
{
"type": "null"
}
],
"default": null,
"description": "The uncertainty associated with the table values"
},
"data_table": {
"anyOf": [
{
"$ref": "#/$defs/DataTable"
},
{
"type": "null"
}
],
"default": null,
"description": "The actual data of the gridded table"
}
},
"title": "GriddedTableDef",
"type": "object"
},
"GriddedTableRef": {
"description": "Reference to a gridded table.",
"properties": {
"gt_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced gridded table",
"title": "Gt Id"
}
},
"title": "GriddedTableRef",
"type": "object"
},
"IndependentVarPts": {
"description": "Independent variable points for a simple function.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the independent variable",
"title": "Name"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of the independent variable",
"title": "Units"
},
"sign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The sign convention for the independent variable",
"title": "Sign"
},
"extrapolate": {
"anyOf": [
{
"$ref": "#/$defs/ExtrapolateEnum"
},
{
"type": "null"
}
],
"default": null,
"description": "The extrapolation method"
},
"interpolate": {
"anyOf": [
{
"$ref": "#/$defs/InterpolateEnum"
},
{
"type": "null"
}
],
"default": null,
"description": "The interpolation method"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The values of the independent variable points",
"title": "Value"
}
},
"title": "IndependentVarPts",
"type": "object"
},
"IndependentVarRef": {
"description": "Reference to an independent variable for a complex function.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
},
"min": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The minimum value of the independent variable",
"title": "Min"
},
"max": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The maximum value of the independent variable",
"title": "Max"
},
"extrapolate": {
"anyOf": [
{
"$ref": "#/$defs/ExtrapolateEnum"
},
{
"type": "null"
}
],
"default": null,
"description": "The extrapolation method"
},
"interpolate": {
"anyOf": [
{
"$ref": "#/$defs/InterpolateEnum"
},
{
"type": "null"
}
],
"default": null,
"description": "The interpolation method"
}
},
"title": "IndependentVarRef",
"type": "object"
},
"InterpolateEnum": {
"description": "Interpolation method for table lookups (ANSI/AIAA-S-119-2011).",
"enum": [
"discrete",
"floor",
"ceiling",
"linear",
"quadraticSpline",
"cubicSpline"
],
"title": "InterpolateEnum",
"type": "string"
},
"NormalPDF": {
"description": "Normal probability distribution function.",
"properties": {
"num_sigmas": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The number of standard deviations",
"title": "Num Sigmas"
},
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
},
"correlates_with": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/CorrelatesWith"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlations with other variables",
"title": "Correlates With"
},
"correlation": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Correlation"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlation coefficients",
"title": "Correlation"
}
},
"title": "NormalPDF",
"type": "object"
},
"Uncertainty": {
"description": "Uncertainty of a function or parameter value.",
"properties": {
"effect": {
"anyOf": [
{
"$ref": "#/$defs/UncertaintyEffect"
},
{
"type": "null"
}
],
"default": null,
"description": "The effect of the uncertainty"
},
"normal_pdf": {
"anyOf": [
{
"$ref": "#/$defs/NormalPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The normal probability distribution function"
},
"uniform_pdf": {
"anyOf": [
{
"$ref": "#/$defs/UniformPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The uniform probability distribution function"
}
},
"title": "Uncertainty",
"type": "object"
},
"UncertaintyEffect": {
"description": "Effect type for uncertainty specification.",
"enum": [
"additive",
"multiplicative",
"percentage",
"absolute"
],
"title": "UncertaintyEffect",
"type": "string"
},
"UngriddedTable": {
"description": "Inline ungridded table.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the ungridded table",
"title": "Name"
},
"confidence_bound": {
"anyOf": [
{
"$ref": "#/$defs/ConfidenceBound"
},
{
"type": "null"
}
],
"default": null,
"description": "The confidence bound for the table data"
},
"data_point": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/DataPoint"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The data points of the ungridded table",
"title": "Data Point"
}
},
"title": "UngriddedTable",
"type": "object"
},
"UngriddedTableDef": {
"description": "Definition of an ungridded table.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the ungridded table",
"title": "Name"
},
"ut_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this ungridded table",
"title": "Ut Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the table values",
"title": "Units"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the ungridded table"
},
"uncertainty": {
"anyOf": [
{
"$ref": "#/$defs/Uncertainty"
},
{
"type": "null"
}
],
"default": null,
"description": "The uncertainty associated with the table values"
},
"data_point": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/DataPoint"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The data points of the ungridded table",
"title": "Data Point"
}
},
"title": "UngriddedTableDef",
"type": "object"
},
"UngriddedTableRef": {
"description": "Reference to an ungridded table.",
"properties": {
"ut_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced ungridded table",
"title": "Ut Id"
}
},
"title": "UngriddedTableRef",
"type": "object"
},
"UniformPDF": {
"description": "Uniform probability distribution function.",
"properties": {
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
}
},
"title": "UniformPDF",
"type": "object"
},
"VariableDef": {
"description": "Definition of a variable.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the variable",
"title": "Name"
},
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this variable",
"title": "Var Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the variable",
"title": "Units"
},
"axis_system": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The axis system for the variable",
"title": "Axis System"
},
"sign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The sign convention for the variable",
"title": "Sign"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An alias for the variable",
"title": "Alias"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A symbol representing the variable",
"title": "Symbol"
},
"initial_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The initial value of the variable",
"title": "Initial Value"
},
"min_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The minimum allowed value of the variable",
"title": "Min Value"
},
"max_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The maximum allowed value of the variable",
"title": "Max Value"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the variable"
},
"calculation": {
"anyOf": [
{
"$ref": "#/$defs/Calculation"
},
{
"type": "null"
}
],
"default": null,
"description": "The calculation for deriving the variable's value"
},
"is_input": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an input",
"title": "Is Input"
},
"is_control": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a control parameter",
"title": "Is Control"
},
"is_disturbance": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a disturbance input",
"title": "Is Disturbance"
},
"is_state": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state variable",
"title": "Is State"
},
"is_state_deriv": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state derivative",
"title": "Is State Deriv"
},
"is_output": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an output",
"title": "Is Output"
},
"is_std_aiaa": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a standard AIAA variable",
"title": "Is Std Aiaa"
},
"uncertainty": {
"anyOf": [
{
"$ref": "#/$defs/Uncertainty"
},
{
"type": "null"
}
],
"default": null,
"description": "The uncertainty associated with the variable"
}
},
"title": "VariableDef",
"type": "object"
},
"VariableRef": {
"description": "Reference to a variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
}
},
"title": "VariableRef",
"type": "object"
}
},
"description": "A DAVE-ML function relating independent variables to a dependent variable.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the function",
"title": "Name"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the function"
},
"independent_var_pts": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/IndependentVarPts"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The independent variable points for simple functions",
"title": "Independent Var Pts"
},
"dependent_var_pts": {
"anyOf": [
{
"$ref": "#/$defs/DependentVarPts"
},
{
"type": "null"
}
],
"default": null,
"description": "The dependent variable points for simple functions"
},
"independent_var_ref": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/IndependentVarRef"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "References to independent variables for complex functions",
"title": "Independent Var Ref"
},
"dependent_var_ref": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/DependentVarRef"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Reference to the dependent variable for complex functions",
"title": "Dependent Var Ref"
},
"function_defn": {
"anyOf": [
{
"$ref": "#/$defs/FunctionDefn"
},
{
"type": "null"
}
],
"default": null,
"description": "The function definition for complex functions"
}
},
"title": "Function",
"type": "object"
}
Fields:
-
name(Optional[str]) -
description(Optional[Description]) -
independent_var_pts(Optional[list[IndependentVarPts]]) -
dependent_var_pts(Optional[DependentVarPts]) -
independent_var_ref(Optional[list[IndependentVarRef]]) -
dependent_var_ref(Optional[list[DependentVarRef]]) -
function_defn(Optional[FunctionDefn])
Validators:
-
validate_function_type→dependent_var_pts,dependent_var_ref,function_defn
pydantic-field
¤
dependent_var_pts: Optional[DependentVarPts] = None
The dependent variable points for simple functions
pydantic-field
¤
dependent_var_ref: Optional[list[DependentVarRef]] = None
Reference to the dependent variable for complex functions
pydantic-field
¤
description: Optional[Description] = None
A description of the function
pydantic-field
¤
function_defn: Optional[FunctionDefn] = None
The function definition for complex functions
pydantic-field
¤
independent_var_pts: Optional[list[IndependentVarPts]] = None
The independent variable points for simple functions
pydantic-field
¤
independent_var_ref: Optional[list[IndependentVarRef]] = None
References to independent variables for complex functions
pydantic-model
¤
Bases: BaseModel
Definition of a complex function (table-based lookup).
Show JSON schema:
{
"$defs": {
"Bounds": {
"description": "Statistical limits of a parameter.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/DataTable"
},
{
"$ref": "#/$defs/VariableDef"
},
{
"$ref": "#/$defs/VariableRef"
},
{
"type": "null"
}
],
"default": null,
"description": "The bound value or reference",
"title": "Value"
}
},
"title": "Bounds",
"type": "object"
},
"BpRef": {
"description": "Reference to a breakpoint set.",
"properties": {
"bp_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced breakpoint set",
"title": "Bp Id"
}
},
"title": "BpRef",
"type": "object"
},
"Calculation": {
"description": "Calculation using MathML content markup.",
"properties": {
"math": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The MathML content markup describing the calculation",
"title": "Math"
}
},
"title": "Calculation",
"type": "object"
},
"ConfidenceBound": {
"description": "Confidence bound for table data.",
"properties": {
"value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The value of the confidence bound",
"title": "Value"
}
},
"title": "ConfidenceBound",
"type": "object"
},
"CorrelatesWith": {
"description": "Indicates correlation with another variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
}
},
"title": "CorrelatesWith",
"type": "object"
},
"Correlation": {
"description": "Correlation between variables.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
},
"corr_coef": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The correlation coefficient",
"title": "Corr Coef"
}
},
"title": "Correlation",
"type": "object"
},
"DataPoint": {
"description": "Data point in an ungridded table.",
"properties": {
"mod_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the modification record for this data point",
"title": "Mod Id"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The values of the data point",
"title": "Value"
}
},
"title": "DataPoint",
"type": "object"
},
"DataTable": {
"description": "Data of a gridded table as whitespace- or comma-separated values.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The table data as a string of comma- or whitespace-separated values",
"title": "Value"
}
},
"title": "DataTable",
"type": "object"
},
"Description": {
"description": "Textual description of an entity.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The description text",
"title": "Value"
}
},
"title": "Description",
"type": "object"
},
"GriddedTable": {
"description": "Inline gridded table.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the gridded table",
"title": "Name"
},
"breakpoint_refs": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BpRef"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "References to the breakpoint sets used in this table",
"title": "Breakpoint Refs"
},
"confidence_bound": {
"anyOf": [
{
"$ref": "#/$defs/ConfidenceBound"
},
{
"type": "null"
}
],
"default": null,
"description": "The confidence bound for the table data"
},
"data_table": {
"anyOf": [
{
"$ref": "#/$defs/DataTable"
},
{
"type": "null"
}
],
"default": null,
"description": "The actual data of the gridded table"
}
},
"title": "GriddedTable",
"type": "object"
},
"GriddedTableDef": {
"description": "Definition of a gridded table.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the gridded table",
"title": "Name"
},
"gt_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this gridded table",
"title": "Gt Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the table values",
"title": "Units"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the gridded table"
},
"breakpoint_refs": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BpRef"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "References to the breakpoint sets used in this table",
"title": "Breakpoint Refs"
},
"uncertainty": {
"anyOf": [
{
"$ref": "#/$defs/Uncertainty"
},
{
"type": "null"
}
],
"default": null,
"description": "The uncertainty associated with the table values"
},
"data_table": {
"anyOf": [
{
"$ref": "#/$defs/DataTable"
},
{
"type": "null"
}
],
"default": null,
"description": "The actual data of the gridded table"
}
},
"title": "GriddedTableDef",
"type": "object"
},
"GriddedTableRef": {
"description": "Reference to a gridded table.",
"properties": {
"gt_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced gridded table",
"title": "Gt Id"
}
},
"title": "GriddedTableRef",
"type": "object"
},
"NormalPDF": {
"description": "Normal probability distribution function.",
"properties": {
"num_sigmas": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The number of standard deviations",
"title": "Num Sigmas"
},
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
},
"correlates_with": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/CorrelatesWith"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlations with other variables",
"title": "Correlates With"
},
"correlation": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Correlation"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlation coefficients",
"title": "Correlation"
}
},
"title": "NormalPDF",
"type": "object"
},
"Uncertainty": {
"description": "Uncertainty of a function or parameter value.",
"properties": {
"effect": {
"anyOf": [
{
"$ref": "#/$defs/UncertaintyEffect"
},
{
"type": "null"
}
],
"default": null,
"description": "The effect of the uncertainty"
},
"normal_pdf": {
"anyOf": [
{
"$ref": "#/$defs/NormalPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The normal probability distribution function"
},
"uniform_pdf": {
"anyOf": [
{
"$ref": "#/$defs/UniformPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The uniform probability distribution function"
}
},
"title": "Uncertainty",
"type": "object"
},
"UncertaintyEffect": {
"description": "Effect type for uncertainty specification.",
"enum": [
"additive",
"multiplicative",
"percentage",
"absolute"
],
"title": "UncertaintyEffect",
"type": "string"
},
"UngriddedTable": {
"description": "Inline ungridded table.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the ungridded table",
"title": "Name"
},
"confidence_bound": {
"anyOf": [
{
"$ref": "#/$defs/ConfidenceBound"
},
{
"type": "null"
}
],
"default": null,
"description": "The confidence bound for the table data"
},
"data_point": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/DataPoint"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The data points of the ungridded table",
"title": "Data Point"
}
},
"title": "UngriddedTable",
"type": "object"
},
"UngriddedTableDef": {
"description": "Definition of an ungridded table.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the ungridded table",
"title": "Name"
},
"ut_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this ungridded table",
"title": "Ut Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the table values",
"title": "Units"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the ungridded table"
},
"uncertainty": {
"anyOf": [
{
"$ref": "#/$defs/Uncertainty"
},
{
"type": "null"
}
],
"default": null,
"description": "The uncertainty associated with the table values"
},
"data_point": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/DataPoint"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The data points of the ungridded table",
"title": "Data Point"
}
},
"title": "UngriddedTableDef",
"type": "object"
},
"UngriddedTableRef": {
"description": "Reference to an ungridded table.",
"properties": {
"ut_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced ungridded table",
"title": "Ut Id"
}
},
"title": "UngriddedTableRef",
"type": "object"
},
"UniformPDF": {
"description": "Uniform probability distribution function.",
"properties": {
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
}
},
"title": "UniformPDF",
"type": "object"
},
"VariableDef": {
"description": "Definition of a variable.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the variable",
"title": "Name"
},
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this variable",
"title": "Var Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the variable",
"title": "Units"
},
"axis_system": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The axis system for the variable",
"title": "Axis System"
},
"sign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The sign convention for the variable",
"title": "Sign"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An alias for the variable",
"title": "Alias"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A symbol representing the variable",
"title": "Symbol"
},
"initial_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The initial value of the variable",
"title": "Initial Value"
},
"min_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The minimum allowed value of the variable",
"title": "Min Value"
},
"max_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The maximum allowed value of the variable",
"title": "Max Value"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the variable"
},
"calculation": {
"anyOf": [
{
"$ref": "#/$defs/Calculation"
},
{
"type": "null"
}
],
"default": null,
"description": "The calculation for deriving the variable's value"
},
"is_input": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an input",
"title": "Is Input"
},
"is_control": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a control parameter",
"title": "Is Control"
},
"is_disturbance": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a disturbance input",
"title": "Is Disturbance"
},
"is_state": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state variable",
"title": "Is State"
},
"is_state_deriv": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state derivative",
"title": "Is State Deriv"
},
"is_output": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an output",
"title": "Is Output"
},
"is_std_aiaa": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a standard AIAA variable",
"title": "Is Std Aiaa"
},
"uncertainty": {
"anyOf": [
{
"$ref": "#/$defs/Uncertainty"
},
{
"type": "null"
}
],
"default": null,
"description": "The uncertainty associated with the variable"
}
},
"title": "VariableDef",
"type": "object"
},
"VariableRef": {
"description": "Reference to a variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
}
},
"title": "VariableRef",
"type": "object"
}
},
"description": "Definition of a complex function (table-based lookup).",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the function definition",
"title": "Name"
},
"gridded_table_ref": {
"anyOf": [
{
"$ref": "#/$defs/GriddedTableRef"
},
{
"type": "null"
}
],
"default": null,
"description": "A reference to a gridded table"
},
"gridded_table_def": {
"anyOf": [
{
"$ref": "#/$defs/GriddedTableDef"
},
{
"type": "null"
}
],
"default": null,
"description": "A gridded table definition"
},
"gridded_table": {
"anyOf": [
{
"$ref": "#/$defs/GriddedTable"
},
{
"type": "null"
}
],
"default": null,
"description": "A gridded table"
},
"ungridded_table_ref": {
"anyOf": [
{
"$ref": "#/$defs/UngriddedTableRef"
},
{
"type": "null"
}
],
"default": null,
"description": "A reference to an ungridded table"
},
"ungridded_table_def": {
"anyOf": [
{
"$ref": "#/$defs/UngriddedTableDef"
},
{
"type": "null"
}
],
"default": null,
"description": "An ungridded table definition"
},
"ungridded_table": {
"anyOf": [
{
"$ref": "#/$defs/UngriddedTable"
},
{
"type": "null"
}
],
"default": null,
"description": "An ungridded table"
}
},
"title": "FunctionDefn",
"type": "object"
}
Fields:
-
name(Optional[str]) -
gridded_table_ref(Optional[GriddedTableRef]) -
gridded_table_def(Optional[GriddedTableDef]) -
gridded_table(Optional[GriddedTable]) -
ungridded_table_ref(Optional[UngriddedTableRef]) -
ungridded_table_def(Optional[UngriddedTableDef]) -
ungridded_table(Optional[UngriddedTable])
Validators:
-
validate_table_type→gridded_table_ref,gridded_table_def,gridded_table,ungridded_table_ref,ungridded_table_def,ungridded_table
pydantic-field
¤
gridded_table_def: Optional[GriddedTableDef] = None
A gridded table definition
pydantic-field
¤
gridded_table_ref: Optional[GriddedTableRef] = None
A reference to a gridded table
pydantic-field
¤
ungridded_table: Optional[UngriddedTable] = None
An ungridded table
pydantic-field
¤
ungridded_table_def: Optional[UngriddedTableDef] = None
An ungridded table definition
pydantic-field
¤
ungridded_table_ref: Optional[UngriddedTableRef] = None
A reference to an ungridded table
pydantic-model
¤
Bases: BaseModel
Inline gridded table.
Show JSON schema:
{
"$defs": {
"BpRef": {
"description": "Reference to a breakpoint set.",
"properties": {
"bp_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced breakpoint set",
"title": "Bp Id"
}
},
"title": "BpRef",
"type": "object"
},
"ConfidenceBound": {
"description": "Confidence bound for table data.",
"properties": {
"value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The value of the confidence bound",
"title": "Value"
}
},
"title": "ConfidenceBound",
"type": "object"
},
"DataTable": {
"description": "Data of a gridded table as whitespace- or comma-separated values.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The table data as a string of comma- or whitespace-separated values",
"title": "Value"
}
},
"title": "DataTable",
"type": "object"
}
},
"description": "Inline gridded table.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the gridded table",
"title": "Name"
},
"breakpoint_refs": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BpRef"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "References to the breakpoint sets used in this table",
"title": "Breakpoint Refs"
},
"confidence_bound": {
"anyOf": [
{
"$ref": "#/$defs/ConfidenceBound"
},
{
"type": "null"
}
],
"default": null,
"description": "The confidence bound for the table data"
},
"data_table": {
"anyOf": [
{
"$ref": "#/$defs/DataTable"
},
{
"type": "null"
}
],
"default": null,
"description": "The actual data of the gridded table"
}
},
"title": "GriddedTable",
"type": "object"
}
Fields:
-
name(Optional[str]) -
breakpoint_refs(Optional[list[BpRef]]) -
confidence_bound(Optional[ConfidenceBound]) -
data_table(Optional[DataTable])
pydantic-field
¤
References to the breakpoint sets used in this table
pydantic-field
¤
confidence_bound: Optional[ConfidenceBound] = None
The confidence bound for the table data
pydantic-field
¤
The actual data of the gridded table
pydantic-model
¤
Bases: BaseModel
Definition of a gridded table.
Show JSON schema:
{
"$defs": {
"Bounds": {
"description": "Statistical limits of a parameter.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/DataTable"
},
{
"$ref": "#/$defs/VariableDef"
},
{
"$ref": "#/$defs/VariableRef"
},
{
"type": "null"
}
],
"default": null,
"description": "The bound value or reference",
"title": "Value"
}
},
"title": "Bounds",
"type": "object"
},
"BpRef": {
"description": "Reference to a breakpoint set.",
"properties": {
"bp_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced breakpoint set",
"title": "Bp Id"
}
},
"title": "BpRef",
"type": "object"
},
"Calculation": {
"description": "Calculation using MathML content markup.",
"properties": {
"math": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The MathML content markup describing the calculation",
"title": "Math"
}
},
"title": "Calculation",
"type": "object"
},
"CorrelatesWith": {
"description": "Indicates correlation with another variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
}
},
"title": "CorrelatesWith",
"type": "object"
},
"Correlation": {
"description": "Correlation between variables.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
},
"corr_coef": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The correlation coefficient",
"title": "Corr Coef"
}
},
"title": "Correlation",
"type": "object"
},
"DataTable": {
"description": "Data of a gridded table as whitespace- or comma-separated values.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The table data as a string of comma- or whitespace-separated values",
"title": "Value"
}
},
"title": "DataTable",
"type": "object"
},
"Description": {
"description": "Textual description of an entity.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The description text",
"title": "Value"
}
},
"title": "Description",
"type": "object"
},
"NormalPDF": {
"description": "Normal probability distribution function.",
"properties": {
"num_sigmas": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The number of standard deviations",
"title": "Num Sigmas"
},
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
},
"correlates_with": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/CorrelatesWith"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlations with other variables",
"title": "Correlates With"
},
"correlation": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Correlation"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlation coefficients",
"title": "Correlation"
}
},
"title": "NormalPDF",
"type": "object"
},
"Uncertainty": {
"description": "Uncertainty of a function or parameter value.",
"properties": {
"effect": {
"anyOf": [
{
"$ref": "#/$defs/UncertaintyEffect"
},
{
"type": "null"
}
],
"default": null,
"description": "The effect of the uncertainty"
},
"normal_pdf": {
"anyOf": [
{
"$ref": "#/$defs/NormalPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The normal probability distribution function"
},
"uniform_pdf": {
"anyOf": [
{
"$ref": "#/$defs/UniformPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The uniform probability distribution function"
}
},
"title": "Uncertainty",
"type": "object"
},
"UncertaintyEffect": {
"description": "Effect type for uncertainty specification.",
"enum": [
"additive",
"multiplicative",
"percentage",
"absolute"
],
"title": "UncertaintyEffect",
"type": "string"
},
"UniformPDF": {
"description": "Uniform probability distribution function.",
"properties": {
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
}
},
"title": "UniformPDF",
"type": "object"
},
"VariableDef": {
"description": "Definition of a variable.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the variable",
"title": "Name"
},
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this variable",
"title": "Var Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the variable",
"title": "Units"
},
"axis_system": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The axis system for the variable",
"title": "Axis System"
},
"sign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The sign convention for the variable",
"title": "Sign"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An alias for the variable",
"title": "Alias"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A symbol representing the variable",
"title": "Symbol"
},
"initial_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The initial value of the variable",
"title": "Initial Value"
},
"min_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The minimum allowed value of the variable",
"title": "Min Value"
},
"max_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The maximum allowed value of the variable",
"title": "Max Value"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the variable"
},
"calculation": {
"anyOf": [
{
"$ref": "#/$defs/Calculation"
},
{
"type": "null"
}
],
"default": null,
"description": "The calculation for deriving the variable's value"
},
"is_input": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an input",
"title": "Is Input"
},
"is_control": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a control parameter",
"title": "Is Control"
},
"is_disturbance": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a disturbance input",
"title": "Is Disturbance"
},
"is_state": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state variable",
"title": "Is State"
},
"is_state_deriv": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state derivative",
"title": "Is State Deriv"
},
"is_output": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an output",
"title": "Is Output"
},
"is_std_aiaa": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a standard AIAA variable",
"title": "Is Std Aiaa"
},
"uncertainty": {
"anyOf": [
{
"$ref": "#/$defs/Uncertainty"
},
{
"type": "null"
}
],
"default": null,
"description": "The uncertainty associated with the variable"
}
},
"title": "VariableDef",
"type": "object"
},
"VariableRef": {
"description": "Reference to a variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
}
},
"title": "VariableRef",
"type": "object"
}
},
"description": "Definition of a gridded table.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the gridded table",
"title": "Name"
},
"gt_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this gridded table",
"title": "Gt Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the table values",
"title": "Units"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the gridded table"
},
"breakpoint_refs": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BpRef"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "References to the breakpoint sets used in this table",
"title": "Breakpoint Refs"
},
"uncertainty": {
"anyOf": [
{
"$ref": "#/$defs/Uncertainty"
},
{
"type": "null"
}
],
"default": null,
"description": "The uncertainty associated with the table values"
},
"data_table": {
"anyOf": [
{
"$ref": "#/$defs/DataTable"
},
{
"type": "null"
}
],
"default": null,
"description": "The actual data of the gridded table"
}
},
"title": "GriddedTableDef",
"type": "object"
}
Fields:
-
name(Optional[str]) -
gt_id(Optional[str]) -
units(Optional[str]) -
description(Optional[Description]) -
breakpoint_refs(Optional[list[BpRef]]) -
uncertainty(Optional[Uncertainty]) -
data_table(Optional[DataTable])
pydantic-field
¤
References to the breakpoint sets used in this table
pydantic-field
¤
The actual data of the gridded table
pydantic-field
¤
description: Optional[Description] = None
A description of the gridded table
pydantic-field
¤
uncertainty: Optional[Uncertainty] = None
The uncertainty associated with the table values
pydantic-model
¤
Bases: BaseModel
Reference to a gridded table.
Show JSON schema:
{
"description": "Reference to a gridded table.",
"properties": {
"gt_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced gridded table",
"title": "Gt Id"
}
},
"title": "GriddedTableRef",
"type": "object"
}
Fields:
pydantic-model
¤
Bases: BaseModel
Independent variable points for a simple function.
Show JSON schema:
{
"$defs": {
"ExtrapolateEnum": {
"description": "Extrapolation method for table lookups.",
"enum": [
"neither",
"min",
"max",
"both"
],
"title": "ExtrapolateEnum",
"type": "string"
},
"InterpolateEnum": {
"description": "Interpolation method for table lookups (ANSI/AIAA-S-119-2011).",
"enum": [
"discrete",
"floor",
"ceiling",
"linear",
"quadraticSpline",
"cubicSpline"
],
"title": "InterpolateEnum",
"type": "string"
}
},
"description": "Independent variable points for a simple function.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the independent variable",
"title": "Name"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of the independent variable",
"title": "Units"
},
"sign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The sign convention for the independent variable",
"title": "Sign"
},
"extrapolate": {
"anyOf": [
{
"$ref": "#/$defs/ExtrapolateEnum"
},
{
"type": "null"
}
],
"default": null,
"description": "The extrapolation method"
},
"interpolate": {
"anyOf": [
{
"$ref": "#/$defs/InterpolateEnum"
},
{
"type": "null"
}
],
"default": null,
"description": "The interpolation method"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The values of the independent variable points",
"title": "Value"
}
},
"title": "IndependentVarPts",
"type": "object"
}
Fields:
-
var_id(Optional[str]) -
name(Optional[str]) -
units(Optional[str]) -
sign(Optional[str]) -
extrapolate(Optional[ExtrapolateEnum]) -
interpolate(Optional[InterpolateEnum]) -
value(Optional[str])
pydantic-model
¤
Bases: BaseModel
Reference to an independent variable for a complex function.
Show JSON schema:
{
"$defs": {
"ExtrapolateEnum": {
"description": "Extrapolation method for table lookups.",
"enum": [
"neither",
"min",
"max",
"both"
],
"title": "ExtrapolateEnum",
"type": "string"
},
"InterpolateEnum": {
"description": "Interpolation method for table lookups (ANSI/AIAA-S-119-2011).",
"enum": [
"discrete",
"floor",
"ceiling",
"linear",
"quadraticSpline",
"cubicSpline"
],
"title": "InterpolateEnum",
"type": "string"
}
},
"description": "Reference to an independent variable for a complex function.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
},
"min": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The minimum value of the independent variable",
"title": "Min"
},
"max": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The maximum value of the independent variable",
"title": "Max"
},
"extrapolate": {
"anyOf": [
{
"$ref": "#/$defs/ExtrapolateEnum"
},
{
"type": "null"
}
],
"default": null,
"description": "The extrapolation method"
},
"interpolate": {
"anyOf": [
{
"$ref": "#/$defs/InterpolateEnum"
},
{
"type": "null"
}
],
"default": null,
"description": "The interpolation method"
}
},
"title": "IndependentVarRef",
"type": "object"
}
Fields:
-
var_id(Optional[str]) -
min(Optional[float]) -
max(Optional[float]) -
extrapolate(Optional[ExtrapolateEnum]) -
interpolate(Optional[InterpolateEnum])
pydantic-model
¤
Bases: BaseModel
Internal variable values for a check case.
Show JSON schema:
{
"$defs": {
"Signal": {
"description": "Signal (input, internal, or output) in a check case.",
"properties": {
"signal_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the signal",
"title": "Signal Name"
},
"signal_units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of the signal",
"title": "Signal Units"
},
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the variable associated with this signal",
"title": "Var Id"
},
"signal_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The value of the signal",
"title": "Signal Value"
},
"tol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The tolerance for this signal's value",
"title": "Tol"
}
},
"title": "Signal",
"type": "object"
}
},
"description": "Internal variable values for a check case.",
"properties": {
"signal": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Signal"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The internal signals for this check case",
"title": "Signal"
}
},
"title": "InternalValues",
"type": "object"
}
Fields:
Interpolation method for table lookups (ANSI/AIAA-S-119-2011).
Returned by:
pydantic-model
¤
Bases: BaseModel
Normal probability distribution function.
Show JSON schema:
{
"$defs": {
"Bounds": {
"description": "Statistical limits of a parameter.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/DataTable"
},
{
"$ref": "#/$defs/VariableDef"
},
{
"$ref": "#/$defs/VariableRef"
},
{
"type": "null"
}
],
"default": null,
"description": "The bound value or reference",
"title": "Value"
}
},
"title": "Bounds",
"type": "object"
},
"Calculation": {
"description": "Calculation using MathML content markup.",
"properties": {
"math": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The MathML content markup describing the calculation",
"title": "Math"
}
},
"title": "Calculation",
"type": "object"
},
"CorrelatesWith": {
"description": "Indicates correlation with another variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
}
},
"title": "CorrelatesWith",
"type": "object"
},
"Correlation": {
"description": "Correlation between variables.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
},
"corr_coef": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The correlation coefficient",
"title": "Corr Coef"
}
},
"title": "Correlation",
"type": "object"
},
"DataTable": {
"description": "Data of a gridded table as whitespace- or comma-separated values.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The table data as a string of comma- or whitespace-separated values",
"title": "Value"
}
},
"title": "DataTable",
"type": "object"
},
"Description": {
"description": "Textual description of an entity.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The description text",
"title": "Value"
}
},
"title": "Description",
"type": "object"
},
"NormalPDF": {
"description": "Normal probability distribution function.",
"properties": {
"num_sigmas": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The number of standard deviations",
"title": "Num Sigmas"
},
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
},
"correlates_with": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/CorrelatesWith"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlations with other variables",
"title": "Correlates With"
},
"correlation": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Correlation"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlation coefficients",
"title": "Correlation"
}
},
"title": "NormalPDF",
"type": "object"
},
"Uncertainty": {
"description": "Uncertainty of a function or parameter value.",
"properties": {
"effect": {
"anyOf": [
{
"$ref": "#/$defs/UncertaintyEffect"
},
{
"type": "null"
}
],
"default": null,
"description": "The effect of the uncertainty"
},
"normal_pdf": {
"anyOf": [
{
"$ref": "#/$defs/NormalPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The normal probability distribution function"
},
"uniform_pdf": {
"anyOf": [
{
"$ref": "#/$defs/UniformPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The uniform probability distribution function"
}
},
"title": "Uncertainty",
"type": "object"
},
"UncertaintyEffect": {
"description": "Effect type for uncertainty specification.",
"enum": [
"additive",
"multiplicative",
"percentage",
"absolute"
],
"title": "UncertaintyEffect",
"type": "string"
},
"UniformPDF": {
"description": "Uniform probability distribution function.",
"properties": {
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
}
},
"title": "UniformPDF",
"type": "object"
},
"VariableDef": {
"description": "Definition of a variable.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the variable",
"title": "Name"
},
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this variable",
"title": "Var Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the variable",
"title": "Units"
},
"axis_system": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The axis system for the variable",
"title": "Axis System"
},
"sign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The sign convention for the variable",
"title": "Sign"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An alias for the variable",
"title": "Alias"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A symbol representing the variable",
"title": "Symbol"
},
"initial_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The initial value of the variable",
"title": "Initial Value"
},
"min_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The minimum allowed value of the variable",
"title": "Min Value"
},
"max_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The maximum allowed value of the variable",
"title": "Max Value"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the variable"
},
"calculation": {
"anyOf": [
{
"$ref": "#/$defs/Calculation"
},
{
"type": "null"
}
],
"default": null,
"description": "The calculation for deriving the variable's value"
},
"is_input": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an input",
"title": "Is Input"
},
"is_control": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a control parameter",
"title": "Is Control"
},
"is_disturbance": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a disturbance input",
"title": "Is Disturbance"
},
"is_state": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state variable",
"title": "Is State"
},
"is_state_deriv": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state derivative",
"title": "Is State Deriv"
},
"is_output": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an output",
"title": "Is Output"
},
"is_std_aiaa": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a standard AIAA variable",
"title": "Is Std Aiaa"
},
"uncertainty": {
"anyOf": [
{
"$ref": "#/$defs/Uncertainty"
},
{
"type": "null"
}
],
"default": null,
"description": "The uncertainty associated with the variable"
}
},
"title": "VariableDef",
"type": "object"
},
"VariableRef": {
"description": "Reference to a variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
}
},
"title": "VariableRef",
"type": "object"
}
},
"$ref": "#/$defs/NormalPDF"
}
Fields:
-
num_sigmas(Optional[float]) -
bounds(Optional[list[Bounds]]) -
correlates_with(Optional[list[CorrelatesWith]]) -
correlation(Optional[list[Correlation]])
pydantic-field
¤
correlates_with: Optional[list[CorrelatesWith]] = None
Correlations with other variables
pydantic-field
¤
correlation: Optional[list[Correlation]] = None
Correlation coefficients
pydantic-model
¤
Bases: BaseModel
Signal (input, internal, or output) in a check case.
Show JSON schema:
{
"description": "Signal (input, internal, or output) in a check case.",
"properties": {
"signal_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the signal",
"title": "Signal Name"
},
"signal_units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of the signal",
"title": "Signal Units"
},
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the variable associated with this signal",
"title": "Var Id"
},
"signal_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The value of the signal",
"title": "Signal Value"
},
"tol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The tolerance for this signal's value",
"title": "Tol"
}
},
"title": "Signal",
"type": "object"
}
Fields:
-
signal_name(Optional[str]) -
signal_units(Optional[str]) -
var_id(Optional[str]) -
signal_value(Optional[str]) -
tol(Optional[str])
pydantic-model
¤
Bases: BaseModel
Static check case for model verification.
Show JSON schema:
{
"$defs": {
"CheckInputs": {
"description": "Input values for a check case.",
"properties": {
"signal": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Signal"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The input signals for this check case",
"title": "Signal"
}
},
"title": "CheckInputs",
"type": "object"
},
"CheckOutputs": {
"description": "Expected output values for a check case.",
"properties": {
"signal": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Signal"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The output signals for this check case",
"title": "Signal"
}
},
"title": "CheckOutputs",
"type": "object"
},
"Description": {
"description": "Textual description of an entity.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The description text",
"title": "Value"
}
},
"title": "Description",
"type": "object"
},
"InternalValues": {
"description": "Internal variable values for a check case.",
"properties": {
"signal": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Signal"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The internal signals for this check case",
"title": "Signal"
}
},
"title": "InternalValues",
"type": "object"
},
"Signal": {
"description": "Signal (input, internal, or output) in a check case.",
"properties": {
"signal_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the signal",
"title": "Signal Name"
},
"signal_units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of the signal",
"title": "Signal Units"
},
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the variable associated with this signal",
"title": "Var Id"
},
"signal_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The value of the signal",
"title": "Signal Value"
},
"tol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The tolerance for this signal's value",
"title": "Tol"
}
},
"title": "Signal",
"type": "object"
}
},
"description": "Static check case for model verification.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the static shot",
"title": "Name"
},
"ref_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The reference ID for this static shot",
"title": "Ref Id"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the static shot"
},
"check_inputs": {
"anyOf": [
{
"$ref": "#/$defs/CheckInputs"
},
{
"type": "null"
}
],
"default": null,
"description": "The input values for this check case"
},
"internal_values": {
"anyOf": [
{
"$ref": "#/$defs/InternalValues"
},
{
"type": "null"
}
],
"default": null,
"description": "The internal variable values for this check case"
},
"check_outputs": {
"anyOf": [
{
"$ref": "#/$defs/CheckOutputs"
},
{
"type": "null"
}
],
"default": null,
"description": "The expected output values for this check case"
}
},
"title": "StaticShot",
"type": "object"
}
Fields:
-
name(Optional[str]) -
ref_id(Optional[str]) -
description(Optional[Description]) -
check_inputs(Optional[CheckInputs]) -
internal_values(Optional[InternalValues]) -
check_outputs(Optional[CheckOutputs])
pydantic-field
¤
check_inputs: Optional[CheckInputs] = None
The input values for this check case
pydantic-field
¤
check_outputs: Optional[CheckOutputs] = None
The expected output values for this check case
pydantic-field
¤
description: Optional[Description] = None
A description of the static shot
pydantic-field
¤
internal_values: Optional[InternalValues] = None
The internal variable values for this check case
pydantic-model
¤
Bases: BaseModel
Mixin that adds optional DaveML table fields for composing into Behavior/Discipline.
Show JSON schema:
{
"$defs": {
"Bounds": {
"description": "Statistical limits of a parameter.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/DataTable"
},
{
"$ref": "#/$defs/VariableDef"
},
{
"$ref": "#/$defs/VariableRef"
},
{
"type": "null"
}
],
"default": null,
"description": "The bound value or reference",
"title": "Value"
}
},
"title": "Bounds",
"type": "object"
},
"BpRef": {
"description": "Reference to a breakpoint set.",
"properties": {
"bp_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced breakpoint set",
"title": "Bp Id"
}
},
"title": "BpRef",
"type": "object"
},
"BreakpointDef": {
"description": "Definition of a breakpoint set.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the breakpoint set",
"title": "Name"
},
"bp_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this breakpoint set",
"title": "Bp Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the breakpoints",
"title": "Units"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the breakpoint set"
},
"bp_vals": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The breakpoint values",
"title": "Bp Vals"
}
},
"title": "BreakpointDef",
"type": "object"
},
"Calculation": {
"description": "Calculation using MathML content markup.",
"properties": {
"math": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The MathML content markup describing the calculation",
"title": "Math"
}
},
"title": "Calculation",
"type": "object"
},
"CheckData": {
"description": "Check data for model verification.",
"properties": {
"static_shot": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/StaticShot"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Static check cases",
"title": "Static Shot"
}
},
"title": "CheckData",
"type": "object"
},
"CheckInputs": {
"description": "Input values for a check case.",
"properties": {
"signal": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Signal"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The input signals for this check case",
"title": "Signal"
}
},
"title": "CheckInputs",
"type": "object"
},
"CheckOutputs": {
"description": "Expected output values for a check case.",
"properties": {
"signal": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Signal"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The output signals for this check case",
"title": "Signal"
}
},
"title": "CheckOutputs",
"type": "object"
},
"ConfidenceBound": {
"description": "Confidence bound for table data.",
"properties": {
"value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The value of the confidence bound",
"title": "Value"
}
},
"title": "ConfidenceBound",
"type": "object"
},
"CorrelatesWith": {
"description": "Indicates correlation with another variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
}
},
"title": "CorrelatesWith",
"type": "object"
},
"Correlation": {
"description": "Correlation between variables.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
},
"corr_coef": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The correlation coefficient",
"title": "Corr Coef"
}
},
"title": "Correlation",
"type": "object"
},
"DataPoint": {
"description": "Data point in an ungridded table.",
"properties": {
"mod_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the modification record for this data point",
"title": "Mod Id"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The values of the data point",
"title": "Value"
}
},
"title": "DataPoint",
"type": "object"
},
"DataTable": {
"description": "Data of a gridded table as whitespace- or comma-separated values.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The table data as a string of comma- or whitespace-separated values",
"title": "Value"
}
},
"title": "DataTable",
"type": "object"
},
"DependentVarPts": {
"description": "Dependent variable points for a simple function.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the dependent variable",
"title": "Name"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of the dependent variable",
"title": "Units"
},
"sign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The sign convention for the dependent variable",
"title": "Sign"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The values of the dependent variable points",
"title": "Value"
}
},
"title": "DependentVarPts",
"type": "object"
},
"DependentVarRef": {
"description": "Reference to a dependent variable for a complex function.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
}
},
"title": "DependentVarRef",
"type": "object"
},
"Description": {
"description": "Textual description of an entity.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The description text",
"title": "Value"
}
},
"title": "Description",
"type": "object"
},
"ExtrapolateEnum": {
"description": "Extrapolation method for table lookups.",
"enum": [
"neither",
"min",
"max",
"both"
],
"title": "ExtrapolateEnum",
"type": "string"
},
"Function": {
"description": "A DAVE-ML function relating independent variables to a dependent variable.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the function",
"title": "Name"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the function"
},
"independent_var_pts": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/IndependentVarPts"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The independent variable points for simple functions",
"title": "Independent Var Pts"
},
"dependent_var_pts": {
"anyOf": [
{
"$ref": "#/$defs/DependentVarPts"
},
{
"type": "null"
}
],
"default": null,
"description": "The dependent variable points for simple functions"
},
"independent_var_ref": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/IndependentVarRef"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "References to independent variables for complex functions",
"title": "Independent Var Ref"
},
"dependent_var_ref": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/DependentVarRef"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Reference to the dependent variable for complex functions",
"title": "Dependent Var Ref"
},
"function_defn": {
"anyOf": [
{
"$ref": "#/$defs/FunctionDefn"
},
{
"type": "null"
}
],
"default": null,
"description": "The function definition for complex functions"
}
},
"title": "Function",
"type": "object"
},
"FunctionDefn": {
"description": "Definition of a complex function (table-based lookup).",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the function definition",
"title": "Name"
},
"gridded_table_ref": {
"anyOf": [
{
"$ref": "#/$defs/GriddedTableRef"
},
{
"type": "null"
}
],
"default": null,
"description": "A reference to a gridded table"
},
"gridded_table_def": {
"anyOf": [
{
"$ref": "#/$defs/GriddedTableDef"
},
{
"type": "null"
}
],
"default": null,
"description": "A gridded table definition"
},
"gridded_table": {
"anyOf": [
{
"$ref": "#/$defs/GriddedTable"
},
{
"type": "null"
}
],
"default": null,
"description": "A gridded table"
},
"ungridded_table_ref": {
"anyOf": [
{
"$ref": "#/$defs/UngriddedTableRef"
},
{
"type": "null"
}
],
"default": null,
"description": "A reference to an ungridded table"
},
"ungridded_table_def": {
"anyOf": [
{
"$ref": "#/$defs/UngriddedTableDef"
},
{
"type": "null"
}
],
"default": null,
"description": "An ungridded table definition"
},
"ungridded_table": {
"anyOf": [
{
"$ref": "#/$defs/UngriddedTable"
},
{
"type": "null"
}
],
"default": null,
"description": "An ungridded table"
}
},
"title": "FunctionDefn",
"type": "object"
},
"GriddedTable": {
"description": "Inline gridded table.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the gridded table",
"title": "Name"
},
"breakpoint_refs": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BpRef"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "References to the breakpoint sets used in this table",
"title": "Breakpoint Refs"
},
"confidence_bound": {
"anyOf": [
{
"$ref": "#/$defs/ConfidenceBound"
},
{
"type": "null"
}
],
"default": null,
"description": "The confidence bound for the table data"
},
"data_table": {
"anyOf": [
{
"$ref": "#/$defs/DataTable"
},
{
"type": "null"
}
],
"default": null,
"description": "The actual data of the gridded table"
}
},
"title": "GriddedTable",
"type": "object"
},
"GriddedTableDef": {
"description": "Definition of a gridded table.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the gridded table",
"title": "Name"
},
"gt_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this gridded table",
"title": "Gt Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the table values",
"title": "Units"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the gridded table"
},
"breakpoint_refs": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BpRef"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "References to the breakpoint sets used in this table",
"title": "Breakpoint Refs"
},
"uncertainty": {
"anyOf": [
{
"$ref": "#/$defs/Uncertainty"
},
{
"type": "null"
}
],
"default": null,
"description": "The uncertainty associated with the table values"
},
"data_table": {
"anyOf": [
{
"$ref": "#/$defs/DataTable"
},
{
"type": "null"
}
],
"default": null,
"description": "The actual data of the gridded table"
}
},
"title": "GriddedTableDef",
"type": "object"
},
"GriddedTableRef": {
"description": "Reference to a gridded table.",
"properties": {
"gt_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced gridded table",
"title": "Gt Id"
}
},
"title": "GriddedTableRef",
"type": "object"
},
"IndependentVarPts": {
"description": "Independent variable points for a simple function.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the independent variable",
"title": "Name"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of the independent variable",
"title": "Units"
},
"sign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The sign convention for the independent variable",
"title": "Sign"
},
"extrapolate": {
"anyOf": [
{
"$ref": "#/$defs/ExtrapolateEnum"
},
{
"type": "null"
}
],
"default": null,
"description": "The extrapolation method"
},
"interpolate": {
"anyOf": [
{
"$ref": "#/$defs/InterpolateEnum"
},
{
"type": "null"
}
],
"default": null,
"description": "The interpolation method"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The values of the independent variable points",
"title": "Value"
}
},
"title": "IndependentVarPts",
"type": "object"
},
"IndependentVarRef": {
"description": "Reference to an independent variable for a complex function.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
},
"min": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The minimum value of the independent variable",
"title": "Min"
},
"max": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The maximum value of the independent variable",
"title": "Max"
},
"extrapolate": {
"anyOf": [
{
"$ref": "#/$defs/ExtrapolateEnum"
},
{
"type": "null"
}
],
"default": null,
"description": "The extrapolation method"
},
"interpolate": {
"anyOf": [
{
"$ref": "#/$defs/InterpolateEnum"
},
{
"type": "null"
}
],
"default": null,
"description": "The interpolation method"
}
},
"title": "IndependentVarRef",
"type": "object"
},
"InternalValues": {
"description": "Internal variable values for a check case.",
"properties": {
"signal": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Signal"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The internal signals for this check case",
"title": "Signal"
}
},
"title": "InternalValues",
"type": "object"
},
"InterpolateEnum": {
"description": "Interpolation method for table lookups (ANSI/AIAA-S-119-2011).",
"enum": [
"discrete",
"floor",
"ceiling",
"linear",
"quadraticSpline",
"cubicSpline"
],
"title": "InterpolateEnum",
"type": "string"
},
"NormalPDF": {
"description": "Normal probability distribution function.",
"properties": {
"num_sigmas": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The number of standard deviations",
"title": "Num Sigmas"
},
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
},
"correlates_with": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/CorrelatesWith"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlations with other variables",
"title": "Correlates With"
},
"correlation": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Correlation"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlation coefficients",
"title": "Correlation"
}
},
"title": "NormalPDF",
"type": "object"
},
"Signal": {
"description": "Signal (input, internal, or output) in a check case.",
"properties": {
"signal_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the signal",
"title": "Signal Name"
},
"signal_units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of the signal",
"title": "Signal Units"
},
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the variable associated with this signal",
"title": "Var Id"
},
"signal_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The value of the signal",
"title": "Signal Value"
},
"tol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The tolerance for this signal's value",
"title": "Tol"
}
},
"title": "Signal",
"type": "object"
},
"StaticShot": {
"description": "Static check case for model verification.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the static shot",
"title": "Name"
},
"ref_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The reference ID for this static shot",
"title": "Ref Id"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the static shot"
},
"check_inputs": {
"anyOf": [
{
"$ref": "#/$defs/CheckInputs"
},
{
"type": "null"
}
],
"default": null,
"description": "The input values for this check case"
},
"internal_values": {
"anyOf": [
{
"$ref": "#/$defs/InternalValues"
},
{
"type": "null"
}
],
"default": null,
"description": "The internal variable values for this check case"
},
"check_outputs": {
"anyOf": [
{
"$ref": "#/$defs/CheckOutputs"
},
{
"type": "null"
}
],
"default": null,
"description": "The expected output values for this check case"
}
},
"title": "StaticShot",
"type": "object"
},
"Uncertainty": {
"description": "Uncertainty of a function or parameter value.",
"properties": {
"effect": {
"anyOf": [
{
"$ref": "#/$defs/UncertaintyEffect"
},
{
"type": "null"
}
],
"default": null,
"description": "The effect of the uncertainty"
},
"normal_pdf": {
"anyOf": [
{
"$ref": "#/$defs/NormalPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The normal probability distribution function"
},
"uniform_pdf": {
"anyOf": [
{
"$ref": "#/$defs/UniformPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The uniform probability distribution function"
}
},
"title": "Uncertainty",
"type": "object"
},
"UncertaintyEffect": {
"description": "Effect type for uncertainty specification.",
"enum": [
"additive",
"multiplicative",
"percentage",
"absolute"
],
"title": "UncertaintyEffect",
"type": "string"
},
"UngriddedTable": {
"description": "Inline ungridded table.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the ungridded table",
"title": "Name"
},
"confidence_bound": {
"anyOf": [
{
"$ref": "#/$defs/ConfidenceBound"
},
{
"type": "null"
}
],
"default": null,
"description": "The confidence bound for the table data"
},
"data_point": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/DataPoint"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The data points of the ungridded table",
"title": "Data Point"
}
},
"title": "UngriddedTable",
"type": "object"
},
"UngriddedTableDef": {
"description": "Definition of an ungridded table.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the ungridded table",
"title": "Name"
},
"ut_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this ungridded table",
"title": "Ut Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the table values",
"title": "Units"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the ungridded table"
},
"uncertainty": {
"anyOf": [
{
"$ref": "#/$defs/Uncertainty"
},
{
"type": "null"
}
],
"default": null,
"description": "The uncertainty associated with the table values"
},
"data_point": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/DataPoint"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The data points of the ungridded table",
"title": "Data Point"
}
},
"title": "UngriddedTableDef",
"type": "object"
},
"UngriddedTableRef": {
"description": "Reference to an ungridded table.",
"properties": {
"ut_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced ungridded table",
"title": "Ut Id"
}
},
"title": "UngriddedTableRef",
"type": "object"
},
"UniformPDF": {
"description": "Uniform probability distribution function.",
"properties": {
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
}
},
"title": "UniformPDF",
"type": "object"
},
"VariableDef": {
"description": "Definition of a variable.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the variable",
"title": "Name"
},
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this variable",
"title": "Var Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the variable",
"title": "Units"
},
"axis_system": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The axis system for the variable",
"title": "Axis System"
},
"sign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The sign convention for the variable",
"title": "Sign"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An alias for the variable",
"title": "Alias"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A symbol representing the variable",
"title": "Symbol"
},
"initial_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The initial value of the variable",
"title": "Initial Value"
},
"min_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The minimum allowed value of the variable",
"title": "Min Value"
},
"max_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The maximum allowed value of the variable",
"title": "Max Value"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the variable"
},
"calculation": {
"anyOf": [
{
"$ref": "#/$defs/Calculation"
},
{
"type": "null"
}
],
"default": null,
"description": "The calculation for deriving the variable's value"
},
"is_input": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an input",
"title": "Is Input"
},
"is_control": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a control parameter",
"title": "Is Control"
},
"is_disturbance": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a disturbance input",
"title": "Is Disturbance"
},
"is_state": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state variable",
"title": "Is State"
},
"is_state_deriv": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state derivative",
"title": "Is State Deriv"
},
"is_output": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an output",
"title": "Is Output"
},
"is_std_aiaa": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a standard AIAA variable",
"title": "Is Std Aiaa"
},
"uncertainty": {
"anyOf": [
{
"$ref": "#/$defs/Uncertainty"
},
{
"type": "null"
}
],
"default": null,
"description": "The uncertainty associated with the variable"
}
},
"title": "VariableDef",
"type": "object"
},
"VariableRef": {
"description": "Reference to a variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
}
},
"title": "VariableRef",
"type": "object"
}
},
"description": "Mixin that adds optional DaveML table fields for composing into Behavior/Discipline.",
"properties": {
"variable_defs": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/VariableDef"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Variable definitions",
"title": "Variable Defs"
},
"breakpoint_defs": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/BreakpointDef"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Breakpoint set definitions",
"title": "Breakpoint Defs"
},
"gridded_table_defs": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/GriddedTableDef"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Gridded table definitions",
"title": "Gridded Table Defs"
},
"ungridded_table_defs": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/UngriddedTableDef"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Ungridded table definitions",
"title": "Ungridded Table Defs"
},
"functions": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Function"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Function definitions",
"title": "Functions"
},
"check_data": {
"anyOf": [
{
"$ref": "#/$defs/CheckData"
},
{
"type": "null"
}
],
"default": null,
"description": "Verification check data"
}
},
"title": "TablesMixin",
"type": "object"
}
Fields:
-
variable_defs(Optional[list[VariableDef]]) -
breakpoint_defs(Optional[list[BreakpointDef]]) -
gridded_table_defs(Optional[list[GriddedTableDef]]) -
ungridded_table_defs(Optional[list[UngriddedTableDef]]) -
functions(Optional[list[Function]]) -
check_data(Optional[CheckData])
pydantic-field
¤
breakpoint_defs: Optional[list[BreakpointDef]] = None
Breakpoint set definitions
pydantic-field
¤
gridded_table_defs: Optional[list[GriddedTableDef]] = None
Gridded table definitions
pydantic-field
¤
ungridded_table_defs: Optional[list[UngriddedTableDef]] = None
Ungridded table definitions
pydantic-field
¤
variable_defs: Optional[list[VariableDef]] = None
Variable definitions
pydantic-model
¤
Bases: BaseModel
Uncertainty of a function or parameter value.
Show JSON schema:
{
"$defs": {
"Bounds": {
"description": "Statistical limits of a parameter.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/DataTable"
},
{
"$ref": "#/$defs/VariableDef"
},
{
"$ref": "#/$defs/VariableRef"
},
{
"type": "null"
}
],
"default": null,
"description": "The bound value or reference",
"title": "Value"
}
},
"title": "Bounds",
"type": "object"
},
"Calculation": {
"description": "Calculation using MathML content markup.",
"properties": {
"math": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The MathML content markup describing the calculation",
"title": "Math"
}
},
"title": "Calculation",
"type": "object"
},
"CorrelatesWith": {
"description": "Indicates correlation with another variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
}
},
"title": "CorrelatesWith",
"type": "object"
},
"Correlation": {
"description": "Correlation between variables.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
},
"corr_coef": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The correlation coefficient",
"title": "Corr Coef"
}
},
"title": "Correlation",
"type": "object"
},
"DataTable": {
"description": "Data of a gridded table as whitespace- or comma-separated values.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The table data as a string of comma- or whitespace-separated values",
"title": "Value"
}
},
"title": "DataTable",
"type": "object"
},
"Description": {
"description": "Textual description of an entity.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The description text",
"title": "Value"
}
},
"title": "Description",
"type": "object"
},
"NormalPDF": {
"description": "Normal probability distribution function.",
"properties": {
"num_sigmas": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The number of standard deviations",
"title": "Num Sigmas"
},
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
},
"correlates_with": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/CorrelatesWith"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlations with other variables",
"title": "Correlates With"
},
"correlation": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Correlation"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlation coefficients",
"title": "Correlation"
}
},
"title": "NormalPDF",
"type": "object"
},
"Uncertainty": {
"description": "Uncertainty of a function or parameter value.",
"properties": {
"effect": {
"anyOf": [
{
"$ref": "#/$defs/UncertaintyEffect"
},
{
"type": "null"
}
],
"default": null,
"description": "The effect of the uncertainty"
},
"normal_pdf": {
"anyOf": [
{
"$ref": "#/$defs/NormalPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The normal probability distribution function"
},
"uniform_pdf": {
"anyOf": [
{
"$ref": "#/$defs/UniformPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The uniform probability distribution function"
}
},
"title": "Uncertainty",
"type": "object"
},
"UncertaintyEffect": {
"description": "Effect type for uncertainty specification.",
"enum": [
"additive",
"multiplicative",
"percentage",
"absolute"
],
"title": "UncertaintyEffect",
"type": "string"
},
"UniformPDF": {
"description": "Uniform probability distribution function.",
"properties": {
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
}
},
"title": "UniformPDF",
"type": "object"
},
"VariableDef": {
"description": "Definition of a variable.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the variable",
"title": "Name"
},
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this variable",
"title": "Var Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the variable",
"title": "Units"
},
"axis_system": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The axis system for the variable",
"title": "Axis System"
},
"sign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The sign convention for the variable",
"title": "Sign"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An alias for the variable",
"title": "Alias"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A symbol representing the variable",
"title": "Symbol"
},
"initial_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The initial value of the variable",
"title": "Initial Value"
},
"min_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The minimum allowed value of the variable",
"title": "Min Value"
},
"max_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The maximum allowed value of the variable",
"title": "Max Value"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the variable"
},
"calculation": {
"anyOf": [
{
"$ref": "#/$defs/Calculation"
},
{
"type": "null"
}
],
"default": null,
"description": "The calculation for deriving the variable's value"
},
"is_input": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an input",
"title": "Is Input"
},
"is_control": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a control parameter",
"title": "Is Control"
},
"is_disturbance": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a disturbance input",
"title": "Is Disturbance"
},
"is_state": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state variable",
"title": "Is State"
},
"is_state_deriv": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state derivative",
"title": "Is State Deriv"
},
"is_output": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an output",
"title": "Is Output"
},
"is_std_aiaa": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a standard AIAA variable",
"title": "Is Std Aiaa"
},
"uncertainty": {
"anyOf": [
{
"$ref": "#/$defs/Uncertainty"
},
{
"type": "null"
}
],
"default": null,
"description": "The uncertainty associated with the variable"
}
},
"title": "VariableDef",
"type": "object"
},
"VariableRef": {
"description": "Reference to a variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
}
},
"title": "VariableRef",
"type": "object"
}
},
"$ref": "#/$defs/Uncertainty"
}
Fields:
-
effect(Optional[UncertaintyEffect]) -
normal_pdf(Optional[NormalPDF]) -
uniform_pdf(Optional[UniformPDF])
Validators:
-
validate_pdf→uniform_pdf
pydantic-field
¤
The normal probability distribution function
pydantic-field
¤
uniform_pdf: Optional[UniformPDF] = None
The uniform probability distribution function
pydantic-model
¤
Bases: BaseModel
Inline ungridded table.
Show JSON schema:
{
"$defs": {
"ConfidenceBound": {
"description": "Confidence bound for table data.",
"properties": {
"value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The value of the confidence bound",
"title": "Value"
}
},
"title": "ConfidenceBound",
"type": "object"
},
"DataPoint": {
"description": "Data point in an ungridded table.",
"properties": {
"mod_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the modification record for this data point",
"title": "Mod Id"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The values of the data point",
"title": "Value"
}
},
"title": "DataPoint",
"type": "object"
}
},
"description": "Inline ungridded table.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the ungridded table",
"title": "Name"
},
"confidence_bound": {
"anyOf": [
{
"$ref": "#/$defs/ConfidenceBound"
},
{
"type": "null"
}
],
"default": null,
"description": "The confidence bound for the table data"
},
"data_point": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/DataPoint"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The data points of the ungridded table",
"title": "Data Point"
}
},
"title": "UngriddedTable",
"type": "object"
}
Fields:
-
name(Optional[str]) -
confidence_bound(Optional[ConfidenceBound]) -
data_point(Optional[list[DataPoint]])
pydantic-field
¤
confidence_bound: Optional[ConfidenceBound] = None
The confidence bound for the table data
pydantic-field
¤
The data points of the ungridded table
pydantic-model
¤
Bases: BaseModel
Definition of an ungridded table.
Show JSON schema:
{
"$defs": {
"Bounds": {
"description": "Statistical limits of a parameter.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/DataTable"
},
{
"$ref": "#/$defs/VariableDef"
},
{
"$ref": "#/$defs/VariableRef"
},
{
"type": "null"
}
],
"default": null,
"description": "The bound value or reference",
"title": "Value"
}
},
"title": "Bounds",
"type": "object"
},
"Calculation": {
"description": "Calculation using MathML content markup.",
"properties": {
"math": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The MathML content markup describing the calculation",
"title": "Math"
}
},
"title": "Calculation",
"type": "object"
},
"CorrelatesWith": {
"description": "Indicates correlation with another variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
}
},
"title": "CorrelatesWith",
"type": "object"
},
"Correlation": {
"description": "Correlation between variables.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
},
"corr_coef": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The correlation coefficient",
"title": "Corr Coef"
}
},
"title": "Correlation",
"type": "object"
},
"DataPoint": {
"description": "Data point in an ungridded table.",
"properties": {
"mod_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the modification record for this data point",
"title": "Mod Id"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The values of the data point",
"title": "Value"
}
},
"title": "DataPoint",
"type": "object"
},
"DataTable": {
"description": "Data of a gridded table as whitespace- or comma-separated values.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The table data as a string of comma- or whitespace-separated values",
"title": "Value"
}
},
"title": "DataTable",
"type": "object"
},
"Description": {
"description": "Textual description of an entity.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The description text",
"title": "Value"
}
},
"title": "Description",
"type": "object"
},
"NormalPDF": {
"description": "Normal probability distribution function.",
"properties": {
"num_sigmas": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The number of standard deviations",
"title": "Num Sigmas"
},
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
},
"correlates_with": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/CorrelatesWith"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlations with other variables",
"title": "Correlates With"
},
"correlation": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Correlation"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlation coefficients",
"title": "Correlation"
}
},
"title": "NormalPDF",
"type": "object"
},
"Uncertainty": {
"description": "Uncertainty of a function or parameter value.",
"properties": {
"effect": {
"anyOf": [
{
"$ref": "#/$defs/UncertaintyEffect"
},
{
"type": "null"
}
],
"default": null,
"description": "The effect of the uncertainty"
},
"normal_pdf": {
"anyOf": [
{
"$ref": "#/$defs/NormalPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The normal probability distribution function"
},
"uniform_pdf": {
"anyOf": [
{
"$ref": "#/$defs/UniformPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The uniform probability distribution function"
}
},
"title": "Uncertainty",
"type": "object"
},
"UncertaintyEffect": {
"description": "Effect type for uncertainty specification.",
"enum": [
"additive",
"multiplicative",
"percentage",
"absolute"
],
"title": "UncertaintyEffect",
"type": "string"
},
"UniformPDF": {
"description": "Uniform probability distribution function.",
"properties": {
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
}
},
"title": "UniformPDF",
"type": "object"
},
"VariableDef": {
"description": "Definition of a variable.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the variable",
"title": "Name"
},
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this variable",
"title": "Var Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the variable",
"title": "Units"
},
"axis_system": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The axis system for the variable",
"title": "Axis System"
},
"sign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The sign convention for the variable",
"title": "Sign"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An alias for the variable",
"title": "Alias"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A symbol representing the variable",
"title": "Symbol"
},
"initial_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The initial value of the variable",
"title": "Initial Value"
},
"min_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The minimum allowed value of the variable",
"title": "Min Value"
},
"max_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The maximum allowed value of the variable",
"title": "Max Value"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the variable"
},
"calculation": {
"anyOf": [
{
"$ref": "#/$defs/Calculation"
},
{
"type": "null"
}
],
"default": null,
"description": "The calculation for deriving the variable's value"
},
"is_input": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an input",
"title": "Is Input"
},
"is_control": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a control parameter",
"title": "Is Control"
},
"is_disturbance": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a disturbance input",
"title": "Is Disturbance"
},
"is_state": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state variable",
"title": "Is State"
},
"is_state_deriv": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state derivative",
"title": "Is State Deriv"
},
"is_output": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an output",
"title": "Is Output"
},
"is_std_aiaa": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a standard AIAA variable",
"title": "Is Std Aiaa"
},
"uncertainty": {
"anyOf": [
{
"$ref": "#/$defs/Uncertainty"
},
{
"type": "null"
}
],
"default": null,
"description": "The uncertainty associated with the variable"
}
},
"title": "VariableDef",
"type": "object"
},
"VariableRef": {
"description": "Reference to a variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
}
},
"title": "VariableRef",
"type": "object"
}
},
"description": "Definition of an ungridded table.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the ungridded table",
"title": "Name"
},
"ut_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this ungridded table",
"title": "Ut Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the table values",
"title": "Units"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the ungridded table"
},
"uncertainty": {
"anyOf": [
{
"$ref": "#/$defs/Uncertainty"
},
{
"type": "null"
}
],
"default": null,
"description": "The uncertainty associated with the table values"
},
"data_point": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/DataPoint"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The data points of the ungridded table",
"title": "Data Point"
}
},
"title": "UngriddedTableDef",
"type": "object"
}
Fields:
-
name(Optional[str]) -
ut_id(Optional[str]) -
units(Optional[str]) -
description(Optional[Description]) -
uncertainty(Optional[Uncertainty]) -
data_point(Optional[list[DataPoint]])
pydantic-field
¤
The data points of the ungridded table
pydantic-field
¤
description: Optional[Description] = None
A description of the ungridded table
pydantic-field
¤
uncertainty: Optional[Uncertainty] = None
The uncertainty associated with the table values
pydantic-model
¤
Bases: BaseModel
Reference to an ungridded table.
Show JSON schema:
{
"description": "Reference to an ungridded table.",
"properties": {
"ut_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced ungridded table",
"title": "Ut Id"
}
},
"title": "UngriddedTableRef",
"type": "object"
}
Fields:
pydantic-model
¤
Bases: BaseModel
Uniform probability distribution function.
Show JSON schema:
{
"$defs": {
"Bounds": {
"description": "Statistical limits of a parameter.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/DataTable"
},
{
"$ref": "#/$defs/VariableDef"
},
{
"$ref": "#/$defs/VariableRef"
},
{
"type": "null"
}
],
"default": null,
"description": "The bound value or reference",
"title": "Value"
}
},
"title": "Bounds",
"type": "object"
},
"Calculation": {
"description": "Calculation using MathML content markup.",
"properties": {
"math": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The MathML content markup describing the calculation",
"title": "Math"
}
},
"title": "Calculation",
"type": "object"
},
"CorrelatesWith": {
"description": "Indicates correlation with another variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
}
},
"title": "CorrelatesWith",
"type": "object"
},
"Correlation": {
"description": "Correlation between variables.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
},
"corr_coef": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The correlation coefficient",
"title": "Corr Coef"
}
},
"title": "Correlation",
"type": "object"
},
"DataTable": {
"description": "Data of a gridded table as whitespace- or comma-separated values.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The table data as a string of comma- or whitespace-separated values",
"title": "Value"
}
},
"title": "DataTable",
"type": "object"
},
"Description": {
"description": "Textual description of an entity.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The description text",
"title": "Value"
}
},
"title": "Description",
"type": "object"
},
"NormalPDF": {
"description": "Normal probability distribution function.",
"properties": {
"num_sigmas": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The number of standard deviations",
"title": "Num Sigmas"
},
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
},
"correlates_with": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/CorrelatesWith"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlations with other variables",
"title": "Correlates With"
},
"correlation": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Correlation"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlation coefficients",
"title": "Correlation"
}
},
"title": "NormalPDF",
"type": "object"
},
"Uncertainty": {
"description": "Uncertainty of a function or parameter value.",
"properties": {
"effect": {
"anyOf": [
{
"$ref": "#/$defs/UncertaintyEffect"
},
{
"type": "null"
}
],
"default": null,
"description": "The effect of the uncertainty"
},
"normal_pdf": {
"anyOf": [
{
"$ref": "#/$defs/NormalPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The normal probability distribution function"
},
"uniform_pdf": {
"anyOf": [
{
"$ref": "#/$defs/UniformPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The uniform probability distribution function"
}
},
"title": "Uncertainty",
"type": "object"
},
"UncertaintyEffect": {
"description": "Effect type for uncertainty specification.",
"enum": [
"additive",
"multiplicative",
"percentage",
"absolute"
],
"title": "UncertaintyEffect",
"type": "string"
},
"UniformPDF": {
"description": "Uniform probability distribution function.",
"properties": {
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
}
},
"title": "UniformPDF",
"type": "object"
},
"VariableDef": {
"description": "Definition of a variable.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the variable",
"title": "Name"
},
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this variable",
"title": "Var Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the variable",
"title": "Units"
},
"axis_system": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The axis system for the variable",
"title": "Axis System"
},
"sign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The sign convention for the variable",
"title": "Sign"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An alias for the variable",
"title": "Alias"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A symbol representing the variable",
"title": "Symbol"
},
"initial_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The initial value of the variable",
"title": "Initial Value"
},
"min_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The minimum allowed value of the variable",
"title": "Min Value"
},
"max_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The maximum allowed value of the variable",
"title": "Max Value"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the variable"
},
"calculation": {
"anyOf": [
{
"$ref": "#/$defs/Calculation"
},
{
"type": "null"
}
],
"default": null,
"description": "The calculation for deriving the variable's value"
},
"is_input": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an input",
"title": "Is Input"
},
"is_control": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a control parameter",
"title": "Is Control"
},
"is_disturbance": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a disturbance input",
"title": "Is Disturbance"
},
"is_state": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state variable",
"title": "Is State"
},
"is_state_deriv": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state derivative",
"title": "Is State Deriv"
},
"is_output": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an output",
"title": "Is Output"
},
"is_std_aiaa": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a standard AIAA variable",
"title": "Is Std Aiaa"
},
"uncertainty": {
"anyOf": [
{
"$ref": "#/$defs/Uncertainty"
},
{
"type": "null"
}
],
"default": null,
"description": "The uncertainty associated with the variable"
}
},
"title": "VariableDef",
"type": "object"
},
"VariableRef": {
"description": "Reference to a variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
}
},
"title": "VariableRef",
"type": "object"
}
},
"$ref": "#/$defs/UniformPDF"
}
Fields:
pydantic-model
¤
Bases: BaseModel
Definition of a variable.
Show JSON schema:
{
"$defs": {
"Bounds": {
"description": "Statistical limits of a parameter.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/DataTable"
},
{
"$ref": "#/$defs/VariableDef"
},
{
"$ref": "#/$defs/VariableRef"
},
{
"type": "null"
}
],
"default": null,
"description": "The bound value or reference",
"title": "Value"
}
},
"title": "Bounds",
"type": "object"
},
"Calculation": {
"description": "Calculation using MathML content markup.",
"properties": {
"math": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The MathML content markup describing the calculation",
"title": "Math"
}
},
"title": "Calculation",
"type": "object"
},
"CorrelatesWith": {
"description": "Indicates correlation with another variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
}
},
"title": "CorrelatesWith",
"type": "object"
},
"Correlation": {
"description": "Correlation between variables.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the correlated variable",
"title": "Var Id"
},
"corr_coef": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The correlation coefficient",
"title": "Corr Coef"
}
},
"title": "Correlation",
"type": "object"
},
"DataTable": {
"description": "Data of a gridded table as whitespace- or comma-separated values.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The table data as a string of comma- or whitespace-separated values",
"title": "Value"
}
},
"title": "DataTable",
"type": "object"
},
"Description": {
"description": "Textual description of an entity.",
"properties": {
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The description text",
"title": "Value"
}
},
"title": "Description",
"type": "object"
},
"NormalPDF": {
"description": "Normal probability distribution function.",
"properties": {
"num_sigmas": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The number of standard deviations",
"title": "Num Sigmas"
},
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
},
"correlates_with": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/CorrelatesWith"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlations with other variables",
"title": "Correlates With"
},
"correlation": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Correlation"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Correlation coefficients",
"title": "Correlation"
}
},
"title": "NormalPDF",
"type": "object"
},
"Uncertainty": {
"description": "Uncertainty of a function or parameter value.",
"properties": {
"effect": {
"anyOf": [
{
"$ref": "#/$defs/UncertaintyEffect"
},
{
"type": "null"
}
],
"default": null,
"description": "The effect of the uncertainty"
},
"normal_pdf": {
"anyOf": [
{
"$ref": "#/$defs/NormalPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The normal probability distribution function"
},
"uniform_pdf": {
"anyOf": [
{
"$ref": "#/$defs/UniformPDF"
},
{
"type": "null"
}
],
"default": null,
"description": "The uniform probability distribution function"
}
},
"title": "Uncertainty",
"type": "object"
},
"UncertaintyEffect": {
"description": "Effect type for uncertainty specification.",
"enum": [
"additive",
"multiplicative",
"percentage",
"absolute"
],
"title": "UncertaintyEffect",
"type": "string"
},
"UniformPDF": {
"description": "Uniform probability distribution function.",
"properties": {
"bounds": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/Bounds"
},
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "The bounds of the distribution",
"title": "Bounds"
}
},
"title": "UniformPDF",
"type": "object"
},
"VariableDef": {
"description": "Definition of a variable.",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The name of the variable",
"title": "Name"
},
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The unique identifier for this variable",
"title": "Var Id"
},
"units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The units of measure for the variable",
"title": "Units"
},
"axis_system": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The axis system for the variable",
"title": "Axis System"
},
"sign": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The sign convention for the variable",
"title": "Sign"
},
"alias": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "An alias for the variable",
"title": "Alias"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A symbol representing the variable",
"title": "Symbol"
},
"initial_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The initial value of the variable",
"title": "Initial Value"
},
"min_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The minimum allowed value of the variable",
"title": "Min Value"
},
"max_value": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "The maximum allowed value of the variable",
"title": "Max Value"
},
"description": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
],
"default": null,
"description": "A description of the variable"
},
"calculation": {
"anyOf": [
{
"$ref": "#/$defs/Calculation"
},
{
"type": "null"
}
],
"default": null,
"description": "The calculation for deriving the variable's value"
},
"is_input": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an input",
"title": "Is Input"
},
"is_control": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a control parameter",
"title": "Is Control"
},
"is_disturbance": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a disturbance input",
"title": "Is Disturbance"
},
"is_state": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state variable",
"title": "Is State"
},
"is_state_deriv": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a state derivative",
"title": "Is State Deriv"
},
"is_output": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is an output",
"title": "Is Output"
},
"is_std_aiaa": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "Indicates if the variable is a standard AIAA variable",
"title": "Is Std Aiaa"
},
"uncertainty": {
"anyOf": [
{
"$ref": "#/$defs/Uncertainty"
},
{
"type": "null"
}
],
"default": null,
"description": "The uncertainty associated with the variable"
}
},
"title": "VariableDef",
"type": "object"
},
"VariableRef": {
"description": "Reference to a variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
}
},
"title": "VariableRef",
"type": "object"
}
},
"$ref": "#/$defs/VariableDef"
}
Fields:
-
name(Optional[str]) -
var_id(Optional[str]) -
units(Optional[str]) -
axis_system(Optional[str]) -
sign(Optional[str]) -
alias(Optional[str]) -
symbol(Optional[str]) -
initial_value(Optional[float]) -
min_value(Optional[float]) -
max_value(Optional[float]) -
description(Optional[Description]) -
calculation(Optional[Calculation]) -
is_input(Optional[bool]) -
is_control(Optional[bool]) -
is_disturbance(Optional[bool]) -
is_state(Optional[bool]) -
is_state_deriv(Optional[bool]) -
is_output(Optional[bool]) -
is_std_aiaa(Optional[bool]) -
uncertainty(Optional[Uncertainty])
pydantic-field
¤
calculation: Optional[Calculation] = None
The calculation for deriving the variable's value
pydantic-field
¤
description: Optional[Description] = None
A description of the variable
pydantic-field
¤
The initial value of the variable
pydantic-field
¤
Indicates if the variable is a control parameter
pydantic-field
¤
Indicates if the variable is a disturbance input
pydantic-field
¤
Indicates if the variable is a state variable
pydantic-field
¤
Indicates if the variable is a state derivative
pydantic-field
¤
Indicates if the variable is a standard AIAA variable
pydantic-field
¤
The maximum allowed value of the variable
pydantic-field
¤
The minimum allowed value of the variable
pydantic-field
¤
uncertainty: Optional[Uncertainty] = None
The uncertainty associated with the variable
pydantic-model
¤
Bases: BaseModel
Reference to a variable.
Show JSON schema:
{
"description": "Reference to a variable.",
"properties": {
"var_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "The ID of the referenced variable",
"title": "Var Id"
}
},
"title": "VariableRef",
"type": "object"
}
Fields: