Package empro :: Module empro :: Class ExternalExcitationList

Class ExternalExcitationList

core.Updatable --+    
                 |    
   core.Selectable --+
                     |
                    ExternalExcitationList

No documentation available.

Instance Methods

__call__(x, ...)
x(...)

__contains__(x, y)
y in x

__delitem__(x, y)
del x[y]

__getitem__(x, y)
x[y]

__len__(x)
len(x)

__setitem__(x, i, y)
x[i]=y

bool

append(iComponent)
Appends a external excitation to the list.

ExternalExcitation

at(iName)
Returns the external excitation by name.

None

clear()
Clear the list.

bool

contains(iComponentDef)
Determines if the external excitation is in the list.

int

index(iComponent)
Retrieves the index of a external excitation.

bool

insert(iIndex, iComponent)
Inserts a external excitation into the list.

list{string}

names()
Returns the names of the external excitations in the list.

bool

remove(iIndex)
Removes a external excitation.

bool

replace(iIndex, iComponent)
Replaces a external excitation.

int

size()
Returns the size of the list.

None

swap(iIndex, iIndex)
Swaps two external excitations.

Inherited from core.Selectable: clone, isSelected

Inherited from core.Updatable: __enter__, __exit__, hash, isValid, reasonWhyInvalid

Properties
Inherited from `core.Selectable`: `metaData`, `name`, `notes`

Method Details

append(iComponent)

Appends a external excitation to the list.

Parameters:

iComponent (ExternalExcitation) - external excitation to add.

Returns: bool

at(iName)

Returns the external excitation by name.

Parameters:

iName (string) - Name of the requested external excitation.

Returns: ExternalExcitation

contains(iComponentDef)

Determines if the external excitation is in the list.

Parameters:

iComponentDef (ExternalExcitation) - external excitation to query.

Returns: bool

index(iComponent)

Retrieves the index of a external excitation.

Parameters:

iComponent (ExternalExcitation) - external excitation to query.

Returns: int

insert(iIndex, iComponent)

Inserts a external excitation into the list.

Parameters:

iIndex (int) - Index of where to insert the new element.
iComponent (ExternalExcitation) - external excitation to add.

Returns: bool

remove(iIndex)

Removes a external excitation.

Parameters:

iIndex (int) - Index of the external excitation to remove.

Returns: bool

replace(iIndex, iComponent)

Replaces a external excitation.

Parameters:

iIndex (int) - Index of which element to replace.
iComponent (ExternalExcitation) - external excitation to add.

Returns: bool

swap(iIndex, iIndex)

Swaps two external excitations.

Parameters:

iIndex (int) - Index of the first external excitation.
iIndex (int) - Index of the second external excitation.

Returns: None