Interface Documentation
Version: invalid
Public Member Functions | Static Public Member Functions | List of all members
flecsi::log::flog_t Class Reference

#include <state.hh>

Public Member Functions

 flog_t (const flog_t &)=delete
 
flog_toperator= (const flog_t &)=delete
 
int initialize (std::string active="none", int verbose=0, std::size_t one_process=-1)
 
void finalize ()
 
int verbose () const
 
const std::unordered_map< std::string, size_t > & tag_map ()
 
std::stringstream & buffer_stream ()
 
std::ostream & stream ()
 
std::ostream & severity_stream (bool active=true)
 
std::ostream & null_stream ()
 
tee_stream_tconfig_stream ()
 
size_t register_tag (const char *tag)
 
const size_t & active_tag () const
 
size_t & active_tag ()
 
std::string tag_name (size_t id)
 
std::string active_tag_name ()
 
bool tag_enabled ()
 
size_t lookup_tag (const char *tag)
 
bool initialized ()
 
bool one_process () const
 
size_t output_process () const
 
std::size_t process ()
 
std::size_t processes ()
 
std::thread & flusher_thread ()
 
std::mutex & packets_mutex ()
 
void buffer_output ()
 
std::vector< packet_t > & packets ()
 
bool run_flusher ()
 
void end_flusher ()
 
void set_serialized ()
 
bool serialized ()
 

Static Public Member Functions

static flog_tinstance ()
 

Detailed Description

The flog_t type provides access to logging parameters and configuration.

This type provides access to the underlying logging parameters for configuration and information. The FleCSI logging functions provide basic logging with an interface that is similar to Google's GLOG and the Boost logging utilities.

Note
We may want to consider adopting one of these packages in the future.

Constructor & Destructor Documentation

◆ flog_t()

flecsi::log::flog_t::flog_t ( const flog_t )
delete

Copy constructor (disabled)

Member Function Documentation

◆ active_tag() [1/2]

const size_t& flecsi::log::flog_t::active_tag ( ) const
inline

Return a reference to the active tag (const version).

◆ active_tag() [2/2]

size_t& flecsi::log::flog_t::active_tag ( )
inline

Return a reference to the active tag (mutable version).

◆ active_tag_name()

std::string flecsi::log::flog_t::active_tag_name ( )
inline

Return the tag name associated with the active tag.

◆ buffer_stream()

std::stringstream& flecsi::log::flog_t::buffer_stream ( )
inline

Return the buffered log stream.

◆ config_stream()

tee_stream_t& flecsi::log::flog_t::config_stream ( )
inline

Return the tee stream to allow the user to set configuration options. FIXME: Need a better interface for this...

◆ instance()

static flog_t& flecsi::log::flog_t::instance ( )
inlinestatic

Meyer's singleton instance.

Returns
The singleton instance of this type.

◆ null_stream()

std::ostream& flecsi::log::flog_t::null_stream ( )
inline

Return a null stream to disable output.

◆ operator=()

flog_t& flecsi::log::flog_t::operator= ( const flog_t )
delete

Assignment operator (disabled)

◆ register_tag()

size_t flecsi::log::flog_t::register_tag ( const char *  tag)
inline

Return the next tag id.

◆ severity_stream()

std::ostream& flecsi::log::flog_t::severity_stream ( bool  active = true)
inline

Return the log stream predicated on a boolean. This method interface will allow us to select between the actual stream and a null stream.

◆ stream()

std::ostream& flecsi::log::flog_t::stream ( )
inline

Return the log stream.

◆ tag_map()

const std::unordered_map<std::string, size_t>& flecsi::log::flog_t::tag_map ( )
inline

Return the tag map.

◆ tag_name()

std::string flecsi::log::flog_t::tag_name ( size_t  id)
inline

Return the tag name associated with a tag id.


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