icarus::details::ROPnumberDispatcher Class Reference

Algorithm assigning IDs to readout planes. More...

Public Member Functions
	ROPnumberDispatcher (std::vector< PlaneColl_t > const &refROP, std::string const &logCategory)
	Constructor: uses refROP as reference to assign number ranges to views. More...
void	setTPCset (readout::TPCsetID const &TPCset)
	Rests the object to work with the specified TPC set next. More...
readout::ROPID	assignID (PlaneColl_t const &ROP)
	Returns the next available ID for the specified ROP. More...

Static Public Member Functions
static geo::View_t	ROPview (PlaneColl_t const &planes)
	Returns the view of the planes (geo::kUnknown if mixed or none). More...

Private Types
template<typename T >
using	DataByView_t = std::map< geo::View_t, T >
	Type of collection of T by view. More...

Private Member Functions
DataByView_t< unsigned int >	ViewROPcounts (std::vector< PlaneColl_t > const &ROPplanes) const
	Returns the number of planes with each view. More...
DataByView_t < readout::ROPID::ROPID_t >	PreferredROPrangesByView (std::vector< PlaneColl_t > const &ROPs) const
	Returns the fist ROP number for each view in ROP. More...

Private Attributes
std::string const	fLogCategory
	Log category name for messages. More...
DataByView_t < readout::ROPID::ROPID_t > const	fFirstROPno
	The first ROP number for each view. More...
DataByView_t < readout::ROPID::ROPID_t >	fAvailableROPno
	The first available ROP number for each view. More...
readout::TPCsetID	fTPCset
	The TPC set being served. More...

Detailed Description

Algorithm assigning IDs to readout planes.

The usage workflow is the following:

1. the algorithm is initialized with a TPC set to be taken as model (constructor);
2. a new TPC set is declared (setTPCset());
3. for each readout plane, an ID is requested (assignID());
4. if more TPC sets need to follow the same reference, repeat steps 2 and 3.

The assignment of the ROP number is in blocks according to the view. The distribution between different views is first come, first serve: the first ROP within a certain view conquers the lowest number still available for all the ROP's within that view.

The algorithm assumes that all TPC sets have the same view composition as the model one used in the constructor. If this requirement is violated, the behavior is undefined (but it's likely that a ROP ID will be assigned multiple times).

Definition at line 216 of file ROPandTPCsetBuildingAlg.cxx.

Member Typedef Documentation

template<typename T >

using icarus::details::ROPnumberDispatcher::DataByView_t = std::map<geo::View_t, T>

private

Type of collection of T by view.

Definition at line 220 of file ROPandTPCsetBuildingAlg.cxx.

Constructor & Destructor Documentation

icarus::details::ROPnumberDispatcher::ROPnumberDispatcher ( std::vector< PlaneColl_t > const &  refROP, std::string const &  logCategory  )

inline

Constructor: uses refROP as reference to assign number ranges to views.

Definition at line 244 of file ROPandTPCsetBuildingAlg.cxx.

    : fLogCategory(logCategory)
    , fFirstROPno(PreferredROPrangesByView(refROP))
    , fAvailableROPno(fFirstROPno)
    {}

Member Function Documentation

readout::ROPID icarus::details::ROPnumberDispatcher::assignID ( PlaneColl_t const &  ROP )

inline

Returns the next available ID for the specified ROP.

Definition at line 255 of file ROPandTPCsetBuildingAlg.cxx.

    { return { fTPCset, fAvailableROPno.at(ROPview(ROP))++ }; }

auto icarus::details::ROPnumberDispatcher::PreferredROPrangesByView ( std::vector< PlaneColl_t > const &  ROPs ) const

private

Returns the fist ROP number for each view in ROP.

Definition at line 266 of file ROPandTPCsetBuildingAlg.cxx.

{
  /*
   * ROP numbers are assigned in blocks of views, on a first come, first serve
   * basis.
   * This, the first ROP on a view books as many ROP numbers as there are ROPs
   * with that view.
   */
  DataByView_t<unsigned int> const viewROPcounts = ViewROPcounts(ROPs);
  
  DataByView_t<readout::ROPID::ROPID_t> FirstROPno;
  readout::ROPID::ROPID_t nextAvailable { 0 };
  
  for (PlaneColl_t const& planes: ROPs) {
    
    geo::View_t const view = ROPview(planes);
    
    //
    // using the facts that:
    // * std::map::emplace() does not insert anything if the key already exists
    // * std::map::emplace() returns as `second` whether it insert or not
    //
    if (!FirstROPno.emplace(view, nextAvailable).second) continue;
    
    mf::LogTrace(fLogCategory)
      << "ROPs on view " << geo::PlaneGeo::ViewName(view)
      << " preferring numbers from " << nextAvailable
      << " (" << viewROPcounts.at(view) << " numbers reserved)";
    
    // so, insertion happened; let's reserve numbers
    nextAvailable += viewROPcounts.at(view);
    
  } // for ROPs
  
  return FirstROPno;
  
} // icarus::details::ROPnumberDispatcher::PreferredROPrangesByView()

geo::View_t icarus::details::ROPnumberDispatcher::ROPview ( PlaneColl_t const &  planes )

static

Returns the view of the planes (geo::kUnknown if mixed or none).

Definition at line 336 of file ROPandTPCsetBuildingAlg.cxx.

{
  auto iPlane = planes.begin();
  auto const pend = planes.end();
  if (iPlane == pend) return geo::kUnknown;
  geo::View_t const view = (*iPlane)->View();
  while (++iPlane != pend) {
    if ((*iPlane)->View() !=view) return geo::kUnknown;
  } // while
  return view;
} // icarus::details::ROPnumberDispatcher::ROPview()

void icarus::details::ROPnumberDispatcher::setTPCset ( readout::TPCsetID const &  TPCset )

inline

Rests the object to work with the specified TPC set next.

Definition at line 251 of file ROPandTPCsetBuildingAlg.cxx.

    { fTPCset = TPCset; fAvailableROPno = fFirstROPno; }

auto icarus::details::ROPnumberDispatcher::ViewROPcounts ( std::vector< PlaneColl_t > const &  ROPplanes ) const

private

Returns the number of planes with each view.

Definition at line 308 of file ROPandTPCsetBuildingAlg.cxx.

{
  DataByView_t<unsigned int> viewROPcounts;
  
  for (PlaneColl_t const& planes: ROPplanes) {
    if (planes.empty()) continue;
    
    geo::View_t const view = ROPview(planes);
    if (view == geo::kUnknown) {
      mf::LogWarning log(fLogCategory);
      log << "A ROP spans multiple views:";
      for (geo::PlaneGeo const* plane: planes) {
        log << " " << geo::PlaneGeo::ViewName(plane->View())
          << " (" << plane->ID() << ")";
      }
    } // if unknown
    
    ++(viewROPcounts[view]);
    
  } // for ROPs
  
  return viewROPcounts;
} // icarus::details::ROPnumberDispatcher::ViewROPcounts()

Member Data Documentation

DataByView_t<readout::ROPID::ROPID_t> icarus::details::ROPnumberDispatcher::fAvailableROPno

private

The first available ROP number for each view.

Definition at line 228 of file ROPandTPCsetBuildingAlg.cxx.

DataByView_t<readout::ROPID::ROPID_t> const icarus::details::ROPnumberDispatcher::fFirstROPno

private

The first ROP number for each view.

Definition at line 225 of file ROPandTPCsetBuildingAlg.cxx.

std::string const icarus::details::ROPnumberDispatcher::fLogCategory

private

Log category name for messages.

Definition at line 222 of file ROPandTPCsetBuildingAlg.cxx.

readout::TPCsetID icarus::details::ROPnumberDispatcher::fTPCset

private

The TPC set being served.

Definition at line 231 of file ROPandTPCsetBuildingAlg.cxx.

---

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

• ROPandTPCsetBuildingAlg.cxx