ldas-tools-al 2.6.7
Loading...
Searching...
No Matches
LDASTools::AL::CommandLineOptions Class Reference

Maintains an ordered container of unparsed command line options. More...

#include <CommandLineOptions.hh>

Inheritance diagram for LDASTools::AL::CommandLineOptions:
Inheritance graph
[legend]
Collaboration diagram for LDASTools::AL::CommandLineOptions:
Collaboration graph
[legend]

Classes

class  Option
class  OptionSet
struct  ValidateBool
struct  Validator

Public Types

enum  { OPT_END_OF_OPTIONS = -1 }
enum  { OPT_END_OF_OPTIONS = -1 }
typedef std::string option_type
typedef std::ostream ostream
typedef int argc_type
typedef const char ** argv_type
typedef std::string option_type
typedef std::ostream ostream
typedef int argc_type
typedef const char ** argv_type

Public Member Functions

 CommandLineOptions (argc_type ArgC, argv_type ArgV)
 Constructor.
 CommandLineOptions (argc_type ArgC, char **ArgV)
 Constructor.
template<typename ARGS>
 CommandLineOptions (const ARGS &Args)
 Constructor.
int Parse (const OptionSet &Options, std::string &ArgumentName, std::string &ArgumentValue)
const option_type Pop ()
 Obtain the next option from the container.
const option_type ProgramName () const
 Return the program name associated with this application.
 CommandLineOptions (argc_type ArgC, argv_type ArgV)
 Constructor.
 CommandLineOptions (argc_type ArgC, char **ArgV)
 Constructor.
template<typename ARGS>
 CommandLineOptions (const ARGS &Args)
 Constructor.
int Parse (const OptionSet &Options, std::string &ArgumentName, std::string &ArgumentValue)
const option_type Pop ()
 Obtain the next option from the container.
const option_type ProgramName () const
 Return the program name associated with this application.

Static Public Member Functions

static bool InterpretBoolean (const std::string &Value)
static bool InterpretBoolean (const std::string &Value)

Private Types

typedef std::list< option_type > option_container_type
typedef std::list< option_type > option_container_type

Private Attributes

const option_type m_program_name
 The program name associated with this application.

Detailed Description

Maintains an ordered container of unparsed command line options.

Member Typedef Documentation

◆ argc_type [1/2]

typedef int LDASTools::AL::CommandLineOptions::argc_type

◆ argc_type [2/2]

typedef int LDASTools::AL::CommandLineOptions::argc_type

◆ argv_type [1/2]

typedef const char** LDASTools::AL::CommandLineOptions::argv_type

◆ argv_type [2/2]

typedef const char** LDASTools::AL::CommandLineOptions::argv_type

◆ option_container_type [1/2]

typedef std::list< option_type > LDASTools::AL::CommandLineOptions::option_container_type
private

◆ option_container_type [2/2]

typedef std::list< option_type > LDASTools::AL::CommandLineOptions::option_container_type
private

◆ option_type [1/2]

typedef std::string LDASTools::AL::CommandLineOptions::option_type

◆ option_type [2/2]

typedef std::string LDASTools::AL::CommandLineOptions::option_type

◆ ostream [1/2]

typedef std::ostream LDASTools::AL::CommandLineOptions::ostream

◆ ostream [2/2]

typedef std::ostream LDASTools::AL::CommandLineOptions::ostream

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
OPT_END_OF_OPTIONS 

◆ anonymous enum

anonymous enum
Enumerator
OPT_END_OF_OPTIONS 

Constructor & Destructor Documentation

◆ CommandLineOptions() [1/6]

LDASTools::AL::CommandLineOptions::CommandLineOptions ( argc_type ArgC,
argv_type ArgV )

Constructor.

Parameters
[in]ArgCNumber of arguments being passed.
[in]ArgVArray of parameters
Returns
New instance of this object.

◆ CommandLineOptions() [2/6]

LDASTools::AL::CommandLineOptions::CommandLineOptions ( argc_type ArgC,
char ** ArgV )

Constructor.

Parameters
[in]ArgCNumber of arguments being passed.
[in]ArgVArray of parameters
Returns
New instance of this object.

◆ CommandLineOptions() [3/6]

template<typename ARGS>
LDASTools::AL::CommandLineOptions::CommandLineOptions ( const ARGS & Args)
inline

Constructor.

Parameters
[in]ArgsContainer of arguments
Returns
New instance of this object.

◆ CommandLineOptions() [4/6]

LDASTools::AL::CommandLineOptions::CommandLineOptions ( argc_type ArgC,
argv_type ArgV )

Constructor.

Parameters
[in]ArgCNumber of arguments being passed.
[in]ArgVArray of parameters
Returns
New instance of this object.

◆ CommandLineOptions() [5/6]

LDASTools::AL::CommandLineOptions::CommandLineOptions ( argc_type ArgC,
char ** ArgV )

Constructor.

Parameters
[in]ArgCNumber of arguments being passed.
[in]ArgVArray of parameters
Returns
New instance of this object.

◆ CommandLineOptions() [6/6]

template<typename ARGS>
LDASTools::AL::CommandLineOptions::CommandLineOptions ( const ARGS & Args)
inline

Constructor.

Parameters
[in]ArgsContainer of arguments
Returns
New instance of this object.

Member Function Documentation

◆ InterpretBoolean() [1/2]

bool LDASTools::AL::CommandLineOptions::InterpretBoolean ( const std::string & Value)
static

◆ InterpretBoolean() [2/2]

bool LDASTools::AL::CommandLineOptions::InterpretBoolean ( const std::string & Value)
static

◆ Parse() [1/2]

int LDASTools::AL::CommandLineOptions::Parse ( const OptionSet & Options,
std::string & ArgumentName,
std::string & ArgumentValue )

◆ Parse() [2/2]

int LDASTools::AL::CommandLineOptions::Parse ( const OptionSet & Options,
std::string & ArgumentName,
std::string & ArgumentValue )

◆ Pop() [1/2]

const CommandLineOptions::option_type LDASTools::AL::CommandLineOptions::Pop ( )
inline

Obtain the next option from the container.

This does reduce the size by one.

◆ Pop() [2/2]

const option_type LDASTools::AL::CommandLineOptions::Pop ( )

Obtain the next option from the container.

This does reduce the size by one.

◆ ProgramName() [1/2]

const CommandLineOptions::option_type LDASTools::AL::CommandLineOptions::ProgramName ( ) const
inline

Return the program name associated with this application.

◆ ProgramName() [2/2]

const option_type LDASTools::AL::CommandLineOptions::ProgramName ( ) const

Return the program name associated with this application.

Member Data Documentation

◆ m_program_name

const option_type LDASTools::AL::CommandLineOptions::m_program_name
private

The program name associated with this application.

The documentation for this class was generated from the following files:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-al-2.6.7-build/ldas-tools-al-2.6.7/build/include/ldastoolsal/CommandLineOptions.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-al-2.6.7-build/ldas-tools-al-2.6.7/src/CommandLineOptions.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-al-2.6.7-build/ldas-tools-al-2.6.7/src/CommandLineOptions.cc