geo::part::AreaOwner Class Reference

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

#include "Partitions.h"

Inheritance diagram for geo::part::AreaOwner:

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 39 of file Partitions.h.

Member Typedef Documentation

using geo::part::AreaOwner::Area_t = lar::util::simple_geo::Rectangle<double>

Type of area covered by the partition.

Definition at line 43 of file Partitions.h.

using geo::part::AreaOwner::AreaRangeMember_t = Area_t::Range_t (Area_t::*)

Type of pointer to Area_t data member of type Range_t.

Definition at line 46 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 49 of file Partitions.h.

: myArea(area) {}

Member Function Documentation

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

inline

Returns the covered area.

Definition at line 56 of file Partitions.h.

References myArea.

Referenced by contains(), 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

inline

Returns whether the specified point is covered by this object.

Definition at line 52 of file Partitions.h.

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

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

template<typename Stream >

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

inline

Output the owned area into an output stream.

Definition at line 60 of file Partitions.h.

References area().

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

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

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:

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