a base class which provides memory management and object aggregation More...

#include <object.h>

Inherits SimpleRefCount< Object, ObjectBase, ObjectDeleter >.

Inherited by ns3::Application, ns3::ArpCache, ns3::ArpL3Protocol, ns3::AthstatsWifiTraceSink, ns3::BandwidthManager, ns3::BSLinkManager, ns3::BSScheduler, ns3::BurstProfileManager, ns3::CanvasLocation, ns3::Channel, ns3::ConnectionManager, ns3::DataCalculator, ns3::DataCollector, ns3::DataOutputInterface, ns3::Dcf, ns3::DeviceEnergyModel, ns3::dot11s::AirtimeLinkMetricCalculator, ns3::dot11s::HwmpRtable, ns3::dot11s::PeerLink, ns3::dot11s::PeerManagementProtocol, ns3::EnergySource, ns3::EnergySourceContainer, ns3::ErrorModel, ns3::ErrorRateModel, ns3::flame::FlameRtable, ns3::FlowMonitor, ns3::GlobalRouter, ns3::IpcsClassifier, ns3::Ipv4, ns3::Ipv4Interface, ns3::Ipv4L4Protocol, ns3::Ipv4RoutingProtocol, ns3::Ipv6, ns3::Ipv6AutoconfiguredPrefix, ns3::Ipv6Extension, ns3::Ipv6ExtensionDemux, ns3::Ipv6ExtensionRoutingDemux, ns3::Ipv6Interface, ns3::Ipv6L4Protocol, ns3::Ipv6Option, ns3::Ipv6OptionDemux, ns3::Ipv6RoutingProtocol, ns3::MacLow, ns3::MeshL2RoutingProtocol, ns3::MeshStack, ns3::MobilityModel, ns3::MsduAggregator, ns3::NdiscCache, ns3::NetDevice, ns3::Node, ns3::NodeListPriv, ns3::Ns3NscStack, ns3::PacketBurst, ns3::PcapFileWrapper, ns3::PositionAllocator, ns3::PriorityUlJob, ns3::PropagationDelayModel, ns3::PropagationLossModel, ns3::Queue, ns3::RttEstimator, ns3::Scheduler, ns3::ServiceFlowManager, ns3::SimulatorImpl, ns3::Socket, ns3::SocketFactory, ns3::SpectrumErrorModel, ns3::SpectrumInterference, ns3::SpectrumPhy, ns3::SpectrumPropagationLossModel, ns3::SSLinkManager, ns3::SSManager, ns3::SSScheduler, ns3::Synchronizer, ns3::TopologyReader, ns3::UanMac, ns3::UanNoiseModel, ns3::UanPhy, ns3::UanPhyCalcSinr, ns3::UanPhyPer, ns3::UanPropModel, ns3::UanTransducer, ns3::UlJob, ns3::UplinkScheduler, ns3::WifiMac, ns3::WifiMacQueue, ns3::WifiPhy, ns3::WifiPhyStateHelper, ns3::WifiRemoteStationManager, ns3::WimaxConnection, ns3::WimaxMacQueue, and ns3::WimaxPhy.

Collaboration diagram for ns3::Object:

[legend]

List of all members.

Classes
class	AggregateIterator
	Iterate over the objects aggregated to an ns3::Object. More...
struct	Aggregates
Public Member Functions
virtual TypeId	GetInstanceTypeId (void) const
template<typename T >
Ptr< T >	GetObject (void) const
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
void	Dispose (void)
void	AggregateObject (Ptr< Object > other)
AggregateIterator	GetAggregateIterator (void) const
void	Start (void)
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::Object.
Protected Member Functions
virtual void	NotifyNewAggregate (void)
virtual void	DoStart (void)
virtual void	DoDispose (void)
	Object (const Object &o)
Friends
class	ObjectFactory
class	AggregateIterator
struct	ObjectDeleter
template<typename T >
Ptr< T >	CreateObjectWithAttributes (const AttributeList &attributes)
template<typename T >
Ptr< T >	CopyObject (Ptr< T > object)
template<typename T >
Ptr< T >	CopyObject (Ptr< const T > object)
void	PythonCompleteConstruct (Ptr< Object > object, TypeId typeId, const AttributeList &attributes)
template<typename T >
Ptr< T >	CompleteConstruct (T *object)

Detailed Description

a base class which provides memory management and object aggregation

The memory management scheme is based on reference-counting with dispose-like functionality to break the reference cycles. The reference count is increamented and decremented with the methods Object::Ref and Object::Unref. If a reference cycle is present, the user is responsible for breaking it by calling Object::Dispose in a single location. This will eventually trigger the invocation of Object::DoDispose on itself and all its aggregates. The Object::DoDispose method is always automatically invoked from the Object::Unref method before destroying the object, even if the user did not call Object::Dispose directly.

Constructor & Destructor Documentation

ns3::Object::Object ( const Object & o ) [protected]

Parameters:

o

the object to copy.

Allow subclasses to implement a copy constructor. While it is technically possible to implement a copy constructor in a subclass, we strongly discourage you to do so. If you really want to do it anyway, you have to understand that this copy constructor will _not_ copy aggregated objects. i.e., if your object instance is already aggregated to another object and if you invoke this copy constructor, the new object instance will be a pristine standalone object instance not aggregated to any other object. It is thus _your_ responsability as a caller of this method to do what needs to be done (if it is needed) to ensure that the object stays in a valid state.

Member Function Documentation

void ns3::Object::AggregateObject ( Ptr< Object > other )

Parameters:

other

another object pointer

This method aggregates the two objects together: after this method returns, it becomes possible to call GetObject on one to get the other, and vice-versa.

This method calls the virtual method NotifyNewAggregates to notify all aggregated objects that they have been aggregated together.

See also:: NotifyNewAggregate

void ns3::Object::Dispose ( void )

Run the DoDispose methods of this object and all the objects aggregated to it. After calling this method, the object is expected to be totally unusable except for the Ref and Unref methods. It is an error to call Dispose twice on the same object instance.

This method is typically used to break reference cycles.

virtual void ns3::Object::DoDispose ( void ) [protected, virtual]

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented in ns3::OnOffApplication, ns3::PacketSink, ns3::Ping6, ns3::Radvd, ns3::UdpClient, ns3::UdpServer, ns3::UdpTraceClient, ns3::UdpEchoClient, ns3::UdpEchoServer, ns3::SpectrumPropagationLossModel, ns3::CounterCalculator< T >, ns3::DataCalculator, ns3::DataCollector, ns3::DataOutputInterface, ns3::OmnetDataOutput, ns3::PacketCounterCalculator, ns3::SqliteDataOutput, ns3::TimeMinMaxAvgTotalCalculator, ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::dot11s::HwmpProtocol, ns3::dot11s::HwmpRtable, ns3::dot11s::PeerLink, ns3::dot11s::PeerManagementProtocol, ns3::flame::FlameProtocol, ns3::flame::FlameRtable, ns3::MeshPointDevice, ns3::MultiModelSpectrumChannel, ns3::SpectrumAnalyzer, ns3::ShannonSpectrumErrorModel, ns3::SpectrumInterference, ns3::TapBridge, ns3::UanChannel, ns3::UanMacAloha, ns3::UanMacRcGw, ns3::UanMacRc, ns3::UanNetDevice, ns3::UanNoiseModel, ns3::UanPhyDual, ns3::UanPhyGen, ns3::UanPhyCalcSinr, ns3::UanPhyPer, ns3::UanPropModel, ns3::UanTransducerHd, ns3::VirtualNetDevice, ns3::EdcaTxopN, ns3::WifiRemoteStationManager, ns3::BandwidthManager, ns3::BsServiceFlowManager, ns3::BurstProfileManager, ns3::ConnectionManager, ns3::ServiceFlowManager, ns3::SSLinkManager, ns3::SSScheduler, ns3::SsServiceFlowManager, ns3::WimaxNetDevice, ns3::WimaxPhy, ns3::Dot11sStack, ns3::FlameStack, ns3::ArpL3Protocol, ns3::Icmpv6L4Protocol, ns3::Ipv4Interface, ns3::Ipv4L3Protocol, ns3::Ipv6ExtensionDemux, ns3::Ipv6ExtensionFragment, ns3::Ipv6ExtensionRoutingDemux, ns3::Ipv6Interface, ns3::Ipv6L3Protocol, ns3::Ipv6OptionDemux, ns3::LoopbackNetDevice, ns3::NscTcpL4Protocol, ns3::NscTcpSocketFactoryImpl, ns3::TcpL4Protocol, ns3::TcpSocketFactoryImpl, ns3::UdpL4Protocol, ns3::UdpSocketFactoryImpl, ns3::Application, ns3::Node, ns3::SimpleNetDevice, ns3::Socket, ns3::aodv::RoutingProtocol, ns3::Ipv4GlobalRouting, ns3::Ipv4ListRouting, ns3::Ipv6ListRouting, ns3::Ipv4StaticRouting, ns3::Ipv6StaticRouting, and ns3::CounterCalculator< uint32_t >.

virtual void ns3::Object::DoStart ( void ) [protected, virtual]

This method is called only once by Object::Start. If the user calls Object::Start multiple times, DoStart is called only the first time.

Subclasses are expected to override this method and _chain up_ to their parent's implementation once they are done. It is safe to call GetObject and AggregateObject from within this method.

Reimplemented in ns3::RandomWaypointMobilityModel, ns3::SteadyStateRandomWaypointMobilityModel, ns3::Application, ns3::Node, ns3::Ipv4ListRouting, and ns3::olsr::RoutingProtocol.

AggregateIterator ns3::Object::GetAggregateIterator ( void ) const

Returns:: an iterator to the first object aggregated to this object.

If no objects are aggregated to this object, then, the returned iterator will be empty and AggregateIterator::HasNext will always return false.

virtual TypeId ns3::Object::GetInstanceTypeId ( void ) const [virtual]

Returns:: the TypeId associated to the most-derived type of this instance.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Implements ns3::ObjectBase.

Reimplemented in ns3::FlowMonitor, and ns3::Ns3NscStack.

template<typename T >

Ptr< T > ns3::Object::GetObject ( TypeId tid ) const

Parameters:

tid

the interface id of the requested interface

Returns:: a pointer to the requested interface or zero if it could not be found.

template<typename T >

Ptr< T > ns3::Object::GetObject ( void ) const [inline]

Returns:: a pointer to the requested interface or zero if it could not be found.

static TypeId ns3::Object::GetTypeId ( void ) [static]

This method returns the TypeId associated to ns3::Object.

This object is accessible through the following paths with Config::Set and Config::Connect:

/NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy
/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier
/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager
/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager
/NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager
/NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy
/NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier
/NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager
/NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler
/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel
/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel
/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac
/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy
/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel
/NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::ObjectBase.

virtual void ns3::Object::NotifyNewAggregate ( void ) [protected, virtual]

This method is invoked whenever two sets of objects are aggregated together. It is invoked exactly once for each object in both sets. This method can be overriden by subclasses who wish to be notified of aggregation events. These subclasses must chain up to their base class NotifyNewAggregate method. It is safe to call GetObject and AggregateObject from within this method.

Reimplemented in ns3::ArpL3Protocol, ns3::Icmpv4L4Protocol, ns3::Icmpv6L4Protocol, ns3::Ipv4L3Protocol, ns3::Ipv6L3Protocol, ns3::NscTcpL4Protocol, ns3::TcpL4Protocol, and ns3::UdpL4Protocol.

void ns3::Object::Start ( void )

This method calls the virtual DoStart method on all the objects aggregated to this object. DoStart will be called only once over the lifetime of an object, just like DoDispose is called only once.

See also:: DoStart

Reimplemented in ns3::SpectrumAnalyzer, ns3::WaveformGenerator, ns3::BaseStationNetDevice, ns3::SubscriberStationNetDevice, and ns3::WimaxNetDevice.

Friends And Related Function Documentation

template<typename T >

Ptr<T> CopyObject ( Ptr< T > object ) [friend]

Parameters:

object

a pointer to the object to copy.

Returns:: a copy of the input object.

This method invoke the copy constructor of the input object and returns the new instance.

template<typename T >

Ptr<T> CopyObject ( Ptr< const T > object ) [friend]

Parameters:

object

a pointer to the object to copy.

Returns:: a copy of the input object.

This method invoke the copy constructor of the input object and returns the new instance.

template<typename T >

Ptr<T> CreateObjectWithAttributes ( const AttributeList & attributes ) [friend]

Parameters:

attributes

a list of attributes to set on the object during construction.

Returns:: a pointer to a newly allocated object.

This allocates an object on the heap and initializes it with a set of attributes.

The documentation for this class was generated from the following files:

src/core/object.h
doc/introspected-doxygen.h

ns3::Object Class Reference [Object]

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

ns3::Object Class Reference
[Object]