WireCell::ConfigManager Class Reference

#include <ConfigManager.h>

Public Types
typedef std::pair< std::string, std::string >	ClassInstance
	Return a list of all known configurables. More...

Public Member Functions
	ConfigManager ()
	~ConfigManager ()
void	extend (Configuration more)
	Extend current list of configuration objects with more. More...
int	add (Configuration &cfg)
int	add (Configuration &data, const std::string &type, const std::string &name="")
Configuration	all () const
	Return top-level, aggregate configuration. More...
Configuration	at (int index) const
int	index (const std::string &type, const std::string &name="") const
int	size () const
	Return the number of configuration objects. More...
Configuration	pop (int ind)
	Remove configuration at given index and return it. More...
std::vector< ClassInstance >	configurables () const

Private Attributes
Configuration	m_top

Detailed Description

Bundle up some policy for handling configuration.

Overall configuration object is a list of configuration objects for each configurable instance.

Each instance configuration is a dict with keys:

• type gives the registered class name
• name gives an instance name, ("" by default if omitted)
• data gives a type-specific Configuration dictionary for the instance.

Definition at line 20 of file ConfigManager.h.

Member Typedef Documentation

typedef std::pair<std::string, std::string> WireCell::ConfigManager::ClassInstance

Return a list of all known configurables.

Definition at line 52 of file ConfigManager.h.

Constructor & Destructor Documentation

ConfigManager::ConfigManager

(

)

Definition at line 8 of file ConfigManager.cxx.

    : m_top(Json::arrayValue)
{
}

ConfigManager::~ConfigManager

(

)

Definition at line 12 of file ConfigManager.cxx.

{
}

Member Function Documentation

int ConfigManager::add

(

Configuration &

cfg

)

Definition at line 39 of file ConfigManager.cxx.

{
    int ind = this->index(get<string>(cfg, "type"), get<string>(cfg, "name"));
    if (ind < 0) {
        ind = m_top.size();
    }
    m_top[ind] = cfg;
    return ind;
}

int ConfigManager::add	(	Configuration &	data,
		const std::string &	type,
		const std::string &	name = ""
	)

Definition at line 49 of file ConfigManager.cxx.

{
    Configuration cfg;
    cfg["data"] = payload;
    cfg["type"] = type;
    cfg["name"] = name;
    return add(cfg);
}

Configuration WireCell::ConfigManager::all ( ) const

inline

Return top-level, aggregate configuration.

Definition at line 37 of file ConfigManager.h.

{ return m_top; }

Configuration ConfigManager::at

(

int

index

)

const

Definition at line 58 of file ConfigManager.cxx.

{
    if (ind < 0 || ind >= size()) {
        return Configuration();
    }
    return m_top[ind];
}

std::vector< ConfigManager::ClassInstance > ConfigManager::configurables

(

)

const

Definition at line 66 of file ConfigManager.cxx.

{
    std::vector<ConfigManager::ClassInstance> ret;
    for (auto c : m_top) {
        ret.push_back(make_pair(get<string>(c, "type"), get<string>(c, "name")));
    }
    return ret;
}

void ConfigManager::extend

(

Configuration

more

)

Extend current list of configuration objects with more.

Definition at line 16 of file ConfigManager.cxx.

{
    m_top = append(m_top, more);
}

int ConfigManager::index	(	const std::string &	type,
		const std::string &	name = ""
	)		const

Return index of configuration for given class and instance names. If not found, returned index == -1;

Definition at line 22 of file ConfigManager.cxx.

{
    int ind = -1;
    for (auto c : m_top) {
        ++ind;
        if (get<string>(c, "type") != type) {
            continue;
        }
        if (get<string>(c, "name") != name) {
            continue;
        }
        return ind;
    }
    return -1;

}

Configuration ConfigManager::pop

(

int

ind

)

Remove configuration at given index and return it.

Definition at line 75 of file ConfigManager.cxx.

{
    if (ind < 0 || ind >= size()) {
        return Configuration();
    }
    Configuration ret;
    Configuration reduced(Json::arrayValue);
    int siz = size();
    for (int i=0; i<siz; ++i) {
        if (i == ind) {
            ret = m_top[i];
        }
        else {
            reduced.append(m_top[i]);
        }
    }
    m_top = reduced;
    return ret;
}

int WireCell::ConfigManager::size ( void  ) const

inline

Return the number of configuration objects.

Definition at line 46 of file ConfigManager.h.

{ return m_top.size(); }

Member Data Documentation

Configuration WireCell::ConfigManager::m_top

private

Definition at line 21 of file ConfigManager.h.

---

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

• wire-cell-build/util/inc/WireCellUtil/ConfigManager.h
• wire-cell-build/util/src/ConfigManager.cxx