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
 AttributeValue 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
 AttributeValue implementation for Boolean.
 
 Box Attribute
 AttributeValue implementation for Box.
 
 Callback Attribute
 AttributeValue implementation for Callback.
 
 DataRate Attribute
 AttributeValue implementation for DataRate.
 
 Double Attribute
 AttributeValue implementation for Double.
 
 EmptyAttribute Attribute
 AttributeValue implementation for EmptyAttribute.
 
 Enum Attribute
 AttributeValue implementation for Enum.
 
 IeMeshId Attribute
 AttributeValue implementation for IeMeshId.
 
 Integer Attribute
 AttributeValue implementation for Integer.
 
 Ipv4Address Attribute
 AttributeValue implementation for Ipv4Address.
 
 Ipv4Mask Attribute
 AttributeValue implementation for Ipv4Mask.
 
 Ipv6Address Attribute
 AttributeValue implementation for Ipv6Address.
 
 Ipv6Prefix Attribute
 AttributeValue implementation for Ipv6Prefix.
 
 Length Attribute
 AttributeValue implementation for Length.
 
 Mac16Address Attribute
 AttributeValue implementation for Mac16Address.
 
 Mac48Address Attribute
 AttributeValue implementation for Mac48Address.
 
 Mac64Address Attribute
 AttributeValue implementation for Mac64Address.
 
 ObjectFactory Attribute
 AttributeValue implementation for ObjectFactory.
 
 ObjectMap Attribute
 AttributeValue implementation for ObjectMap.
 
 ObjectPtrContainer Attribute
 AttributeValue implementation for ObjectPtrContainer.
 
 ObjectVector Attribute
 AttributeValue implementation for ObjectVector.
 
 OrganizationIdentifier Attribute
 AttributeValue implementation for OrganizationIdentifier.
 
 Pair Attribute
 AttributeValue implementation for Pair.
 
 Pointer Attribute
 AttributeValue implementation for Pointer.
 
 Priomap Attribute
 AttributeValue implementation for Priomap.
 
 QueueSize Attribute
 AttributeValue implementation for QueueSize.
 
 Rectangle Attribute
 AttributeValue implementation for Rectangle.
 
 Ssid Attribute
 AttributeValue implementation for Ssid.
 
 String Attribute
 AttributeValue implementation for String.
 
 Time Attribute
 AttributeValue implementation for Time.
 
 Tuple Attribute
 AttributeValue implementation for Tuple.
 
 TypeId Attribute
 AttributeValue implementation for TypeId.
 
 UanModesList Attribute
 AttributeValue implementation for UanModesList.
 
 Uinteger Attribute
 AttributeValue implementation for Uinteger.
 
 ValueClassTest Attribute
 AttributeValue implementation for ValueClassTest.
 
 Vector Attribute
 AttributeValue implementation for Vector.
 
 Vector2D Attribute
 AttributeValue implementation for Vector2D.
 
 Vector3D Attribute
 AttributeValue implementation for Vector3D.
 
 Waypoint Attribute
 AttributeValue implementation for Waypoint.
 
 WifiMode Attribute
 AttributeValue 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 285 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 317 of file attribute.h.

Referenced by DeprecatedAttribute::GetTypeId().

+ Here is the caller graph for this function: