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

This object represents the underlying nsc stack, which is aggregated to a Node object, and which provides access to the sysctls of the nsc stack through attributes. More...

#include "nsc-sysctl.h"

+ Inheritance diagram for ns3::Ns3NscStack:
+ Collaboration diagram for ns3::Ns3NscStack:

Public Member Functions

virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
void SetStack (INetStack *stack)
 Set the underlying stack. More...
 
- 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...
 
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...
 
template<>
Ptr< ObjectGetObject () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
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::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

std::string Get (std::string name) const
 Get an attribute. More...
 
void Set (std::string name, std::string value)
 Set an attribute. More...
 

Private Attributes

INetStackm_stack
 the underlying stack More...
 

Related Functions

(Note that these are not member functions.)

class NscStackStringAccessor
 NscStackStringAccessor friend class. 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

This object represents the underlying nsc stack, which is aggregated to a Node object, and which provides access to the sysctls of the nsc stack through attributes.

Definition at line 35 of file nsc-sysctl.h.

Member Function Documentation

◆ Get()

std::string ns3::Ns3NscStack::Get ( std::string  name) const
private

Get an attribute.

Parameters
namethe attribute name
Returns
the attribute value

Definition at line 135 of file nsc-sysctl.cc.

References m_stack, and INetStack::sysctl_get().

Referenced by ns3::NscStackStringAccessor::Get().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::Ns3NscStack::GetInstanceTypeId ( void  ) const
virtual

Get the most derived TypeId for this Object.

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

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

Reimplemented from ns3::Object.

Definition at line 94 of file nsc-sysctl.cc.

References ns3::TypeId::AddAttribute(), INetStack::get_name(), GetTypeId(), ns3::TypeId::LookupByNameFailSafe(), m_stack, ns3::MakeStringChecker(), ns3::TypeId::SetParent(), INetStack::sysctl_get(), and INetStack::sysctl_getnum().

+ Here is the call graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Referenced by GetInstanceTypeId().

+ Here is the caller graph for this function:

◆ Set()

void ns3::Ns3NscStack::Set ( std::string  name,
std::string  value 
)
private

Set an attribute.

Parameters
namethe attribute name
valuethe attribute value

Definition at line 146 of file nsc-sysctl.cc.

References m_stack, NS_FATAL_ERROR, and INetStack::sysctl_set().

Referenced by ns3::NscStackStringAccessor::Set().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetStack()

void ns3::Ns3NscStack::SetStack ( INetStack stack)
inline

Set the underlying stack.

Parameters
stackthe stack

Definition at line 48 of file nsc-sysctl.h.

References m_stack, and first::stack.

Friends And Related Function Documentation

◆ NscStackStringAccessor

friend class NscStackStringAccessor
friend

NscStackStringAccessor friend class.

Definition at line 55 of file nsc-sysctl.h.

Member Data Documentation

◆ m_stack

INetStack* ns3::Ns3NscStack::m_stack
private

the underlying stack

Definition at line 68 of file nsc-sysctl.h.

Referenced by Get(), GetInstanceTypeId(), Set(), and SetStack().


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