tsdat.config.dimension_definition

Module Contents

Classes

DimKeys

Class that provides a handle for keys in the Dimensions section fo the

DimensionDefinition

Class to represent dimensions defined in the pipeline config file.
class tsdat.config.dimension_definition.DimKeys

Class that provides a handle for keys in the Dimensions section fo the dataset_definition

LENGTH = length
class tsdat.config.dimension_definition.DimensionDefinition(name: str, length: Union[str, int])

Class to represent dimensions defined in the pipeline config file.

Parameters

  • name (str) – The name of the dimension

  • length (Union[str, int]) – The length of the dimension. This should be one of: "unlimited", "variable", or a positive int. The ‘time’ dimension should always have length of "unlimited".

is_unlimited(self) → bool

Returns True is the dimension has unlimited length. Represented by setting the length attribute to "unlimited".

Returns

True if the dimension has unlimited length.

Return type

bool

is_variable_length(self) → bool

Returns True if the dimension has variable length, meaning that the dimension’s length is set at runtime. Represented by setting the length to "variable".

Returns

True if the dimension has variable length, False otherwise.

Return type

bool