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

Stream	type of output stream
Data	type of data to be described

Parameters

out	output stream
data	pointer to the data to be described
indent	indentation string applied to all lines except the first
firstIndent	special 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().

{
  geo::part::PartitionDataDescriber<Data>
    (std::forward<Stream>(out), data, indent, firstIndent);
} // geo::part::describePartitionData()