LArSoft  v09_90_00
Liquid Argon Software toolkit - https://larsoft.org/
geo::part::AreaOwner Class Reference

A basic interface for objects owning an area. More...

#include "Partitions.h"

Inheritance diagram for geo::part::AreaOwner:
geo::part::PartitionBase TPCwithArea_t 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 > geo::part::SortedPartition< Data, details::PartitionSorterByAreaRangeLower< Range > > geo::part::PartitionSortedByRange< Data, Range > geo::part::PartitionSortedByRange< Data,&PartitionBase::Area_t::depth > geo::part::PartitionSortedByRange< Data,&PartitionBase::Area_t::width > geo::part::DepthPartition< Data > geo::part::WidthPartition< Data >

Public Types

using Area_t = lar::util::simple_geo::Rectangle< double >
 Type of area covered by the partition. More...
 
using AreaRangeMember_t = Area_t::Range_t(Area_t::*)
 Type of pointer to Area_t data member of type Range_t. More...
 

Public Member Functions

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

Private Attributes

Area_t myArea
 Covered area. More...
 

Detailed Description

A basic interface for objects owning an area.

Definition at line 37 of file Partitions.h.

Member Typedef Documentation

Type of area covered by the partition.

Definition at line 41 of file Partitions.h.

Type of pointer to Area_t data member of type Range_t.

Definition at line 44 of file Partitions.h.

Constructor & Destructor Documentation

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

Constructor: sets the covered area and no subpartitions.

Definition at line 47 of file Partitions.h.

47 : myArea(area) {}
Area_t myArea
Covered area.
Definition: Partitions.h:63
Area_t const & area() const
Returns the covered area.
Definition: Partitions.h:53

Member Function Documentation

Area_t const& geo::part::AreaOwner::area ( ) const
inline
bool geo::part::AreaOwner::contains ( double  w,
double  d 
) const
inline

Returns whether the specified point is covered by this object.

Definition at line 50 of file Partitions.h.

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

50 { 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:442
Float_t d
Definition: plot.C:235
Area_t const & area() const
Returns the covered area.
Definition: Partitions.h:53
Float_t w
Definition: plot.C:20
template<typename Stream >
void geo::part::AreaOwner::dumpArea ( Stream &&  out) const
inline

Output the owned area into an output stream.

Definition at line 57 of file Partitions.h.

References area().

Referenced by geo::part::PartitionBase::describeArea().

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

Member Data Documentation

Area_t geo::part::AreaOwner::myArea
private

Covered area.

Definition at line 63 of file Partitions.h.

Referenced by area().


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