A Discrete-Event Network Simulator
API
Attributes

The ns-3 attribute system is the mechanism used in ns-3 to organize, document, and modify the values used by the various component models. More...

+ Collaboration diagram for Attributes:

Modules

 Address Attribute
 
Attribute implementation for Address
 
 Attribute Helper
 All these macros can be used to generate automatically the code for subclasses of AttributeValue, AttributeAccessor, and, AttributeChecker, which can be used to give attribute powers to a normal class.
 
 Boolean Attribute
 
Attribute implementation for Boolean
 
 Box Attribute
 
Attribute implementation for Box
 
 Callback Attribute
 
Attribute implementation for Callback
 
 DataRate Attribute
 
Attribute implementation for DataRate
 
 Double Attribute
 
Attribute implementation for Double
 
 DsssParameterSet Attribute
 
Attribute implementation for DsssParameterSet
 
 EdcaParameterSet Attribute
 
Attribute implementation for EdcaParameterSet
 
 EmptyAttribute Attribute
 
Attribute implementation for EmptyAttribute
 
 Enum Attribute
 
Attribute implementation for Enum
 
 ErpInformation Attribute
 
Attribute implementation for ErpInformation
 
 ExtendedCapabilities Attribute
 
Attribute implementation for ExtendedCapabilities
 
 HeCapabilities Attribute
 
Attribute implementation for HeCapabilities
 
 HeOperation Attribute
 
Attribute implementation for HeOperation
 
 HtCapabilities Attribute
 
Attribute implementation for HtCapabilities
 
 HtOperation Attribute
 
Attribute implementation for HtOperation
 
 IeMeshId Attribute
 
Attribute implementation for IeMeshId
 
 Integer Attribute
 
Attribute implementation for Integer
 
 Ipv4Address Attribute
 
Attribute implementation for Ipv4Address
 
 Ipv4Mask Attribute
 
Attribute implementation for Ipv4Mask
 
 Ipv6Address Attribute
 
Attribute implementation for Ipv6Address
 
 Ipv6Prefix Attribute
 
Attribute implementation for Ipv6Prefix
 
 Mac16Address Attribute
 
Attribute implementation for Mac16Address
 
 Mac48Address Attribute
 
Attribute implementation for Mac48Address
 
 Mac64Address Attribute
 
Attribute implementation for Mac64Address
 
 ObjectFactory Attribute
 
Attribute implementation for ObjectFactory
 
 ObjectMap Attribute
 
Attribute implementation for ObjectMap
 
 ObjectPtrContainer Attribute
 
Attribute implementation for ObjectPtrContainer
 
 ObjectVector Attribute
 
Attribute implementation for ObjectVector
 
 OrganizationIdentifier Attribute
 
Attribute implementation for OrganizationIdentifier
 
 Pointer Attribute
 
Attribute implementation for Pointer
 
 RandomVariable Attribute
 
Attribute implementation for RandomVariable
 
 Rectangle Attribute
 
Attribute implementation for Rectangle
 
 Ssid Attribute
 
Attribute implementation for Ssid
 
 String Attribute
 
Attribute implementation for String
 
 Time Attribute
 
Attribute implementation for Time
 
 TypeId Attribute
 
Attribute implementation for TypeId
 
 UanModesList Attribute
 
Attribute implementation for UanModesList
 
 Uinteger Attribute
 
Attribute implementation for Uinteger
 
 Vector2D Attribute
 
Attribute implementation for Vector2D
 
 Vector3D Attribute
 
Attribute implementation for Vector3D
 
 VhtCapabilities Attribute
 
Attribute implementation for VhtCapabilities
 
 VhtOperation Attribute
 
Attribute implementation for VhtOperation
 
 Waypoint Attribute
 
Attribute implementation for Waypoint
 
 WifiMode Attribute
 
Attribute implementation for WifiMode
 

Files

file  attribute.cc
 ns3::AttributeValue, ns3::AttributeAccessor and ns3::AttributeChecker implementations.
 
file  attribute.h
 ns3::AttributeValue, ns3::AttributeAccessor and ns3::AttributeChecker declarations.
 

Classes

class  ns3::AttributeAccessor
 allow setting and getting the value of an attribute. More...
 
class  ns3::AttributeChecker
 Represent the type of an attribute. More...
 
class  ns3::AttributeValue
 Hold a value for an Attribute. More...
 
class  ns3::EmptyAttributeValue
 A class for an empty attribute value. More...
 

Functions

static Ptr< const AttributeAccessorns3::MakeEmptyAttributeAccessor ()
 Create an empty AttributeAccessor. More...
 
static Ptr< AttributeCheckerns3::MakeEmptyAttributeChecker ()
 Create an empty AttributeChecker. More...
 

Detailed Description

The ns-3 attribute system is the mechanism used in ns-3 to organize, document, and modify the values used by the various component models.

Attributes also enable the tracing and statistics gathering in the simulator.

See Attribute Helper for macros to ease the declaration and definition of Attributes.

Function Documentation

◆ MakeEmptyAttributeAccessor()

static Ptr<const AttributeAccessor> ns3::MakeEmptyAttributeAccessor ( )
inlinestatic

Create an empty AttributeAccessor.

Returns
The empty AttributeAccessor (runtime exception if used)

Definition at line 284 of file attribute.h.

Referenced by DeprecatedAttribute::GetTypeId().

+ Here is the caller graph for this function:

◆ MakeEmptyAttributeChecker()

static Ptr<AttributeChecker> ns3::MakeEmptyAttributeChecker ( )
inlinestatic

Create an empty AttributeChecker.

Returns
The empty AttributeChecker (runtime exception if used)

Definition at line 316 of file attribute.h.

Referenced by DeprecatedAttribute::GetTypeId().

+ Here is the caller graph for this function: