DDSpecifics Class Reference

Interface to attach user specific data to nodes in the expanded-view. More...

#include <DDSpecifics.h>

Inheritance diagram for DDSpecifics:

Public Member Functions
	DDSpecifics ()
	Creates a uninitialized reference-object (see DDLogicalPart documentation for details on reference objects) More...
	DDSpecifics (const DDName &name)
	Creates a initialized reference-object or a reference to an allready defined specifcs. More...
	DDSpecifics (const DDName &name, const std::vector< std::string > &partSelections, const DDsvalues_type &svalues, bool doRegex=true)
	Creates a defined reference-object or replaces a already defined reference-object named name. More...
std::pair< bool, DDExpandedView >	node () const
	Calculates the geometrical history of a fully specified PartSelector. More...
const std::vector< DDPartSelection > &	selection () const
	Gives a reference to the collection of part-selections. More...
const DDsvalues_type &	specifics () const
	Reference to the user-data attached to all nodes selected by the selections-strings given through selection. More...
	~DDSpecifics () override
Public Member Functions inherited from DDBase< DDName, DDI::Specific * >
	DDBase ()
const DDName &	ddname () const
def_type	isDefined () const
bool	isValid () const
	true, if the wrapped pointer is valid More...
const DDName &	name () const
	operator bool () const
bool	operator< (const DDBase &b) const
bool	operator== (const DDBase &b) const
bool	operator> (const DDBase &b) const
const DDI::rep_traits< DDName, DDI::Specific * >::reference	rep () const
DDI::rep_traits< DDName, DDI::Specific * >::reference	rep ()
std::string	toString () const
const DDI::rep_traits< DDName, DDI::Specific * >::reference	val () const
const DDI::rep_traits< DDName, DDI::Specific * >::reference	val ()
virtual	~DDBase ()

Friends
std::ostream &	operator<< (std::ostream &, const DDSpecifics &)

Additional Inherited Members
Public Types inherited from DDBase< DDName, DDI::Specific * >
typedef std::pair< const DDName *, bool >	def_type
typedef DDI::Specific *	pimpl_type
typedef DDI::rep_type< DDName, pimpl_type > *	prep_type
typedef DDI::Singleton< DDI::Store< DDName, DDI::Specific * > >	StoreT
Static Public Member Functions inherited from DDBase< DDName, DDI::Specific * >
static auto	begin ()
static void	clear ()
static auto	end ()
static size_t	size ()
Protected Attributes inherited from DDBase< DDName, DDI::Specific * >
prep_type	prep_

Detailed Description

Interface to attach user specific data to nodes in the expanded-view.

used to attach specific (user defined) data to nodes in the expanded view.

• only a std::map<std::string,std::string> (std::map of name,value)User data (currently only of type a std::map<std::string,std::string> ) can be attached to single nodes or set of nodes in the detector tree (represented in DDExpandedView). Nodes where user data has to be attached are selected by a very simplified XPath similar notation.

DDSpecifics are lightweighted reference-objects. For further information concerning reference-objects refere to the documentation of DDLogicalPart.

Definition at line 42 of file DDSpecifics.h.

Constructor & Destructor Documentation

DDSpecifics::DDSpecifics

(

)

Creates a uninitialized reference-object (see DDLogicalPart documentation for details on reference objects)

Definition at line 14 of file DDSpecifics.cc.

  : DDBase<DDName,Specific*>()
{ }

DDSpecifics::DDSpecifics

(

const DDName &

name

)

Creates a initialized reference-object or a reference to an allready defined specifcs.

If a DDSpecifics with name was already defined, this constructor creates a lightweighted reference-object to it. Otherwise a (default) initialized reference-object is registered named name. For further details concerning the usage of reference-objects refere to the documentation of DDLogicalPart.

Definition at line 18 of file DDSpecifics.cc.

References DDI::Singleton< I >::instance(), and DDBase< DDName, DDI::Specific * >::prep_.

                                            : DDBase<DDName,Specific*>()
{
  prep_ = StoreT::instance().create(name);
}

DDSpecifics::DDSpecifics	(	const DDName &	name,
		const std::vector< std::string > &	partSelections,
		const DDsvalues_type &	svalues,
		bool	doRegex = true
	)

Creates a defined reference-object or replaces a already defined reference-object named name.

• name unique name
• partSelections collection of selection-strings which select expanded-nodes
• svalues user data attached to nodes selected by partSelections

Syntax of the selection std::string

bla, bla, bla

Definition at line 23 of file DDSpecifics.cc.

References Exception, DDI::Singleton< I >::instance(), DDBase< DDName, DDI::Specific * >::prep_, DDBase< DDName, DDI::Specific * >::rep(), and findQualityFiles::v.

 : DDBase<DDName,Specific*>()
{
  prep_ = StoreT::instance().create(name, new Specific(partSelections,svalues,doRegex));   
  std::vector<std::pair<DDLogicalPart,std::pair<const DDPartSelection*, const DDsvalues_type*> > > v;
  rep().updateLogicalPart(v);
  for( auto& it : v ) {
    if( it.first.isDefined().second ) {
      it.first.addSpecifics( it.second );
    }
    else {
      throw cms::Exception("DDException") << "Definition of LogicalPart missing! name="
                      << it.first.ddname().fullname();
    }
  }
} 

DDSpecifics::~DDSpecifics ( )

override

Definition at line 43 of file DDSpecifics.cc.

{ }

Member Function Documentation

std::pair< bool, DDExpandedView > DDSpecifics::node

(

)

const

Calculates the geometrical history of a fully specified PartSelector.

node() will only work, if

• there is only one PartSelection std::string
• the PartSelection std::string specifies exactly one full path concatenating always direct children including their copy-number and will return (true,const DDGeoHistory&) if the std::string matches an expanded-part in the ExpandedView, else it will return (false, xxx), whereas xxx is a history which is not valid.

Definition at line 68 of file DDSpecifics.cc.

References DDBase< DDName, DDI::Specific * >::rep().

{
  return rep().node();
}

const std::vector< DDPartSelection > & DDSpecifics::selection

(

)

const

Gives a reference to the collection of part-selections.

Definition at line 45 of file DDSpecifics.cc.

References DDBase< DDName, DDI::Specific * >::rep().

Referenced by Vispa.Plugins.ConfigEditor.CodeTableView.CodeTableView::keyPressEvent(), trackingPlots.Iteration::modules(), Vispa.Views.AbstractView.AbstractView::restoreSelection(), and DDCoreToDDXMLOutput::specpar().

{ 
  return rep().selection(); 
}

const DDsvalues_type & DDSpecifics::specifics

(

void

)

const

Reference to the user-data attached to all nodes selected by the selections-strings given through selection.

Definition at line 50 of file DDSpecifics.cc.

References DDBase< DDName, DDI::Specific * >::rep().

Referenced by DDCoreToDDXMLOutput::specpar().

{ 
  return rep().specifics(); 
}         

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const DDSpecifics &  sp  )

friend

Definition at line 73 of file DDSpecifics.cc.

{
  DDBase<DDName,DDI::Specific*>::def_type defined(sp.isDefined());
  if (defined.first) {
    os << *(defined.first) << " ";
    if (defined.second) {
      sp.rep().stream(os); 
    }
    else {
      os << "* specific not defined * ";  
    }
  }  
  else {
    os << "* specific not declared * ";  
  }  
  return os;
}