bcds.phison
Interface WithEnvParams

All Known Subinterfaces:

Clusterer<V,E>, ElemsSequencer<V,E>, GraphMetric<V,E>, ProcessingModule<V,E>, RoutingAlg<V,E>, StatsExporter

All Known Implementing Classes:

AlgebraicConnectivity, Assortativity, AverageEdgeBC, AverageNeighborConnectivity, AverageNodeBC, AvgPathLength, AvgTwoTermReliability, BrandesBC, CheegerConstantBruteForce, ClusteringCoeff, ConnectivityMatrixSpectralRadius, Density, Diameter, DijkstraAll, DijkstraMaxWidth, Dummy, EdgeSetSize, ElemsSequencerBase, Heterogeneity, LinkConnectivity, LIOA, LMIR, MaxNodeDegree, MinHop, NoackLinLog, NodeConnectivity, Null, OutNodeDegree, PmBase, PmDTypeReplicator, PmDumpRAState, PmElemsSequencer, PmLinkFailure, PmNetProps, PmSID, PmSIDTraceToDOT, PmStatic, PmTrace2TR, PmTraceConn, PmTraceConnGbl, PmTraceLinkUsage, PmTraceLinkUsageToDOT, PmTracePathLength, PmTraceProgress, PmTraceTimestepBlocking, PmTraceTrafficMatrix, PmTrfReader, ProtDPP_MinCost, SequencerBC, SequencerCC, SequencerDegree, SequencerFromFile, SequencerRandom, SequencerSpreaders, SpectralRadius, Spreaders, StatsExporterBase, SWP, SxSeriesToGnuPlot, SxStdoutBasic, SymmetryRatio, VertexSetSize, WSP, ZoneAsCluster

public interface WithEnvParams

Defines methods for establishign and accessing environment parameters, represented as an instance of Environ. Envionment parameters are (key,value) pairs that provide several classes (for example routing algorithms) with extra information so that the caller can influence their behaviour. The names and types of the members of the environment is decided by each implementation.

Author:

Juan Segovia S.

Method Summary

Environ	getEnviron() Returns the environment associated to the instance.
java.lang.Object[]	getEnvParams() Defines the list of "parameters" that the class instances expect to find in the environment.
java.lang.String	getName() An identifier used as prefix for the names of environment parameters.

Method Detail

getEnviron

Environ getEnviron()

Returns the environment associated to the instance. It must always be non-null.

getEnvParams

java.lang.Object[] getEnvParams()

Defines the list of "parameters" that the class instances expect to find in the environment. This list is formally an array to facilitate coding (see example below) and consists of an indeterminate number of two adjacent elements (a key-value pair). In practice, this list defines the name, type and default value of each parameter.

It is recommended that keys use compound names to avoid name clashes. A good alternative is the non-qualified class name, a dot and the parameter name.

A ficticious example:

 class SomeClass<V, E>
    ...
    implements WithEnvParams
 {
    ...
    public Environ getEnvParams()
    {
       return new Object[] {
           "SomeClass.max_iteration",   100,
           "SomeClass.distribute_load", false
       };
    }
 }
 

getName

java.lang.String getName()

An identifier used as prefix for the names of environment parameters. The name is typically the unqualified class name. It must not include dots (.).