Struct CellBox

pub struct CellBox<C> {
    pub identifier: CellIdentifier,
    pub parent: Option<CellIdentifier>,
    pub cell: C,
}

Available on crate feature chili only.

Wrapper around the user-defined CellAgent

This wrapper serves to provide a unique identifier and the option to specify the parent of the current cell.

Fields

identifier: CellIdentifier

The identifier is composed of two values, one for the voxel index in which the object was created and another one which counts how many elements have already been created there.

parent: Option<CellIdentifier>

Identifier of the parent cell if this cell was created by cell-division

cell: C

The cell which is encapsulated by this box.

Implementations

impl<C> CellBox<C>

pub fn new( voxel_index: VoxelPlainIndex, n_cell: u64, cell: C, parent: Option<CellIdentifier>, ) -> CellBox<C>

Available on crate feature cpu_os_threads only.

Create a new CellBox at a specific voxel with a voxel-unique number of cells that has already been created at this position.

Trait Implementations

impl<C> Clone for CellBox<C>

where C: Clone,

fn clone(&self) -> CellBox<C>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C> Deref for CellBox<C>

type Target = C

The resulting type after dereferencing.

fn deref(&self) -> &<CellBox<C> as Deref>::Target

Dereferences the value.

impl<C> DerefMut for CellBox<C>

fn deref_mut(&mut self) -> &mut <CellBox<C> as Deref>::Target

Mutably dereferences the value.

impl<'de, C> Deserialize<'de> for CellBox<C>

where C: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<CellBox<C>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C> Id for CellBox<C>

type Identifier = CellIdentifier

The identifier type is usually chosen to be completely unique and repeatable across different simulations.

fn get_id(&self) -> CellIdentifier

Retrieves the Identifier from the object.

fn ref_id(&self) -> &<CellBox<C> as Id>::Identifier

Returns a reference to the id of the object.

impl<C> Serialize for CellBox<C>

where C: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.