Public Member Functions | List of all members
openfluid::utils::CommandLineOption Class Reference

#include <utils/CommandLineParser.hpp>

Public Member Functions

 CommandLineOption ()
 
 CommandLineOption (const std::string &LongName, const std::string &ShortName, const std::string &HelpText, bool ValueRequired=false)
 
std::string getHelpText () const
 
std::string getLongName () const
 
std::string getShortName () const
 
std::string getValue () const
 
bool isActive () const
 
bool isValueRequired () const
 
void activate (const std::string &Value="")
 
void reset ()
 

Constructor & Destructor Documentation

◆ CommandLineOption() [1/2]

openfluid::utils::CommandLineOption::CommandLineOption ( )
inline

◆ CommandLineOption() [2/2]

openfluid::utils::CommandLineOption::CommandLineOption ( const std::string &  LongName,
const std::string &  ShortName,
const std::string &  HelpText,
bool  ValueRequired = false 
)
inline

Member Function Documentation

◆ activate()

void openfluid::utils::CommandLineOption::activate ( const std::string &  Value = "")
inline

◆ getHelpText()

std::string openfluid::utils::CommandLineOption::getHelpText ( ) const
inline

◆ getLongName()

std::string openfluid::utils::CommandLineOption::getLongName ( ) const
inline

◆ getShortName()

std::string openfluid::utils::CommandLineOption::getShortName ( ) const
inline

◆ getValue()

std::string openfluid::utils::CommandLineOption::getValue ( ) const
inline

◆ isActive()

bool openfluid::utils::CommandLineOption::isActive ( ) const
inline

◆ isValueRequired()

bool openfluid::utils::CommandLineOption::isValueRequired ( ) const
inline

◆ reset()

void openfluid::utils::CommandLineOption::reset ( )
inline

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