DetectorDescription/Core/interface/DDExpandedView.h - master - githubmirror/cmssw

DetectorDescription/Core/interface/DDExpandedView.h
158 строк5 KB
Christopher Jones
Removed usage of DDVectorGetter from production code
01 июн 2020, 23:15
01 июн 2020, 23:150ef36a7
#ifndef DDExpandedView_h
#define DDExpandedView_h

#include <cstddef>
#include <iosfwd>
#include <map>
#include <string>
#include <utility>
#include <vector>

#include "DetectorDescription/Core/interface/DDRotationMatrix.h"
#include "DetectorDescription/Core/interface/DDTranslation.h"
#include "DetectorDescription/Core/interface/DDCompactView.h"
#include "DetectorDescription/Core/interface/DDExpandedNode.h"
#include "DetectorDescription/Core/interface/DDLogicalPart.h"
#include "DetectorDescription/Core/interface/DDPosData.h"
#include "DetectorDescription/Core/interface/DDTransform.h"
#include "DetectorDescription/Core/interface/DDsvalues.h"
#include "DataFormats/Math/interface/GraphWalker.h"

class DDFilteredView;
class DDLogicalPart;
struct DDPosData;

/**
  DDExpandedView provides a tree-walker (iterator) for the 
  expanded view of the detector description. 
  Further it provides a registration mechanism for call-backs
  whenever a node in the expanded view becomes current and
  fullfills the user-defined predicate.
  
  FIXME: DDExpandedView: in the Prototype just one class -
  FIXME:                 later seperation of interface & implementation!
*/
//! Provides an exploded view of the detector (tree-view)
/** Taking a DDCompactView the DDExpandedView expands the compact-view into
    a detector tree. One instance of DDExpandedView corresponds to one node
    in the tree. It is the 'current' node. By using tree navigation ( next(), nextSibling(),
    parent(), firstChild() ) the DDExpandedView represents the new corresponding node.
*/
class DDExpandedView {
  friend class DDFilteredView;

public:
  using WalkerType = math::GraphWalker<DDLogicalPart, DDPosData *>;

  //! std::vector of sibling numbers
  typedef std::vector<int> nav_type;
  typedef std::pair<int const *, size_t> NavRange;

  //! Constructs an expanded-view based on the compact-view
  DDExpandedView(const DDCompactView &);

  virtual ~DDExpandedView();

  //! The logical-part of the current node in the expanded-view
  const DDLogicalPart &logicalPart() const;

  //! The name of the logical-part of the current node in the expanded-view
  const std::string &name() const;

  //! The absolute translation of the current node
  const DDTranslation &translation() const;

  //! The absolute rotation of the current node
  const DDRotationMatrix &rotation() const;

  //! The list of ancestors up to the root-node of the current node
  const DDGeoHistory &geoHistory() const;

  //! transversed the DDExpandedView according to the given stack of sibling numbers
  bool goTo(const nav_type &);
  bool goTo(NavRange);
  bool goTo(int const *newpos, size_t sz);

  //! return the stack of sibling numbers which indicates the current position in the DDExpandedView
  nav_type navPos() const;

  //! return the stack of copy numbers
  nav_type copyNumbers() const;

  //! User specific data attached to the current node
  std::vector<const DDsvalues_type *> specifics() const;
  void specificsV(std::vector<const DDsvalues_type *> &vc) const;

  DDsvalues_type mergedSpecifics() const;
  void mergedSpecificsV(DDsvalues_type &res) const;

  //! The DDVector information
  std::vector<double> const &vector(std::string_view iKey) const { return cpv_->vector(iKey); }

  //! Copy number associated with the current node
  int copyno() const;

  // navigation

  //! The scope of the expanded-view.
  const DDGeoHistory &scope() const;

  //! sets the scope of the expanded view
  bool setScope(const DDGeoHistory &hist, int depth = 0);

  //! clears the scope; the full tree is available, depth=0
  void clearScope();

  //! depth of the scope. 0 means unrestricted depth.
  int depth() const;

  //! set current node to the next node in the expanded tree
  bool next();

  //! broad search order of next()
  bool nextB();

  //! set the current node to the next sibling ...
  bool nextSibling();

  //! set the current node to the first child ...
  bool firstChild();

  //! set the current node to the parent node ...
  bool parent();

  //! true, if a call to firstChild() would succeed (current node has at least one child)
  //bool hasChildren() const;

  //! clears the scope and sets the ExpandedView to its root-node
  void reset();

  /* was protected, now public; was named goTo, now goToHistory*/
  bool goToHistory(const DDGeoHistory &sc);

protected:
  bool descend(const DDGeoHistory &sc);

protected:
  WalkerType *walker_;  //!< the tricky walker
  WalkerType w2_;
  const DDTranslation trans_;
  const DDRotationMatrix rot_;
  DDGeoHistory history_;       //!< std::vector of DDExpandedNode
  DDGeoHistory scope_;         //!< scope of the expanded view
  unsigned int depth_;         //!< depth of the scope, 0==unrestricted depth
  const DDPosData *worldpos_;  //!< ???
  std::vector<nav_type> nextBStack_;
  const DDCompactView *cpv_;
};

std::string printNavType(int const *n, size_t sz);
inline std::ostream &operator<<(std::ostream &os, const DDExpandedView::nav_type &n) {
  os << printNavType(&n.front(), n.size());
  return os;
}
inline std::ostream &operator<<(std::ostream &os, const DDExpandedView::NavRange &n) {
  os << printNavType(n.first, n.second);
  return os;
}
#endif