feat(unitproc):vbm: Add script name to verbose error message

[BK-2020-03.git] / unitproc / bktemp-vbm

#!/bin/bash
# Desc: Display message if optionVerbose true

vbm() {
    # Description: Prints verbose message ("vbm") to stderr if optionVerbose is set to "true".
    # Usage: vbm "DEBUG :verbose message here"
    # Version 0.1.3
    # Input: arg1: string
    #        vars: optionVerbose
    # Output: stderr
    # Depends: bash 5.0.3, echo 8.30, date 8.30

    if [ "$optionVerbose" = "true" ]; then
	functionTime=$(date --iso-8601=ns); # Save current time in nano seconds.
	echo "[$functionTime]:$0:""$*" 1>&2; # Display argument text.
    fi

    # End function
    return 0; # Function finished.
} # Displays message if optionVerbose true

#==BEGIN sample code==
vbm "STATUS:This is a status message.";
optionVerbose="true";
vbm "STATUS:This is another status message.";
#==END sample code==

# Author: Steven Baltakatei Sandoval
# License: GPLv3+