defineDebugSwitch.H File Reference

Macro definitions for debug switches. More...

Include dependency graph for defineDebugSwitch.H:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  RegisterDebugSwitch< Type >
 Define the debug information, lookup as Name. More...
 

Namespaces

 Foam
 Namespace for OpenFOAM.
 

Macros

#define registerTemplateDebugSwitchWithName(Type, Name)
 
#define registerDebugSwitchWithName(Type, Tag, Name)
 Define the debug information, lookup as Name. More...
 
#define defineDebugSwitchWithName(Type, Name, DebugSwitch)   int Type::debug(::Foam::debug::debugSwitch(Name, DebugSwitch))
 Define the debug information, lookup as Name. More...
 
#define defineDebugSwitch(Type, DebugSwitch)
 Define the debug information. More...
 
#define defineTemplateDebugSwitchWithName(Type, Name, DebugSwitch)
 Define the debug information for templates, lookup as Name. More...
 
#define defineTemplate2DebugSwitchWithName(Type, Name, DebugSwitch)
 Define the debug information for templates sub-classes, lookup as Name. More...
 
#define defineTemplateDebugSwitch(Type, DebugSwitch)   defineTemplateDebugSwitchWithName(Type, #Type, DebugSwitch)
 Define the debug information for templates. More...
 
#define defineNamedTemplateDebugSwitch(Type, DebugSwitch)   defineTemplateDebugSwitchWithName(Type, Type::typeName_(), DebugSwitch)
 Define the debug information directly for templates. More...
 
#define defineTemplate2DebugSwitch(Type, DebugSwitch)   defineTemplate2DebugSwitchWithName(Type, #Type, DebugSwitch)
 Define the debug information for templates. More...
 
#define defineNamedTemplate2DebugSwitch(Type, DebugSwitch)   defineTemplate2DebugSwitchWithName(Type, Type::typeName_(), DebugSwitch)
 Define the debug information directly for templates. More...
 

Detailed Description

Macro definitions for debug switches.

Original source file defineDebugSwitch.H

Definition in file defineDebugSwitch.H.

Macro Definition Documentation

◆ registerTemplateDebugSwitchWithName

#define registerTemplateDebugSwitchWithName (   Type,
  Name 
)
Value:
template<> \
static const RegisterDebugSwitch registerDebugSwitch
The unique RegisterDebugSwitch object.

Definition at line 75 of file defineDebugSwitch.H.

◆ registerDebugSwitchWithName

#define registerDebugSwitchWithName (   Type,
  Tag,
  Name 
)
Value:
class add##Tag##ToDebug \
: \
{ \
public: \
add##Tag##ToDebug(const char* name) \
: \
::Foam::simpleRegIOobject(Foam::debug::addDebugObject, name) \
{} \
virtual ~add##Tag##ToDebug() \
{} \
virtual void readData(Foam::Istream& is) \
{ \
Type::debug = readLabel(is); \
} \
virtual void writeData(Foam::Ostream& os) const \
{ \
os << Type::debug; \
} \
}; \
add##Tag##ToDebug add##Tag##ToDebug_(Name)
Abstract base class for registered object with I/O. Used in debug symbol registration.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
virtual void writeData(Ostream &) const =0
Write.
label readLabel(Istream &is)
Definition: label.H:64
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
void add(FieldField< Field1, typename typeOfSum< Type1, Type2 >::type > &f, const FieldField< Field1, Type1 > &f1, const FieldField< Field2, Type2 > &f2)
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
virtual void readData(Istream &)=0
Read.
void addDebugObject(const char *name, simpleRegIOobject *obj)
Register debug switch read/write object.
Definition: debug.C:218

Define the debug information, lookup as Name.

Definition at line 82 of file defineDebugSwitch.H.

◆ defineDebugSwitchWithName

#define defineDebugSwitchWithName (   Type,
  Name,
  DebugSwitch 
)    int Type::debug(::Foam::debug::debugSwitch(Name, DebugSwitch))

Define the debug information, lookup as Name.

Definition at line 107 of file defineDebugSwitch.H.

◆ defineDebugSwitch

#define defineDebugSwitch (   Type,
  DebugSwitch 
)
Value:
defineDebugSwitchWithName(Type, Type::typeName_(), DebugSwitch); \
registerDebugSwitchWithName(Type, Type, Type::typeName_())
#define defineDebugSwitchWithName(Type, Name, DebugSwitch)
Define the debug information, lookup as Name.

Define the debug information.

Definition at line 111 of file defineDebugSwitch.H.

◆ defineTemplateDebugSwitchWithName

#define defineTemplateDebugSwitchWithName (   Type,
  Name,
  DebugSwitch 
)
Value:
defineDebugSwitchWithName(Type, Name, DebugSwitch); \
registerTemplateDebugSwitchWithName(Type, Name)
#define defineDebugSwitchWithName(Type, Name, DebugSwitch)
Define the debug information, lookup as Name.

Define the debug information for templates, lookup as Name.

Definition at line 116 of file defineDebugSwitch.H.

◆ defineTemplate2DebugSwitchWithName

#define defineTemplate2DebugSwitchWithName (   Type,
  Name,
  DebugSwitch 
)
Value:
defineDebugSwitchWithName(Type, Name, DebugSwitch); \
registerTemplateDebugSwitchWithName(Type, Name)
#define defineDebugSwitchWithName(Type, Name, DebugSwitch)
Define the debug information, lookup as Name.

Define the debug information for templates sub-classes, lookup as Name.

Definition at line 122 of file defineDebugSwitch.H.

◆ defineTemplateDebugSwitch

#define defineTemplateDebugSwitch (   Type,
  DebugSwitch 
)    defineTemplateDebugSwitchWithName(Type, #Type, DebugSwitch)

Define the debug information for templates.

Useful with typedefs

Definition at line 129 of file defineDebugSwitch.H.

◆ defineNamedTemplateDebugSwitch

#define defineNamedTemplateDebugSwitch (   Type,
  DebugSwitch 
)    defineTemplateDebugSwitchWithName(Type, Type::typeName_(), DebugSwitch)

Define the debug information directly for templates.

Definition at line 133 of file defineDebugSwitch.H.

◆ defineTemplate2DebugSwitch

#define defineTemplate2DebugSwitch (   Type,
  DebugSwitch 
)    defineTemplate2DebugSwitchWithName(Type, #Type, DebugSwitch)

Define the debug information for templates.

Useful with typedefs

Definition at line 139 of file defineDebugSwitch.H.

◆ defineNamedTemplate2DebugSwitch

#define defineNamedTemplate2DebugSwitch (   Type,
  DebugSwitch 
)    defineTemplate2DebugSwitchWithName(Type, Type::typeName_(), DebugSwitch)

Define the debug information directly for templates.

Definition at line 143 of file defineDebugSwitch.H.