geo::part::PartitionWithData< Data > Class Template Reference

Partition also containing data directly. More...

#include "Partitions.h"

Inheritance diagram for geo::part::PartitionWithData< Data >:

Public Types
using	Base_t = Partition< Data >
	Base class. More...
using	Partition_t = Partition< Data >
	Base type of the partition. More...
using	Data_t = typename Partition_t::Data_t
	Type of contained data. More...
using	Area_t = typename Partition_t::Area_t
	Type of covered area. More...
using	Subpartitions_t = std::vector< std::unique_ptr< Partition_t const >>
	Type of list of subpartitions. It needs to preserve polymorphism. More...
using	AreaRangeMember_t = AreaOwner::AreaRangeMember_t

Public Member Functions
	PartitionWithData (Area_t const &area, Data_t *myData)
	Constructor: sets the covered area and the contained datum. More...
virtual Data_t *	data () const override
	Returns the datum directly stored (nullptr if none). More...
virtual Data_t *	atPoint (double w, double d) const override
	Returns stored datum only if point is covered, nullptr otherwise. More...
std::string	describe (std::string indent, std::string firstIndent) const
	Returns a description of the partition. More...
std::string	describe (std::string indent="") const
	Returns a description of the partition. More...
template<typename Pred >
void	walk (Pred &&pred) const
	Applies pred to all partitions. More...
std::size_t	nParts () const
	Returns the number of subparts in the partition (0 if simple element). 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
virtual Subpartitions_t const &	parts () const
	Returns a list of all subpartitions. More...
std::string	describeArea (std::string indent, std::string firstIndent) const
	Returns a description of the partition area. More...

Static Protected Member Functions
template<typename Pred >
static void	walk (Partition_t const *start, Pred &&pred)

Static Protected Attributes
static Subpartitions_t const	NoSubparts
	Subpartitions (if any). More...

Private Member Functions
virtual std::string	doDescribe (std::string indent, std::string firstIndent) const override
	Returns a description of the partition. More...

Private Attributes
Data_t *	myData
	The contained datum. More...

Detailed Description

template<typename Data>
class geo::part::PartitionWithData< Data >

Partition also containing data directly.

Definition at line 273 of file Partitions.h.

Member Typedef Documentation

template<typename Data >

using geo::part::PartitionWithData< Data >::Area_t = typename Partition_t::Area_t

Type of covered area.

Definition at line 279 of file Partitions.h.

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

inherited

Definition at line 145 of file Partitions.h.

template<typename Data >

using geo::part::PartitionWithData< Data >::Base_t = Partition<Data>

Base class.

Definition at line 276 of file Partitions.h.

template<typename Data >

using geo::part::PartitionWithData< Data >::Data_t = typename Partition_t::Data_t

Type of contained data.

Definition at line 278 of file Partitions.h.

template<typename Data >

using geo::part::PartitionWithData< Data >::Partition_t = Partition<Data>

Base type of the partition.

Definition at line 277 of file Partitions.h.

template<typename Data>

using geo::part::Partition< Data >::Subpartitions_t = std::vector<std::unique_ptr<Partition_t const>>

inherited

Type of list of subpartitions. It needs to preserve polymorphism.

Definition at line 191 of file Partitions.h.

Constructor & Destructor Documentation

template<typename Data >

geo::part::PartitionWithData< Data >::PartitionWithData ( Area_t const &  area, Data_t *  myData  )

inline

Constructor: sets the covered area and the contained datum.

Definition at line 282 of file Partitions.h.

: Base_t(area), myData(myData) {}

Member Function Documentation

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

inlineinherited

Returns the covered area.

Definition at line 53 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; }

template<typename Data >

virtual Data_t* geo::part::PartitionWithData< Data >::atPoint ( double  w, double  d  ) const

inlineoverridevirtual

Returns stored datum only if point is covered, nullptr otherwise.

Implements geo::part::Partition< Data >.

Reimplemented in geo::part::PartitionContainer< Data >.

Definition at line 288 of file Partitions.h.

      {
        return Base_t::contains(w, d) ? myData : nullptr;
      }

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

inlineinherited

Returns whether the specified point is covered by this object.

Definition at line 50 of file Partitions.h.

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

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

template<typename Data >

virtual Data_t* geo::part::PartitionWithData< Data >::data ( ) const

inlineoverridevirtual

Returns the datum directly stored (nullptr if none).

Reimplemented from geo::part::Partition< Data >.

Definition at line 285 of file Partitions.h.

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

{ return myData; }

template<typename Data>

std::string geo::part::Partition< Data >::describe ( std::string  indent, std::string  firstIndent  ) const

inlineinherited

Returns a description of the partition.

Definition at line 215 of file Partitions.h.

      {
        return doDescribe(indent, firstIndent);
      }

template<typename Data>

std::string geo::part::Partition< Data >::describe ( std::string  indent = "" ) const

inlineinherited

Returns a description of the partition.

Definition at line 221 of file Partitions.h.

References geo::part::Partition< Data >::describe(), and art::detail::indent().

Referenced by geo::part::Partition< Data >::describe().

{ return describe(indent, indent); }

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

inlineprotectedinherited

Returns a description of the partition area.

Definition at line 575 of file Partitions.h.

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

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

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

template<typename Data >

std::string geo::part::PartitionWithData< Data >::doDescribe ( std::string  indent, std::string  firstIndent  ) const

overrideprivatevirtual

Returns a description of the partition.

Reimplemented from geo::part::Partition< Data >.

Reimplemented in geo::part::GridPartition< Data >, and geo::part::PartitionContainer< Data >.

Definition at line 763 of file Partitions.h.

References geo::part::describePartitionData().

{
  std::string msg = Base_t::doDescribe(indent, firstIndent);
  if (data()) {
    std::ostringstream sstr;
    sstr << ": ";
    describePartitionData(sstr, data(), indent);
    msg += sstr.str();
  }
  else {
    msg += " (no data)";
  }
  return msg;
} // geo::part::PartitionWithData<Data>::doDescribe()

template<typename Stream >

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

inlineinherited

Output the owned area into an output stream.

Definition at line 57 of file Partitions.h.

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

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

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

template<typename Data>

std::size_t geo::part::Partition< Data >::nParts ( ) const

inlineinherited

Returns the number of subparts in the partition (0 if simple element).

Definition at line 247 of file Partitions.h.

Referenced by geo::part::GridPartition< Data >::detectSeparators().

{ return parts().size(); }

template<typename Data>

virtual Subpartitions_t const& geo::part::Partition< Data >::parts ( ) const

inlineprotectedvirtualinherited

Returns a list of all subpartitions.

Reimplemented in geo::part::PartitionContainer< Data >.

Definition at line 253 of file Partitions.h.

Referenced by geo::part::Partition< Data >::walk().

{ return NoSubparts; }

template<typename Data>

template<typename Pred >

void geo::part::Partition< Data >::walk ( Pred &&  pred ) const

inlineinherited

Applies pred to all partitions.

Template Parameters

Pred	a predicate type

Parameters

pred	the predicate to be applied

The predicate pred is applied to this partition first, and then to all subpartitions in no specified order.

The predicate is any object behaving like a unary function of signature:

void predicate(Partition<Data> const& part);

If the predicate returns a value, that value is ignored. The predicate is forwarded while "walking" through the partitions.

Definition at line 241 of file Partitions.h.

      {
        walk(this, pred);
      }

template<typename Data >

template<typename Pred >

void geo::part::Partition< Data >::walk ( Partition_t const *  start, Pred &&  pred  )

staticprotectedinherited

Applies pred to start partition first, and then to all subpartitions.

Definition at line 748 of file Partitions.h.

References geo::part::Partition< Data >::parts().

{
  if (!start) return;
  pred(*start);

  // recursive implementation
  for (auto const& subPart : start->parts())
    subPart->walk(std::forward<Pred>(pred));

} // geo::part::Partition<Data>::walk()

Member Data Documentation

template<typename Data >

Data_t* geo::part::PartitionWithData< Data >::myData

private

The contained datum.

Definition at line 294 of file Partitions.h.

template<typename Data>

geo::part::Partition< Data >::Subpartitions_t const geo::part::Partition< Data >::NoSubparts

staticprotectedinherited

Subpartitions (if any).

Definition at line 250 of file Partitions.h.

---

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

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