Abstract Channel Base Class. More...
#include "channel.h"
Public Member Functions | |
Channel () | |
~Channel () override | |
virtual Ptr< NetDevice > | GetDevice (std::size_t i) const =0 |
uint32_t | GetId () const |
virtual std::size_t | GetNDevices () const =0 |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
virtual TypeId | GetInstanceTypeId () const =0 |
Get the most derived TypeId for this Object. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Attributes | |
uint32_t | m_id |
Channel id for this channel. | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoDispose () |
Destructor implementation. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Abstract Channel Base Class.
A channel is a logical path over which information flows. The path can be as simple as a short piece of wire, or as complicated as space-time.
Subclasses must use Simulator::ScheduleWithContext to correctly update event contexts when scheduling an event from one node to another one.
ns3::Channel is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Size of this type is 32 bytes (on a 64-bit architecture).
ns3::Channel::Channel | ( | ) |
Definition at line 48 of file channel.cc.
References ns3::ChannelList::Add(), m_id, and NS_LOG_FUNCTION.
|
override |
Definition at line 55 of file channel.cc.
References NS_LOG_FUNCTION.
i | index of NetDevice to retrieve |
This method must be implemented by subclasses.
Implemented in ns3::BridgeChannel, ns3::CsmaChannel, ns3::ErrorChannel, ns3::SimpleChannel, ns3::PointToPointChannel, ns3::MultiModelSpectrumChannel, ns3::SingleModelSpectrumChannel, ns3::UanChannel, ns3::YansWifiChannel, and ns3::WimaxChannel.
uint32_t ns3::Channel::GetId | ( | ) | const |
This unique id happens to be also the index of the Channel into the ChannelList.
Definition at line 61 of file channel.cc.
References m_id, and NS_LOG_FUNCTION.
|
pure virtual |
This method must be implemented by subclasses.
Implemented in ns3::BridgeChannel, ns3::CsmaChannel, ns3::ErrorChannel, ns3::SimpleChannel, ns3::PointToPointChannel, ns3::MultiModelSpectrumChannel, ns3::SingleModelSpectrumChannel, ns3::UanChannel, ns3::YansWifiChannel, and ns3::WimaxChannel.
|
static |
Get the type ID.
Definition at line 34 of file channel.cc.
References ns3::TypeId::ATTR_GET, m_id, ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().
|
private |