All Frameworks  Class Hierarchy  This Framework  Next  Indexes

BatchInfrastructure Interface CATBatClientMonitorCAA

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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*)
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 HRESULT AllowVisuInLocalBatchs()=0
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 HRESULT GetBatchRC(char* uuid,
int& oRC)=0
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 HRESULT GetBatchStatus(char* uuid,
CATBatchStatus& oStatus)=0
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 CATBatClientMonitorCAA* 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 HRESULT InitializeV5Monitoring(int batch_mode=1,
char* hostname=NULL)=0
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 HRESULT KillBatch(char* uuid)=0
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.
o StartV5Batch
public virtual HRESULT StartV5Batch(CATUnicodeString& iParam,
char* oUuid,
char* iHostname=NULL)=0
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 HRESULT WaitOnMessage(int& exitCond,
int timeout=-1,
int* reserved=NULL)=0
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

Copyright © 2003, Dassault Systèmes. All rights reserved.