gem5::SignalSinkPort< State > Class Template Reference

#include <signal.hh>

Inheritance diagram for gem5::SignalSinkPort< State >:

Public Types
using	OnChangeFunc = std::function<void(const State &new_val)>

Public Member Functions
	SignalSinkPort (const std::string &_name, PortID _id=InvalidPortID)
const State &	state () const
void	onChange (OnChangeFunc func)
void	bind (Port &peer) override
	Attach to a peer port.
void	unbind () override
	Dettach from a peer port.
Public Member Functions inherited from gem5::Port
virtual	~Port ()
	Virtual destructor due to inheritance.
Port &	getPeer ()
	Return a reference to this port's peer.
const std::string	name () const
	Return port name (for DPRINTF).
PortID	getId () const
	Get the port id.
bool	isConnected () const
	Is this port currently connected to a peer?
void	takeOverFrom (Port *old)
	A utility function to make it easier to swap out ports.

Protected Member Functions
virtual void	set (const State &new_state, const bool bypass_on_change=false)
Protected Member Functions inherited from gem5::Port
void	reportUnbound () const
	Port (const std::string &_name, PortID _id)
	Abstract base class for ports.

Protected Attributes
OnChangeFunc	_onChange
Protected Attributes inherited from gem5::Port
const PortID	id
	A numeric identifier to distinguish ports in a vector, and set to InvalidPortID in case this port is not part of a vector.
Port *	_peer
	A pointer to this port's peer.
bool	_connected
	Whether this port is currently connected to a peer port.

Private Attributes
friend	SignalSourcePort< State >
SignalSourcePort< State > *	_source = nullptr
State	_state = {}

Detailed Description

template<typename State>
class gem5::SignalSinkPort< State >

Definition at line 43 of file signal.hh.

Member Typedef Documentation

OnChangeFunc

template<typename State>

using gem5::SignalSinkPort< State >::OnChangeFunc = std::function<void(const State &new_val)>

Definition at line 46 of file signal.hh.

Constructor & Destructor Documentation

SignalSinkPort()

template<typename State>

gem5::SignalSinkPort< State >::SignalSinkPort ( const std::string & _name, PortID _id = InvalidPortID )

inline

Definition at line 72 of file signal.hh.

References gem5::InvalidPortID, and gem5::Port::Port().

Member Function Documentation

bind()

template<typename State>

void gem5::SignalSinkPort< State >::bind ( Port & peer )

inlineoverridevirtual

Attach to a peer port.

Reimplemented from gem5::Port.

Definition at line 80 of file signal.hh.

References _source, _state, gem5::Port::bind(), fatal_if, gem5::Port::name(), and gem5::Port::Port().

onChange()

template<typename State>

void gem5::SignalSinkPort< State >::onChange ( OnChangeFunc func )

inline

Definition at line 77 of file signal.hh.

References _onChange.

set()

template<typename State>

virtual void gem5::SignalSinkPort< State >::set ( const State & new_state, const bool bypass_on_change = false )

inlineprotectedvirtual

Definition at line 59 of file signal.hh.

References _onChange, and _state.

state()

template<typename State>

const State & gem5::SignalSinkPort< State >::state ( ) const

inline

Definition at line 76 of file signal.hh.

References _state.

unbind()

template<typename State>

void gem5::SignalSinkPort< State >::unbind ( )

inlineoverridevirtual

Dettach from a peer port.

Reimplemented from gem5::Port.

Definition at line 90 of file signal.hh.

References _source, and gem5::Port::unbind().

Member Data Documentation

_onChange

template<typename State>

OnChangeFunc gem5::SignalSinkPort< State >::_onChange

protected

Definition at line 69 of file signal.hh.

Referenced by onChange(), and set().

_source

template<typename State>

SignalSourcePort<State>* gem5::SignalSinkPort< State >::_source = nullptr

private

Definition at line 51 of file signal.hh.

Referenced by bind(), and unbind().

_state

template<typename State>

State gem5::SignalSinkPort< State >::_state = {}

private

Definition at line 53 of file signal.hh.

Referenced by bind(), set(), and state().

SignalSourcePort< State >

template<typename State>

friend gem5::SignalSinkPort< State >::SignalSourcePort< State >

private

Definition at line 49 of file signal.hh.

---

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

• sim/signal.hh