Public Types | Static Public Member Functions | Private Member Functions | Private Attributes
hayai::Console Class Reference

Static helper class for outputting to a terminal/console. More...

#include <hayai_console.hpp>

List of all members.

Public Types

enum  TextColor {
  TextDefault, TextBlack, TextBlue, TextGreen,
  TextCyan, TextRed, TextPurple, TextYellow,
  TextWhite
}
 Console text colors. More...

Static Public Member Functions

static ConsoleInstance ()
 Get the singleton instance of Console.
static bool IsFormattingEnabled ()
 Test if formatting is enabled.
static void SetFormattingEnabled (bool enabled)
 Set whether formatting is enabled.

Private Member Functions

 Console ()

Private Attributes

bool _formattingEnabled

Detailed Description

Static helper class for outputting to a terminal/console.

Definition at line 22 of file hayai_console.hpp.


Member Enumeration Documentation

Console text colors.

Enumerator:
TextDefault 

Default console color. Used for resets.

TextBlack 

Black.

Warning:
Avoid using black unless it is absolutely necesssary.
TextBlue 

Blue.

TextGreen 

Green.

TextCyan 

Cyan.

TextRed 

Red.

TextPurple 

Purple.

TextYellow 

Yellow.

TextWhite 

White.

Warning:
Avoid using white unless it is absolutely necessary.

Definition at line 26 of file hayai_console.hpp.


Constructor & Destructor Documentation

hayai::Console::Console ( ) [inline, private]

Definition at line 85 of file hayai_console.hpp.


Member Function Documentation

static Console& hayai::Console::Instance ( ) [inline, static]

Get the singleton instance of Console.

Returns:
a reference to the singleton instance of the benchmarker execution controller.

Definition at line 65 of file hayai_console.hpp.

static bool hayai::Console::IsFormattingEnabled ( ) [inline, static]

Test if formatting is enabled.

Definition at line 73 of file hayai_console.hpp.

static void hayai::Console::SetFormattingEnabled ( bool  enabled) [inline, static]

Set whether formatting is enabled.

Definition at line 80 of file hayai_console.hpp.


Member Data Documentation

Definition at line 92 of file hayai_console.hpp.


The documentation for this class was generated from the following file:


hayai
Author(s): Nick Bruun
autogenerated on Thu Jun 6 2019 18:13:43