NCBI C++ ToolKit
Public Member Functions | Private Attributes | Friends | List of all members
CTraversalNode::CUserCall Class Reference

Search Toolkit Book for CTraversalNode::CUserCall

#include "traversal_node.hpp"
(Private to src/serial/datatool.)

+ Inheritance diagram for CTraversalNode::CUserCall:
+ Collaboration diagram for CTraversalNode::CUserCall:

Public Member Functions

 CUserCall (const std::string &user_func_name, const TNodeVec &extra_arg_nodes, const vector< string > &constant_args)
 
const std::stringGetUserFuncName () const
 
const TNodeVecGetExtraArgNodes (void) const
 
const vector< string > & GetConstantArgs (void) const
 
bool operator== (const CUserCall &rhs) const
 
bool operator!= (const CUserCall &rhs) const
 
bool operator< (const CUserCall &rhs) const
 
int Compare (const CUserCall &rhs) 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
 

Private Attributes

const std::string m_UserFuncName
 
TNodeVec m_ExtraArgNodes
 
vector< stringm_ConstantArgs
 

Friends

class CTraversalNode
 

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

Detailed Description

Definition at line 118 of file traversal_node.hpp.

Constructor & Destructor Documentation

CTraversalNode::CUserCall::CUserCall ( const std::string user_func_name,
const TNodeVec extra_arg_nodes,
const vector< string > &  constant_args 
)

Definition at line 409 of file traversal_node.cpp.

References m_ExtraArgNodes, and NON_CONST_ITERATE.

Member Function Documentation

int CTraversalNode::CUserCall::Compare ( const CUserCall rhs) const
inline
const vector<string>& CTraversalNode::CUserCall::GetConstantArgs ( void  ) const
inline

Definition at line 126 of file traversal_node.hpp.

References m_ConstantArgs.

const TNodeVec& CTraversalNode::CUserCall::GetExtraArgNodes ( void  ) const
inline

Definition at line 125 of file traversal_node.hpp.

References m_ExtraArgNodes.

const std::string& CTraversalNode::CUserCall::GetUserFuncName ( ) const
inline

Definition at line 124 of file traversal_node.hpp.

References m_UserFuncName.

bool CTraversalNode::CUserCall::operator!= ( const CUserCall rhs) const
inline

Definition at line 129 of file traversal_node.hpp.

References Compare().

bool CTraversalNode::CUserCall::operator< ( const CUserCall rhs) const
inline

Definition at line 130 of file traversal_node.hpp.

References Compare().

bool CTraversalNode::CUserCall::operator== ( const CUserCall rhs) const
inline

Definition at line 128 of file traversal_node.hpp.

References Compare().

Friends And Related Function Documentation

friend class CTraversalNode
friend

Definition at line 137 of file traversal_node.hpp.

Member Data Documentation

vector<string> CTraversalNode::CUserCall::m_ConstantArgs
private

Definition at line 135 of file traversal_node.hpp.

Referenced by GetConstantArgs().

TNodeVec CTraversalNode::CUserCall::m_ExtraArgNodes
private

Definition at line 134 of file traversal_node.hpp.

Referenced by CUserCall(), and GetExtraArgNodes().

const std::string CTraversalNode::CUserCall::m_UserFuncName
private

Definition at line 133 of file traversal_node.hpp.

Referenced by Compare(), and GetUserFuncName().


The documentation for this class was generated from the following files:
Modified on Thu Feb 22 13:23:31 2018 by modify_doxy.py rev. 546573