axom::utilities::raii::AnnotationsWrapper Class Reference

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/core/utilities/RAII.hpp>

Public Member Functions
	AnnotationsWrapper (const std::string &mode)
	~AnnotationsWrapper ()

Detailed Description

Basic RAII wrapper class for initializing and finalizing axom's annotations API. Calls annotations::initialize() in constructor and annotations::finalize() in destructor

Note

Assumes MPI_COMM_WORLD is the MPI communicator. Applications using a custom communicator should directly call the annotations

In Axom configurations with MPI, this must be called after initializing MPI

Constructor & Destructor Documentation

AnnotationsWrapper()

axom::utilities::raii::AnnotationsWrapper::AnnotationsWrapper ( const std::string &  mode )

inline

References axom::utilities::annotations::initialize().

~AnnotationsWrapper()

axom::utilities::raii::AnnotationsWrapper::~AnnotationsWrapper ( )

inline

References axom::utilities::annotations::finalize().

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/core/utilities/RAII.hpp