A Discrete-Event Network Simulator
API
object.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2007 INRIA, Gustavo Carneiro
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: Gustavo Carneiro <gjcarneiro@gmail.com>,
19  * Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
20  */
21 #ifndef OBJECT_H
22 #define OBJECT_H
23 
24 #include <stdint.h>
25 #include <string>
26 #include <vector>
27 #include "ptr.h"
28 #include "attribute.h"
29 #include "object-base.h"
31 #include "simple-ref-count.h"
32 
40 namespace ns3 {
41 
42 class Object;
43 class AttributeAccessor;
44 class AttributeValue;
45 class TraceSourceAccessor;
46 
60 {
69  inline static void Delete (Object *object);
70 };
71 
87 class Object : public SimpleRefCount<Object, ObjectBase, ObjectDeleter>
88 {
89 public:
94  static TypeId GetTypeId (void);
95 
105  {
106 public:
109 
116  bool HasNext (void) const;
117 
123  Ptr<const Object> Next (void);
124 private:
125  friend class Object;
136  uint32_t m_current;
137  };
138 
140  Object ();
142  virtual ~Object ();
143 
144  virtual TypeId GetInstanceTypeId (void) const;
145 
152  template <typename T>
153  inline Ptr<T> GetObject (void) const;
161  template <typename T>
162  Ptr<T> GetObject (TypeId tid) const;
177  void Dispose (void);
193  void AggregateObject (Ptr<Object> other);
194 
205  AggregateIterator GetAggregateIterator (void) const;
206 
217  void Initialize (void);
218 
224  bool IsInitialized (void) const;
225 
226 protected:
240  virtual void NotifyNewAggregate (void);
252  virtual void DoInitialize (void);
268  virtual void DoDispose (void);
289  Object (const Object &o);
290 
291 private:
292 
303  template <typename T>
304  friend Ptr<T> CopyObject (Ptr<T> object);
305  template <typename T>
306  friend Ptr<T> CopyObject (Ptr<const T> object);
316  template <typename T>
317  friend Ptr<T> CompleteConstruct (T *object);
318 
319  friend class ObjectFactory;
320  friend class AggregateIterator;
321  friend struct ObjectDeleter;
322 
335  struct Aggregates {
337  uint32_t n;
339  Object *buffer[1];
340  };
341 
348  Ptr<Object> DoGetObject (TypeId tid) const;
353  bool Check (void) const;
366  bool CheckLoose (void) const;
376  void SetTypeId (TypeId tid);
387  void Construct (const AttributeConstructionList &attributes);
388 
395  void UpdateSortedArray (struct Aggregates *aggregates, uint32_t i) const;
403  void DoDelete (void);
404 
435 };
436 
437 template <typename T>
439 template <typename T>
440 Ptr<T> CopyObject (Ptr<T> object);
441 
442 } // namespace ns3
443 
444 namespace ns3 {
445 
446 
447 /*************************************************************************
448  * The Object implementation which depends on templates
449  *************************************************************************/
450 
451 void
453 {
454  object->DoDelete ();
455 }
456 
457 template <typename T>
458 Ptr<T>
460 {
461  // This is an optimization: if the cast works (which is likely),
462  // things will be pretty fast.
463  T *result = dynamic_cast<T *> (m_aggregates->buffer[0]);
464  if (result != 0)
465  {
466  return Ptr<T> (result);
467  }
468  // if the cast does not work, we try to do a full type check.
469  Ptr<Object> found = DoGetObject (T::GetTypeId ());
470  if (found != 0)
471  {
472  return Ptr<T> (static_cast<T *> (PeekPointer (found)));
473  }
474  return 0;
475 }
476 
477 template <typename T>
478 Ptr<T>
480 {
481  Ptr<Object> found = DoGetObject (tid);
482  if (found != 0)
483  {
484  return Ptr<T> (static_cast<T *> (PeekPointer (found)));
485  }
486  return 0;
487 }
488 
489 /*************************************************************************
490  * The helper functions which need templates.
491  *************************************************************************/
492 
493 template <typename T>
495 {
496  Ptr<T> p = Ptr<T> (new T (*PeekPointer (object)), false);
497  NS_ASSERT (p->GetInstanceTypeId () == object->GetInstanceTypeId ());
498  return p;
499 }
500 
501 template <typename T>
503 {
504  Ptr<T> p = Ptr<T> (new T (*PeekPointer (object)), false);
505  NS_ASSERT (p->GetInstanceTypeId () == object->GetInstanceTypeId ());
506  return p;
507 }
508 
509 template <typename T>
511 {
512  object->SetTypeId (T::GetTypeId ());
513  object->Object::Construct (AttributeConstructionList ());
514  return Ptr<T> (object, false);
515 }
516 
527 template <typename T>
529 {
530  return CompleteConstruct (new T ());
531 }
539 template <typename T, typename T1>
541 {
542  return CompleteConstruct (new T (a1));
543 }
544 
554 template <typename T, typename T1, typename T2>
555 Ptr<T> CreateObject (T1 a1, T2 a2)
556 {
557  return CompleteConstruct (new T (a1,a2));
558 }
559 
571 template <typename T, typename T1, typename T2, typename T3>
572 Ptr<T> CreateObject (T1 a1, T2 a2, T3 a3)
573 {
574  return CompleteConstruct (new T (a1,a2,a3));
575 }
576 
590 template <typename T, typename T1, typename T2, typename T3, typename T4>
591 Ptr<T> CreateObject (T1 a1, T2 a2, T3 a3, T4 a4)
592 {
593  return CompleteConstruct (new T (a1,a2,a3,a4));
594 }
595 
611 template <typename T, typename T1, typename T2, typename T3, typename T4, typename T5>
612 Ptr<T> CreateObject (T1 a1, T2 a2, T3 a3, T4 a4, T5 a5)
613 {
614  return CompleteConstruct (new T (a1,a2,a3,a4,a5));
615 }
616 
634 template <typename T, typename T1, typename T2, typename T3, typename T4, typename T5, typename T6>
635 Ptr<T> CreateObject (T1 a1, T2 a2, T3 a3, T4 a4, T5 a5, T6 a6)
636 {
637  return CompleteConstruct (new T (a1,a2,a3,a4,a5,a6));
638 }
639 
659 template <typename T, typename T1, typename T2, typename T3, typename T4, typename T5, typename T6, typename T7>
660 Ptr<T> CreateObject (T1 a1, T2 a2, T3 a3, T4 a4, T5 a5, T6 a6, T7 a7)
661 {
662  return CompleteConstruct (new T (a1,a2,a3,a4,a5,a6,a7));
663 }
666 } // namespace ns3
667 
668 #endif /* OBJECT_H */
669 
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
Ptr< T > GetObject(void) const
Get a pointer to the requested aggregated Object.
Definition: object.h:459
ns3::Ptr smart pointer declaration and implementation.
bool m_disposed
Set to true when the DoDispose() method of the Object has run, false otherwise.
Definition: object.h:413
uint32_t m_getObjectCount
The number of times the Object was accessed with a call to GetObject().
Definition: object.h:434
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
Definition: assert.h:67
U * PeekPointer(const Ptr< U > &p)
Definition: ptr.h:564
struct Aggregates * m_aggregates
A pointer to an array of &#39;aggregates&#39;.
Definition: object.h:426
bool m_initialized
Set to true once the DoInitialize() method has run, false otherwise.
Definition: object.h:418
ns3::AttributeConstructionList declaration.
ns3::ObjectBase declaration and NS_OBJECT_ENSURE_REGISTERED() madro definition.
Ptr< const Object > m_object
Parent Object.
Definition: object.h:135
ns3::AttributeValue, ns3::AttributeAccessor and ns3::AttributeChecker declarations.
List of Attribute name, value and checker triples used to construct Objects.
uint32_t n
The number of entries in buffer.
Definition: object.h:337
Every class exported by the ns3 library is enclosed in the ns3 namespace.
TypeId m_tid
Identifies the type of this Object instance.
Definition: object.h:408
Standard Object deleter, used by SimpleRefCount to delete an Object when the reference count drops to...
Definition: object.h:59
static void Delete(Object *object)
Smart pointer deleter implementation for Object.
Definition: object.h:452
Instantiate subclasses of ns3::Object.
Ptr< T > CopyObject(Ptr< const T > object)
Definition: object.h:494
uint32_t m_current
Current position in parent&#39;s aggregates.
Definition: object.h:136
Ptr< T > CompleteConstruct(T *object)
Definition: object.h:510
Ptr< T > CreateObject(void)
Create an object by type, with varying number of constructor parameters.
Definition: object.h:528
A base class which provides memory management and object aggregation.
Definition: object.h:87
A template-based reference counting class.
a unique identifier for an interface.
Definition: type-id.h:58
Iterate over the Objects aggregated to an ns3::Object.
Definition: object.h:104
ns3::SimpleRefCount declaration and template implementation.
The list of Objects aggregated to this one.
Definition: object.h:335