net.sf.myra.framework
Interface Weighable

All Known Implementing Classes:
Edge, Graph.Element, Vertex

public interface Weighable

A class implements the Weighable interface to indicate that it can have pheromone and heuristic information values.

Version:
$Revision$ $Date:: $
Author:
Fernando Esteban Barril Otero

Method Summary
 HeuristicValue getHeuristicValue()
          Returns the heuristic value associated with this component.
 HeuristicValue getHeuristicValue(int level)
          Returns the heuristic value associated with this component.
 Pheromone getPheromone()
          Returns the pheromone value associated with this component.
 Pheromone getPheromone(int level)
          Returns the pheromone value associated with this component at the specified level.
 void setHeuristicValue(HeuristicValue heuristicValue)
          Sets the heuristic value associated with this component.
 void setHeuristicValue(HeuristicValue heuristicValue, int level)
          Sets the heuristic value associated with this component.
 void setPheromone(Pheromone pheromone)
          Sets the pheromone value associated with this component.
 void setPheromone(Pheromone pheromone, int level)
          Sets the pheromone value associated with this component at the specified level.
 

Method Detail

getHeuristicValue

HeuristicValue getHeuristicValue()
Returns the heuristic value associated with this component.

Returns:
the heuristic value associated with this component.
See Also:
getHeuristicValue(int)

getHeuristicValue

HeuristicValue getHeuristicValue(int level)
Returns the heuristic value associated with this component.

Parameters:
level - the level of the heuristic value.
Returns:
the heuristic value associated with this component.

setHeuristicValue

void setHeuristicValue(HeuristicValue heuristicValue)
Sets the heuristic value associated with this component.

Parameters:
heuristicValue - the value to be set.
See Also:
setHeuristicValue(HeuristicValue, int)

setHeuristicValue

void setHeuristicValue(HeuristicValue heuristicValue,
                       int level)
Sets the heuristic value associated with this component.

Parameters:
heuristicValue - the value to be set.
level - the level of the heuristic value.

getPheromone

Pheromone getPheromone()
Returns the pheromone value associated with this component. This is equivalent of setting the pheromone at level 0.

Returns:
the pheromone value associated with this component.
See Also:
getPheromone(int)

getPheromone

Pheromone getPheromone(int level)
Returns the pheromone value associated with this component at the specified level.

Parameters:
level - the level of the pheromone.
Returns:
the pheromone value associated with this component.

setPheromone

void setPheromone(Pheromone pheromone)
Sets the pheromone value associated with this component. This is equivalent of setting the pheromone at level 0.

Parameters:
pheromone - the value to be set.
See Also:
setPheromone(Pheromone, int)

setPheromone

void setPheromone(Pheromone pheromone,
                  int level)
Sets the pheromone value associated with this component at the specified level.

Parameters:
level - the level of the pheromone.
pheromone - the value to be set.


Copyright © 2013. All Rights Reserved.