VehicleGroundEllipsesCollection#

class ansys.stk.core.stkobjects.VehicleGroundEllipsesCollection#

List of Ground Ellipses.

Overview#

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.

remove_ellipse_set

Remove an element from the collection using the Ellipse Set name.

get_ellipse_set

Get an element from the collection using the Ellipse Set name.

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 VehicleGroundEllipsesCollection

Property detail#

property VehicleGroundEllipsesCollection.count: int#

Return the number of elements in a collection.

property VehicleGroundEllipsesCollection._new_enum: EnumeratorProxy#

Return an enumerator that can iterate through the collection.

Method detail#

VehicleGroundEllipsesCollection.item(self, index: int) VehicleGroundEllipseElement#

Given an index, returns an element in the collection.

Parameters:

index : int

Returns:

VehicleGroundEllipseElement

VehicleGroundEllipsesCollection.remove_at(self, index: int) None#

Remove an element from the collection using specified index.

Parameters:

index : int

Returns:

None

VehicleGroundEllipsesCollection.remove_all(self) None#

Remove all elements from the collection.

Returns:

None

VehicleGroundEllipsesCollection.add(self, name: str) VehicleGroundEllipseElement#

Add a new element to the collection.

Parameters:

name : str

Returns:

VehicleGroundEllipseElement

VehicleGroundEllipsesCollection.remove_ellipse_set(self, ellipse_set_name: str) None#

Remove an element from the collection using the Ellipse Set name.

Parameters:

ellipse_set_name : str

Returns:

None

VehicleGroundEllipsesCollection.get_ellipse_set(self, ellipse_set_name: str) VehicleGroundEllipseElement#

Get an element from the collection using the Ellipse Set name.

Parameters:

ellipse_set_name : str

Returns:

VehicleGroundEllipseElement