register_obj Class Reference

class modeling a register object More...

#include <register_obj.hpp>

Inheritance diagram for register_obj:

Collaboration diagram for register_obj:

Public Member Functions
	register_obj (const unsigned int index)
	This is the constructor of the object class, with a given id. More...
	~register_obj () override=default
	Destructor. More...
generic_objRef	get_wr_enable () const
	Gets the write enable object for the given register. More...
void	set_wr_enable (const generic_objRef &wr_en)
	Sets the write enable for given register. More...
unsigned int	get_register_index ()
	Gets the index of the register represented by this object. More...
Public Member Functions inherited from generic_obj
	generic_obj (const resource_type t, const std::string &_name)
	This is the constructor of the object class. More...
virtual	~generic_obj ()=default
	Destructor. More...
void	print (std::ostream &os) const
	Prints elements into given stream. More...
const std::string	get_string () const
	Returns the name associated with the element. More...
unsigned int	get_type () const
	Return generic_obj type. More...
void	set_structural_obj (const structural_objectRef &SM_)
	Sets structural_object associated to this object. More...
void	set_out_sign (const structural_objectRef &out_sign_)
	Sets structural_object of output signal associated to this object. More...
const structural_objectRef	get_structural_obj () const
	Gets structural_object associated to this object. More...
const structural_objectRef	get_out_sign () const
	Gets structural_object of output signal associated to this object. More...
bool	operator< (const generic_obj &other) const

Private Attributes
generic_objRef	wr_enable
unsigned int	register_index

Additional Inherited Members
Public Types inherited from generic_obj
enum	resource_type {   FUNCTIONAL_UNIT = 0, REGISTER, MULTI_UNBOUNDED_OBJ, COMMAND_PORT,   DATA_PORT, CONNECTION_ELEMENT, ADDER_CONN_OBJ, UU_CONV_CONN_OBJ,   UI_CONV_CONN_OBJ, IU_CONV_CONN_OBJ, II_CONV_CONN_OBJ, FF_CONV_CONN_OBJ,   I_ASSIGN_CONN_OBJ, U_ASSIGN_CONN_OBJ, F_ASSIGN_CONN_OBJ }
	Admissible resource types. More...
Protected Attributes inherited from generic_obj
const resource_type	type
	type of resource More...
Wrefcount< structural_object >	SM
	structural_object associated to element More...
Wrefcount< structural_object >	out_sign
	output signal associated to element. More...
std::string	name
	connection obj id More...

Detailed Description

class modeling a register object

Definition at line 56 of file register_obj.hpp.

Constructor & Destructor Documentation

register_obj()

register_obj::register_obj ( const unsigned int  index )

inlineexplicit

This is the constructor of the object class, with a given id.

Parameters

new_value

is the new value for register entry

Definition at line 68 of file register_obj.hpp.

References index, and ~register_obj().

Here is the call graph for this function:

~register_obj()

register_obj::~register_obj ( )

overridedefault

Destructor.

Referenced by register_obj().

Here is the caller graph for this function:

Member Function Documentation

get_register_index()

unsigned int register_obj::get_register_index ( )

inline

Gets the index of the register represented by this object.

Returns

the index of the represented register

Definition at line 100 of file register_obj.hpp.

References register_index.

get_wr_enable()

generic_objRef register_obj::get_wr_enable ( ) const

inline

Gets the write enable object for the given register.

Returns

a set of sets where each of them can enable register write (when all conditions contained are true)

Definition at line 83 of file register_obj.hpp.

References wr_enable.

set_wr_enable()

void register_obj::set_wr_enable ( const generic_objRef &  wr_en )

inline

Sets the write enable for given register.

Definition at line 91 of file register_obj.hpp.

Field Documentation

register_index

unsigned int register_obj::register_index

private

Definition at line 61 of file register_obj.hpp.

Referenced by get_register_index().

wr_enable

generic_objRef register_obj::wr_enable

private

Definition at line 58 of file register_obj.hpp.

Referenced by get_wr_enable().

---

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

• /workspace/src/HLS/virtual_components/register_obj.hpp