FFpBatchExport Class Reference

Class managing auto-export of curve data for batch executions. More...

#include <FFpBatchExport.H>

Collaboration diagram for FFpBatchExport:

Public Member Functions
	FFpBatchExport (const std::vector< std::string > &frsFiles)
	The constructor initializes myExtractor. More...
	~FFpBatchExport ()
	The destructor releases the heap-allocated data objects. More...
bool	readCurves (const std::string &defFile)
	Reads the curve definitions from a specified model file. More...
bool	exportCurves (const std::string &path, const std::string &modelFile, int format)
	Exports curves as separate two-column files. More...
bool	exportGraph (const std::string &fName, const std::string &modelFile, int format, const FFpRPC3Data &rpc)
	Exports curves as a single multi-column file. More...
bool	printPosition (const std::string &fName="")
	Prints position data for the curve data variables (for debugging). More...

Static Public Member Functions
static bool	readFrsFiles (std::vector< std::string > &frsFiles, const std::string &modelFile)
	Reads a list of frs-files with results from specified model file. More...

Private Member Functions
void	readPlottingData (FFpGraph &rdbCurves)
	Reads the curve data to be exported. More...

Private Attributes
FFrExtractor *	myExtractor
	Extractor object holding the results data. More...
std::vector< FFpCurveDef * >	myCurves
	Curve definition container. More...

Detailed Description

Class managing auto-export of curve data for batch executions.

Constructor & Destructor Documentation

FFpBatchExport()

FFpBatchExport::FFpBatchExport

(

const std::vector< std::string > &

frsFiles

)

The constructor initializes myExtractor.

Parameters

[in]

frsFiles

List of frs-files to read curve data from

~FFpBatchExport()

FFpBatchExport::~FFpBatchExport

(

)

The destructor releases the heap-allocated data objects.

Member Function Documentation

exportCurves()

bool FFpBatchExport::exportCurves	(	const std::string &	path,
		const std::string &	modelFile,
		int	format
	)

Exports curves as separate two-column files.

Parameters

[in]	path	Prefix of the exported curve data files.
[in]	modelFile	Fedem model file (for curve data file header)
[in]	format	Format of the exported curve files.

exportGraph()

bool FFpBatchExport::exportGraph	(	const std::string &	fName,
		const std::string &	modelFile,
		int	format,
		const FFpRPC3Data &	rpc
	)

Exports curves as a single multi-column file.

Parameters

[in]	fName	Name of the exported curve data file.
[in]	modelFile	Fedem model file (for curve data file header)
[in]	format	Format of the exported curve file.
[in]	rpc	RPC3-file meta data

printPosition()

bool FFpBatchExport::printPosition

(

const std::string &

fName = ""

)

Prints position data for the curve data variables (for debugging).

Parameters

[in]

fName

Optional file to print to, if empty use std::cout.

readCurves()

bool FFpBatchExport::readCurves

(

const std::string &

defFile

)

Reads the curve definitions from a specified model file.

Parameters

[in]

defFile

The Fedem model file to read curve definitions from

readFrsFiles()

bool FFpBatchExport::readFrsFiles ( std::vector< std::string > &  frsFiles, const std::string &  modelFile  )

static

Reads a list of frs-files with results from specified model file.

Parameters

[out]	frsFiles	List of frs-files associated with the model file.
[in]	modelFile	The Fedem model file to extract frs-file names from

readPlottingData()

void FFpBatchExport::readPlottingData ( FFpGraph &  rdbCurves )

private

Reads the curve data to be exported.

Parameters

[out]

rdbCurves

Container holding all curve data to be exporte

Member Data Documentation

myCurves

std::vector<FFpCurveDef*> FFpBatchExport::myCurves

private

Curve definition container.

myExtractor

FFrExtractor* FFpBatchExport::myExtractor

private

Extractor object holding the results data.

---

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

• fedem-foundation/src/FFpLib/FFpExport/FFpBatchExport.H
• fedem-foundation/src/FFpLib/FFpExport/FFpBatchExport.C