CommSystemAccessEventDetectionSubsample#

class ansys.stk.core.stkobjects.CommSystemAccessEventDetectionSubsample#

Bases: ICommSystemAccessEventDetection

Class defining a CommSystem access options.

Overview#

time_convergence

Get or set the time convergence value for Access. Uses Time Dimension.

absolute_tolerance

Get or set the criterion used for convergence in value for values near 0. An event is said to be detected when a constraint value’s difference compared to the previous sample is within this tolerance: (value - previousValue) < absoluteTolerance.

relative_tolerance

An event is said to be detected when a constraint value’s relative difference compared to the previous sample is within this tolerance: (value - previousValue) / value < relativeTolerance.

Import detail#

from ansys.stk.core.stkobjects import CommSystemAccessEventDetectionSubsample

Property detail#

property CommSystemAccessEventDetectionSubsample.time_convergence: float#

Get or set the time convergence value for Access. Uses Time Dimension.

property CommSystemAccessEventDetectionSubsample.absolute_tolerance: float#

Get or set the criterion used for convergence in value for values near 0. An event is said to be detected when a constraint value’s difference compared to the previous sample is within this tolerance: (value - previousValue) < absoluteTolerance.

property CommSystemAccessEventDetectionSubsample.relative_tolerance: float#

An event is said to be detected when a constraint value’s relative difference compared to the previous sample is within this tolerance: (value - previousValue) / value < relativeTolerance.