object-ptr-container.h

Go to the documentation of this file.

/*
 * Copyright (c) 2007 INRIA, Mathieu Lacage
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Authors: Mathieu Lacage <mathieu.lacage@gmail.com>
 */
#ifndef OBJECT_PTR_CONTAINER_H
#define OBJECT_PTR_CONTAINER_H
 
#include "attribute.h"
#include "object.h"
#include "ptr.h"
 
#include <map>
 
/**
 * @file
 * @ingroup attribute_ObjectPtrContainer
 * ns3::ObjectPtrContainerValue attribute value declarations and template implementations.
 */
 
/**
 * @ingroup attributes
 * @defgroup attribute_ObjectPtrContainer ObjectPtrContainer Attribute
 * AttributeValue implementation for ObjectPtrContainer
 */
namespace ns3
{
 
/**
 * @ingroup attribute_ObjectPtrContainer
 *
 * @brief Container for a set of ns3::Object pointers.
 *
 * This class it used to get attribute access to an array of
 * ns3::Object pointers.
 *
 * @see AttributeValue
 *
 * Call graph was not generated because of its size.
 * @hidecallergraph
 * @hidecallgraph
 */
class ObjectPtrContainerValue : public AttributeValue
{
  public:
    /** Iterator type for traversing this container. */
    typedef std::map<std::size_t, Ptr<Object>>::const_iterator Iterator;
 
    /** Default constructor. */
    ObjectPtrContainerValue();
 
    /**
     * Get an iterator to the first Object.
     *
     * @returns An iterator to the first Object.
     */
    Iterator Begin() const;
    /**
     * Get an iterator to the _past-the-end_ Object.
     *
     * @returns An iterator to the _past-the-end_ Object.
     */
    Iterator End() const;
    /**
     * Get the number of Objects.
     *
     * @returns The number of objects.
     */
    std::size_t GetN() const;
    /**
     * Get a specific Object.
     *
     * @param [in] i The index of the requested object.
     * @returns The requested object
     */
    Ptr<Object> Get(std::size_t i) const;
 
    /**
     * Get a copy of this container.
     *
     * @returns A copy of this container.
     */
    Ptr<AttributeValue> Copy() const override;
    /**
     * Serialize each of the Object pointers to a string.
     *
     * Note this serializes the Ptr values, not the Objects themselves.
     *
     * @param [in] checker The checker to use (currently not used.)
     * @returns The string form of the Objects.
     */
    std::string SerializeToString(Ptr<const AttributeChecker> checker) const override;
    /**
     * Deserialize from a string. (Not implemented; raises a fatal error.)
     *
     * @param [in] value The serialized string form.
     * @param [in] checker The checker to use.
     * @returns \c true.
     */
    bool DeserializeFromString(std::string value, Ptr<const AttributeChecker> checker) override;
 
  private:
    /** ObjectPtrContainerAccessor::Get() needs access. */
    friend class ObjectPtrContainerAccessor;
    /** The container implementation. */
    std::map<std::size_t, Ptr<Object>> m_objects;
};
 
/**
 * @ingroup attribute_ObjectPtrContainer
 * Create an AttributeAccessor using a container class indexed get method.
 *
 * The two versions of this function differ only in argument order.
 *
 * @tparam T \deduced The container class type.
 * @tparam U \deduced The type of object the get method returns.
 * @tparam INDEX \deduced The type of the index variable.
 * @param [in] get The class method to get a specific instance
 *             from the container.
 * @param [in] getN The class method to return the number of objects
 *             in the container.
 * @return The AttributeAccessor.
 */
template <typename T, typename U, typename INDEX>
Ptr<const AttributeAccessor> MakeObjectPtrContainerAccessor(Ptr<U> (T::*get)(INDEX) const,
                                                            INDEX (T::*getN)() const);
 
/**
 * @ingroup attribute_ObjectPtrContainer
 * Create an AttributeAccessor using a container class indexed get method.
 *
 * The two versions of this function differ only in argument order.
 *
 * @tparam T \deduced The container class type.
 * @tparam U \deduced The type of object the get method returns.
 * @tparam INDEX \deduced The type of the index variable.
 * @param [in] get The class method to get a specific instance
 *             from the container.
 * @param [in] getN The class method to return the number of objects
 *             in the container.
 * @return The AttributeAccessor.
 */
template <typename T, typename U, typename INDEX>
Ptr<const AttributeAccessor> MakeObjectPtrContainerAccessor(INDEX (T::*getN)() const,
                                                            Ptr<U> (T::*get)(INDEX) const);
 
/**
 * @ingroup attribute_ObjectPtrContainer
 *
 * AttributeChecker implementation for ObjectPtrContainerValue.
 * @see AttributeChecker
 */
class ObjectPtrContainerChecker : public AttributeChecker
{
  public:
    /**
     * Get the TypeId of the container class type.
     * @returns The class TypeId.
     */
    virtual TypeId GetItemTypeId() const = 0;
};
 
/**
 * @ingroup attribute_ObjectPtrContainer
 * @returns The AttributeChecker.
 * @see AttributeChecker
 */
template <typename T>
Ptr<const AttributeChecker> MakeObjectPtrContainerChecker();
 
} // namespace ns3
 
//
// The implementation of the above functions.
//
 
namespace ns3
{
 
namespace internal
{
/**
 * ObjectPtrContainerChecker implementation class.
 */
template <typename T>
class ObjectPtrContainerChecker : public ns3::ObjectPtrContainerChecker
{
  public:
    TypeId GetItemTypeId() const override
    {
        return T::GetTypeId();
    }
 
    bool Check(const AttributeValue& value) const override
    {
        return dynamic_cast<const ObjectPtrContainerValue*>(&value) != nullptr;
    }
 
    std::string GetValueTypeName() const override
    {
        return "ns3::ObjectPtrContainerValue";
    }
 
    bool HasUnderlyingTypeInformation() const override
    {
        return true;
    }
 
    std::string GetUnderlyingTypeInformation() const override
    {
        return "ns3::Ptr< " + T::GetTypeId().GetName() + " >";
    }
 
    Ptr<AttributeValue> Create() const override
    {
        return ns3::Create<ObjectPtrContainerValue>();
    }
 
    bool Copy(const AttributeValue& source, AttributeValue& destination) const override
    {
        const auto src = dynamic_cast<const ObjectPtrContainerValue*>(&source);
        auto dst = dynamic_cast<ObjectPtrContainerValue*>(&destination);
        if (src == nullptr || dst == nullptr)
        {
            return false;
        }
        *dst = *src;
        return true;
    }
};
 
} // namespace internal
 
/**
 * @ingroup attribute_ObjectPtrContainer
 * AttributeAccessor implementation for ObjectPtrContainerValue.
 */
class ObjectPtrContainerAccessor : public AttributeAccessor
{
  public:
    bool Set(ObjectBase* object, const AttributeValue& value) const override;
    bool Get(const ObjectBase* object, AttributeValue& value) const override;
    bool HasGetter() const override;
    bool HasSetter() const override;
 
  private:
    /**
     * Get the number of instances in the container.
     *
     * @param [in] object The container object.
     * @param [out] n The number of instances in the container.
     * @returns true if the value could be obtained successfully.
     */
    virtual bool DoGetN(const ObjectBase* object, std::size_t* n) const = 0;
    /**
     * Get an instance from the container, identified by index.
     *
     * @param [in] object The container object.
     * @param [in] i The desired instance index.
     * @param [out] index The index retrieved.
     * @returns The index requested.
     */
    virtual Ptr<Object> DoGet(const ObjectBase* object,
                              std::size_t i,
                              std::size_t* index) const = 0;
};
 
template <typename T, typename U, typename INDEX>
Ptr<const AttributeAccessor>
MakeObjectPtrContainerAccessor(Ptr<U> (T::*get)(INDEX) const, INDEX (T::*getN)() const)
{
    struct MemberGetters : public ObjectPtrContainerAccessor
    {
        bool DoGetN(const ObjectBase* object, std::size_t* n) const override
        {
            const T* obj = dynamic_cast<const T*>(object);
            if (obj == nullptr)
            {
                return false;
            }
            *n = (obj->*m_getN)();
            return true;
        }
 
        Ptr<Object> DoGet(const ObjectBase* object,
                          std::size_t i,
                          std::size_t* index) const override
        {
            const T* obj = static_cast<const T*>(object);
            *index = i;
            return (obj->*m_get)(i);
        }
 
        Ptr<U> (T::*m_get)(INDEX) const;
        INDEX (T::*m_getN)() const;
    }* spec = new MemberGetters();
 
    spec->m_get = get;
    spec->m_getN = getN;
    return Ptr<const AttributeAccessor>(spec, false);
}
 
template <typename T, typename U, typename INDEX>
Ptr<const AttributeAccessor>
MakeObjectPtrContainerAccessor(INDEX (T::*getN)() const, Ptr<U> (T::*get)(INDEX) const)
{
    return MakeObjectPtrContainerAccessor(get, getN);
}
 
template <typename T>
Ptr<const AttributeChecker>
MakeObjectPtrContainerChecker()
{
    return Create<internal::ObjectPtrContainerChecker<T>>();
}
 
} // namespace ns3
 
#endif /* OBJECT_PTR_CONTAINER_H */