1.5.1 (revision 4026)
Typedefs | Functions
otf2/OTF2_MarkerWriter.h File Reference

This file provides all routines that write marker records. More...

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

Go to the source code of this file.

Typedefs

typedef struct
OTF2_MarkerWriter_struct 
OTF2_MarkerWriter
 Handle definition for the external marker writer.

Functions

OTF2_ErrorCode OTF2_MarkerWriter_WriteDefMarker (OTF2_MarkerWriter *writerHandle, OTF2_MarkerRef self, const char *markerGroup, const char *markerCategory, OTF2_MarkerSeverity severity)
 Write a marker definition.
OTF2_ErrorCode OTF2_MarkerWriter_WriteMarker (OTF2_MarkerWriter *writerHandle, OTF2_TimeStamp timestamp, OTF2_TimeStamp duration, OTF2_MarkerRef marker, OTF2_MarkerScope scope, uint64_t scopeRef, const char *text)
 Write a marker record.

Detailed Description

This file provides all routines that write marker records.


Function Documentation

OTF2_ErrorCode OTF2_MarkerWriter_WriteDefMarker ( OTF2_MarkerWriter writerHandle,
OTF2_MarkerRef  self,
const char *  markerGroup,
const char *  markerCategory,
OTF2_MarkerSeverity  severity 
)

Write a marker definition.

Parameters:
writerHandleMarker writer handle.
selfReference to this marker definition.
markerGroupGroup name, e.g., "MUST", ...
markerCategoryMarker category, e.g., "Argument type error", ... The tuple (markerGroup, markerCategory) must be unique over all marker definitions.
severityThe severity for this marker category.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_MarkerWriter_WriteMarker ( OTF2_MarkerWriter writerHandle,
OTF2_TimeStamp  timestamp,
OTF2_TimeStamp  duration,
OTF2_MarkerRef  marker,
OTF2_MarkerScope  scope,
uint64_t  scopeRef,
const char *  text 
)

Write a marker record.

Parameters:
writerHandleMarker writer handle.
timestampTime of the marker.
durationA possible duration of this marker. May be 0.
markerReference to a marker definition.
scopeThe type of scope of this marker instance: OTF2_MARKER_SCOPE_GLOBAL, OTF2_MARKER_SCOPE_LOCATION, OTF2_MARKER_SCOPE_LOCATION_GROUP, OTF2_MARKER_SCOPE_SYSTEM_TREE_NODE, OTF2_MARKER_SCOPE_GROUP, or OTF2_MARKER_SCOPE_COMM.
scopeRefThe reference to an element of the scope of this marker. Depends on scope.
textA textual description for this marker.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.