LifeCycle Types#

Module containing types for the Lifecycle Service.

Constants#

class ansys.sherlock.core.types.lifecycle_types.ThermalSignalFileProperties(**data)#

Properties of a thermal signal file.

column_delimiter: str#: Delimiter used to separate columns in the file.

header_row_count: int#: Number of rows before the column header in the file.

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod non_negative_int_validation(value, info)#: Validate integer fields listed contain non-negative values.

numeric_format: str#: Numeric format for the values.

classmethod str_validation(value, info)#: Validate string fields listed.

temperature_column: str#: Name of the column containing temperature values.

temperature_units: str#: Units of the temperature values.

time_column: str#: Name of the column containing time values.

time_units: str#: Units of the time values.

class ansys.sherlock.core.types.lifecycle_types.ImportThermalSignalRequest(**data)#

Request to import a thermal signal file.

file_name: str#: The full path to the CSV thermal signal file to be imported.

filtering_limit: float#: Minimum cycle range to include in results, 0 for not filtering

generated_cycles_label: str#: Label used to define the name of all generated thermal events.

load_range_percentage: float#: Defines the fraction of the range near peaks and valleys considered as a dwell region

model_config: ClassVar[ConfigDict] = {}#: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod non_negative_int_validation(value, info)#: Validate integer fields listed contain non-negative values.

number_of_bins: int#: Number of bins for binning cycles, 0 for no binning

phase_name: str#: Name of the phase in which the thermal signal is imported.

project: str#: Sherlock project name in which the thermal signal is imported.

classmethod str_validation(value, info)#: Validate string fields listed.

thermal_signal_file_properties: ThermalSignalFileProperties#: Properties of the thermal signal file.

time_removal: bool#: Option to indicate that time results with shorter half-cycle durations are removed.