DDD_LogFacade.h

Go to the documentation of this file.

#ifndef DDD_LOGGER_H_
#define DDD_LOGGER_H_

/*! \file DDD_LogFacade.h
  

  \par Copyright Information

  Copyright (c) 2012 The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBLITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/
#include "DDD_Include.h"
#include <string>

namespace disti
{
/** \brief  Facade to provide a simpler interface to the DDD_Log singleton. Its second purpose is for decoupling; 
  it eliminates user plugins dependencies on DDD_Log (and its dependencies). */
class DDD_EXPORT DDD_LogFacade
{
public:
    /** Sends a string to log with debug level (general info) importance
      * \param format C style printf format string 
      */
    static void LogDebug(const char *format,...);

    /** Sends a string to log with low level (general info) importance
      * \param format C style printf format string 
      */
    static void LogInfo(const char *format,...);

    /** Sends a string to log with mid level (warning) importance
      * \param format C style printf format string 
      */
    static void LogWarning(const char *format,...);

    /** Sends a string to log with high level (error) importance
      * \param format C style printf format string 
      */
    static void LogError(const char *format,...);
};


/** \def DDD_LogDebug(X)  Macro for debug logging. 
   \a X should be the same syntax as the Log* methods in DDD_LogFacade. */
#ifdef DDD_LOG_DEBUG
#define DDD_LogDebug(X)   DDD_LogFacade::LogInfo(X)
#else
#define DDD_LogDebug(X)   ((void)0)
#endif  // DDD_LOG_DEBUG



} // end of namespace disti

#endif