HereditaryStratigraphicColumnBundle

class HereditaryStratigraphicColumnBundle

Packages multiple HereditaryStratigraphicColumn instances together.

Allows packaged columns to conveniently advance in sync along a line of descent with a similar interface to an individual HereditaryStratigraphicColumn.

__init__(columns: Dict[str, HereditaryStratigraphicColumn])

Construct bundle.

Parameters

columnsdict

HereditaryStratigraphicColumn objects to bundle together, each associated with a unique names as its key.

Methods

Clone() → HereditaryStratigraphicColumnBundle

Create a copy of the bundle.

Copy contains identical data but may be freely altered without affecting data within this bundle.

CloneDescendant(stratum_annotation: Any | None = None) → HereditaryStratigraphicColumnBundle

Return a cloned bundle that has had an additional stratum deposited.

Does not alter self.

Parameters

stratum_annotation: any, optional

Optional object to store as an annotation. Allows arbitrary user- provided to be associated with this stratum deposition in the line of descent.

DepositStratum(annotation: Any | None = None) → None

Elapse a generation on all constituent columns.

Parameters

annotation: any, optional

Optional object to store as an annotation. Allows arbitrary user- provided to be associated with this stratum’s generation in its line of descent.

GetNumStrataDeposited() → int

How many strata have been deposited on constituent columns?

Should be identical across constituent columns.

__init__(columns: Dict[str, HereditaryStratigraphicColumn])

Construct bundle.

Parameters

columnsdict

HereditaryStratigraphicColumn objects to bundle together, each associated with a unique names as its key.