HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pxr_CLI::CLI::ConfigINI Class Reference

ConfigINI generates a "standard" INI compliant output. More...

#include <CLI11.h>

+ Inheritance diagram for pxr_CLI::CLI::ConfigINI:

Public Member Functions

 ConfigINI ()
 
- Public Member Functions inherited from pxr_CLI::CLI::ConfigBase
std::string to_config (const App *, bool default_also, bool write_description, std::string prefix) const override
 Convert an app into a configuration. More...
 
std::vector< ConfigItemfrom_config (std::istream &input) const override
 Convert a configuration into an app. More...
 
ConfigBasecomment (char cchar)
 Specify the configuration for comment characters. More...
 
ConfigBasearrayBounds (char aStart, char aEnd)
 Specify the start and end characters for an array. More...
 
ConfigBasearrayDelimiter (char aSep)
 Specify the delimiter character for an array. More...
 
ConfigBasevalueSeparator (char vSep)
 Specify the delimiter between a name and value. More...
 
ConfigBasequoteCharacter (char qString, char qChar)
 Specify the quote characters used around strings and characters. More...
 
ConfigBasemaxLayers (uint8_t layers)
 Specify the maximum number of parents. More...
 
ConfigBaseparentSeparator (char sep)
 Specify the separator to use for parent layers. More...
 
std::stringsectionRef ()
 get a reference to the configuration section More...
 
CLI11_NODISCARD const std::stringsection () const
 get the section More...
 
ConfigBasesection (const std::string &sectionName)
 specify a particular section of the configuration file to use More...
 
int16_t & indexRef ()
 get a reference to the configuration index More...
 
CLI11_NODISCARD int16_t index () const
 get the section index More...
 
ConfigBaseindex (int16_t sectionIndex)
 specify a particular index in the section to use (-1) for all sections to use More...
 
- Public Member Functions inherited from pxr_CLI::CLI::Config
virtual CLI11_NODISCARD std::string to_flag (const ConfigItem &item) const
 Get a flag value. More...
 
CLI11_NODISCARD std::vector
< ConfigItem
from_file (const std::string &name) const
 Parse a config file, throw an error (ParseError:ConfigParseError or FileError) on failure. More...
 
virtual ~Config ()=default
 Virtual destructor. More...
 

Additional Inherited Members

- Protected Attributes inherited from pxr_CLI::CLI::ConfigBase
char commentChar = '#'
 the character used for comments More...
 
char arrayStart = '['
 the character used to start an array '\0' is a default to not use More...
 
char arrayEnd = ']'
 the character used to end an array '\0' is a default to not use More...
 
char arraySeparator = ','
 the character used to separate elements in an array More...
 
char valueDelimiter = '='
 the character used separate the name from the value More...
 
char stringQuote = '"'
 the character to use around strings More...
 
char characterQuote = '\''
 the character to use around single characters More...
 
uint8_t maximumLayers {255}
 the maximum number of layers to allow More...
 
char parentSeparatorChar {'.'}
 the separator used to separator parent layers More...
 
int16_t configIndex {-1}
 Specify the configuration index to use for arrayed sections. More...
 
std::string configSection {}
 Specify the configuration section that should be used. More...
 
- Protected Attributes inherited from pxr_CLI::CLI::Config
std::vector< ConfigItemitems {}
 

Detailed Description

ConfigINI generates a "standard" INI compliant output.

Definition at line 2804 of file CLI11.h.

Constructor & Destructor Documentation

pxr_CLI::CLI::ConfigINI::ConfigINI ( )
inline

Definition at line 2807 of file CLI11.h.


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