A Discrete-Event Network Simulator
API
Private Member Functions | List of all members
ns3::internal::PointerChecker< T > Class Template Reference

PointerChecker implementation. More...

#include "pointer.h"

+ Inheritance diagram for ns3::internal::PointerChecker< T >:

Private Member Functions

virtual bool Check (const AttributeValue &val) const
 
virtual bool Copy (const AttributeValue &source, AttributeValue &destination) const
 Copy the source to the destination. More...
 
virtual Ptr< AttributeValueCreate (void) const
 
virtual TypeId GetPointeeTypeId (void) const
 Get the TypeId of the base type. More...
 
virtual std::string GetUnderlyingTypeInformation (void) const
 
virtual std::string GetValueTypeName (void) const
 
virtual bool HasUnderlyingTypeInformation (void) const
 

Additional Inherited Members

- 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 ()
 Default 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 operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 

Detailed Description

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

PointerChecker implementation.

Definition at line 130 of file pointer.h.

Member Function Documentation

◆ Check()

template<typename T >
virtual bool ns3::internal::PointerChecker< T >::Check ( const AttributeValue value) const
inlineprivatevirtual
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 132 of file pointer.h.

References ns3::PointerValue::GetObject(), and ns3::PeekPointer().

◆ Copy()

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

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 162 of file pointer.h.

◆ Create()

template<typename T >
virtual Ptr<AttributeValue> ns3::internal::PointerChecker< T >::Create ( void  ) const
inlineprivatevirtual
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 159 of file pointer.h.

◆ GetPointeeTypeId()

template<typename T >
virtual TypeId ns3::internal::PointerChecker< T >::GetPointeeTypeId ( void  ) const
inlineprivatevirtual

Get the TypeId of the base type.

Returns
The base TypeId.

Implements ns3::PointerChecker.

Definition at line 172 of file pointer.h.

◆ GetUnderlyingTypeInformation()

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

Implements ns3::AttributeChecker.

Definition at line 155 of file pointer.h.

References ns3::TypeId::GetName().

◆ GetValueTypeName()

template<typename T >
virtual std::string ns3::internal::PointerChecker< T >::GetValueTypeName ( void  ) const
inlineprivatevirtual
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 149 of file pointer.h.

◆ HasUnderlyingTypeInformation()

template<typename T >
virtual bool ns3::internal::PointerChecker< T >::HasUnderlyingTypeInformation ( void  ) const
inlineprivatevirtual
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 152 of file pointer.h.


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