A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::CommandLine::Item Class Referenceabstract

The argument abstract base class. More...

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

Public Member Functions

virtual ~Item ()
 Destructor.
 
virtual std::string GetDefault () const =0
 
virtual bool HasDefault () const
 
virtual bool Parse (const std::string &value) const =0
 Parse from a string.
 

Public Attributes

std::string m_help
 Argument help string.
 
std::string m_name
 Argument label: --m_name=...
 

Detailed Description

The argument abstract base class.

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

Constructor & Destructor Documentation

◆ ~Item()

ns3::CommandLine::Item::~Item ( )
virtual

Destructor.

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetDefault()

virtual std::string ns3::CommandLine::Item::GetDefault ( ) const
pure virtual

◆ HasDefault()

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

Reimplemented in ns3::CommandLine::UserItem< T >, ns3::CommandLine::StringItem, ns3::CommandLine::CharStarItem, and ns3::CommandLine::CallbackItem.

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

◆ Parse()

virtual bool ns3::CommandLine::Item::Parse ( const std::string &  value) const
pure virtual

Parse from a string.

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

Implemented in ns3::CommandLine::UserItem< T >, ns3::CommandLine::StringItem, ns3::CommandLine::CharStarItem, and ns3::CommandLine::CallbackItem.

Member Data Documentation

◆ m_help

std::string ns3::CommandLine::Item::m_help

Argument help string.

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

◆ m_name

std::string ns3::CommandLine::Item::m_name

Argument label: --m_name=...

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


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