upsimulator.interfaces

Class BasicName

java.lang.Object

upsimulator.interfaces.BasicName

All Implemented Interfaces:

Dimensional, Name

Direct Known Subclasses:

BooleanCondition, MembraneCreateResult, ObjectConditionsWithTarget, PMembrane, PObject, PositionResult, PositionResult.Target, PRule

public class BasicName
extends java.lang.Object
implements Name

Constructor Summary

Constructors

Constructor and Description
BasicName()
BasicName(BasicName dimensional)
BasicName(java.lang.String name)
BasicName(java.lang.String name, java.util.ArrayList<Dimension> dimensions)
BasicName(java.lang.String name, java.util.ArrayList<Dimension> dimensions, boolean fixed)
BasicName(java.lang.String name, java.lang.String... dimensions)

Method Summary

Modifier and Type	Method and Description
void	addDimension(Dimension dimension) Add new dimensions to an instance of Dimensional.
void	addDimension(java.lang.Long dimension) Add new fixed dimensions to an instance of Dimensional.
void	addDimension(java.lang.String dimension) Add new formula dimensions to an instance of dimension.
BasicName	deepClone() Clone the name
void	fix(java.util.Map<java.lang.String,java.lang.Object> mappedValues) Fix all the dimension by calculating them using the mapped values
Dimension	get(int i) Get the i-th dimension
java.util.ArrayList<Dimension>	getDimensions() Get all the dimensions of an instance
int	getDimensionSize() Return the number of total dimensions
java.lang.String	getName() Get the name
java.lang.String	getNameDim() Get the name with dimensions.
boolean	isFixed() Check if all the dimensions are fixed
java.util.List<java.lang.Long[]>	predictPossibleValue(Membrane membrane, java.util.List<Dimension> dList) Predict the possible values in this membrane
java.util.List<java.lang.Long[]>	predictPossibleValueOfNeighbor(Membrane membrane, java.util.List<Dimension> dList)
java.util.List<java.lang.Long[]>	predictPossibleValueOfObjects(Membrane membrane, java.util.List<Dimension> dList)
java.util.List<java.lang.Long[]>	predictPossibleValueOfSubmembrane(Membrane membrane, java.util.List<Dimension> dList)
void	setName(java.lang.String name) Set the name

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicName

public BasicName()

BasicName

public BasicName(java.lang.String name)

BasicName

public BasicName(java.lang.String name,
                 java.lang.String... dimensions)

BasicName

public BasicName(java.lang.String name,
                 java.util.ArrayList<Dimension> dimensions)

BasicName

public BasicName(java.lang.String name,
                 java.util.ArrayList<Dimension> dimensions,
                 boolean fixed)

BasicName

public BasicName(BasicName dimensional)

Method Detail

addDimension

public void addDimension(Dimension dimension)

Description copied from interface: Dimensional

Add new dimensions to an instance of Dimensional. For example, a[i+1] have a dimension i+1 and i+1 should be added to a.

Specified by:

addDimension in interface Dimensional

Parameters:

dimension - dimensions

addDimension

public void addDimension(java.lang.Long dimension)

Description copied from interface: Dimensional

Add new fixed dimensions to an instance of Dimensional. For example, a[1] have a dimension 1 and 1 should be added to a.

Specified by:

addDimension in interface Dimensional

Parameters:

dimension - dimensions

addDimension

public void addDimension(java.lang.String dimension)

Description copied from interface: Dimensional

Add new formula dimensions to an instance of dimension. For example, a[i+1] have a dimension i+1 and i+1 should be added to a.

Specified by:

addDimension in interface Dimensional

Parameters:

dimension - dimensions

getDimensions

public java.util.ArrayList<Dimension> getDimensions()

Description copied from interface: Dimensional

Get all the dimensions of an instance

Specified by:

getDimensions in interface Dimensional

Returns:

dimensions

fix

public void fix(java.util.Map<java.lang.String,java.lang.Object> mappedValues)

Description copied from interface: Dimensional

Fix all the dimension by calculating them using the mapped values

Specified by:

fix in interface Dimensional

Parameters:

mappedValues - mapped values

isFixed

public boolean isFixed()

Description copied from interface: Dimensional

Check if all the dimensions are fixed

Specified by:

isFixed in interface Dimensional

Returns:

true if all the dimensions are fixed, and if getDimensionSize()==0 return true, else return false

getDimensionSize

public int getDimensionSize()

Description copied from interface: Dimensional

Return the number of total dimensions

Specified by:

getDimensionSize in interface Dimensional

Returns:

the number of total dimensions

setName

public void setName(java.lang.String name)

Description copied from interface: Name

Set the name

Specified by:

setName in interface Name

Parameters:

name - name of object, rule, or membrane

getNameDim

public java.lang.String getNameDim()

Description copied from interface: Name

Get the name with dimensions. For example, object a has a dimension 2, then the return value is a[2].

Specified by:

getNameDim in interface Name

Returns:

string combined name and dimensions

getName

public java.lang.String getName()

Description copied from interface: Name

Get the name

Specified by:

getName in interface Name

Returns:

name

get

public Dimension get(int i)

Description copied from interface: Dimensional

Get the i-th dimension

Specified by:

get in interface Dimensional

Parameters:

i - index of dimension wanted

Returns:

i-th dimension

deepClone

public BasicName deepClone()

Description copied from interface: Name

Clone the name

Specified by:

deepClone in interface Dimensional

Specified by:

deepClone in interface Name

Returns:

name

predictPossibleValue

public java.util.List<java.lang.Long[]> predictPossibleValue(Membrane membrane,
                                                             java.util.List<Dimension> dList)

Description copied from interface: Dimensional

Predict the possible values in this membrane

Specified by:

predictPossibleValue in interface Dimensional

Parameters:

membrane - targetMembrane

dList - the list of dimensions which want to be predicted their value

Returns:

possible value list for all dimensions. If dimension is fixed, null will be returned

predictPossibleValueOfObjects

public java.util.List<java.lang.Long[]> predictPossibleValueOfObjects(Membrane membrane,
                                                                      java.util.List<Dimension> dList)

predictPossibleValueOfSubmembrane

public java.util.List<java.lang.Long[]> predictPossibleValueOfSubmembrane(Membrane membrane,
                                                                          java.util.List<Dimension> dList)

predictPossibleValueOfNeighbor

public java.util.List<java.lang.Long[]> predictPossibleValueOfNeighbor(Membrane membrane,
                                                                       java.util.List<Dimension> dList)