Search Toolkit Book for CArgAllowMaximumFileNameLength
Class to constrain the length of the file name passed to a given CArgDescriptions key. More...
#include <algo/blast/blastinput/blast_input_aux.hpp>
Inheritance diagram for CArgAllowMaximumFileNameLength:
Collaboration diagram for CArgAllowMaximumFileNameLength:
Public Member Functions | |
| CArgAllowMaximumFileNameLength (Uint4 max=kDfltMaxLength) | |
| Public Member Functions inherited from CArgAllow | |
| virtual void | PrintUsageXml (CNcbiOstream &out) const |
| Print constraints in XML format. More... | |
| virtual | ~CArgAllow (void) |
| virtual CArgAllow * | Clone (void) const |
| Create object's clone, moving it from stack memory into heap. More... | |
| 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 |
Static Public Attributes | |
| static constexpr Uint4 | kDfltMaxLength = 256 |
| 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... | |
Protected Member Functions | |
| virtual bool | Verify (const string &value) const |
| Overloaded method from CArgAllow. More... | |
| virtual string | GetUsage (void) const |
| Overloaded method from CArgAllow. 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... | |
Private Attributes | |
| Uint4 | m_MaxLength |
| Maximum string length value for this object. 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) |
Detailed Description
Class to constrain the length of the file name passed to a given CArgDescriptions key.
Definition at line 76 of file blast_input_aux.hpp.
Constructor & Destructor Documentation
◆ CArgAllowMaximumFileNameLength()
|
inline |
Definition at line 81 of file blast_input_aux.hpp.
Member Function Documentation
◆ GetUsage()
|
inlineprotectedvirtual |
Overloaded method from CArgAllow.
Implements CArgAllow.
Definition at line 91 of file blast_input_aux.hpp.
References NStr::IntToString(), and m_MaxLength.
◆ Verify()
|
inlineprotectedvirtual |
Overloaded method from CArgAllow.
Implements CArgAllow.
Definition at line 85 of file blast_input_aux.hpp.
References CDirEntry::GetName(), m_MaxLength, and rapidjson::value.
Member Data Documentation
◆ kDfltMaxLength
|
staticconstexpr |
Definition at line 79 of file blast_input_aux.hpp.
◆ m_MaxLength
|
private |
Maximum string length value for this object.
Definition at line 96 of file blast_input_aux.hpp.
Referenced by GetUsage(), and Verify().
The documentation for this class was generated from the following file:
- include/algo/blast/blastinput/blast_input_aux.hpp
