/home/coin/svn-release/OS-2.7.0/OS/src/OSUtils/OSOutput.h File Reference

#include "OSConfig.h"
#include "OSParameters.h"
#include "OSReferenced.hpp"
#include "OSSmartPtr.hpp"
#include <string>
#include <vector>
Include dependency graph for OSOutput.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  OSOutputChannel
 a class that holds information about one output channel (file, device, stream, peripheral, etc.) More...
class  OSOutput
 This class handles all the output from OSSolverService, OSAmplClient and other executables derived from them. Every output statement in the code uses methods in this class, passing information about the area that originated the request as well as the print, verbosity or severity level of the message. The message creates output only if the print level matches the user specifications. The main advantage of doing things this way is that multiple output streams can be maintained, each tailored to a specific need and containing only output that the user really wants to see. There can be as many output streams as needed; each one has an identifying name ("stdout" and "stderr" are reserved names) and an array of print levels, one for each area. The class is implemented as a Singleton, which means that two private methods must be defined in the header but must *never* be implemented: a copy constructor, and an equality operator. More...

Defines

#define DEFAULT_OUTPUT_LEVEL   ENUM_OUTPUT_LEVEL_error

Enumerations

enum  ENUM_OUTPUT_LEVEL {
  ENUM_OUTPUT_LEVEL_always = 0, ENUM_OUTPUT_LEVEL_error, ENUM_OUTPUT_LEVEL_summary, ENUM_OUTPUT_LEVEL_warning,
  ENUM_OUTPUT_LEVEL_info, ENUM_OUTPUT_LEVEL_debug, ENUM_OUTPUT_LEVEL_trace, ENUM_OUTPUT_LEVEL_detailed_trace,
  ENUM_OUTPUT_LEVEL_NUMBER_OF_LEVELS
}
 

Enumeration for the different verbosity levels that can be used in producing output.

More...
enum  ENUM_OUTPUT_AREA {
  ENUM_OUTPUT_AREA_main = 0, ENUM_OUTPUT_AREA_OSAgent, ENUM_OUTPUT_AREA_Command_line_parser, ENUM_OUTPUT_AREA_OSiL_parser,
  ENUM_OUTPUT_AREA_OSoL_parser, ENUM_OUTPUT_AREA_OSrL_parser, ENUM_OUTPUT_AREA_OSGeneral, ENUM_OUTPUT_AREA_OSInstance,
  ENUM_OUTPUT_AREA_OSOption, ENUM_OUTPUT_AREA_OSResult, ENUM_OUTPUT_AREA_OSExpressionTree, ENUM_OUTPUT_AREA_OSiLwriter,
  ENUM_OUTPUT_AREA_OSoLwriter, ENUM_OUTPUT_AREA_OSrLwriter, ENUM_OUTPUT_AREA_OSModelInterfaces, ENUM_OUTPUT_AREA_OSSolverInterfaces,
  ENUM_OUTPUT_AREA_OSUtils, ENUM_OUTPUT_AREA_NUMBER_OF_AREAS
}
 

Enumeration for the different areas that can produce output.

More...

Variables

const OSSmartPtr< OSOutputosoutput

Detailed Description

Author:
Horand Gassmann, Jun Ma, Kipp Martin
Remarks:
Copyright (C) 2012-2013, Horand Gassmann, Jun Ma, Kipp Martin, Northwestern University, and the University of Chicago. All Rights Reserved. This software is licensed under the Eclipse Public License. Please see the accompanying LICENSE file in root directory for terms.

Definition in file OSOutput.h.


Define Documentation

#define DEFAULT_OUTPUT_LEVEL   ENUM_OUTPUT_LEVEL_error

Definition at line 54 of file OSOutput.h.


Enumeration Type Documentation

Enumeration for the different verbosity levels that can be used in producing output.

The last three levels are used only in debug mode.

Enumerator:
ENUM_OUTPUT_LEVEL_always 
ENUM_OUTPUT_LEVEL_error 
ENUM_OUTPUT_LEVEL_summary 
ENUM_OUTPUT_LEVEL_warning 
ENUM_OUTPUT_LEVEL_info 
ENUM_OUTPUT_LEVEL_debug 
ENUM_OUTPUT_LEVEL_trace 
ENUM_OUTPUT_LEVEL_detailed_trace 
ENUM_OUTPUT_LEVEL_NUMBER_OF_LEVELS 

Definition at line 40 of file OSOutput.h.

Enumeration for the different areas that can produce output.

The last entry ENUM_OUTPUT_AREA_NUMBER_OF_AREAS gives a convenient way to count them and to allocate space

Enumerator:
ENUM_OUTPUT_AREA_main 
ENUM_OUTPUT_AREA_OSAgent 
ENUM_OUTPUT_AREA_Command_line_parser 
ENUM_OUTPUT_AREA_OSiL_parser 
ENUM_OUTPUT_AREA_OSoL_parser 
ENUM_OUTPUT_AREA_OSrL_parser 
ENUM_OUTPUT_AREA_OSGeneral 
ENUM_OUTPUT_AREA_OSInstance 
ENUM_OUTPUT_AREA_OSOption 
ENUM_OUTPUT_AREA_OSResult 
ENUM_OUTPUT_AREA_OSExpressionTree 
ENUM_OUTPUT_AREA_OSiLwriter 
ENUM_OUTPUT_AREA_OSoLwriter 
ENUM_OUTPUT_AREA_OSrLwriter 
ENUM_OUTPUT_AREA_OSModelInterfaces 
ENUM_OUTPUT_AREA_OSSolverInterfaces 
ENUM_OUTPUT_AREA_OSUtils 
ENUM_OUTPUT_AREA_NUMBER_OF_AREAS 

Definition at line 61 of file OSOutput.h.


Variable Documentation

Definition at line 39 of file OSOutput.cpp.


Generated on 24 Jul 2013 by  doxygen 1.6.1