NCBI C++ ToolKit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
CNCBINode Class Reference

Search Toolkit Book for CNCBINode

#include <html/node.hpp>

+ Inheritance diagram for CNCBINode:
+ Collaboration diagram for CNCBINode:


struct  SAttributeValue
class  TMode

Public Types

enum  EMode { eHTML = 0 , ePlainText = 1 , eXHTML = 2 }
enum  EExceptionFlags { fAddTrace = 0x1 , fCatchAll = 0x2 , fDisableCheckRecursion = 0x4 }
 Flags defining how to catch and process exceptions. More...
typedef list< CNodeRefTChildren
typedef unique_ptr< TChildrenTChildrenMember
typedef map< string, SAttributeValue, PNocaseTAttributes
typedef int TExceptionFlags
 Binary OR of "EExceptionFlags". 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

 CNCBINode (void)
 CNCBINode (const string &name)
 CNCBINode (const char *name)
virtual ~CNCBINode ()
CNCBINodeAppendChild (CNCBINode *child)
CNCBINodeAppendChild (CNodeRef &ref)
CNodeRef RemoveChild (CNCBINode *child)
CNodeRef RemoveChild (CNodeRef &child)
void RemoveAllChildren (void)
bool HaveChildren (void) const
TChildrenChildren (void)
const TChildrenChildren (void) const
TChildren::iterator ChildBegin (void)
TChildren::iterator ChildEnd (void)
TChildren::const_iterator ChildBegin (void) const
TChildren::const_iterator ChildEnd (void) const
virtual CNcbiOstreamPrint (CNcbiOstream &out, TMode mode=eHTML)
virtual CNcbiOstreamPrintBegin (CNcbiOstream &out, TMode mode)
virtual CNcbiOstreamPrintChildren (CNcbiOstream &out, TMode mode)
virtual CNcbiOstreamPrintEnd (CNcbiOstream &out, TMode mode)
void SetRepeatCount (size_t count=0)
size_t GetRepeatCount (void)
virtual void CreateSubNodes (void)
void Initialize (void)
void ReInitialize (void)
virtual CNCBINodeMapTag (const string &tagname)
CNodeRef MapTagAll (const string &tagname, const TMode &mode)
void RepeatTag (bool enable=true)
bool NeedRepeatTag (void)
const stringGetName (void) const
bool HaveAttributes (void) const
TAttributesAttributes (void)
const TAttributesAttributes (void) const
bool HaveAttribute (const string &name) const
const stringGetAttribute (const string &name) const
bool AttributeIsOptional (const string &name) const
bool AttributeIsOptional (const char *name) const
void SetAttributeOptional (const string &name, bool optional=true)
void SetAttributeOptional (const char *name, bool optional=true)
const stringGetAttributeValue (const string &name) const
void SetAttribute (const string &name, const string &value)
void SetAttribute (const string &name)
void SetAttribute (const string &name, int value)
void SetOptionalAttribute (const string &name, const string &value)
void SetOptionalAttribute (const string &name, bool set)
void SetAttribute (const char *name, const string &value)
void SetAttribute (const char *name)
void SetAttribute (const char *name, int value)
void SetOptionalAttribute (const char *name, const string &value)
void SetOptionalAttribute (const char *name, bool set)
- 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

Static Public Member Functions

static CNCBINodeNode (TChildren::iterator i)
static const CNCBINodeNode (TChildren::const_iterator i)
static void SetExceptionFlags (TExceptionFlags flags)
static TExceptionFlags GetExceptionFlags (void)
- 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)

Protected Member Functions

virtual void DoAppendChild (CNCBINode *child)
virtual void DoSetAttribute (const string &name, const string &value, bool optional)
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...

Protected Attributes

bool m_CreateSubNodesCalled
TChildrenMember m_Children
 Child nodes. More...
string m_Name
 Node name. More...
size_t m_RepeatCount
 How many times repeat node. More...
bool m_RepeatTag
unique_ptr< TAttributesm_Attributes

Private Member Functions

 CNCBINode (const CNCBINode &node)
CNCBINodeoperator= (const CNCBINode &node)
TChildrenGetChildren (void)
TAttributesGetAttributes (void)


class CRef< CNCBINode >

Additional Inherited Members

- 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

Definition at line 58 of file node.hpp.

The documentation for this class was generated from the following files:
Modified on Sun Apr 14 05:25:28 2024 by rev. 669887