In This Package:

DetElemFinder Class Reference

Implementation of IDetElemFinder. More...

#include <DetElemFinder.h>

Inheritance diagram for DetElemFinder:

[legend]Collaboration diagram for DetElemFinder:[legend]List of all members.

Public Types
	SUCCESS
	NO_INTERFACE
	VERSMISMATCH
	LAST_ERROR
enum	Status
	SUCCESS
	NO_INTERFACE
	VERSMISMATCH
	LAST_ERROR
Public Member Functions
	DetElemFinder (const std::string &name, ISvcLocator *svcloc)
	Standard constructor.
virtual	~DetElemFinder ()
	Destructor.
virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvUnknown)
	Query interfaces (.
virtual const IDetectorElement *	detectorElementForPath (const std::string &path) const
	Find the detector element instance associated to a given physical volume path.
virtual StatusCode	initialize ()
	Initialize Service.
virtual StatusCode	finalize ()
	Finalize Service.
virtual unsigned long	addRef ()
virtual unsigned long	release ()
virtual const std::string &	name () const
virtual const InterfaceID &	type () const
virtual StatusCode	configure ()
virtual StatusCode	start ()
virtual StatusCode	stop ()
virtual StatusCode	terminate ()
virtual Gaudi::StateMachine::State	FSMState () const
virtual Gaudi::StateMachine::State	targetFSMState () const
virtual StatusCode	reinitialize ()
virtual StatusCode	restart ()
virtual StatusCode	sysInitialize ()
virtual StatusCode	sysStart ()
virtual StatusCode	sysStop ()
virtual StatusCode	sysFinalize ()
virtual StatusCode	sysReinitialize ()
virtual StatusCode	sysRestart ()
virtual StatusCode	setProperty (const Property &p)
virtual StatusCode	setProperty (const std::string &s)
virtual StatusCode	setProperty (const std::string &n, const std::string &v)
StatusCode	setProperty (const std::string &name, const TYPE &value)
virtual StatusCode	getProperty (Property *p) const
virtual const Property &	getProperty (const std::string &name) const
virtual StatusCode	getProperty (const std::string &n, std::string &v) const
virtual const std::vector< Property * > &	getProperties () const
ISvcLocator *	serviceLocator () const
IMessageSvc *	msgSvc ()
IMessageSvc *	msgSvc () const
IMessageSvc *	messageService ()
IMessageSvc *	messageService () const
StatusCode	setProperties ()
StatusCode	service (const std::string &name, T *&psvc, bool createIf=true) const
StatusCode	service (const std::string &svcType, const std::string &svcName, T *&psvc) const
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
IAuditorSvc *	auditorSvc () const
virtual unsigned long	addRef ()=0
virtual unsigned long	release ()=0
Static Public Member Functions
static const InterfaceID &	interfaceID ()
static const InterfaceID &	interfaceID ()
static const InterfaceID &	interfaceID ()
static const InterfaceID &	interfaceID ()
Public Attributes
	SUCCESS
	NO_INTERFACE
	VERSMISMATCH
	LAST_ERROR
Protected Member Functions
int	outputLevel () const
Protected Attributes
IntegerProperty	m_outputLevel
Gaudi::StateMachine::State	m_state
Gaudi::StateMachine::State	m_targetState
IMessageSvc *	m_messageSvc
Private Types
typedef GaudiUtils::HashMap< std::string, const IDetectorElement * >	map_type
Private Member Functions
StatusCode	insert (const IDetectorElement *de, const std::string &parent_path="")
	Recursively add the given detector element and its children.
StatusCode	detector_element_path (const IDetectorElement *de, std::string &path, const std::string &parent_path="")
	Find the detector element path and fill the variable path.
Private Attributes
std::string	m_detDataSvcName
	Name of the Data Provider (set by the option DetDataSvc, by default "DetectorDataSvc").
std::string	m_rootElement
	Path to the detector element to start from. (DetElemFinder.RootElement = "/dd/Structure/LHCb").
bool	m_dumpMap
	Flag to dump the retrieved map of detector elements. (DetElemFinder.DumpMap = false).
map_type	m_map
	Structure for the mapping.
Friends
class	SvcFactory< DetElemFinder >
	Allow SvcFactory to instantiate the service.
friend class	ServiceManager

---

Detailed Description

Implementation of IDetElemFinder.

Author:

Marco Clemencic

Date:

2006-09-01

Definition at line 17 of file DetElemFinder.h.

---

Member Typedef Documentation

typedef GaudiUtils::HashMap<std::string, const IDetectorElement *> DetElemFinder::map_type [private]

Definition at line 66 of file DetElemFinder.h.

---

Constructor & Destructor Documentation

DetElemFinder::DetElemFinder	(	const std::string &	name,
		ISvcLocator *	svcloc
	)

Standard constructor.

Definition at line 26 of file DetElemFinder.cpp.

00026                                                                         :
00027   Service(name,svcloc)
00028 {
00029   declareProperty( "DetectorDataSvc", m_detDataSvcName = "DetectorDataSvc" );
00030   declareProperty( "RootElement",     m_rootElement    = "/dd/Structure/LHCb" );
00031   declareProperty( "DumpMap",         m_dumpMap        = false );
00032 }
//=============================================================================

DetElemFinder::~DetElemFinder

(

)

[virtual]

Destructor.

Definition at line 36 of file DetElemFinder.cpp.

{} 

---

Member Function Documentation

StatusCode DetElemFinder::queryInterface	(	const InterfaceID &	riid,
		void **	ppvUnknown
	)			[virtual]

Query interfaces (.

See also:

{IInterface})

Parameters:

	riid	ID of Interface to be retrieved
	ppvUnknown	Pointer to Location for interface pointer

Reimplemented from Service.

Definition at line 41 of file DetElemFinder.cpp.

                                                                                  {
  if ( IID_IDetElemFinder.versionMatch(riid) ) {
    *ppvUnknown = (IDetElemFinder*)this;
    addRef();
    return StatusCode::SUCCESS;
  }
  return Service::queryInterface(riid,ppvUnknown);
}

const IDetectorElement * DetElemFinder::detectorElementForPath

(

const std::string &

path

)

const [virtual]

Find the detector element instance associated to a given physical volume path.

Returns 0 if there is no suitable detector element.

Implements IDetElemFinder.

Definition at line 53 of file DetElemFinder.cpp.

{
  return m_map(path);
}

StatusCode DetElemFinder::initialize

(

)

[virtual]

Initialize Service.

Reimplemented from Service.

Definition at line 62 of file DetElemFinder.cpp.

{
        // base class initialization
        StatusCode sc = Service::initialize();
        if (!sc.isSuccess()) return sc;

        // local initialization
        MsgStream log(msgSvc(),name());
        log << MSG::DEBUG << "--- initialize ---" << endmsg;

  IDataProviderSvc *detSvc = 0;
  sc = service(m_detDataSvcName,detSvc,true);
  if (!sc.isSuccess()) {
                log << MSG::ERROR << "Unable to get a handle to the detector data service ("
        << m_detDataSvcName << ")" << endmsg; 
    return sc;
        }
  
  DataObject *obj;
  sc = detSvc->retrieveObject(m_rootElement,obj);
  if (!sc.isSuccess()) {
                log << MSG::ERROR << "Unable to retrieve object '" << m_rootElement << "'" << endmsg; 
    detSvc->release();
    return sc;
        }
  IDetectorElement *de = dynamic_cast<IDetectorElement *>(obj);
  if (!de) {
                log << MSG::ERROR << "Object '" << m_rootElement << "' is not a DetectorElement" << endmsg; 
    detSvc->release();
    return sc;
        }

  // I do not need anymore the data proivider
  detSvc->release();

  // add all the detector elements to the map
  return insert(de);
}

StatusCode DetElemFinder::finalize

(

)

[virtual]

Finalize Service.

Reimplemented from Service.

Definition at line 103 of file DetElemFinder.cpp.

{
        // local finalization
        MsgStream log(msgSvc(),name());
        log << MSG::DEBUG << "--- finalize ---" << endmsg;

  //if (m_outputLevel <= MSG::DEBUG) {
  if ( m_dumpMap ) {
    for ( map_type::iterator i = m_map.begin(); i != m_map.end(); ++i ){
      //log << MSG::DEBUG << i->first << " -> " << i->second->name() << endmsg;
      log << MSG::ALWAYS << i->first << " -> " << i->second->name() << endmsg;
    } 
  }

        // base class finalization
  return Service::finalize();
}

StatusCode DetElemFinder::insert	(	const IDetectorElement *	de,
		const std::string &	parent_path = ""
	)			[private]

Recursively add the given detector element and its children.

The parameter parent_path is the used to speed up recursion.

Definition at line 178 of file DetElemFinder.cpp.

                                                                                           {

  MsgStream log(msgSvc(),name());
  log << MSG::DEBUG << "Preocessing detector element " << de->name() << endmsg;

  StatusCode sc = StatusCode::SUCCESS;

  std::string path;

  // discover the identifier of the DE from the parent:
  sc = detector_element_path(de,path,parent_path);
  if ( ! sc.isSuccess() ) {
    return sc;
  }
  
  map_type::iterator x = m_map.find(path);
  if ( x != m_map.end() ) {
    log << MSG::ERROR << "Cannot insert duplicated path \"" << path << "\" for \"" << de->name() << "\"" << endmsg;
    log << MSG::ERROR << "Already used for \"" << x->second->name() << "\"" << endmsg;
    return StatusCode::FAILURE;
  }
  else {
    log << MSG::DEBUG << "Insert path \"" << path << "\"" << endmsg;
    m_map[path] = de;
  }

  // insert all children
  IDetectorElement::IDEContainer::const_iterator child;
  for ( child = de->childBegin(); sc.isSuccess() && child != de->childEnd(); ++child ){
    sc = insert(*child,path);
    if ( ! sc.isSuccess() ) {
      return sc;
    }
  }
  return sc;
}

StatusCode DetElemFinder::detector_element_path	(	const IDetectorElement *	de,
		std::string &	path,
		const std::string &	parent_path = ""
	)			[private]

Find the detector element path and fill the variable path.

If parent_path is not specified, it retrieved recursively.

Definition at line 124 of file DetElemFinder.cpp.

{
  StatusCode sc = StatusCode::SUCCESS;

  // initialize the output variable
  path = parent_path;
  
  // get the parent geometryInfo (supportIGeometryInfo() is public)
  IGeometryInfo* sgi = de->geometry()->supportIGeometryInfo();

  if (NULL == sgi) {
    return sc;
  }
  
  // If the parent path was not specified, I have to find it recursively
  if (parent_path.empty()){
    if (de->parentIDetectorElement()) {
      sc = detector_element_path(de->parentIDetectorElement(),path);
      if (!sc.isSuccess()) {
        return sc;
      }
    } else { // this should never happen
      return sc;
    }
  }
  
  // get support LVolume
  const ILVolume* lv = sgi->lvolume();
  
  // define a PVolumePath (this is simply std::vector<const IPVolume*> )
  
  ILVolume::PVolumePath volumePath;
  
  // Fill it with PVolume* corresponding to the supportPath().
  sc = lv->traverse( de->geometry()->supportPath().begin(),
                     de->geometry()->supportPath().end(),
                     volumePath );
  if (!sc.isSuccess()) {
    MsgStream log(msgSvc(),name());
    log << MSG::ERROR << "Cannot traverse the support path" << endmsg;
    return sc;
  }
  
  // build the string
  for ( ILVolume::PVolumePath::iterator pv = volumePath.begin(); pv != volumePath.end(); ++pv ) {
    path += "/" + (*pv)->name();
  }
  return sc;
}

---

Friends And Related Function Documentation

friend class SvcFactory< DetElemFinder > [friend]

Allow SvcFactory to instantiate the service.

Definition at line 55 of file DetElemFinder.h.

---

Member Data Documentation

std::string DetElemFinder::m_detDataSvcName [private]

Name of the Data Provider (set by the option DetDataSvc, by default "DetectorDataSvc").

Definition at line 58 of file DetElemFinder.h.

std::string DetElemFinder::m_rootElement [private]

Path to the detector element to start from. (DetElemFinder.RootElement = "/dd/Structure/LHCb").

Definition at line 61 of file DetElemFinder.h.

bool DetElemFinder::m_dumpMap [private]

Flag to dump the retrieved map of detector elements. (DetElemFinder.DumpMap = false).

Definition at line 64 of file DetElemFinder.h.

map_type DetElemFinder::m_map [private]

Structure for the mapping.

Definition at line 68 of file DetElemFinder.h.

---

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

• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/lhcb/Det/DetDescSvc/src/DetElemFinder.h
• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/lhcb/Det/DetDescSvc/src/DetElemFinder.cpp

---