GRSISort
Created by P.C. Bender
Developement Team: P.C. Bender, R. Dunlop, V. Bildstein
An extension of the ROOT analysis Framework
ArgParseConfigT< bool > Class Template Reference

template<>
class ArgParseConfigT< bool >

Definition at line 227 of file ArgParser.h.

Public Member Functions

 ArgParseConfigT (std::string flag, bool *output_location, bool firstPass)
 
virtual ArgParseConfigcolour (const std::string &c)
 
ArgParseConfig< bool > & default_value (bool value) override
 
virtual ArgParseConfigdescription (const std::string &d)
 
std::string flag_name () const override
 
bool is_present () const
 
bool is_required () const override
 
bool matches (const std::string &flag) const override
 
int num_arguments () const override
 
void parse (const std::string &name, const std::vector< std::string > &arguments, bool firstPass, bool ignore_num_arguments=false)
 
void parse_item (const std::vector< std::string > &arguments) override
 
std::string printable (int description_column=-1, int *chars_before_desc=nullptr) const override
 
virtual ArgParseConfigrequired ()
 
ArgParseConfig< bool > & takes_argument ()
 

Protected Attributes

std::string fColour
 
std::string fDescription
 
std::vector< std::string > fFlags
 
std::vector< std::string > fRawFlags
 
bool fRequired
 

Private Attributes

int fNum_arguments_expected
 
bool * fOutput_location
 
bool fStored_default_value
 

#include <ArgParser.h>

+ Inheritance diagram for ArgParseConfigT< bool >:
+ Collaboration diagram for ArgParseConfigT< bool >:

Constructor & Destructor Documentation

◆ ArgParseConfigT()

ArgParseConfigT< bool >::ArgParseConfigT ( std::string  flag,
bool *  output_location,
bool  firstPass 
)
inline

Definition at line 229 of file ArgParser.h.

References ArgParseConfigT< T >::fOutput_location.

Member Function Documentation

◆ colour()

virtual ArgParseConfig& ArgParseConfig< bool >::colour ( const std::string &  c)
inlinevirtualinherited

Definition at line 121 of file ArgParser.h.

References ArgParseConfig< T >::fColour.

◆ default_value()

ArgParseConfig<bool>& ArgParseConfigT< bool >::default_value ( bool  value)
inlineoverridevirtual

Implements ArgParseConfig< bool >.

Definition at line 235 of file ArgParser.h.

References ArgParseConfigT< T >::fOutput_location.

◆ description()

virtual ArgParseConfig& ArgParseConfig< bool >::description ( const std::string &  d)
inlinevirtualinherited

Definition at line 115 of file ArgParser.h.

References ArgParseConfig< T >::fDescription.

◆ flag_name()

std::string ArgParseConfig< bool >::flag_name ( ) const
inlineoverridevirtualinherited

Implements ArgParseItem.

Definition at line 89 of file ArgParser.h.

References ArgParseConfig< T >::fFlags.

◆ is_present()

bool ArgParseItem::is_present ( ) const
inlineinherited

Definition at line 35 of file ArgParser.h.

References ArgParseItem::present_.

◆ is_required()

bool ArgParseConfig< bool >::is_required ( ) const
inlineoverridevirtualinherited

Implements ArgParseItem.

Definition at line 133 of file ArgParser.h.

References ArgParseConfig< T >::fRequired.

◆ matches()

bool ArgParseConfig< bool >::matches ( const std::string &  flag) const
inlineoverridevirtualinherited

Implements ArgParseItem.

Definition at line 100 of file ArgParser.h.

References ArgParseConfig< T >::fFlags.

◆ num_arguments()

int ArgParseConfigT< bool >::num_arguments ( ) const
inlineoverridevirtual

Implements ArgParseItem.

Definition at line 258 of file ArgParser.h.

◆ parse()

void ArgParseItem::parse ( const std::string &  name,
const std::vector< std::string > &  arguments,
bool  firstPass,
bool  ignore_num_arguments = false 
)
inlineinherited

◆ parse_item()

void ArgParseConfigT< bool >::parse_item ( const std::vector< std::string > &  arguments)
inlineoverridevirtual

Implements ArgParseItem.

Definition at line 248 of file ArgParser.h.

References ArgParseConfigT< T >::fOutput_location.

◆ printable()

std::string ArgParseConfig< bool >::printable ( int  description_column = -1,
int *  chars_before_desc = nullptr 
) const
inlineoverridevirtualinherited

◆ required()

virtual ArgParseConfig& ArgParseConfig< bool >::required ( )
inlinevirtualinherited

Definition at line 127 of file ArgParser.h.

References ArgParseConfig< T >::fRequired.

◆ takes_argument()

ArgParseConfig<bool>& ArgParseConfigT< bool >::takes_argument ( )
inline

Definition at line 242 of file ArgParser.h.

Member Data Documentation

◆ fColour

std::string ArgParseConfig< bool >::fColour
protectedinherited

Colour string to be use for display.

Definition at line 188 of file ArgParser.h.

◆ fDescription

std::string ArgParseConfig< bool >::fDescription
protectedinherited

A description for display on the terminal.

Definition at line 185 of file ArgParser.h.

◆ fFlags

std::vector<std::string> ArgParseConfig< bool >::fFlags
protectedinherited

The literal flag that is searched for, including leading dashes.

Definition at line 191 of file ArgParser.h.

◆ fNum_arguments_expected

int ArgParseConfigT< bool >::fNum_arguments_expected
private

Definition at line 263 of file ArgParser.h.

◆ fOutput_location

bool* ArgParseConfigT< bool >::fOutput_location
private

Definition at line 261 of file ArgParser.h.

◆ fRawFlags

std::vector<std::string> ArgParseConfig< bool >::fRawFlags
protectedinherited

The flags without the leading dashes.

Definition at line 194 of file ArgParser.h.

◆ fRequired

bool ArgParseConfig< bool >::fRequired
protectedinherited

Whether the flag must be supplied.

Definition at line 197 of file ArgParser.h.

◆ fStored_default_value

bool ArgParseConfigT< bool >::fStored_default_value
private

Definition at line 262 of file ArgParser.h.