A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::SimpleChannel Class Reference

A simple channel, for simple things and testing. More...

#include <simple-channel.h>

+ Inheritance diagram for ns3::SimpleChannel:
+ Collaboration diagram for ns3::SimpleChannel:

Public Member Functions

 SimpleChannel ()
 
virtual void Add (Ptr< SimpleNetDevice > device)
 Attached a net device to the channel. More...
 
virtual Ptr< NetDeviceGetDevice (uint32_t i) const
 
virtual uint32_t GetNDevices (void) const
 
virtual void Send (Ptr< Packet > p, uint16_t protocol, Mac48Address to, Mac48Address from, Ptr< SimpleNetDevice > sender)
 A packet is sent by a net device. More...
 
- Public Member Functions inherited from ns3::Channel
 Channel ()
 
virtual ~Channel ()
 
uint32_t GetId (void) const
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 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. 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
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

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::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

std::vector< Ptr
< SimpleNetDevice > > 
m_devices
 devices connected by the channel More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

A simple channel, for simple things and testing.

Config Paths

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

  • /ChannelList/[i]/$ns3::SimpleChannel

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

Definition at line 36 of file simple-channel.h.

Constructor & Destructor Documentation

ns3::SimpleChannel::SimpleChannel ( )

Definition at line 43 of file simple-channel.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::SimpleChannel::Add ( Ptr< SimpleNetDevice device)
virtual

Attached a net device to the channel.

Parameters
devicethe device to attach to the channel

Reimplemented in ns3::ErrorChannelSixlow, and ns3::ErrorChannel.

Definition at line 67 of file simple-channel.cc.

References m_devices, and NS_LOG_FUNCTION.

Ptr< NetDevice > ns3::SimpleChannel::GetDevice ( uint32_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.

Reimplemented in ns3::ErrorChannelSixlow, and ns3::ErrorChannel.

Definition at line 80 of file simple-channel.cc.

References m_devices, and NS_LOG_FUNCTION.

uint32_t ns3::SimpleChannel::GetNDevices ( void  ) const
virtual
Returns
the number of NetDevices connected to this Channel.

This method must be implemented by subclasses.

Implements ns3::Channel.

Reimplemented in ns3::ErrorChannelSixlow, and ns3::ErrorChannel.

Definition at line 74 of file simple-channel.cc.

References m_devices, and NS_LOG_FUNCTION.

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

Get the type ID.

Returns
the object TypeId

Definition at line 34 of file simple-channel.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

void ns3::SimpleChannel::Send ( Ptr< Packet p,
uint16_t  protocol,
Mac48Address  to,
Mac48Address  from,
Ptr< SimpleNetDevice sender 
)
virtual

A packet is sent by a net device.

A receive event will be scheduled for all net device connected to the channel other than the net device who sent the packet

Parameters
ppacket to be sent
protocolprotocol number
toaddress to send packet to
fromaddress the packet is coming from
sendernetdevice who sent the packet

Reimplemented in ns3::ErrorChannelSixlow, and ns3::ErrorChannel.

Definition at line 49 of file simple-channel.cc.

References ns3::Packet::Copy(), m_devices, NS_LOG_FUNCTION, ns3::SimpleNetDevice::Receive(), and ns3::Simulator::ScheduleWithContext().

+ Here is the call graph for this function:

Member Data Documentation

std::vector<Ptr<SimpleNetDevice> > ns3::SimpleChannel::m_devices
private

devices connected by the channel

Definition at line 73 of file simple-channel.h.

Referenced by Add(), GetDevice(), GetNDevices(), and Send().


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