BatchInfrastructure Interface CATBatClientMonitorCAA

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATBatClientMonitorCAA

Batch Monitoring.
Role: This class allow you to start and monitor a batch

Method Index

o AllowVisuInLocalBatchs(): Allow the batch to access the graphical adapater
Role: This method is to be called if your computer have a graphical adapter A few batches may use the graphical adapter for computation aid.
o GetBatchRC(char*,int&): Retrieves the status of a V5 Batch.
o GetBatchStatus(char*,CATBatchStatus&): Retrieves the status of a V5 Batch.
o GetTheClientMonitorCAA(): Retrieves the static singleton of CATBatClientMonitorCAA class.
o InitializeV5Monitoring(int,char*): Initialize the monitoring mechanism for V5 Batch
Role: This method set the callback mechanism which allow you to monitor a V5 batch.
o KillBatch(char*,char*): Kill a V5 Batch.
o StartV5Batch(CATUnicodeString&,char*,char*): Start a V5 Batch.
o WaitOnMessage(int&,int,int*): Block the current process to wait for incoming Batch monitoring messages
Role: This method make the current process wait for Batch monitoring messages until exitCond is true.

Methods

o AllowVisuInLocalBatchs

public virtual AllowVisuInLocalBatchs(

)

Allow the batch to access the graphical adapater
Role: This method is to be called if your computer have a graphical adapter A few batches may use the graphical adapter for computation aid. You have to decide if you allow this batch to run on your computer by calling this method. If you don't these batches will exit with a RC=7.

o GetBatchRC

public virtual GetBatchRC(		`uuid`,
		`oRC`)

Retrieves the status of a V5 Batch.
Role: This method allows you to get the status of a V5 batch

Parameters:

oUuid: the uuid, identifying the batch.

o GetBatchStatus

public virtual GetBatchStatus(		`uuid`,
		`oStatus`)

Retrieves the status of a V5 Batch.
Role: This method allows you to get the status of a V5 batch

Parameters:

oUuid: the uuid, identifying the batch.

o GetTheClientMonitorCAA

public static GetTheClientMonitorCAA(

)

Retrieves the static singleton of CATBatClientMonitorCAA class.
Role: This method allows you to retrieve the static singleton of CATBatClientMonitorCAA class.

o InitializeV5Monitoring

public virtual InitializeV5Monitoring(		`batch_mode`	`=1`,
		`hostname`	`=NULL`)

Initialize the monitoring mechanism for V5 Batch
Role: This method set the callback mechanism which allow you to monitor a V5 batch.

o KillBatch

public virtual KillBatch(		`uuid`,
		`hostname`	`=NULL`)

Kill a V5 Batch.
Role: This method allows you to kill the V5 Batch process giving in its uuid

Parameters:

oUuid: the uuid, identifying the batch.
hostname: hostname of the computer on which the batch is running.

o StartV5Batch

public virtual StartV5Batch(	`iParam`,
	`oUuid`,
	`iHostname`	`=NULL`)

Start a V5 Batch.
Role: This method allows you to launch a batch giving its XML parameter file path.

Parameters:

iPram: Full path of the XML parameter file which may have been generated using CATBatchParameters API
oUuid: the uuid, identifying the batch.

o WaitOnMessage

public virtual WaitOnMessage(	`exitCond`,
	`timeout`	`=-1`,
	`reserved`	`=NULL`)

Block the current process to wait for incoming Batch monitoring messages
Role: This method make the current process wait for Batch monitoring messages until exitCond is true. This method is mandatory if you want to receive notification from the Batch infrastructure.

This object is included in the file: CATBatClientMonitorCAA.h
If needed, your Imakefile.mk should include the module: CATBatCliMonitor