inet::ModuleRef< T > Class Template Reference

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

#include <ModuleRef.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
void	reference (cModule *referencingModule, const char *parameterName, bool mandatory)
void	reference (cGate *gate, bool mandatory)

Private Member Functions
void	checkReference () const

Private Attributes
opp_component_ptr< T >	referencedModule

Detailed Description

template<typename T>
class inet::ModuleRef< 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::ModuleRef< T >::checkReference ( ) const

inlineprivate

                                {
        if (referencedModule.getNullable() == nullptr)
            throw cRuntimeError("Dereferencing uninitialized reference of type '%s'", opp_typename(typeid(T)));
    }

get() [1/2]

template<typename T >

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

inline

{ checkReference(); return referencedModule.get(); }

get() [2/2]

template<typename T >

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

inline

{ checkReference(); return referencedModule.get(); }

getNullable() [1/2]

template<typename T >

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

inline

{ return referencedModule.getNullable(); }

getNullable() [2/2]

template<typename T >

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

inline

{ return referencedModule.getNullable(); }

operator bool()

template<typename T >

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

inlineexplicit

{ return (bool)referencedModule; }

operator T*()

template<typename T >

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

inline

                         {
        return referencedModule;
    }

operator*()

template<typename T >

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

inline

                         {
        checkReference();
        return *referencedModule;
    }

operator->()

template<typename T >

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

inline

                          {
        checkReference();
        return referencedModule;
    }

reference() [1/2]

template<typename T >

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

inline

                                                {
        if (gate == nullptr)
            throw cRuntimeError("Gate is nullptr");
        referencedModule = mandatory ? getConnectedModule<T>(gate) : findConnectedModule<T>(gate);
    }

reference() [2/2]

template<typename T >

void inet::ModuleRef< T >::reference ( cModule *  referencingModule, const char *  parameterName, bool  mandatory  )

inline

                                                                                          {
        if (referencingModule == nullptr)
            throw cRuntimeError("Referencing module is nullptr");
        if (parameterName == nullptr)
            throw cRuntimeError("Parameter name is nullptr");
        auto& parameter = referencingModule->par(parameterName);
        referencedModule = mandatory ? getModuleFromPar<T>(parameter, referencingModule) : findModuleFromPar<T>(parameter, referencingModule);
    }

Member Data Documentation

referencedModule

template<typename T >

opp_component_ptr<T> inet::ModuleRef< T >::referencedModule

private

---

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

• ModuleRef.h