Inheritance diagram for core_example::Core:

[legend]

Collaboration diagram for core_example::Core:

[legend]

Classes
class	CoreParameterSet
	Parameters for Core model. More...

Public Member Functions
	Core (sparta::TreeNode node, const CoreParameterSet params)
	Core constructor.

Public Member Functions inherited from sparta::Unit
	Unit (TreeNode *rc, const std::string &name)
	Construct unit with a ResouceContainer.

	Unit (TreeNode *rc)
	Construct unit with a ResouceContainer.

virtual	~Unit ()
	Destroy!

void	setAutoPrecedence (bool auto_p)
	Turn off auto-precedence.

PortSet *	getPortSet ()
	Return the port set.

EventSet *	getEventSet ()
	Return the event set.

StatisticSet *	getStatisticSet ()
	Return the stat set.

Public Member Functions inherited from sparta::Resource
	Resource (TreeNode *rc)
	Construct resource with a resource container.

	Resource (TreeNode *rc, const std::string &name)
	Construct resource with a specific name and resource container.

	Resource (const std::string &name, const Clock *clk)
	Construct a Resource with the given name and clock having NO association with a resource container. This constructor is reserved for free-standing resources owned by other resources (not containers [TreeNodes])

virtual	~Resource ()
	Destroy!

const Clock *	getClock () const

Scheduler *	getScheduler (const bool must_exist=true) const

std::string	getName () const

TreeNode *	getContainer ()
	Gets the TreeNode (container) for this resource (if any)

const TreeNode *	getContainer () const
	Gets the TreeNode (container) for this resource (if any)

ResourceContainer *	getResourceContainer ()
	Gets the ResourceContainer for this resource (if any)

const ResourceContainer *	getResourceContainer () const
	Gets the ResourceContainer for this resource (if any)

virtual void	addLink (TreeNode *node, const std::string &label)

virtual void	activateLink (const std::string &label)

	Resource (const Resource &)=delete
	Disallow copying.

Resource &	operator= (const Resource &)=delete

Static Public Attributes
static constexpr char	name [] = "core_example_core"
	Name of this resource. Required by sparta::UnitFactory.

Static Public Attributes inherited from sparta::Unit
static constexpr const char *	INFO_LOG = "info"

static constexpr const char *	WARN_LOG = log::categories::WARN_STR

static constexpr const char *	DEBUG_LOG = log::categories::DEBUG_STR

Additional Inherited Members
Protected Member Functions inherited from sparta::Unit
virtual void	onBindTreeEarly_ () override

virtual void	onBindTreeLate_ () override
	Dump a dot.

Protected Attributes inherited from sparta::Unit
sparta::PortSet	unit_port_set_
	The Unit's Ports.

sparta::EventSet	unit_event_set_
	The Unit's event set.

sparta::StatisticSet	unit_stat_set_
	The Unit's statistic set.

log::MessageSource	info_logger_
	Default info logger.

log::MessageSource	warn_logger_
	Default warn logger.

log::MessageSource	debug_logger_
	Default debug logger.

Detailed Description

Definition at line 18 of file Core.hpp.

Constructor & Destructor Documentation

◆ Core()

core_example::Core::Core	(	sparta::TreeNode *	node,
		const CoreParameterSet *	params
	)

Core constructor.

Note: This signature is dictated by the sparta::UnitFactory created to contain this node. Generally,

Parameters

node	TreeNode that is creating this core (always a sparta::UnitTreeNode)
params	Fully configured and validated params, which were instantiate by the sparta::UnitFactory which is instnatiating this resource. Note that the type of params is the ParamsT argument of sparta::UnitFactory and defaults to this class' nested ParameterSet type, NOT sparta::ParameterSet.
ports	Fully configured ports for this component.

Definition at line 24 of file Core.cpp.

Here is the call graph for this function:

◆ ~Core()

core_example::Core::~Core ( )

inline

Definition at line 62 of file Core.hpp.

Member Data Documentation

◆ name

constexpr char core_example::Core::name[] = "core_example_core"

staticconstexpr

Name of this resource. Required by sparta::UnitFactory.

Definition at line 44 of file Core.hpp.

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

/github/workspace/sparta/example/CoreModel/src/Core.hpp
/github/workspace/sparta/example/CoreModel/src/Core.cpp

Classes

Public Member Functions