#include <DriverInfo.h>

Public Attributes
ExceptionCode(*	Info )(Instance driverObj, DriverInfo info, const char *settings)

void(*	DisposeInfo )(DriverInfo *info)

void (	CreateSession )(Instance driverObj, const DriverMethods methods, const char deviceURL)

void(*	DisposeSession )(Instance driverObj, void obj)

void(*	PrinterStatus )(Instance driverObj, ACPL::XML statusDict)

void(*	GetPrivateCacheData )(Instance *driverObj, ACPL::Stream &outStream)

void(*	SetPrivateCacheData )(Instance *driverObj, ACPL::Stream &inStream)

bool(*	UpdateDriver )(Instance driverObj, const char proxy, uint8_t region, void *hostObj, DriverInitCB progressCB)

void(*	SetHostInterface )(Instance driverObj, const char hostName, void hostObj, bool(hostCB)(void *hostObj, ACPL::XML &query, ACPL::XML &response))

bool(*	PrinterQuery )(Instance *driverObj, ACPL::XML &query, ACPL::XML &response)

bool(*	StartJobTracking )(Instance *driverObj)

const ACPL::StringList &(*	GetInkset )(Instance *driverObj)

Detailed Description

Instance methods

The instance method exported by the driver. The entries might be NULL and are thus not supported. This means the call can ommitted and the next call in the calling order should be executed (see below).

Definition at line 1374 of file DriverInfo.h.

Member Data Documentation

◆ CreateSession

void *(* aur::ADA::InstanceMethods::CreateSession) (Instance *driverObj, const DriverMethods **methods, const char *deviceURL)

This function is called to create an instance of the driver for the given model. This function is not called when information about the driver is queried (like media sizes) only when a job has to be processed.

The CreateSession function supplies the RIP with a reference to an object. This reference is opaque to the RIP. This means that the RIP does not know the definition of the object. The RIP uses this reference only as a reference of the driver and has only a meaning to the driver it self (e.g. it might be the address of a C++ object or a structure in memory to hold information needed during processing) The Create function also supplies a pointer to a table of routine pointers. Those routines are called during the processing of the job. Every routine has as first parameter the aforementioned reference.

Parameters

driverObj	Reference to the printer object obtained from PrinterIntitialize.
methods	Pointer that receives the pointer to the DriverMethods table of the driver.
deviceURL	URL that describes the connection to be used. When NULL is specified then the default URI will be used. Only used for folder based devices.

Returns: Opaque driver reference to be used with all driver methods and Dispose.

See also: DisposeSession, DriverMethods

Definition at line 1418 of file DriverInfo.h.

◆ DisposeSession

void(* aur::ADA::InstanceMethods::DisposeSession) (Instance *driverObj, void *obj)

This function is called when the RIP is done using the instance of the driver after processing a job.

Parameters

obj	Opaque driver reference returned by Create().

See also: CreateSession

Definition at line 1425 of file DriverInfo.h.

◆ GetInkset

const ACPL::StringList &(* aur::ADA::InstanceMethods::GetInkset) (Instance *driverObj)

Returns the default inkset of printer. This could be defined using deviceScript script. Having a deviceScript does not dictate that an inkset is defined. When not defined the result is null or an empty list.

Parameters

driverObj Reference to the printer object obtained from PrinterIntitialize.

Returns: Reference to a string list naming the inks in the order the Info call will return. An empty list means there is no inkset defined by the deviceScript.

Definition at line 1511 of file DriverInfo.h.

◆ GetPrivateCacheData

void(* aur::ADA::InstanceMethods::GetPrivateCacheData) (Instance *driverObj, ACPL::Stream &outStream)

GetPrivateCacheData retrieves information stored by the driver in its private cache to allow it to be retained. This private data can be cached information from the actual printer to speed-up the queries or to build the proper content of the DriverInfo structure (like medias installed at the printer).

Parameters

driverObj	Reference to the printer object obtained from PrinterIntitialize.
outStream	Empty stream that receives that private cache data that is used to initialize this printer instance.

See also: SetPrivateCacheData

Definition at line 1446 of file DriverInfo.h.

◆ Info

ExceptionCode(* aur::ADA::InstanceMethods::Info) (Instance *driverObj, DriverInfo *info, const char *settings)

The Info function supplies the RIP with all needed information about the device like:

Descriptive information like DPI, sizes and inks.
Media sizes and trays
Communication methods available for this device
An XML that generates the user interface for the device specific settings

Parameters

driverObj	Reference to the printer object obtained from PrinterIntitialize.
info	Initialized info class that will receive the driver
settings	XML containing the driver settings. When an empty string is supplied the default settings are used to fill the DriverInfo

Definition at line 1388 of file DriverInfo.h.

◆ PrinterQuery

bool(* aur::ADA::InstanceMethods::PrinterQuery) (Instance *driverObj, ACPL::XML &query, ACPL::XML &response)

Query used to by pass the workflow component. Used by the Calibrator/Profiler to access build-in photospectrometers. The implementation is device dependend, the API is generalization of the process.

Parameters

	driverObj	Reference to the printer object obtained from PrinterIntitialize.
[in]	query	Query to the device.
[out]	response	Response from the device.

Returns: True when succesful or false when failed/

Definition at line 1494 of file DriverInfo.h.

◆ PrinterStatus

void(* aur::ADA::InstanceMethods::PrinterStatus) (Instance *driverObj, ACPL::XML *statusDict)

PrinterStatus returns information about the printer ink levels and loaded media if the routine is available and the printer supports this information. The data is returned in XML form containing all the information available, if the printer is not supporting a certain type of feedback the XML will not contain the keywords.

Parameters

driverObj	Reference to the printer object obtained from PrinterIntitialize.
obj	Opaque driver reference returned by Create().
statusDict	XML DOM containing the status information on return, documentation of the keyword can be found in the xds

Definition at line 1436 of file DriverInfo.h.

◆ SetHostInterface

void(* aur::ADA::InstanceMethods::SetHostInterface) (Instance *driverObj, const char *hostName, void *hostObj, bool(*hostCB)(void *hostObj, ACPL::XML &query, ACPL::XML &response))

SetHostInterface provides a callback mechanism for the driver to call specific functions in the hosting application. The call is generalized in an XML query and XML response, the provided functionality through this API is host specific and can't be trusted to be available in every host.

Parameters

driverObj	Reference to the printer object obtained from PrinterIntitialize.
hostName	Name to identify the host, this can be used by the driver to determine which API is available.
hostObj	Reference to the host object, this needs to be provided by every call to the host-callback routine.
hostCB	Routine pointer providing query-XML as input and response-XML as output XML. Return value true means success and false that the API is not available or the call failed.

Definition at line 1483 of file DriverInfo.h.

◆ SetPrivateCacheData

void(* aur::ADA::InstanceMethods::SetPrivateCacheData) (Instance *driverObj, ACPL::Stream &inStream)

SetPrivateCacheData stored retained private information used by the driver to overwrite its private cache. This private data can be cached information from the actual printer to speed-up the queries or to build the proper content of the DriverInfo structure (like medias installed at the printer).

Parameters

driverObj	Reference to the printer object obtained from PrinterIntitialize.
inStream	Stream with its marker set to the start of the stream and contain the private cache data that is used to initialize this printer instance. The data is obtained earlier using GetPrivateCacheData.

See also: GetPrivateCacheData

Definition at line 1457 of file DriverInfo.h.

◆ StartJobTracking

bool(* aur::ADA::InstanceMethods::StartJobTracking) (Instance *driverObj)

Start Job Tracking. If the driver is capable of tracking job (see caps jobStatusTracking) then this can be called to start the jobStatusTracker. Updates are pushed to the host callback routine.

Parameters

driverObj Reference to the printer object obtained from PrinterIntitialize.

Returns: True when succesful or false when failed

Definition at line 1502 of file DriverInfo.h.

◆ UpdateDriver

bool(* aur::ADA::InstanceMethods::UpdateDriver) (Instance *driverObj, const char *proxy, uint8_t region, void *hostObj, DriverInitCB progressCB)

PrinterUpdateDriver is to be called directly after PrinterInitialize to update modes, definitions or complete drivers. This is an option method.

Parameters

[in]	driverObj	Reference to the printer object obtained from PrinterIntitialize.
[in]	proxy	URL to the proxy to use for http communication. If not specified (NULL or empty string) then direct internet access is assumed.
[in]	region	Region code: 0 = international, 1 = PRC China
[in]	hostObj	Reference to the host object, this needs to be provided by every call to the host-callback routine.
[in]	progressCB	Routine pointer providing status XML to the host reporting on the init progress. Return value true means success and false that the initialization is to be aborted.

Returns: True if the update has been executed succesfully.

Definition at line 1471 of file DriverInfo.h.

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

D:/Environments/desktop6/Source/ADA/DriverInfo.h

Public Attributes

Detailed Description

Member Data Documentation

◆ CreateSession

◆ DisposeSession

◆ GetInkset

◆ GetPrivateCacheData

◆ Info

◆ PrinterQuery

◆ PrinterStatus

◆ SetHostInterface

◆ SetPrivateCacheData

◆ StartJobTracking

◆ UpdateDriver