viennashe::const_quantity< AssociatedT, ValueT > Class Template Reference

Common representation of any quantity associated with objects of a certain type. More...

#include <simulator_quantity.hpp>

Public Types
typedef const_quantity< AssociatedT, ValueT >	self_type
typedef ValueT	value_type
typedef AssociatedT	associated_type
typedef associated_type	access_type

Public Member Functions
	const_quantity (std::string quan_name, std::size_t num_values, value_type default_value=value_type())
	const_quantity (std::string quan_name, std::vector< ValueT > const &values_array)
	const_quantity (self_type const &o)
void	operator= (self_type const &o)
ValueT	get_value (associated_type const &elem) const
ValueT	at (associated_type const &elem) const
ValueT	operator() (associated_type const &elem) const
std::string	name () const

Detailed Description

template<typename AssociatedT, typename ValueT = double>
class viennashe::const_quantity< AssociatedT, ValueT >

Common representation of any quantity associated with objects of a certain type.

This is the minimum requirement one can have: Return value for a vertex/cell.

Definition at line 51 of file simulator_quantity.hpp.

Member Typedef Documentation

access_type

template<typename AssociatedT , typename ValueT = double>

typedef associated_type viennashe::const_quantity< AssociatedT, ValueT >::access_type

Definition at line 58 of file simulator_quantity.hpp.

associated_type

template<typename AssociatedT , typename ValueT = double>

typedef AssociatedT viennashe::const_quantity< AssociatedT, ValueT >::associated_type

Definition at line 57 of file simulator_quantity.hpp.

self_type

template<typename AssociatedT , typename ValueT = double>

typedef const_quantity<AssociatedT, ValueT> viennashe::const_quantity< AssociatedT, ValueT >::self_type

Definition at line 54 of file simulator_quantity.hpp.

value_type

template<typename AssociatedT , typename ValueT = double>

typedef ValueT viennashe::const_quantity< AssociatedT, ValueT >::value_type

Definition at line 56 of file simulator_quantity.hpp.

Constructor & Destructor Documentation

const_quantity() [1/3]

template<typename AssociatedT , typename ValueT = double>

viennashe::const_quantity< AssociatedT, ValueT >::const_quantity ( std::string  quan_name, std::size_t  num_values, value_type  default_value = value_type()  )

inline

Definition at line 60 of file simulator_quantity.hpp.

const_quantity() [2/3]

template<typename AssociatedT , typename ValueT = double>

viennashe::const_quantity< AssociatedT, ValueT >::const_quantity ( std::string  quan_name, std::vector< ValueT > const &  values_array  )

inline

Definition at line 66 of file simulator_quantity.hpp.

const_quantity() [3/3]

template<typename AssociatedT , typename ValueT = double>

viennashe::const_quantity< AssociatedT, ValueT >::const_quantity ( self_type const &  o )

inline

Definition at line 71 of file simulator_quantity.hpp.

Member Function Documentation

at()

template<typename AssociatedT , typename ValueT = double>

ValueT viennashe::const_quantity< AssociatedT, ValueT >::at ( associated_type const &  elem ) const

inline

Definition at line 75 of file simulator_quantity.hpp.

get_value()

template<typename AssociatedT , typename ValueT = double>

ValueT viennashe::const_quantity< AssociatedT, ValueT >::get_value ( associated_type const &  elem ) const

inline

Definition at line 74 of file simulator_quantity.hpp.

name()

template<typename AssociatedT , typename ValueT = double>

std::string viennashe::const_quantity< AssociatedT, ValueT >::name ( ) const

inline

Definition at line 78 of file simulator_quantity.hpp.

operator()()

template<typename AssociatedT , typename ValueT = double>

ValueT viennashe::const_quantity< AssociatedT, ValueT >::operator() ( associated_type const &  elem ) const

inline

Definition at line 76 of file simulator_quantity.hpp.

operator=()

template<typename AssociatedT , typename ValueT = double>

void viennashe::const_quantity< AssociatedT, ValueT >::operator= ( self_type const &  o )

inline

Definition at line 72 of file simulator_quantity.hpp.

---

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

• viennashe/simulator_quantity.hpp