GEOSX
Public Member Functions | Public Attributes | List of all members
geos::xmlWrapper::xmlNodePos Struct Reference

#include <xmlWrapper.hpp>

Inheritance diagram for geos::xmlWrapper::xmlNodePos:
Inheritance graph
[legend]

Public Member Functions

 xmlNodePos (xmlDocument const &document, string const &filePath, size_t line, size_t offsetInLine, size_t offset)
 Constructor of this struct. More...
 
bool isFound () const
 
xmlAttributePos getAttributeLine (string const &attName) const
 Compute the xmlAttributePos of an xml attribute. More...
 
- Public Member Functions inherited from geos::xmlWrapper::xmlAttributePos
 xmlAttributePos (string const &filePath, size_t line, size_t offsetInLine, size_t offset)
 Constructor of this struct. More...
 
bool isFound () const
 
string toString () const
 

Public Attributes

const xmlDocumentdocument
 Reference of the main xmlDocument that contains all original file buffers.
 
- Public Attributes inherited from geos::xmlWrapper::xmlAttributePos
string filePath
 Path of the file containing this element.
 
const size_t line
 
const size_t offsetInLine
 
const size_t offset
 

Detailed Description

Used to retrieve the position of dataRepository::Wrapper in XML

Definition at line 111 of file xmlWrapper.hpp.

Constructor & Destructor Documentation

◆ xmlNodePos()

geos::xmlWrapper::xmlNodePos::xmlNodePos ( xmlDocument const &  document,
string const &  filePath,
size_t  line,
size_t  offsetInLine,
size_t  offset 
)

Constructor of this struct.

Parameters
documentan xml document containing this node, or including a file which includes it
filePaththe path of the original xml file containing this node
lineLine where the node is defined. Start at 1.
offsetInLineCharacter offset of this node in the line that contains it (starting from 1)
offsetCharacter offset of this node in the file that contains it (starting from 0)

Member Function Documentation

◆ getAttributeLine()

xmlAttributePos geos::xmlWrapper::xmlNodePos::getAttributeLine ( string const &  attName) const

Compute the xmlAttributePos of an xml attribute.

Parameters
attNamethe name of the attribute to locate
Returns
an xmlAttributePos object that represents the position of the target node.

◆ isFound()

bool geos::xmlWrapper::xmlNodePos::isFound ( ) const
Returns
false if the position is undefined.

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