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)
	Copy constructor. More...

virtual Ptr< AttributeValue >	Copy (void) const

virtual bool	DeserializeFromString (std::string value, Ptr< const AttributeChecker > checker)

std::string	Get (void) const

template<typename T >
bool	GetAccessor (T &value) const
	Access the String value as type `T`. More...

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

void	Set (const std::string &value)
	Set the value. More...

Public Member Functions inherited from ns3::AttributeValue
	AttributeValue ()

virtual	~AttributeValue ()

Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

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

Additional Inherited Members
Static Public Member Functions inherited from ns3::SimpleRefCount< AttributeValue >
static void	Cleanup (void)
	Noop. More...

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 41 of file string.h.

Constructor & Destructor Documentation

ns3::StringValue::StringValue ( )

Definition at line 31 of file string.cc.

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

Copy constructor.

Parameters

[in] value The String value to copy.

Definition at line 31 of file string.cc.

Member Function Documentation

Ptr< AttributeValue > ns3::StringValue::Copy ( void ) const

virtual

Returns: a deep copy of this class, wrapped into an Attribute object.

Implements ns3::AttributeValue.

Definition at line 31 of file string.cc.

bool ns3::StringValue::DeserializeFromString	(	std::string	value,
		Ptr< const AttributeChecker >	checker
	)

virtual

Parameters

value	a string representation of the value
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.

std::string ns3::StringValue::Get ( void ) 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(), ns3::AttributeChecker::CreateValidValue(), ns3::MpiInterface::Enable(), ns3::GetImpl(), ns3::RawTextConfigSave::Global(), ns3::XmlConfigSave::Global(), PrintAllGlobals(), ns3::CommandLine::PrintGlobals(), ns3::NscStackStringAccessor::Set(), VanetRoutingExperiment::SetConfigFromGlobals(), VanetRoutingExperiment::SetGlobalsFromConfig(), and ns3::Simulator::SetImplementation().

Here is the caller graph for this function:

template<typename T >

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

inline

Access the String value as type T.

Parameters

[out] value The String value, as type T.

Returns: true.

Definition at line 41 of file string.h.

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

virtual

Parameters

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.

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.

Referenced by ns3::NscStackStringAccessor::Get(), ns3::ObjectBase::GetAttribute(), ns3::ObjectBase::GetAttributeFailSafe(), and ns3::GlobalValue::GetValue().

Here is the caller graph for this function: