Group tirexresult

Modules > tirexresult

Classes

Type	Name
struct	tirexResultEntry_st Holds a result entry, i.e., a key-value pair of a name (string) and a value (tirexResult).

Public Types

Type	Name
typedef struct tirexResult_st	tirexResult Holds a handle to the results of a measurement.
typedef struct tirexResultEntry_st	tirexResultEntry Holds a result entry, i.e., a key-value pair of a name (string) and a value (tirexResult).
typedef enum tirexResultType_enum	tirexResultType
enum	tirexResultType_enum

Public Functions

Type	Name
TIREX_TRACKER_EXPORT tirexError	tirexResultEntryGetByIndex (const tirexResult * result, size_t index, tirexResultEntry * entry)
TIREX_TRACKER_EXPORT tirexError	tirexResultEntryNum (const tirexResult * result, size_t * num) Returns the number of entries contained in the result set.
TIREX_TRACKER_EXPORT void	tirexResultFree (tirexResult * result) Deinitializes and frees the result pointed at by result .

Macros

Type	Name
define	static_assert (cond, msg)

Public Types Documentation

typedef tirexResult

Holds a handle to the results of a measurement.

typedef struct tirexResult_st tirexResult;

The measurement result is structed as a tree of categories, subcategories and (at the leaves) values.

See also: tirexStopTracking(tirexMeasureHandle*, char**)

---

typedef tirexResultEntry

Holds a result entry, i.e., a key-value pair of a name (string) and a value (tirexResult).

typedef struct tirexResultEntry_st tirexResultEntry;

---

typedef tirexResultType

typedef enum tirexResultType_enum tirexResultType;

Note: Currently unused

---

enum tirexResultType_enum

enum tirexResultType_enum {
    TIREX_STRING = 0,
    TIREX_INTEGER = 1,
    TIREX_FLOATING = 2,
    TIREX_BOOLEAN = 3,
    TIREX_WSTRING = 4,
    TIREX_LIST = 1 << 7,
    TIREX_STRING_LIST = TIREX_STRING | TIREX_LIST,
    TIREX_INTEGER_LIST = TIREX_INTEGER | TIREX_LIST,
    TIREX_FLOATING_LIST = TIREX_FLOATING | TIREX_LIST,
    TIREX_BOOLEAN_LIST = TIREX_BOOLEAN | TIREX_LIST,
    TIREX_WSTRING_LIST = TIREX_WSTRING | TIREX_LIST
};

Note: Currently unused

---

Public Functions Documentation

function tirexResultEntryGetByIndex

TIREX_TRACKER_EXPORT tirexError tirexResultEntryGetByIndex (
    const tirexResult * result,
    size_t index,
    tirexResultEntry * entry
) 

Parameters:

• result
• index
• entry

Returns:

TIREX_SUCCESS on success or an error code.

---

function tirexResultEntryNum

Returns the number of entries contained in the result set.

TIREX_TRACKER_EXPORT tirexError tirexResultEntryNum (
    const tirexResult * result,
    size_t * num
) 

Parameters:

• result
• num

Returns:

TIREX_SUCCESS on success or an error code.

---

function tirexResultFree

Deinitializes and frees the result pointed at by result .

TIREX_TRACKER_EXPORT void tirexResultFree (
    tirexResult * result
) 

Parameters:

• result The result to be destructed.

---

Macro Definition Documentation

define static_assert

#define static_assert (
    cond,
    msg
) 

---

---