inet::physicallayer::Interpolated< Mapping * > Class Template Reference

Helper class (-specialization) for multiDimMapping which is used by an InterpolateableMap as return value of the "getValue()" - method. More...

#include <MappingUtils.h>

Public Member Functions
	Interpolated (const LinearIntplMapping &m)
	Initializes this Interpolated instance to represent the passed Interpolated Mapping. More...
	Interpolated (value_type v, bool isIntpl=true)
	Initializes this Interpolated instance to represent the Mapping the passed pointer points to and with the passed isIntpl value. More...
	Interpolated (const _Self &o)
	Copy-constructor which assures that the internal storage is used correctly. More...
	~Interpolated ()
const _Self &	operator= (const _Self &o)
	Assignment operator which assures that the internal storage is copied correctly. More...
value_ref_type	operator* ()
	Dereferences this Interpolated to the represented value (works like dereferencing an std::iterator). More...
value_ptr_type	operator-> ()
	Dereferences this Interpolated to the represented value (works like dereferencing an std::iterator). More...
bool	operator== (const _Self &other) const
	Two Interpolated<Mapping*> are compared equal if the pointer to the represented Mapping is the same as well as the "isInterpolated" value. More...
bool	operator!= (const _Self &other) const
	Two Interpolated<Mapping*> are compared non equal if the pointer to the represented Mapping differs or the "isInterpolated" value. More...

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

Protected Types
typedef Mapping *	value_type
typedef const value_type &	value_cref_type
typedef value_type &	value_ref_type
typedef value_type *	value_ptr_type
typedef Interpolated< value_type >	_Self

Protected Attributes
LinearIntplMapping	mapping
	Holds the temporary InterpolatedMapping if necessary. More...
value_type	value
	A pointer to the Mapping this class represents. More...
bool	isPointer
	Stores if we use the temporary IntplMapping or a external pointer. More...

Detailed Description

template<>
class inet::physicallayer::Interpolated< Mapping * >

Helper class (-specialization) for multiDimMapping which is used by an InterpolateableMap as return value of the "getValue()" - method.

Provides either an pointer to an actual SubMapping of the MultiDimMapping or a Pointer to an temporary InterpolatedMapping between two Sub-mappings of the MultiDimMapping.

Author

Karl Wessel

Member Typedef Documentation

typedef Interpolated<value_type> inet::physicallayer::Interpolated< Mapping * >::_Self

protected

typedef const value_type& inet::physicallayer::Interpolated< Mapping * >::value_cref_type

protected

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

protected

typedef value_type& inet::physicallayer::Interpolated< Mapping * >::value_ref_type

protected

typedef Mapping* inet::physicallayer::Interpolated< Mapping * >::value_type

protected

Constructor & Destructor Documentation

inet::physicallayer::Interpolated< Mapping * >::Interpolated ( const LinearIntplMapping &  m )

inline

Initializes this Interpolated instance to represent the passed Interpolated Mapping.

Copies the passed Mapping to its internal member. Sets "isInterpolated" to true.

                                              :
        mapping(m), value(), isPointer(false), isInterpolated(true)
    {
        value = &mapping;
    }

inet::physicallayer::Interpolated< Mapping * >::Interpolated ( value_type  v, bool  isIntpl = true  )

inline

Initializes this Interpolated instance to represent the Mapping the passed pointer points to and with the passed isIntpl value.

The passed pointer has to be valid as long as this instance exists.

                                                    :
        mapping(), value(v), isPointer(true), isInterpolated(isIntpl) {}

inet::physicallayer::Interpolated< Mapping * >::Interpolated ( const _Self &  o )

inline

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

                                 :
        mapping(), value(o.value), isPointer(o.isPointer), isInterpolated(o.isInterpolated)
    {
        if (!isPointer) {
            mapping = o.mapping;
            value = &mapping;
        }
    }

inet::physicallayer::Interpolated< Mapping * >::~Interpolated ( )

inline

{}

Member Function Documentation

bool inet::physicallayer::Interpolated< Mapping * >::operator!= ( const _Self &  other ) const

inline

Two Interpolated<Mapping*> are compared non equal if the pointer to the represented Mapping differs or the "isInterpolated" value.

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

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

inline

Dereferences this Interpolated to the represented value (works like dereferencing an std::iterator).

    {
        return value;
    }

value_ptr_type inet::physicallayer::Interpolated< Mapping * >::operator-> ( )

inline

Dereferences this Interpolated to the represented value (works like dereferencing an std::iterator).

    {
        return &value;
    }

const _Self& inet::physicallayer::Interpolated< Mapping * >::operator= ( const _Self &  o )

inline

Assignment operator which assures that the internal storage is copied correctly.

    {
        isInterpolated = o.isInterpolated;
        isPointer = o.isPointer;
        value = o.value;
        if (!isPointer) {
            mapping = o.mapping;
            value = &mapping;
        }
        return *this;
    }

bool inet::physicallayer::Interpolated< Mapping * >::operator== ( const _Self &  other ) const

inline

Two Interpolated<Mapping*> are compared equal if the pointer to the represented Mapping is the same as well as the "isInterpolated" value.

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

Member Data Documentation

bool inet::physicallayer::Interpolated< Mapping * >::isInterpolated

Stores if the underlying Mapping is interpolated or not.

bool inet::physicallayer::Interpolated< Mapping * >::isPointer

protected

Stores if we use the temporary IntplMapping or a external pointer.

LinearIntplMapping inet::physicallayer::Interpolated< Mapping * >::mapping

protected

Holds the temporary InterpolatedMapping if necessary.

value_type inet::physicallayer::Interpolated< Mapping * >::value

protected

A pointer to the Mapping this class represents.

---

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

• MappingUtils.h