org.ginsim.service.tool.composition

Class GenericTopology

java.lang.Object

org.ginsim.service.tool.composition.GenericTopology

All Implemented Interfaces:

Topology

public class GenericTopology
extends Object
implements Topology

Represents the topological relationships between Logical Regulatory Modules being composed.

Author:

Nuno D. Mendes

Constructor Summary

Constructors

Constructor and Description
GenericTopology(int numberInstances) The topology

Method Summary

Modifier and Type	Method and Description
void	addNeighbour(int neighindex1, int neighindex2) Specifies that module neighindex2 is a neighbour of module neighindex1, but not the other way around.
boolean	areNeighbours(int neighindex1, int neighindex2) Method determining whether one module in neighbour of another in the defined Topology
int[]	getNeighbourIndices(int index) Returns a vector containing the indices of neighbouring modules
int	getNumberInstances()
int	getNumberNeighbours(int index)
boolean	hasNeighbours(int index)
void	removeNeighbour(int neighindex1, int neighindex2)

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericTopology

public GenericTopology(int numberInstances)

The topology

Parameters:

numberInstances - the number of identical modules

Method Detail

getNumberInstances

public int getNumberInstances()

Specified by:

getNumberInstances in interface Topology

Returns:

Number of module instances in the Topology.

addNeighbour

public void addNeighbour(int neighindex1,
                         int neighindex2)

Specifies that module neighindex2 is a neighbour of module neighindex1, but not the other way around.

Specified by:

addNeighbour in interface Topology

Parameters:

neighindex1 - indicates the index of the first module

neighindex2 - indicates the index of the second module

removeNeighbour

public void removeNeighbour(int neighindex1,
                            int neighindex2)

Specified by:

removeNeighbour in interface Topology

Parameters:

neighindex1 - indicates the index of the first module

neighindex2 - indicates the index of the second module

areNeighbours

public boolean areNeighbours(int neighindex1,
                             int neighindex2)

Method determining whether one module in neighbour of another in the defined Topology

Specified by:

areNeighbours in interface Topology

Parameters:

neighindex1 - Index of first module (starting in 0)

neighindex2 - Index of second module (starting in 0)

Returns:

TRUE if the first module is a neighbour of the second module, FALSE otherwise

hasNeighbours

public boolean hasNeighbours(int index)

Specified by:

hasNeighbours in interface Topology

Parameters:

index - A module index

Returns:

TRUE if the module has neighbours, FALSE otherwise

getNumberNeighbours

public int getNumberNeighbours(int index)

Specified by:

getNumberNeighbours in interface Topology

Parameters:

index - A module index

Returns:

the number of neighbours of the given module

getNeighbourIndices

public int[] getNeighbourIndices(int index)

Returns a vector containing the indices of neighbouring modules

Specified by:

getNeighbourIndices in interface Topology

Parameters:

index - the index of the given module