OpenMPI  0.1.1
OTF_KeyValue.h File Reference

Provides an additional list of key value pairs that can be added to records. More...

#include "OTF_inttypes.h"
#include "OTF_Definitions.h"

Go to the source code of this file.

Typedefs

typedef enum OTF_Type_enum OTF_Type
 An enum which holds all OTF datatypes that are relevant for OTF_KeyValueList. More...
 
typedef struct
OTF_KeyValueList_struct 
OTF_KeyValueList
 Object type which holds a key-value list. More...
 
typedef struct
OTF_KeyValuePair_struct 
OTF_KeyValuePair
 Object type which holds a key-value pair. More...
 

Enumerations

enum  OTF_Type_enum {
  OTF_UNKNOWN = -1, OTF_CHAR = 0, OTF_INT8 = 1, OTF_UINT8 = 2,
  OTF_INT16 = 3, OTF_UINT16 = 4, OTF_INT32 = 5, OTF_UINT32 = 6,
  OTF_INT64 = 7, OTF_UINT64 = 8, OTF_FLOAT = 9, OTF_DOUBLE = 10,
  OTF_BYTE_ARRAY = 11
}
 An enum which holds all OTF datatypes that are relevant for OTF_KeyValueList. More...
 

Functions

OTF_KeyValueListOTF_KeyValueList_new (void)
 Create a new OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_close (OTF_KeyValueList *list)
 Close an OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_reset (OTF_KeyValueList *list)
 Reset an OTF_KeyValueList instance without deallocating memory. More...
 
uint8_t OTF_KeyValueList_realloc (OTF_KeyValueList *list, uint32_t num)
 Expand an OTF_KeyValueList by allocating more memory. More...
 
uint8_t OTF_KeyValueList_appendChar (OTF_KeyValueList *list, uint32_t key, char value)
 Append a character to a given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_appendInt8 (OTF_KeyValueList *list, uint32_t key, int8_t value)
 Append a signed integer of 8 bit to a OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_appendUint8 (OTF_KeyValueList *list, uint32_t key, uint8_t value)
 Append an unsigned integer of 8 bit to a OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_appendInt16 (OTF_KeyValueList *list, uint32_t key, int16_t value)
 Append a signed integer of 16 bit to a OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_appendUint16 (OTF_KeyValueList *list, uint32_t key, uint16_t value)
 Append an unsigned integer of 16 bit to a OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_appendInt32 (OTF_KeyValueList *list, uint32_t key, int32_t value)
 Append a signed integer of 32 bit to a OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_appendUint32 (OTF_KeyValueList *list, uint32_t key, uint32_t value)
 Append an unsigned integer of 32 bit to a OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_appendInt64 (OTF_KeyValueList *list, uint32_t key, int64_t value)
 Append a signed integer of 64 bit to a OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_appendUint64 (OTF_KeyValueList *list, uint32_t key, uint64_t value)
 Append an unsigned integer of 64 bit to a given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_appendFloat (OTF_KeyValueList *list, uint32_t key, float value)
 Append a float to a given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_appendDouble (OTF_KeyValueList *list, uint32_t key, double value)
 Append a double to a given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_appendByteArray (OTF_KeyValueList *list, uint32_t key, uint8_t *value, uint32_t len)
 Append a byte array to a given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_appendKeyValueList (OTF_KeyValueList *dest_list, OTF_KeyValueList *source_list)
 Append an existing OTF_KeyValueList to a given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_getChar (OTF_KeyValueList *list, uint32_t key, char *value)
 Read a character from the given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_getInt8 (OTF_KeyValueList *list, uint32_t key, int8_t *value)
 Read a signed integer of 8 bit from the given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_getUint8 (OTF_KeyValueList *list, uint32_t key, uint8_t *value)
 Read an unsigned integer of 8 bit from the given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_getInt16 (OTF_KeyValueList *list, uint32_t key, int16_t *value)
 Read a signed integer of 16 bit from the given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_getUint16 (OTF_KeyValueList *list, uint32_t key, uint16_t *value)
 Read an unsigned integer of 16 bit from the given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_getInt32 (OTF_KeyValueList *list, uint32_t key, int32_t *value)
 Read a signed integer of 32 bit from the given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_getUint32 (OTF_KeyValueList *list, uint32_t key, uint32_t *value)
 Read an unsigned integer of 32 bit from the given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_getInt64 (OTF_KeyValueList *list, uint32_t key, int64_t *value)
 Read a signed integer of 64 bit from the given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_getUint64 (OTF_KeyValueList *list, uint32_t key, uint64_t *value)
 Read an unsigned integer of 64 bit from the given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_getFloat (OTF_KeyValueList *list, uint32_t key, float *value)
 Read a float from the given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_getDouble (OTF_KeyValueList *list, uint32_t key, double *value)
 Read a double from the given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_getByteArray (OTF_KeyValueList *list, uint32_t key, uint8_t *value, uint32_t *len)
 Read a byte array from the given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_getArrayLength (OTF_KeyValueList *list, uint32_t key, uint32_t *len)
 Provides the lenght of a byte array in an OTF_KeyValueList instance by given key. More...
 
OTF_Type OTF_KeyValueList_getTypeForKey (OTF_KeyValueList *list, uint32_t key)
 Search for key in given OTF_KeyValueList instance and return its type. More...
 
uint8_t OTF_KeyValueList_hasKey (OTF_KeyValueList *list, uint32_t key)
 Search for key in the given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_removeKey (OTF_KeyValueList *list, uint32_t key)
 Remove key from the given OTF_KeyValueList instance. More...
 
uint8_t OTF_KeyValueList_getKeyByIndex (OTF_KeyValueList *list, uint32_t index, uint32_t *key)
 Search for a key at the given index position. More...
 
uint8_t OTF_KeyValueList_getPairByIndex (OTF_KeyValueList *list, uint32_t index, OTF_KeyValuePair **pair)
 Search for a key-value pair at the given index position. More...
 
uint32_t OTF_KeyValueList_getCount (OTF_KeyValueList *list)
 Returns the number of elements in the given OTF_KeyValueList instance. More...
 
float OTF_Int32ToFloat (uint32_t value)
 Convert an integer of 32 bit to a float.
 
uint32_t OTF_FloatToInt32 (float value)
 Convert a float to an integer of 32 bit.
 
double OTF_Int64ToDouble (uint64_t value)
 Convert an integer of 64 bit to a double.
 
uint64_t OTF_DoubleToInt64 (double value)
 Convert a double to a signed integer of 64 bit.
 

Detailed Description

Provides an additional list of key value pairs that can be added to records.

Typedef Documentation

typedef struct OTF_KeyValueList_struct OTF_KeyValueList

Object type which holds a key-value list.

typedef struct OTF_KeyValuePair_struct OTF_KeyValuePair

Object type which holds a key-value pair.

typedef enum OTF_Type_enum OTF_Type

An enum which holds all OTF datatypes that are relevant for OTF_KeyValueList.

Enumeration Type Documentation

An enum which holds all OTF datatypes that are relevant for OTF_KeyValueList.