ScheduleTimeCollection

class ansys.stk.core.stkobjects.ScheduleTimeCollection

Collection of user-scheduled access times.

Overview

Methods

add	Add a schedule time item to the collection. Start/Stop use DateFormat Dimension.
remove_index	Remove an item given an index.
remove_all	Remove all items in the collection.
remove_schedule	Remove an interval using the interval interface. Start/Stop use DateFormat Dimension.
item	Retrieve and ScheduleTime interface given an index.
deconflict	Deconflicts the schedule time intervals.

Properties

count	The number of items in the collection.
_new_enum	Enumerates through the collection.

Import detail

from ansys.stk.core.stkobjects import ScheduleTimeCollection

Property detail

property ScheduleTimeCollection.count: int

The number of items in the collection.

property ScheduleTimeCollection._new_enum: EnumeratorProxy

Enumerates through the collection.

Method detail

ScheduleTimeCollection.add(self, start: Any, stop: Any, name: str) → ScheduleTime

Add a schedule time item to the collection. Start/Stop use DateFormat Dimension.

Parameters:

start : Any

stop : Any

name : str

Returns:

ScheduleTime

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

Remove an item given an index.

Parameters:

index : int

Returns:

None

ScheduleTimeCollection.remove_all(self) → None

Remove all items in the collection.

Returns:

None

ScheduleTimeCollection.remove_schedule(self, start: Any, stop: Any, name: str) → None

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

Parameters:

start : Any

stop : Any

name : str

Returns:

None

ScheduleTimeCollection.item(self, index: int) → ScheduleTime

Retrieve and ScheduleTime interface given an index.

Parameters:

index : int

Returns:

ScheduleTime

ScheduleTimeCollection.deconflict(self) → None

Deconflicts the schedule time intervals.

Returns:

None