hal::PinChangedEvent Class Reference

#include <hal_core/netlist/gate_library/enums/pin_event.h>

Collaboration diagram for hal::PinChangedEvent:

Public Member Functions
	PinChangedEvent (Module *m, PinEvent pev, u32 id)
Module *	get_module () const
u32	associated_data ()
void	send ()

Static Public Member Functions
static void	discard (Module *m)

Friends
class	PinChangedEventScope
class	PinChangedBulkScope
bool	pin_event_order (const PinChangedEvent &a, const PinChangedEvent &b)

Detailed Description

Wrapper class for core pin_changed events.

Events can be send immediately or stacked and send at according to their priority.

Definition at line 76 of file pin_event.h.

Constructor & Destructor Documentation

PinChangedEvent()

hal::PinChangedEvent::PinChangedEvent	(	Module *	m,
		PinEvent	pev,
		u32	id
	)

PinChangedEvent class for single event

Parameters

m	- The module comprising pins and pin groups
pev	- The pin event enum
id	- pin or pin group ID

Definition at line 32 of file pin_event.cpp.

Member Function Documentation

associated_data()

u32 hal::PinChangedEvent::associated_data

(

)

Return bitwise binary encoded PinEvent and ID 4LSB = The pin event enum as 4 bit int 28HSB = The ID as 28 bit int

Returns

The bitcode according to scheme above

Definition at line 71 of file pin_event.cpp.

Referenced by send().

discard()

void hal::PinChangedEvent::discard ( Module *  m )

static

Drops all events collected for a module without sending them. Must be called when a module gets destroyed so that no event refers to a dangling module.

Parameters

m	The module comprising pins and pin groups

Definition at line 57 of file pin_event.cpp.

get_module()

Module * hal::PinChangedEvent::get_module

(

)

const

Returns the module for which pins or pin groups have been changed

Returns

The module comprising pins and pin groups

Definition at line 66 of file pin_event.cpp.

send()

void hal::PinChangedEvent::send

(

)

Attempts to send event. If this routine or any calling routine wants to collect events the event gets written on stack instead.

Definition at line 36 of file pin_event.cpp.

References associated_data(), hal::Module::get_event_handler(), hal::EventHandler::notify(), and hal::ModuleEvent::pin_changed.

Referenced by hal::Module::assign_pin_to_group(), hal::Module::create_pin(), hal::Module::create_pin_group(), hal::Module::delete_pin_group(), hal::Module::move_pin_group(), hal::Module::move_pin_within_group(), hal::Module::set_pin_group_direction(), hal::Module::set_pin_group_name(), hal::Module::set_pin_group_type(), hal::Module::set_pin_name(), and hal::Module::set_pin_type().

Friends And Related Function Documentation

pin_event_order

bool pin_event_order ( const PinChangedEvent &  a, const PinChangedEvent &  b  )

friend

Function used by sort algorithm to organize events according to their priority.

Parameters

a	- Pin changed event A
b	- Pin changed event B

Returns

true if A should be handled before B, false otherwise.

Definition at line 76 of file pin_event.cpp.

PinChangedBulkScope

friend class PinChangedBulkScope

friend

Definition at line 80 of file pin_event.h.

PinChangedEventScope

friend class PinChangedEventScope

friend

Definition at line 79 of file pin_event.h.

---

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

• include/hal_core/netlist/gate_library/enums/pin_event.h
• src/netlist/gate_library/enums/pin_event.cpp