ns3::ObjectVectorValue Class Reference
[Object]

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

#include <object-vector.h>

Inheritance diagram for ns3::ObjectVectorValue:
Inheritance graph
[legend]
Collaboration diagram for ns3::ObjectVectorValue:
Collaboration graph
[legend]

List of all members.

Public Types

typedef std::vector< Ptr
< Object > >::const_iterator 
Iterator

Public Member Functions

 ObjectVectorValue ()
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)

Private Attributes

std::vector< Ptr< Object > > m_objects

Friends

class ObjectVectorAccessor

Detailed Description

contain a vector of ns3::Object pointers.

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

Definition at line 19 of file object-vector.h.


Member Typedef Documentation

typedef std::vector<Ptr<Object> >::const_iterator ns3::ObjectVectorValue::Iterator

Definition at line 22 of file object-vector.h.


Constructor & Destructor Documentation

ns3::ObjectVectorValue::ObjectVectorValue (  ) 

Definition at line 5 of file object-vector.cc.


Member Function Documentation

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

Definition at line 9 of file object-vector.cc.

References m_objects.

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

Implements ns3::AttributeValue.

Definition at line 30 of file object-vector.cc.

bool ns3::ObjectVectorValue::DeserializeFromString ( std::string  value,
Ptr< const AttributeChecker checker 
) [virtual]
Parameters:
value a string representation of the value
checker a 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.

Definition at line 49 of file object-vector.cc.

References NS_FATAL_ERROR.

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

Definition at line 14 of file object-vector.cc.

References m_objects.

Ptr< Object > ns3::ObjectVectorValue::Get ( uint32_t  i  )  const
Parameters:
i the index of the requested object.
Returns:
the requested object

Definition at line 24 of file object-vector.cc.

References m_objects.

Referenced by ns3::Resolver::DoArrayResolve(), and ns3::AttributeTest::RunTests().

uint32_t ns3::ObjectVectorValue::GetN ( void   )  const
Returns:
the number of objects contained in this vector.

Definition at line 19 of file object-vector.cc.

References m_objects.

Referenced by ns3::Resolver::DoArrayResolve(), and ns3::AttributeTest::RunTests().

std::string ns3::ObjectVectorValue::SerializeToString ( Ptr< const AttributeChecker checker  )  const [virtual]
Parameters:
checker the 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.

Definition at line 35 of file object-vector.cc.

References m_objects.


Friends And Related Function Documentation

friend class ObjectVectorAccessor [friend]

Definition at line 49 of file object-vector.h.


Member Data Documentation

std::vector<Ptr<Object> > ns3::ObjectVectorValue::m_objects [private]

Definition at line 50 of file object-vector.h.

Referenced by Begin(), End(), ns3::ObjectVectorAccessor::Get(), Get(), GetN(), and SerializeToString().


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:10:22 2009 for NS-3 by  doxygen 1.6.3