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

#include <xmlWrapper.hpp>

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

Public Member Functions

 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

string filePath
 Path of the file containing this element.
 
const size_t line
 
const size_t offsetInLine
 
const size_t offset
 

Detailed Description

Stores the source file path, and position in the file of a xml attribute.

Definition at line 74 of file xmlWrapper.hpp.

Constructor & Destructor Documentation

◆ xmlAttributePos()

geos::xmlWrapper::xmlAttributePos::xmlAttributePos ( string const &  filePath,
size_t  line,
size_t  offsetInLine,
size_t  offset 
)

Constructor of this struct.

Parameters
filePaththe path of the original xml file containing this attribute
lineLine where the element is defined. Start at 1.
offsetInLineCharacter offset of this element in the line that contains it (starting from 1)
offsetCharacter offset of this element in the file that contains it (starting from 0)

Member Function Documentation

◆ isFound()

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

◆ toString()

string geos::xmlWrapper::xmlAttributePos::toString ( ) const
Returns
a string containing the file name and position in the file.

Member Data Documentation

◆ line

const size_t geos::xmlWrapper::xmlAttributePos::line

Line where the element is defined. Start at 1. Default value is xmlDocument::npos

Definition at line 80 of file xmlWrapper.hpp.

◆ offset

const size_t geos::xmlWrapper::xmlAttributePos::offset

Character offset of this element in the file that contains it (starting from 0) Equals to xmlDocument::npos if it couldn't be determined.

Definition at line 86 of file xmlWrapper.hpp.

◆ offsetInLine

const size_t geos::xmlWrapper::xmlAttributePos::offsetInLine

Character offset of this element in the line that contains it (starting from 1) Equals to xmlDocument::npos if it couldn't be determined.

Definition at line 83 of file xmlWrapper.hpp.


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