SurgSim::Framework::StreamOutput Class Reference

Class to output logging information to a stream that can be passed into the constructor of the class. More...

`#include <SurgSim/Framework/LogOutput.h>`

Inheritance diagram for SurgSim::Framework::StreamOutput:

## Public Member Functions

| StreamOutput (std::ostream &ostream)
| Constructor. More...
bool | writeMessage (const std::string &message) override
| Writes a message to the stream. More...
Public Member Functions inherited from SurgSim::Framework::LogOutput
| LogOutput ()
virtual | ~LogOutput ()

## Private Attributes

std::ostream & | m_stream
boost::mutex | m_mutex

## Detailed Description

Class to output logging information to a stream that can be passed into the constructor of the class.

## Constructor & Destructor Documentation

## StreamOutput()

SurgSim::Framework::StreamOutput::StreamOutput | ( | std::ostream & | ostream | ) |

explicit

Constructor.

Parameters

  ostream | stream to be used for writing ostream parameter to be passed by non-const reference on purpose.

## Member Function Documentation

## writeMessage()

bool SurgSim::Framework::StreamOutput::writeMessage | ( | const std::string & | message | ) |

override virtual

Writes a message to the stream.

Parameters

  message | Message to be written to the stream

Returns
  True on success

Implements SurgSim::Framework::LogOutput.

## Member Data Documentation

## m_mutex

boost::mutex SurgSim::Framework::StreamOutput::m_mutex

private

## m_stream

std::ostream& SurgSim::Framework::StreamOutput::m_stream

private

The documentation for this class was generated from the following files:

- SurgSim/Framework/LogOutput.h
- SurgSim/Framework/LogOutput.cpp