com.ur.urcap.api.contribution.driver.general.script

Interface ScriptCodeGenerator<P>

Type Parameters:

P - the (generic) type parameter for the interface representing parameters which can be used as input to the script code generation. Use them if applicable.

public interface ScriptCodeGenerator<P>

Implement this interface to provide script code for a (regular or feedback) capability.

Pass the implementation of this interface when registering a capability for a device driver.

Since:

1.9.0

Method Summary

Modifier and Type	Method and Description
void	generateScript(ScriptWriter scriptWriter, P parameters) When this method is called (by PolyScope), the needed script code for the capability must be generated.

Method Detail

generateScript

void generateScript(ScriptWriter scriptWriter,
                    P parameters)

When this method is called (by PolyScope), the needed script code for the capability must be generated.

Use the provided parameters (configured by the user) as input to the script code generation if necessary in the given context.

Parameters:

scriptWriter - use this script writer instance to generate the script code for the capability

parameters - the user-defined parameters