Class to store list of visibility segments. More...

Inheritance diagram for EECFI.VisibilityList:

Public Member Functions
	VisibilityList ()
	Empty Class constructor.
	VisibilityList (final Vector< VisibilitySegment > segmentsIn)
	Parameter constructor.
native VisibilityList	computeNot (final OrbitId orbitId, long orderSwitch) throws CfiError
	Get the list of complementary list of time segments.
native VisibilityList	computeOr (final OrbitId orbitId, long orderSwitch, VisibilityList list2) throws CfiError
	Get the union of two lists.
native VisibilityList	computeAnd (final OrbitId orbitId, long orderSwitch, VisibilityList list2) throws CfiError
	Get the intersection of two lists.
native void	sort (final OrbitId orbitId) throws CfiError
	Sort the list by the start time of the visibility segments.
native void	merge (final OrbitId orbitId, long orderSwitch) throws CfiError
	Merge the list. The overlapping VisibilitySegments are merged.
native void	delta (final OrbitId orbitId, double entryOffset, double exitOffset) throws CfiError
	Add the input margins to every visibility segment.
Public Attributes
Vector< VisibilitySegment >	segments
	List of visibility segments.

Detailed Description

Class to store list of visibility segments.

Constructor & Destructor Documentation

EECFI.VisibilityList.VisibilityList ( )

Empty Class constructor.

EECFI.VisibilityList.VisibilityList ( final Vector< VisibilitySegment > segmentsIn )

Parameter constructor.

VisibilityList EECFI.VisibilityList::computeAnd	(	final OrbitId	orbitId,
		long	orderSwitch,
		VisibilityList	list2
	)			throws CfiError

Get the intersection of two lists.

Parameters:

	orbitId	Orbit Id.
	orderSwitch	Indicates if the input list is sorted by start times. If input segments are already sorted, the flag should be set to XVCFI_TIME_ORDER to save computation time. (XV_time_segments_order_enum in VisibilityData.h)
	list2	Second list to be intersected with the input list.

Returns:: The list with the visibility segments resulting from the intersection of the two lists

native VisibilityList EECFI.VisibilityList.computeNot	(	final OrbitId	orbitId,
		long	orderSwitch
	)			throws CfiError

Get the list of complementary list of time segments.

VisibilityList EECFI.VisibilityList::computeOr	(	final OrbitId	orbitId,
		long	orderSwitch,
		VisibilityList	list2
	)			throws CfiError

Get the union of two lists.

Parameters:

	orbitId	Orbit Id.
	orderSwitch	Indicates if the input list is sorted by start times. If input segments are already sorted, the flag should be set to XVCFI_TIME_ORDER to save computation time. (XV_time_segments_order_enum in VisibilityData.h)
	list2	Second list to be joined to the input list.

Returns:: The list with the visibility segments resulting from the union the the two lists

void EECFI.VisibilityList::delta	(	final OrbitId	orbitId,
		double	entryOffset,
		double	exitOffset
	)			throws CfiError

Add the input margins to every visibility segment.

Parameters:

	orbitId	Orbit Id.
	entryOffset	Number of seconds to add/subtract at the beginning of every segment. If entry_offset > 0, the entry_offset is added at the beginning of the segments making them shorter.
	exitOffset	Number of seconds to add/subtract at the end of every segment. If exit_offset > 0 the exit_offset is added at the end of the segments making them longer.

void EECFI.VisibilityList::merge	(	final OrbitId	orbitId,
		long	orderSwitch
	)			throws CfiError

Merge the list. The overlapping VisibilitySegments are merged.

Parameters:

	orbitId	Orbit Id.
	orderSwitch	Indicates if the input list is sorted by start times. If input segments are already sorted, the flag should be set to XVCFI_TIME_ORDER to save computation time. (XV_time_segments_order_enum in VisibilityData.h)

void EECFI.VisibilityList::sort ( final OrbitId orbitId ) throws CfiError

Sort the list by the start time of the visibility segments.

Parameters:

orbitId

Orbit Id.

List of visibility segments.

Generated on Thu Jun 6 2024 13:54:58 for by

1.7.1