Hermes2D  2.0
Hermes::Hermes2D::RefinementSelectors::ProjBasedSelector< Scalar >::ValueCacheItem< T > Struct Template Reference

An item of a value cache. More...

#include <proj_based_selector.h>

Public Member Functions

bool is_valid () const
 Returns true if value is mared as valid. More...
 
void mark (int new_state=H2DRS_VALCACHE_VALID)
 Marks a value. More...
 
void set (T new_value)
 Sets a value. More...
 
get () const
 Returns the value. It does check the state of the value. More...
 
 ValueCacheItem (const T &value=0, const int state=H2DRS_VALCACHE_INVALID)
 Constructor. More...
 

Detailed Description

template<typename Scalar>
template<typename T>
struct Hermes::Hermes2D::RefinementSelectors::ProjBasedSelector< Scalar >::ValueCacheItem< T >

An item of a value cache.

Definition at line 193 of file proj_based_selector.h.

Constructor & Destructor Documentation

template<typename Scalar>
template<typename T>
Hermes::Hermes2D::RefinementSelectors::ProjBasedSelector< Scalar >::ValueCacheItem< T >::ValueCacheItem ( const T &  value = 0,
const int  state = H2DRS_VALCACHE_INVALID 
)
inline

Constructor.

By default, the item is set as invalid.

Parameters
valueA starting value.
stateA state of the value.

Definition at line 214 of file proj_based_selector.h.

Member Function Documentation

template<typename Scalar>
template<typename T>
T Hermes::Hermes2D::RefinementSelectors::ProjBasedSelector< Scalar >::ValueCacheItem< T >::get ( ) const
inline

Returns the value. It does check the state of the value.

Returns
A current value.

Definition at line 208 of file proj_based_selector.h.

Referenced by Hermes::Hermes2D::RefinementSelectors::ProjBasedSelector< Scalar >::calc_error_cand_element().

template<typename Scalar>
template<typename T>
bool Hermes::Hermes2D::RefinementSelectors::ProjBasedSelector< Scalar >::ValueCacheItem< T >::is_valid ( ) const
inline

Returns true if value is mared as valid.

Returns
True if the value is marked as valid.

Definition at line 196 of file proj_based_selector.h.

Referenced by Hermes::Hermes2D::RefinementSelectors::ProjBasedSelector< Scalar >::calc_error_cand_element().

template<typename Scalar>
template<typename T>
void Hermes::Hermes2D::RefinementSelectors::ProjBasedSelector< Scalar >::ValueCacheItem< T >::mark ( int  new_state = H2DRS_VALCACHE_VALID)
inline

Marks a value.

Parameters
[in]new_stateA new state of the value. By default, it marks the value as valid.

Definition at line 200 of file proj_based_selector.h.

Referenced by Hermes::Hermes2D::RefinementSelectors::ProjBasedSelector< Scalar >::calc_error_cand_element().

template<typename Scalar>
template<typename T>
void Hermes::Hermes2D::RefinementSelectors::ProjBasedSelector< Scalar >::ValueCacheItem< T >::set ( new_value)
inline

Sets a value.

Parameters
[in]new_valueA new value. It does not change state of the value.

Definition at line 204 of file proj_based_selector.h.

Referenced by Hermes::Hermes2D::RefinementSelectors::ProjBasedSelector< Scalar >::calc_error_cand_element().


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