a run-time configurable list of data objects More...

#include <SGFolder.h>

Inheritance diagram for SG::Folder:

Collaboration diagram for SG::Folder:

structors
typedef IFolder::ItemList	ItemList
	the list we manage More...

	Folder (const std::string &type, const std::string &name, const IInterface *parent)

virtual	~Folder () override

access the ItemList
typedef IFolder::const_iterator	const_iterator

virtual const_iterator	begin () const override

virtual const_iterator	end () const override

virtual StatusCode	add (const std::string &typeName, const std::string &skey) override
	add a data object identifier to the list. More...

virtual StatusCode	add (const CLID &clid, const std::string &skey) override
	add a data object identifier to the list. More...

virtual void	clear () override
	clear the folder contents More...

virtual void	updateItemList (bool checkValidCLID) override final
	update contents of the ItemList More...

AlgTool boilerplate
ServiceHandle< IClassIDSvc >	m_pCLIDSvc

StringArrayProperty	m_itemList
	property: the list of items (data objects identified by a class name/key pair) More...

ItemList	m_list

BooleanProperty	m_checkItems
	property: check if item types are known to ClassIDSvc More...

class	Folder_tester

virtual StatusCode	initialize () override

void	decodeItemList (Gaudi::Details::PropertyBase &)

void	decodeItem (const std::string &item, bool checkValidCLID)

StatusCode	add (const CLID &clid, const std::string &skey, bool checkValidCLID, bool exact)
	add a data object identifier to the list, optionally checking if the clid is known to ClassIDSvc. More...

Detailed Description

a run-time configurable list of data objects

the ItemList property, used to initialize the folder, is a list of class name (or clid)/key pairs. One can use '*' as key value to add all objects of a given type to the Folder. Examples:

ItemList = [ "DataHeader#*", "AthenaAttributeList#SimpleTag", "8101/Foo" ]

Normally, an object will be written as the type as which it was recorded in StoreGate, regardless of the type used to request it in the ItemList. But if the type name ends with a !, then the object will be written as the exact type which was requested in the ItemList.

Definition at line 42 of file SGFolder.h.

Member Typedef Documentation

◆ const_iterator

typedef IFolder::const_iterator SG::Folder::const_iterator

Definition at line 58 of file SGFolder.h.

◆ ItemList

typedef IFolder::ItemList SG::Folder::ItemList

the list we manage

Definition at line 54 of file SGFolder.h.

Constructor & Destructor Documentation

◆ Folder()

Folder::Folder	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Definition at line 27 of file SGFolder.cxx.

                                           : 
   base_class( type, name, parent ),
   m_pCLIDSvc("ClassIDSvc", name),
   m_checkItems(false)
 {
   declareProperty("ItemList", m_itemList,
           " list of data objects identified by a class name (or clid)#key pairs. One can use '*' as key value to add all objects of a given type to the Folder.  If the type name ends with !, then write the object as exactly that type (and not as any derived class). ");
   m_itemList.declareUpdateHandler(&Folder::decodeItemList, this);
   declareProperty("CheckItems", m_checkItems, 
           "check if item types are known to ClassIDSvc");
 }

◆ ~Folder()

Folder::~Folder ( )

overridevirtual

Definition at line 42 of file SGFolder.cxx.

43 {}

Member Function Documentation

◆ add() [1/3]

virtual StatusCode SG::Folder::add	(	const CLID &	clid,
		const std::string &	skey
	)

inlineoverridevirtual

add a data object identifier to the list.

The clid is not checked against the ClassIDSvc registry

Definition at line 69 of file SGFolder.h.

                                                                              {
       const bool DONTCHECKVALIDCLID(false);
       return add(clid, skey, DONTCHECKVALIDCLID, false);
     }

◆ add() [2/3]

StatusCode Folder::add	(	const CLID &	clid,
		const std::string &	skey,
		bool	checkValidCLID,
		bool	exact
	)

private

add a data object identifier to the list, optionally checking if the clid is known to ClassIDSvc.

Definition at line 101 of file SGFolder.cxx.

 {
   StatusCode sc(StatusCode::FAILURE);
   if ( !checkValid || m_pCLIDSvc->isIDInUse(clid) ) {
     m_list.insert(FolderItem(clid, skey, exact));
     sc = StatusCode::SUCCESS;
   } else if (0 != clid) {
     MsgStream log(msgSvc(), name());
     log << MSG::WARNING << "add: can not find clid "
     << clid << " in clid db" << endmsg;
   }
 #ifdef SGFOLDER_DEBUG
     std::cout << "SG::Folder::add(" << clid << ",\"" << skey << "\") returns " 
           << (sc.isSuccess() ? "SUCCESS" : "FAILURE") << std::endl;
 #endif     
   return sc;
 }

◆ add() [3/3]

StatusCode Folder::add	(	const std::string &	typeName,
		const std::string &	skey
	)

overridevirtual

add a data object identifier to the list.

Notice that if the typename is not yet in the ClassIDSvc registry the entry will be ignored and and add will return StatusCode::FAILURE

Definition at line 79 of file SGFolder.cxx.

                                                             {
   bool exact = false;
   std::string tn = typeName;
   if (tn.size() > 0 && tn[tn.size()-1] == '!') {
     exact = true;
     tn.erase (tn.end()-1);
   }
   
   CLID clid;
   //let's see if the typename is known to ClassIDSvc
   StatusCode sc(m_pCLIDSvc->getIDOfTypeName(tn, clid));
   //if so, add the corresponding clid (no point in checking it again)
   if (sc.isSuccess()) sc=add(clid, skey, false, exact);
   else {
     MsgStream log(msgSvc(), name());
     log << MSG::WARNING << "add: can not find type ["
     << typeName << "] in clid db" << endmsg;
   }
   return sc;
 }

◆ begin()

virtual const_iterator SG::Folder::begin ( ) const

inlineoverridevirtual

Definition at line 59 of file SGFolder.h.

59 { return m_list.begin(); }

◆ clear()

virtual void SG::Folder::clear ( )

inlineoverridevirtual

clear the folder contents

Definition at line 75 of file SGFolder.h.

75 { m_list.clear(); }

◆ decodeItem()

void Folder::decodeItem	(	const std::string &	item,
		bool	checkValidCLID
	)

private

Definition at line 57 of file SGFolder.cxx.

                                                               {
   assert( !item.empty() );
   assert( m_pCLIDSvc );
 #ifdef SGFOLDER_DEBUG
   //can't use MsgStream (log level still not defined)
   std::cout << "Folder::decodeItem("<< item<<") called" << std::endl;
 #endif
   std::string::size_type sep(item.rfind('#'));
   std::string typeName (item.substr(0,sep));
   std::string skey;
   if (sep != std::string::npos) skey = item.substr(sep+1);
  
   //item contains a typename OR a CLID. Try the CLID hypothesis first 
   CLID clid(atoi(typeName.c_str()));  
   //atoi would return 0 if "typeName" is not a stringified number
   if ( 0 == clid) {
     //notice that if the typename is not yet in the ClassIDSvc registry the entry will be ignored
     add(typeName, skey).ignore();
   } else add(clid, skey, checkValid, false).ignore();
 }

◆ decodeItemList()

void SG::Folder::decodeItemList ( Gaudi::Details::PropertyBase & )

inlineprivate

Definition at line 91 of file SGFolder.h.

                                                    { 
       const bool DONTCHECKVALIDCLID(false);
       Folder::updateItemList(DONTCHECKVALIDCLID); 
     }

◆ end()

virtual const_iterator SG::Folder::end ( ) const

inlineoverridevirtual

Definition at line 60 of file SGFolder.h.

60 { return m_list.end(); }

◆ initialize()

StatusCode Folder::initialize ( )

overridevirtual

Definition at line 46 of file SGFolder.cxx.

                               {
   return m_pCLIDSvc.retrieve();
 }

◆ updateItemList()

void Folder::updateItemList ( bool checkValidCLID )

finaloverridevirtual

update contents of the ItemList

Definition at line 51 of file SGFolder.cxx.

                                            {
   std::vector< std::string >::const_iterator 
     i(m_itemList.value().begin()), e(m_itemList.value().end());
   while (i != e) decodeItem(*i++, checkValid);
 }

Friends And Related Function Documentation

◆ Folder_tester

friend class Folder_tester

friend

Definition at line 96 of file SGFolder.h.

Member Data Documentation

◆ m_checkItems

BooleanProperty SG::Folder::m_checkItems

private

property: check if item types are known to ClassIDSvc

Definition at line 104 of file SGFolder.h.

◆ m_itemList

StringArrayProperty SG::Folder::m_itemList

private

property: the list of items (data objects identified by a class name/key pair)

Definition at line 90 of file SGFolder.h.

◆ m_list

ItemList SG::Folder::m_list

private

Definition at line 102 of file SGFolder.h.

◆ m_pCLIDSvc

ServiceHandle<IClassIDSvc> SG::Folder::m_pCLIDSvc

private

Definition at line 88 of file SGFolder.h.

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

structors

access the ItemList

AlgTool boilerplate

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ ItemList

Constructor & Destructor Documentation

◆ Folder()

◆ ~Folder()

Member Function Documentation

◆ add() [1/3]

◆ add() [2/3]

◆ add() [3/3]

◆ begin()

◆ clear()

◆ decodeItem()

◆ decodeItemList()

◆ end()

◆ initialize()

◆ updateItemList()

Friends And Related Function Documentation

◆ Folder_tester

Member Data Documentation

◆ m_checkItems

◆ m_itemList

◆ m_list

◆ m_pCLIDSvc