Generic Trace Generator (GTG)  0.1
GTGOTF_Basic.h
Go to the documentation of this file.
1 
16 #ifndef _GTG_OTF_BASIC_H_
17 #define _GTG_OTF_BASIC_H_
18 
19 #include "GTGTypes.h"
20 #include "GTGBasic.h"
21 #include "GTGOTF_Structs.h"
22 
35 
45 trace_return_t OTFInitTrace (const char* filename, gtg_flag_t flags);
46 
56 
69 trace_return_t OTFAddContType (const char* alias, const char* contType,
70  const char* name);
71 
84 trace_return_t OTFAddStateType (const char* alias, const char* contType,
85  const char* name);
86 
99 trace_return_t OTFAddEventType (const char* alias, const char* contType,
100  const char* name);
101 
118 trace_return_t OTFAddLinkType (const char* alias , const char* name,
119  const char* contType, const char* srcContType,
120  const char* destContType);
121 
134 trace_return_t OTFAddVarType (const char* alias , const char* name,
135  const char* contType);
136 
151 trace_return_t OTFAddEntityValue (const char* alias, const char* entType,
152  const char* name , const otf_color_t color);
153 
171 trace_return_t OTFDefineContainer (const char* alias,
172  const char* type, const char* container,
173  const char* name, const char* file);
174 
193 trace_return_t OTFStartContainer (varPrec time, const char* alias ,
194  const char* type, const char* container,
195  const char* name, const char* file);
196 
209 trace_return_t OTFDestroyContainer (varPrec time, const char* name,
210  const char* type);
211 
226 trace_return_t OTFSetState (varPrec time, const char* type,
227  const char* cont, const char* val);
228 
243 trace_return_t OTFPushState (varPrec time, const char* type,
244  const char* cont, const char* val);
245 
258 trace_return_t OTFPopState (varPrec time, const char* type,
259  const char* cont);
260 
275 trace_return_t OTFAddEvent (varPrec time, const char* type,
276  const char* cont, const char* val);
277 
296 trace_return_t OTFStartLink (varPrec time, const char* type,
297  const char* src, const char* dest,
298  const char* val , const char* key);
299 
318 trace_return_t OTFEndLink (varPrec time, const char* type,
319  const char* src, const char* dest,
320  const char* val, const char* key);
321 
336 trace_return_t OTFSetVar (varPrec time, const char* type,
337  const char* cont, varPrec val);
338 
353 trace_return_t OTFAddVar (varPrec time, const char* type,
354  const char* cont, varPrec val);
355 
370 trace_return_t OTFSubVar (varPrec time, const char* type,
371  const char* cont, varPrec val);
372 
382 trace_return_t OTFAddComment (const char* comment);
383 
392 
393 #endif /* _GTG_OTF_BASIC_H_ */
394 
395 
396 
trace_return_t OTFStartContainer(varPrec time, const char *alias, const char *type, const char *container, const char *name, const char *file)
Start a Container.
trace_return_t OTFAddVar(varPrec time, const char *type, const char *cont, varPrec val)
Add a value to a Variable.
trace_return_t OTFSetVar(varPrec time, const char *type, const char *cont, varPrec val)
Set a Variable value.
trace_return_t OTFDefineContainer(const char *alias, const char *type, const char *container, const char *name, const char *file)
double varPrec
Use the double precision type for time and value.
Definition: GTGTypes.h:28
trace_return_t OTFSubVar(varPrec time, const char *type, const char *cont, varPrec val)
Substract a value from a Variable.
trace_return_t OTFDestroyContainer(varPrec time, const char *name, const char *type)
Destroy a Container.
trace_return_t OTFAddVarType(const char *alias, const char *name, const char *contType)
Add a Variable Type.
trace_return_t OTFAddContType(const char *alias, const char *contType, const char *name)
Add a Container Type.
trace_return_t OTFPopState(varPrec time, const char *type, const char *cont)
Revert the State of a Container to its previous value.
trace_return_t OTFAddStateType(const char *alias, const char *contType, const char *name)
Add a State Type.
trace_return_t OTFAddComment(const char *comment)
Add some Comment in Trace file.
trace_return_t
Define various return values.
Definition: GTGTypes.h:35
trace_return_t OTFEndLink(varPrec time, const char *type, const char *src, const char *dest, const char *val, const char *key)
End a Link.
trace_return_t OTFSetState(varPrec time, const char *type, const char *cont, const char *val)
Set the State of a Container.
trace_return_t OTFAddEventType(const char *alias, const char *contType, const char *name)
Add an Event Type.
GTGBasic is a basic interface to generate trace in various formats.
trace_return_t OTFAddEntityValue(const char *alias, const char *entType, const char *name, const otf_color_t color)
Add an Entity Value.
This structure defines a color that can be used by GTG.
Definition: GTGColor.h:25
trace_return_t OTFEndTrace()
Finalize an OTF trace.
uint8_t gtg_flag_t
Flags that can be specified to GTG.
Definition: GTGBasic.h:51
Definition: GTGOTF_Structs.h:114
trace_return_t OTFSetCompress(int val)
Enable trace compression.
const otf_color_t OTF_get_color(gtg_color_t color)
Converts a GTG color into a OTF color.
trace_return_t OTFStartLink(varPrec time, const char *type, const char *src, const char *dest, const char *val, const char *key)
Start a Link.
trace_return_t OTFAddLinkType(const char *alias, const char *name, const char *contType, const char *srcContType, const char *destContType)
Add a Link Type.
OTF_Structs gives the global types and functions needed to have the OTF implementation.
trace_return_t OTFPushState(varPrec time, const char *type, const char *cont, const char *val)
Save the current State on a stack and change the State of a Container.
trace_return_t OTFInitTrace(const char *filename, gtg_flag_t flags)
Initialize an OTF trace.
trace_return_t OTFAddEvent(varPrec time, const char *type, const char *cont, const char *val)
Add an Event.