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

This class provides a converter for configuration files. More...

#include <CLI11.h>

+ Inheritance diagram for pxr_CLI::CLI::Config:

Public Member Functions

virtual std::string to_config (const App *, bool, bool, std::string) const =0
 Convert an app into a configuration. More...
 
virtual std::vector< ConfigItemfrom_config (std::istream &) const =0
 Convert a configuration into an app. More...
 
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...
 

Protected Attributes

std::vector< ConfigItemitems {}
 

Detailed Description

This class provides a converter for configuration files.

Definition at line 2676 of file CLI11.h.

Constructor & Destructor Documentation

virtual pxr_CLI::CLI::Config::~Config ( )
virtualdefault

Virtual destructor.

Member Function Documentation

virtual std::vector<ConfigItem> pxr_CLI::CLI::Config::from_config ( std::istream &  ) const
pure virtual

Convert a configuration into an app.

Implemented in pxr_CLI::CLI::ConfigBase.

CLI11_NODISCARD std::vector<ConfigItem> pxr_CLI::CLI::Config::from_file ( const std::string name) const
inline

Parse a config file, throw an error (ParseError:ConfigParseError or FileError) on failure.

Definition at line 2699 of file CLI11.h.

virtual std::string pxr_CLI::CLI::Config::to_config ( const App ,
bool  ,
bool  ,
std::string   
) const
pure virtual

Convert an app into a configuration.

Implemented in pxr_CLI::CLI::ConfigBase.

virtual CLI11_NODISCARD std::string pxr_CLI::CLI::Config::to_flag ( const ConfigItem item) const
inlinevirtual

Get a flag value.

Definition at line 2688 of file CLI11.h.

Member Data Documentation

std::vector<ConfigItem> pxr_CLI::CLI::Config::items {}
protected

Definition at line 2678 of file CLI11.h.


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