ChainStrandAnalysisOpts#

class ansys.stk.core.stkobjects.ChainStrandAnalysisOpts#

Class defining Chain strand analysis options.

Overview#

calc_scalar_file_name

Strand analysis AWB calculation scalar file (.awb) to evaluate to determine strand analytics.

calc_scalar_name

Strand analysis AWB calculation scalar to evaluate to determine strand analytics.

calc_scalar_type

Strand analysis AWB calculation scalar type used when the strand analysis type is set to use a calculation scalar.

compute

Compute strands analytics.

compute_type

Strand analysis type.

include_access_edge_times_in_samples

Include all chain connection access pairs when computing sample times for strand analytics.

link_comparison_type

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

num_strands_to_store

Maximum number of objects in all strands for the Chain.

sampling_time_step

Time step used to sample strand metric when computing strand analytics.

strand_comparison_type

Strand analysis comparison type (min or max) used when comparing strands.

type

Strand analysis type.

Import detail#

from ansys.stk.core.stkobjects import ChainStrandAnalysisOpts

Property detail#

property ChainStrandAnalysisOpts.calc_scalar_file_name: str#

Strand analysis AWB calculation scalar file (.awb) to evaluate to determine strand analytics.

property ChainStrandAnalysisOpts.calc_scalar_name: str#

Strand analysis AWB calculation scalar to evaluate to determine strand analytics.

property ChainStrandAnalysisOpts.calc_scalar_type: ChainOptimalStrandCalculationScalarMetricType#

Strand analysis AWB calculation scalar type used when the strand analysis type is set to use a calculation scalar.

property ChainStrandAnalysisOpts.compute: bool#

Compute strands analytics.

property ChainStrandAnalysisOpts.compute_type: ChainStrandAnalysisComputeType#

Strand analysis type.

property ChainStrandAnalysisOpts.include_access_edge_times_in_samples: bool#

Include all chain connection access pairs when computing sample times for strand analytics.

Strand analysis 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 ChainStrandAnalysisOpts.num_strands_to_store: int#

Maximum number of objects in all strands for the Chain.

property ChainStrandAnalysisOpts.sampling_time_step: float#

Time step used to sample strand metric when computing strand analytics.

property ChainStrandAnalysisOpts.strand_comparison_type: ChainOptimalStrandCompareStrandsType#

Strand analysis comparison type (min or max) used when comparing strands.

property ChainStrandAnalysisOpts.type: ChainOptimalStrandMetricType#

Strand analysis type.