NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
CArgValue Class Referenceabstract

Search Toolkit Book for CArgValue

CArgValue –. More...

#include <corelib/ncbiargs.hpp>

+ Inheritance diagram for CArgValue:
+ Collaboration diagram for CArgValue:

Public Types

enum  EFileFlags {
  fBinary = (1 << 1) , fText = 0 , fAppend = (1 << 2) , fTruncate = (1 << 12) ,
  fNoCreate = (1 << 11) , fCreatePath = (1 << 8)
}
 
enum  EArgValueFlags { fArgValue_HasDefault = (1 << 0) , fArgValue_FromDefault = (1 << 1) }
 Whether the argument: More...
 
typedef unsigned int TFileFlags
 Bitwise OR of "EFileFlags". More...
 
typedef vector< stringTStringArray
 Some values types can contain several value lists. More...
 
typedef unsigned int TArgValueFlags
 Bitwise OR of "EArgValueFlags". More...
 
- 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...
 

Public Member Functions

const stringGetName (void) const
 Get argument name. More...
 
virtual bool HasValue (void) const =0
 Check if argument holds a value. More...
 
 DECLARE_OPERATOR_BOOL (HasValue())
 Synonym for HasValue(). More...
 
virtual const stringAsString (void) const =0
 Get the argument's string value. More...
 
virtual Int8 AsInt8 (void) const =0
 Get the argument's integer (8-byte long) value. More...
 
virtual int AsInteger (void) const =0
 Get the argument's integer value. More...
 
virtual TIntId AsIntId (void) const =0
 Get the argument's value as an integer id (TIntId). More...
 
virtual double AsDouble (void) const =0
 Get the argument's double value. More...
 
virtual bool AsBoolean (void) const =0
 Get the argument's boolean value. More...
 
virtual CNcbiIstreamAsInputFile (TFileFlags flags=0) const =0
 Get the argument as an input file stream. More...
 
virtual CNcbiOstreamAsOutputFile (TFileFlags flags=0) const =0
 Get the argument as an output file stream. More...
 
virtual CNcbiIostreamAsIOFile (TFileFlags flags=0) const =0
 Get the argument as a file stream. More...
 
virtual const CDirAsDirectory (void) const =0
 Get the argument as a directory. More...
 
virtual const CTimeAsDateTime (void) const =0
 Get the argument as a DateTime. More...
 
virtual void CloseFile (void) const =0
 Close the file. More...
 
virtual const TStringArrayGetStringList () const
 Get the value list. More...
 
virtual TStringArraySetStringList ()
 Get reference on value list for further modification. More...
 
size_t GetOrdinalPosition (void) const
 Get ordinal position of the value. More...
 
const stringGetDefault (TArgValueFlags *flags=NULL) const
 Get default value of the argument. 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
 

Protected Member Functions

 CArgValue (const string &name)
 Protected constructor and destructor. More...
 
virtual ~CArgValue (void)
 
void SetOrdinalPosition (size_t pos)
 
void x_SetDefault (const string &def_value, bool from_def)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Protected Attributes

string m_Name
 Argument name. More...
 
size_t m_Ordinal
 
string m_Default
 
TArgValueFlags m_Flags
 

Friends

class CArgs
 
class CArgDescDefault
 
class CArgDescMandatory
 
class CArgDesc_Flag
 

Additional Inherited Members

- 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

CArgValue –.

Generic abstract base class for argument values.

Definition at line 183 of file ncbiargs.hpp.


The documentation for this class was generated from the following files:
Modified on Thu May 30 12:23:59 2024 by modify_doxy.py rev. 669887