carputils
Doxygen code documentation for the python framework controlling openCARP
Public Member Functions | List of all members
carputils.cml.cmlparser.CMLParserYAML Class Reference

Class to parse YAML strings. More...

Inheritance diagram for carputils.cml.cmlparser.CMLParserYAML:
carputils.cml.cmlparser.CMLParser

Public Member Functions

def __init__ (self, emptyValue=None)
 Method to initialize a CMLParserYAML object. More...
 
def parsef (self, fp)
 Parse a YAML file. More...
 
def parses (self, string)
 Parse a YAML string. More...
 
def parsel (self, lines)
 Parse a YAML strings. More...
 
- Public Member Functions inherited from carputils.cml.cmlparser.CMLParser
def __init__ (self)
 
def parsef (self, fp)
 Parse a file. More...
 
def parses (self, string)
 Parse a string. More...
 
def parsel (self, lines)
 Parse lines. More...
 

Detailed Description

Class to parse YAML strings.

Constructor & Destructor Documentation

◆ __init__()

def carputils.cml.cmlparser.CMLParserYAML.__init__ (   self,
  emptyValue = None 
)

Method to initialize a CMLParserYAML object.

Parameters
empty_valuedefault value for empty nodes

Member Function Documentation

◆ parsef()

def carputils.cml.cmlparser.CMLParserYAML.parsef (   self,
  fp 
)

Parse a YAML file.

Parameters
fpFile pointer to the YAML file to be parsed
Exceptions
AttributeError
Returns
A cmltree.CMLDictBranch representing the root node of the parsed code

◆ parsel()

def carputils.cml.cmlparser.CMLParserYAML.parsel (   self,
  lines 
)

Parse a YAML strings.

Parameters
linesYAML lines to be parsed
Exceptions
AttributeError
Returns
A cmltree.CMLDictBranch representing the root node of the parsed code

◆ parses()

def carputils.cml.cmlparser.CMLParserYAML.parses (   self,
  string 
)

Parse a YAML string.

Parameters
stringYAML string to be parsed
Exceptions
AttributeError
Returns
A cmltree.CMLDictBranch representing the root node of the parsed code

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