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)
	Constructor.
Ptr< AttributeValue >	Copy () const override
bool	DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker) override
std::string	Get () const
template<typename T >
bool	GetAccessor (T &value) const
	Access the String value as type T.
std::string	SerializeToString (Ptr< const AttributeChecker > checker) const override
void	Set (const std::string &value)
	Set the value.
Public Member Functions inherited from ns3::AttributeValue
	AttributeValue ()
virtual	~AttributeValue ()
virtual Ptr< AttributeValue >	Copy () const =0
virtual bool	DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)=0
virtual std::string	SerializeToString (Ptr< const AttributeChecker > checker) const =0
Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
	SimpleRefCount ()
	Default constructor.
	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.
uint32_t	GetReferenceCount () const
	Get the reference count of the object.
SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.
void	Ref () const
	Increment the reference count.
void	Unref () const
	Decrement the reference count.

Private Attributes
std::string	m_value
	The stored String instance.

Detailed Description

Hold variables of type string.

AttributeValue implementation for String.

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

See also

AttributeValue

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

)

Constructor.

Parameters

[in]

value

The String value to use.

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]	value	A string representation of the value
[in]	checker	A 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()

std::string ns3::StringValue::Get

(

)

const

Returns

The String value.

Definition at line 31 of file string.cc.

Referenced by ns3::RawTextConfigSave::Attributes(), ns3::XmlConfigSave::Attributes(), ns3::cell_data_function_col_1(), AttributeTestCase< T >::CheckGetCodePaths(), PrioQueueDiscTestCase::DoRun(), ns3::GetImpl(), PrintAllGlobals(), ns3::CommandLine::PrintGlobals(), ns3::Simulator::SetImplementation(), and ns3::MpiInterface::SetParallelSimulatorImpl().

Here is the caller graph for this function:

GetAccessor()

template<typename T >

bool ns3::StringValue::GetAccessor ( T &  value ) const

inline

Access the String value as type T.

Template Parameters

T	[explicit] The type to cast to.

Parameters

[out]

value

The String value, as type T.

Returns

true.

Definition at line 56 of file string.h.

SerializeToString()

std::string ns3::StringValue::SerializeToString ( Ptr< const AttributeChecker >  checker ) const

overridevirtual

Parameters

[in]

checker

The 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

)

Set the value.

Parameters

[in]

value

The value to adopt.

Definition at line 31 of file string.cc.

Member Data Documentation

m_value

std::string ns3::StringValue::m_value

private

The stored String instance.

Definition at line 56 of file string.h.

---

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

• src/core/model/string.h
• src/core/model/string.cc
• doc/introspected-doxygen.h