PXL
Public Member Functions | Static Public Member Functions
pxl::Collision Class Reference

This class represents individual interactions in multicollision events. More...

#include <Collision.hh>

+ Inheritance diagram for pxl::Collision:
+ Collaboration diagram for pxl::Collision:

Public Member Functions

virtual Serializableclone () const
 Creates a deep copy and returns a C++ pointer to the newly-created object. More...
 
 Collision ()
 
 Collision (const Collision &original)
 This copy constructor provides a deep copy of the event container original with all data members, hep objects, and their (redirected) relations. More...
 
 Collision (const Collision *original)
 This copy constructor provides a deep copy of the event container original with all data members, hep objects, and their (redirected) relations. More...
 
virtual WkPtrBasecreateSelfWkPtr ()
 Creates a weak pointer to itself and returns a pxl::WkPtrBase* to the newly-created weak pointer instance. More...
 
virtual void deserialize (const InputStream &in)
 This method deserializes this object. More...
 
virtual const IdgetTypeId () const
 Returns the unique ID of this class. More...
 
virtual std::ostream & print (int level=1, std::ostream &os=std::cout, int pan=0) const
 Prints out object state information on various verbosity levels. More...
 
virtual void serialize (const OutputStream &out) const
 This method serializes this object by serializing the type ID and the unique object ID. More...
 
- Public Member Functions inherited from pxl::Object
int getWorkFlag () const
 Returns the value of the workflag. More...
 
bool isLocked () const
 Returns the value of the lock flag. More...
 
 Object ()
 
 Object (const Object &original)
 
 Object (const Object *original)
 
virtual std::ostream & printContent (int level=1, std::ostream &os=std::cout, int pan=0) const
 
void setLocked (bool v)
 Sets the value of the lock flag to v. More...
 
void setWorkFlag (int v)
 Sets the value of the workflag to v. More...
 
- Public Member Functions inherited from pxl::Relative
RelativegetDaughter () const
 Returns the first entry of the daughter relations. More...
 
const RelationsgetDaughterRelations () const
 Grants const access to the pxl::Relations instance managing daughter relations. More...
 
const std::set< Relative * > & getDaughters () const
 Returns all daughter relations. More...
 
const RelationsgetFlatRelations () const
 Grants const access to the pxl::Relations instance managing flat relations. More...
 
RelativegetMother () const
 Returns the first entry of the mother relations. More...
 
const RelationsgetMotherRelations () const
 Grants const access to the Relations instance managing mother relations. More...
 
const std::set< Relative * > & getMothers () const
 Returns all mother relations. More...
 
const std::string & getName () const
 Returns the name. More...
 
const SoftRelationsgetSoftRelations () const
 Get access to the soft relations. More...
 
SoftRelationsgetSoftRelations ()
 Get access to the soft relations. More...
 
Id id () const
 Returns the PXL unique object-id (UUID) More...
 
void linkDaughter (Relative *target)
 Establishes a daughter relation to the target object; please notice, that only relations between objects owned by the same object owner will be established. More...
 
void linkFlat (Relative *target)
 Establishes a flat relation to the target object; please notice, that only relations between objects owned by the same object owner will be established. More...
 
void linkMother (Relative *target)
 Establishes a mother relation to the target object; please notice, that only relations between objects owned by the same object owner will be established. More...
 
void linkSoft (Relative *relative, const std::string &type)
 Create a soft relation with name type to the Relative relative. More...
 
size_t numberOfDaughters () const
 Returns number of daughters. More...
 
size_t numberOfMothers () const
 Returns number of mothers. More...
 
ObjectOwnerowner () const
 Returns a C++ pointer to the pxl::ObjectOwner it is owned by. More...
 
std::ostream & printDecayTree (int level=0, std::ostream &os=std::cout, int pan=1) const
 Recursively invokes its own and the print() methods of all daughter objects. More...
 
void setName (const std::string &v)
 Sets the name to the contents of v. More...
 
void unlinkDaughter (Relative *target)
 Removes an existing daughter relation to the target object. More...
 
void unlinkDaughters ()
 Removes all existing daughter relations. More...
 
void unlinkFlat (Relative *target)
 Removes an existing daughter relation to the target object. More...
 
void unlinkFlat ()
 Removes all existing flat relations. More...
 
void unlinkMother (Relative *target)
 Removes an existing daughter relation to the target object. More...
 
void unlinkMothers ()
 Removes all existing mother relations. More...
 
void unlinkSoft (Relative *relative, const std::string &type)
 Remove a soft relation with name type to the Relative relative. More...
 
virtual ~Relative ()
 Destructor, ensures safe deletion of all hard relations. More...
 
- Public Member Functions inherited from pxl::Serializable
const IdgetId () const
 Returns the unique ID (UUID) of the individual object. More...
 
Serializableoperator= (const Serializable &original)
 Assignment operator, UUID is changed in case this object is changed. More...
 
 Serializable ()
 Constructor. More...
 
 Serializable (const Serializable &original)
 Copy constructor. A copied object gets a new unique ID. More...
 
virtual const std::string toString () const
 Returns a string with the output of the virtual print method. More...
 
virtual ~Serializable ()
 Destructor. More...
 
- Public Member Functions inherited from pxl::UserRecordHelper
void deserialize (const InputStream &in)
 
void eraseUserRecord (const std::string &key)
 
const VariantgetUserRecord (const std::string &key) const
 
template<typename datatype >
bool getUserRecord (const std::string &key, datatype &item) const
 
const UserRecordsgetUserRecords () const
 
UserRecordsgetUserRecords ()
 
bool hasUserRecord (const std::string &key) const
 
void serialize (const OutputStream &out) const
 
void setUserRecord (const std::string &key, const Variant &value)
 
void setUserRecords (const UserRecords &value)
 

Static Public Member Functions

static const IdgetStaticTypeId ()
 
- Static Public Member Functions inherited from pxl::Object
static const IdgetStaticTypeId ()
 
- Static Public Member Functions inherited from pxl::Relative
static const IdgetStaticTypeId ()
 

Additional Inherited Members

- Protected Member Functions inherited from pxl::Relative
std::ostream & printPan (std::ostream &os, int pan) const
 Service method for printing relations tree. More...
 
std::ostream & printPan1st (std::ostream &os, int pan) const
 Service method for printing relations tree. More...
 
 Relative ()
 Default constructor. More...
 
 Relative (const Relative &original)
 Copy constructor. Relations are not copied. More...
 
 Relative (const Relative *original)
 Copy constructor. Relations are not copied. More...
 

Detailed Description

This class represents individual interactions in multicollision events.

It allows the separation of different collisions as they occur at high-rate hadron colliders by providing the relation management necessary to associate pxl::Vertex or pxl::Particle objects, for instance.

Constructor & Destructor Documentation

pxl::Collision::Collision ( )
inline
pxl::Collision::Collision ( const Collision original)
inline

This copy constructor provides a deep copy of the event container original with all data members, hep objects, and their (redirected) relations.

pxl::Collision::Collision ( const Collision original)
inlineexplicit

This copy constructor provides a deep copy of the event container original with all data members, hep objects, and their (redirected) relations.

Member Function Documentation

virtual Serializable* pxl::Collision::clone ( ) const
inlinevirtual

Creates a deep copy and returns a C++ pointer to the newly-created object.

Reimplemented from pxl::Object.

virtual WkPtrBase* pxl::Collision::createSelfWkPtr ( )
inlinevirtual

Creates a weak pointer to itself and returns a pxl::WkPtrBase* to the newly-created weak pointer instance.

Reimplemented from pxl::Object.

virtual void pxl::Collision::deserialize ( const InputStream in)
inlinevirtual

This method deserializes this object.

When extending this method, derived classes must first call the base class method.

Reimplemented from pxl::Object.

static const Id& pxl::Collision::getStaticTypeId ( )
inlinestatic
virtual const Id& pxl::Collision::getTypeId ( ) const
inlinevirtual

Returns the unique ID of this class.

Reimplemented from pxl::Object.

std::ostream & pxl::Collision::print ( int  level = 1,
std::ostream &  os = std::cout,
int  pan = 0 
) const
virtual

Prints out object state information on various verbosity levels.

Parameters
levelverbosity level
osoutput _stream, default is std::cout
panprint indention
Returns
output _stream

Reimplemented from pxl::Object.

virtual void pxl::Collision::serialize ( const OutputStream out) const
inlinevirtual

This method serializes this object by serializing the type ID and the unique object ID.

When extending this method, derived classes must first call the base class method.

Reimplemented from pxl::Object.


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