Package empro :: Module empro :: Class WaveGuideList

Class WaveGuideList

core.Updatable --+    
                 |    
   core.Selectable --+
                     |
                    WaveGuideList

Manages the list of wave guides.

Class Hierarchy for WaveGuideList

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 wave guide to the list.

WaveGuide

at(iName)
Returns the circuit component by name.

None

clear()
Clear the list.

bool

contains(iComponentDef)
Determines if the circuit component is in the list.

int

index(iComponent)
Retrieves the index of a wave guide.

bool

insert(iIndex, iComponent)
Inserts a wave guide into the list.

list{string}

names()
Returns the names of the wave guides in the list.

bool

remove(iIndex)
Removes a circuit component.

bool

replace(iIndex, iComponent)
Replaces a circuit component.

int

size()
Returns the size of the list.

None

swap(iIndex, iIndex)
Swaps two wave guides.

undoableAppend(...)
No documentation available.

undoableReplace(...)
No documentation available.

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 wave guide to the list.

Parameters:

iComponent (WaveGuide) - Wave guide to add.

Returns: bool

at(iName)

Returns the circuit component by name.

Parameters:

iName (string) - Name of the requested wave guide.

Returns: WaveGuide

contains(iComponentDef)

Determines if the circuit component is in the list.

Parameters:

iComponentDef (WaveGuide) - Wave guide to query.

Returns: bool

index(iComponent)

Retrieves the index of a wave guide.

Parameters:

iComponent (WaveGuide) - Wave guide to query.

Returns: int

insert(iIndex, iComponent)

Inserts a wave guide into the list.

Parameters:

iIndex (int) - Index of where to insert the new element.
iComponent (WaveGuide) - Wave guide to add.

Returns: bool

remove(iIndex)

Removes a circuit component.

Parameters:

iIndex (int) - Index of the wave guide to remove.

Returns: bool

replace(iIndex, iComponent)

Replaces a circuit component.

Parameters:

iIndex (int) - Index of which element to replace.
iComponent (WaveGuide) - Wave guide to add.

Returns: bool

swap(iIndex, iIndex)

Swaps two wave guides.

Parameters:

iIndex (int) - Index of the first wave guide.
iIndex (int) - Index of the second wave guide.

Returns: None