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

Partition-related utilities. More...

Namespaces

 details
 

Classes

class  AreaOwner
 A basic interface for objects owning an area. More...
 
class  DepthPartition
 Partition of area along the depth dimension. More...
 
class  GridPartition
 A container of partitions organised in a width/depth rectangular grid. More...
 
class  Partition
 Base element of a partitioned structure. More...
 
class  PartitionBase
 Non-template definitions and data for Partition class hierarchy. More...
 
class  PartitionContainer
 Partition divided in subpartitions (abstract). More...
 
struct  PartitionDataDescriber
 Class providing custom dump for data contained in the partition. More...
 
struct  PartitionDataDescriber< geo::TPCGeo >
 Describes a geo::TPCGeo object for Partition::describe(). More...
 
class  PartitionElement
 Unpartitioned element ("leaf") of a partitioned area. More...
 
class  PartitionSortedByRange
 Partition of area along a area range dimension (width or depth). More...
 
class  PartitionWithData
 Partition also containing data directly. More...
 
class  SortedPartition
 Partition of area sorted across a dimension. More...
 
class  WidthPartition
 Partition of area along the width dimension. More...
 

Functions

template<typename Stream , typename Data >
void describePartitionData (Stream &&out, Data const *data, std::string indent="", std::string firstIndent="")
 Describes a data object for Partition::describe() method. More...
 

Detailed Description

Partition-related utilities.

Function Documentation

template<typename Stream , typename Data >
void geo::part::describePartitionData ( Stream &&  out,
Data const *  data,
std::string  indent = "",
std::string  firstIndent = "" 
)

Describes a data object for Partition::describe() method.

Template Parameters
Streamtype of output stream
Datatype of data to be described
Parameters
outoutput stream
datapointer to the data to be described
indentindentation string applied to all lines except the first
firstIndentspecial indentation string for the first line

The description of the data pointed by data is printed into the output stream out. The first line of the output is indented with firstIndent string (by default: no indent), while all the others are indented with the string indent (by default, also no indent). The last output line is not ended by a end-of-line character.

This function relies on PartitionDataDescriber template class, that should be specialized to customize the printout of known data types.

Definition at line 784 of file Partitions.h.

Referenced by geo::part::PartitionWithData< Data >::doDescribe(), geo::part::PartitionContainer< Data >::doDescribe(), and geo::part::GridPartition< Data >::doDescribe().

788 {
790  (std::forward<Stream>(out), data, indent, firstIndent);
791 } // geo::part::describePartitionData()
Class providing custom dump for data contained in the partition.
Definition: Partitions.h:97
std::string indent(std::size_t const i)