RadarActivityTimeComponentListCollection

class ansys.stk.core.stkobjects.RadarActivityTimeComponentListCollection

Class defining an radar antenna beam collection.

Overview

Methods

item	Given an index, returns the time component element in the collection.
remove_at	Remove the time component element with the specified index.
insert_at	Insert a new time component element at the supplied index, configured with a component with the supplied identifier. An example of a valid component identifier would be Facility/MFR_Facility/Radar/MFR LightingIntervals.Umbra EventIntervalList.
add	Add a new time component element to the collection, configured with a component with the supplied identifier. An example of a valid component identifier would be Facility/MFR_Facility/Radar/MFR LightingIntervals.Umbra EventIntervalList.
clear	Clear all time component elements from the collection.

Properties

count	Return the number of time component elements in the collection.
_new_enum	Return an enumerator for the collection.

Import detail

from ansys.stk.core.stkobjects import RadarActivityTimeComponentListCollection

Property detail

property RadarActivityTimeComponentListCollection.count: int

Return the number of time component elements in the collection.

property RadarActivityTimeComponentListCollection._new_enum: EnumeratorProxy

Return an enumerator for the collection.

Method detail

RadarActivityTimeComponentListCollection.item(self, index: int) → RadarActivityTimeComponentListElement

Given an index, returns the time component element in the collection.

Parameters:

index : int

Returns:

RadarActivityTimeComponentListElement

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

Remove the time component element with the specified index.

Parameters:

index : int

Returns:

None

RadarActivityTimeComponentListCollection.insert_at(self, index: int, component_identifier: str) → RadarActivityTimeComponentListElement

Insert a new time component element at the supplied index, configured with a component with the supplied identifier. An example of a valid component identifier would be Facility/MFR_Facility/Radar/MFR LightingIntervals.Umbra EventIntervalList.

Parameters:

index : int

component_identifier : str

Returns:

RadarActivityTimeComponentListElement

RadarActivityTimeComponentListCollection.add(self, component_identifier: str) → RadarActivityTimeComponentListElement

Add a new time component element to the collection, configured with a component with the supplied identifier. An example of a valid component identifier would be Facility/MFR_Facility/Radar/MFR LightingIntervals.Umbra EventIntervalList.

Parameters:

component_identifier : str

Returns:

RadarActivityTimeComponentListElement

RadarActivityTimeComponentListCollection.clear(self) → None

Clear all time component elements from the collection.

Returns:

None