LifeCycle Types#

Module containing types for the Lifecycle Service.

Constants#

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

Properties of a harmonic vibe profile CSV file.

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

frequency_column: str#: Name of the column containing frequency values.

frequency_units: str#: Units of the frequency values

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

load_column: str#: Name of the column containing load values.

load_units: str#: Units of the load values.

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 optional_str_validation(value, info)#: Allow the test_point_ids to not be set, i.e., None.

profile_name: str#: Name of the harmonic vibe profile.

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

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

Properties of a random vibe profile CSV file.

amplitude_column: str#: Name of the column containing amplitude values.

amplitude_units: str#: Units of the amplitude values.

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

frequency_column: str#: Name of the column containing frequency values.

frequency_units: str#: Units of the frequency values

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 optional_str_validation(value, info)#: Allow the test_point_ids to not be set, i.e., None.

profile_name: str#: Name of the random vibe profile.

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

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

Properties of a shock event profile using dataset CSV 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.

load_column: str#: Name of the column containing load values.

load_units: str#: Units of the load values.

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 optional_str_validation(value, info)#: Allow the test_point_ids to not be set, i.e., None.

profile_name: str#: Name of the shock vibe profile.

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

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

time_units: str#: Units of the timeuency values

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

Properties of a shock event profile using pulses CSV file.

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

decay_column: str#: Name of the column containing decay values.

duration: float#: Pulse duration length

duration_units: str#: Time units of the pulse duration

frequency_column: str#: Name of the column containing frequency values.

frequency_units: str#: Units of the frequency values

classmethod greater_than_zero_float_validation(value, info)#: Validate float fields listed contain values greater than 0.

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

load_column: str#: Name of the column containing load values.

load_units: str#: Units of the load values.

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 optional_str_validation(value, info)#: Allow the test_point_ids to not be set, i.e., None.

profile_name: str#: Name of the shock vibe profile.

sample_rate: float#: Sample rate

sample_rate_units: str#: Time units of the sample rate

shape_column: str#: Name of the column containing shape values.

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

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

Properties of a thermal profile CSV 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 optional_str_validation(value, info)#: Allow the test_point_ids to not be set, i.e., None.

profile_name: str#: Name of the thermal profile.

step_column: str#: Name of the column containing step 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 duration values.

time_units: str#: Units of the time values.

type_column: str#: Name of the column containing step type values.

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.

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_dwell_bins: int#: Number of dwell bins for binning cycles, 0 for no dwell binning.

number_of_mean_bins: int#: Number of mean bins for binning cycles, 0 for no mean binning.

number_of_range_bins: int#: Number of range bins for binning cycles, 0 for no range 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.

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

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

time_filtering_limit: float#: Maximum cycle time to include in results, default is 72 hours.

time_filtering_limit_units: str#: Units of the time filtering limit.

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

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

Request for updating an existing life phase in a specified project’s life cycle.

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

new_cycle_type: Optional[str]#: (Optional) Updated cycle type. Acceptable values are COUNT, DUTY_CYCLE, PER YEAR, PER DAY, PER HOUR, PER MIN, and PER SEC.

new_description: Optional[str]#: (Optional) Updated description of life phase.

new_duration: Optional[float]#: (Optional) Updated event duration length.

new_duration_units: Optional[str]#: (Optional) Updated event duration units.

new_num_of_cycles: Optional[float]#: (Optional) Updated number of cycles defined for the life phase.

new_phase_name: Optional[str]#: (Optional) Updated name of life phase.

classmethod optional_str_validation(value, info)#: Allow the optional fields to not be set, i.e., None.

phase_name: str#: Name of the life cycle phase to be updated.

project: str#: Sherlock project name.

result_archive_file_name: Optional[str]#: (Optional) Filename for saving analysis results and life cycle data, including any sub-assembly results. Any existing results will be overwritten. If this file name is omitted, then analysis results will not be saved during the update.

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