common Struct Reference

the "common" structure gathers some popular elements of lower-level classes. More...

#include <definitions.h>

List of all members.

Public Types
enum	outcomes {   OKAY, fine, NOT_IMPLEMENTED, unimplemented,   OUT_OF_RANGE, bounds, NOT_FOUND, present,   BAD_INPUT, inappropriate, BAD_TYPE, types,   IS_FULL, facility, IS_EMPTY, currently,   IS_NEW, new, EXISTING, present,   FAILURE, occurred, OUT_OF_MEMORY, system,   ACCESS_DENIED, denied, system, IN_USE,   use, UNINITIALIZED, properly, TIMED_OUT,   elapsed, GARBAGE, corrupted, NO_SPACE,   reached, DISALLOWED, request, INCOMPLETE,   completed, NO_HANDLER, method, NONE_READY,   available, INVALID, invalid, PARTIAL,   finished, NO_LICENSE, request, UNEXPECTED,   unexpected, erroneous, ENCRYPTION_MISMATCH, provided }
	these outcomes are returned by classes that use the basic HOOPLE support. More...
enum	list_positions { HEAD = -298, TAIL, MIDDLE }
enum	how_to_copy { NEW_AT_END, NEW_AT_BEGINNING, DONT_COPY }
enum	filters {   NEVER_PRINT, dropped, ALWAYS_PRINT, recorded,   NETWORK_LOGGING, performed, UNUSUAL_LOGGING, events,   FIRST_LOW_LEVEL_FILTER = NETWORK_LOGGING, LAST_LOW_LEVEL_FILTER = UNUSUAL_LOGGING }
	These are the lowest-level filters defined for logging. More...
Static Public Member Functions
static const char *	outcome_name (const outcome &to_name)
	Returns a string representation of the outcome "to_name".
static int_set	low_level_filters ()
	A set that contains all of the low-level filter values.

---

Detailed Description

the "common" structure gathers some popular elements of lower-level classes.

Definition at line 229 of file definitions.h.

---

Member Enumeration Documentation

enum common::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:

OKAY
fine
NOT_IMPLEMENTED
unimplemented
OUT_OF_RANGE
bounds
NOT_FOUND
present
BAD_INPUT
inappropriate
BAD_TYPE
types
IS_FULL
facility
IS_EMPTY
currently
IS_NEW
new
EXISTING
present
FAILURE
occurred
OUT_OF_MEMORY
system
ACCESS_DENIED
denied
system
IN_USE
use
UNINITIALIZED
properly
TIMED_OUT
elapsed
GARBAGE
corrupted
NO_SPACE
reached
DISALLOWED
request
INCOMPLETE
completed
NO_HANDLER
method
NONE_READY
available
INVALID
invalid
PARTIAL
finished
NO_LICENSE
request
UNEXPECTED
unexpected
erroneous
ENCRYPTION_MISMATCH
provided

Definition at line 234 of file definitions.h.

enum common::list_positions

the list positions specify well known places in a linked list, or indeed in any structure that has a beginning and an end.

Enumerator:

HEAD	the beginning element in the list.
TAIL	the final element in the list.
MIDDLE	an indeterminate place that is neither head nor tail.

Definition at line 284 of file definitions.h.

enum common::how_to_copy

Enumerator:

NEW_AT_END
NEW_AT_BEGINNING
DONT_COPY

Definition at line 290 of file definitions.h.

enum common::filters

These are the lowest-level filters defined for logging.

Enumerator:

NEVER_PRINT
dropped
ALWAYS_PRINT
recorded
NETWORK_LOGGING
performed
UNUSUAL_LOGGING
events
FIRST_LOW_LEVEL_FILTER
LAST_LOW_LEVEL_FILTER

Definition at line 303 of file definitions.h.

---

Member Function Documentation

const char * 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 33 of file definitions.cpp.

References ACCESS_DENIED, BAD_INPUT, BAD_TYPE, DISALLOWED, ENCRYPTION_MISMATCH, EXISTING, FAILURE, GARBAGE, IN_USE, INCOMPLETE, INVALID, IS_EMPTY, IS_FULL, IS_NEW, NO_HANDLER, NO_LICENSE, NO_SPACE, NONE_READY, NOT_FOUND, NOT_IMPLEMENTED, OKAY, OUT_OF_MEMORY, OUT_OF_RANGE, PARTIAL, TIMED_OUT, UNEXPECTED, UNINITIALIZED, and outcome::value().

Referenced by array_tester(), deep_array_tester(), cromp_client::login(), main(), xml_parser::outcome_name(), xml_generator::outcome_name(), recursive_file_copy::outcome_name(), scheduling_common::outcome_name(), process_manager::outcome_name(), heavy_file_operations::outcome_name(), tentacle::outcome_name(), communication_commons::outcome_name(), buffer_base::outcome_name(), and directory_tree::remove_path().

int_set common::low_level_filters

(

)

[static]

A set that contains all of the low-level filter values.

Definition at line 67 of file definitions.cpp.

References FIRST_LOW_LEVEL_FILTER, and LAST_LOW_LEVEL_FILTER.

---

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

• /home/fred/hoople/source/lib_src/library/basis/definitions.h
• /home/fred/hoople/source/lib_src/library/basis/definitions.cpp

---