Basic setting types

Although organized hierarchically into dictionary-like structures, all System Coupling settings are ultimately instances of basic Python built-in types or are simple containers of such types.

The basic types are:

• String (str)

• Integer (int)

• Real (float)

• Boolean (bool)

System Coupling supports expressions for real valued settings, and these are specified as strings. Therefore a Python type hint RealType is defined in the API to allow this option to be expressed.

Similarly, type hints are defined for the derived list types.

These additional type hint definitions are documented in the following sections.

RealType

Union[float, str] - the underlying data model type is float but an expression string may also be assigned.

StringListType

List[str] - list of str values.

IntegerListType

List[int] - list of int values.

RealListType

List[RealType] - list of RealType values.

RealVectorType

Tuple[RealType, RealType, RealType] - 3-tuple of RealType values. Holds a real 3D vector or coordinate value.

BoolListType

List[bool] - list of bool values.