libMesh::ParameterProxy< T > Class Template Reference

#include <parameter_accessor.h>

Public Member Functions
	ParameterProxy (ParameterAccessor< T > &accessor)
	Constructor: which parameter are we a proxy for? More...
ParameterProxy &	operator= (const T &new_value)
	Setter: change the value of the parameter we access. More...
ParameterProxy &	operator= (const ParameterProxy< T > &new_value)
	Setter: change the value of the parameter we access. More...
ParameterProxy &	operator= (const ConstParameterProxy< T > &new_value)
	Setter: change the value of the parameter we access. More...
ParameterProxy &	operator+= (const T &value_increment)
	Setter: change the value of the parameter we access. More...
ParameterProxy &	operator-= (const T &value_decrement)
	Setter: change the value of the parameter we access. More...
ParameterProxy &	operator*= (const T &value_multiplier)
	Setter: change the value of the parameter we access. More...
ParameterProxy &	operator/= (const T &value_divisor)
	Setter: change the value of the parameter we access. More...
	operator T () const
	Getter: get the value of the parameter we access. More...
	operator boost::multiprecision::backends::float128_backend () const

Private Attributes
ParameterAccessor< T > &	_accessor

Detailed Description

template<typename T = Number>
class libMesh::ParameterProxy< T >

Definition at line 36 of file parameter_accessor.h.

Constructor & Destructor Documentation

ParameterProxy()

template<typename T = Number>

libMesh::ParameterProxy< T >::ParameterProxy ( ParameterAccessor< T > &  accessor )

inline

Constructor: which parameter are we a proxy for?

Definition at line 109 of file parameter_accessor.h.

    : _accessor(accessor) {}

Member Function Documentation

operator boost::multiprecision::backends::float128_backend()

template<typename T = Number>

libMesh::ParameterProxy< T >::operator boost::multiprecision::backends::float128_backend ( ) const

inline

Definition at line 153 of file parameter_accessor.h.

{ return _accessor.get().backend(); }

References libMesh::ParameterProxy< T >::_accessor.

operator T()

template<typename T = Number>

libMesh::ParameterProxy< T >::operator T ( ) const

inline

Getter: get the value of the parameter we access.

Definition at line 150 of file parameter_accessor.h.

{ return _accessor.get(); }

References libMesh::ParameterProxy< T >::_accessor.

operator*=()

template<typename T = Number>

ParameterProxy& libMesh::ParameterProxy< T >::operator*= ( const T &  value_multiplier )

inline

Setter: change the value of the parameter we access.

Definition at line 140 of file parameter_accessor.h.

{ _accessor.set(_accessor.get() * value_multiplier); return *this; }

References libMesh::ParameterProxy< T >::_accessor.

operator+=()

template<typename T = Number>

ParameterProxy& libMesh::ParameterProxy< T >::operator+= ( const T &  value_increment )

inline

Setter: change the value of the parameter we access.

Definition at line 130 of file parameter_accessor.h.

{ _accessor.set(_accessor.get() + value_increment); return *this; }

References libMesh::ParameterProxy< T >::_accessor.

operator-=()

template<typename T = Number>

ParameterProxy& libMesh::ParameterProxy< T >::operator-= ( const T &  value_decrement )

inline

Setter: change the value of the parameter we access.

Definition at line 135 of file parameter_accessor.h.

{ _accessor.set(_accessor.get() - value_decrement); return *this; }

References libMesh::ParameterProxy< T >::_accessor.

operator/=()

template<typename T = Number>

ParameterProxy& libMesh::ParameterProxy< T >::operator/= ( const T &  value_divisor )

inline

Setter: change the value of the parameter we access.

Definition at line 145 of file parameter_accessor.h.

{ _accessor.set(_accessor.get() / value_divisor); return *this; }

References libMesh::ParameterProxy< T >::_accessor.

operator=() [1/3]

template<typename T = Number>

ParameterProxy& libMesh::ParameterProxy< T >::operator= ( const ConstParameterProxy< T > &  new_value )

inline

Setter: change the value of the parameter we access.

Definition at line 125 of file parameter_accessor.h.

{ _accessor.set(new_value.get()); return *this; }

References libMesh::ParameterProxy< T >::_accessor, and libMesh::ConstParameterProxy< T >::get().

operator=() [2/3]

template<typename T = Number>

ParameterProxy& libMesh::ParameterProxy< T >::operator= ( const ParameterProxy< T > &  new_value )

inline

Setter: change the value of the parameter we access.

Definition at line 120 of file parameter_accessor.h.

{ _accessor.set(new_value.get()); }

References libMesh::ParameterProxy< T >::_accessor.

operator=() [3/3]

template<typename T = Number>

ParameterProxy& libMesh::ParameterProxy< T >::operator= ( const T &  new_value )

inline

Setter: change the value of the parameter we access.

Definition at line 115 of file parameter_accessor.h.

{ _accessor.set(new_value); return *this; }

References libMesh::ParameterProxy< T >::_accessor.

Member Data Documentation

_accessor

template<typename T = Number>

ParameterAccessor<T>& libMesh::ParameterProxy< T >::_accessor

private

Definition at line 157 of file parameter_accessor.h.

Referenced by libMesh::ParameterProxy< T >::operator boost::multiprecision::backends::float128_backend(), libMesh::ParameterProxy< T >::operator T(), libMesh::ParameterProxy< T >::operator*=(), libMesh::ParameterProxy< T >::operator+=(), libMesh::ParameterProxy< T >::operator-=(), libMesh::ParameterProxy< T >::operator/=(), and libMesh::ParameterProxy< T >::operator=().

---

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

• include/systems/parameter_accessor.h