OpenStudio:utilities
Loading...
Searching...
No Matches
openstudio::FileLogSink Class Reference

#include <FileLogSink.hpp>

+ Inheritance diagram for openstudio::FileLogSink:

Public Member Functions

 FileLogSink (const openstudio::path &path)
 constructor takes path of file, opens in write mode positioned at file beginning and registers in the global logger
 
std::vector< LogMessagelogMessages () const
 get messages out of the file content
 
openstudio::path path () const
 returns the path that log messages are written to
 
- Public Member Functions inherited from openstudio::LogSink
bool autoFlush () const
 get if messages are automatically flushed
 
boost::optional< boost::regex > channelRegex () const
 get the regular expression to match log channels
 
void disable ()
 disable the sink
 
void enable ()
 enable the sink
 
bool isEnabled () const
 is the sink enabled
 
boost::optional< LogLevel > logLevel () const
 get the logging level
 
void resetChannelRegex ()
 reset the regular expression to match log channels
 
void resetLogLevel ()
 reset the core logging level
 
void resetThreadId ()
 reset the thread id that messages are filtered by
 
void setAutoFlush (bool autoFlush)
 set if messages are automatically flushed
 
void setChannelRegex (const boost::regex &channelRegex)
 set the regular expression to match log channels
 
void setChannelRegex (const std::string &channelRegex)
 set the regular expression to match log channels
 
void setFormatter (const boost::log::formatter &fmter)
 
void setLogLevel (LogLevel logLevel)
 set the logging level
 
void setThreadId (std::thread::id threadId)
 set the thread id that messages are filtered by
 
std::thread::id threadId () const
 get the thread id that messages are filtered by
 
void useWorkflowGemFormatter (bool use, bool include_channel=true)
 

Additional Inherited Members

- Protected Member Functions inherited from openstudio::LogSink
 LogSink ()
 
 LogSink (const boost::shared_ptr< detail::LogSink_Impl > &impl)
 
void setStream (boost::shared_ptr< std::ostream > os)
 
boost::shared_ptr< LogSinkBackendsink () const
 

Constructor & Destructor Documentation

◆ FileLogSink()

openstudio::FileLogSink::FileLogSink ( const openstudio::path & path)

constructor takes path of file, opens in write mode positioned at file beginning and registers in the global logger

Member Function Documentation

◆ logMessages()

std::vector< LogMessage > openstudio::FileLogSink::logMessages ( ) const

get messages out of the file content

◆ path()

openstudio::path openstudio::FileLogSink::path ( ) const

returns the path that log messages are written to