TTK
Classes | Namespaces | Macros | Variables
BaseClass.h File Reference
#include <DataTypes.h>
#include <OpenMP.h>
#include <MPIUtils.h>

Go to the source code of this file.

Classes

class  ttk::BaseClass
 TTK base package. More...
 

Namespaces

namespace  ttk
 The Topology ToolKit.
 

Macros

#define COMMON_EXPORTS
 
#define ttkNotUsed(x)
 Mark function/method parameters that are not used in the function body at all. More...
 
#define TTK_FORCE_USE(x)   (void)(x)
 Force the compiler to use the function/method parameter. More...
 

Variables

COMMON_EXPORTS int ttk::globalThreadNumber_ = 1
 
COMMON_EXPORTS int ttk::MPIrank_ = -1
 
COMMON_EXPORTS int ttk::MPIsize_ = -1
 

Macro Definition Documentation

◆ COMMON_EXPORTS

#define COMMON_EXPORTS

Definition at line 31 of file BaseClass.h.

◆ TTK_FORCE_USE

#define TTK_FORCE_USE (   x)    (void)(x)

Force the compiler to use the function/method parameter.

Some function/method parameters are used under some #ifdef preprocessor conditions. This macro introduce a no-op statement that uses those parameters, to silence compiler warnings in the #else blocks. It can be inserted anywhere in the function body.

Definition at line 57 of file BaseClass.h.

◆ ttkNotUsed

#define ttkNotUsed (   x)

Mark function/method parameters that are not used in the function body at all.

This is the TTK version of vtkNotUsed. It silences compiler warnings about unused parameters when those parameters are not used in the current function/method body but still necessary in the function/method signature (for instance when implementing a particular API with inheritance).

Basically, it removes the name of the parameter at its definition site (similar to commenting the parameter name).

Definition at line 47 of file BaseClass.h.