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

Hold variables of type string. More...

#include "string.h"

+ Inheritance diagram for ns3::StringValue:
+ Collaboration diagram for ns3::StringValue:

Public Member Functions

 StringValue ()
 
 StringValue (const std::string &value)
 
Ptr< AttributeValueCopy () const override
 
bool DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker) override
 
std::string Get () const
 
template<typename T >
bool GetAccessor (T &value) const
 
std::string SerializeToString (Ptr< const AttributeChecker > checker) const override
 
void Set (const std::string &value)
 
- Public Member Functions inherited from ns3::AttributeValue
 AttributeValue ()
 
virtual ~AttributeValue ()
 
- Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () const
 Decrement the reference count. More...
 

Private Attributes

std::string m_value
 

Detailed Description

Hold variables of type string.

This class can be used to hold variables of type string, that is, either char * or std::string.

Definition at line 56 of file string.h.

Constructor & Destructor Documentation

◆ StringValue() [1/2]

ns3::StringValue::StringValue ( )

Definition at line 31 of file string.cc.

◆ StringValue() [2/2]

ns3::StringValue::StringValue ( const std::string &  value)

Definition at line 31 of file string.cc.

Member Function Documentation

◆ Copy()

Ptr< AttributeValue > ns3::StringValue::Copy ( ) const
overridevirtual
Returns
a deep copy of this class, wrapped into an Attribute object.

Implements ns3::AttributeValue.

Definition at line 31 of file string.cc.

◆ DeserializeFromString()

bool ns3::StringValue::DeserializeFromString ( std::string  value,
Ptr< const AttributeChecker checker 
)
overridevirtual
Parameters
[in]valueA string representation of the value
[in]checkerA 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 31 of file string.cc.

◆ Get()

◆ GetAccessor()

template<typename T >
bool ns3::StringValue::GetAccessor ( T &  value) const
inline

Definition at line 56 of file string.h.

◆ SerializeToString()

std::string ns3::StringValue::SerializeToString ( Ptr< const AttributeChecker checker) const
overridevirtual
Parameters
[in]checkerThe 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 31 of file string.cc.

◆ Set()

void ns3::StringValue::Set ( const std::string &  value)

Definition at line 31 of file string.cc.

Member Data Documentation

◆ m_value

std::string ns3::StringValue::m_value
private

Definition at line 56 of file string.h.


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