PCL
pcl::XMLNodeLocation Struct Reference

Source code location of a parsed XML document node. More...

#include <XML.h>

Public Member Functions

 XMLNodeLocation ()=default
 
 XMLNodeLocation (int line_, int column_)
 
 XMLNodeLocation (const XMLNodeLocation &)=default
 
String ToString () const
 

Public Attributes

int64 column = 0
 
int64 line = 0
 

Detailed Description

Definition at line 429 of file XML.h.

Constructor & Destructor Documentation

◆ XMLNodeLocation() [1/3]

pcl::XMLNodeLocation::XMLNodeLocation ( )
default

Default constructor. Initializes the line and column members to -1, signaling an undefined source code location.

◆ XMLNodeLocation() [2/3]

pcl::XMLNodeLocation::XMLNodeLocation ( int  line_,
int  column_ 
)
inline

Constructs an XMLNodeLocation object with the specified zero-based text line and column numbers.

Definition at line 460 of file XML.h.

◆ XMLNodeLocation() [3/3]

pcl::XMLNodeLocation::XMLNodeLocation ( const XMLNodeLocation )
default

Copy constructor.

Member Function Documentation

◆ ToString()

String pcl::XMLNodeLocation::ToString ( ) const

Returns a string representation of this XMLNodeLocation object in the form " (line=n offset=m)", where n and m are, respectively, the one-based line number and zero-based text character offset transported by this object. This representation is suitable to be included directly in warning or error messages generated by parsers.

The line number token won't be generated if the text line number is undefined (< 0) in this object. Similarly, the offset token won't be generated if the column member is < 0. If no location information is available, this member function returns an empty string.

Member Data Documentation

◆ column

int64 pcl::XMLNodeLocation::column = 0

Zero-based text column number, counted from the starting character of a text line, where a parsed node has been identified in an XML document. This member is -1 if text location information is not available.

Note that the value stored in this field is actually a character index, not necessarily a valid text column number. It is an actual column number only if the corresponding line of text does not contain tabulator characters (#x9). If there are tabulators, there is usually no one-to-one correspondence between characters and represented text columns.

Definition at line 448 of file XML.h.

◆ line

int64 pcl::XMLNodeLocation::line = 0

Zero-based text line number where a parsed node has been identified in an XML document, or -1 if text location information is not available.

Definition at line 435 of file XML.h.


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