edm4eic::TrackSegment Class Reference

#include <TrackSegment.h>

Public Types
using	mutable_type = MutableTrackSegment
using	collection_type = TrackSegmentCollection

Public Member Functions
	TrackSegment ()
	default constructor
	TrackSegment (const float length, const float lengthError)
	Constructor initializing all members.
	TrackSegment (const TrackSegment &other)=default
	copy constructor
TrackSegment &	operator= (TrackSegment other) &
	copy-assignment operator
TrackSegment &	operator= (TrackSegment other) &&=delete
MutableTrackSegment	clone (bool cloneRelations=true) const
	~TrackSegment ()=default
	destructor
	TrackSegment (const MutableTrackSegment &other)
	converting constructor from mutable object
float	getLength () const
	Access the Pathlength from the first to the last point.
float	getLengthError () const
	Access the Error on the segment length.
const edm4eic::Track	getTrack () const
	Access the Track used for this projection.
std::size_t	points_size () const
edm4eic::TrackPoint	getPoints (std::size_t) const
std::vector< edm4eic::TrackPoint >::const_iterator	points_begin () const
std::vector< edm4eic::TrackPoint >::const_iterator	points_end () const
podio::RelationRange< edm4eic::TrackPoint >	getPoints () const
bool	isAvailable () const
	check whether the object is actually available
void	unlink ()
	disconnect from TrackSegmentObj instance
bool	operator== (const TrackSegment &other) const
bool	operator== (const MutableTrackSegment &other) const
bool	operator!= (const TrackSegment &other) const
bool	operator!= (const MutableTrackSegment &other) const
bool	operator< (const TrackSegment &other) const
podio::ObjectID	id () const
const podio::ObjectID	getObjectID () const

Static Public Member Functions
static TrackSegment	makeEmpty ()

Static Public Attributes
static constexpr std::string_view	typeName = "edm4eic::TrackSegment"

Friends
class	MutableTrackSegment
class	TrackSegmentCollection
class	edm4eic::TrackSegmentCollectionData
class	TrackSegmentCollectionIterator
podio::detail::OrderKey	podio::detail::getOrderKey (const TrackSegment &obj)
void	swap (TrackSegment &a, TrackSegment &b)

Detailed Description

A track segment defined by one or more points along a track.

Author

: S. Joosten

Member Typedef Documentation

collection_type

using edm4eic::TrackSegment::collection_type = TrackSegmentCollection

mutable_type

using edm4eic::TrackSegment::mutable_type = MutableTrackSegment

Constructor & Destructor Documentation

TrackSegment() [1/4]

edm4eic::TrackSegment::TrackSegment

(

)

default constructor

TrackSegment() [2/4]

edm4eic::TrackSegment::TrackSegment	(	const float	length,
		const float	lengthError )

Constructor initializing all members.

TrackSegment() [3/4]

edm4eic::TrackSegment::TrackSegment ( const TrackSegment & other )

default

copy constructor

~TrackSegment()

edm4eic::TrackSegment::~TrackSegment ( )

default

destructor

TrackSegment() [4/4]

edm4eic::TrackSegment::TrackSegment

(

const MutableTrackSegment &

other

)

converting constructor from mutable object

Member Function Documentation

clone()

MutableTrackSegment edm4eic::TrackSegment::clone

(

bool

cloneRelations = true

)

const

create a mutable deep-copy of the object with identical relations if cloneRelations=false, the relations are not cloned and will be empty

getLength()

float edm4eic::TrackSegment::getLength

(

)

const

Access the Pathlength from the first to the last point.

getLengthError()

float edm4eic::TrackSegment::getLengthError

(

)

const

Access the Error on the segment length.

getObjectID()

const podio::ObjectID edm4eic::TrackSegment::getObjectID

(

)

const

getPoints() [1/2]

podio::RelationRange< edm4eic::TrackPoint > edm4eic::TrackSegment::getPoints

(

)

const

getPoints() [2/2]

edm4eic::TrackPoint edm4eic::TrackSegment::getPoints

(

std::size_t

index

)

const

getTrack()

const edm4eic::Track edm4eic::TrackSegment::getTrack

(

)

const

Access the Track used for this projection.

id()

podio::ObjectID edm4eic::TrackSegment::id ( ) const

inline

isAvailable()

bool edm4eic::TrackSegment::isAvailable

(

)

const

check whether the object is actually available

makeEmpty()

TrackSegment edm4eic::TrackSegment::makeEmpty ( )

static

operator!=() [1/2]

bool edm4eic::TrackSegment::operator!= ( const MutableTrackSegment & other ) const

inline

operator!=() [2/2]

bool edm4eic::TrackSegment::operator!= ( const TrackSegment & other ) const

inline

operator<()

bool edm4eic::TrackSegment::operator< ( const TrackSegment & other ) const

inline

operator=() [1/2]

TrackSegment & edm4eic::TrackSegment::operator=

(

TrackSegment

other

)

&

copy-assignment operator

operator=() [2/2]

TrackSegment & edm4eic::TrackSegment::operator= ( TrackSegment other ) &&

delete

operator==() [1/2]

bool edm4eic::TrackSegment::operator==

(

const MutableTrackSegment &

other

)

const

operator==() [2/2]

bool edm4eic::TrackSegment::operator== ( const TrackSegment & other ) const

inline

points_begin()

std::vector< edm4eic::TrackPoint >::const_iterator edm4eic::TrackSegment::points_begin

(

)

const

points_end()

std::vector< edm4eic::TrackPoint >::const_iterator edm4eic::TrackSegment::points_end

(

)

const

points_size()

std::size_t edm4eic::TrackSegment::points_size

(

)

const

unlink()

void edm4eic::TrackSegment::unlink ( )

inline

disconnect from TrackSegmentObj instance

Friends And Related Symbol Documentation

edm4eic::TrackSegmentCollectionData

friend class edm4eic::TrackSegmentCollectionData

friend

MutableTrackSegment

friend class MutableTrackSegment

friend

podio::detail::getOrderKey

podio::detail::OrderKey podio::detail::getOrderKey ( const TrackSegment & obj )

friend

swap

void swap ( TrackSegment & a, TrackSegment & b )

friend

TrackSegmentCollection

friend class TrackSegmentCollection

friend

TrackSegmentCollectionIterator

friend class TrackSegmentCollectionIterator

friend

Member Data Documentation

typeName

std::string_view edm4eic::TrackSegment::typeName = "edm4eic::TrackSegment"

staticconstexpr

---

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

• build/edm4eic/TrackSegment.h
• build/src/TrackSegment.cc