import Cell from 'Artistoo/src/cells/Cell.js'
public class | source

Cell

Direct Subclass:

Divider

Constructor Summary

Public Constructor
public

constructor(conf: object, kind: CellKind, C: CPMEvol, id: CellId)

The constructor of class Cell.

Member Summary

Public Members
public

C: *

public

conf: *

public

id: *

public

kind: *

public

The id of the parent cell, all seeded cells have parent -1, to overwrite this this.birth(parent) needs to be called @type{number}

public get

vol: Number: *

Get the current volume of this cell

Method Summary

Public Methods
public

birth(parent: Cell)

Adds parentId number, and can be overwritten to execute functionality on birth events.

public

death()

This is called upon death events.

Public Constructors

public constructor(conf: object, kind: CellKind, C: CPMEvol, id: CellId) source

The constructor of class Cell.

Params:

NameTypeAttributeDescription
conf object

configuration settings of the simulation, containing the relevant parameters. Note: this should include all constraint parameters.

kind CellKind

the cellkind of this cell, the parameters of kind are used when parameters are not explicitly overwritten

C CPMEvol

the CPM - used among others to draw random numbers

id CellId

the CellId of this cell (its key in the CPM.cells), unique identifier

Public Members

public C: * source

public conf: * source

public id: * source

public kind: * source

public parentId: * source

The id of the parent cell, all seeded cells have parent -1, to overwrite this this.birth(parent) needs to be called @type{number}

public get vol: Number: * source

Get the current volume of this cell

Return:

Number

volume of this cell

Public Methods

public birth(parent: Cell) source

Adds parentId number, and can be overwritten to execute functionality on birth events.

Params:

NameTypeAttributeDescription
parent Cell

the parent Cell object

public death() source

This is called upon death events. Can be redefined in subclasses