Loading...
Searching...
No Matches
ocsd_msg_logger.h
Go to the documentation of this file.
/*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef ARM_OCSD_MSG_LOGGER_H_INCLUDED
#define ARM_OCSD_MSG_LOGGER_H_INCLUDED
#include <string>
#include <fstream>
class ocsdMsgLogStrOutI
{
public:
ocsdMsgLogStrOutI() {};
virtual ~ocsdMsgLogStrOutI() {};
virtual void printOutStr(const std::string &outStr) = 0;
};
class ocsdMsgLogger
{
public:
ocsdMsgLogger();
~ocsdMsgLogger();
typedef enum {
OUT_NONE = 0,
OUT_FILE = 1,
OUT_STDERR = 2,
OUT_STDOUT = 4,
OUT_STR_CB = 8
} output_dest;
void setLogOpts(int logOpts);
const int getLogOpts() const
{ return m_outFlags; };
void setLogFileName(const char *fileName);
void setStrOutFn(ocsdMsgLogStrOutI *p_IstrOut);
void LogMsg(const std::string &msg);
const bool isLogging() const;
private:
int m_outFlags;
std::string m_logFileName;
std::fstream m_out_file;
ocsdMsgLogStrOutI *m_pOutStrI;
};
#endif // ARM_OCSD_MSG_LOGGER_H_INCLUDED
/* End of File ocsd_msg_logger.h */
ocsdMsgLogStrOutI
Definition ocsd_msg_logger.h:42
ocsdMsgLogStrOutI::~ocsdMsgLogStrOutI
virtual ~ocsdMsgLogStrOutI()
Definition ocsd_msg_logger.h:45
ocsdMsgLogStrOutI::printOutStr
virtual void printOutStr(const std::string &outStr)=0
ocsdMsgLogStrOutI::ocsdMsgLogStrOutI
ocsdMsgLogStrOutI()
Definition ocsd_msg_logger.h:44
ocsdMsgLogger
Definition ocsd_msg_logger.h:51
ocsdMsgLogger::setStrOutFn
void setStrOutFn(ocsdMsgLogStrOutI *p_IstrOut)
Set the output log string callback and enable logging to callback.
ocsdMsgLogger::getLogOpts
const int getLogOpts() const
get the current output logging flags value.
Definition ocsd_msg_logger.h:67
ocsdMsgLogger::setLogFileName
void setLogFileName(const char *fileName)
Set the output log filename, and enable logging to file.
ocsdMsgLogger::ocsdMsgLogger
ocsdMsgLogger()
ocsdMsgLogger::output_dest
output_dest
Definition ocsd_msg_logger.h:58
ocsdMsgLogger::OUT_FILE
@ OUT_FILE
Definition ocsd_msg_logger.h:60
ocsdMsgLogger::OUT_STDERR
@ OUT_STDERR
Definition ocsd_msg_logger.h:61
ocsdMsgLogger::OUT_STR_CB
@ OUT_STR_CB
Definition ocsd_msg_logger.h:63
ocsdMsgLogger::OUT_NONE
@ OUT_NONE
Definition ocsd_msg_logger.h:59
ocsdMsgLogger::OUT_STDOUT
@ OUT_STDOUT
Definition ocsd_msg_logger.h:62
ocsdMsgLogger::LogMsg
void LogMsg(const std::string &msg)
Log a message to the current set output channels.
ocsdMsgLogger::isLogging
const bool isLogging() const
true if logging active
ocsdMsgLogger::~ocsdMsgLogger
~ocsdMsgLogger()
ocsdMsgLogger::setLogOpts
void setLogOpts(int logOpts)
set the output logging flags.