A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
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 () override
 
bool Check (const AttributeValue &value) const override
 
bool Copy (const AttributeValue &source, AttributeValue &destination) const override
 Copy the source to the destination.
 
Ptr< AttributeValueCreate () const override
 
std::string GetUnderlyingTypeInformation () const override
 
std::string GetValueTypeName () const override
 
bool HasUnderlyingTypeInformation () const override
 
- Public Member Functions inherited from ns3::AttributeChecker
 AttributeChecker ()
 
virtual ~AttributeChecker ()
 
virtual bool Check (const AttributeValue &value) const =0
 
virtual bool Copy (const AttributeValue &source, AttributeValue &destination) const =0
 Copy the source to the destination.
 
virtual Ptr< AttributeValueCreate () const =0
 
Ptr< AttributeValueCreateValidValue (const AttributeValue &value) const
 Create a valid value from the argument value, or reinterpret the argument as a string.
 
virtual std::string GetUnderlyingTypeInformation () const =0
 
virtual std::string GetValueTypeName () const =0
 
virtual bool HasUnderlyingTypeInformation () const =0
 
- Public Member Functions inherited from ns3::SimpleRefCount< AttributeChecker >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 

Detailed Description

A checker for EmptyAttributeValue.

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

Definition at line 297 of file attribute.h.

Constructor & Destructor Documentation

◆ EmptyAttributeChecker()

ns3::EmptyAttributeChecker::EmptyAttributeChecker ( )

Definition at line 153 of file attribute.cc.

◆ ~EmptyAttributeChecker()

ns3::EmptyAttributeChecker::~EmptyAttributeChecker ( )
override

Definition at line 158 of file attribute.cc.

Member Function Documentation

◆ Check()

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

◆ Copy()

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

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

◆ Create()

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

◆ GetUnderlyingTypeInformation()

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

Implements ns3::AttributeChecker.

Definition at line 181 of file attribute.cc.

◆ GetValueTypeName()

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

◆ HasUnderlyingTypeInformation()

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


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