gov.nist.antd.optical.algorithm
Interface Algorithm

All Known Implementing Classes:

AlgorithmTemplate

public interface Algorithm

This interface is the basic algorithm interface.

 This interface was developed at the National Institute of Standards and
 Technology by employees of the Federal Government in the course of
 their official duties. Pursuant to title 17 Section 105 of the United
 States Code this software is not subject to copyright protection and
 is in the public domain.
 NIST assumes no responsibility whatsoever for its use by other parties,
 and makes no guarantees, expressed or implied, about its quality,
 reliability, or any other characteristic.
 

 We would appreciate acknowledgement if the software is used.
 

 NIST ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" CONDITION AND
 DISCLAIM ANY LIABILITY OF ANY KIND FOR ANY DAMAGES WHATSOEVER RESULTING
 FROM THE USE OF THIS SOFTWARE.
 

Author:

borchert

, rouil

Field Summary

static byte	ROUTING Indicates a routing algorithm.
static byte	RWA Indicates a routing and wavelength algorithm.
static byte	UNKNOWN Indicates an unknown algorithm type.
static byte	WAVELENGTH Indicates a wavelength algorithm.

Method Summary

void	config(com.renesys.raceway.DML.Configuration cfg, Glass net) Configure the Centralized Algorithm.
java.lang.Object[]	execute(Glass net, OpticalConnection[] routes, java.lang.Object[] parameter) This method executes the algorithm.
java.util.Vector	execute(Glass net, java.util.Vector routes, java.util.Vector parameter) This method executes the algorithm.
java.lang.String	getName() Returns the name of the algorithm.
byte	getType() Returns the type of the algorithm.

Field Detail

UNKNOWN

public static final byte UNKNOWN

Indicates an unknown algorithm type.

Since:

1.1

See Also:

Constant Field Values

ROUTING

public static final byte ROUTING

Indicates a routing algorithm.

Since:

1.1

See Also:

Constant Field Values

WAVELENGTH

public static final byte WAVELENGTH

Indicates a wavelength algorithm.

Since:

1.1

See Also:

Constant Field Values

RWA

public static final byte RWA

Indicates a routing and wavelength algorithm.

Since:

1.1

See Also:

Constant Field Values

Method Detail

execute

public java.util.Vector execute(Glass net,
                                java.util.Vector routes,
                                java.util.Vector parameter)
                         throws AlgorithmException

This method executes the algorithm.

Parameters:

net - The Net object that contains the topology.

routes - The vector of the requested routes.

parameter - The vector containing the parameters for the algorithm.

Returns:

The vector containing the result.

Throws:

AlgorithmException - An AlgorithmException occured.

execute

public java.lang.Object[] execute(Glass net,
                                  OpticalConnection[] routes,
                                  java.lang.Object[] parameter)
                           throws AlgorithmException

This method executes the algorithm.

Parameters:

net - The Net object that contains the topology.

routes - The array of the requested routes.

parameter - The array containing the parameters for the algorithm.

Returns:

The array of objects containing the result.

Throws:

AlgorithmException - An AlgorithmException occured.

config

public void config(com.renesys.raceway.DML.Configuration cfg,
                   Glass net)
            throws com.renesys.raceway.DML.configException

Configure the Centralized Algorithm.

Parameters:

cfg - configuration

net - The Glass object that contains the topology.

Throws:

com.renesys.raceway.DML.configException - when a configuration exception occurs.

Since:

1.1

getName

public java.lang.String getName()

Returns the name of the algorithm.

Returns:

The name of the algorithm.

getType

public byte getType()

Returns the type of the algorithm. Types are defined in the upper section of that interface.

Returns:

The type of the algorithm.

Since:

1.1