OTF2_Marker.h File Reference

This file provides types and enums for markers. More...

#include <stdint.h>
#include <otf2/OTF2_ErrorCodes.h>
#include <otf2/OTF2_Definitions.h>

Go to the source code of this file.

Macros
#define	OTF2_UNDEFINED_MARKER   ( ( OTF2_MarkerRef )OTF2_UNDEFINED_UINT32 )
	The invalid value for a reference to a DefMarker definition.

Typedefs
typedef uint32_t	OTF2_MarkerRef
	Type used to indicate a reference to a DefMarker definition.
typedef uint8_t	OTF2_MarkerSeverity
	Wrapper for enum OTF2_MarkerSeverity_enum.
typedef uint8_t	OTF2_MarkerScope
	Wrapper for enum OTF2_MarkerScope_enum.

Enumerations
enum	OTF2_MarkerSeverity_enum {   OTF2_SEVERITY_NONE,   OTF2_SEVERITY_LOW,   OTF2_SEVERITY_MEDIUM,   OTF2_SEVERITY_HIGH }
enum	OTF2_MarkerScope_enum {   OTF2_MARKER_SCOPE_GLOBAL,   OTF2_MARKER_SCOPE_LOCATION,   OTF2_MARKER_SCOPE_LOCATION_GROUP,   OTF2_MARKER_SCOPE_SYSTEM_TREE_NODE,   OTF2_MARKER_SCOPE_GROUP,   OTF2_MARKER_SCOPE_COMM }

Detailed Description

This file provides types and enums for markers.

Enumeration Type Documentation

enum OTF2_MarkerSeverity_enum

A list of possible severities of user markers.

Enumerator
OTF2_SEVERITY_NONE	The marker does not have a severity.
OTF2_SEVERITY_LOW	The marker has a low severity.
OTF2_SEVERITY_MEDIUM	The marker has a medium severity.
OTF2_SEVERITY_HIGH	The marker has a high severity.

enum OTF2_MarkerScope_enum

A user marker does have a scope of it validity.

Enumerator
OTF2_MARKER_SCOPE_GLOBAL	The user marker has a global scope (could also be NONE).
OTF2_MARKER_SCOPE_LOCATION	The user marker has a scope of a location.
OTF2_MARKER_SCOPE_LOCATION_GROUP	The user marker has a scope of a location group.
OTF2_MARKER_SCOPE_SYSTEM_TREE_NODE	The user marker has a scope of a system tree.
OTF2_MARKER_SCOPE_GROUP	The user marker has a scope of a group.
OTF2_MARKER_SCOPE_COMM	The user marker has a scope of a communicator.