Package rosetta :: Package basic :: Module _basic_ :: Class Tracer
[hide private]
[frames] | no frames]

Class Tracer

                                   object --+        
                                            |        
                                  ??.instance --+    
                                                |    
basic_otstream_T_char_std_char_traits_T_char_T__T --+
                                                    |
                                                   Tracer
Known Subclasses:

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 'src.basic.scoring.myfile'

Instance Methods [hide private]
 
__call__(...)
__call__( (Tracer)arg1, (int)priority) -> Tracer : basic/Tracer.hh:186
 
__init__(...)
__init__( (object)arg1 [, (str)channel='' [, (TracerPriority)priority=rosetta.basic._basic_.TracerPriority.t_info [, (bool)muted_by_default=False]]]) -> None : Create Tracer object with given channel and priority
 
channel(...)
channel( (Tracer)arg1) -> str : basic/Tracer.hh:189
 
flush_all_channels(...)
flush_all_channels( (Tracer)arg1) -> None : flush tracer buffer and flush buffers of all sub-channels ie: Fatal, Error, Warning, Info, Debug, Trace
 
init(...)
init( (Tracer)arg1, (Tracer)tr) -> None : re-init using data from another tracer object.
 
priority(...)
priority( (Tracer)arg1) -> int : get/set tracer priority level.
 
visible(...)
visible( (Tracer)arg1) -> bool : Is this tracer currently visible?.

Inherited from basic_otstream_T_char_std_char_traits_T_char_T__T: __reduce__, is_flushed

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Static Methods [hide private]
None :
calculate_tracer_visibilities()
This function should be invoked after the options system has been initialized, so that the visibility for all tracers that have so far been constructed and have been waiting for the options system to be initialized can now have their visibility calculated.
OStream :
final_stream()
set ios hook for final tracer stream (deafult is std::cout).
None :
flush_all_tracers()
basic/Tracer.hh:198
str :
get_all_channels_string()
basic/Tracer.hh:176
None :
set_default_final_stream()
basic/Tracer.hh:168
 
set_ios_hook(...)
set_ios_hook( (basic_otstream_T_char_std_char_traits_T_char_T__T)tr, (str)monitoring_channels_list [, (bool)raw=True]) -> None : basic/Tracer.hh:174
 
set_new_final_stream(...)
set_new_final_stream( (OStream)new_final_stream) -> None : basic/Tracer.hh:167
bool :
super_mute()
global super mute flag that allow to mute all io no matter what.
TracerOptions :
tracer_options()
get/set tracer options - global options for Tracer IO.
Class Variables [hide private]

Inherited from basic_otstream_T_char_std_char_traits_T_char_T__T: __instance_size__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__call__(...)
(Call operator)

 

__call__( (Tracer)arg1, (int)priority) -> Tracer :
    basic/Tracer.hh:186

    C++ signature :
        basic::Tracer {lvalue} __call__(basic::Tracer {lvalue},int)

__init__(...)
(Constructor)

 

__init__( (object)arg1 [, (str)channel='' [, (TracerPriority)priority=rosetta.basic._basic_.TracerPriority.t_info [, (bool)muted_by_default=False]]]) -> None :
    Create Tracer object with given channel and priority
    

    C++ signature :
        void __init__(_object* [,std::string='' [,basic::TracerPriority=rosetta.basic._basic_.TracerPriority.t_info [,bool=False]]])

Overrides: object.__init__

calculate_tracer_visibilities()
Static Method

 
    This function should be invoked after the options system has been
    initialized, so that the visibility for all tracers that have so far been
    constructed and have been waiting for the options system to be initialized
    can now have their visibility calculated.  After this function completes,
    all newly-constructed Tracers will calculate their visibility in their
    constructors.  Visibility is no longer be calculated on a just-in-time
    basis and stored in mutable data members.
    

    C++ signature :
        void calculate_tracer_visibilities()

Returns: None :

channel(...)

 

channel( (Tracer)arg1) -> str :
    basic/Tracer.hh:189

    C++ signature :
        std::string channel(basic::Tracer {lvalue})

final_stream()
Static Method

 
    set ios hook for final tracer stream (deafult is std::cout).
    

    C++ signature :
        std::ostream* {lvalue} final_stream()

Returns: OStream :

flush_all_channels(...)

 

flush_all_channels( (Tracer)arg1) -> None :
    flush tracer buffer and flush buffers of all
           sub-channels ie: Fatal, Error, Warning, Info, Debug, Trace
    

    C++ signature :
        void flush_all_channels(basic::Tracer {lvalue})

flush_all_tracers()
Static Method

 
    basic/Tracer.hh:198

    C++ signature :
        void flush_all_tracers()

Returns: None :

get_all_channels_string()
Static Method

 
    basic/Tracer.hh:176

    C++ signature :
        std::string get_all_channels_string()

Returns: str :

init(...)

 

init( (Tracer)arg1, (Tracer)tr) -> None :
    re-init using data from another tracer object.
    

    C++ signature :
        void init(basic::Tracer {lvalue},basic::Tracer)

priority(...)

 

priority( (Tracer)arg1) -> int :
    get/set tracer priority level.
    

    C++ signature :
        int priority(basic::Tracer {lvalue})

priority( (Tracer)arg1, (int)priority) -> None :
    basic/Tracer.hh:187

    C++ signature :
        void priority(basic::Tracer {lvalue},int)

set_default_final_stream()
Static Method

 
    basic/Tracer.hh:168

    C++ signature :
        void set_default_final_stream()

Returns: None :

set_ios_hook(...)
Static Method

 

set_ios_hook( (basic_otstream_T_char_std_char_traits_T_char_T__T)tr, (str)monitoring_channels_list [, (bool)raw=True]) -> None :
    basic/Tracer.hh:174

    C++ signature :
        void set_ios_hook(boost::shared_ptr<basic::basic_otstream<char, std::char_traits<char> > >,std::string [,bool=True])

set_new_final_stream(...)
Static Method

 

set_new_final_stream( (OStream)new_final_stream) -> None :
    basic/Tracer.hh:167

    C++ signature :
        void set_new_final_stream(std::ostream*)

super_mute()
Static Method

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

    C++ signature :
        bool super_mute()

super_mute( (bool)f) -> None :
    basic/Tracer.hh:196

    C++ signature :
        void super_mute(bool)

Returns: bool :

tracer_options()
Static Method

 
    get/set tracer options - global options for Tracer IO.
    

    C++ signature :
        basic::TracerOptions {lvalue} tracer_options()

Returns: TracerOptions :

visible(...)

 

visible( (Tracer)arg1) -> bool :
    Is this tracer currently visible?.
    

    C++ signature :
        bool visible(basic::Tracer {lvalue})

visible( (Tracer)arg1, (int)priority) -> bool :
    is this tracer visible, if it used the given priority value?
    

    C++ signature :
        bool visible(basic::Tracer {lvalue},int)