OpenStudio:utilities
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
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 More...
 
std::vector< LogMessagelogMessages () const
 get messages out of the file content More...
 
openstudio::path path () const
 returns the path that log messages are written to More...
 
- Public Member Functions inherited from openstudio::LogSink
bool autoFlush () const
 get if messages are automatically flushed More...
 
boost::optional< boost::regex > channelRegex () const
 get the regular expression to match log channels More...
 
void disable ()
 disable the sink More...
 
void enable ()
 enable the sink More...
 
bool isEnabled () const
 is the sink enabled More...
 
boost::optional< LogLevel > logLevel () const
 get the logging level More...
 
void resetChannelRegex ()
 reset the regular expression to match log channels More...
 
void resetLogLevel ()
 reset the core logging level More...
 
void resetThreadId ()
 reset the thread id that messages are filtered by More...
 
void setAutoFlush (bool autoFlush)
 set if messages are automatically flushed More...
 
void setChannelRegex (const boost::regex &channelRegex)
 set the regular expression to match log channels More...
 
void setChannelRegex (const std::string &channelRegex)
 set the regular expression to match log channels More...
 
void setFormatter (const boost::log::formatter &fmter)
 
void setLogLevel (LogLevel logLevel)
 set the logging level More...
 
void setThreadId (std::thread::id threadId)
 set the thread id that messages are filtered by More...
 
std::thread::id threadId () const
 get the thread id that messages are filtered by More...
 
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< LogSinkBackend > sink () const
 

Constructor & Destructor Documentation

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

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

get messages out of the file content

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

returns the path that log messages are written to