OpenTAP 9.25
API Reference
Public Member Functions | Properties | List of all members
OpenTap.TraceBar Class Reference

Utility class to help print an "ASCII-art" graph with limits in the log files and windows. More...

Public Member Functions

string GetBar (double result)
 Returns a string containing a "tracebar" ready to be printed in the log. More...
 
 TraceBar ()
 Initializes a new instance of the TraceBar class.
 

Properties

double LowerLimit [getset]
 Gets or sets the lower limit which is also used to determine the range of the graph.
 
double UpperLimit [getset]
 Gets or sets the upper limit which is also used to determine the range of the graph.
 
bool ShowResult [getset]
 Gets or sets a Boolean value indicating whether the result will be printed as a number next to the bar.
 
bool ShowVerdict [getset]
 Gets or sets a Boolean value indicating whether the verdict (pass/fail) will be shown next to the bar.
 
byte BarLength [getset]
 Gets or sets the length of the bar in characters.
 
Verdict CombinedVerdict [get]
 Combined verdict for all times GetBar has been called.
 

Detailed Description

Utility class to help print an "ASCII-art" graph with limits in the log files and windows.

Member Function Documentation

◆ GetBar()

string OpenTap.TraceBar.GetBar ( double  result)
inline

Returns a string containing a "tracebar" ready to be printed in the log.

Parameters
resultThe value to visualize in a TraceBar.
Returns
A string containing a "tracebar" ready to be printed in the log.

OpenTAP 9.25 API built Tue Aug 6 2024 07:49:25