com.tplan.robot.imagecomparison

Interface MultiPassModule

All Superinterfaces:

Cloneable

All Known Implementing Classes:

SearchImageComparisonModule2

public interface MultiPassModule
extends Cloneable

Interface of a method which needs to be executed multiple times for a number of different configurations.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Method Summary

Modifier and Type	Method and Description
List<Map<String,String>>	getConfigurations() Get the list of configurations (parameter sets).
int	getMatchingConfigurationIndex() Get the index of the configuration that produced a match (positive comparison result).
void	setMatchingConfigurationIndex(int index) Set the matching configuration index.
void	setParameters(Map<String,String> params) Set the current parameters (configuration).

Method Detail

getConfigurations

List<Map<String,String>> getConfigurations()

Get the list of configurations (parameter sets). Each configuration is a map of [parameter,value] pairs where each parameter must be a valid one supported by the method.

Returns:

the list of configuration to execute the method repeatedly for.

setParameters

void setParameters(Map<String,String> params)

Set the current parameters (configuration).

Parameters:

params - the map of parameters.

getMatchingConfigurationIndex

int getMatchingConfigurationIndex()

Get the index of the configuration that produced a match (positive comparison result).

Returns:

index of the matching configuration in the list returned by getConfigurations().

setMatchingConfigurationIndex

void setMatchingConfigurationIndex(int index)

Set the matching configuration index.

Parameters:

index - the matching config index.