DisplayTimesTimeComponent

class ansys.stk.core.stkobjects.DisplayTimesTimeComponent

Bases: IDisplayTimesData

Provide methods to configure the display times using Timeline API components.

Overview

Methods

get_qualified_path	Return the time component’ qualified path or null if no component has been configured yet.
get_time_component	Return a time component used to configure the display times or null if component has not been configured yet.
reset	Remove and resets the display configuration by unsetting currently set time component (if any).
set_qualified_path	Configure the display times using the specified time component. Allowed are only intervals and interval lists. QualifiedPath format adheres to the format used throughout VGT API (i.e. Scenario/Scenario1 AnalysisInterval EventInterval).
set_time_component	Configure the display times using the specified time component. Allowed are only intervals and interval lists.

Import detail

from ansys.stk.core.stkobjects import DisplayTimesTimeComponent

Method detail

DisplayTimesTimeComponent.get_qualified_path(self) → str

Return the time component’ qualified path or null if no component has been configured yet.

Returns:

str

DisplayTimesTimeComponent.get_time_component(self) → IAnalysisWorkbenchComponent

Return a time component used to configure the display times or null if component has not been configured yet.

Returns:

IAnalysisWorkbenchComponent

DisplayTimesTimeComponent.reset(self) → None

Remove and resets the display configuration by unsetting currently set time component (if any).

Returns:

None

DisplayTimesTimeComponent.set_qualified_path(self, qualified_path: str) → None

Configure the display times using the specified time component. Allowed are only intervals and interval lists. QualifiedPath format adheres to the format used throughout VGT API (i.e. Scenario/Scenario1 AnalysisInterval EventInterval).

Parameters:

qualified_path : str

Returns:

None

DisplayTimesTimeComponent.set_time_component(self, component: IAnalysisWorkbenchComponent) → None

Configure the display times using the specified time component. Allowed are only intervals and interval lists.

Parameters:

component : IAnalysisWorkbenchComponent

Returns:

None