EquNet (MochyCore 2.0.3-SNAPSHOT API)

java.lang.Object
- fr.inria.mochy.core.abstractClass.PhysicalModel
- - fr.inria.mochy.core.equalization.EquNet

Direct Known Subclasses:

EquNetNeural, EquNetStopsLoic, EquNetV1Fix, EquNetV1Mov, EquNetV2Fix, EquNetV2Mov, EquNetV3Fix, EquNetV3Mov
```
public abstract class EquNet
extends PhysicalModel
```
An EquNet is a Petri-Net which have tokens on a loop with successives transitions and places. The goal of its regulation is to seek to stick to an equal distance between each pair of successive tokens

Field Summary

Fields
Modifier and Type	Field	Description
`HashMap<Integer,EquTransition>`	`blocked`	the list of the blocked transitions e.g.
`HashMap<Integer,EquTransition>`	`enabled`	the list of enabled transitions e.g.
`HashMap<Integer,EquTransition>`	`fireable`	the list of fireable transitions e.g.
`EquPlace`	`garage`	a place which is a garage from where new tokens can be inserted by calling the insertToken method
`HashMap<Integer,Float>`	`initialState`	the pair of place number and the time to browse set to its token at the initial state
`HashMap<Integer,EquPlace>`	`places`	the list of the places which manage the location of a token in the petri nets
`HashMap<Integer,EquTransition>`	`transitions`	the list of the transitions which manage the time in the petri nets

Fields inherited from class fr.inria.mochy.core.abstractClass.PhysicalModel
discreteStep, fname, nbDiscreteSteps, nbTokens, startLogs, stepsNb, timeElapsed, tokens

Constructor Summary

Constructors
Constructor Description

EquNet(String fname)
instanciate the EquNet and set the file name as specified in parameters

Constructors
Constructor	Description
`EquNet(String fname)`	instanciate the EquNet and set the file name as specified in parameters

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`addInFlow(int tnum, int pnum)`	adds a place in the preset of a transition
`protected void`	`addOutFlow(int tnum, int pnum)`	adds a place in the postset of a transition
`Boolean`	`addToken(int p)`	add a token in the place specified in parameter by its number
`void`	`discreteMove()`	perform a discrete move e.g.
`boolean`	`discreteMove(String pathLogs, long elapsedTime, boolean enableLogs)`	perform a discrete move e.g.
`void`	`drop()`	display informations of the network model
`String`	`dropConfig()`	display informations of the configuration of the network model
`PlaceAbstract`	`findPlace(int pname)`	return the place as specified by its number in parameter
`TransitionAbstract`	`findTransition(Integer tname)`	return the transition as specified by its number in parameter
`TransitionAbstract`	`findTransition(String string)`	return the transition as specified by its name in parameter
`ArrayList<TransitionAbstract>`	`fireableTransition()`	return the list of fireable transitions
`float`	`getALPHA()`	A constant for the whole simulation describing adherence to target speed This constant is used when computing an advice of time to browse a moving place for a train can be set in the input file as a line : ALPHA:value
`float`	`getAverage()`	average of the headway distance between the tokens, used in getStandardDeviation method
`float`	`getAvgSpeed()`
`float`	`getClock(Integer transitionNumber)`	get the clock of a transition
`PlaceAbstract`	`getControlPlace(int aplace)`	return a control place as specified by its number in parameter
`HashMap<Integer,? extends PlaceAbstract>`	`getControlPlaces()`	return the list of the control places which can be recovered by their id number
`float`	`getCurrentAvgSpeed()`	get the current average speed of the moving tokens in the EquNet loop
`float`	`getCurrentMaxSpeed()`	the max speed at the current state
`float`	`getCurrentMinSpeed()`	the min speed at the current state of the moving tokens
`float`	`getDistanceInNetwork(Integer tokenNumber)`	get the position of a token in the EquNet
`float`	`getDistanceInPlace(Integer tokenNumber)`	get the position of a token in a place
`HashMap<Integer,? extends TransitionAbstract>`	`getEnabled()`	get the list of the enabled transitions which can be retrieved by their id number
`HashMap<Integer,? extends TransitionAbstract>`	`getFirable()`	get the list of the fireable transitions which can be retrieved by their id number
`float`	`getLastTokenSpeed()`	get the speed of a token which has been inserted into a new place while a discrete step was performed
`float`	`getLastTokenTtb()`	get the time to browse/clock of a token which has been inserted into a new place while a discrete step was performed
`int`	`getNbDiscreteSteps()`	get the number of discrete steps performed
`HashMap<Integer,EquPlace>`	`getPlaces()`	list the places which can be recovered with their number
`static float`	`getRANGE_NOISE()`	the range for the noise in the calculTime method.
`float`	`getSpeed(Integer tokenNumber)`	get the current speed of the token number set in parameter
`float`	`getStandardDeviation()`	return the standard deviation of the distances between the pairs of successive tokens
`float`	`getStandardDeviation(String pathLogs)`	return the standard deviation of the distances between the pairs of successive tokens
`float`	`getTimeElapsed()`	get the time elapsed since the start of the simulation
`float`	`getTimeToBrowse(Integer tokenNumber)`	get the time to browse a place or the time to be elapsed to allow the token to be ready to get to a next place
`LinkedHashMap<Integer,Token>`	`getTokens()`
`float`	`getTotalDistance()`	get the total distance of the loop of the network
`float`	`getTransitionClock(String name)`	get the clock of a transition
`HashMap<Integer,? extends TransitionAbstract>`	`getTransitions()`	list the transitions which can be recovered with their number
`int`	`getWeibullCoef()`	get the coefficient used for the weibull prob.
`protected String`	`handleLine(String readLine, int lineNb)`	load a line of the input file
`void`	`insertToken()`	insert a new token in the net at the garage place
`boolean`	`isBlocked(int tnum)`	return true if the transition specified in parameter by its number is blocked
`boolean`	`isDiscreteMove()`	return true if the last step is a discrete move
`boolean`	`isGaussian()`	return true if the prob.
`boolean`	`isWeibull()`	return true if the prob.
`String`	`loadFile()`	called to load the input model file
`float`	`maxAllowedTimedMove()`	return the allowed timed move to be elapsed to perform a step
`void`	`multipleSteps(int steps)`	perform the number of steps specified in parameter (timed move, discrete move, ...)
`int`	`numberBlocked()`	return the number of blocked transitions
`int`	`numberFireable()`	return the number of fireable transitions
`void`	`reset(boolean init)`	reset the network model to its initial status
`void`	`resetSpeedData()`	used to reset the speed data information used to get average speed on a part of a simulation
`void`	`setALPHA(float aLPHA)`	Set Alpha, A constant for the whole simulation describing adherence to target speed This constant is used when computing an advice of time to browse a moving place for a train can be set in the input file as a line : ALPHA:value
`void`	`setBunchingState(int nbTokens)`	set the net in a bunching state where tokens are grouped in successives places
`static void`	`setRANGE_NOISE(float rANGE_NOISE)`	set the range for the noise in the calculTime method.

Methods inherited from class fr.inria.mochy.core.abstractClass.PhysicalModel
discreteMove, getStepsNb, isDiscreteStep, minimumClock, progressTime

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - transitions
```
public HashMap<Integer,EquTransition> transitions
```
    the list of the transitions which manage the time in the petri nets
  - places
```
public HashMap<Integer,EquPlace> places
```
    the list of the places which manage the location of a token in the petri nets
  - enabled
```
public HashMap<Integer,EquTransition> enabled
```
    the list of enabled transitions e.g. their clock is not 0 but there is tokens in their previous places
  - fireable
```
public HashMap<Integer,EquTransition> fireable
```
    the list of fireable transitions e.g. their clock is 0 and there is tokens in their previous places
  - blocked
```
public HashMap<Integer,EquTransition> blocked
```
    the list of the blocked transitions e.g. there is tokens at the end of the previous places but they are prevent from entering the next place due to minimum safety distance
  - garage
```
public EquPlace garage
```
    a place which is a garage from where new tokens can be inserted by calling the insertToken method
  - initialState
```
public HashMap<Integer,Float> initialState
```
    the pair of place number and the time to browse set to its token at the initial state
- Constructor Detail
  - EquNet
```
public EquNet(String fname)
```
    instanciate the EquNet and set the file name as specified in parameters
- Method Detail
  - loadFile
```
public String loadFile()
```
    Description copied from class: PhysicalModel
    
    called to load the input model file
    
    Specified by:
    
    loadFile in class PhysicalModel
  - handleLine
```
protected String handleLine(String readLine,
                            int lineNb)
```
    load a line of the input file
    
    Parameters:
    
    readLine - the line of the input file
    
    lineNb - the number of the line in the input file
    
    Returns:
    
    logs information as a String
  - addInFlow
```
protected void addInFlow(int tnum,
                         int pnum)
```
    adds a place in the preset of a transition
    
    Parameters:
    
    tnum - the id number of the transition
    
    pnum - the id number of the place
  - addOutFlow
```
protected void addOutFlow(int tnum,
                          int pnum)
```
    adds a place in the postset of a transition
    
    Parameters:
    
    tnum - the transition id number
    
    pnum - the place id number
  - getTransitions
```
public HashMap<Integer,? extends TransitionAbstract> getTransitions()
```
    Description copied from class: PhysicalModel
    
    list the transitions which can be recovered with their number
    
    Specified by:
    
    getTransitions in class PhysicalModel
  - getPlaces
```
public HashMap<Integer,EquPlace> getPlaces()
```
    Description copied from class: PhysicalModel
    
    list the places which can be recovered with their number
    
    Specified by:
    
    getPlaces in class PhysicalModel
  - maxAllowedTimedMove
```
public float maxAllowedTimedMove()
```
    Description copied from class: PhysicalModel
    
    return the allowed timed move to be elapsed to perform a step
    
    Specified by:
    
    maxAllowedTimedMove in class PhysicalModel
  - numberFireable
```
public int numberFireable()
```
    Description copied from class: PhysicalModel
    
    return the number of fireable transitions
    
    Specified by:
    
    numberFireable in class PhysicalModel
  - numberBlocked
```
public int numberBlocked()
```
    Description copied from class: PhysicalModel
    
    return the number of blocked transitions
    
    Specified by:
    
    numberBlocked in class PhysicalModel
  - isBlocked
```
public boolean isBlocked(int tnum)
```
    Description copied from class: PhysicalModel
    
    return true if the transition specified in parameter by its number is blocked
    
    Specified by:
    
    isBlocked in class PhysicalModel
  - multipleSteps
```
public void multipleSteps(int steps)
```
    Description copied from class: PhysicalModel
    
    perform the number of steps specified in parameter (timed move, discrete move, ...)
    
    Specified by:
    
    multipleSteps in class PhysicalModel
  - reset
```
public void reset(boolean init)
```
    Description copied from class: PhysicalModel
    
    reset the network model to its initial status
    
    Overrides:
    
    reset in class PhysicalModel
  - setBunchingState
```
public void setBunchingState(int nbTokens)
```
    set the net in a bunching state where tokens are grouped in successives places
  - discreteMove
```
public void discreteMove()
```
    Description copied from class: PhysicalModel
    
    perform a discrete move e.g. a transition will be fired and a token will change of place
    
    Specified by:
    
    discreteMove in class PhysicalModel
  - discreteMove
```
public boolean discreteMove(String pathLogs,
                            long elapsedTime,
                            boolean enableLogs)
```
    Description copied from class: PhysicalModel
    
    perform a discrete move e.g. a transition will be fired and a token will change of place
    
    Specified by:
    
    discreteMove in class PhysicalModel
  - drop
```
public void drop()
```
    Description copied from class: PhysicalModel
    
    display informations of the network model
    
    Specified by:
    
    drop in class PhysicalModel
  - dropConfig
```
public String dropConfig()
```
    Description copied from class: PhysicalModel
    
    display informations of the configuration of the network model
    
    Specified by:
    
    dropConfig in class PhysicalModel
  - findTransition
```
public TransitionAbstract findTransition(Integer tname)
```
    Description copied from class: PhysicalModel
    
    return the transition as specified by its number in parameter
    
    Specified by:
    
    findTransition in class PhysicalModel
  - findTransition
```
public TransitionAbstract findTransition(String string)
```
    Description copied from class: PhysicalModel
    
    return the transition as specified by its name in parameter
    
    Specified by:
    
    findTransition in class PhysicalModel
  - findPlace
```
public PlaceAbstract findPlace(int pname)
```
    Description copied from class: PhysicalModel
    
    return the place as specified by its number in parameter
    
    Specified by:
    
    findPlace in class PhysicalModel
  - addToken
```
public Boolean addToken(int p)
```
    Description copied from class: PhysicalModel
    
    add a token in the place specified in parameter by its number
    
    Specified by:
    
    addToken in class PhysicalModel
  - getControlPlace
```
public PlaceAbstract getControlPlace(int aplace)
```
    Description copied from class: PhysicalModel
    
    return a control place as specified by its number in parameter
    
    Specified by:
    
    getControlPlace in class PhysicalModel
  - getControlPlaces
```
public HashMap<Integer,? extends PlaceAbstract> getControlPlaces()
```
    Description copied from class: PhysicalModel
    
    return the list of the control places which can be recovered by their id number
    
    Specified by:
    
    getControlPlaces in class PhysicalModel
  - getStandardDeviation
```
public float getStandardDeviation()
```
    return the standard deviation of the distances between the pairs of successive tokens
  - getStandardDeviation
```
public float getStandardDeviation(String pathLogs)
```
    return the standard deviation of the distances between the pairs of successive tokens
  - fireableTransition
```
public ArrayList<TransitionAbstract> fireableTransition()
```
    Description copied from class: PhysicalModel
    
    return the list of fireable transitions
    
    Specified by:
    
    fireableTransition in class PhysicalModel
  - getAvgSpeed
```
public float getAvgSpeed()
```
  - getEnabled
```
public HashMap<Integer,? extends TransitionAbstract> getEnabled()
```
    Description copied from class: PhysicalModel
    
    get the list of the enabled transitions which can be retrieved by their id number
    
    Specified by:
    
    getEnabled in class PhysicalModel
  - getFirable
```
public HashMap<Integer,? extends TransitionAbstract> getFirable()
```
    Description copied from class: PhysicalModel
    
    get the list of the fireable transitions which can be retrieved by their id number
    
    Specified by:
    
    getFirable in class PhysicalModel
  - isGaussian
```
public boolean isGaussian()
```
    Description copied from class: PhysicalModel
    
    return true if the prob. distribution is gaussian. used for the sampling of the transitions
    
    Specified by:
    
    isGaussian in class PhysicalModel
  - isWeibull
```
public boolean isWeibull()
```
    Description copied from class: PhysicalModel
    
    return true if the prob. distribution is weibull. used for the sampling of the transitions
    
    Specified by:
    
    isWeibull in class PhysicalModel
  - getWeibullCoef
```
public int getWeibullCoef()
```
    Description copied from class: PhysicalModel
    
    get the coefficient used for the weibull prob. distribution. used for the sampling of the transitions
    
    Specified by:
    
    getWeibullCoef in class PhysicalModel
  - getTotalDistance
```
public float getTotalDistance()
```
    get the total distance of the loop of the network
  - getAverage
```
public float getAverage()
```
    average of the headway distance between the tokens, used in getStandardDeviation method
  - getTimeElapsed
```
public float getTimeElapsed()
```
    get the time elapsed since the start of the simulation
    
    Overrides:
    
    getTimeElapsed in class PhysicalModel
  - getNbDiscreteSteps
```
public int getNbDiscreteSteps()
```
    Description copied from class: PhysicalModel
    
    get the number of discrete steps performed
    
    Overrides:
    
    getNbDiscreteSteps in class PhysicalModel
  - getALPHA
```
public float getALPHA()
```
    A constant for the whole simulation describing adherence to target speed This constant is used when computing an advice of time to browse a moving place for a train can be set in the input file as a line : ALPHA:value
  - setALPHA
```
public void setALPHA(float aLPHA)
```
    Set Alpha, A constant for the whole simulation describing adherence to target speed This constant is used when computing an advice of time to browse a moving place for a train can be set in the input file as a line : ALPHA:value
  - getRANGE_NOISE
```
public static float getRANGE_NOISE()
```
    the range for the noise in the calculTime method. can be set in the input file as a line : RANGE_NOISE:value
  - setRANGE_NOISE
```
public static void setRANGE_NOISE(float rANGE_NOISE)
```
    set the range for the noise in the calculTime method. can be set in the input file as a line : RANGE_NOISE:value
  - getLastTokenSpeed
```
public float getLastTokenSpeed()
```
    get the speed of a token which has been inserted into a new place while a discrete step was performed
  - getLastTokenTtb
```
public float getLastTokenTtb()
```
    get the time to browse/clock of a token which has been inserted into a new place while a discrete step was performed
  - isDiscreteMove
```
public boolean isDiscreteMove()
```
    return true if the last step is a discrete move
  - getCurrentAvgSpeed
```
public float getCurrentAvgSpeed()
```
    get the current average speed of the moving tokens in the EquNet loop
  - getCurrentMinSpeed
```
public float getCurrentMinSpeed()
```
    the min speed at the current state of the moving tokens
  - getCurrentMaxSpeed
```
public float getCurrentMaxSpeed()
```
    the max speed at the current state
  - insertToken
```
public void insertToken()
                 throws NullGarageException
```
    insert a new token in the net at the garage place
    
    Throws:
    
    NullGarageException
  - resetSpeedData
```
public void resetSpeedData()
```
    used to reset the speed data information used to get average speed on a part of a simulation
  - getSpeed
```
public float getSpeed(Integer tokenNumber)
```
    get the current speed of the token number set in parameter
    
    Returns:
    
    the current speed
  - getTimeToBrowse
```
public float getTimeToBrowse(Integer tokenNumber)
```
    get the time to browse a place or the time to be elapsed to allow the token to be ready to get to a next place
    
    Parameters:
    
    tokenNumber - the id of the token from 0 to n-1, n is the number of tokens in the EquNet
    
    Returns:
    
    the time to browse a place
  - getDistanceInPlace
```
public float getDistanceInPlace(Integer tokenNumber)
```
    get the position of a token in a place
    
    Parameters:
    
    tokenNumber - the id of the token from 0 to n - 1, n is the number of tokens
  - getDistanceInNetwork
```
public float getDistanceInNetwork(Integer tokenNumber)
```
    get the position of a token in the EquNet
    
    Parameters:
    
    tokenNumber - the id of the token from 0 to n - 1, n is the number of tokens
  - getClock
```
public float getClock(Integer transitionNumber)
               throws TransitionNotFoundException
```
    get the clock of a transition
    
    Parameters:
    
    transitionNumber - the id of the transition as described in the .net inpute file i.e. transition:3:ta2:[0.5,1] -> id = 3
    
    Throws:
    
    TransitionNotFoundException
  - getTransitionClock
```
public float getTransitionClock(String name)
                         throws Exception
```
    get the clock of a transition
    
    Parameters:
    
    name - the name of the transition
    
    Throws:
    
    InvocationTargetException
    
    Exception
  - getTokens
```
public LinkedHashMap<Integer,Token> getTokens()
```
    Specified by:
    
    getTokens in class PhysicalModel

Class EquNet

Field Summary

Fields inherited from class fr.inria.mochy.core.abstractClass.PhysicalModel

Constructor Summary

Method Summary

Methods inherited from class fr.inria.mochy.core.abstractClass.PhysicalModel

Methods inherited from class java.lang.Object

Field Detail

transitions

places

enabled

fireable

blocked

garage

initialState

Constructor Detail

EquNet

Method Detail

loadFile

handleLine

addInFlow

addOutFlow

getTransitions

getPlaces

maxAllowedTimedMove

numberFireable

numberBlocked

isBlocked

multipleSteps

reset

setBunchingState

discreteMove

discreteMove

drop

dropConfig

findTransition

findTransition

findPlace

addToken

getControlPlace

getControlPlaces

getStandardDeviation

getStandardDeviation

fireableTransition

getAvgSpeed

getEnabled

getFirable

isGaussian

isWeibull

getWeibullCoef

getTotalDistance

getAverage

getTimeElapsed

getNbDiscreteSteps

getALPHA

setALPHA

getRANGE_NOISE

setRANGE_NOISE

getLastTokenSpeed

getLastTokenTtb

isDiscreteMove

getCurrentAvgSpeed

getCurrentMinSpeed

getCurrentMaxSpeed

insertToken

resetSpeedData

getSpeed

getTimeToBrowse

getDistanceInPlace

getDistanceInNetwork

getClock

getTransitionClock

getTokens