captureplugin.drivers.defaultdriver

Class CaptureParamLibrary

java.lang.Object

util.paramhandler.ParamLibrary

captureplugin.drivers.defaultdriver.CaptureParamLibrary

public class CaptureParamLibrary
extends ParamLibrary

This Class extends the ParamLibrary with Capture-Plugin-Specific Parameters.

Author:

bodum

Constructor Summary

Constructors

Constructor and Description
CaptureParamLibrary(DeviceConfig config) Create the ParamLibrary
CaptureParamLibrary(DeviceConfig config, ProgramTime prgTime) Create the ParamLibrary

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescriptionForFunctions(String function) Get the description for a specific Funtion
String	getDescriptionForKey(String key) Get the description for one Key
String[]	getPossibleFunctions() Get the List of possible Functions
String[]	getPossibleKeys() Get the possible Keys
ProgramTime	getProgramTime() Get the ProgramTime this ParamLibrary uses to calculate start/endtime
String	getStringForFunction(Program prg, String function, String[] params) Returns the Value of a function
String	getStringForKey(Program prg, String key) Get the String for a key
void	setProgramTime(ProgramTime prgTime) Set the ProgramTime

Methods inherited from class util.paramhandler.ParamLibrary

getErrorString, hasErrors, setErrors, setErrorString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CaptureParamLibrary

public CaptureParamLibrary(DeviceConfig config)

Create the ParamLibrary

Parameters:

config - Configuration

CaptureParamLibrary

public CaptureParamLibrary(DeviceConfig config,
                   ProgramTime prgTime)

Create the ParamLibrary

Parameters:

config - Configuration

prgTime - ProgramTime to use for calculating start/endtime

Method Detail

setProgramTime

public void setProgramTime(ProgramTime prgTime)

Set the ProgramTime

Parameters:

prgTime - ProgramTime to use for calculating start/endtime

getProgramTime

public ProgramTime getProgramTime()

Get the ProgramTime this ParamLibrary uses to calculate start/endtime

Returns:

ProgramTime

getDescriptionForFunctions

public String getDescriptionForFunctions(String function)

Description copied from class: ParamLibrary

Get the description for a specific Funtion

Overrides:

getDescriptionForFunctions in class ParamLibrary

Returns:

getPossibleFunctions

public String[] getPossibleFunctions()

Description copied from class: ParamLibrary

Get the List of possible Functions

Overrides:

getPossibleFunctions in class ParamLibrary

Returns:

List of possible Functions

getStringForFunction

public String getStringForFunction(Program prg,
                          String function,
                          String[] params)

Description copied from class: ParamLibrary

Returns the Value of a function

Overrides:

getStringForFunction in class ParamLibrary

Parameters:

prg - Program to use

function - Function to use

params - Params for the Function

Returns:

Return-Value of Function

getDescriptionForKey

public String getDescriptionForKey(String key)

Description copied from class: ParamLibrary

Get the description for one Key

Overrides:

getDescriptionForKey in class ParamLibrary

Returns:

description for one key

getPossibleKeys

public String[] getPossibleKeys()

Description copied from class: ParamLibrary

Get the possible Keys

Overrides:

getPossibleKeys in class ParamLibrary

Returns:

Array with possible Keys

getStringForKey

public String getStringForKey(Program prg,
                     String key)

Description copied from class: ParamLibrary

Get the String for a key

Overrides:

getStringForKey in class ParamLibrary

Parameters:

prg - Program to use

key - Key to use

Returns:

Value of key in prg