OpenTAP 9.24
API Reference
Public Member Functions | Static Public Member Functions | Properties | List of all members
OpenTap.ConsoleTraceListener Class Reference

A class that prints trace messages to the console. More...

Inheritance diagram for OpenTap.ConsoleTraceListener:
OpenTap.TraceListener OpenTap.Diagnostic.ILogListener

Public Member Functions

override void Flush ()
 Waits for the messages to be written to the console.
 
 ConsoleTraceListener (bool isVerbose, bool isQuiet, bool isColor)
 Creates an instance of the ConsoleTraceListener that can be used to output log messages in consoles. More...
 
override void TraceEvents (IEnumerable< Event > events)
 Prints all log messages to the console. More...
 
- Public Member Functions inherited from OpenTap.TraceListener
virtual void TraceEvent (string source, LogEventType eventType, int id, string format)
 Empty TraceEvent method.
 
virtual void TraceEvent (string source, LogEventType eventType, int id, string format, params object[] args)
 Empty TraceEvent method.
 
virtual void Write (string str)
 Virtual method to match System.Diagnostics.TraceListener. Might be removed.
 
virtual void WriteLine (string str)
 Virtual method to match System.Diagnostics.TraceListener. Might be removed.
 

Static Public Member Functions

static void SetStartupTime (DateTime time)
 Set logs startup time, this will affect timestamp of all log messages. More...
 

Properties

bool IsVerbose [getset]
 Show verbose/debug level log messages.
 
bool IsQuiet [getset]
 Hide debug and information level log messages.
 
bool IsColor [getset]
 Color messages according to their level.
 

Detailed Description

A class that prints trace messages to the console.

Constructor & Destructor Documentation

◆ ConsoleTraceListener()

OpenTap.ConsoleTraceListener.ConsoleTraceListener ( bool  isVerbose,
bool  isQuiet,
bool  isColor 
)
inline

Creates an instance of the ConsoleTraceListener that can be used to output log messages in consoles.

Parameters
isVerbose
isQuiet
isColor

Member Function Documentation

◆ SetStartupTime()

static void OpenTap.ConsoleTraceListener.SetStartupTime ( DateTime  time)
inlinestatic

Set logs startup time, this will affect timestamp of all log messages.

Parameters
time

◆ TraceEvents()

override void OpenTap.ConsoleTraceListener.TraceEvents ( IEnumerable< Event events)
inlinevirtual

Prints all log messages to the console.

Parameters
events

Reimplemented from OpenTap.TraceListener.

OpenTAP 9.24 API built Tue Apr 30 2024 13:44:41