inet::physicallayer::Interpolated< V > Class Template Reference

Represents an interpolated value of any type. More...

#include <Interpolation.h>

Public Member Functions
	Interpolated (value_cref_type v, bool isIntpl=true)
	Interpolated (const Interpolated< value_type > &o)
	Copy-constructor which assures that the internal storage is used correctly. More...
value_ref_type	operator* ()
value_ptr_type	operator-> ()
bool	operator== (const Interpolated< value_type > &other) const
	Two Interpolated<V> are compared equal if the value is the same as well as the "isInterpolated" flag. More...
bool	operator!= (const Interpolated< value_type > &other) const
	Two Interpolated<V> are compared non equal if the value differs or the "isInterpolated" flag. More...

Public Attributes
const bool	isInterpolated
	Stores if the underlying value is interpolated or not. More...

Protected Types
typedef V	value_type
typedef const value_type &	value_cref_type
typedef value_type &	value_ref_type
typedef value_type *	value_ptr_type

Protected Attributes
value_type	value
	A value this class represents. More...

Private Member Functions
	Interpolated ()

Detailed Description

template<class V>
class inet::physicallayer::Interpolated< V >

Represents an interpolated value of any type.

This class is used for performance, transparency and memory reasons. Since the actual value can be of arbitrary type and therefore arbitrary complexity (for example a whole Mapping instance) or could even be a pointer to an existing or a new object. This class hides the actual value from the user and just provides it with the value and takes care of any memory deallocation if necessary.

The actual value can be gotten by dereferencing the instance of this class (like with iterators).

Returned by InterpolateableMaps "getValue()"

Author

Karl Wessel

Member Typedef Documentation

template<class V>

typedef const value_type& inet::physicallayer::Interpolated< V >::value_cref_type

protected

template<class V>

typedef value_type* inet::physicallayer::Interpolated< V >::value_ptr_type

protected

template<class V>

typedef value_type& inet::physicallayer::Interpolated< V >::value_ref_type

protected

template<class V>

typedef V inet::physicallayer::Interpolated< V >::value_type

protected

Constructor & Destructor Documentation

template<class V>

inet::physicallayer::Interpolated< V >::Interpolated ( value_cref_type  v, bool  isIntpl = true  )

inline

                                                         :
        value(v), isInterpolated(isIntpl) {}

template<class V>

inet::physicallayer::Interpolated< V >::Interpolated ( const Interpolated< value_type > &  o )

inline

Copy-constructor which assures that the internal storage is used correctly.

                                                    :
        value(o.value), isInterpolated(o.isInterpolated) {}

template<class V>

inet::physicallayer::Interpolated< V >::Interpolated ( )

inlineprivate

                   :
        value(), isInterpolated(true) {}

Member Function Documentation

template<class V>

bool inet::physicallayer::Interpolated< V >::operator!= ( const Interpolated< value_type > &  other ) const

inline

Two Interpolated<V> are compared non equal if the value differs or the "isInterpolated" flag.

    {
        return value != other.value || isInterpolated != other.isInterpolated;
    }

template<class V>

value_ref_type inet::physicallayer::Interpolated< V >::operator* ( )

inline

    {
        return value;
    }

template<class V>

value_ptr_type inet::physicallayer::Interpolated< V >::operator-> ( )

inline

    {
        return &value;
    }

template<class V>

bool inet::physicallayer::Interpolated< V >::operator== ( const Interpolated< value_type > &  other ) const

inline

Two Interpolated<V> are compared equal if the value is the same as well as the "isInterpolated" flag.

    {
        return value == other.value && isInterpolated == other.isInterpolated;
    }

Member Data Documentation

template<class V>

const bool inet::physicallayer::Interpolated< V >::isInterpolated

Stores if the underlying value is interpolated or not.

Referenced by inet::physicallayer::MultiDimMappingIterator< Linear >::inRange(), inet::physicallayer::MultiDimMappingIterator< Linear >::MultiDimMappingIterator(), inet::physicallayer::MultiDimMappingIterator< Linear >::next(), inet::physicallayer::Interpolated< mapped_type >::operator!=(), inet::physicallayer::Interpolated< Mapping * >::operator!=(), inet::physicallayer::Interpolated< Mapping * >::operator=(), inet::physicallayer::Interpolated< mapped_type >::operator==(), inet::physicallayer::Interpolated< Mapping * >::operator==(), inet::physicallayer::MultiDimMappingIterator< Linear >::setValue(), inet::physicallayer::MultiDimMappingIterator< Linear >::updateNextPosition(), and inet::physicallayer::MultiDimMappingIterator< Linear >::updateSubIterator().

template<class V>

value_type inet::physicallayer::Interpolated< V >::value

protected

A value this class represents.

Referenced by inet::physicallayer::Interpolated< mapped_type >::operator!=(), inet::physicallayer::Interpolated< Mapping * >::operator!=(), inet::physicallayer::Interpolated< mapped_type >::operator*(), inet::physicallayer::Interpolated< mapped_type >::operator->(), inet::physicallayer::Interpolated< Mapping * >::operator=(), inet::physicallayer::Interpolated< mapped_type >::operator==(), inet::physicallayer::Interpolated< Mapping * >::operator==(), and inet::physicallayer::InterpolateableIterator< TInterpolator >::setValue().

---

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

• Interpolation.h