main-ptr.cc

Go to the documentation of this file.

/*
 * Copyright (c) 2006 INRIA
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */
 
#include "ns3/command-line.h"
#include "ns3/object.h"
#include "ns3/ptr.h"
 
#include <iostream>
 
/**
 * @file
 * @ingroup core-examples
 * @ingroup ptr
 * Example program illustrating use of the ns3::Ptr smart pointer.
 */
 
using namespace ns3;
 
/**
 * Example class illustrating use of Ptr.
 */
class PtrExample : public Object
{
  public:
    /**
     * @brief Get the type ID.
     * @return the object TypeId
     */
    static TypeId GetTypeId();
 
    /** Constructor. */
    PtrExample();
    /** Destructor. */
    ~PtrExample() override;
    /** Example class method. */
    void Method();
};
 
NS_OBJECT_ENSURE_REGISTERED(PtrExample);
 
TypeId
PtrExample::GetTypeId()
{
    static TypeId tid =
        TypeId("ns3::PtrExample").SetParent<Object>().SetGroupName("Core").HideFromDocumentation();
    return tid;
}
 
PtrExample::PtrExample()
{
    std::cout << "PtrExample constructor" << std::endl;
}
 
PtrExample::~PtrExample()
{
    std::cout << "PtrExample destructor" << std::endl;
}
 
void
PtrExample::Method()
{
    std::cout << "PtrExample method" << std::endl;
}
 
/**
 *  Example Ptr global variable.
 */
static Ptr<PtrExample> g_ptr = nullptr;
 
/**
 * Example Ptr manipulations.
 *
 * This function stores it's argument in the global variable \c g_ptr
 * and returns the old value of \c g_ptr.
 * @param [in] p A Ptr.
 * @returns The prior value of \c g_ptr.
 */
static Ptr<PtrExample>
StorePtr(Ptr<PtrExample> p)
{
    Ptr<PtrExample> prev = g_ptr;
    g_ptr = p;
    return prev;
}
 
/**
 *  Set \c g_ptr to NULL.
 */
static void
ClearPtr()
{
    g_ptr = nullptr;
}
 
int
main(int argc, char* argv[])
{
    CommandLine cmd(__FILE__);
    cmd.Parse(argc, argv);
 
    {
        // Create a new object of type PtrExample, store it in global
        // variable g_ptr
        Ptr<PtrExample> p = CreateObject<PtrExample>();
        p->Method();
        Ptr<PtrExample> prev = StorePtr(p);
        NS_ASSERT(!prev);
    }
 
    {
        // Create a new object of type PtrExample, store it in global
        // variable g_ptr, get a hold on the previous PtrExample object.
        Ptr<PtrExample> p = CreateObject<PtrExample>();
        Ptr<PtrExample> prev = StorePtr(p);
        // call method on object
        prev->Method();
        // Clear the currently-stored object
        ClearPtr();
        // get the raw pointer and release it.
        PtrExample* raw = GetPointer(prev);
        prev = nullptr;
        raw->Method();
        raw->Unref();
    }
 
    return 0;
}