MySQL  8.0.18
Source Code Documentation
Group_action_diagnostics Class Reference

The parent class for group wide operations. More...

#include <group_action.h>

Public Types

enum  enum_action_result_level { GROUP_ACTION_LOG_INFO = 0, GROUP_ACTION_LOG_WARNING = 1, GROUP_ACTION_LOG_ERROR = 2, GROUP_ACTION_LOG_END = 3 }
 

Public Member Functions

 Group_action_diagnostics ()
 
Constructor More...
 
void set_execution_info (Group_action_diagnostics *diagnostics)
 
Set the message for this operation More...
 
void set_execution_message_level (enum_action_result_level level)
 
Set the result level for the message for this operation More...
 
void set_execution_message (enum_action_result_level level, std::string &message)
 
Set the message for this operation More...
 
void set_execution_message (enum_action_result_level level, const char *message)
 
Set the message for this operation More...
 
void append_execution_message (const char *message)
 
Appends the given message to the execution message for this operation More...
 
void append_execution_message (std::string &message)
 
Appends the given message to the execution message for this operation More...
 
void set_warning_message (const char *warning_msg)
 
Set the warning message for this operation More...
 
void append_warning_message (const char *warning_msg)
 
Append to the warning message for this operation More...
 
std::string & get_execution_message ()
 
std::string & get_warning_message ()
 
More...
 
enum_action_result_level get_execution_message_level ()
 
More...
 
bool has_warning ()
 return The test has logged warnings? More...
 
void clear_info ()
 
Removes the old log messages and level information More...
 

Private Attributes

enum_action_result_level message_level
 Simply log, are there warnings, or should we report an error. More...
 
std::string log_message
 The log execution message: success or failure. More...
 
std::string warning_message
 The warning message. More...
 

Detailed Description

The parent class for group wide operations.

Member Enumeration Documentation

◆ enum_action_result_level

Enumerator
GROUP_ACTION_LOG_INFO 
GROUP_ACTION_LOG_WARNING 
GROUP_ACTION_LOG_ERROR 
GROUP_ACTION_LOG_END 

Constructor & Destructor Documentation

◆ Group_action_diagnostics()

Group_action_diagnostics::Group_action_diagnostics ( )


Constructor

Member Function Documentation

◆ append_execution_message() [1/2]

void Group_action_diagnostics::append_execution_message ( const char *  message)


Appends the given message to the execution message for this operation

Parameters
messagethe message to append

◆ append_execution_message() [2/2]

void Group_action_diagnostics::append_execution_message ( std::string &  message)


Appends the given message to the execution message for this operation

Parameters
messagethe message to append

◆ append_warning_message()

void Group_action_diagnostics::append_warning_message ( const char *  warning_msg)


Append to the warning message for this operation

Parameters
warning_msgthe message to the user

◆ clear_info()

void Group_action_diagnostics::clear_info ( )


Removes the old log messages and level information

◆ get_execution_message()

std::string & Group_action_diagnostics::get_execution_message ( )
Returns
the message to be shown to the user

◆ get_execution_message_level()

Group_action_diagnostics::enum_action_result_level Group_action_diagnostics::get_execution_message_level ( )


Returns
the message level be shown to the user

◆ get_warning_message()

std::string & Group_action_diagnostics::get_warning_message ( )


Returns
the warning to be shown to the user

◆ has_warning()

bool Group_action_diagnostics::has_warning ( )

return The test has logged warnings?

◆ set_execution_info()

void Group_action_diagnostics::set_execution_info ( Group_action_diagnostics diagnostics)


Set the message for this operation

Parameters
diagnosticsanother diagnostics object

◆ set_execution_message() [1/2]

void Group_action_diagnostics::set_execution_message ( enum_action_result_level  level,
std::string &  message 
)


Set the message for this operation

Parameters
levelif it is an information, warning or error message
messagethe message to the user

◆ set_execution_message() [2/2]

void Group_action_diagnostics::set_execution_message ( enum_action_result_level  level,
const char *  message 
)


Set the message for this operation

Parameters
levelif it is an information, warning or error message
messagethe message to the user

◆ set_execution_message_level()

void Group_action_diagnostics::set_execution_message_level ( enum_action_result_level  level)


Set the result level for the message for this operation

Parameters
levelthe level of the return message

◆ set_warning_message()

void Group_action_diagnostics::set_warning_message ( const char *  warning_msg)


Set the warning message for this operation

Parameters
warning_msgthe message to the user

Member Data Documentation

◆ log_message

std::string Group_action_diagnostics::log_message
private

The log execution message: success or failure.

◆ message_level

enum_action_result_level Group_action_diagnostics::message_level
private

Simply log, are there warnings, or should we report an error.

◆ warning_message

std::string Group_action_diagnostics::warning_message
private

The warning message.


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