Documentation for OpenFLUID 2.2.0
openfluid::utils::CommandLineArg Class Reference

#include <utils/CommandLineParser.hpp>

Public Member Functions

 CommandLineArg (const std::string &Name, bool Required=true)
 
std::string getName () const
 
bool isRequired () const
 

Constructor & Destructor Documentation

◆ CommandLineArg()

openfluid::utils::CommandLineArg::CommandLineArg ( const std::string &  Name,
bool  Required = true 
)
inline

Instanciates an argument with the given parameters

Parameters
[in]NameThe long name of the option
[in]RequiredTrue if the argument is required (true is default)

Member Function Documentation

◆ getName()

std::string openfluid::utils::CommandLineArg::getName ( ) const
inline

Returns the name of the arg

Returns
The name

◆ isRequired()

bool openfluid::utils::CommandLineArg::isRequired ( ) const
inline

Returns if the arg is required

Returns
the required predicate

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