Access

class ansys.stk.core.stkobjects.Access

Bases: ILifetimeInformation

Class defining Access.

Overview

Methods

clear_access	Clear the access intervals, but not the definitional settings of the access object itself (like step size, light time delay settings, time interval, etc.).
compute_access	Recomputes the access between two objects. Calls to ComputeAccess should not be made between calls to BeginUpdate and EndUpdate.
remove_access	Remove the access that was computed between two objects.
specify_access_event_intervals	Access is computed using the intervals in the specified event interval list.
specify_access_intervals	Allow a list of intervals to be used for the access calculation.
specify_access_time_period	If eUserSpec is selected for AccessTimePeriod, specify the start and stop times for the user-defined period.

Properties

access_time_period	Specify the time period option. A member of the AccessTimeType enumeration.
access_time_period_data	Return an TimeIntervalCollection if AccessTimePeriod is eAccessTimeIntervals; returns an AccessTimePeriod if AccessTimePeriod is eUserSpecAccessTime; returns an AccessAllowedTimeIntervals if AccessTimePeriod is eAccessTimeEventIntervals.
advanced	Get the Advanced properties for the Access computations.
analysis_workbench_components	Get a VGT provider to access the analytical vector geometry, timeline, calculation and other types of components.
base	Base object used in the access.
computed_access_interval_times	Return a list of the computed access interval times.
data_displays	Get the VO Data Display Collection.
data_providers	Return the object representing a list of available data providers for the object.
graphics	Get the Graphics properties for the Access computations.
name	Name of the access.
save_computed_data	Flag indicating whether to save computed data with the Access instance.
target	Target object used in the access.

Examples

Configure the access analysis time period to specified time instants

# STKObjectRoot root: STK Object Model root

satellite = root.get_object_from_path("Satellite/MySatellite")
facility = root.get_object_from_path("Facility/MyFacility")

# For this code snippet, let's use the time interval when the satellite reached min and max altitude values.
# Note, this assumes time at min happens before time at max.
timeOfAltMin = satellite.analysis_workbench_components.time_instants.item(
    "GroundTrajectory.Detic.LLA.Altitude.TimeOfMin"
)
timeOfAltMax = satellite.analysis_workbench_components.time_instants.item(
    "GroundTrajectory.Detic.LLA.Altitude.TimeOfMax"
)

# Set the access time period with the times we figured out above.
access = satellite.get_access_to_object(facility)
access.access_time_period = AccessTimeType.SPECIFIED_TIME_PERIOD
accessTimePeriod = access.access_time_period_data

accessTimePeriod.access_interval.state = SmartIntervalState.START_STOP

accessStartEpoch = accessTimePeriod.access_interval.get_start_epoch()
accessStartEpoch.set_implicit_time(timeOfAltMin)
accessTimePeriod.access_interval.set_start_epoch(accessStartEpoch)

accessStopEpoch = accessTimePeriod.access_interval.get_stop_epoch()
accessStopEpoch.set_implicit_time(timeOfAltMax)
accessTimePeriod.access_interval.set_stop_epoch(accessStopEpoch)

Compute and extract access interval times

# Access access: Access calculation
# Get and display the Computed Access Intervals
intervalCollection = access.computed_access_interval_times

# Set the intervals to use to the Computed Access Intervals
computedIntervals = intervalCollection.to_array(0, -1)
access.specify_access_intervals(computedIntervals)

Compute an Access with Advanced Settings

# Access access: Access object

access.advanced.enable_light_time_delay = True
access.advanced.time_light_delay_convergence = 0.00005
access.advanced.aberration_type = AberrationType.ANNUAL
access.advanced.use_default_clock_host_and_signal_sense = False
access.advanced.clock_host = IvClockHost.BASE
access.advanced.signal_sense_of_clock_host = IvTimeSense.TRANSMIT
access.compute_access()

Compute an access between two STK Objects (using object path)

# Satellite satellite: Satellite object

# Get access by object path
access = satellite.get_access("Facility/MyFacility")

# Compute access
access.compute_access()

Compute an access between two STK Objects (using ISTKObject interface)

# Satellite satellite: Satellite object
# Facility facility: Facility object

# Get access by STK Object
access = satellite.get_access_to_object(facility)

# Compute access
access.compute_access()

Import detail

from ansys.stk.core.stkobjects import Access

Property detail

property Access.access_time_period: AccessTimeType

Specify the time period option. A member of the AccessTimeType enumeration.

property Access.access_time_period_data: IAccessInterval

Return an TimeIntervalCollection if AccessTimePeriod is eAccessTimeIntervals; returns an AccessTimePeriod if AccessTimePeriod is eUserSpecAccessTime; returns an AccessAllowedTimeIntervals if AccessTimePeriod is eAccessTimeEventIntervals.

property Access.advanced: AccessAdvancedSettings

Get the Advanced properties for the Access computations.

property Access.analysis_workbench_components: IAnalysisWorkbenchComponentProvider

Get a VGT provider to access the analytical vector geometry, timeline, calculation and other types of components.

property Access.base: ISTKObject

Base object used in the access.

property Access.computed_access_interval_times: TimeIntervalCollection

Return a list of the computed access interval times.

property Access.data_displays: Graphics3DDataDisplayCollection

Get the VO Data Display Collection.

property Access.data_providers: DataProviderCollection

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

property Access.graphics: AccessGraphics

Get the Graphics properties for the Access computations.

property Access.name: str

Name of the access.

property Access.save_computed_data: bool

Flag indicating whether to save computed data with the Access instance.

property Access.target: ISTKObject

Target object used in the access.

Method detail

Access.clear_access(self) → None

Clear the access intervals, but not the definitional settings of the access object itself (like step size, light time delay settings, time interval, etc.).

Returns:

None

Access.compute_access(self) → None

Recomputes the access between two objects. Calls to ComputeAccess should not be made between calls to BeginUpdate and EndUpdate.

Returns:

None

Access.remove_access(self) → None

Remove the access that was computed between two objects.

Returns:

None

Access.specify_access_event_intervals(self, event_interval_list: ITimeToolTimeIntervalList) → None

Access is computed using the intervals in the specified event interval list.

Parameters:

event_interval_list : ITimeToolTimeIntervalList

Returns:

None

Access.specify_access_intervals(self, access_intervals: list) → None

Allow a list of intervals to be used for the access calculation.

Parameters:

access_intervals : list

Returns:

None

Access.specify_access_time_period(self, start_time: Any, stop_time: Any) → None

If eUserSpec is selected for AccessTimePeriod, specify the start and stop times for the user-defined period.

Parameters:

start_time : Any

stop_time : Any

Returns:

None