podio::CollectionIDTable Class Reference

#include <CollectionIDTable.h>

Public Member Functions
	CollectionIDTable ()
	~CollectionIDTable ()=default
	CollectionIDTable (const CollectionIDTable &)=delete
CollectionIDTable &	operator= (const CollectionIDTable &)=delete
	CollectionIDTable (CollectionIDTable &&)=default
CollectionIDTable &	operator= (CollectionIDTable &&)=default
	CollectionIDTable (std::vector< int > &&ids, std::vector< std::string > &&names)
	constructor from existing ID:name mapping
	CollectionIDTable (const std::vector< int > &ids, const std::vector< std::string > &names)
int	collectionID (const std::string &name) const
	return collection ID for given name
const std::string	name (int collectionID) const
	return name for given collection ID
bool	present (const std::string &name) const
	Check if collection name is known.
const std::vector< std::string > &	names () const
	return registered names
const std::vector< int > &	ids () const
	return the ids
int	add (const std::string &name)
void	print () const
	Prints collection information.
bool	empty () const
	Does this table hold any information?

Detailed Description

Definition at line 11 of file CollectionIDTable.h.

Constructor & Destructor Documentation

CollectionIDTable() [1/5]

podio::CollectionIDTable::CollectionIDTable

(

)

Definition at line 8 of file CollectionIDTable.cc.

                                     : m_mutex(std::make_unique<std::mutex>()) {
}

~CollectionIDTable()

podio::CollectionIDTable::~CollectionIDTable ( )

default

CollectionIDTable() [2/5]

podio::CollectionIDTable::CollectionIDTable ( const CollectionIDTable &  )

delete

CollectionIDTable() [3/5]

podio::CollectionIDTable::CollectionIDTable ( CollectionIDTable &&  )

default

CollectionIDTable() [4/5]

podio::CollectionIDTable::CollectionIDTable	(	std::vector< int > &&	ids,
		std::vector< std::string > &&	names
	)

constructor from existing ID:name mapping

Definition at line 11 of file CollectionIDTable.cc.

                                                                                       :
    m_collectionIDs(std::move(ids)), m_names(std::move(names)), m_mutex(std::make_unique<std::mutex>()) {
}

CollectionIDTable() [5/5]

podio::CollectionIDTable::CollectionIDTable	(	const std::vector< int > &	ids,
		const std::vector< std::string > &	names
	)

Definition at line 15 of file CollectionIDTable.cc.

                                                                                                 :
    m_collectionIDs(ids), m_names(names), m_mutex(std::make_unique<std::mutex>()) {
}

Member Function Documentation

add()

int podio::CollectionIDTable::add

(

const std::string &

name

)

register new name to the table returns assigned collection ID

Definition at line 47 of file CollectionIDTable.cc.

                                                {
  std::lock_guard<std::mutex> lock(*m_mutex);
  const auto result = std::find(begin(m_names), end(m_names), name);
  int ID = 0;
  if (result == m_names.end()) {
    m_names.emplace_back(name);
    ID = m_names.size();
    m_collectionIDs.emplace_back(ID);
  } else {
    const auto index = std::distance(m_names.begin(), result);
    ID = m_collectionIDs[index];
  }
  return ID;
}

collectionID()

int podio::CollectionIDTable::collectionID

(

const std::string &

name

)

const

return collection ID for given name

Definition at line 26 of file CollectionIDTable.cc.

                                                               {
  std::lock_guard<std::mutex> lock(*m_mutex);
  const auto result = std::find(begin(m_names), end(m_names), name);
  const auto index = std::distance(m_names.begin(), result);
  return m_collectionIDs[index];
}

Referenced by podio::sio_utils::createCollIDBlock().

empty()

bool podio::CollectionIDTable::empty ( ) const

inline

Does this table hold any information?

Definition at line 54 of file CollectionIDTable.h.

                     {
    return m_names.empty();
  }

Referenced by podio::SIOFrameData::getIDTable().

ids()

const std::vector< int > & podio::CollectionIDTable::ids ( ) const

inline

return the ids

Definition at line 42 of file CollectionIDTable.h.

                                    {
    return m_collectionIDs;
  }

Referenced by podio::SIOFrameData::getIDTable(), and podio::root_utils::reconstructCollectionInfo().

name()

const std::string podio::CollectionIDTable::name

(

int

collectionID

)

const

return name for given collection ID

Definition at line 19 of file CollectionIDTable.cc.

                                                    {
  std::lock_guard<std::mutex> lock(*m_mutex);
  const auto result = std::find(begin(m_collectionIDs), end(m_collectionIDs), ID);
  const auto index = std::distance(m_collectionIDs.begin(), result);
  return m_names[index];
}

Referenced by add(), collectionID(), podio::createCollectionBranches(), podio::SIOFrameData::getAvailableCollections(), and present().

names()

const std::vector< std::string > & podio::CollectionIDTable::names ( ) const

inline

return registered names

Definition at line 37 of file CollectionIDTable.h.

                                            {
    return m_names;
  };

Referenced by podio::SIOFrameData::getCollectionBuffers(), podio::SIOFrameData::getIDTable(), and podio::root_utils::reconstructCollectionInfo().

operator=() [1/2]

CollectionIDTable & podio::CollectionIDTable::operator= ( CollectionIDTable &&  )

default

operator=() [2/2]

CollectionIDTable & podio::CollectionIDTable::operator= ( const CollectionIDTable &  )

delete

present()

bool podio::CollectionIDTable::present

(

const std::string &

name

)

const

Check if collection name is known.

Definition at line 41 of file CollectionIDTable.cc.

                                                           {
  std::lock_guard<std::mutex> lock(*m_mutex);
  const auto result = std::find(begin(m_names), end(m_names), name);
  return result != end(m_names);
}

Referenced by podio::SIOFrameData::getCollectionBuffers().

print()

void podio::CollectionIDTable::print

(

)

const

Prints collection information.

Definition at line 33 of file CollectionIDTable.cc.

                                    {
  std::lock_guard<std::mutex> lock(*m_mutex);
  std::cout << "CollectionIDTable" << std::endl;
  for (unsigned i = 0; i < m_names.size(); ++i) {
    std::cout << "\t" << m_names[i] << " : " << m_collectionIDs[i] << std::endl;
  }
}

---

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

• CollectionIDTable.h
• CollectionIDTable.cc