feisty meow concerns codebase  2.140
basis::common Class Reference

the "common" class defines our common_outcomes. More...

#include <common_outcomes.h>

Public Types

enum  outcomes {
  DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") ,
  DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") ,
  DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") ,
  DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") ,
  DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") ,
  DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") ,
  DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine") , DEFINE_API_OUTCOME =(OKAY, 0, "Everything is just fine")
}
 these outcomes are returned by classes that use the basic HOOPLE support. More...
 

Static Public Member Functions

static const char * outcome_name (const outcome &to_name)
 Returns a string representation of the outcome "to_name". More...
 

Detailed Description

the "common" class defines our common_outcomes.

Definition at line 23 of file common_outcomes.h.

Member Enumeration Documentation

◆ outcomes

these outcomes are returned by classes that use the basic HOOPLE support.

More complicated classes will need to define their own outcome values to describe what occurred during the processing of requests.

Enumerator
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 
DEFINE_API_OUTCOME 

Definition at line 29 of file common_outcomes.h.

Member Function Documentation

◆ outcome_name()

const char * basis::common::outcome_name ( const outcome to_name)
static

Returns a string representation of the outcome "to_name".

If "to_name" is unknown, because it's not a member of the common::outcomes enum, then a string reporting that is returned.

Definition at line 19 of file common_outcomes.cpp.

References basis::outcome::value().

Referenced by textual::xml_parser::outcome_name(), and sockets::communication_commons::outcome_name().


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