ChainOptimalStrandOpts
======================

.. py:class:: ansys.stk.core.stkobjects.ChainOptimalStrandOpts

   Class defining Chain optimal strand options.

.. py:currentmodule:: ChainOptimalStrandOpts

Overview
--------

.. tab-set::

    .. tab-item:: Properties

        .. list-table::
            :header-rows: 0
            :widths: auto

            * - :py:attr:`~ansys.stk.core.stkobjects.ChainOptimalStrandOpts.compute`
              - Compute optimal strands.
            * - :py:attr:`~ansys.stk.core.stkobjects.ChainOptimalStrandOpts.sampling_time_step`
              - Time step used to sample optimal strand metric when computing optimal strands.
            * - :py:attr:`~ansys.stk.core.stkobjects.ChainOptimalStrandOpts.include_access_edge_times_in_samples`
              - Include all chain connection access pairs when computing sample times for optimal strands.
            * - :py:attr:`~ansys.stk.core.stkobjects.ChainOptimalStrandOpts.num_strands_to_store`
              - Maximum number of objects in all strands for the Chain.
            * - :py:attr:`~ansys.stk.core.stkobjects.ChainOptimalStrandOpts.type`
              - Optimal path type.
            * - :py:attr:`~ansys.stk.core.stkobjects.ChainOptimalStrandOpts.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.
            * - :py:attr:`~ansys.stk.core.stkobjects.ChainOptimalStrandOpts.strand_comparison_type`
              - Optimal path comparison type (min or max) used when comparing strands.
            * - :py:attr:`~ansys.stk.core.stkobjects.ChainOptimalStrandOpts.calc_scalar_type`
              - Optimal path AWB calculation scalar type used when the optiml path type is set to use a calculation scalar.
            * - :py:attr:`~ansys.stk.core.stkobjects.ChainOptimalStrandOpts.calc_scalar_name`
              - Optimal path AWB calculation scalar to evaluate to determine optimal strands.
            * - :py:attr:`~ansys.stk.core.stkobjects.ChainOptimalStrandOpts.calc_scalar_file_name`
              - Optimal path AWB calculation scalar file (.awb) to evaluate to determine optimal strands.



Import detail
-------------

.. code-block:: python

    from ansys.stk.core.stkobjects import ChainOptimalStrandOpts


Property detail
---------------

.. py:property:: compute
    :canonical: ansys.stk.core.stkobjects.ChainOptimalStrandOpts.compute
    :type: bool

    Compute optimal strands.

.. py:property:: sampling_time_step
    :canonical: ansys.stk.core.stkobjects.ChainOptimalStrandOpts.sampling_time_step
    :type: float

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

.. py:property:: include_access_edge_times_in_samples
    :canonical: ansys.stk.core.stkobjects.ChainOptimalStrandOpts.include_access_edge_times_in_samples
    :type: bool

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

.. py:property:: num_strands_to_store
    :canonical: ansys.stk.core.stkobjects.ChainOptimalStrandOpts.num_strands_to_store
    :type: int

    Maximum number of objects in all strands for the Chain.

.. py:property:: type
    :canonical: ansys.stk.core.stkobjects.ChainOptimalStrandOpts.type
    :type: ChainOptimalStrandMetricType

    Optimal path type.

.. py:property:: link_comparison_type
    :canonical: ansys.stk.core.stkobjects.ChainOptimalStrandOpts.link_comparison_type
    :type: ChainOptimalStrandLinkCompareType

    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.

.. py:property:: strand_comparison_type
    :canonical: ansys.stk.core.stkobjects.ChainOptimalStrandOpts.strand_comparison_type
    :type: ChainOptimalStrandCompareStrandsType

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

.. py:property:: calc_scalar_type
    :canonical: ansys.stk.core.stkobjects.ChainOptimalStrandOpts.calc_scalar_type
    :type: ChainOptimalStrandCalculationScalarMetricType

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

.. py:property:: calc_scalar_name
    :canonical: ansys.stk.core.stkobjects.ChainOptimalStrandOpts.calc_scalar_name
    :type: str

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

.. py:property:: calc_scalar_file_name
    :canonical: ansys.stk.core.stkobjects.ChainOptimalStrandOpts.calc_scalar_file_name
    :type: str

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