Command parser. More...

#include <ViewerTest_CmdParser.hxx>

Public Member Functions
	ViewerTest_CmdParser (const std::string &theDescription=std::string())
	Initializes help option.

void	SetDescription (const std::string &theDescription)
	Sets description for command.

ViewerTest_CommandOptionKey	AddOption (const std::string &theOptionNames, const std::string &theOptionDescription=std::string())
	Adds option to available option list. Several names may be provided if separated with '\|'.

void	PrintHelp () const
	Prints help message based on provided command and options descriptions.

void	Parse (Standard_Integer theArgsNb, const char const theArgVec)
	Parses argument list (skips the command name); assigns local arguments to each option.

std::string	GetOptionNameByKey (ViewerTest_CommandOptionKey theOptionKey) const
	Gets an option name by its access key.

ViewerTest_CommandOptionKeySet	GetUsedOptions () const
	Gets a set of used options.

bool	HasNoOption () const
	Tests if there were no command line options provided.

bool	HasUnnamedOption () const
	Tests if the unnamed command line option was provided.

bool	HasOnlyUnnamedOption () const
	Tests if only unnamed command line option was provided.

bool	HasOption (const std::string &theOptionName, std::size_t theMandatoryArgsNb=0, bool isFatal=Standard_False) const
	Checks if option was used with given minimal number of arguments. Prints error message if isFatal flag was set.

bool	HasOption (ViewerTest_CommandOptionKey theOptionKey, std::size_t theMandatoryArgsNb=0, bool isFatal=Standard_False) const
	Checks if option was used with given minimal number of arguments. Prints error message if isFatal flag was set.

Standard_Integer	GetNumberOfOptionArguments (const std::string &theOptionName) const
	Gets a number of option arguments.

Standard_Integer	GetNumberOfOptionArguments (ViewerTest_CommandOptionKey theOptionKey) const
	Gets a number of option arguments.

bool	Arg (const std::string &theOptionName, Standard_Integer theArgumentIndex, std::string &theOptionArgument) const
	Accesses local argument of option 'theOptionName' with index 'theArgumentIndex'.

bool	Arg (ViewerTest_CommandOptionKey theOptionKey, Standard_Integer theArgumentIndex, std::string &theOptionArgument) const
	Accesses a local argument with the index 'theArgumentIndex' of the option with the key 'theOptionKey'.

std::string	Arg (const std::string &theOptionName, Standard_Integer theArgumentIndex) const
	Accesses local argument of option 'theOptionName' with index 'theArgumentIndex'.

std::string	Arg (ViewerTest_CommandOptionKey theOptionKey, Standard_Integer theArgumentIndex) const
	Accesses a local argument with the index 'theArgumentIndex' of the option with the key 'theOptionKey'.

Graphic3d_Vec3	ArgVec3f (const std::string &theOptionName, const Standard_Integer theArgumentIndex=0) const

Graphic3d_Vec3d	ArgVec3d (const std::string &theOptionName, const Standard_Integer theArgumentIndex=0) const

gp_Vec	ArgVec (const std::string &theOptionName, const Standard_Integer theArgumentIndex=0) const

gp_Pnt	ArgPnt (const std::string &theOptionName, const Standard_Integer theArgumentIndex=0) const

Standard_Real	ArgDouble (const std::string &theOptionName, const Standard_Integer theArgumentIndex=0) const

Standard_ShortReal	ArgFloat (const std::string &theOptionName, const Standard_Integer theArgumentIndex=0) const

Standard_Integer	ArgInt (const std::string &theOptionName, const Standard_Integer theArgumentIndex=0) const

bool	ArgBool (const std::string &theOptionName, const Standard_Integer theArgumentIndex=0) const

template<typename TheColor>
bool	ArgColor (const std::string &theOptionName, Standard_Integer &theArgumentIndex, TheColor &theColor) const
	Interprets arguments of the option 'theOptionName' with the index 'theArgumentIndex' as an RGB(A) color object.

template<typename TheColor>
bool	ArgColor (ViewerTest_CommandOptionKey theOptionKey, Standard_Integer &theArgumentIndex, TheColor &theColor) const
	Interprets arguments of the option with the key 'theOptionKey' as an RGB(A) color object.

Static Public Attributes
static const std::size_t	THE_UNNAMED_COMMAND_OPTION_KEY
	The key of the unnamed command option.

static const std::size_t	THE_HELP_COMMAND_OPTION_KEY
	The key of the help command option.

Detailed Description

Command parser.

Constructor & Destructor Documentation

◆ ViewerTest_CmdParser()

ViewerTest_CmdParser::ViewerTest_CmdParser ( const std::string & theDescription = std::string() )

Initializes help option.

Parameters

theDescription the description of the command

Member Function Documentation

◆ AddOption()

ViewerTest_CommandOptionKey ViewerTest_CmdParser::AddOption	(	const std::string &	theOptionNames,
		const std::string &	theOptionDescription = std::string() )

Adds option to available option list. Several names may be provided if separated with '|'.

Parameters

theOptionNames	the list of possible option names separated with '\|' (the first name is main, the other names are aliases)
theOptionDescription	the description of the option

Returns: an access key of the newly added option

◆ Arg() [1/4]

std::string ViewerTest_CmdParser::Arg	(	const std::string &	theOptionName,
		Standard_Integer	theArgumentIndex ) const

Accesses local argument of option 'theOptionName' with index 'theArgumentIndex'.

Parameters

theOptionName	the name of the option which argument is to be accessed
theArgumentIndex	the index of an accessed argument

Returns: an argument of the option with the given name

◆ Arg() [2/4]

bool ViewerTest_CmdParser::Arg	(	const std::string &	theOptionName,
		Standard_Integer	theArgumentIndex,
		std::string &	theOptionArgument ) const

Accesses local argument of option 'theOptionName' with index 'theArgumentIndex'.

Parameters

theOptionName	the name of the option which argument is to be accessed
theArgumentIndex	the index of an accessed argument
theOptionArgument	an argument of the option with the given name

Returns: true if an access was successful, or false otherwise

◆ Arg() [3/4]

std::string ViewerTest_CmdParser::Arg	(	ViewerTest_CommandOptionKey	theOptionKey,
		Standard_Integer	theArgumentIndex ) const

Accesses a local argument with the index 'theArgumentIndex' of the option with the key 'theOptionKey'.

Parameters

theOptionKey	the access key of the option which argument is to be accessed
theArgumentIndex	the index of an accessed argument

Returns: an argument of the option with the given key

◆ Arg() [4/4]

bool ViewerTest_CmdParser::Arg	(	ViewerTest_CommandOptionKey	theOptionKey,
		Standard_Integer	theArgumentIndex,
		std::string &	theOptionArgument ) const

Accesses a local argument with the index 'theArgumentIndex' of the option with the key 'theOptionKey'.

Parameters

theOptionKey	the access key of the option which argument is to be accessed
theArgumentIndex	the index of an accessed argument
theOptionArgument	an argument of the option with the given key

Returns: true if an access was successful, or false otherwise

◆ ArgBool()

bool ViewerTest_CmdParser::ArgBool	(	const std::string &	theOptionName,
		const Standard_Integer	theArgumentIndex = 0 ) const

◆ ArgColor() [1/2]

template<typename TheColor>

bool ViewerTest_CmdParser::ArgColor	(	const std::string &	theOptionName,
		Standard_Integer &	theArgumentIndex,
		TheColor &	theColor ) const

Interprets arguments of the option 'theOptionName' with the index 'theArgumentIndex' as an RGB(A) color object.

Template Parameters

theColor the type of a resulting RGB(A) color object

Parameters

theOptionName	the name of the option which arguments are to be interpreted
theArgumentIndex	the index of the first argument to be interpreted (will be promoted to the next argument after the block of interpreted arguments)
theColor	a color that is an interpretation of argument(s) of the option with the given name

Returns: true if an interpretation was successful, or false otherwise

◆ ArgColor() [2/2]

template<typename TheColor>

bool ViewerTest_CmdParser::ArgColor	(	ViewerTest_CommandOptionKey	theOptionKey,
		Standard_Integer &	theArgumentIndex,
		TheColor &	theColor ) const

Interprets arguments of the option with the key 'theOptionKey' as an RGB(A) color object.

Template Parameters

theColor the type of a resulting RGB(A) color object

Parameters

theOptionKey	the access key of the option which arguments are to be interpreted
theArgumentIndex	the index of the first argument to be interpreted (will be promoted to the next argument after the block of interpreted arguments)
theColor	a color that is an interpretation of argument(s) of the option with the given name

Returns: true if an interpretation was successful, or false otherwise

◆ ArgDouble()

Standard_Real ViewerTest_CmdParser::ArgDouble	(	const std::string &	theOptionName,
		const Standard_Integer	theArgumentIndex = 0 ) const

◆ ArgFloat()

Standard_ShortReal ViewerTest_CmdParser::ArgFloat	(	const std::string &	theOptionName,
		const Standard_Integer	theArgumentIndex = 0 ) const

◆ ArgInt()

Standard_Integer ViewerTest_CmdParser::ArgInt	(	const std::string &	theOptionName,
		const Standard_Integer	theArgumentIndex = 0 ) const

◆ ArgPnt()

gp_Pnt ViewerTest_CmdParser::ArgPnt	(	const std::string &	theOptionName,
		const Standard_Integer	theArgumentIndex = 0 ) const

◆ ArgVec()

gp_Vec ViewerTest_CmdParser::ArgVec	(	const std::string &	theOptionName,
		const Standard_Integer	theArgumentIndex = 0 ) const

◆ ArgVec3d()

Graphic3d_Vec3d ViewerTest_CmdParser::ArgVec3d	(	const std::string &	theOptionName,
		const Standard_Integer	theArgumentIndex = 0 ) const

◆ ArgVec3f()

Graphic3d_Vec3 ViewerTest_CmdParser::ArgVec3f	(	const std::string &	theOptionName,
		const Standard_Integer	theArgumentIndex = 0 ) const

◆ GetNumberOfOptionArguments() [1/2]

Standard_Integer ViewerTest_CmdParser::GetNumberOfOptionArguments ( const std::string & theOptionName ) const

Gets a number of option arguments.

Parameters

theOptionName the name of the option

Returns: a number of option arguments, or 0 if option was not used

◆ GetNumberOfOptionArguments() [2/2]

Standard_Integer ViewerTest_CmdParser::GetNumberOfOptionArguments ( ViewerTest_CommandOptionKey theOptionKey ) const

Gets a number of option arguments.

Parameters

theOptionKey the access key of the option

Returns: a number of option arguments, or 0 if option was not used

◆ GetOptionNameByKey()

std::string ViewerTest_CmdParser::GetOptionNameByKey ( ViewerTest_CommandOptionKey theOptionKey ) const

Gets an option name by its access key.

Parameters

theOptionKey the access key of the option which name is to be found @retuan a name of the option with the given access key

◆ GetUsedOptions()

ViewerTest_CommandOptionKeySet ViewerTest_CmdParser::GetUsedOptions ( ) const

Gets a set of used options.

Returns: a set of used options

◆ HasNoOption()

bool ViewerTest_CmdParser::HasNoOption ( ) const

Tests if there were no command line options provided.

Returns: true if no command line options were provided, or false otherwise

◆ HasOnlyUnnamedOption()

bool ViewerTest_CmdParser::HasOnlyUnnamedOption ( ) const

Tests if only unnamed command line option was provided.

Returns: true if only unnamed command line option was provided, or false otherwise

◆ HasOption() [1/2]

bool ViewerTest_CmdParser::HasOption	(	const std::string &	theOptionName,
		std::size_t	theMandatoryArgsNb = 0,
		bool	isFatal = Standard_False ) const

Checks if option was used with given minimal number of arguments. Prints error message if isFatal flag was set.

Parameters

theOptionName	the name of the option to be checked
theMandatoryArgsNb	the number of mandatory arguments
isFatal	the flag that controls printing of an error message

Returns: true if an option was set, or false otherwise

◆ HasOption() [2/2]

bool ViewerTest_CmdParser::HasOption	(	ViewerTest_CommandOptionKey	theOptionKey,
		std::size_t	theMandatoryArgsNb = 0,
		bool	isFatal = Standard_False ) const

Checks if option was used with given minimal number of arguments. Prints error message if isFatal flag was set.

Parameters

theOptionKey	the access key of the option to be checked
theMandatoryArgsNb	the number of mandatory arguments
isFatal	the flag that controls printing of an error message

Returns: true if an option was set, or false otherwise

◆ HasUnnamedOption()

bool ViewerTest_CmdParser::HasUnnamedOption ( ) const

Tests if the unnamed command line option was provided.

Returns: true if the unnamed command line option was provided, or false otherwise

◆ Parse()

void ViewerTest_CmdParser::Parse	(	Standard_Integer	theArgsNb,
		const char const	theArgVec )

Parses argument list (skips the command name); assigns local arguments to each option.

◆ PrintHelp()

void ViewerTest_CmdParser::PrintHelp ( ) const

Prints help message based on provided command and options descriptions.

◆ SetDescription()

void ViewerTest_CmdParser::SetDescription ( const std::string & theDescription )

inline

Sets description for command.

Field Documentation

◆ THE_HELP_COMMAND_OPTION_KEY

const std::size_t ViewerTest_CmdParser::THE_HELP_COMMAND_OPTION_KEY

static

The key of the help command option.

◆ THE_UNNAMED_COMMAND_OPTION_KEY

const std::size_t ViewerTest_CmdParser::THE_UNNAMED_COMMAND_OPTION_KEY

static

The key of the unnamed command option.

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

ViewerTest_CmdParser.hxx

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ViewerTest_CmdParser()

Member Function Documentation

◆ AddOption()

◆ Arg() [1/4]

◆ Arg() [2/4]

◆ Arg() [3/4]

◆ Arg() [4/4]

◆ ArgBool()

◆ ArgColor() [1/2]

◆ ArgColor() [2/2]

◆ ArgDouble()

◆ ArgFloat()

◆ ArgInt()

◆ ArgPnt()

◆ ArgVec()

◆ ArgVec3d()

◆ ArgVec3f()

◆ GetNumberOfOptionArguments() [1/2]

◆ GetNumberOfOptionArguments() [2/2]

◆ GetOptionNameByKey()

◆ GetUsedOptions()

◆ HasNoOption()

◆ HasOnlyUnnamedOption()

◆ HasOption() [1/2]

◆ HasOption() [2/2]

◆ HasUnnamedOption()

◆ Parse()

◆ PrintHelp()

◆ SetDescription()

Field Documentation

◆ THE_HELP_COMMAND_OPTION_KEY

◆ THE_UNNAMED_COMMAND_OPTION_KEY