A Discrete-Event Network Simulator
API
ns3::BridgeChannel Class Reference

Virtual channel implementation for bridges (BridgeNetDevice). More...

#include "bridge-channel.h"

+ Inheritance diagram for ns3::BridgeChannel:
+ Collaboration diagram for ns3::BridgeChannel:

Public Member Functions

 BridgeChannel ()
 
virtual ~BridgeChannel ()
 
void AddChannel (Ptr< Channel > bridgedChannel)
 Adds a channel to the bridged pool. More...
 
virtual Ptr< NetDeviceGetDevice (std::size_t i) const
 
virtual std::size_t GetNDevices (void) const
 
- Public Member Functions inherited from ns3::Channel
 Channel ()
 
virtual ~Channel ()
 
uint32_t GetId (void) const
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Channel
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Member Functions

 BridgeChannel (const BridgeChannel &)
 Copy constructor. More...
 
BridgeChanneloperator= (const BridgeChannel &)
 Copy constructor. More...
 

Private Attributes

std::vector< Ptr< Channel > > m_bridgedChannels
 pool of bridged channels More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Virtual channel implementation for bridges (BridgeNetDevice).


Just like BridgeNetDevice aggregates multiple NetDevices, BridgeChannel aggregates multiple channels and make them appear as a single channel to upper layers.

Config Paths

ns3::BridgeChannel is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::BridgeChannel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::BridgeChannel"
  • "/ChannelList/[i]/$ns3::BridgeChannel"

No Attributes are defined for this type.

Attributes defined in parent class ns3::Channel

  • Id: The id (unique integer) of this Channel.

No TraceSources are defined for this type.
Size of this type is 56 bytes (on a 64-bit architecture).

Definition at line 42 of file bridge-channel.h.

Constructor & Destructor Documentation

◆ BridgeChannel() [1/2]

ns3::BridgeChannel::BridgeChannel ( )

Definition at line 45 of file bridge-channel.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ ~BridgeChannel()

ns3::BridgeChannel::~BridgeChannel ( )
virtual

Definition at line 51 of file bridge-channel.cc.

References m_bridgedChannels, and NS_LOG_FUNCTION_NOARGS.

◆ BridgeChannel() [2/2]

ns3::BridgeChannel::BridgeChannel ( const BridgeChannel )
private

Copy constructor.

Defined and unimplemented to avoid misuse

Member Function Documentation

◆ AddChannel()

void ns3::BridgeChannel::AddChannel ( Ptr< Channel bridgedChannel)

Adds a channel to the bridged pool.

Parameters
bridgedChannelthe channel to add to the pool

Definition at line 65 of file bridge-channel.cc.

References m_bridgedChannels.

◆ GetDevice()

Ptr< NetDevice > ns3::BridgeChannel::GetDevice ( std::size_t  i) const
virtual
Parameters
iindex of NetDevice to retrieve
Returns
one of the NetDevices connected to this channel.

This method must be implemented by subclasses.

Implements ns3::Channel.

Definition at line 84 of file bridge-channel.cc.

References m_bridgedChannels.

◆ GetNDevices()

std::size_t ns3::BridgeChannel::GetNDevices ( void  ) const
virtual
Returns
the number of NetDevices connected to this Channel.

This method must be implemented by subclasses.

Implements ns3::Channel.

Definition at line 71 of file bridge-channel.cc.

References m_bridgedChannels.

◆ GetTypeId()

TypeId ns3::BridgeChannel::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 35 of file bridge-channel.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ operator=()

BridgeChannel& ns3::BridgeChannel::operator= ( const BridgeChannel )
private

Copy constructor.

Defined and unimplemented to avoid misuse

Returns

Member Data Documentation

◆ m_bridgedChannels

std::vector< Ptr<Channel> > ns3::BridgeChannel::m_bridgedChannels
private

pool of bridged channels

Definition at line 80 of file bridge-channel.h.

Referenced by AddChannel(), GetDevice(), GetNDevices(), and ~BridgeChannel().


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