nginstack

Class: Progress

@nginstack/engine/lib/progress/Progress~ Progress

new Progress( [opt_logger])

Classe que permite o registro do progresso de tarefas. O progresso será gravado no log na prioridade PROGRESS, um nível entre DEBUG e INFO. Para que o progresso seja registrado, a categoria de log utilizada deve estar configurada com prioridade DEBUG ou PROGRESS.

Parameters:
Name Type Argument Description
opt_logger Logger <optional>

Logger que deve ser utilizado para gravar as mensagens de progresso. Caso não seja informado, os logs serão gravados na categoria root.
See:
Example
var progress = new Progress()
try {
  progress.beginTask( "Loop de 1 a 100", 100 )
  for ( var i = 0; i < 100; ++i ){
     // Faz algo
     progress.worked()
  }
} finally {
  progress.done()
}

Methods

beginTask(name [, opt_totalWork])

Inicia o registro do progresso de uma tarefa.

Parameters:
Name Type Argument Description
name string

Nome da tarefa
opt_totalWork number <optional>

Indica o total de trabalho necessário para concluir a tarefa. O registro do trabalho será realizado pelo método worked(). A estimativa de término será indefinido caso este parâmetro não seja informado.
See:

done()

Finaliza o progresso de uma tarefa.

See:

forkSubTask(workQty)

Indica que uma subtarefa irá realizar parte do trabalho. O trabalho da subtarefa será registrado proporcionalmente como trabalho da tarefa corrente. O registro do progresso da subtarefa deve ser realizado através da criação de um novo objeto Progress.

Parameters:
Name Type Description
workQty number

Quantidade de trabalho que a subtarefa irá realizar.

worked( [opt_qty])

Informa o avanço na tarefa.

Parameters:
Name Type Argument Description
opt_qty number <optional>

Quantidade de trabalho realizado dentre o total informado no método beginTask. Se não for informado, será considerado 1.
See: