btftoolchain
Public Types | Static Public Member Functions | List of all members
btf::Stimulus Class Reference

Class for Stimulus (STIM) Events (see BTF Specification Chapter 2.3.1). More...

#include <stimulus.h>

Public Types

enum class  Events { trigger , unknown }
 Possible types of Stimulus 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 Stimulus (STIM) Events (see BTF Specification Chapter 2.3.1).

A Stimulus (STI) is used to represent interactions among the internal behavior and between the system and the surrounding environment.

Member Enumeration Documentation

◆ Events

enum btf::Stimulus::Events
strong

Possible types of Stimulus events.

Enumerator
trigger 

The trigger event indicates that the internal behavior or the surrounding environment triggers
the activation of a task/interrupt service routine or the setting of a signal value or OS-Event

unknown 

Default value.

Member Function Documentation

◆ eventToString()

std::string btf::Stimulus::eventToString ( Events  ev)
static

Converts the enum Events into string.

Parameters
[in]evEvents 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()

Stimulus::Events btf::Stimulus::stringToEvent ( const std::string &  str)
static

Converts a string into the enum Events.

Parameters
[in]strString that will be converted.
Returns
Events enum.
Here is the caller graph for this function:
The documentation for this class was generated from the following files: