tpglibs::ProcessorInternalStateNameRegistry< T > Class Template Reference

Registry of internal state names. More...

#include <ProcessorInternalStateNameRegistry.hpp>

Public Types
using	signal_t = T
	Signal type to use. Generally __m256i or std::array<int16_t, 16>;.

Public Member Functions
	ProcessorInternalStateNameRegistry ()=default
	Constructor.
	~ProcessorInternalStateNameRegistry ()
	Destructor.
	ProcessorInternalStateNameRegistry (const ProcessorInternalStateNameRegistry &)=delete
ProcessorInternalStateNameRegistry &	operator= (const ProcessorInternalStateNameRegistry &)=delete
	ProcessorInternalStateNameRegistry (ProcessorInternalStateNameRegistry &&)=default
ProcessorInternalStateNameRegistry &	operator= (ProcessorInternalStateNameRegistry &&)=default
size_t	get_number_of_requested_internal_states ()
	Get the number of requested internal states.
std::vector< std::string >	get_names_of_requested_internal_states () const
	Get the names of the requested internal states.
void	parse_requested_internal_state_items (std::string config_string)
	Parse the requested internal state items from a configuration string.
void	register_internal_state (std::string name, std::shared_ptr< signal_t > pointer_to_state)
	Register an internal state.
std::shared_ptr< signal_t >	get_internal_state_item_ptr (std::string name)
	Get a pointer to an internal state item.
std::vector< std::shared_ptr< signal_t > >	get_all_requested_internal_state_item_ptrs ()
	Get a vector of pointers to all internal state items.
bool	is_registered (const std::string &name) const
	Check if an internal state name is registered.
bool	is_requested (const std::string &name) const
	Check if an internal state name is requested.

Protected Member Functions
std::vector< std::string >	get_all_registered_internal_state_names ()
	Get all registered internal state names.
void	clear ()
	Clear the registry.

Private Attributes
std::unordered_map< std::string, std::shared_ptr< signal_t > >	m_internal_state_map
	Map of internal state names to pointers.
std::vector< std::string >	m_requested_internal_state_names
	Vector of all requested internal state names.

Detailed Description

template<typename T>
class tpglibs::ProcessorInternalStateNameRegistry< T >

Registry of internal state names.

Definition at line 27 of file ProcessorInternalStateNameRegistry.hpp.

Member Typedef Documentation

signal_t

template<typename T >

using tpglibs::ProcessorInternalStateNameRegistry< T >::signal_t = T

Signal type to use. Generally __m256i or std::array<int16_t, 16>;.

Definition at line 30 of file ProcessorInternalStateNameRegistry.hpp.

Constructor & Destructor Documentation

ProcessorInternalStateNameRegistry() [1/3]

template<typename T >

tpglibs::ProcessorInternalStateNameRegistry< T >::ProcessorInternalStateNameRegistry ( )

default

Constructor.

~ProcessorInternalStateNameRegistry()

template<typename T >

tpglibs::ProcessorInternalStateNameRegistry< T >::~ProcessorInternalStateNameRegistry

(

)

Destructor.

Definition at line 130 of file ProcessorInternalStateNameRegistry.hpp.

                                                                               {
        clear();
    }

ProcessorInternalStateNameRegistry() [2/3]

template<typename T >

tpglibs::ProcessorInternalStateNameRegistry< T >::ProcessorInternalStateNameRegistry ( const ProcessorInternalStateNameRegistry< T > & )

delete

ProcessorInternalStateNameRegistry() [3/3]

template<typename T >

tpglibs::ProcessorInternalStateNameRegistry< T >::ProcessorInternalStateNameRegistry ( ProcessorInternalStateNameRegistry< T > && )

default

Member Function Documentation

clear()

template<typename T >

void tpglibs::ProcessorInternalStateNameRegistry< T >::clear ( )

protected

Clear the registry.

Definition at line 210 of file ProcessorInternalStateNameRegistry.hpp.

                                                      {
        // reinitialize member variables
        m_internal_state_map.clear();
        m_requested_internal_state_names.clear();
    }

get_all_registered_internal_state_names()

template<typename T >

std::vector< std::string > tpglibs::ProcessorInternalStateNameRegistry< T >::get_all_registered_internal_state_names ( )

protected

Get all registered internal state names.

Returns

A vector of all registered internal state names.

Definition at line 156 of file ProcessorInternalStateNameRegistry.hpp.

                                                                                                        {
        std::vector<std::string> names;
        for (const auto& item : m_internal_state_map) {
            names.push_back(item.first);
        }
        return names;
    }

get_all_requested_internal_state_item_ptrs()

template<typename T >

std::vector< std::shared_ptr< typename ProcessorInternalStateNameRegistry< T >::signal_t > > tpglibs::ProcessorInternalStateNameRegistry< T >::get_all_requested_internal_state_item_ptrs

(

)

Get a vector of pointers to all internal state items.

Returns

A vector of pointers to all internal state items.

Definition at line 218 of file ProcessorInternalStateNameRegistry.hpp.

                                                                                      {
        std::vector<std::shared_ptr<typename ProcessorInternalStateNameRegistry<T>::signal_t>> item_ptrs;
        for (const auto& item : m_requested_internal_state_names) {
            item_ptrs.push_back(m_internal_state_map[item]);
        }
        return item_ptrs;
    }

get_internal_state_item_ptr()

template<typename T >

std::shared_ptr< typename ProcessorInternalStateNameRegistry< T >::signal_t > tpglibs::ProcessorInternalStateNameRegistry< T >::get_internal_state_item_ptr

(

std::string

name

)

Get a pointer to an internal state item.

Parameters

name	The name of the internal state.

Returns

A pointer to the internal state item.

Definition at line 151 of file ProcessorInternalStateNameRegistry.hpp.

                                                                                     {
        return m_internal_state_map[name];
    }

get_names_of_requested_internal_states()

template<typename T >

std::vector< std::string > tpglibs::ProcessorInternalStateNameRegistry< T >::get_names_of_requested_internal_states

(

)

const

Get the names of the requested internal states.

Returns

The names of the requested internal states.

Definition at line 140 of file ProcessorInternalStateNameRegistry.hpp.

                                                                                                             {
        return m_requested_internal_state_names;
    }

get_number_of_requested_internal_states()

template<typename T >

size_t tpglibs::ProcessorInternalStateNameRegistry< T >::get_number_of_requested_internal_states

(

)

Get the number of requested internal states.

Returns

The number of requested internal states.

Definition at line 135 of file ProcessorInternalStateNameRegistry.hpp.

                                                                                          {
        return m_requested_internal_state_names.size();
    }

is_registered()

template<typename T >

bool tpglibs::ProcessorInternalStateNameRegistry< T >::is_registered

(

const std::string &

name

)

const

Check if an internal state name is registered.

Parameters

name	The name to check.

Returns

True if the name is registered, false otherwise.

Definition at line 227 of file ProcessorInternalStateNameRegistry.hpp.

                                                                                         {
        return m_internal_state_map.find(name) != m_internal_state_map.end();
    }

is_requested()

template<typename T >

bool tpglibs::ProcessorInternalStateNameRegistry< T >::is_requested

(

const std::string &

name

)

const

Check if an internal state name is requested.

Parameters

name	The name to check.

Returns

True if the name is in the requested list, false otherwise.

Definition at line 232 of file ProcessorInternalStateNameRegistry.hpp.

                                                                                        {
        for (const auto& requested_name : m_requested_internal_state_names) {
            if (requested_name == name) {
                return true;
            }
        }
        return false;
    }

operator=() [1/2]

template<typename T >

ProcessorInternalStateNameRegistry & tpglibs::ProcessorInternalStateNameRegistry< T >::operator= ( const ProcessorInternalStateNameRegistry< T > & )

delete

operator=() [2/2]

template<typename T >

ProcessorInternalStateNameRegistry & tpglibs::ProcessorInternalStateNameRegistry< T >::operator= ( ProcessorInternalStateNameRegistry< T > && )

default

parse_requested_internal_state_items()

template<typename T >

void tpglibs::ProcessorInternalStateNameRegistry< T >::parse_requested_internal_state_items

(

std::string

config_string

)

Parse the requested internal state items from a configuration string.

Parameters

config_string

The configuration string.

Definition at line 165 of file ProcessorInternalStateNameRegistry.hpp.

                                                                                                            {
        // Clear existing requested names first
        m_requested_internal_state_names.clear();
        
        if (config_string.empty()) {
            return;
        }
        
        // Parse comma-separated items
        std::string::size_type start = 0;
        std::string::size_type end = config_string.find(',');
        
        while (end != std::string::npos) {
            // Extract item name and trim whitespace
            std::string item_name = config_string.substr(start, end - start);
            
            // Trim leading and trailing whitespace
            item_name.erase(0, item_name.find_first_not_of(" \t\r\n"));
            item_name.erase(item_name.find_last_not_of(" \t\r\n") + 1);
            
            // Only add non-empty item names
            if (!item_name.empty()) {
                m_requested_internal_state_names.push_back(item_name);
            }
            
            start = end + 1;
            end = config_string.find(',', start);
        }
        
        // Handle the last item (after the final comma or if there are no commas)
        if (start < config_string.length()) {
            std::string last_item = config_string.substr(start);
            
            // Trim leading and trailing whitespace
            last_item.erase(0, last_item.find_first_not_of(" \t\r\n"));
            last_item.erase(last_item.find_last_not_of(" \t\r\n") + 1);
            
            // Only add non-empty item names
            if (!last_item.empty()) {
                m_requested_internal_state_names.push_back(last_item);
            }
        }
    }

register_internal_state()

template<typename T >

void tpglibs::ProcessorInternalStateNameRegistry< T >::register_internal_state	(	std::string	name,
		std::shared_ptr< signal_t >	pointer_to_state )

Register an internal state.

Parameters

name	The name of the internal state.
pointer_to_state	A pointer to the internal state item.

Definition at line 145 of file ProcessorInternalStateNameRegistry.hpp.

                                                                                                                                {
        m_internal_state_map[name] = pointer_to_state;
    }

Member Data Documentation

m_internal_state_map

template<typename T >

std::unordered_map<std::string, std::shared_ptr<signal_t> > tpglibs::ProcessorInternalStateNameRegistry< T >::m_internal_state_map

private

Map of internal state names to pointers.

Definition at line 121 of file ProcessorInternalStateNameRegistry.hpp.

m_requested_internal_state_names

template<typename T >

std::vector<std::string> tpglibs::ProcessorInternalStateNameRegistry< T >::m_requested_internal_state_names

private

Vector of all requested internal state names.

Definition at line 124 of file ProcessorInternalStateNameRegistry.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/tpglibs/include/tpglibs/ProcessorInternalStateNameRegistry.hpp