A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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)
 
virtual Ptr< AttributeValueCopy (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
 
virtual std::string SerializeToString (Ptr< const AttributeChecker > checker) const
 
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 ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (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
 

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

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

Definition at line 19 of file string.h.

Constructor & Destructor Documentation

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

Member Function Documentation

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

Implements ns3::AttributeValue.

virtual bool ns3::StringValue::DeserializeFromString ( std::string  value,
Ptr< const AttributeChecker checker 
)
virtual
Parameters
valuea string representation of the value
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.

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

Definition at line 19 of file string.h.

virtual std::string ns3::StringValue::SerializeToString ( Ptr< const AttributeChecker checker) const
virtual
Parameters
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.

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

Member Data Documentation

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

Definition at line 19 of file string.h.


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