ldas-tools-al  2.6.4
Public Types | Public Member Functions | Protected Types | Static Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
anonymous_namespace{CommandLineOptions.cc}::doxygen_option_set Class Reference
Inheritance diagram for anonymous_namespace{CommandLineOptions.cc}::doxygen_option_set:
Inheritance graph
[legend]
Collaboration diagram for anonymous_namespace{CommandLineOptions.cc}::doxygen_option_set:
Collaboration graph
[legend]

Public Types

typedef Option element_type
 
typedef Option element_type
 

Public Member Functions

 doxygen_option_set (const std::string &ProgramName, const OptionSet &Options)
 
std::ostream & Arguments (std::ostream &Stream)
 
std::ostream & Header (std::ostream &Stream)
 
std::ostream & Footer (std::ostream &Stream)
 
std::ostream & Usage (std::ostream &Stream)
 
void Write (std::ostream &Stream)
 
void Add (const Option &Opt)
 
void Add (const OptionSet &Opts)
 
void Add (const Option &Opt)
 
void Add (const OptionSet &Opts)
 
void Description (const std::string &Text)
 
void Description (const std::string &Text)
 
void Summary (const std::string &Text)
 
void Summary (const std::string &Text)
 
bool SummaryOnly () const
 
bool SummaryOnly () const
 
void Synopsis (const std::string &Text)
 
void Synopsis (const std::string &Text)
 
ostream & Write (ostream &Stream, int Indent=0) const
 
const Optionoperator[] (const std::string &Name) const
 
const Optionoperator[] (int) const
 
const Optionoperator[] (const std::string &Name) const
 
const Optionoperator[] (int) const
 

Protected Types

typedef std::list< Optionoption_container_type
 
typedef std::list< Optionoption_container_type
 
typedef LDASTools::AL::unordered_map< int, option_container_type::const_iterator > key_container_type
 
typedef LDASTools::AL::unordered_map< int, option_container_type::const_iterator > key_container_type
 
typedef LDASTools::AL::unordered_map< std::string, option_container_type::const_iterator > name_container_type
 
typedef LDASTools::AL::unordered_map< std::string, option_container_type::const_iterator > name_container_type
 
typedef std::list< const OptionSet *> subcommand_container_type
 
typedef std::list< const OptionSet *> subcommand_container_type
 

Static Protected Member Functions

static void hanging_par (ostream &Stream, size_t Indent, const std::string &Paragraph)
 Format a paragraph of data. More...
 
static void hanging_par (ostream &Stream, size_t Indent, const std::string &Paragraph)
 Format a paragraph of data. More...
 

Protected Attributes

option_container_type m_options
 
name_container_type m_name_mapping
 
key_container_type m_key_mapping
 
subcommand_container_type m_subcommands
 
std::string m_description
 
std::string m_summary
 
std::string m_synopsis
 

Private Member Functions

void column_dec ()
 
void column_inc ()
 
std::string indent () const
 
std::string pagename () const
 
std::string synopsis () const
 

Static Private Member Functions

static std::string cononical_program_name (const std::string &Source)
 

Private Attributes

int column
 
std::string program_name
 

Member Typedef Documentation

◆ element_type [1/2]

typedef Option LDASTools::AL::CommandLineOptions::OptionSet::element_type
inherited

◆ element_type [2/2]

typedef Option LDASTools::AL::CommandLineOptions::OptionSet::element_type
inherited

◆ key_container_type [1/2]

typedef LDASTools::AL:: unordered_map< int, option_container_type::const_iterator > LDASTools::AL::CommandLineOptions::OptionSet::key_container_type
protectedinherited

◆ key_container_type [2/2]

typedef LDASTools::AL:: unordered_map< int, option_container_type::const_iterator > LDASTools::AL::CommandLineOptions::OptionSet::key_container_type
protectedinherited

◆ name_container_type [1/2]

typedef LDASTools::AL::unordered_map< std::string, option_container_type::const_iterator > LDASTools::AL::CommandLineOptions::OptionSet::name_container_type
protectedinherited

◆ name_container_type [2/2]

typedef LDASTools::AL::unordered_map< std::string, option_container_type::const_iterator > LDASTools::AL::CommandLineOptions::OptionSet::name_container_type
protectedinherited

◆ option_container_type [1/2]

◆ option_container_type [2/2]

◆ subcommand_container_type [1/2]

typedef std::list< const OptionSet* > LDASTools::AL::CommandLineOptions::OptionSet::subcommand_container_type
protectedinherited

◆ subcommand_container_type [2/2]

typedef std::list< const OptionSet* > LDASTools::AL::CommandLineOptions::OptionSet::subcommand_container_type
protectedinherited

Constructor & Destructor Documentation

◆ doxygen_option_set()

anonymous_namespace{CommandLineOptions.cc}::doxygen_option_set::doxygen_option_set ( const std::string &  ProgramName,
const OptionSet Options 
)

Member Function Documentation

◆ Add() [1/4]

void LDASTools::AL::CommandLineOptions::OptionSet::Add ( const Option Opt)
inherited

◆ Add() [2/4]

void LDASTools::AL::CommandLineOptions::OptionSet::Add ( const Option Opt)
inherited

◆ Add() [3/4]

void LDASTools::AL::CommandLineOptions::OptionSet::Add ( const OptionSet Opts)
inherited

◆ Add() [4/4]

void LDASTools::AL::CommandLineOptions::OptionSet::Add ( const OptionSet Opts)
inherited

◆ Arguments()

std::ostream & anonymous_namespace{CommandLineOptions.cc}::doxygen_option_set::Arguments ( std::ostream &  Stream)

◆ column_dec()

void anonymous_namespace{CommandLineOptions.cc}::doxygen_option_set::column_dec ( )
inlineprivate

◆ column_inc()

void anonymous_namespace{CommandLineOptions.cc}::doxygen_option_set::column_inc ( )
inlineprivate

◆ cononical_program_name()

std::string anonymous_namespace{CommandLineOptions.cc}::doxygen_option_set::cononical_program_name ( const std::string &  Source)
staticprivate

◆ Description() [1/2]

void LDASTools::AL::CommandLineOptions::OptionSet::Description ( const std::string &  Text)
inlineinherited

◆ Description() [2/2]

void LDASTools::AL::CommandLineOptions::OptionSet::Description ( const std::string &  Text)
inherited

◆ Footer()

std::ostream & anonymous_namespace{CommandLineOptions.cc}::doxygen_option_set::Footer ( std::ostream &  Stream)

◆ hanging_par() [1/2]

void LDASTools::AL::CommandLineOptions::OptionSet::hanging_par ( ostream Stream,
size_t  Indent,
const std::string &  Paragraph 
)
staticprotectedinherited

Format a paragraph of data.

Parameters
[in]StreamOutput stream where the paragraph is to be written.
[in]IndentThe number of columns to indent each line of the paragraph.
[in]ParagraphThe text of the paragraph.

This method formats a string of text appropriately for a fixed width display.

Note
The current assumption is a screen width of 72 characters.

◆ hanging_par() [2/2]

static void LDASTools::AL::CommandLineOptions::OptionSet::hanging_par ( ostream Stream,
size_t  Indent,
const std::string &  Paragraph 
)
staticprotectedinherited

Format a paragraph of data.

Parameters
[in]StreamOutput stream where the paragraph is to be written.
[in]IndentThe number of columns to indent each line of the paragraph.
[in]ParagraphThe text of the paragraph.

◆ Header()

std::ostream & anonymous_namespace{CommandLineOptions.cc}::doxygen_option_set::Header ( std::ostream &  Stream)

◆ indent()

std::string anonymous_namespace{CommandLineOptions.cc}::doxygen_option_set::indent ( ) const
private

◆ operator[]() [1/4]

const CommandLineOptions::Option & LDASTools::AL::OptionSet::operator[] ( const std::string &  Name) const
inherited

◆ operator[]() [2/4]

const Option& LDASTools::AL::CommandLineOptions::OptionSet::operator[] ( const std::string &  Name) const
inherited

◆ operator[]() [3/4]

const Option& LDASTools::AL::CommandLineOptions::OptionSet::operator[] ( int  ) const
inherited

◆ operator[]() [4/4]

const CommandLineOptions::Option & LDASTools::AL::OptionSet::operator[] ( int  Key) const
inherited

◆ pagename()

std::string anonymous_namespace{CommandLineOptions.cc}::doxygen_option_set::pagename ( ) const
private

◆ Summary() [1/2]

void LDASTools::AL::CommandLineOptions::OptionSet::Summary ( const std::string &  Text)
inlineinherited

◆ Summary() [2/2]

void LDASTools::AL::CommandLineOptions::OptionSet::Summary ( const std::string &  Text)
inherited

◆ SummaryOnly() [1/2]

bool LDASTools::AL::CommandLineOptions::OptionSet::SummaryOnly ( ) const
inlineinherited

◆ SummaryOnly() [2/2]

bool LDASTools::AL::CommandLineOptions::OptionSet::SummaryOnly ( ) const
inherited

◆ synopsis()

std::string anonymous_namespace{CommandLineOptions.cc}::doxygen_option_set::synopsis ( ) const
private

◆ Synopsis() [1/2]

void LDASTools::AL::CommandLineOptions::OptionSet::Synopsis ( const std::string &  Text)
inherited

◆ Synopsis() [2/2]

void LDASTools::AL::CommandLineOptions::OptionSet::Synopsis ( const std::string &  Text)
inlineinherited

◆ Usage()

std::ostream & anonymous_namespace{CommandLineOptions.cc}::doxygen_option_set::Usage ( std::ostream &  Stream)

◆ Write() [1/2]

void anonymous_namespace{CommandLineOptions.cc}::doxygen_option_set::Write ( std::ostream &  Stream)

◆ Write() [2/2]

ostream & LDASTools::AL::CommandLineOptions::OptionSet::Write ( ostream Stream,
int  Indent = 0 
) const
inherited

Member Data Documentation

◆ column

int anonymous_namespace{CommandLineOptions.cc}::doxygen_option_set::column
private

◆ m_description

std::string LDASTools::AL::CommandLineOptions::OptionSet::m_description
protectedinherited

◆ m_key_mapping

key_container_type LDASTools::AL::CommandLineOptions::OptionSet::m_key_mapping
protectedinherited

◆ m_name_mapping

name_container_type LDASTools::AL::CommandLineOptions::OptionSet::m_name_mapping
protectedinherited

◆ m_options

option_container_type LDASTools::AL::CommandLineOptions::OptionSet::m_options
protectedinherited

◆ m_subcommands

subcommand_container_type LDASTools::AL::CommandLineOptions::OptionSet::m_subcommands
protectedinherited

◆ m_summary

std::string LDASTools::AL::CommandLineOptions::OptionSet::m_summary
protectedinherited

◆ m_synopsis

std::string LDASTools::AL::CommandLineOptions::OptionSet::m_synopsis
protectedinherited

◆ program_name

std::string anonymous_namespace{CommandLineOptions.cc}::doxygen_option_set::program_name
private

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