NCBI C++ ToolKit
|
Search Toolkit Book for CArgDesc
#include <corelib/ncbiargs.hpp>
Public Member Functions | |
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 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 CArgValue * | ProcessArgument (const string &value) const =0 |
Process argument with specified value. More... | |
virtual CArgValue * | ProcessDefault (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 CArgAllow * | GetConstraint (void) const |
Get argument constraint. More... | |
string | GetUsageConstraint (void) const |
Get usage constraint. More... | |
virtual const CArgErrorHandler * | GetErrorHandler (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 |
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.