# class PipelineBatch

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

# Properties

# Methods

# Static methods

# Properties details

# CascadedRunMode

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

// Setter
void SetCascadedRunMode( Simplygon::EPipelineRunMode mode );

// Getter
Simplygon::EPipelineRunMode GetCascadedRunMode();

// Setter
void SetCascadedRunMode(enum(EPipelineRunMode) mode);

// Getter
 GetCascadedRunMode();

# Setter
None SetCascadedRunMode(mode: EPipelineRunMode_*)

# Getter
EPipelineRunMode_* GetCascadedRunMode()

# 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.

// Setter
void SetStoragePath( const char * path );

// Getter
spString GetStoragePath();

// Setter
void SetStoragePath(string path);

// Getter
string GetStoragePath();

# Setter
None SetStoragePath(path: str)

# Getter
str GetStoragePath()

# Methods details

# Clear

Manually clear the queue.

void Clear();

void Clear();

None Clear()

# GetBatchCount

Get the number of pipelines queued in the pipeline batch.

unsigned int GetBatchCount();

uint GetBatchCount();

int GetBatchCount()

# GetClass

Get the name of the PipelineBatch class.

spString GetClass();

string GetClass();

str GetClass()

# GetOutputPath

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

spString GetOutputPath( unsigned int index );

string GetOutputPath(uint index);

str GetOutputPath(index: int)

# GetPipelinePath

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

spString GetPipelinePath( unsigned int index );

string GetPipelinePath(uint index);

str GetPipelinePath(index: int)

# GetScenePath

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

spString GetScenePath( unsigned int index );

string GetScenePath(uint index);

str GetScenePath(index: int)

# IsA

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

bool IsA( const char * type );

bool IsA(string type);

bool IsA(type: str)

# IsNull

Returns true if the PipelineBatch object is invalid.

bool IsNull();

bool IsNull();

bool IsNull()

# 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.

spScene LoadProcessedScene( unsigned int handle );

spScene LoadProcessedScene(uint handle);

spScene LoadProcessedScene(handle: int)

# 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.

unsigned int Queue( spPipeline pipeline , spScene scene );

uint Queue(spPipeline pipeline, spScene scene);

int Queue(pipeline: spPipeline, scene: spScene)

# 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.

unsigned int QueueFile( const char * pipeline , const char * scene );

uint QueueFile(string pipeline, string scene);

int QueueFile(pipeline: str, scene: str)

# Run

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

void Run( Simplygon::EPipelineRunMode runMode );

void Run(enum(EPipelineRunMode) runMode);

None Run(runMode: EPipelineRunMode_*)

# Static methods details

# IsClassA

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

static bool IsClassA( const char * type );

static bool IsClassA(string type);

@staticmethod
bool IsClassA(type: str)

# 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.

static spPipelineBatch SafeCast( spObject object );

static spPipelineBatch SafeCast(spObject object);

@staticmethod
spPipelineBatch SafeCast(object: spObject)