com.inscoper.api.SequenceHandler

SequenceHandler class manages sequence preparation progress and cancellation. More...

Public Functions

	Name
synchronized void	delete()
void	swigReleaseOwnership()
void	swigTakeOwnership()
	SequenceHandler(java.math.BigInteger interval) Constructor with interval.
	SequenceHandler() Constructor with interval.
void	onProgress(ESequencePreparationStatus status, float progress) Progress notification.
void	cancelPreparation() Cancel preparation.
boolean	isCancelled() Check if cancelled.
void	setInterval(java.math.BigInteger interval) Set notification interval.
java.math.BigInteger	getInterval() Get notification interval.

Protected Functions

	Name
	SequenceHandler(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
void	swigDirectorDisconnect()
long	getCPtr(SequenceHandler obj)

Detailed Description

public class com.inscoper.api.SequenceHandler;

SequenceHandler class manages sequence preparation progress and cancellation.

This abstract class provides a mechanism for users to be notified of preparation progress (0.0 to 1.0) and to request cancellation of the process.

Public Functions Documentation

function delete

public synchronized void delete()

function swigReleaseOwnership

public void swigReleaseOwnership()

function swigTakeOwnership

public void swigTakeOwnership()

function SequenceHandler

public SequenceHandler(
    java.math.BigInteger interval
)

Constructor with interval.

Parameters:

• interval : Interval between two notifications in microseconds (default: 1,000,000 us = 1s)

Initializes a new instance of the SequenceHandler class.

function SequenceHandler

public SequenceHandler()

Constructor with interval.

Initializes a new instance of the SequenceHandler class.

function onProgress

public void onProgress(
    ESequencePreparationStatus status,
    float progress
)

Progress notification.

Parameters:

• status : The current preparation status
• progress : The preparation progress (0.0 to 1.0)

This callback method is invoked at each time interval to report the current status and progress of the preparation. Must be overridden.

function cancelPreparation

public void cancelPreparation()

Cancel preparation.

Requests the cancellation of the current sequence preparation.

function isCancelled

public boolean isCancelled()

Check if cancelled.

Return: True if cancellation has been requested, false otherwise

Checks whether a cancellation request has been issued.

function setInterval

public void setInterval(
    java.math.BigInteger interval
)

Set notification interval.

Parameters:

• interval : The interval in microseconds

Sets the time interval between consecutive progress notifications.

function getInterval

public java.math.BigInteger getInterval()

Get notification interval.

Return: The interval in microseconds

Retrieves the current time interval between progress notifications.

Protected Functions Documentation

function SequenceHandler

protected SequenceHandler(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

function finalize

protected void finalize()

function swigDirectorDisconnect

protected void swigDirectorDisconnect()

function getCPtr

protected static long getCPtr(
    SequenceHandler obj
)

---

Updated on 2026-04-02 at 10:55:38 +0200