BPlaneCollection

class ansys.stk.core.stkobjects.astrogator.BPlaneCollection

The collection of B-Planes.

Overview

Methods

add	Add a BPlane.
remove	Remove a BPlane.
remove_all	Remove all BPlanes.
item	Allow you to iterate through the collection.

Properties

_new_enum	Allow you to enumerate through the collection.
count	Get the number of active BPlanes.

Import detail

from ansys.stk.core.stkobjects.astrogator import BPlaneCollection

Property detail

property BPlaneCollection._new_enum: EnumeratorProxy

Allow you to enumerate through the collection.

property BPlaneCollection.count: int

Get the number of active BPlanes.

Method detail

BPlaneCollection.add(self, plane_name: str) → None

Add a BPlane.

Parameters:

plane_name : str

Returns:

None

BPlaneCollection.remove(self, plane_name: str) → None

Remove a BPlane.

Parameters:

plane_name : str

Returns:

None

BPlaneCollection.remove_all(self) → None

Remove all BPlanes.

Returns:

None

BPlaneCollection.item(self, index: int) → str

Allow you to iterate through the collection.

Parameters:

index : int

Returns:

str