dd4hep::Author Class Reference

Handle class describing an author entity. More...

#include <Objects.h>

Inheritance diagram for dd4hep::Author:

Public Member Functions
	Author ()=default
	Default constructor. More...
	Author (const Author &e)=default
	Constructorto be used for assignment from a handle. More...
template<typename Q >
	Author (const Handle< Q > &e)
	Constructor to be used when assigning already valid handle. More...
	Author (Detector &doc)
	Constructor to be used when creating a new object. More...
Author &	operator= (const Author &e)=default
	Assignment operator. More...
std::string	authorName () const
	Access the author's name. More...
void	setAuthorName (const std::string &nam)
	Set the author's name. More...
std::string	authorEmail () const
	Access the author's email address. More...
void	setAuthorEmail (const std::string &addr)
	Set the author's email address. More...
Public Member Functions inherited from dd4hep::Handle< T >
	Handle ()=default
	Default constructor. More...
	Handle (Handle< T > &&element)=default
	Copy constructor. More...
	Handle (const Handle< T > &element)=default
	Copy constructor. More...
	Handle (T *element)
	Initializing constructor from pointer. More...
template<typename Q >
	Handle (Q *element)
	Initializing constructor from unrelated pointer with type checking. More...
template<typename Q >
	Handle (const Handle< Q > &element)
	Initializing constructor from unrelated handle with type checking. More...
Handle< T > &	operator= (Handle< T > &&element)=default
	Assignment move operator. More...
Handle< T > &	operator= (const Handle< T > &element)=default
	Assignment copy operator. More...
bool	operator== (const Handle< T > &element) const
	Boolean operator == used for RB tree insertions. More...
bool	operator< (const Handle< T > &element) const
	Boolean operator < used for RB tree insertions. More...
bool	operator> (const Handle< T > &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< T > &	clear ()
	Release the object held by the handle. More...
T *	operator-> () const
	Access the held object using the -> operator. More...
	operator T& () const
	Automatic type conversion to an object references. More...
T &	operator* () const
	Access the held object using the * operator. More...
T *	ptr () const
	Access to the held object. More...
template<typename Q >
Q *	_ptr () const
	Access to an unrelated object type. More...
template<typename Q >
Q *	data () const
	Access to an unrelated object type. More...
template<typename Q >
Q &	object () const
	Access to an unrelated object type. More...
T *	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...
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	destroy ()
	Destroy the underlying object (be careful here: things are not reference counted)! More...
void	assign (_Segmentation *s, const std::string &n, const std::string &)
const char *	name () const
const char *	name () const
void	assign (NamedObject *p, const std::string &n, const std::string &t)

Additional Inherited Members
Public Types inherited from dd4hep::Handle< T >
typedef T	Object
	Extern accessible definition of the contained element type. More...
typedef Handle< T >	Base
	Self type: used by sub-classes. More...
Static Public Member Functions inherited from dd4hep::Handle< T >
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< T >
T *	m_element {nullptr}
	Single and only data member: Reference to the actual element. More...

Detailed Description

Handle class describing an author entity.

Author

M.Frank

Version

1.0

Definition at line 127 of file Objects.h.

Constructor & Destructor Documentation

Author() [1/4]

dd4hep::Author::Author ( )

default

Default constructor.

Author() [2/4]

dd4hep::Author::Author ( const Author &  e )

default

Constructorto be used for assignment from a handle.

Author() [3/4]

template<typename Q >

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

inline

Constructor to be used when assigning already valid handle.

Definition at line 134 of file Objects.h.

Author() [4/4]

Author::Author

(

Detector &

doc

)

Constructor to be used when creating a new object.

Constructor to be used when creating a new DOM tree.

Definition at line 36 of file Objects.cpp.

Member Function Documentation

authorEmail()

std::string Author::authorEmail

(

)

const

Access the author's email address.

Definition at line 51 of file Objects.cpp.

authorName()

std::string Author::authorName

(

)

const

Access the author's name.

Definition at line 41 of file Objects.cpp.

operator=()

Author& dd4hep::Author::operator= ( const Author &  e )

default

Assignment operator.

setAuthorEmail()

void Author::setAuthorEmail

(

const std::string &

addr

)

Set the author's email address.

Definition at line 56 of file Objects.cpp.

setAuthorName()

void Author::setAuthorName

(

const std::string &

nam

)

Set the author's name.

Definition at line 46 of file Objects.cpp.

---

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

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