# class PipelineBatch

Control object to launch pipelines in batches, both locally and distributed

# Properties

Property Description
CascadedRunMode The run mode to use on cascaded pipelines when executing the pipeline batch.
StoragePath The path to the directory where data is serialized. All pipelines and scenes are serialized in this path as temporary storage. If the path is not explicitly set the pipeline batch will create a temporary directory which will be removed once the pipeline batch object is deallocated, discarding all processed scenes.

# Methods

Method Description
Clear Manually clear the queue.
GetBatchCount Get the number of pipelines queued in the pipeline batch.
GetClass Get the name of the PipelineBatch class.
GetOutputPath Get the path of the serialized output scene for the given batch index.
GetPipelinePath Get the path of the serialized pipeline for the given batch index.
GetScenePath Get the path of the serialized input scene for the given batch index.
IsA Returns true if PipelineBatch is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the PipelineBatch object is invalid.
LoadProcessedScene Load the output scene for the given queue handle. For a cascaded pipeline, use GetCascadedSceneCount/GetCascadedSceneForIndex on the returned scene to get the corresponding cascaded scene output.
Queue Queue a pipeline to process the given scene. Use the returned handle to retrieve the processed scene once the run call completes. The pipeline and scene will be serialized in this function call and any updates to pipeline settings and/or scene data will NOT affect the execution in this pipeline batch.
QueueFile Queue execution of a pipeline on a scene, both given as external files. Use the returned handle to retrieve the processed scene once the run call completes.
Run Run processing on all queued pipelines using the given run mode, either local or distributed, and clear the queue.

# Static methods

Method Description
IsClassA Returns true if the class is a or is a descendant of the class named as the type parameter.
SafeCast SafeCast makes sure the input object is of a class that can be cast into spPipelineBatch, and if this is the case, returns the object cast into spPipelineBatch.

# Properties details

# CascadedRunMode

The run mode to use on cascaded pipelines when executing the pipeline batch.

    # StoragePath

    The path to the directory where data is serialized. All pipelines and scenes are serialized in this path as temporary storage. If the path is not explicitly set the pipeline batch will create a temporary directory which will be removed once the pipeline batch object is deallocated, discarding all processed scenes.

      # Methods details

      # Clear

      Manually clear the queue.

        # GetBatchCount

        Get the number of pipelines queued in the pipeline batch.

          # GetClass

          Get the name of the PipelineBatch class.

            # GetOutputPath

            Get the path of the serialized output scene for the given batch index.

              # GetPipelinePath

              Get the path of the serialized pipeline for the given batch index.

                # GetScenePath

                Get the path of the serialized input scene for the given batch index.

                  # IsA

                  Returns true if PipelineBatch is a or is a descendant of the class named as the type parameter.

                    # IsNull

                    Returns true if the PipelineBatch object is invalid.

                      # LoadProcessedScene

                      Load the output scene for the given queue handle. For a cascaded pipeline, use GetCascadedSceneCount/GetCascadedSceneForIndex on the returned scene to get the corresponding cascaded scene output.

                        # Queue

                        Queue a pipeline to process the given scene. Use the returned handle to retrieve the processed scene once the run call completes. The pipeline and scene will be serialized in this function call and any updates to pipeline settings and/or scene data will NOT affect the execution in this pipeline batch.

                          # QueueFile

                          Queue execution of a pipeline on a scene, both given as external files. Use the returned handle to retrieve the processed scene once the run call completes.

                            # Run

                            Run processing on all queued pipelines using the given run mode, either local or distributed, and clear the queue.

                              # Static methods details

                              # IsClassA

                              Returns true if the class is a or is a descendant of the class named as the type parameter.

                                # SafeCast

                                SafeCast makes sure the input object is of a class that can be cast into spPipelineBatch, and if this is the case, returns the object cast into spPipelineBatch.