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

This class represents a vertex in high energy collisions. More...

#include <Vertex.hh>

+ Inheritance diagram for pxl::Vertex:
+ Collaboration diagram for pxl::Vertex:

Public Member Functions

void addVector (const Basic3Vector &vector)
 Adds the passed three-vector to this vertex. More...
 
void addVertex (const Vertex *vx)
 Adds the passed three-vector of the passed vertex to this vertex. More...
 
void addXYZ (double x, double y, double z)
 Add the passed x, y, z values to the vertex point. More...
 
virtual Serializableclone () const
 Returns a clone of this vertex. 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...
 
const Basic3VectorgetVector () const
 This method grants read access to the vector. More...
 
double getX () const
 Returns the x component of the vertex. More...
 
double getY () const
 Returns the y component of the vertex. More...
 
double getZ () const
 Returns the z component of the vertex. More...
 
const Vertexoperator+= (const Vertex &vx)
 Adds the vector of vx. More...
 
const Vertexoperator-= (const Vertex &vx)
 Subtracts the vector of vx. More...
 
virtual std::ostream & print (int level=1, std::ostream &os=std::cout, int pan=0) const
 Prints information about this vertex to the passed stream os. More...
 
virtual void serialize (const OutputStream &out) const
 This method serializes this object by serializing the type ID and the unique object ID. More...
 
void setVector (const Basic3Vector &vector)
 Directly set the contained three-vector. More...
 
void setX (double x)
 Set the x component of the vertex. More...
 
void setXYZ (double x, double y, double z)
 Set the x, y and z components of the vertex. More...
 
void setY (double y)
 Set the y component of the vertex. More...
 
void setZ (double z)
 Set the z component of the vertex. More...
 
 Vertex ()
 
 Vertex (const Vertex &original)
 
 Vertex (const Vertex *original)
 
- Public Member Functions inherited from pxl::Object
virtual WkPtrBasecreateSelfWkPtr ()
 Creates a weak pointer to itself and returns a pxl::WkPtrBase* to the newly-created weak pointer instance. More...
 
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)
 
- Public Member Functions inherited from pxl::CommonVertex
virtual ~CommonVertex ()
 

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 a vertex in high energy collisions.

It contains a three-vector and can hold further properties of the decay vertex via the user records. In addition, relations to other objects, e.g. particles, can be established.

Constructor & Destructor Documentation

pxl::Vertex::Vertex ( )
inline
pxl::Vertex::Vertex ( const Vertex original)
inline
pxl::Vertex::Vertex ( const Vertex original)
inlineexplicit

Member Function Documentation

void pxl::Vertex::addVector ( const Basic3Vector vector)
inline

Adds the passed three-vector to this vertex.

void pxl::Vertex::addVertex ( const Vertex vx)
inline

Adds the passed three-vector of the passed vertex to this vertex.

void pxl::Vertex::addXYZ ( double  x,
double  y,
double  z 
)
inlinevirtual

Add the passed x, y, z values to the vertex point.

Implements pxl::CommonVertex.

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

Returns a clone of this vertex.

Reimplemented from pxl::Object.

virtual void pxl::Vertex::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::Vertex::getStaticTypeId ( )
inlinestatic
virtual const Id& pxl::Vertex::getTypeId ( ) const
inlinevirtual

Returns the unique ID of this class.

Reimplemented from pxl::Object.

const Basic3Vector& pxl::Vertex::getVector ( ) const
inline

This method grants read access to the vector.

double pxl::Vertex::getX ( ) const
inlinevirtual

Returns the x component of the vertex.

Implements pxl::CommonVertex.

double pxl::Vertex::getY ( ) const
inlinevirtual

Returns the y component of the vertex.

Implements pxl::CommonVertex.

double pxl::Vertex::getZ ( ) const
inlinevirtual

Returns the z component of the vertex.

Implements pxl::CommonVertex.

const Vertex& pxl::Vertex::operator+= ( const Vertex vx)
inline

Adds the vector of vx.

const Vertex& pxl::Vertex::operator-= ( const Vertex vx)
inline

Subtracts the vector of vx.

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

Prints information about this vertex to the passed stream os.

Reimplemented from pxl::Object.

virtual void pxl::Vertex::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.

void pxl::Vertex::setVector ( const Basic3Vector vector)
inline

Directly set the contained three-vector.

void pxl::Vertex::setX ( double  x)
inlinevirtual

Set the x component of the vertex.

Implements pxl::CommonVertex.

void pxl::Vertex::setXYZ ( double  x,
double  y,
double  z 
)
inlinevirtual

Set the x, y and z components of the vertex.

Implements pxl::CommonVertex.

void pxl::Vertex::setY ( double  y)
inlinevirtual

Set the y component of the vertex.

Implements pxl::CommonVertex.

void pxl::Vertex::setZ ( double  z)
inlinevirtual

Set the z component of the vertex.

Implements pxl::CommonVertex.


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