A Discrete-Event Network Simulator
API
Public Member Functions | Public Attributes | List of all members
ns3::CommandLine::StringItem Class Reference
Core » Command Line Parsing

Extension of Item for extra non-options, stored as strings. More...

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

Public Member Functions

std::string GetDefault () const override
 
bool HasDefault () const override
 
bool Parse (const std::string &value) const override
 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 extra non-options, stored as strings.

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

Member Function Documentation

◆ GetDefault()

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

Implements ns3::CommandLine::Item.

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

◆ HasDefault()

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

Reimplemented from ns3::CommandLine::Item.

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

◆ Parse()

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

Parse from a string.

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

Implements ns3::CommandLine::Item.

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

Member Data Documentation

◆ m_value

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

The argument value.

Internal: This has to be mutable because the Parse()
function is const in the base class Item.

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

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