NCBI C++ ToolKit
Public Member Functions | Private Attributes | List of all members
CArgDesc_Alias Class Reference

Search Toolkit Book for CArgDesc_Alias

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

+ Inheritance diagram for CArgDesc_Alias:
+ Collaboration diagram for CArgDesc_Alias:

Public Member Functions

 CArgDesc_Alias (const string &alias, const string &arg_name, const string &comment)
 
virtual ~CArgDesc_Alias (void)
 
const stringGetAliasedName (void) const
 
virtual string GetUsageSynopsis (bool name_only) const
 Get usage synopsis. More...
 
virtual string GetUsageCommentAttr (void) const
 Get usage comment attribute. More...
 
virtual CArgValueProcessArgument (const string &value) const
 Process argument with specified value. More...
 
virtual CArgValueProcessDefault (void) const
 Process argument default. More...
 
void SetNegativeFlag (bool value)
 
bool GetNegativeFlag (void) const
 
- 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 stringGetName (void) const
 Get argument name. More...
 
const stringGetComment (void) const
 Get argument description. More...
 
virtual size_t GetGroup (void) const
 Get argument group. More...
 
virtual void SetGroup (size_t)
 Set argument group. More...
 
virtual void VerifyDefault (void) const
 Verify argument default value. More...
 
virtual void SetConstraint (const CArgAllow *constraint, CArgDescriptions::EConstraintNegate negate=CArgDescriptions::eConstraint)
 Set argument constraint. More...
 
virtual bool IsConstraintInverted () const
 Returns TRUE if associated constraint is inverted (NOT) More...
 
virtual const CArgAllowGetConstraint (void) const
 Get argument constraint. More...
 
string GetUsageConstraint (void) const
 Get usage constraint. More...
 
virtual const CArgErrorHandlerGetErrorHandler (void) const
 Get error handler for the argument. More...
 
virtual void SetErrorHandler (CArgErrorHandler *)
 Set error handler for the argument. More...
 
CArgDescriptions::TFlags GetFlags (void) const
 Get argument flags. More...
 
string PrintXml (CNcbiOstream &out) const
 Print description in XML format. More...
 

Private Attributes

string m_ArgName
 
bool m_NegativeFlag
 

Detailed Description

Definition at line 555 of file ncbiargs_p.hpp.

Constructor & Destructor Documentation

◆ CArgDesc_Alias()

CArgDesc_Alias::CArgDesc_Alias ( const string alias,
const string arg_name,
const string comment 
)

Definition at line 1699 of file ncbiargs.cpp.

◆ ~CArgDesc_Alias()

CArgDesc_Alias::~CArgDesc_Alias ( void  )
virtual

Definition at line 1709 of file ncbiargs.cpp.

Member Function Documentation

◆ GetAliasedName()

const string & CArgDesc_Alias::GetAliasedName ( void  ) const

◆ GetNegativeFlag()

bool CArgDesc_Alias::GetNegativeFlag ( void  ) const
inline

◆ GetUsageCommentAttr()

string CArgDesc_Alias::GetUsageCommentAttr ( void  ) const
virtual

Get usage comment attribute.

Implements CArgDesc.

Definition at line 1726 of file ncbiargs.cpp.

References kEmptyStr.

◆ GetUsageSynopsis()

string CArgDesc_Alias::GetUsageSynopsis ( bool  name_only) const
virtual

Get usage synopsis.

Implements CArgDesc.

Definition at line 1720 of file ncbiargs.cpp.

References kEmptyStr.

◆ ProcessArgument()

CArgValue * CArgDesc_Alias::ProcessArgument ( const string value) const
virtual

Process argument with specified value.

Implements CArgDesc.

Definition at line 1732 of file ncbiargs.cpp.

References CArgDesc::GetName().

◆ ProcessDefault()

CArgValue * CArgDesc_Alias::ProcessDefault ( void  ) const
virtual

Process argument default.

Implements CArgDesc.

Definition at line 1738 of file ncbiargs.cpp.

References CArgDesc::GetName().

◆ SetNegativeFlag()

void CArgDesc_Alias::SetNegativeFlag ( bool  value)
inline

Definition at line 575 of file ncbiargs_p.hpp.

References m_NegativeFlag, and rapidjson::value.

Member Data Documentation

◆ m_ArgName

string CArgDesc_Alias::m_ArgName
private

Definition at line 578 of file ncbiargs_p.hpp.

Referenced by GetAliasedName().

◆ m_NegativeFlag

bool CArgDesc_Alias::m_NegativeFlag
private

Definition at line 579 of file ncbiargs_p.hpp.

Referenced by GetNegativeFlag(), and SetNegativeFlag().


The documentation for this class was generated from the following files:
Modified on Sat May 25 14:20:27 2024 by modify_doxy.py rev. 669887