NS3-对象框架之智能指针

---

title: 03、NS-3的对象框架 之 智能指针
tags: 新建,模板,小书匠
slug: storywriter/upgrade_log
grammar_mindmap: true

renderNumberedHeading: true

grammar_code: true
grammar_decorate: true
grammar_mathjax: true

---

一、NS-3的对象框架之智能指针

NS-3提供了一套基于引用计数的智能指针系统，可以使得对象在不再被使用时自动被删除。使用一个Ref()方法在有新的指针指向对象时，将其内部的计数加1；而在指针不再指向时调用UnRef()方法，将计数器减1。当计数器为0的时候，说明没有任何指针再指向该对象，那么说明对象不再被需要，从而可以直接删除。为了实现这种自动计数的智能指针机制，NS-3使用了两个类：SimpleRefCount和Ptr。

1. NS-3对象框架概述

1.1 三个特殊基类

• SimpleRefCount：继承该类将得到智能指针特性，经典类Packet(网络中的一个数据包)
• ObjectBase：继承该类将得到NS-3的属性系统支持，经典类Tag(包中标记)
• Object：继承自该对象相当于继承了上面两个对象，此外还支持聚合特性支持

2. SimpleRefCount和智能指针Ptr

2.1 Ptr

** 产生新的引用加1的五种情况：**

• Ptr ()：默认无参构造函数，如果构造一个空的Ptr对象，那么其指向的对象为空。
• Ptr (T *ptr)：如果构造函数传入的参数是一个指针，那么将引用加1。
• Ptr (Ptr const&o)：拷贝构造函数，如果将一个Ptr对象复制了一次，那么引用加1。
• Ptr (Ptr const &o)：带类型转换的拷贝构造函数，如果将一个其他类型的Ptr对象复制了一次，那么引用也加1。

• operator = (Ptr const& o)：赋值的时候，相当于改变了引用的指向，原来引用的对象的计数要减1，新引用的对象的计数要加1。
  调用了Unref()方法的函数就是让引用减1，具体情况有如下两种

• ~Ptr ()：析构函数，当一个引用对象的Ptr被销毁的时候，说明指向少了一个

• operator = (Ptr const& o)：使用赋值的时候，如果不是将自己赋值给自己，那么就有可能产生引用的增减。原来引用的对象的的引用要减1，新引用的对象的计数要加1。

** Ptr类有一个特殊的构造函数，可以让用户在创建引用的时候，不产生任何的计数：**

• Ptr (T *ptr, bool ref)：当构造函数的第二个参数为false时，将不再产生任何计数。此时用户可以自己维护对象的删除。

2.1.1 创建智能指针，使用Ptr的时候一般写法是：

Ptr obj = Create(); //创建智能指针指向的对象，该方法自动调用构造函数
obj->SomeMethod();  //当作普通指针使用

2.1.2 通过外来指针构造智能指针

SelfRefObject * p_obj = new SelfRefObject();//创建对象的时候，其基本计数已经为1
Ptr obj = Ptr(p_obj);//调用Ptr构造函数的时候，其引用计数将加1，因此计数为2

如果对象不是通过Create()方法创建的，而是通过构造函数传入的，那么将不会自动被销毁。其原因在于，NS-3认为这个对象开始并没有被智能指针维护，因此如果NS-3销毁了这个对象，可能会影响其他地方继续使用该对象，从而引起错误。因此，程序员应该自动维护该对象占用的空间。

正确的使用方法，如果要让NS-3帮我们维护智能指针，我们可以使用另外一个Ptr的构造函数，传入参数false让Ptr不再增加引用计数

SelfRefObject * p_obj = new SelfRefObject();
Ptr obj = Ptr(p_obj, false);
obj->SomeMethod();

现在能够获得正确计数，并帮我们销毁了对象

警告：然而需要注意的是，如果NS-3以智能指针的方式帮我们维护了一个外来的指针，那么这个智能指针的对象销毁之后，外来指针指向的对象也将无法继续使用。

2.1.3 智能指针的拷贝构造函数

总体来说，在C++中，有三种情况会调用拷贝构造函数：

• 一个对象以值传递的方式传入函数体
• 一个对象以值传递的方式从函数返回
• 一个对象需要通过另外一个对象进行初始化

2.1.4 智能指针的赋值操作副重载

将一个对象赋值给另外一个对象，C++中有如下规则：

• 对象在声明的同时将另一个已存在的对象赋给它，就会调用拷贝构造函数；//A b (a);
• 如果对象已经存在了，然后再将另一个已存在的对象赋给它，调用的就是重载赋值运算符。//A c = b;c = a;

2.2 SimpleRefCount

NS-3提供了一个最简单的SimpleRefCount类，该类已经实现Ref()和Unref()方法，并且在内部维护了引用计数，可以和Ptr智能指针完美结合，比自己实现Ref和Unref方法更加安全可靠。

二、NS-3的对象框架之TypeId

NS-3提供的这样一套动态创建对象机制TypeId类，可以动态从字符串创建对象，还可以判断对象的所属的继承属性。TypeId还是NS-3的属性框架(Attribute Framework)和追踪框架(Tracing Framework)的基础。

1.ObjectBase类(抽象类)

ObjectBase是整个NS-3对象框架的基础。为NS-3的其他对象功能提供必要的支持。由于TypeId本身是没有任何作用的。它必须在一个类的内部定义，而这个类一般都继承自ObjectBase。

ObjectBase类其中的共有方法可分为三大功能模块：TypeId支持、属性框架支持、追踪框架支持

1.1 TypeId支持

• GetTypeId()：通过类获得当前类的TypeId。静态方法，可直接通过类来调用：ObjectBase::GetTypeId()
• GetInstanceTypeId()：通过类的实例获得其TypeId。实例方法，并且是一个纯虚方法

1.2 属性框架支持

• SetAttribute()：为对象设置一个属性
• SetAttributeFailSafe()：为对象设置一个属性，出现错误的时候不会停止运行
• GetAttribute()：获取对象的某个属性
• GetAttributeFailSafe()：获取对象的某个属性，出现错误的时候不会停止程序的运行

1.3 追踪框架支持

• TraceConnect()：链接对象的某个追踪源
• TraceConnectWithoutContext()：连接对象的某个追踪源，但是不携带上下文信息
• TraceDisconnect()：断开对象的某个追踪源，不再继续追踪属性的变化和事件的发生
• TraceDisconnectWithoutContext()：断开不带上下文的某个追踪源

2 TypeId

TypeId类的四类核心方法：

• 构造函数和操作符重载：这类方法定义了我们如何创建和比较一个TypeId
• 查找TypeId和相关信息：这类方法都是静态方法，定义了我们如何能够获得一个已经存在的TypeId，以及获得全局TypeId的相关信息
• 通过TypeId设置和获取类的信息：这类方法定义了我们如何通过TypeId的实例去设置一些和其所描述的类相关的信息
• 通过TypeId解析类相关的继承层次关系：这类方法使得我们可以了解该TypeId的实例所描述的类的继承层次关系

3.创建对象

#include
using namespace std;
using namespace ns3;

namespace ns3{
    class MyObject:public ObjectBase{
    
        public:
                        static TypeId GetTypeId();
                        MyObject();
                    
                        virtual ~MyObject();
        
                        virtual TypeId GetInstanceTypeId() const;
        
                            void MyMethod();
    };
    
    NS_LOG_COMPONENT_DEFINE("MyObject");
    NS_OBJECT_ENSURE_REGISTERED(MyObject);
    
    TypeId MyObject::GetTypeId(){
            //1.创建TypeId
            static TypeId tid = TypeId("ns3::MyObject")
                                                    .SetParent(ObjectBase::GetTypeId())
                                                    .SetGroupName("MyExample")
                                                    .AddConstructor();
        
            return tid;
          //
    }
    MyObject::MyObject(){
        NS_LOG_FUNCTION(this);
    }
    
    MyObject::~MyObject(){
            NS_LOG_FUNCTION(this);
    }
    
    TypeId MyObject::GetInstanceTypeId() const{
             return MyObject::GetTypeId();
    }
    
    void MyObject::MyMethod(){
            NS_LOG_UNCOND("my method is executed");
    }
}

int main(int argc,char *argv[]){
        LogComponentEnable("MyObject",LOG_LEVEL_LOGIC);
        
        TypeId tid = TypeId::LookupByName("ns3::MyObject");//用类的名字的字符串查找到了类所对应的TypeId
        Callback constructor = tid.GetConstructor();//获取了该类的构造函数的回调,只能返回基类类型
        MyObject *obj = dynamic_cast(constructor());//dynmaic_cast方法将指针转换成子类类型
        obj->MyMethod();
    
        delete obj;//未使用智能指针，因此，必须在适当的时候自己删除所创建的对象
        obj=0;
}

4.反射机制

可以模仿Java中Class.forName()类似的反射机制，从配置文件中读取类的配置信息，动态创建出具体对象

  ifstream infile("MyObjectConfig.ini");
  std::string line;
  getline(infile, line);
  if(!line.empty()) {
    NS_LOG_INFO("config from file is " << line);
    TypeId tid = TypeId::LookupByName(line);
    MyObject * obj = dynamic_cast(tid.GetConstructor()());
    obj->MyMethod();
    delete obj;
    obj = 0;
  }

通过从文件读取出来的字符串创建了MyObject3对象，并成功调用了其方法,可以让我们在不用重新编译程序的情况下，动态地决定创建的对象实例究竟是属于哪个类型。

5.和SimpleRefCount结合

class MyObject : public SimpleRefCount    //继承自SimpleRefCount，又继承自ObjectBase
  {
  public:
    static TypeId GetTypeId ();             //必须实现此方法

    MyObject ();
    virtual ~MyObject();

    virtual TypeId GetInstanceTypeId () const;  //必须实现此方法

    //业务方法
    virtual void MyMethod();
  };

//
TypeId tid = TypeId::LookupByName(line);
    Ptr obj = Ptr((MyObject *)tid.GetConstructor()(), false);


template
Ptr CreatePtrObject() {
  return Ptr(dynamic_cast(T::GetTypeId().GetConstructor()()), false);
}

Ptr obj = CreatePtrObject();

6. 使用TypeId判断对象的类型

void TestType(Ptr obj)
{
    TypeId tid = obj->GetInstanceTypeId();
    NS_LOG_LOGIC("obj type is " << tid.GetName());
    if (tid == MyObject2::GetTypeId())  //此处要注意，tid在实现的时候必须是static才能正确比较相等
    {
            NS_LOG_LOGIC("is instance of MyObject2, call method2");
            Ptr obj2 = DynamicCast(obj);
            obj2->MyMethod2();
    }
    else if(tid == MyObject3::GetTypeId())
    {
            NS_LOG_LOGIC("is instance of MyObject3, call method3");
            Ptr obj3 = DynamicCast(obj);
            obj3->MyMethod3();
    }
}

int main (int argc, char *argv[])
{
    LogComponentEnable("MyObject",            LOG_LEVEL_LOGIC);

  ifstream infile("MyObjectConfig.ini");
  std::string line;
  getline(infile, line);
  if(!line.empty()) {
    NS_LOG_INFO("config from file is " << line);
    TypeId tid = TypeId::LookupByName(line);
    Ptr obj = Ptr((MyObject *)tid.GetConstructor()(), false);
    obj->MyMethod();

    TestType(obj);
  }
}

7.使用TypeId判断类的继承关系

void TestType(Ptr obj)
{
    TypeId tid = obj->GetInstanceTypeId();
    TypeId tid2 = MyObject2::GetTypeId();
    NS_LOG_LOGIC("obj type is " << tid.GetName());
    if(tid == tid2 || tid.IsChildOf(tid2)) {
            NS_LOG_LOGIC("这是正确的对象类型");
    } else {
      NS_LOG_LOGIC("对象类型不能被接受，父类是" << tid.GetParent().GetName());
    }
}

三、NS-3的对象框架之属性框架

使用NS-3的属性框架，可方便地对对象属性进行设置和读取，可设置类的默认属性。在NS-3中所有内置属性都可和字符串属性类型相互转换。NS-3的属性框架主要是通过ObjectBase和TypeId来实现的，因此要使用属性框架的类，必须继承自ObjectBase，并且维护一个TypeId实例。

在NS-3中，我们现在使用其对象和属性框架的步骤一般如下：

• 使用CreateObject<>()方法创建某个类的对象实例，并得到一个指向该对象的智能指针。

• 使用对象的SetAttribute()方法来设置对象的各种属性。

• 调用Initialize()方法来初始化对象，因为SetAttribute()方法设置的属性，无法在构造函数中初始化。

1. 属性框架简介

type-id.cc AddAttribute()方法的参数的意义

• name: 属性的名字
• help: 用一句话来解释一下属性的作用
• flags: 用于控制属性读写特性的参数
• initialValue: 属性的初始值，类型为AttributeValue。AttributeValue是一切属性值类型的父类，例如整形值UintegerValue，浮点数值DoubleValue以及字符串值StringValue等。本章后面部分会介绍不同的属性值类型。
• accessor: 如何访问该属性，是通过对象的成员变量访问呢？还是通过Getter/Setter方法来访问？其类型是一个AttributeAccessor的子类。
• checker: 检查属性的值是否符合要求
• supportLevel: 表示这个属性是处于使用状态、不推荐状态，还是过时状态，其类型是一个枚举变量，共有三种值：
  • SUPPORT: 属性正在受到支持，可以正常使用，默认值
  • DEPRECATED：属性快要过时，不支持使用
  • OBSOLETE：属性已经过时，不能使用
  • supportMsg: 支持性字符串，当supportLeve为不同的值时，msg的值也将不同：
  • SUPPORT: 无作用，可以使用默认值空字符串(“”)
  • DEPRECATED: 提示属性快要过时，给出解决方法，以后该用什么属性替代该属性
  • OBSOLETE: 提示属性已经过时，不能使用，并提示使用什么属性来替代
    其中flags参数的取值是由TypeId中定义的枚举类型描述的：

enum AttributeFlag {
ATTR_GET = 1<<0, /**< 只读属性 */
ATTR_SET = 1<<1, /**< 只写属性 */
ATTR_CONSTRUC = 1<<2, /**< 属性只能在构造时被初始化 */
ATTR_SGC = ATTR_GET | ATTR_SET | ATTR_CONSTRUCT, /**< 可读可写可初始化 */
};
在没有flags参数的重载中，flags的值默认为ATTR_SGC，即包含全部的特性。

enum AttributeFlag {
    ATTR_GET = 1<<0, /**< 只读属性 */
    ATTR_SET = 1<<1, /**< 只写属性 */
    ATTR_CONSTRUC = 1<<2, /**< 属性只能在构造时被初始化 */
    ATTR_SGC = ATTR_GET | ATTR_SET | ATTR_CONSTRUCT, /**< 可读可写可初始化 默认 */
  };

1.1. 定义属性

为了更好地使用属性，框架，NS-3提供了Object类(继承自ObjectBase和SimpleRefCount)，Object类还实现了GetInstanceTypeId()方法，而子类无需在重写此方法。然而要注意，要让GetInstanceTypeId()自动能够获取任意子类的正确TypeId类型，必须使用NS-3提供的CreateObject()函数来创建对象，否则GetInstanceTypeId()方法返回的总是Object自己的TypeId。而NS-3的整个属性框架的基础就是TypeId，因此必须保证TypeId能够描述正确的类。

TypeId  MyObject::GetTypeId (){
    static TypeId tid = TypeId("ns3::MyObject")     //创建TypeId，
      .SetParent(Object::GetTypeId())
      .SetGroupName("MyExample")
      .AddConstructor()
      .AddAttribute ("MyValue",
                   "An example attribute",
                   TypeId::ATTR_SGC,
                   UintegerValue (100),
                   MakeUintegerAccessor (&MyObject::m_myValue),
                   MakeUintegerChecker ())
      ;
    return tid;
  }

注意：要想使变量m_myValue初始化成功为100,有一个必要条件，那就是属性的flags参数必须为ATTR_CONSTRUCT或者ATTR_SGC二者之一，换句话说，必须包含ATTR_CONSTRUCT。

1.2 设置和访问属性

除了调用Getter和Setter方法来访问和设置属性之外，ObjectBase还提供了GetAttribute和SetAttribute两个方法来完成同样的工作，即便是在我们自己没有实现Getter/Setter方法的情况下，这两个方法一直都存在。

    Ptr obj = CreateObject();
    obj->MyMethod();
    obj->SetAttribute("MyValue", UintegerValue(200));
    UintegerValue myValue;
    obj->GetAttribute("MyValue", myValue);
    NS_LOG_UNCOND(myValue.Get());

也可以使用CreateObjectWithAttributes()函数在创建对象的时候就设置属性(最多9个属性)，其语法和CreateObject()函数类似，但是可以添加属性的名称和值作为参数：

Ptr obj = CreateObjectWithAttributes("MyValue", UintegerValue(200));
Ptr