Package org.scictrl.csshell.epics.server.application.cycling

Class CyclingParameters

java.lang.Object

org.scictrl.csshell.epics.server.application.cycling.CyclingParameters

All Implemented Interfaces:

Cloneable

public final class CyclingParameters
extends Object
implements Cloneable

This type was created in VisualAge.

Author:

igor@scictrl.com

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CYCLE_DECREMENT	Constant CYCLE_DECREMENT="CycleDecrement"
static final String	FINAL_VALUE	Constant FINAL_VALUE="FinalValue"
static final String	MAX_LIMIT	Constant MAX_LIMIT="MaxLimit"
static final String	MIN_LIMIT	Constant MIN_LIMIT="MinLimit"
static final String	NO_CYCLES	Constant NO_CYCLES="NoCycles"
static final String	STARTING_AS_FINAL	Constant STARTING_AS_FINAL="StartingAsFinal"
static final String	STEPS_PER_RAMP	Constant STEPS_PER_RAMP="StepsPerRamp"
static final String	TOP_SCALE	Constant TOP_SCALE="TopScale"
static final String	USE_DEVICE_LIMITS	Constant USE_DEVICE_LIMITS="UseDeviceLimits"
static final String	WAIT_AT_LIMITS	Constant WAIT_AT_LIMITS="WaitAtLimits"
static final String	WAIT_BETWEEN_STEPS	Constant WAIT_BETWEEN_STEPS="WaitBetweenSteps"

Constructor Summary

Constructors

Constructor	Description
CyclingParameters()	DefaultDataValues constructor comment.
CyclingParameters(int noCycles, int stepsPerRamp, double waitBetweenSteps, double waitAtLimits, double maxLimit, double minLimit, double finalValue, double cycleDecrement, boolean useDeviceLimits, boolean startingAsFinal, double topScale)	Constructor to include max/min values
CyclingParameters(String parameters)	DefaultDataValues constructor comment.

Method Summary

Modifier and Type	Method	Description
double	getCycleDecrement()	Getter for the field cycleDecrement.
double	getFinalValue()	Getter for the field finalValue.
double	getMaxLimit()	Getter for the field maxLimit.
double	getMinLimit()	Getter for the field minLimit.
int	getNoCycles()	Getter for the field noCycles.
int	getStepsPerRamp()	Getter for the field stepsPerRamp.
double	getTopScale()	Getter for the field topScale.
double	getWaitAtLimits()	Getter for the field waitAtLimits.
double	getWaitBetweenSteps()	Getter for the field waitBetweenSteps.
boolean	isStartingAsFinal()	isStartingAsFinal.
boolean	isUseDeviceLimits()	isUseDeviceLimits.
String	toString()	Insert the method's description here.
CyclingParameters	withParameter(String param, Number value)	withParameter.

Methods inherited from class java.lang.Object

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

Field Details

NO_CYCLES

public static final String NO_CYCLES

Constant NO_CYCLES="NoCycles"

See Also:

• Constant Field Values

STEPS_PER_RAMP

public static final String STEPS_PER_RAMP

Constant STEPS_PER_RAMP="StepsPerRamp"

See Also:

• Constant Field Values

WAIT_BETWEEN_STEPS

public static final String WAIT_BETWEEN_STEPS

Constant WAIT_BETWEEN_STEPS="WaitBetweenSteps"

See Also:

• Constant Field Values

WAIT_AT_LIMITS

public static final String WAIT_AT_LIMITS

Constant WAIT_AT_LIMITS="WaitAtLimits"

See Also:

• Constant Field Values

FINAL_VALUE

public static final String FINAL_VALUE

Constant FINAL_VALUE="FinalValue"

See Also:

• Constant Field Values

STARTING_AS_FINAL

public static final String STARTING_AS_FINAL

Constant STARTING_AS_FINAL="StartingAsFinal"

See Also:

• Constant Field Values

CYCLE_DECREMENT

public static final String CYCLE_DECREMENT

Constant CYCLE_DECREMENT="CycleDecrement"

See Also:

• Constant Field Values

USE_DEVICE_LIMITS

public static final String USE_DEVICE_LIMITS

Constant USE_DEVICE_LIMITS="UseDeviceLimits"

See Also:

• Constant Field Values

MAX_LIMIT

public static final String MAX_LIMIT

Constant MAX_LIMIT="MaxLimit"

See Also:

• Constant Field Values

MIN_LIMIT

public static final String MIN_LIMIT

Constant MIN_LIMIT="MinLimit"

See Also:

• Constant Field Values

TOP_SCALE

public static final String TOP_SCALE

Constant TOP_SCALE="TopScale"

See Also:

• Constant Field Values

Constructor Details

CyclingParameters

public CyclingParameters()

DefaultDataValues constructor comment.

CyclingParameters

public CyclingParameters(int noCycles,
 int stepsPerRamp,
 double waitBetweenSteps,
 double waitAtLimits,
 double maxLimit,
 double minLimit,
 double finalValue,
 double cycleDecrement,
 boolean useDeviceLimits,
 boolean startingAsFinal,
 double topScale)

Constructor to include max/min values

Parameters:

noCycles - a int

stepsPerRamp - a int

waitBetweenSteps - a double

waitAtLimits - a double

maxLimit - a double

minLimit - a double

finalValue - a double

cycleDecrement - a double

useDeviceLimits - a boolean

startingAsFinal - a boolean

topScale - a double

CyclingParameters

public CyclingParameters(String parameters)
                  throws NumberFormatException

DefaultDataValues constructor comment.

Parameters:

parameters - a String object

Throws:

NumberFormatException - if any.

Method Details

withParameter

public CyclingParameters withParameter(String param,
 Number value)

withParameter.

Parameters:

param - a String object

value - a Number object

Returns:

a CyclingParameters object

toString

public String toString()

Insert the method's description here. Creation date: (10.11.2001 22:10:13)

Overrides:

toString in class Object

Returns:

java.lang.String

getTopScale

public double getTopScale()

Getter for the field topScale.

Returns:

a double

getCycleDecrement

public double getCycleDecrement()

Getter for the field cycleDecrement.

Returns:

the cycleDecrement

getFinalValue

public double getFinalValue()

Getter for the field finalValue.

Returns:

the finalValue

getMaxLimit

public double getMaxLimit()

Getter for the field maxLimit.

Returns:

the maxLimit

getMinLimit

public double getMinLimit()

Getter for the field minLimit.

Returns:

the minLimit

getNoCycles

public int getNoCycles()

Getter for the field noCycles.

Returns:

the noCycles

getStepsPerRamp

public int getStepsPerRamp()

Getter for the field stepsPerRamp.

Returns:

the stepsPerRamp

isUseDeviceLimits

public boolean isUseDeviceLimits()

isUseDeviceLimits.

Returns:

the useDeviceLimits

getWaitAtLimits

public double getWaitAtLimits()

Getter for the field waitAtLimits.

Returns:

the waitAtLimits

getWaitBetweenSteps

public double getWaitBetweenSteps()

Getter for the field waitBetweenSteps.

Returns:

the waitBetweenSteps

isStartingAsFinal

public boolean isStartingAsFinal()

isStartingAsFinal.

Returns:

a boolean