reactions::element_wrapper< Element > Class Template Reference

Template for elements of a reaction or decay. More...

#include <processes.hpp>

Public Member Functions
	element_wrapper (Element &&e)
	Constructor given the underlying element. More...
	~element_wrapper ()=default
	Default destructor. More...
	element_wrapper (const element_wrapper &)=default
	Copy constructor. More...
	element_wrapper (element_wrapper &&)=default
	Move constructor. More...
element_wrapper &	operator= (const element_wrapper &)=default
	Assignment constructor. More...
	element_wrapper ()=delete
Element const &	operator* () const
	Access the underlying element by reference. More...
Element const *	operator-> () const
	Access the underlying element by pointer. More...

Protected Attributes
Element	m_element
	Underlying element. More...

Detailed Description

template<class Element>
class reactions::element_wrapper< Element >

Template for elements of a reaction or decay.

This class wraps the template argument type, which becomes accessible through the * and -> operators.

Constructor & Destructor Documentation

element_wrapper() [1/4]

template<class Element >

reactions::element_wrapper< Element >::element_wrapper ( Element &&  e )

inline

Constructor given the underlying element.

~element_wrapper()

template<class Element >

reactions::element_wrapper< Element >::~element_wrapper ( )

default

Default destructor.

element_wrapper() [2/4]

template<class Element >

reactions::element_wrapper< Element >::element_wrapper ( const element_wrapper< Element > &  )

default

Copy constructor.

element_wrapper() [3/4]

template<class Element >

reactions::element_wrapper< Element >::element_wrapper ( element_wrapper< Element > &&  )

default

Move constructor.

element_wrapper() [4/4]

template<class Element >

reactions::element_wrapper< Element >::element_wrapper ( )

delete

Member Function Documentation

operator*()

template<class Element >

Element const& reactions::element_wrapper< Element >::operator* ( ) const

inline

Access the underlying element by reference.

operator->()

template<class Element >

Element const* reactions::element_wrapper< Element >::operator-> ( ) const

inline

Access the underlying element by pointer.

operator=()

template<class Element >

element_wrapper& reactions::element_wrapper< Element >::operator= ( const element_wrapper< Element > &  )

default

Assignment constructor.

Member Data Documentation

m_element

template<class Element >

Element reactions::element_wrapper< Element >::m_element

protected

Underlying element.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/reactions/checkouts/v0.1.0/include/reactions/processes.hpp