ObjectCoverage

class ansys.stk.core.stkobjects.ObjectCoverage

Class defining object coverage.

Overview

Methods

compute	Compute the object coverage.
clear	Remove the computation on the object coverage.
clear_coverage	Clear object coverage.

Properties

data_providers	Return the object representing a list of available data providers for the object.
start_time	Get or set the start time of object coverage. Uses DateFormat Dimension.
stop_time	Get or set the stop time of object coverage. Uses DateFormat Dimension.
assets	Get the asset list collection.
figure_of_merit	Get the figure of merit on the object coverage.
access_interval	The object coverage’s access interval.
use_object_times	Use object interval times.
is_coverage_configuration_saved	Save the single-object coverage definitions when the scenario is saved to disk, if a compute has been done.

Examples

Compute Object Coverage

# Aircraft aircraft: Aircraft object
objCoverage = aircraft.object_coverage
objCoverage.assets.remove_all
objCoverage.assets.add("Satellite/MySatellite")
objCoverage.use_object_times = True
objCoverage.compute()

objCoverageFOM = objCoverage.figure_of_merit
objCoverageFOM.set_definition_type(FigureOfMeritDefinitionType.COVERAGE_TIME)
objCoverageFOM.definition.set_compute_type(FigureOfMeritCompute.TOTAL)

Import detail

from ansys.stk.core.stkobjects import ObjectCoverage

Property detail

property ObjectCoverage.data_providers: DataProviderCollection

Return the object representing a list of available data providers for the object.

property ObjectCoverage.start_time: Any

Get or set the start time of object coverage. Uses DateFormat Dimension.

property ObjectCoverage.stop_time: Any

Get or set the stop time of object coverage. Uses DateFormat Dimension.

property ObjectCoverage.assets: CoverageAssetListCollection

Get the asset list collection.

property ObjectCoverage.figure_of_merit: ObjectCoverageFigureOfMerit

Get the figure of merit on the object coverage.

property ObjectCoverage.access_interval: ITimeToolTimeIntervalSmartInterval

The object coverage’s access interval.

property ObjectCoverage.use_object_times: bool

Use object interval times.

property ObjectCoverage.is_coverage_configuration_saved: bool

Save the single-object coverage definitions when the scenario is saved to disk, if a compute has been done.

Method detail

ObjectCoverage.compute(self) → None

Compute the object coverage.

Returns:

None

ObjectCoverage.clear(self) → None

Remove the computation on the object coverage.

Returns:

None

ObjectCoverage.clear_coverage(self) → None

Clear object coverage.

Returns:

None