Class for Signal (SIG) Events (see BTF Specification Chapter 2.3.6). More...

#include <btf_signal.h>

Public Types
enum class	Events { read , write , unknown }
	Possible types of Signal events. More...

Static Public Member Functions
static std::string	eventToString (Events ev)
	Converts the enum Events into string. More...

static Events	stringToEvent (const std::string &str)
	Converts a string into the enum Events. More...

Detailed Description

Class for Signal (SIG) Events (see BTF Specification Chapter 2.3.6).

A Signal (SIG) is basically an address in the memory of a micro-controller. This memory location contains a certain value, which can be accessed by a process instance if required.
So generally, a signal fulfills the function of naming the memory space, like a label. According to the stored value the process accessing it might change its behavior (READ).
Besides a process also a stimulus is able to write to the storage location and change the value of this label (WRITE).

Member Enumeration Documentation

◆ Events

enum btf::Signal::Events

strong

Possible types of Signal events.

Enumerator
read	The read event indicates that a signal (target) gets read by a process (source).
write	The write event indicates that a signal (target) gets written by a process or stimulus (source).
unknown	Default value.

Member Function Documentation

◆ eventToString()

std::string btf::Signal::eventToString ( Events ev )

static

Converts the enum Events into string.

Parameters

[in] ev Events enum that will be converted.

Returns: String if Events type is valid, else a fatal error is triggered.

Here is the caller graph for this function:

◆ stringToEvent()

Signal::Events btf::Signal::stringToEvent ( const std::string & str )

static

Converts a string into the enum Events.

Parameters

[in] str String that will be converted.

Returns: Events enum.