#include "axom/config.hpp"
#include "axom/core/utilities/Annotations.hpp"

Macros
#define	AXOM_ANNOTATE_BEGIN(name) axom::utilities::annotations::begin(name)
	This macro is used to mark the beginning of an annotated region. More...

#define	AXOM_ANNOTATE_END(name) axom::utilities::annotations::end(name)
	This macro is used to mark the end of an annotated region. More...

#define	AXOM_ANNOTATE_SCOPE(name)
	This macro is used to annotate a region within an enclosing scope and is automatically closed when its enclosing scope ends. More...

#define	AXOM_ANNOTATE_METADATA(name, value, category) axom::utilities::annotations::declare_metadata(name, value, category)
	This macro is used to add metadata to the run and is added to caliper output in modes that generate an output file. More...

Macro Definition Documentation

◆ AXOM_ANNOTATE_BEGIN

#define AXOM_ANNOTATE_BEGIN ( name ) axom::utilities::annotations::begin(name)

This macro is used to mark the beginning of an annotated region.

Note: AXOM_ANNOTATE_BEGIN must be closed with a matching AXOM_ANNOTATE_END

#define AXOM_ANNOTATE_END ( name ) axom::utilities::annotations::end(name)

This macro is used to mark the end of an annotated region.

#define AXOM_ANNOTATE_SCOPE ( name )

Value:

    do                              \
    {                               \
    } while(false)

This macro is used to annotate a region within an enclosing scope and is automatically closed when its enclosing scope ends.

Warning: The AXOM_ANNOTATE_SCOPE can only be called once within a given scope

Note: AXOM_ANNOTATE_SCOPE only annotates the portion of the scope following this macro. It adds a variable whose constructor begins an annotation region and whose destructor, which is called at the end of the scope, ends the annotation region.

#define AXOM_ANNOTATE_METADATA	(	name,
		value,
		category
	)	axom::utilities::annotations::declare_metadata(name, value, category)

This macro is used to add metadata to the run and is added to caliper output in modes that generate an output file.