PCL
pcl::XMLDocTypeDeclaration Class Reference

XML DOCTYPE declaration More...

#include <XML.h>

+ Inheritance diagram for pcl::XMLDocTypeDeclaration:

Public Member Functions

 XMLDocTypeDeclaration (const String &name=String(), const String &definition=String())
 
 XMLDocTypeDeclaration (const XMLDocTypeDeclaration &)=default
 
const StringDefinition () const
 
bool IsDefined () const
 
const StringName () const
 
void Serialize (IsoString &text) const
 
- Public Member Functions inherited from pcl::XMLComponent
 XMLComponent ()=default
 
 XMLComponent (const XMLComponent &)=default
 
bool IsTopLevel () const
 
XMLElementParentElement () const
 

Detailed Description

XMLDocTypeDeclaration represents a document type declaration in an XML document prolog:

https://www.w3.org/TR/xml11/#dt-doctype

Definition at line 2257 of file XML.h.

Constructor & Destructor Documentation

◆ XMLDocTypeDeclaration() [1/2]

pcl::XMLDocTypeDeclaration::XMLDocTypeDeclaration ( const String name = String(),
const String definition = String() 
)
inline

Constructs a new XMLDocTypeDeclaration object with the specified document type name and type definition.

Definition at line 2265 of file XML.h.

◆ XMLDocTypeDeclaration() [2/2]

pcl::XMLDocTypeDeclaration::XMLDocTypeDeclaration ( const XMLDocTypeDeclaration )
default

Copy constructor.

Member Function Documentation

◆ Definition()

const String& pcl::XMLDocTypeDeclaration::Definition ( ) const
inline

Returns a reference to the (immutable) document type definition.

Definition at line 2288 of file XML.h.

◆ IsDefined()

bool pcl::XMLDocTypeDeclaration::IsDefined ( ) const
inline

Returns true iff this document type declaration has been defined. This function can be used to check if a parsed XML document includes an DOCTYPE declaration.

Definition at line 2298 of file XML.h.

◆ Name()

const String& pcl::XMLDocTypeDeclaration::Name ( ) const
inline

Returns a reference to the (immutable) document type name.

Definition at line 2280 of file XML.h.

◆ Serialize()

void pcl::XMLDocTypeDeclaration::Serialize ( IsoString text) const

Serializes this DOCTYPE declaration with UTF-8 encoding.

The generated serialization will be appended to the specified 8-bit text string, encoded in UTF-8. This function won't generate any characters if no document type name has been defined for this object.


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