diff --git a/.github/workflows/ci_cd_night.yml b/.github/workflows/ci_cd_night.yml
index 5d5d818d45..1753858a0e 100644
--- a/.github/workflows/ci_cd_night.yml
+++ b/.github/workflows/ci_cd_night.yml
@@ -31,7 +31,7 @@ env:
MINIMUM_PYTHON_VERSION: '3.10'
PYSTK_DIR: '/home/stk/pystk'
QUARTO_VERSION: '1.5.55'
- STK_DOCKER_IMAGE: 'ansys/stk-12.10:dev-ubuntu22.04'
+ STK_DOCKER_IMAGE: 'ansys/stk-13.0:dev-ubuntu22.04'
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
@@ -69,7 +69,7 @@ jobs:
doc-build:
name: "Doc build"
runs-on: [self-hosted, pystk]
- timeout-minutes: 90
+ timeout-minutes: 360
needs: build-wheelhouse
permissions:
contents: read
diff --git a/.github/workflows/ci_cd_pr.yml b/.github/workflows/ci_cd_pr.yml
index b13e88be57..b6aeaca280 100644
--- a/.github/workflows/ci_cd_pr.yml
+++ b/.github/workflows/ci_cd_pr.yml
@@ -11,7 +11,7 @@ env:
MINIMUM_PYTHON_VERSION: '3.10'
PYSTK_DIR: '/home/stk/pystk'
QUARTO_VERSION: '1.5.55'
- STK_DOCKER_IMAGE: 'ansys/stk-12.10:dev-ubuntu22.04'
+ STK_DOCKER_IMAGE: 'ansys/stk-13.0:dev-ubuntu22.04'
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
@@ -37,6 +37,7 @@ jobs:
- name: "Checkout repository"
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
+ clean: true
persist-credentials: false
- name: "Update labels"
@@ -121,6 +122,7 @@ jobs:
- name: "Checkout project"
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
+ clean: true
persist-credentials: false
- name: "Install jq"
@@ -194,7 +196,7 @@ jobs:
runner: [self-hosted, pystk]
- needs-self-hosted-runner: true
runner: ubuntu-latest
- timeout-minutes: 90
+ timeout-minutes: 360
permissions:
contents: read
steps:
@@ -202,6 +204,7 @@ jobs:
- name: "Checkout the project"
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
+ clean: true
persist-credentials: false
- name: "Install Python ${{ env.MAIN_PYTHON_VERSION }}"
@@ -304,7 +307,7 @@ jobs:
docker exec \
--workdir ${PYSTK_DIR} \
"${STK_CONTAINER}" /bin/bash -c \
- "export BUILD_API=false BUILD_EXAMPLES=true && tox -e doc-links,doc-html"
+ "export BUILD_API=false BUILD_EXAMPLES=true && tox -e doc-clean,doc-links,doc-html"
- name: "Build docs including the 'API' section"
id: build-doc-with-api
@@ -312,7 +315,7 @@ jobs:
contains(github.event.pull_request.labels.*.name, 'docs:api') &&
!contains(github.event.pull_request.labels.*.name, 'docs:examples')
run: |
- python -m tox -e doc-links,doc-html
+ python -m tox -e doc-clean,doc-links,doc-html
env:
BUILD_API: true
BUILD_EXAMPLES: false
@@ -322,7 +325,7 @@ jobs:
!contains(github.event.pull_request.labels.*.name, 'docs:examples') &&
!contains(github.event.pull_request.labels.*.name, 'docs:api')
run: |
- python -m tox -e doc-links,doc-html
+ python -m tox -e doc-clean,doc-links,doc-html
env:
BUILD_API: false
BUILD_EXAMPLES: false
@@ -338,7 +341,7 @@ jobs:
docker exec \
--workdir ${PYSTK_DIR} \
"${STK_CONTAINER}" /bin/bash -c \
- "export BUILD_API=true BUILD_EXAMPLES=true && tox -e doc-links,doc-html"
+ "export BUILD_API=true BUILD_EXAMPLES=true && tox -e doc-clean,doc-links,doc-html"
# If required, combine partially rendered documentation with the nightly
# build artifacts. Upload the generated documentation as an artifact in
@@ -416,6 +419,7 @@ jobs:
- name: "Checkout the project"
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
+ clean: true
persist-credentials: false
- name: "Generate the name of the Docker image and the container"
@@ -458,8 +462,6 @@ jobs:
"${STK_CONTAINER}" /bin/bash -c \
"python -m pip install --group tests ."
- # -- Tests
-
- name: "Run the extensions tests"
env:
STK_CONTAINER: ${{ steps.docker.outputs.container }}
diff --git a/.github/workflows/ci_cd_release.yml b/.github/workflows/ci_cd_release.yml
index 4f69f3c273..1de776f7cf 100644
--- a/.github/workflows/ci_cd_release.yml
+++ b/.github/workflows/ci_cd_release.yml
@@ -12,7 +12,7 @@ env:
MINIMUM_PYTHON_VERSION: '3.10'
PYSTK_DIR: '/home/stk/pystk'
QUARTO_VERSION: '1.5.55'
- STK_DOCKER_IMAGE: 'ansys/stk-12.10:dev-ubuntu22.04'
+ STK_DOCKER_IMAGE: 'ansys/stk-13.0:dev-ubuntu22.04'
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
@@ -116,7 +116,7 @@ jobs:
name: "Doc build"
runs-on: [self-hosted, pystk]
needs: build-wheelhouse
- timeout-minutes: 90
+ timeout-minutes: 360
permissions:
contents: read
steps:
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 95c1fc0797..ca3492212d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -72,11 +72,12 @@ Use the following commands to build the images for your target distribution:
~$ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
- ansys/stk-12.10 dev-ubuntu22.04-python3.13 5a6ca2ffecae 4 hours ago 4.04GB
- ansys/stk-12.10 dev-ubuntu22.04-python3.12 94bafab28a80 4 hours ago 4.03GB
- ansys/stk-12.10 dev-ubuntu22.04-python3.11 97bdccd1c2a6 4 hours ago 4.03GB
- ansys/stk-12.10 dev-ubuntu22.04-pybase c9fb6e9502df 5 hours ago 4.21GB
- ansys/stk-12.10 dev-ubuntu22.04 1e26759936b1 5 hours ago 3.42GB
+ ansys/stk-13.0 dev-ubuntu22.04-python3.13 9eea14569958 14 minutes ago 5.33GB
+ ansys/stk-13.0 dev-ubuntu22.04-python3.12 edee06182a7a 15 minutes ago 5.32GB
+ ansys/stk-13.0 dev-ubuntu22.04-python3.11 205043fd378b 16 minutes ago 5.32GB
+ ansys/stk-13.0 dev-ubuntu22.04-python3.10 c4ec5d4bd662 22 minutes ago 5.21GB
+ ansys/stk-13.0 dev-ubuntu22.04-pybase 3e620a3bbaad 25 minutes ago 5.5GB
+ ansys/stk-13.0 dev-ubuntu22.04 d57b49b927df 30 minutes ago 4.71GB
```
- **Windows**
diff --git a/doc/source/api/ansys/stk/core/analysis_workbench/AnalysisWorkbenchComponentProvider.rst b/doc/source/api/ansys/stk/core/analysis_workbench/AnalysisWorkbenchComponentProvider.rst
index 4864f82d21..dfa47bc3ab 100644
--- a/doc/source/api/ansys/stk/core/analysis_workbench/AnalysisWorkbenchComponentProvider.rst
+++ b/doc/source/api/ansys/stk/core/analysis_workbench/AnalysisWorkbenchComponentProvider.rst
@@ -291,14 +291,14 @@ Create a new Custom Script Vector
customScript = VectFactory.create("Script", "Description", VectorType.CUSTOM_SCRIPT)
# Initialization script if needed
# customScript.InitializationScriptFile = ''
- trainingSamplesDir = r"C:\Program Files\AGI\STK 12\Data\Resources\stktraining\samples"
+ trainingSamplesDir = r"C:\Program Files\AGI\STK_ODTK 13\Data\Resources\stktraining\samples"
scriptFilePath = r"\Heliograph\Scripting\VectorTool\Vector\vector.vbs"
customScript.script_file = trainingSamplesDir + scriptFilePath
if customScript.is_valid is False:
print("Script component not valid!")
from os import getenv
- customScriptingDir = r"C:\Users\%s\Documents\STK 12\Config\Scripting\VectorTool" % getenv("USERNAME")
+ customScriptingDir = r"C:\Users\%s\Documents\STK_ODTK 13\Config\Scripting\VectorTool" % getenv("USERNAME")
print(r"Copy vbs file from " + trainingSamplesDir + scriptFilePath + r" to " + customScriptingDir)
diff --git a/doc/source/api/ansys/stk/core/analysis_workbench/SpatialAnalysisToolGridCoordinateDefinition.rst b/doc/source/api/ansys/stk/core/analysis_workbench/SpatialAnalysisToolGridCoordinateDefinition.rst
index b56f2ab255..d2cb957d7c 100644
--- a/doc/source/api/ansys/stk/core/analysis_workbench/SpatialAnalysisToolGridCoordinateDefinition.rst
+++ b/doc/source/api/ansys/stk/core/analysis_workbench/SpatialAnalysisToolGridCoordinateDefinition.rst
@@ -21,8 +21,6 @@ Overview
* - :py:attr:`~ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridCoordinateDefinition.set_custom`
- Set grid values type to custom values.
* - :py:attr:`~ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridCoordinateDefinition.set_grid_values_fixed_number_of_steps`
- - Do not use this method, as it is deprecated. Use SetGridValuesFixedNumberOfStepsEx.
- * - :py:attr:`~ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridCoordinateDefinition.set_fixed_number_of_steps`
- Set grid values type to fixed number of steps with min and max as Quantity.
* - :py:attr:`~ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridCoordinateDefinition.set_fixed_step`
- Set grid values type to fixed step.
@@ -83,27 +81,9 @@ Method detail
:obj:`~SpatialAnalysisToolGridValuesCustom`
-.. py:method:: set_grid_values_fixed_number_of_steps(self, min: float, max: float, num_steps: int) -> SpatialAnalysisToolGridValuesFixedNumberOfSteps
+.. py:method:: set_grid_values_fixed_number_of_steps(self, min: Quantity, max: Quantity, num_steps: int) -> SpatialAnalysisToolGridValuesFixedNumberOfSteps
:canonical: ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridCoordinateDefinition.set_grid_values_fixed_number_of_steps
- Do not use this method, as it is deprecated. Use SetGridValuesFixedNumberOfStepsEx.
-
- :Parameters:
-
- **min** : :obj:`~float`
-
- **max** : :obj:`~float`
-
- **num_steps** : :obj:`~int`
-
-
- :Returns:
-
- :obj:`~SpatialAnalysisToolGridValuesFixedNumberOfSteps`
-
-.. py:method:: set_fixed_number_of_steps(self, min: Quantity, max: Quantity, num_steps: int) -> SpatialAnalysisToolGridValuesFixedNumberOfSteps
- :canonical: ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridCoordinateDefinition.set_fixed_number_of_steps
-
Set grid values type to fixed number of steps with min and max as Quantity.
:Parameters:
diff --git a/doc/source/api/ansys/stk/core/analysis_workbench/SpatialAnalysisToolGridValuesFixedNumberOfSteps.rst b/doc/source/api/ansys/stk/core/analysis_workbench/SpatialAnalysisToolGridValuesFixedNumberOfSteps.rst
index 41e9a1cce8..09cb2f8574 100644
--- a/doc/source/api/ansys/stk/core/analysis_workbench/SpatialAnalysisToolGridValuesFixedNumberOfSteps.rst
+++ b/doc/source/api/ansys/stk/core/analysis_workbench/SpatialAnalysisToolGridValuesFixedNumberOfSteps.rst
@@ -20,12 +20,8 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridValuesFixedNumberOfSteps.max`
- - Do not use this property, as it is deprecated. Use MaxEx.
* - :py:attr:`~ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridValuesFixedNumberOfSteps.maximum`
- Maximum coordinate value as Quantity.
- * - :py:attr:`~ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridValuesFixedNumberOfSteps.min`
- - Do not use this property, as it is deprecated. Use MinEx.
* - :py:attr:`~ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridValuesFixedNumberOfSteps.minimum`
- Minimum coordinate value as Quantity.
* - :py:attr:`~ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridValuesFixedNumberOfSteps.number_of_steps`
@@ -44,24 +40,12 @@ Import detail
Property detail
---------------
-.. py:property:: max
- :canonical: ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridValuesFixedNumberOfSteps.max
- :type: float
-
- Do not use this property, as it is deprecated. Use MaxEx.
-
.. py:property:: maximum
:canonical: ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridValuesFixedNumberOfSteps.maximum
:type: Quantity
Maximum coordinate value as Quantity.
-.. py:property:: min
- :canonical: ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridValuesFixedNumberOfSteps.min
- :type: float
-
- Do not use this property, as it is deprecated. Use MinEx.
-
.. py:property:: minimum
:canonical: ansys.stk.core.analysis_workbench.SpatialAnalysisToolGridValuesFixedNumberOfSteps.minimum
:type: Quantity
diff --git a/doc/source/api/ansys/stk/core/analysis_workbench/TimeToolTimeArrayFiltered.rst b/doc/source/api/ansys/stk/core/analysis_workbench/TimeToolTimeArrayFiltered.rst
index c9ae5cd648..903221fec7 100644
--- a/doc/source/api/ansys/stk/core/analysis_workbench/TimeToolTimeArrayFiltered.rst
+++ b/doc/source/api/ansys/stk/core/analysis_workbench/TimeToolTimeArrayFiltered.rst
@@ -14,6 +14,19 @@ Overview
.. tab-set::
+ .. tab-item:: Methods
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.get_filter_interval_list_or_interval`
+ - Get the interval(s) used to filter samples (being either an Interval or an IntervalList) when FilterType is set to Skip Intervals.
+ * - :py:attr:`~ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.set_filter_interval`
+ - Set the interval used to filter samples when FilterType is set to Skip Intervals when using only one interval.
+ * - :py:attr:`~ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.set_filter_interval_list`
+ - Set the interval list used to filter samples when FilterType is set to Skip Intervals when using a set of intervals.
+
.. tab-item:: Properties
.. list-table::
@@ -22,8 +35,6 @@ Overview
* - :py:attr:`~ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.count`
- Specify the number of times skipped between accepted samples when FilterType is set to Skip Count...
- * - :py:attr:`~ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.filter_interval_list`
- - The interval list used to filter samples when FilterType is set to Skip Intervals.
* - :py:attr:`~ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.filter_type`
- Skip Time Steps filter type omits from filtered time array any times that fall within specified time step of last accepted time sample. Skip Count filter type omits specified number of time samples since last accepted time sample...
* - :py:attr:`~ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.include_interval_stop_times`
@@ -52,12 +63,6 @@ Property detail
Specify the number of times skipped between accepted samples when FilterType is set to Skip Count...
-.. py:property:: filter_interval_list
- :canonical: ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.filter_interval_list
- :type: ITimeToolTimeIntervalList
-
- The interval list used to filter samples when FilterType is set to Skip Intervals.
-
.. py:property:: filter_type
:canonical: ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.filter_type
:type: EventArrayFilterType
@@ -83,3 +88,53 @@ Property detail
The number of steps skipped between accepted samples when FilterType is set to Skip Time Steps.
+Method detail
+-------------
+
+
+
+
+
+.. py:method:: get_filter_interval_list_or_interval(self) -> IAnalysisWorkbenchComponent
+ :canonical: ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.get_filter_interval_list_or_interval
+
+ Get the interval(s) used to filter samples (being either an Interval or an IntervalList) when FilterType is set to Skip Intervals.
+
+ :Returns:
+
+ :obj:`~IAnalysisWorkbenchComponent`
+
+
+
+
+
+.. py:method:: set_filter_interval(self, intvl: ITimeToolTimeInterval) -> None
+ :canonical: ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.set_filter_interval
+
+ Set the interval used to filter samples when FilterType is set to Skip Intervals when using only one interval.
+
+ :Parameters:
+
+ **intvl** : :obj:`~ITimeToolTimeInterval`
+
+
+ :Returns:
+
+ :obj:`~None`
+
+.. py:method:: set_filter_interval_list(self, intvls: ITimeToolTimeIntervalList) -> None
+ :canonical: ansys.stk.core.analysis_workbench.TimeToolTimeArrayFiltered.set_filter_interval_list
+
+ Set the interval list used to filter samples when FilterType is set to Skip Intervals when using a set of intervals.
+
+ :Parameters:
+
+ **intvls** : :obj:`~ITimeToolTimeIntervalList`
+
+
+ :Returns:
+
+ :obj:`~None`
+
+
+
diff --git a/doc/source/api/ansys/stk/core/graphics.rst b/doc/source/api/ansys/stk/core/graphics.rst
index a8992ba15b..06cdec3c9b 100644
--- a/doc/source/api/ansys/stk/core/graphics.rst
+++ b/doc/source/api/ansys/stk/core/graphics.rst
@@ -189,6 +189,12 @@ Summary
* - :py:class:`~ansys.stk.core.graphics.CentralBodyGraphicsIndexer`
- An indexer into the central body graphics for a particular central body, which provides graphical properties such as showing or hiding the central body in the scene, and working with terrain and imagery for the specified central body.
+ * - :py:class:`~ansys.stk.core.graphics.CesiumIonTerrainOverlay`
+ - A terrain overlay for handling Cesium Ion Streaming Terrain.
+
+ * - :py:class:`~ansys.stk.core.graphics.CesiumIonTerrainOverlayFactory`
+ - A terrain overlay for handling Cesium Ion Streaming Terrain.
+
* - :py:class:`~ansys.stk.core.graphics.Clouds`
- Load, show and hide clouds in the scene.
@@ -427,10 +433,10 @@ Summary
- A collection containing a model primitive's available articulations. A model articulation identifies geometry on the model and is a collection of transformations that can be applied to that geometry.
* - :py:class:`~ansys.stk.core.graphics.ModelPrimitive`
- - The model primitive loads and renders `COLLADA `_ (DAE) and AGI `MDL `_ (MDL) models.
+ - The model primitive loads and renders `glTF 2.0 `_ (.gltf, .glb), `COLLADA `_ (DAE) and AGI `MDL `_ (MDL) models.
* - :py:class:`~ansys.stk.core.graphics.ModelPrimitiveFactory`
- - The model primitive loads and renders `COLLADA `_ (DAE) and AGI `MDL `_ (MDL) models.
+ - The model primitive loads and renders `glTF 2.0 `_ (.gltf, .glb), `COLLADA `_ (DAE) and AGI `MDL `_ (MDL) models.
* - :py:class:`~ansys.stk.core.graphics.ModelTransformation`
- A model transformation defines a transformation that is applied to geometry on a model primitive. That geometry is identified by the model articulation which contains the transformation...
@@ -765,7 +771,7 @@ Summary
- The method used to blur or smooth a raster.
* - :py:class:`~ansys.stk.core.graphics.ConstrainedUpAxis`
- - When setting the camera'saxes, this defines which axis of the axes is up in screen space, where up is from the bottom to the top of the screen.
+ - When setting the camera's axes, this defines which axis of the axes is up in screen space, where up is from the bottom to the top of the screen.
* - :py:class:`~ansys.stk.core.graphics.CylinderFillOptions`
- Cylinder faces that can be filled.
@@ -819,7 +825,7 @@ Summary
- Transformation types that define the way a model transformation changes the geometry of the model articulation it is associated with.
* - :py:class:`~ansys.stk.core.graphics.ModelUpAxis`
- - When setting the camera'saxes, this defines which axis of the axes is up in screen space, where up is from the bottom to the top of the screen.
+ - When setting the camera's axes, this defines which axis of the axes is up in screen space, where up is from the bottom to the top of the screen.
* - :py:class:`~ansys.stk.core.graphics.Origin`
- Vertical and horizontal origin.
@@ -840,7 +846,7 @@ Summary
- Describes how to interpret positions defining a polyline.
* - :py:class:`~ansys.stk.core.graphics.PrimitiveIndicesOrderHint`
- - An optimization hint optionally provided to a primitive'sSetPartial method to enhance performance.
+ - An optimization hint optionally provided to a primitive's SetPartial method to enhance performance.
* - :py:class:`~ansys.stk.core.graphics.PrimitivesSortOrder`
- The order in which primitives are sorted before rendering.
@@ -852,7 +858,7 @@ Summary
- The axis on which a raster will be flipped.
* - :py:class:`~ansys.stk.core.graphics.RasterFormat`
- - Common raster band layouts that may be contained within a raster dataset. Each pixel of the raster will contain the bands defined by the layout in the specified order. A typical color raster image will have an rgbraster format.
+ - Common raster band layouts that may be contained within a raster dataset. Each pixel of the raster will contain the bands defined by the layout in the specified order. A typical color raster image will have an rgb raster format.
* - :py:class:`~ansys.stk.core.graphics.RasterOrientation`
- The vertical orientation of the raster.
@@ -873,7 +879,7 @@ Summary
- Describes when a primitive will be rendered. Some primitives need to be rendered during or at a certain time. For example, translucent primitives need to be rendered after opaque primitives to allow proper blending...
* - :py:class:`~ansys.stk.core.graphics.RenderPassHint`
- - An optimization hint optionally provided to a primitive'sSet method to enhance performance when per-position colors are used.
+ - An optimization hint optionally provided to a primitive's Set method to enhance performance when per-position colors are used.
* - :py:class:`~ansys.stk.core.graphics.ScreenOverlayOrigin`
- Specify the origin of a screen overlay, as well as the direction of the horizontal and vertical axes. The origin specifies both the origin in the parent overlay's coordinate system and the origin within the overlay itself that is positioned.
@@ -1001,6 +1007,8 @@ well as in STK Engine custom applications.
CameraVideoRecording
CentralBodyGraphics
CentralBodyGraphicsIndexer
+ CesiumIonTerrainOverlay
+ CesiumIonTerrainOverlayFactory
Clouds
ColorToLuminanceFilter
ColorToLuminanceFilterFactory
diff --git a/doc/source/api/ansys/stk/core/graphics/CameraVideoRecording.rst b/doc/source/api/ansys/stk/core/graphics/CameraVideoRecording.rst
index 5630fab196..cbc6dc3b09 100644
--- a/doc/source/api/ansys/stk/core/graphics/CameraVideoRecording.rst
+++ b/doc/source/api/ansys/stk/core/graphics/CameraVideoRecording.rst
@@ -18,8 +18,6 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.graphics.CameraVideoRecording.start_recording`
- - Do not use this method, as it is deprecated. Use the overload taking a video format instead. Starts recording a file in the WMV format at the specified bit and frame rate.
* - :py:attr:`~ansys.stk.core.graphics.CameraVideoRecording.start_recording_frame_stack`
- Start recording a frame stack. Each frame is saved as a separate image file. The filename of each frame is defined by a prefix followed by a frame number.
* - :py:attr:`~ansys.stk.core.graphics.CameraVideoRecording.start_recording_video`
@@ -60,24 +58,6 @@ Method detail
-------------
-.. py:method:: start_recording(self, wmv_filename: str, video_bit_rate: int, video_frame_rate: int) -> None
- :canonical: ansys.stk.core.graphics.CameraVideoRecording.start_recording
-
- Do not use this method, as it is deprecated. Use the overload taking a video format instead. Starts recording a file in the WMV format at the specified bit and frame rate.
-
- :Parameters:
-
- **wmv_filename** : :obj:`~str`
-
- **video_bit_rate** : :obj:`~int`
-
- **video_frame_rate** : :obj:`~int`
-
-
- :Returns:
-
- :obj:`~None`
-
.. py:method:: start_recording_frame_stack(self, file_directory: str, file_prefix: str, camera_snapshot_file_format: SnapshotFileFormat, starting_frame_number: int, number_of_frame_digits: int) -> None
:canonical: ansys.stk.core.graphics.CameraVideoRecording.start_recording_frame_stack
diff --git a/doc/source/api/ansys/stk/core/graphics/CentralBodyGraphics.rst b/doc/source/api/ansys/stk/core/graphics/CentralBodyGraphics.rst
index 2f805f2d11..d08b0a1291 100644
--- a/doc/source/api/ansys/stk/core/graphics/CentralBodyGraphics.rst
+++ b/doc/source/api/ansys/stk/core/graphics/CentralBodyGraphics.rst
@@ -58,7 +58,7 @@ Add Imagery and Terrain to the Scene
# Retrieve the boundaries of the imported files
manager = scenario.scene_manager
# Add Terrain
- installPath = r"C:\Program Files\AGI\STK 12" if os.name == "nt" else os.environ["STK_INSTALL_DIR"]
+ installPath = r"C:\Program Files\AGI\STK_ODTK 13" if os.name == "nt" else os.environ["STK_INSTALL_DIR"]
terrainTile = manager.scenes.item(0).central_bodies.earth.terrain.add_uri_string(
os.path.join(installPath, "Data", "Resources", "stktraining", "samples", "SRTM_Skopje.pdtt")
)
diff --git a/doc/source/api/ansys/stk/core/graphics/CesiumIonTerrainOverlay.rst b/doc/source/api/ansys/stk/core/graphics/CesiumIonTerrainOverlay.rst
new file mode 100644
index 0000000000..f2da9577d6
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/graphics/CesiumIonTerrainOverlay.rst
@@ -0,0 +1,21 @@
+CesiumIonTerrainOverlay
+=======================
+
+.. py:class:: ansys.stk.core.graphics.CesiumIonTerrainOverlay
+
+ Bases: :py:class:`~ansys.stk.core.graphics.ITerrainOverlay`, :py:class:`~ansys.stk.core.graphics.IGlobeOverlay`
+
+ A terrain overlay for handling Cesium Ion Streaming Terrain.
+
+.. py:currentmodule:: CesiumIonTerrainOverlay
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.graphics import CesiumIonTerrainOverlay
+
+
+
diff --git a/doc/source/api/ansys/stk/core/graphics/CesiumIonTerrainOverlayFactory.rst b/doc/source/api/ansys/stk/core/graphics/CesiumIonTerrainOverlayFactory.rst
new file mode 100644
index 0000000000..74c180509e
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/graphics/CesiumIonTerrainOverlayFactory.rst
@@ -0,0 +1,74 @@
+CesiumIonTerrainOverlayFactory
+==============================
+
+.. py:class:: ansys.stk.core.graphics.CesiumIonTerrainOverlayFactory
+
+ A terrain overlay for handling Cesium Ion Streaming Terrain.
+
+.. py:currentmodule:: CesiumIonTerrainOverlayFactory
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Methods
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.graphics.CesiumIonTerrainOverlayFactory.initialize_with_asset_uri`
+ - Initialize a cesiumion terrain overlay with the provided values necessary to communicate with a Cesium ion endpoint.
+ * - :py:attr:`~ansys.stk.core.graphics.CesiumIonTerrainOverlayFactory.initialize_with_string`
+ - Initialize a cesiumion terrain overlay with the provided values necessary to communicate with a Cesium ion endpoint.
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.graphics import CesiumIonTerrainOverlayFactory
+
+
+
+Method detail
+-------------
+
+.. py:method:: initialize_with_asset_uri(self, asset_uri: str, api_endpoint_uri: str, access_token: str) -> CesiumIonTerrainOverlay
+ :canonical: ansys.stk.core.graphics.CesiumIonTerrainOverlayFactory.initialize_with_asset_uri
+
+ Initialize a cesiumion terrain overlay with the provided values necessary to communicate with a Cesium ion endpoint.
+
+ :Parameters:
+
+ **asset_uri** : :obj:`~str`
+
+ **api_endpoint_uri** : :obj:`~str`
+
+ **access_token** : :obj:`~str`
+
+
+ :Returns:
+
+ :obj:`~CesiumIonTerrainOverlay`
+
+.. py:method:: initialize_with_string(self, tileset_name: str, api_endpoint_uri: str, access_token: str) -> CesiumIonTerrainOverlay
+ :canonical: ansys.stk.core.graphics.CesiumIonTerrainOverlayFactory.initialize_with_string
+
+ Initialize a cesiumion terrain overlay with the provided values necessary to communicate with a Cesium ion endpoint.
+
+ :Parameters:
+
+ **tileset_name** : :obj:`~str`
+
+ **api_endpoint_uri** : :obj:`~str`
+
+ **access_token** : :obj:`~str`
+
+
+ :Returns:
+
+ :obj:`~CesiumIonTerrainOverlay`
+
diff --git a/doc/source/api/ansys/stk/core/graphics/FactoryAndInitializers.rst b/doc/source/api/ansys/stk/core/graphics/FactoryAndInitializers.rst
index bd4ce96d69..2010c561bf 100644
--- a/doc/source/api/ansys/stk/core/graphics/FactoryAndInitializers.rst
+++ b/doc/source/api/ansys/stk/core/graphics/FactoryAndInitializers.rst
@@ -48,6 +48,8 @@ Overview
- Access global methods and properties of BoxTriangulator (what's known as static properties, static methods and constructors in languages such as C++, C#, etc.).
* - :py:attr:`~ansys.stk.core.graphics.FactoryAndInitializers.brightness_filter`
- Access global methods and properties of BrightnessFilter (what's known as static properties, static methods and constructors in languages such as C++, C#, etc.).
+ * - :py:attr:`~ansys.stk.core.graphics.FactoryAndInitializers.cesium_ion_terrain_overlay`
+ - Access global methods and properties of CesiumionTerrainOverlay (what's known as static properties, static methods and constructors in languages such as C++, C#, etc.).
* - :py:attr:`~ansys.stk.core.graphics.FactoryAndInitializers.color_to_luminance_filter`
- Access global methods and properties of ColorToLuminanceFilter (what's known as static properties, static methods and constructors in languages such as C++, C#, etc.).
* - :py:attr:`~ansys.stk.core.graphics.FactoryAndInitializers.composite_display_condition`
@@ -288,6 +290,12 @@ Property detail
Access global methods and properties of BrightnessFilter (what's known as static properties, static methods and constructors in languages such as C++, C#, etc.).
+.. py:property:: cesium_ion_terrain_overlay
+ :canonical: ansys.stk.core.graphics.FactoryAndInitializers.cesium_ion_terrain_overlay
+ :type: CesiumIonTerrainOverlayFactory
+
+ Access global methods and properties of CesiumionTerrainOverlay (what's known as static properties, static methods and constructors in languages such as C++, C#, etc.).
+
.. py:property:: color_to_luminance_filter
:canonical: ansys.stk.core.graphics.FactoryAndInitializers.color_to_luminance_filter
:type: ColorToLuminanceFilterFactory
diff --git a/doc/source/api/ansys/stk/core/graphics/IOverlay.rst b/doc/source/api/ansys/stk/core/graphics/IOverlay.rst
index 82a84dd211..694de477d9 100644
--- a/doc/source/api/ansys/stk/core/graphics/IOverlay.rst
+++ b/doc/source/api/ansys/stk/core/graphics/IOverlay.rst
@@ -74,7 +74,7 @@ Overview
* - :py:attr:`~ansys.stk.core.graphics.IOverlay.padding`
- Get or set the padding surrounding the overlays that are contained within this overlay. The array contains the components of the padding arranged in the order left, top, right, bottom.
* - :py:attr:`~ansys.stk.core.graphics.IOverlay.parent`
- - Get the overlay's parent. This may be another overlay if this overlay was added to that overlay's overlays collection. Or, it may be the screen overlay manager if this overlay was added to the scene manager'sscreen overlays collection.
+ - Get the overlay's parent. This may be another overlay if this overlay was added to that overlay's overlays collection. Or, it may be the screen overlay manager if this overlay was added to the scene manager's screen overlays collection.
* - :py:attr:`~ansys.stk.core.graphics.IOverlay.picking_enabled`
- Get or set a value indicating whether or not picking on the overlay is enabled. If picking is disabled, this overlay will never show up in the result of PickScreenOverlay, even if it occupies the specified pick position.
* - :py:attr:`~ansys.stk.core.graphics.IOverlay.pinning_origin`
@@ -248,7 +248,7 @@ Property detail
:canonical: ansys.stk.core.graphics.IOverlay.parent
:type: IScreenOverlayContainer
- Get the overlay's parent. This may be another overlay if this overlay was added to that overlay's overlays collection. Or, it may be the screen overlay manager if this overlay was added to the scene manager'sscreen overlays collection.
+ Get the overlay's parent. This may be another overlay if this overlay was added to that overlay's overlays collection. Or, it may be the screen overlay manager if this overlay was added to the scene manager's screen overlays collection.
.. py:property:: picking_enabled
:canonical: ansys.stk.core.graphics.IOverlay.picking_enabled
diff --git a/doc/source/api/ansys/stk/core/graphics/ModelPrimitive.rst b/doc/source/api/ansys/stk/core/graphics/ModelPrimitive.rst
index 0bd9f44281..696f452ba7 100644
--- a/doc/source/api/ansys/stk/core/graphics/ModelPrimitive.rst
+++ b/doc/source/api/ansys/stk/core/graphics/ModelPrimitive.rst
@@ -5,7 +5,7 @@ ModelPrimitive
Bases: :py:class:`~ansys.stk.core.graphics.IPrimitive`
- The model primitive loads and renders `COLLADA `_ (DAE) and AGI `MDL `_ (MDL) models.
+ The model primitive loads and renders `glTF 2.0 `_ (.gltf, .glb), `COLLADA `_ (DAE) and AGI `MDL `_ (MDL) models.
.. py:currentmodule:: ModelPrimitive
@@ -20,10 +20,12 @@ Overview
:header-rows: 0
:widths: auto
+ * - :py:attr:`~ansys.stk.core.graphics.ModelPrimitive.allow_collada_models`
+ - Do not use this method, as it is deprecated. support for COLLADA 3D models has been removed Support for loading COLLADA 3D model format has been officially removed. This method will allow users to continue loading COLLADA models for a short period of time.
* - :py:attr:`~ansys.stk.core.graphics.ModelPrimitive.load_with_string_uri`
- - For convenience. Loads a `COLLADA `_ (DAE) or AGI `MDL `_ (MDL) model using a file path.
+ - For convenience. Loads a `glTF 2.0 `_ (.gltf, .glb), `COLLADA `_ (DAE) or AGI `MDL `_ (MDL) model using a file path.
* - :py:attr:`~ansys.stk.core.graphics.ModelPrimitive.load_with_string_uri_and_up_axis`
- - For convenience. Loads a `COLLADA `_ (DAE) or AGI `MDL `_ (MDL) model using a file path.
+ - For convenience. Loads a `glTF 2.0 `_ (.gltf, .glb), `COLLADA `_ (DAE) or AGI `MDL `_ (MDL) model using a file path.
* - :py:attr:`~ansys.stk.core.graphics.ModelPrimitive.set_position_cartographic`
- For convenience. Sets the cartographic position of the model. This also sets position.
@@ -91,11 +93,25 @@ Property detail
Method detail
-------------
+.. py:method:: allow_collada_models(self, allow: bool) -> None
+ :canonical: ansys.stk.core.graphics.ModelPrimitive.allow_collada_models
+
+ Do not use this method, as it is deprecated. support for COLLADA 3D models has been removed Support for loading COLLADA 3D model format has been officially removed. This method will allow users to continue loading COLLADA models for a short period of time.
+
+ :Parameters:
+
+ **allow** : :obj:`~bool`
+
+
+ :Returns:
+
+ :obj:`~None`
+
.. py:method:: load_with_string_uri(self, uri: str) -> None
:canonical: ansys.stk.core.graphics.ModelPrimitive.load_with_string_uri
- For convenience. Loads a `COLLADA `_ (DAE) or AGI `MDL `_ (MDL) model using a file path.
+ For convenience. Loads a `glTF 2.0 `_ (.gltf, .glb), `COLLADA `_ (DAE) or AGI `MDL `_ (MDL) model using a file path.
:Parameters:
@@ -109,7 +125,7 @@ Method detail
.. py:method:: load_with_string_uri_and_up_axis(self, uri: str, up_axis: ModelUpAxis) -> None
:canonical: ansys.stk.core.graphics.ModelPrimitive.load_with_string_uri_and_up_axis
- For convenience. Loads a `COLLADA `_ (DAE) or AGI `MDL `_ (MDL) model using a file path.
+ For convenience. Loads a `glTF 2.0 `_ (.gltf, .glb), `COLLADA `_ (DAE) or AGI `MDL `_ (MDL) model using a file path.
:Parameters:
diff --git a/doc/source/api/ansys/stk/core/graphics/ModelPrimitiveFactory.rst b/doc/source/api/ansys/stk/core/graphics/ModelPrimitiveFactory.rst
index 9e3b1128ec..78d05d4dbd 100644
--- a/doc/source/api/ansys/stk/core/graphics/ModelPrimitiveFactory.rst
+++ b/doc/source/api/ansys/stk/core/graphics/ModelPrimitiveFactory.rst
@@ -3,7 +3,7 @@ ModelPrimitiveFactory
.. py:class:: ansys.stk.core.graphics.ModelPrimitiveFactory
- The model primitive loads and renders `COLLADA `_ (DAE) and AGI `MDL `_ (MDL) models.
+ The model primitive loads and renders `glTF 2.0 `_ (.gltf, .glb), `COLLADA `_ (DAE) and AGI `MDL `_ (MDL) models.
.. py:currentmodule:: ModelPrimitiveFactory
@@ -18,6 +18,8 @@ Overview
:header-rows: 0
:widths: auto
+ * - :py:attr:`~ansys.stk.core.graphics.ModelPrimitiveFactory.allow_collada_models`
+ - Support for loading COLLADA 3D model format has been officially removed. This method will allow users to continue loading COLLADA models for a short period of time.
* - :py:attr:`~ansys.stk.core.graphics.ModelPrimitiveFactory.initialize`
- Initialize a default model primitive.
* - :py:attr:`~ansys.stk.core.graphics.ModelPrimitiveFactory.initialize_with_string_uri`
@@ -38,6 +40,20 @@ Import detail
Method detail
-------------
+.. py:method:: allow_collada_models(self, allow: bool) -> None
+ :canonical: ansys.stk.core.graphics.ModelPrimitiveFactory.allow_collada_models
+
+ Support for loading COLLADA 3D model format has been officially removed. This method will allow users to continue loading COLLADA models for a short period of time.
+
+ :Parameters:
+
+ **allow** : :obj:`~bool`
+
+
+ :Returns:
+
+ :obj:`~None`
+
.. py:method:: initialize(self) -> ModelPrimitive
:canonical: ansys.stk.core.graphics.ModelPrimitiveFactory.initialize
diff --git a/doc/source/api/ansys/stk/core/graphics/ModelTransformationType.rst b/doc/source/api/ansys/stk/core/graphics/ModelTransformationType.rst
index fdc637bd8e..bcae5cb985 100644
--- a/doc/source/api/ansys/stk/core/graphics/ModelTransformationType.rst
+++ b/doc/source/api/ansys/stk/core/graphics/ModelTransformationType.rst
@@ -88,6 +88,9 @@ Overview
* - :py:attr:`~TRANSLATE_BLUE`
- Translate the blue band of color associated with the geometry.
+ * - :py:attr:`~ANIMATION`
+ - Control an animation cycle defined on the model.
+
Import detail
-------------
diff --git a/doc/source/api/ansys/stk/core/graphics/PrimitiveManager.rst b/doc/source/api/ansys/stk/core/graphics/PrimitiveManager.rst
index de0eb20a75..9119e90814 100644
--- a/doc/source/api/ansys/stk/core/graphics/PrimitiveManager.rst
+++ b/doc/source/api/ansys/stk/core/graphics/PrimitiveManager.rst
@@ -37,8 +37,6 @@ Overview
- Return an enumerator that iterates through the collection. The order of the primitives is not guaranteed to be the order that the primitives were added.
* - :py:attr:`~ansys.stk.core.graphics.PrimitiveManager.count`
- Get the number of primitives in the manager.
- * - :py:attr:`~ansys.stk.core.graphics.PrimitiveManager.precision_exponent`
- - Do not use this property, as it is deprecated. This property is no longer in use Gets or sets the exponent used to compute the maximum precision for primitive rendering. For example, a value of -3 indicates the maximum precision of 2^-3, 0.125 m along the x, y, or z axis...
* - :py:attr:`~ansys.stk.core.graphics.PrimitiveManager.translucent_primitives_sort_order`
- Get or set the sort order for translucent primitives in the primitive manager. This determines a trade-off between rendering speed and quality...
@@ -67,12 +65,6 @@ Property detail
Get the number of primitives in the manager.
-.. py:property:: precision_exponent
- :canonical: ansys.stk.core.graphics.PrimitiveManager.precision_exponent
- :type: int
-
- Do not use this property, as it is deprecated. This property is no longer in use Gets or sets the exponent used to compute the maximum precision for primitive rendering. For example, a value of -3 indicates the maximum precision of 2^-3, 0.125 m along the x, y, or z axis...
-
.. py:property:: translucent_primitives_sort_order
:canonical: ansys.stk.core.graphics.PrimitiveManager.translucent_primitives_sort_order
:type: PrimitivesSortOrder
@@ -121,8 +113,6 @@ Method detail
:obj:`~bool`
-
-
.. py:method:: remove(self, primitive: IPrimitive) -> None
:canonical: ansys.stk.core.graphics.PrimitiveManager.remove
diff --git a/doc/source/api/ansys/stk/core/graphics/Scene.rst b/doc/source/api/ansys/stk/core/graphics/Scene.rst
index 987f4cc705..1adc262194 100644
--- a/doc/source/api/ansys/stk/core/graphics/Scene.rst
+++ b/doc/source/api/ansys/stk/core/graphics/Scene.rst
@@ -62,7 +62,7 @@ Overview
* - :py:attr:`~ansys.stk.core.graphics.Scene.show_water_surface`
- Get or set whether water surface on earth is shown or hidden in the scene.
* - :py:attr:`~ansys.stk.core.graphics.Scene.visual_effects`
- - Get the visual effects associated with the scene.
+ - Get the visual effects associated with the scene.
@@ -173,7 +173,7 @@ Property detail
:canonical: ansys.stk.core.graphics.Scene.visual_effects
:type: VisualEffects
- Get the visual effects associated with the scene.
+ Get the visual effects associated with the scene.
Method detail
diff --git a/doc/source/api/ansys/stk/core/graphics/SurfacePolygonTriangulatorInitializer.rst b/doc/source/api/ansys/stk/core/graphics/SurfacePolygonTriangulatorInitializer.rst
index 1d10a198dc..fbb048fb32 100644
--- a/doc/source/api/ansys/stk/core/graphics/SurfacePolygonTriangulatorInitializer.rst
+++ b/doc/source/api/ansys/stk/core/graphics/SurfacePolygonTriangulatorInitializer.rst
@@ -41,7 +41,7 @@ Draw a new Surface Extent Triangulator
# Scenario scenario: Scenario object
manager = scenario.scene_manager
- installPath = r"C:\Program Files\AGI\STK 12" if os.name == "nt" else os.environ["STK_INSTALL_DIR"]
+ installPath = r"C:\Program Files\AGI\STK_ODTK 13" if os.name == "nt" else os.environ["STK_INSTALL_DIR"]
texture_path = os.path.join(installPath, "STKData", "VO", "Textures", "AGI_logo_small.png")
texture = manager.textures.load_from_string_uri(texture_path)
mesh = manager.initializers.surface_mesh_primitive.initialize()
diff --git a/doc/source/api/ansys/stk/core/graphics/TextureScreenOverlay.rst b/doc/source/api/ansys/stk/core/graphics/TextureScreenOverlay.rst
index 49fd6c22c0..e0975fbc96 100644
--- a/doc/source/api/ansys/stk/core/graphics/TextureScreenOverlay.rst
+++ b/doc/source/api/ansys/stk/core/graphics/TextureScreenOverlay.rst
@@ -40,7 +40,7 @@ Draw a new Texture Screen Overlay
manager = scenario.scene_manager
overlays = manager.screen_overlays.overlays
textureOverlay = manager.initializers.texture_screen_overlay.initialize_with_xy_width_height(0, 0, 128, 128)
- installPath = r"C:\Program Files\AGI\STK 12" if os.name == "nt" else os.environ["STK_INSTALL_DIR"]
+ installPath = r"C:\Program Files\AGI\STK_ODTK 13" if os.name == "nt" else os.environ["STK_INSTALL_DIR"]
textureOverlay.texture = manager.textures.load_from_string_uri(
os.path.join(installPath, "STKData", "VO", "Textures", "agilogo3.ppm")
)
diff --git a/doc/source/api/ansys/stk/core/stkdesktop/STKDesktop.rst b/doc/source/api/ansys/stk/core/stkdesktop/STKDesktop.rst
index a10c6b0447..130e598a7a 100644
--- a/doc/source/api/ansys/stk/core/stkdesktop/STKDesktop.rst
+++ b/doc/source/api/ansys/stk/core/stkdesktop/STKDesktop.rst
@@ -30,6 +30,8 @@ Overview
grpc_port is the integral port number that the gRPC server is using.
grpc_timeout_sec specifies the time allocated to wait for a grpc connection (seconds).
grpc_max_message_size is the maximum size in bytes that the gRPC client can receive. Set to zero to use the gRPC default.
+ grpc_channel_credentials are channel credentials to be attached to the grpc channel (most common use case: SSL credentials,
+ see https://grpc.io/docs/guides/auth/ for more information).
Only available on Windows.
* - :py:attr:`~ansys.stk.core.stkdesktop.STKDesktop.create_thread_marshaller`
- Return a ThreadMarshaller instance capable of marshalling the stk_object argument to a new thread.
@@ -50,6 +52,8 @@ Overview
grpc_port is the integral port number that the gRPC server is using (valid values are integers from 0 to 65535).
grpc_timeout_sec specifies the time allocated to wait for a grpc connection (seconds).
grpc_max_message_size is the maximum size in bytes that the gRPC client can receive. Set to zero to use the gRPC default.
+ grpc_channel_credentials are channel credentials to be attached to the grpc channel (most common use case: SSL credentials,
+ see https://grpc.io/docs/guides/auth/ for more information).
Only available on Windows.
Import detail
@@ -63,7 +67,7 @@ Import detail
Method detail
-------------
-.. py:method:: attach_to_application(pid: int = None, grpc_server: bool = False, grpc_host: str = localhost, grpc_port: int = 40704, grpc_timeout_sec: int = 60, grpc_max_message_size: int = 0) -> STKDesktopApplication
+.. py:method:: attach_to_application(pid: int = None, grpc_server: bool = False, grpc_host: str = localhost, grpc_port: int = 40704, grpc_timeout_sec: int = 60, grpc_max_message_size: int = 0, grpc_channel_credentials) -> STKDesktopApplication
:canonical: ansys.stk.core.stkdesktop.STKDesktop.attach_to_application
Attach to an existing STK Desktop instance.
@@ -74,6 +78,8 @@ Method detail
grpc_port is the integral port number that the gRPC server is using.
grpc_timeout_sec specifies the time allocated to wait for a grpc connection (seconds).
grpc_max_message_size is the maximum size in bytes that the gRPC client can receive. Set to zero to use the gRPC default.
+ grpc_channel_credentials are channel credentials to be attached to the grpc channel (most common use case: SSL credentials,
+ see https://grpc.io/docs/guides/auth/ for more information).
Only available on Windows.
:Parameters:
@@ -117,7 +123,7 @@ Method detail
:obj:`~None`
-.. py:method:: start_application(visible: bool = False, user_control: bool = False, grpc_server: bool = False, grpc_host: str = localhost, grpc_port: int = 40704, grpc_timeout_sec: int = 60, grpc_max_message_size: int = 0) -> STKDesktopApplication
+.. py:method:: start_application(visible: bool = False, user_control: bool = False, grpc_server: bool = False, grpc_host: str = localhost, grpc_port: int = 40704, grpc_timeout_sec: int = 60, grpc_max_message_size: int = 0, grpc_channel_credentials) -> STKDesktopApplication
:canonical: ansys.stk.core.stkdesktop.STKDesktop.start_application
Create a new STK Desktop application instance.
@@ -130,6 +136,8 @@ Method detail
grpc_port is the integral port number that the gRPC server is using (valid values are integers from 0 to 65535).
grpc_timeout_sec specifies the time allocated to wait for a grpc connection (seconds).
grpc_max_message_size is the maximum size in bytes that the gRPC client can receive. Set to zero to use the gRPC default.
+ grpc_channel_credentials are channel credentials to be attached to the grpc channel (most common use case: SSL credentials,
+ see https://grpc.io/docs/guides/auth/ for more information).
Only available on Windows.
:Parameters:
diff --git a/doc/source/api/ansys/stk/core/stkengine/STKEngine.rst b/doc/source/api/ansys/stk/core/stkengine/STKEngine.rst
index 31a7ee20e4..b93248ff3c 100644
--- a/doc/source/api/ansys/stk/core/stkengine/STKEngine.rst
+++ b/doc/source/api/ansys/stk/core/stkengine/STKEngine.rst
@@ -25,6 +25,7 @@ Overview
- Initialize STK Engine in-process and return the instance.
Must only be used once per Python process.
+ Specify no_graphics = True to start the application in no-graphics mode.
Import detail
-------------
@@ -43,6 +44,7 @@ Method detail
Initialize STK Engine in-process and return the instance.
Must only be used once per Python process.
+ Specify no_graphics = True to start the application in no-graphics mode.
:Parameters:
diff --git a/doc/source/api/ansys/stk/core/stkobjects.rst b/doc/source/api/ansys/stk/core/stkobjects.rst
index f7ae735428..ef9b8337b4 100644
--- a/doc/source/api/ansys/stk/core/stkobjects.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects.rst
@@ -71,9 +71,6 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.IAtmosphericAbsorptionModel`
- Provide access to the properties and methods an atmospheric absorption model.
- * - :py:class:`~ansys.stk.core.stkobjects.IAtmosphericAbsorptionModelITURP676`
- - Provide access to the properties and methods of the ITU-R P676 atmospheric absorption model.
-
* - :py:class:`~ansys.stk.core.stkobjects.IAtmosphericAbsorptionModelTIREM`
- Provide access to the properties and methods of the TIREM atmospheric absorption model.
@@ -227,9 +224,6 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.ILaserAtmosphericLossModel`
- Provide access to the properties and methods for a laser atmospheric absorption loss model.
- * - :py:class:`~ansys.stk.core.stkobjects.ILaserPropagationChannel`
- - Provide access to laser propagation loss models.
-
* - :py:class:`~ansys.stk.core.stkobjects.ILaserTroposphericScintillationLossModel`
- Provide access to the properties and methods for a laser tropospheric scintillation loss model.
@@ -251,9 +245,6 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.IOrientationAscNode`
- Base Interface to OrientationLongitudeOfAscending and OrientationRightAscensionOfAscendingNode.
- * - :py:class:`~ansys.stk.core.stkobjects.IPlatformRFEnvironment`
- - Provide access to the properties and methods defining the platform RF environment.
-
* - :py:class:`~ansys.stk.core.stkobjects.IPointingStrategy`
- Provide the base interface for a pointing strategy.
@@ -290,27 +281,6 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.IRadarActivity`
- Provide access to the properties and methods defining radar activity.
- * - :py:class:`~ansys.stk.core.stkobjects.IRadarClutterGeometryModel`
- - Do not use this interface, as it is deprecated. Use IScatteringPointProvider interface instead. Provides access to the properties and methods defining a radar clutter geometry model.
-
- * - :py:class:`~ansys.stk.core.stkobjects.IRadarClutterGeometryModelPlugin`
- - Do not use this interface, as it is deprecated. Use ScatteringPointProviderPlugin interface instead. Provides access to the properties and methods defining a radar clutter geometry plugin model.
-
- * - :py:class:`~ansys.stk.core.stkobjects.IRadarClutterMap`
- - Do not use this interface, as it is deprecated. This interface is no longer used and there is no alternative. Provides access to the properties and methods defining a radar clutter map.
-
- * - :py:class:`~ansys.stk.core.stkobjects.IRadarClutterMapInheritable`
- - Do not use this interface, as it is deprecated. This interface is no longer used and there is no alternative. Provides access to the properties and methods defining a radar inheritable clutter map.
-
- * - :py:class:`~ansys.stk.core.stkobjects.IRadarClutterMapModel`
- - Do not use this interface, as it is deprecated. Use IScatteringPointModel interface instead. Provides access to the properties and methods defining a radar clutter map model.
-
- * - :py:class:`~ansys.stk.core.stkobjects.IRadarClutterMapModelConstantCoefficient`
- - Do not use this interface, as it is deprecated. Use ScatteringPointModelConstantCoefficient interface instead. Provides access to the properties and methods defining a radar clutter map constant coefficient model.
-
- * - :py:class:`~ansys.stk.core.stkobjects.IRadarClutterMapModelPlugin`
- - Do not use this interface, as it is deprecated. Use ScatteringPointModelPlugin interface instead. Provides access to the properties and methods defining a radar clutter map plugin model.
-
* - :py:class:`~ansys.stk.core.stkobjects.IRadarContinuousWaveAnalysisMode`
- Interface which defines an continuous wave analysis.
@@ -598,9 +568,6 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.AccessConstraintPluginMinMax`
- Class related to defining access plugin constraints in terms of minimum and/or maximum values.
- * - :py:class:`~ansys.stk.core.stkobjects.AccessConstraintThirdBody`
- - Do not use this class, as it is deprecated. Use AccessConstraintCentralBodyObstruction instead. Class defining Central Body Obstruction constraints.
-
* - :py:class:`~ansys.stk.core.stkobjects.AccessConstraintTimeSlipRange`
- Class for controlling the use the Time Slip constraint for a missile or launch vehicle, used with the Close Approach Tool.
@@ -919,9 +886,6 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.AreaTypePatternCollection`
- Class defining the list of coordinates of the AreaTarget AreaType.
- * - :py:class:`~ansys.stk.core.stkobjects.Atmosphere`
- - Class defining local atmosphere.
-
* - :py:class:`~ansys.stk.core.stkobjects.AtmosphericAbsorptionModel`
- Class defining an atmospheric absorption model.
@@ -1093,6 +1057,9 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.Chain`
- Chain Class is used to access the methods and properties of the STK Chain Object.
+ * - :py:class:`~ansys.stk.core.stkobjects.ChainAnalysisOptions`
+ - Class containing analysis options for an object when computing optimal strands of a chain.
+
* - :py:class:`~ansys.stk.core.stkobjects.ChainConnection`
- Class defining Chain connections.
@@ -1921,7 +1888,7 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.LaserEnvironment`
- Class defining the laser environment for an object.
- * - :py:class:`~ansys.stk.core.stkobjects.LaserPropagationLossModels`
+ * - :py:class:`~ansys.stk.core.stkobjects.LaserPropagationChannel`
- Class defining the properties for laser propagatoin models.
* - :py:class:`~ansys.stk.core.stkobjects.LaserTroposphericScintillationLossModel`
@@ -2317,6 +2284,9 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.PlatformLaserEnvironment`
- Class defining the laser environment for an platform.
+ * - :py:class:`~ansys.stk.core.stkobjects.PlatformRFEnvironment`
+ - Class defining local atmosphere.
+
* - :py:class:`~ansys.stk.core.stkobjects.PointingStrategy`
- Class defining a pointing strategy.
@@ -2464,9 +2434,6 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.PropagatorSGP4LoadFile`
- SGP4 propagator. Allows the user to load segments from file.
- * - :py:class:`~ansys.stk.core.stkobjects.PropagatorSGP4OnlineAutoLoad`
- - Do not use this class, as it is deprecated. Use PropagatorSGP4OnlineLoad instead. SGP4 propagator. Allows the user to load the most current segment from online.
-
* - :py:class:`~ansys.stk.core.stkobjects.PropagatorSGP4OnlineLoad`
- SGP4 propagator. Allows the user to load segments from online.
@@ -2551,9 +2518,6 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.RadarClutter`
- Class defining a radar clutter.
- * - :py:class:`~ansys.stk.core.stkobjects.RadarClutterGeometry`
- - Class defining a radar clutter geometry.
-
* - :py:class:`~ansys.stk.core.stkobjects.RadarContinuousWaveAnalysisModeFixedTime`
- Class defining the continuous wave fixed time analysis mode.
@@ -3514,6 +3478,9 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv2ExportTool`
- The Ephemeris/Attitude Export Tool for CCSDSv2 Ephemeris type.
+ * - :py:class:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool`
+ - The Ephemeris/Attitude Export Tool for CCSDSv3 Ephemeris type.
+
* - :py:class:`~ansys.stk.core.stkobjects.VehicleEphemerisCode500ExportTool`
- VehicleEphemerisCode500ExportTool Class.
@@ -4116,9 +4083,6 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.AccessTimeType`
- The time period to use for the access computation.
- * - :py:class:`~ansys.stk.core.stkobjects.ActionType`
- - Specify the action type for the Interval Access Constraint.
-
* - :py:class:`~ansys.stk.core.stkobjects.AdvCATConjunctionType`
- Mode for computing events involving conjunction TCA.
@@ -4545,6 +4509,9 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.IonosphericFadingLossModelType`
- Ionospheric loss model types.
+ * - :py:class:`~ansys.stk.core.stkobjects.ITURP676AtmosphereDataType`
+ - ITU-R P.676-13 atmosphere data type.
+
* - :py:class:`~ansys.stk.core.stkobjects.IvClockHost`
- Clock host options for access. Time values are reported with a clock colocated with the clock host object.
@@ -4689,12 +4656,6 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.RadarActivityType`
- Radar activity times strategy.
- * - :py:class:`~ansys.stk.core.stkobjects.RadarClutterGeometryModelType`
- - Radar clutter geometry model type.
-
- * - :py:class:`~ansys.stk.core.stkobjects.RadarClutterMapModelType`
- - Radar clutter map model type.
-
* - :py:class:`~ansys.stk.core.stkobjects.RadarContinuousWaveAnalysisMode`
- Radar continuous wave analysis mode.
@@ -5234,7 +5195,6 @@ The following is an overview of the classes, interfaces and enumerations of the
IAntennaModelOpticalSimple
IAreaTypeData
IAtmosphericAbsorptionModel
- IAtmosphericAbsorptionModelITURP676
IAtmosphericAbsorptionModelTIREM
IAtmosphericTurbulenceModel
IAzElMaskData
@@ -5286,7 +5246,6 @@ The following is an overview of the classes, interfaces and enumerations of the
IGreatArcVehicle
IIonosphericFadingLossModel
ILaserAtmosphericLossModel
- ILaserPropagationChannel
ILaserTroposphericScintillationLossModel
ILatitudeLongitudeAltitudePosition
ILifetimeInformation
@@ -5294,7 +5253,6 @@ The following is an overview of the classes, interfaces and enumerations of the
IModulatorModelScriptPlugin
IOrbitDisplayData
IOrientationAscNode
- IPlatformRFEnvironment
IPointingStrategy
IPolarization
IPolarizationCrossPolLeakage
@@ -5307,13 +5265,6 @@ The following is an overview of the classes, interfaces and enumerations of the
IPropagatorSGP4LoadData
IProvideSpatialInfo
IRadarActivity
- IRadarClutterGeometryModel
- IRadarClutterGeometryModelPlugin
- IRadarClutterMap
- IRadarClutterMapInheritable
- IRadarClutterMapModel
- IRadarClutterMapModelConstantCoefficient
- IRadarClutterMapModelPlugin
IRadarContinuousWaveAnalysisMode
IRadarCrossSectionComputeStrategy
IRadarModeBistaticReceiver
@@ -5413,7 +5364,6 @@ The following is an overview of the classes, interfaces and enumerations of the
AccessConstraintMinMaxBase
AccessConstraintObjExAngle
AccessConstraintPluginMinMax
- AccessConstraintThirdBody
AccessConstraintTimeSlipRange
AccessEventDetection
AccessGraphics
@@ -5520,7 +5470,6 @@ The following is an overview of the classes, interfaces and enumerations of the
AreaTypeEllipse
AreaTypePattern
AreaTypePatternCollection
- Atmosphere
AtmosphericAbsorptionModel
AtmosphericAbsorptionModelCOMPlugin
AtmosphericAbsorptionModelGraphics3DACAP
@@ -5578,6 +5527,7 @@ The following is an overview of the classes, interfaces and enumerations of the
CentralBodyTerrainCollection
CentralBodyTerrainCollectionElement
Chain
+ ChainAnalysisOptions
ChainConnection
ChainConnectionCollection
ChainConstraints
@@ -5854,7 +5804,7 @@ The following is an overview of the classes, interfaces and enumerations of the
LaserAtmosphericLossModel
LaserAtmosphericLossModelBeerBouguerLambertLaw
LaserEnvironment
- LaserPropagationLossModels
+ LaserPropagationChannel
LaserTroposphericScintillationLossModel
LaserTroposphericScintillationLossModelITURP1814
LatitudeLongitudeAltitudeCentric
@@ -5986,6 +5936,7 @@ The following is an overview of the classes, interfaces and enumerations of the
PlanetPositionCentralBody
PlanetPositionFile
PlatformLaserEnvironment
+ PlatformRFEnvironment
PointingStrategy
PointingStrategyFixed
PointingStrategySpinning
@@ -6035,7 +5986,6 @@ The following is an overview of the classes, interfaces and enumerations of the
PropagatorSGP4AutoUpdateProperties
PropagatorSGP4CommonTasks
PropagatorSGP4LoadFile
- PropagatorSGP4OnlineAutoLoad
PropagatorSGP4OnlineLoad
PropagatorSGP4PropagatorSettings
PropagatorSGP4Segment
@@ -6064,7 +6014,6 @@ The following is an overview of the classes, interfaces and enumerations of the
RadarAntennaBeam
RadarAntennaBeamCollection
RadarClutter
- RadarClutterGeometry
RadarContinuousWaveAnalysisModeFixedTime
RadarContinuousWaveAnalysisModeGoalSNR
RadarCrossSection
@@ -6385,6 +6334,7 @@ The following is an overview of the classes, interfaces and enumerations of the
VehicleEphemerisBinaryExportTool
VehicleEphemerisCCSDSExportTool
VehicleEphemerisCCSDSv2ExportTool
+ VehicleEphemerisCCSDSv3ExportTool
VehicleEphemerisCode500ExportTool
VehicleEphemerisExportTool
VehicleEphemerisSPICEExportTool
@@ -6589,7 +6539,6 @@ The following is an overview of the classes, interfaces and enumerations of the
≔ AberrationType
≔ AccessConstraintType
≔ AccessTimeType
- ≔ ActionType
≔ AdvCATConjunctionType
≔ AdvCATEllipsoidClassType
≔ AdvCATSecondaryEllipsoidsVisibilityType
@@ -6732,6 +6681,7 @@ The following is an overview of the classes, interfaces and enumerations of the
≔ HFSSFarFieldDataGainType
≔ IntersectionType
≔ IonosphericFadingLossModelType
+ ≔ ITURP676AtmosphereDataType
≔ IvClockHost
≔ IvTimeSense
≔ LaserPropagationLossModelType
@@ -6780,8 +6730,6 @@ The following is an overview of the classes, interfaces and enumerations of the
≔ PropagatorType
≔ PulseWidthMode
≔ RadarActivityType
- ≔ RadarClutterGeometryModelType
- ≔ RadarClutterMapModelType
≔ RadarContinuousWaveAnalysisMode
≔ RadarCrossSectionContourGraphicsPolarization
≔ RadarFrequencySpecificationType
diff --git a/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintCollection.rst b/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintCollection.rst
index 78123163f1..b82e2c9e91 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintCollection.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintCollection.rst
@@ -41,8 +41,6 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.AccessConstraintCollection.remove_constraint`
- Remove a constraint from the collection.
* - :py:attr:`~ansys.stk.core.stkobjects.AccessConstraintCollection.remove_named_constraint`
- - Do not use this method, as it is deprecated. Use RemoveNamedConstraintEx instead. Removes a constraint with the given name from the collection.
- * - :py:attr:`~ansys.stk.core.stkobjects.AccessConstraintCollection.remove_named_constraint_ex`
- Remove a constraint with the given name from the collection.
.. tab-item:: Properties
@@ -276,20 +274,6 @@ Method detail
.. py:method:: remove_named_constraint(self, cnstr_name: str) -> None
:canonical: ansys.stk.core.stkobjects.AccessConstraintCollection.remove_named_constraint
- Do not use this method, as it is deprecated. Use RemoveNamedConstraintEx instead. Removes a constraint with the given name from the collection.
-
- :Parameters:
-
- **cnstr_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-.. py:method:: remove_named_constraint_ex(self, cnstr_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.AccessConstraintCollection.remove_named_constraint_ex
-
Remove a constraint with the given name from the collection.
:Parameters:
diff --git a/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintExclZonesCollection.rst b/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintExclZonesCollection.rst
index 5a6ca9fa0f..fc17b0425e 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintExclZonesCollection.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintExclZonesCollection.rst
@@ -49,6 +49,8 @@ Overview
- Get the constraint type.
* - :py:attr:`~ansys.stk.core.stkobjects.AccessConstraintExclZonesCollection.count`
- Number of items in the collection.
+ * - :py:attr:`~ansys.stk.core.stkobjects.AccessConstraintExclZonesCollection.enabled`
+ - Indicate whether the constraint should be considered (true) or ignored (false) in access computations.
* - :py:attr:`~ansys.stk.core.stkobjects.AccessConstraintExclZonesCollection.exclusion_interval`
- Get or set the ExclInterval.
* - :py:attr:`~ansys.stk.core.stkobjects.AccessConstraintExclZonesCollection.is_plugin`
@@ -95,6 +97,12 @@ Property detail
Number of items in the collection.
+.. py:property:: enabled
+ :canonical: ansys.stk.core.stkobjects.AccessConstraintExclZonesCollection.enabled
+ :type: bool
+
+ Indicate whether the constraint should be considered (true) or ignored (false) in access computations.
+
.. py:property:: exclusion_interval
:canonical: ansys.stk.core.stkobjects.AccessConstraintExclZonesCollection.exclusion_interval
:type: bool
@@ -150,6 +158,8 @@ Method detail
+
+
.. py:method:: get_exclusion_zone(self, index: int) -> typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]
:canonical: ansys.stk.core.stkobjects.AccessConstraintExclZonesCollection.get_exclusion_zone
diff --git a/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintIntervals.rst b/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintIntervals.rst
index 0a9d7149b8..289714789b 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintIntervals.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintIntervals.rst
@@ -20,8 +20,6 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.AccessConstraintIntervals.action_type`
- - Do not use this property, as it is deprecated. Use ExclIntvl instead to determine whether intervals are to be excluded or not. The action type (include or exclude).
* - :py:attr:`~ansys.stk.core.stkobjects.AccessConstraintIntervals.file_path`
- Full path and name of file containing the intervals data.
* - :py:attr:`~ansys.stk.core.stkobjects.AccessConstraintIntervals.filename`
@@ -42,12 +40,6 @@ Import detail
Property detail
---------------
-.. py:property:: action_type
- :canonical: ansys.stk.core.stkobjects.AccessConstraintIntervals.action_type
- :type: ActionType
-
- Do not use this property, as it is deprecated. Use ExclIntvl instead to determine whether intervals are to be excluded or not. The action type (include or exclude).
-
.. py:property:: file_path
:canonical: ansys.stk.core.stkobjects.AccessConstraintIntervals.file_path
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintThirdBody.rst b/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintThirdBody.rst
deleted file mode 100644
index 2dcd341be8..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintThirdBody.rst
+++ /dev/null
@@ -1,113 +0,0 @@
-AccessConstraintThirdBody
-=========================
-
-.. py:class:: ansys.stk.core.stkobjects.AccessConstraintThirdBody
-
- Bases: :py:class:`~ansys.stk.core.stkobjects.IAccessConstraint`
-
- Do not use this class, as it is deprecated. Use AccessConstraintCentralBodyObstruction instead. Class defining Central Body Obstruction constraints.
-
-.. py:currentmodule:: AccessConstraintThirdBody
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Methods
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.AccessConstraintThirdBody.add_obstruction`
- - Do not use this method, as it is deprecated. Use AddObstruction on AccessConstraintCentralBodyObstruction instead. Adds an Obstruction by Name.
- * - :py:attr:`~ansys.stk.core.stkobjects.AccessConstraintThirdBody.is_obstruction_assigned`
- - Do not use this method, as it is deprecated. Use IsObstructionAssigned on AccessConstraintCentralBodyObstruction instead. Check whether a third body is already assigned.
- * - :py:attr:`~ansys.stk.core.stkobjects.AccessConstraintThirdBody.remove_obstruction`
- - Do not use this method, as it is deprecated. Use RemoveObstruction on AccessConstraintCentralBodyObstruction instead. Remove an Obstruction by Name.
-
- .. tab-item:: Properties
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.AccessConstraintThirdBody.assigned_obstructions`
- - Do not use this property, as it is deprecated. Use AssignedObstructions on AccessConstraintCentralBodyObstruction instead. Gets the Assigned Obstructions.
- * - :py:attr:`~ansys.stk.core.stkobjects.AccessConstraintThirdBody.available_obstructions`
- - Do not use this property, as it is deprecated. Use AvailableObstructions on AccessConstraintCentralBodyObstruction instead. Gets the Available Obstructions.
-
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects import AccessConstraintThirdBody
-
-
-Property detail
----------------
-
-.. py:property:: assigned_obstructions
- :canonical: ansys.stk.core.stkobjects.AccessConstraintThirdBody.assigned_obstructions
- :type: list
-
- Do not use this property, as it is deprecated. Use AssignedObstructions on AccessConstraintCentralBodyObstruction instead. Gets the Assigned Obstructions.
-
-.. py:property:: available_obstructions
- :canonical: ansys.stk.core.stkobjects.AccessConstraintThirdBody.available_obstructions
- :type: list
-
- Do not use this property, as it is deprecated. Use AvailableObstructions on AccessConstraintCentralBodyObstruction instead. Gets the Available Obstructions.
-
-
-Method detail
--------------
-
-.. py:method:: add_obstruction(self, obstruction: str) -> None
- :canonical: ansys.stk.core.stkobjects.AccessConstraintThirdBody.add_obstruction
-
- Do not use this method, as it is deprecated. Use AddObstruction on AccessConstraintCentralBodyObstruction instead. Adds an Obstruction by Name.
-
- :Parameters:
-
- **obstruction** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-
-
-.. py:method:: is_obstruction_assigned(self, obstruction: str) -> bool
- :canonical: ansys.stk.core.stkobjects.AccessConstraintThirdBody.is_obstruction_assigned
-
- Do not use this method, as it is deprecated. Use IsObstructionAssigned on AccessConstraintCentralBodyObstruction instead. Check whether a third body is already assigned.
-
- :Parameters:
-
- **obstruction** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~bool`
-
-.. py:method:: remove_obstruction(self, obstruction: str) -> None
- :canonical: ansys.stk.core.stkobjects.AccessConstraintThirdBody.remove_obstruction
-
- Do not use this method, as it is deprecated. Use RemoveObstruction on AccessConstraintCentralBodyObstruction instead. Remove an Obstruction by Name.
-
- :Parameters:
-
- **obstruction** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintType.rst b/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintType.rst
index 057677c458..ccc2e50d86 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintType.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/AccessConstraintType.rst
@@ -34,9 +34,6 @@ Overview
* - :py:attr:`~APPARENT_TIME`
- Apparent time. Use interface IAccessConstraintMinMaxBase.
- * - :py:attr:`~AREA_TARGET_CENTROID_ELEVATION_ANGLE`
- - Do not use this enumeration, as it is deprecated. Area Target centroid elevation angle. Use interface IAccessConstraintMinMaxBase.
-
* - :py:attr:`~AZIMUTH_ANGLE`
- Azimuth angle. Use interface IAccessConstraintMinMaxBase.
@@ -202,18 +199,6 @@ Overview
* - :py:attr:`~SUN_SPECULAR_EXCLUSION_ANGLE`
- Sun specular exclusion. Use interface AccessConstraintAngle.
- * - :py:attr:`~THIRD_BODY_OBSTRUCTION`
- - Do not use this enumeration, as it is deprecated. Third body obstruction. Use interface AccessConstraintThirdBody.
-
- * - :py:attr:`~CENTROID_AZIMUTH_ANGLE`
- - Do not use this enumeration, as it is deprecated. Centroid azimuth angle. Use interface IAccessConstraintMinMaxBase.
-
- * - :py:attr:`~CENTROID_RANGE`
- - Do not use this enumeration, as it is deprecated. Centroid range. Use interface IAccessConstraintMinMaxBase.
-
- * - :py:attr:`~CENTROID_SUN_ELEVATION_ANGLE`
- - Do not use this enumeration, as it is deprecated. Centroid sun elevation angle. Use interface IAccessConstraintMinMaxBase.
-
* - :py:attr:`~COLLECTION_ANGLE`
- Collection angle. Use interface IAccessConstraintMinMaxBase.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ActionType.rst b/doc/source/api/ansys/stk/core/stkobjects/ActionType.rst
deleted file mode 100644
index 7316f353a7..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/ActionType.rst
+++ /dev/null
@@ -1,36 +0,0 @@
-ActionType
-==========
-
-.. py:class:: ansys.stk.core.stkobjects.ActionType
-
- IntEnum
-
-
-.. py:currentmodule:: ActionType
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Members
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~INCLUDE`
- - Include time intervals during which the constraint is satisfied.
-
- * - :py:attr:`~EXCLUDE`
- - Exclude time intervals during which the constraint is satisfied.
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects import ActionType
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/Aircraft.rst b/doc/source/api/ansys/stk/core/stkobjects/Aircraft.rst
index 4240f6bd37..651dd64b4f 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/Aircraft.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/Aircraft.rst
@@ -20,8 +20,8 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.Aircraft.atmosphere`
- - Do not use this property, as it is deprecated. The new RFEnvironment property can be used to configure atmospheric models.
+ * - :py:attr:`~ansys.stk.core.stkobjects.Aircraft.chain_analysis_options`
+ - Get the aircraft's chain analysis options.
* - :py:attr:`~ansys.stk.core.stkobjects.Aircraft.export_tools`
- Return the AircraftExportTools interface.
* - :py:attr:`~ansys.stk.core.stkobjects.Aircraft.get_eoir_settings`
@@ -36,8 +36,6 @@ Overview
- Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is false. Uses Time Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.Aircraft.lighting_maximum_step_terrain`
- Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
- * - :py:attr:`~ansys.stk.core.stkobjects.Aircraft.radar_clutter_map`
- - Return the radar clutter map.
* - :py:attr:`~ansys.stk.core.stkobjects.Aircraft.radar_cross_section`
- Return the radar cross sectoin.
* - :py:attr:`~ansys.stk.core.stkobjects.Aircraft.rf_environment`
@@ -113,11 +111,11 @@ Import detail
Property detail
---------------
-.. py:property:: atmosphere
- :canonical: ansys.stk.core.stkobjects.Aircraft.atmosphere
- :type: Atmosphere
+.. py:property:: chain_analysis_options
+ :canonical: ansys.stk.core.stkobjects.Aircraft.chain_analysis_options
+ :type: ChainAnalysisOptions
- Do not use this property, as it is deprecated. The new RFEnvironment property can be used to configure atmospheric models.
+ Get the aircraft's chain analysis options.
.. py:property:: export_tools
:canonical: ansys.stk.core.stkobjects.Aircraft.export_tools
@@ -161,12 +159,6 @@ Property detail
Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
-.. py:property:: radar_clutter_map
- :canonical: ansys.stk.core.stkobjects.Aircraft.radar_clutter_map
- :type: IRadarClutterMapInheritable
-
- Return the radar clutter map.
-
.. py:property:: radar_cross_section
:canonical: ansys.stk.core.stkobjects.Aircraft.radar_cross_section
:type: RadarCrossSectionInheritable
@@ -175,7 +167,7 @@ Property detail
.. py:property:: rf_environment
:canonical: ansys.stk.core.stkobjects.Aircraft.rf_environment
- :type: IPlatformRFEnvironment
+ :type: PlatformRFEnvironment
Get the RF environment.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/Antenna.rst b/doc/source/api/ansys/stk/core/stkobjects/Antenna.rst
index 94e7dafc07..74cbe5e6cd 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/Antenna.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/Antenna.rst
@@ -22,8 +22,6 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.Antenna.is_refraction_type_supported`
- Get a value indicating whether the specified type can be used.
- * - :py:attr:`~ansys.stk.core.stkobjects.Antenna.set_model`
- - Do not use this method, as it is deprecated. Use ModelComponentLinking on Antenna instead. Sets the current antenna model by name.
.. tab-item:: Properties
@@ -31,14 +29,14 @@ Overview
:header-rows: 0
:widths: auto
+ * - :py:attr:`~ansys.stk.core.stkobjects.Antenna.chain_analysis_options`
+ - Get the antenna's chain analysis options.
* - :py:attr:`~ansys.stk.core.stkobjects.Antenna.graphics`
- Get the 2D Graphics properties for the antenna.
* - :py:attr:`~ansys.stk.core.stkobjects.Antenna.graphics_3d`
- Get the 3D Graphics properties for the antenna.
* - :py:attr:`~ansys.stk.core.stkobjects.Antenna.laser_environment`
- Get the object laser environment settings.
- * - :py:attr:`~ansys.stk.core.stkobjects.Antenna.model`
- - Do not use this property, as it is deprecated. Use ModelComponentLinking on Antenna instead. Gets the current antenna model.
* - :py:attr:`~ansys.stk.core.stkobjects.Antenna.model_component_linking`
- Get the link/embed controller for managing the antenna model component.
* - :py:attr:`~ansys.stk.core.stkobjects.Antenna.orientation`
@@ -51,8 +49,6 @@ Overview
- Return an array of valid choices.
* - :py:attr:`~ansys.stk.core.stkobjects.Antenna.rf_environment`
- Get the object RF environment settings.
- * - :py:attr:`~ansys.stk.core.stkobjects.Antenna.supported_models`
- - Do not use this property, as it is deprecated. Use ModelComponentLinking on Antenna instead. Gets an array of supported model names.
* - :py:attr:`~ansys.stk.core.stkobjects.Antenna.use_refraction_in_access`
- Flag controls whether refraction is applied when computing relative position in Access.
@@ -105,8 +101,8 @@ Modify Antenna Model Type
.. code-block:: python
# Antenna antenna: Antenna object
- antenna.set_model("Dipole")
- antennaModel = antenna.model
+ antenna.model_component_linking.set_component("Dipole")
+ antennaModel = antenna.model_component_linking.component
antennaModel.design_frequency = 15 # GHz
antennaModel.length = 1.5 # m
antennaModel.length_to_wavelength_ratio = 45
@@ -132,6 +128,12 @@ Import detail
Property detail
---------------
+.. py:property:: chain_analysis_options
+ :canonical: ansys.stk.core.stkobjects.Antenna.chain_analysis_options
+ :type: ChainAnalysisOptions
+
+ Get the antenna's chain analysis options.
+
.. py:property:: graphics
:canonical: ansys.stk.core.stkobjects.Antenna.graphics
:type: AntennaGraphics
@@ -150,12 +152,6 @@ Property detail
Get the object laser environment settings.
-.. py:property:: model
- :canonical: ansys.stk.core.stkobjects.Antenna.model
- :type: IAntennaModel
-
- Do not use this property, as it is deprecated. Use ModelComponentLinking on Antenna instead. Gets the current antenna model.
-
.. py:property:: model_component_linking
:canonical: ansys.stk.core.stkobjects.Antenna.model_component_linking
:type: IComponentLinkEmbedControl
@@ -192,12 +188,6 @@ Property detail
Get the object RF environment settings.
-.. py:property:: supported_models
- :canonical: ansys.stk.core.stkobjects.Antenna.supported_models
- :type: list
-
- Do not use this property, as it is deprecated. Use ModelComponentLinking on Antenna instead. Gets an array of supported model names.
-
.. py:property:: use_refraction_in_access
:canonical: ansys.stk.core.stkobjects.Antenna.use_refraction_in_access
:type: bool
@@ -209,6 +199,7 @@ Method detail
-------------
+
.. py:method:: is_refraction_type_supported(self, model: SensorRefractionType) -> bool
:canonical: ansys.stk.core.stkobjects.Antenna.is_refraction_type_supported
@@ -233,21 +224,5 @@ Method detail
-.. py:method:: set_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.Antenna.set_model
-
- Do not use this method, as it is deprecated. Use ModelComponentLinking on Antenna instead. Sets the current antenna model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/AntennaControl.rst b/doc/source/api/ansys/stk/core/stkobjects/AntennaControl.rst
index 6c9daf20df..8c55396e4f 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/AntennaControl.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/AntennaControl.rst
@@ -12,23 +12,12 @@ Overview
.. tab-set::
- .. tab-item:: Methods
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.AntennaControl.set_embedded_model`
- - Do not use this method, as it is deprecated. Use EmbeddedModelComponentLinking on AntennaControl instead. Sets the current antenna model by name.
-
.. tab-item:: Properties
.. list-table::
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.AntennaControl.embedded_model`
- - Do not use this property, as it is deprecated. Use EmbeddedModelComponentLinking on AntennaControl instead. Gets the current antenna model.
* - :py:attr:`~ansys.stk.core.stkobjects.AntennaControl.embedded_model_component_linking`
- Get the link/embed controller for managing the embedded antenna model component.
* - :py:attr:`~ansys.stk.core.stkobjects.AntennaControl.embedded_model_orientation`
@@ -37,8 +26,6 @@ Overview
- Get or set the linked antenna object.
* - :py:attr:`~ansys.stk.core.stkobjects.AntennaControl.reference_type`
- Get or set the antenna control reference type.
- * - :py:attr:`~ansys.stk.core.stkobjects.AntennaControl.supported_embedded_models`
- - Do not use this property, as it is deprecated. Use EmbeddedModelComponentLinking on AntennaControl instead. Gets an array of supported model names.
* - :py:attr:`~ansys.stk.core.stkobjects.AntennaControl.supported_linked_antenna_objects`
- Get an array of available antenna objects that this object can link to and use.
@@ -55,12 +42,6 @@ Import detail
Property detail
---------------
-.. py:property:: embedded_model
- :canonical: ansys.stk.core.stkobjects.AntennaControl.embedded_model
- :type: IAntennaModel
-
- Do not use this property, as it is deprecated. Use EmbeddedModelComponentLinking on AntennaControl instead. Gets the current antenna model.
-
.. py:property:: embedded_model_component_linking
:canonical: ansys.stk.core.stkobjects.AntennaControl.embedded_model_component_linking
:type: IComponentLinkEmbedControl
@@ -85,12 +66,6 @@ Property detail
Get or set the antenna control reference type.
-.. py:property:: supported_embedded_models
- :canonical: ansys.stk.core.stkobjects.AntennaControl.supported_embedded_models
- :type: list
-
- Do not use this property, as it is deprecated. Use EmbeddedModelComponentLinking on AntennaControl instead. Gets an array of supported model names.
-
.. py:property:: supported_linked_antenna_objects
:canonical: ansys.stk.core.stkobjects.AntennaControl.supported_linked_antenna_objects
:type: list
@@ -98,30 +73,3 @@ Property detail
Get an array of available antenna objects that this object can link to and use.
-Method detail
--------------
-
-
-
-
-
-
-
-
-
-.. py:method:: set_embedded_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.AntennaControl.set_embedded_model
-
- Do not use this method, as it is deprecated. Use EmbeddedModelComponentLinking on AntennaControl instead. Sets the current antenna model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/AntennaVolumeGraphics.rst b/doc/source/api/ansys/stk/core/stkobjects/AntennaVolumeGraphics.rst
index 00f68d924c..ace98edea9 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/AntennaVolumeGraphics.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/AntennaVolumeGraphics.rst
@@ -49,8 +49,6 @@ Overview
- Get the elevation start value.
* - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.elevation_stop`
- Get the elevation stop value.
- * - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.gain_offset`
- - Do not use this property, as it is deprecated. Use the MinimumDisplayedGain property instead. Gets or sets the gain offset value.
* - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.gain_scale`
- Get or set the gain scale value.
* - :py:attr:`~ansys.stk.core.stkobjects.AntennaVolumeGraphics.levels`
@@ -141,12 +139,6 @@ Property detail
Get the elevation stop value.
-.. py:property:: gain_offset
- :canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.gain_offset
- :type: float
-
- Do not use this property, as it is deprecated. Use the MinimumDisplayedGain property instead. Gets or sets the gain offset value.
-
.. py:property:: gain_scale
:canonical: ansys.stk.core.stkobjects.AntennaVolumeGraphics.gain_scale
:type: float
@@ -216,8 +208,6 @@ Method detail
-
-
.. py:method:: set_number_of_points(self, azimuth_start: float, azimuth_stop: float, azimuth_num_points: int, elevation_start: float, elevation_stop: float, elevation_num_points: int) -> None
diff --git a/doc/source/api/ansys/stk/core/stkobjects/AreaTarget.rst b/doc/source/api/ansys/stk/core/stkobjects/AreaTarget.rst
index 18e2e7303f..a7d9217586 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/AreaTarget.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/AreaTarget.rst
@@ -30,6 +30,8 @@ Overview
- Get the data defining the boundary with the selected method.
* - :py:attr:`~ansys.stk.core.stkobjects.AreaTarget.automatic_computation_of_centroid`
- Opt whether to have the centroid automatically computed.
+ * - :py:attr:`~ansys.stk.core.stkobjects.AreaTarget.chain_analysis_options`
+ - Get the area target's chain analysis options.
* - :py:attr:`~ansys.stk.core.stkobjects.AreaTarget.common_tasks`
- Common tasks associated with AreaTargets.
* - :py:attr:`~ansys.stk.core.stkobjects.AreaTarget.graphics`
@@ -183,6 +185,12 @@ Property detail
Opt whether to have the centroid automatically computed.
+.. py:property:: chain_analysis_options
+ :canonical: ansys.stk.core.stkobjects.AreaTarget.chain_analysis_options
+ :type: ChainAnalysisOptions
+
+ Get the area target's chain analysis options.
+
.. py:property:: common_tasks
:canonical: ansys.stk.core.stkobjects.AreaTarget.common_tasks
:type: AreaTargetCommonTasks
diff --git a/doc/source/api/ansys/stk/core/stkobjects/Atmosphere.rst b/doc/source/api/ansys/stk/core/stkobjects/Atmosphere.rst
deleted file mode 100644
index 247ba1837c..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/Atmosphere.rst
+++ /dev/null
@@ -1,140 +0,0 @@
-Atmosphere
-==========
-
-.. py:class:: ansys.stk.core.stkobjects.Atmosphere
-
- Bases: :py:class:`~ansys.stk.core.stkobjects.IPlatformRFEnvironment`
-
- Class defining local atmosphere.
-
-.. py:currentmodule:: Atmosphere
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Methods
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.Atmosphere.set_local_atmospheric_absorption_model`
- - Do not use this method, as it is deprecated. Use the PropagationChannel property to set the atmospheric absorption model.
-
- .. tab-item:: Properties
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.Atmosphere.enable_local_rain_data`
- - Get or set the option for enabling local rain data.
- * - :py:attr:`~ansys.stk.core.stkobjects.Atmosphere.inherit_atmospheric_absorption_model`
- - Do not use this property, as it is deprecated. Use the PropagationChannel property to enable or disable the atmospheric absorption model.
- * - :py:attr:`~ansys.stk.core.stkobjects.Atmosphere.local_atmospheric_absorption_model`
- - Do not use this property, as it is deprecated. Use the PropagationChannel property to get the atmospheric absorption model.
- * - :py:attr:`~ansys.stk.core.stkobjects.Atmosphere.local_rain_height`
- - Get or set the local rain iso height.
- * - :py:attr:`~ansys.stk.core.stkobjects.Atmosphere.local_rain_rate`
- - Get or set the local rain rate.
- * - :py:attr:`~ansys.stk.core.stkobjects.Atmosphere.local_surface_temperature`
- - Do not use this property, as it is deprecated. Gets or sets the local surface temperature.
- * - :py:attr:`~ansys.stk.core.stkobjects.Atmosphere.propagation_channel`
- - Get the propagation channel.
- * - :py:attr:`~ansys.stk.core.stkobjects.Atmosphere.supported_local_atmospheric_absorption_models`
- - Do not use this property, as it is deprecated. Use the PropagationChannel property to determine the supported atmospheric absorption models.
-
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects import Atmosphere
-
-
-Property detail
----------------
-
-.. py:property:: enable_local_rain_data
- :canonical: ansys.stk.core.stkobjects.Atmosphere.enable_local_rain_data
- :type: bool
-
- Get or set the option for enabling local rain data.
-
-.. py:property:: inherit_atmospheric_absorption_model
- :canonical: ansys.stk.core.stkobjects.Atmosphere.inherit_atmospheric_absorption_model
- :type: bool
-
- Do not use this property, as it is deprecated. Use the PropagationChannel property to enable or disable the atmospheric absorption model.
-
-.. py:property:: local_atmospheric_absorption_model
- :canonical: ansys.stk.core.stkobjects.Atmosphere.local_atmospheric_absorption_model
- :type: IAtmosphericAbsorptionModel
-
- Do not use this property, as it is deprecated. Use the PropagationChannel property to get the atmospheric absorption model.
-
-.. py:property:: local_rain_height
- :canonical: ansys.stk.core.stkobjects.Atmosphere.local_rain_height
- :type: float
-
- Get or set the local rain iso height.
-
-.. py:property:: local_rain_rate
- :canonical: ansys.stk.core.stkobjects.Atmosphere.local_rain_rate
- :type: float
-
- Get or set the local rain rate.
-
-.. py:property:: local_surface_temperature
- :canonical: ansys.stk.core.stkobjects.Atmosphere.local_surface_temperature
- :type: float
-
- Do not use this property, as it is deprecated. Gets or sets the local surface temperature.
-
-.. py:property:: propagation_channel
- :canonical: ansys.stk.core.stkobjects.Atmosphere.propagation_channel
- :type: PropagationChannel
-
- Get the propagation channel.
-
-.. py:property:: supported_local_atmospheric_absorption_models
- :canonical: ansys.stk.core.stkobjects.Atmosphere.supported_local_atmospheric_absorption_models
- :type: list
-
- Do not use this property, as it is deprecated. Use the PropagationChannel property to determine the supported atmospheric absorption models.
-
-
-Method detail
--------------
-
-
-
-
-
-
-
-
-
-
-
-
-
-.. py:method:: set_local_atmospheric_absorption_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.Atmosphere.set_local_atmospheric_absorption_model
-
- Do not use this method, as it is deprecated. Use the PropagationChannel property to set the atmospheric absorption model.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/AtmosphericAbsorptionModelGraphics3DACAP.rst b/doc/source/api/ansys/stk/core/stkobjects/AtmosphericAbsorptionModelGraphics3DACAP.rst
index 7661490726..e8dea7c648 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/AtmosphericAbsorptionModelGraphics3DACAP.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/AtmosphericAbsorptionModelGraphics3DACAP.rst
@@ -32,8 +32,6 @@ Overview
- Get or set the solar activity configuration.
* - :py:attr:`~ansys.stk.core.stkobjects.AtmosphericAbsorptionModelGraphics3DACAP.solar_activity_configuration_type`
- Get or set the solar activity configuration enumeration.
- * - :py:attr:`~ansys.stk.core.stkobjects.AtmosphericAbsorptionModelGraphics3DACAP.sunspot_number`
- - Do not use this property, as it is deprecated. The Sunspot Number Solar Activity Configuration should be used instead.
* - :py:attr:`~ansys.stk.core.stkobjects.AtmosphericAbsorptionModelGraphics3DACAP.use_day_of_month_average`
- Get or set the indicator to use day of month average.
@@ -86,12 +84,6 @@ Property detail
Get or set the solar activity configuration enumeration.
-.. py:property:: sunspot_number
- :canonical: ansys.stk.core.stkobjects.AtmosphericAbsorptionModelGraphics3DACAP.sunspot_number
- :type: int
-
- Do not use this property, as it is deprecated. The Sunspot Number Solar Activity Configuration should be used instead.
-
.. py:property:: use_day_of_month_average
:canonical: ansys.stk.core.stkobjects.AtmosphericAbsorptionModelGraphics3DACAP.use_day_of_month_average
:type: bool
diff --git a/doc/source/api/ansys/stk/core/stkobjects/AtmosphericAbsorptionModelITURP676Version13.rst b/doc/source/api/ansys/stk/core/stkobjects/AtmosphericAbsorptionModelITURP676Version13.rst
index 8e58f2a224..0a4378e82d 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/AtmosphericAbsorptionModelITURP676Version13.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/AtmosphericAbsorptionModelITURP676Version13.rst
@@ -3,12 +3,31 @@ AtmosphericAbsorptionModelITURP676Version13
.. py:class:: ansys.stk.core.stkobjects.AtmosphericAbsorptionModelITURP676Version13
- Bases: :py:class:`~ansys.stk.core.stkobjects.IAtmosphericAbsorptionModelITURP676`, :py:class:`~ansys.stk.core.stkobjects.IAtmosphericAbsorptionModel`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`
+ Bases: :py:class:`~ansys.stk.core.stkobjects.IAtmosphericAbsorptionModel`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`
Class defining an atmospheric absorption model.
.. py:currentmodule:: AtmosphericAbsorptionModelITURP676Version13
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Properties
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.AtmosphericAbsorptionModelITURP676Version13.atmosphere_data_type`
+ - Get or set the atmosphere data type.
+ * - :py:attr:`~ansys.stk.core.stkobjects.AtmosphericAbsorptionModelITURP676Version13.fast_approximation_method`
+ - Get or set the option for using the fast approximation method.
+ * - :py:attr:`~ansys.stk.core.stkobjects.AtmosphericAbsorptionModelITURP676Version13.use_water_vapor_from_section2_2`
+ - Get or set the use of P.676-13 Section 2.2 for water vapor computations.
+
+
Import detail
-------------
@@ -18,4 +37,25 @@ Import detail
from ansys.stk.core.stkobjects import AtmosphericAbsorptionModelITURP676Version13
+Property detail
+---------------
+
+.. py:property:: atmosphere_data_type
+ :canonical: ansys.stk.core.stkobjects.AtmosphericAbsorptionModelITURP676Version13.atmosphere_data_type
+ :type: ITURP676AtmosphereDataType
+
+ Get or set the atmosphere data type.
+
+.. py:property:: fast_approximation_method
+ :canonical: ansys.stk.core.stkobjects.AtmosphericAbsorptionModelITURP676Version13.fast_approximation_method
+ :type: bool
+
+ Get or set the option for using the fast approximation method.
+
+.. py:property:: use_water_vapor_from_section2_2
+ :canonical: ansys.stk.core.stkobjects.AtmosphericAbsorptionModelITURP676Version13.use_water_vapor_from_section2_2
+ :type: bool
+
+ Get or set the use of P.676-13 Section 2.2 for water vapor computations.
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/AtmosphericAbsorptionModelITURP676Version9.rst b/doc/source/api/ansys/stk/core/stkobjects/AtmosphericAbsorptionModelITURP676Version9.rst
index b54b10dc57..304d387fb4 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/AtmosphericAbsorptionModelITURP676Version9.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/AtmosphericAbsorptionModelITURP676Version9.rst
@@ -3,12 +3,29 @@ AtmosphericAbsorptionModelITURP676Version9
.. py:class:: ansys.stk.core.stkobjects.AtmosphericAbsorptionModelITURP676Version9
- Bases: :py:class:`~ansys.stk.core.stkobjects.IAtmosphericAbsorptionModelITURP676`, :py:class:`~ansys.stk.core.stkobjects.IAtmosphericAbsorptionModel`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`
+ Bases: :py:class:`~ansys.stk.core.stkobjects.IAtmosphericAbsorptionModel`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`
Class defining an atmospheric absorption model.
.. py:currentmodule:: AtmosphericAbsorptionModelITURP676Version9
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Properties
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.AtmosphericAbsorptionModelITURP676Version9.fast_approximation_method`
+ - Get or set the option for using the fast approximation method.
+ * - :py:attr:`~ansys.stk.core.stkobjects.AtmosphericAbsorptionModelITURP676Version9.seasonal_regional_method`
+ - Get or set the option for using the seasonal/regional method.
+
+
Import detail
-------------
@@ -18,4 +35,19 @@ Import detail
from ansys.stk.core.stkobjects import AtmosphericAbsorptionModelITURP676Version9
+Property detail
+---------------
+
+.. py:property:: fast_approximation_method
+ :canonical: ansys.stk.core.stkobjects.AtmosphericAbsorptionModelITURP676Version9.fast_approximation_method
+ :type: bool
+
+ Get or set the option for using the fast approximation method.
+
+.. py:property:: seasonal_regional_method
+ :canonical: ansys.stk.core.stkobjects.AtmosphericAbsorptionModelITURP676Version9.seasonal_regional_method
+ :type: bool
+
+ Get or set the option for using the seasonal/regional method.
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/AtmosphericDensityModel.rst b/doc/source/api/ansys/stk/core/stkobjects/AtmosphericDensityModel.rst
index 78370418c9..e6dfbb3620 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/AtmosphericDensityModel.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/AtmosphericDensityModel.rst
@@ -25,9 +25,6 @@ Overview
* - :py:attr:`~CIRA72`
- CIRA 1972: empirical model of atmospheric temperature and densities as recommended by the Committee on Space Research (COSPAR). Lower altitude boundary is 90 km.
- * - :py:attr:`~EXPONENTIAL_MODEL`
- - Do not use this enumeration, as it is deprecated. Exponential Model: uses equation calculating atmospheric density on basis of a specified altitude, reference density, reference altitude and scale altitude.
-
* - :py:attr:`~HARRIS_PRIESTER`
- Harris-Priester: takes into account a 10.7 cm solar flux level and diurnal bulge. Uses density tables. Valid range of 0-1000 km.
@@ -55,9 +52,6 @@ Overview
* - :py:attr:`~UNKNOWN`
- Unsupported or unknown atmospheric density model.
- * - :py:attr:`~USER_DEFINED`
- - Do not use this enumeration, as it is deprecated. This option is no longer available for VehicleHPOPForceModelDrag. User-defined atmospheric density model.
-
* - :py:attr:`~DTM2012`
- DTM 2012: The Drag Temperature Model (DTM), 2012 version, is a semi-empirical model which computes the temperature, density, and composition of the thermosphere. Developed at CNES. Valid range of 120 - 1500 km.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/AttitudeStandardOrbit.rst b/doc/source/api/ansys/stk/core/stkobjects/AttitudeStandardOrbit.rst
index c2be317d9c..677d64b901 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/AttitudeStandardOrbit.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/AttitudeStandardOrbit.rst
@@ -40,7 +40,7 @@ Set satellite attitude external
# Satellite satellite: Satellite object
if os.name == "nt":
- installPath = r"C:\Program Files\AGI\STK 12"
+ installPath = r"C:\Program Files\AGI\STK_ODTK 13"
else:
installPath = os.environ["STK_INSTALL_DIR"]
satellite.attitude.external.load(
diff --git a/doc/source/api/ansys/stk/core/stkobjects/Chain.rst b/doc/source/api/ansys/stk/core/stkobjects/Chain.rst
index 8a1f207378..84440b3a16 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/Chain.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/Chain.rst
@@ -69,8 +69,6 @@ Overview
- Maximum number of objects in all strands for the Chain.
* - :py:attr:`~ansys.stk.core.stkobjects.Chain.maximum_time_step`
- Get or set the maximum sampling step size used when computing the chain. The maximum step size limits the amount of time that is allowed to elapse between sampling of the constraint functions during access computations. Uses Time Dimension.
- * - :py:attr:`~ansys.stk.core.stkobjects.Chain.objects`
- - Do not use this property, as it is deprecated. Use the StartObject, EndObject and Connections properties to configure objects in the chain.
* - :py:attr:`~ansys.stk.core.stkobjects.Chain.optimal_strand_opts`
- Optimal strands settings for the Chain.
* - :py:attr:`~ansys.stk.core.stkobjects.Chain.recompute_automatically`
@@ -135,8 +133,8 @@ Define and compute a chain (advanced)
chain.clear_access()
# Add some objects to chain
- chain.objects.add("Facility/MyFacility")
- chain.objects.add_object(satellite)
+ chain.start_object = facility
+ chain.end_object = satellite
# Configure chain parameters
chain.recompute_automatically = False
@@ -164,9 +162,9 @@ Define and compute a chain (basic)
# Chain chain: Chain object
- # Add some objects to chain (using STK path)
- chain.objects.add("Facility/MyFacility")
- chain.objects.add("Satellite/MySatellite")
+ # Add some objects to chain
+ chain.start_object = facility
+ chain.end_object = satellite
# Compute the chain
chain.compute_access()
@@ -289,12 +287,6 @@ Property detail
Get or set the maximum sampling step size used when computing the chain. The maximum step size limits the amount of time that is allowed to elapse between sampling of the constraint functions during access computations. Uses Time Dimension.
-.. py:property:: objects
- :canonical: ansys.stk.core.stkobjects.Chain.objects
- :type: ObjectLinkCollection
-
- Do not use this property, as it is deprecated. Use the StartObject, EndObject and Connections properties to configure objects in the chain.
-
.. py:property:: optimal_strand_opts
:canonical: ansys.stk.core.stkobjects.Chain.optimal_strand_opts
:type: ChainOptimalStrandOpts
@@ -385,7 +377,6 @@ Method detail
-
.. py:method:: reset_access_intervals_file(self) -> None
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ChainAnalysisOptions.rst b/doc/source/api/ansys/stk/core/stkobjects/ChainAnalysisOptions.rst
new file mode 100644
index 0000000000..3e3ac790ba
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/ChainAnalysisOptions.rst
@@ -0,0 +1,51 @@
+ChainAnalysisOptions
+====================
+
+.. py:class:: ansys.stk.core.stkobjects.ChainAnalysisOptions
+
+ Class containing analysis options for an object when computing optimal strands of a chain.
+
+.. py:currentmodule:: ChainAnalysisOptions
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Properties
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.ChainAnalysisOptions.data_rate`
+ - The data rate used for this object when computing optimal strands.
+ * - :py:attr:`~ansys.stk.core.stkobjects.ChainAnalysisOptions.processing_delay_time`
+ - The processing delay time used for this object when computing optimal strands.
+
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects import ChainAnalysisOptions
+
+
+Property detail
+---------------
+
+.. py:property:: data_rate
+ :canonical: ansys.stk.core.stkobjects.ChainAnalysisOptions.data_rate
+ :type: float
+
+ The data rate used for this object when computing optimal strands.
+
+.. py:property:: processing_delay_time
+ :canonical: ansys.stk.core.stkobjects.ChainAnalysisOptions.processing_delay_time
+ :type: float
+
+ The processing delay time used for this object when computing optimal strands.
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ChainGraphics2DAnimation.rst b/doc/source/api/ansys/stk/core/stkobjects/ChainGraphics2DAnimation.rst
index 0326424f8f..bd3b2b2f58 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ChainGraphics2DAnimation.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ChainGraphics2DAnimation.rst
@@ -26,8 +26,6 @@ Overview
- Get or set the width of the valid strand lines used in animation graphics.
* - :py:attr:`~ansys.stk.core.stkobjects.ChainGraphics2DAnimation.number_of_optimal_strands_to_display`
- The number of animation optimal strands lines to show.
- * - :py:attr:`~ansys.stk.core.stkobjects.ChainGraphics2DAnimation.optimal_path_color`
- - Do not use this property, as it is deprecated. Use OptimalPathColorRampStartColor. Gets or sets the color in which the optimal strands lines are to be displayed during animation.
* - :py:attr:`~ansys.stk.core.stkobjects.ChainGraphics2DAnimation.optimal_path_color_ramp_end_color`
- The end color for the color ramp in which the optimal strands lines are to be displayed during animation.
* - :py:attr:`~ansys.stk.core.stkobjects.ChainGraphics2DAnimation.optimal_path_color_ramp_start_color`
@@ -82,12 +80,6 @@ Property detail
The number of animation optimal strands lines to show.
-.. py:property:: optimal_path_color
- :canonical: ansys.stk.core.stkobjects.ChainGraphics2DAnimation.optimal_path_color
- :type: Color
-
- Do not use this property, as it is deprecated. Use OptimalPathColorRampStartColor. Gets or sets the color in which the optimal strands lines are to be displayed during animation.
-
.. py:property:: optimal_path_color_ramp_end_color
:canonical: ansys.stk.core.stkobjects.ChainGraphics2DAnimation.optimal_path_color_ramp_end_color
:type: Color
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ChainOptimalStrandMetricType.rst b/doc/source/api/ansys/stk/core/stkobjects/ChainOptimalStrandMetricType.rst
index 09a7a8e08a..3700309301 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ChainOptimalStrandMetricType.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ChainOptimalStrandMetricType.rst
@@ -34,6 +34,9 @@ Overview
* - :py:attr:`~STRAND_METRIC_DURATION`
- Chain optimal strand duration metric.
+ * - :py:attr:`~STRAND_METRIC_DATA_RATE`
+ - Chain optimal strand data rate metric.
+
Import detail
-------------
diff --git a/doc/source/api/ansys/stk/core/stkobjects/EphemExportToolFileFormat.rst b/doc/source/api/ansys/stk/core/stkobjects/EphemExportToolFileFormat.rst
index b2c385e605..4a14a3b778 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/EphemExportToolFileFormat.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/EphemExportToolFileFormat.rst
@@ -20,10 +20,10 @@ Overview
:widths: auto
* - :py:attr:`~ORBIT_EPHEMERIS_MESSAGE`
- - The Ephemeris Export tool will generate an Orbit Ephemeris Message (.oem) file following the CCSDS Ephemeris v2.0 standard.
+ - The Ephemeris Export tool will generate an Orbit Ephemeris Message (.oem) file.
* - :py:attr:`~XML`
- - The Ephemeris Export tool will generate an XML file following the CCSDS Ephemeris v2.0 standard.
+ - The Ephemeris Export tool will generate an XML file. Available for CCSDS v2.0 and v3.0 Ephemeris standard only.
Import detail
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ExternalEphemerisFormatType.rst b/doc/source/api/ansys/stk/core/stkobjects/ExternalEphemerisFormatType.rst
index ff1adb1b26..e3ef37019f 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ExternalEphemerisFormatType.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ExternalEphemerisFormatType.rst
@@ -40,6 +40,9 @@ Overview
* - :py:attr:`~CCSDS_V2`
- CCSDS v2 orbit ephemeris file format that ends with '.oem' extension.
+ * - :py:attr:`~CCSDS_V3`
+ - CCSDS v3 orbit ephemeris file format that ends with '.oem' extension.
+
Import detail
-------------
diff --git a/doc/source/api/ansys/stk/core/stkobjects/Facility.rst b/doc/source/api/ansys/stk/core/stkobjects/Facility.rst
index d479e48bc8..8405c94f4d 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/Facility.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/Facility.rst
@@ -39,8 +39,8 @@ Overview
- Get the constraints imposed on the facility.
* - :py:attr:`~ansys.stk.core.stkobjects.Facility.altitude_reference`
- Get or set the altitude reference of the object.
- * - :py:attr:`~ansys.stk.core.stkobjects.Facility.atmosphere`
- - Do not use this property, as it is deprecated. The new RFEnvironment property can be used to configure atmospheric models.
+ * - :py:attr:`~ansys.stk.core.stkobjects.Facility.chain_analysis_options`
+ - Get the facility's chain analysis options.
* - :py:attr:`~ansys.stk.core.stkobjects.Facility.graphics`
- Get the 2D Graphics properties of the facility.
* - :py:attr:`~ansys.stk.core.stkobjects.Facility.graphics_3d`
@@ -59,8 +59,6 @@ Overview
- Get or set the maximum range to use when computing the az el mask using terrain data. Zero indicates to use algorithm default. Only applies when GetAzElMask returns eTerrainData (cannot be set if eMaskFile). Uses Distance Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.Facility.position`
- Get the position of the facility.
- * - :py:attr:`~ansys.stk.core.stkobjects.Facility.radar_clutter_map`
- - Return the radar clutter map.
* - :py:attr:`~ansys.stk.core.stkobjects.Facility.radar_cross_section`
- Return the radar cross sectoin.
* - :py:attr:`~ansys.stk.core.stkobjects.Facility.rf_environment`
@@ -153,11 +151,11 @@ Property detail
Get or set the altitude reference of the object.
-.. py:property:: atmosphere
- :canonical: ansys.stk.core.stkobjects.Facility.atmosphere
- :type: Atmosphere
+.. py:property:: chain_analysis_options
+ :canonical: ansys.stk.core.stkobjects.Facility.chain_analysis_options
+ :type: ChainAnalysisOptions
- Do not use this property, as it is deprecated. The new RFEnvironment property can be used to configure atmospheric models.
+ Get the facility's chain analysis options.
.. py:property:: graphics
:canonical: ansys.stk.core.stkobjects.Facility.graphics
@@ -213,12 +211,6 @@ Property detail
Get the position of the facility.
-.. py:property:: radar_clutter_map
- :canonical: ansys.stk.core.stkobjects.Facility.radar_clutter_map
- :type: IRadarClutterMapInheritable
-
- Return the radar clutter map.
-
.. py:property:: radar_cross_section
:canonical: ansys.stk.core.stkobjects.Facility.radar_cross_section
:type: RadarCrossSectionInheritable
@@ -227,7 +219,7 @@ Property detail
.. py:property:: rf_environment
:canonical: ansys.stk.core.stkobjects.Facility.rf_environment
- :type: IPlatformRFEnvironment
+ :type: PlatformRFEnvironment
Get the RF environment.
@@ -302,7 +294,6 @@ Method detail
-
.. py:method:: reset_az_el_mask(self) -> None
:canonical: ansys.stk.core.stkobjects.Facility.reset_az_el_mask
diff --git a/doc/source/api/ansys/stk/core/stkobjects/FigureOfMeritConstraintName.rst b/doc/source/api/ansys/stk/core/stkobjects/FigureOfMeritConstraintName.rst
index 6b4a1faa61..824f98cea2 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/FigureOfMeritConstraintName.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/FigureOfMeritConstraintName.rst
@@ -172,15 +172,6 @@ Overview
* - :py:attr:`~POINT_METRIC`
- Coordinate Point Metric constraint.
- * - :py:attr:`~CENTROID_AZIMUTH_ANGLE`
- - Do not use this enumeration, as it is deprecated. Centroid Azimuth Angle constraint.
-
- * - :py:attr:`~CENTROID_RANGE`
- - Do not use this enumeration, as it is deprecated. Centroid Range constraint.
-
- * - :py:attr:`~CENTROID_SUN_ELEVATION_ANGLE`
- - Do not use this enumeration, as it is deprecated. Centroid Sun Elevation Angle constraint.
-
* - :py:attr:`~COLLECTION_ANGLE`
- Collection Angle constraint.
@@ -214,9 +205,6 @@ Overview
* - :py:attr:`~BETA_ANGLE`
- Beta Angle constraint.
- * - :py:attr:`~AREA_TARGET_CENTROID_ELEVATION_ANGLE`
- - Do not use this enumeration, as it is deprecated. Area Target Centroid Elevation Angle constraint.
-
* - :py:attr:`~EXCLUSION_ZONE`
- Exclusion Zone constraint.
@@ -529,9 +517,6 @@ Overview
* - :py:attr:`~ACCESS_CONSTRAINT_PLUGIN`
- Access Constraint Plugin constraint.
- * - :py:attr:`~THIRD_BODY_OBS`
- - Do not use this enumeration, as it is deprecated. Third Body Obstruction constraint.
-
* - :py:attr:`~SPECTRAL_FLUX_DENSITY`
- Spectral Flux Density constraint.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/FigureOfMeritGraphics2DColorOptions.rst b/doc/source/api/ansys/stk/core/stkobjects/FigureOfMeritGraphics2DColorOptions.rst
index eb00093f8f..9153db1dbe 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/FigureOfMeritGraphics2DColorOptions.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/FigureOfMeritGraphics2DColorOptions.rst
@@ -18,12 +18,8 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.FigureOfMeritGraphics2DColorOptions.background`
- - Do not use this property, as it is deprecated. Background color of legend.
* - :py:attr:`~ansys.stk.core.stkobjects.FigureOfMeritGraphics2DColorOptions.background_color`
- Background color of legend.
- * - :py:attr:`~ansys.stk.core.stkobjects.FigureOfMeritGraphics2DColorOptions.text`
- - Do not use this property, as it is deprecated. Text color of legend.
* - :py:attr:`~ansys.stk.core.stkobjects.FigureOfMeritGraphics2DColorOptions.text_color`
- Text color of legend.
@@ -40,24 +36,12 @@ Import detail
Property detail
---------------
-.. py:property:: background
- :canonical: ansys.stk.core.stkobjects.FigureOfMeritGraphics2DColorOptions.background
- :type: Color
-
- Do not use this property, as it is deprecated. Background color of legend.
-
.. py:property:: background_color
:canonical: ansys.stk.core.stkobjects.FigureOfMeritGraphics2DColorOptions.background_color
:type: Color
Background color of legend.
-.. py:property:: text
- :canonical: ansys.stk.core.stkobjects.FigureOfMeritGraphics2DColorOptions.text
- :type: Color
-
- Do not use this property, as it is deprecated. Text color of legend.
-
.. py:property:: text_color
:canonical: ansys.stk.core.stkobjects.FigureOfMeritGraphics2DColorOptions.text_color
:type: Color
diff --git a/doc/source/api/ansys/stk/core/stkobjects/GroundVehicle.rst b/doc/source/api/ansys/stk/core/stkobjects/GroundVehicle.rst
index 27de381b0f..1deeff0f78 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/GroundVehicle.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/GroundVehicle.rst
@@ -20,8 +20,8 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.GroundVehicle.atmosphere`
- - Do not use this property, as it is deprecated. The new RFEnvironment property can be used to configure atmospheric models.
+ * - :py:attr:`~ansys.stk.core.stkobjects.GroundVehicle.chain_analysis_options`
+ - Get the ground vehicle's chain analysis options.
* - :py:attr:`~ansys.stk.core.stkobjects.GroundVehicle.export_tools`
- Return the GroundVehicleExportTools interface.
* - :py:attr:`~ansys.stk.core.stkobjects.GroundVehicle.get_eoir_settings`
@@ -36,8 +36,6 @@ Overview
- Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is false. Uses Time Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.GroundVehicle.lighting_maximum_step_terrain`
- Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
- * - :py:attr:`~ansys.stk.core.stkobjects.GroundVehicle.radar_clutter_map`
- - Return the radar clutter map.
* - :py:attr:`~ansys.stk.core.stkobjects.GroundVehicle.radar_cross_section`
- Return the radar cross sectoin.
* - :py:attr:`~ansys.stk.core.stkobjects.GroundVehicle.rf_environment`
@@ -113,11 +111,11 @@ Import detail
Property detail
---------------
-.. py:property:: atmosphere
- :canonical: ansys.stk.core.stkobjects.GroundVehicle.atmosphere
- :type: Atmosphere
+.. py:property:: chain_analysis_options
+ :canonical: ansys.stk.core.stkobjects.GroundVehicle.chain_analysis_options
+ :type: ChainAnalysisOptions
- Do not use this property, as it is deprecated. The new RFEnvironment property can be used to configure atmospheric models.
+ Get the ground vehicle's chain analysis options.
.. py:property:: export_tools
:canonical: ansys.stk.core.stkobjects.GroundVehicle.export_tools
@@ -161,12 +159,6 @@ Property detail
Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
-.. py:property:: radar_clutter_map
- :canonical: ansys.stk.core.stkobjects.GroundVehicle.radar_clutter_map
- :type: IRadarClutterMapInheritable
-
- Return the radar clutter map.
-
.. py:property:: radar_cross_section
:canonical: ansys.stk.core.stkobjects.GroundVehicle.radar_cross_section
:type: RadarCrossSectionInheritable
@@ -175,7 +167,7 @@ Property detail
.. py:property:: rf_environment
:canonical: ansys.stk.core.stkobjects.GroundVehicle.rf_environment
- :type: IPlatformRFEnvironment
+ :type: PlatformRFEnvironment
Get the RF environment.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/IAccessConstraint.rst b/doc/source/api/ansys/stk/core/stkobjects/IAccessConstraint.rst
index 7dbb36a894..f39cbe3b04 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/IAccessConstraint.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/IAccessConstraint.rst
@@ -22,6 +22,8 @@ Overview
- Property used to access the constraint name.
* - :py:attr:`~ansys.stk.core.stkobjects.IAccessConstraint.constraint_type`
- Property used to access the constraint type.
+ * - :py:attr:`~ansys.stk.core.stkobjects.IAccessConstraint.enabled`
+ - Indicate whether the constraint should be considered (true) or ignored (false) in access computations.
* - :py:attr:`~ansys.stk.core.stkobjects.IAccessConstraint.exclusion_interval`
- Exclude Time Intervals.
* - :py:attr:`~ansys.stk.core.stkobjects.IAccessConstraint.is_plugin`
@@ -243,6 +245,12 @@ Property detail
Property used to access the constraint type.
+.. py:property:: enabled
+ :canonical: ansys.stk.core.stkobjects.IAccessConstraint.enabled
+ :type: bool
+
+ Indicate whether the constraint should be considered (true) or ignored (false) in access computations.
+
.. py:property:: exclusion_interval
:canonical: ansys.stk.core.stkobjects.IAccessConstraint.exclusion_interval
:type: bool
diff --git a/doc/source/api/ansys/stk/core/stkobjects/IAtmosphericAbsorptionModelITURP676.rst b/doc/source/api/ansys/stk/core/stkobjects/IAtmosphericAbsorptionModelITURP676.rst
deleted file mode 100644
index 45ade9f7d7..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/IAtmosphericAbsorptionModelITURP676.rst
+++ /dev/null
@@ -1,50 +0,0 @@
-IAtmosphericAbsorptionModelITURP676
-===================================
-
-.. py:class:: ansys.stk.core.stkobjects.IAtmosphericAbsorptionModelITURP676
-
- Provide access to the properties and methods of the ITU-R P676 atmospheric absorption model.
-
-.. py:currentmodule:: IAtmosphericAbsorptionModelITURP676
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Properties
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.IAtmosphericAbsorptionModelITURP676.fast_approximation_method`
- - Get or set the option for using the fast approximation method.
- * - :py:attr:`~ansys.stk.core.stkobjects.IAtmosphericAbsorptionModelITURP676.seasonal_regional_method`
- - Get or set the option for using the seasonal/regional method.
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects import IAtmosphericAbsorptionModelITURP676
-
-
-Property detail
----------------
-
-.. py:property:: fast_approximation_method
- :canonical: ansys.stk.core.stkobjects.IAtmosphericAbsorptionModelITURP676.fast_approximation_method
- :type: bool
-
- Get or set the option for using the fast approximation method.
-
-.. py:property:: seasonal_regional_method
- :canonical: ansys.stk.core.stkobjects.IAtmosphericAbsorptionModelITURP676.seasonal_regional_method
- :type: bool
-
- Get or set the option for using the seasonal/regional method.
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/IGreatArcVehicle.rst b/doc/source/api/ansys/stk/core/stkobjects/IGreatArcVehicle.rst
index d2ddd662cc..832127d055 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/IGreatArcVehicle.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/IGreatArcVehicle.rst
@@ -45,8 +45,6 @@ Overview
- Get the customized list of Eclipse Bodies, which are central bodies used in lighting computations.
* - :py:attr:`~ansys.stk.core.stkobjects.IGreatArcVehicle.ground_ellipses`
- Get the ground ellipses properties.
- * - :py:attr:`~ansys.stk.core.stkobjects.IGreatArcVehicle.lighting_maximum_step`
- - Do not use this property, as it is deprecated. Use LightingMaxStepTerrain or LightingMaxStepCbShape as appropriate. The maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.IGreatArcVehicle.route`
- Get the route properties.
* - :py:attr:`~ansys.stk.core.stkobjects.IGreatArcVehicle.route_supported_types`
@@ -104,12 +102,6 @@ Property detail
Get the ground ellipses properties.
-.. py:property:: lighting_maximum_step
- :canonical: ansys.stk.core.stkobjects.IGreatArcVehicle.lighting_maximum_step
- :type: float
-
- Do not use this property, as it is deprecated. Use LightingMaxStepTerrain or LightingMaxStepCbShape as appropriate. The maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
-
.. py:property:: route
:canonical: ansys.stk.core.stkobjects.IGreatArcVehicle.route
:type: IPropagator
@@ -175,8 +167,6 @@ Method detail
-
-
.. py:method:: set_attitude_type(self, attitude: VehicleAttitude) -> None
:canonical: ansys.stk.core.stkobjects.IGreatArcVehicle.set_attitude_type
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ILaserPropagationChannel.rst b/doc/source/api/ansys/stk/core/stkobjects/ILaserPropagationChannel.rst
deleted file mode 100644
index 84eaf056ce..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/ILaserPropagationChannel.rst
+++ /dev/null
@@ -1,132 +0,0 @@
-ILaserPropagationChannel
-========================
-
-.. py:class:: ansys.stk.core.stkobjects.ILaserPropagationChannel
-
- Provide access to laser propagation loss models.
-
-.. py:currentmodule:: ILaserPropagationChannel
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Methods
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.ILaserPropagationChannel.set_atmospheric_loss_model`
- - Do not use this method, as it is deprecated. Use AtmosphericLossModelComponentLinking on ILaserPropagationChannel instead. Sets the current atmospheric absorption loss model by name.
- * - :py:attr:`~ansys.stk.core.stkobjects.ILaserPropagationChannel.set_tropospheric_scintillation_loss_model`
- - Do not use this method, as it is deprecated. Use TroposphericScintillationLossModelComponentLinking on ILaserPropagationChannel instead. Sets the current tropospheric scintillation loss model by name.
-
- .. tab-item:: Properties
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.ILaserPropagationChannel.atmospheric_loss_model`
- - Do not use this property, as it is deprecated. Use AtmosphericLossModelComponentLinking on ILaserPropagationChannel instead. Gets the laser atmospheric absorption loss model.
- * - :py:attr:`~ansys.stk.core.stkobjects.ILaserPropagationChannel.atmospheric_loss_model_component_linking`
- - Get the link/embed controller for managing the atmospheric loss model component.
- * - :py:attr:`~ansys.stk.core.stkobjects.ILaserPropagationChannel.enable_atmospheric_loss_model`
- - Get or set the option for computing atmospheric absorption propagation loss.
- * - :py:attr:`~ansys.stk.core.stkobjects.ILaserPropagationChannel.enable_tropospheric_scintillation_loss_model`
- - Get or set the option for computing tropospheric scintillation propagation loss.
- * - :py:attr:`~ansys.stk.core.stkobjects.ILaserPropagationChannel.tropospheric_scintillation_loss_model`
- - Do not use this property, as it is deprecated. Use TroposphericScintillationLossModelComponentLinking on ILaserPropagationChannel instead. Gets the laser propagation loss model.
- * - :py:attr:`~ansys.stk.core.stkobjects.ILaserPropagationChannel.tropospheric_scintillation_loss_model_component_linking`
- - Get the link/embed controller for managing the tropospheric scintillation loss model component.
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects import ILaserPropagationChannel
-
-
-Property detail
----------------
-
-.. py:property:: atmospheric_loss_model
- :canonical: ansys.stk.core.stkobjects.ILaserPropagationChannel.atmospheric_loss_model
- :type: ILaserAtmosphericLossModel
-
- Do not use this property, as it is deprecated. Use AtmosphericLossModelComponentLinking on ILaserPropagationChannel instead. Gets the laser atmospheric absorption loss model.
-
-.. py:property:: atmospheric_loss_model_component_linking
- :canonical: ansys.stk.core.stkobjects.ILaserPropagationChannel.atmospheric_loss_model_component_linking
- :type: IComponentLinkEmbedControl
-
- Get the link/embed controller for managing the atmospheric loss model component.
-
-.. py:property:: enable_atmospheric_loss_model
- :canonical: ansys.stk.core.stkobjects.ILaserPropagationChannel.enable_atmospheric_loss_model
- :type: bool
-
- Get or set the option for computing atmospheric absorption propagation loss.
-
-.. py:property:: enable_tropospheric_scintillation_loss_model
- :canonical: ansys.stk.core.stkobjects.ILaserPropagationChannel.enable_tropospheric_scintillation_loss_model
- :type: bool
-
- Get or set the option for computing tropospheric scintillation propagation loss.
-
-.. py:property:: tropospheric_scintillation_loss_model
- :canonical: ansys.stk.core.stkobjects.ILaserPropagationChannel.tropospheric_scintillation_loss_model
- :type: ILaserTroposphericScintillationLossModel
-
- Do not use this property, as it is deprecated. Use TroposphericScintillationLossModelComponentLinking on ILaserPropagationChannel instead. Gets the laser propagation loss model.
-
-.. py:property:: tropospheric_scintillation_loss_model_component_linking
- :canonical: ansys.stk.core.stkobjects.ILaserPropagationChannel.tropospheric_scintillation_loss_model_component_linking
- :type: IComponentLinkEmbedControl
-
- Get the link/embed controller for managing the tropospheric scintillation loss model component.
-
-
-Method detail
--------------
-
-
-
-
-
-
-
-.. py:method:: set_atmospheric_loss_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.ILaserPropagationChannel.set_atmospheric_loss_model
-
- Do not use this method, as it is deprecated. Use AtmosphericLossModelComponentLinking on ILaserPropagationChannel instead. Sets the current atmospheric absorption loss model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-.. py:method:: set_tropospheric_scintillation_loss_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.ILaserPropagationChannel.set_tropospheric_scintillation_loss_model
-
- Do not use this method, as it is deprecated. Use TroposphericScintillationLossModelComponentLinking on ILaserPropagationChannel instead. Sets the current tropospheric scintillation loss model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/IPlatformRFEnvironment.rst b/doc/source/api/ansys/stk/core/stkobjects/IPlatformRFEnvironment.rst
deleted file mode 100644
index ac4da318fd..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/IPlatformRFEnvironment.rst
+++ /dev/null
@@ -1,74 +0,0 @@
-IPlatformRFEnvironment
-======================
-
-.. py:class:: ansys.stk.core.stkobjects.IPlatformRFEnvironment
-
- Provide access to the properties and methods defining the platform RF environment.
-
-.. py:currentmodule:: IPlatformRFEnvironment
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Properties
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.IPlatformRFEnvironment.enable_local_rain_data`
- - Get or set the option for enabling local rain data.
- * - :py:attr:`~ansys.stk.core.stkobjects.IPlatformRFEnvironment.local_rain_height`
- - Get or set the local rain iso height.
- * - :py:attr:`~ansys.stk.core.stkobjects.IPlatformRFEnvironment.local_rain_rate`
- - Get or set the local rain rate.
- * - :py:attr:`~ansys.stk.core.stkobjects.IPlatformRFEnvironment.local_surface_temperature`
- - Get or set the local surface temperature.
- * - :py:attr:`~ansys.stk.core.stkobjects.IPlatformRFEnvironment.propagation_channel`
- - Get the propagation channel.
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects import IPlatformRFEnvironment
-
-
-Property detail
----------------
-
-.. py:property:: enable_local_rain_data
- :canonical: ansys.stk.core.stkobjects.IPlatformRFEnvironment.enable_local_rain_data
- :type: bool
-
- Get or set the option for enabling local rain data.
-
-.. py:property:: local_rain_height
- :canonical: ansys.stk.core.stkobjects.IPlatformRFEnvironment.local_rain_height
- :type: float
-
- Get or set the local rain iso height.
-
-.. py:property:: local_rain_rate
- :canonical: ansys.stk.core.stkobjects.IPlatformRFEnvironment.local_rain_rate
- :type: float
-
- Get or set the local rain rate.
-
-.. py:property:: local_surface_temperature
- :canonical: ansys.stk.core.stkobjects.IPlatformRFEnvironment.local_surface_temperature
- :type: float
-
- Get or set the local surface temperature.
-
-.. py:property:: propagation_channel
- :canonical: ansys.stk.core.stkobjects.IPlatformRFEnvironment.propagation_channel
- :type: PropagationChannel
-
- Get the propagation channel.
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterGeometryModel.rst b/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterGeometryModel.rst
deleted file mode 100644
index 25106c7923..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterGeometryModel.rst
+++ /dev/null
@@ -1,50 +0,0 @@
-IRadarClutterGeometryModel
-==========================
-
-.. py:class:: ansys.stk.core.stkobjects.IRadarClutterGeometryModel
-
- Do not use this interface, as it is deprecated. Use IScatteringPointProvider interface instead. Provides access to the properties and methods defining a radar clutter geometry model.
-
-.. py:currentmodule:: IRadarClutterGeometryModel
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Properties
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.IRadarClutterGeometryModel.name`
- - Do not use this property, as it is deprecated. Use Name on IScatteringPointProvider instead. Gets the radar clutter geometry model name.
- * - :py:attr:`~ansys.stk.core.stkobjects.IRadarClutterGeometryModel.type`
- - Do not use this property, as it is deprecated. Use PointProviderType on IScatteringPointProvider instead. Gets the radar clutter geometry model type enumeration.
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects import IRadarClutterGeometryModel
-
-
-Property detail
----------------
-
-.. py:property:: name
- :canonical: ansys.stk.core.stkobjects.IRadarClutterGeometryModel.name
- :type: str
-
- Do not use this property, as it is deprecated. Use Name on IScatteringPointProvider instead. Gets the radar clutter geometry model name.
-
-.. py:property:: type
- :canonical: ansys.stk.core.stkobjects.IRadarClutterGeometryModel.type
- :type: RadarClutterGeometryModelType
-
- Do not use this property, as it is deprecated. Use PointProviderType on IScatteringPointProvider instead. Gets the radar clutter geometry model type enumeration.
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterGeometryModelPlugin.rst b/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterGeometryModelPlugin.rst
deleted file mode 100644
index 58603f1b16..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterGeometryModelPlugin.rst
+++ /dev/null
@@ -1,50 +0,0 @@
-IRadarClutterGeometryModelPlugin
-================================
-
-.. py:class:: ansys.stk.core.stkobjects.IRadarClutterGeometryModelPlugin
-
- Do not use this interface, as it is deprecated. Use ScatteringPointProviderPlugin interface instead. Provides access to the properties and methods defining a radar clutter geometry plugin model.
-
-.. py:currentmodule:: IRadarClutterGeometryModelPlugin
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Properties
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.IRadarClutterGeometryModelPlugin.plugin_configuration`
- - Do not use this property, as it is deprecated. Use PluginConfiguration on ScatteringPointProviderPlugin instead. Gets the plugin configuration interface.
- * - :py:attr:`~ansys.stk.core.stkobjects.IRadarClutterGeometryModelPlugin.raw_plugin_object`
- - Do not use this property, as it is deprecated. Use RawPluginObject on ScatteringPointProviderPlugin instead. Gets the raw plugin IUnknown interface.
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects import IRadarClutterGeometryModelPlugin
-
-
-Property detail
----------------
-
-.. py:property:: plugin_configuration
- :canonical: ansys.stk.core.stkobjects.IRadarClutterGeometryModelPlugin.plugin_configuration
- :type: CommRadPluginConfiguration
-
- Do not use this property, as it is deprecated. Use PluginConfiguration on ScatteringPointProviderPlugin instead. Gets the plugin configuration interface.
-
-.. py:property:: raw_plugin_object
- :canonical: ansys.stk.core.stkobjects.IRadarClutterGeometryModelPlugin.raw_plugin_object
- :type: typing.Any
-
- Do not use this property, as it is deprecated. Use RawPluginObject on ScatteringPointProviderPlugin instead. Gets the raw plugin IUnknown interface.
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterMap.rst b/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterMap.rst
deleted file mode 100644
index f74de6bedb..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterMap.rst
+++ /dev/null
@@ -1,78 +0,0 @@
-IRadarClutterMap
-================
-
-.. py:class:: ansys.stk.core.stkobjects.IRadarClutterMap
-
- Do not use this interface, as it is deprecated. This interface is no longer used and there is no alternative. Provides access to the properties and methods defining a radar clutter map.
-
-.. py:currentmodule:: IRadarClutterMap
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Methods
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.IRadarClutterMap.set_model`
- - Set the current clutter map model by name.
-
- .. tab-item:: Properties
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.IRadarClutterMap.model`
- - Get the current clutter map model.
- * - :py:attr:`~ansys.stk.core.stkobjects.IRadarClutterMap.supported_models`
- - Get an array of supported model names.
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects import IRadarClutterMap
-
-
-Property detail
----------------
-
-.. py:property:: model
- :canonical: ansys.stk.core.stkobjects.IRadarClutterMap.model
- :type: IRadarClutterMapModel
-
- Get the current clutter map model.
-
-.. py:property:: supported_models
- :canonical: ansys.stk.core.stkobjects.IRadarClutterMap.supported_models
- :type: list
-
- Get an array of supported model names.
-
-
-Method detail
--------------
-
-
-.. py:method:: set_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.IRadarClutterMap.set_model
-
- Set the current clutter map model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterMapInheritable.rst b/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterMapInheritable.rst
deleted file mode 100644
index 16656c31b9..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterMapInheritable.rst
+++ /dev/null
@@ -1,50 +0,0 @@
-IRadarClutterMapInheritable
-===========================
-
-.. py:class:: ansys.stk.core.stkobjects.IRadarClutterMapInheritable
-
- Do not use this interface, as it is deprecated. This interface is no longer used and there is no alternative. Provides access to the properties and methods defining a radar inheritable clutter map.
-
-.. py:currentmodule:: IRadarClutterMapInheritable
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Properties
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.IRadarClutterMapInheritable.clutter_map`
- - Get the radar clutter map.
- * - :py:attr:`~ansys.stk.core.stkobjects.IRadarClutterMapInheritable.inherit`
- - Get or set the option to inherit the clutter map from the scenario object.
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects import IRadarClutterMapInheritable
-
-
-Property detail
----------------
-
-.. py:property:: clutter_map
- :canonical: ansys.stk.core.stkobjects.IRadarClutterMapInheritable.clutter_map
- :type: IRadarClutterMap
-
- Get the radar clutter map.
-
-.. py:property:: inherit
- :canonical: ansys.stk.core.stkobjects.IRadarClutterMapInheritable.inherit
- :type: bool
-
- Get or set the option to inherit the clutter map from the scenario object.
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterMapModel.rst b/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterMapModel.rst
deleted file mode 100644
index 5f88a2bda0..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterMapModel.rst
+++ /dev/null
@@ -1,50 +0,0 @@
-IRadarClutterMapModel
-=====================
-
-.. py:class:: ansys.stk.core.stkobjects.IRadarClutterMapModel
-
- Do not use this interface, as it is deprecated. Use IScatteringPointModel interface instead. Provides access to the properties and methods defining a radar clutter map model.
-
-.. py:currentmodule:: IRadarClutterMapModel
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Properties
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.IRadarClutterMapModel.name`
- - Do not use this property, as it is deprecated. Use Name on IScatteringPointModel instead. Gets the radar clutter map model name.
- * - :py:attr:`~ansys.stk.core.stkobjects.IRadarClutterMapModel.type`
- - Do not use this property, as it is deprecated. Use Type on IScatteringPointModel instead. Gets the radar clutter map model type enumeration.
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects import IRadarClutterMapModel
-
-
-Property detail
----------------
-
-.. py:property:: name
- :canonical: ansys.stk.core.stkobjects.IRadarClutterMapModel.name
- :type: str
-
- Do not use this property, as it is deprecated. Use Name on IScatteringPointModel instead. Gets the radar clutter map model name.
-
-.. py:property:: type
- :canonical: ansys.stk.core.stkobjects.IRadarClutterMapModel.type
- :type: RadarClutterMapModelType
-
- Do not use this property, as it is deprecated. Use Type on IScatteringPointModel instead. Gets the radar clutter map model type enumeration.
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterMapModelConstantCoefficient.rst b/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterMapModelConstantCoefficient.rst
deleted file mode 100644
index 27a376194a..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterMapModelConstantCoefficient.rst
+++ /dev/null
@@ -1,42 +0,0 @@
-IRadarClutterMapModelConstantCoefficient
-========================================
-
-.. py:class:: ansys.stk.core.stkobjects.IRadarClutterMapModelConstantCoefficient
-
- Do not use this interface, as it is deprecated. Use ScatteringPointModelConstantCoefficient interface instead. Provides access to the properties and methods defining a radar clutter map constant coefficient model.
-
-.. py:currentmodule:: IRadarClutterMapModelConstantCoefficient
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Properties
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.IRadarClutterMapModelConstantCoefficient.constant_coefficient`
- - Do not use this property, as it is deprecated. Use ConstantCoefficient on ScatteringPointModelConstantCoefficient instead. Gets the constant coefficient value.
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects import IRadarClutterMapModelConstantCoefficient
-
-
-Property detail
----------------
-
-.. py:property:: constant_coefficient
- :canonical: ansys.stk.core.stkobjects.IRadarClutterMapModelConstantCoefficient.constant_coefficient
- :type: float
-
- Do not use this property, as it is deprecated. Use ConstantCoefficient on ScatteringPointModelConstantCoefficient instead. Gets the constant coefficient value.
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterMapModelPlugin.rst b/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterMapModelPlugin.rst
deleted file mode 100644
index 125b51dc38..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/IRadarClutterMapModelPlugin.rst
+++ /dev/null
@@ -1,50 +0,0 @@
-IRadarClutterMapModelPlugin
-===========================
-
-.. py:class:: ansys.stk.core.stkobjects.IRadarClutterMapModelPlugin
-
- Do not use this interface, as it is deprecated. Use ScatteringPointModelPlugin interface instead. Provides access to the properties and methods defining a radar clutter map plugin model.
-
-.. py:currentmodule:: IRadarClutterMapModelPlugin
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Properties
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.IRadarClutterMapModelPlugin.plugin_configuration`
- - Do not use this property, as it is deprecated. Use PluginConfiguration on ScatteringPointModelPlugin instead. Gets the plugin configuration interface.
- * - :py:attr:`~ansys.stk.core.stkobjects.IRadarClutterMapModelPlugin.raw_plugin_object`
- - Do not use this property, as it is deprecated. Use RawPluginObject on ScatteringPointModelPlugin instead. Gets the raw plugin IUnknown interface.
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects import IRadarClutterMapModelPlugin
-
-
-Property detail
----------------
-
-.. py:property:: plugin_configuration
- :canonical: ansys.stk.core.stkobjects.IRadarClutterMapModelPlugin.plugin_configuration
- :type: CommRadPluginConfiguration
-
- Do not use this property, as it is deprecated. Use PluginConfiguration on ScatteringPointModelPlugin instead. Gets the plugin configuration interface.
-
-.. py:property:: raw_plugin_object
- :canonical: ansys.stk.core.stkobjects.IRadarClutterMapModelPlugin.raw_plugin_object
- :type: typing.Any
-
- Do not use this property, as it is deprecated. Use RawPluginObject on ScatteringPointModelPlugin instead. Gets the raw plugin IUnknown interface.
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/IScatteringPointProvider.rst b/doc/source/api/ansys/stk/core/stkobjects/IScatteringPointProvider.rst
index 79c2ba4e5a..fd3732b9cd 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/IScatteringPointProvider.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/IScatteringPointProvider.rst
@@ -20,7 +20,7 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.IScatteringPointProvider.name`
- Get the scattering point provider name.
- * - :py:attr:`~ansys.stk.core.stkobjects.IScatteringPointProvider.point_provider_type`
+ * - :py:attr:`~ansys.stk.core.stkobjects.IScatteringPointProvider.type`
- Get the scattering point provider type enumeration.
@@ -41,8 +41,8 @@ Property detail
Get the scattering point provider name.
-.. py:property:: point_provider_type
- :canonical: ansys.stk.core.stkobjects.IScatteringPointProvider.point_provider_type
+.. py:property:: type
+ :canonical: ansys.stk.core.stkobjects.IScatteringPointProvider.type
:type: ScatteringPointProviderType
Get the scattering point provider type enumeration.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ITURP676AtmosphereDataType.rst b/doc/source/api/ansys/stk/core/stkobjects/ITURP676AtmosphereDataType.rst
new file mode 100644
index 0000000000..dab6aa556f
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/ITURP676AtmosphereDataType.rst
@@ -0,0 +1,39 @@
+ITURP676AtmosphereDataType
+==========================
+
+.. py:class:: ansys.stk.core.stkobjects.ITURP676AtmosphereDataType
+
+ IntEnum
+
+
+.. py:currentmodule:: ITURP676AtmosphereDataType
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Members
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~UNKNOWN`
+ - Unknown atmosphere data type.
+
+ * - :py:attr:`~ANNUAL_GLOBAL`
+ - Annual Global atmosphere data.
+
+ * - :py:attr:`~SEASONAL_REGIONAL`
+ - Seasonal/Regional atmosphere data.
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects import ITURP676AtmosphereDataType
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/IVehicleGraphics2DAttributesBasic.rst b/doc/source/api/ansys/stk/core/stkobjects/IVehicleGraphics2DAttributesBasic.rst
index c8781ebb08..8b4c750797 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/IVehicleGraphics2DAttributesBasic.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/IVehicleGraphics2DAttributesBasic.rst
@@ -53,7 +53,7 @@ Set 2D Graphics display properties
attributes.line.style = LineStyle.LONG_DASH
attributes.color = Colors.Lime
if os.name == "nt":
- installPath = r"C:\Program Files\AGI\STK 12"
+ installPath = r"C:\Program Files\AGI\STK_ODTK 13"
else:
installPath = os.environ["STK_INSTALL_DIR"]
attributes.marker_style = os.path.join(installPath, "STKData", "Pixmaps", "MarkersWin", "m010Satellite.bmp")
diff --git a/doc/source/api/ansys/stk/core/stkobjects/IonosphericFadingLossModelP531Version13.rst b/doc/source/api/ansys/stk/core/stkobjects/IonosphericFadingLossModelP531Version13.rst
index 44f9e6fc5e..9c7abe0c35 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/IonosphericFadingLossModelP531Version13.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/IonosphericFadingLossModelP531Version13.rst
@@ -9,23 +9,6 @@ IonosphericFadingLossModelP531Version13
.. py:currentmodule:: IonosphericFadingLossModelP531Version13
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Properties
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.IonosphericFadingLossModelP531Version13.filename`
- - Get or set the alternate AP filename.
- * - :py:attr:`~ansys.stk.core.stkobjects.IonosphericFadingLossModelP531Version13.use_alternate_ap_file`
- - Get or set the option for alternate AP data file.
-
-
Import detail
-------------
@@ -35,19 +18,4 @@ Import detail
from ansys.stk.core.stkobjects import IonosphericFadingLossModelP531Version13
-Property detail
----------------
-
-.. py:property:: filename
- :canonical: ansys.stk.core.stkobjects.IonosphericFadingLossModelP531Version13.filename
- :type: str
-
- Get or set the alternate AP filename.
-
-.. py:property:: use_alternate_ap_file
- :canonical: ansys.stk.core.stkobjects.IonosphericFadingLossModelP531Version13.use_alternate_ap_file
- :type: bool
-
- Get or set the option for alternate AP data file.
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/LaserEnvironment.rst b/doc/source/api/ansys/stk/core/stkobjects/LaserEnvironment.rst
index b9c7a40eb2..6d3bc985a0 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/LaserEnvironment.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/LaserEnvironment.rst
@@ -36,7 +36,7 @@ Property detail
.. py:property:: propagation_channel
:canonical: ansys.stk.core.stkobjects.LaserEnvironment.propagation_channel
- :type: ILaserPropagationChannel
+ :type: LaserPropagationChannel
Get the propagation channel.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/LaserPropagationChannel.rst b/doc/source/api/ansys/stk/core/stkobjects/LaserPropagationChannel.rst
new file mode 100644
index 0000000000..50eab42f5e
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/LaserPropagationChannel.rst
@@ -0,0 +1,67 @@
+LaserPropagationChannel
+=======================
+
+.. py:class:: ansys.stk.core.stkobjects.LaserPropagationChannel
+
+ Class defining the properties for laser propagatoin models.
+
+.. py:currentmodule:: LaserPropagationChannel
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Properties
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.LaserPropagationChannel.atmospheric_loss_model_component_linking`
+ - Get the link/embed controller for managing the atmospheric loss model component.
+ * - :py:attr:`~ansys.stk.core.stkobjects.LaserPropagationChannel.enable_atmospheric_loss_model`
+ - Get or set the option for computing atmospheric absorption propagation loss.
+ * - :py:attr:`~ansys.stk.core.stkobjects.LaserPropagationChannel.enable_tropospheric_scintillation_loss_model`
+ - Get or set the option for computing tropospheric scintillation propagation loss.
+ * - :py:attr:`~ansys.stk.core.stkobjects.LaserPropagationChannel.tropospheric_scintillation_loss_model_component_linking`
+ - Get the link/embed controller for managing the tropospheric scintillation loss model component.
+
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects import LaserPropagationChannel
+
+
+Property detail
+---------------
+
+.. py:property:: atmospheric_loss_model_component_linking
+ :canonical: ansys.stk.core.stkobjects.LaserPropagationChannel.atmospheric_loss_model_component_linking
+ :type: IComponentLinkEmbedControl
+
+ Get the link/embed controller for managing the atmospheric loss model component.
+
+.. py:property:: enable_atmospheric_loss_model
+ :canonical: ansys.stk.core.stkobjects.LaserPropagationChannel.enable_atmospheric_loss_model
+ :type: bool
+
+ Get or set the option for computing atmospheric absorption propagation loss.
+
+.. py:property:: enable_tropospheric_scintillation_loss_model
+ :canonical: ansys.stk.core.stkobjects.LaserPropagationChannel.enable_tropospheric_scintillation_loss_model
+ :type: bool
+
+ Get or set the option for computing tropospheric scintillation propagation loss.
+
+.. py:property:: tropospheric_scintillation_loss_model_component_linking
+ :canonical: ansys.stk.core.stkobjects.LaserPropagationChannel.tropospheric_scintillation_loss_model_component_linking
+ :type: IComponentLinkEmbedControl
+
+ Get the link/embed controller for managing the tropospheric scintillation loss model component.
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/LaserPropagationLossModels.rst b/doc/source/api/ansys/stk/core/stkobjects/LaserPropagationLossModels.rst
deleted file mode 100644
index ec34cd97c5..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/LaserPropagationLossModels.rst
+++ /dev/null
@@ -1,117 +0,0 @@
-LaserPropagationLossModels
-==========================
-
-.. py:class:: ansys.stk.core.stkobjects.LaserPropagationLossModels
-
- Bases: :py:class:`~ansys.stk.core.stkobjects.ILaserPropagationChannel`
-
- Class defining the properties for laser propagatoin models.
-
-.. py:currentmodule:: LaserPropagationLossModels
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Methods
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.LaserPropagationLossModels.set_atmospheric_loss_model`
- - Set the current atmospheric absorption loss model by name.
- * - :py:attr:`~ansys.stk.core.stkobjects.LaserPropagationLossModels.set_tropospheric_scintillation_loss_model`
- - Set the current tropospheric scintillation loss model by name.
-
- .. tab-item:: Properties
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.LaserPropagationLossModels.atmospheric_loss_model`
- - Get the laser atmospheric absorption loss model.
- * - :py:attr:`~ansys.stk.core.stkobjects.LaserPropagationLossModels.enable_atmospheric_loss_model`
- - Get or set the option for computing atmospheric absorption propagation loss.
- * - :py:attr:`~ansys.stk.core.stkobjects.LaserPropagationLossModels.enable_tropospheric_scintillation_loss_model`
- - Get or set the option for computing tropospheric scintillation propagation loss.
- * - :py:attr:`~ansys.stk.core.stkobjects.LaserPropagationLossModels.tropospheric_scintillation_loss_model`
- - Get the laser propagation loss model.
-
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects import LaserPropagationLossModels
-
-
-Property detail
----------------
-
-.. py:property:: atmospheric_loss_model
- :canonical: ansys.stk.core.stkobjects.LaserPropagationLossModels.atmospheric_loss_model
- :type: ILaserAtmosphericLossModel
-
- Get the laser atmospheric absorption loss model.
-
-.. py:property:: enable_atmospheric_loss_model
- :canonical: ansys.stk.core.stkobjects.LaserPropagationLossModels.enable_atmospheric_loss_model
- :type: bool
-
- Get or set the option for computing atmospheric absorption propagation loss.
-
-.. py:property:: enable_tropospheric_scintillation_loss_model
- :canonical: ansys.stk.core.stkobjects.LaserPropagationLossModels.enable_tropospheric_scintillation_loss_model
- :type: bool
-
- Get or set the option for computing tropospheric scintillation propagation loss.
-
-.. py:property:: tropospheric_scintillation_loss_model
- :canonical: ansys.stk.core.stkobjects.LaserPropagationLossModels.tropospheric_scintillation_loss_model
- :type: ILaserTroposphericScintillationLossModel
-
- Get the laser propagation loss model.
-
-
-Method detail
--------------
-
-
-
-
-
-
-.. py:method:: set_atmospheric_loss_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.LaserPropagationLossModels.set_atmospheric_loss_model
-
- Set the current atmospheric absorption loss model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-.. py:method:: set_tropospheric_scintillation_loss_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.LaserPropagationLossModels.set_tropospheric_scintillation_loss_model
-
- Set the current tropospheric scintillation loss model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/LaunchVehicle.rst b/doc/source/api/ansys/stk/core/stkobjects/LaunchVehicle.rst
index 3c67b8040b..334d546db0 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/LaunchVehicle.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/LaunchVehicle.rst
@@ -37,14 +37,14 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.LaunchVehicle.access_constraints`
- Get the constraints imposed on the launch vehicle.
- * - :py:attr:`~ansys.stk.core.stkobjects.LaunchVehicle.atmosphere`
- - Do not use this property, as it is deprecated. The new RFEnvironment property can be used to configure atmospheric models.
* - :py:attr:`~ansys.stk.core.stkobjects.LaunchVehicle.attitude`
- Get the launch vehicle's attitude profile.
* - :py:attr:`~ansys.stk.core.stkobjects.LaunchVehicle.attitude_supported_types`
- Return an array of valid choices.
* - :py:attr:`~ansys.stk.core.stkobjects.LaunchVehicle.attitude_type`
- Get the type of attitude profile used by the launch vehicle.
+ * - :py:attr:`~ansys.stk.core.stkobjects.LaunchVehicle.chain_analysis_options`
+ - Get the launch vehicle's chain analysis options.
* - :py:attr:`~ansys.stk.core.stkobjects.LaunchVehicle.eclipse_bodies`
- Get the customized list of Eclipse Bodies, which are central bodies used in lighting computations.
* - :py:attr:`~ansys.stk.core.stkobjects.LaunchVehicle.export_tools`
@@ -57,14 +57,10 @@ Overview
- Get the launch vehicle's ground ellipses properties.
* - :py:attr:`~ansys.stk.core.stkobjects.LaunchVehicle.laser_environment`
- Get the laser environment.
- * - :py:attr:`~ansys.stk.core.stkobjects.LaunchVehicle.lighting_maximum_step`
- - Do not use this property, as it is deprecated. Use LightingMaxStepTerrain or LightingMaxStepCbShape as appropriate. The maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.LaunchVehicle.lighting_maximum_step_central_body_shape`
- Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is false. Uses Time Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.LaunchVehicle.lighting_maximum_step_terrain`
- Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
- * - :py:attr:`~ansys.stk.core.stkobjects.LaunchVehicle.radar_clutter_map`
- - Return the radar clutter map.
* - :py:attr:`~ansys.stk.core.stkobjects.LaunchVehicle.radar_cross_section`
- Return the radar cross sectoin.
* - :py:attr:`~ansys.stk.core.stkobjects.LaunchVehicle.rf_environment`
@@ -99,12 +95,6 @@ Property detail
Get the constraints imposed on the launch vehicle.
-.. py:property:: atmosphere
- :canonical: ansys.stk.core.stkobjects.LaunchVehicle.atmosphere
- :type: Atmosphere
-
- Do not use this property, as it is deprecated. The new RFEnvironment property can be used to configure atmospheric models.
-
.. py:property:: attitude
:canonical: ansys.stk.core.stkobjects.LaunchVehicle.attitude
:type: IVehicleAttitude
@@ -123,6 +113,12 @@ Property detail
Get the type of attitude profile used by the launch vehicle.
+.. py:property:: chain_analysis_options
+ :canonical: ansys.stk.core.stkobjects.LaunchVehicle.chain_analysis_options
+ :type: ChainAnalysisOptions
+
+ Get the launch vehicle's chain analysis options.
+
.. py:property:: eclipse_bodies
:canonical: ansys.stk.core.stkobjects.LaunchVehicle.eclipse_bodies
:type: VehicleEclipseBodies
@@ -159,12 +155,6 @@ Property detail
Get the laser environment.
-.. py:property:: lighting_maximum_step
- :canonical: ansys.stk.core.stkobjects.LaunchVehicle.lighting_maximum_step
- :type: float
-
- Do not use this property, as it is deprecated. Use LightingMaxStepTerrain or LightingMaxStepCbShape as appropriate. The maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
-
.. py:property:: lighting_maximum_step_central_body_shape
:canonical: ansys.stk.core.stkobjects.LaunchVehicle.lighting_maximum_step_central_body_shape
:type: float
@@ -177,12 +167,6 @@ Property detail
Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
-.. py:property:: radar_clutter_map
- :canonical: ansys.stk.core.stkobjects.LaunchVehicle.radar_clutter_map
- :type: IRadarClutterMapInheritable
-
- Return the radar clutter map.
-
.. py:property:: radar_cross_section
:canonical: ansys.stk.core.stkobjects.LaunchVehicle.radar_cross_section
:type: RadarCrossSectionInheritable
@@ -191,7 +175,7 @@ Property detail
.. py:property:: rf_environment
:canonical: ansys.stk.core.stkobjects.LaunchVehicle.rf_environment
- :type: IPlatformRFEnvironment
+ :type: PlatformRFEnvironment
Get the RF environment.
@@ -273,9 +257,6 @@ Method detail
-
-
-
.. py:method:: set_attitude_type(self, attitude: VehicleAttitude) -> None
:canonical: ansys.stk.core.stkobjects.LaunchVehicle.set_attitude_type
diff --git a/doc/source/api/ansys/stk/core/stkobjects/LineTarget.rst b/doc/source/api/ansys/stk/core/stkobjects/LineTarget.rst
index 4184e91eb4..b4949f9053 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/LineTarget.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/LineTarget.rst
@@ -24,6 +24,8 @@ Overview
- Return the constraints for the line target.
* - :py:attr:`~ansys.stk.core.stkobjects.LineTarget.allow_object_access`
- Opt to have access to the object constrained to when it applies to the entire object,rather than any part of it.
+ * - :py:attr:`~ansys.stk.core.stkobjects.LineTarget.chain_analysis_options`
+ - Get the line target's chain analysis options.
* - :py:attr:`~ansys.stk.core.stkobjects.LineTarget.graphics`
- Return the 2D graphics properties of the line target.
* - :py:attr:`~ansys.stk.core.stkobjects.LineTarget.graphics_3d`
@@ -69,6 +71,12 @@ Property detail
Opt to have access to the object constrained to when it applies to the entire object,rather than any part of it.
+.. py:property:: chain_analysis_options
+ :canonical: ansys.stk.core.stkobjects.LineTarget.chain_analysis_options
+ :type: ChainAnalysisOptions
+
+ Get the line target's chain analysis options.
+
.. py:property:: graphics
:canonical: ansys.stk.core.stkobjects.LineTarget.graphics
:type: LineTargetGraphics
diff --git a/doc/source/api/ansys/stk/core/stkobjects/LoadMethod.rst b/doc/source/api/ansys/stk/core/stkobjects/LoadMethod.rst
index 06abcc98e8..10968ef5f0 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/LoadMethod.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/LoadMethod.rst
@@ -28,9 +28,6 @@ Overview
* - :py:attr:`~FILE_LOAD`
- File load: loads the selected TLE data and replaces all TLE data that is currently associated with the satellite.
- * - :py:attr:`~ONLINE_AUTOMATIC_LOAD`
- - Online auto-load: STK automatically loads the TLE sets corresponding to the SSC number of the satellite from the AGI Web site.
-
* - :py:attr:`~ONLINE_LOAD`
- goes directly to the AGI Web site to download the latest TLE sets.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/MTO.rst b/doc/source/api/ansys/stk/core/stkobjects/MTO.rst
index 2e6c9393f7..ca7c6b280b 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/MTO.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/MTO.rst
@@ -45,7 +45,7 @@ Load multi-track object (MTO) track points from a file
# load_points expects the path an Ephemeris file path
# MTO mto: MTO Object
track2 = mto.tracks.add(2)
- installPath = r"C:\Program Files\AGI\STK 12" if os.name == "nt" else os.environ["STK_INSTALL_DIR"]
+ installPath = r"C:\Program Files\AGI\STK_ODTK 13" if os.name == "nt" else os.environ["STK_INSTALL_DIR"]
track2.points.load_points(
os.path.join(installPath, "Data", "Resources", "stktraining", "text", "EphemerisLLATimePosVel_Example.e")
)
diff --git a/doc/source/api/ansys/stk/core/stkobjects/Missile.rst b/doc/source/api/ansys/stk/core/stkobjects/Missile.rst
index e0c8cf8499..342b10b97a 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/Missile.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/Missile.rst
@@ -37,14 +37,14 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.Missile.access_constraints`
- Get the constraints imposed on the missile.
- * - :py:attr:`~ansys.stk.core.stkobjects.Missile.atmosphere`
- - Do not use this property, as it is deprecated. The new RFEnvironment property can be used to configure atmospheric models.
* - :py:attr:`~ansys.stk.core.stkobjects.Missile.attitude`
- Get the missile's attitude profile.
* - :py:attr:`~ansys.stk.core.stkobjects.Missile.attitude_supported_types`
- Return an array of valid choices.
* - :py:attr:`~ansys.stk.core.stkobjects.Missile.attitude_type`
- Get the type of attitude profile used by the missile.
+ * - :py:attr:`~ansys.stk.core.stkobjects.Missile.chain_analysis_options`
+ - Get the missile's chain analysis options.
* - :py:attr:`~ansys.stk.core.stkobjects.Missile.eclipse_bodies`
- Get the customized list of Eclipse Bodies, which are central bodies used in lighting computations.
* - :py:attr:`~ansys.stk.core.stkobjects.Missile.export_tools`
@@ -59,14 +59,10 @@ Overview
- Get the missile's ground ellipses properties.
* - :py:attr:`~ansys.stk.core.stkobjects.Missile.laser_environment`
- Get the laser environment.
- * - :py:attr:`~ansys.stk.core.stkobjects.Missile.lighting_maximum_step`
- - Do not use this property, as it is deprecated. Use LightingMaxStepTerrain or LightingMaxStepCbShape as appropriate. The maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.Missile.lighting_maximum_step_central_body_shape`
- Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is false. Uses Time Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.Missile.lighting_maximum_step_terrain`
- Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
- * - :py:attr:`~ansys.stk.core.stkobjects.Missile.radar_clutter_map`
- - Return the radar clutter map.
* - :py:attr:`~ansys.stk.core.stkobjects.Missile.radar_cross_section`
- Return the radar cross sectoin.
* - :py:attr:`~ansys.stk.core.stkobjects.Missile.rf_environment`
@@ -123,12 +119,6 @@ Property detail
Get the constraints imposed on the missile.
-.. py:property:: atmosphere
- :canonical: ansys.stk.core.stkobjects.Missile.atmosphere
- :type: Atmosphere
-
- Do not use this property, as it is deprecated. The new RFEnvironment property can be used to configure atmospheric models.
-
.. py:property:: attitude
:canonical: ansys.stk.core.stkobjects.Missile.attitude
:type: IVehicleAttitude
@@ -147,6 +137,12 @@ Property detail
Get the type of attitude profile used by the missile.
+.. py:property:: chain_analysis_options
+ :canonical: ansys.stk.core.stkobjects.Missile.chain_analysis_options
+ :type: ChainAnalysisOptions
+
+ Get the missile's chain analysis options.
+
.. py:property:: eclipse_bodies
:canonical: ansys.stk.core.stkobjects.Missile.eclipse_bodies
:type: VehicleEclipseBodies
@@ -189,12 +185,6 @@ Property detail
Get the laser environment.
-.. py:property:: lighting_maximum_step
- :canonical: ansys.stk.core.stkobjects.Missile.lighting_maximum_step
- :type: float
-
- Do not use this property, as it is deprecated. Use LightingMaxStepTerrain or LightingMaxStepCbShape as appropriate. The maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
-
.. py:property:: lighting_maximum_step_central_body_shape
:canonical: ansys.stk.core.stkobjects.Missile.lighting_maximum_step_central_body_shape
:type: float
@@ -207,12 +197,6 @@ Property detail
Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
-.. py:property:: radar_clutter_map
- :canonical: ansys.stk.core.stkobjects.Missile.radar_clutter_map
- :type: IRadarClutterMapInheritable
-
- Return the radar clutter map.
-
.. py:property:: radar_cross_section
:canonical: ansys.stk.core.stkobjects.Missile.radar_cross_section
:type: RadarCrossSectionInheritable
@@ -221,7 +205,7 @@ Property detail
.. py:property:: rf_environment
:canonical: ansys.stk.core.stkobjects.Missile.rf_environment
- :type: IPlatformRFEnvironment
+ :type: PlatformRFEnvironment
Get the RF environment.
@@ -304,9 +288,6 @@ Method detail
-
-
-
.. py:method:: set_attitude_type(self, attitude: VehicleAttitude) -> None
:canonical: ansys.stk.core.stkobjects.Missile.set_attitude_type
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ObjectLaserEnvironment.rst b/doc/source/api/ansys/stk/core/stkobjects/ObjectLaserEnvironment.rst
index d3b2596794..ed8719f36a 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ObjectLaserEnvironment.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ObjectLaserEnvironment.rst
@@ -36,7 +36,7 @@ Property detail
.. py:property:: propagation_channel
:canonical: ansys.stk.core.stkobjects.ObjectLaserEnvironment.propagation_channel
- :type: ILaserPropagationChannel
+ :type: LaserPropagationChannel
Get the propagation channel.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/Place.rst b/doc/source/api/ansys/stk/core/stkobjects/Place.rst
index af7e5e3fcf..3d414f88e7 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/Place.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/Place.rst
@@ -39,8 +39,8 @@ Overview
- Get the constraints imposed on the place.
* - :py:attr:`~ansys.stk.core.stkobjects.Place.altitude_reference`
- Get or set the altitude reference of the object.
- * - :py:attr:`~ansys.stk.core.stkobjects.Place.atmosphere`
- - Do not use this property, as it is deprecated. The new RFEnvironment property can be used to configure atmospheric models.
+ * - :py:attr:`~ansys.stk.core.stkobjects.Place.chain_analysis_options`
+ - Get the places's chain analysis options.
* - :py:attr:`~ansys.stk.core.stkobjects.Place.graphics`
- Get the 2D Graphics properties of the place.
* - :py:attr:`~ansys.stk.core.stkobjects.Place.graphics_3d`
@@ -59,8 +59,6 @@ Overview
- Get or set the maximum range to use when computing the az el mask using terrain data. Zero indicates to use algorithm default. Only applies when GetAzElMask returns eTerrainData (cannot be set if eMaskFile). Uses Distance Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.Place.position`
- Get the position of the place.
- * - :py:attr:`~ansys.stk.core.stkobjects.Place.radar_clutter_map`
- - Return the radar clutter map.
* - :py:attr:`~ansys.stk.core.stkobjects.Place.radar_cross_section`
- Return the radar cross sectoin.
* - :py:attr:`~ansys.stk.core.stkobjects.Place.rf_environment`
@@ -101,11 +99,11 @@ Property detail
Get or set the altitude reference of the object.
-.. py:property:: atmosphere
- :canonical: ansys.stk.core.stkobjects.Place.atmosphere
- :type: Atmosphere
+.. py:property:: chain_analysis_options
+ :canonical: ansys.stk.core.stkobjects.Place.chain_analysis_options
+ :type: ChainAnalysisOptions
- Do not use this property, as it is deprecated. The new RFEnvironment property can be used to configure atmospheric models.
+ Get the places's chain analysis options.
.. py:property:: graphics
:canonical: ansys.stk.core.stkobjects.Place.graphics
@@ -161,12 +159,6 @@ Property detail
Get the position of the place.
-.. py:property:: radar_clutter_map
- :canonical: ansys.stk.core.stkobjects.Place.radar_clutter_map
- :type: IRadarClutterMapInheritable
-
- Return the radar clutter map.
-
.. py:property:: radar_cross_section
:canonical: ansys.stk.core.stkobjects.Place.radar_cross_section
:type: RadarCrossSectionInheritable
@@ -175,7 +167,7 @@ Property detail
.. py:property:: rf_environment
:canonical: ansys.stk.core.stkobjects.Place.rf_environment
- :type: IPlatformRFEnvironment
+ :type: PlatformRFEnvironment
Get the RF environment.
@@ -250,7 +242,6 @@ Method detail
-
.. py:method:: reset_az_el_mask(self) -> None
:canonical: ansys.stk.core.stkobjects.Place.reset_az_el_mask
diff --git a/doc/source/api/ansys/stk/core/stkobjects/Planet.rst b/doc/source/api/ansys/stk/core/stkobjects/Planet.rst
index 50e46ffaaf..aef87dc2e6 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/Planet.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/Planet.rst
@@ -22,6 +22,8 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.Planet.access_constraints`
- Get the constraints imposed on the planet.
+ * - :py:attr:`~ansys.stk.core.stkobjects.Planet.chain_analysis_options`
+ - Get the planet's chain analysis options.
* - :py:attr:`~ansys.stk.core.stkobjects.Planet.common_tasks`
- Common Tasks associated with the planet.
* - :py:attr:`~ansys.stk.core.stkobjects.Planet.graphics`
@@ -77,6 +79,12 @@ Property detail
Get the constraints imposed on the planet.
+.. py:property:: chain_analysis_options
+ :canonical: ansys.stk.core.stkobjects.Planet.chain_analysis_options
+ :type: ChainAnalysisOptions
+
+ Get the planet's chain analysis options.
+
.. py:property:: common_tasks
:canonical: ansys.stk.core.stkobjects.Planet.common_tasks
:type: PlanetCommonTasks
diff --git a/doc/source/api/ansys/stk/core/stkobjects/PlatformLaserEnvironment.rst b/doc/source/api/ansys/stk/core/stkobjects/PlatformLaserEnvironment.rst
index 0f217d98fe..cc6fff2ff9 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/PlatformLaserEnvironment.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/PlatformLaserEnvironment.rst
@@ -36,7 +36,7 @@ Property detail
.. py:property:: propagation_channel
:canonical: ansys.stk.core.stkobjects.PlatformLaserEnvironment.propagation_channel
- :type: ILaserPropagationChannel
+ :type: LaserPropagationChannel
Get the propagation channel.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/PlatformRFEnvironment.rst b/doc/source/api/ansys/stk/core/stkobjects/PlatformRFEnvironment.rst
new file mode 100644
index 0000000000..fc6e9d1c54
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/PlatformRFEnvironment.rst
@@ -0,0 +1,67 @@
+PlatformRFEnvironment
+=====================
+
+.. py:class:: ansys.stk.core.stkobjects.PlatformRFEnvironment
+
+ Class defining local atmosphere.
+
+.. py:currentmodule:: PlatformRFEnvironment
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Properties
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.PlatformRFEnvironment.enable_local_rain_data`
+ - Get or set the option for enabling local rain data.
+ * - :py:attr:`~ansys.stk.core.stkobjects.PlatformRFEnvironment.local_rain_height`
+ - Get or set the local rain iso height.
+ * - :py:attr:`~ansys.stk.core.stkobjects.PlatformRFEnvironment.local_rain_rate`
+ - Get or set the local rain rate.
+ * - :py:attr:`~ansys.stk.core.stkobjects.PlatformRFEnvironment.propagation_channel`
+ - Get the propagation channel.
+
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects import PlatformRFEnvironment
+
+
+Property detail
+---------------
+
+.. py:property:: enable_local_rain_data
+ :canonical: ansys.stk.core.stkobjects.PlatformRFEnvironment.enable_local_rain_data
+ :type: bool
+
+ Get or set the option for enabling local rain data.
+
+.. py:property:: local_rain_height
+ :canonical: ansys.stk.core.stkobjects.PlatformRFEnvironment.local_rain_height
+ :type: float
+
+ Get or set the local rain iso height.
+
+.. py:property:: local_rain_rate
+ :canonical: ansys.stk.core.stkobjects.PlatformRFEnvironment.local_rain_rate
+ :type: float
+
+ Get or set the local rain rate.
+
+.. py:property:: propagation_channel
+ :canonical: ansys.stk.core.stkobjects.PlatformRFEnvironment.propagation_channel
+ :type: PropagationChannel
+
+ Get the propagation channel.
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/PropagationChannel.rst b/doc/source/api/ansys/stk/core/stkobjects/PropagationChannel.rst
index 2b8c0661da..e3239a3aea 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/PropagationChannel.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/PropagationChannel.rst
@@ -12,37 +12,14 @@ Overview
.. tab-set::
- .. tab-item:: Methods
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.set_atmospheric_absorption_model`
- - Do not use this method, as it is deprecated. Use AtmosAbsorptionModelComponentLinking on PropagationChannel instead. Sets the atmospheric absorption model by name.
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.set_clouds_and_fog_fading_loss_model`
- - Do not use this method, as it is deprecated. Use CloudsAndFogFadingLossModelComponentLinking on PropagationChannel instead. Sets the CloudsAndFogFading loss model by name.
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.set_ionospheric_fading_loss_model`
- - Do not use this method, as it is deprecated. Use IonosphericFadingLossModelComponentLinking on PropagationChannel instead. Sets the Ionospheric Fading loss model by name.
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.set_rain_loss_model`
- - Do not use this method, as it is deprecated. Use RainLossModelComponentLinking on PropagationChannel instead. Sets the rain loss model by name.
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.set_tropospheric_scintillation_fading_loss_model`
- - Do not use this method, as it is deprecated. Use TroposphericScintillationFadingLossModelComponentLinking on PropagationChannel instead. Sets the Tropospheric Scintillation Fading loss model by name.
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.set_urban_terrestrial_loss_model`
- - Do not use this method, as it is deprecated. Use UrbanTerrestrialLossModelComponentLinking on PropagationChannel instead. Sets the urban/terrestrial loss model by name.
-
.. tab-item:: Properties
.. list-table::
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.atmospheric_absorption_model`
- - Do not use this property, as it is deprecated. Use AtmosAbsorptionModelComponentLinking on PropagationChannel instead. Gets the atmospheric absorption model.
* - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.atmospheric_absorption_model_component_linking`
- Get the link/embed controller for managing the atmospheric absorption model component.
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.clouds_and_fog_fading_loss_model`
- - Do not use this property, as it is deprecated. Use CloudsAndFogFadingLossModelComponentLinking on PropagationChannel instead. Gets the CloudsAndFogFading loss model.
* - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.clouds_and_fog_fading_loss_model_component_linking`
- Get the link/embed controller for managing the clouds and fog fading loss model component.
* - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.custom_a`
@@ -65,32 +42,12 @@ Overview
- Get or set the option to use the tropospheric scintillation fading loss model.
* - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.enable_urban_terrestrial_loss`
- Get or set the option to use the urban/terrestrial loss model.
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.ionospheric_fading_loss_model`
- - Do not use this property, as it is deprecated. Use IonosphericFadingLossModelComponentLinking on PropagationChannel instead. Gets the Ionospheric Fading loss model.
* - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.ionospheric_fading_loss_model_component_linking`
- Get the link/embed controller for managing the ionospheric fading loss model component.
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.rain_loss_model`
- - Do not use this property, as it is deprecated. Use RainLossModelComponentLinking on PropagationChannel instead. Gets the rain loss model.
* - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.rain_loss_model_component_linking`
- Get the link/embed controller for managing the rain loss model component.
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.supported_atmospheric_absorption_models`
- - Do not use this property, as it is deprecated. Use AtmosAbsorptionModelComponentLinking on PropagationChannel instead. Gets an array of supported atmospheric absorption model names.
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.supported_clouds_and_fog_fading_loss_models`
- - Do not use this property, as it is deprecated. Use CloudsAndFogFadingLossModelComponentLinking on PropagationChannel instead. Gets an array of supported CloudsAndFog Fading loss model names.
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.supported_ionospheric_fading_loss_models`
- - Do not use this property, as it is deprecated. Use IonosphericFadingLossModelComponentLinking on PropagationChannel instead. Gets an array of supported Ionospheric Fading loss model names.
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.supported_rain_loss_models`
- - Do not use this property, as it is deprecated. Use RainLossModelComponentLinking on PropagationChannel instead. Gets an array of supported rain loss model names.
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.supported_tropospheric_scintillation_fading_loss_models`
- - Do not use this property, as it is deprecated. Use TroposphericScintillationFadingLossModelComponentLinking on PropagationChannel instead. Gets an array of supported Tropospheric Scintillation Fading loss model names.
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.supported_urban_terrestrial_loss_models`
- - Do not use this property, as it is deprecated. Use UrbanTerrestrialLossModelComponentLinking on PropagationChannel instead. Gets an array of supported urban/terrestrial loss model names.
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.tropospheric_scintillation_fading_loss_model`
- - Do not use this property, as it is deprecated. Use TroposphericScintillationFadingLossModelComponentLinking on PropagationChannel instead. Gets the Tropospheric Scintillation Fading loss model.
* - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.tropospheric_scintillation_fading_loss_model_component_linking`
- Get the link/embed controller for managing the tropospheric scintillation fading loss model component.
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.urban_terrestrial_loss_model`
- - Do not use this property, as it is deprecated. Use UrbanTerrestrialLossModelComponentLinking on PropagationChannel instead. Gets the urban/terrestrial loss model.
* - :py:attr:`~ansys.stk.core.stkobjects.PropagationChannel.urban_terrestrial_loss_model_component_linking`
- Get the link/embed controller for managing the urban terrestrial loss model component.
@@ -107,24 +64,12 @@ Import detail
Property detail
---------------
-.. py:property:: atmospheric_absorption_model
- :canonical: ansys.stk.core.stkobjects.PropagationChannel.atmospheric_absorption_model
- :type: IAtmosphericAbsorptionModel
-
- Do not use this property, as it is deprecated. Use AtmosAbsorptionModelComponentLinking on PropagationChannel instead. Gets the atmospheric absorption model.
-
.. py:property:: atmospheric_absorption_model_component_linking
:canonical: ansys.stk.core.stkobjects.PropagationChannel.atmospheric_absorption_model_component_linking
:type: IComponentLinkEmbedControl
Get the link/embed controller for managing the atmospheric absorption model component.
-.. py:property:: clouds_and_fog_fading_loss_model
- :canonical: ansys.stk.core.stkobjects.PropagationChannel.clouds_and_fog_fading_loss_model
- :type: ICloudsAndFogFadingLossModel
-
- Do not use this property, as it is deprecated. Use CloudsAndFogFadingLossModelComponentLinking on PropagationChannel instead. Gets the CloudsAndFogFading loss model.
-
.. py:property:: clouds_and_fog_fading_loss_model_component_linking
:canonical: ansys.stk.core.stkobjects.PropagationChannel.clouds_and_fog_fading_loss_model_component_linking
:type: IComponentLinkEmbedControl
@@ -191,84 +136,24 @@ Property detail
Get or set the option to use the urban/terrestrial loss model.
-.. py:property:: ionospheric_fading_loss_model
- :canonical: ansys.stk.core.stkobjects.PropagationChannel.ionospheric_fading_loss_model
- :type: IIonosphericFadingLossModel
-
- Do not use this property, as it is deprecated. Use IonosphericFadingLossModelComponentLinking on PropagationChannel instead. Gets the Ionospheric Fading loss model.
-
.. py:property:: ionospheric_fading_loss_model_component_linking
:canonical: ansys.stk.core.stkobjects.PropagationChannel.ionospheric_fading_loss_model_component_linking
:type: IComponentLinkEmbedControl
Get the link/embed controller for managing the ionospheric fading loss model component.
-.. py:property:: rain_loss_model
- :canonical: ansys.stk.core.stkobjects.PropagationChannel.rain_loss_model
- :type: IRainLossModel
-
- Do not use this property, as it is deprecated. Use RainLossModelComponentLinking on PropagationChannel instead. Gets the rain loss model.
-
.. py:property:: rain_loss_model_component_linking
:canonical: ansys.stk.core.stkobjects.PropagationChannel.rain_loss_model_component_linking
:type: IComponentLinkEmbedControl
Get the link/embed controller for managing the rain loss model component.
-.. py:property:: supported_atmospheric_absorption_models
- :canonical: ansys.stk.core.stkobjects.PropagationChannel.supported_atmospheric_absorption_models
- :type: list
-
- Do not use this property, as it is deprecated. Use AtmosAbsorptionModelComponentLinking on PropagationChannel instead. Gets an array of supported atmospheric absorption model names.
-
-.. py:property:: supported_clouds_and_fog_fading_loss_models
- :canonical: ansys.stk.core.stkobjects.PropagationChannel.supported_clouds_and_fog_fading_loss_models
- :type: list
-
- Do not use this property, as it is deprecated. Use CloudsAndFogFadingLossModelComponentLinking on PropagationChannel instead. Gets an array of supported CloudsAndFog Fading loss model names.
-
-.. py:property:: supported_ionospheric_fading_loss_models
- :canonical: ansys.stk.core.stkobjects.PropagationChannel.supported_ionospheric_fading_loss_models
- :type: list
-
- Do not use this property, as it is deprecated. Use IonosphericFadingLossModelComponentLinking on PropagationChannel instead. Gets an array of supported Ionospheric Fading loss model names.
-
-.. py:property:: supported_rain_loss_models
- :canonical: ansys.stk.core.stkobjects.PropagationChannel.supported_rain_loss_models
- :type: list
-
- Do not use this property, as it is deprecated. Use RainLossModelComponentLinking on PropagationChannel instead. Gets an array of supported rain loss model names.
-
-.. py:property:: supported_tropospheric_scintillation_fading_loss_models
- :canonical: ansys.stk.core.stkobjects.PropagationChannel.supported_tropospheric_scintillation_fading_loss_models
- :type: list
-
- Do not use this property, as it is deprecated. Use TroposphericScintillationFadingLossModelComponentLinking on PropagationChannel instead. Gets an array of supported Tropospheric Scintillation Fading loss model names.
-
-.. py:property:: supported_urban_terrestrial_loss_models
- :canonical: ansys.stk.core.stkobjects.PropagationChannel.supported_urban_terrestrial_loss_models
- :type: list
-
- Do not use this property, as it is deprecated. Use UrbanTerrestrialLossModelComponentLinking on PropagationChannel instead. Gets an array of supported urban/terrestrial loss model names.
-
-.. py:property:: tropospheric_scintillation_fading_loss_model
- :canonical: ansys.stk.core.stkobjects.PropagationChannel.tropospheric_scintillation_fading_loss_model
- :type: ITroposphericScintillationFadingLossModel
-
- Do not use this property, as it is deprecated. Use TroposphericScintillationFadingLossModelComponentLinking on PropagationChannel instead. Gets the Tropospheric Scintillation Fading loss model.
-
.. py:property:: tropospheric_scintillation_fading_loss_model_component_linking
:canonical: ansys.stk.core.stkobjects.PropagationChannel.tropospheric_scintillation_fading_loss_model_component_linking
:type: IComponentLinkEmbedControl
Get the link/embed controller for managing the tropospheric scintillation fading loss model component.
-.. py:property:: urban_terrestrial_loss_model
- :canonical: ansys.stk.core.stkobjects.PropagationChannel.urban_terrestrial_loss_model
- :type: IUrbanTerrestrialLossModel
-
- Do not use this property, as it is deprecated. Use UrbanTerrestrialLossModelComponentLinking on PropagationChannel instead. Gets the urban/terrestrial loss model.
-
.. py:property:: urban_terrestrial_loss_model_component_linking
:canonical: ansys.stk.core.stkobjects.PropagationChannel.urban_terrestrial_loss_model_component_linking
:type: IComponentLinkEmbedControl
@@ -276,125 +161,3 @@ Property detail
Get the link/embed controller for managing the urban terrestrial loss model component.
-Method detail
--------------
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-.. py:method:: set_atmospheric_absorption_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.PropagationChannel.set_atmospheric_absorption_model
-
- Do not use this method, as it is deprecated. Use AtmosAbsorptionModelComponentLinking on PropagationChannel instead. Sets the atmospheric absorption model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-.. py:method:: set_clouds_and_fog_fading_loss_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.PropagationChannel.set_clouds_and_fog_fading_loss_model
-
- Do not use this method, as it is deprecated. Use CloudsAndFogFadingLossModelComponentLinking on PropagationChannel instead. Sets the CloudsAndFogFading loss model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-.. py:method:: set_ionospheric_fading_loss_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.PropagationChannel.set_ionospheric_fading_loss_model
-
- Do not use this method, as it is deprecated. Use IonosphericFadingLossModelComponentLinking on PropagationChannel instead. Sets the Ionospheric Fading loss model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-.. py:method:: set_rain_loss_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.PropagationChannel.set_rain_loss_model
-
- Do not use this method, as it is deprecated. Use RainLossModelComponentLinking on PropagationChannel instead. Sets the rain loss model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-.. py:method:: set_tropospheric_scintillation_fading_loss_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.PropagationChannel.set_tropospheric_scintillation_fading_loss_model
-
- Do not use this method, as it is deprecated. Use TroposphericScintillationFadingLossModelComponentLinking on PropagationChannel instead. Sets the Tropospheric Scintillation Fading loss model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-.. py:method:: set_urban_terrestrial_loss_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.PropagationChannel.set_urban_terrestrial_loss_model
-
- Do not use this method, as it is deprecated. Use UrbanTerrestrialLossModelComponentLinking on PropagationChannel instead. Sets the urban/terrestrial loss model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-
-
-
-
-
-
-
-
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/PropagatorHPOP.rst b/doc/source/api/ansys/stk/core/stkobjects/PropagatorHPOP.rst
index f2cad9cbb2..065fe175a2 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/PropagatorHPOP.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/PropagatorHPOP.rst
@@ -62,7 +62,7 @@ Set satellite propagator to HPOP and set force model properties
forceModel = satellite.propagator.force_model
if os.name == "nt":
- installPath = r"C:\Program Files\AGI\STK 12"
+ installPath = r"C:\Program Files\AGI\STK_ODTK 13"
else:
installPath = os.environ["STK_INSTALL_DIR"]
grv_path = ["STKData", "CentralBodies", "Earth", "WGS84_EGM96.grv"]
diff --git a/doc/source/api/ansys/stk/core/stkobjects/PropagatorSGP4OnlineAutoLoad.rst b/doc/source/api/ansys/stk/core/stkobjects/PropagatorSGP4OnlineAutoLoad.rst
deleted file mode 100644
index 53ca26949a..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/PropagatorSGP4OnlineAutoLoad.rst
+++ /dev/null
@@ -1,52 +0,0 @@
-PropagatorSGP4OnlineAutoLoad
-============================
-
-.. py:class:: ansys.stk.core.stkobjects.PropagatorSGP4OnlineAutoLoad
-
- Bases: :py:class:`~ansys.stk.core.stkobjects.IPropagatorSGP4LoadData`
-
- Do not use this class, as it is deprecated. Use PropagatorSGP4OnlineLoad instead. SGP4 propagator. Allows the user to load the most current segment from online.
-
-.. py:currentmodule:: PropagatorSGP4OnlineAutoLoad
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Methods
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.PropagatorSGP4OnlineAutoLoad.add_latest_segment_from_online`
- - Do not use this method, as it is deprecated. Use AddSegsFromOnline on PropagatorSGP4OnlineLoad instead. Adds the latest segment from Online given an SSC number.
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects import PropagatorSGP4OnlineAutoLoad
-
-
-
-Method detail
--------------
-
-.. py:method:: add_latest_segment_from_online(self, ssc_number: str) -> None
- :canonical: ansys.stk.core.stkobjects.PropagatorSGP4OnlineAutoLoad.add_latest_segment_from_online
-
- Do not use this method, as it is deprecated. Use AddSegsFromOnline on PropagatorSGP4OnlineLoad instead. Adds the latest segment from Online given an SSC number.
-
- :Parameters:
-
- **ssc_number** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/PropagatorSPICE.rst b/doc/source/api/ansys/stk/core/stkobjects/PropagatorSPICE.rst
index 0920bf9dfa..5966fa607f 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/PropagatorSPICE.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/PropagatorSPICE.rst
@@ -56,7 +56,7 @@ Set satellite propagator to SPICE and propagate
satellite.set_propagator_type(PropagatorType.SPICE)
propagator = satellite.propagator
if os.name == "nt":
- installPath = r"C:\Program Files\AGI\STK 12"
+ installPath = r"C:\Program Files\AGI\STK_ODTK 13"
else:
installPath = os.environ["STK_INSTALL_DIR"]
bspPath = ["STKData", "Spice", "planets.bsp"]
diff --git a/doc/source/api/ansys/stk/core/stkobjects/Radar.rst b/doc/source/api/ansys/stk/core/stkobjects/Radar.rst
index 52fd49ed90..8cfe6b927d 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/Radar.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/Radar.rst
@@ -22,8 +22,6 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.Radar.is_refraction_type_supported`
- Get a value indicating whether the specified type can be used.
- * - :py:attr:`~ansys.stk.core.stkobjects.Radar.set_model`
- - Do not use this method, as it is deprecated. Use ModelComponentLinking on Radar instead. Sets the current radar model by name.
.. tab-item:: Properties
@@ -31,12 +29,12 @@ Overview
:header-rows: 0
:widths: auto
+ * - :py:attr:`~ansys.stk.core.stkobjects.Radar.chain_analysis_options`
+ - Get the radar's chain analysis options.
* - :py:attr:`~ansys.stk.core.stkobjects.Radar.graphics`
- Get the 2D Graphics properties for the radar.
* - :py:attr:`~ansys.stk.core.stkobjects.Radar.graphics_3d`
- Get the 3D Graphics properties for the radar.
- * - :py:attr:`~ansys.stk.core.stkobjects.Radar.model`
- - Do not use this property, as it is deprecated. Use ModelComponentLinking on Radar instead. Gets the current radar model.
* - :py:attr:`~ansys.stk.core.stkobjects.Radar.model_component_linking`
- Get the link/embed controller for managing the radar model component.
* - :py:attr:`~ansys.stk.core.stkobjects.Radar.refraction`
@@ -47,8 +45,6 @@ Overview
- Return an array of valid choices.
* - :py:attr:`~ansys.stk.core.stkobjects.Radar.rf_environment`
- Get the object RF Environment settings.
- * - :py:attr:`~ansys.stk.core.stkobjects.Radar.supported_models`
- - Do not use this property, as it is deprecated. Use ModelComponentLinking on Radar instead. Gets an array of supported model names.
* - :py:attr:`~ansys.stk.core.stkobjects.Radar.use_refraction_in_access`
- Flag controls whether refraction is applied when computing relative position in Access.
@@ -65,6 +61,12 @@ Import detail
Property detail
---------------
+.. py:property:: chain_analysis_options
+ :canonical: ansys.stk.core.stkobjects.Radar.chain_analysis_options
+ :type: ChainAnalysisOptions
+
+ Get the radar's chain analysis options.
+
.. py:property:: graphics
:canonical: ansys.stk.core.stkobjects.Radar.graphics
:type: RadarGraphics
@@ -77,12 +79,6 @@ Property detail
Get the 3D Graphics properties for the radar.
-.. py:property:: model
- :canonical: ansys.stk.core.stkobjects.Radar.model
- :type: IRadarModel
-
- Do not use this property, as it is deprecated. Use ModelComponentLinking on Radar instead. Gets the current radar model.
-
.. py:property:: model_component_linking
:canonical: ansys.stk.core.stkobjects.Radar.model_component_linking
:type: IComponentLinkEmbedControl
@@ -113,12 +109,6 @@ Property detail
Get the object RF Environment settings.
-.. py:property:: supported_models
- :canonical: ansys.stk.core.stkobjects.Radar.supported_models
- :type: list
-
- Do not use this property, as it is deprecated. Use ModelComponentLinking on Radar instead. Gets an array of supported model names.
-
.. py:property:: use_refraction_in_access
:canonical: ansys.stk.core.stkobjects.Radar.use_refraction_in_access
:type: bool
@@ -130,6 +120,7 @@ Method detail
-------------
+
.. py:method:: is_refraction_type_supported(self, model: SensorRefractionType) -> bool
:canonical: ansys.stk.core.stkobjects.Radar.is_refraction_type_supported
@@ -151,21 +142,5 @@ Method detail
-.. py:method:: set_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.Radar.set_model
-
- Do not use this method, as it is deprecated. Use ModelComponentLinking on Radar instead. Sets the current radar model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/RadarAntennaBeam.rst b/doc/source/api/ansys/stk/core/stkobjects/RadarAntennaBeam.rst
index a495c52400..c0cd467cbf 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/RadarAntennaBeam.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/RadarAntennaBeam.rst
@@ -33,7 +33,7 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.RadarAntennaBeam.activity`
- Get the activity.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarAntennaBeam.beam_width`
+ * - :py:attr:`~ansys.stk.core.stkobjects.RadarAntennaBeam.beamwidth`
- Get or set the antenna beamwidth.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarAntennaBeam.gain`
- Get or set the antenna mainlobe gain.
@@ -63,8 +63,8 @@ Property detail
Get the activity.
-.. py:property:: beam_width
- :canonical: ansys.stk.core.stkobjects.RadarAntennaBeam.beam_width
+.. py:property:: beamwidth
+ :canonical: ansys.stk.core.stkobjects.RadarAntennaBeam.beamwidth
:type: float
Get or set the antenna beamwidth.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/RadarClutterGeometry.rst b/doc/source/api/ansys/stk/core/stkobjects/RadarClutterGeometry.rst
deleted file mode 100644
index b52a313cd2..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/RadarClutterGeometry.rst
+++ /dev/null
@@ -1,89 +0,0 @@
-RadarClutterGeometry
-====================
-
-.. py:class:: ansys.stk.core.stkobjects.RadarClutterGeometry
-
- Class defining a radar clutter geometry.
-
-.. py:currentmodule:: RadarClutterGeometry
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Methods
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarClutterGeometry.set_model`
- - Do not use this method, as it is deprecated. Use ScatteringPointProviderList on RadarClutter instead. Sets the current clutter geometry model by name.
-
- .. tab-item:: Properties
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarClutterGeometry.enabled`
- - Do not use this property, as it is deprecated. Use Enabled on RadarClutter instead. Gets or sets whether clutter geometry is enabled or disabled.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarClutterGeometry.model`
- - Do not use this property, as it is deprecated. Use ScatteringPointProviderList on RadarClutter instead. Gets the current clutter geometry model.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarClutterGeometry.supported_models`
- - Do not use this property, as it is deprecated. Use ScatteringPointProviderList on RadarClutter instead. Gets an array of supported model names.
-
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects import RadarClutterGeometry
-
-
-Property detail
----------------
-
-.. py:property:: enabled
- :canonical: ansys.stk.core.stkobjects.RadarClutterGeometry.enabled
- :type: bool
-
- Do not use this property, as it is deprecated. Use Enabled on RadarClutter instead. Gets or sets whether clutter geometry is enabled or disabled.
-
-.. py:property:: model
- :canonical: ansys.stk.core.stkobjects.RadarClutterGeometry.model
- :type: IRadarClutterGeometryModel
-
- Do not use this property, as it is deprecated. Use ScatteringPointProviderList on RadarClutter instead. Gets the current clutter geometry model.
-
-.. py:property:: supported_models
- :canonical: ansys.stk.core.stkobjects.RadarClutterGeometry.supported_models
- :type: list
-
- Do not use this property, as it is deprecated. Use ScatteringPointProviderList on RadarClutter instead. Gets an array of supported model names.
-
-
-Method detail
--------------
-
-
-
-
-.. py:method:: set_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.RadarClutterGeometry.set_model
-
- Do not use this method, as it is deprecated. Use ScatteringPointProviderList on RadarClutter instead. Sets the current clutter geometry model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/RadarClutterGeometryModelType.rst b/doc/source/api/ansys/stk/core/stkobjects/RadarClutterGeometryModelType.rst
deleted file mode 100644
index 3341e0bc02..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/RadarClutterGeometryModelType.rst
+++ /dev/null
@@ -1,45 +0,0 @@
-RadarClutterGeometryModelType
-=============================
-
-.. py:class:: ansys.stk.core.stkobjects.RadarClutterGeometryModelType
-
- IntEnum
-
-
-.. py:currentmodule:: RadarClutterGeometryModelType
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Members
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~UNKNOWN`
- - Unknown.
-
- * - :py:attr:`~SINGLE_POINT`
- - Single point.
-
- * - :py:attr:`~SMOOTH_OBLATE_EARTH`
- - Smooth oblate earth.
-
- * - :py:attr:`~PLUGIN`
- - Plugin.
-
- * - :py:attr:`~RANGE_OVER_CFAR_CELLS`
- - Range Over CFAR Cells.
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects import RadarClutterGeometryModelType
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/RadarClutterMapModelType.rst b/doc/source/api/ansys/stk/core/stkobjects/RadarClutterMapModelType.rst
deleted file mode 100644
index ce5119ee38..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/RadarClutterMapModelType.rst
+++ /dev/null
@@ -1,39 +0,0 @@
-RadarClutterMapModelType
-========================
-
-.. py:class:: ansys.stk.core.stkobjects.RadarClutterMapModelType
-
- IntEnum
-
-
-.. py:currentmodule:: RadarClutterMapModelType
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Members
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~UNKNOWN`
- - Unknown.
-
- * - :py:attr:`~PLUGIN`
- - Plugin.
-
- * - :py:attr:`~CONSTANT_COEFFICIENT`
- - Constant Coefficient.
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects import RadarClutterMapModelType
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/RadarCrossSection.rst b/doc/source/api/ansys/stk/core/stkobjects/RadarCrossSection.rst
index 920086f190..816ae6760b 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/RadarCrossSection.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/RadarCrossSection.rst
@@ -12,27 +12,14 @@ Overview
.. tab-set::
- .. tab-item:: Methods
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarCrossSection.set_model`
- - Do not use this method, as it is deprecated. Use ModelComponentLinking on RadarCrossSection instead. Sets the current RCS model by name.
-
.. tab-item:: Properties
.. list-table::
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarCrossSection.model`
- - Do not use this property, as it is deprecated. Use ModelComponentLinking on RadarCrossSection instead. Gets the current RCS model.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarCrossSection.model_component_linking`
- Get the link/embed controller for managing the radar cross section model component.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarCrossSection.supported_models`
- - Do not use this property, as it is deprecated. Use ModelComponentLinking on RadarCrossSection instead. Gets an array of supported model names.
@@ -47,42 +34,10 @@ Import detail
Property detail
---------------
-.. py:property:: model
- :canonical: ansys.stk.core.stkobjects.RadarCrossSection.model
- :type: RadarCrossSectionModel
-
- Do not use this property, as it is deprecated. Use ModelComponentLinking on RadarCrossSection instead. Gets the current RCS model.
-
.. py:property:: model_component_linking
:canonical: ansys.stk.core.stkobjects.RadarCrossSection.model_component_linking
:type: IComponentLinkEmbedControl
Get the link/embed controller for managing the radar cross section model component.
-.. py:property:: supported_models
- :canonical: ansys.stk.core.stkobjects.RadarCrossSection.supported_models
- :type: list
-
- Do not use this property, as it is deprecated. Use ModelComponentLinking on RadarCrossSection instead. Gets an array of supported model names.
-
-
-Method detail
--------------
-
-
-
-.. py:method:: set_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.RadarCrossSection.set_model
-
- Do not use this method, as it is deprecated. Use ModelComponentLinking on RadarCrossSection instead. Sets the current RCS model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/RadarCrossSectionInheritable.rst b/doc/source/api/ansys/stk/core/stkobjects/RadarCrossSectionInheritable.rst
index c96399eb22..dbb4e047ba 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/RadarCrossSectionInheritable.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/RadarCrossSectionInheritable.rst
@@ -12,15 +12,6 @@ Overview
.. tab-set::
- .. tab-item:: Methods
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarCrossSectionInheritable.set_model`
- - Do not use this method, as it is deprecated. Use ModelComponentLinking on RadarCrossSectionInheritable instead. Sets the current RCS model by name.
-
.. tab-item:: Properties
.. list-table::
@@ -29,12 +20,8 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.RadarCrossSectionInheritable.inherit`
- Get or set the option to inherit the radar cross section from the scenario object.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarCrossSectionInheritable.model`
- - Do not use this property, as it is deprecated. Use ModelComponentLinking on RadarCrossSectionInheritable instead. Gets the current RCS model.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarCrossSectionInheritable.model_component_linking`
- Get the link/embed controller for managing the radar cross section model component.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarCrossSectionInheritable.supported_models`
- - Do not use this property, as it is deprecated. Use ModelComponentLinking on RadarCrossSectionInheritable instead. Gets an array of supported model names.
@@ -55,44 +42,10 @@ Property detail
Get or set the option to inherit the radar cross section from the scenario object.
-.. py:property:: model
- :canonical: ansys.stk.core.stkobjects.RadarCrossSectionInheritable.model
- :type: RadarCrossSectionModel
-
- Do not use this property, as it is deprecated. Use ModelComponentLinking on RadarCrossSectionInheritable instead. Gets the current RCS model.
-
.. py:property:: model_component_linking
:canonical: ansys.stk.core.stkobjects.RadarCrossSectionInheritable.model_component_linking
:type: IComponentLinkEmbedControl
Get the link/embed controller for managing the radar cross section model component.
-.. py:property:: supported_models
- :canonical: ansys.stk.core.stkobjects.RadarCrossSectionInheritable.supported_models
- :type: list
-
- Do not use this property, as it is deprecated. Use ModelComponentLinking on RadarCrossSectionInheritable instead. Gets an array of supported model names.
-
-
-Method detail
--------------
-
-
-
-
-
-.. py:method:: set_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.RadarCrossSectionInheritable.set_model
-
- Do not use this method, as it is deprecated. Use ModelComponentLinking on RadarCrossSectionInheritable instead. Sets the current RCS model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/RadarModelBistaticReceiver.rst b/doc/source/api/ansys/stk/core/stkobjects/RadarModelBistaticReceiver.rst
index 1751050eeb..f200c1764b 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/RadarModelBistaticReceiver.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/RadarModelBistaticReceiver.rst
@@ -14,15 +14,6 @@ Overview
.. tab-set::
- .. tab-item:: Methods
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarModelBistaticReceiver.set_mode`
- - Do not use this method, as it is deprecated. Use ModeComponentLinking on RadarModelBistaticReceiver instead. Sets the current radar mode by name.
-
.. tab-item:: Properties
.. list-table::
@@ -35,18 +26,12 @@ Overview
- Get the bistatic transmitter collection.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarModelBistaticReceiver.clutter`
- Get the radar clutter settings.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarModelBistaticReceiver.clutter_geometry`
- - Do not use this property, as it is deprecated.Use the Clutter property instead.Gets the radar clutter geometry.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarModelBistaticReceiver.jamming`
- Get the radar jamming.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarModelBistaticReceiver.mode`
- - Do not use this property, as it is deprecated. Use ModeComponentLinking on RadarModelBistaticReceiver instead. Gets the current radar mode.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarModelBistaticReceiver.mode_component_linking`
- Get the link/embed controller for managing the radar mode component.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarModelBistaticReceiver.receiver`
- Get the radar receiver.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarModelBistaticReceiver.supported_modes`
- - Do not use this property, as it is deprecated. Use ModeComponentLinking on RadarModelBistaticReceiver instead. Gets an array of supported mode names.
@@ -79,24 +64,12 @@ Property detail
Get the radar clutter settings.
-.. py:property:: clutter_geometry
- :canonical: ansys.stk.core.stkobjects.RadarModelBistaticReceiver.clutter_geometry
- :type: RadarClutterGeometry
-
- Do not use this property, as it is deprecated.Use the Clutter property instead.Gets the radar clutter geometry.
-
.. py:property:: jamming
:canonical: ansys.stk.core.stkobjects.RadarModelBistaticReceiver.jamming
:type: RadarJamming
Get the radar jamming.
-.. py:property:: mode
- :canonical: ansys.stk.core.stkobjects.RadarModelBistaticReceiver.mode
- :type: IRadarModeBistaticReceiver
-
- Do not use this property, as it is deprecated. Use ModeComponentLinking on RadarModelBistaticReceiver instead. Gets the current radar mode.
-
.. py:property:: mode_component_linking
:canonical: ansys.stk.core.stkobjects.RadarModelBistaticReceiver.mode_component_linking
:type: IComponentLinkEmbedControl
@@ -109,36 +82,4 @@ Property detail
Get the radar receiver.
-.. py:property:: supported_modes
- :canonical: ansys.stk.core.stkobjects.RadarModelBistaticReceiver.supported_modes
- :type: list
-
- Do not use this property, as it is deprecated. Use ModeComponentLinking on RadarModelBistaticReceiver instead. Gets an array of supported mode names.
-
-
-Method detail
--------------
-
-
-
-
-
-
-
-
-
-.. py:method:: set_mode(self, mode_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.RadarModelBistaticReceiver.set_mode
-
- Do not use this method, as it is deprecated. Use ModeComponentLinking on RadarModelBistaticReceiver instead. Sets the current radar mode by name.
-
- :Parameters:
-
- **mode_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/RadarModelBistaticTransmitter.rst b/doc/source/api/ansys/stk/core/stkobjects/RadarModelBistaticTransmitter.rst
index 39ea1efc84..eddd2bbe04 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/RadarModelBistaticTransmitter.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/RadarModelBistaticTransmitter.rst
@@ -14,15 +14,6 @@ Overview
.. tab-set::
- .. tab-item:: Methods
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarModelBistaticTransmitter.set_mode`
- - Do not use this method, as it is deprecated. Use ModeComponentLinking on RadarModelBistaticTransmitter instead. Sets the current radar mode by name.
-
.. tab-item:: Properties
.. list-table::
@@ -33,12 +24,8 @@ Overview
- Get the radar antenna control.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarModelBistaticTransmitter.bistatic_receivers`
- Get the bistatic receiver collection.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarModelBistaticTransmitter.mode`
- - Do not use this property, as it is deprecated. Use ModeComponentLinking on RadarModelBistaticTransmitter instead. Gets the current radar mode.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarModelBistaticTransmitter.mode_component_linking`
- Get the link/embed controller for managing the radar mode component.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarModelBistaticTransmitter.supported_modes`
- - Do not use this property, as it is deprecated. Use ModeComponentLinking on RadarModelBistaticTransmitter instead. Gets an array of supported mode names.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarModelBistaticTransmitter.transmitter`
- Get the radar transmitter.
@@ -67,24 +54,12 @@ Property detail
Get the bistatic receiver collection.
-.. py:property:: mode
- :canonical: ansys.stk.core.stkobjects.RadarModelBistaticTransmitter.mode
- :type: IRadarModeBistaticTransmitter
-
- Do not use this property, as it is deprecated. Use ModeComponentLinking on RadarModelBistaticTransmitter instead. Gets the current radar mode.
-
.. py:property:: mode_component_linking
:canonical: ansys.stk.core.stkobjects.RadarModelBistaticTransmitter.mode_component_linking
:type: IComponentLinkEmbedControl
Get the link/embed controller for managing the radar mode component.
-.. py:property:: supported_modes
- :canonical: ansys.stk.core.stkobjects.RadarModelBistaticTransmitter.supported_modes
- :type: list
-
- Do not use this property, as it is deprecated. Use ModeComponentLinking on RadarModelBistaticTransmitter instead. Gets an array of supported mode names.
-
.. py:property:: transmitter
:canonical: ansys.stk.core.stkobjects.RadarModelBistaticTransmitter.transmitter
:type: RadarTransmitter
@@ -92,26 +67,3 @@ Property detail
Get the radar transmitter.
-Method detail
--------------
-
-
-
-
-
-.. py:method:: set_mode(self, mode_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.RadarModelBistaticTransmitter.set_mode
-
- Do not use this method, as it is deprecated. Use ModeComponentLinking on RadarModelBistaticTransmitter instead. Sets the current radar mode by name.
-
- :Parameters:
-
- **mode_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/RadarModelMonostatic.rst b/doc/source/api/ansys/stk/core/stkobjects/RadarModelMonostatic.rst
index 8b09be336e..9a6332faf8 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/RadarModelMonostatic.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/RadarModelMonostatic.rst
@@ -14,15 +14,6 @@ Overview
.. tab-set::
- .. tab-item:: Methods
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarModelMonostatic.set_mode`
- - Do not use this method, as it is deprecated. Use ModeComponentLinking on RadarModelMonostatic instead. Sets the current radar mode by name.
-
.. tab-item:: Properties
.. list-table::
@@ -33,18 +24,12 @@ Overview
- Get the radar antenna control.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarModelMonostatic.clutter`
- Get the radar clutter settings.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarModelMonostatic.clutter_geometry`
- - Do not use this property, as it is deprecated. Use the Clutter property instead. Gets the radar clutter geometry.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarModelMonostatic.jamming`
- Get the radar jamming.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarModelMonostatic.mode`
- - Do not use this property, as it is deprecated. Use ModeComponentLinking on RadarModelMonostatic instead. Gets the current radar mode.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarModelMonostatic.mode_component_linking`
- Get the link/embed controller for managing the radar mode component.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarModelMonostatic.receiver`
- Get the radar receiver.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarModelMonostatic.supported_modes`
- - Do not use this property, as it is deprecated. Use ModeComponentLinking on RadarModelMonostatic instead. Gets an array of supported mode names.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarModelMonostatic.transmitter`
- Get the radar transmitter.
@@ -73,24 +58,12 @@ Property detail
Get the radar clutter settings.
-.. py:property:: clutter_geometry
- :canonical: ansys.stk.core.stkobjects.RadarModelMonostatic.clutter_geometry
- :type: RadarClutterGeometry
-
- Do not use this property, as it is deprecated. Use the Clutter property instead. Gets the radar clutter geometry.
-
.. py:property:: jamming
:canonical: ansys.stk.core.stkobjects.RadarModelMonostatic.jamming
:type: RadarJamming
Get the radar jamming.
-.. py:property:: mode
- :canonical: ansys.stk.core.stkobjects.RadarModelMonostatic.mode
- :type: IRadarModeMonostatic
-
- Do not use this property, as it is deprecated. Use ModeComponentLinking on RadarModelMonostatic instead. Gets the current radar mode.
-
.. py:property:: mode_component_linking
:canonical: ansys.stk.core.stkobjects.RadarModelMonostatic.mode_component_linking
:type: IComponentLinkEmbedControl
@@ -103,12 +76,6 @@ Property detail
Get the radar receiver.
-.. py:property:: supported_modes
- :canonical: ansys.stk.core.stkobjects.RadarModelMonostatic.supported_modes
- :type: list
-
- Do not use this property, as it is deprecated. Use ModeComponentLinking on RadarModelMonostatic instead. Gets an array of supported mode names.
-
.. py:property:: transmitter
:canonical: ansys.stk.core.stkobjects.RadarModelMonostatic.transmitter
:type: RadarTransmitter
@@ -116,29 +83,3 @@ Property detail
Get the radar transmitter.
-Method detail
--------------
-
-
-
-
-
-
-
-
-.. py:method:: set_mode(self, mode_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.RadarModelMonostatic.set_mode
-
- Do not use this method, as it is deprecated. Use ModeComponentLinking on RadarModelMonostatic instead. Sets the current radar mode by name.
-
- :Parameters:
-
- **mode_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/RadarModelMultifunction.rst b/doc/source/api/ansys/stk/core/stkobjects/RadarModelMultifunction.rst
index 17b10fb2bd..041d1a0cf8 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/RadarModelMultifunction.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/RadarModelMultifunction.rst
@@ -33,8 +33,6 @@ Overview
- Get the antenna beams collection.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarModelMultifunction.clutter`
- Get the radar clutter settings.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarModelMultifunction.clutter_geometry`
- - Do not use this property, as it is deprecated.Use the Clutter property instead.Gets the radar clutter geometry.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarModelMultifunction.detection_processing`
- Get the radar detection processing object.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarModelMultifunction.jamming`
@@ -75,12 +73,6 @@ Property detail
Get the radar clutter settings.
-.. py:property:: clutter_geometry
- :canonical: ansys.stk.core.stkobjects.RadarModelMultifunction.clutter_geometry
- :type: RadarClutterGeometry
-
- Do not use this property, as it is deprecated.Use the Clutter property instead.Gets the radar clutter geometry.
-
.. py:property:: detection_processing
:canonical: ansys.stk.core.stkobjects.RadarModelMultifunction.detection_processing
:type: RadarMultifunctionDetectionProcessing
@@ -134,7 +126,6 @@ Method detail
-
.. py:method:: set_pointing_strategy_type(self, value: PointingStrategyType) -> None
:canonical: ansys.stk.core.stkobjects.RadarModelMultifunction.set_pointing_strategy_type
diff --git a/doc/source/api/ansys/stk/core/stkobjects/RadarReceiver.rst b/doc/source/api/ansys/stk/core/stkobjects/RadarReceiver.rst
index 102f01d1a2..096508ad2d 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/RadarReceiver.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/RadarReceiver.rst
@@ -18,8 +18,6 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarReceiver.set_filter`
- - Do not use this method, as it is deprecated. Use FilterComponentLinking on RadarReceiver instead. Sets the current filter model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarReceiver.set_ifstc_type`
- Set the IF STC Type.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarReceiver.set_polarization_type`
@@ -45,8 +43,6 @@ Overview
- Get or set the enable polarization option.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarReceiver.enable_rfstc`
- Get or set whether the RF STC is enabled.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarReceiver.filter`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on RadarReceiver instead. Gets the current filter model.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarReceiver.filter_component_linking`
- Get the link/embed controller for managing the filter model component.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarReceiver.frequency`
@@ -67,8 +63,6 @@ Overview
- Get or set the rain outage percent.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarReceiver.rfstc`
- Get the RF STC.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarReceiver.supported_filters`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on RadarReceiver instead. Gets an array of supported model names.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarReceiver.supported_ifstc_types`
- Get the IF STC Types.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarReceiver.supported_rain_outage_percent_values`
@@ -129,12 +123,6 @@ Property detail
Get or set whether the RF STC is enabled.
-.. py:property:: filter
- :canonical: ansys.stk.core.stkobjects.RadarReceiver.filter
- :type: IRFFilterModel
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on RadarReceiver instead. Gets the current filter model.
-
.. py:property:: filter_component_linking
:canonical: ansys.stk.core.stkobjects.RadarReceiver.filter_component_linking
:type: IComponentLinkEmbedControl
@@ -195,12 +183,6 @@ Property detail
Get the RF STC.
-.. py:property:: supported_filters
- :canonical: ansys.stk.core.stkobjects.RadarReceiver.supported_filters
- :type: list
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on RadarReceiver instead. Gets an array of supported model names.
-
.. py:property:: supported_ifstc_types
:canonical: ansys.stk.core.stkobjects.RadarReceiver.supported_ifstc_types
:type: list
@@ -261,21 +243,6 @@ Method detail
-
-
-.. py:method:: set_filter(self, name: str) -> None
- :canonical: ansys.stk.core.stkobjects.RadarReceiver.set_filter
-
- Do not use this method, as it is deprecated. Use FilterComponentLinking on RadarReceiver instead. Sets the current filter model by name.
-
- :Parameters:
-
- **name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
.. py:method:: set_ifstc_type(self, type_name: str) -> None
:canonical: ansys.stk.core.stkobjects.RadarReceiver.set_ifstc_type
@@ -325,4 +292,3 @@ Method detail
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/RadarTransmitter.rst b/doc/source/api/ansys/stk/core/stkobjects/RadarTransmitter.rst
index 5101d0a41f..73f3bca1bb 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/RadarTransmitter.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/RadarTransmitter.rst
@@ -18,8 +18,6 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarTransmitter.set_filter`
- - Do not use this method, as it is deprecated. Use FilterComponentLinking on RadarTransmitter instead. Sets the current filter model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarTransmitter.set_polarization_type`
- Set the current polarization type.
@@ -35,8 +33,6 @@ Overview
- Get or set the option for enabling the orthogonal polarization.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarTransmitter.enable_polarization`
- Get or set the enable polarization option.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarTransmitter.filter`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on RadarTransmitter instead. Gets the current filter model.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarTransmitter.filter_component_linking`
- Get the link/embed controller for managing the filter model component.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarTransmitter.frequency`
@@ -51,8 +47,6 @@ Overview
- Get or set the power.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarTransmitter.power_amplifier_bandwidth`
- Get or set the power amplifier bandwidth.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarTransmitter.supported_filters`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on RadarTransmitter instead. Gets an array of supported filter model names.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarTransmitter.wavelength`
- Get or set the wavelength.
@@ -87,12 +81,6 @@ Property detail
Get or set the enable polarization option.
-.. py:property:: filter
- :canonical: ansys.stk.core.stkobjects.RadarTransmitter.filter
- :type: IRFFilterModel
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on RadarTransmitter instead. Gets the current filter model.
-
.. py:property:: filter_component_linking
:canonical: ansys.stk.core.stkobjects.RadarTransmitter.filter_component_linking
:type: IComponentLinkEmbedControl
@@ -135,12 +123,6 @@ Property detail
Get or set the power amplifier bandwidth.
-.. py:property:: supported_filters
- :canonical: ansys.stk.core.stkobjects.RadarTransmitter.supported_filters
- :type: list
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on RadarTransmitter instead. Gets an array of supported filter model names.
-
.. py:property:: wavelength
:canonical: ansys.stk.core.stkobjects.RadarTransmitter.wavelength
:type: float
@@ -168,21 +150,6 @@ Method detail
-
-.. py:method:: set_filter(self, name: str) -> None
- :canonical: ansys.stk.core.stkobjects.RadarTransmitter.set_filter
-
- Do not use this method, as it is deprecated. Use FilterComponentLinking on RadarTransmitter instead. Sets the current filter model by name.
-
- :Parameters:
-
- **name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
.. py:method:: set_polarization_type(self, value: PolarizationType) -> None
:canonical: ansys.stk.core.stkobjects.RadarTransmitter.set_polarization_type
@@ -199,4 +166,3 @@ Method detail
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/RadarTransmitterMultifunction.rst b/doc/source/api/ansys/stk/core/stkobjects/RadarTransmitterMultifunction.rst
index 440260197e..d30b4679b0 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/RadarTransmitterMultifunction.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/RadarTransmitterMultifunction.rst
@@ -18,8 +18,6 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarTransmitterMultifunction.set_filter`
- - Do not use this method, as it is deprecated. Use FilterComponentLinking on RadarTransmitterMultifunction instead. Sets the current filter model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarTransmitterMultifunction.set_polarization_type`
- Set the current polarization type.
@@ -35,8 +33,6 @@ Overview
- Get or set the option for enabling the orthogonal polarization.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarTransmitterMultifunction.enable_polarization`
- Get or set the enable polarization option.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarTransmitterMultifunction.filter`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on RadarTransmitterMultifunction instead. Gets the current filter model.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarTransmitterMultifunction.filter_component_linking`
- Get the link/embed controller for managing the filter model component.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarTransmitterMultifunction.maximum_power_limit`
@@ -47,8 +43,6 @@ Overview
- Get the collection of additional post transmit gains and losses.
* - :py:attr:`~ansys.stk.core.stkobjects.RadarTransmitterMultifunction.power_amplifier_bandwidth`
- Get or set the power amplifier bandwidth.
- * - :py:attr:`~ansys.stk.core.stkobjects.RadarTransmitterMultifunction.supported_filters`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on RadarTransmitterMultifunction instead. Gets an array of supported filter model names.
@@ -81,12 +75,6 @@ Property detail
Get or set the enable polarization option.
-.. py:property:: filter
- :canonical: ansys.stk.core.stkobjects.RadarTransmitterMultifunction.filter
- :type: IRFFilterModel
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on RadarTransmitterMultifunction instead. Gets the current filter model.
-
.. py:property:: filter_component_linking
:canonical: ansys.stk.core.stkobjects.RadarTransmitterMultifunction.filter_component_linking
:type: IComponentLinkEmbedControl
@@ -117,12 +105,6 @@ Property detail
Get or set the power amplifier bandwidth.
-.. py:property:: supported_filters
- :canonical: ansys.stk.core.stkobjects.RadarTransmitterMultifunction.supported_filters
- :type: list
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on RadarTransmitterMultifunction instead. Gets an array of supported filter model names.
-
Method detail
-------------
@@ -140,21 +122,6 @@ Method detail
-
-.. py:method:: set_filter(self, name: str) -> None
- :canonical: ansys.stk.core.stkobjects.RadarTransmitterMultifunction.set_filter
-
- Do not use this method, as it is deprecated. Use FilterComponentLinking on RadarTransmitterMultifunction instead. Sets the current filter model by name.
-
- :Parameters:
-
- **name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
.. py:method:: set_polarization_type(self, value: PolarizationType) -> None
:canonical: ansys.stk.core.stkobjects.RadarTransmitterMultifunction.set_polarization_type
@@ -169,4 +136,3 @@ Method detail
:obj:`~None`
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ReTransmitterModelComplex.rst b/doc/source/api/ansys/stk/core/stkobjects/ReTransmitterModelComplex.rst
index b4c059890f..44ae001de1 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ReTransmitterModelComplex.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ReTransmitterModelComplex.rst
@@ -20,8 +20,6 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelComplex.set_filter`
- - Do not use this method, as it is deprecated. Use FilterComponentLinking on ReTransmitterModelComplex instead. Sets the current filter model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelComplex.set_polarization_type`
- Set the current polarization type.
@@ -37,8 +35,6 @@ Overview
- Get or set the flag determines whether or not to enable the Filter.
* - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelComplex.enable_polarization`
- Get or set the enable polarization option.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelComplex.filter`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on ReTransmitterModelComplex instead. Gets the current filter model.
* - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelComplex.filter_component_linking`
- Get the link/embed controller for managing the filter model component.
* - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelComplex.polarization`
@@ -47,8 +43,6 @@ Overview
- Get the collection of additional post transmit gains and losses.
* - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelComplex.saturated_power`
- Get or set the saturated power.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelComplex.supported_filters`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on ReTransmitterModelComplex instead. Gets an array of supported filter model names.
@@ -81,12 +75,6 @@ Property detail
Get or set the enable polarization option.
-.. py:property:: filter
- :canonical: ansys.stk.core.stkobjects.ReTransmitterModelComplex.filter
- :type: IRFFilterModel
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on ReTransmitterModelComplex instead. Gets the current filter model.
-
.. py:property:: filter_component_linking
:canonical: ansys.stk.core.stkobjects.ReTransmitterModelComplex.filter_component_linking
:type: IComponentLinkEmbedControl
@@ -111,12 +99,6 @@ Property detail
Get or set the saturated power.
-.. py:property:: supported_filters
- :canonical: ansys.stk.core.stkobjects.ReTransmitterModelComplex.supported_filters
- :type: list
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on ReTransmitterModelComplex instead. Gets an array of supported filter model names.
-
Method detail
-------------
@@ -131,21 +113,6 @@ Method detail
-
-.. py:method:: set_filter(self, name: str) -> None
- :canonical: ansys.stk.core.stkobjects.ReTransmitterModelComplex.set_filter
-
- Do not use this method, as it is deprecated. Use FilterComponentLinking on ReTransmitterModelComplex instead. Sets the current filter model by name.
-
- :Parameters:
-
- **name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
.. py:method:: set_polarization_type(self, value: PolarizationType) -> None
:canonical: ansys.stk.core.stkobjects.ReTransmitterModelComplex.set_polarization_type
@@ -160,4 +127,3 @@ Method detail
:obj:`~None`
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ReTransmitterModelMedium.rst b/doc/source/api/ansys/stk/core/stkobjects/ReTransmitterModelMedium.rst
index 33c7aa0bf8..00e300c213 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ReTransmitterModelMedium.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ReTransmitterModelMedium.rst
@@ -20,8 +20,6 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelMedium.set_filter`
- - Do not use this method, as it is deprecated. Use FilterComponentLinking on ReTransmitterModelMedium instead. Sets the current filter model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelMedium.set_polarization_type`
- Set the current polarization type.
@@ -37,8 +35,6 @@ Overview
- Get or set the flag determines whether or not to enable the Filter.
* - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelMedium.enable_polarization`
- Get or set the enable polarization option.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelMedium.filter`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on ReTransmitterModelMedium instead. Gets the current filter model.
* - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelMedium.filter_component_linking`
- Get the link/embed controller for managing the filter model component.
* - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelMedium.polarization`
@@ -47,8 +43,6 @@ Overview
- Get the collection of additional post transmit gains and losses.
* - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelMedium.saturated_power`
- Get or set the saturated power.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelMedium.supported_filters`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on ReTransmitterModelMedium instead. Gets an array of supported filter model names.
@@ -81,12 +75,6 @@ Property detail
Get or set the enable polarization option.
-.. py:property:: filter
- :canonical: ansys.stk.core.stkobjects.ReTransmitterModelMedium.filter
- :type: IRFFilterModel
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on ReTransmitterModelMedium instead. Gets the current filter model.
-
.. py:property:: filter_component_linking
:canonical: ansys.stk.core.stkobjects.ReTransmitterModelMedium.filter_component_linking
:type: IComponentLinkEmbedControl
@@ -111,12 +99,6 @@ Property detail
Get or set the saturated power.
-.. py:property:: supported_filters
- :canonical: ansys.stk.core.stkobjects.ReTransmitterModelMedium.supported_filters
- :type: list
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on ReTransmitterModelMedium instead. Gets an array of supported filter model names.
-
Method detail
-------------
@@ -132,21 +114,6 @@ Method detail
-
-.. py:method:: set_filter(self, name: str) -> None
- :canonical: ansys.stk.core.stkobjects.ReTransmitterModelMedium.set_filter
-
- Do not use this method, as it is deprecated. Use FilterComponentLinking on ReTransmitterModelMedium instead. Sets the current filter model by name.
-
- :Parameters:
-
- **name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
.. py:method:: set_polarization_type(self, value: PolarizationType) -> None
:canonical: ansys.stk.core.stkobjects.ReTransmitterModelMedium.set_polarization_type
@@ -161,4 +128,3 @@ Method detail
:obj:`~None`
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ReTransmitterModelSimple.rst b/doc/source/api/ansys/stk/core/stkobjects/ReTransmitterModelSimple.rst
index b3c69ec1f1..70ee87b712 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ReTransmitterModelSimple.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ReTransmitterModelSimple.rst
@@ -20,8 +20,6 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelSimple.set_filter`
- - Do not use this method, as it is deprecated. Use FilterComponentLinking on ReTransmitterModelSimple instead. Sets the current filter model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelSimple.set_polarization_type`
- Set the current polarization type.
@@ -35,8 +33,6 @@ Overview
- Get or set the flag determines whether or not to enable the Filter.
* - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelSimple.enable_polarization`
- Get or set the enable polarization option.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelSimple.filter`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on ReTransmitterModelSimple instead. Gets the current filter model.
* - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelSimple.filter_component_linking`
- Get the link/embed controller for managing the filter model component.
* - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelSimple.polarization`
@@ -45,8 +41,6 @@ Overview
- Get the collection of additional post transmit gains and losses.
* - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelSimple.saturated_eirp`
- Get or set the saturated eirp.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReTransmitterModelSimple.supported_filters`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on ReTransmitterModelSimple instead. Gets an array of supported filter model names.
@@ -73,12 +67,6 @@ Property detail
Get or set the enable polarization option.
-.. py:property:: filter
- :canonical: ansys.stk.core.stkobjects.ReTransmitterModelSimple.filter
- :type: IRFFilterModel
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on ReTransmitterModelSimple instead. Gets the current filter model.
-
.. py:property:: filter_component_linking
:canonical: ansys.stk.core.stkobjects.ReTransmitterModelSimple.filter_component_linking
:type: IComponentLinkEmbedControl
@@ -103,12 +91,6 @@ Property detail
Get or set the saturated eirp.
-.. py:property:: supported_filters
- :canonical: ansys.stk.core.stkobjects.ReTransmitterModelSimple.supported_filters
- :type: list
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on ReTransmitterModelSimple instead. Gets an array of supported filter model names.
-
Method detail
-------------
@@ -122,21 +104,6 @@ Method detail
-
-.. py:method:: set_filter(self, name: str) -> None
- :canonical: ansys.stk.core.stkobjects.ReTransmitterModelSimple.set_filter
-
- Do not use this method, as it is deprecated. Use FilterComponentLinking on ReTransmitterModelSimple instead. Sets the current filter model by name.
-
- :Parameters:
-
- **name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
.. py:method:: set_polarization_type(self, value: PolarizationType) -> None
:canonical: ansys.stk.core.stkobjects.ReTransmitterModelSimple.set_polarization_type
@@ -151,4 +118,3 @@ Method detail
:obj:`~None`
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/Receiver.rst b/doc/source/api/ansys/stk/core/stkobjects/Receiver.rst
index 78f95f1544..8d6294009e 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/Receiver.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/Receiver.rst
@@ -22,8 +22,6 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.Receiver.is_refraction_type_supported`
- Get a value indicating whether the specified type can be used.
- * - :py:attr:`~ansys.stk.core.stkobjects.Receiver.set_model`
- - Do not use this method, as it is deprecated. Use ModelComponentLinking on Receiver instead. Sets the current receiver model by name.
.. tab-item:: Properties
@@ -31,14 +29,14 @@ Overview
:header-rows: 0
:widths: auto
+ * - :py:attr:`~ansys.stk.core.stkobjects.Receiver.chain_analysis_options`
+ - Get the receiver's chain analysis options.
* - :py:attr:`~ansys.stk.core.stkobjects.Receiver.graphics`
- Get the 2D Graphics properties for the receiver.
* - :py:attr:`~ansys.stk.core.stkobjects.Receiver.graphics_3d`
- Get the 3D Graphics properties for the receiver.
* - :py:attr:`~ansys.stk.core.stkobjects.Receiver.laser_environment`
- Get the object laser environment settings.
- * - :py:attr:`~ansys.stk.core.stkobjects.Receiver.model`
- - Do not use this property, as it is deprecated. Use ModelComponentLinking on Receiver instead. Gets the current receiver model.
* - :py:attr:`~ansys.stk.core.stkobjects.Receiver.model_component_linking`
- Get the link/embed controller for managing the receiver model component.
* - :py:attr:`~ansys.stk.core.stkobjects.Receiver.refraction`
@@ -49,8 +47,6 @@ Overview
- Return an array of valid choices.
* - :py:attr:`~ansys.stk.core.stkobjects.Receiver.rf_environment`
- Get the object RF environment settings.
- * - :py:attr:`~ansys.stk.core.stkobjects.Receiver.supported_models`
- - Do not use this property, as it is deprecated. Use ModelComponentLinking on Receiver instead. Gets an array of supported model names.
* - :py:attr:`~ansys.stk.core.stkobjects.Receiver.use_refraction_in_access`
- Flag controls whether refraction is applied when computing relative position in Access.
@@ -64,7 +60,7 @@ Receiver additional Gain
.. code-block:: python
# Receiver receiver: Receiver object
- recModel = receiver.model
+ recModel = receiver.model_component_linking.component
gain = recModel.pre_receive_gains_losses.add(5) # dB
gain.identifier = "Example Gain"
@@ -74,10 +70,10 @@ Modify Receiver Filter Properties
.. code-block:: python
# Receiver receiver: Receiver object
- recModel = receiver.model
+ recModel = receiver.model_component_linking.component
recModel.enable_filter = True
- recModel.set_filter("Bessel")
- recFilter = recModel.filter
+ recModel.filter_component_linking.set_component("Bessel")
+ recFilter = recModel.filter_component_linking.component
recFilter.lower_bandwidth_limit = -20
recFilter.upper_bandwidth_limit = 20
recFilter.cut_off_frequency = 10
@@ -88,7 +84,7 @@ Modify Receiver Demodulator Properties
.. code-block:: python
# Receiver receiver: Receiver object
- recModel = receiver.model
+ recModel = receiver.model_component_linking.component
recModel.select_demodulator_automatically = False
recModel.set_demodulator("16PSK")
@@ -98,8 +94,8 @@ Modify Receiver System Noise Temperature
.. code-block:: python
# Receiver receiver: Receiver object
- receiver.set_model("Complex Receiver Model")
- recModel = receiver.model
+ receiver.model_component_linking.set_component("Complex Receiver Model")
+ recModel = receiver.model_component_linking.component
recModel.system_noise_temperature.constant_noise_temperature = 280 # K
@@ -109,8 +105,8 @@ Modify Orientation of the Receiver Antenna
# Complex receivers Only
# Receiver receiver: Receiver object
- receiver.set_model("Complex Receiver Model")
- recModel = receiver.model
+ receiver.model_component_linking.set_component("Complex Receiver Model")
+ recModel = receiver.model_component_linking.component
antennaControl = recModel.antenna_control
antOrientation = antennaControl.embedded_model_orientation
antOrientation.assign_az_el(45, 85, AzElAboutBoresight.ROTATE)
@@ -124,7 +120,7 @@ Modify Receiver Polarization Properties
.. code-block:: python
# Receiver receiver: Receiver object
- recModel = receiver.model
+ recModel = receiver.model_component_linking.component
recModel.enable_polarization = True
recModel.set_polarization_type(PolarizationType.LINEAR)
polarization = recModel.polarization
@@ -137,11 +133,11 @@ Modify Receiver Embedded Antenna
.. code-block:: python
# Receiver receiver: Receiver object
- receiver.set_model("Complex Receiver Model")
- recModel = receiver.model
+ receiver.model_component_linking.set_component("Complex Receiver Model")
+ recModel = receiver.model_component_linking.component
antennaControl = recModel.antenna_control
- antennaControl.set_embedded_model("Hemispherical")
- antennaControl.embedded_model.efficiency = 85 # Percent
+ antennaControl.embedded_model_component_linking.set_component("Hemispherical")
+ antennaControl.embedded_model_component_linking.component.efficiency = 85 # Percent
Modify Receiver Model Type
@@ -149,8 +145,8 @@ Modify Receiver Model Type
.. code-block:: python
# Receiver receiver: Receiver object
- receiver.set_model("Complex Receiver Model")
- recModel = receiver.model
+ receiver.model_component_linking.set_component("Complex Receiver Model")
+ recModel = receiver.model_component_linking.component
recModel.track_frequency_automatically = False
recModel.frequency = 11.81
@@ -174,6 +170,12 @@ Import detail
Property detail
---------------
+.. py:property:: chain_analysis_options
+ :canonical: ansys.stk.core.stkobjects.Receiver.chain_analysis_options
+ :type: ChainAnalysisOptions
+
+ Get the receiver's chain analysis options.
+
.. py:property:: graphics
:canonical: ansys.stk.core.stkobjects.Receiver.graphics
:type: ReceiverGraphics
@@ -192,12 +194,6 @@ Property detail
Get the object laser environment settings.
-.. py:property:: model
- :canonical: ansys.stk.core.stkobjects.Receiver.model
- :type: IReceiverModel
-
- Do not use this property, as it is deprecated. Use ModelComponentLinking on Receiver instead. Gets the current receiver model.
-
.. py:property:: model_component_linking
:canonical: ansys.stk.core.stkobjects.Receiver.model_component_linking
:type: IComponentLinkEmbedControl
@@ -228,12 +224,6 @@ Property detail
Get the object RF environment settings.
-.. py:property:: supported_models
- :canonical: ansys.stk.core.stkobjects.Receiver.supported_models
- :type: list
-
- Do not use this property, as it is deprecated. Use ModelComponentLinking on Receiver instead. Gets an array of supported model names.
-
.. py:property:: use_refraction_in_access
:canonical: ansys.stk.core.stkobjects.Receiver.use_refraction_in_access
:type: bool
@@ -245,6 +235,7 @@ Method detail
-------------
+
.. py:method:: is_refraction_type_supported(self, model: SensorRefractionType) -> bool
:canonical: ansys.stk.core.stkobjects.Receiver.is_refraction_type_supported
@@ -267,21 +258,5 @@ Method detail
-.. py:method:: set_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.Receiver.set_model
-
- Do not use this method, as it is deprecated. Use ModelComponentLinking on Receiver instead. Sets the current receiver model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelComplex.rst b/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelComplex.rst
index e1a07bb981..7969f24816 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelComplex.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelComplex.rst
@@ -22,8 +22,6 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelComplex.set_demodulator`
- Set the current demodulator model by name.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelComplex.set_filter`
- - Do not use this method, as it is deprecated. Use FilterComponentLinking on ReceiverModelComplex instead. Sets the current filter model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelComplex.set_polarization_type`
- Set the current polarization type.
@@ -45,8 +43,6 @@ Overview
- Get or set the flag determines whether or not to enable the Filter.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelComplex.enable_polarization`
- Get or set the enable polarization option.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelComplex.filter`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelComplex instead. Gets the current filter model.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelComplex.filter_component_linking`
- Get the link/embed controller for managing the filter model component.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelComplex.frequency`
@@ -73,8 +69,6 @@ Overview
- Get or set the auto select demodulator option.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelComplex.supported_demodulators`
- Get an array of supported demodulator model names.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelComplex.supported_filters`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelComplex instead. Gets an array of supported filter model names.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelComplex.supported_rain_outage_percent_values`
- Get an array of supported rain outage percent values.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelComplex.system_noise_temperature`
@@ -133,12 +127,6 @@ Property detail
Get or set the enable polarization option.
-.. py:property:: filter
- :canonical: ansys.stk.core.stkobjects.ReceiverModelComplex.filter
- :type: IRFFilterModel
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelComplex instead. Gets the current filter model.
-
.. py:property:: filter_component_linking
:canonical: ansys.stk.core.stkobjects.ReceiverModelComplex.filter_component_linking
:type: IComponentLinkEmbedControl
@@ -217,12 +205,6 @@ Property detail
Get an array of supported demodulator model names.
-.. py:property:: supported_filters
- :canonical: ansys.stk.core.stkobjects.ReceiverModelComplex.supported_filters
- :type: list
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelComplex instead. Gets an array of supported filter model names.
-
.. py:property:: supported_rain_outage_percent_values
:canonical: ansys.stk.core.stkobjects.ReceiverModelComplex.supported_rain_outage_percent_values
:type: list
@@ -279,7 +261,6 @@ Method detail
-
.. py:method:: set_demodulator(self, name: str) -> None
@@ -296,20 +277,6 @@ Method detail
:obj:`~None`
-.. py:method:: set_filter(self, name: str) -> None
- :canonical: ansys.stk.core.stkobjects.ReceiverModelComplex.set_filter
-
- Do not use this method, as it is deprecated. Use FilterComponentLinking on ReceiverModelComplex instead. Sets the current filter model by name.
-
- :Parameters:
-
- **name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
.. py:method:: set_polarization_type(self, value: PolarizationType) -> None
:canonical: ansys.stk.core.stkobjects.ReceiverModelComplex.set_polarization_type
@@ -329,4 +296,3 @@ Method detail
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelLaser.rst b/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelLaser.rst
index f877dcfb45..e17c6415d7 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelLaser.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelLaser.rst
@@ -22,8 +22,6 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelLaser.set_demodulator`
- Set the current demodulator model by name.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelLaser.set_filter`
- - Do not use this method, as it is deprecated. Use FilterComponentLinking on ReceiverModelLaser instead. Sets the current filter model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelLaser.set_polarization_type`
- Set the current polarization type.
@@ -55,8 +53,6 @@ Overview
- Get or set the flag determines whether or not to enable the Filter.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelLaser.enable_polarization`
- Get or set the enable polarization option.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelLaser.filter`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelLaser instead. Gets the current filter model.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelLaser.filter_component_linking`
- Get the link/embed controller for managing the filter model component.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelLaser.frequency`
@@ -69,16 +65,12 @@ Overview
- Get the collection of additional pre-demod gains and losses.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelLaser.pre_receive_gains_losses`
- Get the collection of additional pre-receive gains and losses.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelLaser.propagation_loss_models`
- - Do not use this property, as it is deprecated. The laser propagation loss models can be accessed from the LaserEnvironment property.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelLaser.scale_bandwidth_automatically`
- Get or set the auto scale bandwidth option.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelLaser.select_demodulator_automatically`
- Get or set the auto select demodulator option.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelLaser.supported_demodulators`
- Get an array of supported demodulator model names.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelLaser.supported_filters`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelLaser instead. Gets an array of supported filter model names.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelLaser.track_frequency_automatically`
- Get or set the auto track frequency option.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelLaser.use_avalanche_photo_detector_model`
@@ -163,12 +155,6 @@ Property detail
Get or set the enable polarization option.
-.. py:property:: filter
- :canonical: ansys.stk.core.stkobjects.ReceiverModelLaser.filter
- :type: IRFFilterModel
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelLaser instead. Gets the current filter model.
-
.. py:property:: filter_component_linking
:canonical: ansys.stk.core.stkobjects.ReceiverModelLaser.filter_component_linking
:type: IComponentLinkEmbedControl
@@ -205,12 +191,6 @@ Property detail
Get the collection of additional pre-receive gains and losses.
-.. py:property:: propagation_loss_models
- :canonical: ansys.stk.core.stkobjects.ReceiverModelLaser.propagation_loss_models
- :type: LaserPropagationLossModels
-
- Do not use this property, as it is deprecated. The laser propagation loss models can be accessed from the LaserEnvironment property.
-
.. py:property:: scale_bandwidth_automatically
:canonical: ansys.stk.core.stkobjects.ReceiverModelLaser.scale_bandwidth_automatically
:type: bool
@@ -229,12 +209,6 @@ Property detail
Get an array of supported demodulator model names.
-.. py:property:: supported_filters
- :canonical: ansys.stk.core.stkobjects.ReceiverModelLaser.supported_filters
- :type: list
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelLaser instead. Gets an array of supported filter model names.
-
.. py:property:: track_frequency_automatically
:canonical: ansys.stk.core.stkobjects.ReceiverModelLaser.track_frequency_automatically
:type: bool
@@ -281,8 +255,6 @@ Method detail
-
-
@@ -300,20 +272,6 @@ Method detail
:obj:`~None`
-.. py:method:: set_filter(self, name: str) -> None
- :canonical: ansys.stk.core.stkobjects.ReceiverModelLaser.set_filter
-
- Do not use this method, as it is deprecated. Use FilterComponentLinking on ReceiverModelLaser instead. Sets the current filter model by name.
-
- :Parameters:
-
- **name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
.. py:method:: set_polarization_type(self, value: PolarizationType) -> None
:canonical: ansys.stk.core.stkobjects.ReceiverModelLaser.set_polarization_type
@@ -331,4 +289,3 @@ Method detail
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelMedium.rst b/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelMedium.rst
index a934c9933e..e1a5beec68 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelMedium.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelMedium.rst
@@ -22,8 +22,6 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMedium.set_demodulator`
- Set the current demodulator model by name.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMedium.set_filter`
- - Do not use this method, as it is deprecated. Use FilterComponentLinking on ReceiverModelMedium instead. Sets the current filter model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMedium.set_polarization_type`
- Set the current polarization type.
@@ -45,8 +43,6 @@ Overview
- Get or set the flag determines whether or not to enable the Filter.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMedium.enable_polarization`
- Get or set the enable polarization option.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMedium.filter`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelMedium instead. Gets the current filter model.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMedium.filter_component_linking`
- Get the link/embed controller for managing the filter model component.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMedium.frequency`
@@ -73,8 +69,6 @@ Overview
- Get or set the auto select demodulator option.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMedium.supported_demodulators`
- Get an array of supported demodulator model names.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMedium.supported_filters`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelMedium instead. Gets an array of supported filter model names.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMedium.supported_rain_outage_percent_values`
- Get an array of supported rain outage percent values.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMedium.system_noise_temperature`
@@ -133,12 +127,6 @@ Property detail
Get or set the enable polarization option.
-.. py:property:: filter
- :canonical: ansys.stk.core.stkobjects.ReceiverModelMedium.filter
- :type: IRFFilterModel
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelMedium instead. Gets the current filter model.
-
.. py:property:: filter_component_linking
:canonical: ansys.stk.core.stkobjects.ReceiverModelMedium.filter_component_linking
:type: IComponentLinkEmbedControl
@@ -217,12 +205,6 @@ Property detail
Get an array of supported demodulator model names.
-.. py:property:: supported_filters
- :canonical: ansys.stk.core.stkobjects.ReceiverModelMedium.supported_filters
- :type: list
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelMedium instead. Gets an array of supported filter model names.
-
.. py:property:: supported_rain_outage_percent_values
:canonical: ansys.stk.core.stkobjects.ReceiverModelMedium.supported_rain_outage_percent_values
:type: list
@@ -280,7 +262,6 @@ Method detail
-
.. py:method:: set_demodulator(self, name: str) -> None
@@ -297,20 +278,6 @@ Method detail
:obj:`~None`
-.. py:method:: set_filter(self, name: str) -> None
- :canonical: ansys.stk.core.stkobjects.ReceiverModelMedium.set_filter
-
- Do not use this method, as it is deprecated. Use FilterComponentLinking on ReceiverModelMedium instead. Sets the current filter model by name.
-
- :Parameters:
-
- **name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
.. py:method:: set_polarization_type(self, value: PolarizationType) -> None
:canonical: ansys.stk.core.stkobjects.ReceiverModelMedium.set_polarization_type
@@ -330,4 +297,3 @@ Method detail
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelMultibeam.rst b/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelMultibeam.rst
index 360f5b2628..1606005ea3 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelMultibeam.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelMultibeam.rst
@@ -22,8 +22,6 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMultibeam.set_demodulator`
- Set the current demodulator model by name.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMultibeam.set_filter`
- - Do not use this method, as it is deprecated. Use FilterComponentLinking on ReceiverModelMultibeam instead. Sets the current filter model by name.
.. tab-item:: Properties
@@ -41,8 +39,6 @@ Overview
- Get the current demodulator model.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMultibeam.enable_filter`
- Get or set the flag determines whether or not to enable the Filter.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMultibeam.filter`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelMultibeam instead. Gets the current filter model.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMultibeam.filter_component_linking`
- Get the link/embed controller for managing the filter model component.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMultibeam.interference`
@@ -65,8 +61,6 @@ Overview
- Get or set the auto select demodulator option.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMultibeam.supported_demodulators`
- Get an array of supported demodulator model names.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMultibeam.supported_filters`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelMultibeam instead. Gets an array of supported filter model names.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMultibeam.supported_rain_outage_percent_values`
- Get an array of supported rain outage percent values.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelMultibeam.system_noise_temperature`
@@ -119,12 +113,6 @@ Property detail
Get or set the flag determines whether or not to enable the Filter.
-.. py:property:: filter
- :canonical: ansys.stk.core.stkobjects.ReceiverModelMultibeam.filter
- :type: IRFFilterModel
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelMultibeam instead. Gets the current filter model.
-
.. py:property:: filter_component_linking
:canonical: ansys.stk.core.stkobjects.ReceiverModelMultibeam.filter_component_linking
:type: IComponentLinkEmbedControl
@@ -191,12 +179,6 @@ Property detail
Get an array of supported demodulator model names.
-.. py:property:: supported_filters
- :canonical: ansys.stk.core.stkobjects.ReceiverModelMultibeam.supported_filters
- :type: list
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelMultibeam instead. Gets an array of supported filter model names.
-
.. py:property:: supported_rain_outage_percent_values
:canonical: ansys.stk.core.stkobjects.ReceiverModelMultibeam.supported_rain_outage_percent_values
:type: list
@@ -248,7 +230,6 @@ Method detail
-
.. py:method:: set_demodulator(self, name: str) -> None
@@ -265,21 +246,6 @@ Method detail
:obj:`~None`
-.. py:method:: set_filter(self, name: str) -> None
- :canonical: ansys.stk.core.stkobjects.ReceiverModelMultibeam.set_filter
-
- Do not use this method, as it is deprecated. Use FilterComponentLinking on ReceiverModelMultibeam instead. Sets the current filter model by name.
-
- :Parameters:
-
- **name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelSimple.rst b/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelSimple.rst
index 6264c71cd4..c82e46335a 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelSimple.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ReceiverModelSimple.rst
@@ -22,8 +22,6 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelSimple.set_demodulator`
- Set the current demodulator model by name.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelSimple.set_filter`
- - Do not use this method, as it is deprecated. Use FilterComponentLinking on ReceiverModelSimple instead. Sets the current filter model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelSimple.set_polarization_type`
- Set the current polarization type.
@@ -41,8 +39,6 @@ Overview
- Get or set the flag determines whether or not to enable the Filter.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelSimple.enable_polarization`
- Get or set the enable polarization option.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelSimple.filter`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelSimple instead. Gets the current filter model.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelSimple.filter_component_linking`
- Get the link/embed controller for managing the filter model component.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelSimple.frequency`
@@ -67,8 +63,6 @@ Overview
- Get or set the auto select demodulator option.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelSimple.supported_demodulators`
- Get an array of supported demodulator model names.
- * - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelSimple.supported_filters`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelSimple instead. Gets an array of supported filter model names.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelSimple.supported_rain_outage_percent_values`
- Get an array of supported rain outage percent values.
* - :py:attr:`~ansys.stk.core.stkobjects.ReceiverModelSimple.track_frequency_automatically`
@@ -113,12 +107,6 @@ Property detail
Get or set the enable polarization option.
-.. py:property:: filter
- :canonical: ansys.stk.core.stkobjects.ReceiverModelSimple.filter
- :type: IRFFilterModel
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelSimple instead. Gets the current filter model.
-
.. py:property:: filter_component_linking
:canonical: ansys.stk.core.stkobjects.ReceiverModelSimple.filter_component_linking
:type: IComponentLinkEmbedControl
@@ -191,12 +179,6 @@ Property detail
Get an array of supported demodulator model names.
-.. py:property:: supported_filters
- :canonical: ansys.stk.core.stkobjects.ReceiverModelSimple.supported_filters
- :type: list
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on ReceiverModelSimple instead. Gets an array of supported filter model names.
-
.. py:property:: supported_rain_outage_percent_values
:canonical: ansys.stk.core.stkobjects.ReceiverModelSimple.supported_rain_outage_percent_values
:type: list
@@ -242,7 +224,6 @@ Method detail
-
.. py:method:: set_demodulator(self, name: str) -> None
@@ -259,20 +240,6 @@ Method detail
:obj:`~None`
-.. py:method:: set_filter(self, name: str) -> None
- :canonical: ansys.stk.core.stkobjects.ReceiverModelSimple.set_filter
-
- Do not use this method, as it is deprecated. Use FilterComponentLinking on ReceiverModelSimple instead. Sets the current filter model by name.
-
- :Parameters:
-
- **name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
.. py:method:: set_polarization_type(self, value: PolarizationType) -> None
:canonical: ansys.stk.core.stkobjects.ReceiverModelSimple.set_polarization_type
@@ -291,4 +258,3 @@ Method detail
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/STKObjectRoot.rst b/doc/source/api/ansys/stk/core/stkobjects/STKObjectRoot.rst
index a8f279d810..e1b9c228dd 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/STKObjectRoot.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/STKObjectRoot.rst
@@ -46,10 +46,6 @@ Overview
- Use Load method. Loads a scenario using the specified path. The method throws an exception if there is a scenario already loaded.
* - :py:attr:`~ansys.stk.core.stkobjects.STKObjectRoot.load_vdf`
- Load a vdf using the specified path. The method throws an exception if there is a scenario already loaded. If the password isn't needed, enter an empty string.
- * - :py:attr:`~ansys.stk.core.stkobjects.STKObjectRoot.load_vdf_from_sdf`
- - Do not use this method, as it is deprecated. SDF functionality has been removed and this will be removed in the next major release. Loads a vdf from SDF using the specified path. The method throws an exception if there is a scenario already loaded.
- * - :py:attr:`~ansys.stk.core.stkobjects.STKObjectRoot.load_vdf_from_sdf_with_version`
- - Do not use this method, as it is deprecated. SDF functionality has been removed and this will be removed in the next major release. Loads a vdf from SDF using the specified path. The method throws an exception if there is a scenario already loaded.
* - :py:attr:`~ansys.stk.core.stkobjects.STKObjectRoot.new_scenario`
- Create a new scenario. User must close a scenario before creating a new one; otherwise an exception will occur.
* - :py:attr:`~ansys.stk.core.stkobjects.STKObjectRoot.object_exists`
@@ -64,8 +60,6 @@ Overview
- Use SaveAs method. Saves the changes made to the scenario to a specified path and file name.
* - :py:attr:`~ansys.stk.core.stkobjects.STKObjectRoot.save_vdf_as`
- Save the changes made to the scenario to a specified path and file name as a vdf file.
- * - :py:attr:`~ansys.stk.core.stkobjects.STKObjectRoot.save_vdf_to_sdf`
- - Do not use this method, as it is deprecated. SDF functionality has been removed and this will be removed in the next major release. Saves a vdf to SDF at the specified location. The method throws an exception if the VDF creation or upload fails.
* - :py:attr:`~ansys.stk.core.stkobjects.STKObjectRoot.subscribe`
- """Return an ISTKObjectRootEventHandler that is subscribed to handle events associated with this instance of STKObjectRoot."""
@@ -313,7 +307,7 @@ Open a Viewer Data File
# STKObjectRoot root: STK Object Model Root
if os.name == "nt":
- installPath = r"C:\Program Files\AGI\STK 12"
+ installPath = r"C:\Program Files\AGI\STK_ODTK 13"
else:
installPath = os.environ["STK_INSTALL_DIR"]
vdfPath = "Data", "ExampleScenarios", "Intro_STK_Space_Systems.vdf"
@@ -594,47 +588,13 @@ Method detail
# STKObjectRoot root: STK Object Model Root
if os.name == "nt":
- installPath = r"C:\Program Files\AGI\STK 12"
+ installPath = r"C:\Program Files\AGI\STK_ODTK 13"
else:
installPath = os.environ["STK_INSTALL_DIR"]
vdfPath = "Data", "ExampleScenarios", "Intro_STK_Space_Systems.vdf"
root.load_vdf(os.path.join(installPath, *vdfPath), "")
-.. py:method:: load_vdf_from_sdf(self, vdf_path: str, password: str) -> None
- :canonical: ansys.stk.core.stkobjects.STKObjectRoot.load_vdf_from_sdf
-
- Do not use this method, as it is deprecated. SDF functionality has been removed and this will be removed in the next major release. Loads a vdf from SDF using the specified path. The method throws an exception if there is a scenario already loaded.
-
- :Parameters:
-
- **vdf_path** : :obj:`~str`
-
- **password** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-.. py:method:: load_vdf_from_sdf_with_version(self, vdf_path: str, password: str, version: float) -> None
- :canonical: ansys.stk.core.stkobjects.STKObjectRoot.load_vdf_from_sdf_with_version
-
- Do not use this method, as it is deprecated. SDF functionality has been removed and this will be removed in the next major release. Loads a vdf from SDF using the specified path. The method throws an exception if there is a scenario already loaded.
-
- :Parameters:
-
- **vdf_path** : :obj:`~str`
-
- **password** : :obj:`~str`
-
- **version** : :obj:`~float`
-
-
- :Returns:
-
- :obj:`~None`
-
.. py:method:: new_scenario(self, scenario_name: str) -> None
:canonical: ansys.stk.core.stkobjects.STKObjectRoot.new_scenario
@@ -743,20 +703,6 @@ Method detail
:obj:`~None`
-.. py:method:: save_vdf_to_sdf(self, sdf_path: str) -> None
- :canonical: ansys.stk.core.stkobjects.STKObjectRoot.save_vdf_to_sdf
-
- Do not use this method, as it is deprecated. SDF functionality has been removed and this will be removed in the next major release. Saves a vdf to SDF at the specified location. The method throws an exception if the VDF creation or upload fails.
-
- :Parameters:
-
- **sdf_path** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/Satellite.rst b/doc/source/api/ansys/stk/core/stkobjects/Satellite.rst
index 12d2424b45..8f6dbc2b8b 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/Satellite.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/Satellite.rst
@@ -43,6 +43,8 @@ Overview
- Return an array of valid choices.
* - :py:attr:`~ansys.stk.core.stkobjects.Satellite.attitude_type`
- Get the type of the satellite's attitude.
+ * - :py:attr:`~ansys.stk.core.stkobjects.Satellite.chain_analysis_options`
+ - Get the satellite's chain analysis options.
* - :py:attr:`~ansys.stk.core.stkobjects.Satellite.eclipse_bodies`
- Get the customized list of Eclipse Bodies, which are central bodies used in lighting computations.
* - :py:attr:`~ansys.stk.core.stkobjects.Satellite.export_tools`
@@ -55,8 +57,6 @@ Overview
- Get the 3D Graphics properties of the satellite.
* - :py:attr:`~ansys.stk.core.stkobjects.Satellite.ground_ellipses`
- Get the Ground Ellipses properties of the satellite.
- * - :py:attr:`~ansys.stk.core.stkobjects.Satellite.lighting_maximum_step`
- - Do not use this property, as it is deprecated. Use LightingMaxStepTerrain or LightingMaxStepCbShape as appropriate. The maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.Satellite.lighting_maximum_step_central_body_shape`
- Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is false. Uses Time Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.Satellite.lighting_maximum_step_terrain`
@@ -71,8 +71,6 @@ Overview
- Return an array of valid choices.
* - :py:attr:`~ansys.stk.core.stkobjects.Satellite.propagator_type`
- Get the type of propagator used to define the satellite's orbit.
- * - :py:attr:`~ansys.stk.core.stkobjects.Satellite.radar_clutter_map`
- - Return the radar clutter map.
* - :py:attr:`~ansys.stk.core.stkobjects.Satellite.radar_cross_section`
- Return the radar cross sectoin.
* - :py:attr:`~ansys.stk.core.stkobjects.Satellite.reference_vehicle`
@@ -93,7 +91,7 @@ Set satellite attitude external
# Satellite satellite: Satellite object
if os.name == "nt":
- installPath = r"C:\Program Files\AGI\STK 12"
+ installPath = r"C:\Program Files\AGI\STK_ODTK 13"
else:
installPath = os.environ["STK_INSTALL_DIR"]
satellite.attitude.external.load(
@@ -168,6 +166,12 @@ Property detail
Get the type of the satellite's attitude.
+.. py:property:: chain_analysis_options
+ :canonical: ansys.stk.core.stkobjects.Satellite.chain_analysis_options
+ :type: ChainAnalysisOptions
+
+ Get the satellite's chain analysis options.
+
.. py:property:: eclipse_bodies
:canonical: ansys.stk.core.stkobjects.Satellite.eclipse_bodies
:type: VehicleEclipseBodies
@@ -204,12 +208,6 @@ Property detail
Get the Ground Ellipses properties of the satellite.
-.. py:property:: lighting_maximum_step
- :canonical: ansys.stk.core.stkobjects.Satellite.lighting_maximum_step
- :type: float
-
- Do not use this property, as it is deprecated. Use LightingMaxStepTerrain or LightingMaxStepCbShape as appropriate. The maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
-
.. py:property:: lighting_maximum_step_central_body_shape
:canonical: ansys.stk.core.stkobjects.Satellite.lighting_maximum_step_central_body_shape
:type: float
@@ -252,12 +250,6 @@ Property detail
Get the type of propagator used to define the satellite's orbit.
-.. py:property:: radar_clutter_map
- :canonical: ansys.stk.core.stkobjects.Satellite.radar_clutter_map
- :type: IRadarClutterMapInheritable
-
- Return the radar clutter map.
-
.. py:property:: radar_cross_section
:canonical: ansys.stk.core.stkobjects.Satellite.radar_cross_section
:type: RadarCrossSectionInheritable
@@ -295,6 +287,7 @@ Method detail
+
.. py:method:: is_attitude_type_supported(self, attitude: VehicleAttitude) -> bool
:canonical: ansys.stk.core.stkobjects.Satellite.is_attitude_type_supported
@@ -334,9 +327,6 @@ Method detail
-
-
-
.. py:method:: set_attitude_type(self, attitude: VehicleAttitude) -> None
:canonical: ansys.stk.core.stkobjects.Satellite.set_attitude_type
diff --git a/doc/source/api/ansys/stk/core/stkobjects/SatelliteExportTools.rst b/doc/source/api/ansys/stk/core/stkobjects/SatelliteExportTools.rst
index 37e6983e89..90b0bfc952 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/SatelliteExportTools.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/SatelliteExportTools.rst
@@ -24,6 +24,8 @@ Overview
- Return an Ephemeris file of the CCSDS ephemeris type for export.
* - :py:attr:`~ansys.stk.core.stkobjects.SatelliteExportTools.get_ephemeris_ccsds_v2_export_tool`
- Return an Ephemeris file of the CCSDS v2 ephemeris type for export.
+ * - :py:attr:`~ansys.stk.core.stkobjects.SatelliteExportTools.get_ephemeris_ccsds_v3_export_tool`
+ - Return an Ephemeris file of the CCSDS v3 ephemeris type for export.
* - :py:attr:`~ansys.stk.core.stkobjects.SatelliteExportTools.get_ephemeris_code500_export_tool`
- Return an Ephemeris file of the Code500Ephem ephemeris type for export; AgAsCode500.dll must be copied to your install data's 'Modules' directory.
* - :py:attr:`~ansys.stk.core.stkobjects.SatelliteExportTools.get_ephemeris_spice_export_tool`
@@ -90,6 +92,15 @@ Method detail
:obj:`~VehicleEphemerisCCSDSv2ExportTool`
+.. py:method:: get_ephemeris_ccsds_v3_export_tool(self) -> VehicleEphemerisCCSDSv3ExportTool
+ :canonical: ansys.stk.core.stkobjects.SatelliteExportTools.get_ephemeris_ccsds_v3_export_tool
+
+ Return an Ephemeris file of the CCSDS v3 ephemeris type for export.
+
+ :Returns:
+
+ :obj:`~VehicleEphemerisCCSDSv3ExportTool`
+
.. py:method:: get_ephemeris_code500_export_tool(self) -> VehicleEphemerisCode500ExportTool
:canonical: ansys.stk.core.stkobjects.SatelliteExportTools.get_ephemeris_code500_export_tool
diff --git a/doc/source/api/ansys/stk/core/stkobjects/SatelliteGraphics3DModel.rst b/doc/source/api/ansys/stk/core/stkobjects/SatelliteGraphics3DModel.rst
index 14b0c19c59..fc38a24cd2 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/SatelliteGraphics3DModel.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/SatelliteGraphics3DModel.rst
@@ -49,7 +49,7 @@ Change the 3D Model and marker properties
model.model_data.filename = r"STKData\VO\Models\Space\dsp.glb"
orbitmarker = model.orbit_marker
if os.name == "nt":
- installPath = r"C:\Program Files\AGI\STK 12"
+ installPath = r"C:\Program Files\AGI\STK_ODTK 13"
else:
installPath = os.environ["STK_INSTALL_DIR"]
orbitmarker.set_marker_image_filename(os.path.join(installPath, "STKData", "VO", "Markers", "Satellite.ppm"))
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointModelConstantCoefficient.rst b/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointModelConstantCoefficient.rst
index cbaed1a746..e6a8bf6845 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointModelConstantCoefficient.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointModelConstantCoefficient.rst
@@ -3,7 +3,7 @@ ScatteringPointModelConstantCoefficient
.. py:class:: ansys.stk.core.stkobjects.ScatteringPointModelConstantCoefficient
- Bases: :py:class:`~ansys.stk.core.stkobjects.IScatteringPointModel`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`, :py:class:`~ansys.stk.core.stkobjects.IRadarClutterMapModelConstantCoefficient`
+ Bases: :py:class:`~ansys.stk.core.stkobjects.IScatteringPointModel`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`
Class defining a constant coefficient scattering point model.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointModelPlugin.rst b/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointModelPlugin.rst
index ff0eac0a72..ce6eb01915 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointModelPlugin.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointModelPlugin.rst
@@ -3,7 +3,7 @@ ScatteringPointModelPlugin
.. py:class:: ansys.stk.core.stkobjects.ScatteringPointModelPlugin
- Bases: :py:class:`~ansys.stk.core.stkobjects.IScatteringPointModel`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`, :py:class:`~ansys.stk.core.stkobjects.IRadarClutterMapModelPlugin`
+ Bases: :py:class:`~ansys.stk.core.stkobjects.IScatteringPointModel`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`
Class defining a plugin scattering point model.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProvider.rst b/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProvider.rst
index 5af4d64233..e8c56030d4 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProvider.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProvider.rst
@@ -3,7 +3,7 @@ ScatteringPointProvider
.. py:class:: ansys.stk.core.stkobjects.ScatteringPointProvider
- Bases: :py:class:`~ansys.stk.core.stkobjects.IScatteringPointProvider`, :py:class:`~ansys.stk.core.stkobjects.IRadarClutterGeometryModel`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`
+ Bases: :py:class:`~ansys.stk.core.stkobjects.IScatteringPointProvider`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`
Class defining a scattering point provider.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProviderPlugin.rst b/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProviderPlugin.rst
index 71e6ac28e1..645fba2a81 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProviderPlugin.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProviderPlugin.rst
@@ -3,7 +3,7 @@ ScatteringPointProviderPlugin
.. py:class:: ansys.stk.core.stkobjects.ScatteringPointProviderPlugin
- Bases: :py:class:`~ansys.stk.core.stkobjects.IScatteringPointProvider`, :py:class:`~ansys.stk.core.stkobjects.IRadarClutterGeometryModelPlugin`, :py:class:`~ansys.stk.core.stkobjects.IRadarClutterGeometryModel`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`
+ Bases: :py:class:`~ansys.stk.core.stkobjects.IScatteringPointProvider`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`
Class defining a plugin scattering point provider.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProviderRangeOverCFARCells.rst b/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProviderRangeOverCFARCells.rst
index ccbdf7f5b9..043f551351 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProviderRangeOverCFARCells.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProviderRangeOverCFARCells.rst
@@ -3,7 +3,7 @@ ScatteringPointProviderRangeOverCFARCells
.. py:class:: ansys.stk.core.stkobjects.ScatteringPointProviderRangeOverCFARCells
- Bases: :py:class:`~ansys.stk.core.stkobjects.IScatteringPointProvider`, :py:class:`~ansys.stk.core.stkobjects.IRadarClutterGeometryModel`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`
+ Bases: :py:class:`~ansys.stk.core.stkobjects.IScatteringPointProvider`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`
Class defining a range over CFAR cells scattering point provider.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProviderSinglePoint.rst b/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProviderSinglePoint.rst
index c61adb655e..52ab37359b 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProviderSinglePoint.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProviderSinglePoint.rst
@@ -3,7 +3,7 @@ ScatteringPointProviderSinglePoint
.. py:class:: ansys.stk.core.stkobjects.ScatteringPointProviderSinglePoint
- Bases: :py:class:`~ansys.stk.core.stkobjects.IScatteringPointProvider`, :py:class:`~ansys.stk.core.stkobjects.IRadarClutterGeometryModel`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`
+ Bases: :py:class:`~ansys.stk.core.stkobjects.IScatteringPointProvider`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`
Class defining a single point scattring point provider.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProviderSmoothOblateEarth.rst b/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProviderSmoothOblateEarth.rst
index a418d47e8f..b696b9b29f 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProviderSmoothOblateEarth.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ScatteringPointProviderSmoothOblateEarth.rst
@@ -3,7 +3,7 @@ ScatteringPointProviderSmoothOblateEarth
.. py:class:: ansys.stk.core.stkobjects.ScatteringPointProviderSmoothOblateEarth
- Bases: :py:class:`~ansys.stk.core.stkobjects.IScatteringPointProvider`, :py:class:`~ansys.stk.core.stkobjects.IRadarClutterGeometryModel`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`
+ Bases: :py:class:`~ansys.stk.core.stkobjects.IScatteringPointProvider`, :py:class:`~ansys.stk.core.stkobjects.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.ICloneable`
Class defining a smooth oblate earth scattering point provider.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/Scenario.rst b/doc/source/api/ansys/stk/core/stkobjects/Scenario.rst
index d0385533f4..258cb1eac1 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/Scenario.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/Scenario.rst
@@ -61,8 +61,6 @@ Overview
- Specify whether scenario needs to be saved.
* - :py:attr:`~ansys.stk.core.stkobjects.Scenario.laser_environment`
- Return the laser environment.
- * - :py:attr:`~ansys.stk.core.stkobjects.Scenario.radar_clutter_map`
- - Return the global radar clutter map.
* - :py:attr:`~ansys.stk.core.stkobjects.Scenario.radar_cross_section`
- Return the global radar cross section.
* - :py:attr:`~ansys.stk.core.stkobjects.Scenario.rf_environment`
@@ -191,12 +189,6 @@ Property detail
Return the laser environment.
-.. py:property:: radar_clutter_map
- :canonical: ansys.stk.core.stkobjects.Scenario.radar_clutter_map
- :type: IRadarClutterMap
-
- Return the global radar clutter map.
-
.. py:property:: radar_cross_section
:canonical: ansys.stk.core.stkobjects.Scenario.radar_cross_section
:type: RadarCrossSection
@@ -321,7 +313,6 @@ Method detail
-
.. py:method:: set_dirty(self) -> None
:canonical: ansys.stk.core.stkobjects.Scenario.set_dirty
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ScenarioBeforeSaveEventArguments.rst b/doc/source/api/ansys/stk/core/stkobjects/ScenarioBeforeSaveEventArguments.rst
index 876e6dc3d4..955da77cb0 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ScenarioBeforeSaveEventArguments.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ScenarioBeforeSaveEventArguments.rst
@@ -26,8 +26,6 @@ Overview
- Saving as user-specified file type and filename.
* - :py:attr:`~ansys.stk.core.stkobjects.ScenarioBeforeSaveEventArguments.save_as_vdf`
- Saving as VDF.
- * - :py:attr:`~ansys.stk.core.stkobjects.ScenarioBeforeSaveEventArguments.save_to_sdf`
- - Do not use this property, as it is deprecated. SDF functionality has been removed and this will be removed in the next major release. Saving to SDF.
@@ -66,10 +64,4 @@ Property detail
Saving as VDF.
-.. py:property:: save_to_sdf
- :canonical: ansys.stk.core.stkobjects.ScenarioBeforeSaveEventArguments.save_to_sdf
- :type: bool
-
- Do not use this property, as it is deprecated. SDF functionality has been removed and this will be removed in the next major release. Saving to SDF.
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/Sensor.rst b/doc/source/api/ansys/stk/core/stkobjects/Sensor.rst
index 107f196f53..5bf4508d53 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/Sensor.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/Sensor.rst
@@ -51,6 +51,8 @@ Overview
- Get the az-el mask.
* - :py:attr:`~ansys.stk.core.stkobjects.Sensor.az_el_mask_data`
- Get az-el mask data for the sensor.
+ * - :py:attr:`~ansys.stk.core.stkobjects.Sensor.chain_analysis_options`
+ - Get the sensor's chain analysis options.
* - :py:attr:`~ansys.stk.core.stkobjects.Sensor.common_tasks`
- Return an interface that exposes common tasks.
* - :py:attr:`~ansys.stk.core.stkobjects.Sensor.detector_pitch`
@@ -95,7 +97,7 @@ Sensor Body Mask
# Sensor sensor: Sensor object
if os.name == "nt":
- installPath = r"C:\Program Files\AGI\STK 12"
+ installPath = r"C:\Program Files\AGI\STK_ODTK 13"
else:
installPath = os.environ["STK_INSTALL_DIR"]
bmskPath = ["Data", "Resources", "stktraining", "text", "BodyMask_hga.bmsk"]
@@ -153,6 +155,12 @@ Property detail
Get az-el mask data for the sensor.
+.. py:property:: chain_analysis_options
+ :canonical: ansys.stk.core.stkobjects.Sensor.chain_analysis_options
+ :type: ChainAnalysisOptions
+
+ Get the sensor's chain analysis options.
+
.. py:property:: common_tasks
:canonical: ansys.stk.core.stkobjects.Sensor.common_tasks
:type: SensorCommonTasks
@@ -261,6 +269,7 @@ Method detail
+
.. py:method:: get_stars_in_field_of_view(self, epoch: typing.Any) -> ICelestialBodyInformationCollection
:canonical: ansys.stk.core.stkobjects.Sensor.get_stars_in_field_of_view
diff --git a/doc/source/api/ansys/stk/core/stkobjects/Ship.rst b/doc/source/api/ansys/stk/core/stkobjects/Ship.rst
index 0aa2b440e6..ee5b5273c2 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/Ship.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/Ship.rst
@@ -20,8 +20,8 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.Ship.atmosphere`
- - Do not use this property, as it is deprecated. The new RFEnvironment property can be used to configure atmospheric models.
+ * - :py:attr:`~ansys.stk.core.stkobjects.Ship.chain_analysis_options`
+ - Get the ship's chain analysis options.
* - :py:attr:`~ansys.stk.core.stkobjects.Ship.export_tools`
- Return the ShipExportTools interface.
* - :py:attr:`~ansys.stk.core.stkobjects.Ship.get_eoir_settings`
@@ -36,8 +36,6 @@ Overview
- Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is false. Uses Time Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.Ship.lighting_maximum_step_terrain`
- Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
- * - :py:attr:`~ansys.stk.core.stkobjects.Ship.radar_clutter_map`
- - Return the radar clutter map.
* - :py:attr:`~ansys.stk.core.stkobjects.Ship.radar_cross_section`
- Return the radar cross sectoin.
* - :py:attr:`~ansys.stk.core.stkobjects.Ship.rf_environment`
@@ -56,11 +54,11 @@ Import detail
Property detail
---------------
-.. py:property:: atmosphere
- :canonical: ansys.stk.core.stkobjects.Ship.atmosphere
- :type: Atmosphere
+.. py:property:: chain_analysis_options
+ :canonical: ansys.stk.core.stkobjects.Ship.chain_analysis_options
+ :type: ChainAnalysisOptions
- Do not use this property, as it is deprecated. The new RFEnvironment property can be used to configure atmospheric models.
+ Get the ship's chain analysis options.
.. py:property:: export_tools
:canonical: ansys.stk.core.stkobjects.Ship.export_tools
@@ -104,12 +102,6 @@ Property detail
Get or set the maximum step size to use when computing lighting when UseTerrainInLightingComputations is true. Uses Time Dimension.
-.. py:property:: radar_clutter_map
- :canonical: ansys.stk.core.stkobjects.Ship.radar_clutter_map
- :type: IRadarClutterMapInheritable
-
- Return the radar clutter map.
-
.. py:property:: radar_cross_section
:canonical: ansys.stk.core.stkobjects.Ship.radar_cross_section
:type: RadarCrossSectionInheritable
@@ -118,7 +110,7 @@ Property detail
.. py:property:: rf_environment
:canonical: ansys.stk.core.stkobjects.Ship.rf_environment
- :type: IPlatformRFEnvironment
+ :type: PlatformRFEnvironment
Get the RF environment.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/SpaceEnvironmentMagnitudeFieldGraphics2D.rst b/doc/source/api/ansys/stk/core/stkobjects/SpaceEnvironmentMagnitudeFieldGraphics2D.rst
index 45f0017aaf..1bca10a927 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/SpaceEnvironmentMagnitudeFieldGraphics2D.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/SpaceEnvironmentMagnitudeFieldGraphics2D.rst
@@ -35,12 +35,8 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.SpaceEnvironmentMagnitudeFieldGraphics2D.color_mode`
- Mode by which color is assigned.
- * - :py:attr:`~ansys.stk.core.stkobjects.SpaceEnvironmentMagnitudeFieldGraphics2D.color_ramp_start`
- - Do not use this property, as it is deprecated. Magnetic field start color.
* - :py:attr:`~ansys.stk.core.stkobjects.SpaceEnvironmentMagnitudeFieldGraphics2D.color_ramp_start_color`
- Magnetic field start color.
- * - :py:attr:`~ansys.stk.core.stkobjects.SpaceEnvironmentMagnitudeFieldGraphics2D.color_ramp_stop`
- - Do not use this property, as it is deprecated. Magnetic field stop color.
* - :py:attr:`~ansys.stk.core.stkobjects.SpaceEnvironmentMagnitudeFieldGraphics2D.color_ramp_stop_color`
- Magnetic field stop color.
* - :py:attr:`~ansys.stk.core.stkobjects.SpaceEnvironmentMagnitudeFieldGraphics2D.color_scale`
@@ -91,24 +87,12 @@ Property detail
Mode by which color is assigned.
-.. py:property:: color_ramp_start
- :canonical: ansys.stk.core.stkobjects.SpaceEnvironmentMagnitudeFieldGraphics2D.color_ramp_start
- :type: Color
-
- Do not use this property, as it is deprecated. Magnetic field start color.
-
.. py:property:: color_ramp_start_color
:canonical: ansys.stk.core.stkobjects.SpaceEnvironmentMagnitudeFieldGraphics2D.color_ramp_start_color
:type: Color
Magnetic field start color.
-.. py:property:: color_ramp_stop
- :canonical: ansys.stk.core.stkobjects.SpaceEnvironmentMagnitudeFieldGraphics2D.color_ramp_stop
- :type: Color
-
- Do not use this property, as it is deprecated. Magnetic field stop color.
-
.. py:property:: color_ramp_stop_color
:canonical: ansys.stk.core.stkobjects.SpaceEnvironmentMagnitudeFieldGraphics2D.color_ramp_stop_color
:type: Color
@@ -211,10 +195,6 @@ Method detail
-
-
-
-
.. py:method:: compute_b_over_beq(self, time: typing.Any, lat: float, lon: float, alt: float) -> float
:canonical: ansys.stk.core.stkobjects.SpaceEnvironmentMagnitudeFieldGraphics2D.compute_b_over_beq
diff --git a/doc/source/api/ansys/stk/core/stkobjects/Star.rst b/doc/source/api/ansys/stk/core/stkobjects/Star.rst
index b3643e239c..69e90ca1e1 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/Star.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/Star.rst
@@ -22,6 +22,8 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.Star.access_constraints`
- Get the constraints imposed on the star.
+ * - :py:attr:`~ansys.stk.core.stkobjects.Star.chain_analysis_options`
+ - Get the star's chain analysis options.
* - :py:attr:`~ansys.stk.core.stkobjects.Star.epoch`
- Epoch of the star position information as a Julian epoch (yyyy.yy). The Julian epoch is related to the Julian date by the expression JD = 2451545.0 + (yyyy.yy - 2000.0) x 365.25, where 2451545.0 (TT) represents the standard J2000 epoch.
* - :py:attr:`~ansys.stk.core.stkobjects.Star.graphics`
@@ -38,10 +40,10 @@ Overview
- Annual parallax: motion of a star due to changes in the Earth's position relative to the solar system barycenter. Uses Angle Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.Star.proper_motion_declination`
- Motion of the star relative to the solar system barycenter expressed in arc seconds per year. Here, declination refers to motion from the inertial equator measured towards the inertial positive Z-axis. Uses AngleRate Dimension.
- * - :py:attr:`~ansys.stk.core.stkobjects.Star.proper_motion_radial_velocity`
- - Property motion radial velocity. Uses Distance dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.Star.proper_motion_right_ascension`
- Motion of star relative to solar system barycenter expressed in arc seconds per year. Here, right ascension refers to motion in equatorial plane measured in a right-handed sense about the inertial Z-axis from inertial X-axis. Uses AngleRate Dimension.
+ * - :py:attr:`~ansys.stk.core.stkobjects.Star.radial_velocity`
+ - The star's radial velocity relative to the solar system barycenter. Uses Rate dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.Star.reference_frame`
- Return a reference frame.
@@ -64,6 +66,12 @@ Property detail
Get the constraints imposed on the star.
+.. py:property:: chain_analysis_options
+ :canonical: ansys.stk.core.stkobjects.Star.chain_analysis_options
+ :type: ChainAnalysisOptions
+
+ Get the star's chain analysis options.
+
.. py:property:: epoch
:canonical: ansys.stk.core.stkobjects.Star.epoch
:type: str
@@ -112,18 +120,18 @@ Property detail
Motion of the star relative to the solar system barycenter expressed in arc seconds per year. Here, declination refers to motion from the inertial equator measured towards the inertial positive Z-axis. Uses AngleRate Dimension.
-.. py:property:: proper_motion_radial_velocity
- :canonical: ansys.stk.core.stkobjects.Star.proper_motion_radial_velocity
- :type: float
-
- Property motion radial velocity. Uses Distance dimension.
-
.. py:property:: proper_motion_right_ascension
:canonical: ansys.stk.core.stkobjects.Star.proper_motion_right_ascension
:type: float
Motion of star relative to solar system barycenter expressed in arc seconds per year. Here, right ascension refers to motion in equatorial plane measured in a right-handed sense about the inertial Z-axis from inertial X-axis. Uses AngleRate Dimension.
+.. py:property:: radial_velocity
+ :canonical: ansys.stk.core.stkobjects.Star.radial_velocity
+ :type: float
+
+ The star's radial velocity relative to the solar system barycenter. Uses Rate dimension.
+
.. py:property:: reference_frame
:canonical: ansys.stk.core.stkobjects.Star.reference_frame
:type: StarReferenceFrame
diff --git a/doc/source/api/ansys/stk/core/stkobjects/Target.rst b/doc/source/api/ansys/stk/core/stkobjects/Target.rst
index 7de238ec0d..0b135edc48 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/Target.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/Target.rst
@@ -39,8 +39,8 @@ Overview
- Get the constraints imposed on the target.
* - :py:attr:`~ansys.stk.core.stkobjects.Target.altitude_reference`
- Get or set the altitude reference of the object.
- * - :py:attr:`~ansys.stk.core.stkobjects.Target.atmosphere`
- - Do not use this property, as it is deprecated. The new RFEnvironment property can be used to configure atmospheric models.
+ * - :py:attr:`~ansys.stk.core.stkobjects.Target.chain_analysis_options`
+ - Get the target's chain analysis options.
* - :py:attr:`~ansys.stk.core.stkobjects.Target.graphics`
- Get the 2D Graphics properties of the target.
* - :py:attr:`~ansys.stk.core.stkobjects.Target.graphics_3d`
@@ -59,8 +59,6 @@ Overview
- Get or set the maximum range to use when computing the az el mask using terrain data. Zero indicates to use algorithm default. Only applies when GetAzElMask returns eTerrainData (cannot be set if eMaskFile). Uses Distance Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.Target.position`
- Get the position of the target.
- * - :py:attr:`~ansys.stk.core.stkobjects.Target.radar_clutter_map`
- - Return the radar clutter map.
* - :py:attr:`~ansys.stk.core.stkobjects.Target.radar_cross_section`
- Return the radar cross sectoin.
* - :py:attr:`~ansys.stk.core.stkobjects.Target.rf_environment`
@@ -101,11 +99,11 @@ Property detail
Get or set the altitude reference of the object.
-.. py:property:: atmosphere
- :canonical: ansys.stk.core.stkobjects.Target.atmosphere
- :type: Atmosphere
+.. py:property:: chain_analysis_options
+ :canonical: ansys.stk.core.stkobjects.Target.chain_analysis_options
+ :type: ChainAnalysisOptions
- Do not use this property, as it is deprecated. The new RFEnvironment property can be used to configure atmospheric models.
+ Get the target's chain analysis options.
.. py:property:: graphics
:canonical: ansys.stk.core.stkobjects.Target.graphics
@@ -161,12 +159,6 @@ Property detail
Get the position of the target.
-.. py:property:: radar_clutter_map
- :canonical: ansys.stk.core.stkobjects.Target.radar_clutter_map
- :type: IRadarClutterMapInheritable
-
- Return the radar clutter map.
-
.. py:property:: radar_cross_section
:canonical: ansys.stk.core.stkobjects.Target.radar_cross_section
:type: RadarCrossSectionInheritable
@@ -175,7 +167,7 @@ Property detail
.. py:property:: rf_environment
:canonical: ansys.stk.core.stkobjects.Target.rf_environment
- :type: IPlatformRFEnvironment
+ :type: PlatformRFEnvironment
Get the RF environment.
@@ -250,7 +242,6 @@ Method detail
-
.. py:method:: reset_az_el_mask(self) -> None
:canonical: ansys.stk.core.stkobjects.Target.reset_az_el_mask
diff --git a/doc/source/api/ansys/stk/core/stkobjects/ThirdBodyGravitySourceType.rst b/doc/source/api/ansys/stk/core/stkobjects/ThirdBodyGravitySourceType.rst
index 492f503456..478991d79f 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/ThirdBodyGravitySourceType.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/ThirdBodyGravitySourceType.rst
@@ -22,9 +22,6 @@ Overview
* - :py:attr:`~CENTRAL_BODY_FILE`
- Central body file (all bodies): gravitational value from editable central body file shipped with STK.
- * - :py:attr:`~HPOP_HISTORICAL`
- - HPOP historical (Sun and Moon only): hard-coded, uneditable value used in prior versions of HPOP.
-
* - :py:attr:`~JPL_DEVELOPMENTAL_EPHEMERIS`
- JPL DE (Sun, Moon and planets): DE 405 ephemerides, covering a time span from 1960 to 2060.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/Transmitter.rst b/doc/source/api/ansys/stk/core/stkobjects/Transmitter.rst
index dc807357dc..433a3a033e 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/Transmitter.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/Transmitter.rst
@@ -22,8 +22,6 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.Transmitter.is_refraction_type_supported`
- Get a value indicating whether the specified type can be used.
- * - :py:attr:`~ansys.stk.core.stkobjects.Transmitter.set_model`
- - Do not use this method, as it is deprecated. Use ModelComponentLinking on Transmitter instead. Sets the current transmitter model by name.
.. tab-item:: Properties
@@ -31,14 +29,14 @@ Overview
:header-rows: 0
:widths: auto
+ * - :py:attr:`~ansys.stk.core.stkobjects.Transmitter.chain_analysis_options`
+ - Get the transmitter's chain analysis options.
* - :py:attr:`~ansys.stk.core.stkobjects.Transmitter.graphics`
- Get the 2D Graphics properties for the transmitter.
* - :py:attr:`~ansys.stk.core.stkobjects.Transmitter.graphics_3d`
- Get the 3D Graphics properties for the transmitter.
* - :py:attr:`~ansys.stk.core.stkobjects.Transmitter.laser_environment`
- Get the object laser environment settings.
- * - :py:attr:`~ansys.stk.core.stkobjects.Transmitter.model`
- - Do not use this property, as it is deprecated. Use ModelComponentLinking on Transmitter instead. Gets the current transmitter model.
* - :py:attr:`~ansys.stk.core.stkobjects.Transmitter.model_component_linking`
- Get the link/embed controller for managing the transmitter model component.
* - :py:attr:`~ansys.stk.core.stkobjects.Transmitter.refraction`
@@ -49,8 +47,6 @@ Overview
- Return an array of valid choices.
* - :py:attr:`~ansys.stk.core.stkobjects.Transmitter.rf_environment`
- Get the object RF environment settings.
- * - :py:attr:`~ansys.stk.core.stkobjects.Transmitter.supported_models`
- - Do not use this property, as it is deprecated. Use ModelComponentLinking on Transmitter instead. Gets an array of supported model names.
* - :py:attr:`~ansys.stk.core.stkobjects.Transmitter.use_refraction_in_access`
- Flag controls whether refraction is applied when computing relative position in Access.
@@ -64,7 +60,7 @@ Transmitter additional Gain
.. code-block:: python
# Transmitter transmitter: Transmitter object
- txModel = transmitter.model
+ txModel = transmitter.model_component_linking.component
gain = txModel.post_transmit_gains_losses.add(-5) # dB
gain.identifier = "Example Loss"
@@ -74,10 +70,10 @@ Modify a Transmitter Filter
.. code-block:: python
# Transmitter transmitter: Transmitter object
- txModel = transmitter.model
+ txModel = transmitter.model_component_linking.component
txModel.enable_filter = True
- txModel.set_filter("Butterworth")
- recFilter = txModel.filter
+ txModel.filter_component_linking.set_component("Butterworth")
+ recFilter = txModel.filter_component_linking.component
recFilter.lower_bandwidth_limit = -20
recFilter.upper_bandwidth_limit = 20
recFilter.cut_off_frequency = 10
@@ -88,7 +84,7 @@ Modify a Transmitter's Modulator Properties
.. code-block:: python
# Transmitter transmitter: Transmitter object
- txModel = transmitter.model
+ txModel = transmitter.model_component_linking.component
txModel.set_modulator("BPSK")
txModel.modulator.scale_bandwidth_automatically = True
@@ -98,8 +94,8 @@ Modify a Transmitter's Orientation and Position
.. code-block:: python
# Transmitter transmitter: Transmitter object
- transmitter.set_model("Complex Transmitter Model")
- txModel = transmitter.model
+ transmitter.model_component_linking.set_component("Complex Transmitter Model")
+ txModel = transmitter.model_component_linking.component
antennaControl = txModel.antenna_control
antOrientation = antennaControl.embedded_model_orientation
antOrientation.assign_az_el(0, 90, 1) # 1 represents Rotate About Boresight
@@ -113,8 +109,8 @@ Modify a Transmitter's Polarization Properties
.. code-block:: python
# Transmitter transmitter: Transmitter object
- transmitter.set_model("Complex Transmitter Model")
- txModel = transmitter.model
+ transmitter.model_component_linking.set_component("Complex Transmitter Model")
+ txModel = transmitter.model_component_linking.component
txModel.enable_polarization = True
txModel.set_polarization_type(PolarizationType.LINEAR)
polarization = txModel.polarization
@@ -127,11 +123,11 @@ Modify a Transmitter's Embedded Antenna
.. code-block:: python
# Transmitter transmitter: Transmitter object
- transmitter.set_model("Complex Transmitter Model")
- txModel = transmitter.model
+ transmitter.model_component_linking.set_component("Complex Transmitter Model")
+ txModel = transmitter.model_component_linking.component
antennaControl = txModel.antenna_control
- antennaControl.set_embedded_model("Isotropic")
- antennaControl.embedded_model.efficiency = 85 # Percent
+ antennaControl.embedded_model_component_linking.set_component("Isotropic")
+ antennaControl.embedded_model_component_linking.component.efficiency = 85 # Percent
Modify a Transmitter's Model Type
@@ -139,8 +135,8 @@ Modify a Transmitter's Model Type
.. code-block:: python
# Transmitter transmitter: Transmitter object
- transmitter.set_model("Complex Transmitter Model")
- txModel = transmitter.model
+ transmitter.model_component_linking.set_component("Complex Transmitter Model")
+ txModel = transmitter.model_component_linking.component
txModel.frequency = 14 # GHz
txModel.power = 25 # dBW
txModel.data_rate = 15 # Mb/sec
@@ -165,6 +161,12 @@ Import detail
Property detail
---------------
+.. py:property:: chain_analysis_options
+ :canonical: ansys.stk.core.stkobjects.Transmitter.chain_analysis_options
+ :type: ChainAnalysisOptions
+
+ Get the transmitter's chain analysis options.
+
.. py:property:: graphics
:canonical: ansys.stk.core.stkobjects.Transmitter.graphics
:type: TransmitterGraphics
@@ -183,12 +185,6 @@ Property detail
Get the object laser environment settings.
-.. py:property:: model
- :canonical: ansys.stk.core.stkobjects.Transmitter.model
- :type: ITransmitterModel
-
- Do not use this property, as it is deprecated. Use ModelComponentLinking on Transmitter instead. Gets the current transmitter model.
-
.. py:property:: model_component_linking
:canonical: ansys.stk.core.stkobjects.Transmitter.model_component_linking
:type: IComponentLinkEmbedControl
@@ -219,12 +215,6 @@ Property detail
Get the object RF environment settings.
-.. py:property:: supported_models
- :canonical: ansys.stk.core.stkobjects.Transmitter.supported_models
- :type: list
-
- Do not use this property, as it is deprecated. Use ModelComponentLinking on Transmitter instead. Gets an array of supported model names.
-
.. py:property:: use_refraction_in_access
:canonical: ansys.stk.core.stkobjects.Transmitter.use_refraction_in_access
:type: bool
@@ -236,6 +226,7 @@ Method detail
-------------
+
.. py:method:: is_refraction_type_supported(self, model: SensorRefractionType) -> bool
:canonical: ansys.stk.core.stkobjects.Transmitter.is_refraction_type_supported
@@ -258,21 +249,5 @@ Method detail
-.. py:method:: set_model(self, model_name: str) -> None
- :canonical: ansys.stk.core.stkobjects.Transmitter.set_model
-
- Do not use this method, as it is deprecated. Use ModelComponentLinking on Transmitter instead. Sets the current transmitter model by name.
-
- :Parameters:
-
- **model_name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelComplex.rst b/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelComplex.rst
index 40552126ba..91533aba90 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelComplex.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelComplex.rst
@@ -20,8 +20,6 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelComplex.set_filter`
- - Do not use this method, as it is deprecated. Use FilterComponentLinking on TransmitterModelComplex instead. Sets the current filter model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelComplex.set_modulator`
- Set the current modulator model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelComplex.set_polarization_type`
@@ -41,8 +39,6 @@ Overview
- Get or set the flag determines whether or not to enable the Filter.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelComplex.enable_polarization`
- Get or set the enable polarization option.
- * - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelComplex.filter`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelComplex instead. Gets the current filter model.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelComplex.filter_component_linking`
- Get the link/embed controller for managing the filter model component.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelComplex.frequency`
@@ -55,8 +51,6 @@ Overview
- Get the collection of additional post transmit gains and losses.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelComplex.power`
- Get or set the power.
- * - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelComplex.supported_filters`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelComplex instead. Gets an array of supported filter model names.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelComplex.supported_modulators`
- Get an array of supported modulator model names.
@@ -97,12 +91,6 @@ Property detail
Get or set the enable polarization option.
-.. py:property:: filter
- :canonical: ansys.stk.core.stkobjects.TransmitterModelComplex.filter
- :type: IRFFilterModel
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelComplex instead. Gets the current filter model.
-
.. py:property:: filter_component_linking
:canonical: ansys.stk.core.stkobjects.TransmitterModelComplex.filter_component_linking
:type: IComponentLinkEmbedControl
@@ -139,12 +127,6 @@ Property detail
Get or set the power.
-.. py:property:: supported_filters
- :canonical: ansys.stk.core.stkobjects.TransmitterModelComplex.supported_filters
- :type: list
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelComplex instead. Gets an array of supported filter model names.
-
.. py:property:: supported_modulators
:canonical: ansys.stk.core.stkobjects.TransmitterModelComplex.supported_modulators
:type: list
@@ -170,21 +152,6 @@ Method detail
-
-.. py:method:: set_filter(self, name: str) -> None
- :canonical: ansys.stk.core.stkobjects.TransmitterModelComplex.set_filter
-
- Do not use this method, as it is deprecated. Use FilterComponentLinking on TransmitterModelComplex instead. Sets the current filter model by name.
-
- :Parameters:
-
- **name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
.. py:method:: set_modulator(self, name: str) -> None
:canonical: ansys.stk.core.stkobjects.TransmitterModelComplex.set_modulator
@@ -214,4 +181,3 @@ Method detail
:obj:`~None`
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelLaser.rst b/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelLaser.rst
index c74f418368..56b55176f3 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelLaser.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelLaser.rst
@@ -20,8 +20,6 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelLaser.set_filter`
- - Do not use this method, as it is deprecated. Use FilterComponentLinking on TransmitterModelLaser instead. Sets the current filter model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelLaser.set_modulator`
- Set the current modulator model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelLaser.set_polarization_type`
@@ -41,8 +39,6 @@ Overview
- Get or set the flag determines whether or not to enable the Filter.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelLaser.enable_polarization`
- Get or set the enable polarization option.
- * - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelLaser.filter`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelLaser instead. Gets the current filter model.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelLaser.filter_component_linking`
- Get the link/embed controller for managing the filter model component.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelLaser.frequency`
@@ -55,8 +51,6 @@ Overview
- Get the collection of additional post transmit gains and losses.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelLaser.power`
- Get or set the power.
- * - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelLaser.supported_filters`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelLaser instead. Gets an array of supported filter model names.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelLaser.supported_modulators`
- Get an array of supported modulator model names.
@@ -97,12 +91,6 @@ Property detail
Get or set the enable polarization option.
-.. py:property:: filter
- :canonical: ansys.stk.core.stkobjects.TransmitterModelLaser.filter
- :type: IRFFilterModel
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelLaser instead. Gets the current filter model.
-
.. py:property:: filter_component_linking
:canonical: ansys.stk.core.stkobjects.TransmitterModelLaser.filter_component_linking
:type: IComponentLinkEmbedControl
@@ -139,12 +127,6 @@ Property detail
Get or set the power.
-.. py:property:: supported_filters
- :canonical: ansys.stk.core.stkobjects.TransmitterModelLaser.supported_filters
- :type: list
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelLaser instead. Gets an array of supported filter model names.
-
.. py:property:: supported_modulators
:canonical: ansys.stk.core.stkobjects.TransmitterModelLaser.supported_modulators
:type: list
@@ -170,21 +152,6 @@ Method detail
-
-.. py:method:: set_filter(self, name: str) -> None
- :canonical: ansys.stk.core.stkobjects.TransmitterModelLaser.set_filter
-
- Do not use this method, as it is deprecated. Use FilterComponentLinking on TransmitterModelLaser instead. Sets the current filter model by name.
-
- :Parameters:
-
- **name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
.. py:method:: set_modulator(self, name: str) -> None
:canonical: ansys.stk.core.stkobjects.TransmitterModelLaser.set_modulator
@@ -214,4 +181,3 @@ Method detail
:obj:`~None`
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelMedium.rst b/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelMedium.rst
index bcc03a3db9..8669e5646b 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelMedium.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelMedium.rst
@@ -20,8 +20,6 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMedium.set_filter`
- - Do not use this method, as it is deprecated. Use FilterComponentLinking on TransmitterModelMedium instead. Sets the current filter model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMedium.set_modulator`
- Set the current modulator model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMedium.set_polarization_type`
@@ -41,8 +39,6 @@ Overview
- Get or set the flag determines whether or not to enable the Filter.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMedium.enable_polarization`
- Get or set the enable polarization option.
- * - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMedium.filter`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelMedium instead. Gets the current filter model.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMedium.filter_component_linking`
- Get the link/embed controller for managing the filter model component.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMedium.frequency`
@@ -55,8 +51,6 @@ Overview
- Get the collection of additional post transmit gains and losses.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMedium.power`
- Get or set the power.
- * - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMedium.supported_filters`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelMedium instead. Gets an array of supported filter model names.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMedium.supported_modulators`
- Get an array of supported modulator model names.
@@ -97,12 +91,6 @@ Property detail
Get or set the enable polarization option.
-.. py:property:: filter
- :canonical: ansys.stk.core.stkobjects.TransmitterModelMedium.filter
- :type: IRFFilterModel
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelMedium instead. Gets the current filter model.
-
.. py:property:: filter_component_linking
:canonical: ansys.stk.core.stkobjects.TransmitterModelMedium.filter_component_linking
:type: IComponentLinkEmbedControl
@@ -139,12 +127,6 @@ Property detail
Get or set the power.
-.. py:property:: supported_filters
- :canonical: ansys.stk.core.stkobjects.TransmitterModelMedium.supported_filters
- :type: list
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelMedium instead. Gets an array of supported filter model names.
-
.. py:property:: supported_modulators
:canonical: ansys.stk.core.stkobjects.TransmitterModelMedium.supported_modulators
:type: list
@@ -171,21 +153,6 @@ Method detail
-
-.. py:method:: set_filter(self, name: str) -> None
- :canonical: ansys.stk.core.stkobjects.TransmitterModelMedium.set_filter
-
- Do not use this method, as it is deprecated. Use FilterComponentLinking on TransmitterModelMedium instead. Sets the current filter model by name.
-
- :Parameters:
-
- **name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
.. py:method:: set_modulator(self, name: str) -> None
:canonical: ansys.stk.core.stkobjects.TransmitterModelMedium.set_modulator
@@ -215,4 +182,3 @@ Method detail
:obj:`~None`
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelMultibeam.rst b/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelMultibeam.rst
index 69129f3de1..1f5156854f 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelMultibeam.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelMultibeam.rst
@@ -20,8 +20,6 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMultibeam.set_filter`
- - Do not use this method, as it is deprecated. Use FilterComponentLinking on TransmitterModelMultibeam instead. Sets the current filter model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMultibeam.set_modulator`
- Set the current modulator model by name.
@@ -37,16 +35,12 @@ Overview
- Get or set the data rate.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMultibeam.enable_filter`
- Get or set the flag determines whether or not to enable the Filter.
- * - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMultibeam.filter`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelMultibeam instead. Gets the current filter model.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMultibeam.filter_component_linking`
- Get the link/embed controller for managing the filter model component.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMultibeam.modulator`
- Get the current modulator model.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMultibeam.post_transmit_gains_losses`
- Get the collection of additional post transmit gains and losses.
- * - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMultibeam.supported_filters`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelMultibeam instead. Gets an array of supported filter model names.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelMultibeam.supported_modulators`
- Get an array of supported modulator model names.
@@ -81,12 +75,6 @@ Property detail
Get or set the flag determines whether or not to enable the Filter.
-.. py:property:: filter
- :canonical: ansys.stk.core.stkobjects.TransmitterModelMultibeam.filter
- :type: IRFFilterModel
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelMultibeam instead. Gets the current filter model.
-
.. py:property:: filter_component_linking
:canonical: ansys.stk.core.stkobjects.TransmitterModelMultibeam.filter_component_linking
:type: IComponentLinkEmbedControl
@@ -105,12 +93,6 @@ Property detail
Get the collection of additional post transmit gains and losses.
-.. py:property:: supported_filters
- :canonical: ansys.stk.core.stkobjects.TransmitterModelMultibeam.supported_filters
- :type: list
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelMultibeam instead. Gets an array of supported filter model names.
-
.. py:property:: supported_modulators
:canonical: ansys.stk.core.stkobjects.TransmitterModelMultibeam.supported_modulators
:type: list
@@ -129,21 +111,6 @@ Method detail
-
-.. py:method:: set_filter(self, name: str) -> None
- :canonical: ansys.stk.core.stkobjects.TransmitterModelMultibeam.set_filter
-
- Do not use this method, as it is deprecated. Use FilterComponentLinking on TransmitterModelMultibeam instead. Sets the current filter model by name.
-
- :Parameters:
-
- **name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
.. py:method:: set_modulator(self, name: str) -> None
:canonical: ansys.stk.core.stkobjects.TransmitterModelMultibeam.set_modulator
@@ -159,4 +126,3 @@ Method detail
:obj:`~None`
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelSimple.rst b/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelSimple.rst
index 75e3f2cc18..a163d486a9 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelSimple.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/TransmitterModelSimple.rst
@@ -20,8 +20,6 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelSimple.set_filter`
- - Do not use this method, as it is deprecated. Use FilterComponentLinking on TransmitterModelSimple instead. Sets the current filter model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelSimple.set_modulator`
- Set the current modulator model by name.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelSimple.set_polarization_type`
@@ -41,8 +39,6 @@ Overview
- Get or set the flag determines whether or not to enable the Filter.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelSimple.enable_polarization`
- Get or set the enable polarization option.
- * - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelSimple.filter`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelSimple instead. Gets the current filter model.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelSimple.filter_component_linking`
- Get the link/embed controller for managing the filter model component.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelSimple.frequency`
@@ -53,8 +49,6 @@ Overview
- Get the polarization.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelSimple.post_transmit_gains_losses`
- Get the collection of additional post transmit gains and losses.
- * - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelSimple.supported_filters`
- - Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelSimple instead. Gets an array of supported filter model names.
* - :py:attr:`~ansys.stk.core.stkobjects.TransmitterModelSimple.supported_modulators`
- Get an array of supported modulator model names.
@@ -95,12 +89,6 @@ Property detail
Get or set the enable polarization option.
-.. py:property:: filter
- :canonical: ansys.stk.core.stkobjects.TransmitterModelSimple.filter
- :type: IRFFilterModel
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelSimple instead. Gets the current filter model.
-
.. py:property:: filter_component_linking
:canonical: ansys.stk.core.stkobjects.TransmitterModelSimple.filter_component_linking
:type: IComponentLinkEmbedControl
@@ -131,12 +119,6 @@ Property detail
Get the collection of additional post transmit gains and losses.
-.. py:property:: supported_filters
- :canonical: ansys.stk.core.stkobjects.TransmitterModelSimple.supported_filters
- :type: list
-
- Do not use this property, as it is deprecated. Use FilterComponentLinking on TransmitterModelSimple instead. Gets an array of supported filter model names.
-
.. py:property:: supported_modulators
:canonical: ansys.stk.core.stkobjects.TransmitterModelSimple.supported_modulators
:type: list
@@ -161,21 +143,6 @@ Method detail
-
-.. py:method:: set_filter(self, name: str) -> None
- :canonical: ansys.stk.core.stkobjects.TransmitterModelSimple.set_filter
-
- Do not use this method, as it is deprecated. Use FilterComponentLinking on TransmitterModelSimple instead. Sets the current filter model by name.
-
- :Parameters:
-
- **name** : :obj:`~str`
-
-
- :Returns:
-
- :obj:`~None`
-
.. py:method:: set_modulator(self, name: str) -> None
:canonical: ansys.stk.core.stkobjects.TransmitterModelSimple.set_modulator
@@ -205,4 +172,3 @@ Method detail
:obj:`~None`
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/TroposphericScintillationFadingLossModelP618Version12.rst b/doc/source/api/ansys/stk/core/stkobjects/TroposphericScintillationFadingLossModelP618Version12.rst
index b78f55330a..44d0d26adf 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/TroposphericScintillationFadingLossModelP618Version12.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/TroposphericScintillationFadingLossModelP618Version12.rst
@@ -22,12 +22,8 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.TroposphericScintillationFadingLossModelP618Version12.average_time_choice`
- Get or set the TropoScintillation average fade time choice.
- * - :py:attr:`~ansys.stk.core.stkobjects.TroposphericScintillationFadingLossModelP618Version12.compute_deep_fade`
- - Do not use this property, as it is deprecated. The ComputeDeepFade property should not be used.
* - :py:attr:`~ansys.stk.core.stkobjects.TroposphericScintillationFadingLossModelP618Version12.fade_exceeded`
- Get or set the fade exceeded percent.
- * - :py:attr:`~ansys.stk.core.stkobjects.TroposphericScintillationFadingLossModelP618Version12.fade_outage`
- - Do not use this property, as it is deprecated. Use the FadeExceeded property.
* - :py:attr:`~ansys.stk.core.stkobjects.TroposphericScintillationFadingLossModelP618Version12.percent_time_refractivity_gradient`
- Get or set the percentage of time that the refractivity gradient is less than -100 N units / km.
* - :py:attr:`~ansys.stk.core.stkobjects.TroposphericScintillationFadingLossModelP618Version12.surface_temperature`
@@ -52,24 +48,12 @@ Property detail
Get or set the TropoScintillation average fade time choice.
-.. py:property:: compute_deep_fade
- :canonical: ansys.stk.core.stkobjects.TroposphericScintillationFadingLossModelP618Version12.compute_deep_fade
- :type: bool
-
- Do not use this property, as it is deprecated. The ComputeDeepFade property should not be used.
-
.. py:property:: fade_exceeded
:canonical: ansys.stk.core.stkobjects.TroposphericScintillationFadingLossModelP618Version12.fade_exceeded
:type: float
Get or set the fade exceeded percent.
-.. py:property:: fade_outage
- :canonical: ansys.stk.core.stkobjects.TroposphericScintillationFadingLossModelP618Version12.fade_outage
- :type: float
-
- Do not use this property, as it is deprecated. Use the FadeExceeded property.
-
.. py:property:: percent_time_refractivity_gradient
:canonical: ansys.stk.core.stkobjects.TroposphericScintillationFadingLossModelP618Version12.percent_time_refractivity_gradient
:type: float
diff --git a/doc/source/api/ansys/stk/core/stkobjects/VehicleEphemerisCCSDSv3ExportTool.rst b/doc/source/api/ansys/stk/core/stkobjects/VehicleEphemerisCCSDSv3ExportTool.rst
new file mode 100644
index 0000000000..0c86cd5ca8
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/VehicleEphemerisCCSDSv3ExportTool.rst
@@ -0,0 +1,247 @@
+VehicleEphemerisCCSDSv3ExportTool
+=================================
+
+.. py:class:: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool
+
+ The Ephemeris/Attitude Export Tool for CCSDSv3 Ephemeris type.
+
+.. py:currentmodule:: VehicleEphemerisCCSDSv3ExportTool
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Methods
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.export`
+ - Export the ephemeris file.
+
+ .. tab-item:: Properties
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.central_body_name`
+ - Get or set the central body of the satellite.
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.classification`
+ - A string that specifies the classification/caveats of the data file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.date_format`
+ - Get or set the desired date format.
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.ephemeris_format`
+ - Get or set the desired format to be used for representing the position and velocity information as either scientific notation or floating point notation. Scientific notation is recommended when possible.
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.file_format`
+ - Get or set the file format that will be generated by the export tool.
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.has_covariance_data`
+ - Return true if the object has covariance data.
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.include_acceleration`
+ - Include acceleration data in the exported file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.include_covariance`
+ - Include covariance data in the exported file. If covariance data is not available, this property becomes read-only.
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.message_id`
+ - A string defining the message ID which should uniquely identify the message.
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.object_id`
+ - A string defining the Object ID - to be specified as the international spacecraft designator, also known as an NSSDC identifier.
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.object_name`
+ - A name for the Object. By recommendation of the CCSDS standard, the name from the SPACEWARN Bulletin should be used.
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.originator`
+ - A string that specifies an identifier of the organization producing the data file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.reference_frame`
+ - Get or set the reference frame of the ephemeris.
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.reference_frames_supported`
+ - Return an array of valid choices.
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.step_size`
+ - If the Use Ephemeris Steps option is not selected, enter a Step Size to be used for the vehicle.
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.time_period`
+ - Set the time period. Options are Use Entire Ephemeris - STK creates a data file using the Start and Stop Time specified in the vehicle's Orbit tab or Specify Time Period - STK creates a data file using the Start and Stop Time specified here.
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.time_precision`
+ - If selected, STK uses the Step Size specified in the vehicle's Basic properties. If not selected, specify a Step Size. Dimensionless.
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.time_system`
+ - Get or set the time system of the ephemeris.
+ * - :py:attr:`~ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.use_satellite_center_and_frame`
+ - Use the satellite center and frame. Setting the property to 'True' will cause CentralBody and ReferenceFrame properties become read-only.
+
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects import VehicleEphemerisCCSDSv3ExportTool
+
+
+Property detail
+---------------
+
+.. py:property:: central_body_name
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.central_body_name
+ :type: str
+
+ Get or set the central body of the satellite.
+
+.. py:property:: classification
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.classification
+ :type: str
+
+ A string that specifies the classification/caveats of the data file.
+
+.. py:property:: date_format
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.date_format
+ :type: CCSDSDateFormat
+
+ Get or set the desired date format.
+
+.. py:property:: ephemeris_format
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.ephemeris_format
+ :type: CCSDSEphemerisFormatType
+
+ Get or set the desired format to be used for representing the position and velocity information as either scientific notation or floating point notation. Scientific notation is recommended when possible.
+
+.. py:property:: file_format
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.file_format
+ :type: EphemExportToolFileFormat
+
+ Get or set the file format that will be generated by the export tool.
+
+.. py:property:: has_covariance_data
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.has_covariance_data
+ :type: bool
+
+ Return true if the object has covariance data.
+
+.. py:property:: include_acceleration
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.include_acceleration
+ :type: bool
+
+ Include acceleration data in the exported file.
+
+.. py:property:: include_covariance
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.include_covariance
+ :type: bool
+
+ Include covariance data in the exported file. If covariance data is not available, this property becomes read-only.
+
+.. py:property:: message_id
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.message_id
+ :type: str
+
+ A string defining the message ID which should uniquely identify the message.
+
+.. py:property:: object_id
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.object_id
+ :type: str
+
+ A string defining the Object ID - to be specified as the international spacecraft designator, also known as an NSSDC identifier.
+
+.. py:property:: object_name
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.object_name
+ :type: str
+
+ A name for the Object. By recommendation of the CCSDS standard, the name from the SPACEWARN Bulletin should be used.
+
+.. py:property:: originator
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.originator
+ :type: str
+
+ A string that specifies an identifier of the organization producing the data file.
+
+.. py:property:: reference_frame
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.reference_frame
+ :type: CCSDSReferenceFrame
+
+ Get or set the reference frame of the ephemeris.
+
+.. py:property:: reference_frames_supported
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.reference_frames_supported
+ :type: list
+
+ Return an array of valid choices.
+
+.. py:property:: step_size
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.step_size
+ :type: ExportToolStepSize
+
+ If the Use Ephemeris Steps option is not selected, enter a Step Size to be used for the vehicle.
+
+.. py:property:: time_period
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.time_period
+ :type: ExportToolTimePeriod
+
+ Set the time period. Options are Use Entire Ephemeris - STK creates a data file using the Start and Stop Time specified in the vehicle's Orbit tab or Specify Time Period - STK creates a data file using the Start and Stop Time specified here.
+
+.. py:property:: time_precision
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.time_precision
+ :type: int
+
+ If selected, STK uses the Step Size specified in the vehicle's Basic properties. If not selected, specify a Step Size. Dimensionless.
+
+.. py:property:: time_system
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.time_system
+ :type: CCSDSTimeSystem
+
+ Get or set the time system of the ephemeris.
+
+.. py:property:: use_satellite_center_and_frame
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.use_satellite_center_and_frame
+ :type: bool
+
+ Use the satellite center and frame. Setting the property to 'True' will cause CentralBody and ReferenceFrame properties become read-only.
+
+
+Method detail
+-------------
+
+
+
+
+
+
+
+
+
+.. py:method:: export(self, file_name: str) -> None
+ :canonical: ansys.stk.core.stkobjects.VehicleEphemerisCCSDSv3ExportTool.export
+
+ Export the ephemeris file.
+
+ :Parameters:
+
+ **file_name** : :obj:`~str`
+
+
+ :Returns:
+
+ :obj:`~None`
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/VehicleHPOPForceModelDrag.rst b/doc/source/api/ansys/stk/core/stkobjects/VehicleHPOPForceModelDrag.rst
index 8b0258ce6a..f2102e81e9 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/VehicleHPOPForceModelDrag.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/VehicleHPOPForceModelDrag.rst
@@ -43,8 +43,6 @@ Overview
- Return a type of the active drag model.
* - :py:attr:`~ansys.stk.core.stkobjects.VehicleHPOPForceModelDrag.low_altitude_atmosphere_density_model`
- Select the low altitude atmospheric density model to be used.
- * - :py:attr:`~ansys.stk.core.stkobjects.VehicleHPOPForceModelDrag.low_altitude_atmospheric_density_model`
- - Do not use this property, as it is deprecated. Use LowAltAtmosDensityModel instead. Select the low altitude atmospheric density model to be used.
* - :py:attr:`~ansys.stk.core.stkobjects.VehicleHPOPForceModelDrag.solar_flux_geo_magnitude`
- Solar and geomagnetic flux.
* - :py:attr:`~ansys.stk.core.stkobjects.VehicleHPOPForceModelDrag.solar_flux_geo_magnitude_type`
@@ -101,12 +99,6 @@ Property detail
Select the low altitude atmospheric density model to be used.
-.. py:property:: low_altitude_atmospheric_density_model
- :canonical: ansys.stk.core.stkobjects.VehicleHPOPForceModelDrag.low_altitude_atmospheric_density_model
- :type: AtmosphericDensityModel
-
- Do not use this property, as it is deprecated. Use LowAltAtmosDensityModel instead. Select the low altitude atmospheric density model to be used.
-
.. py:property:: solar_flux_geo_magnitude
:canonical: ansys.stk.core.stkobjects.VehicleHPOPForceModelDrag.solar_flux_geo_magnitude
:type: IVehicleSolarFluxGeoMagnitude
@@ -152,8 +144,6 @@ Method detail
-
-
.. py:method:: set_drag_model_type(self, drag_model: DragModel) -> None
:canonical: ansys.stk.core.stkobjects.VehicleHPOPForceModelDrag.set_drag_model_type
diff --git a/doc/source/api/ansys/stk/core/stkobjects/VehicleInitialState.rst b/doc/source/api/ansys/stk/core/stkobjects/VehicleInitialState.rst
index 449f6aa6c3..b91aa35c44 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/VehicleInitialState.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/VehicleInitialState.rst
@@ -20,12 +20,8 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.VehicleInitialState.orbit_epoch`
- Get the smart epoch component to configure the orbit state epoch.
- * - :py:attr:`~ansys.stk.core.stkobjects.VehicleInitialState.propagation_frame`
- - Do not use this property, as it is deprecated. Use Two-body, J2 and J4 propagators to configure propagation frame. The propagation frame.
* - :py:attr:`~ansys.stk.core.stkobjects.VehicleInitialState.representation`
- Representation.
- * - :py:attr:`~ansys.stk.core.stkobjects.VehicleInitialState.supported_propagation_frames`
- - Do not use this property, as it is deprecated. Use Two-body, J2 and J4 propagators to get a list of supported propagation frames. Returns supported propagation frames.
@@ -46,22 +42,10 @@ Property detail
Get the smart epoch component to configure the orbit state epoch.
-.. py:property:: propagation_frame
- :canonical: ansys.stk.core.stkobjects.VehicleInitialState.propagation_frame
- :type: VehiclePropagationFrame
-
- Do not use this property, as it is deprecated. Use Two-body, J2 and J4 propagators to configure propagation frame. The propagation frame.
-
.. py:property:: representation
:canonical: ansys.stk.core.stkobjects.VehicleInitialState.representation
:type: IOrbitState
Representation.
-.. py:property:: supported_propagation_frames
- :canonical: ansys.stk.core.stkobjects.VehicleInitialState.supported_propagation_frames
- :type: list
-
- Do not use this property, as it is deprecated. Use Two-body, J2 and J4 propagators to get a list of supported propagation frames. Returns supported propagation frames.
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/VehicleLOPDragSettings.rst b/doc/source/api/ansys/stk/core/stkobjects/VehicleLOPDragSettings.rst
index 821b65e280..08628f93a7 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/VehicleLOPDragSettings.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/VehicleLOPDragSettings.rst
@@ -20,8 +20,6 @@ Overview
* - :py:attr:`~ansys.stk.core.stkobjects.VehicleLOPDragSettings.atmosphere_density_model`
- Atmospheric density model.
- * - :py:attr:`~ansys.stk.core.stkobjects.VehicleLOPDragSettings.atmospheric_density_model`
- - Do not use this property, as it is deprecated. Use AtmosDensityModel instead. Atmospheric density model.
* - :py:attr:`~ansys.stk.core.stkobjects.VehicleLOPDragSettings.density_weighing_factor`
- Get or set the scale factor to be used during density calculations. Dimensionless.
* - :py:attr:`~ansys.stk.core.stkobjects.VehicleLOPDragSettings.exponential_density_model_parameters`
@@ -50,12 +48,6 @@ Property detail
Atmospheric density model.
-.. py:property:: atmospheric_density_model
- :canonical: ansys.stk.core.stkobjects.VehicleLOPDragSettings.atmospheric_density_model
- :type: AtmosphericDensityModel
-
- Do not use this property, as it is deprecated. Use AtmosDensityModel instead. Atmospheric density model.
-
.. py:property:: density_weighing_factor
:canonical: ansys.stk.core.stkobjects.VehicleLOPDragSettings.density_weighing_factor
:type: float
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator.rst
index fa2a5c27f1..521d5bcbe0 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator.rst
@@ -360,6 +360,15 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.Exponential`
- Exponential atmospheric propagator function.
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecord`
+ - Flight Dynamics Records.
+
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordCreator`
+ - Flight dynamics record creator.
+
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordPreview`
+ - Flight dynamics record preview.
+
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.FuelTank`
- Fuel Tank parameters.
@@ -537,6 +546,18 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.MSISE1990`
- MSISE 1990 atmospheric propagator function.
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParameter`
+ - NPlate Stochastic Correction Parameter definition.
+
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParametersCollection`
+ - NPlate Stochastic Correction Parameter Collection.
+
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticParameter`
+ - NPlate Stochastic Parameter definition.
+
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticParametersCollection`
+ - NPlate Stochastic Parameter Collection.
+
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.NRLMSISE2000`
- NRLMSISE 2000 atmospheric propagator function.
@@ -621,18 +642,12 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.RadiationPressureFunction`
- Radiation Pressure Propagator Function.
- * - :py:class:`~ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd`
- - RK2nd3rd Numerical Integrator.
-
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.RungeKutta4th`
- RK4th Numerical Integrator.
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.RungeKutta4th5th`
- RK4th5th Numerical Integrator.
- * - :py:class:`~ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt`
- - RK4thAdapt Numerical Integrator.
-
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.RungeKuttaF7th8th`
- RKF7th8th Numerical Integrator.
@@ -891,7 +906,7 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.StateCalcGeodeticTrueLongitudeAtTimeOfPerigee`
- GeodeticTrueLongitudeAtTimeOfPerigee Calc objects.
- * - :py:class:`~ansys.stk.core.stkobjects.astrogator.StateCalcGravCoeff`
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.StateCalcGravCoefficient`
- Gravity Coefficient Calc objects.
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.StateCalcGravitationalParameter`
@@ -1218,9 +1233,24 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.StateCalcVMagnitude`
- VMag Calc objects.
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.StateConfig`
+ - State config. property.
+
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.StateConfigCollection`
+ - State config. properties Collection.
+
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.StateTransformationFunction`
- State Transition Propagator Function.
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.StochasticDensityCorrection`
+ - Properties for Stochastic Density Correction.
+
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.StochasticModelParameters`
+ - Properties for Stochastic Model Parameters.
+
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.StochasticParameters`
+ - Stochastic Parameters.
+
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.StoppingCondition`
- A stopping condition.
@@ -1373,7 +1403,7 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.ClearEphemerisDirection`
- Direction in which to clear ephemeris.
- * - :py:class:`~ansys.stk.core.stkobjects.astrogator.CoeffRungeKuttaV8th9th`
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.CoefficientRungeKuttaV8th9th`
- Coefficient sets for RKV8th(9th) integrator.
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.ComplexNumber`
@@ -1460,6 +1490,9 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.DifferentialCorrectorScalingMethod`
- The Scaling Method types for a Differential Corrector profile.
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.DragCorrectionType`
+ - Interpretation of the Gauss Markov used for spherical drag accelerations.
+
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.DragModelType`
- Type of Drag Model.
@@ -1484,6 +1517,9 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.ErrorControl`
- Error Control for the numerical integrator.
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordEpochType`
+ - The types for Desired Epoch Type for Vector Selection.
+
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.FollowJoin`
- Joining options for the Follow segment.
@@ -1518,12 +1554,12 @@ Summary
- The source of the gravitational parameter for a CStateCalcGravitationalParameter calculation object.
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.GravityCoefficientNormalizationType`
- - The normalization type for the CStateCalcGravCoeff calculation object.
+ - The normalization type for the CStateCalcGravCoefficient calculation object.
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.GravityCoefficientType`
- - The coefficient type for the CStateCalcGravCoeff calculation object.
+ - The coefficient type for the CStateCalcGravCoefficient calculation object.
- * - :py:class:`~ansys.stk.core.stkobjects.astrogator.GravParamSource`
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.GravParameterSource`
- The gravity parameter source.
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.GridSearchDesiredOperation`
@@ -1661,6 +1697,9 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.SquaredType`
- Whether to calculate the value as the square of the sum of each component or the sum of the squares.
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.SRPCorrectionType`
+ - Interpretation of the Gauss Markov used for spherical SRP accelerations.
+
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.StateType`
- The Stop segment state types.
@@ -1670,6 +1709,9 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.STMPerturbationVariables`
- The initial and final Cartesian variational variables that describe an STM element.
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.StochasticModel`
+ - Interpretation of the Gauss Markov used for spherical SRP accelerations.
+
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.StoppingConditionType`
- Type of stopping condition.
@@ -1697,7 +1739,7 @@ Summary
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.UpdateAction`
- Actions for the Update segment.
- * - :py:class:`~ansys.stk.core.stkobjects.astrogator.UpdateParam`
+ * - :py:class:`~ansys.stk.core.stkobjects.astrogator.UpdateParameter`
- Spacecraft parameters that can be modified by an Update segment.
* - :py:class:`~ansys.stk.core.stkobjects.astrogator.VenusGRAMDensityType`
@@ -1838,6 +1880,9 @@ Object Model components specifically designed to support STK Astrogator.
EOMFuncPluginFunction
ER3BPFunc
Exponential
+ FlightDynamicsRecord
+ FlightDynamicsRecordCreator
+ FlightDynamicsRecordPreview
FuelTank
GaussJacksonIntegrator
GeneralRelativityFunction
@@ -1897,6 +1942,10 @@ Object Model components specifically designed to support STK Astrogator.
MCSUpdate
MSIS1986
MSISE1990
+ NPlateStochasticCorrectionParameter
+ NPlateStochasticCorrectionParametersCollection
+ NPlateStochasticParameter
+ NPlateStochasticParametersCollection
NRLMSISE2000
NumericalPropagatorWrapper
NumericalPropagatorWrapperCR3BP
@@ -1925,10 +1974,8 @@ Object Model components specifically designed to support STK Astrogator.
ProfileSNOPTOptimizer
PropagatorFunctionCollection
RadiationPressureFunction
- RungeKutta2nd3rd
RungeKutta4th
RungeKutta4th5th
- RungeKutta4thAdapt
RungeKuttaF7th8th
RungeKuttaV8th9th
ScriptingCalculationObject
@@ -2015,7 +2062,7 @@ Object Model components specifically designed to support STK Astrogator.
StateCalcGeodeticMeanRightAscension
StateCalcGeodeticTrueLongitude
StateCalcGeodeticTrueLongitudeAtTimeOfPerigee
- StateCalcGravCoeff
+ StateCalcGravCoefficient
StateCalcGravitationalParameter
StateCalcHeightAboveTerrain
StateCalcImpactFlux
@@ -2124,7 +2171,12 @@ Object Model components specifically designed to support STK Astrogator.
StateCalcVelocityAz
StateCalcVelocityDifferenceOtherSegment
StateCalcVMagnitude
+ StateConfig
+ StateConfigCollection
StateTransformationFunction
+ StochasticDensityCorrection
+ StochasticModelParameters
+ StochasticParameters
StoppingCondition
StoppingConditionCollection
StoppingConditionElement
@@ -2179,7 +2231,7 @@ Object Model components specifically designed to support STK Astrogator.
≔ CentralBodyGravityModel
≔ CentralBodyShape
≔ ClearEphemerisDirection
- ≔ CoeffRungeKuttaV8th9th
+ ≔ CoefficientRungeKuttaV8th9th
≔ ComplexNumber
≔ ConstraintSign
≔ ControlAdvanced
@@ -2208,6 +2260,7 @@ Object Model components specifically designed to support STK Astrogator.
≔ DerivativeCalculationMethod
≔ DifferenceOrder
≔ DifferentialCorrectorScalingMethod
+ ≔ DragCorrectionType
≔ DragModelType
≔ DrawPerturbation
≔ EclipsingBodiesSource
@@ -2216,6 +2269,7 @@ Object Model components specifically designed to support STK Astrogator.
≔ EngineModelFunction
≔ EphemerisSource
≔ ErrorControl
+ ≔ FlightDynamicsRecordEpochType
≔ FollowJoin
≔ FollowSeparation
≔ FollowSpacecraftAndFuelTank
@@ -2229,7 +2283,7 @@ Object Model components specifically designed to support STK Astrogator.
≔ GravitationalParameterSource
≔ GravityCoefficientNormalizationType
≔ GravityCoefficientType
- ≔ GravParamSource
+ ≔ GravParameterSource
≔ GridSearchDesiredOperation
≔ IdealOrbitRadius
≔ ImpulsiveDeltaVRepresentation
@@ -2275,9 +2329,11 @@ Object Model components specifically designed to support STK Astrogator.
≔ SNOPTGoal
≔ SolarForceMethod
≔ SquaredType
+ ≔ SRPCorrectionType
≔ StateType
≔ STMEigenNumber
≔ STMPerturbationVariables
+ ≔ StochasticModel
≔ StoppingConditionType
≔ SunPosition
≔ TabVecInterpolationMethod
@@ -2287,6 +2343,6 @@ Object Model components specifically designed to support STK Astrogator.
≔ ThrusterDirection
≔ ThrustType
≔ UpdateAction
- ≔ UpdateParam
+ ≔ UpdateParameter
≔ VenusGRAMDensityType
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/Cira72Function.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/Cira72Function.rst
index 5bff6125da..d105ae1e6b 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/Cira72Function.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/Cira72Function.rst
@@ -32,6 +32,8 @@ Overview
- Flag indicates whether this model computes pressure.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Cira72Function.computes_temperature`
- Flag indicates whether this model computes temperature.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Cira72Function.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Cira72Function.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Cira72Function.drag_model_plugin_name`
@@ -46,10 +48,20 @@ Overview
- Geomagnetic Index (Kp). Dimensionless.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Cira72Function.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Cira72Function.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Cira72Function.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Cira72Function.stochastic_density_correction`
+ - Stochastic StochasticDensity Correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Cira72Function.sun_position`
- Get or set the sun position computation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Cira72Function.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Cira72Function.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Cira72Function.use_stochastic_density_correction`
+ - True if using stochastic model for a density model correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Cira72Function.variable_area_history_file`
- Drag variable area history file.
@@ -102,6 +114,12 @@ Property detail
Flag indicates whether this model computes temperature.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.Cira72Function.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.Cira72Function.drag_model_plugin
:type: DragModelPlugin
@@ -144,6 +162,24 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.Cira72Function.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.Cira72Function.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
+.. py:property:: stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.Cira72Function.stochastic_density_correction
+ :type: StochasticDensityCorrection
+
+ Stochastic StochasticDensity Correction.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.Cira72Function.sun_position
:type: SunPosition
@@ -156,6 +192,18 @@ Property detail
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.Cira72Function.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
+.. py:property:: use_stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.Cira72Function.use_stochastic_density_correction
+ :type: bool
+
+ True if using stochastic model for a density model correction.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.Cira72Function.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/CoeffRungeKuttaV8th9th.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/CoefficientRungeKuttaV8th9th.rst
similarity index 56%
rename from doc/source/api/ansys/stk/core/stkobjects/astrogator/CoeffRungeKuttaV8th9th.rst
rename to doc/source/api/ansys/stk/core/stkobjects/astrogator/CoefficientRungeKuttaV8th9th.rst
index 54a5fd1a61..3d0724408c 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/CoeffRungeKuttaV8th9th.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/CoefficientRungeKuttaV8th9th.rst
@@ -1,12 +1,12 @@
-CoeffRungeKuttaV8th9th
-======================
+CoefficientRungeKuttaV8th9th
+============================
-.. py:class:: ansys.stk.core.stkobjects.astrogator.CoeffRungeKuttaV8th9th
+.. py:class:: ansys.stk.core.stkobjects.astrogator.CoefficientRungeKuttaV8th9th
IntEnum
-.. py:currentmodule:: CoeffRungeKuttaV8th9th
+.. py:currentmodule:: CoefficientRungeKuttaV8th9th
Overview
--------
@@ -31,6 +31,6 @@ Import detail
.. code-block:: python
- from ansys.stk.core.stkobjects.astrogator import CoeffRungeKuttaV8th9th
+ from ansys.stk.core.stkobjects.astrogator import CoefficientRungeKuttaV8th9th
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/ConvergenceCriteria.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/ConvergenceCriteria.rst
index 1bff92f173..b71047c00e 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/ConvergenceCriteria.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/ConvergenceCriteria.rst
@@ -22,7 +22,7 @@ Overview
* - :py:attr:`~EQUALITY_CONSTRAINT_WITHIN_TOLERANCE`
- Equality Constraints Satisfied - the differences between the achieved and desired equality constraint values must be within the specified tolerances for convergence.
- * - :py:attr:`~CONVERVENCE_CRITERIA_EITHER_EQUALITY_CONSTRAINTS_OR_CONTROL_PARAMS`
+ * - :py:attr:`~CONVERVENCE_CRITERIA_EITHER_EQUALITY_CONSTRAINTS_OR_CONTROL_PARAMETERS`
- Equality Constraints Satisfied or Parameter Variations within Tolerance - the differences between the achieved and desired EC values must be within tolerances, or the last updates to the control parameters must be within tolerances for convergence.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/DTM2012.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/DTM2012.rst
index 3f4c1c31a8..c65ff70ed7 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/DTM2012.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/DTM2012.rst
@@ -32,6 +32,8 @@ Overview
- Flag indicates whether this model computes pressure.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2012.computes_temperature`
- Flag indicates whether this model computes temperature.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2012.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2012.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2012.drag_model_plugin_name`
@@ -46,10 +48,20 @@ Overview
- Geomagnetic Index (Kp). Dimensionless.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2012.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2012.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2012.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2012.stochastic_density_correction`
+ - Stochastic StochasticDensity Correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2012.sun_position`
- Get or set the sun position computation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2012.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2012.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2012.use_stochastic_density_correction`
+ - True if using stochastic model for a density model correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2012.variable_area_history_file`
- Drag variable area history file.
@@ -102,6 +114,12 @@ Property detail
Flag indicates whether this model computes temperature.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.DTM2012.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.DTM2012.drag_model_plugin
:type: DragModelPlugin
@@ -144,6 +162,24 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.DTM2012.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.DTM2012.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
+.. py:property:: stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.DTM2012.stochastic_density_correction
+ :type: StochasticDensityCorrection
+
+ Stochastic StochasticDensity Correction.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.DTM2012.sun_position
:type: SunPosition
@@ -156,6 +192,18 @@ Property detail
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.DTM2012.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
+.. py:property:: use_stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.DTM2012.use_stochastic_density_correction
+ :type: bool
+
+ True if using stochastic model for a density model correction.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.DTM2012.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/DTM2020.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/DTM2020.rst
index 5932481bbf..ad6421489b 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/DTM2020.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/DTM2020.rst
@@ -32,6 +32,8 @@ Overview
- Flag indicates whether this model computes pressure.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2020.computes_temperature`
- Flag indicates whether this model computes temperature.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2020.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2020.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2020.drag_model_plugin_name`
@@ -46,10 +48,20 @@ Overview
- Geomagnetic Index (Kp). Dimensionless.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2020.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2020.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2020.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2020.stochastic_density_correction`
+ - Stochastic StochasticDensity Correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2020.sun_position`
- Get or set the sun position computation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2020.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2020.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2020.use_stochastic_density_correction`
+ - True if using stochastic model for a density model correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.DTM2020.variable_area_history_file`
- Drag variable area history file.
@@ -102,6 +114,12 @@ Property detail
Flag indicates whether this model computes temperature.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.DTM2020.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.DTM2020.drag_model_plugin
:type: DragModelPlugin
@@ -144,6 +162,24 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.DTM2020.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.DTM2020.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
+.. py:property:: stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.DTM2020.stochastic_density_correction
+ :type: StochasticDensityCorrection
+
+ Stochastic StochasticDensity Correction.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.DTM2020.sun_position
:type: SunPosition
@@ -156,6 +192,18 @@ Property detail
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.DTM2020.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
+.. py:property:: use_stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.DTM2020.use_stochastic_density_correction
+ :type: bool
+
+ True if using stochastic model for a density model correction.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.DTM2020.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/DragCorrectionType.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/DragCorrectionType.rst
new file mode 100644
index 0000000000..eb269e90b8
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/DragCorrectionType.rst
@@ -0,0 +1,42 @@
+DragCorrectionType
+==================
+
+.. py:class:: ansys.stk.core.stkobjects.astrogator.DragCorrectionType
+
+ IntEnum
+
+
+.. py:currentmodule:: DragCorrectionType
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Members
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~BALLISTIC_COEFFICIENT_RELATIVE`
+ - Relative correction to ballistic coefficient.
+
+ * - :py:attr:`~BALLISTIC_COEFFICIENT_ADDITIVE`
+ - Additive correction to ballistic coefficient.
+
+ * - :py:attr:`~CD_RELATIVE`
+ - Relative correction to Cd.
+
+ * - :py:attr:`~CD_ADDITIVE`
+ - Additive correction to Cd.
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects.astrogator import DragCorrectionType
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/Exponential.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/Exponential.rst
index a4528423f7..8ff64e41eb 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/Exponential.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/Exponential.rst
@@ -20,6 +20,8 @@ Overview
:header-rows: 0
:widths: auto
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Exponential.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Exponential.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Exponential.drag_model_plugin_name`
@@ -28,14 +30,20 @@ Overview
- Drag model type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Exponential.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Exponential.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Exponential.reference_altitude`
- Get or set the reference altitude. Uses Distance Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Exponential.reference_density`
- Get or set the reference density. Uses Density Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Exponential.scale_altitude`
- Get or set the scale altitude. Uses Distance Dimension.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Exponential.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Exponential.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Exponential.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Exponential.variable_area_history_file`
- Drag variable area history file.
@@ -52,6 +60,12 @@ Import detail
Property detail
---------------
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.Exponential.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.Exponential.drag_model_plugin
:type: DragModelPlugin
@@ -76,6 +90,12 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.Exponential.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
.. py:property:: reference_altitude
:canonical: ansys.stk.core.stkobjects.astrogator.Exponential.reference_altitude
:type: float
@@ -94,12 +114,24 @@ Property detail
Get or set the scale altitude. Uses Distance Dimension.
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.Exponential.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
.. py:property:: use_approximate_altitude
:canonical: ansys.stk.core.stkobjects.astrogator.Exponential.use_approximate_altitude
:type: bool
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.Exponential.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.Exponential.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/FlightDynamicsRecord.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/FlightDynamicsRecord.rst
new file mode 100644
index 0000000000..184b92cecf
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/FlightDynamicsRecord.rst
@@ -0,0 +1,104 @@
+FlightDynamicsRecord
+====================
+
+.. py:class:: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecord
+
+ Bases: :py:class:`~ansys.stk.core.stkobjects.astrogator.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.astrogator.ICloneable`
+
+ Flight Dynamics Records.
+
+.. py:currentmodule:: FlightDynamicsRecord
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Methods
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecord.export_propulsion_to_browser`
+ - Export the version of the propagator stored in this record to the component browser.
+
+ .. tab-item:: Properties
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecord.notes`
+ - User commecnt/information associated with the record.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecord.propagator`
+ - The numerical propagator (force model and integrator) configuration associated with this record
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecord.propagator_name`
+ - Propagator name.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecord.record_time_stamp`
+ - Time stamp when the FD record was created from its source.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecord.state_config_properties`
+ - State Config. properties
+
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects.astrogator import FlightDynamicsRecord
+
+
+Property detail
+---------------
+
+.. py:property:: notes
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecord.notes
+ :type: str
+
+ User commecnt/information associated with the record.
+
+.. py:property:: propagator
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecord.propagator
+ :type: IComponentInfo
+
+ The numerical propagator (force model and integrator) configuration associated with this record
+
+.. py:property:: propagator_name
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecord.propagator_name
+ :type: str
+
+ Propagator name.
+
+.. py:property:: record_time_stamp
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecord.record_time_stamp
+ :type: str
+
+ Time stamp when the FD record was created from its source.
+
+.. py:property:: state_config_properties
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecord.state_config_properties
+ :type: StateConfigCollection
+
+ State Config. properties
+
+
+Method detail
+-------------
+
+.. py:method:: export_propulsion_to_browser(self) -> None
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecord.export_propulsion_to_browser
+
+ Export the version of the propagator stored in this record to the component browser.
+
+ :Returns:
+
+ :obj:`~None`
+
+
+
+
+
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/FlightDynamicsRecordCreator.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/FlightDynamicsRecordCreator.rst
new file mode 100644
index 0000000000..1a0bb2e59f
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/FlightDynamicsRecordCreator.rst
@@ -0,0 +1,126 @@
+FlightDynamicsRecordCreator
+===========================
+
+.. py:class:: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordCreator
+
+ Flight dynamics record creator.
+
+.. py:currentmodule:: FlightDynamicsRecordCreator
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Methods
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordCreator.export`
+ - Set the converted initial state to be used by the problem.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordCreator.reset`
+ - Reset the flight dynamics record creator parameters to default values.
+
+ .. tab-item:: Properties
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordCreator.desired_epoch_type`
+ - Get or sets the the state from the ephemeris.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordCreator.epoch`
+ - Get or set the Date & Time associated with this launch time.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordCreator.preview`
+ - Get the flight dynamics record preview.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordCreator.record_name`
+ - Get or set the flight dynamics record name.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordCreator.segment_name`
+ - Get or set the segment to pull the ephemeris from.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordCreator.use_default_record_name`
+ - Get or set the option for using the default record name.
+
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects.astrogator import FlightDynamicsRecordCreator
+
+
+Property detail
+---------------
+
+.. py:property:: desired_epoch_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordCreator.desired_epoch_type
+ :type: FlightDynamicsRecordEpochType
+
+ Get or sets the the state from the ephemeris.
+
+.. py:property:: epoch
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordCreator.epoch
+ :type: typing.Any
+
+ Get or set the Date & Time associated with this launch time.
+
+.. py:property:: preview
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordCreator.preview
+ :type: FlightDynamicsRecordPreview
+
+ Get the flight dynamics record preview.
+
+.. py:property:: record_name
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordCreator.record_name
+ :type: str
+
+ Get or set the flight dynamics record name.
+
+.. py:property:: segment_name
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordCreator.segment_name
+ :type: str
+
+ Get or set the segment to pull the ephemeris from.
+
+.. py:property:: use_default_record_name
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordCreator.use_default_record_name
+ :type: bool
+
+ Get or set the option for using the default record name.
+
+
+Method detail
+-------------
+
+
+
+
+
+.. py:method:: export(self) -> None
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordCreator.export
+
+ Set the converted initial state to be used by the problem.
+
+ :Returns:
+
+ :obj:`~None`
+
+
+
+
+.. py:method:: reset(self) -> None
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordCreator.reset
+
+ Reset the flight dynamics record creator parameters to default values.
+
+ :Returns:
+
+ :obj:`~None`
+
+
+
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/FlightDynamicsRecordEpochType.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/FlightDynamicsRecordEpochType.rst
new file mode 100644
index 0000000000..11f702b631
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/FlightDynamicsRecordEpochType.rst
@@ -0,0 +1,39 @@
+FlightDynamicsRecordEpochType
+=============================
+
+.. py:class:: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordEpochType
+
+ IntEnum
+
+
+.. py:currentmodule:: FlightDynamicsRecordEpochType
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Members
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~CLOSEST_POINT`
+ - Desired epcoh at closest point.
+
+ * - :py:attr:`~FIRST_POINT`
+ - Desired epcoh at first point.
+
+ * - :py:attr:`~LAST_POINT`
+ - Desired epcoh at last point.
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects.astrogator import FlightDynamicsRecordEpochType
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/FlightDynamicsRecordPreview.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/FlightDynamicsRecordPreview.rst
new file mode 100644
index 0000000000..b7cc1822dd
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/FlightDynamicsRecordPreview.rst
@@ -0,0 +1,99 @@
+FlightDynamicsRecordPreview
+===========================
+
+.. py:class:: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordPreview
+
+ Flight dynamics record preview.
+
+.. py:currentmodule:: FlightDynamicsRecordPreview
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Properties
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordPreview.epoch_label`
+ - Get the epoch of the retrieved state from the ephemeris.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordPreview.preview_result_label`
+ - Get the result of the initial state validation operation.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordPreview.rx_label`
+ - Get the initial x position component for import label.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordPreview.ry_label`
+ - Get the initial y position component for import label.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordPreview.rz_label`
+ - Get the initial z position component for import label.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordPreview.vx_label`
+ - Get the x velocity component for import label.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordPreview.vy_label`
+ - Get the y velocity component for import label.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordPreview.vz_label`
+ - Get the z velocity component for import label.
+
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects.astrogator import FlightDynamicsRecordPreview
+
+
+Property detail
+---------------
+
+.. py:property:: epoch_label
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordPreview.epoch_label
+ :type: str
+
+ Get the epoch of the retrieved state from the ephemeris.
+
+.. py:property:: preview_result_label
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordPreview.preview_result_label
+ :type: str
+
+ Get the result of the initial state validation operation.
+
+.. py:property:: rx_label
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordPreview.rx_label
+ :type: str
+
+ Get the initial x position component for import label.
+
+.. py:property:: ry_label
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordPreview.ry_label
+ :type: str
+
+ Get the initial y position component for import label.
+
+.. py:property:: rz_label
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordPreview.rz_label
+ :type: str
+
+ Get the initial z position component for import label.
+
+.. py:property:: vx_label
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordPreview.vx_label
+ :type: str
+
+ Get the x velocity component for import label.
+
+.. py:property:: vy_label
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordPreview.vy_label
+ :type: str
+
+ Get the y velocity component for import label.
+
+.. py:property:: vz_label
+ :canonical: ansys.stk.core.stkobjects.astrogator.FlightDynamicsRecordPreview.vz_label
+ :type: str
+
+ Get the z velocity component for import label.
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/GravParamSource.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/GravParameterSource.rst
similarity index 78%
rename from doc/source/api/ansys/stk/core/stkobjects/astrogator/GravParamSource.rst
rename to doc/source/api/ansys/stk/core/stkobjects/astrogator/GravParameterSource.rst
index 6621a07f12..e53e7c515c 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/GravParamSource.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/GravParameterSource.rst
@@ -1,12 +1,12 @@
-GravParamSource
-===============
+GravParameterSource
+===================
-.. py:class:: ansys.stk.core.stkobjects.astrogator.GravParamSource
+.. py:class:: ansys.stk.core.stkobjects.astrogator.GravParameterSource
IntEnum
-.. py:currentmodule:: GravParamSource
+.. py:currentmodule:: GravParameterSource
Overview
--------
@@ -37,6 +37,6 @@ Import detail
.. code-block:: python
- from ansys.stk.core.stkobjects.astrogator import GravParamSource
+ from ansys.stk.core.stkobjects.astrogator import GravParameterSource
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/HarrisPriester.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/HarrisPriester.rst
index dd5a9cf8f2..c898b46533 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/HarrisPriester.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/HarrisPriester.rst
@@ -28,6 +28,8 @@ Overview
- Flag indicates whether this model computes pressure.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.HarrisPriester.computes_temperature`
- Flag indicates whether this model computes temperature.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.HarrisPriester.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.HarrisPriester.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.HarrisPriester.drag_model_plugin_name`
@@ -38,10 +40,16 @@ Overview
- Average solar Flux (F10.7); the 81-day averaged Ottawa 10.7 cm solar flux value. Dimensionless.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.HarrisPriester.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.HarrisPriester.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.HarrisPriester.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.HarrisPriester.sun_position`
- Get or set the sun position computation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.HarrisPriester.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.HarrisPriester.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.HarrisPriester.variable_area_history_file`
- Drag variable area history file.
@@ -82,6 +90,12 @@ Property detail
Flag indicates whether this model computes temperature.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.HarrisPriester.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.HarrisPriester.drag_model_plugin
:type: DragModelPlugin
@@ -112,6 +126,18 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.HarrisPriester.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.HarrisPriester.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.HarrisPriester.sun_position
:type: SunPosition
@@ -124,6 +150,12 @@ Property detail
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.HarrisPriester.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.HarrisPriester.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/Jacchia1960.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/Jacchia1960.rst
index 0dc5216251..35ecd80aa9 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/Jacchia1960.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/Jacchia1960.rst
@@ -24,6 +24,8 @@ Overview
- Flag indicates whether this model computes pressure.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1960.computes_temperature`
- Flag indicates whether this model computes temperature.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1960.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1960.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1960.drag_model_plugin_name`
@@ -32,10 +34,16 @@ Overview
- Drag model type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1960.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1960.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1960.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1960.sun_position`
- Get or set the sun position computation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1960.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1960.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1960.variable_area_history_file`
- Drag variable area history file.
@@ -64,6 +72,12 @@ Property detail
Flag indicates whether this model computes temperature.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1960.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1960.drag_model_plugin
:type: DragModelPlugin
@@ -88,6 +102,18 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1960.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1960.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1960.sun_position
:type: SunPosition
@@ -100,6 +126,12 @@ Property detail
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1960.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1960.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/Jacchia1970.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/Jacchia1970.rst
index 277ba50d38..7c084054a9 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/Jacchia1970.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/Jacchia1970.rst
@@ -32,6 +32,8 @@ Overview
- Flag indicates whether this model computes pressure.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1970.computes_temperature`
- Flag indicates whether this model computes temperature.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1970.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1970.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1970.drag_model_plugin_name`
@@ -46,10 +48,20 @@ Overview
- Geomagnetic Index (Kp). Dimensionless.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1970.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1970.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1970.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1970.stochastic_density_correction`
+ - Stochastic StochasticDensity Correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1970.sun_position`
- Get or set the sun position computation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1970.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1970.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1970.use_stochastic_density_correction`
+ - True if using stochastic model for a density model correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1970.variable_area_history_file`
- Drag variable area history file.
@@ -102,6 +114,12 @@ Property detail
Flag indicates whether this model computes temperature.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1970.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1970.drag_model_plugin
:type: DragModelPlugin
@@ -144,6 +162,24 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1970.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1970.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
+.. py:property:: stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1970.stochastic_density_correction
+ :type: StochasticDensityCorrection
+
+ Stochastic StochasticDensity Correction.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1970.sun_position
:type: SunPosition
@@ -156,6 +192,18 @@ Property detail
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1970.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
+.. py:property:: use_stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1970.use_stochastic_density_correction
+ :type: bool
+
+ True if using stochastic model for a density model correction.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1970.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/Jacchia1971.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/Jacchia1971.rst
index 7ba0b88fb7..65a4ee3957 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/Jacchia1971.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/Jacchia1971.rst
@@ -32,6 +32,8 @@ Overview
- Flag indicates whether this model computes pressure.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1971.computes_temperature`
- Flag indicates whether this model computes temperature.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1971.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1971.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1971.drag_model_plugin_name`
@@ -46,10 +48,20 @@ Overview
- Geomagnetic Index (Kp). Dimensionless.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1971.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1971.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1971.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1971.stochastic_density_correction`
+ - Stochastic StochasticDensity Correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1971.sun_position`
- Get or set the sun position computation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1971.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1971.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1971.use_stochastic_density_correction`
+ - True if using stochastic model for a density model correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.Jacchia1971.variable_area_history_file`
- Drag variable area history file.
@@ -102,6 +114,12 @@ Property detail
Flag indicates whether this model computes temperature.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1971.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1971.drag_model_plugin
:type: DragModelPlugin
@@ -144,6 +162,24 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1971.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1971.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
+.. py:property:: stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1971.stochastic_density_correction
+ :type: StochasticDensityCorrection
+
+ Stochastic StochasticDensity Correction.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1971.sun_position
:type: SunPosition
@@ -156,6 +192,18 @@ Property detail
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1971.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
+.. py:property:: use_stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1971.use_stochastic_density_correction
+ :type: bool
+
+ True if using stochastic model for a density model correction.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.Jacchia1971.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/JacchiaBowman2008.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/JacchiaBowman2008.rst
index 633bc1e33b..a15774ffb6 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/JacchiaBowman2008.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/JacchiaBowman2008.rst
@@ -26,6 +26,8 @@ Overview
- Get or set the atmospheric model DTC file path.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.atmosphere_data_source`
- Get or set the atmospheric model data source - data file or constant values.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.drag_model_plugin_name`
@@ -44,14 +46,24 @@ Overview
- Average solar Flux (M10). Dimensionless.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.s10`
- Solar Flux (S10). Dimensionless.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.s10_avg`
- Average solar Flux (S10). Dimensionless.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.stochastic_density_correction`
+ - Stochastic StochasticDensity Correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.sun_position`
- Get or set the sun position computation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.use_stochastic_density_correction`
+ - True if using stochastic model for a density model correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.variable_area_history_file`
- Drag variable area history file.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.y10`
@@ -90,6 +102,12 @@ Property detail
Get or set the atmospheric model data source - data file or constant values.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.drag_model_plugin
:type: DragModelPlugin
@@ -144,6 +162,12 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
.. py:property:: s10
:canonical: ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.s10
:type: float
@@ -156,6 +180,18 @@ Property detail
Average solar Flux (S10). Dimensionless.
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
+.. py:property:: stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.stochastic_density_correction
+ :type: StochasticDensityCorrection
+
+ Stochastic StochasticDensity Correction.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.sun_position
:type: SunPosition
@@ -168,6 +204,18 @@ Property detail
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
+.. py:property:: use_stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.use_stochastic_density_correction
+ :type: bool
+
+ True if using stochastic model for a density model correction.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.JacchiaBowman2008.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/JacchiaRoberts.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/JacchiaRoberts.rst
index 808d1af534..67dbfb7949 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/JacchiaRoberts.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/JacchiaRoberts.rst
@@ -32,6 +32,8 @@ Overview
- Flag indicates whether this model computes pressure.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.computes_temperature`
- Flag indicates whether this model computes temperature.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.drag_model_plugin_name`
@@ -46,10 +48,20 @@ Overview
- Geomagnetic Index (Kp). Dimensionless.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.stochastic_density_correction`
+ - Stochastic StochasticDensity Correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.sun_position`
- Get or set the sun position computation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.use_stochastic_density_correction`
+ - True if using stochastic model for a density model correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.variable_area_history_file`
- Drag variable area history file.
@@ -102,6 +114,12 @@ Property detail
Flag indicates whether this model computes temperature.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.drag_model_plugin
:type: DragModelPlugin
@@ -144,6 +162,24 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
+.. py:property:: stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.stochastic_density_correction
+ :type: StochasticDensityCorrection
+
+ Stochastic StochasticDensity Correction.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.sun_position
:type: SunPosition
@@ -156,6 +192,18 @@ Property detail
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
+.. py:property:: use_stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.use_stochastic_density_correction
+ :type: bool
+
+ True if using stochastic model for a density model correction.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.JacchiaRoberts.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MCSDriver.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MCSDriver.rst
index 42d88bb213..122f50b9a4 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MCSDriver.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MCSDriver.rst
@@ -51,6 +51,8 @@ Overview
- Get the Automatic Sequences.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MCSDriver.calculation_graphs`
- Get the calculation graphs.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MCSDriver.flight_dynamics_record_creator`
+ - Get the flight dynamics record creator.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MCSDriver.main_sequence`
- Get the Mission Control Sequence.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MCSDriver.options`
@@ -103,6 +105,12 @@ Property detail
Get the calculation graphs.
+.. py:property:: flight_dynamics_record_creator
+ :canonical: ansys.stk.core.stkobjects.astrogator.MCSDriver.flight_dynamics_record_creator
+ :type: FlightDynamicsRecordCreator
+
+ Get the flight dynamics record creator.
+
.. py:property:: main_sequence
:canonical: ansys.stk.core.stkobjects.astrogator.MCSDriver.main_sequence
:type: MCSSegmentCollection
@@ -200,6 +208,7 @@ Method detail
+
.. py:method:: reset_all_profiles(self) -> None
:canonical: ansys.stk.core.stkobjects.astrogator.MCSDriver.reset_all_profiles
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MCSInitialState.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MCSInitialState.rst
index 76180c5f86..7db48700fd 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MCSInitialState.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MCSInitialState.rst
@@ -28,6 +28,8 @@ Overview
- Sees if a control is enabled.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MCSInitialState.set_element_type`
- Select an coordinate type.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MCSInitialState.unlock_initial_state_segment`
+ - Unlocks the initial state segment.
.. tab-item:: Properties
@@ -43,12 +45,18 @@ Overview
- Get the elements of the selected coordinate type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MCSInitialState.element_type`
- Get the coordinate type.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MCSInitialState.flight_dynamics_record_name`
+ - Return the name of the flight dynamics record used in the initial state segment.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MCSInitialState.fuel_tank`
- Get the fuel tank parameters.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MCSInitialState.orbit_epoch`
- Get or set the orbit epoch. Uses DateFormat Dimension.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MCSInitialState.propagator_name`
+ - Return the name of the propagator embedded in the flight dynamics record used in the initial state segment.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MCSInitialState.spacecraft_parameters`
- Get the spacecraft parameters.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MCSInitialState.stochastic_parameters`
+ - Get the stochastic parameters.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MCSInitialState.user_variables`
- Interface used to modify user variables for the initial state segment.
@@ -89,6 +97,12 @@ Property detail
Get the coordinate type.
+.. py:property:: flight_dynamics_record_name
+ :canonical: ansys.stk.core.stkobjects.astrogator.MCSInitialState.flight_dynamics_record_name
+ :type: str
+
+ Return the name of the flight dynamics record used in the initial state segment.
+
.. py:property:: fuel_tank
:canonical: ansys.stk.core.stkobjects.astrogator.MCSInitialState.fuel_tank
:type: FuelTank
@@ -101,12 +115,24 @@ Property detail
Get or set the orbit epoch. Uses DateFormat Dimension.
+.. py:property:: propagator_name
+ :canonical: ansys.stk.core.stkobjects.astrogator.MCSInitialState.propagator_name
+ :type: str
+
+ Return the name of the propagator embedded in the flight dynamics record used in the initial state segment.
+
.. py:property:: spacecraft_parameters
:canonical: ansys.stk.core.stkobjects.astrogator.MCSInitialState.spacecraft_parameters
:type: SpacecraftParameters
Get the spacecraft parameters.
+.. py:property:: stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.MCSInitialState.stochastic_parameters
+ :type: StochasticParameters
+
+ Get the stochastic parameters.
+
.. py:property:: user_variables
:canonical: ansys.stk.core.stkobjects.astrogator.MCSInitialState.user_variables
:type: UserVariableCollection
@@ -151,6 +177,7 @@ Method detail
:obj:`~None`
+
.. py:method:: is_control_parameter_enabled(self, param: ControlInitState) -> bool
:canonical: ansys.stk.core.stkobjects.astrogator.MCSInitialState.is_control_parameter_enabled
@@ -167,6 +194,7 @@ Method detail
+
.. py:method:: set_element_type(self, element_type: ElementSetType) -> None
:canonical: ansys.stk.core.stkobjects.astrogator.MCSInitialState.set_element_type
@@ -183,3 +211,13 @@ Method detail
+.. py:method:: unlock_initial_state_segment(self) -> None
+ :canonical: ansys.stk.core.stkobjects.astrogator.MCSInitialState.unlock_initial_state_segment
+
+ Unlocks the initial state segment.
+
+ :Returns:
+
+ :obj:`~None`
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MCSUpdate.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MCSUpdate.rst
index 3e0ca60649..911c99a902 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MCSUpdate.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MCSUpdate.rst
@@ -106,28 +106,28 @@ Method detail
:obj:`~None`
-.. py:method:: get_action(self, parameter_type: UpdateParam) -> UpdateAction
+.. py:method:: get_action(self, parameter_type: UpdateParameter) -> UpdateAction
:canonical: ansys.stk.core.stkobjects.astrogator.MCSUpdate.get_action
Get the action type for a parameter.
:Parameters:
- **parameter_type** : :obj:`~UpdateParam`
+ **parameter_type** : :obj:`~UpdateParameter`
:Returns:
:obj:`~UpdateAction`
-.. py:method:: get_value(self, parameter_type: UpdateParam) -> float
+.. py:method:: get_value(self, parameter_type: UpdateParameter) -> float
:canonical: ansys.stk.core.stkobjects.astrogator.MCSUpdate.get_value
Get the value type for a parameter.
:Parameters:
- **parameter_type** : :obj:`~UpdateParam`
+ **parameter_type** : :obj:`~UpdateParameter`
:Returns:
@@ -148,14 +148,14 @@ Method detail
:obj:`~bool`
-.. py:method:: set_action(self, parameter_name: UpdateParam, action_type: UpdateAction) -> None
+.. py:method:: set_action(self, parameter_name: UpdateParameter, action_type: UpdateAction) -> None
:canonical: ansys.stk.core.stkobjects.astrogator.MCSUpdate.set_action
Set the update action type.
:Parameters:
- **parameter_name** : :obj:`~UpdateParam`
+ **parameter_name** : :obj:`~UpdateParameter`
**action_type** : :obj:`~UpdateAction`
@@ -164,14 +164,14 @@ Method detail
:obj:`~None`
-.. py:method:: set_action_and_value(self, parameter_type: UpdateParam, action_type: UpdateAction, value: float) -> None
+.. py:method:: set_action_and_value(self, parameter_type: UpdateParameter, action_type: UpdateAction, value: float) -> None
:canonical: ansys.stk.core.stkobjects.astrogator.MCSUpdate.set_action_and_value
Set an action and the new value.
:Parameters:
- **parameter_type** : :obj:`~UpdateParam`
+ **parameter_type** : :obj:`~UpdateParameter`
**action_type** : :obj:`~UpdateAction`
@@ -182,14 +182,14 @@ Method detail
:obj:`~None`
-.. py:method:: set_value(self, parameter_name: UpdateParam, value: float) -> None
+.. py:method:: set_value(self, parameter_name: UpdateParameter, value: float) -> None
:canonical: ansys.stk.core.stkobjects.astrogator.MCSUpdate.set_value
Set the update value.
:Parameters:
- **parameter_name** : :obj:`~UpdateParam`
+ **parameter_name** : :obj:`~UpdateParameter`
**value** : :obj:`~float`
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MSIS1986.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MSIS1986.rst
index acc88bfe26..f6a330a017 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MSIS1986.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MSIS1986.rst
@@ -32,6 +32,8 @@ Overview
- Flag indicates whether this model computes pressure.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSIS1986.computes_temperature`
- Flag indicates whether this model computes temperature.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSIS1986.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSIS1986.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSIS1986.drag_model_plugin_name`
@@ -46,10 +48,20 @@ Overview
- Geomagnetic Index (Kp). Dimensionless.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSIS1986.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSIS1986.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSIS1986.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSIS1986.stochastic_density_correction`
+ - Stochastic StochasticDensity Correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSIS1986.sun_position`
- Get or set the sun position computation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSIS1986.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSIS1986.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSIS1986.use_stochastic_density_correction`
+ - True if using stochastic model for a density model correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSIS1986.variable_area_history_file`
- Drag variable area history file.
@@ -102,6 +114,12 @@ Property detail
Flag indicates whether this model computes temperature.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.MSIS1986.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.MSIS1986.drag_model_plugin
:type: DragModelPlugin
@@ -144,6 +162,24 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.MSIS1986.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.MSIS1986.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
+.. py:property:: stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.MSIS1986.stochastic_density_correction
+ :type: StochasticDensityCorrection
+
+ Stochastic StochasticDensity Correction.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.MSIS1986.sun_position
:type: SunPosition
@@ -156,6 +192,18 @@ Property detail
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.MSIS1986.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
+.. py:property:: use_stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.MSIS1986.use_stochastic_density_correction
+ :type: bool
+
+ True if using stochastic model for a density model correction.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.MSIS1986.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MSISE1990.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MSISE1990.rst
index 5b3a2fd04f..c1749e1a78 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MSISE1990.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MSISE1990.rst
@@ -32,6 +32,8 @@ Overview
- Flag indicates whether this model computes pressure.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSISE1990.computes_temperature`
- Flag indicates whether this model computes temperature.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSISE1990.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSISE1990.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSISE1990.drag_model_plugin_name`
@@ -46,10 +48,20 @@ Overview
- Geomagnetic Index (Kp). Dimensionless.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSISE1990.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSISE1990.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSISE1990.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSISE1990.stochastic_density_correction`
+ - Stochastic StochasticDensity Correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSISE1990.sun_position`
- Get or set the sun position computation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSISE1990.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSISE1990.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSISE1990.use_stochastic_density_correction`
+ - True if using stochastic model for a density model correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MSISE1990.variable_area_history_file`
- Drag variable area history file.
@@ -102,6 +114,12 @@ Property detail
Flag indicates whether this model computes temperature.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.MSISE1990.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.MSISE1990.drag_model_plugin
:type: DragModelPlugin
@@ -144,6 +162,24 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.MSISE1990.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.MSISE1990.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
+.. py:property:: stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.MSISE1990.stochastic_density_correction
+ :type: StochasticDensityCorrection
+
+ Stochastic StochasticDensity Correction.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.MSISE1990.sun_position
:type: SunPosition
@@ -156,6 +192,18 @@ Property detail
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.MSISE1990.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
+.. py:property:: use_stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.MSISE1990.use_stochastic_density_correction
+ :type: bool
+
+ True if using stochastic model for a density model correction.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.MSISE1990.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM2000.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM2000.rst
index 24cd94b7f6..0f658564e2 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM2000.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM2000.rst
@@ -32,6 +32,8 @@ Overview
- Path to the data directory.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.density_type`
- Low, mean, high or randomly perturbed density type.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.drag_model_plugin_name`
@@ -42,12 +44,22 @@ Overview
- Solar Flux (F10.7); the daily Ottawa 10.7 cm solar flux value. Dimensionless.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.namelist_file`
- Full path of namelist file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.stochastic_density_correction`
+ - Stochastic StochasticDensity Correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.sun_position`
- Get or set the sun position computation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.use_stochastic_density_correction`
+ - True if using stochastic model for a density model correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.variable_area_history_file`
- Drag variable area history file.
@@ -100,6 +112,12 @@ Property detail
Low, mean, high or randomly perturbed density type.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.drag_model_plugin
:type: DragModelPlugin
@@ -130,12 +148,30 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
.. py:property:: namelist_file
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.namelist_file
:type: str
Full path of namelist file.
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
+.. py:property:: stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.stochastic_density_correction
+ :type: StochasticDensityCorrection
+
+ Stochastic StochasticDensity Correction.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.sun_position
:type: SunPosition
@@ -148,6 +184,18 @@ Property detail
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
+.. py:property:: use_stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.use_stochastic_density_correction
+ :type: bool
+
+ True if using stochastic model for a density model correction.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2000.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM2001.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM2001.rst
index d09fd76d6f..bef026d031 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM2001.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM2001.rst
@@ -32,6 +32,8 @@ Overview
- Path to the data directory.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.density_type`
- Low, mean, high or randomly perturbed density type.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.drag_model_plugin_name`
@@ -42,12 +44,22 @@ Overview
- Solar Flux (F10.7); the daily Ottawa 10.7 cm solar flux value. Dimensionless.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.namelist_file`
- Path to namelist file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.stochastic_density_correction`
+ - Stochastic StochasticDensity Correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.sun_position`
- Get or set the sun position computation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.use_stochastic_density_correction`
+ - True if using stochastic model for a density model correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.variable_area_history_file`
- Drag variable area history file.
@@ -100,6 +112,12 @@ Property detail
Low, mean, high or randomly perturbed density type.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.drag_model_plugin
:type: DragModelPlugin
@@ -130,12 +148,30 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
.. py:property:: namelist_file
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.namelist_file
:type: str
Path to namelist file.
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
+.. py:property:: stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.stochastic_density_correction
+ :type: StochasticDensityCorrection
+
+ Stochastic StochasticDensity Correction.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.sun_position
:type: SunPosition
@@ -148,6 +184,18 @@ Property detail
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
+.. py:property:: use_stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.use_stochastic_density_correction
+ :type: bool
+
+ True if using stochastic model for a density model correction.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2001.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM2005.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM2005.rst
index 1df8f056a3..d5e4869b0f 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM2005.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM2005.rst
@@ -32,6 +32,8 @@ Overview
- Path to the data directory.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.density_type`
- Low, mean, high or randomly perturbed density type.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.drag_model_plugin_name`
@@ -42,12 +44,22 @@ Overview
- Solar Flux (F10.7); the daily Ottawa 10.7 cm solar flux value. Dimensionless.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.namelist_file`
- Full path of namelist file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.stochastic_density_correction`
+ - Stochastic StochasticDensity Correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.sun_position`
- Get or set the sun position computation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.use_stochastic_density_correction`
+ - True if using stochastic model for a density model correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.variable_area_history_file`
- Drag variable area history file.
@@ -100,6 +112,12 @@ Property detail
Low, mean, high or randomly perturbed density type.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.drag_model_plugin
:type: DragModelPlugin
@@ -130,12 +148,30 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
.. py:property:: namelist_file
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.namelist_file
:type: str
Full path of namelist file.
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
+.. py:property:: stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.stochastic_density_correction
+ :type: StochasticDensityCorrection
+
+ Stochastic StochasticDensity Correction.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.sun_position
:type: SunPosition
@@ -148,6 +184,18 @@ Property detail
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
+.. py:property:: use_stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.use_stochastic_density_correction
+ :type: bool
+
+ True if using stochastic model for a density model correction.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2005.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM2010.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM2010.rst
index 79196686a1..2c64e28712 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM2010.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM2010.rst
@@ -32,6 +32,8 @@ Overview
- Path to the data directory.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.density_type`
- Low, mean, high or randomly perturbed density type.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.drag_model_plugin_name`
@@ -42,12 +44,22 @@ Overview
- Solar Flux (F10.7); the daily Ottawa 10.7 cm solar flux value. Dimensionless.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.namelist_file`
- Full path of namelist file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.stochastic_density_correction`
+ - Stochastic StochasticDensity Correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.sun_position`
- Get or set the sun position computation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.use_stochastic_density_correction`
+ - True if using stochastic model for a density model correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.variable_area_history_file`
- Drag variable area history file.
@@ -100,6 +112,12 @@ Property detail
Low, mean, high or randomly perturbed density type.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.drag_model_plugin
:type: DragModelPlugin
@@ -130,12 +148,30 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
.. py:property:: namelist_file
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.namelist_file
:type: str
Full path of namelist file.
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
+.. py:property:: stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.stochastic_density_correction
+ :type: StochasticDensityCorrection
+
+ Stochastic StochasticDensity Correction.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.sun_position
:type: SunPosition
@@ -148,6 +184,18 @@ Property detail
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
+.. py:property:: use_stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.use_stochastic_density_correction
+ :type: bool
+
+ True if using stochastic model for a density model correction.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM2010.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM37.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM37.rst
index a50e052eba..d9467acc37 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM37.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/MarsGRAM37.rst
@@ -32,6 +32,8 @@ Overview
- Path to the data directory.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM37.density_type`
- Low, mean or high density type.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM37.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM37.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM37.drag_model_plugin_name`
@@ -42,12 +44,22 @@ Overview
- Solar Flux (F10.7); the daily Ottawa 10.7 cm solar flux value. Dimensionless.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM37.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM37.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM37.namelist_file`
- Full path of namelist file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM37.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM37.stochastic_density_correction`
+ - Stochastic StochasticDensity Correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM37.sun_position`
- Get or set the sun position computation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM37.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM37.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM37.use_stochastic_density_correction`
+ - True if using stochastic model for a density model correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.MarsGRAM37.variable_area_history_file`
- Drag variable area history file.
@@ -100,6 +112,12 @@ Property detail
Low, mean or high density type.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM37.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM37.drag_model_plugin
:type: DragModelPlugin
@@ -130,12 +148,30 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM37.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
.. py:property:: namelist_file
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM37.namelist_file
:type: str
Full path of namelist file.
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM37.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
+.. py:property:: stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM37.stochastic_density_correction
+ :type: StochasticDensityCorrection
+
+ Stochastic StochasticDensity Correction.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM37.sun_position
:type: SunPosition
@@ -148,6 +184,18 @@ Property detail
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM37.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
+.. py:property:: use_stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM37.use_stochastic_density_correction
+ :type: bool
+
+ True if using stochastic model for a density model correction.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.MarsGRAM37.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/NPlateStochasticCorrectionParameter.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/NPlateStochasticCorrectionParameter.rst
new file mode 100644
index 0000000000..e3462e58ab
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/NPlateStochasticCorrectionParameter.rst
@@ -0,0 +1,59 @@
+NPlateStochasticCorrectionParameter
+===================================
+
+.. py:class:: ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParameter
+
+ NPlate Stochastic Correction Parameter definition.
+
+.. py:currentmodule:: NPlateStochasticCorrectionParameter
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Properties
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParameter.initial_estimate`
+ - Initial Error Estimat.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParameter.long_term_initial_estimate`
+ - Long Term Initial Error Estimate
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParameter.name`
+ - NPlate Stochastic Correction Parameter name.
+
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects.astrogator import NPlateStochasticCorrectionParameter
+
+
+Property detail
+---------------
+
+.. py:property:: initial_estimate
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParameter.initial_estimate
+ :type: float
+
+ Initial Error Estimat.
+
+.. py:property:: long_term_initial_estimate
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParameter.long_term_initial_estimate
+ :type: float
+
+ Long Term Initial Error Estimate
+
+.. py:property:: name
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParameter.name
+ :type: str
+
+ NPlate Stochastic Correction Parameter name.
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/NPlateStochasticCorrectionParametersCollection.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/NPlateStochasticCorrectionParametersCollection.rst
new file mode 100644
index 0000000000..dc248dbc31
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/NPlateStochasticCorrectionParametersCollection.rst
@@ -0,0 +1,111 @@
+NPlateStochasticCorrectionParametersCollection
+==============================================
+
+.. py:class:: ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParametersCollection
+
+ NPlate Stochastic Correction Parameter Collection.
+
+.. py:currentmodule:: NPlateStochasticCorrectionParametersCollection
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Methods
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParametersCollection.get_item_by_index`
+ - Retrieve an associated object from the collection by index.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParametersCollection.get_item_by_name`
+ - Retrieve an associated object from the collection by name.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParametersCollection.item`
+ - Iterate through the collection.
+
+ .. tab-item:: Properties
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParametersCollection._new_enum`
+ - A property that allows you to enumerate through the collection.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParametersCollection.count`
+ - Get the number of associated objects in the set.
+
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects.astrogator import NPlateStochasticCorrectionParametersCollection
+
+
+Property detail
+---------------
+
+.. py:property:: _new_enum
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParametersCollection._new_enum
+ :type: EnumeratorProxy
+
+ A property that allows you to enumerate through the collection.
+
+.. py:property:: count
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParametersCollection.count
+ :type: int
+
+ Get the number of associated objects in the set.
+
+
+Method detail
+-------------
+
+
+.. py:method:: get_item_by_index(self, index: int) -> NPlateStochasticCorrectionParameter
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParametersCollection.get_item_by_index
+
+ Retrieve an associated object from the collection by index.
+
+ :Parameters:
+
+ **index** : :obj:`~int`
+
+
+ :Returns:
+
+ :obj:`~NPlateStochasticCorrectionParameter`
+
+.. py:method:: get_item_by_name(self, name: str) -> NPlateStochasticCorrectionParameter
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParametersCollection.get_item_by_name
+
+ Retrieve an associated object from the collection by name.
+
+ :Parameters:
+
+ **name** : :obj:`~str`
+
+
+ :Returns:
+
+ :obj:`~NPlateStochasticCorrectionParameter`
+
+.. py:method:: item(self, index_or_name: typing.Any) -> NPlateStochasticCorrectionParameter
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticCorrectionParametersCollection.item
+
+ Iterate through the collection.
+
+ :Parameters:
+
+ **index_or_name** : :obj:`~typing.Any`
+
+
+ :Returns:
+
+ :obj:`~NPlateStochasticCorrectionParameter`
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/NPlateStochasticParameter.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/NPlateStochasticParameter.rst
new file mode 100644
index 0000000000..eaa63de1e6
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/NPlateStochasticParameter.rst
@@ -0,0 +1,83 @@
+NPlateStochasticParameter
+=========================
+
+.. py:class:: ansys.stk.core.stkobjects.astrogator.NPlateStochasticParameter
+
+ NPlate Stochastic Parameter definition.
+
+.. py:currentmodule:: NPlateStochasticParameter
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Properties
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticParameter.estimate_parameter`
+ - True if estimating this parameter.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticParameter.half_life`
+ - Half life of the parameter.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticParameter.long_term_sigma`
+ - Long term Sigma value for the parameter.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticParameter.name`
+ - NPlate Stochastic Parameter name.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticParameter.nominal_value`
+ - Nominal Value for this N-Plate group.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticParameter.sigma`
+ - Sigma value for the parameter.
+
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects.astrogator import NPlateStochasticParameter
+
+
+Property detail
+---------------
+
+.. py:property:: estimate_parameter
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticParameter.estimate_parameter
+ :type: bool
+
+ True if estimating this parameter.
+
+.. py:property:: half_life
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticParameter.half_life
+ :type: float
+
+ Half life of the parameter.
+
+.. py:property:: long_term_sigma
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticParameter.long_term_sigma
+ :type: float
+
+ Long term Sigma value for the parameter.
+
+.. py:property:: name
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticParameter.name
+ :type: str
+
+ NPlate Stochastic Parameter name.
+
+.. py:property:: nominal_value
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticParameter.nominal_value
+ :type: float
+
+ Nominal Value for this N-Plate group.
+
+.. py:property:: sigma
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticParameter.sigma
+ :type: float
+
+ Sigma value for the parameter.
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/NPlateStochasticParametersCollection.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/NPlateStochasticParametersCollection.rst
new file mode 100644
index 0000000000..6c545b5e02
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/NPlateStochasticParametersCollection.rst
@@ -0,0 +1,111 @@
+NPlateStochasticParametersCollection
+====================================
+
+.. py:class:: ansys.stk.core.stkobjects.astrogator.NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameter Collection.
+
+.. py:currentmodule:: NPlateStochasticParametersCollection
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Methods
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticParametersCollection.get_item_by_index`
+ - Retrieve an associated object from the collection by index.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticParametersCollection.get_item_by_name`
+ - Retrieve an associated object from the collection by name.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticParametersCollection.item`
+ - Iterate through the collection.
+
+ .. tab-item:: Properties
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticParametersCollection._new_enum`
+ - A property that allows you to enumerate through the collection.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NPlateStochasticParametersCollection.count`
+ - Get the number of associated objects in the set.
+
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects.astrogator import NPlateStochasticParametersCollection
+
+
+Property detail
+---------------
+
+.. py:property:: _new_enum
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticParametersCollection._new_enum
+ :type: EnumeratorProxy
+
+ A property that allows you to enumerate through the collection.
+
+.. py:property:: count
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticParametersCollection.count
+ :type: int
+
+ Get the number of associated objects in the set.
+
+
+Method detail
+-------------
+
+
+.. py:method:: get_item_by_index(self, index: int) -> NPlateStochasticParameter
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticParametersCollection.get_item_by_index
+
+ Retrieve an associated object from the collection by index.
+
+ :Parameters:
+
+ **index** : :obj:`~int`
+
+
+ :Returns:
+
+ :obj:`~NPlateStochasticParameter`
+
+.. py:method:: get_item_by_name(self, name: str) -> NPlateStochasticParameter
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticParametersCollection.get_item_by_name
+
+ Retrieve an associated object from the collection by name.
+
+ :Parameters:
+
+ **name** : :obj:`~str`
+
+
+ :Returns:
+
+ :obj:`~NPlateStochasticParameter`
+
+.. py:method:: item(self, index_or_name: typing.Any) -> NPlateStochasticParameter
+ :canonical: ansys.stk.core.stkobjects.astrogator.NPlateStochasticParametersCollection.item
+
+ Iterate through the collection.
+
+ :Parameters:
+
+ **index_or_name** : :obj:`~typing.Any`
+
+
+ :Returns:
+
+ :obj:`~NPlateStochasticParameter`
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/NRLMSISE2000.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/NRLMSISE2000.rst
index e6883d6671..c2a9282ce8 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/NRLMSISE2000.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/NRLMSISE2000.rst
@@ -32,6 +32,8 @@ Overview
- Flag indicates whether this model computes pressure.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.computes_temperature`
- Flag indicates whether this model computes temperature.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.drag_model_plugin_name`
@@ -46,10 +48,20 @@ Overview
- Geomagnetic Index (Kp). Dimensionless.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.stochastic_density_correction`
+ - Stochastic StochasticDensity Correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.sun_position`
- Get or set the sun position computation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.use_stochastic_density_correction`
+ - True if using stochastic model for a density model correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.variable_area_history_file`
- Drag variable area history file.
@@ -102,6 +114,12 @@ Property detail
Flag indicates whether this model computes temperature.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.drag_model_plugin
:type: DragModelPlugin
@@ -144,6 +162,24 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
+.. py:property:: stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.stochastic_density_correction
+ :type: StochasticDensityCorrection
+
+ Stochastic StochasticDensity Correction.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.sun_position
:type: SunPosition
@@ -156,6 +192,18 @@ Property detail
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
+.. py:property:: use_stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.use_stochastic_density_correction
+ :type: bool
+
+ True if using stochastic model for a density model correction.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.NRLMSISE2000.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/NumericalIntegrator.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/NumericalIntegrator.rst
index 9a8f02bd61..ba392b0678 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/NumericalIntegrator.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/NumericalIntegrator.rst
@@ -19,9 +19,6 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~RUNGE_KUTTA_4TH_ADAPT`
- - A 4th order Runge-Kutta integrator, adapting step size by comparing one full step to two half steps. Although this technique can be quite slow compared to the other algorithms, it is very common and can be used for comparison.
-
* - :py:attr:`~RUNGE_KUTTA_FEHLBERG_7TH_8TH`
- A 7th order Runge-Kutta-Fehlberg integrator with 8th order error control. This is the default integrator used in the HPOP propagator.
@@ -34,9 +31,6 @@ Overview
* - :py:attr:`~GAUSS_JACKSON`
- A 12th order Gauss-Jackson integrator for second order ODEs. There is currently no error control implemented for this method, meaning that a fixed step size is used.
- * - :py:attr:`~RUNGE_KUTTA_2ND_3RD`
- - A 2nd order Runge-Kutta integrator with 3rd order error control, using Bogacki and Shampine coefficients.
-
* - :py:attr:`~RUNGE_KUTTA_4TH_5TH`
- A 4th order Runge-Kutta integrator with 5th order error control, using Cash-Karp coefficients.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/PointMassFunction.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/PointMassFunction.rst
index 46556a09a0..fdb16344f6 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/PointMassFunction.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/PointMassFunction.rst
@@ -40,7 +40,7 @@ Property detail
.. py:property:: gravitational_parameter_source
:canonical: ansys.stk.core.stkobjects.astrogator.PointMassFunction.gravitational_parameter_source
- :type: GravParamSource
+ :type: GravParameterSource
Get or set the source for the third body's gravitational parameter.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/RadiationPressureFunction.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/RadiationPressureFunction.rst
index c0109eb111..c820a8c9ad 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/RadiationPressureFunction.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/RadiationPressureFunction.rst
@@ -28,12 +28,6 @@ Overview
- True if including accelerations derived from albedo (reflected sunlight radiation from the central body).
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RadiationPressureFunction.include_thermal_radiation_pressure`
- True if including accelerations derived from thermal radiation pressure from the central body.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RadiationPressureFunction.override_segment_settings`
- - Do not use this property, as it is deprecated. True to use Ck and area values defined on this component for radiation pressure computations, rather than those defined in the MCS segments.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RadiationPressureFunction.radiation_pressure_area`
- - Do not use this property, as it is deprecated. Area to be used for radiation pressure computations. Small area dimension.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RadiationPressureFunction.radiation_pressure_coefficient`
- - Do not use this property, as it is deprecated. Coefficient, Ck, for use with radiation pressure computation.
@@ -72,22 +66,4 @@ Property detail
True if including accelerations derived from thermal radiation pressure from the central body.
-.. py:property:: override_segment_settings
- :canonical: ansys.stk.core.stkobjects.astrogator.RadiationPressureFunction.override_segment_settings
- :type: bool
-
- Do not use this property, as it is deprecated. True to use Ck and area values defined on this component for radiation pressure computations, rather than those defined in the MCS segments.
-
-.. py:property:: radiation_pressure_area
- :canonical: ansys.stk.core.stkobjects.astrogator.RadiationPressureFunction.radiation_pressure_area
- :type: float
-
- Do not use this property, as it is deprecated. Area to be used for radiation pressure computations. Small area dimension.
-
-.. py:property:: radiation_pressure_coefficient
- :canonical: ansys.stk.core.stkobjects.astrogator.RadiationPressureFunction.radiation_pressure_coefficient
- :type: float
-
- Do not use this property, as it is deprecated. Coefficient, Ck, for use with radiation pressure computation.
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/RungeKutta2nd3rd.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/RungeKutta2nd3rd.rst
deleted file mode 100644
index 4e7eb54375..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/RungeKutta2nd3rd.rst
+++ /dev/null
@@ -1,133 +0,0 @@
-RungeKutta2nd3rd
-================
-
-.. py:class:: ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd
-
- Bases: :py:class:`~ansys.stk.core.stkobjects.astrogator.INumericalIntegrator`
-
- RK2nd3rd Numerical Integrator.
-
-.. py:currentmodule:: RungeKutta2nd3rd
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Properties
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.error_control`
- - Get or set the error control method.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.high_safety_coefficient`
- - Get or set the 'safety' coefficient used to decrease step size if the error is too high. Dimensionless.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.initial_step`
- - Get or set the initial step. Uses time dimension.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.low_safety_coefficient`
- - Get or set the 'safety' coefficient used to increase step size if the error is too low. Dimensionless.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.max_absolute_err`
- - Get or set the maximum absolute error; Also used if relative scale is too small. Dimensionless.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.max_iterations`
- - Get or set the maximum iterations. Dimensionless.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.max_relative_err`
- - Get or set the maximum relative error used to control step size. Dimensionless.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.max_step`
- - Get or set the maximum step size to allow (absolute value). Uses Time Dimension.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.min_step`
- - Get or set the minimum step size to allow (absolute value). Uses Time Dimension.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.use_fixed_step`
- - True if running in fixed-step mode.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.use_max_step`
- - Whether or not to enforce the maximum step.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.use_min_step`
- - Whether or not to enforce the minimum step.
-
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects.astrogator import RungeKutta2nd3rd
-
-
-Property detail
----------------
-
-.. py:property:: error_control
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.error_control
- :type: ErrorControl
-
- Get or set the error control method.
-
-.. py:property:: high_safety_coefficient
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.high_safety_coefficient
- :type: float
-
- Get or set the 'safety' coefficient used to decrease step size if the error is too high. Dimensionless.
-
-.. py:property:: initial_step
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.initial_step
- :type: float
-
- Get or set the initial step. Uses time dimension.
-
-.. py:property:: low_safety_coefficient
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.low_safety_coefficient
- :type: float
-
- Get or set the 'safety' coefficient used to increase step size if the error is too low. Dimensionless.
-
-.. py:property:: max_absolute_err
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.max_absolute_err
- :type: float
-
- Get or set the maximum absolute error; Also used if relative scale is too small. Dimensionless.
-
-.. py:property:: max_iterations
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.max_iterations
- :type: int
-
- Get or set the maximum iterations. Dimensionless.
-
-.. py:property:: max_relative_err
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.max_relative_err
- :type: float
-
- Get or set the maximum relative error used to control step size. Dimensionless.
-
-.. py:property:: max_step
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.max_step
- :type: float
-
- Get or set the maximum step size to allow (absolute value). Uses Time Dimension.
-
-.. py:property:: min_step
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.min_step
- :type: float
-
- Get or set the minimum step size to allow (absolute value). Uses Time Dimension.
-
-.. py:property:: use_fixed_step
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.use_fixed_step
- :type: bool
-
- True if running in fixed-step mode.
-
-.. py:property:: use_max_step
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.use_max_step
- :type: bool
-
- Whether or not to enforce the maximum step.
-
-.. py:property:: use_min_step
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta2nd3rd.use_min_step
- :type: bool
-
- Whether or not to enforce the minimum step.
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/RungeKutta4thAdapt.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/RungeKutta4thAdapt.rst
deleted file mode 100644
index fdcb4bbc02..0000000000
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/RungeKutta4thAdapt.rst
+++ /dev/null
@@ -1,133 +0,0 @@
-RungeKutta4thAdapt
-==================
-
-.. py:class:: ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt
-
- Bases: :py:class:`~ansys.stk.core.stkobjects.astrogator.INumericalIntegrator`
-
- RK4thAdapt Numerical Integrator.
-
-.. py:currentmodule:: RungeKutta4thAdapt
-
-Overview
---------
-
-.. tab-set::
-
- .. tab-item:: Properties
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.error_control`
- - Get or set the error control method.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.high_safety_coefficient`
- - Get or set the 'safety' coefficient used to decrease step size if the error is too high. Dimensionless.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.initial_step`
- - Get or set the initial step. Uses time dimension.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.low_safety_coefficient`
- - Get or set the 'safety' coefficient used to increase step size if the error is too low. Dimensionless.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.max_absolute_err`
- - Get or set the maximum absolute error; Also used if relative scale is too small. Dimensionless.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.max_iterations`
- - Get or set the maximum iterations. Dimensionless.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.max_relative_err`
- - Get or set the maximum relative error used to control step size. Dimensionless.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.max_step`
- - Get or set the maximum step size to allow (absolute value). Uses Time Dimension.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.min_step`
- - Get or set the minimum step size to allow (absolute value). Uses Time Dimension.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.use_fixed_step`
- - True if running in fixed-step mode.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.use_max_step`
- - Whether or not to enforce the maximum step.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.use_min_step`
- - Whether or not to enforce the minimum step.
-
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.stkobjects.astrogator import RungeKutta4thAdapt
-
-
-Property detail
----------------
-
-.. py:property:: error_control
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.error_control
- :type: ErrorControl
-
- Get or set the error control method.
-
-.. py:property:: high_safety_coefficient
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.high_safety_coefficient
- :type: float
-
- Get or set the 'safety' coefficient used to decrease step size if the error is too high. Dimensionless.
-
-.. py:property:: initial_step
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.initial_step
- :type: float
-
- Get or set the initial step. Uses time dimension.
-
-.. py:property:: low_safety_coefficient
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.low_safety_coefficient
- :type: float
-
- Get or set the 'safety' coefficient used to increase step size if the error is too low. Dimensionless.
-
-.. py:property:: max_absolute_err
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.max_absolute_err
- :type: float
-
- Get or set the maximum absolute error; Also used if relative scale is too small. Dimensionless.
-
-.. py:property:: max_iterations
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.max_iterations
- :type: int
-
- Get or set the maximum iterations. Dimensionless.
-
-.. py:property:: max_relative_err
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.max_relative_err
- :type: float
-
- Get or set the maximum relative error used to control step size. Dimensionless.
-
-.. py:property:: max_step
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.max_step
- :type: float
-
- Get or set the maximum step size to allow (absolute value). Uses Time Dimension.
-
-.. py:property:: min_step
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.min_step
- :type: float
-
- Get or set the minimum step size to allow (absolute value). Uses Time Dimension.
-
-.. py:property:: use_fixed_step
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.use_fixed_step
- :type: bool
-
- True if running in fixed-step mode.
-
-.. py:property:: use_max_step
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.use_max_step
- :type: bool
-
- Whether or not to enforce the maximum step.
-
-.. py:property:: use_min_step
- :canonical: ansys.stk.core.stkobjects.astrogator.RungeKutta4thAdapt.use_min_step
- :type: bool
-
- Whether or not to enforce the minimum step.
-
-
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/RungeKuttaV8th9th.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/RungeKuttaV8th9th.rst
index 7605517b70..2ac4b5c43f 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/RungeKuttaV8th9th.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/RungeKuttaV8th9th.rst
@@ -62,7 +62,7 @@ Property detail
.. py:property:: coefficient_type
:canonical: ansys.stk.core.stkobjects.astrogator.RungeKuttaV8th9th.coefficient_type
- :type: CoeffRungeKuttaV8th9th
+ :type: CoefficientRungeKuttaV8th9th
Get or set the set of coefficients to use.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPAerospaceT20.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPAerospaceT20.rst
index c2e4cf979d..ba5baa4e1e 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPAerospaceT20.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPAerospaceT20.rst
@@ -26,12 +26,18 @@ Overview
- Other eclipsing bodies.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPAerospaceT20.include_boundary_mitigation`
- True if shadow boundary mitigation should be performed; the state of the satellite after crossing a shadow boundary will be corrected for errors possibly caused by the sudden change in SRP which occurred during the integration step.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPAerospaceT20.k1_stochastic_srp_coefficient`
+ - K1 Stochastic SRP Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPAerospaceT20.k2_stochastic_srp_coefficient`
+ - K2 Stochastic SRP Coefficient.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPAerospaceT20.shadow_model`
- Get or set the shadow model type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPAerospaceT20.solar_radius`
- Get or set the solar radius value to use in eclipse calculations. Uses Distance Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPAerospaceT20.sun_position`
- Get or set the sun position computation.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPAerospaceT20.use_stochastic_srp_coefficient`
+ - True if using a stochastic SRP for propagation or estimation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPAerospaceT20.use_sun_central_body_file_values`
- True if solar radius should come from the Sun.cb file.
@@ -66,6 +72,18 @@ Property detail
True if shadow boundary mitigation should be performed; the state of the satellite after crossing a shadow boundary will be corrected for errors possibly caused by the sudden change in SRP which occurred during the integration step.
+.. py:property:: k1_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPAerospaceT20.k1_stochastic_srp_coefficient
+ :type: StochasticModelParameters
+
+ K1 Stochastic SRP Coefficient.
+
+.. py:property:: k2_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPAerospaceT20.k2_stochastic_srp_coefficient
+ :type: StochasticModelParameters
+
+ K2 Stochastic SRP Coefficient.
+
.. py:property:: shadow_model
:canonical: ansys.stk.core.stkobjects.astrogator.SRPAerospaceT20.shadow_model
:type: ShadowModel
@@ -84,6 +102,12 @@ Property detail
Get or set the sun position computation.
+.. py:property:: use_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPAerospaceT20.use_stochastic_srp_coefficient
+ :type: bool
+
+ True if using a stochastic SRP for propagation or estimation.
+
.. py:property:: use_sun_central_body_file_values
:canonical: ansys.stk.core.stkobjects.astrogator.SRPAerospaceT20.use_sun_central_body_file_values
:type: bool
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPAerospaceT30.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPAerospaceT30.rst
index 743c66d435..75e9ea92b6 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPAerospaceT30.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPAerospaceT30.rst
@@ -26,12 +26,18 @@ Overview
- Other eclipsing bodies.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPAerospaceT30.include_boundary_mitigation`
- True if shadow boundary mitigation should be performed; the state of the satellite after crossing a shadow boundary will be corrected for errors possibly caused by the sudden change in SRP which occurred during the integration step.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPAerospaceT30.k1_stochastic_srp_coefficient`
+ - K1 Stochastic SRP Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPAerospaceT30.k2_stochastic_srp_coefficient`
+ - K2 Stochastic SRP Coefficient.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPAerospaceT30.shadow_model`
- Get or set the shadow model type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPAerospaceT30.solar_radius`
- Get or set the solar radius value to use in eclipse calculations. Uses Distance Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPAerospaceT30.sun_position`
- Get or set the sun position computation.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPAerospaceT30.use_stochastic_srp_coefficient`
+ - True if using a stochastic SRP for propagation or estimation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPAerospaceT30.use_sun_central_body_file_values`
- True if solar radius should come from the Sun.cb file.
@@ -66,6 +72,18 @@ Property detail
True if shadow boundary mitigation should be performed; the state of the satellite after crossing a shadow boundary will be corrected for errors possibly caused by the sudden change in SRP which occurred during the integration step.
+.. py:property:: k1_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPAerospaceT30.k1_stochastic_srp_coefficient
+ :type: StochasticModelParameters
+
+ K1 Stochastic SRP Coefficient.
+
+.. py:property:: k2_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPAerospaceT30.k2_stochastic_srp_coefficient
+ :type: StochasticModelParameters
+
+ K2 Stochastic SRP Coefficient.
+
.. py:property:: shadow_model
:canonical: ansys.stk.core.stkobjects.astrogator.SRPAerospaceT30.shadow_model
:type: ShadowModel
@@ -84,6 +102,12 @@ Property detail
Get or set the sun position computation.
+.. py:property:: use_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPAerospaceT30.use_stochastic_srp_coefficient
+ :type: bool
+
+ True if using a stochastic SRP for propagation or estimation.
+
.. py:property:: use_sun_central_body_file_values
:canonical: ansys.stk.core.stkobjects.astrogator.SRPAerospaceT30.use_sun_central_body_file_values
:type: bool
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPCorrectionType.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPCorrectionType.rst
new file mode 100644
index 0000000000..93d2df04f0
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPCorrectionType.rst
@@ -0,0 +1,42 @@
+SRPCorrectionType
+=================
+
+.. py:class:: ansys.stk.core.stkobjects.astrogator.SRPCorrectionType
+
+ IntEnum
+
+
+.. py:currentmodule:: SRPCorrectionType
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Members
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~CR_A_OVER_M_RELATIVE`
+ - Relative correction to CrA/M.
+
+ * - :py:attr:`~CR_A_OVER_M_ADDITIVE`
+ - Additive correction to CrA/M.
+
+ * - :py:attr:`~CR_RELATIVE`
+ - Relative correction to Cr.
+
+ * - :py:attr:`~CR_ADDITIVE`
+ - Additive correction to Cr.
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects.astrogator import SRPCorrectionType
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPGSPM04aIIA.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPGSPM04aIIA.rst
index 6a3e64b2ff..f4d8fdaaee 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPGSPM04aIIA.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPGSPM04aIIA.rst
@@ -26,12 +26,18 @@ Overview
- Other eclipsing bodies.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIA.include_boundary_mitigation`
- True if shadow boundary mitigation should be performed; the state of the satellite after crossing a shadow boundary will be corrected for errors possibly caused by the sudden change in SRP which occurred during the integration step.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIA.k1_stochastic_srp_coefficient`
+ - K1 Stochastic SRP Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIA.k2_stochastic_srp_coefficient`
+ - K2 Stochastic SRP Coefficient.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIA.shadow_model`
- Get or set the shadow model type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIA.solar_radius`
- Get or set the solar radius value to use in eclipse calculations. Uses Distance Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIA.sun_position`
- Get or set the sun position computation.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIA.use_stochastic_srp_coefficient`
+ - True if using a stochastic SRP for propagation or estimation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIA.use_sun_central_body_file_values`
- True if solar radius should come from the Sun.cb file.
@@ -66,6 +72,18 @@ Property detail
True if shadow boundary mitigation should be performed; the state of the satellite after crossing a shadow boundary will be corrected for errors possibly caused by the sudden change in SRP which occurred during the integration step.
+.. py:property:: k1_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIA.k1_stochastic_srp_coefficient
+ :type: StochasticModelParameters
+
+ K1 Stochastic SRP Coefficient.
+
+.. py:property:: k2_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIA.k2_stochastic_srp_coefficient
+ :type: StochasticModelParameters
+
+ K2 Stochastic SRP Coefficient.
+
.. py:property:: shadow_model
:canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIA.shadow_model
:type: ShadowModel
@@ -84,6 +102,12 @@ Property detail
Get or set the sun position computation.
+.. py:property:: use_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIA.use_stochastic_srp_coefficient
+ :type: bool
+
+ True if using a stochastic SRP for propagation or estimation.
+
.. py:property:: use_sun_central_body_file_values
:canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIA.use_sun_central_body_file_values
:type: bool
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPGSPM04aIIR.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPGSPM04aIIR.rst
index a25ce9d4fc..171b72cd7c 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPGSPM04aIIR.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPGSPM04aIIR.rst
@@ -26,12 +26,18 @@ Overview
- Other eclipsing bodies.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIR.include_boundary_mitigation`
- True if shadow boundary mitigation should be performed; the state of the satellite after crossing a shadow boundary will be corrected for errors possibly caused by the sudden change in SRP which occurred during the integration step.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIR.k1_stochastic_srp_coefficient`
+ - K1 Stochastic SRP Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIR.k2_stochastic_srp_coefficient`
+ - K2 Stochastic SRP Coefficient.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIR.shadow_model`
- Get or set the shadow model type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIR.solar_radius`
- Get or set the solar radius value to use in eclipse calculations. Uses Distance Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIR.sun_position`
- Get or set the sun position computation.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIR.use_stochastic_srp_coefficient`
+ - True if using a stochastic SRP for propagation or estimation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIR.use_sun_central_body_file_values`
- True if solar radius should come from the Sun.cb file.
@@ -66,6 +72,18 @@ Property detail
True if shadow boundary mitigation should be performed; the state of the satellite after crossing a shadow boundary will be corrected for errors possibly caused by the sudden change in SRP which occurred during the integration step.
+.. py:property:: k1_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIR.k1_stochastic_srp_coefficient
+ :type: StochasticModelParameters
+
+ K1 Stochastic SRP Coefficient.
+
+.. py:property:: k2_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIR.k2_stochastic_srp_coefficient
+ :type: StochasticModelParameters
+
+ K2 Stochastic SRP Coefficient.
+
.. py:property:: shadow_model
:canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIR.shadow_model
:type: ShadowModel
@@ -84,6 +102,12 @@ Property detail
Get or set the sun position computation.
+.. py:property:: use_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIR.use_stochastic_srp_coefficient
+ :type: bool
+
+ True if using a stochastic SRP for propagation or estimation.
+
.. py:property:: use_sun_central_body_file_values
:canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aIIR.use_sun_central_body_file_values
:type: bool
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPGSPM04aeIIA.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPGSPM04aeIIA.rst
index a85ecffd3a..77df04eef9 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPGSPM04aeIIA.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPGSPM04aeIIA.rst
@@ -26,12 +26,18 @@ Overview
- Other eclipsing bodies.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIA.include_boundary_mitigation`
- True if shadow boundary mitigation should be performed; the state of the satellite after crossing a shadow boundary will be corrected for errors possibly caused by the sudden change in SRP which occurred during the integration step.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIA.k1_stochastic_srp_coefficient`
+ - K1 Stochastic SRP Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIA.k2_stochastic_srp_coefficient`
+ - K2 Stochastic SRP Coefficient.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIA.shadow_model`
- Get or set the shadow model type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIA.solar_radius`
- Get or set the solar radius value to use in eclipse calculations. Uses Distance Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIA.sun_position`
- Get or set the sun position computation.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIA.use_stochastic_srp_coefficient`
+ - True if using a stochastic SRP for propagation or estimation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIA.use_sun_central_body_file_values`
- True if solar radius should come from the Sun.cb file.
@@ -66,6 +72,18 @@ Property detail
True if shadow boundary mitigation should be performed; the state of the satellite after crossing a shadow boundary will be corrected for errors possibly caused by the sudden change in SRP which occurred during the integration step.
+.. py:property:: k1_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIA.k1_stochastic_srp_coefficient
+ :type: StochasticModelParameters
+
+ K1 Stochastic SRP Coefficient.
+
+.. py:property:: k2_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIA.k2_stochastic_srp_coefficient
+ :type: StochasticModelParameters
+
+ K2 Stochastic SRP Coefficient.
+
.. py:property:: shadow_model
:canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIA.shadow_model
:type: ShadowModel
@@ -84,6 +102,12 @@ Property detail
Get or set the sun position computation.
+.. py:property:: use_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIA.use_stochastic_srp_coefficient
+ :type: bool
+
+ True if using a stochastic SRP for propagation or estimation.
+
.. py:property:: use_sun_central_body_file_values
:canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIA.use_sun_central_body_file_values
:type: bool
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPGSPM04aeIIR.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPGSPM04aeIIR.rst
index 271d7404ab..6f434213ba 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPGSPM04aeIIR.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPGSPM04aeIIR.rst
@@ -26,12 +26,18 @@ Overview
- Other eclipsing bodies.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIR.include_boundary_mitigation`
- True if shadow boundary mitigation should be performed; the state of the satellite after crossing a shadow boundary will be corrected for errors possibly caused by the sudden change in SRP which occurred during the integration step.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIR.k1_stochastic_srp_coefficient`
+ - K1 Stochastic SRP Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIR.k2_stochastic_srp_coefficient`
+ - K2 Stochastic SRP Coefficient.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIR.shadow_model`
- Get or set the shadow model type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIR.solar_radius`
- Get or set the solar radius value to use in eclipse calculations. Uses Distance Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIR.sun_position`
- Get or set the sun position computation.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIR.use_stochastic_srp_coefficient`
+ - True if using a stochastic SRP for propagation or estimation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIR.use_sun_central_body_file_values`
- True if solar radius should come from the Sun.cb file.
@@ -66,6 +72,18 @@ Property detail
True if shadow boundary mitigation should be performed; the state of the satellite after crossing a shadow boundary will be corrected for errors possibly caused by the sudden change in SRP which occurred during the integration step.
+.. py:property:: k1_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIR.k1_stochastic_srp_coefficient
+ :type: StochasticModelParameters
+
+ K1 Stochastic SRP Coefficient.
+
+.. py:property:: k2_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIR.k2_stochastic_srp_coefficient
+ :type: StochasticModelParameters
+
+ K2 Stochastic SRP Coefficient.
+
.. py:property:: shadow_model
:canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIR.shadow_model
:type: ShadowModel
@@ -84,6 +102,12 @@ Property detail
Get or set the sun position computation.
+.. py:property:: use_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIR.use_stochastic_srp_coefficient
+ :type: bool
+
+ True if using a stochastic SRP for propagation or estimation.
+
.. py:property:: use_sun_central_body_file_values
:canonical: ansys.stk.core.stkobjects.astrogator.SRPGSPM04aeIIR.use_sun_central_body_file_values
:type: bool
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPNPlate.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPNPlate.rst
index 82be1da349..702d089eaf 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPNPlate.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPNPlate.rst
@@ -32,6 +32,8 @@ Overview
- Get or set the mean solar flux at 1 au (W/m^2).
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPNPlate.n_plate_definition_file`
- Full path of NPlate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPNPlate.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPNPlate.shadow_model`
- Get or set the shadow model type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPNPlate.solar_force_method`
@@ -40,6 +42,8 @@ Overview
- Get or set the solar radius value to use in eclipse calculations. Uses Distance Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPNPlate.sun_position`
- Get or set the sun position computation.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPNPlate.use_stochastic_srp_coefficient`
+ - True if using a stochastic SRP for propagation or estimation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPNPlate.use_sun_central_body_file_values`
- True if solar values should come from the Sun.cb file.
@@ -92,6 +96,12 @@ Property detail
Full path of NPlate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPNPlate.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
.. py:property:: shadow_model
:canonical: ansys.stk.core.stkobjects.astrogator.SRPNPlate.shadow_model
:type: ShadowModel
@@ -116,6 +126,12 @@ Property detail
Get or set the sun position computation.
+.. py:property:: use_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPNPlate.use_stochastic_srp_coefficient
+ :type: bool
+
+ True if using a stochastic SRP for propagation or estimation.
+
.. py:property:: use_sun_central_body_file_values
:canonical: ansys.stk.core.stkobjects.astrogator.SRPNPlate.use_sun_central_body_file_values
:type: bool
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPReflectionPlugin.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPReflectionPlugin.rst
index 5237ed51d9..7b43512dd2 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPReflectionPlugin.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPReflectionPlugin.rst
@@ -36,6 +36,8 @@ Overview
- Get the solar radius value to use in eclipse calculations. Uses Distance Dimension.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPReflectionPlugin.sun_position`
- Get or set the sun position computation.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPReflectionPlugin.use_stochastic_srp_coefficient`
+ - True if using a stochastic SRP for propagation or estimation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPReflectionPlugin.use_sun_central_body_file_values`
- True if solar values should come from the Sun.cb file.
@@ -100,6 +102,12 @@ Property detail
Get or set the sun position computation.
+.. py:property:: use_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPReflectionPlugin.use_stochastic_srp_coefficient
+ :type: bool
+
+ True if using a stochastic SRP for propagation or estimation.
+
.. py:property:: use_sun_central_body_file_values
:canonical: ansys.stk.core.stkobjects.astrogator.SRPReflectionPlugin.use_sun_central_body_file_values
:type: bool
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPSpherical.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPSpherical.rst
index 1dcf1c0c47..97bf3521cd 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPSpherical.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPSpherical.rst
@@ -36,8 +36,14 @@ Overview
- Get or set the solar force method.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPSpherical.solar_radius`
- Get or set the solar radius value to use in eclipse calculations. Uses Distance Dimension.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPSpherical.srp_correction_type`
+ - Get or set the SRP correction type.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPSpherical.stochastic_srp_coefficient`
+ - Stochastic SRP Coefficient.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPSpherical.sun_position`
- Get or set the sun position computation.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPSpherical.use_stochastic_srp_coefficient`
+ - True if using a stochastic SRP for propagation or estimation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPSpherical.use_sun_central_body_file_values`
- True if solar values should come from the Sun.cb file.
@@ -102,12 +108,30 @@ Property detail
Get or set the solar radius value to use in eclipse calculations. Uses Distance Dimension.
+.. py:property:: srp_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPSpherical.srp_correction_type
+ :type: SRPCorrectionType
+
+ Get or set the SRP correction type.
+
+.. py:property:: stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPSpherical.stochastic_srp_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic SRP Coefficient.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.SRPSpherical.sun_position
:type: SunPosition
Get or set the sun position computation.
+.. py:property:: use_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPSpherical.use_stochastic_srp_coefficient
+ :type: bool
+
+ True if using a stochastic SRP for propagation or estimation.
+
.. py:property:: use_sun_central_body_file_values
:canonical: ansys.stk.core.stkobjects.astrogator.SRPSpherical.use_sun_central_body_file_values
:type: bool
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPTabulatedAreaVector.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPTabulatedAreaVector.rst
index ad2327b84d..769d544e66 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPTabulatedAreaVector.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPTabulatedAreaVector.rst
@@ -38,10 +38,14 @@ Overview
- Get or set the solar force method.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPTabulatedAreaVector.solar_radius`
- Get or set the solar radius value to use in eclipse calculations. Uses Distance Dimension.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPTabulatedAreaVector.stochastic_srp_coefficient`
+ - Stochastic SRP Coefficient.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPTabulatedAreaVector.sun_position`
- Get or set the sun position computation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPTabulatedAreaVector.tab_area_vector_definition_file`
- Full path of the tabulated area vector definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPTabulatedAreaVector.use_stochastic_srp_coefficient`
+ - True if using a stochastic SRP for propagation or estimation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPTabulatedAreaVector.use_sun_central_body_file_values`
- True if solar values should come from the Sun.cb file.
@@ -112,6 +116,12 @@ Property detail
Get or set the solar radius value to use in eclipse calculations. Uses Distance Dimension.
+.. py:property:: stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPTabulatedAreaVector.stochastic_srp_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic SRP Coefficient.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.SRPTabulatedAreaVector.sun_position
:type: SunPosition
@@ -124,6 +134,12 @@ Property detail
Full path of the tabulated area vector definition file.
+.. py:property:: use_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPTabulatedAreaVector.use_stochastic_srp_coefficient
+ :type: bool
+
+ True if using a stochastic SRP for propagation or estimation.
+
.. py:property:: use_sun_central_body_file_values
:canonical: ansys.stk.core.stkobjects.astrogator.SRPTabulatedAreaVector.use_sun_central_body_file_values
:type: bool
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPVariableArea.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPVariableArea.rst
index 5d6d664662..f9c28169a7 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPVariableArea.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/SRPVariableArea.rst
@@ -36,8 +36,12 @@ Overview
- Get or set the solar force method.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPVariableArea.solar_radius`
- Get or set the solar radius value to use in eclipse calculations. Uses Distance Dimension.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPVariableArea.stochastic_srp_coefficient`
+ - Stochastic SRP Coefficient.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPVariableArea.sun_position`
- Get or set the sun position computation.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPVariableArea.use_stochastic_srp_coefficient`
+ - True if using a stochastic SRP for propagation or estimation.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPVariableArea.use_sun_central_body_file_values`
- True if solar values should come from the Sun.cb file.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.SRPVariableArea.variable_area_history_file`
@@ -104,12 +108,24 @@ Property detail
Get or set the solar radius value to use in eclipse calculations. Uses Distance Dimension.
+.. py:property:: stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPVariableArea.stochastic_srp_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic SRP Coefficient.
+
.. py:property:: sun_position
:canonical: ansys.stk.core.stkobjects.astrogator.SRPVariableArea.sun_position
:type: SunPosition
Get or set the sun position computation.
+.. py:property:: use_stochastic_srp_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.SRPVariableArea.use_stochastic_srp_coefficient
+ :type: bool
+
+ True if using a stochastic SRP for propagation or estimation.
+
.. py:property:: use_sun_central_body_file_values
:canonical: ansys.stk.core.stkobjects.astrogator.SRPVariableArea.use_sun_central_body_file_values
:type: bool
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/StateCalcGravCoeff.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/StateCalcGravCoefficient.rst
similarity index 79%
rename from doc/source/api/ansys/stk/core/stkobjects/astrogator/StateCalcGravCoeff.rst
rename to doc/source/api/ansys/stk/core/stkobjects/astrogator/StateCalcGravCoefficient.rst
index 0a6e8db165..3326be4108 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/StateCalcGravCoeff.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/StateCalcGravCoefficient.rst
@@ -1,13 +1,13 @@
-StateCalcGravCoeff
-==================
+StateCalcGravCoefficient
+========================
-.. py:class:: ansys.stk.core.stkobjects.astrogator.StateCalcGravCoeff
+.. py:class:: ansys.stk.core.stkobjects.astrogator.StateCalcGravCoefficient
Bases: :py:class:`~ansys.stk.core.stkobjects.astrogator.IComponentInfo`, :py:class:`~ansys.stk.core.stkobjects.astrogator.ICloneable`
Gravity Coefficient Calc objects.
-.. py:currentmodule:: StateCalcGravCoeff
+.. py:currentmodule:: StateCalcGravCoefficient
Overview
--------
@@ -20,17 +20,17 @@ Overview
:header-rows: 0
:widths: auto
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateCalcGravCoeff.central_body_name`
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateCalcGravCoefficient.central_body_name`
- Get or set the central body of the component.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateCalcGravCoeff.coefficient_type`
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateCalcGravCoefficient.coefficient_type`
- Coefficient type.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateCalcGravCoeff.degree`
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateCalcGravCoefficient.degree`
- Degree of the coefficient.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateCalcGravCoeff.gravity_filename`
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateCalcGravCoefficient.gravity_filename`
- Source for the gravity coefficient.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateCalcGravCoeff.normalization_type`
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateCalcGravCoefficient.normalization_type`
- Normalization type.
- * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateCalcGravCoeff.order`
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateCalcGravCoefficient.order`
- Order of the coefficient.
@@ -40,44 +40,44 @@ Import detail
.. code-block:: python
- from ansys.stk.core.stkobjects.astrogator import StateCalcGravCoeff
+ from ansys.stk.core.stkobjects.astrogator import StateCalcGravCoefficient
Property detail
---------------
.. py:property:: central_body_name
- :canonical: ansys.stk.core.stkobjects.astrogator.StateCalcGravCoeff.central_body_name
+ :canonical: ansys.stk.core.stkobjects.astrogator.StateCalcGravCoefficient.central_body_name
:type: str
Get or set the central body of the component.
.. py:property:: coefficient_type
- :canonical: ansys.stk.core.stkobjects.astrogator.StateCalcGravCoeff.coefficient_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.StateCalcGravCoefficient.coefficient_type
:type: GravityCoefficientType
Coefficient type.
.. py:property:: degree
- :canonical: ansys.stk.core.stkobjects.astrogator.StateCalcGravCoeff.degree
+ :canonical: ansys.stk.core.stkobjects.astrogator.StateCalcGravCoefficient.degree
:type: int
Degree of the coefficient.
.. py:property:: gravity_filename
- :canonical: ansys.stk.core.stkobjects.astrogator.StateCalcGravCoeff.gravity_filename
+ :canonical: ansys.stk.core.stkobjects.astrogator.StateCalcGravCoefficient.gravity_filename
:type: str
Source for the gravity coefficient.
.. py:property:: normalization_type
- :canonical: ansys.stk.core.stkobjects.astrogator.StateCalcGravCoeff.normalization_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.StateCalcGravCoefficient.normalization_type
:type: GravityCoefficientNormalizationType
Normalization type.
.. py:property:: order
- :canonical: ansys.stk.core.stkobjects.astrogator.StateCalcGravCoeff.order
+ :canonical: ansys.stk.core.stkobjects.astrogator.StateCalcGravCoefficient.order
:type: int
Order of the coefficient.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/StateConfig.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/StateConfig.rst
new file mode 100644
index 0000000000..7d5fa0992e
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/StateConfig.rst
@@ -0,0 +1,59 @@
+StateConfig
+===========
+
+.. py:class:: ansys.stk.core.stkobjects.astrogator.StateConfig
+
+ State config. property.
+
+.. py:currentmodule:: StateConfig
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Properties
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateConfig.description`
+ - State config. property description
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateConfig.name`
+ - State config. property name
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateConfig.value`
+ - State config. property value
+
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects.astrogator import StateConfig
+
+
+Property detail
+---------------
+
+.. py:property:: description
+ :canonical: ansys.stk.core.stkobjects.astrogator.StateConfig.description
+ :type: str
+
+ State config. property description
+
+.. py:property:: name
+ :canonical: ansys.stk.core.stkobjects.astrogator.StateConfig.name
+ :type: str
+
+ State config. property name
+
+.. py:property:: value
+ :canonical: ansys.stk.core.stkobjects.astrogator.StateConfig.value
+ :type: typing.Any
+
+ State config. property value
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/StateConfigCollection.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/StateConfigCollection.rst
new file mode 100644
index 0000000000..1cde35794b
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/StateConfigCollection.rst
@@ -0,0 +1,111 @@
+StateConfigCollection
+=====================
+
+.. py:class:: ansys.stk.core.stkobjects.astrogator.StateConfigCollection
+
+ State config. properties Collection.
+
+.. py:currentmodule:: StateConfigCollection
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Methods
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateConfigCollection.get_item_by_index`
+ - Retrieve a state config property in the collection by index.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateConfigCollection.get_item_by_name`
+ - Retrieve a state config property in the collection by name.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateConfigCollection.item`
+ - Allow you to iterate through the collection.
+
+ .. tab-item:: Properties
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateConfigCollection._new_enum`
+ - Allow you to enumerate through the collection.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StateConfigCollection.count`
+ - Return the size of the collection.
+
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects.astrogator import StateConfigCollection
+
+
+Property detail
+---------------
+
+.. py:property:: _new_enum
+ :canonical: ansys.stk.core.stkobjects.astrogator.StateConfigCollection._new_enum
+ :type: EnumeratorProxy
+
+ Allow you to enumerate through the collection.
+
+.. py:property:: count
+ :canonical: ansys.stk.core.stkobjects.astrogator.StateConfigCollection.count
+ :type: int
+
+ Return the size of the collection.
+
+
+Method detail
+-------------
+
+
+.. py:method:: get_item_by_index(self, index: int) -> StateConfig
+ :canonical: ansys.stk.core.stkobjects.astrogator.StateConfigCollection.get_item_by_index
+
+ Retrieve a state config property in the collection by index.
+
+ :Parameters:
+
+ **index** : :obj:`~int`
+
+
+ :Returns:
+
+ :obj:`~StateConfig`
+
+.. py:method:: get_item_by_name(self, name: str) -> StateConfig
+ :canonical: ansys.stk.core.stkobjects.astrogator.StateConfigCollection.get_item_by_name
+
+ Retrieve a state config property in the collection by name.
+
+ :Parameters:
+
+ **name** : :obj:`~str`
+
+
+ :Returns:
+
+ :obj:`~StateConfig`
+
+.. py:method:: item(self, index_or_name: typing.Any) -> StateConfig
+ :canonical: ansys.stk.core.stkobjects.astrogator.StateConfigCollection.item
+
+ Allow you to iterate through the collection.
+
+ :Parameters:
+
+ **index_or_name** : :obj:`~typing.Any`
+
+
+ :Returns:
+
+ :obj:`~StateConfig`
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/StochasticDensityCorrection.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/StochasticDensityCorrection.rst
new file mode 100644
index 0000000000..4d038bd187
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/StochasticDensityCorrection.rst
@@ -0,0 +1,75 @@
+StochasticDensityCorrection
+===========================
+
+.. py:class:: ansys.stk.core.stkobjects.astrogator.StochasticDensityCorrection
+
+ Properties for Stochastic Density Correction.
+
+.. py:currentmodule:: StochasticDensityCorrection
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Properties
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticDensityCorrection.density_increase_threshold`
+ - Open density gain when density ratio increases by this amount.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticDensityCorrection.density_ratio_root`
+ - Mapping of density uncertainty goes as K^(1/n).
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticDensityCorrection.half_life`
+ - Density Correction Half-life.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticDensityCorrection.sigma`
+ - Uncertainty in relative density at periapsis for non-Earth atmospheres.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticDensityCorrection.sigma_scale`
+ - Scale Factor for Density Correction Sigma.
+
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects.astrogator import StochasticDensityCorrection
+
+
+Property detail
+---------------
+
+.. py:property:: density_increase_threshold
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticDensityCorrection.density_increase_threshold
+ :type: float
+
+ Open density gain when density ratio increases by this amount.
+
+.. py:property:: density_ratio_root
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticDensityCorrection.density_ratio_root
+ :type: float
+
+ Mapping of density uncertainty goes as K^(1/n).
+
+.. py:property:: half_life
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticDensityCorrection.half_life
+ :type: float
+
+ Density Correction Half-life.
+
+.. py:property:: sigma
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticDensityCorrection.sigma
+ :type: float
+
+ Uncertainty in relative density at periapsis for non-Earth atmospheres.
+
+.. py:property:: sigma_scale
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticDensityCorrection.sigma_scale
+ :type: float
+
+ Scale Factor for Density Correction Sigma.
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/StochasticModel.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/StochasticModel.rst
new file mode 100644
index 0000000000..9f0f8f4dd6
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/StochasticModel.rst
@@ -0,0 +1,39 @@
+StochasticModel
+===============
+
+.. py:class:: ansys.stk.core.stkobjects.astrogator.StochasticModel
+
+ IntEnum
+
+
+.. py:currentmodule:: StochasticModel
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Members
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~GAUSS_MARKOV`
+ - Gauss Markov Stochastic Model.
+
+ * - :py:attr:`~RANDOM_WALK`
+ - Random Walk Stochastic Model.
+
+ * - :py:attr:`~VASICEK`
+ - Vasicek Stochastic Model.
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects.astrogator import StochasticModel
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/StochasticModelParameters.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/StochasticModelParameters.rst
new file mode 100644
index 0000000000..777fe94835
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/StochasticModelParameters.rst
@@ -0,0 +1,91 @@
+StochasticModelParameters
+=========================
+
+.. py:class:: ansys.stk.core.stkobjects.astrogator.StochasticModelParameters
+
+ Properties for Stochastic Model Parameters.
+
+.. py:currentmodule:: StochasticModelParameters
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Properties
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticModelParameters.diffusion_coefficient`
+ - Determine the amount of process noise to be added to state covariance used in the Random Walk model.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticModelParameters.error_threshold`
+ - Covariance floor for long term mean used in the Vasicek model.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticModelParameters.half_life`
+ - Half life value for Gauss Markov stochastic process.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticModelParameters.model_type`
+ - Type of stochastic model used for SRP correction.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticModelParameters.process_noise_step`
+ - Process noise step when minimum floor is hit used in the Vasicek model.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticModelParameters.sigma`
+ - Root variance of the initial error in the nominal value.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticModelParameters.sigma_long_term`
+ - Root variance of the initial error in the long term constant value used in the Vasicek model.
+
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects.astrogator import StochasticModelParameters
+
+
+Property detail
+---------------
+
+.. py:property:: diffusion_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticModelParameters.diffusion_coefficient
+ :type: float
+
+ Determine the amount of process noise to be added to state covariance used in the Random Walk model.
+
+.. py:property:: error_threshold
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticModelParameters.error_threshold
+ :type: float
+
+ Covariance floor for long term mean used in the Vasicek model.
+
+.. py:property:: half_life
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticModelParameters.half_life
+ :type: float
+
+ Half life value for Gauss Markov stochastic process.
+
+.. py:property:: model_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticModelParameters.model_type
+ :type: StochasticModel
+
+ Type of stochastic model used for SRP correction.
+
+.. py:property:: process_noise_step
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticModelParameters.process_noise_step
+ :type: float
+
+ Process noise step when minimum floor is hit used in the Vasicek model.
+
+.. py:property:: sigma
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticModelParameters.sigma
+ :type: float
+
+ Root variance of the initial error in the nominal value.
+
+.. py:property:: sigma_long_term
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticModelParameters.sigma_long_term
+ :type: float
+
+ Root variance of the initial error in the long term constant value used in the Vasicek model.
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/StochasticParameters.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/StochasticParameters.rst
new file mode 100644
index 0000000000..0bc6491f83
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/StochasticParameters.rst
@@ -0,0 +1,109 @@
+StochasticParameters
+====================
+
+.. py:class:: ansys.stk.core.stkobjects.astrogator.StochasticParameters
+
+ Bases: :py:class:`~ansys.stk.core.stkobjects.astrogator.IRuntimeTypeInfoProvider`
+
+ Stochastic Parameters.
+
+.. py:currentmodule:: StochasticParameters
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Properties
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticParameters.ballistic_coefficient`
+ - Get the ballistic coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticParameters.cr_a_over_m`
+ - Get the Cr A / M
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticParameters.density_model_initial_correction`
+ - Get or set the density model initial correction.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticParameters.drag_initial_correction`
+ - Get or set the drag initial correction.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticParameters.drag_long_term_initial_correction`
+ - Get or set the drag long term initial correction.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticParameters.drag_n_plate_stochastic_correction_parameters`
+ - Drag NPlate Stochastic Correction Parameters.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticParameters.srp_initial_correction`
+ - Get or set the Solar Radiation Pressure initial correction.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticParameters.srp_long_term_initial_correction`
+ - Get or set the Solar Radiation Pressure long term initial correction.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.StochasticParameters.srp_n_plate_stochastic_correction_parameters`
+ - SRP NPlate Stochastic Correction Parameters.
+
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.stkobjects.astrogator import StochasticParameters
+
+
+Property detail
+---------------
+
+.. py:property:: ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticParameters.ballistic_coefficient
+ :type: float
+
+ Get the ballistic coefficient.
+
+.. py:property:: cr_a_over_m
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticParameters.cr_a_over_m
+ :type: float
+
+ Get the Cr A / M
+
+.. py:property:: density_model_initial_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticParameters.density_model_initial_correction
+ :type: float
+
+ Get or set the density model initial correction.
+
+.. py:property:: drag_initial_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticParameters.drag_initial_correction
+ :type: float
+
+ Get or set the drag initial correction.
+
+.. py:property:: drag_long_term_initial_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticParameters.drag_long_term_initial_correction
+ :type: float
+
+ Get or set the drag long term initial correction.
+
+.. py:property:: drag_n_plate_stochastic_correction_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticParameters.drag_n_plate_stochastic_correction_parameters
+ :type: NPlateStochasticCorrectionParametersCollection
+
+ Drag NPlate Stochastic Correction Parameters.
+
+.. py:property:: srp_initial_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticParameters.srp_initial_correction
+ :type: float
+
+ Get or set the Solar Radiation Pressure initial correction.
+
+.. py:property:: srp_long_term_initial_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticParameters.srp_long_term_initial_correction
+ :type: float
+
+ Get or set the Solar Radiation Pressure long term initial correction.
+
+.. py:property:: srp_n_plate_stochastic_correction_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.StochasticParameters.srp_n_plate_stochastic_correction_parameters
+ :type: NPlateStochasticCorrectionParametersCollection
+
+ SRP NPlate Stochastic Correction Parameters.
+
+
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/TwoBodyFunction.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/TwoBodyFunction.rst
index 38ed9c3d5a..0af2c7949a 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/TwoBodyFunction.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/TwoBodyFunction.rst
@@ -42,7 +42,7 @@ Property detail
.. py:property:: gravitational_parameter_source
:canonical: ansys.stk.core.stkobjects.astrogator.TwoBodyFunction.gravitational_parameter_source
- :type: GravParamSource
+ :type: GravParameterSource
Get or set the source for the gravitational parameter.
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/USStandardAtmosphere.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/USStandardAtmosphere.rst
index ec479427d7..141d6b5f97 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/USStandardAtmosphere.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/USStandardAtmosphere.rst
@@ -24,6 +24,8 @@ Overview
- Flag indicates whether this model computes pressure.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.USStandardAtmosphere.computes_temperature`
- Flag indicates whether this model computes temperature.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.USStandardAtmosphere.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.USStandardAtmosphere.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.USStandardAtmosphere.drag_model_plugin_name`
@@ -32,8 +34,14 @@ Overview
- Drag model type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.USStandardAtmosphere.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.USStandardAtmosphere.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.USStandardAtmosphere.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.USStandardAtmosphere.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.USStandardAtmosphere.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.USStandardAtmosphere.variable_area_history_file`
- Drag variable area history file.
@@ -62,6 +70,12 @@ Property detail
Flag indicates whether this model computes temperature.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.USStandardAtmosphere.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.USStandardAtmosphere.drag_model_plugin
:type: DragModelPlugin
@@ -86,12 +100,30 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.USStandardAtmosphere.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.USStandardAtmosphere.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
.. py:property:: use_approximate_altitude
:canonical: ansys.stk.core.stkobjects.astrogator.USStandardAtmosphere.use_approximate_altitude
:type: bool
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.USStandardAtmosphere.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.USStandardAtmosphere.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/UpdateParam.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/UpdateParameter.rst
similarity index 93%
rename from doc/source/api/ansys/stk/core/stkobjects/astrogator/UpdateParam.rst
rename to doc/source/api/ansys/stk/core/stkobjects/astrogator/UpdateParameter.rst
index 8b61607018..63c767f020 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/UpdateParam.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/UpdateParameter.rst
@@ -1,12 +1,12 @@
-UpdateParam
-===========
+UpdateParameter
+===============
-.. py:class:: ansys.stk.core.stkobjects.astrogator.UpdateParam
+.. py:class:: ansys.stk.core.stkobjects.astrogator.UpdateParameter
IntEnum
-.. py:currentmodule:: UpdateParam
+.. py:currentmodule:: UpdateParameter
Overview
--------
@@ -58,6 +58,6 @@ Import detail
.. code-block:: python
- from ansys.stk.core.stkobjects.astrogator import UpdateParam
+ from ansys.stk.core.stkobjects.astrogator import UpdateParameter
diff --git a/doc/source/api/ansys/stk/core/stkobjects/astrogator/VenusGRAM2005.rst b/doc/source/api/ansys/stk/core/stkobjects/astrogator/VenusGRAM2005.rst
index 35cd9a2c0f..eb7e94dcb1 100644
--- a/doc/source/api/ansys/stk/core/stkobjects/astrogator/VenusGRAM2005.rst
+++ b/doc/source/api/ansys/stk/core/stkobjects/astrogator/VenusGRAM2005.rst
@@ -28,6 +28,8 @@ Overview
- Path to the data directory.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.density_type`
- Low, mean, high or randomly perturbed density type.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.drag_correction_type`
+ - Drag correction type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.drag_model_plugin`
- Drag model plugin properties.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.drag_model_plugin_name`
@@ -36,10 +38,20 @@ Overview
- Drag model type.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.n_plate_definition_file`
- Drag N-Plate definition file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.n_plate_stochastic_parameters`
+ - NPlate Stochastic Parameters.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.namelist_file`
- Full path of namelist file.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.stochastic_ballistic_coefficient`
+ - Stochastic Ballistic Coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.stochastic_density_correction`
+ - Stochastic StochasticDensity Correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.use_approximate_altitude`
- True if using approximate altitude formula.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.use_stochastic_ballistic_coefficient`
+ - True if using stochastic model for ballistic coefficient.
+ * - :py:attr:`~ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.use_stochastic_density_correction`
+ - True if using stochastic model for a density model correction.
* - :py:attr:`~ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.variable_area_history_file`
- Drag variable area history file.
@@ -80,6 +92,12 @@ Property detail
Low, mean, high or randomly perturbed density type.
+.. py:property:: drag_correction_type
+ :canonical: ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.drag_correction_type
+ :type: DragCorrectionType
+
+ Drag correction type.
+
.. py:property:: drag_model_plugin
:canonical: ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.drag_model_plugin
:type: DragModelPlugin
@@ -104,18 +122,48 @@ Property detail
Drag N-Plate definition file.
+.. py:property:: n_plate_stochastic_parameters
+ :canonical: ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.n_plate_stochastic_parameters
+ :type: NPlateStochasticParametersCollection
+
+ NPlate Stochastic Parameters.
+
.. py:property:: namelist_file
:canonical: ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.namelist_file
:type: str
Full path of namelist file.
+.. py:property:: stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.stochastic_ballistic_coefficient
+ :type: StochasticModelParameters
+
+ Stochastic Ballistic Coefficient.
+
+.. py:property:: stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.stochastic_density_correction
+ :type: StochasticDensityCorrection
+
+ Stochastic StochasticDensity Correction.
+
.. py:property:: use_approximate_altitude
:canonical: ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.use_approximate_altitude
:type: bool
True if using approximate altitude formula.
+.. py:property:: use_stochastic_ballistic_coefficient
+ :canonical: ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.use_stochastic_ballistic_coefficient
+ :type: bool
+
+ True if using stochastic model for ballistic coefficient.
+
+.. py:property:: use_stochastic_density_correction
+ :canonical: ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.use_stochastic_density_correction
+ :type: bool
+
+ True if using stochastic model for a density model correction.
+
.. py:property:: variable_area_history_file
:canonical: ansys.stk.core.stkobjects.astrogator.VenusGRAM2005.variable_area_history_file
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkrfchannelmodeler/Extent.rst b/doc/source/api/ansys/stk/core/stkrfchannelmodeler/Extent.rst
index 0bfa8058d0..f8c21014d1 100644
--- a/doc/source/api/ansys/stk/core/stkrfchannelmodeler/Extent.rst
+++ b/doc/source/api/ansys/stk/core/stkrfchannelmodeler/Extent.rst
@@ -12,6 +12,15 @@ Overview
.. tab-set::
+ .. tab-item:: Methods
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.Extent.set_extent_values`
+ - Set the extent values in degrees
+
.. tab-item:: Properties
.. list-table::
@@ -65,3 +74,34 @@ Property detail
Get or set the west longitude.
+Method detail
+-------------
+
+
+
+
+
+.. py:method:: set_extent_values(self, north: float, south: float, east: float, west: float) -> None
+ :canonical: ansys.stk.core.stkrfchannelmodeler.Extent.set_extent_values
+
+ Set the extent values in degrees
+
+ :Parameters:
+
+ **north** : :obj:`~float`
+
+ **south** : :obj:`~float`
+
+ **east** : :obj:`~float`
+
+ **west** : :obj:`~float`
+
+
+ :Returns:
+
+ :obj:`~None`
+
+
+
+
+
diff --git a/doc/source/api/ansys/stk/core/stkrfchannelmodeler/FrequencyPulseResponse.rst b/doc/source/api/ansys/stk/core/stkrfchannelmodeler/FrequencyPulseResponse.rst
index 6c995ca1ed..53b3d89782 100644
--- a/doc/source/api/ansys/stk/core/stkrfchannelmodeler/FrequencyPulseResponse.rst
+++ b/doc/source/api/ansys/stk/core/stkrfchannelmodeler/FrequencyPulseResponse.rst
@@ -20,6 +20,8 @@ Overview
:header-rows: 0
:widths: auto
+ * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.FrequencyPulseResponse.data_dimensions`
+ - Get the dimensions of the data. The dimensions are ordered in {Transmit Antenna Count, Receive Antenna Count, Pulse Count, Frequency Sample Count, Complex Number (imaginary and real)}.
* - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.FrequencyPulseResponse.frequency_sample_count`
- Get the frequency sample count.
* - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.FrequencyPulseResponse.pulse_count`
@@ -38,6 +40,12 @@ Import detail
Property detail
---------------
+.. py:property:: data_dimensions
+ :canonical: ansys.stk.core.stkrfchannelmodeler.FrequencyPulseResponse.data_dimensions
+ :type: list
+
+ Get the dimensions of the data. The dimensions are ordered in {Transmit Antenna Count, Receive Antenna Count, Pulse Count, Frequency Sample Count, Complex Number (imaginary and real)}.
+
.. py:property:: frequency_sample_count
:canonical: ansys.stk.core.stkrfchannelmodeler.FrequencyPulseResponse.frequency_sample_count
:type: int
diff --git a/doc/source/api/ansys/stk/core/stkrfchannelmodeler/IResponse.rst b/doc/source/api/ansys/stk/core/stkrfchannelmodeler/IResponse.rst
index d6a19ee67c..085d0aece1 100644
--- a/doc/source/api/ansys/stk/core/stkrfchannelmodeler/IResponse.rst
+++ b/doc/source/api/ansys/stk/core/stkrfchannelmodeler/IResponse.rst
@@ -19,7 +19,7 @@ Overview
:widths: auto
* - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.IResponse.data`
- - Get the response data.
+ - Get the response data in a single dimension. Reshape to a multi-dimensional array using the DataDimensions property from the derived response class.
* - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.IResponse.receive_antenna_count`
- Get the receive antenna count.
* - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.IResponse.transmit_antenna_count`
@@ -43,7 +43,7 @@ Property detail
:canonical: ansys.stk.core.stkrfchannelmodeler.IResponse.data
:type: list
- Get the response data.
+ Get the response data in a single dimension. Reshape to a multi-dimensional array using the DataDimensions property from the derived response class.
.. py:property:: receive_antenna_count
:canonical: ansys.stk.core.stkrfchannelmodeler.IResponse.receive_antenna_count
diff --git a/doc/source/api/ansys/stk/core/stkrfchannelmodeler/Material.rst b/doc/source/api/ansys/stk/core/stkrfchannelmodeler/Material.rst
index a4fd004c2e..d8f17e7cc3 100644
--- a/doc/source/api/ansys/stk/core/stkrfchannelmodeler/Material.rst
+++ b/doc/source/api/ansys/stk/core/stkrfchannelmodeler/Material.rst
@@ -18,8 +18,12 @@ Overview
:header-rows: 0
:widths: auto
+ * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.Material.height_standard_deviation`
+ - Get or set the material height standard deviation
* - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.Material.properties`
- Get material properties.
+ * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.Material.roughness`
+ - Get or set the material roughness
* - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.Material.type`
- Get material type.
@@ -36,12 +40,24 @@ Import detail
Property detail
---------------
+.. py:property:: height_standard_deviation
+ :canonical: ansys.stk.core.stkrfchannelmodeler.Material.height_standard_deviation
+ :type: float
+
+ Get or set the material height standard deviation
+
.. py:property:: properties
:canonical: ansys.stk.core.stkrfchannelmodeler.Material.properties
:type: str
Get material properties.
+.. py:property:: roughness
+ :canonical: ansys.stk.core.stkrfchannelmodeler.Material.roughness
+ :type: float
+
+ Get or set the material roughness
+
.. py:property:: type
:canonical: ansys.stk.core.stkrfchannelmodeler.Material.type
:type: str
diff --git a/doc/source/api/ansys/stk/core/stkrfchannelmodeler/RangeDopplerResponse.rst b/doc/source/api/ansys/stk/core/stkrfchannelmodeler/RangeDopplerResponse.rst
index 4607666389..67b5e26a1c 100644
--- a/doc/source/api/ansys/stk/core/stkrfchannelmodeler/RangeDopplerResponse.rst
+++ b/doc/source/api/ansys/stk/core/stkrfchannelmodeler/RangeDopplerResponse.rst
@@ -22,6 +22,8 @@ Overview
* - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.RangeDopplerResponse.angular_velocity`
- Get the angular velocity.
+ * - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.RangeDopplerResponse.data_dimensions`
+ - Get the dimensions of the data. The dimensions are ordered in {Transmit Antenna Count, Receive Antenna Count, Velocity Count, Range Count, Complex Number (imaginary and real)}.
* - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.RangeDopplerResponse.pulse_count`
- Get the pulse count.
* - :py:attr:`~ansys.stk.core.stkrfchannelmodeler.RangeDopplerResponse.range_count`
@@ -52,6 +54,12 @@ Property detail
Get the angular velocity.
+.. py:property:: data_dimensions
+ :canonical: ansys.stk.core.stkrfchannelmodeler.RangeDopplerResponse.data_dimensions
+ :type: list
+
+ Get the dimensions of the data. The dimensions are ordered in {Transmit Antenna Count, Receive Antenna Count, Velocity Count, Range Count, Complex Number (imaginary and real)}.
+
.. py:property:: pulse_count
:canonical: ansys.stk.core.stkrfchannelmodeler.RangeDopplerResponse.pulse_count
:type: int
diff --git a/doc/source/api/ansys/stk/core/stkruntime/STKRuntime.rst b/doc/source/api/ansys/stk/core/stkruntime/STKRuntime.rst
index c448cb6059..882d87a4d4 100644
--- a/doc/source/api/ansys/stk/core/stkruntime/STKRuntime.rst
+++ b/doc/source/api/ansys/stk/core/stkruntime/STKRuntime.rst
@@ -28,6 +28,8 @@ Overview
grpc_port is the integral port number that the gRPC server is using.
grpc_timeout_sec specifies the time allocated to wait for a grpc connection (seconds).
grpc_max_message_size is the maximum size in bytes that the gRPC client can receive. Set to zero to use the gRPC default.
+ grpc_channel_credentials are channel credentials to be attached to the grpc channel (most common use case: SSL credentials,
+ see https://grpc.io/docs/guides/auth/ for more information).
* - :py:attr:`~ansys.stk.core.stkruntime.STKRuntime.start_application`
- Create a new STK Runtime instance and attach to the remote host.
@@ -35,8 +37,11 @@ Overview
grpc_port is the integral port number that the gRPC server is using (valid values are integers from 0 to 65535).
grpc_timeout_sec specifies the time allocated to wait for a grpc connection (seconds).
grpc_max_message_size is the maximum size in bytes that the gRPC client can receive. Set to zero to use the gRPC default.
- Specify user_control = True to return the application to the user's control
+ user_control specifies if the application returns to the user's control
(the application remains open) after terminating the Python API connection.
+ no_graphics controls if runtime is started with or without graphics.
+ grpc_channel_credentials are channel credentials to be attached to the grpc channel (most common use case: SSL credentials,
+ see https://grpc.io/docs/guides/auth/ for more information).
Import detail
-------------
@@ -49,7 +54,7 @@ Import detail
Method detail
-------------
-.. py:method:: attach_to_application(grpc_host: str = localhost, grpc_port: int = 40704, grpc_timeout_sec: int = 60, grpc_max_message_size: int = 0) -> STKRuntimeApplication
+.. py:method:: attach_to_application(grpc_host: str = localhost, grpc_port: int = 40704, grpc_timeout_sec: int = 60, grpc_max_message_size: int = 0, grpc_channel_credentials) -> STKRuntimeApplication
:canonical: ansys.stk.core.stkruntime.STKRuntime.attach_to_application
Attach to STKRuntime.
@@ -58,6 +63,8 @@ Method detail
grpc_port is the integral port number that the gRPC server is using.
grpc_timeout_sec specifies the time allocated to wait for a grpc connection (seconds).
grpc_max_message_size is the maximum size in bytes that the gRPC client can receive. Set to zero to use the gRPC default.
+ grpc_channel_credentials are channel credentials to be attached to the grpc channel (most common use case: SSL credentials,
+ see https://grpc.io/docs/guides/auth/ for more information).
:Parameters:
@@ -74,7 +81,7 @@ Method detail
:obj:`~STKRuntimeApplication`
-.. py:method:: start_application(grpc_host: str = localhost, grpc_port: int = 40704, grpc_timeout_sec: int = 60, grpc_max_message_size: int = 0, user_control: bool = False, no_graphics: bool = True) -> STKRuntimeApplication
+.. py:method:: start_application(grpc_host: str = localhost, grpc_port: int = 40704, grpc_timeout_sec: int = 60, grpc_max_message_size: int = 0, user_control: bool = False, no_graphics: bool = True, grpc_channel_credentials) -> STKRuntimeApplication
:canonical: ansys.stk.core.stkruntime.STKRuntime.start_application
Create a new STK Runtime instance and attach to the remote host.
@@ -83,8 +90,11 @@ Method detail
grpc_port is the integral port number that the gRPC server is using (valid values are integers from 0 to 65535).
grpc_timeout_sec specifies the time allocated to wait for a grpc connection (seconds).
grpc_max_message_size is the maximum size in bytes that the gRPC client can receive. Set to zero to use the gRPC default.
- Specify user_control = True to return the application to the user's control
+ user_control specifies if the application returns to the user's control
(the application remains open) after terminating the Python API connection.
+ no_graphics controls if runtime is started with or without graphics.
+ grpc_channel_credentials are channel credentials to be attached to the grpc channel (most common use case: SSL credentials,
+ see https://grpc.io/docs/guides/auth/ for more information).
:Parameters:
diff --git a/doc/source/api/ansys/stk/core/stkx/Graphics2DControlBase.rst b/doc/source/api/ansys/stk/core/stkx/Graphics2DControlBase.rst
index 51ce1204e9..9d9f26287e 100644
--- a/doc/source/api/ansys/stk/core/stkx/Graphics2DControlBase.rst
+++ b/doc/source/api/ansys/stk/core/stkx/Graphics2DControlBase.rst
@@ -81,8 +81,6 @@ Overview
- Return/sets the background color of the control.
* - :py:attr:`~ansys.stk.core.stkx.Graphics2DControlBase.show_progress_image`
- The animated progress image type.
- * - :py:attr:`~ansys.stk.core.stkx.Graphics2DControlBase.vendor_id`
- - Do not use this property, as it is deprecated. The identifier of the vendor.
* - :py:attr:`~ansys.stk.core.stkx.Graphics2DControlBase.window_id`
- Window identifier (for Connect commands).
@@ -201,12 +199,6 @@ Property detail
The animated progress image type.
-.. py:property:: vendor_id
- :canonical: ansys.stk.core.stkx.Graphics2DControlBase.vendor_id
- :type: str
-
- Do not use this property, as it is deprecated. The identifier of the vendor.
-
.. py:property:: window_id
:canonical: ansys.stk.core.stkx.Graphics2DControlBase.window_id
:type: int
@@ -371,8 +363,6 @@ Method detail
-
-
.. py:method:: zoom_in(self) -> None
:canonical: ansys.stk.core.stkx.Graphics2DControlBase.zoom_in
diff --git a/doc/source/api/ansys/stk/core/stkx/Graphics3DControlBase.rst b/doc/source/api/ansys/stk/core/stkx/Graphics3DControlBase.rst
index 2c41d12ba4..9d58ca24a9 100644
--- a/doc/source/api/ansys/stk/core/stkx/Graphics3DControlBase.rst
+++ b/doc/source/api/ansys/stk/core/stkx/Graphics3DControlBase.rst
@@ -87,8 +87,6 @@ Overview
- Return/sets the background color of the control.
* - :py:attr:`~ansys.stk.core.stkx.Graphics3DControlBase.show_progress_image`
- The animated progress image type.
- * - :py:attr:`~ansys.stk.core.stkx.Graphics3DControlBase.vendor_id`
- - Do not use this property, as it is deprecated. The identifier of the vendor.
* - :py:attr:`~ansys.stk.core.stkx.Graphics3DControlBase.window_id`
- Window identifier (for Connect commands).
@@ -219,12 +217,6 @@ Property detail
The animated progress image type.
-.. py:property:: vendor_id
- :canonical: ansys.stk.core.stkx.Graphics3DControlBase.vendor_id
- :type: str
-
- Do not use this property, as it is deprecated. The identifier of the vendor.
-
.. py:property:: window_id
:canonical: ansys.stk.core.stkx.Graphics3DControlBase.window_id
:type: int
@@ -408,8 +400,6 @@ Method detail
-
-
.. py:method:: zoom_in(self) -> None
:canonical: ansys.stk.core.stkx.Graphics3DControlBase.zoom_in
diff --git a/doc/source/api/ansys/stk/core/stkx/GraphicsAnalysisControlBase.rst b/doc/source/api/ansys/stk/core/stkx/GraphicsAnalysisControlBase.rst
index dedafbe32e..2f7deb077e 100644
--- a/doc/source/api/ansys/stk/core/stkx/GraphicsAnalysisControlBase.rst
+++ b/doc/source/api/ansys/stk/core/stkx/GraphicsAnalysisControlBase.rst
@@ -41,8 +41,6 @@ Overview
- Get or set the splash logo graphic file to be displayed in the control.
* - :py:attr:`~ansys.stk.core.stkx.GraphicsAnalysisControlBase.ready_state`
- Return the ready state of the control.
- * - :py:attr:`~ansys.stk.core.stkx.GraphicsAnalysisControlBase.vendor_id`
- - Do not use this property, as it is deprecated. The identifier of the vendor.
* - :py:attr:`~ansys.stk.core.stkx.GraphicsAnalysisControlBase.window_id`
- Window identifier (for Connect commands).
@@ -101,12 +99,6 @@ Property detail
Return the ready state of the control.
-.. py:property:: vendor_id
- :canonical: ansys.stk.core.stkx.GraphicsAnalysisControlBase.vendor_id
- :type: str
-
- Do not use this property, as it is deprecated. The identifier of the vendor.
-
.. py:property:: window_id
:canonical: ansys.stk.core.stkx.GraphicsAnalysisControlBase.window_id
:type: int
@@ -145,5 +137,3 @@ Method detail
-
-
diff --git a/doc/source/api/ansys/stk/core/stkx/STKXApplication.rst b/doc/source/api/ansys/stk/core/stkx/STKXApplication.rst
index 790e56615a..b57d2518d7 100644
--- a/doc/source/api/ansys/stk/core/stkx/STKXApplication.rst
+++ b/doc/source/api/ansys/stk/core/stkx/STKXApplication.rst
@@ -22,8 +22,6 @@ Overview
- Send a connect command to STK X.
* - :py:attr:`~ansys.stk.core.stkx.STKXApplication.execute_multiple_commands`
- Execute multiple CONNECT actions. The method throws an exception if any of the specified commands have failed.
- * - :py:attr:`~ansys.stk.core.stkx.STKXApplication.get_licensing_report`
- - Do not use this method, as it is deprecated. Returns a formatted string that contains the license names and their states. The string is formatted as an XML document.
* - :py:attr:`~ansys.stk.core.stkx.STKXApplication.get_online_options`
- Get http proxy online options.
* - :py:attr:`~ansys.stk.core.stkx.STKXApplication.is_feature_available`
@@ -65,8 +63,6 @@ Overview
- Show the Software License Agreement dialog if not already accepted.
* - :py:attr:`~ansys.stk.core.stkx.STKXApplication.use_hook`
- Start engine with or without message hook setup (default: engine starts with message hook setup.).
- * - :py:attr:`~ansys.stk.core.stkx.STKXApplication.vendor_id`
- - Do not use this property, as it is deprecated. The identifier of the vendor.
* - :py:attr:`~ansys.stk.core.stkx.STKXApplication.version`
- Return the version number.
@@ -139,16 +135,10 @@ Property detail
.. py:property:: use_hook
:canonical: ansys.stk.core.stkx.STKXApplication.use_hook
- :type: None
+ :type: bool
Start engine with or without message hook setup (default: engine starts with message hook setup.).
-.. py:property:: vendor_id
- :canonical: ansys.stk.core.stkx.STKXApplication.vendor_id
- :type: str
-
- Do not use this property, as it is deprecated. The identifier of the vendor.
-
.. py:property:: version
:canonical: ansys.stk.core.stkx.STKXApplication.version
:type: str
@@ -195,15 +185,6 @@ Method detail
:obj:`~ExecuteMultipleCommandsResult`
-.. py:method:: get_licensing_report(self) -> str
- :canonical: ansys.stk.core.stkx.STKXApplication.get_licensing_report
-
- Do not use this method, as it is deprecated. Returns a formatted string that contains the license names and their states. The string is formatted as an XML document.
-
- :Returns:
-
- :obj:`~str`
-
.. py:method:: get_online_options(self) -> typing.Tuple[bool, str, int, str, bool]
:canonical: ansys.stk.core.stkx.STKXApplication.get_online_options
@@ -286,6 +267,7 @@ Method detail
:obj:`~None`
+
.. py:method:: use_software_renderer(self) -> None
:canonical: ansys.stk.core.stkx.STKXApplication.use_software_renderer
@@ -296,6 +278,3 @@ Method detail
:obj:`~None`
-
-
-
diff --git a/doc/source/api/ansys/stk/core/uiapplication.rst b/doc/source/api/ansys/stk/core/uiapplication.rst
index 7a85ef8ef9..088c4fb951 100644
--- a/doc/source/api/ansys/stk/core/uiapplication.rst
+++ b/doc/source/api/ansys/stk/core/uiapplication.rst
@@ -62,6 +62,9 @@ Summary
* - :py:class:`~ansys.stk.core.uiapplication.ApplicationOpenLogFileMode`
- Log file open modes.
+ * - :py:class:`~ansys.stk.core.uiapplication.PreferencesFilesMode`
+ - Specify how application should handle user preference files
+
Description
@@ -101,4 +104,5 @@ The STK UI Application library is a COM library containing classes, interfaces a
≔ ApplicationErrorCodes
≔ ApplicationLogMessageType
≔ ApplicationOpenLogFileMode
+ ≔ PreferencesFilesMode
diff --git a/doc/source/api/ansys/stk/core/uiapplication/PreferencesFilesMode.rst b/doc/source/api/ansys/stk/core/uiapplication/PreferencesFilesMode.rst
new file mode 100644
index 0000000000..835715f936
--- /dev/null
+++ b/doc/source/api/ansys/stk/core/uiapplication/PreferencesFilesMode.rst
@@ -0,0 +1,39 @@
+PreferencesFilesMode
+====================
+
+.. py:class:: ansys.stk.core.uiapplication.PreferencesFilesMode
+
+ IntEnum
+
+
+.. py:currentmodule:: PreferencesFilesMode
+
+Overview
+--------
+
+.. tab-set::
+
+ .. tab-item:: Members
+
+ .. list-table::
+ :header-rows: 0
+ :widths: auto
+
+ * - :py:attr:`~_NO_LOAD_NO_SAVE`
+ - Neither Load nor Save user preference files.
+
+ * - :py:attr:`~_LOAD_NO_SAVE`
+ - Only Load (on startup) but do not Save user preference files.
+
+ * - :py:attr:`~_LOAD_AND_SAVE`
+ - Both Load (on startup) and Save (on exit) user preference files.
+
+
+Import detail
+-------------
+
+.. code-block:: python
+
+ from ansys.stk.core.uiapplication import PreferencesFilesMode
+
+
diff --git a/doc/source/api/ansys/stk/core/uiapplication/UiApplication.rst b/doc/source/api/ansys/stk/core/uiapplication/UiApplication.rst
index e37448dfee..859001c395 100644
--- a/doc/source/api/ansys/stk/core/uiapplication/UiApplication.rst
+++ b/doc/source/api/ansys/stk/core/uiapplication/UiApplication.rst
@@ -69,6 +69,8 @@ Overview
- Return a reference to the currently loaded personality.
* - :py:attr:`~ansys.stk.core.uiapplication.UiApplication.personality2`
- Return an new instance of the root object of the STK Object Model.
+ * - :py:attr:`~ansys.stk.core.uiapplication.UiApplication.preferences_files_mode`
+ - Get or set whether to use saved user preference files.
* - :py:attr:`~ansys.stk.core.uiapplication.UiApplication.process_id`
- Get process id for the current instance.
* - :py:attr:`~ansys.stk.core.uiapplication.UiApplication.top`
@@ -168,6 +170,12 @@ Property detail
Return an new instance of the root object of the STK Object Model.
+.. py:property:: preferences_files_mode
+ :canonical: ansys.stk.core.uiapplication.UiApplication.preferences_files_mode
+ :type: PreferencesFilesMode
+
+ Get or set whether to use saved user preference files.
+
.. py:property:: process_id
:canonical: ansys.stk.core.uiapplication.UiApplication.process_id
:type: int
@@ -381,6 +389,8 @@ Method detail
+
+
.. py:method:: quit(self) -> None
:canonical: ansys.stk.core.uiapplication.UiApplication.quit
diff --git a/doc/source/api/ansys/stk/core/utilities.rst b/doc/source/api/ansys/stk/core/utilities.rst
index 57bb9318e5..8f61428d22 100644
--- a/doc/source/api/ansys/stk/core/utilities.rst
+++ b/doc/source/api/ansys/stk/core/utilities.rst
@@ -16,7 +16,6 @@ Summary
* - :py:obj:`~ansys.stk.core.utilities.colors`
* - :py:obj:`~ansys.stk.core.utilities.comobject`
- * - :py:obj:`~ansys.stk.core.utilities.exceptions`
* - :py:obj:`~ansys.stk.core.utilities.grpcutilities`
@@ -37,7 +36,6 @@ Utilities.
🗎 colors
🗎 comobject
- 🗎 exceptions
🗎 grpcutilities
diff --git a/doc/source/api/ansys/stk/core/utilities/colors.rst b/doc/source/api/ansys/stk/core/utilities/colors.rst
index 45fa5bea57..12283f94e6 100644
--- a/doc/source/api/ansys/stk/core/utilities/colors.rst
+++ b/doc/source/api/ansys/stk/core/utilities/colors.rst
@@ -15,20 +15,20 @@ Summary
:widths: auto
* - :py:class:`~ansys.stk.core.utilities.colors.Color`
- - An opaque color representation that can be used with the STK Object Model.
+ - An opaque color representation that can be used with the Object Model.
* - :py:class:`~ansys.stk.core.utilities.colors.ColorRGBA`
- - A variably translucent color representation that can be used with certain methods in the STK Object Model.
+ - A variably translucent color representation that can be used with certain methods in the Object Model.
* - :py:class:`~ansys.stk.core.utilities.colors.Colors`
- - A factory for creating Color objects that may be used with the STK object model.
+ - A factory for creating Color objects that may be used with the Object Model.
Description
-----------
-Used to communicate color information between Python and STK.
+Used to communicate color information.
Color is the color object type and Colors is the factory for creating Color objects.
diff --git a/doc/source/api/ansys/stk/core/utilities/colors/Color.rst b/doc/source/api/ansys/stk/core/utilities/colors/Color.rst
index b980e19b39..872331ffaa 100644
--- a/doc/source/api/ansys/stk/core/utilities/colors/Color.rst
+++ b/doc/source/api/ansys/stk/core/utilities/colors/Color.rst
@@ -5,7 +5,7 @@ Color
object
- An opaque color representation that can be used with the STK Object Model.
+ An opaque color representation that can be used with the Object Model.
.. py:currentmodule:: Color
diff --git a/doc/source/api/ansys/stk/core/utilities/colors/ColorRGBA.rst b/doc/source/api/ansys/stk/core/utilities/colors/ColorRGBA.rst
index 554d06b247..f5a229dbb1 100644
--- a/doc/source/api/ansys/stk/core/utilities/colors/ColorRGBA.rst
+++ b/doc/source/api/ansys/stk/core/utilities/colors/ColorRGBA.rst
@@ -5,7 +5,7 @@ ColorRGBA
object
- A variably translucent color representation that can be used with certain methods in the STK Object Model.
+ A variably translucent color representation that can be used with certain methods in the Object Model.
.. py:currentmodule:: ColorRGBA
diff --git a/doc/source/api/ansys/stk/core/utilities/colors/Colors.rst b/doc/source/api/ansys/stk/core/utilities/colors/Colors.rst
index 7c3a6cc213..e9517a4e64 100644
--- a/doc/source/api/ansys/stk/core/utilities/colors/Colors.rst
+++ b/doc/source/api/ansys/stk/core/utilities/colors/Colors.rst
@@ -5,7 +5,7 @@ Colors
object
- A factory for creating Color objects that may be used with the STK object model.
+ A factory for creating Color objects that may be used with the Object Model.
Contains factory methods and named colors.
diff --git a/doc/source/api/ansys/stk/core/utilities/comobject.rst b/doc/source/api/ansys/stk/core/utilities/comobject.rst
index cf02f9ed62..a2aa757462 100644
--- a/doc/source/api/ansys/stk/core/utilities/comobject.rst
+++ b/doc/source/api/ansys/stk/core/utilities/comobject.rst
@@ -22,7 +22,7 @@ Summary
Description
-----------
-Contains a wrapper for a raw COM object that is not part of the STK Object Model.
+Contains a wrapper for a raw COM object that is not part of the Object Model.
.. py:currentmodule:: ansys.stk.core.utilities.comobject
diff --git a/doc/source/api/ansys/stk/core/utilities/comobject/COMObject.rst b/doc/source/api/ansys/stk/core/utilities/comobject/COMObject.rst
index dc66465629..0cd0e55b47 100644
--- a/doc/source/api/ansys/stk/core/utilities/comobject/COMObject.rst
+++ b/doc/source/api/ansys/stk/core/utilities/comobject/COMObject.rst
@@ -7,7 +7,7 @@ COMObject
Holds a raw COM pointer.
- May be returned from STK if the return argument is not part of the STK Object Model.
+ May be returned from if the return argument is not part of the Object Model.
.. py:currentmodule:: COMObject
diff --git a/doc/source/api/ansys/stk/core/utilities/exceptions.rst b/doc/source/api/ansys/stk/core/utilities/exceptions.rst
deleted file mode 100644
index 1689a88ced..0000000000
--- a/doc/source/api/ansys/stk/core/utilities/exceptions.rst
+++ /dev/null
@@ -1,70 +0,0 @@
-The ``exceptions`` module
-=========================
-
-.. py:module:: ansys.stk.core.utilities.exceptions
-
-Summary
--------
-
-.. tab-set::
-
- .. tab-item:: Classes
-
- .. list-table::
- :header-rows: 0
- :widths: auto
-
- * - :py:class:`~ansys.stk.core.utilities.exceptions.GrpcUtilitiesError`
- - Raised when using gRPC utilities in an unsupported manner.
-
- * - :py:class:`~ansys.stk.core.utilities.exceptions.STKAttributeError`
- - Raised when attempting to set an unrecognized attribute within the STK API.
-
- * - :py:class:`~ansys.stk.core.utilities.exceptions.STKColorError`
- - Raised when a problem is encountered with color classes.
-
- * - :py:class:`~ansys.stk.core.utilities.exceptions.STKEventsAPIError`
- - Raised when attempting to assign to an STK Event rather than using operator += or -=.
-
- * - :py:class:`~ansys.stk.core.utilities.exceptions.STKInitializationError`
- - Raised in STKDesktop and STKEngine when unable to initialize or attach to STK.
-
- * - :py:class:`~ansys.stk.core.utilities.exceptions.STKInvalidCastError`
- - Raised when attempting to cast an object to an unsupported interface or class type.
-
- * - :py:class:`~ansys.stk.core.utilities.exceptions.STKInvalidTimerError`
- - Raised when attempting to use an engine timer that cannot be implemented.
-
- * - :py:class:`~ansys.stk.core.utilities.exceptions.STKPluginMethodNotImplementedError`
- - Raised when a plugin method is called by STK that was not implemented by the user.
-
- * - :py:class:`~ansys.stk.core.utilities.exceptions.STKRuntimeError`
- - Raised when an STK method call fails.
-
-
-
-Description
------------
-
-Contains specific exceptions that may be raised from the STK API.
-
-.. py:currentmodule:: ansys.stk.core.utilities.exceptions
-
-.. TABLE OF CONTENTS
-
-.. toctree::
- :titlesonly:
- :maxdepth: 1
- :hidden:
-
- GrpcUtilitiesError
- STKAttributeError
- STKColorError
- STKEventsAPIError
- STKInitializationError
- STKInvalidCastError
- STKInvalidTimerError
- STKPluginMethodNotImplementedError
- STKRuntimeError
-
-
diff --git a/doc/source/api/ansys/stk/core/utilities/exceptions/GrpcUtilitiesError.rst b/doc/source/api/ansys/stk/core/utilities/exceptions/GrpcUtilitiesError.rst
deleted file mode 100644
index 0bab6754df..0000000000
--- a/doc/source/api/ansys/stk/core/utilities/exceptions/GrpcUtilitiesError.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-GrpcUtilitiesError
-==================
-
-.. py:class:: ansys.stk.core.utilities.exceptions.GrpcUtilitiesError
-
- SyntaxError
-
- Raised when using gRPC utilities in an unsupported manner.
-
-.. py:currentmodule:: GrpcUtilitiesError
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.utilities.exceptions import GrpcUtilitiesError
-
-
diff --git a/doc/source/api/ansys/stk/core/utilities/exceptions/STKAttributeError.rst b/doc/source/api/ansys/stk/core/utilities/exceptions/STKAttributeError.rst
deleted file mode 100644
index d43d11830e..0000000000
--- a/doc/source/api/ansys/stk/core/utilities/exceptions/STKAttributeError.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-STKAttributeError
-=================
-
-.. py:class:: ansys.stk.core.utilities.exceptions.STKAttributeError
-
- AttributeError
-
- Raised when attempting to set an unrecognized attribute within the STK API.
-
-.. py:currentmodule:: STKAttributeError
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.utilities.exceptions import STKAttributeError
-
-
diff --git a/doc/source/api/ansys/stk/core/utilities/exceptions/STKColorError.rst b/doc/source/api/ansys/stk/core/utilities/exceptions/STKColorError.rst
deleted file mode 100644
index 2041cbfdfd..0000000000
--- a/doc/source/api/ansys/stk/core/utilities/exceptions/STKColorError.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-STKColorError
-=============
-
-.. py:class:: ansys.stk.core.utilities.exceptions.STKColorError
-
- RuntimeError
-
- Raised when a problem is encountered with color classes.
-
-.. py:currentmodule:: STKColorError
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.utilities.exceptions import STKColorError
-
-
diff --git a/doc/source/api/ansys/stk/core/utilities/exceptions/STKEventsAPIError.rst b/doc/source/api/ansys/stk/core/utilities/exceptions/STKEventsAPIError.rst
deleted file mode 100644
index 4e204bdbb2..0000000000
--- a/doc/source/api/ansys/stk/core/utilities/exceptions/STKEventsAPIError.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-STKEventsAPIError
-=================
-
-.. py:class:: ansys.stk.core.utilities.exceptions.STKEventsAPIError
-
- SyntaxError
-
- Raised when attempting to assign to an STK Event rather than using operator += or -=.
-
-.. py:currentmodule:: STKEventsAPIError
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.utilities.exceptions import STKEventsAPIError
-
-
diff --git a/doc/source/api/ansys/stk/core/utilities/exceptions/STKInitializationError.rst b/doc/source/api/ansys/stk/core/utilities/exceptions/STKInitializationError.rst
deleted file mode 100644
index 0fc65e8ab0..0000000000
--- a/doc/source/api/ansys/stk/core/utilities/exceptions/STKInitializationError.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-STKInitializationError
-======================
-
-.. py:class:: ansys.stk.core.utilities.exceptions.STKInitializationError
-
- RuntimeError
-
- Raised in STKDesktop and STKEngine when unable to initialize or attach to STK.
-
-.. py:currentmodule:: STKInitializationError
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.utilities.exceptions import STKInitializationError
-
-
diff --git a/doc/source/api/ansys/stk/core/utilities/exceptions/STKInvalidCastError.rst b/doc/source/api/ansys/stk/core/utilities/exceptions/STKInvalidCastError.rst
deleted file mode 100644
index 2a67a0c8c7..0000000000
--- a/doc/source/api/ansys/stk/core/utilities/exceptions/STKInvalidCastError.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-STKInvalidCastError
-===================
-
-.. py:class:: ansys.stk.core.utilities.exceptions.STKInvalidCastError
-
- RuntimeError
-
- Raised when attempting to cast an object to an unsupported interface or class type.
-
-.. py:currentmodule:: STKInvalidCastError
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.utilities.exceptions import STKInvalidCastError
-
-
diff --git a/doc/source/api/ansys/stk/core/utilities/exceptions/STKInvalidTimerError.rst b/doc/source/api/ansys/stk/core/utilities/exceptions/STKInvalidTimerError.rst
deleted file mode 100644
index 63491c58de..0000000000
--- a/doc/source/api/ansys/stk/core/utilities/exceptions/STKInvalidTimerError.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-STKInvalidTimerError
-====================
-
-.. py:class:: ansys.stk.core.utilities.exceptions.STKInvalidTimerError
-
- RuntimeError
-
- Raised when attempting to use an engine timer that cannot be implemented.
-
-.. py:currentmodule:: STKInvalidTimerError
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.utilities.exceptions import STKInvalidTimerError
-
-
diff --git a/doc/source/api/ansys/stk/core/utilities/exceptions/STKPluginMethodNotImplementedError.rst b/doc/source/api/ansys/stk/core/utilities/exceptions/STKPluginMethodNotImplementedError.rst
deleted file mode 100644
index a1acdbc05d..0000000000
--- a/doc/source/api/ansys/stk/core/utilities/exceptions/STKPluginMethodNotImplementedError.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-STKPluginMethodNotImplementedError
-==================================
-
-.. py:class:: ansys.stk.core.utilities.exceptions.STKPluginMethodNotImplementedError
-
- SyntaxError
-
- Raised when a plugin method is called by STK that was not implemented by the user.
-
-.. py:currentmodule:: STKPluginMethodNotImplementedError
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.utilities.exceptions import STKPluginMethodNotImplementedError
-
-
diff --git a/doc/source/api/ansys/stk/core/utilities/exceptions/STKRuntimeError.rst b/doc/source/api/ansys/stk/core/utilities/exceptions/STKRuntimeError.rst
deleted file mode 100644
index 7c12e04e9b..0000000000
--- a/doc/source/api/ansys/stk/core/utilities/exceptions/STKRuntimeError.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-STKRuntimeError
-===============
-
-.. py:class:: ansys.stk.core.utilities.exceptions.STKRuntimeError
-
- RuntimeError
-
- Raised when an STK method call fails.
-
-.. py:currentmodule:: STKRuntimeError
-
-
-Import detail
--------------
-
-.. code-block:: python
-
- from ansys.stk.core.utilities.exceptions import STKRuntimeError
-
-
diff --git a/doc/source/changelog/837.added.md b/doc/source/changelog/837.added.md
new file mode 100644
index 0000000000..b1c5fec929
--- /dev/null
+++ b/doc/source/changelog/837.added.md
@@ -0,0 +1 @@
+Switch the repo to STK 13.0.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index a87876259c..a1614b379f 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -363,7 +363,7 @@ def read_optional_dependencies_from_pyproject():
"SUPPORTED_PYTHON_VERSIONS": ["3.11", "3.12", "3.13"],
"SUPPORTED_PLATFORMS": ["windows", "ubuntu"],
"PYSTK_VERSION": version,
- "STK_VERSION": "12.10.0",
+ "STK_VERSION": "13.0.0",
}
jinja_contexts = {
diff --git a/doc/source/getting-started/prerequisites.rst b/doc/source/getting-started/prerequisites.rst
index ce79889877..ae09e6ec09 100644
--- a/doc/source/getting-started/prerequisites.rst
+++ b/doc/source/getting-started/prerequisites.rst
@@ -35,11 +35,14 @@ The STK desktop application or STK Engine must be installed and licensed on your
:header-rows: 1
* - Ansys Release
- - 2025.1
- * - STK Release
+ - STK Release
+ - PySTK Release
+ * - 2025.1
- 12.10
- * - PySTK Release
- 0.1.x
+ * - 2025.2
+ - 13.0
+ - 0.2.x
Install the STK Desktop application
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/doc/source/user-guide/code-snippets.rst b/doc/source/user-guide/code-snippets.rst
index 9782452091..89f818eeba 100644
--- a/doc/source/user-guide/code-snippets.rst
+++ b/doc/source/user-guide/code-snippets.rst
@@ -124,32 +124,6 @@ STK Objects
- :ref:`Define and compute a chain (advanced) `
- :ref:`Define and compute a chain (basic) `
- :ref:`Create a chain (on the current scenario central body) `
- Communications
- Antenna
- - :ref:`Modify antenna graphics `
- - :ref:`Modify antenna orientation and position `
- - :ref:`Modify antenna refraction `
- - :ref:`Modify antenna model type `
- - :ref:`Create a new antenna object `
- Receiver
- - :ref:`Receiver additional gain `
- - :ref:`Modify receiver filter properties `
- - :ref:`Modify receiver demodulator properties `
- - :ref:`Modify receiver system noise temperature `
- - :ref:`Modify orientation of the receiver antenna