Here we include a list of all functions that are provided to the user.
See Chapter 1 for extensive examples on how to use these functions.
Abstractly speaking, a process is a series of actions or steps taken in order to achieve a particular end.
We refer to steps by their position in the series. For technical reasons, we add an artificial step 0 at the beginning of the series. Step 0 is completed when the process starts.
A step might be broken down into smaller steps, and thus we can think of a step as a (sub-)process. In this case, we call the larger process the parent (process) and the nested (sub-)process the child (process). Therefore a process naturally induces a tree graph via the parent-child relations which we call a process tree.
The progress of a process is the measure how close we are to the end. The process has terminated when the end is reached.
Displaying the progress of a process means that we only show information about the current state of the process, whilst removing all visual references to the past states.
A change of one step to the next is called the progression of a process. We update the display on the terminal screen for each progression automatically.
This package displays the progress of exactly one main process, which we call the root (process).
Here we include a list of all functions related to creating and modifying a process.
‣ ProcessIterator( iterLike[, id[, parent]][, content] ) | ( function ) |
Returns an iterator that behaves the same way as iterLike and displays the progression of the iteration in the terminal, see Chapter 1 for examples.
The argument iterLike must be either in the filter IsListOrCollection or IsIterator, or be a record with entries (iter, totalSteps) where iter is in the filter IsIterator and totalSteps is the number of times we have to call NextIterator until IsDoneIterator returns true.
The optional argument id must be a unique string identifier for the process. If no id is provided, this process is assigned a random identifier.
The optional argument parent must either be a process iterator, a process record, the id of a valid process, or fail to declare the process as the root. If no parent is set, the parent is set automatically to the most recent active process.
The optional argument content must be a record, that contains additional information for the printer, possibly about the progress of the process, see Chapter 4.
‣ SetProcess( totalSteps[, id[, parent]][, content] ) | ( function ) |
Returns a (new) process whose parameters are set to the given arguments, see Chapter 1 for examples.
The argument totalSteps indicates the number of steps needed for the process to terminate. May be set to infinity if the number of steps is not known. In this case, the process has to be terminated manually via TerminateProcess (2.2-7).
For the specifications and default values of the other arguments, see ProcessIterator (2.2-1).
If a process with the given id under parent already exists, this resets the process and sets totalSteps and content to the given arguments afterwards, see ResetProcess (2.2-8).
Otherwise this creates a new process under parent with identifier id. In particular if the parent is set to fail, this will always create a new process and set it as the root.
‣ RefreshProcess( process ) | ( function ) |
This function updates the timers of the process and displays the progress in the terminal.
The argument process must either be a process iterator, a process record, or the id of a valid process.
‣ UpdateProcess( process[, content[, doRefresh]] ) | ( function ) |
This function progresses the process. Call this function at the end of each step, see Chapter 1 for examples.
The argument process must either be a process iterator, a process record, or the id of a valid process.
The optional argument doRefresh is a boolean indicating whether RefreshProcess (2.2-3) should be called afterwards. It is set to true by default.
For the specifications and default values of content, see ProcessIterator (2.2-1).
‣ StartProcess( process[, doRefresh] ) | ( function ) |
This function starts/resumes the timing of process and all its descendants.
For the specifications and default values of the arguments, see UpdateProcess (2.2-4).
‣ StopProcess( process[, doRefresh] ) | ( function ) |
This function stops the timing of process and all its descendants.
For the specifications and default values of the arguments, see UpdateProcess (2.2-4).
‣ TerminateProcess( process[, doRefresh] ) | ( function ) |
This function terminates process and all its descendants.
For the specifications and default values of the arguments, see UpdateProcess (2.2-4).
‣ ResetProcess( process[, doRefresh] ) | ( function ) |
This function resets process and all its descendants to the initial state.
For the specifications and default values of the arguments, see UpdateProcess (2.2-4).
Here we include a list of all functions related to the display.
‣ SetLayout( layout ) | ( function ) |
Sets the layout of the progress printer.
See Chapter 3 for a list of available layouts.
‣ LayoutOptions( ) | ( function ) |
Prints the layout options of the progress printer.
‣ SetLayoutOptions( optrec ) | ( function ) |
Sets the layout options of the progress printer.
The argument optrec must be a record with components that are valid options for the current layout, see Chapter 3. The components for the layout options are set to the values specified by the components in optrec.
‣ ResetLayoutOptions( ) | ( function ) |
Resets the layout options of the progress printer to default.
Some layout options allow to set a color or a style. The available colors and styles are listed below.
Color"default" is the default printing color of your terminal. This color might dynamically change depending on your local settings like nightmode.
other: black , red , green , yellow , blue , magenta , cyan , white .
Style"default" is the default printing style of your terminal, usually roman.
other: bold , dim , italic , underline , blinking.
generated by GAPDoc2HTML