scc::ticking_clock< BASE > Class Template Reference

The ticking_clock class is a mixin that provides ticking clock functionality. More...

#include <clock_if_mixins.h>

Inheritance diagram for scc::ticking_clock< BASE >:

Collaboration diagram for scc::ticking_clock< BASE >:

Public Member Functions
	ticking_clock (sc_core::sc_module_name const &nm)
	Constructor for the ticking_clock class.
template<typename... Args>
	ticking_clock (sc_core::sc_module_name const &nm, Args &&... args)
	Constructor for the ticking_clock class with variable number of arguments.
virtual	~ticking_clock ()=default
	Virtual destructor for the tickless_clock class.

Public Attributes
sc_core::sc_in< bool >	clk_i {"clk_i"}
	An input port for the clock signal.

Protected Member Functions
void	end_of_elaboration () override
	Method called at the end of elaboration.

Detailed Description

template<typename BASE>
class scc::ticking_clock< BASE >

The ticking_clock class is a mixin that provides ticking clock functionality.

The ticking_clock class is a template class that inherits from a base class. It adds ticking clock functionality to the base class by monitoring an input clock signal.

Template Parameters

BASE	The base class to which the ticking clock functionality will be added.

Definition at line 35 of file clock_if_mixins.h.

Constructor & Destructor Documentation

ticking_clock() [1/2]

template<typename BASE>

scc::ticking_clock< BASE >::ticking_clock ( sc_core::sc_module_name const & nm )

inline

Constructor for the ticking_clock class.

Parameters

nm	The name of the ticking_clock instance.

Definition at line 53 of file clock_if_mixins.h.

ticking_clock() [2/2]

template<typename BASE>

template<typename... Args>

scc::ticking_clock< BASE >::ticking_clock ( sc_core::sc_module_name const & nm, Args &&... args )

inline

Constructor for the ticking_clock class with variable number of arguments.

Parameters

nm	The name of the ticking_clock instance.
args	Template arguments for the base class constructor.

Definition at line 62 of file clock_if_mixins.h.

Member Function Documentation

end_of_elaboration()

template<typename BASE>

void scc::ticking_clock< BASE >::end_of_elaboration ( )

inlineoverrideprotected

Method called at the end of elaboration.

This method is responsible for setting the clock period based on the input clock signal.

Definition at line 75 of file clock_if_mixins.h.

Member Data Documentation

clk_i

template<typename BASE>

sc_core::sc_in<bool> scc::ticking_clock< BASE >::clk_i {"clk_i"}

An input port for the clock signal.

This input port is used to monitor the clock signal and provide ticking clock functionality.

Definition at line 47 of file clock_if_mixins.h.

---

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

• /home/eyck/Projects/MINRES/SystemC-Components/src/components/scc/clock_if_mixins.h