Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Attributes | List of all members
GML_error Struct Reference

Reason and position of an error in a GML file. More...

#include <JETSCAPE/blob/main/external_packages/gtl/include/GTL/gml_scanner.h>

Public Attributes

GML_error_value err_num
 
int line
 
int column
 

Detailed Description

Reason and position of an error in a GML file.

When an error occurs while parsing the structure of a GML file GML_error is used to return the type and position of the error detected. Position is specified by line and column, but might be somewhat imprecise. However at least the line number should not differ too much from the real position.

See Also
graph::load

Definition at line 52 of file gml_scanner.h.

View newest version in sPHENIX GitHub at line 52 of file gml_scanner.h

Member Data Documentation

int GML_error::column

Contains the column, where the error was detected.

Definition at line 89 of file gml_scanner.h.

View newest version in sPHENIX GitHub at line 89 of file gml_scanner.h

Referenced by GML_parser(), and GML_scanner().

GML_error_value GML_error::err_num

Contains the error description as symbolic constant:

  • GML_FILE_NOT_FOUND: A file with that name doesn't exist.
  • GML_OK: No error :-)
  • GML_TOO_MANY_BRACKETS: A mismatch of brackets was detected, i.e. there were too many closing brackets (]).
  • GML_OPEN_BRACKET: Now, there were too many opening brackets ([)
  • GML_TOO_MANY_DIGITS: The number of digits a integer or floating point value can have is limited to 1024, this should be enough :-)
  • GML_PREMATURE_EOF: An EOF occured, where it wasn't expected, e.g. while scanning a string.
  • GML_SYNTAX: The file isn't a valid GML file, e.g. a mismatch in the key-value pairs.
  • GML_UNEXPECTED: A character occured, where it makes no sense, e.g. non-numerical characters in numbers or keys beginning with numbers

Definition at line 77 of file gml_scanner.h.

View newest version in sPHENIX GitHub at line 77 of file gml_scanner.h

Referenced by GML_parser(), GML_scanner(), graph::load(), and main().

int GML_error::line

Contains the line, where the error was detected. This will usually be near the line where the error really is located.

Definition at line 84 of file gml_scanner.h.

View newest version in sPHENIX GitHub at line 84 of file gml_scanner.h

Referenced by item.Item::__eq__(), item.Item::__hash__(), GML_parser(), and GML_scanner().

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