geo::part::PartitionBase Class Reference

Non-template definitions and data for Partition class hierarchy. More...

#include "Partitions.h"

Inheritance diagram for geo::part::PartitionBase:

Public Types
using	Area_t = AreaOwner::Area_t
using	AreaRangeMember_t = AreaOwner::AreaRangeMember_t

Public Member Functions
	PartitionBase (Area_t const &area)
	Constructor: sets the covered area and no subpartitions. More...
bool	contains (double w, double d) const
	Returns whether the specified point is covered by this object. More...
Area_t const &	area () const
	Returns the covered area. More...
template<typename Stream >
void	dumpArea (Stream &&out) const
	Output the owned area into an output stream. More...

Protected Member Functions
std::string	describeArea (std::string indent, std::string firstIndent) const
	Returns a description of the partition area. More...

Detailed Description

Non-template definitions and data for Partition class hierarchy.

The partition base class provides a common non-templated ground for all Partition hierarchies. The class defines an area that the partition cover, as a rectangle. The dimensions of this rectangle, called "width" and "depth", don't have to match any axis from any 3D coordinate system.

Definition at line 142 of file Partitions.h.

Member Typedef Documentation

using geo::part::PartitionBase::Area_t = AreaOwner::Area_t

Definition at line 146 of file Partitions.h.

using geo::part::PartitionBase::AreaRangeMember_t = AreaOwner::AreaRangeMember_t

Definition at line 147 of file Partitions.h.

Constructor & Destructor Documentation

geo::part::PartitionBase::PartitionBase ( Area_t const &  area )

inline

Constructor: sets the covered area and no subpartitions.

Definition at line 150 of file Partitions.h.

References art::detail::indent().

: AreaOwner(area) {}

Member Function Documentation

Area_t const& geo::part::AreaOwner::area ( ) const

inlineinherited

Returns the covered area.

Definition at line 56 of file Partitions.h.

References geo::part::AreaOwner::myArea.

Referenced by geo::part::AreaOwner::contains(), geo::part::AreaOwner::dumpArea(), makeTPCPartitionElement(), geo::part::details::RangeLowerBoundExtractor< Range >::operator()(), and geo::part::details::PartitionRangeLowerBoundExtractor< Range >::operator()().

{ return myArea; }

bool geo::part::AreaOwner::contains ( double  w, double  d  ) const

inlineinherited

Returns whether the specified point is covered by this object.

Definition at line 52 of file Partitions.h.

References geo::part::AreaOwner::area(), and lar::util::simple_geo::Rectangle< Data >::contains().

        { return area().contains(w, d); }

std::string geo::part::PartitionBase::describeArea ( std::string  indent, std::string  firstIndent  ) const

inlineprotected

Returns a description of the partition area.

Definition at line 606 of file Partitions.h.

References geo::part::AreaOwner::dumpArea(), and part.

Referenced by geo::part::Partition< Data >::doDescribe(), and geo::part::GridPartition< Data >::part().

{
  std::ostringstream sstr;
  sstr << firstIndent << "partition covers ";
  dumpArea(sstr);
  return sstr.str();
} // geo::part::PartitionBase::describeArea()

template<typename Stream >

void geo::part::AreaOwner::dumpArea ( Stream &&  out ) const

inlineinherited

Output the owned area into an output stream.

Definition at line 60 of file Partitions.h.

References geo::part::AreaOwner::area().

Referenced by describeArea().

{ std::forward<Stream>(out) << area(); }

---

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

• larcorealg/v1_24_01/source/larcorealg/Geometry/Partitions.h