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

Search Toolkit Book for CArg_String

#include "ncbiargs_p.hpp"
(Private to src/corelib.)

+ Inheritance diagram for CArg_String:
+ Collaboration diagram for CArg_String:

Public Member Functions

 CArg_String (const string &name, const string &value)
 
virtual bool HasValue (void) const
 Check if argument holds a value. More...
 
virtual const stringAsString (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 CDirAsDirectory (void) const
 Get the argument as a directory. More...
 
virtual const CTimeAsDateTime (void) const
 Get the argument as a DateTime. More...
 
virtual CNcbiIstreamAsInputFile (TFileFlags flags=0) const
 Get the argument as an input file stream. More...
 
virtual CNcbiOstreamAsOutputFile (TFileFlags flags=0) const
 Get the argument as an output file stream. More...
 
virtual CNcbiIostreamAsIOFile (TFileFlags flags=0) const
 Get the argument as a file stream. More...
 
virtual void CloseFile (void) const
 Close the file. More...
 
virtual const TStringArrayGetStringList () const
 Get the value list. More...
 
virtual TStringArraySetStringList ()
 Get reference on value list for further modification. More...
 
- Public Member Functions inherited from CArgValue
const stringGetName (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 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
 

Private Attributes

TStringArray m_StringList
 Value of the argument as passed to the constructor ("value") becomes the first element in the value list AsString() and other methods then use it. More...
 

Additional Inherited Members

- Public Types inherited from CArgValue
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...
 
- 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 CArgValue
 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 inherited from CArgValue
string m_Name
 Argument name. More...
 
size_t m_Ordinal
 
string m_Default
 
TArgValueFlags m_Flags
 

Detailed Description

Definition at line 112 of file ncbiargs_p.hpp.

Constructor & Destructor Documentation

◆ CArg_String()

CArg_String::CArg_String ( const string name,
const string value 
)
inline

Definition at line 266 of file ncbiargs.cpp.

References m_StringList, and rapidjson::value.

Member Function Documentation

◆ 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

Get the argument as a DateTime.

Implements CArgValue.

Reimplemented in CArg_DateTime.

Definition at line 326 of file ncbiargs.cpp.

References AsString(), CArgValue::GetName(), NCBI_THROW, and s_ArgExptMsg().

◆ AsDirectory()

const CDir & CArg_String::AsDirectory ( void  ) const
virtual

Get the argument as a directory.

Implements CArgValue.

Reimplemented in CArg_Dir.

Definition at line 322 of file ncbiargs.cpp.

References AsString(), CArgValue::GetName(), NCBI_THROW, and s_ArgExptMsg().

◆ AsDouble()

double CArg_String::AsDouble ( void  ) const
virtual

Get the argument's double value.

If you request a wrong value type, such as a call to "AsDouble()" for a "boolean" argument, an exception is thrown.

See also
AsString(), AsInt8(), AsInteger, AsBoolean()

Implements CArgValue.

Reimplemented in CArg_Double.

Definition at line 314 of file ncbiargs.cpp.

References AsString(), CArgValue::GetName(), NCBI_THROW, and s_ArgExptMsg().

◆ AsInputFile()

CNcbiIstream & CArg_String::AsInputFile ( TFileFlags  flags = 0) const
virtual

Get the argument as an input file stream.

Implements CArgValue.

Reimplemented in CArg_Ios.

Definition at line 330 of file ncbiargs.cpp.

References AsString(), CArgValue::GetName(), NCBI_THROW, and s_ArgExptMsg().

Referenced by CArg_Ios::AsInputFile().

◆ AsInt8()

Int8 CArg_String::AsInt8 ( void  ) const
virtual

Get the argument's integer (8-byte long) value.

If you request a wrong value type, such as a call to "AsInt8()" for a "boolean" argument, an exception is thrown. This will however work okay for "plain integer" argument.

See also
AsInteger(), AsString(), AsDouble, AsBoolean()

Implements CArgValue.

Reimplemented in CArg_DataSize, and CArg_Int8.

Definition at line 300 of file ncbiargs.cpp.

References AsString(), CArgValue::GetName(), NCBI_THROW, and s_ArgExptMsg().

◆ AsInteger()

int CArg_String::AsInteger ( void  ) const
virtual

Get the argument's integer value.

If you request a wrong value type, such as a call to "AsInteger()" for a "boolean" or even "Int8" argument, an exception is thrown.

See also
AsInt8(), AsString(), AsDouble, AsBoolean()

Implements CArgValue.

Reimplemented in CArg_IntId, and CArg_Integer.

Definition at line 304 of file ncbiargs.cpp.

References AsString(), CArgValue::GetName(), NCBI_THROW, and s_ArgExptMsg().

◆ AsIntId()

TIntId CArg_String::AsIntId ( void  ) const
virtual

Get the argument's value as an integer id (TIntId).

The actual value is Int4 or Int8 depending on the NCBI_INT8_GI definition.

If you request a wrong value type, such as a call to "AsIntId()" for a "boolean", an exception is thrown. Calling AsIntId() on an integer argument is always allowed. For an Int8 argument it will throw an exception if NCBI_INT8_GI is not defined.

See also
AsInteger(), AsInt8()

Implements CArgValue.

Reimplemented in CArg_IntId, CArg_Integer, and CArg_Int8.

Definition at line 308 of file ncbiargs.cpp.

References AsString(), CArgValue::GetName(), NCBI_THROW, and s_ArgExptMsg().

◆ AsIOFile()

CNcbiIostream & CArg_String::AsIOFile ( TFileFlags  flags = 0) const
virtual

Get the argument as a file stream.

Implements CArgValue.

Reimplemented in CArg_Ios.

Definition at line 338 of file ncbiargs.cpp.

References AsString(), CArgValue::GetName(), NCBI_THROW, and s_ArgExptMsg().

Referenced by CArg_Ios::AsIOFile().

◆ AsOutputFile()

CNcbiOstream & CArg_String::AsOutputFile ( TFileFlags  flags = 0) const
virtual

Get the argument as an output file stream.

Implements CArgValue.

Reimplemented in CArg_Ios.

Definition at line 334 of file ncbiargs.cpp.

References AsString(), CArgValue::GetName(), NCBI_THROW, and s_ArgExptMsg().

Referenced by CArg_Ios::AsOutputFile().

◆ AsString()

const string & CArg_String::AsString ( void  ) const
virtual

◆ CloseFile()

void CArg_String::CloseFile ( void  ) const
virtual

Close the file.

Implements CArgValue.

Reimplemented in CArg_Ios.

Definition at line 342 of file ncbiargs.cpp.

References AsString(), CArgValue::GetName(), NCBI_THROW, and s_ArgExptMsg().

◆ GetStringList()

const CArgValue::TStringArray & CArg_String::GetStringList ( ) const
virtual

Get the value list.

Reimplemented from CArgValue.

Definition at line 288 of file ncbiargs.cpp.

References m_StringList.

◆ 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()

CArgValue::TStringArray & CArg_String::SetStringList ( )
virtual

Get reference on value list for further modification.

Reimplemented from CArgValue.

Definition at line 294 of file ncbiargs.cpp.

References m_StringList.

Member Data Documentation

◆ m_StringList

TStringArray CArg_String::m_StringList
private

Value of the argument as passed to the constructor ("value") becomes the first element in the value list AsString() and other methods then use it.

Definition at line 139 of file ncbiargs_p.hpp.

Referenced by AsString(), CArg_String(), GetStringList(), HasValue(), and SetStringList().


The documentation for this class was generated from the following files:
Modified on Sat May 25 14:16:44 2024 by modify_doxy.py rev. 669887