VehicleGraphics2DTimeComponentsCollection

class ansys.stk.core.stkobjects.VehicleGraphics2DTimeComponentsCollection

A collection of time components used to configure the object appearance in 2D and 3D views.

Overview

Methods

item	Given an index, returns an element in the collection.
remove_at	Remove an element from the collection using specified index.
remove_all	Remove all elements from the collection.
add	Add a new element to the collection using the specified fully qualified component’s path (i.e. Scenario/Scenario1 AnalysisInterval EventInterval). Only intervals, interval lists or interval collections are allowed.

Properties

count	Return the number of elements in a collection.
_new_enum	Return an enumerator that can iterate through the collection.

Import detail

from ansys.stk.core.stkobjects import VehicleGraphics2DTimeComponentsCollection

Property detail

property VehicleGraphics2DTimeComponentsCollection.count: int

Return the number of elements in a collection.

property VehicleGraphics2DTimeComponentsCollection._new_enum: EnumeratorProxy

Return an enumerator that can iterate through the collection.

Method detail

VehicleGraphics2DTimeComponentsCollection.item(self, index: int) → IVehicleGraphics2DTimeComponentsElement

Given an index, returns an element in the collection.

Parameters:

index : int

Returns:

IVehicleGraphics2DTimeComponentsElement

VehicleGraphics2DTimeComponentsCollection.remove_at(self, index: int) → None

Remove an element from the collection using specified index.

Parameters:

index : int

Returns:

None

VehicleGraphics2DTimeComponentsCollection.remove_all(self) → None

Remove all elements from the collection.

Returns:

None

VehicleGraphics2DTimeComponentsCollection.add(self, qualified_path: str) → IVehicleGraphics2DTimeComponentsElement

Add a new element to the collection using the specified fully qualified component’s path (i.e. Scenario/Scenario1 AnalysisInterval EventInterval). Only intervals, interval lists or interval collections are allowed.

Parameters:

qualified_path : str

Returns:

IVehicleGraphics2DTimeComponentsElement