LArSoft  v06_85_00
Liquid Argon Software toolkit - http://larsoft.org/
geo::part::PartitionBase Class Reference

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

#include "Partitions.h"

Inheritance diagram for geo::part::PartitionBase:
geo::part::AreaOwner geo::part::Partition< Data > geo::part::PartitionWithData< Data > geo::part::PartitionContainer< Data > geo::part::PartitionElement< Data > geo::part::GridPartition< Data > geo::part::SortedPartition< Data, Sorter >

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

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().

150 : AreaOwner(area) {}
AreaOwner(Area_t const &area)
Constructor: sets the covered area and no subpartitions.
Definition: Partitions.h:49
Area_t const & area() const
Returns the covered area.
Definition: Partitions.h:56

Member Function Documentation

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().

53  { return area().contains(w, d); }
bool contains(Data_t w, Data_t d) const
Returns whether the specified point is in the area.
Definition: SimpleGeo.h:408
Float_t d
Definition: plot.C:237
Area_t const & area() const
Returns the covered area.
Definition: Partitions.h:56
Float_t w
Definition: plot.C:23
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().

607 {
608  std::ostringstream sstr;
609  sstr << firstIndent << "partition covers ";
610  dumpArea(sstr);
611  return sstr.str();
612 } // geo::part::PartitionBase::describeArea()
void dumpArea(Stream &&out) const
Output the owned area into an output stream.
Definition: Partitions.h:60
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().

60 { std::forward<Stream>(out) << area(); }
Area_t const & area() const
Returns the covered area.
Definition: Partitions.h:56

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