VisibilityCalculator Object

The VisibilityCalculator object allows users to work with multiple VisibilitySegments at once in order to determine whether any or all of the segments are simultaneously true.

Available In Editions:

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Name	Description	Attributes
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
Segments	The VisibilitySegment objects to be evaluated.	Type: Array of VisibilitySegment Access: Read-Only
VisibilityRequirement	Determines how the evaluation results of each segment are combined to determine visibility. This setting affects computation of the instantaneous method VisibilityCalculator.Visibility and the interval method VisibilityCalculator.VisibilityTimes. The following options are available: All - VisibilitySegment.Visibility must be true for all active VisibilitySegment objects associated with this VisibilityCalculator in order for VisibilityCalculator.Visibility to be true. Any - If VisibilitySegment.Visibility is true for any active VisibilitySegment objects associated with this VisibilityCalculator, VisibilityCalculator.Visibility will be true.	Type: Variable Access: Read/Write

Name	Description
AddSegment	Creates a new VisibilitySegment as a child object of this VisibilityCalculator, with the option to specify a label. VisibilitySegment objects can also be created separately from VisibilityCalculator objects as standalone objects in FreeForm script.
ClearSavedStates	Clears previous saved states for this object.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
GetSegmentByLabel	Gets the segment with the specified label.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
RemoveAllSegments	Removes all segments.
RemoveSegment	Removes the specified segment.
ResetConfiguration	Removes all VisibilitySegment objects and resets the VisibilityCalculator to the default configuration.
ResetMethodStates	Resets any method states associated with the calling object.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.
Visibility	Evaluates the visibility condition(s) determined by the VisibilitySegment objects associated with this VisibilityCalculator and returns true (1) if any/all of the VisibilitySegment observers can see their targets and returns false (0) otherwise. The "any/all" condition is determined by the VisibilityCalculator.VisibilityRequirement property.
VisibilityTimes	Detects start of visibility (AOS) and end of visibility (LOS) events.

VisibilityCalculator Object

Description

Available In Editions:

Timing Precision Mode