PCL
pcl::XMLComment Class Reference

XML comment section More...

#include <XML.h>

+ Inheritance diagram for pcl::XMLComment:

Public Member Functions

 XMLComment (const String &comment)
 
 XMLComment (const XMLComment &)=default
 
const StringComment () const
 
void Serialize (IsoString &text, bool autoFormat, char indentChar, unsigned indentSize, unsigned level) const override
 
- Public Member Functions inherited from pcl::XMLNode
 XMLNode (node_type type)
 
 XMLNode (const XMLNode &x)
 
virtual ~XMLNode ()
 
bool IsChildNode () const
 
bool IsComment () const
 
bool IsElement () const
 
bool IsText () const
 
const XMLNodeLocationLocation () const
 
virtual bool NLAfter (const XMLNode &previous) const
 
node_type NodeType () const
 
- Public Member Functions inherited from pcl::XMLComponent
 XMLComponent ()=default
 
 XMLComponent (const XMLComponent &)=default
 
bool IsTopLevel () const
 
XMLElementParentElement () const
 

Additional Inherited Members

- Public Types inherited from pcl::XMLNode
typedef XMLNodeType::mask_type node_type
 

Detailed Description

The XMLComment class represents a comment in an XML document:

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

Definition at line 2053 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 2065 of file XML.h.

◆ XMLComment() [2/2]

pcl::XMLComment::XMLComment ( const XMLComment )
default

Copy constructor.

Member Function Documentation

◆ Comment()

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

Returns a reference to the (immutable) comment string.

Definition at line 2079 of file XML.h.

◆ 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.

Implements pcl::XMLNode.


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