XML comment section More...

#include <XML.h>

Inheritance diagram for pcl::XMLComment:

Public Member Functions
	XMLComment (const String &comment)

	XMLComment (const XMLComment &)=default

XMLNode *	Clone () const override

const String &	Comment () const

XMLComment &	operator= (const XMLComment &)=default

void	Serialize (IsoString &text, bool autoFormat, char indentChar, unsigned indentSize, unsigned level) const override

Public Member Functions inherited from pcl::XMLNode
	XMLNode (const XMLNode &x)

	XMLNode (node_type type)

	~XMLNode () override

bool	IsChildNode () const

bool	IsComment () const

bool	IsElement () const

bool	IsText () const

const XMLNodeLocation &	Location () const

virtual bool	NLAfter (const XMLNode &previous) const

node_type	NodeType () const

XMLNode &	operator= (const XMLNode &x)

virtual void	SerializeAsHTML (IsoString &text, bool autoFormat, char indentChar, unsigned indentSize, unsigned level) const

Public Member Functions inherited from pcl::XMLComponent
	XMLComponent ()=default

	XMLComponent (const XMLComponent &)=default

virtual	~XMLComponent ()

bool	IsTopLevel () const

XMLElement *	ParentElement () const

Additional Inherited Members
Public Types inherited from pcl::XMLNode
using	node_type = XMLNodeType::mask_type

Detailed Description

The XMLComment class represents a comment in an XML document:

https://www.w3.org/TR/xml11/#sec-comments

Definition at line 2280 of file XML.h.

Constructor & Destructor Documentation

◆ XMLComment() [1/2]

pcl::XMLComment::XMLComment ( const String & comment )

inline

Constructs a new XMLComment object with the specified comment string encoded in UTF-16.

The specified comment must not contain the sequence "--" or end with a '-' character. Any occurrence of these forbidden sequences will be removed for serialization.

Definition at line 2292 of file XML.h.

◆ XMLComment() [2/2]

pcl::XMLComment::XMLComment ( const XMLComment & )

default

Copy constructor.

Member Function Documentation

◆ Clone()

XMLNode* pcl::XMLComment::Clone ( ) const

inlineoverridevirtual

Returns a dynamically allocated copy of this XML node.

Implements pcl::XMLNode.

Definition at line 2319 of file XML.h.

◆ Comment()

const String& pcl::XMLComment::Comment ( ) const

inline

Returns a reference to the (immutable) comment string.

Definition at line 2311 of file XML.h.

◆ operator=()

XMLComment& pcl::XMLComment::operator= ( const XMLComment & )

default

Copy assignment operator. Returns a reference to this object.

◆ Serialize()

void pcl::XMLComment::Serialize	(	IsoString &	text,
		bool	autoFormat,
		char	indentChar,
		unsigned	indentSize,
		unsigned	level
	)		const

overridevirtual

Serializes this XML comment section with UTF-8 encoding.

See XMLNode::Serialize() for information on function parameters.