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

Search Toolkit Book for CFuncWithArgs

Class to store one function as it appears in the macro and its arguments (as GUI fieldnames) More...

#include <gui/widgets/edit/macro_interpret.hpp>

+ Inheritance diagram for CFuncWithArgs:
+ Collaboration diagram for CFuncWithArgs:

Public Types

using TInterpretedArgs = unordered_map< string, string >
 Map of control names and corresponding values. It may contain more 'arguments' than the function has. 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

 CFuncWithArgs ()
 
 CFuncWithArgs (const SMacroFuncWithArgs &fnc)
 
CFuncWithArgsoperator= (const CFuncWithArgs &)
 
bool operator== (const CFuncWithArgs &other) const
 
- 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
 

Public Attributes

string m_FName
 Function name as it appears in the macro. More...
 
TInterpretedArgs m_FArgs
 
bool m_Negate { false }
 
string m_ParentFnc
 
CRef< SMacroFuncWithArgsm_ChildFnc { nullptr }
 
EMacroFieldType m_FieldTypeFrom { EMacroFieldType::eNotSet }
 
EMacroFieldType m_FieldTypeTo { EMacroFieldType::eNotSet }
 

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...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Class to store one function as it appears in the macro and its arguments (as GUI fieldnames)

Definition at line 41 of file macro_interpret.hpp.

Member Typedef Documentation

◆ TInterpretedArgs

Map of control names and corresponding values. It may contain more 'arguments' than the function has.

Definition at line 55 of file macro_interpret.hpp.

Constructor & Destructor Documentation

◆ CFuncWithArgs() [1/2]

CFuncWithArgs::CFuncWithArgs ( )
inline

Definition at line 44 of file macro_interpret.hpp.

◆ CFuncWithArgs() [2/2]

CFuncWithArgs::CFuncWithArgs ( const SMacroFuncWithArgs fnc)
inline

Definition at line 45 of file macro_interpret.hpp.

Member Function Documentation

◆ operator=()

CFuncWithArgs & CFuncWithArgs::operator= ( const CFuncWithArgs other)

◆ operator==()

bool CFuncWithArgs::operator== ( const CFuncWithArgs other) const

Member Data Documentation

◆ m_ChildFnc

CRef<SMacroFuncWithArgs> CFuncWithArgs::m_ChildFnc { nullptr }

Definition at line 59 of file macro_interpret.hpp.

Referenced by operator<<(), operator=(), and operator==().

◆ m_FArgs

TInterpretedArgs CFuncWithArgs::m_FArgs

◆ m_FieldTypeFrom

EMacroFieldType CFuncWithArgs::m_FieldTypeFrom { EMacroFieldType::eNotSet }

Definition at line 61 of file macro_interpret.hpp.

Referenced by operator<<(), operator=(), and operator==().

◆ m_FieldTypeTo

EMacroFieldType CFuncWithArgs::m_FieldTypeTo { EMacroFieldType::eNotSet }

Definition at line 62 of file macro_interpret.hpp.

Referenced by operator<<(), operator=(), and operator==().

◆ m_FName

string CFuncWithArgs::m_FName

◆ m_Negate

bool CFuncWithArgs::m_Negate { false }

◆ m_ParentFnc

string CFuncWithArgs::m_ParentFnc

The documentation for this class was generated from the following files:
Modified on Wed Apr 17 13:11:01 2024 by modify_doxy.py rev. 669887