C++ Device API Reference Manual
Reference documentation for the Simics C++ Device API.
 
Loading...
Searching...
No Matches
simics::EventInterface Class Referenceabstract

An event is required to implement the interface. More...

#include <event-interface.h>

Inheritance diagram for simics::EventInterface:
simics::Event simics::AfterEvent simics::CycleEvent< T > simics::StepEvent< T > simics::TimeEvent< T >

Public Member Functions

virtual ~EventInterface ()=default
 
virtual void callback (void *data)=0
 Called when the event expires.
 
virtual void destroy (void *data)=0
 Called when the event is removed from the queue without being called.
 
virtual attr_value_t get_value (void *data)=0
 Called to convert the event data into a value that can be saved in a configuration.
 
virtual void * set_value (attr_value_t value)=0
 Called to convert a configuration value into event data.
 
virtual char * describe (void *data) const =0
 Called to generate a human-readable description of the event to be used in the print-event-queue command.
 

Detailed Description

An event is required to implement the interface.

Constructor & Destructor Documentation

◆ ~EventInterface()

virtual simics::EventInterface::~EventInterface ( )
virtualdefault

Member Function Documentation

◆ callback()

virtual void simics::EventInterface::callback ( void *  data)
pure virtual

Called when the event expires.

Implemented in simics::AfterEvent.

◆ describe()

virtual char * simics::EventInterface::describe ( void *  data) const
pure virtual

Called to generate a human-readable description of the event to be used in the print-event-queue command.

Implemented in simics::Event.

◆ destroy()

virtual void simics::EventInterface::destroy ( void *  data)
pure virtual

Called when the event is removed from the queue without being called.

Implemented in simics::Event.

◆ get_value()

virtual attr_value_t simics::EventInterface::get_value ( void *  data)
pure virtual

Called to convert the event data into a value that can be saved in a configuration.

Implemented in simics::AfterEvent, and simics::Event.

◆ set_value()

virtual void * simics::EventInterface::set_value ( attr_value_t  value)
pure virtual

Called to convert a configuration value into event data.

Implemented in simics::AfterEvent, and simics::Event.


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