sgr_commhandler.api.functional_profile_api
Attributes
Defines a generic functional profile data type. |
Classes
Implements a functional profile. |
Module Contents
- sgr_commhandler.api.functional_profile_api.TFpSpec
Defines a generic functional profile data type.
- class sgr_commhandler.api.functional_profile_api.FunctionalProfile(fp_spec)
Bases:
Generic[TFpSpec]Implements a functional profile.
- Parameters:
fp_spec (TFpSpec)
- _fp_spec: TFpSpec
- name()
Gets the functional profile name.
- Returns:
the functional profile name
- Return type:
str
- get_data_points()
Gets all data points.
- Returns:
all data points
- Return type:
dict[tuple[str, str], DataPoint]
- get_data_point(dp_name)
Gets a data point.
- Parameters:
dp_name (str) – the data point name
- Returns:
a data point
- Return type:
- async get_values_async(parameters=None)
Gets all data point values of the functional profile asynchronously.
- Returns:
all data point values by name
- Return type:
dict[str, Any]
- Parameters:
parameters (Optional[dict[str, str]])
- describe()
Describes the functional profile.
- Returns:
the functional profile information
- Return type:
tuple[str, dict[str, tuple[DataDirectionProduct, DataTypes]]]
- get_specification()
Gets the functional profile specification.
- Returns:
the functional profile specification
- Return type:
TFpSpec