A Discrete-Event Network Simulator
API
attribute.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2008 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 #ifndef ATTRIBUTE_H
21 #define ATTRIBUTE_H
22 
23 #include <string>
24 #include <stdint.h>
25 #include "ptr.h"
26 #include "simple-ref-count.h"
27 
35 namespace ns3 {
36 
37 class AttributeAccessor;
38 class AttributeChecker;
39 class Attribute;
40 class ObjectBase;
41 
68 class AttributeValue : public SimpleRefCount<AttributeValue>
69 {
70 public:
71  AttributeValue ();
72  virtual ~AttributeValue ();
73 
77  virtual Ptr<AttributeValue> Copy (void) const = 0;
87  virtual std::string SerializeToString (Ptr<const AttributeChecker> checker) const = 0;
101  virtual bool DeserializeFromString (std::string value, Ptr<const AttributeChecker> checker) = 0;
102 };
103 
114 class AttributeAccessor : public SimpleRefCount<AttributeAccessor>
115 {
116 public:
118  virtual ~AttributeAccessor ();
119 
128  virtual bool Set (ObjectBase * object, const AttributeValue &value) const = 0;
138  virtual bool Get (const ObjectBase * object, AttributeValue &attribute) const = 0;
139 
144  virtual bool HasGetter (void) const = 0;
149  virtual bool HasSetter (void) const = 0;
150 };
151 
166 class AttributeChecker : public SimpleRefCount<AttributeChecker>
167 {
168 public:
169  AttributeChecker ();
170  virtual ~AttributeChecker ();
171 
186  virtual bool Check (const AttributeValue &value) const = 0;
195  virtual std::string GetValueTypeName (void) const = 0;
203  virtual bool HasUnderlyingTypeInformation (void) const = 0;
208  virtual std::string GetUnderlyingTypeInformation (void) const = 0;
216  virtual Ptr<AttributeValue> Create (void) const = 0;
224  virtual bool Copy (const AttributeValue &source, AttributeValue &destination) const = 0;
225 };
226 
233 {
234 public:
237 
238 private:
242  virtual Ptr<AttributeValue> Copy (void) const;
249  virtual std::string SerializeToString (Ptr<const AttributeChecker> checker) const;
258  virtual bool DeserializeFromString (std::string value, Ptr<const AttributeChecker> checker);
259 };
260 
267 {
268 public:
271  virtual bool Set (ObjectBase * object, const AttributeValue &value) const;
272  virtual bool Get (const ObjectBase * object, AttributeValue &attribute) const;
273  virtual bool HasGetter (void) const;
274  virtual bool HasSetter (void) const;
275 };
276 
284 static inline Ptr<const AttributeAccessor>
286 {
288 }
289 
297 {
298 public:
301  virtual bool Check (const AttributeValue &value) const;
302  virtual std::string GetValueTypeName (void) const;
303  virtual bool HasUnderlyingTypeInformation (void) const;
304  virtual std::string GetUnderlyingTypeInformation (void) const;
305  virtual Ptr<AttributeValue> Create (void) const;
306  virtual bool Copy (const AttributeValue &source, AttributeValue &destination) const;
307 };
308 
316 static inline Ptr<AttributeChecker>
318 {
319  return Ptr<AttributeChecker> (new EmptyAttributeChecker (), false);
320 }
321 
322 } // namespace ns3
323 
324 #endif /* ATTRIBUTE_H */
virtual bool Copy(const AttributeValue &source, AttributeValue &destination) const =0
Copy the source to the destination.
virtual bool HasGetter(void) const
Definition: attribute.cc:128
Represent the type of an attribute.
Definition: attribute.h:166
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
virtual std::string GetValueTypeName(void) const
Definition: attribute.cc:153
ns3::Ptr smart pointer declaration and implementation.
Hold a value for an Attribute.
Definition: attribute.h:68
virtual bool Get(const ObjectBase *object, AttributeValue &attribute) const =0
virtual bool Set(ObjectBase *object, const AttributeValue &value) const
Definition: attribute.cc:112
virtual bool DeserializeFromString(std::string value, Ptr< const AttributeChecker > checker)
Definition: attribute.cc:99
static Ptr< const AttributeAccessor > MakeEmptyAttributeAccessor()
Create an empty AttributeAccessor.
Definition: attribute.h:285
virtual bool HasGetter(void) const =0
Anchor the ns-3 type and attribute system.
Definition: object-base.h:119
Ptr< AttributeValue > CreateValidValue(const AttributeValue &value) const
Create a valid value from the argument value, or reinterpret the argument as a string.
Definition: attribute.cc:54
virtual bool HasUnderlyingTypeInformation(void) const =0
virtual bool HasSetter(void) const =0
EmptyAttributeValue()
Default constructor.
Definition: attribute.cc:82
virtual bool Copy(const AttributeValue &source, AttributeValue &destination) const
Copy the source to the destination.
Definition: attribute.cc:178
virtual std::string SerializeToString(Ptr< const AttributeChecker > checker) const =0
A class for an empty attribute value.
Definition: attribute.h:232
virtual ~AttributeAccessor()
Definition: attribute.cc:45
virtual std::string GetValueTypeName(void) const =0
allow setting and getting the value of an attribute.
Definition: attribute.h:114
An accessor for EmptyAttributeValue.
Definition: attribute.h:266
virtual ~AttributeValue()
Definition: attribute.cc:39
virtual Ptr< AttributeValue > Copy(void) const =0
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual bool HasSetter(void) const
Definition: attribute.cc:134
virtual bool Set(ObjectBase *object, const AttributeValue &value) const =0
virtual Ptr< AttributeValue > Create(void) const =0
A checker for EmptyAttributeValue.
Definition: attribute.h:296
virtual ~AttributeChecker()
Definition: attribute.cc:50
virtual std::string SerializeToString(Ptr< const AttributeChecker > checker) const
Definition: attribute.cc:93
virtual Ptr< AttributeValue > Create(void) const
Definition: attribute.cc:171
virtual Ptr< AttributeValue > Copy(void) const
Definition: attribute.cc:87
virtual bool DeserializeFromString(std::string value, Ptr< const AttributeChecker > checker)=0
virtual bool HasUnderlyingTypeInformation(void) const
Definition: attribute.cc:159
virtual std::string GetUnderlyingTypeInformation(void) const
Definition: attribute.cc:165
virtual bool Check(const AttributeValue &value) const
Definition: attribute.cc:146
static Ptr< AttributeChecker > MakeEmptyAttributeChecker()
Create an empty AttributeChecker.
Definition: attribute.h:317
virtual bool Check(const AttributeValue &value) const =0
virtual std::string GetUnderlyingTypeInformation(void) const =0
A template-based reference counting class.
virtual bool Get(const ObjectBase *object, AttributeValue &attribute) const
Definition: attribute.cc:120
ns3::SimpleRefCount declaration and template implementation.