axom::utilities::annotations Namespace Reference

Namespaces
	detail

Functions
void	initialize (const std::string &mode)
	Initializes the Annotation API. More...
void	finalize ()
	Finalizes and flushes the Annotation API. More...
void	begin (const std::string &name)
	Begins an annotation within a region. More...
void	end (const std::string &name)
	Ends an annotation within a region. More...
template<typename T >
void	declare_metadata (const std::string &name, const T &value, std::string category="")
	Declares metadata for this run. More...
std::map< std::string, std::string >	retrieve_metadata ()
	Access registered metadata from adiak (when available) and returns the result as a map of key-value pairs of strings. More...

Function Documentation

initialize()

void axom::utilities::annotations::initialize

(

const std::string &

mode

)

Initializes the Annotation API.

finalize()

void axom::utilities::annotations::finalize

(

)

Finalizes and flushes the Annotation API.

begin()

void axom::utilities::annotations::begin

(

const std::string &

name

)

Begins an annotation within a region.

end()

void axom::utilities::annotations::end

(

const std::string &

name

)

Ends an annotation within a region.

declare_metadata()

template<typename T >

void axom::utilities::annotations::declare_metadata	(	const std::string &	name,
		const T &	value,
		std::string	category = ""
	)

Declares metadata for this run.

References AXOM_UNUSED_VAR, and axom::utilities::annotations::detail::initialize_adiak().

retrieve_metadata()

std::map<std::string, std::string> axom::utilities::annotations::retrieve_metadata

(

)

Access registered metadata from adiak (when available) and returns the result as a map of key-value pairs of strings.

Note

Returns an empty map in configurations without adiak