Panda3D
Public Member Functions | Static Public Member Functions | Friends | List of all members
NotifyCategory Class Reference

A particular category of error messages. More...

#include "notifyCategory.h"

Inheritance diagram for NotifyCategory:
MemoryBase ConfigFlags

Public Member Functions

ostream & debug (bool prefix=true) const
 A shorthand way to write out(NS_debug). More...
 
ostream & error (bool prefix=true) const
 A shorthand way to write out(NS_error). More...
 
ostream & fatal (bool prefix=true) const
 A shorthand way to write out(NS_fatal). More...
 
string get_basename () const
 
NotifyCategoryget_child (int i) const
 Returns the nth child Category of this particular Category. More...
 
string get_fullname () const
 
int get_num_children () const
 Returns the number of child Categories of this particular Category. More...
 
NotifySeverity get_severity () const
 
ostream & info (bool prefix=true) const
 A shorthand way to write out(NS_info). More...
 
bool is_error () const
 A shorthand way to write is_on(NS_error). More...
 
bool is_fatal () const
 A shorthand way to write is_on(NS_fatal). More...
 
bool is_info () const
 A shorthand way to write is_on(NS_info). More...
 
bool is_on (NotifySeverity severity) const
 Returns true if messages of the indicated severity level ought to be reported for this Category. More...
 
bool is_warning () const
 A shorthand way to write is_on(NS_warning). More...
 
ostream & out (NotifySeverity severity, bool prefix=true) const
 Begins a new message to this Category at the indicated severity level. More...
 
void set_severity (NotifySeverity severity)
 Sets the severity level of messages that will be reported from this Category. More...
 
ostream & spam (bool prefix=true) const
 A shorthand way to write out(NS_spam). More...
 
ostream & warning (bool prefix=true) const
 A shorthand way to write out(NS_warning). More...
 

Static Public Member Functions

static CONSTEXPR bool is_debug ()
 When NOTIFY_DEBUG is not defined, the categories are never set to "spam" or "debug" severities, and these methods are redefined to be static to make it more obvious to the compiler. More...
 
static CONSTEXPR bool is_spam ()
 When NOTIFY_DEBUG is not defined, the categories are never set to "spam" or "debug" severities, and these methods are redefined to be static to make it more obvious to the compiler. More...
 
static void set_server_delta (long delta)
 Sets a global delta (in seconds) between the local time and the server's time, for the purpose of synchronizing the time stamps in the log messages of the client with that of a known server. More...
 

Friends

class Notify
 

Additional Inherited Members

- Public Types inherited from ConfigFlags
enum  ValueType {
  VT_undefined, VT_list, VT_string, VT_filename,
  VT_bool, VT_int, VT_double, VT_enum,
  VT_search_path, VT_int64, VT_color
}
 
enum  VariableFlags {
  F_trust_level_mask = 0x00000fff, F_open = 0x00001000, F_closed = 0x00002000, F_dynamic = 0x00004000,
  F_dconfig = 0x00008000
}
 

Detailed Description

A particular category of error messages.

Typically there will be one of these per package, so that we can turn on or off error messages at least at a package level; further nested categories can be created within a package if a finer grain of control is required.

Definition at line 36 of file notifyCategory.h.

Member Function Documentation

◆ debug()

ostream & NotifyCategory::debug ( bool  prefix = true) const
inline

A shorthand way to write out(NS_debug).

Definition at line 188 of file notifyCategory.I.

References info(), Notify::null(), and out().

Referenced by NotifyCategoryProxy< GetCategory >::get_safe_ptr(), and spam().

◆ error()

ostream & NotifyCategory::error ( bool  prefix = true) const
inline

A shorthand way to write out(NS_error).

Definition at line 222 of file notifyCategory.I.

References fatal(), and out().

Referenced by Shader::cp_report_error(), NotifyCategoryProxy< GetCategory >::get_safe_ptr(), and warning().

◆ fatal()

ostream & NotifyCategory::fatal ( bool  prefix = true) const
inline

A shorthand way to write out(NS_fatal).

Definition at line 232 of file notifyCategory.I.

References out().

Referenced by error(), and NotifyCategoryProxy< GetCategory >::get_safe_ptr().

◆ get_child()

NotifyCategory * NotifyCategory::get_child ( int  i) const

Returns the nth child Category of this particular Category.

Definition at line 140 of file notifyCategory.cxx.

References set_server_delta().

Referenced by get_num_children().

◆ get_num_children()

int NotifyCategory::get_num_children ( ) const

Returns the number of child Categories of this particular Category.

Definition at line 129 of file notifyCategory.cxx.

References get_child().

Referenced by out().

◆ info()

ostream & NotifyCategory::info ( bool  prefix = true) const
inline

A shorthand way to write out(NS_info).

Definition at line 202 of file notifyCategory.I.

References out(), and warning().

Referenced by debug(), and NotifyCategoryProxy< GetCategory >::get_safe_ptr().

◆ is_debug()

CONSTEXPR bool NotifyCategory::is_debug ( )
static

When NOTIFY_DEBUG is not defined, the categories are never set to "spam" or "debug" severities, and these methods are redefined to be static to make it more obvious to the compiler.

Definition at line 123 of file notifyCategory.I.

References is_info().

Referenced by NotifyCategoryProxy< GetCategory >::get_safe_ptr(), is_on(), and is_spam().

◆ is_error()

bool NotifyCategory::is_error ( ) const
inline

A shorthand way to write is_on(NS_error).

Definition at line 154 of file notifyCategory.I.

References is_fatal(), and is_on().

Referenced by NotifyCategoryProxy< GetCategory >::get_safe_ptr(), and is_warning().

◆ is_fatal()

bool NotifyCategory::is_fatal ( ) const
inline

A shorthand way to write is_on(NS_fatal).

Definition at line 164 of file notifyCategory.I.

References is_on(), and spam().

Referenced by NotifyCategoryProxy< GetCategory >::get_safe_ptr(), and is_error().

◆ is_info()

bool NotifyCategory::is_info ( ) const
inline

A shorthand way to write is_on(NS_info).

Definition at line 134 of file notifyCategory.I.

References is_on(), and is_warning().

Referenced by NotifyCategoryProxy< GetCategory >::get_safe_ptr(), and is_debug().

◆ is_on()

bool NotifyCategory::is_on ( NotifySeverity  severity) const
inline

Returns true if messages of the indicated severity level ought to be reported for this Category.

Definition at line 75 of file notifyCategory.I.

References is_debug(), and is_spam().

Referenced by NotifyCategoryProxy< GetCategory >::get_safe_ptr(), is_error(), is_fatal(), is_info(), is_warning(), and set_severity().

◆ is_spam()

CONSTEXPR bool NotifyCategory::is_spam ( )
static

When NOTIFY_DEBUG is not defined, the categories are never set to "spam" or "debug" severities, and these methods are redefined to be static to make it more obvious to the compiler.

Definition at line 110 of file notifyCategory.I.

References is_debug().

Referenced by NotifyCategoryProxy< GetCategory >::get_safe_ptr(), and is_on().

◆ is_warning()

bool NotifyCategory::is_warning ( ) const
inline

A shorthand way to write is_on(NS_warning).

Definition at line 144 of file notifyCategory.I.

References is_error(), and is_on().

Referenced by NotifyCategoryProxy< GetCategory >::get_safe_ptr(), and is_info().

◆ out()

ostream & NotifyCategory::out ( NotifySeverity  severity,
bool  prefix = true 
) const

Begins a new message to this Category at the indicated severity level.

If the indicated severity level is enabled, this writes a prefixing string to the Notify::out() stream and returns that. If the severity level is disabled, this returns Notify::null().

Definition at line 66 of file notifyCategory.cxx.

References get_num_children(), and Notify::null().

Referenced by debug(), error(), fatal(), NotifyCategoryProxy< GetCategory >::get_safe_ptr(), info(), spam(), and warning().

◆ set_server_delta()

void NotifyCategory::set_server_delta ( long  delta)
static

Sets a global delta (in seconds) between the local time and the server's time, for the purpose of synchronizing the time stamps in the log messages of the client with that of a known server.

Definition at line 154 of file notifyCategory.cxx.

Referenced by get_child().

◆ set_severity()

void NotifyCategory::set_severity ( NotifySeverity  severity)
inline

Sets the severity level of messages that will be reported from this Category.

This allows any message of this severity level or higher.

Definition at line 58 of file notifyCategory.I.

References is_on().

Referenced by EggPalettize::handle_args().

◆ spam()

ostream & NotifyCategory::spam ( bool  prefix = true) const
inline

A shorthand way to write out(NS_spam).

Definition at line 174 of file notifyCategory.I.

References debug(), Notify::null(), and out().

Referenced by NotifyCategoryProxy< GetCategory >::get_safe_ptr(), and is_fatal().

◆ warning()

ostream & NotifyCategory::warning ( bool  prefix = true) const
inline

A shorthand way to write out(NS_warning).

Definition at line 212 of file notifyCategory.I.

References error(), and out().

Referenced by NotifyCategoryProxy< GetCategory >::get_safe_ptr(), and info().


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