hal::RAMComponent Class Reference

#include <hal_core/netlist/gate_library/gate_type_component/ram_component.h>

Inheritance diagram for hal::RAMComponent:

Collaboration diagram for hal::RAMComponent:

Public Member Functions
ComponentType	get_type () const override
std::vector< GateTypeComponent * >	get_components (const std::function< bool(const GateTypeComponent *)> &filter=nullptr) const override
u32	get_bit_size () const
void	set_bit_size (const u32 bit_size)
const std::vector< std::string > &	get_init_identifiers () const
void	set_init_identifiers (const std::vector< std::string > &init_identifiers)
Public Member Functions inherited from hal::GateTypeComponent
virtual	~GateTypeComponent ()=default
template<typename T >
T *	convert_to ()
template<typename T >
const T *	convert_to () const
GateTypeComponent *	get_component (const std::function< bool(const GateTypeComponent *)> &filter=nullptr) const
template<typename T >
T *	get_component_as (const std::function< bool(const GateTypeComponent *)> &filter=nullptr)

Static Public Member Functions
static std::unique_ptr< RAMComponent >	create (std::unique_ptr< GateTypeComponent > component, const u32 bit_size, const std::vector< std::string > &init_identifiers={})
static bool	is_class_of (const GateTypeComponent *component)

Additional Inherited Members
Public Types inherited from hal::GateTypeComponent
enum class	ComponentType {   lut , ff , latch , ram ,   mac , init , state , ram_port ,   state_table }

Detailed Description

A gate type component that describes a random access memory, in particular its size in bits.

Definition at line 38 of file ram_component.h.

Member Function Documentation

create()

std::unique_ptr< RAMComponent > hal::RAMComponent::create ( std::unique_ptr< GateTypeComponent >  component, const u32  bit_size, const std::vector< std::string > &  init_identifiers = {}  )

static

Create a new RAMComponent with given child component.

Parameters

[in]	component	- Another component to be added as a child component.
[in]	bit_size	- The size of the RAM in bits.
[in]	init_identifiers	- The parameter names for initialization data.

Returns

The RAMComponent.

Definition at line 12 of file ram_component.cpp.

Referenced by hal::GateLibraryWizard::setComponents().

get_bit_size()

u32 hal::RAMComponent::get_bit_size

(

)

const

Get the size of the RAM in bits.

Returns

The size of the RAM in bits.

Definition at line 50 of file ram_component.cpp.

Referenced by hal::gate_type_components_init().

get_components()

std::vector< GateTypeComponent * > hal::RAMComponent::get_components ( const std::function< bool(const GateTypeComponent *)> &  filter = nullptr ) const

overridevirtual

Get the sub-components of the gate type component. A user-defined filter may be applied to the result vector, but is disabled by default.

Parameters

[in]

filter

- The user-defined filter function applied to all candidate components.

Returns

The sub-components of the gate type component.

Implements hal::GateTypeComponent.

Definition at line 27 of file ram_component.cpp.

get_init_identifiers()

const std::vector< std::string > & hal::RAMComponent::get_init_identifiers

(

)

const

Get the parameter names used to find initialization data.

Returns

The vector of init identifier strings.

Definition at line 60 of file ram_component.cpp.

Referenced by hal::gate_type_components_init().

get_type()

RAMComponent::ComponentType hal::RAMComponent::get_type ( ) const

overridevirtual

Get the type of the gate type component.

Returns

The type of the gate type component.

Implements hal::GateTypeComponent.

Definition at line 17 of file ram_component.cpp.

is_class_of()

bool hal::RAMComponent::is_class_of ( const GateTypeComponent *  component )

static

Check whether a component is a RAMComponent.

Parameters

[in]

component

- The component to check.

Returns

true if component is a RAMComponent, false otherwise.

Definition at line 22 of file ram_component.cpp.

References hal::GateTypeComponent::get_type().

Referenced by hal::gate_type_components_init(), hal::RAMWizardPage::setData(), and hal::GateLibraryFrameRAM::update().

set_bit_size()

void hal::RAMComponent::set_bit_size

(

const u32

bit_size

)

Set the size of the RAM in bits.

Parameters

[in]

bit_size

- The size of the RAM in bits.

Definition at line 55 of file ram_component.cpp.

Referenced by hal::gate_type_components_init().

set_init_identifiers()

void hal::RAMComponent::set_init_identifiers

(

const std::vector< std::string > &

init_identifiers

)

Set the parameter names used to find initialization data.

Parameters

[in]

init_identifiers

- The vector of init identifier strings.

Definition at line 65 of file ram_component.cpp.

Referenced by hal::gate_type_components_init().

---

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

• include/hal_core/netlist/gate_library/gate_type_component/ram_component.h
• src/netlist/gate_library/gate_type_component/ram_component.cpp