ns-3
ns3::ObjectPtrContainerValue Class Reference

contain a set of ns3::Object pointers. More...

#include <object-ptr-container.h>

Inheritance diagram for ns3::ObjectPtrContainerValue:
Collaboration diagram for ns3::ObjectPtrContainerValue:

List of all members.

Public Types

typedef std::map< uint32_t,
Ptr< Object >
>::const_iterator 
Iterator

Public Member Functions

Iterator Begin (void) const
Iterator End (void) const
uint32_t GetN (void) const
Ptr< ObjectGet (uint32_t i) const
virtual Ptr< AttributeValueCopy (void) const
virtual std::string SerializeToString (Ptr< const AttributeChecker > checker) const
virtual bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)

Friends

class ObjectPtrContainerAccessor

Detailed Description

contain a set of ns3::Object pointers.

This class it used to get attribute access to an array of ns3::Object pointers.


Member Function Documentation

ObjectPtrContainerValue::Iterator ns3::ObjectPtrContainerValue::Begin ( void  ) const
Returns:
an iterator to the first object contained in this set

Referenced by SerializeToString().

Ptr< AttributeValue > ns3::ObjectPtrContainerValue::Copy ( void  ) const
virtual
Returns:
a deep copy of this class, wrapped into an Attribute object.

Implements ns3::AttributeValue.

bool ns3::ObjectPtrContainerValue::DeserializeFromString ( std::string  value,
Ptr< const AttributeChecker checker 
)
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.

Implements ns3::AttributeValue.

References NS_FATAL_ERROR.

ObjectPtrContainerValue::Iterator ns3::ObjectPtrContainerValue::End ( void  ) const
Returns:
an iterator to the last object contained in this set

Referenced by SerializeToString().

Ptr< Object > ns3::ObjectPtrContainerValue::Get ( uint32_t  i) const
Parameters:
ithe index of the requested object.
Returns:
the requested object
uint32_t ns3::ObjectPtrContainerValue::GetN ( void  ) const
Returns:
the number of objects contained in this set.
std::string ns3::ObjectPtrContainerValue::SerializeToString ( Ptr< const AttributeChecker checker) const
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.

Implements ns3::AttributeValue.

References Begin(), and End().


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