org.ginsim.service.tool.composition

Interface Topology

All Known Implementing Classes:

GenericTopology

public interface Topology

Represents the interface of any Topology

Author:

Nuno D. Mendes

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)
int	getNumberInstances()
int	getNumberNeighbours(int index)
boolean	hasNeighbours(int index)
void	removeNeighbour(int neighindex1, int neighindex2)

Method Detail

getNumberInstances

int getNumberInstances()

Returns:

number of module instances

addNeighbour

void addNeighbour(int neighindex1,
                  int neighindex2)

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

Parameters:

neighindex1 - indicates the index of the first module

neighindex2 - indicates the index of the second module

removeNeighbour

void removeNeighbour(int neighindex1,
                     int neighindex2)

Parameters:

neighindex1 - indicates the index of the first module

neighindex2 - indicates the index of the second module

areNeighbours

boolean areNeighbours(int neighindex1,
                      int neighindex2)

Method determining whether one module in neighbour of another in the defined 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

boolean hasNeighbours(int index)

Parameters:

index - A module index

Returns:

TRUE if the module has neighbours, FALSE otherwise

getNumberNeighbours

int getNumberNeighbours(int index)

Parameters:

index - A module index

Returns:

the number of neighbours of the given module

getNeighbourIndices

int[] getNeighbourIndices(int index)