AccessConstraintExclZonesCollection

class ansys.stk.core.stkobjects.AccessConstraintExclZonesCollection

Bases: IAccessConstraint

Collection of Exclusion Zones used in Exclusion Zone constraint.

Overview

Methods

remove_index	Remove an item given an index.
remove_all	Remove all items from the collection.
remove_exclusion_zone	Remove an Exclusion Zone using the min and max lat/lon values. Lat/Lon Values use Latitude and Longitude Dimensions respectively.
change_exclusion_zone	Update Exclusion Zone data at a given index. Lat/Lon Values use Latitude and Longitude Dimensions respectively.
get_exclusion_zone	Return min and max lat/lon values at a given index. Lat/Lon Values use Latitude and Longitude Dimensions respectively.
to_array	Return a four-dimensional array of min/max lat/lon values beginning at a given position and having specified number of rows.
item	Get an AccessConstraintLatitudeLongitudeZone interface using an index.

Properties

count	Number of items in the collection.
constraint_name	Get the constraint name.
is_plugin	Return true if the access constraint is a plugin.
exclusion_interval	Get or set the ExclInterval.
constraint_type	Get the constraint type.
_new_enum	Enumerate the AccessConstraintLatitudeLongitudeZone interfaces.
maximum_time_step	Maximum time step used in adaptive sampling.
maximum_relative_motion	Maximum relative motion used in adaptive sampling.

Import detail

from ansys.stk.core.stkobjects import AccessConstraintExclZonesCollection

Property detail

property AccessConstraintExclZonesCollection.count: int

Number of items in the collection.

property AccessConstraintExclZonesCollection.constraint_name: str

Get the constraint name.

property AccessConstraintExclZonesCollection.is_plugin: bool

Return true if the access constraint is a plugin.

property AccessConstraintExclZonesCollection.exclusion_interval: bool

Get or set the ExclInterval.

property AccessConstraintExclZonesCollection.constraint_type: AccessConstraintType

Get the constraint type.

property AccessConstraintExclZonesCollection._new_enum: EnumeratorProxy

Enumerate the AccessConstraintLatitudeLongitudeZone interfaces.

property AccessConstraintExclZonesCollection.maximum_time_step: float

Maximum time step used in adaptive sampling.

property AccessConstraintExclZonesCollection.maximum_relative_motion: float

Maximum relative motion used in adaptive sampling.

Method detail

AccessConstraintExclZonesCollection.remove_index(self, index: int) → None

Remove an item given an index.

Parameters:

index : int

Returns:

None

AccessConstraintExclZonesCollection.remove_all(self) → None

Remove all items from the collection.

Returns:

None

AccessConstraintExclZonesCollection.remove_exclusion_zone(self, min_lat: Any, min_lon: Any, max_lat: Any, max_lon: Any) → None

Remove an Exclusion Zone using the min and max lat/lon values. Lat/Lon Values use Latitude and Longitude Dimensions respectively.

Parameters:

min_lat : Any

min_lon : Any

max_lat : Any

max_lon : Any

Returns:

None

AccessConstraintExclZonesCollection.change_exclusion_zone(self, index: int, min_lat: Any, min_lon: Any, max_lat: Any, max_lon: Any) → None

Update Exclusion Zone data at a given index. Lat/Lon Values use Latitude and Longitude Dimensions respectively.

Parameters:

index : int

min_lat : Any

min_lon : Any

max_lat : Any

max_lon : Any

Returns:

None

AccessConstraintExclZonesCollection.get_exclusion_zone(self, index: int) → Tuple[Any, Any, Any, Any]

Return min and max lat/lon values at a given index. Lat/Lon Values use Latitude and Longitude Dimensions respectively.

Parameters:

index : int

Returns:

Any]

AccessConstraintExclZonesCollection.to_array(self, index: int, length: int) → list

Return a four-dimensional array of min/max lat/lon values beginning at a given position and having specified number of rows.

Parameters:

index : int

length : int

Returns:

list

AccessConstraintExclZonesCollection.item(self, index: int) → AccessConstraintLatitudeLongitudeZone

Get an AccessConstraintLatitudeLongitudeZone interface using an index.

Parameters:

index : int

Returns:

AccessConstraintLatitudeLongitudeZone