inet::ModuleRefByGate< T > Class Template Reference

This template class implements a module reference that is parameterized by a gate of the referencing module. More...

#include <ModuleRefByGate.h>

Public Member Functions
T &	operator* () const
T *	operator-> () const
	operator T* () const
	operator bool () const
T *	getNullable ()
const T *	getNullable () const
T *	get ()
const T *	get () const
cGate *	getGate ()
const cGate *	getGate () const
void	reference (cGate *gate, bool mandatory)

Private Member Functions
void	checkReference () const

Private Attributes
opp_component_ptr< T >	referencedModule
cGate *	gate = nullptr

Detailed Description

template<typename T>
class inet::ModuleRefByGate< T >

This template class implements a module reference that is parameterized by a gate of the referencing module.

The reference can be set by providing the gate of the referencing module. After the reference is set, it can be used similarly to simple a C++ pointer. The pointer is automatically set to nullptr when the referenced module is deleted.

TODO follow connection

Member Function Documentation

checkReference()

template<typename T >

void inet::ModuleRefByGate< T >::checkReference ( ) const

inlineprivate

                                {
        if (referencedModule.getNullable() == nullptr) {
            if (gate == nullptr)
                throw cRuntimeError("Dereferencing uninitialized reference of type '%s'", opp_typename(typeid(T)));
            else
                throw cRuntimeError("Dereferencing nullptr of type '%s' referenced by '(%s)%s' through gate '%s'",
                                    opp_typename(typeid(T)), gate->getOwnerModule()->getClassName(), gate->getOwnerModule()->getFullPath().c_str(), gate->getFullName());
        }
    }

get() [1/2]

template<typename T >

T* inet::ModuleRefByGate< T >::get ( )

inline

{ checkReference(); return get(); }

Referenced by inet::ModuleRefByGate< T >::get().

get() [2/2]

template<typename T >

const T* inet::ModuleRefByGate< T >::get ( ) const

inline

{ checkReference(); return get(); }

Referenced by inet::ModuleRefByGate< T >::get().

getGate() [1/2]

template<typename T >

cGate* inet::ModuleRefByGate< T >::getGate ( )

inline

{ return gate; }

getGate() [2/2]

template<typename T >

const cGate* inet::ModuleRefByGate< T >::getGate ( ) const

inline

{ return gate; }

getNullable() [1/2]

template<typename T >

T* inet::ModuleRefByGate< T >::getNullable ( )

inline

{ return referencedModule.getNullable(); }

getNullable() [2/2]

template<typename T >

const T* inet::ModuleRefByGate< T >::getNullable ( ) const

inline

{ return referencedModule.getNullable(); }

operator bool()

template<typename T >

inet::ModuleRefByGate< T >::operator bool ( ) const

inlineexplicit

{ return (bool)referencedModule; }

operator T*()

template<typename T >

inet::ModuleRefByGate< T >::operator T* ( ) const

inline

                         {
        return referencedModule;
    }

operator*()

template<typename T >

T& inet::ModuleRefByGate< T >::operator* ( ) const

inline

                         {
        checkReference();
        return *referencedModule;
    }

operator->()

template<typename T >

T* inet::ModuleRefByGate< T >::operator-> ( ) const

inline

                          {
        checkReference();
        return referencedModule;
    }

reference()

template<typename T >

void inet::ModuleRefByGate< T >::reference ( cGate *  gate, bool  mandatory  )

inline

                                                {
        if (gate == nullptr)
            throw cRuntimeError("Gate is nullptr");
        if (this->gate != nullptr)
            throw cRuntimeError("Reference is already initialized");
        this->gate = gate;
        referencedModule = mandatory ? getConnectedModule<T>(gate) : findConnectedModule<T>(gate);
    }

Member Data Documentation

gate

template<typename T >

cGate* inet::ModuleRefByGate< T >::gate = nullptr

private

referencedModule

template<typename T >

opp_component_ptr<T> inet::ModuleRefByGate< T >::referencedModule

private

---

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

• ModuleRefByGate.h