TimeToolTimeIntervalCollectionFactory

class ansys.stk.core.analysis_workbench.TimeToolTimeIntervalCollectionFactory

The factory creates collections of event interval lists.

Overview

Methods

create	Create and register an event interval collection using specified name, description, and type.
create_lighting	Create an event interval collection defined by computing sunlight, penumbra and umbra intervals as seen at specified location using specified selection of eclipsing bodies.
create_signaled	Create an event interval collection recorded at target clock location by performing signal transmission of original interval list collection between base and target clock locations.
is_type_supported	Return whether the specified type is supported.
create_satisfaction	Create an event interval collection containing intervals during which condition set is satisfied.

Import detail

from ansys.stk.core.analysis_workbench import TimeToolTimeIntervalCollectionFactory

Method detail

TimeToolTimeIntervalCollectionFactory.create(self, name: str, description: str, type: EventIntervalCollectionType) → ITimeToolTimeIntervalCollection

Create and register an event interval collection using specified name, description, and type.

Parameters:

name : str

description : str

type : EventIntervalCollectionType

Returns:

ITimeToolTimeIntervalCollection

TimeToolTimeIntervalCollectionFactory.create_lighting(self, name: str, description: str) → ITimeToolTimeIntervalCollection

Create an event interval collection defined by computing sunlight, penumbra and umbra intervals as seen at specified location using specified selection of eclipsing bodies.

Parameters:

name : str

description : str

Returns:

ITimeToolTimeIntervalCollection

TimeToolTimeIntervalCollectionFactory.create_signaled(self, name: str, description: str) → ITimeToolTimeIntervalCollection

Create an event interval collection recorded at target clock location by performing signal transmission of original interval list collection between base and target clock locations.

Parameters:

name : str

description : str

Returns:

ITimeToolTimeIntervalCollection

TimeToolTimeIntervalCollectionFactory.is_type_supported(self, type: EventIntervalCollectionType) → bool

Return whether the specified type is supported.

Parameters:

type : EventIntervalCollectionType

Returns:

bool

TimeToolTimeIntervalCollectionFactory.create_satisfaction(self, name: str, description: str) → ITimeToolTimeIntervalCollection

Create an event interval collection containing intervals during which condition set is satisfied.

Parameters:

name : str

description : str

Returns:

ITimeToolTimeIntervalCollection