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

Method	Description
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

Method	Description
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)

Properties details

CascadedRunMode

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

Syntax

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

// Getter
Simplygon::EPipelineRunMode GetCascadedRunMode() const;

SetCascadedRunMode parameters

Type	Name	Min	Max	Description
EPipelineRunMode	mode			The run mode to use for cascaded pipelines.

GetCascadedRunMode return value

Type: EPipelineRunMode

Key	Value	Comment
RunInThisProcess	0	Run the pipeline in this process
RunInNewProcess	1	Run the pipeline in a new process using the batch executor tool
RunDistributedUsingSimplygonGrid	2	Run the pipeline distributed using SimplygonGrid
RunDistributedUsingIncredibuild	3	Run the pipeline distributed using IncrediBuild
RunDistributedUsingFastbuild	4	Run the pipeline distributed using Fastbuild

Syntax

// Setter
void SetCascadedRunMode(EPipelineRunMode mode);

// Getter
EPipelineRunMode GetCascadedRunMode();

SetCascadedRunMode parameters

Type	Name	Min	Max	Description
EPipelineRunMode	mode			The run mode to use for cascaded pipelines.

GetCascadedRunMode return value

Type: EPipelineRunMode

Key	Value	Comment
RunInThisProcess	0	Run the pipeline in this process
RunInNewProcess	1	Run the pipeline in a new process using the batch executor tool
RunDistributedUsingSimplygonGrid	2	Run the pipeline distributed using SimplygonGrid
RunDistributedUsingIncredibuild	3	Run the pipeline distributed using IncrediBuild
RunDistributedUsingFastbuild	4	Run the pipeline distributed using Fastbuild

Syntax

# Setter
None SetCascadedRunMode(mode: EPipelineRunMode_*)

# Getter
EPipelineRunMode_* GetCascadedRunMode()

SetCascadedRunMode parameters

Name	Type	Min	Max	Description
mode	EPipelineRunMode			The run mode to use for cascaded pipelines.

GetCascadedRunMode return value

Type: EPipelineRunMode

Key	Value	Comment
EPipelineRunMode_RunInThisProcess	0	Run the pipeline in this process
EPipelineRunMode_RunInNewProcess	1	Run the pipeline in a new process using the batch executor tool
EPipelineRunMode_RunDistributedUsingSimplygonGrid	2	Run the pipeline distributed using SimplygonGrid
EPipelineRunMode_RunDistributedUsingIncredibuild	3	Run the pipeline distributed using IncrediBuild
EPipelineRunMode_RunDistributedUsingFastbuild	4	Run the pipeline distributed using Fastbuild

Name

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

Syntax

// Setter
void SetName( const char * name ) const;

// Getter
spString GetName() const;

SetName parameters

Type	Name	Min	Max	Description
const char *	name			New name of the object.

GetName return value

Type: spString

Syntax

// Setter
void SetName(string name);

// Getter
string GetName();

SetName parameters

Type	Name	Min	Max	Description
string	name			New name of the object.

GetName return value

Type: string

Syntax

# Setter
None SetName(name: str)

# Getter
str GetName()

SetName parameters

Name	Type	Min	Max	Description
name	str			New name of the object.

GetName return value

Type: str

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.

Syntax

// Setter
void SetSimplygonBatchPath( const char * value ) const;

// Getter
spString GetSimplygonBatchPath() const;

SetSimplygonBatchPath parameters

Type	Name	Min	Max	Description
const char *	value			Path where SimplygonBatch executable is located.

GetSimplygonBatchPath return value

Type: spString

Syntax

// Setter
void SetSimplygonBatchPath(string value);

// Getter
string GetSimplygonBatchPath();

SetSimplygonBatchPath parameters

Type	Name	Min	Max	Description
string	value			Path where SimplygonBatch executable is located.

GetSimplygonBatchPath return value

Type: string

Syntax

# Setter
None SetSimplygonBatchPath(value: str)

# Getter
str GetSimplygonBatchPath()

SetSimplygonBatchPath parameters

Name	Type	Min	Max	Description
value	str			Path where SimplygonBatch executable is located.

GetSimplygonBatchPath return value

Type: str

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.

Syntax

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

// Getter
spString GetStoragePath() const;

SetStoragePath parameters

Type	Name	Min	Max	Description
const char *	path			The path to use to serialize temporary storage of pipelines and scenes.

GetStoragePath return value

Type: spString

Syntax

// Setter
void SetStoragePath(string path);

// Getter
string GetStoragePath();

SetStoragePath parameters

Type	Name	Min	Max	Description
string	path			The path to use to serialize temporary storage of pipelines and scenes.

GetStoragePath return value

Type: string

Syntax

# Setter
None SetStoragePath(path: str)

# Getter
str GetStoragePath()

SetStoragePath parameters

Name	Type	Min	Max	Description
path	str			The path to use to serialize temporary storage of pipelines and scenes.

GetStoragePath return value

Type: str

Methods details

AddObserver

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

Syntax

rid AddObserver( const spObserver & observer ) const;

Parameters

Type	Name	Min	Max	Description
Observer	observer			Observer is the object that will receive events.

Return value

Type: rid

Syntax

int AddObserver(spObserver observer);

Parameters

Type	Name	Min	Max	Description
Observer	observer			Observer is the object that will receive events.

Return value

Type: int

Syntax

int AddObserver(observer: spObserver)

Parameters

Name	Type	Min	Max	Description
observer	Observer			Observer is the object that will receive events.

Return value

Type: int

Clear

Manually clear the queue.

Syntax

void Clear() const;

Parameters

Type	Name	Min	Max	Description

Syntax

void Clear();

Parameters

Type	Name	Min	Max	Description

Syntax

None Clear()

Parameters

Name	Type	Min	Max	Description

GetBatchCount

Get the number of pipelines queued in the pipeline batch.

Syntax

unsigned int GetBatchCount() const;

Parameters

Type	Name	Min	Max	Description

Return value

Type: unsigned int

Syntax

uint GetBatchCount();

Parameters

Type	Name	Min	Max	Description

Return value

Type: uint

Syntax

int GetBatchCount()

Parameters

Name	Type	Min	Max	Description

Return value

Type: int

GetClass

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

Syntax

spString GetClass() const;

Parameters

GetClass takes no parameters.

Return value

Type: spString

Syntax

string GetClass();

Parameters

GetClass takes no parameters.

Return value

Type: string

Syntax

str GetClass()

Parameters

GetClass takes no parameters.

Return value

Type: str

GetOutputPath

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

Syntax

spString GetOutputPath( unsigned int index ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	index			The batch index.

Return value

Type: spString

Syntax

string GetOutputPath(uint index);

Parameters

Type	Name	Min	Max	Description
uint	index			The batch index.

Return value

Type: string

Syntax

str GetOutputPath(index: int)

Parameters

Name	Type	Min	Max	Description
index	int			The batch index.

Return value

Type: str

GetPipelinePath

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

Syntax

spString GetPipelinePath( unsigned int index ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	index			The batch index.

Return value

Type: spString

Syntax

string GetPipelinePath(uint index);

Parameters

Type	Name	Min	Max	Description
uint	index			The batch index.

Return value

Type: string

Syntax

str GetPipelinePath(index: int)

Parameters

Name	Type	Min	Max	Description
index	int			The batch index.

Return value

Type: str

GetScenePath

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

Syntax

spString GetScenePath( unsigned int index ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	index			The batch index.

Return value

Type: spString

Syntax

string GetScenePath(uint index);

Parameters

Type	Name	Min	Max	Description
uint	index			The batch index.

Return value

Type: string

Syntax

str GetScenePath(index: int)

Parameters

Name	Type	Min	Max	Description
index	int			The batch index.

Return value

Type: str

IsA

Returns true if PipelineBatch is a or is a descendant of the class named as the type parameter. (Inherited from Object)

Syntax

bool IsA( const char * type ) const;

Parameters

Type	Name	Min	Max	Description
const char *	type			Name of the class to check if PipelineBatch is, or is a descendant of.

Return value

Type: bool

Syntax

bool IsA(string type);

Parameters

Type	Name	Min	Max	Description
string	type			Name of the class to check if PipelineBatch is, or is a descendant of.

Return value

Type: bool

Syntax

bool IsA(type: str)

Parameters

Name	Type	Min	Max	Description
type	str			Name of the class to check if PipelineBatch is, or is a descendant of.

Return value

Type: bool

IsNull

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

Syntax

bool IsNull() const;

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull();

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull()

Parameters

IsNull takes no parameters.

Return value

Type: bool

IsSameObjectAs

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

Syntax

bool IsSameObjectAs( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Return value

Type: bool

Syntax

bool IsSameObjectAs(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Return value

Type: bool

Syntax

bool IsSameObjectAs(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to compare with.

Return value

Type: bool

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.

Syntax

spScene LoadProcessedScene( unsigned int handle ) const;

Parameters

Type	Name	Min	Max	Description
unsigned int	handle			The handle for the scene as returned by a call to Queue/QueueFile.

Return value

Type: Scene

Syntax

spScene LoadProcessedScene(uint handle);

Parameters

Type	Name	Min	Max	Description
uint	handle			The handle for the scene as returned by a call to Queue/QueueFile.

Return value

Type: Scene

Syntax

spScene LoadProcessedScene(handle: int)

Parameters

Name	Type	Min	Max	Description
handle	int			The handle for the scene as returned by a call to Queue/QueueFile.

Return value

Type: Scene

NonNull

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

Syntax

bool NonNull() const;

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull();

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull()

Parameters

NonNull takes no parameters.

Return value

Type: bool

PrintInfo

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

Syntax

void PrintInfo() const;

Parameters

PrintInfo takes no parameters.

Syntax

void PrintInfo();

Parameters

PrintInfo takes no parameters.

Syntax

None PrintInfo()

Parameters

PrintInfo takes no parameters.

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.

Syntax

unsigned int Queue( const spPipeline & pipeline , const spScene & scene ) const;

Parameters

Type	Name	Min	Max	Description
Pipeline	pipeline			The pipeline to execute.
Scene	scene			The scene to process.

Return value

Type: unsigned int

Syntax

uint Queue(spPipeline pipeline, spScene scene);

Parameters

Type	Name	Min	Max	Description
Pipeline	pipeline			The pipeline to execute.
Scene	scene			The scene to process.

Return value

Type: uint

Syntax

int Queue(pipeline: spPipeline, scene: spScene)

Parameters

Name	Type	Min	Max	Description
pipeline	Pipeline			The pipeline to execute.
scene	Scene			The scene to process.

Return value

Type: int

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.

Syntax

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

Parameters

Type	Name	Min	Max	Description
const char *	pipeline			The pipeline file to execute.
const char *	scene			The scene file to process.

Return value

Type: unsigned int

Syntax

uint QueueFile(string pipeline, string scene);

Parameters

Type	Name	Min	Max	Description
string	pipeline			The pipeline file to execute.
string	scene			The scene file to process.

Return value

Type: uint

Syntax

int QueueFile(pipeline: str, scene: str)

Parameters

Name	Type	Min	Max	Description
pipeline	str			The pipeline file to execute.
scene	str			The scene file to process.

Return value

Type: int

RemoveObserver

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

Syntax

void RemoveObserver( rid observerId ) const;

Parameters

Type	Name	Min	Max	Description
rid	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Syntax

void RemoveObserver(int observerId);

Parameters

Type	Name	Min	Max	Description
int	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Syntax

None RemoveObserver(observerId: int)

Parameters

Name	Type	Min	Max	Description
observerId	int			ObserverId is the id returned by AddObserver when the observer was added.

Run

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

Syntax

Simplygon::EErrorCodes Run( Simplygon::EPipelineRunMode runMode ) const;

Parameters

Type	Name	Min	Max	Description
EPipelineRunMode	runMode			The run mode for all pipelines.

Return value

Type: EErrorCodes

Key	Value	Comment
NoError	0	No error, the initialization or process has finished, and with no errors
NoLicense	-1	no license was found (or licence expired)
NotInitialized	-2	the SDK is not initialized, or no process object has been loaded/created
AlreadyInitialized	-3	the SDK is already initialized
DLLOrDependenciesNotFound	-4	the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment.
InvalidInputParam	-5	an invalid parameter was passed to the method
FailedTesting	-6	the reduction failed post-testing
DLLAndHeaderFileIsNotMatching	-7	the Simplygon DLL and header file interface versions do not match
DLLFailedToLoad	-8	the Simplygon DLL failed loading, probably because of a missing dependency
LicenseNotForThisApplication	-9	the license is not made for this application of Simplygon
LicenseNotForThisPlatform	-10	the license is not made for this platform of Simplygon
LicenseNotForThisVersion	-11	the license is not made for this version of Simplygon
FailedToCreatePipelineSerializer	-12	failed to create pipeline serializer
FailedToRunPipeline	-13	failed to run pipeline
UnhandledException	-14	an unhandled exception was encountered
FileError	-15	a file read/write failed.
InvalidPath	-16	a path is invalid or a file/directory is missing.
DependencyMissing	-17	a needed dependency is missing. see log for info on what is missing.
UnexpectedError	-18	an unexpected error happened.
FailedToUploadFreeLicenseAsset	-50	failed to upload free license asset
ExceptionalError	-1000	An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks.
FailedToResolveLicenseServerHostName	-10001	cannot reach the licensing server, cant look up server, check DNS
FailedToConnectToLicenseServer	-10002	cannot contact the licensing server, check firewall/proxy server
FailedToConnectToLicenseServerAndSendData	-10003	Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy.
FailedToConnectToLicenseServerAndReceiveData	-10004	cannot receive data from the licensing server, check firewall/proxy server
DataFromLicenseServerIsCorrupt	-10005	data from licensing server is corrupted, try again, check connection
LicenseHasExpired	-10006	the license has expired
LicenseIsInvalid	-10007	the license data is corrupted, please reinstall the license key
LicenseNotForThisProduct	-10008	the license is not for this product, please contact licensing, and replace license key
NoNetworkCardFound	-10009	no network card was found on the machine
LicenseDecodeFailed	-10010	could not decode license, it is corrupted
LicenseLockNotMatchingMachine	-10011	the license is locked to another machine
ConnectionToLicenseServerLost	-10012	Connection to license server lost
LicenseHashDataCorrupt	-10013	could not decode license, it is corrupted
LicenseExpired	-10014	the license is invalid, please contact licensing
LicenseNotLockedForThisMachine	-10020	the license is locked to another machine
YourLicenseRequiresLatestWindows10	-10024	your license requires latest Windows 10 version
LicenseServerReturnedBadRequest	-10400	Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support
ProcessingCap	-10403	You have reached the maximum number of processings for your license. Please try again in 24 hours or reach out to SimplygonSales@microsoft.com for support..
UnknownLicenseKey	-10404	You are using an unknown license key. Please verify so you typed in the license key correctly and try again
LicenseIsNotActive	-10410	You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support
MaxNodesReachForThisLicense	-10409	You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine
YourLicenseRequiresLatestSimplygon	-10426	The license key you are using requires you to update to the latest version before you can use Simplygon
LicenseServerReturnServerError	-10501	Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support
ProcessingValidationError	-20001	The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes.

Syntax

EErrorCodes Run(EPipelineRunMode runMode);

Parameters

Type	Name	Min	Max	Description
EPipelineRunMode	runMode			The run mode for all pipelines.

Return value

Type: EErrorCodes

Key	Value	Comment
NoError	0	No error, the initialization or process has finished, and with no errors
NoLicense	-1	no license was found (or licence expired)
NotInitialized	-2	the SDK is not initialized, or no process object has been loaded/created
AlreadyInitialized	-3	the SDK is already initialized
DLLOrDependenciesNotFound	-4	the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment.
InvalidInputParam	-5	an invalid parameter was passed to the method
FailedTesting	-6	the reduction failed post-testing
DLLAndHeaderFileIsNotMatching	-7	the Simplygon DLL and header file interface versions do not match
DLLFailedToLoad	-8	the Simplygon DLL failed loading, probably because of a missing dependency
LicenseNotForThisApplication	-9	the license is not made for this application of Simplygon
LicenseNotForThisPlatform	-10	the license is not made for this platform of Simplygon
LicenseNotForThisVersion	-11	the license is not made for this version of Simplygon
FailedToCreatePipelineSerializer	-12	failed to create pipeline serializer
FailedToRunPipeline	-13	failed to run pipeline
UnhandledException	-14	an unhandled exception was encountered
FileError	-15	a file read/write failed.
InvalidPath	-16	a path is invalid or a file/directory is missing.
DependencyMissing	-17	a needed dependency is missing. see log for info on what is missing.
UnexpectedError	-18	an unexpected error happened.
FailedToUploadFreeLicenseAsset	-50	failed to upload free license asset
ExceptionalError	-1000	An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks.
FailedToResolveLicenseServerHostName	-10001	cannot reach the licensing server, cant look up server, check DNS
FailedToConnectToLicenseServer	-10002	cannot contact the licensing server, check firewall/proxy server
FailedToConnectToLicenseServerAndSendData	-10003	Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy.
FailedToConnectToLicenseServerAndReceiveData	-10004	cannot receive data from the licensing server, check firewall/proxy server
DataFromLicenseServerIsCorrupt	-10005	data from licensing server is corrupted, try again, check connection
LicenseHasExpired	-10006	the license has expired
LicenseIsInvalid	-10007	the license data is corrupted, please reinstall the license key
LicenseNotForThisProduct	-10008	the license is not for this product, please contact licensing, and replace license key
NoNetworkCardFound	-10009	no network card was found on the machine
LicenseDecodeFailed	-10010	could not decode license, it is corrupted
LicenseLockNotMatchingMachine	-10011	the license is locked to another machine
ConnectionToLicenseServerLost	-10012	Connection to license server lost
LicenseHashDataCorrupt	-10013	could not decode license, it is corrupted
LicenseExpired	-10014	the license is invalid, please contact licensing
LicenseNotLockedForThisMachine	-10020	the license is locked to another machine
YourLicenseRequiresLatestWindows10	-10024	your license requires latest Windows 10 version
LicenseServerReturnedBadRequest	-10400	Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support
ProcessingCap	-10403	You have reached the maximum number of processings for your license. Please try again in 24 hours or reach out to SimplygonSales@microsoft.com for support..
UnknownLicenseKey	-10404	You are using an unknown license key. Please verify so you typed in the license key correctly and try again
LicenseIsNotActive	-10410	You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support
MaxNodesReachForThisLicense	-10409	You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine
YourLicenseRequiresLatestSimplygon	-10426	The license key you are using requires you to update to the latest version before you can use Simplygon
LicenseServerReturnServerError	-10501	Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support
ProcessingValidationError	-20001	The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes.

Syntax

EErrorCodes_* Run(runMode: EPipelineRunMode_*)

Parameters

Name	Type	Min	Max	Description
runMode	EPipelineRunMode			The run mode for all pipelines.

Return value

Type: EErrorCodes

Key	Value	Comment
EErrorCodes_NoError	0	No error, the initialization or process has finished, and with no errors
EErrorCodes_NoLicense	-1	no license was found (or licence expired)
EErrorCodes_NotInitialized	-2	the SDK is not initialized, or no process object has been loaded/created
EErrorCodes_AlreadyInitialized	-3	the SDK is already initialized
EErrorCodes_DLLOrDependenciesNotFound	-4	the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment.
EErrorCodes_InvalidInputParam	-5	an invalid parameter was passed to the method
EErrorCodes_FailedTesting	-6	the reduction failed post-testing
EErrorCodes_DLLAndHeaderFileIsNotMatching	-7	the Simplygon DLL and header file interface versions do not match
EErrorCodes_DLLFailedToLoad	-8	the Simplygon DLL failed loading, probably because of a missing dependency
EErrorCodes_LicenseNotForThisApplication	-9	the license is not made for this application of Simplygon
EErrorCodes_LicenseNotForThisPlatform	-10	the license is not made for this platform of Simplygon
EErrorCodes_LicenseNotForThisVersion	-11	the license is not made for this version of Simplygon
EErrorCodes_FailedToCreatePipelineSerializer	-12	failed to create pipeline serializer
EErrorCodes_FailedToRunPipeline	-13	failed to run pipeline
EErrorCodes_UnhandledException	-14	an unhandled exception was encountered
EErrorCodes_FileError	-15	a file read/write failed.
EErrorCodes_InvalidPath	-16	a path is invalid or a file/directory is missing.
EErrorCodes_DependencyMissing	-17	a needed dependency is missing. see log for info on what is missing.
EErrorCodes_UnexpectedError	-18	an unexpected error happened.
EErrorCodes_FailedToUploadFreeLicenseAsset	-50	failed to upload free license asset
EErrorCodes_ExceptionalError	-1000	An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks.
EErrorCodes_FailedToResolveLicenseServerHostName	-10001	cannot reach the licensing server, cant look up server, check DNS
EErrorCodes_FailedToConnectToLicenseServer	-10002	cannot contact the licensing server, check firewall/proxy server
EErrorCodes_FailedToConnectToLicenseServerAndSendData	-10003	Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy.
EErrorCodes_FailedToConnectToLicenseServerAndReceiveData	-10004	cannot receive data from the licensing server, check firewall/proxy server
EErrorCodes_DataFromLicenseServerIsCorrupt	-10005	data from licensing server is corrupted, try again, check connection
EErrorCodes_LicenseHasExpired	-10006	the license has expired
EErrorCodes_LicenseIsInvalid	-10007	the license data is corrupted, please reinstall the license key
EErrorCodes_LicenseNotForThisProduct	-10008	the license is not for this product, please contact licensing, and replace license key
EErrorCodes_NoNetworkCardFound	-10009	no network card was found on the machine
EErrorCodes_LicenseDecodeFailed	-10010	could not decode license, it is corrupted
EErrorCodes_LicenseLockNotMatchingMachine	-10011	the license is locked to another machine
EErrorCodes_ConnectionToLicenseServerLost	-10012	Connection to license server lost
EErrorCodes_LicenseHashDataCorrupt	-10013	could not decode license, it is corrupted
EErrorCodes_LicenseExpired	-10014	the license is invalid, please contact licensing
EErrorCodes_LicenseNotLockedForThisMachine	-10020	the license is locked to another machine
EErrorCodes_YourLicenseRequiresLatestWindows10	-10024	your license requires latest Windows 10 version
EErrorCodes_LicenseServerReturnedBadRequest	-10400	Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support
EErrorCodes_ProcessingCap	-10403	You have reached the maximum number of processings for your license. Please try again in 24 hours or reach out to SimplygonSales@microsoft.com for support..
EErrorCodes_UnknownLicenseKey	-10404	You are using an unknown license key. Please verify so you typed in the license key correctly and try again
EErrorCodes_LicenseIsNotActive	-10410	You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support
EErrorCodes_MaxNodesReachForThisLicense	-10409	You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine
EErrorCodes_YourLicenseRequiresLatestSimplygon	-10426	The license key you are using requires you to update to the latest version before you can use Simplygon
EErrorCodes_LicenseServerReturnServerError	-10501	Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support
EErrorCodes_ProcessingValidationError	-20001	The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes.

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)

Syntax

static bool IsClassA( const char * type ) const;

Parameters

Type	Name	Min	Max	Description
const char *	type			Name of the class to check if the class is, or is a descendant of.

Return value

Type: bool

Syntax

static bool IsClassA(string type);

Parameters

Type	Name	Min	Max	Description
string	type			Name of the class to check if the class is, or is a descendant of.

Return value

Type: bool

Syntax

@staticmethod
bool IsClassA(type: str)

Parameters

Name	Type	Min	Max	Description
type	str			Name of the class to check if the class is, or is a descendant of.

Return value

Type: bool

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)

Syntax

static spPipelineBatch SafeCast( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: PipelineBatch

Syntax

static spPipelineBatch SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: PipelineBatch

Syntax

@staticmethod
spPipelineBatch SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: PipelineBatch