Inheritance diagram for EECFI::VisibilityList:

Public Member Functions
	VisibilityList ()
	Default constructor.
	~VisibilityList () NOEXCEPT
	Class destructor.
EECFI::VisibilityList	computeNot (OrbitId &orbitId, long orderSwitch) const
	Get the list of complementary list of time segments.
EECFI::VisibilityList	computeOr (OrbitId &orbitId, long orderSwitch, const EECFI::VisibilityList &list2) const
	Get the union of two lists.
EECFI::VisibilityList	computeAnd (OrbitId &orbitId, long orderSwitch, const EECFI::VisibilityList &list2) const
	Get the intersection of two lists.
void	sort (OrbitId &orbitId)
	Sort the list by the start time of the visibility segments.
void	merge (OrbitId &orbitId, long orderSwitch)
	Merge the list. The overlapping VisibilitySegments are merged.
void	delta (OrbitId &orbitId, double entryOffset, double exitOffset)
	Add the input margins to every visibility segment.

Constructor & Destructor Documentation

EECFI::VisibilityList::VisibilityList ( )

Default constructor.

EECFI::VisibilityList::~VisibilityList ( )

Class destructor.

Member Function Documentation

EECFI::VisibilityList EECFI::VisibilityList::computeAnd	(	OrbitId &	orbitId,
		long	orderSwitch,
		const EECFI::VisibilityList &	list2
	)			const

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

EECFI::VisibilityList EECFI::VisibilityList::computeNot	(	OrbitId &	orbitId,
		long	orderSwitch
	)			const

Get the list of complementary list of time segments.

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)

EECFI::VisibilityList EECFI::VisibilityList::computeOr	(	OrbitId &	orbitId,
		long	orderSwitch,
		const EECFI::VisibilityList &	list2
	)			const

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	(	OrbitId &	orbitId,
		double	entryOffset,
		double	exitOffset
	)

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	(	OrbitId &	orbitId,
		long	orderSwitch
	)

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 VisibilityList::sort ( OrbitId & orbitId )

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

Parameters:

orbitId

Orbit Id.

Generated on Thu Jun 6 2024 12:47:19 for by

1.7.1