Handle class describing a set of limits as they are used for simulation. More...

#include <Objects.h>

Inheritance diagram for dd4hep::LimitSet:

Public Types
typedef std::set< Limit >	Set
	Iterator definitions. More...

typedef std::set< Limit >::iterator	iterator

typedef std::set< Limit >::const_iterator	const_iterator

Public Types inherited from dd4hep::Handle< LimitSetObject >
typedef LimitSetObject	Object
	Extern accessible definition of the contained element type. More...

typedef Handle< LimitSetObject >	Base
	Self type: used by sub-classes. More...

Public Member Functions
	LimitSet ()=default
	Constructor to be used when reading the already parsed DOM tree. More...

	LimitSet (const LimitSet &e)=default
	Copy constructor for handle. More...

	LimitSet (const Handle< LimitSetObject > &e)
	Copy constructor for handles. More...

template<typename Q >
	LimitSet (const Handle< Q > &e)
	Constructor to be used when reading the already parsed DOM tree. More...

LimitSet &	operator= (const LimitSet &c)=default
	Assignment operator. More...

	LimitSet (const std::string &name)
	Constructor to be used when creating a new object. More...

bool	addLimit (const Limit &limit)
	Add new limit. Returns true if the new limit was added, false if it already existed. More...

const std::set< Limit > &	limits () const
	Accessor to limits container. More...

bool	addCut (const Limit &limit)
	Add new limit. Returns true if the new limit was added, false if it already existed. More...

const std::set< Limit > &	cuts () const
	Accessor to limits container. More...

Public Member Functions inherited from dd4hep::Handle< LimitSetObject >
	Handle ()=default
	Default constructor. More...

	Handle (Handle< LimitSetObject > &&element)=default
	Copy constructor. More...

	Handle (const Handle< LimitSetObject > &element)=default
	Copy constructor. More...

	Handle (LimitSetObject *element)
	Initializing constructor from pointer. More...

	Handle (Q *element)
	Initializing constructor from unrelated pointer with type checking. More...

	Handle (const Handle< Q > &element)
	Initializing constructor from unrelated handle with type checking. More...

Handle< LimitSetObject > &	operator= (Handle< LimitSetObject > &&element)=default
	Assignment move operator. More...

Handle< LimitSetObject > &	operator= (const Handle< LimitSetObject > &element)=default
	Assignment copy operator. More...

bool	operator== (const Handle< LimitSetObject > &element) const
	Boolean operator == used for RB tree insertions. More...

bool	operator< (const Handle< LimitSetObject > &element) const
	Boolean operator < used for RB tree insertions. More...

bool	operator> (const Handle< LimitSetObject > &element) const
	Boolean operator > used for RB tree insertions. More...

bool	isValid () const
	Check the validity of the object held by the handle. More...

bool	operator! () const
	Check the validity of the object held by the handle. More...

Handle< LimitSetObject > &	clear ()
	Release the object held by the handle. More...

LimitSetObject *	operator-> () const
	Access the held object using the -> operator. More...

	operator LimitSetObject & () const
	Automatic type conversion to an object references. More...

LimitSetObject &	operator* () const
	Access the held object using the * operator. More...

LimitSetObject *	ptr () const
	Access to the held object. More...

Q *	_ptr () const
	Access to an unrelated object type. More...

Q *	data () const
	Access to an unrelated object type. More...

Q &	object () const
	Access to an unrelated object type. More...

LimitSetObject *	access () const
	Checked object access. Throws invalid handle runtime exception if invalid handle. More...

const char *	name () const
	Access the object name (or "" if not supported by the object) More...

const char *	name () const

const char *	name () const

void	assign (Object *n, const std::string &nam, const std::string &title)
	Assign a new named object. Note: object references must be managed by the user. More...

void	assign (_Segmentation *s, const std::string &n, const std::string &)

void	assign (NamedObject *p, const std::string &n, const std::string &t)

void	destroy ()
	Destroy the underlying object (be careful here: things are not reference counted)! More...

Additional Inherited Members
Static Public Member Functions inherited from dd4hep::Handle< LimitSetObject >
static void	bad_assignment (const std::type_info &from, const std::type_info &to)
	Helper routine called when unrelated types are assigned. More...

Public Attributes inherited from dd4hep::Handle< LimitSetObject >
LimitSetObject *	m_element
	Single and only data member: Reference to the actual element. More...

Detailed Description

Handle class describing a set of limits as they are used for simulation.

The class manages the production cuts and the limits for a given simulation region. Currently known clients of this objects are simulation programs.

Author: M.Frank

Version: 1.0

Definition at line 425 of file Objects.h.

Member Typedef Documentation

◆ const_iterator

typedef std::set<Limit>::const_iterator dd4hep::LimitSet::const_iterator

Definition at line 430 of file Objects.h.

◆ iterator

typedef std::set<Limit>::iterator dd4hep::LimitSet::iterator

Definition at line 429 of file Objects.h.

◆ Set

typedef std::set<Limit> dd4hep::LimitSet::Set

Iterator definitions.

Definition at line 428 of file Objects.h.

Constructor & Destructor Documentation

◆ LimitSet() [1/5]

dd4hep::LimitSet::LimitSet ( )

default

Constructor to be used when reading the already parsed DOM tree.

◆ LimitSet() [2/5]

dd4hep::LimitSet::LimitSet ( const LimitSet & e )

default

Copy constructor for handle.

◆ LimitSet() [3/5]

dd4hep::LimitSet::LimitSet ( const Handle< LimitSetObject > & e )

inline

Copy constructor for handles.

Definition at line 438 of file Objects.h.

◆ LimitSet() [4/5]

template<typename Q >

dd4hep::LimitSet::LimitSet ( const Handle< Q > & e )

inline

Constructor to be used when reading the already parsed DOM tree.

Definition at line 441 of file Objects.h.

◆ LimitSet() [5/5]

LimitSet::LimitSet ( const std::string & name )

Constructor to be used when creating a new object.

Constructor to be used when creating a new DOM tree.

Definition at line 453 of file Objects.cpp.

Member Function Documentation

◆ addCut()

bool LimitSet::addCut ( const Limit & limit )

Add new limit. Returns true if the new limit was added, false if it already existed.

Definition at line 470 of file Objects.cpp.

◆ addLimit()

bool LimitSet::addLimit ( const Limit & limit )

Add new limit. Returns true if the new limit was added, false if it already existed.

Definition at line 458 of file Objects.cpp.

◆ cuts()

const std::set< Limit > & LimitSet::cuts ( ) const

Accessor to limits container.

Definition at line 476 of file Objects.cpp.

◆ limits()

const std::set< Limit > & LimitSet::limits ( ) const

Accessor to limits container.

Definition at line 464 of file Objects.cpp.

◆ operator=()

LimitSet& dd4hep::LimitSet::operator= ( const LimitSet & c )

default

Assignment operator.

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

DDCore/include/DD4hep/Objects.h
DDCore/src/Objects.cpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ iterator

◆ Set

Constructor & Destructor Documentation

◆ LimitSet() [1/5]

◆ LimitSet() [2/5]

◆ LimitSet() [3/5]

◆ LimitSet() [4/5]

◆ LimitSet() [5/5]

Member Function Documentation

◆ addCut()

◆ addLimit()

◆ cuts()

◆ limits()

◆ operator=()