Package empro :: Module empro :: Module geometry :: Class Recipe

Class Recipe

core.Updatable --+    
                 |    
   core.Selectable --+
                     |
                    Recipe

Interface to a recipe to build a model. A recipe uses different Features to describe the construction of a Model.

Class Hierarchy for Recipe

constructor Recipe(): Constructs an empty recipe.

Instance Methods

__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

None

append(iFeature)
Append a Feature to the back of the recipe.

Feature

at(iIndex)
Returns the Feature at the given index.

Feature

child(iIndex)
Returns the Feature at the given index.

None

clear()
Removes all Features from the recipe.

contains(...)
No documentation available.

getBackupBody(...)
No documentation available.

getBody(...)
No documentation available.

int

index(iFeature)
Returns the index of given Feature.

None

insert(iIndex, iFeature)
Inserts a Feature at the given index.

bool

isEmpty()
Returns True when the recipe is empty.

None

remove(iIndex)
Removes the Feature at the given index.

int

size()
Returns the number of Features in this recipe.

None

swap(iIndex1, iIndex2)
Swaps two Features.

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

Append a Feature to the back of the recipe.

Parameters:

iFeature (Feature) - The Feature to append.

Returns: None

at(iIndex)

Returns the Feature at the given index.

Parameters:

iIndex (int) - The index of the given Feature.

Returns: Feature

child(iIndex)

Returns the Feature at the given index.

Parameters:

iIndex (int) - The index of the given Feature.

Returns: Feature

index(iFeature)

Returns the index of given Feature.

Parameters:

iFeature (Feature) - The Feature to query.

Returns: int

insert(iIndex, iFeature)

Inserts a Feature at the given index.

Parameters:

iIndex (int) - The index to insert at.
iFeature (Feature) - The Feature to insert.

Returns: None

remove(iIndex)

Removes the Feature at the given index.

Parameters:

iIndex (int) - The index of the given Feature.

Returns: None

swap(iIndex1, iIndex2)

Swaps two Features.

Parameters:

iIndex1 (int) - The first index to swap.
iIndex2 (int) - The second index to swap.

Returns: None