A Discrete-Event Network Simulator
API
ns3::internal::ObjectPtrContainerChecker< T > Class Template Reference

ObjectPtrContainerChecker implementation class. More...

#include "object-ptr-container.h"

+ Inheritance diagram for ns3::internal::ObjectPtrContainerChecker< T >:
+ Collaboration diagram for ns3::internal::ObjectPtrContainerChecker< T >:

Public Member Functions

virtual bool Check (const AttributeValue &value) const
 
virtual bool Copy (const AttributeValue &source, AttributeValue &destination) const
 Copy the source to the destination. More...
 
virtual Ptr< AttributeValueCreate (void) const
 
virtual TypeId GetItemTypeId (void) const
 Get the TypeId of the container class type. More...
 
virtual std::string GetUnderlyingTypeInformation (void) const
 
virtual std::string GetValueTypeName (void) const
 
virtual bool HasUnderlyingTypeInformation (void) const
 
- Public Member Functions inherited from ns3::AttributeChecker
 AttributeChecker ()
 
virtual ~AttributeChecker ()
 
Ptr< AttributeValueCreateValidValue (const AttributeValue &value) const
 Create a valid value from the argument value, or reinterpret the argument as a string. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< AttributeChecker >
 SimpleRefCount ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::SimpleRefCount< AttributeChecker >
static void Cleanup (void)
 Noop. More...
 

Detailed Description

template<typename T>
class ns3::internal::ObjectPtrContainerChecker< T >

ObjectPtrContainerChecker implementation class.

Definition at line 176 of file object-ptr-container.h.

Member Function Documentation

template<typename T >
virtual bool ns3::internal::ObjectPtrContainerChecker< T >::Check ( const AttributeValue value) const
inlinevirtual
Parameters
[in]valueA pointer to the value to check
Returns
true if the input value is both of the right type and if its value is within the requested range. Returns false otherwise.

Implements ns3::AttributeChecker.

Definition at line 182 of file object-ptr-container.h.

template<typename T >
virtual bool ns3::internal::ObjectPtrContainerChecker< T >::Copy ( const AttributeValue source,
AttributeValue destination 
) const
inlinevirtual

Copy the source to the destination.

Parameters
[in]sourceSource AttributeValue
[out]destinationDestination AttributeValue
Returns
true if copy was successful

Implements ns3::AttributeChecker.

Definition at line 197 of file object-ptr-container.h.

template<typename T >
virtual Ptr<AttributeValue> ns3::internal::ObjectPtrContainerChecker< T >::Create ( void  ) const
inlinevirtual
Returns
a new instance of an AttributeValue (wrapper in an Attribute instance) which matches the type of the underlying attribute.

This method is typically used to create a temporary variable prior to calling Attribute::DeserializeFromString.

Implements ns3::AttributeChecker.

Definition at line 194 of file object-ptr-container.h.

template<typename T >
virtual TypeId ns3::internal::ObjectPtrContainerChecker< T >::GetItemTypeId ( void  ) const
inlinevirtual

Get the TypeId of the container class type.

Returns
The class TypeId.

Implements ns3::ObjectPtrContainerChecker.

Definition at line 179 of file object-ptr-container.h.

template<typename T >
virtual std::string ns3::internal::ObjectPtrContainerChecker< T >::GetUnderlyingTypeInformation ( void  ) const
inlinevirtual
Returns
a human-readable representation of information about the underlying C++ type.

Implements ns3::AttributeChecker.

Definition at line 191 of file object-ptr-container.h.

template<typename T >
virtual std::string ns3::internal::ObjectPtrContainerChecker< T >::GetValueTypeName ( void  ) const
inlinevirtual
Returns
the c++ fully-qualified typename of the subclass of the ns3::AttributeValue base class which is associated to this checker.

A typical return value here is FooValue where Foo is the name of the type being wrapped.

Implements ns3::AttributeChecker.

Definition at line 185 of file object-ptr-container.h.

template<typename T >
virtual bool ns3::internal::ObjectPtrContainerChecker< T >::HasUnderlyingTypeInformation ( void  ) const
inlinevirtual
Returns
true if this checker has information about the underlying C++ type, false otherwise.

If this method returns false, the return value of the GetUnderlyingTypeInformation method cannot be relied upon.

Implements ns3::AttributeChecker.

Definition at line 188 of file object-ptr-container.h.


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