The Sparta Modeling Framework
Loading...
Searching...
No Matches
core_example::ROB Class Reference
Inheritance diagram for core_example::ROB:
Collaboration diagram for core_example::ROB:

Classes

class  ROBParameterSet
 Parameters for ROB model. More...
 

Public Member Functions

 ROB (sparta::TreeNode *node, const ROBParameterSet *p)
 Constructor for ROB.
 
 ~ROB ()
 Destroy!
 
- 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.
 
PortSetgetPortSet ()
 Return the port set.
 
EventSetgetEventSet ()
 Return the event set.
 
StatisticSetgetStatisticSet ()
 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 ClockgetClock () const
 
SchedulergetScheduler (const bool must_exist=true) const
 
std::string getName () const
 
TreeNodegetContainer ()
 Gets the TreeNode (container) for this resource (if any)
 
const TreeNodegetContainer () const
 Gets the TreeNode (container) for this resource (if any)
 
ResourceContainergetResourceContainer ()
 Gets the ResourceContainer for this resource (if any)
 
const ResourceContainergetResourceContainer () 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.
 
Resourceoperator= (const Resource &)=delete
 

Static Public Attributes

static const char name [] = "rob"
 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 27 of file ROB.hpp.

Constructor & Destructor Documentation

◆ ROB()

core_example::ROB::ROB ( sparta::TreeNode node,
const ROBParameterSet p 
)

Constructor for ROB.

Parameters
nodeThe node that represents (has a pointer to) the ROB
pThe ROB's parameter set

In the constructor for the unit, it is expected that the user register the TypedPorts that this unit will need to perform work.

Definition at line 12 of file ROB.cpp.

Here is the call graph for this function:

◆ ~ROB()

core_example::ROB::~ROB ( )

Destroy!

Definition at line 55 of file ROB.cpp.

Member Data Documentation

◆ name

const char core_example::ROB::name = "rob"
static

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

Definition at line 60 of file ROB.hpp.


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