BatchSyncOption Property

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Syntax

Step.BatchSyncOption

Data Type

BatchSynchronizationOptions

Use the following constants with this data type:

  • BatchSyncOption_NoSync–(Value: 2) No batch synchronization is used on this step.
  • BatchSyncOption_OneThreadOnly–(Value: 5) Use a One Thread Only section to specify that only one thread in the batch executes the single step or the steps in the section. Typically, you use this type of section to perform an operation that applies to the batch as a whole, such as raising the temperature in a test chamber. When all threads in a batch arrive at their respective instances of the single step or an Enter step for a One Thread Only section, TestStand releases only the thread with the lowest order number. When that thread executes the single step or arrives at the Exit step for the section, all remaining threads in the batch skip the single step or jump from the Enter step to the Exit step, skipping steps within the section. The threads in the batch then continue and exit the section together.
  • BatchSyncOption_Parallel–(Value: 4) When all threads in the batch arrive at their respective instances of a single step or an Enter step for a Parallel section, TestStand releases all the threads at once. Each thread blocks after executing the single step or after reaching the Exit step for the section until all threads can continue and exit the section together.
  • BatchSyncOption_Serial–(Value: 3) Use a Serial section to ensure that each thread in the batch executes a single step sequentially or the steps in a section sequentially and in the order you specified when you created the batch. When all threads in a batch arrive at their respective instances of a single step or an Enter step for a Serial section, TestStand releases one thread at a time in ascending order according to the order number you assign to threads when you added them to the batch using the Batch Specification step type. As each thread executes the single step or reaches the Exit step for the section, the next thread in the batch executes the single step or proceeds from the Enter step. After all threads in the batch execute the single step or arrive at the Exit step, they continue and exit the section together.
  • BatchSyncOption_UseModelSetting–(Value: 1) Uses the same option the model is using.
  • BatchSyncOption_UseSeqFileSetting–(Value: 0) Uses the same option the sequence file is using.

Purpose

Specifies the Batch Synchronization operation that the step enters before it executes and exits after it completes.


See Also

Step.MutexNameOrRefExpr

Step.UseMutex

WAS THIS ARTICLE HELPFUL?

Not Helpful