HepMC3 event record library
Data Structures | Namespaces | Macros | Typedefs | Functions
Relatives.h File Reference

Detailed Description

Defines helper classes to extract relatives of an input GenParticle or GenVertex.

Definition in file Relatives.h.

#include <vector>
#include "HepMC3/GenParticle.h"
#include "HepMC3/GenVertex.h"
+ Include dependency graph for Relatives.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

class  _parents
 Provides operator to find the parent particles of a Vertex or Particle. More...
 
class  _children
 Provides operator to find the child particles of a Vertex or Particle. More...
 
class  Relatives
 Define a common interface that all Relatives objects will satisfy Relatives provides an operator to get the relatives of a range of different GenObject types. The following are examples. More...
 
class  RelativesInterface< Relative_type >
 forward declare the Relatives interface in which _parents and _children are wrapped More...
 
class  Recursive< Relation_type >
 forward declare the recursion wrapper More...
 
class  Recursive< Relation_type >::hasId
 hasID More...
 
class  Recursive< Relation_type >::idInterface< ID_type >
 iDinterface More...
 

Namespaces

namespace  HepMC3
 HepMC3 main namespace.
 

Typedefs

using Parents = RelativesInterface< _parents >
 alias of _parents wrapped in the Relatives interface
 
using Children = RelativesInterface< _children >
 alias of _children wrapped in the Relatives interface
 
using Ancestors = RelativesInterface< Recursive< _parents > >
 Ancestors is an alias to Recursion applied to the _parents and wrapped in the Relatives interface.
 
using Descendants = RelativesInterface< Recursive< _children > >
 Descendants is an alias to Recursion applied to the _children and wrapped in the Relatives interface.
 

Functions

std::vector< HepMC3::GenParticlePtr > children_particles (HepMC3::GenVertexPtr O)
 Return children particles.
 
std::vector< HepMC3::ConstGenParticlePtr > children_particles (HepMC3::ConstGenVertexPtr O)
 Return children particles.
 
std::vector< HepMC3::GenVertexPtr > children_vertices (HepMC3::GenParticlePtr O)
 Return children vertices.
 
std::vector< HepMC3::ConstGenVertexPtr > children_vertices (HepMC3::ConstGenParticlePtr O)
 Return children vertices.
 
std::vector< HepMC3::GenParticlePtr > grandchildren_particles (HepMC3::GenParticlePtr O)
 Return grandchildren particles.
 
std::vector< HepMC3::ConstGenParticlePtr > grandchildren_particles (HepMC3::ConstGenParticlePtr O)
 Return grandchildren particles.
 
std::vector< HepMC3::GenVertexPtr > grandchildren_vertices (HepMC3::GenVertexPtr O)
 Return grandchildren vertices.
 
std::vector< HepMC3::ConstGenVertexPtr > grandchildren_vertices (HepMC3::ConstGenVertexPtr O)
 Return grandchildren vertices.
 
std::vector< HepMC3::GenParticlePtr > parent_particles (HepMC3::GenVertexPtr O)
 Return parent particles.
 
std::vector< HepMC3::ConstGenParticlePtr > parent_particles (HepMC3::ConstGenVertexPtr O)
 Return parent particles.
 
std::vector< HepMC3::GenVertexPtr > parent_vertices (HepMC3::GenParticlePtr O)
 Return parent vertices.
 
std::vector< HepMC3::ConstGenVertexPtr > parent_vertices (HepMC3::ConstGenParticlePtr O)
 Return parent vertices.
 
std::vector< HepMC3::GenParticlePtr > grandparent_particles (HepMC3::GenParticlePtr O)
 Return grandparent particles.
 
std::vector< HepMC3::ConstGenParticlePtr > grandparent_particles (HepMC3::ConstGenParticlePtr O)
 Return grandparent particles.
 
std::vector< HepMC3::GenVertexPtr > grandparent_vertices (HepMC3::GenVertexPtr O)
 Return grandparent vertices.
 
std::vector< HepMC3::ConstGenVertexPtr > grandparent_vertices (HepMC3::ConstGenVertexPtr O)
 Return grandparent vertices.
 
std::vector< HepMC3::ConstGenParticlePtr > descendant_particles (HepMC3::ConstGenVertexPtr obj)
 Return descendant particles.
 
std::vector< HepMC3::GenParticlePtr > descendant_particles (HepMC3::GenVertexPtr obj)
 Return descendant particles.
 
std::vector< HepMC3::ConstGenParticlePtr > descendant_particles (HepMC3::ConstGenParticlePtr obj)
 Return descendant particles.
 
std::vector< HepMC3::GenParticlePtr > descendant_particles (HepMC3::GenParticlePtr obj)
 Return descendant particles.
 
std::vector< HepMC3::ConstGenVertexPtr > descendant_vertices (HepMC3::ConstGenParticlePtr obj)
 Return descendant vertices.
 
std::vector< HepMC3::GenVertexPtr > descendant_vertices (HepMC3::GenParticlePtr obj)
 Return descendant vertices.
 
std::vector< HepMC3::ConstGenVertexPtr > descendant_vertices (HepMC3::ConstGenVertexPtr obj)
 Return descendant vertices.
 
std::vector< HepMC3::GenVertexPtr > descendant_vertices (HepMC3::GenVertexPtr obj)
 Return descendant vertices.
 
std::vector< HepMC3::ConstGenParticlePtr > ancestor_particles (HepMC3::ConstGenVertexPtr obj)
 Return ancestor particles.
 
std::vector< HepMC3::GenParticlePtr > ancestor_particles (HepMC3::GenVertexPtr obj)
 Return ancestor particles.
 
std::vector< HepMC3::ConstGenParticlePtr > ancestor_particles (HepMC3::ConstGenParticlePtr obj)
 Return ancestor particles.
 
std::vector< HepMC3::GenParticlePtr > ancestor_particles (HepMC3::GenParticlePtr obj)
 Return ancestor particles.
 
std::vector< HepMC3::ConstGenVertexPtr > ancestor_vertices (HepMC3::ConstGenParticlePtr obj)
 Return ancestor vertices.
 
std::vector< HepMC3::GenVertexPtr > ancestor_vertices (HepMC3::GenParticlePtr obj)
 Return ancestor vertices.
 
std::vector< HepMC3::ConstGenVertexPtr > ancestor_vertices (HepMC3::ConstGenVertexPtr obj)
 Return ancestor vertices.
 
std::vector< HepMC3::GenVertexPtr > ancestor_vertices (HepMC3::GenVertexPtr obj)
 Return ancestor vertices.
 

Macro Definition Documentation

◆ HEPMC3search_Relatives_EXPORT_API

#define HEPMC3search_Relatives_EXPORT_API

Definition at line 19 of file Relatives.h.