printutils.h

00001 /*
00002  * Orca-Robotics Project: Components for robotics
00003  *               http://orca-robotics.sf.net/
00004  * Copyright (c) 2004-2009 Alex Brooks, Alexei Makarenko, Tobias Kaupp
00005  *
00006  * This copy of Orca is licensed to you under the terms described in
00007  * the LICENSE file included in this distribution.
00008  *
00009  */
00010 
00011 #ifndef ORCAICE_PRINT_UTILITIES_H
00012 #define ORCAICE_PRINT_UTILITIES_H
00013 
00014 #include <orcaice/context.h>
00015 
00016 #include <orca/common.h>
00017 
00018 // These functions should've been in privateutils.h but they are needed for templated functions
00019 // in connectutils.h.
00020 // Do not doxygen, these are not part of public API.
00021 
00022 namespace orcaice
00023 {
00024     // A uniform way to print messages before the standard tracer object is created.
00025     void initTracerInfo( const std::string & message );
00026     void initTracerWarning( const std::string & message );
00027     void initTracerError( const std::string & message );
00028 
00029     // Will try to use the Tracer, will print to screen if fails
00030     void initTracerInfo( const orcaice::Context & context, const std::string & message, bool localOnly=false );
00031     void initTracerWarning( const orcaice::Context & context, const std::string & message, bool localOnly=false );
00032     void initTracerError( const orcaice::Context & context, const std::string & message, bool localOnly=false );
00033 
00034 } // namespace
00035 
00036 #endif