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

Search Toolkit Book for CTaskCmdLineArgs

Argument class to specify the supported tasks a given program. More...

#include <algo/blast/blastinput/blast_args.hpp>

+ Inheritance diagram for CTaskCmdLineArgs:
+ Collaboration diagram for CTaskCmdLineArgs:

Public Member Functions

 CTaskCmdLineArgs (const set< string > &supported_tasks, const string &default_task)
 Constructor. More...
 
virtual void SetArgumentDescriptions (CArgDescriptions &arg_desc)
 Interface method,. More...
 
virtual void ExtractAlgorithmOptions (const CArgs &cmd_line_args, CBlastOptions &options)
 Interface method,. More...
 
- Public Member Functions inherited from IBlastCmdLineArgs
virtual ~IBlastCmdLineArgs ()
 Our virtual destructor. More...
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (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
 

Private Attributes

const set< stringm_SupportedTasks
 Set of supported tasks by this command line argument. More...
 
string m_DefaultTask
 Default task for this command line argument. 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< Uint8TCounter
 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...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Argument class to specify the supported tasks a given program.

Definition at line 197 of file blast_args.hpp.

Constructor & Destructor Documentation

◆ CTaskCmdLineArgs()

CTaskCmdLineArgs::CTaskCmdLineArgs ( const set< string > &  supported_tasks,
const string default_task 
)

Constructor.

Parameters
supported_taskslist of supported tasks [in]
default_taskOne of the tasks above, to be displayed as default in the command line arguments (cannot be empty or absent from the set above) [in]

Definition at line 84 of file blast_args.cpp.

References _ASSERT, set< Key, Compare >::empty(), set< Key, Compare >::end(), set< Key, Compare >::find(), m_DefaultTask, and m_SupportedTasks.

Member Function Documentation

◆ ExtractAlgorithmOptions()

void CTaskCmdLineArgs::ExtractAlgorithmOptions ( const CArgs cmd_line_args,
CBlastOptions options 
)
virtual

Interface method,.

See also
IBlastCmdLineArgs::SetArgumentDescriptions

Reimplemented from IBlastCmdLineArgs.

Definition at line 111 of file blast_args.cpp.

◆ SetArgumentDescriptions()

void CTaskCmdLineArgs::SetArgumentDescriptions ( CArgDescriptions arg_desc)
virtual

Member Data Documentation

◆ m_DefaultTask

string CTaskCmdLineArgs::m_DefaultTask
private

Default task for this command line argument.

Definition at line 217 of file blast_args.hpp.

Referenced by CTaskCmdLineArgs(), and SetArgumentDescriptions().

◆ m_SupportedTasks

const set<string> CTaskCmdLineArgs::m_SupportedTasks
private

Set of supported tasks by this command line argument.

Definition at line 215 of file blast_args.hpp.

Referenced by CTaskCmdLineArgs(), and SetArgumentDescriptions().


The documentation for this class was generated from the following files:
Modified on Tue Feb 27 05:50:26 2024 by modify_doxy.py rev. 669887