All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
XmlReadOptions Class Reference

#include <XmlIo.h>

Public Member Functions

 XmlReadOptions ()
 ~XmlReadOptions ()

Public Attributes

bool readComments
bool readNewlines
bool upgradeVersion
XmlReadFunction readXIncludeFunction
StringVec parentXIncludes

Detailed Description

A set of options for controlling the behavior of XML read functions.

Definition at line 31 of file XmlIo.h.

Constructor & Destructor Documentation

XmlReadOptions::XmlReadOptions ( )
XmlReadOptions::~XmlReadOptions ( )

Definition at line 35 of file XmlIo.h.

Member Data Documentation

StringVec XmlReadOptions::parentXIncludes

The vector of parent XIncludes at the scope of the current document. Defaults to an empty vector.

Definition at line 55 of file XmlIo.h.

bool XmlReadOptions::readComments

If true, then XML comments will be read into documents as comment elements. Defaults to false.

Definition at line 39 of file XmlIo.h.

bool XmlReadOptions::readNewlines

If true, then XML newlines will be read into documents as newline elements. Defaults to false.

Definition at line 43 of file XmlIo.h.

XmlReadFunction XmlReadOptions::readXIncludeFunction

If provided, this function will be invoked when an XInclude reference needs to be read into a document. Defaults to readFromXmlFile.

Definition at line 51 of file XmlIo.h.

bool XmlReadOptions::upgradeVersion

If true, then documents from earlier versions of MaterialX will be upgraded to the current version. Defaults to true.

Definition at line 47 of file XmlIo.h.

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