Skip to content
On this page

class PipelineBatch

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

Properties

PropertyDescription
CascadedRunModeThe run mode to use on cascaded pipelines when executing the pipeline batch.
NameThe name of the PipelineBatch object. (Inherited from Object)
SimplygonBatchPathThe path for the batch tool used when executing pipelines in a new/distributed process. This should be the path to the directory where the SimplygonBatch executable is located. If the tool is in the system path this setting should be an empty string.
StoragePathThe 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

MethodDescription
AddObserverAdds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
ClearManually clear the queue.
GetBatchCountGet the number of pipelines queued in the pipeline batch.
GetClassGet the name of the PipelineBatch class. (Inherited from Object)
GetOutputPathGet the path of the serialized output scene for the given batch index.
GetPipelinePathGet the path of the serialized pipeline for the given batch index.
GetScenePathGet the path of the serialized input scene for the given batch index.
IsAReturns true if PipelineBatch is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNullReturns true if the PipelineBatch object is invalid. (Inherited from Object)
IsSameObjectAsReturns true if the PipelineBatch object is valid. (Inherited from Object)
LoadProcessedSceneLoad 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.
NonNullReturns true if the PipelineBatch object is valid. (Inherited from Object)
PrintInfoPrints the content/info of the PipelineBatch object to the log. (Inherited from Object)
QueueQueue 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.
QueueFileQueue 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.
RemoveObserverRemoves a previously added observer object. (Inherited from Object)
RunRun processing on all queued pipelines using the given run mode, either local or distributed, and clear the queue.

Static methods

MethodDescription
IsClassAReturns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)
SafeCastSafeCast 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. (Inherited from Object)

Properties details

CascadedRunMode

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

Name

The name of the PipelineBatch object. (Inherited from Object)

SimplygonBatchPath

The path for the batch tool used when executing pipelines in a new/distributed process. This should be the path to the directory where the SimplygonBatch executable is located. If the tool is in the system path this setting should be an empty string.

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

AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

Clear

Manually clear the queue.

GetBatchCount

Get the number of pipelines queued in the pipeline batch.

GetClass

Get the name of the PipelineBatch class. (Inherited from Object)

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. (Inherited from Object)

IsNull

Returns true if the PipelineBatch object is invalid. (Inherited from Object)

IsSameObjectAs

Returns true if the PipelineBatch object is valid. (Inherited from Object)

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.

NonNull

Returns true if the PipelineBatch object is valid. (Inherited from Object)

PrintInfo

Prints the content/info of the PipelineBatch object to the log. (Inherited from Object)

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.

RemoveObserver

Removes a previously added observer object. (Inherited from Object)

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. (Inherited from Object)

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. (Inherited from Object)