libMesh
Public Member Functions | Private Attributes | List of all members
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 (const ParameterProxy< T > &accessor)=default
 Default Copy Constructor works. More...
 
ParameterProxyoperator= (const T &new_value)
 Setter: change the value of the parameter we access. More...
 
ParameterProxyoperator= (const ParameterProxy< T > &new_value)
 Setter: change the value of the parameter we access. More...
 
ParameterProxyoperator= (const ConstParameterProxy< T > &new_value)
 Setter: change the value of the parameter we access. More...
 
ParameterProxyoperator+= (const T &value_increment)
 Setter: change the value of the parameter we access. More...
 
ParameterProxyoperator-= (const T &value_decrement)
 Setter: change the value of the parameter we access. More...
 
ParameterProxyoperator*= (const T &value_multiplier)
 Setter: change the value of the parameter we access. More...
 
ParameterProxyoperator/= (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() [1/2]

template<typename T = Number>
libMesh::ParameterProxy< T >::ParameterProxy ( ParameterAccessor< T > &  accessor)
inline

Constructor: which parameter are we a proxy for?

Definition at line 99 of file parameter_accessor.h.

100  : _accessor(accessor) {}
ParameterAccessor< T > & _accessor

◆ ParameterProxy() [2/2]

template<typename T = Number>
libMesh::ParameterProxy< T >::ParameterProxy ( const ParameterProxy< T > &  accessor)
default

Default Copy Constructor works.

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 148 of file parameter_accessor.h.

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

148 { return _accessor.get().backend(); }
ParameterAccessor< 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 145 of file parameter_accessor.h.

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

145 { return _accessor.get(); }
ParameterAccessor< 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 135 of file parameter_accessor.h.

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

135 { _accessor.set(_accessor.get() * value_multiplier); return *this; }
ParameterAccessor< 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 125 of file parameter_accessor.h.

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

125 { _accessor.set(_accessor.get() + value_increment); return *this; }
ParameterAccessor< 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 130 of file parameter_accessor.h.

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

130 { _accessor.set(_accessor.get() - value_decrement); return *this; }
ParameterAccessor< 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 140 of file parameter_accessor.h.

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

140 { _accessor.set(_accessor.get() / value_divisor); return *this; }
ParameterAccessor< T > & _accessor

◆ operator=() [1/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 110 of file parameter_accessor.h.

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

110 { _accessor.set(new_value); return *this; }
ParameterAccessor< T > & _accessor

◆ 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 115 of file parameter_accessor.h.

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

115 { _accessor.set(new_value.get()); }
ParameterAccessor< T > & _accessor

◆ operator=() [3/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 120 of file parameter_accessor.h.

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

120 { _accessor.set(new_value.get()); return *this; }
ParameterAccessor< T > & _accessor

Member Data Documentation

◆ _accessor

template<typename T = Number>
ParameterAccessor<T>& libMesh::ParameterProxy< T >::_accessor
private

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