NCBI C++ ToolKit
Public Member Functions | Private Attributes | List of all members
CArgDesc Class Referenceabstract

Search Toolkit Book for CArgDesc

CArgDesc –. More...

#include <corelib/ncbiargs.hpp>

+ Inheritance diagram for CArgDesc:

Public Member Functions

 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 string GetUsageSynopsis (bool name_only=false) const =0
 Get usage synopsis. More...
 
virtual string GetUsageCommentAttr (void) const =0
 Get usage comment attribute. More...
 
virtual CArgValueProcessArgument (const string &value) const =0
 Process argument with specified value. More...
 
virtual CArgValueProcessDefault (void) const =0
 Process argument default. 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_Name
 Argument name. More...
 
string m_Comment
 Argument description. More...
 
CArgDescriptions::TFlags m_Flags
 

Detailed Description

CArgDesc –.

Base class for the description of various types of argument.

This was a pre-declaration; in MSVC, a predeclaration here causes a heap corruption on termination because this class's virtual destructor isn't defined at the moment the compiler instantiates the destructor of AutoPtr<CArgDesc>.

Definition at line 1824 of file ncbiargs.hpp.


The documentation for this class was generated from the following files:
Modified on Fri Sep 20 14:57:19 2024 by modify_doxy.py rev. 669887