ns-3
ns3::AttributeValue Class Reference

Hold a value for an Attribute. More...

#include <attribute.h>

Inheritance diagram for ns3::AttributeValue:
Collaboration diagram for ns3::AttributeValue:

List of all members.

Public Member Functions

virtual Ptr< AttributeValueCopy (void) const =0
virtual std::string SerializeToString (Ptr< const AttributeChecker > checker) const =0
virtual bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)=0
- Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const

Additional Inherited Members

- Static Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
static void Cleanup (void)

Detailed Description

Hold a value for an Attribute.

Instances of this class should always be wrapped into an Attribute object. Most subclasses of this base class are implemented by the ATTRIBUTE_HELPER_* macros.


Member Function Documentation

virtual Ptr<AttributeValue> ns3::AttributeValue::Copy ( void  ) const
pure virtual
virtual bool ns3::AttributeValue::DeserializeFromString ( std::string  value,
Ptr< const AttributeChecker checker 
)
pure virtual
Parameters:
valuea string representation of the value
checkera pointer to the checker associated to the attribute.
Returns:
true if the input string was correctly-formatted and could be successfully deserialized, false otherwise.

Upon return of this function, this AttributeValue instance contains the deserialized value. In most cases, this method will not make any use of the checker argument. However, in a very limited set of cases, the checker argument is needed to perform proper serialization. A nice example of code which needs it is the EnumValue::SerializeToString code.

Implemented in ns3::CallbackValue, ns3::RandomVariableValue, ns3::TimeValue, ns3::ObjectPtrContainerValue, ns3::PointerValue, ns3::BooleanValue, ns3::EnumValue, ns3::UintegerValue, ns3::IntegerValue, ns3::DoubleValue, and ns3::StringValue.

virtual std::string ns3::AttributeValue::SerializeToString ( Ptr< const AttributeChecker checker) const
pure virtual
Parameters:
checkerthe checker associated to the attribute
Returns:
a string representation of this value.

In most cases, this method will not make any use of the checker argument. However, in a very limited set of cases, the checker argument is needed to perform proper serialization. A nice example of code which needs it is the EnumValue::SerializeToString code.

Implemented in ns3::CallbackValue, ns3::RandomVariableValue, ns3::TimeValue, ns3::ObjectPtrContainerValue, ns3::PointerValue, ns3::BooleanValue, ns3::EnumValue, ns3::UintegerValue, ns3::IntegerValue, ns3::DoubleValue, and ns3::StringValue.

Referenced by ns3::ObjectBase::GetAttribute(), ns3::ObjectBase::GetAttributeFailSafe(), ns3::GlobalValue::GetValue(), and ns3::AttributeDefaultIterator::Iterate().


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