ofstd/include/oflogfil.h

/*
 *
 *  Copyright (C) 2000-2004, OFFIS
 *
 *  This software and supporting documentation were developed by
 *
 *    Kuratorium OFFIS e.V.
 *    Healthcare Information and Communication Systems
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *  THIS SOFTWARE IS MADE AVAILABLE,  AS IS,  AND OFFIS MAKES NO  WARRANTY
 *  REGARDING  THE  SOFTWARE,  ITS  PERFORMANCE,  ITS  MERCHANTABILITY  OR
 *  FITNESS FOR ANY PARTICULAR USE, FREEDOM FROM ANY COMPUTER DISEASES  OR
 *  ITS CONFORMITY TO ANY SPECIFICATION. THE ENTIRE RISK AS TO QUALITY AND
 *  PERFORMANCE OF THE SOFTWARE IS WITH THE USER.
 *
 *  Module:  ofstd
 *
 *  Author:  Joerg Riesmeier
 *
 *  Purpose: Define general purpose facility for log file output
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2004/01/16 10:30:12 $
 *  CVS/RCS Revision: $Revision: 1.12 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */


#ifndef OFLOGFIL_H
#define OFLOGFIL_H

#include "osconfig.h"
#include "ofthread.h"
#include "ofstream.h"

#define INCLUDE_CSTDLIB
#include "ofstdinc.h"


class OFLogFile
{
 public:

    enum LF_Level
    {
        LL_none = 0,
        LL_error = 1,
        LL_warning = 2,
        LL_informational = 3,
        LL_debug = 4
    };

    OFLogFile(const char *filename, int flags = ios::app);

    virtual ~OFLogFile() {}

    ofstream &lockFile(LF_Level level = LL_none, const char *module = NULL);

    void unlockFile()
    {
        File.flush();
#ifdef _REENTRANT
        Mutex.unlock();
#endif
    }

    OFBool good()
    {
#ifdef _REENTRANT
        Mutex.lock();
#endif
        OFBool status = File.good() ? OFTrue : OFFalse;
#ifdef _REENTRANT
        Mutex.unlock();
#endif
        return status;
    }

    ostream& getFile()
    {
        return File;
    }

    void writeMessage(const char *message, int indent = 3);

    void setFilter(LF_Level level)
    {
#ifdef _REENTRANT
        Mutex.lock();
#endif
        Filter = level;
#ifdef _REENTRANT
        Mutex.unlock();
#endif
    }

    LF_Level getFilter()
    {
        return Filter;
    }

    OFBool checkFilter(LF_Level level)
    {
        return (level != LL_none) && (level <= Filter);
    }


 private:

    OFLogFile(const OFLogFile &arg);

    OFLogFile& operator=(const OFLogFile &arg);

    ofstream File;

    LF_Level Filter;

#ifdef _REENTRANT

    OFMutex Mutex;
#endif
};


#endif


/*
 *
 * CVS/RCS Log:
 * $Log: oflogfil.h,v $
 * Revision 1.12  2004/01/16 10:30:12  joergr
 * Removed acknowledgements with e-mail addresses from CVS log.
 *
 * Revision 1.11  2003/12/05 10:37:41  joergr
 * Removed leading underscore characters from preprocessor symbols (reserved
 * symbols). Updated copyright date where appropriate.
 *
 * Revision 1.10  2003/06/12 13:14:29  joergr
 * Fixed inconsistent API documentation reported by Doxygen.
 *
 * Revision 1.9  2003/06/11 13:26:09  meichel
 * Cleaned up usage of boolean constants
 *
 * Revision 1.8  2002/11/27 11:23:05  meichel
 * Adapted module ofstd to use of new header file ofstdinc.h
 *
 * Revision 1.7  2002/05/16 15:56:18  meichel
 * Minor fixes to make ofstd compile on NeXTStep 3.3
 *
 * Revision 1.6  2002/05/14 08:12:29  joergr
 * Updated comments.
 *
 * Revision 1.5  2002/04/16 13:36:03  joergr
 * Added configurable support for C++ ANSI standard includes (e.g. streams).
 *
 * Revision 1.4  2001/06/01 15:51:34  meichel
 * Updated copyright header
 *
 * Revision 1.3  2000/12/12 17:19:57  joergr
 * Changed type of stream 'open_mode' from long to int to avoid compiler
 * warnings reported by SunCC 2.0.1.
 *
 * Revision 1.2  2000/06/21 15:47:54  meichel
 * Including stdlib.h, required for Sun CC 4.2
 *
 * Revision 1.1  2000/06/05 16:16:23  joergr
 * Added new class for writing standardized status messages to a log file.
 *
 *
 */

---

Generated on 4 Nov 2004 for OFFIS DCMTK Version 3.5.3 by Doxygen 1.3.8