upsimulator.interfaces

Interface Membrane

All Superinterfaces:

java.lang.Cloneable, Dimensional, Name

All Known Implementing Classes:

PMembrane

public interface Membrane
extends Name, java.lang.Cloneable

Represents a membrane which contains objects, rules, dimensions

Author:

quan

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.HashMap<java.lang.String,Membrane>	membraneClass
static java.util.HashMap<java.lang.String,java.lang.Boolean>	membraneClassStatus

Method Summary

Modifier and Type	Method and Description
default void	addChild(java.lang.Class<?> tunnelClass, Membrane child) Add a child to this membrane
void	addListener(MembraneListener listener) Add a listener to this membrane
void	addObject(Obj object, java.lang.Number num) Add object to this membrane
void	addRule(Rule rule) Add a new rule
void	addTunnel(Tunnel t) Add a tunnel between two membranes.
Membrane	deepClone() Deep clone a membrane
void	delete() Delete a membrane.
void	extend(Membrane template) Extend a template
java.util.Map<Rule,java.lang.Integer>	fetch() All the satisfied rules try to fetch the objects they need
default java.util.List<Membrane>	getChildren() Get all the children to whom this membrane has a in tunnel
static Membrane	getMemClass(java.lang.String name) Get the template of one membrane class
static Membrane	getMemInstanceOf(java.lang.String membraneName) Create an instance of a membrane class
default java.util.List<Membrane>	getNeighbors() Get all the neighbors to whom this membrane has a go tunnel
java.lang.Number	getNumOf(Obj object) Get the quantity of object
java.util.Map<Obj,java.lang.Number>	getObjects() Get all the objects contained in this membrane
default Membrane	getParent() Get the parent membrane of this membrane
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
java.lang.Object	getProperty(java.lang.String propertyName) Get the property's value of this membrane
java.util.List<Rule>	getRules() Get all the rules contained in this membrane
Tunnel	getTunnel(Tunnel.TunnelType type, java.lang.String target) Get the tunnel from current to target
java.util.List<Tunnel>	getTunnels() Get all the tunnels of current membrane
java.util.Map<Rule,java.lang.Integer>	getUsableRules() Check all the rules inside if they are satisfied, and return all the usable rules.
boolean	isDeleted() Return if this membrane is deleted.
static boolean	isPredefinedMem(java.lang.String membraneName) Check if a name is the name of one predefined membrane class
void	newStepInit() Remove runtime properties whose name starts with $ and initialize this membrane for a new simulation
boolean	reduceObject(Obj object, java.lang.Number num) Reduce object in this membrane
static void	registMemClass(java.lang.String name, Membrane membrane, boolean predefined) Register a Membrane Class
void	removeListener(MembraneListener listener) Remove a listener from this membrane
default void	removeTunnel(Tunnel t) Remove a tunnel from this membranes.
java.util.Map<Rule,java.lang.Integer>	setProducts() Set products of rules
void	setProperty(java.lang.String propertyName, java.lang.Object propertyValue) Set property of membrane
java.lang.String	toString(java.lang.String space, boolean withObject, boolean withProp, boolean withRule, boolean withSubmembrane, boolean withTunnel)

Methods inherited from interface upsimulator.interfaces.Name

getName, getNameDim, setName

Methods inherited from interface upsimulator.interfaces.Dimensional

addDimension, addDimension, addDimension, fix, get, getDimensions, getDimensionSize, isFixed, predictPossibleValue

Field Detail

membraneClass

static final java.util.HashMap<java.lang.String,Membrane> membraneClass

membraneClassStatus

static final java.util.HashMap<java.lang.String,java.lang.Boolean> membraneClassStatus

Method Detail

registMemClass

static void registMemClass(java.lang.String name,
                           Membrane membrane,
                           boolean predefined)

Register a Membrane Class

Parameters:

name - name of membrane class

membrane - template of membrane class

predefined - if it is a predefined membrane class. Predefined membrane classes can be membranes which use Java code to implement Membrane interface, other than use UPLanguage to define a membrane class.

getMemInstanceOf

static Membrane getMemInstanceOf(java.lang.String membraneName)

Create an instance of a membrane class

Parameters:

membraneName - the name of membrane class

Returns:

an instance or null if membrane class required does not exist

isPredefinedMem

static boolean isPredefinedMem(java.lang.String membraneName)

Check if a name is the name of one predefined membrane class

Parameters:

membraneName - the name used to check

Returns:

return true if the name is registered as a predefined membrane class, else return false

getMemClass

static Membrane getMemClass(java.lang.String name)

Get the template of one membrane class

Parameters:

name - the name of membrane class

Returns:

template membrane

newStepInit

void newStepInit()

Remove runtime properties whose name starts with $ and initialize this membrane for a new simulation

getNumOf

java.lang.Number getNumOf(Obj object)

Get the quantity of object

Parameters:

object - P object

Returns:

the quantity of object

addObject

void addObject(Obj object,
               java.lang.Number num)

Add object to this membrane

Parameters:

object - the new added object

num - the quantity of object

reduceObject

boolean reduceObject(Obj object,
                     java.lang.Number num)

Reduce object in this membrane

Parameters:

object - the object which will be reduced

num - the reduced quantity

Returns:

if the object's quantity is greater than num, then reduce it and return true

getObjects

java.util.Map<Obj,java.lang.Number> getObjects()

Get all the objects contained in this membrane

Returns:

objects and their quantity

addRule

void addRule(Rule rule)

Add a new rule

Parameters:

rule - A new rule

getRules

java.util.List<Rule> getRules()

Get all the rules contained in this membrane

Returns:

All the rules

addTunnel

void addTunnel(Tunnel t)

Add a tunnel between two membranes.

Parameters:

t - the tunnel between two membrane, through it the results of rules can be set.

removeTunnel

default void removeTunnel(Tunnel t)

Remove a tunnel from this membranes.

Parameters:

t - the tunnel between two membrane, through it the results of rules can be set.

getTunnel

Tunnel getTunnel(Tunnel.TunnelType type,
                 java.lang.String target)

Get the tunnel from current to target

Parameters:

type - the type of the tunnel

target - the name of the target membrane. It can be null if the type is Out, Here, in/go all/random.

Returns:

the tunnel to target. Null will be returned if not found.

getTunnels

java.util.List<Tunnel> getTunnels()

Get all the tunnels of current membrane

Returns:

All the tunnels of current membrane

delete

void delete()

Delete a membrane.

Close all the tunnels and set current membrane deleted

isDeleted

boolean isDeleted()

Return if this membrane is deleted.

Returns:

if this membrane is deleted, return true

getUsableRules

java.util.Map<Rule,java.lang.Integer> getUsableRules()
                                              throws UnpredictableDimensionException,
                                                     java.lang.CloneNotSupportedException

Check all the rules inside if they are satisfied, and return all the usable rules.

• Maximum parallelism and minimum parallelism can be controlled by editing the returned list.
• Inhibitors and promoters and other nonconsumption conditions can be checked first.

Returns:

All the usable rules and satisfied times

Throws:

java.lang.CloneNotSupportedException - if some rules, objects, cannot be cloned

UnpredictableDimensionException - if there exist unpredictable dimension, such as the dimension of one rule only appears at a inhibitor

fetch

java.util.Map<Rule,java.lang.Integer> fetch()
                                     throws TunnelNotExistException

All the satisfied rules try to fetch the objects they need

Returns:

the quantity of rules which have fetched the objects

Throws:

TunnelNotExistException - If one rule want to get a neighbor of this membrane and no tunnel was found

setProducts

java.util.Map<Rule,java.lang.Integer> setProducts()

Set products of rules

Returns:

the rules have set their product successfully

toString

java.lang.String toString(java.lang.String space,
                          boolean withObject,
                          boolean withProp,
                          boolean withRule,
                          boolean withSubmembrane,
                          boolean withTunnel)

Parameters:

space - put in the front of items

withObject - whether show objects or not

withProp - whether show properties or not

withRule - whether show rules or not

withSubmembrane - whether show sub-membranes or not

withTunnel - whether show tunnels

Returns:

a string which represents this membrane

deepClone

Membrane deepClone()

Deep clone a membrane

Specified by:

deepClone in interface Dimensional

Specified by:

deepClone in interface Name

Returns:

the cloned membrane

setProperty

void setProperty(java.lang.String propertyName,
                 java.lang.Object propertyValue)

Set property of membrane

Parameters:

propertyName - the name of property

propertyValue - the value of property

getProperty

java.lang.Object getProperty(java.lang.String propertyName)

Get the property's value of this membrane

Parameters:

propertyName - the name of property

Returns:

property's value. If property doesn't exist in this membrane, null will be returned.

getProperties

java.util.Map<java.lang.String,java.lang.Object> getProperties()

Returns:

all the properties of this membrane

addListener

void addListener(MembraneListener listener)

Add a listener to this membrane

Parameters:

listener - a membrane listener

removeListener

void removeListener(MembraneListener listener)

Remove a listener from this membrane

Parameters:

listener - the listener you want to remove

extend

void extend(Membrane template)

Extend a template

Parameters:

template - template membrane

getChildren

default java.util.List<Membrane> getChildren()

Get all the children to whom this membrane has a in tunnel

Returns:

all the children

getNeighbors

default java.util.List<Membrane> getNeighbors()

Get all the neighbors to whom this membrane has a go tunnel

Returns:

all the neighbors

getParent

default Membrane getParent()

Get the parent membrane of this membrane

Returns:

parent membrane or null if parent membrane does not exist

addChild

default void addChild(java.lang.Class<?> tunnelClass,
                      Membrane child)

Add a child to this membrane

Parameters:

tunnelClass - the tunnel class of the two membrane

child - child membrane