stk::ITraceable Class Reference

Traceable object. More...

#include <stk_common.h>

Inheritance diagram for stk::ITraceable:

Public Member Functions
void	SetTraceName (const char *name)
	Set name.
const char *	GetTraceName () const
	Get name.

Detailed Description

Traceable object.

Note

Used for debugging and tracing by tools like SEGGER SystemView. See STK_SYNC_DEBUG_NAMES.

Definition at line 254 of file stk_common.h.

Member Function Documentation

GetTraceName()

const char * stk::ITraceable::GetTraceName ( ) const

inline

Get name.

Returns

Name string, or NULL if not set or if STK_SYNC_DEBUG_NAMES is 0.

Definition at line 278 of file stk_common.h.

    {
    #if STK_SYNC_DEBUG_NAMES
        return m_trace_name;
    #else
        return nullptr;
    #endif
    }

SetTraceName()

void stk::ITraceable::SetTraceName ( const char * name )

inline

Set name.

Parameters

[in]

name

Null-terminated string or NULL.

Note

If STK_SYNC_DEBUG_NAMES is 0 then calling this function has no effect.

Definition at line 266 of file stk_common.h.

    {
    #if STK_SYNC_DEBUG_NAMES
        m_trace_name = name;
    #else
        (void)name;
    #endif
    }

---

The documentation for this class was generated from the following file:

• stk_common.h