Package empro :: Module empro :: Class CircuitComponentDefinitionList

Class CircuitComponentDefinitionList

core.Updatable --+    
                 |    
   core.Selectable --+
                     |
                    CircuitComponentDefinitionList

Manages the list of circuit component definitions.

Class Hierarchy for CircuitComponentDefinitionList

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(iComponentDef)
Appends a circuit component definition to the list.

CircuitComponentDefinition

at(iName)
Returns the circuit component definition by name.

None

clear()
Clear the list.

bool

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

int

index(iComponentDef)
Retrieves the index of a circuit component definition.

bool

insert(iIndex, iComponentDef)
Inserts a circuit component definition into the list.

list{string}

names()
Returns the names of the circuit component definitions in the list.

bool

remove(iIndex)
Removes a circuit component definition.

bool

replace(iIndex, iComponentDef)
Replaces a circuit component definition.

int

size()
Returns the size of the list.

None

swap(iIndex, iIndex)
Swaps two circuit component definitions.

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

Appends a circuit component definition to the list.

Parameters:

iComponentDef (CircuitComponentDefinition) - Circuit component definition to add.

Returns: bool

at(iName)

Returns the circuit component definition by name.

Parameters:

iName (string) - Name of the requested circuit component definition.

Returns: CircuitComponentDefinition

contains(iComponentDef)

Determines if the circuit component definition is in the list.

Parameters:

iComponentDef (CircuitComponentDefinition) - Circuit component definition to query.

Returns: bool

index(iComponentDef)

Retrieves the index of a circuit component definition.

Parameters:

iComponentDef (CircuitComponentDefinition) - Circuit component definition to query.

Returns: int

insert(iIndex, iComponentDef)

Inserts a circuit component definition into the list.

Parameters:

iIndex (int) - Index of where to insert the new element.
iComponentDef (CircuitComponentDefinition) - Circuit component definition to add.

Returns: bool

remove(iIndex)

Removes a circuit component definition.

Parameters:

iIndex (int) - Index of the circuit component definition to remove.

Returns: bool

replace(iIndex, iComponentDef)

Replaces a circuit component definition.

Parameters:

iIndex (int) - Index of which element to replace.
iComponentDef (CircuitComponentDefinition) - Circuit component definition to add.

Returns: bool

swap(iIndex, iIndex)

Swaps two circuit component definitions.

Parameters:

iIndex (int) - Index of the first circuit component definition.
iIndex (int) - Index of the second circuit component definition.

Returns: None