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

Class ScanApplication.ScanningTask

java.lang.Object

org.scictrl.csshell.epics.server.application.ScanApplication.ScanningTask

All Implemented Interfaces:

Runnable

Enclosing class:

ScanApplication

public static class ScanApplication.ScanningTask
extends Object
implements Runnable

Runnable performing scan.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScanApplication.ScanningTask.ScanController	Interface that facilitates connection to undelaying services and context.

Constructor Summary

Constructors

Constructor	Description
ScanningTask(double start, double end, double step, long rate, int count, ScanApplication.Repeat repeat, double precision, ScanApplication.ScanningTask.ScanController ctrl, int overflowCount)	Creates scan/ramp task

Method Summary

Modifier and Type	Method	Description
void	abort()	Abort scan.
void	cancel()	Cancels and aborts the scan.
Long	getNextStepTime()	Returns next time step should happen, could be null if there is no next step
boolean	isAborted()	Returns true if scan has been aborted.
boolean	isCanceled()	Returns true if scan has been canceled.
void	ramp(double rStart, double rEnd, double rStep)	Ramps remote value from start to end in steps.
void	run()

Methods inherited from class java.lang.Object

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

Constructor Details

ScanningTask

public ScanningTask(double start,
 double end,
 double step,
 long rate,
 int count,
 ScanApplication.Repeat repeat,
 double precision,
 ScanApplication.ScanningTask.ScanController ctrl,
 int overflowCount)

Creates scan/ramp task

Parameters:

start - the start value

end - the end value

step - the step size

rate - the time to wait between steps in ms

count - the repetition count, 0 means one run without repetition

repeat - repetition specification

precision - value precision, determines how precise end value can be

ctrl - the scan control that provides underlying context services

overflowCount - hard limit that prevents runaway stepping

Method Details

getNextStepTime

public Long getNextStepTime()

Returns next time step should happen, could be null if there is no next step

Returns:

next time step should happen

abort

public void abort()

Abort scan. Scan progress is stopped. ScanController is notified that scan has been aborted.

cancel

public void cancel()

Cancels and aborts the scan. Scan progress is stopped, there is no notification to ScanController.

isCanceled

public boolean isCanceled()

Returns true if scan has been canceled.

Returns:

true if scan has been canceled

isAborted

public boolean isAborted()

Returns true if scan has been aborted.

Returns:

true if scan has been aborted

run

public void run()

Specified by:

run in interface Runnable

ramp

public void ramp(double rStart,
 double rEnd,
 double rStep)

Ramps remote value from start to end in steps.

Parameters:

rStart - start value

rEnd - end value

rStep - step size