rmreport.h File Reference

Simplified Scalable RIP Raster Manager reporting for raster backends that produce files. More...

#include "skintest.h"
#include "ripapiversn.h"
#include "rmoutputapi.h"
#include "swdevice.h"
#include "skinras.h"

Functions
sw_rmoutput_api_20190618 *	get_rm_output_api (void)
	Return the Raster Manager output API, if it is registered. More...
HqBool	ripfarm_report_raster (DEVICELIST *dev, uint8 *filename, const char *filetype, const char *metadata, RasterDescription *rd, sw_rmoutput_handled_fn *handled_fn, void *handled_data)
	Send raster information for an output file to the Scalable RIP raster manager for collation. More...

Detailed Description

Simplified Scalable RIP Raster Manager reporting for raster backends that produce files.

Function Documentation

get_rm_output_api()

sw_rmoutput_api_20190618* get_rm_output_api

(

void

)

Return the Raster Manager output API, if it is registered.

This API will only be registered for Farm RIPs in a Scalable RIP system, so don't try more than once.

Returns

The Raster Manager output API pointer, if registered, or NULL if not.

ripfarm_report_raster()

HqBool ripfarm_report_raster	(	DEVICELIST *	dev,
		uint8 *	filename,
		const char *	filetype,
		const char *	metadata,
		RasterDescription *	rd,
		sw_rmoutput_handled_fn *	handled_fn,
		void *	handled_data
	)

Send raster information for an output file to the Scalable RIP raster manager for collation.

Parameters

[in]	dev	The device that filename was saved on. If this is NULL, then the filename is used directly as the raster name to report to the raster manager.
[in]	filename	The filename to report to the raster manager. If this is NULL, then a blank page is being reported.
[in]	filetype	The data type reported to the raster manager.
[in]	metadata	The metadata reported to the raster manager.
[in]	rd	The RasterDescription used to produce this page. This is used to determine details of the job number, page numbers, and whether the raster is complete or not.
[in]	handled_fn	An optional callback function, called when the raster manager has handled this page.
[in]	handled_data	A data pointer for handled_fn.

Return values

TRUE	The raster was reported to the Scalable RIP Raster Manager successfully.
FALSE	The raster could not be created, or could not be reported as ready for output.

This is a simplified function for interfacing to the Scalable RIP Raster Manager for raster backends that store their output in files. It is useful as an example of how to interface with the Raster Manager. In particular, it make the assumptions:

• The name reported to the raster manager is a platform filename, valid on this machine only.
• The location reported to the raster manager is the blade ID.
• There are no callbacks for blank pages.