QueueDiscClass is the base class for classes that are included in a queue disc. More...

#include "queue-disc.h"

Inheritance diagram for ns3::QueueDiscClass:

Collaboration diagram for ns3::QueueDiscClass:

Public Member Functions
	QueueDiscClass ()

	~QueueDiscClass () override

Ptr< QueueDisc >	GetQueueDisc () const
	Get the queue disc attached to this class.

void	SetQueueDisc (Ptr< QueueDisc > qd)
	Set the queue disc attached to this class.

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.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

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, bool permissive=false) 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.

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.

Protected Member Functions
void	DoDispose () override
	Dispose of the object.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

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.

Private Attributes
Ptr< QueueDisc >	m_queueDisc
	Queue disc attached to this class.

Additional Inherited Members
Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

QueueDiscClass is the base class for classes that are included in a queue disc.

It has a single attribute, QueueDisc, used to set the child queue disc attached to the class. Classful queue discs needing to set parameters for their classes can subclass QueueDiscClass and add the required parameters as attributes.

Definition at line 40 of file queue-disc.h.

Constructor & Destructor Documentation

◆ QueueDiscClass()

ns3::QueueDiscClass::QueueDiscClass ( )

Definition at line 43 of file queue-disc.cc.

References NS_LOG_FUNCTION.

◆ ~QueueDiscClass()

ns3::QueueDiscClass::~QueueDiscClass ( )

override

Definition at line 48 of file queue-disc.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::QueueDiscClass::DoDispose ( )

overrideprotectedvirtual

Dispose of the object.

Reimplemented from ns3::Object.

Definition at line 54 of file queue-disc.cc.

References ns3::Object::DoDispose(), m_queueDisc, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetQueueDisc()

Ptr< QueueDisc > ns3::QueueDiscClass::GetQueueDisc ( ) const

Get the queue disc attached to this class.

Returns: the queue disc attached to this class.

Definition at line 62 of file queue-disc.cc.

References m_queueDisc, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::QueueDiscClass::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 29 of file queue-disc.cc.

References m_queueDisc, ns3::MakePointerAccessor(), ns3::MakePointerChecker(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ SetQueueDisc()

void ns3::QueueDiscClass::SetQueueDisc ( Ptr< QueueDisc > qd )

Set the queue disc attached to this class.

Parameters

qd	The queue disc to attach to this class

Definition at line 69 of file queue-disc.cc.

References m_queueDisc, NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_queueDisc

Ptr<QueueDisc> ns3::QueueDiscClass::m_queueDisc

private

Queue disc attached to this class.

Definition at line 71 of file queue-disc.h.

Referenced by DoDispose(), GetQueueDisc(), GetTypeId(), and SetQueueDisc().

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

src/traffic-control/model/queue-disc.h
src/traffic-control/model/queue-disc.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members