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

#include <after.h>

Inheritance diagram for simics::AfterEvent:
simics::Event simics::EventInterface

Public Member Functions

void callback (void *data) override
 Called when the event expires.
 
attr_value_t get_value (void *data) override
 Called to convert the event data into a value that can be saved in a configuration.
 
void * set_value (attr_value_t value) override
 Called to convert a configuration value into event data.
 
void remove (void *=nullptr) const
 
void post (double seconds, void *data=nullptr)
 
void post (cycles_t cycles, void *data=nullptr)
 
 Event (ConfObject *obj, event_class_t *ev)
 
 Event (ConfObject *obj, const std::string &name)
 
- Public Member Functions inherited from simics::Event
 Event (ConfObject *obj, event_class_t *ev)
 
 Event (ConfObject *obj, const std::string &name)
 
void destroy (void *data) override
 Called when the event is removed from the queue without being called.
 
attr_value_t get_value (void *data) override
 Called to convert the event data into a value that can be saved in a configuration.
 
void * set_value (attr_value_t value) override
 Called to convert a configuration value into event data.
 
char * describe (void *data) const override
 Called to generate a human-readable description of the event to be used in the print-event-queue command.
 
 operator event_class_t * () const
 
- Public Member Functions inherited from simics::EventInterface
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.
 

Additional Inherited Members

- Protected Member Functions inherited from simics::Event
template<typename T >
T * device_ptr () const
 
const char * name () const
 
- Static Protected Member Functions inherited from simics::Event
static int pointer_eq (void *data, void *match_data)
 
- Protected Attributes inherited from simics::Event
ConfObjectobj_ {nullptr}
 
event_class_t * ev_ {nullptr}
 
conf_object_t * clock_ {nullptr}
 clock_ cannot be initialized here by SIM_object_clock, since attribute queue is not set yet
 

Member Function Documentation

◆ callback()

void simics::AfterEvent::callback ( void *  data)
overridevirtual

Called when the event expires.

Implements simics::EventInterface.

◆ Event() [1/2]

simics::Event::Event ( ConfObject obj,
const std::string &  name 
)
Parameters
nameis the name of the event class registered

◆ Event() [2/2]

simics::Event::Event ( ConfObject obj,
event_class_t *  ev 
)
Parameters
objshould be an instance of the same class the event is registered on
evshould be pointed to the registered Simics event class (e.g., SIM_register_event)

◆ get_value()

attr_value_t simics::AfterEvent::get_value ( void *  data)
overridevirtual

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

Implements simics::EventInterface.

◆ post() [1/2]

void simics::AfterEvent::post ( cycles_t  cycles,
void *  data = nullptr 
)

◆ post() [2/2]

void simics::AfterEvent::post ( double  seconds,
void *  data = nullptr 
)

◆ remove()

void simics::AfterEvent::remove ( void *  = nullptr) const

◆ set_value()

void * simics::AfterEvent::set_value ( attr_value_t  value)
overridevirtual

Called to convert a configuration value into event data.

Implements simics::EventInterface.


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