itk::DOMTextNode Class Reference

#include <itkDOMTextNode.h>

Inheritance diagram for itk::DOMTextNode:

Collaboration diagram for itk::DOMTextNode:

Detailed Description

Class to represent a special DOM node that holds a text string.

A text node has no attributes and children. So a text node is always a leaf node, and the special attribute "id" cannot be used. In this implementation, a text node is internally represented using a special tag name of "!". This is not a problem as "!" is not a valid tag name in any XML file.

Definition at line 40 of file itkDOMTextNode.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = DOMTextNode
using	Superclass = DOMNode
Public Types inherited from itk::DOMNode
using	AttributeItemType = std::pair< const AttributeKeyType, AttributeValueType >
using	AttributeKeyType = std::string
using	AttributesListType = std::list< AttributeItemType >
using	AttributeValueType = std::string
using	ChildrenListType = std::vector< DOMNode * >
using	ConstChildrenListType = std::vector< const DOMNode * >
using	ConstPointer = SmartPointer< const Self >
using	IdentifierType = int
using	OffsetType = int
using	Pointer = SmartPointer< Self >
using	Self = DOMNode
using	SizeType = std::vcl_size_t
using	Superclass = Object
Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = Object
using	Superclass = LightObject
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual const char *	GetNameOfClass () const
virtual void	SetText (std::string &_arg)
virtual const std::string &	GetText () const
Public Member Functions inherited from itk::DOMNode
virtual void	AddChild (DOMNode *node, IdentifierType i=0)
virtual void	AddChildAtBegin (DOMNode *node)
virtual void	AddChildAtEnd (DOMNode *node)
virtual void	AddTextChild (const std::string &text, IdentifierType i=0)
virtual void	AddTextChildAtBegin (const std::string &text)
virtual void	AddTextChildAtEnd (const std::string &text)
virtual void	GetAllAttributes (AttributesListType &output, bool keepOriginalOrder=true) const
virtual void	GetAllChildren (ChildrenListType &output)
virtual void	GetAllChildren (ConstChildrenListType &output) const
virtual std::string	GetAttribute (const std::string &key) const
virtual void	GetChildren (const std::string &tag, ChildrenListType &output)
virtual void	GetChildren (const std::string &tag, ConstChildrenListType &output) const
virtual SizeType	GetNumberOfChildren () const
virtual std::string	GetPath () const
virtual bool	HasAttribute (const std::string &key) const
virtual void	RemoveAllAttributes ()
virtual void	RemoveAllAttributesAndChildren ()
virtual void	RemoveAllChildren ()
virtual void	RemoveAttribute (const std::string &key)
virtual void	RemoveChild (IdentifierType i=0)
virtual void	SetAttribute (const std::string &key, const std::string &value)
virtual void	SetChild (DOMNode *node, IdentifierType i=0)
virtual void	SetTextChild (const std::string &text, IdentifierType i=0)
virtual bool	ShareRoot (const DOMNode *node) const
virtual void	SetParent (DOMNode *node)
DOMNode *	GetParent ()
const DOMNode *	GetParent () const
virtual void	SetName (std::string &_arg)
virtual const std::string &	GetName () const
virtual void	SetID (std::string &_arg)
virtual const std::string &	GetID () const
virtual DOMNode *	GetChild (IdentifierType i=0)
virtual const DOMNode *	GetChild (IdentifierType i=0) const
virtual DOMNode *	GetChild (const std::string &tag, IdentifierType i=0)
virtual const DOMNode *	GetChild (const std::string &tag, IdentifierType i=0) const
virtual DOMNode *	GetChildByID (const std::string &value)
virtual const DOMNode *	GetChildByID (const std::string &value) const
virtual DOMNode *	GetSibling (OffsetType i)
virtual const DOMNode *	GetSibling (OffsetType i) const
virtual DOMNode *	GetRoot ()
virtual const DOMNode *	GetRoot () const
virtual DOMNode *	Find (const std::string &path)
virtual const DOMNode *	Find (const std::string &path) const
virtual DOMTextNode *	GetTextChild (IdentifierType i=0)
virtual const DOMTextNode *	GetTextChild (IdentifierType i=0) const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexceptoverride
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::DOMNode
static Pointer	New ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Protected Member Functions
	DOMTextNode ()
Protected Member Functions inherited from itk::DOMNode
	DOMNode ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual void	SetTimeStamp (const TimeStamp &time)
	~Object () override
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Attributes
std::string	m_Text

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Member Typedef Documentation

using itk::DOMTextNode::ConstPointer = SmartPointer< const Self >

Definition at line 49 of file itkDOMTextNode.h.

using itk::DOMTextNode::Pointer = SmartPointer< Self >

Definition at line 48 of file itkDOMTextNode.h.

using itk::DOMTextNode::Self = DOMTextNode

Standard class type aliases.

Definition at line 46 of file itkDOMTextNode.h.

using itk::DOMTextNode::Superclass = DOMNode

Definition at line 47 of file itkDOMTextNode.h.

Constructor & Destructor Documentation

itk::DOMTextNode::DOMTextNode ( )

inlineprotected

Definition at line 63 of file itkDOMTextNode.h.

References itk::DOMNode::SetName().

Member Function Documentation

virtual::itk::LightObject::Pointer itk::DOMTextNode::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::DOMNode.

virtual const char* itk::DOMTextNode::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::DOMNode.

virtual const std::string& itk::DOMTextNode::GetText ( ) const

virtual

Functions to set/get the enclosed text of this node.

static Pointer itk::DOMTextNode::New ( )

static

Method for creation through the object factory.

virtual void itk::DOMTextNode::SetText ( std::string &  _arg )

virtual

Functions to set/get the enclosed text of this node.

Member Data Documentation

std::string itk::DOMTextNode::m_Text

private

Variable to hold the text string of this node.

Definition at line 70 of file itkDOMTextNode.h.

---

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

• itkDOMTextNode.h