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

Private Attributes

ParameterAccessor< T > & _accessor
 

Detailed Description

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

Definition at line 37 of file parameter_accessor.h.

Constructor & Destructor Documentation

◆ ParameterProxy()

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

Constructor: which parameter are we a proxy for?

Definition at line 110 of file parameter_accessor.h.

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

Member Function Documentation

◆ operator T()

template<typename T = Number>
libMesh::ParameterProxy< T >::operator T ( ) const

Getter: get the value of the parameter we access.

Definition at line 151 of file parameter_accessor.h.

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

151 { return _accessor.get(); }
ParameterAccessor< T > & _accessor

◆ operator*=()

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

Setter: change the value of the parameter we access.

Definition at line 141 of file parameter_accessor.h.

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

141 { _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)

Setter: change the value of the parameter we access.

Definition at line 131 of file parameter_accessor.h.

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

131 { _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)

Setter: change the value of the parameter we access.

Definition at line 136 of file parameter_accessor.h.

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

136 { _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)

Setter: change the value of the parameter we access.

Definition at line 146 of file parameter_accessor.h.

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

146 { _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)

Setter: change the value of the parameter we access.

Definition at line 116 of file parameter_accessor.h.

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

116 { _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)

Setter: change the value of the parameter we access.

Definition at line 121 of file parameter_accessor.h.

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

121 { _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)

Setter: change the value of the parameter we access.

Definition at line 126 of file parameter_accessor.h.

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

126 { _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: