OTF2_AttributeList.h File Reference

This layer enables dynamic appending of arbitrary attributes to any type of event record. More...

#include <stdint.h>
#include <stdbool.h>
#include <otf2/OTF2_ErrorCodes.h>
#include <otf2/OTF2_GeneralDefinitions.h>
#include <otf2/OTF2_AttributeValue.h>

Go to the source code of this file.

Typedefs
typedef struct OTF2_AttributeList_struct	OTF2_AttributeList
	Attribute list handle.

Functions
OTF2_AttributeList *	OTF2_AttributeList_New (void)
	Create a new attribute list handle. More...
OTF2_ErrorCode	OTF2_AttributeList_Delete (OTF2_AttributeList *attributeList)
	Delete an attribute list handle. More...
OTF2_ErrorCode	OTF2_AttributeList_AddAttribute (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_Type type, OTF2_AttributeValue attributeValue)
	Add an attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddUint8 (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, uint8_t uint8Value)
	Add an OTF2_TYPE_UINT8 attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddUint16 (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, uint16_t uint16Value)
	Add an OTF2_TYPE_UINT16 attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddUint32 (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, uint32_t uint32Value)
	Add an OTF2_TYPE_UINT32 attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddUint64 (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, uint64_t uint64Value)
	Add an OTF2_TYPE_UINT64 attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddInt8 (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, int8_t int8Value)
	Add an OTF2_TYPE_INT8 attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddInt16 (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, int16_t int16Value)
	Add an OTF2_TYPE_INT16 attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddInt32 (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, int32_t int32Value)
	Add an OTF2_TYPE_INT32 attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddInt64 (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, int64_t int64Value)
	Add an OTF2_TYPE_INT64 attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddFloat (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, float float32Value)
	Add an OTF2_TYPE_FLOAT attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddDouble (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, double float64Value)
	Add an OTF2_TYPE_DOUBLE attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddStringRef (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_StringRef stringRef)
	Add an OTF2_TYPE_STRING attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddAttributeRef (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_AttributeRef attributeRef)
	Add an OTF2_TYPE_ATTRIBUTE attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddLocationRef (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_LocationRef locationRef)
	Add an OTF2_TYPE_LOCATION attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddRegionRef (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_RegionRef regionRef)
	Add an OTF2_TYPE_REGION attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddGroupRef (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_GroupRef groupRef)
	Add an OTF2_TYPE_GROUP attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddMetricRef (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_MetricRef metricRef)
	Add an OTF2_TYPE_METRIC attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddCommRef (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_CommRef commRef)
	Add an OTF2_TYPE_COMM attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddParameterRef (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_ParameterRef parameterRef)
	Add an OTF2_TYPE_PARAMETER attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddRmaWinRef (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_RmaWinRef rmaWinRef)
	Add an OTF2_TYPE_RMA_WIN attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddSourceCodeLocationRef (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_SourceCodeLocationRef sourceCodeLocationRef)
	Add an OTF2_TYPE_SOURCE_CODE_LOCATION attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddCallingContextRef (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_CallingContextRef callingContextRef)
	Add an OTF2_TYPE_CALLING_CONTEXT attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddInterruptGeneratorRef (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_InterruptGeneratorRef interruptGeneratorRef)
	Add an OTF2_TYPE_INTERRUPT_GENERATOR attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddIoFileRef (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_IoFileRef ioFileRef)
	Add an OTF2_TYPE_IO_FILE attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddIoHandleRef (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_IoHandleRef ioHandleRef)
	Add an OTF2_TYPE_IO_HANDLE attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_AddLocationGroupRef (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_LocationGroupRef locationGroupRef)
	Add an OTF2_TYPE_LOCATION_GROUP attribute to an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_RemoveAttribute (OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute)
	Remove an attribute from an attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_RemoveAllAttributes (OTF2_AttributeList *attributeList)
	Remove all attributes from an attribute list. More...
bool	OTF2_AttributeList_TestAttributeByID (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute)
	Test if an attribute is in the attribute list. More...
OTF2_ErrorCode	OTF2_AttributeList_GetAttributeByID (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_Type *type, OTF2_AttributeValue *attributeValue)
	Get an attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetUint8 (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, uint8_t *uint8Value)
	Get an OTF2_TYPE_UINT8 attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetUint16 (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, uint16_t *uint16Value)
	Get an OTF2_TYPE_UINT16 attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetUint32 (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, uint32_t *uint32Value)
	Get an OTF2_TYPE_UINT32 attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetUint64 (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, uint64_t *uint64Value)
	Get an OTF2_TYPE_UINT64 attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetInt8 (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, int8_t *int8Value)
	Get an OTF2_TYPE_INT8 attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetInt16 (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, int16_t *int16Value)
	Get an OTF2_TYPE_INT16 attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetInt32 (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, int32_t *int32Value)
	Get an OTF2_TYPE_INT32 attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetInt64 (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, int64_t *int64Value)
	Get an OTF2_TYPE_INT64 attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetFloat (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, float *float32Value)
	Get an OTF2_TYPE_FLOAT attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetDouble (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, double *float64Value)
	Get an OTF2_TYPE_DOUBLE attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetStringRef (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_StringRef *stringRef)
	Get an OTF2_TYPE_STRING attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetAttributeRef (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_AttributeRef *attributeRef)
	Get an OTF2_TYPE_ATTRIBUTE attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetLocationRef (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_LocationRef *locationRef)
	Get an OTF2_TYPE_LOCATION attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetRegionRef (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_RegionRef *regionRef)
	Get an OTF2_TYPE_REGION attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetGroupRef (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_GroupRef *groupRef)
	Get an OTF2_TYPE_GROUP attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetMetricRef (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_MetricRef *metricRef)
	Get an OTF2_TYPE_METRIC attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetCommRef (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_CommRef *commRef)
	Get an OTF2_TYPE_COMM attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetParameterRef (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_ParameterRef *parameterRef)
	Get an OTF2_TYPE_PARAMETER attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetRmaWinRef (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_RmaWinRef *rmaWinRef)
	Get an OTF2_TYPE_RMA_WIN attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetSourceCodeLocationRef (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_SourceCodeLocationRef *sourceCodeLocationRef)
	Get an OTF2_TYPE_SOURCE_CODE_LOCATION attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetCallingContextRef (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_CallingContextRef *callingContextRef)
	Get an OTF2_TYPE_CALLING_CONTEXT attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetInterruptGeneratorRef (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_InterruptGeneratorRef *interruptGeneratorRef)
	Get an OTF2_TYPE_INTERRUPT_GENERATOR attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetIoFileRef (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_IoFileRef *ioFileRef)
	Get an OTF2_TYPE_IO_FILE attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetIoHandleRef (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_IoHandleRef *ioHandleRef)
	Get an OTF2_TYPE_IO_HANDLE attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetLocationGroupRef (const OTF2_AttributeList *attributeList, OTF2_AttributeRef attribute, OTF2_LocationGroupRef *locationGroupRef)
	Get an OTF2_TYPE_LOCATION_GROUP attribute from an attribute list by attribute ID. More...
OTF2_ErrorCode	OTF2_AttributeList_GetAttributeByIndex (const OTF2_AttributeList *attributeList, uint32_t index, OTF2_AttributeRef *attribute, OTF2_Type *type, OTF2_AttributeValue *attributeValue)
	Get an attribute from an attribute list by attribute index. More...
OTF2_ErrorCode	OTF2_AttributeList_PopAttribute (OTF2_AttributeList *attributeList, OTF2_AttributeRef *attribute, OTF2_Type *type, OTF2_AttributeValue *attributeValue)
	Get first attribute from an attribute list and remove it. More...
uint32_t	OTF2_AttributeList_GetNumberOfElements (const OTF2_AttributeList *attributeList)
	Get the number of entries in an attribute list. More...

Detailed Description

This layer enables dynamic appending of arbitrary attributes to any type of event record.

Source template

template/OTF2_AttributeList.tmpl.h

Function Documentation

OTF2_AttributeList* OTF2_AttributeList_New

(

void

)

Create a new attribute list handle.

Returns

Returns a handle to the attribute list if successful, NULL otherwise.

OTF2_ErrorCode OTF2_AttributeList_Delete

(

OTF2_AttributeList *

attributeList

)

Delete an attribute list handle.

Deletes an attribute list handle and releases all associated resources.

Parameters

attributeList

Attribute list handle.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddAttribute	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_Type	type,
		OTF2_AttributeValue	attributeValue
	)

Add an attribute to an attribute list.

Adds an attribute to an attribute list. If the attribute already exists, it fails and returns an error.

Parameters

attributeList	Attribute list handle.
attribute	Reference to attribute definition.
type	Type of the attribute.
attributeValue	Value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddUint8	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		uint8_t	uint8Value
	)

Add an OTF2_TYPE_UINT8 attribute to an attribute list.

Convenient function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
uint8Value	Value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddUint16	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		uint16_t	uint16Value
	)

Add an OTF2_TYPE_UINT16 attribute to an attribute list.

Convenient function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
uint16Value	Value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddUint32	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		uint32_t	uint32Value
	)

Add an OTF2_TYPE_UINT32 attribute to an attribute list.

Convenient function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
uint32Value	Value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddUint64	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		uint64_t	uint64Value
	)

Add an OTF2_TYPE_UINT64 attribute to an attribute list.

Convenient function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
uint64Value	Value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddInt8	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		int8_t	int8Value
	)

Add an OTF2_TYPE_INT8 attribute to an attribute list.

Convenient function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
int8Value	Value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddInt16	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		int16_t	int16Value
	)

Add an OTF2_TYPE_INT16 attribute to an attribute list.

Convenient function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
int16Value	Value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddInt32	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		int32_t	int32Value
	)

Add an OTF2_TYPE_INT32 attribute to an attribute list.

Convenient function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
int32Value	Value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddInt64	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		int64_t	int64Value
	)

Add an OTF2_TYPE_INT64 attribute to an attribute list.

Convenient function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
int64Value	Value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddFloat	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		float	float32Value
	)

Add an OTF2_TYPE_FLOAT attribute to an attribute list.

Convenient function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
float32Value	Value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddDouble	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		double	float64Value
	)

Add an OTF2_TYPE_DOUBLE attribute to an attribute list.

Convenient function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
float64Value	Value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddStringRef	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_StringRef	stringRef
	)

Add an OTF2_TYPE_STRING attribute to an attribute list.

Convenience function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
stringRef	Reference to String definition.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddAttributeRef	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_AttributeRef	attributeRef
	)

Add an OTF2_TYPE_ATTRIBUTE attribute to an attribute list.

Convenience function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
attributeRef	Reference to Attribute definition.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddLocationRef	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_LocationRef	locationRef
	)

Add an OTF2_TYPE_LOCATION attribute to an attribute list.

Convenience function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
locationRef	Reference to Location definition.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddRegionRef	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_RegionRef	regionRef
	)

Add an OTF2_TYPE_REGION attribute to an attribute list.

Convenience function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
regionRef	Reference to Region definition.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddGroupRef	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_GroupRef	groupRef
	)

Add an OTF2_TYPE_GROUP attribute to an attribute list.

Convenience function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
groupRef	Reference to Group definition.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddMetricRef	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_MetricRef	metricRef
	)

Add an OTF2_TYPE_METRIC attribute to an attribute list.

Convenience function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
metricRef	Reference to Metric definition.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddCommRef	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_CommRef	commRef
	)

Add an OTF2_TYPE_COMM attribute to an attribute list.

Convenience function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
commRef	Reference to Comm definition.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddParameterRef	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_ParameterRef	parameterRef
	)

Add an OTF2_TYPE_PARAMETER attribute to an attribute list.

Convenience function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
parameterRef	Reference to Parameter definition.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddRmaWinRef	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_RmaWinRef	rmaWinRef
	)

Add an OTF2_TYPE_RMA_WIN attribute to an attribute list.

Convenience function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
rmaWinRef	Reference to RmaWin definition.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddSourceCodeLocationRef	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_SourceCodeLocationRef	sourceCodeLocationRef
	)

Add an OTF2_TYPE_SOURCE_CODE_LOCATION attribute to an attribute list.

Convenience function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
sourceCodeLocationRef	Reference to SourceCodeLocation definition.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddCallingContextRef	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_CallingContextRef	callingContextRef
	)

Add an OTF2_TYPE_CALLING_CONTEXT attribute to an attribute list.

Convenience function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
callingContextRef	Reference to CallingContext definition.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddInterruptGeneratorRef	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_InterruptGeneratorRef	interruptGeneratorRef
	)

Add an OTF2_TYPE_INTERRUPT_GENERATOR attribute to an attribute list.

Convenience function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
interruptGeneratorRef	Reference to InterruptGenerator definition.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddIoFileRef	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_IoFileRef	ioFileRef
	)

Add an OTF2_TYPE_IO_FILE attribute to an attribute list.

Convenience function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
ioFileRef	Reference to IoFile definition.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddIoHandleRef	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_IoHandleRef	ioHandleRef
	)

Add an OTF2_TYPE_IO_HANDLE attribute to an attribute list.

Convenience function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
ioHandleRef	Reference to IoHandle definition.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_AddLocationGroupRef	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_LocationGroupRef	locationGroupRef
	)

Add an OTF2_TYPE_LOCATION_GROUP attribute to an attribute list.

Convenience function around OTF2_AttributeList_AddAttribute.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.
locationGroupRef	Reference to LocationGroup definition.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_RemoveAttribute	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute
	)

Remove an attribute from an attribute list.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_RemoveAllAttributes

(

OTF2_AttributeList *

attributeList

)

Remove all attributes from an attribute list.

Parameters

attributeList

Attribute list handle.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

bool OTF2_AttributeList_TestAttributeByID	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute
	)

Test if an attribute is in the attribute list.

Parameters

attributeList	Attribute list handle.
attribute	Reference to Attribute definition.

Returns

True if the id is in the list, else false.

OTF2_ErrorCode OTF2_AttributeList_GetAttributeByID	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_Type *	type,
		OTF2_AttributeValue *	attributeValue
	)

Get an attribute from an attribute list by attribute ID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to Attribute definition.
[out]	type	Returned type of the attribute.
[out]	attributeValue	Returned value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetUint8	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		uint8_t *	uint8Value
	)

Get an OTF2_TYPE_UINT8 attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to Attribute definition.
[out]	uint8Value	Returned value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetUint16	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		uint16_t *	uint16Value
	)

Get an OTF2_TYPE_UINT16 attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to Attribute definition.
[out]	uint16Value	Returned value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetUint32	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		uint32_t *	uint32Value
	)

Get an OTF2_TYPE_UINT32 attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to Attribute definition.
[out]	uint32Value	Returned value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetUint64	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		uint64_t *	uint64Value
	)

Get an OTF2_TYPE_UINT64 attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to Attribute definition.
[out]	uint64Value	Returned value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetInt8	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		int8_t *	int8Value
	)

Get an OTF2_TYPE_INT8 attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to Attribute definition.
[out]	int8Value	Returned value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetInt16	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		int16_t *	int16Value
	)

Get an OTF2_TYPE_INT16 attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to Attribute definition.
[out]	int16Value	Returned value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetInt32	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		int32_t *	int32Value
	)

Get an OTF2_TYPE_INT32 attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to Attribute definition.
[out]	int32Value	Returned value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetInt64	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		int64_t *	int64Value
	)

Get an OTF2_TYPE_INT64 attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to Attribute definition.
[out]	int64Value	Returned value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetFloat	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		float *	float32Value
	)

Get an OTF2_TYPE_FLOAT attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to Attribute definition.
[out]	float32Value	Returned value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetDouble	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		double *	float64Value
	)

Get an OTF2_TYPE_DOUBLE attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to Attribute definition.
[out]	float64Value	Returned value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetStringRef	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_StringRef *	stringRef
	)

Get an OTF2_TYPE_STRING attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to attribute definition.
[out]	stringRef	Returned string value.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetAttributeRef	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_AttributeRef *	attributeRef
	)

Get an OTF2_TYPE_ATTRIBUTE attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to attribute definition.
[out]	attributeRef	Returned attribute value.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetLocationRef	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_LocationRef *	locationRef
	)

Get an OTF2_TYPE_LOCATION attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to attribute definition.
[out]	locationRef	Returned location value.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetRegionRef	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_RegionRef *	regionRef
	)

Get an OTF2_TYPE_REGION attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to attribute definition.
[out]	regionRef	Returned region value.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetGroupRef	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_GroupRef *	groupRef
	)

Get an OTF2_TYPE_GROUP attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to attribute definition.
[out]	groupRef	Returned group value.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetMetricRef	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_MetricRef *	metricRef
	)

Get an OTF2_TYPE_METRIC attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to attribute definition.
[out]	metricRef	Returned metric value.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetCommRef	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_CommRef *	commRef
	)

Get an OTF2_TYPE_COMM attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to attribute definition.
[out]	commRef	Returned comm value.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetParameterRef	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_ParameterRef *	parameterRef
	)

Get an OTF2_TYPE_PARAMETER attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to attribute definition.
[out]	parameterRef	Returned parameter value.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetRmaWinRef	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_RmaWinRef *	rmaWinRef
	)

Get an OTF2_TYPE_RMA_WIN attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to attribute definition.
[out]	rmaWinRef	Returned rmaWin value.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetSourceCodeLocationRef	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_SourceCodeLocationRef *	sourceCodeLocationRef
	)

Get an OTF2_TYPE_SOURCE_CODE_LOCATION attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to attribute definition.
[out]	sourceCodeLocationRef	Returned sourceCodeLocation value.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetCallingContextRef	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_CallingContextRef *	callingContextRef
	)

Get an OTF2_TYPE_CALLING_CONTEXT attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to attribute definition.
[out]	callingContextRef	Returned callingContext value.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetInterruptGeneratorRef	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_InterruptGeneratorRef *	interruptGeneratorRef
	)

Get an OTF2_TYPE_INTERRUPT_GENERATOR attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to attribute definition.
[out]	interruptGeneratorRef	Returned interruptGenerator value.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetIoFileRef	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_IoFileRef *	ioFileRef
	)

Get an OTF2_TYPE_IO_FILE attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to attribute definition.
[out]	ioFileRef	Returned ioFile value.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetIoHandleRef	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_IoHandleRef *	ioHandleRef
	)

Get an OTF2_TYPE_IO_HANDLE attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to attribute definition.
[out]	ioHandleRef	Returned ioHandle value.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetLocationGroupRef	(	const OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef	attribute,
		OTF2_LocationGroupRef *	locationGroupRef
	)

Get an OTF2_TYPE_LOCATION_GROUP attribute from an attribute list by attribute ID.

Convenient function around OTF2_AttributeList_GetAttributeByID.

Parameters

	attributeList	Attribute list handle.
	attribute	Reference to attribute definition.
[out]	locationGroupRef	Returned locationGroup value.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_GetAttributeByIndex	(	const OTF2_AttributeList *	attributeList,
		uint32_t	index,
		OTF2_AttributeRef *	attribute,
		OTF2_Type *	type,
		OTF2_AttributeValue *	attributeValue
	)

Get an attribute from an attribute list by attribute index.

Parameters

	attributeList	Attribute list handle.
	index	Position of the attribute in the attribute list.
[out]	attribute	Returned attribute reference.
[out]	type	Returned type of the attribute.
[out]	attributeValue	Returned value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

OTF2_ErrorCode OTF2_AttributeList_PopAttribute	(	OTF2_AttributeList *	attributeList,
		OTF2_AttributeRef *	attribute,
		OTF2_Type *	type,
		OTF2_AttributeValue *	attributeValue
	)

Get first attribute from an attribute list and remove it.

Returns the first entry in the attribute list and removes it from the list.

Parameters

	attributeList	Attribute list handle.
[out]	attribute	Returned attribute reference.
[out]	type	Returned type of the attribute.
[out]	attributeValue	Returned value of the attribute.

Returns

OTF2_SUCCESS if successful, an error code if an error occurs.

uint32_t OTF2_AttributeList_GetNumberOfElements

(

const OTF2_AttributeList *

attributeList

)

Get the number of entries in an attribute list.

Parameters

attributeList

Attribute list handle.

Returns

Returns the number of elements in the list. Returns zero if the list does not exist.