---

DDXMLElementRegistry Class Reference

This is a base class for Registering DDXMLElements. More...

#include <DetectorDescription/Parser/src/DDXMLElementRegistry.h>

Inheritance diagram for DDXMLElementRegistry:

List of all members.

Public Types
typedef std::map< std::string, DDXMLElement * >	RegistryMap
Public Member Functions
DDXMLElement *	getElement (const std::string &name)
	THE most important part. Getting the pointer to a given element type.
std::string	getElementName (DDXMLElement *theElement)
	Get the name given a pointer. This may not be needed...
void	registerElement (const std::string &name, DDXMLElement *)
	This allows other Elements to register themselves with the static registry.
void	stream (std::ostream &os) const
virtual	~DDXMLElementRegistry ()
	Destructor.
Protected Member Functions
	DDXMLElementRegistry ()
	Private constructor for singleton.
Private Attributes
RegistryMap	registry_
Friends
std::ostream &	operator<< (std::ostream &os, const DDXMLElementRegistry &element)

---

Detailed Description

This is a base class for Registering DDXMLElements.

DDXMLElementRegistry.h - description ------------------- begin: Wed Mar 27 2002 email: case@ucdhep.ucdavis.edu

This class is registry of DDXMLElements. It is used wherever you want to register and retrieve DDXMLElements so that using getElement you can get a pointer to a DDXMLElement based on the name of the XML Element.

Definition at line 29 of file DDXMLElementRegistry.h.

---

Member Typedef Documentation

typedef std::map<std::string, DDXMLElement*> DDXMLElementRegistry::RegistryMap

Definition at line 36 of file DDXMLElementRegistry.h.

---

Constructor & Destructor Documentation

DDXMLElementRegistry::~DDXMLElementRegistry

(

)

[virtual]

Destructor.

Definition at line 39 of file DDXMLElementRegistry.cc.

References find(), it, and registry_.

{
  // Complicated cleanup.  I keep track of DDXMLElements that have
  // already been deleted using this vector.  Then delete them one-by-one.
  std::vector<DDXMLElement*> toDelete;
  for ( RegistryMap::const_iterator it = registry_.begin(); it != registry_.end(); ++it) {
    std::vector<DDXMLElement*>::const_iterator deleteIt = std::find(toDelete.begin(), toDelete.end(), it->second);
    if ( deleteIt == toDelete.end() ) {
      toDelete.push_back(it->second);
      delete it->second;
    }
  }
}

DDXMLElementRegistry::DDXMLElementRegistry

(

)

[protected]

Private constructor for singleton.

Definition at line 34 of file DDXMLElementRegistry.cc.

{
  //  registry_ = new RegistryMap;
}

---

Member Function Documentation

DDXMLElement * DDXMLElementRegistry::getElement

(

const std::string &

name

)

THE most important part. Getting the pointer to a given element type.

If this is called with a DDXMLElementRegistry pointer, it will simply return a pointer if already registered or NULL, no instantiating.

Reimplemented in DDLElementRegistry.

Definition at line 65 of file DDXMLElementRegistry.cc.

References DCOUT_V, lat::endl(), it, NULL, and registry_.

{
  DCOUT_V('P',  "DDXMLElementRegistry::getElement " << name << std::endl);
  RegistryMap::iterator it = registry_.find(name);
  DDXMLElement* myret = NULL;
  if (it != registry_.end())
    myret = it->second;
  DCOUT_V('P',  "DDXMLElementRegistry::getElement " << name << std::endl);
  return myret;
}

std::string DDXMLElementRegistry::getElementName

(

DDXMLElement *

theElement

)

Get the name given a pointer. This may not be needed...

Definition at line 77 of file DDXMLElementRegistry.cc.

References it, and registry_.

{
  std::string ret = "";
  for (RegistryMap::const_iterator it = registry_.begin(); it != registry_.end(); ++it)
    if (it->second == theElementBase)
      ret = it->first;
  return ret;
}

void DDXMLElementRegistry::registerElement	(	const std::string &	name,
		DDXMLElement *	element
	)

This allows other Elements to register themselves with the static registry.

Definition at line 58 of file DDXMLElementRegistry.cc.

References DCOUT_V, and registry_.

Referenced by DDLElementRegistry::getElement(), and DDLElementRegistry::instance().

{
  DCOUT_V('P',"DDXMLElementRegistry::registerElementBase: "  << name << " at " << element);
  registry_[name] = element;
}

void DDXMLElementRegistry::stream

(

std::ostream &

os

)

const

Definition at line 92 of file DDXMLElementRegistry.cc.

References lat::endl(), it, and registry_.

Referenced by operator<<().

{
  os << "Output of current Element Registry:" << std::endl;
  for (RegistryMap::const_iterator it=registry_.begin(); it != registry_.end(); ++it)
    os << it->first <<  " at address " << it->second << std::endl;
}                        

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const DDXMLElementRegistry &	element
	)			[friend]

Definition at line 86 of file DDXMLElementRegistry.cc.

{
  element.stream(os);
  return os;
}

---

Member Data Documentation

RegistryMap DDXMLElementRegistry::registry_ [private]

Definition at line 69 of file DDXMLElementRegistry.h.

Referenced by getElement(), getElementName(), registerElement(), stream(), and ~DDXMLElementRegistry().

---

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

• DetectorDescription/Parser/src/DDXMLElementRegistry.h
• DetectorDescription/Parser/src/DDXMLElementRegistry.cc

---