LogOutput.h
Go to the documentation of this file.
// This file is a part of the OpenSurgSim project.
// Copyright 2013-2016, SimQuest Solutions Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef SURGSIM_FRAMEWORK_LOGOUTPUT_H
#define SURGSIM_FRAMEWORK_LOGOUTPUT_H
#include <boost/thread/mutex.hpp>
#include <fstream>
namespace SurgSim
{
namespace Framework
{
class LogOutput
{
public:
LogOutput()
{
}
virtual ~LogOutput()
{
}
virtual bool writeMessage(const std::string& message) = 0;
};
class NullOutput : public LogOutput
{
public:
virtual bool writeMessage(const std::string& message) {return true;}
};
class FileOutput : public LogOutput
{
public:
explicit FileOutput(const std::string& filename);
bool writeMessage(const std::string& message) override;
private:
std::string m_filename;
std::ofstream m_stream;
boost::mutex m_mutex;
};
class StreamOutput : public LogOutput
{
public:
explicit StreamOutput(std::ostream& ostream); //NOLINT
bool writeMessage(const std::string& message) override;
private:
std::ostream& m_stream;
boost::mutex m_mutex;
};
}; // namespace Framework
}; // namespace SurgSim
#endif // SURGSIM_FRAMEWORK_LOGOUTPUT_H
SurgSim
Definition: CompoundShapeToGraphics.cpp:29
SurgSim::Framework::LogOutput
Virtual Base class to define an interface for outputting logging information.
Definition: LogOutput.h:28
SurgSim::Framework::StreamOutput::m_stream
std::ostream & m_stream
Definition: LogOutput.h:88
SurgSim::Framework::FileOutput::m_stream
std::ofstream m_stream
Definition: LogOutput.h:67
SurgSim::Framework::LogOutput::LogOutput
LogOutput()
Definition: LogOutput.h:31
SurgSim::Framework::LogOutput::~LogOutput
virtual ~LogOutput()
Definition: LogOutput.h:35
SurgSim::Framework::NullOutput
Definition: LogOutput.h:45
SurgSim::Framework::FileOutput::m_mutex
boost::mutex m_mutex
Definition: LogOutput.h:68
SurgSim::Framework::FileOutput
Class to output logging information to a give file.
Definition: LogOutput.h:53
SurgSim::Framework::StreamOutput
Class to output logging information to a stream that can be passed into the constructor of the class...
Definition: LogOutput.h:73
SurgSim::Framework::FileOutput::m_filename
std::string m_filename
Definition: LogOutput.h:66
SurgSim::Framework::StreamOutput::m_mutex
boost::mutex m_mutex
Definition: LogOutput.h:89
SurgSim::Framework::NullOutput::writeMessage
virtual bool writeMessage(const std::string &message)
Definition: LogOutput.h:48
SurgSim::Framework::LogOutput::writeMessage
virtual bool writeMessage(const std::string &message)=0