libMesh::ParameterProxy< T > Class Template Reference

#include <parameter_accessor.h>

List of all members.

Public Member Functions
	ParameterProxy (ParameterAccessor< T > &accessor)
ParameterProxy &	operator= (const T &new_value)
ParameterProxy &	operator= (const ParameterProxy< T > &new_value)
ParameterProxy &	operator= (const ConstParameterProxy< T > &new_value)
ParameterProxy &	operator+= (const T &value_increment)
ParameterProxy &	operator-= (const T &value_decrement)
ParameterProxy &	operator*= (const T &value_multiplier)
ParameterProxy &	operator/= (const T &value_divisor)
	operator T () const
Private Attributes
ParameterAccessor< T > &	_accessor

---

Detailed Description

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

Definition at line 86 of file parameter_accessor.h.

---

Constructor & Destructor Documentation

template<typename T = Number>

libMesh::ParameterProxy< T >::ParameterProxy

(

ParameterAccessor< T > &

accessor

)

[inline]

Constructor: which parameter are we a proxy for?

Definition at line 92 of file parameter_accessor.h.

    : _accessor(accessor) {}

---

Member Function Documentation

template<typename T = Number>

libMesh::ParameterProxy< T >::operator T

(

)

const [inline]

Getter: get the value of the parameter we access.

Definition at line 133 of file parameter_accessor.h.

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

{ return _accessor.get(); }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

---

Member Data Documentation

template<typename T = Number>

ParameterAccessor<T>& libMesh::ParameterProxy< T >::_accessor [private]

Definition at line 136 of file parameter_accessor.h.

Referenced by 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:

• parameter_accessor.h