NCBI C++ ToolKit
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
CArgAllow_Doubles Class Reference

Search Toolkit Book for CArgAllow_Doubles

CArgAllow_Doubles –. More...

#include <corelib/ncbiargs.hpp>

+ Inheritance diagram for CArgAllow_Doubles:
+ Collaboration diagram for CArgAllow_Doubles:

Public Member Functions

 CArgAllow_Doubles (double x_value)
 Constructor specifying an allowed integer value. More...
 
 CArgAllow_Doubles (double x_min, double x_max)
 Constructor specifying range of allowed double values. More...
 
CArgAllow_DoublesAllowRange (double from, double to)
 Add allowed values. More...
 
CArgAllow_DoublesAllow (double value)
 
- Public Member Functions inherited from CArgAllow
virtual ~CArgAllow (void)
 
- 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
 

Protected Types

typedef pair< double, double > TInterval
 

Protected Member Functions

virtual bool Verify (const string &value) const
 Verify if specified value is allowed. More...
 
virtual string GetUsage (void) const
 Get usage information. More...
 
virtual void PrintUsageXml (CNcbiOstream &out) const
 Print constraints in XML format. More...
 
 CArgAllow_Doubles (void)
 
virtual CArgAllowClone (void) const
 Create object's clone, moving it from stack memory into heap. 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...
 

Protected Attributes

set< TIntervalm_MinMax
 

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 CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue TCount
 Alias for value type of counter. More...
 
- Static Public Member Functions inherited from CObject
static NCBI_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN 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

CArgAllow_Doubles –.

Define constraint to describe range of double values.

Argument to have only double values falling within given interval.

Example:

Definition at line 1668 of file ncbiargs.hpp.

Member Typedef Documentation

typedef pair<double,double> CArgAllow_Doubles::TInterval
protected

Definition at line 1695 of file ncbiargs.hpp.

Constructor & Destructor Documentation

CArgAllow_Doubles::CArgAllow_Doubles ( double  x_value)

Constructor specifying an allowed integer value.

Definition at line 4495 of file ncbiargs.cpp.

References Allow().

CArgAllow_Doubles::CArgAllow_Doubles ( double  x_min,
double  x_max 
)

Constructor specifying range of allowed double values.

Definition at line 4501 of file ncbiargs.cpp.

References AllowRange().

CArgAllow_Doubles::CArgAllow_Doubles ( void  )
inlineprotected

Definition at line 1691 of file ncbiargs.hpp.

Referenced by Clone().

Member Function Documentation

CArgAllow_Doubles & CArgAllow_Doubles::Allow ( double  value)

Definition at line 4567 of file ncbiargs.cpp.

References set< Key, Compare >::insert(), and m_MinMax.

Referenced by CArgAllow_Doubles().

CArgAllow_Doubles & CArgAllow_Doubles::AllowRange ( double  from,
double  to 
)

Add allowed values.

Definition at line 4561 of file ncbiargs.cpp.

References set< Key, Compare >::insert(), and m_MinMax.

Referenced by CArgAllow_Doubles().

CArgAllow * CArgAllow_Doubles::Clone ( void  ) const
protectedvirtual

Create object's clone, moving it from stack memory into heap.

The method is required only when using objects created on stack.

NOTE: Default implementation returns NULL. Inherited classes must override this method.

See also
CArgDescriptions::SetConstraint

Reimplemented from CArgAllow.

Definition at line 4573 of file ncbiargs.cpp.

References CArgAllow_Doubles(), and m_MinMax.

string CArgAllow_Doubles::GetUsage ( void  ) const
protectedvirtual
void CArgAllow_Doubles::PrintUsageXml ( CNcbiOstream out) const
protectedvirtual

Print constraints in XML format.

Reimplemented from CArgAllow.

Definition at line 4551 of file ncbiargs.cpp.

References NStr::DoubleToString(), ITERATE, m_MinMax, pi, and s_WriteXmlLine().

bool CArgAllow_Doubles::Verify ( const string value) const
protectedvirtual

Verify if specified value is allowed.

Implements CArgAllow.

Definition at line 4508 of file ncbiargs.cpp.

References NStr::fDecimalPosixOrLocal, ITERATE, m_MinMax, pi, NStr::StringToDouble(), and val.

Member Data Documentation

set< TInterval > CArgAllow_Doubles::m_MinMax
protected

Definition at line 1696 of file ncbiargs.hpp.

Referenced by Allow(), AllowRange(), Clone(), GetUsage(), PrintUsageXml(), and Verify().


The documentation for this class was generated from the following files:
Modified on Mon Jul 06 13:58:37 2015 by modify_doxy.py rev. 426318