TimeIntervalCollection

class ansys.stk.core.stkobjects.TimeIntervalCollection

Bases: IDisplayTimesData, IAccessInterval

Class defining display intervals.

Overview

Methods

add	Add an interval to the collection and returns the index. Start/Stop use DateFormat Dimension.
remove_index	Remove an item by the index.
remove_all	Remove all items in the collection.
remove_interval	Remove an interval using the interval interface. Start/Stop use DateFormat Dimension.
deconflict	Deconflict display intervals.
load_intervals	Load an interval file.
change_interval	Update interval with specified start and stop times at a given index. Start/Stop use DateFormat Dimension.
get_interval	Return start and stop times of the interval at a given index. Start/Stop use DateFormat Dimension.
to_array	Return a two-dimensional array of intervals beginning at a given position and having specified number of rows.

Properties

count

Number of items in the collection.

Import detail

from ansys.stk.core.stkobjects import TimeIntervalCollection

Property detail

property TimeIntervalCollection.count: int

Number of items in the collection.

Method detail

TimeIntervalCollection.add(self, start: Any, stop: Any) → int

Add an interval to the collection and returns the index. Start/Stop use DateFormat Dimension.

Parameters:

start : Any

stop : Any

Returns:

int

TimeIntervalCollection.remove_index(self, index: int) → None

Remove an item by the index.

Parameters:

index : int

Returns:

None

TimeIntervalCollection.remove_all(self) → None

Remove all items in the collection.

Returns:

None

TimeIntervalCollection.remove_interval(self, start: Any, stop: Any) → None

Remove an interval using the interval interface. Start/Stop use DateFormat Dimension.

Parameters:

start : Any

stop : Any

Returns:

None

TimeIntervalCollection.deconflict(self) → None

Deconflict display intervals.

Returns:

None

TimeIntervalCollection.load_intervals(self, filename: str) → None

Load an interval file.

Parameters:

filename : str

Returns:

None

TimeIntervalCollection.change_interval(self, index: int, start: Any, stop: Any) → None

Update interval with specified start and stop times at a given index. Start/Stop use DateFormat Dimension.

Parameters:

index : int

start : Any

stop : Any

Returns:

None

TimeIntervalCollection.get_interval(self, index: int) → Tuple[Any, Any]

Return start and stop times of the interval at a given index. Start/Stop use DateFormat Dimension.

Parameters:

index : int

Returns:

Any]

TimeIntervalCollection.to_array(self, index: int, length: int) → list

Return a two-dimensional array of intervals beginning at a given position and having specified number of rows.

Parameters:

index : int

length : int

Returns:

list