Search Toolkit Book for CArgAllow_Strings
#include <corelib/ncbiargs.hpp>
Inheritance diagram for CArgAllow_Strings:
Collaboration diagram for CArgAllow_Strings:
Public Member Functions | |
| CArgAllow_Strings (NStr::ECase use_case=NStr::eCase) | |
| Constructor. More... | |
| CArgAllow_Strings (initializer_list< string > values, NStr::ECase use_case=NStr::eCase) | |
| Constructor. More... | |
| CArgAllow_Strings * | Allow (const string &value) |
| Add allowed string values. More... | |
| CArgAllow_Strings & | AllowValue (const string &value) |
| Add allowed string values. More... | |
| CArgAllow_Strings & | operator, (const string &value) |
| Short notation operator for adding allowed string values. More... | |
| Public Member Functions inherited from CArgAllow | |
| virtual | ~CArgAllow (void) |
| Public Member Functions inherited from CObject | |
| CObject (void) | |
| Constructor. More... | |
| CObject (const CObject &src) | |
| Copy constructor. More... | |
| virtual | ~CObject (void) |
| Destructor. More... | |
| CObject & | operator= (const CObject &src) THROWS_NONE |
| Assignment operator. More... | |
| bool | CanBeDeleted (void) const THROWS_NONE |
| Check if object can be deleted. More... | |
| bool | IsAllocatedInPool (void) const THROWS_NONE |
| Check if object is allocated in memory pool (not system heap) More... | |
| bool | Referenced (void) const THROWS_NONE |
| Check if object is referenced. More... | |
| bool | ReferencedOnlyOnce (void) const THROWS_NONE |
| Check if object is referenced only once. More... | |
| void | AddReference (void) const |
| Add reference to object. More... | |
| void | RemoveReference (void) const |
| Remove reference to object. More... | |
| void | ReleaseReference (void) const |
| Remove reference without deleting object. More... | |
| virtual void | DoNotDeleteThisObject (void) |
| Mark this object as not allocated in heap – do not delete this object. More... | |
| virtual void | DoDeleteThisObject (void) |
| Mark this object as allocated in heap – object can be deleted. More... | |
| void * | operator new (size_t size) |
| Define new operator for memory allocation. More... | |
| void * | operator new[] (size_t size) |
| Define new[] operator for 'array' memory allocation. More... | |
| void | operator delete (void *ptr) |
| Define delete operator for memory deallocation. More... | |
| void | operator delete[] (void *ptr) |
| Define delete[] operator for memory deallocation. More... | |
| void * | operator new (size_t size, void *place) |
| Define new operator. More... | |
| void | operator delete (void *ptr, void *place) |
| Define delete operator. More... | |
| void * | operator new (size_t size, CObjectMemoryPool *place) |
| Define new operator using memory pool. More... | |
| void | operator delete (void *ptr, CObjectMemoryPool *place) |
| Define delete operator. More... | |
| virtual void | DebugDump (CDebugDumpContext ddc, unsigned int depth) const |
| Define method for dumping debug information. More... | |
| Public Member Functions inherited from CDebugDumpable | |
| CDebugDumpable (void) | |
| virtual | ~CDebugDumpable (void) |
| void | DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const |
| void | DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const |
| void | DumpToConsole (void) const |
Protected Types | |
| typedef set< string, PNocase_Conditional > | TStrings |
| Type of the container that contains the allowed string values. More... | |
Protected Member Functions | |
| virtual bool | Verify (const string &value) const |
| Verify if specified value is allowed. More... | |
| virtual string | GetUsage (void) const |
| Get usage information. More... | |
| virtual void | PrintUsageXml (CNcbiOstream &out) const |
| Print constraints in XML format. More... | |
| virtual CArgAllow * | Clone (void) const |
| Create object's clone, moving it from stack memory into heap. More... | |
| Protected Member Functions inherited from CArgAllow | |
| CArgAllow (void) | |
| Protected Member Functions inherited from CObject | |
| virtual void | DeleteThis (void) |
| Virtual method "deleting" this object. More... | |
Protected Attributes | |
| TStrings | m_Strings |
| Set of allowed string values. More... | |
Additional Inherited Members | |
| Public Types inherited from CObject | |
| enum | EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern } |
| Control filling of newly allocated memory. More... | |
| typedef CObjectCounterLocker | TLockerType |
| Default locker type for CRef. More... | |
| typedef atomic< Uint8 > | TCounter |
| Counter type is CAtomiCounter. More... | |
| typedef Uint8 | TCount |
| Alias for value type of counter. More... | |
| Static Public Member Functions inherited from CObject | |
| static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (void) |
| Define method to throw null pointer exception. More... | |
| static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (const type_info &type) |
| static EAllocFillMode | GetAllocFillMode (void) |
| static void | SetAllocFillMode (EAllocFillMode mode) |
| static void | SetAllocFillMode (const string &value) |
| Set mode from configuration parameter value. More... | |
| Static Public Member Functions inherited from CDebugDumpable | |
| static void | EnableDebugDump (bool on) |
| Static Public Attributes inherited from CObject | |
| static const TCount | eCounterBitsCanBeDeleted = 1 << 0 |
| Define possible object states. More... | |
| static const TCount | eCounterBitsInPlainHeap = 1 << 1 |
| Heap signature was found. More... | |
| static const TCount | eCounterBitsPlaceMask |
| Mask for 'in heap' state flags. More... | |
| static const int | eCounterStep = 1 << 2 |
| Skip over the "in heap" bits. More... | |
| static const TCount | eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2) |
| Minimal value for valid objects (reference counter is zero) Must be a single bit value. More... | |
| static const TCount | eCounterStateMask |
| Valid object, and object in heap. More... | |
Detailed Description
Define constraint to describe set of string values.
Argument to have only particular string values. Use the Allow() method to add the allowed string values, which can be daisy-chained.
Examples:
- SetConstraint("a", (new CArgAllow_Strings)-> Allow("foo")->Allow("bar")->Allow("etc"))
- You can use "operator,()" to shorten the notation: SetConstraint("b", &(*new CArgAllow_Strings, "foo", "bar", "etc"))
Definition at line 1640 of file ncbiargs.hpp.
The documentation for this class was generated from the following files:
- include/corelib/ncbiargs.hpp
- src/corelib/ncbiargs.cpp
