OnePointAccess

class ansys.stk.core.stkobjects.OnePointAccess

One Point Access.

Overview

Methods

compute	Compute one point access results using the StartTime, StopTime, StepSize, and SummaryOption.
remove	Remove the one point access component that was created.
compute_first_satisfaction	Compute and reports the first N satisfaction intervals (where N <= MaxNumAccessesToFind) over the specified interval whose spans meet the specified minimum duration. Does not use output file.

Properties

summary_option	Summary option that specifies the level of detail to provide in the computed results.
start_time	Get or set the start time. Uses current animation time if none is entered.
stop_time	Get or set the stop time. Uses current animation time if none is entered. Set this to the same value as StartTime to report at a single time.
step_size	Get or set the step size. Default is 60 seconds.
output_to_file	Whether to output to a file.
output_filename	If set to do so, results will be output to a file with this name.

Examples

Compute an access for one point

# ISTKObject facility: Facility object
onePtAccess = facility.create_one_point_access("Satellite/MySatellite")

# Configure properties (if necessary)
onePtAccess.start_time = root.current_scenario.start_time
onePtAccess.stop_time = root.current_scenario.stop_time
onePtAccess.step_size = 600
onePtAccess.summary_option = OnePointAccessSummary.DETAILED

# Compute results
results = onePtAccess.compute()

# Print results
for i in range(0, results.count):
    result = results.item(i)
    print("Time: %s HasAccess: %s" % (result.time, str(result.access_is_satisfied)))

    for j in range(0, result.constraints.count):
        constraint = result.constraints.item(j)
        print(
            "Constraint: %s Object: %s Status: %s Value:%s"
            % (constraint.constraint, constraint.object_path, constraint.status, str(constraint.value))
        )

Import detail

from ansys.stk.core.stkobjects import OnePointAccess

Property detail

property OnePointAccess.summary_option: OnePointAccessSummary

Summary option that specifies the level of detail to provide in the computed results.

property OnePointAccess.start_time: Any

Get or set the start time. Uses current animation time if none is entered.

property OnePointAccess.stop_time: Any

Get or set the stop time. Uses current animation time if none is entered. Set this to the same value as StartTime to report at a single time.

property OnePointAccess.step_size: float

Get or set the step size. Default is 60 seconds.

property OnePointAccess.output_to_file: bool

Whether to output to a file.

property OnePointAccess.output_filename: str

If set to do so, results will be output to a file with this name.

Method detail

OnePointAccess.compute(self) → OnePointAccessResultCollection

Compute one point access results using the StartTime, StopTime, StepSize, and SummaryOption.

Returns:

OnePointAccessResultCollection

OnePointAccess.remove(self) → None

Remove the one point access component that was created.

Returns:

None

OnePointAccess.compute_first_satisfaction(self, start_time: Any, stop_time: Any, max_num_accesses_to_find: int, min_duration: float) → TimeIntervalCollectionReadOnly

Compute and reports the first N satisfaction intervals (where N <= MaxNumAccessesToFind) over the specified interval whose spans meet the specified minimum duration. Does not use output file.

Parameters:

start_time : Any

stop_time : Any

max_num_accesses_to_find : int

min_duration : float

Returns:

TimeIntervalCollectionReadOnly