CAsnWriteNode Class Reference

Search Toolkit Book for CAsnWriteNode

#include <ctools/asn/asnwrite.hpp>

Inheritance diagram for CAsnWriteNode:

Collaboration diagram for CAsnWriteNode:

Public Member Functions
	CAsnWriteNode (void)
	CAsnWriteNode (int mode)
	~CAsnWriteNode (void)
AsnIoPtr	GetOut (void)
	operator AsnIoPtr (void)
virtual CNcbiOstream &	PrintChildren (CNcbiOstream &out, TMode mode)
Public Member Functions inherited from CHTMLNode
	CHTMLNode (void)
	CHTMLNode (const char *tagname)
	CHTMLNode (const char *tagname, const char *text)
	CHTMLNode (const char *tagname, const string &text)
	CHTMLNode (const char *tagname, CNCBINode *node)
	CHTMLNode (const string &tagname)
	CHTMLNode (const string &tagname, const char *text)
	CHTMLNode (const string &tagname, const string &text)
	CHTMLNode (const string &tagname, CNCBINode *node)
	~CHTMLNode (void)
CHTMLNode *	SetClass (const string &class_name)
CHTMLNode *	SetStyle (const string &style)
CHTMLNode *	SetId (const string &id)
CHTMLNode *	SetWidth (int width)
CHTMLNode *	SetWidth (const string &width)
CHTMLNode *	SetHeight (int height)
CHTMLNode *	SetHeight (const string &width)
CHTMLNode *	SetSize (int size)
CHTMLNode *	SetAlign (const string &align)
CHTMLNode *	SetVAlign (const string &align)
CHTMLNode *	SetBgColor (const string &color)
CHTMLNode *	SetColor (const string &color)
CHTMLNode *	SetNameAttribute (const string &name)
const string &	GetNameAttribute (void) const
CHTMLNode *	SetTitle (const string &title)
CHTMLNode *	SetAccessKey (char key)
CHTMLNode *	AppendPlainText (const char *text, bool noEncode=false)
CHTMLNode *	AppendPlainText (const string &text, bool noEncode=false)
CHTMLNode *	AppendHTMLText (const char *text)
CHTMLNode *	AppendHTMLText (const string &text)
string	GetEventHandlerName (const EHTML_EH_Attribute event) const
void	SetEventHandler (const EHTML_EH_Attribute event, const string &value)
Public Member Functions inherited from CNCBINode
	CNCBINode (void)
	CNCBINode (const string &name)
	CNCBINode (const char *name)
virtual	~CNCBINode ()
CNCBINode *	AppendChild (CNCBINode *child)
CNCBINode *	AppendChild (CNodeRef &ref)
CNodeRef	RemoveChild (CNCBINode *child)
CNodeRef	RemoveChild (CNodeRef &child)
void	RemoveAllChildren (void)
bool	HaveChildren (void) const
TChildren &	Children (void)
const TChildren &	Children (void) const
TChildren::iterator	ChildBegin (void)
TChildren::iterator	ChildEnd (void)
TChildren::const_iterator	ChildBegin (void) const
TChildren::const_iterator	ChildEnd (void) const
virtual CNcbiOstream &	Print (CNcbiOstream &out, TMode mode=eHTML)
virtual CNcbiOstream &	PrintBegin (CNcbiOstream &out, TMode mode)
virtual CNcbiOstream &	PrintEnd (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 CNCBINode *	MapTag (const string &tagname)
CNodeRef	MapTagAll (const string &tagname, const TMode &mode)
void	RepeatTag (bool enable=true)
bool	NeedRepeatTag (void)
const string &	GetName (void) const
bool	HaveAttributes (void) const
TAttributes &	Attributes (void)
const TAttributes &	Attributes (void) const
bool	HaveAttribute (const string &name) const
const string &	GetAttribute (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 string *	GetAttributeValue (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...
CObject &	operator= (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
AsnIoPtr	m_Out
int	m_Mode

Additional Inherited Members
Public Types inherited from CNCBINode
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< CNodeRef >	TChildren
typedef unique_ptr< TChildren >	TChildrenMember
typedef map< string, SAttributeValue, PNocase >	TAttributes
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< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...
typedef Uint8	TCount
	Alias for value type of counter. More...
Static Public Member Functions inherited from CNCBINode
static CNCBINode *	Node (TChildren::iterator i)
static const CNCBINode *	Node (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)
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 CNCBINode
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 inherited from CNCBINode
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< TAttributes >	m_Attributes

Detailed Description

Definition at line 41 of file asnwrite.hpp.

Constructor & Destructor Documentation

CAsnWriteNode() [1/2]

CAsnWriteNode::CAsnWriteNode

(

void

)

Definition at line 39 of file asnwrite.cpp.

CAsnWriteNode() [2/2]

CAsnWriteNode::CAsnWriteNode

(

int

mode

)

Definition at line 44 of file asnwrite.cpp.

~CAsnWriteNode()

CAsnWriteNode::~CAsnWriteNode

(

void

)

Definition at line 49 of file asnwrite.cpp.

References m_Out.

Member Function Documentation

GetOut()

AsnIoPtr CAsnWriteNode::GetOut

(

void

)

Definition at line 65 of file asnwrite.cpp.

References m_Mode, m_Out, out(), and WriteAsn().

Referenced by operator AsnIoPtr().

operator AsnIoPtr()

CAsnWriteNode::operator AsnIoPtr ( void  )

inline

Definition at line 49 of file asnwrite.hpp.

References GetOut().

PrintChildren()

CNcbiOstream & CAsnWriteNode::PrintChildren ( CNcbiOstream &  out, TMode  mode  )

virtual

Reimplemented from CNCBINode.

Definition at line 75 of file asnwrite.cpp.

References m_Out, out(), and CNCBINode::PrintChildren().

Member Data Documentation

m_Mode

int CAsnWriteNode::m_Mode

private

Definition at line 60 of file asnwrite.hpp.

Referenced by GetOut().

m_Out

AsnIoPtr CAsnWriteNode::m_Out

private

Definition at line 59 of file asnwrite.hpp.

Referenced by GetOut(), PrintChildren(), and ~CAsnWriteNode().

---

The documentation for this class was generated from the following files:

• include/ctools/asn/asnwrite.hpp
• src/ctools/asn/asnwrite.cpp