Search Toolkit Book for CArgDesc_KeyOpt

#include "ncbiargs_p.hpp"
(Private to src/corelib.)

Inheritance diagram for CArgDesc_KeyOpt:

Collaboration diagram for CArgDesc_KeyOpt:

Public Member Functions
	CArgDesc_KeyOpt (const string &name, const string &comment, CArgDescriptions::EType type, CArgDescriptions::TFlags flags, const string &synopsis)

virtual	~CArgDesc_KeyOpt (void)

virtual string	GetUsageSynopsis (bool name_only=false) const
	Get usage synopsis. More...

Public Member Functions inherited from CArgDesc_PosOpt
	CArgDesc_PosOpt (const string &name, const string &comment, CArgDescriptions::EType type, CArgDescriptions::TFlags flags)

virtual	~CArgDesc_PosOpt (void)

Public Member Functions inherited from CArgDescOptional
	CArgDescOptional (const string &name, const string &comment, CArgDescriptions::EType type, CArgDescriptions::TFlags flags)

virtual	~CArgDescOptional (void)

virtual CArgValue *	ProcessDefault (void) const
	Process argument default. More...

virtual size_t	GetGroup (void) const
	Get argument group. More...

virtual void	SetGroup (size_t group)
	Set argument group. More...

Public Member Functions inherited from CArgDescMandatory
	CArgDescMandatory (const string &name, const string &comment, CArgDescriptions::EType type, CArgDescriptions::TFlags flags)

virtual	~CArgDescMandatory (void)

CArgDescriptions::EType	GetType (void) const

virtual string	GetUsageCommentAttr (void) const
	Get usage comment attribute. More...

virtual CArgValue *	ProcessArgument (const string &value) const
	Process argument with specified value. More...

virtual void	SetConstraint (const CArgAllow *constraint, CArgDescriptions::EConstraintNegate negate)
	Set argument constraint. More...

virtual const CArgAllow *	GetConstraint (void) const
	Get argument constraint. More...

virtual bool	IsConstraintInverted () const
	Returns TRUE if associated constraint is inverted (NOT) More...

virtual const CArgErrorHandler *	GetErrorHandler (void) const
	Get error handler for the argument. More...

virtual void	SetErrorHandler (CArgErrorHandler *err_handler)
	Set error handler for the argument. More...

Public Member Functions inherited from CArgDesc
	CArgDesc (const string &name, const string &comment, CArgDescriptions::TFlags flags=0)
	Constructor. More...

virtual	~CArgDesc (void)
	Destructor. More...

const string &	GetName (void) const
	Get argument name. More...

const string &	GetComment (void) const
	Get argument description. More...

virtual void	VerifyDefault (void) const
	Verify argument default value. More...

string	GetUsageConstraint (void) const
	Get usage constraint. More...

CArgDescriptions::TFlags	GetFlags (void) const
	Get argument flags. More...

string	PrintXml (CNcbiOstream &out) const
	Print description in XML format. More...

Public Member Functions inherited from CArgDesc_Pos
	CArgDesc_Pos (const string &name, const string &comment, CArgDescriptions::EType type, CArgDescriptions::TFlags flags)

virtual	~CArgDesc_Pos (void)

Public Member Functions inherited from CArgDescSynopsis
	CArgDescSynopsis (const string &synopsis)

const string &	GetSynopsis (void) const

Detailed Description

Definition at line 522 of file ncbiargs_p.hpp.

Constructor & Destructor Documentation

◆ CArgDesc_KeyOpt()

CArgDesc_KeyOpt::CArgDesc_KeyOpt	(	const string &	name,
		const string &	comment,
		CArgDescriptions::EType	type,
		CArgDescriptions::TFlags	flags,
		const string &	synopsis
	)

Definition at line 1636 of file ncbiargs.cpp.

◆ ~CArgDesc_KeyOpt()

CArgDesc_KeyOpt::~CArgDesc_KeyOpt ( void )

virtual

Definition at line 1650 of file ncbiargs.cpp.

Member Function Documentation

◆ GetUsageSynopsis()

string CArgDesc_KeyOpt::GetUsageSynopsis ( bool name_only = false ) const

virtual

Get usage synopsis.

Reimplemented from CArgDesc_Pos.

Definition at line 1656 of file ncbiargs.cpp.

References CArgDesc::GetFlags(), CArgDesc::GetName(), CArgDescSynopsis::GetSynopsis(), and s_KeyUsageSynopsis().

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