ProgressReporter

Reports progress of an operation to its listeners. Progress starts at 0.0 and finishes at 1.0, so 0.3 means 30% progress.

Example usage:

class CounterWithProgress(marker: Char) extends ProgressReporter {
  def count(max: Int) {
    val progressIncrement = Math.max(max / 10, 1)

    println("Counting " + max + " '" + marker + "'.")

    for (i <- 1 to max) {
      print(marker)
      if (i % progressIncrement == 0) notifyProgressListeners(i, max)
    }

    println("\nCounting done.")
  }
}

object ProgressReporterExample extends App {
  // Create counter
  val counter = new CounterWithProgress('+')

  // Add progress listener
  counter.addProgressListener(e => println(f"\nProgress notification: ${e.progressPercent}%3.0f%%"))

  // Count
  counter.count(100)
}

Linear Supertypes

AnyRef, Any

Known Subclasses

CoherenceEnhancingDiffusion

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
def addProgressListener[R](op: (ProgressEvent) ⇒ R): Unit

Add progress listener.
def addProgressListener(l: ProgressListener): Unit

Add progress listener.
Add progress listener.
l
listener to add.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def currentProgress: Double

Report what fraction of the processing task was already completed.
Report what fraction of the processing task was already completed. Progress value is between 0 and 1 (meaning 100% completed). For instance, 0.25 means that 25% con the processing was completed.
returns
current progress.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def notifyProgressListeners(count: Long, max: Long, message: String = ""): Unit

Set new progress value and notify listeners.
Set new progress value and notify listeners. Progress is calculated from count and max values:
```
progress = count.toDouble / max.toDouble
```
message
message that will be send to listeners within ProgressEvent

Attributes
protected
def notifyProgressListeners(progress: Double): Unit

Attributes
protected
def notifyProgressListeners(progress: Double, message: String): Unit

Set new progress value and notify listeners.
Set new progress value and notify listeners.
progress
new value of currentProgress. The value must be not less than 0 and not more than 1.
message
message that will be send to listeners within ProgressEvent

Attributes
protected
def notifyProgressListeners(): Unit

Notify listeners of current value of progress.
Notify listeners of current value of progress. Progress message is an empty string.

Attributes
protected
See also
#notifyProgressListeners(double)
def removeAllProgressListener(): Unit

Remove all progress listener.
def removeProgressListener(l: ProgressListener): Unit

Remove specific progress listener.
Remove specific progress listener.
l
listener to remove.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

trait ProgressReporter extends AnyRef

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def addProgressListener[R](op: (ProgressEvent) ⇒ R): Unit

def addProgressListener(l: ProgressListener): Unit

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def currentProgress: Double

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def notifyProgressListeners(count: Long, max: Long, message: String = ""): Unit

def notifyProgressListeners(progress: Double): Unit

def notifyProgressListeners(progress: Double, message: String): Unit

def notifyProgressListeners(): Unit

def removeAllProgressListener(): Unit

def removeProgressListener(l: ProgressListener): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped