Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/classCArg__String.html below:
NCBI C++ ToolKit: CArg_String Class Reference
Search Toolkit Book for CArg_String
#include "ncbiargs_p.hpp"
(Private to src/corelib.)
CArg_String (const string &name, const string &value) virtual bool HasValue (void) const Check if argument holds a value. More...
virtual const string & AsString (void) const Get the argument's string value. More...
virtual Int8 AsInt8 (void) const Get the argument's integer (8-byte long) value. More...
virtual int AsInteger (void) const Get the argument's integer value. More...
virtual TIntId AsIntId (void) const Get the argument's value as an integer id (TIntId). More...
virtual double AsDouble (void) const Get the argument's double value. More...
virtual bool AsBoolean (void) const Get the argument's boolean value. More...
virtual const CDir & AsDirectory (void) const Get the argument as a directory. More...
virtual const CTime & AsDateTime (void) const Get the argument as a DateTime. More...
virtual CNcbiIstream & AsInputFile (TFileFlags flags=0) const Get the argument as an input file stream. More...
virtual CNcbiOstream & AsOutputFile (TFileFlags flags=0) const Get the argument as an output file stream. More...
virtual CNcbiIostream & AsIOFile (TFileFlags flags=0) const Get the argument as a file stream. More...
virtual void CloseFile (void) const Close the file. More...
virtual const TStringArray & GetStringList () const Get the value list. More...
virtual TStringArray & SetStringList () Get reference on value list for further modification. More...
const string & GetName (void) const Get argument name. More...
DECLARE_OPERATOR_BOOL (HasValue()) Synonym for HasValue(). More...
size_t GetOrdinalPosition (void) const Get ordinal position of the value. More...
const string & GetDefault (TArgValueFlags *flags=NULL) const Get default value of the argument. More...
size_t IsStandard (void) const Checks that this is a standard/special argument. More...
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...
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 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< string > TStringArray Some values types can contain several value lists. More...
typedef unsigned int TArgValueFlags Bitwise OR of "EArgValueFlags". More...
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 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 void EnableDebugDump (bool on) 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...
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) virtual void DeleteThis (void) Virtual method "deleting" this object. More...
string m_Name Argument name. More...
size_t m_Ordinal string m_Default TArgValueFlags m_Flags bool m_Standard
Definition at line 112 of file ncbiargs_p.hpp.
◆ CArg_String() ◆ AsBoolean() bool CArg_String::AsBoolean ( void ) const virtual
Get the argument's boolean value.
If you request a wrong value type, such as a call to "AsBoolean()" for a "integer" argument, an exception is thrown.
NOTE: Do not confuse HasValue(), operator bool() and AsBoolean(). The former two methods check if the argument has any value, they do not return its actual value.
-
See also
-
HasValue(), AsString(), AsInt8(), AsInteger, AsDouble()
Implements CArgValue.
Reimplemented in CArg_Boolean.
Definition at line 318 of file ncbiargs.cpp.
References AsString(), CArgValue::GetName(), NCBI_THROW, and s_ArgExptMsg().
◆ AsDateTime() const CTime & CArg_String::AsDateTime ( void ) const virtual ◆ AsDirectory() const CDir & CArg_String::AsDirectory ( void ) const virtual ◆ AsDouble() double CArg_String::AsDouble ( void ) const virtual ◆ AsInputFile() ◆ AsInt8() Int8 CArg_String::AsInt8 ( void ) const virtual ◆ AsInteger() int CArg_String::AsInteger ( void ) const virtual ◆ AsIntId() TIntId CArg_String::AsIntId ( void ) const virtual ◆ AsIOFile() ◆ AsOutputFile() ◆ AsString()
Get the argument's string value.
If it is a value of a flag argument, then return either "true" or "false".
-
See also
-
AsInteger(), AsInt8(), AsDouble(), AsBoolean()
Implements CArgValue.
Definition at line 279 of file ncbiargs.cpp.
References kEmptyStr, and m_StringList.
Referenced by AsBoolean(), AsDateTime(), AsDirectory(), AsDouble(), AsInputFile(), AsInt8(), AsInteger(), CArg_IntId::AsInteger(), AsIntId(), CArg_Int8::AsIntId(), AsIOFile(), AsOutputFile(), CloseFile(), CArg_Ios::CloseFile(), CArg_Ios::x_CreatePath(), CArg_Ios::x_Open(), CArg_InputFile::x_Open(), CArg_OutputFile::x_Open(), and CArg_IOFile::x_Open().
◆ CloseFile() void CArg_String::CloseFile ( void ) const virtual ◆ GetStringList() ◆ HasValue() bool CArg_String::HasValue ( void ) const virtual
Check if argument holds a value.
Argument does not hold value if it was described as optional argument without default value, and if it was not passed a value in the command line. On attempt to retrieve the value from such "no-value" argument, exception will be thrown.
NOTE: HasValue() and operator bool() check if the argument has any value, they do not return the actual value of boolean arguments. if (args["bv"]) ... - check if "bv" has any value if (args["bv"].AsBoolean()) ... - check the actual value of "bv" argument
Implements CArgValue.
Reimplemented in CArg_Flag.
Definition at line 273 of file ncbiargs.cpp.
References m_StringList.
◆ SetStringList() ◆ m_StringList
The documentation for this class was generated from the following files:
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4