The class is meant to store links (of type TrigFeatureLink) to trigger objects and arbitrary details (of type, float, int, string, or vectors of those) More...

#include <TrigComposite.h>

Collaboration diagram for TrigComposite:

Public Member Functions
	TrigComposite (const std::string &name)
	Constructs empty composite, no objects no details.
	TrigComposite ()=default
	Default constructor should not be normally used, needed by the persistency layer.
	TrigComposite (TrigComposite &&) noexcept=default
TrigComposite &	operator= (TrigComposite &&) noexcept=default
	~TrigComposite ()=default
	TrigComposite (const std::string &name, std::string &label1, TrigFeatureLink t1, std::string &label2, TrigFeatureLink t2)
	Constructs composite with the links to two trigger objects/links to them The validity of the links is not checked during the construction.
const std::string &	name () const
template<typename T>
void	setFormat (const std::vector< std::string > &keys, bool mustBeSet=false)
	defines the content (details which must to be stored) The method can be used to enforce certain content of the object (set the demand that the deail are set).
bool	isValid () const
	Checks the validity of the format, i.e.
void	lockFormat ()
	makes further addition of the details impossible
bool	isFormatLocked () const
	return true if the format can not be further changed (no addDetail can be called)
void	unlockFormat ()
	makes addition of further details possible again
void	addObject (const std::string &key, TrigFeatureLink link)
	adds the link
void	setObject (const std::string &key, TrigFeatureLink link)
	sets the link
bool	hasObject (const std::string &key) const
	checks if the object has link to the object under the key
const TrigFeatureLink &	getObject (const std::string &key) const
	returns
template<typename T>
std::vector< TrigFeatureLink >	getObjectsByType (const std::string &keypart="") const
	get all links which point to objects of given type
template<typename T>
void	addDetail (const std::string &key, const T &value=T())
	adds the value user the key, if they detail under that key already exists the exception is thrown If the format is locked the exception is thrown each time
template<typename T>
void	setDetail (const std::string &key, const T &value)
	sets the value user the key, if they detail under that key already exists it's value is overwritten, If the key does not exists, the exception is thrown
template<typename T>
bool	hasDetail (const std::string &key) const
	Checks if the object contains detail of the type T No verification is made if it is set.
template<typename T>
const T &	getDetail (const std::string &key) const
	return the value of the detail, if the key is absent the default is returned
template<class T>
const std::map< std::string, T > &	allDetails () const
	return the map of all the details Notie that the non-const version is not provided because it would allow to circumvent format fixing whcih may be defined for this object.
template<typename T>
void	eraseDetail (const std::string &key)
	erases the detail if it existed If the details inder that key did not exist, no action is performed.

Private Types
typedef std::set< std::string >	MustSetList

Private Member Functions
template<class T>
void	mustSet (const std::string &key)
template<typename T>
std::map< std::string, T > &	detailsMap ()
template<typename T>
const std::map< std::string, T > &	detailsMap () const
template<typename T>
MustSetList &	detailsMustSetList ()
template<typename T>
const T &	specimen () const

Private Attributes
std::map< std::string, TrigFeatureLink >	m_links
MustSetList	m_linksToBeSet
std::map< std::string, float >	m_floats
MustSetList	m_floatsToBeSet
std::map< std::string, int >	m_ints
MustSetList	m_intsToBeSet
std::map< std::string, std::string >	m_strings
MustSetList	m_stringsToBeSet
std::map< std::string, std::vector< float > >	m_v_floats
MustSetList	m_v_floatsToBeSet
std::map< std::string, std::vector< int > >	m_v_ints
MustSetList	m_v_intsToBeSet
std::map< std::string, std::vector< std::string > >	m_v_strings
MustSetList	m_v_stringsToBeSet
std::string	m_name {"dummy"}
bool	m_locked {false}

Detailed Description

The class is meant to store links (of type TrigFeatureLink) to trigger objects and arbitrary details (of type, float, int, string, or vectors of those)

Author: Camille Belanger-Champagne; Tomasz Bold

Definition at line 27 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

Member Typedef Documentation

◆ MustSetList

typedef std::set<std::string> TrigComposite::MustSetList

private

Definition at line 177 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

Constructor & Destructor Documentation

◆ TrigComposite() [1/4]

TrigComposite::TrigComposite ( const std::string & name )

Constructs empty composite, no objects no details.

Definition at line 12 of file TrigComposite.cxx.

  : m_name(name),
    m_locked(false)    
{
}

◆ TrigComposite() [2/4]

TrigComposite::TrigComposite ( )

default

Default constructor should not be normally used, needed by the persistency layer.

◆ TrigComposite() [3/4]

TrigComposite::TrigComposite ( TrigComposite && )

defaultnoexcept

◆ ~TrigComposite()

TrigComposite::~TrigComposite ( )

default

◆ TrigComposite() [4/4]

TrigComposite::TrigComposite	(	const std::string &	name,
		std::string &	label1,
		TrigFeatureLink	t1,
		std::string &	label2,
		TrigFeatureLink	t2 )

Constructs composite with the links to two trigger objects/links to them The validity of the links is not checked during the construction.

Definition at line 19 of file TrigComposite.cxx.

  : m_name(name), 
    m_locked(false)    
{
  addObject(label1, t1);
  addObject(label2, t2);
}

Member Function Documentation

◆ addDetail()

template<typename T>

void TrigComposite::addDetail	(	const std::string &	key,
		const T &	value = T() )

adds the value user the key, if they detail under that key already exists the exception is thrown If the format is locked the exception is thrown each time

Definition at line 80 of file TrigComposite.cxx.

                                                                  {
  if ( isFormatLocked() )
    throw std::invalid_argument("The format of TrigComposite object has been locked, addDetails can not be used anymore, see unlockFormat or setDetail");
  if ( hasDetail<T>(key) ) 
    throw std::invalid_argument("The TrigCompositeObejct already has key: "+ key);
  
  // now it needs to fins appropriate collection and add to it the value
  detailsMap<T>()[key] = value;
}

◆ addObject()

void TrigComposite::addObject	(	const std::string &	key,
		TrigFeatureLink	link )

adds the link

See also: TrigFeatuerLink to the object, link is not checked for the validity,; addDetail

Definition at line 47 of file TrigComposite.cxx.

                                                                        {
  addDetail(key, link);
}

◆ allDetails()

template<class T>

const std::map< std::string, T > & TrigComposite::allDetails ( ) const

inline

return the map of all the details Notie that the non-const version is not provided because it would allow to circumvent format fixing whcih may be defined for this object.

Definition at line 159 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

                                                 {
    return detailsMap<T>();
  }

◆ detailsMap() [1/2]

template<typename T>

std::map< std::string, T > & TrigComposite::detailsMap ( )

private

Definition at line 126 of file TrigComposite.cxx.

                                                {
  // this should never be needed, need to add compile error here
  [[maybe_unused]]
  int z =
    sizeof(struct TrigComposite_does_not_support_that_type_as_a_detail);
  std::abort();
}

◆ detailsMap() [2/2]

template<typename T>

const std::map< std::string, T > & TrigComposite::detailsMap ( ) const

private

Definition at line 135 of file TrigComposite.cxx.

                                                            {
  // this should never be needed, need to add compile error here
  [[maybe_unused]]
  int z =
    sizeof(struct TrigComposite_does_not_support_that_type_as_a_detail);
  std::abort();
}

◆ detailsMustSetList()

template<typename T>

MustSetList & TrigComposite::detailsMustSetList ( )

private

◆ eraseDetail()

template<typename T>

void TrigComposite::eraseDetail ( const std::string & key )

erases the detail if it existed If the details inder that key did not exist, no action is performed.

Definition at line 120 of file TrigComposite.cxx.

                                                    {
  detailsMap<T>().erase(key);
}

◆ getDetail()

template<typename T>

const T & TrigComposite::getDetail ( const std::string & key ) const

return the value of the detail, if the key is absent the default is returned

Definition at line 112 of file TrigComposite.cxx.

                                                             {
  if ( hasDetail<T>(key) ) 
    return detailsMap<T>().find(key)->second;
  return specimen<T>();
}

◆ getObject()

const TrigFeatureLink & TrigComposite::getObject ( const std::string & key ) const

returns

See also: TrigFeatureLink associated to the key, if there is none, the invalid TrigFeatureLink is returned

Definition at line 60 of file TrigComposite.cxx.

                                                                          {
  return getDetail<TrigFeatureLink>(key);
}

◆ getObjectsByType()

template<typename T>

std::vector< TrigFeatureLink > TrigComposite::getObjectsByType ( const std::string & keypart = "" ) const

get all links which point to objects of given type

keypart retrieve only objects with matching key, (checked by means of string::find)

Definition at line 226 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

                                                                                         {
  const CLID requested_clid = ClassID_traits<T>::ID(); 
  std::vector<TrigFeatureLink> result;
  for ( std::map<std::string, TrigFeatureLink>::const_iterator i = m_links.begin(); i != m_links.end(); ++i ) {
    if ( i->second.clid() == requested_clid and i->first.find(keypart) != std::string::npos) 
      result.push_back(i->second);
  }
  return result;
}

◆ hasDetail()

template<typename T>

bool TrigComposite::hasDetail ( const std::string & key ) const

Checks if the object contains detail of the type T No verification is made if it is set.

Definition at line 103 of file TrigComposite.cxx.

                                                        {
  return detailsMap<T>().find(key) != detailsMap<T>().end();
}

◆ hasObject()

bool TrigComposite::hasObject ( const std::string & key ) const

checks if the object has link to the object under the key

Definition at line 56 of file TrigComposite.cxx.

                                                        {
  return hasDetail<TrigFeatureLink>(key);
}

◆ isFormatLocked()

bool TrigComposite::isFormatLocked ( ) const

inline

return true if the format can not be further changed (no addDetail can be called)

Definition at line 81 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

81{return m_locked; }

◆ isValid()

bool TrigComposite::isValid ( ) const

Checks the validity of the format, i.e.

if all the details which were meant to be added are added

Definition at line 64 of file TrigComposite.cxx.

                                  {
  if ( m_linksToBeSet.empty()
       and m_floatsToBeSet.empty()
       and  m_intsToBeSet.empty()
       and  m_stringsToBeSet.empty()
       and  m_v_intsToBeSet.empty() 
       and  m_v_floatsToBeSet.empty() 
       and  m_v_stringsToBeSet.empty() )
    return true;
  return false;
}

◆ lockFormat()

void TrigComposite::lockFormat ( )

inline

makes further addition of the details impossible

Definition at line 76 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

76{m_locked=true;}

◆ mustSet()

template<class T>

void TrigComposite::mustSet ( const std::string & key )

private

Definition at line 40 of file TrigComposite.cxx.

                                                {
  detailsMustSetList<T>().insert(key);  
}

◆ name()

const std::string & TrigComposite::name ( ) const

inline

Definition at line 52 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

52{ return m_name; }

◆ operator=()

TrigComposite & TrigComposite::operator= ( TrigComposite && )

defaultnoexcept

◆ setDetail()

template<typename T>

void TrigComposite::setDetail	(	const std::string &	key,
		const T &	value )

sets the value user the key, if they detail under that key already exists it's value is overwritten, If the key does not exists, the exception is thrown

Definition at line 92 of file TrigComposite.cxx.

                                                                  {
  if ( hasDetail<T>(key) == false ) 
    throw std::invalid_argument("The TrigCompositeObejct does not have key: "+ key);
  
  // now it needs to fins appropriate collection and set the value
  detailsMap<T>()[key] = value;
  detailsMustSetList<T>().erase(key);
}

◆ setFormat()

template<typename T>

void TrigComposite::setFormat	(	const std::vector< std::string > &	keys,
		bool	mustBeSet = false )

defines the content (details which must to be stored) The method can be used to enforce certain content of the object (set the demand that the deail are set).

Each type of the details can be fixed independently. Also the links can be demanded to be set this way.

This functionality can be used in some sort factories producing TrigComposite of fixed content/contract for the numer of algorithms which they will be "forced" to fill. The enforcement is weak, the isValid method can be then called and so the fulfillment of the contract.

Definition at line 30 of file TrigComposite.cxx.

                                                                               {
  for(const std::string& key : keys) {
    addDetail<T>(key);
    if (mustBeSet) {
      mustSet<T>(key);
    }
  }
}

◆ setObject()

void TrigComposite::setObject	(	const std::string &	key,
		TrigFeatureLink	link )

sets the link

See also: TrigFeatuerLink to the object, link is not checked for the validity; setDetail

Definition at line 51 of file TrigComposite.cxx.

                                                                        {
  setDetail(key, link);
}

◆ specimen()

template<typename T>

const T & TrigComposite::specimen ( ) const

private

◆ unlockFormat()

void TrigComposite::unlockFormat ( )

inline

makes addition of further details possible again

Definition at line 87 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

87{m_locked=false;}

Member Data Documentation

◆ m_floats

std::map<std::string, float > TrigComposite::m_floats

private

Definition at line 182 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

◆ m_floatsToBeSet

MustSetList TrigComposite::m_floatsToBeSet

private

Definition at line 183 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

◆ m_ints

std::map<std::string, int> TrigComposite::m_ints

private

Definition at line 185 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

◆ m_intsToBeSet

MustSetList TrigComposite::m_intsToBeSet

private

Definition at line 186 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

◆ m_links

std::map<std::string, TrigFeatureLink > TrigComposite::m_links

private

Definition at line 179 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

◆ m_linksToBeSet

MustSetList TrigComposite::m_linksToBeSet

private

Definition at line 180 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

◆ m_locked

bool TrigComposite::m_locked {false}

private

Definition at line 215 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

215{false};

◆ m_name

std::string TrigComposite::m_name {"dummy"}

private

Definition at line 214 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

214{"dummy"};

◆ m_strings

std::map<std::string, std::string> TrigComposite::m_strings

private

Definition at line 188 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

◆ m_stringsToBeSet

MustSetList TrigComposite::m_stringsToBeSet

private

Definition at line 189 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

◆ m_v_floats

std::map<std::string, std::vector<float> > TrigComposite::m_v_floats

private

Definition at line 191 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

◆ m_v_floatsToBeSet

MustSetList TrigComposite::m_v_floatsToBeSet

private

Definition at line 192 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

◆ m_v_ints

std::map<std::string, std::vector<int> > TrigComposite::m_v_ints

private

Definition at line 194 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

◆ m_v_intsToBeSet

MustSetList TrigComposite::m_v_intsToBeSet

private

Definition at line 195 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

◆ m_v_strings

std::map<std::string, std::vector<std::string> > TrigComposite::m_v_strings

private

Definition at line 197 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

◆ m_v_stringsToBeSet

MustSetList TrigComposite::m_v_stringsToBeSet

private

Definition at line 198 of file Trigger/TrigEvent/TrigCombinedEvent/TrigCombinedEvent/TrigComposite.h.

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ MustSetList

Constructor & Destructor Documentation

◆ TrigComposite() [1/4]

◆ TrigComposite() [2/4]

◆ TrigComposite() [3/4]

◆ ~TrigComposite()

◆ TrigComposite() [4/4]

Member Function Documentation

◆ addDetail()

◆ addObject()

◆ allDetails()

◆ detailsMap() [1/2]

◆ detailsMap() [2/2]

◆ detailsMustSetList()

◆ eraseDetail()

◆ getDetail()

◆ getObject()

◆ getObjectsByType()

◆ hasDetail()

◆ hasObject()

◆ isFormatLocked()

◆ isValid()

◆ lockFormat()

◆ mustSet()

◆ name()

◆ operator=()

◆ setDetail()

◆ setFormat()

◆ setObject()

◆ specimen()

◆ unlockFormat()

Member Data Documentation

◆ m_floats

◆ m_floatsToBeSet

◆ m_ints

◆ m_intsToBeSet

◆ m_links

◆ m_linksToBeSet

◆ m_locked

◆ m_name

◆ m_strings

◆ m_stringsToBeSet

◆ m_v_floats

◆ m_v_floatsToBeSet

◆ m_v_ints

◆ m_v_intsToBeSet

◆ m_v_strings

◆ m_v_stringsToBeSet