RiFeedback

Responsible for giving feedback to the user (Errors, Stats, Warnings, and Info)

This is an abstract class and cannot be directly instanced.

[ Common | Source | Search | Keywords | Summary | Ancestors | All Members | Descendants ]

Quick Index

DESCRIPTION

Class Summary

class RiFeedback
{
public:
enum Terminator ;
// Constructors and assignment
RiFeedback() ;
~RiFeedback() ;
// Accessors
static RiFeedback &Error();
static RiFeedback &Warning();
static RiFeedback &Info();
static RiFeedback &Statistics();
static void SetError(RiFeedback *);
static void SetWarning(RiFeedback *);
static void SetInfo(RiFeedback *);
static void SetStatistics(RiFeedback *);
ostream &GetOStream(); // pure virtual
// Members
void EndOfInput(Terminator);
static void Abort();
protected:
}; // RiFeedback

DESCRIPTION

This class functions much like an ostream. The operator << is overloaded (as an inline) to work for RiFeedback classes and RiFeedback terminators. The Terminators allow fatal errors to cause a clean crash. Critical errors are those where there is a significant amount of data loss. A crash might not be warrented.

enum Terminator ;

Terminator {endl, fatal, critical};No documentation available.

    enum Terminator {endl, fatal, critical};

RiFeedback() ;

 edback() {} GROUP: Constructors and assignment

    RiFeedback()   
;

Function is currently defined inline.

~RiFeedback() ;

 Destructor

    virtual ~RiFeedback()   
;

Function is currently defined inline.

RiFeedback &Error();

 Return the error feedback handler

    static RiFeedback &Error();

RiFeedback &Warning();

 Return the warning feedback handler

    static RiFeedback &Warning();

RiFeedback &Info();

 Return the info feedback handler

    static RiFeedback &Info();

RiFeedback &Statistics();

 Return the stats feedback handler

    static RiFeedback &Statistics();

void SetError(RiFeedback *);

 Set the error feedback handler

    static void SetError(RiFeedback *);

void SetWarning(RiFeedback *);

 Set the warning feedback handler

    static void SetWarning(RiFeedback *);

void SetInfo(RiFeedback *);

 Set the info feedback handler

    static void SetInfo(RiFeedback *);

void SetStatistics(RiFeedback *);

 Set the stats feedback handler

    static void SetStatistics(RiFeedback *);

ostream &GetOStream();

 return an ostream that will accept the data.

    virtual ostream &GetOStream();

void EndOfInput(Terminator);

 Do any actions required at the end of a message The default is to send an endl (endline) to GetOStream

    virtual void EndOfInput(Terminator);

void Abort();

 Abort the program (perhaps cleaning up and saving partial work)

    static void Abort();

All Members

public:
enum Terminator ;
// Accessors
static RiFeedback &Error();
static RiFeedback &Warning();
static RiFeedback &Info();
static RiFeedback &Statistics();
static void SetError(RiFeedback *);
static void SetWarning(RiFeedback *);
static void SetInfo(RiFeedback *);
static void SetStatistics(RiFeedback *);
ostream &GetOStream(); // pure virtual
// Members
void EndOfInput(Terminator);
static void Abort();
protected:

Ancestors

Class does not inherit from any other class.

Descendants

Generated from source by the Cocoon utilities on Fri Feb 25 15:15:04 2000 .