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.

49 : myArea(area) {}

geo::part::AreaOwner::myArea

Area_t myArea

Covered area.

Definition: Partitions.h:63

geo::part::AreaOwner::area

Area_t const & area() const

Returns the covered area.

Definition: Partitions.h:56

Member Function Documentation

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

inline

Returns the covered area.

Definition at line 56 of file Partitions.h.

56 { return myArea; }

geo::part::AreaOwner::myArea

Area_t myArea

Covered area.

Definition: Partitions.h:63

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.

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

lar::util::simple_geo::Rectangle::contains

bool contains(Data_t w, Data_t d) const

Returns whether the specified point is in the area.

Definition: SimpleGeo.h:408

geo::part::AreaOwner::area

Area_t const & area() const

Returns the covered area.

Definition: Partitions.h:56

gen_crt_frags.w

tuple w

Definition: gen_crt_frags.py:1416

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.

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

geo::part::AreaOwner::area

Area_t const & area() const

Returns the covered area.

Definition: Partitions.h:56

Member Data Documentation

Area_t geo::part::AreaOwner::myArea

private

Covered area.

Definition at line 63 of file Partitions.h.

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

Partitions.h