subsystem_controllers::EntryManager Class Reference

An entry manager keeps track of the set of entries and makes it easy to add or remove entries. More...

#include <entry_manager.h>

Collaboration diagram for subsystem_controllers::EntryManager:

Public Member Functions
	EntryManager ()=default
	Default constructor for EntryManager. More...
void	update_entry (const Entry &entry)
	Add a new entry if the given name does not exist. Update an existing entry if the given name exists. More...
std::vector< Entry >	get_entries () const
	Get all entries as a list. More...
std::vector< std::string >	get_entry_names () const
	Get all entry names as a list. More...
boost::optional< Entry >	get_entry_by_name (const std::string &name) const
	Get a entry using name as the key. More...
void	delete_entry (const std::string &name)
	Delete an entry using the given name as the key. More...

Private Attributes
std::unordered_map< std::string, Entry >	entry_map_
	private map by entry name to keep track of all entries More...

Detailed Description

An entry manager keeps track of the set of entries and makes it easy to add or remove entries.

Definition at line 29 of file entry_manager.h.

Constructor & Destructor Documentation

EntryManager()

subsystem_controllers::EntryManager::EntryManager ( )

default

Default constructor for EntryManager.

Member Function Documentation

delete_entry()

void subsystem_controllers::EntryManager::delete_entry

(

const std::string &

name

)

Delete an entry using the given name as the key.

Definition at line 51 of file entry_manager.cpp.

    {
        if (entry_map_.find(name) != entry_map_.end())
            entry_map_.erase(name);
    }

References entry_map_.

get_entries()

std::vector< Entry > subsystem_controllers::EntryManager::get_entries

(

)

const

Get all entries as a list.

Definition at line 28 of file entry_manager.cpp.

    {
        // returns the copy of the original data
        std::vector<Entry> entries;
        entries.reserve(entry_map_.size());
 
        for (const auto& e : entry_map_)
            entries.push_back(e.second);
 
        return entries;
    }

References entry_map_.

Referenced by subsystem_controllers::PluginManager::activate(), subsystem_controllers::PluginManager::cleanup(), subsystem_controllers::PluginManager::configure(), subsystem_controllers::PluginManager::deactivate(), subsystem_controllers::PluginManager::get_active_plugins(), subsystem_controllers::PluginManager::get_control_plugins_by_capability(), subsystem_controllers::PluginManager::get_registered_plugins(), subsystem_controllers::PluginManager::get_strategic_plugins_by_capability(), and subsystem_controllers::PluginManager::get_tactical_plugins_by_capability().

Here is the caller graph for this function:

get_entry_by_name()

boost::optional< Entry > subsystem_controllers::EntryManager::get_entry_by_name

(

const std::string &

name

)

const

Get a entry using name as the key.

Definition at line 57 of file entry_manager.cpp.

    {
        if (entry_map_.find(name) != entry_map_.end())
            return entry_map_.at(name);
 
 
        // use boost::optional because requested entry might not exist
        return boost::none;
    }

References entry_map_.

Referenced by subsystem_controllers::PluginManager::activate_plugin(), and subsystem_controllers::PluginManager::update_plugin_status().

Here is the caller graph for this function:

get_entry_names()

std::vector< std::string > subsystem_controllers::EntryManager::get_entry_names

(

)

const

Get all entry names as a list.

Definition at line 40 of file entry_manager.cpp.

    {
        std::vector<std::string> names;
        names.reserve(entry_map_.size());
 
        for (const auto& e : entry_map_)
            names.push_back(e.second.name_);
        
        return names;
    }

References entry_map_.

Referenced by subsystem_controllers::PluginManager::shutdown().

Here is the caller graph for this function:

update_entry()

void subsystem_controllers::EntryManager::update_entry

(

const Entry &

entry

)

Add a new entry if the given name does not exist. Update an existing entry if the given name exists.

Parameters

entry

The entry to update or add

Definition at line 22 of file entry_manager.cpp.

    {
        entry_map_[entry.name_] = entry;
    }

References entry_map_, and subsystem_controllers::Entry::name_.

Referenced by subsystem_controllers::PluginManager::PluginManager(), subsystem_controllers::PluginManager::activate(), subsystem_controllers::PluginManager::activate_plugin(), subsystem_controllers::PluginManager::add_plugin(), subsystem_controllers::PluginManager::cleanup(), subsystem_controllers::PluginManager::configure(), subsystem_controllers::PluginManager::deactivate(), and subsystem_controllers::PluginManager::update_plugin_status().

Here is the caller graph for this function:

Member Data Documentation

entry_map_

std::unordered_map<std::string, Entry> subsystem_controllers::EntryManager::entry_map_

private

private map by entry name to keep track of all entries

Definition at line 69 of file entry_manager.h.

Referenced by delete_entry(), get_entries(), get_entry_by_name(), get_entry_names(), and update_entry().

---

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

• subsystem_controllers/include/subsystem_controllers/guidance_controller/entry_manager.h
• subsystem_controllers/src/guidance_controller/entry_manager.cpp