pxr_CLI::CLI::OptionDefaults Class Reference

#include <CLI11.h>

Inheritance diagram for pxr_CLI::CLI::OptionDefaults:

Public Member Functions
	OptionDefaults ()=default
OptionDefaults *	multi_option_policy (MultiOptionPolicy value=MultiOptionPolicy::Throw)
	Take the last argument if given multiple times. More...
OptionDefaults *	ignore_case (bool value=true)
	Ignore the case of the option name. More...
OptionDefaults *	ignore_underscore (bool value=true)
	Ignore underscores in the option name. More...
OptionDefaults *	disable_flag_override (bool value=true)
	Disable overriding flag values with an '=' segment. More...
OptionDefaults *	delimiter (char value= '\0')
	set a delimiter character to split up single arguments to treat as multiple inputs More...
Public Member Functions inherited from pxr_CLI::CLI::OptionBase< OptionDefaults >
OptionDefaults *	group (const std::string &name)
	Changes the group membership. More...
OptionDefaults *	required (bool value=true)
	Set the option as required. More...
OptionDefaults *	mandatory (bool value=true)
	Support Plumbum term. More...
OptionDefaults *	always_capture_default (bool value=true)
CLI11_NODISCARD const std::string &	get_group () const
	Get the group of this option. More...
CLI11_NODISCARD bool	get_required () const
	True if this is a required option. More...
CLI11_NODISCARD bool	get_ignore_case () const
	The status of ignore case. More...
CLI11_NODISCARD bool	get_ignore_underscore () const
	The status of ignore_underscore. More...
CLI11_NODISCARD bool	get_configurable () const
	The status of configurable. More...
CLI11_NODISCARD bool	get_disable_flag_override () const
	The status of configurable. More...
CLI11_NODISCARD char	get_delimiter () const
	Get the current delimiter char. More...
CLI11_NODISCARD bool	get_always_capture_default () const
	Return true if this will automatically capture the default value for help printing. More...
CLI11_NODISCARD MultiOptionPolicy	get_multi_option_policy () const
	The status of the multi option policy. More...
OptionDefaults *	take_last ()
	Set the multi option policy to take last. More...
OptionDefaults *	take_first ()
	Set the multi option policy to take last. More...
OptionDefaults *	take_all ()
	Set the multi option policy to take all arguments. More...
OptionDefaults *	join ()
	Set the multi option policy to join. More...
OptionDefaults *	join (char delim)
	Set the multi option policy to join with a specific delimiter. More...
OptionDefaults *	configurable (bool value=true)
	Allow in a configuration file. More...
OptionDefaults *	delimiter (char value= '\0')
	Allow in a configuration file. More...

Additional Inherited Members
Protected Member Functions inherited from pxr_CLI::CLI::OptionBase< OptionDefaults >
void	copy_to (T *other) const
	Copy the contents to another similar class (one based on OptionBase) More...
Protected Attributes inherited from pxr_CLI::CLI::OptionBase< OptionDefaults >
std::string	group_
	The group membership. More...
bool	required_
	True if this is a required option. More...
bool	ignore_case_
	Ignore the case when matching (option, not value) More...
bool	ignore_underscore_
	Ignore underscores when matching (option, not value) More...
bool	configurable_
	Allow this option to be given in a configuration file. More...
bool	disable_flag_override_
	Disable overriding flag values with '=value'. More...
char	delimiter_
	Specify a delimiter character for vector arguments. More...
bool	always_capture_default_
	Automatically capture default value. More...
MultiOptionPolicy	multi_option_policy_
	Policy for handling multiple arguments beyond the expected Max. More...

Detailed Description

This is a version of OptionBase that only supports setting values, for defaults. It is stored as the default option in an App.

Definition at line 4310 of file CLI11.h.

Constructor & Destructor Documentation

pxr_CLI::CLI::OptionDefaults::OptionDefaults ( )

default

Member Function Documentation

OptionDefaults* pxr_CLI::CLI::OptionDefaults::delimiter ( char  value = '\0' )

inline

set a delimiter character to split up single arguments to treat as multiple inputs

Definition at line 4341 of file CLI11.h.

OptionDefaults* pxr_CLI::CLI::OptionDefaults::disable_flag_override ( bool  value = true )

inline

Disable overriding flag values with an '=' segment.

Definition at line 4335 of file CLI11.h.

OptionDefaults* pxr_CLI::CLI::OptionDefaults::ignore_case ( bool  value = true )

inline

Ignore the case of the option name.

Definition at line 4323 of file CLI11.h.

OptionDefaults* pxr_CLI::CLI::OptionDefaults::ignore_underscore ( bool  value = true )

inline

Ignore underscores in the option name.

Definition at line 4329 of file CLI11.h.

OptionDefaults* pxr_CLI::CLI::OptionDefaults::multi_option_policy ( MultiOptionPolicy  value = MultiOptionPolicy::Throw )

inline

Take the last argument if given multiple times.

Definition at line 4317 of file CLI11.h.

---

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

• pxr/base/tf/pxrCLI11/CLI11.h