Package empro :: Module empro :: Class WaveformList

Class WaveformList

core.Updatable --+    
                 |    
   core.Selectable --+
                     |
                    WaveformList

Manages the list of waveforms.

Class Hierarchy for WaveformList

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(iWaveform)
Appends a waveform to the list.

Waveform

at(iName)
Returns the waveform by name.

None

clear()
Clear the list.

bool

contains(iWaveform)
Determines if the waveform is in the list.

int

index(iWaveform)
Retrieves the index of a waveform.

bool

insert(iIndex, iWaveform)
Inserts a waveform into the list.

list{string}

names()
Returns the names of the waveforms in the list.

bool

remove(iIndex)
Removes a waveform.

bool

replace(iIndex, iWaveform)
Replaces a waveform.

int

size()
Returns the size of the list.

None

swap(iIndex, iIndex)
Swaps two waveforms.

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(iWaveform)

Appends a waveform to the list.

Parameters:

iWaveform (Waveform) - Waveform to add.

Returns: bool

at(iName)

Returns the waveform by name.

Parameters:

iName (string) - Name of the requested waveform.

Returns: Waveform

contains(iWaveform)

Determines if the waveform is in the list.

Parameters:

iWaveform (Waveform) - Waveform to query.

Returns: bool

index(iWaveform)

Retrieves the index of a waveform.

Parameters:

iWaveform (Waveform) - Waveform to query.

Returns: int

insert(iIndex, iWaveform)

Inserts a waveform into the list.

Parameters:

iIndex (int) - Index of where to insert the new element.
iWaveform (Waveform) - Waveform to add.

Returns: bool

remove(iIndex)

Removes a waveform.

Parameters:

iIndex (int) - Index of the waveform to remove.

Returns: bool

replace(iIndex, iWaveform)

Replaces a waveform.

Parameters:

iIndex (int) - Index of which waveform to replace.
iWaveform (Waveform) - Waveform to add.

Returns: bool

swap(iIndex, iIndex)

Swaps two waveforms.

Parameters:

iIndex (int) - Index of the first waveform.
iIndex (int) - Index of the second waveform.

Returns: None