Handle class describing the basic information about geometry objects as it is defined in Detector. More...

#include <Objects.h>

Inheritance diagram for dd4hep::Header:

Public Member Functions
	Header ()=default
	Default constructor. More...

	Header (const Header &copy)=default
	Constructorto be used for assignment from a handle. More...

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

	Header (const std::string &author, const std::string &url)
	Constructor to be used when creating a new DOM tree. More...

Header &	operator= (const Header &copy)=default
	Assignment operator. More...

const std::string	name () const
	Accessor to object name. More...

void	setName (const std::string &new_name)
	Accessor: set object name. More...

const std::string	title () const
	Accessor to object title. More...

void	setTitle (const std::string &new_title)
	Accessor: set object title. More...

const std::string &	author () const
	Accessor to object author. More...

void	setAuthor (const std::string &new_author)
	Accessor: set object author. More...

const std::string &	url () const
	Accessor to object url. More...

void	setUrl (const std::string &new_url)
	Accessor: set object url. More...

const std::string &	status () const
	Accessor to object status. More...

void	setStatus (const std::string &new_status)
	Accessor: set object status. More...

const std::string &	version () const
	Accessor to object version. More...

void	setVersion (const std::string &new_version)
	Accessor: set object version. More...

const std::string &	comment () const
	Accessor to object comment. More...

void	setComment (const std::string &new_comment)
	Accessor: set object comment. More...

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

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

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

	Handle (HeaderObject *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< HeaderObject > &	operator= (Handle< HeaderObject > &&element)=default
	Assignment move operator. More...

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

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

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

bool	operator> (const Handle< HeaderObject > &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< HeaderObject > &	clear ()
	Release the object held by the handle. More...

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

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

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

HeaderObject *	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...

HeaderObject *	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
Public Types inherited from dd4hep::Handle< HeaderObject >
typedef HeaderObject	Object
	Extern accessible definition of the contained element type. More...

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

Static Public Member Functions inherited from dd4hep::Handle< HeaderObject >
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< HeaderObject >
HeaderObject *	m_element
	Single and only data member: Reference to the actual element. More...

Detailed Description

Handle class describing the basic information about geometry objects as it is defined in Detector.

Description of the geometry header. Containes useful auxiliary information.

Author: M.Frank

Version: 1.0

Definition at line 157 of file Objects.h.

Constructor & Destructor Documentation

◆ Header() [1/4]

dd4hep::Header::Header ( )

default

Default constructor.

◆ Header() [2/4]

dd4hep::Header::Header ( const Header & copy )

default

Constructorto be used for assignment from a handle.

◆ Header() [3/4]

template<typename Q >

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

inline

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

Definition at line 164 of file Objects.h.

◆ Header() [4/4]

Header::Header	(	const std::string &	author,
		const std::string &	url
	)

Constructor to be used when creating a new DOM tree.

Definition at line 61 of file Objects.cpp.

Member Function Documentation

◆ author()

const std::string & Header::author ( ) const

Accessor to object author.

Definition at line 97 of file Objects.cpp.

◆ comment()

const std::string & Header::comment ( ) const

Accessor to object comment.

Definition at line 127 of file Objects.cpp.

◆ name()

const std::string Header::name ( ) const

Accessor to object name.

Definition at line 67 of file Objects.cpp.

◆ operator=()

Header& dd4hep::Header::operator= ( const Header & copy )

default

Assignment operator.

◆ setAuthor()

void Header::setAuthor ( const std::string & new_author )

Accessor: set object author.

Definition at line 102 of file Objects.cpp.

◆ setComment()

void Header::setComment ( const std::string & new_comment )

Accessor: set object comment.

Definition at line 132 of file Objects.cpp.

◆ setName()

void Header::setName ( const std::string & new_name )

Accessor: set object name.

Definition at line 72 of file Objects.cpp.

◆ setStatus()

void Header::setStatus ( const std::string & new_status )

Accessor: set object status.

Definition at line 112 of file Objects.cpp.

◆ setTitle()

void Header::setTitle ( const std::string & new_title )

Accessor: set object title.

Definition at line 82 of file Objects.cpp.

◆ setUrl()

void Header::setUrl ( const std::string & new_url )

Accessor: set object url.

Definition at line 92 of file Objects.cpp.

◆ setVersion()

void Header::setVersion ( const std::string & new_version )

Accessor: set object version.

Definition at line 122 of file Objects.cpp.

◆ status()

const std::string & Header::status ( ) const

Accessor to object status.

Definition at line 107 of file Objects.cpp.

◆ title()

const std::string Header::title ( ) const

Accessor to object title.

Definition at line 77 of file Objects.cpp.

◆ url()

const std::string & Header::url ( ) const

Accessor to object url.

Definition at line 87 of file Objects.cpp.

◆ version()

const std::string & Header::version ( ) const

Accessor to object version.

Definition at line 117 of file Objects.cpp.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Header() [1/4]

◆ Header() [2/4]

◆ Header() [3/4]

◆ Header() [4/4]

Member Function Documentation

◆ author()

◆ comment()

◆ name()

◆ operator=()

◆ setAuthor()

◆ setComment()

◆ setName()

◆ setStatus()

◆ setTitle()

◆ setUrl()

◆ setVersion()

◆ status()

◆ title()

◆ url()

◆ version()