_BaseTimeVaringInfo

Doc:

short class_name: _BaseTimeVaringInfo

full class_name : oceantracker.time_varying_info._base_time_varying_info._BaseTimeVaringInfo

Inheritance: > ParameterBaseClass> _BaseTimeVaringInfo

Parameters:

  • class_name<class 'str'> <optional>

    Description: Class name as string A.B.C, used to import this class from python path

    • default: None

    • data_type: <class 'str'>

  • description<class 'str'> <optional>
    • default: None

    • data_type: <class 'str'>

  • dtype<class 'str'> <optional>
    • default: float64

    • data_type: <class 'str'>

    • possible_values: ['float64', 'float32', 'bool', 'int32', 'int16', 'int8', 'int64']

  • initial_value<class 'float'> <optional>
    • default: 0.0

    • data_type: <class 'float'>

  • name<class 'str'> <optional>

    Description: Name used to refer to class in code and output, = None for core claseses

    • default: None

    • data_type: <class 'str'>

  • prop_dim3<class 'int'> <optional>
    • default: 1

    • data_type: <class 'int'>

    • min: 1

  • units<class 'str'> <optional>
    • default: None

    • data_type: <class 'str'>

  • update<class 'bool'> <optional>
    • default: True

    • data_type: <class 'bool'>

    • possible_values: [True, False]

  • user_note<class 'str'> <optional>
    • default: None

    • data_type: <class 'str'>

  • vector_dim<class 'int'> <optional>
    • default: 1

    • data_type: <class 'int'>

    • min: 1

  • write<class 'bool'> <optional>
    • default: True

    • data_type: <class 'bool'>

    • possible_values: [True, False]

Expert Parameters: