3.1-rc3 (revision d9ca08bb)
OTF2_MarkerWriter.h
Go to the documentation of this file.
1 /*
2  * This file is part of the Score-P software (http://www.score-p.org)
3  *
4  * Copyright (c) 2013,
5  * Technische Universitaet Dresden, Germany
6  *
7  * This software may be modified and distributed under the terms of
8  * a BSD-style license. See the COPYING file in the package base
9  * directory for details.
10  */
11 
12 
13 #ifndef OTF2_MARKER_WRITER_H
14 #define OTF2_MARKER_WRITER_H
15 
16 
24 #include <stdint.h>
25 
26 
27 #include <otf2/OTF2_ErrorCodes.h>
28 
29 
30 #include <otf2/OTF2_Definitions.h>
31 
32 
33 #include <otf2/OTF2_Marker.h>
34 
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif /* __cplusplus */
39 
40 
42 typedef struct OTF2_MarkerWriter_struct OTF2_MarkerWriter;
43 
44 
61  OTF2_MarkerRef self,
62  const char* markerGroup,
63  const char* markerCategory,
64  OTF2_MarkerSeverity severity );
65 
89  OTF2_TimeStamp timestamp,
90  OTF2_TimeStamp duration,
91  OTF2_MarkerRef marker,
92  OTF2_MarkerScope scope,
93  uint64_t scopeRef,
94  const char* text );
95 
96 #ifdef __cplusplus
97 }
98 #endif /* __cplusplus */
99 
100 
101 #endif /* !OTF2_MARKER_WRITER_H */
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
Definition: OTF2_ErrorCodes.h:53
Data types used in the definition records.
uint8_t OTF2_MarkerSeverity
Wrapper for enum OTF2_MarkerSeverity_enum.
Definition: OTF2_Marker.h:45
uint64_t OTF2_TimeStamp
OTF2 time stamp.
Definition: OTF2_GeneralDefinitions.h:106
uint32_t OTF2_MarkerRef
Type used to indicate a reference to a DefMarker definition.
Definition: OTF2_Marker.h:39
struct OTF2_MarkerWriter_struct OTF2_MarkerWriter
Handle definition for the external marker writer.
Definition: OTF2_MarkerWriter.h:42
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.
This file provides types and enums for markers.
uint8_t OTF2_MarkerScope
Wrapper for enum OTF2_MarkerScope_enum.
Definition: OTF2_Marker.h:62
Error codes and error handling.