hal::StateComponent Class Reference

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

Inheritance diagram for hal::StateComponent:

Collaboration diagram for hal::StateComponent:

Public Member Functions
ComponentType	get_type () const override
std::vector< GateTypeComponent * >	get_components (const std::function< bool(const GateTypeComponent *)> &filter=nullptr) const override
const std::string &	get_state_identifier () const
void	set_state_identifier (const std::string &state_identifier)
const std::string &	get_neg_state_identifier () const
void	set_neg_state_identifier (const std::string &neg_state_identifier)
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< StateComponent >	create (std::unique_ptr< GateTypeComponent > component, const std::string &state_identifier, const std::string &neg_state_identifier)
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 the internal state of a sequential gate by naming its state and negated state identifiers.

Definition at line 38 of file state_component.h.

Member Function Documentation

create()

std::unique_ptr< StateComponent > hal::StateComponent::create ( std::unique_ptr< GateTypeComponent >  component, const std::string &  state_identifier, const std::string &  neg_state_identifier  )

static

Create a new StateComponent with given child component and the internal state identifiers.

Parameters

[in]	component	- Another component to be added as a child component.
[in]	state_identifier	- The identifier of the internal state.
[in]	neg_state_identifier	- The identifier of the negated internal state.

Returns

The StateComponent.

Definition at line 12 of file state_component.cpp.

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

get_components()

std::vector< GateTypeComponent * > hal::StateComponent::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 state_component.cpp.

get_neg_state_identifier()

const std::string & hal::StateComponent::get_neg_state_identifier

(

)

const

Get the identifier of the negated internal state.

Returns

The identifier of the negated internal state.

Definition at line 60 of file state_component.cpp.

Referenced by hal::gate_type_components_init(), and hal::verilator::converter::get_function_for_ff().

get_state_identifier()

const std::string & hal::StateComponent::get_state_identifier

(

)

const

Get the identifier of the internal state.

Returns

The identifier of the internal state.

Definition at line 50 of file state_component.cpp.

Referenced by hal::gate_type_components_init(), and hal::verilator::converter::get_function_for_ff().

get_type()

StateComponent::ComponentType hal::StateComponent::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 state_component.cpp.

is_class_of()

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

static

Check whether a component is a StateComponent.

Parameters

[in]

component

- The component to check.

Returns

true if component is a StateComponent, false otherwise.

Definition at line 22 of file state_component.cpp.

References hal::GateTypeComponent::get_type().

Referenced by hal::gate_type_components_init(), hal::StateWizardPage::setData(), and hal::GatelibraryFrameState::update().

set_neg_state_identifier()

void hal::StateComponent::set_neg_state_identifier

(

const std::string &

neg_state_identifier

)

Set the identifier of the negated internal state.

Parameters

[in]

neg_state_identifier

- The identifier of the negated internal state.

Definition at line 65 of file state_component.cpp.

Referenced by hal::gate_type_components_init().

set_state_identifier()

void hal::StateComponent::set_state_identifier

(

const std::string &

state_identifier

)

Set the identifier of the internal state.

Parameters

[in]

state_identifier

- The identifier of the internal state.

Definition at line 55 of file state_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/state_component.h
• src/netlist/gate_library/gate_type_component/state_component.cpp