ADDSMessageCollection

class ansys.stk.core.stkobjects.aviator.ADDSMessageCollection

Class defining a collection of messages from the NOAA ADDS service.

Overview

Methods

item	Given an index, returns an element in the collection.
remove_message	Remove this message from the forecast.
clear_messages	Clear all of the messages in the collection.

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.aviator import ADDSMessageCollection

Property detail

property ADDSMessageCollection.count: int

Return the number of elements in a collection.

property ADDSMessageCollection._new_enum: EnumeratorProxy

Return an enumerator that can iterate through the collection.

Method detail

ADDSMessageCollection.item(self, index: int) → ADDSMessage

Given an index, returns an element in the collection.

Parameters:

index : int

Returns:

ADDSMessage

ADDSMessageCollection.remove_message(self, message: ADDSMessage) → None

Remove this message from the forecast.

Parameters:

message : ADDSMessage

Returns:

None

ADDSMessageCollection.clear_messages(self) → None

Clear all of the messages in the collection.

Returns:

None