A Discrete-Event Network Simulator
API
ns3::EmptyAttributeChecker Class Reference

A checker for EmptyAttributeValue. More...

#include "attribute.h"

+ Inheritance diagram for ns3::EmptyAttributeChecker:
+ Collaboration diagram for ns3::EmptyAttributeChecker:

Public Member Functions

 EmptyAttributeChecker ()
 
 ~EmptyAttributeChecker ()
 
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 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 ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] 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

A checker for EmptyAttributeValue.

Does nothing, since every EmptyAttributeValue does not contain anything and is, of course, valid.

Definition at line 296 of file attribute.h.

Constructor & Destructor Documentation

◆ EmptyAttributeChecker()

ns3::EmptyAttributeChecker::EmptyAttributeChecker ( )

Definition at line 139 of file attribute.cc.

◆ ~EmptyAttributeChecker()

ns3::EmptyAttributeChecker::~EmptyAttributeChecker ( )

Definition at line 142 of file attribute.cc.

Member Function Documentation

◆ Check()

bool ns3::EmptyAttributeChecker::Check ( const AttributeValue value) const
virtual
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 146 of file attribute.cc.

◆ Copy()

bool ns3::EmptyAttributeChecker::Copy ( const AttributeValue source,
AttributeValue destination 
) const
virtual

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 178 of file attribute.cc.

◆ Create()

Ptr< AttributeValue > ns3::EmptyAttributeChecker::Create ( void  ) const
virtual
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 171 of file attribute.cc.

◆ GetUnderlyingTypeInformation()

std::string ns3::EmptyAttributeChecker::GetUnderlyingTypeInformation ( void  ) const
virtual
Returns
a human-readable representation of information about the underlying C++ type.

Implements ns3::AttributeChecker.

Definition at line 165 of file attribute.cc.

◆ GetValueTypeName()

std::string ns3::EmptyAttributeChecker::GetValueTypeName ( void  ) const
virtual
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 153 of file attribute.cc.

◆ HasUnderlyingTypeInformation()

bool ns3::EmptyAttributeChecker::HasUnderlyingTypeInformation ( void  ) const
virtual
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 159 of file attribute.cc.


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