basic::Tracer Class Reference

Class for handling user debug/warnings/errors. Use instance of this class instead of 'std::cout' for all your regular io. Channel argument must be related to the location of the source file. For example if you create Tracer object in src/basic/scoring/myfile.cc, then channel must be something like 'basic.scoring.myfile'. More...

#include <Tracer.hh>

Inheritance diagram for basic::Tracer:

Classes
class	TracerProxy

Public Member Functions
	Tracer (std::string const &channel="", TracerPriority priority=t_info, bool muted_by_default=false)
	Create Tracer object with given channel and priority. More...
	Tracer (std::string const &channel, utility::CSI::CSI_Enum const &channel_color, utility::CSI::CSI_Enum const &channel_name_color=utility::CSI::Nothing, TracerPriority priority=t_info, bool muted_by_default=false)
	Create Tracer object with channel color, channel name color and given channel and priority. More...
virtual	~Tracer ()
	Tracer (Tracer const &)=delete
Tracer &	operator= (Tracer const &)=delete
template<typename T >
TracerImpl &	operator<< (T const &entry)
	output operator We return a TracerImpl instead of ourself to make subsequent access faster. More...
TracerImpl &	operator<< (std::ostream &(*entry)(std::ostream &))
	operator std::ostream & ()
	Allow Tracer object to be passed to something expecting a std::ostream. More...
void	flush ()
void	flush_all_channels ()
	flush tracer buffer and flush buffers of all sub-channels ie: Fatal, Error, Warning, Info, Debug, Trace More...
bool	visible ()
bool	visible (int priority)
std::string const &	channel ()
TracerImpl &	operator() (int priority)
void	set_local_print_channel_name (bool const setting)
	Set whether we're printing the channel name. More...
bool	get_local_print_channel_name ()
	Get whether we're printing the channel name. More...
std::streamsize	width ()
std::streamsize	width (std::streamsize wide)
std::streamsize	precision ()
std::streamsize	precision (std::streamsize prec)
std::ios_base::fmtflags	flags ()
std::ios_base::fmtflags	flags (std::ios_base::fmtflags fmtfl)

Static Public Member Functions
static void	set_ios_hook (otstreamOP tr, std::string const &monitoring_channels_list, bool raw=true)
	TODO: See if we can kill any usage of this, except for the esoteric. More...
static std::string const &	get_all_channels_string ()
static bool	super_mute ()
	global super mute flag that allow to mute all io no matter what. More...
static void	super_mute (bool f)

Public Attributes
TracerProxy	Fatal
	channels with predefined priority levels. More...
TracerProxy	Error
TracerProxy	Warning
TracerProxy	Info
TracerProxy	Debug
TracerProxy	Trace

Static Public Attributes
static utility::CSI::CSI_Enum	Reset
static utility::CSI::CSI_Enum	Bold
static utility::CSI::CSI_Enum	Underline
static utility::CSI::CSI_Enum	Black
static utility::CSI::CSI_Enum	Red
static utility::CSI::CSI_Enum	Green
static utility::CSI::CSI_Enum	Yellow
static utility::CSI::CSI_Enum	Blue
static utility::CSI::CSI_Enum	Magenta
static utility::CSI::CSI_Enum	Cyan
static utility::CSI::CSI_Enum	White
static utility::CSI::CSI_Enum	bgBlack
static utility::CSI::CSI_Enum	bgRed
static utility::CSI::CSI_Enum	bgGreen
static utility::CSI::CSI_Enum	bgYellow
static utility::CSI::CSI_Enum	bgBlue
static utility::CSI::CSI_Enum	bgMagenta
static utility::CSI::CSI_Enum	bgCyan
static utility::CSI::CSI_Enum	bgWhite

Protected Member Functions
TracerImpl &	tracer_impl ()
	The function which handles the construct-on-first use Not virtual for speed in the usual (non-creation) case. More...
virtual std::unique_ptr < TracerImpl >	create_impl ()

Private Attributes
std::string	channel_
utility::CSI::CSI_Enum	channel_color_
utility::CSI::CSI_Enum	channel_name_color_
TracerPriority	priority_
bool	muted_by_default_

Detailed Description

Class for handling user debug/warnings/errors. Use instance of this class instead of 'std::cout' for all your regular io. Channel argument must be related to the location of the source file. For example if you create Tracer object in src/basic/scoring/myfile.cc, then channel must be something like 'basic.scoring.myfile'.

Intended usage is as a global-scope static object. If you need a heap/stack allocated object, use the TracerImpl class directly.

The funky indirection to TracerImpl here is so that the heavy-weight TracerImpl object is only constructed on first use, and isn't static or thread_local

Constructor & Destructor Documentation

basic::Tracer::Tracer	(	std::string const &	channel = "",
		TracerPriority	priority = t_info,
		bool	muted_by_default = false
	)

Create Tracer object with given channel and priority.

basic::Tracer::Tracer	(	std::string const &	channel,
		utility::CSI::CSI_Enum const &	channel_color,
		utility::CSI::CSI_Enum const &	channel_name_color = utility::CSI::Nothing,
		TracerPriority	priority = t_info,
		bool	muted_by_default = false
	)

Create Tracer object with channel color, channel name color and given channel and priority.

Ex: static basic::Tracer Blue("blue", utility::CSI::Blue);

basic::Tracer::~Tracer ( )

virtualdefault

Ideally, we'd clean ourselves up from the tracer_impl_map, but that's complicated by it being a) thread-dependent, and b) subject to static initialization order fiasco (static destruction order fiasco) issues. Regardless, the associated TracerImpl will be flushed when the static tracer_impl_map gets destroyed. The one tricky bit is that the TracerImpl for non-static tracers stick around, and may accidentally be re-used if we re-use the same pointer ... so avoid non-static Tracer objects: use a TracerImpl directly instead.

basic::Tracer::Tracer ( Tracer const &  )

delete

Member Function Documentation

std::string const& basic::Tracer::channel ( )

inline

References basic::TracerImpl::channel(), and tracer_impl().

Referenced by basic::show_time().

std::unique_ptr< TracerImpl > basic::Tracer::create_impl ( )

protectedvirtual

Reimplemented in basic::MemTracer.

References channel_, channel_color_, channel_name_color_, muted_by_default_, and priority_.

Referenced by tracer_impl().

std::ios_base::fmtflags basic::Tracer::flags ( )

inline

References tracer_impl().

std::ios_base::fmtflags basic::Tracer::flags ( std::ios_base::fmtflags  fmtfl )

inline

References tracer_impl().

void basic::Tracer::flush ( )

inline

References tracer_impl().

Referenced by main(), basic::options::process(), and basic::mpi::request_data_from_head_node().

void basic::Tracer::flush_all_channels ( )

inline

flush tracer buffer and flush buffers of all sub-channels ie: Fatal, Error, Warning, Info, Debug, Trace

References basic::TracerImpl::flush_all_channels(), and tracer_impl().

Referenced by main().

static std::string const& basic::Tracer::get_all_channels_string ( )

inlinestatic

References basic::TracerImpl::get_all_channels_string().

bool basic::Tracer::get_local_print_channel_name ( )

inline

Get whether we're printing the channel name.

This looks at the local setting, but does not check the global setting.

Note

In practice, if the local setting is true then the global setting is used. If the local setting is false, it overrides the global setting.

Author

Vikram K. Mulligan (vmull.nosp@m.igan.nosp@m.@flat.nosp@m.iron.nosp@m.insti.nosp@m.tute.nosp@m..org)

References basic::TracerImpl::get_local_print_channel_name(), and tracer_impl().

basic::Tracer::operator std::ostream & ( )

inline

Allow Tracer object to be passed to something expecting a std::ostream.

References tracer_impl().

TracerImpl& basic::Tracer::operator() ( int  priority )

inline

References tracer_impl().

template<typename T >

TracerImpl& basic::Tracer::operator<< ( T const &  entry )

inline

output operator We return a TracerImpl instead of ourself to make subsequent access faster.

References tracer_impl().

TracerImpl& basic::Tracer::operator<< ( std::ostream &(*)(std::ostream &)  entry )

inline

References tracer_impl().

Tracer& basic::Tracer::operator= ( Tracer const &  )

delete

std::streamsize basic::Tracer::precision ( )

inline

References tracer_impl().

std::streamsize basic::Tracer::precision ( std::streamsize  prec )

inline

References tracer_impl().

static void basic::Tracer::set_ios_hook ( otstreamOP  tr, std::string const &  monitoring_channels_list, bool  raw = true  )

inlinestatic

TODO: See if we can kill any usage of this, except for the esoteric.

References basic::options::OptionKeys::out::file::raw, and basic::TracerImpl::set_ios_hook().

void basic::Tracer::set_local_print_channel_name ( bool const  setting )

inline

Set whether we're printing the channel name.

This overrides the local setting, but does not alter the global setting.

Note

In practice, if the local setting is true then the global setting is used. If the local setting is false, it overrides the global setting.

Author

Vikram K. Mulligan (vmull.nosp@m.igan.nosp@m.@flat.nosp@m.iron.nosp@m.insti.nosp@m.tute.nosp@m..org)

References basic::TracerImpl::set_local_print_channel_name(), and tracer_impl().

static bool basic::Tracer::super_mute ( )

inlinestatic

global super mute flag that allow to mute all io no matter what.

References basic::TracerImpl::super_mute().

static void basic::Tracer::super_mute ( bool  f )

inlinestatic

References basic::TracerImpl::super_mute().

TracerImpl & basic::Tracer::tracer_impl ( )

protected

The function which handles the construct-on-first use Not virtual for speed in the usual (non-creation) case.

References create_impl(), and THREAD_LOCAL.

Referenced by channel(), flags(), flush(), flush_all_channels(), get_local_print_channel_name(), operator std::ostream &(), operator()(), operator<<(), precision(), set_local_print_channel_name(), basic::Tracer::TracerProxy::tracer_proxy_impl(), visible(), and width().

bool basic::Tracer::visible ( )

inline

References tracer_impl(), and basic::TracerImpl::visible().

Referenced by main().

bool basic::Tracer::visible ( int  priority )

inline

References tracer_impl(), and basic::TracerImpl::visible().

std::streamsize basic::Tracer::width ( )

inline

References tracer_impl().

std::streamsize basic::Tracer::width ( std::streamsize  wide )

inline

References tracer_impl().

Member Data Documentation

utility::CSI::CSI_Enum basic::Tracer::bgBlack

static

utility::CSI::CSI_Enum basic::Tracer::bgBlue

static

Referenced by basic::citation_manager::CitationManager::write_all_citations_and_unpublished_author_info().

utility::CSI::CSI_Enum basic::Tracer::bgCyan

static

utility::CSI::CSI_Enum basic::Tracer::bgGreen

static

utility::CSI::CSI_Enum basic::Tracer::bgMagenta

static

utility::CSI::CSI_Enum basic::Tracer::bgRed

static

utility::CSI::CSI_Enum basic::Tracer::bgWhite

static

utility::CSI::CSI_Enum basic::Tracer::bgYellow

static

utility::CSI::CSI_Enum basic::Tracer::Black

static

utility::CSI::CSI_Enum basic::Tracer::Blue

static

Referenced by BuildFullModel::fill_and_sample_full_model(), mg_modeler_test(), output_seq_with_residue_emphasis(), and swa_rna_sample().

utility::CSI::CSI_Enum basic::Tracer::Bold

static

Referenced by basic::citation_manager::CitationManager::write_all_citations_and_unpublished_author_info().

std::string basic::Tracer::channel_

private

Referenced by create_impl().

utility::CSI::CSI_Enum basic::Tracer::channel_color_

private

Referenced by create_impl().

utility::CSI::CSI_Enum basic::Tracer::channel_name_color_

private

Referenced by create_impl().

utility::CSI::CSI_Enum basic::Tracer::Cyan

static

Referenced by build_full_model_test(), and BuildFullModel::fill_and_sample_full_model().

TracerProxy basic::Tracer::Debug

Referenced by BacksideHbondFinderMover::apply(), build_full_model_test(), calc_scores(), basic::database::schema_generator::Schema::check_table_and_perform_write(), DockFragmentsMover::cluster_frags(), determine_residues_to_rebuild(), drrafter_error_estimation(), basic::database::find_cache_file(), generate_dunbrack_binaries(), basic::mpi::MessageListenerFactory::get_listener(), get_median_structure(), get_simple_RNA_protein_fold_tree(), basic::citation_manager::CitationManager::load_rosetta_citations_from_database(), main(), make_mutations(), mutate_and_score_RNP(), BacksideHbondFinderMover::mutate_residue(), basic::citation_manager::CitationManager::populate_doi_rosetta_citation_map(), read_in_mutations(), read_pose(), read_structures(), read_thickness(), basic::mpi::request_data_from_head_node(), resample_full_model(), ScoreFragmentSetMover::run(), ConsensusFragmentMover::run(), SolutionRescoreMover::run(), SphereGrinder(), and basic::database::schema_generator::Schema::write().

TracerProxy basic::Tracer::Error

Referenced by IAMover::apply(), collect_residue_types(), correlation(), get_out_tag(), harvest_motifs(), UBQ_GTPase_disulfide_Mover::init_on_new_input(), UBQ_E2Mover::init_on_new_input(), load_loops_from_file(), main(), basic::datacache::WriteableCacheableDataFactory::new_data_instance(), output_packstat_pdb(), read_in_flexible_regions(), read_in_mutations(), ScoreEachBenchmark::run(), ScoreEachBenchmark::run_long_ranged_two_body_energy(), ScoreEachBenchmark::run_one_body_energy(), ScoreEachBenchmark::run_short_ranged_two_body_energy(), basic::database::safely_prepare_statement(), ScoreEachBenchmark::setUp(), basic::show_time(), statistics(), validate_dunbrack_binaries(), basic::database::schema_generator::Schema::write(), and basic::database::write_schema_to_database().

TracerProxy basic::Tracer::Fatal

channels with predefined priority levels.

Referenced by DummyMover::apply(), check_option_conflicts(), basic::random::determine_random_number_seed(), and basic::options::start_files().

utility::CSI::CSI_Enum basic::Tracer::Green

static

Referenced by BuildFullModel::fill_and_sample_full_model().

TracerProxy basic::Tracer::Info

Referenced by main(), and run().

utility::CSI::CSI_Enum basic::Tracer::Magenta

static

Referenced by build_full_model_test(), BuildFullModel::fill_and_sample_full_model(), BuildFullModel::make_built_residues_repulsive(), and BuildFullModel::make_built_residues_virtual().

bool basic::Tracer::muted_by_default_

private

Referenced by create_impl().

TracerPriority basic::Tracer::priority_

private

Referenced by create_impl().

utility::CSI::CSI_Enum basic::Tracer::Red

static

Referenced by build_full_model_test(), BuildFullModel::fill_and_sample_full_model(), and MC_run().

utility::CSI::CSI_Enum basic::Tracer::Reset

static

These are just convenience references to the enum entries

Referenced by build_full_model_test(), BuildFullModel::fill_and_sample_full_model(), BuildFullModel::make_built_residues_repulsive(), BuildFullModel::make_built_residues_virtual(), mg_modeler_test(), my_main(), output_seq_with_residue_emphasis(), swa_rna_sample(), and basic::citation_manager::CitationManager::write_all_citations_and_unpublished_author_info().

TracerProxy basic::Tracer::Trace

Referenced by analyze_poses_for_convergence(), bump_check(), basic::database::schema_generator::Schema::check_table_and_perform_write(), densityTools(), BuildFullModel::make_built_residues_repulsive(), and output_seq_with_residue_emphasis().

utility::CSI::CSI_Enum basic::Tracer::Underline

static

Referenced by basic::citation_manager::CitationManager::write_all_citations_and_unpublished_author_info().

TracerProxy basic::Tracer::Warning

Referenced by build_full_model_test(), check_number_of_poses(), check_score_function(), count_analytically(), basic::thread_manager::RosettaThreadManager::do_multistage_work_vector_in_threads(), do_options_checks(), basic::thread_manager::RosettaThreadManager::do_work_vector_in_threads(), filter_combine_long_loop(), basic::database::full_name(), basic::database::get_db_session(), main(), output_residue_types(), basic::database::parse_database_connection(), basic::database::set_cache_size(), ScoreEachBenchmark::setUp(), InteractionGraphPerformanceBenchmark::setup_for_sc12he(), InteractionGraphPerformanceBenchmark::setup_for_sc12sp2(), InteractionGraphPerformanceBenchmark::setup_for_score12(), InteractionGraphPerformanceBenchmark::setup_for_sp2hecart(), and swa_rna_cluster().

utility::CSI::CSI_Enum basic::Tracer::White

static

Referenced by basic::citation_manager::CitationManager::write_all_citations_and_unpublished_author_info().

utility::CSI::CSI_Enum basic::Tracer::Yellow

static

Referenced by BuildFullModel::fill_and_sample_full_model(), BuildFullModel::make_built_residues_repulsive(), and BuildFullModel::make_built_residues_virtual().

---

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

• src/basic/Tracer.hh
• src/basic/Tracer.cc