IO::BulkParser Class Reference

#include <BulkParser.h>

List of all members.

Public Member Functions
	BulkParser ()
	~BulkParser (void)
StructureObject *	parseBulk (XMLParser &rParser, string bulkType, StructureObject *pPrevStructureObject, vector< float > &rLambda, float xmax, float ymax)
void	parseBulkGenerate (XMLParser &rParser, string type)

---

Detailed Description

Class responsible for parsing bulk elements in the specification XML file. To add support for a new type of bulk, add a new method conforming to bulkParsePtr signature and add it to the map in the constructor of this class. The new method will then be invoked automatically when that type of bulk is encountered in the specification file.

Author:

Mikael Lindquister

Version:

2008-11-25

---

Constructor & Destructor Documentation

BulkParser::BulkParser

(

)

Class constructor.

BulkParser::~BulkParser

(

void

)

Class destructor.

---

Member Function Documentation

StructureObject * BulkParser::parseBulk	(	XMLParser &	rParser,
		string	bulkType,
		StructureObject *	pPrevStructureObject,
		vector< float > &	rLambda,
		float	xmax,
		float	ymax
	)

Parses the bulk element with the type specified and returns a pointer to the bulk that was created. The parsers state will be advanced to the end tag of the bulk element after this method has returned.

Parameters:

rParser	pointer to the XML stream, it should be at the start tag of the bulk.
bulkType	of the bulk.
prev	a pointer to the previous paper object.
type	type of the bulk to be parsed.
rLambda	the wavelengths to be simulated.
xmax	size in the x direction of the simulation volume.
ymax	size in the y direction of the simulation volume.

Returns:

pointer to the paper object that was created by this method.

Here is the call graph for this function:

void BulkParser::parseBulkGenerate	(	XMLParser &	rParser,
		string	type
	)

Parses the bulk element with the type specified and generates a static basesheet based on the input specifications.

Parameters:

parser	pointer to the XML stream.
type	type of the static basesheet.

Here is the call graph for this function:

---

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

• OpenPaperOpt/BulkParser.h
• OpenPaperOpt/BulkParser.cpp