BatchInfrastructure CATBatStatePubCAA
Usage: you must use this class as is. You should never derive it.
public class CATBatStatePubCAA
Batch state Publishing.
Role: This class allow your batch to publish its state .
It can be used in your batch to send sate messages to the batch monitor.
Method Index
- o
GetCAAStatePub()
- Retrieves the CATBatStatePubCAA singleton.
- o
SetBatchState(int)
- Publish the state of your batch.
- o
SetLicenceState(int)
- Publish the licencing state of your batch.
Methods
o GetCAAStatePub
| public static GetCAAStatePub( | ) |
-
Retrieves the CATBatStatePubCAA singleton. Do not call the constructor.
Role: This method creates and/or retrieves the unique instance of CATBatStatePubCAA.
o SetBatchState
| public virtual SetBatchState( | | state) |
-
Publish the state of your batch.
Role: This method allows you to send to tha batch monitor a completion percentage for your batch (from 1 to 100);
This number will be displayed in the batch monitor UI.
- Parameters:
-
- state
- percentage of completion
o SetLicenceState
| public virtual SetLicenceState( | | OK) |
-
Publish the licencing state of your batch.
Role: This method allows you to send a notification to the batch monitor containing its licence status
1 means the batch has the licences it needs to run
0 means the taken licences does not allow to run this batch. In this case an error is displayed in the batch monitor.
- Parameters:
-
- OK
- licence state of the batch
This object is included in the file: CATBatStatePubCAA.h
If needed, your Imakefile.mk should include the module: CATBatProtocol
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.