upsimulator.core

Class PMembrane

java.lang.Object

upsimulator.interfaces.BasicName

upsimulator.core.PMembrane

All Implemented Interfaces:

java.lang.Cloneable, Dimensional, Membrane, MembraneListener, Name

public class PMembrane
extends BasicName
implements Membrane, MembraneListener

The default membrane implementation, a container of objects, rules, tunnels, and properties.

Author:

quan

Field Summary

Fields inherited from interface upsimulator.interfaces.Membrane

membraneClass, membraneClassStatus

Constructor Summary

Constructors

Constructor and Description
PMembrane() Create an empty membrane with no name
PMembrane(java.lang.String name) Create an empty membrane with a name

Method Summary

Modifier and Type	Method and Description
void	addChild(java.lang.Class<?> tunnelClass, Membrane child) Add a child to this membrane
void	addDimension(java.lang.String formula) Add new formula dimensions to an instance of dimension.
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.
PMembrane	deepClone() Clone the name
void	delete() Delete a membrane.
void	endChecking(Membrane membrane) End checking all rules if some of them are satisfied
void	endFetching(Membrane membrane) End fetching all the satisfied rules
void	endSetting(Membrane membrane) End setting product in this membrane include all its sub-membranes.
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
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
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.HashMap<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.
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
void	removeListener(MembraneListener listener) Remove a listener from this membrane
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
void	startChecking(Membrane membrane) Start to check all rules if some of them are satisfied
void	startFetching(Membrane membrane) Start to fetch all the satisfied rules
void	startSetting(Membrane membrane) Start to set product in this membrane
java.lang.String	toString()
java.lang.String	toString(java.lang.String space, boolean withObject, boolean withProp, boolean withRule, boolean withSubmembrane, boolean withTunnel)

Methods inherited from class upsimulator.interfaces.BasicName

addDimension, addDimension, fix, get, getDimensions, getDimensionSize, getName, getNameDim, isFixed, predictPossibleValue, predictPossibleValueOfNeighbor, predictPossibleValueOfObjects, predictPossibleValueOfSubmembrane, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface upsimulator.interfaces.Membrane

getChildren, getMemClass, getMemInstanceOf, getNeighbors, getParent, isPredefinedMem, registMemClass, removeTunnel

Methods inherited from interface upsimulator.interfaces.Name

getName, getNameDim, setName

Methods inherited from interface upsimulator.interfaces.Dimensional

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

Constructor Detail

PMembrane

public PMembrane(java.lang.String name)

Create an empty membrane with a name

Parameters:

name - membrane name

PMembrane

public PMembrane()

Create an empty membrane with no name

Method Detail

deepClone

public PMembrane deepClone()

Description copied from interface: Name

Clone the name

Specified by:

deepClone in interface Dimensional

Specified by:

deepClone in interface Membrane

Specified by:

deepClone in interface Name

Overrides:

deepClone in class BasicName

Returns:

name

getNumOf

public java.lang.Number getNumOf(Obj object)

Description copied from interface: Membrane

Get the quantity of object

Specified by:

getNumOf in interface Membrane

Parameters:

object - P object

Returns:

the quantity of object

addObject

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

Description copied from interface: Membrane

Add object to this membrane

Specified by:

addObject in interface Membrane

Parameters:

object - the new added object

num - the quantity of object

reduceObject

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

Description copied from interface: Membrane

Reduce object in this membrane

Specified by:

reduceObject in interface 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

addRule

public void addRule(Rule rule)

Description copied from interface: Membrane

Add a new rule

Specified by:

addRule in interface Membrane

Parameters:

rule - A new rule

getObjects

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

Description copied from interface: Membrane

Get all the objects contained in this membrane

Specified by:

getObjects in interface Membrane

Returns:

objects and their quantity

getUsableRules

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

Description copied from interface: Membrane

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.

Specified by:

getUsableRules in interface Membrane

Returns:

All the usable rules and satisfied times

Throws:

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

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

fetch

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

Description copied from interface: Membrane

All the satisfied rules try to fetch the objects they need

Specified by:

fetch in interface Membrane

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

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

Description copied from interface: Membrane

Set products of rules

Specified by:

setProducts in interface Membrane

Returns:

the rules have set their product successfully

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

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

Specified by:

toString in interface Membrane

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

setProperty

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

Description copied from interface: Membrane

Set property of membrane

Specified by:

setProperty in interface Membrane

Parameters:

propertyName - the name of property

propertyValue - the value of property

getProperty

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

Description copied from interface: Membrane

Get the property's value of this membrane

Specified by:

getProperty in interface Membrane

Parameters:

propertyName - the name of property

Returns:

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

getRules

public java.util.List<Rule> getRules()

Description copied from interface: Membrane

Get all the rules contained in this membrane

Specified by:

getRules in interface Membrane

Returns:

All the rules

addDimension

public void addDimension(java.lang.String formula)

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

Overrides:

addDimension in class BasicName

Parameters:

formula - dimensions

extend

public void extend(Membrane template)

Description copied from interface: Membrane

Extend a template

Specified by:

extend in interface Membrane

Parameters:

template - template membrane

getProperties

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

Specified by:

getProperties in interface Membrane

Returns:

all the properties of this membrane

delete

public void delete()

Description copied from interface: Membrane

Delete a membrane.

Close all the tunnels and set current membrane deleted

Specified by:

delete in interface Membrane

isDeleted

public boolean isDeleted()

Description copied from interface: Membrane

Return if this membrane is deleted.

Specified by:

isDeleted in interface Membrane

Returns:

if this membrane is deleted, return true

newStepInit

public void newStepInit()

Description copied from interface: Membrane

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

Specified by:

newStepInit in interface Membrane

addTunnel

public void addTunnel(Tunnel t)

Description copied from interface: Membrane

Add a tunnel between two membranes.

Specified by:

addTunnel in interface Membrane

Parameters:

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

getTunnel

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

Description copied from interface: Membrane

Get the tunnel from current to target

Specified by:

getTunnel in interface Membrane

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

public java.util.List<Tunnel> getTunnels()

Description copied from interface: Membrane

Get all the tunnels of current membrane

Specified by:

getTunnels in interface Membrane

Returns:

All the tunnels of current membrane

addChild

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

Description copied from interface: Membrane

Add a child to this membrane

Specified by:

addChild in interface Membrane

Parameters:

tunnelClass - the tunnel class of the two membrane

child - child membrane

addListener

public void addListener(MembraneListener listener)

Description copied from interface: Membrane

Add a listener to this membrane

Specified by:

addListener in interface Membrane

Parameters:

listener - a membrane listener

removeListener

public void removeListener(MembraneListener listener)

Description copied from interface: Membrane

Remove a listener from this membrane

Specified by:

removeListener in interface Membrane

Parameters:

listener - the listener you want to remove

startChecking

public void startChecking(Membrane membrane)

Description copied from interface: MembraneListener

Start to check all rules if some of them are satisfied

Specified by:

startChecking in interface MembraneListener

Parameters:

membrane - this membrane

endChecking

public void endChecking(Membrane membrane)

Description copied from interface: MembraneListener

End checking all rules if some of them are satisfied

Specified by:

endChecking in interface MembraneListener

Parameters:

membrane - this membrane

startFetching

public void startFetching(Membrane membrane)

Description copied from interface: MembraneListener

Start to fetch all the satisfied rules

Specified by:

startFetching in interface MembraneListener

Parameters:

membrane - this membrane

endFetching

public void endFetching(Membrane membrane)

Description copied from interface: MembraneListener

End fetching all the satisfied rules

Specified by:

endFetching in interface MembraneListener

Parameters:

membrane - this membrane

startSetting

public void startSetting(Membrane membrane)

Description copied from interface: MembraneListener

Start to set product in this membrane

Specified by:

startSetting in interface MembraneListener

Parameters:

membrane - this membrane

endSetting

public void endSetting(Membrane membrane)

Description copied from interface: MembraneListener

End setting product in this membrane include all its sub-membranes. Listeners only can be removed in this function

Specified by:

endSetting in interface MembraneListener

Parameters:

membrane - this membrane