A Discrete-Event Network Simulator
API
ns3::CommandLine::StringItem Class Reference

Extension of Item for strings. More...

+ Inheritance diagram for ns3::CommandLine::StringItem:
+ Collaboration diagram for ns3::CommandLine::StringItem:

Public Member Functions

std::string GetDefault (void) const
 
bool HasDefault (void) const
 
bool Parse (const std::string value)
 Parse from a string. More...
 
- Public Member Functions inherited from ns3::CommandLine::Item
virtual ~Item ()
 Destructor. More...
 

Public Attributes

std::string m_value
 The argument value. More...
 
- Public Attributes inherited from ns3::CommandLine::Item
std::string m_help
 Argument help string. More...
 
std::string m_name
 Argument label: --m_name=... More...
 

Detailed Description

Extension of Item for strings.

Definition at line 467 of file command-line.h.

Member Function Documentation

◆ GetDefault()

std::string ns3::CommandLine::StringItem::GetDefault ( void  ) const
virtual
Returns
The default value

Reimplemented from ns3::CommandLine::Item.

Definition at line 799 of file command-line.cc.

◆ HasDefault()

bool ns3::CommandLine::StringItem::HasDefault ( void  ) const
virtual
Returns
true if this item has a default value.

Reimplemented from ns3::CommandLine::Item.

Definition at line 793 of file command-line.cc.

◆ Parse()

bool ns3::CommandLine::StringItem::Parse ( const std::string  value)
virtual

Parse from a string.

Parameters
[in]valueThe string representation
Returns
true if parsing the value succeeded

Implements ns3::CommandLine::Item.

Definition at line 786 of file command-line.cc.

Member Data Documentation

◆ m_value

std::string ns3::CommandLine::StringItem::m_value

The argument value.

Definition at line 475 of file command-line.h.

Referenced by ns3::CommandLine::GetExtraNonOption().


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