ldas-tools-al 2.6.4
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Types | Static Protected Member Functions | Protected Attributes | List of all members
LDASTools::AL::CommandLineOptions::OptionSet Class Reference

#include <CommandLineOptions.hh>

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

Public Types

typedef Option element_type
 
typedef Option element_type
 

Public Member Functions

void Add (const Option &Opt)
 
void Add (const OptionSet &Opts)
 
void Description (const std::string &Text)
 
void Summary (const std::string &Text)
 
bool SummaryOnly () const
 
void Synopsis (const std::string &Text)
 
ostreamWrite (ostream &Stream, int Indent=0) const
 
const Optionoperator[] (const std::string &Name) const
 
const Optionoperator[] (int) const
 
void Add (const Option &Opt)
 
void Add (const OptionSet &Opts)
 
void Description (const std::string &Text)
 
void Summary (const std::string &Text)
 
bool SummaryOnly () const
 
void Synopsis (const std::string &Text)
 
ostreamWrite (ostream &Stream, int Indent=0) const
 
const Optionoperator[] (const std::string &Name) const
 
const Optionoperator[] (int) const
 

Protected Types

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< std::string, option_container_type::const_iterator > name_container_type
 
typedef std::list< const OptionSet * > subcommand_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< std::string, option_container_type::const_iterator > name_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.
 
static void hanging_par (ostream &Stream, size_t Indent, const std::string &Paragraph)
 Format a paragraph of data.
 

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
 

Member Typedef Documentation

◆ element_type [1/2]

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

◆ element_type [2/2]

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

◆ key_container_type [1/2]

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

◆ key_container_type [2/2]

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

◆ name_container_type [1/2]

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

◆ name_container_type [2/2]

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

◆ 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
protected

◆ subcommand_container_type [2/2]

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

Member Function Documentation

◆ Add() [1/4]

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

◆ Add() [2/4]

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

◆ Add() [3/4]

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

◆ Add() [4/4]

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

◆ Description() [1/2]

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

◆ Description() [2/2]

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

◆ hanging_par() [1/2]

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

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 )
staticprotected

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.

◆ operator[]() [1/4]

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

◆ operator[]() [2/4]

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

◆ operator[]() [3/4]

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

◆ operator[]() [4/4]

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

◆ Summary() [1/2]

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

◆ Summary() [2/2]

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

◆ SummaryOnly() [1/2]

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

◆ SummaryOnly() [2/2]

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

◆ Synopsis() [1/2]

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

◆ Synopsis() [2/2]

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

◆ Write() [1/2]

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

◆ Write() [2/2]

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

Member Data Documentation

◆ m_description

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

◆ m_key_mapping

key_container_type LDASTools::AL::CommandLineOptions::OptionSet::m_key_mapping
protected

◆ m_name_mapping

name_container_type LDASTools::AL::CommandLineOptions::OptionSet::m_name_mapping
protected

◆ m_options

option_container_type LDASTools::AL::CommandLineOptions::OptionSet::m_options
protected

◆ m_subcommands

subcommand_container_type LDASTools::AL::CommandLineOptions::OptionSet::m_subcommands
protected

◆ m_summary

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

◆ m_synopsis

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

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