ChainOptimalStrandOpts#

class ansys.stk.core.stkobjects.ChainOptimalStrandOpts#

Class defining Chain optimal strand options.

Overview#

compute

Compute optimal strands.

sampling_time_step

Time step used to sample optimal strand metric when computing optimal strands.

include_access_edge_times_in_samples

Include all chain connection access pairs when computing sample times for optimal strands.

num_strands_to_store

Maximum number of objects in all strands for the Chain.

type

Optimal path type.

link_comparison_type

Optimal path comparison type (min, max or sum) used when comparing connections of a strand when computing an overall value of the metric for a strand.

strand_comparison_type

Optimal path comparison type (min or max) used when comparing strands.

calc_scalar_type

Optimal path AWB calculation scalar type used when the optiml path type is set to use a calculation scalar.

calc_scalar_name

Optimal path AWB calculation scalar to evaluate to determine optimal strands.

calc_scalar_file_name

Optimal path AWB calculation scalar file (.awb) to evaluate to determine optimal strands.

Import detail#

from ansys.stk.core.stkobjects import ChainOptimalStrandOpts

Property detail#

property ChainOptimalStrandOpts.compute: bool#

Compute optimal strands.

property ChainOptimalStrandOpts.sampling_time_step: float#

Time step used to sample optimal strand metric when computing optimal strands.

property ChainOptimalStrandOpts.include_access_edge_times_in_samples: bool#

Include all chain connection access pairs when computing sample times for optimal strands.

property ChainOptimalStrandOpts.num_strands_to_store: int#

Maximum number of objects in all strands for the Chain.

property ChainOptimalStrandOpts.type: ChainOptimalStrandMetricType#

Optimal path type.

Optimal path comparison type (min, max or sum) used when comparing connections of a strand when computing an overall value of the metric for a strand.

property ChainOptimalStrandOpts.strand_comparison_type: ChainOptimalStrandCompareStrandsType#

Optimal path comparison type (min or max) used when comparing strands.

property ChainOptimalStrandOpts.calc_scalar_type: ChainOptimalStrandCalculationScalarMetricType#

Optimal path AWB calculation scalar type used when the optiml path type is set to use a calculation scalar.

property ChainOptimalStrandOpts.calc_scalar_name: str#

Optimal path AWB calculation scalar to evaluate to determine optimal strands.

property ChainOptimalStrandOpts.calc_scalar_file_name: str#

Optimal path AWB calculation scalar file (.awb) to evaluate to determine optimal strands.