bio.singa.simulation.model.sections

Enum CellTopology

java.lang.Object

java.lang.Enum<CellTopology>

bio.singa.simulation.model.sections.CellTopology

All Implemented Interfaces:

Serializable, Comparable<CellTopology>

public enum CellTopology
extends Enum<CellTopology>

The cell topology defines how the subsections are spatially organized. A subsection is considered inner if a membrane is enclosing the subsection, isolating it from outer influences. A subsection is considered membrane, when it separates inside and outside of a cell section. For example the nucleus region of the cell could have the following topologies: INNER: nucleoplasm, MEMBRANE: nuclear envelope and OUTER: Cytoplasm.

Author:

cl

Enum Constant Summary

Enum Constants

Enum Constant and Description
INNER A membrane is enclosing this subsection.
MEMBRANE The membrane separating inner and outer subsections.
OUTER A membrane is separating this subsection form the inner subsection.

Method Summary

Modifier and Type	Method and Description
static CellTopology	valueOf(String name) Returns the enum constant of this type with the specified name.
static CellTopology[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INNER

public static final CellTopology INNER

A membrane is enclosing this subsection.

OUTER

public static final CellTopology OUTER

A membrane is separating this subsection form the inner subsection.

MEMBRANE

public static final CellTopology MEMBRANE

The membrane separating inner and outer subsections.

Method Detail

values

public static CellTopology[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CellTopology c : CellTopology.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CellTopology valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null