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

Constructor & Destructor Documentation

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

Constructor: which parameter are we a proxy for?

Definition at line 107 of file parameter_accessor.h.

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

Member Function Documentation

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

Getter: get the value of the parameter we access.

Definition at line 148 of file parameter_accessor.h.

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

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

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

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

143 { _accessor.set(_accessor.get() / value_divisor); return *this; }
ParameterAccessor< T > & _accessor
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 113 of file parameter_accessor.h.

113 { _accessor.set(new_value); return *this; }
ParameterAccessor< T > & _accessor
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 118 of file parameter_accessor.h.

118 { _accessor.set(new_value.get()); }
ParameterAccessor< T > & _accessor
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 123 of file parameter_accessor.h.

References libMesh::ConstParameterProxy< T >::get().

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

Member Data Documentation

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

Definition at line 151 of file parameter_accessor.h.


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