Package dataGram

Class DatagramProgress

java.lang.Object

pamViewFX.pamTask.PamTaskUpdate

dataGram.DatagramProgress

public class DatagramProgress
extends PamTaskUpdate

Progress data on datagram creation

Author:

Doug Gillespie

Field Summary

Fields

Modifier and Type	Field	Description
int	currentPoint
PamDataBlock	dataBlock
OfflineDataMapPoint	dataMapPoint
int	nDataBlocks
int	pointsToUpdate
int	processedUnits
static final int	STATUS_BLOCKCOUNT
static final int	STATUS_ENDINGBLOCK
static final int	STATUS_ENDINGFILE
static final int	STATUS_STARTINGBLOCK
static final int	STATUS_STARTINGFILE
static final int	STATUS_UNITCOUNT
int	totalUnits

Fields inherited from class pamViewFX.pamTask.PamTaskUpdate

STATUS_ANALYSING_FILES, STATUS_COUNTING_FILES, STATUS_DESERIALIZING, STATUS_DONE, STATUS_DONE_ERROR, STATUS_IDLE, STATUS_SERIALIZING, STATUS_SORTING

Constructor Summary

Constructors

Constructor	Description
DatagramProgress(int statusType, int nDataBlocks)
DatagramProgress(int statusType, int totalUnits, int processedUnits)
DatagramProgress(int statusType, OfflineDataMapPoint dataMapPoint, int currentPoint)
DatagramProgress(int statusType, PamDataBlock dataBlock, int pointsToUpdate)

Method Summary

Modifier and Type	Method	Description
String	getName()	Get the name of the load thread.
double	getProgress()	Get the progress of the load thread.
double	getProgress2()	There may be a need for two progress bars for long task- one showing overall progress and the other showing more fine scale loading tasks.
String	getProgressString()	Returns a message indicating progress.
String	getProgressString2()	If two updates are available then this is used to return the fine progress update message.

Methods inherited from class pamViewFX.pamTask.PamTaskUpdate

getStatus, isDualProgressUpdate, setDualProgressUpdate, setStatus

Methods inherited from class java.lang.Object

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

Field Details

STATUS_BLOCKCOUNT

public static final int STATUS_BLOCKCOUNT

See Also:

• Constant Field Values

STATUS_STARTINGBLOCK

public static final int STATUS_STARTINGBLOCK

See Also:

• Constant Field Values

STATUS_ENDINGBLOCK

public static final int STATUS_ENDINGBLOCK

See Also:

• Constant Field Values

STATUS_STARTINGFILE

public static final int STATUS_STARTINGFILE

See Also:

• Constant Field Values

STATUS_ENDINGFILE

public static final int STATUS_ENDINGFILE

See Also:

• Constant Field Values

STATUS_UNITCOUNT

public static final int STATUS_UNITCOUNT

See Also:

• Constant Field Values

nDataBlocks

public int nDataBlocks

pointsToUpdate

public int pointsToUpdate

currentPoint

public int currentPoint

dataBlock

public PamDataBlock dataBlock

dataMapPoint

public OfflineDataMapPoint dataMapPoint

processedUnits

public int processedUnits

totalUnits

public int totalUnits

Constructor Details

DatagramProgress

public DatagramProgress(int statusType,
 int nDataBlocks)

Parameters:

statusType -

nDataBlocks -

DatagramProgress

public DatagramProgress(int statusType,
 PamDataBlock dataBlock,
 int pointsToUpdate)

Parameters:

statusType -

dataBlock -

DatagramProgress

public DatagramProgress(int statusType,
 int totalUnits,
 int processedUnits)

DatagramProgress

public DatagramProgress(int statusType,
 OfflineDataMapPoint dataMapPoint,
 int currentPoint)

Parameters:

statusType -

dataMapPoint -

Method Details

getName

public String getName()

Description copied from class: PamTaskUpdate

Get the name of the load thread. Note the name is also the unique identifier for the running thread so cannot be the same between two different threads.

Specified by:

getName in class PamTaskUpdate

Returns:

the name of the thread.

getProgress2

public double getProgress2()

Description copied from class: PamTaskUpdate

There may be a need for two progress bars for long task- one showing overall progress and the other showing more fine scale loading tasks. If this is the case then

Note that ProgressIndicator.INTERMEDIATE can be used as an update value to set progress to intermediate.

Overrides:

getProgress2 in class PamTaskUpdate

Returns:

the progress of the thread, between 0 and 1.

getProgress

public double getProgress()

Description copied from class: PamTaskUpdate

Get the progress of the load thread. This is a value between 0 and 1 were 1 is equivalent to 100% or the thread having finished.

Note that ProgressIndicator.INTERMEDIATE can be used as an update value to set progress to intermediate.

Specified by:

getProgress in class PamTaskUpdate

Returns:

the progress of the thread, between 0 and 1.

getProgressString

public String getProgressString()

Description copied from class: PamTaskUpdate

Returns a message indicating progress. Can be overriden to supply other messages.

Overrides:

getProgressString in class PamTaskUpdate

Returns:

getProgressString2

public String getProgressString2()

Description copied from class: PamTaskUpdate

If two updates are available then this is used to return the fine progress update message.

Overrides:

getProgressString2 in class PamTaskUpdate

Returns: