Class Network

java.lang.Object
   |
   +----Network

class Network

extends Object

implements StoreElement

Version:

$Revision: 1.74 $

basenames

The selection of basenames for this network.

connections

currentBasename

A reference to the basename for which the network is currently being executed.

maxInConnector

maxOutConnector

maxParameter

moduleStore

moduleTypeList

name

nrOfModuleTypes

observable

runPath

The run path.

state

The state the Network currently is in.

Network(int, int)

addConnection(InConnector, OutConnector)

Add a new Connection to the Network.

addModule(Module)

Adds an existing Module to the Network.

addModule(Module, InfoHandler)

Adds an existing Module to the Network with view-specific information.

addModule(String)

Adds a module to the Network.

addModuleType(ModuleType)

checkOutConnectors(ModuleStore)

Check if all OutConnectors of the Modules in a specified ModuleStore can write their Data to a file, that is, check if the method fileAvailable() of the OutConnectors returns true for all OutConnectors.

clearNetwork()

determineRunPath()

Determine the run path of the current network.

disconnect(Connection)

Remove a Connection from the Network's list of Connections.

findModuleType(String)

getBasenames()

getConnection(int)

getConnections()

getCurrentBasename()

getEndModule(int)

getMaxInConnector()

getMaxOutConnector()

getMaxParameter()

getModule(int)

getModules()

getName()

getNrOfConnections()

getNrOfModules()

getObservable()

getStartModule(int)

getState()

Get the current state of the Network.

loadNetwork(String)

Load the network from disk.

makeModule(String)

Creates a new instance of Module.

preserveBackSlash(String)

StreamTokenizer does not correctly handle the backslash, it wants to have 2 backslashes.

printItems()

readNetworkConnectionLine(String, String)

Read a connection line from the network file.

readNetworkModuleLine(String, String)

Read a module line from the network file.

removeConnection(Connection)

removeModule(Module)

Remove a Module from the Network.

run()

runSingleBasename()

saveNetwork(String)

Save the network to disk.

setBasenames(FileStore)

setEndModule(int, boolean)

setName(String)

setStartModule(int, boolean)

setState(NetworkState)

Set the new state of the Network.

 private int maxInConnector

 private int maxOutConnector

 private int maxParameter

 private String name

 private NetworkObservable observable

 private ModuleStore moduleStore

 private ModuleType moduleTypeList[]

 private ConnectionStore connections

 private int nrOfModuleTypes

 private FileStore basenames

The selection of basenames for this network.

 private NetworkState state

The state the Network currently is in. This can be either Idle or Running. The state is set by the Network itself and can be queried by others.

See Also:

getState

 private String currentBasename

A reference to the basename for which the network is currently being executed.

 private ModuleStore runPath

The run path. Only valid while the Network is in Running state.

 public Network(int maxModules,
                int maxConnections)

 String getCurrentBasename()

 String getName()

 private void setName(String name)

 int getMaxInConnector()

 int getMaxOutConnector()

 int getMaxParameter()

 void setStartModule(int moduleNr,
                     boolean set)

 void setEndModule(int moduleNr,
                   boolean set)

 boolean getStartModule(int moduleNr)

 boolean getEndModule(int moduleNr)

 Module getModule(int moduleNr)

 ModuleStore getModules()

 int getNrOfModules()

 Connection getConnection(int connectionNr)

 int getNrOfConnections()

 ConnectionStore getConnections()

 void removeModule(Module m)

Remove a Module from the Network.

 void removeConnection(Connection c)

 void disconnect(Connection c)

Remove a Connection from the Network's list of Connections. This is called by a Connection when it disconnects itself from Modules.

 public void clearNetwork()

 public void printItems()

 public void saveNetwork(String fileName)

Save the network to disk. Save al modules (doubles are allowed), save all connections. Connections are between in connectors and out connectors.

 public void loadNetwork(String fileName)

Load the network from disk. The network file contains all modules in the network (doubles are allowed), the start and end modules and the connections between the connectors of the modules.

 private boolean readNetworkModuleLine(String moduleString,
                                       String fileName)

Read a module line from the network file. A module line contains the module description file, whether it is a start/end module and parameters of the modules (if not default). When a faulty module line is detected or the module can not be loaded then the rest of the network will not be loaded, when there is a problem with loading the parameters the parameters of that module are skipped.

 public String preserveBackSlash(String str)

StreamTokenizer does not correctly handle the backslash, it wants to have 2 backslashes. Unfortunately the StreamReader already deleted 1 of the 2 backslashes. This method adds a backslash every time a bs is found.

 private boolean readNetworkConnectionLine(String connectionString,
                                           String fileName)

Read a connection line from the network file. A connection line is constructed of a description of the connection: it holds a from module and a to module and for both modules the connector number that is connected. Note: when a non parsable connection line or an invalid connection is detected it is (simply) skipped.

 ModuleType findModuleType(String MDFileName)

 void addModuleType(ModuleType newModuleType)

 void run()

 private void runSingleBasename()

 ModuleStore determineRunPath()

Determine the run path of the current network.

Returns:

a ModuleStore containing all Modules that are part of the run path.

 void setBasenames(FileStore basenames)

 FileStore getBasenames()

 private Module makeModule(String MDFName)

Creates a new instance of Module. Reads the specified Module Description File and stores the results are stored in the new Module. The new Module is not part of the model yet and the views will not be notified if this Module changes until it becomes part of the model. A Module can be added to the model using addModule(Module) or addModule(Module, InfoHandler).

Parameters:

MDFName - the name of the Module Description File to read.

See Also:

addModule, addModule

 Module addModule(String MDFName)

Adds a module to the Network. A new Module is created using makeModule(). The Module is added to the ModuleStore of the Network and the views on the Network are updated using addModule(Module).

Returns:

a reference to the newly created Module or null if the Module could not be created. In the last case, error messages will have been displayed by the methods in class Module.

See Also:

makeModule, addModule

 private void addModule(Module m)

Adds an existing Module to the Network. The Module is added to the ModuleStore of the Network and the views on the Network are updated. Afterwards, the Module is a part of the model and the views will be notified if the Module changes.

Parameters:

m - the Module to add.

See Also:

addModule

 private void addModule(Module m,
                        InfoHandler infoHandler)

Adds an existing Module to the Network with view-specific information. The Module is added to the ModuleStore of the Network and the views on the Network are updated. The views will be notified with view-specific information. Afterwards, the Module is a part of the model and the views will be notified if the Module changes.

Parameters:

m - the Module to add.

infoHandler - an InfoHandler object that contains the view-specific information that is passed to the views.

See Also:

addModule, InfoHandler

 AddConnectionResult addConnection(InConnector inConnector,
                                   OutConnector outConnector)

Add a new Connection to the Network.

Returns:

an instance of class AddConnectionResult that indicates if the function succeeded or the reason why it failed.

 NetworkObservable getObservable()

 private void setState(NetworkState state)

Set the new state of the Network.

 NetworkState getState()

Get the current state of the Network.

 private boolean checkOutConnectors(ModuleStore s)

Check if all OutConnectors of the Modules in a specified ModuleStore can write their Data to a file, that is, check if the method fileAvailable() of the OutConnectors returns true for all OutConnectors.

See Also:

fileAvailable