btftoolchain
btf::Simulation Class Reference

Class for the Simulation (SIM) events. More...

#include <simulation.h>

Public Types

enum class  Events { tag , unknown }
 Possible types of simulation 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 the Simulation (SIM) events.

Simulation events provide additional information, such as model information from the simulation environment.

Member Enumeration Documentation

◆ Events

Possible types of simulation events.

Enumerator
tag 

The tag event is used to annotate the BTF trace with system and model information.

unknown 

Default value.

Member Function Documentation

◆ eventToString()

std::string btf::Simulation::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()

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

Converts a string into the enum Events.

Parameters
[in]strString that will be converted.
Returns
Events enum.

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