class
PipelineSerializer
Methods
Method | Description |
GetClass | Get the name of the PipelineSerializer class. |
IsA | Returns true if PipelineSerializer is a or is a descendant of the class named as the type parameter. |
IsNull | Returns true if the PipelineSerializer object is invalid. |
LoadPipelineFromFile | Load the pipeline definition to the given file and create a pipeline object as defined in this file, including settings. |
SavePipelineToFile | Save the pipeline definition and settings to the given file, which can be used to restore the pipeline through the LoadPipelineFromFile method. Note that pipeline files are NOT meant for storage, only as a transient transfer format between processes and hosts. Do NOT store pipeline files for later use, as there is no guarantee that pipeline files will be compatible between different versions of Simplygon. |
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 spPipelineSerializer, and if this is the case, returns the object cast into spPipelineSerializer. |
Methods details
GetClass
Get the name of the PipelineSerializer class.
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: spString
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: string
Syntax
Parameters
GetClass takes no parameters.
Return value
Type: str
IsA
Returns true if PipelineSerializer is a or is a descendant of the class named as the type parameter.
Syntax
Parameters
Type | Name | Min | Max | Description |
const char * | type | | | Name of the class to check if PipelineSerializer is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
Type | Name | Min | Max | Description |
string | type | | | Name of the class to check if PipelineSerializer is, or is a descendant of. |
Return value
Type: bool
Syntax
Parameters
Name | Type | Min | Max | Description |
type | str | | | Name of the class to check if PipelineSerializer is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the PipelineSerializer object is invalid.
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
Syntax
Parameters
IsNull takes no parameters.
Return value
Type: bool
LoadPipelineFromFile
Load the pipeline definition to the given file and create a pipeline object as defined in this file, including settings.
Syntax
Parameters
Type | Name | Min | Max | Description |
const char * | path | | | The file path of the input pipeline definition. |
Return value
Type: Pipeline
Syntax
Parameters
Type | Name | Min | Max | Description |
string | path | | | The file path of the input pipeline definition. |
Return value
Type: Pipeline
Syntax
Parameters
Name | Type | Min | Max | Description |
path | str | | | The file path of the input pipeline definition. |
Return value
Type: Pipeline
SavePipelineToFile
Save the pipeline definition and settings to the given file, which can be used to restore the pipeline through the LoadPipelineFromFile method. Note that pipeline files are NOT meant for storage, only as a transient transfer format between processes and hosts. Do NOT store pipeline files for later use, as there is no guarantee that pipeline files will be compatible between different versions of Simplygon.
Syntax
Parameters
Type | Name | Min | Max | Description |
const char * | path | | | The file path of the output pipeline definition. |
Pipeline | pipeline | | | The pipeline object to save. |
Syntax
Parameters
Type | Name | Min | Max | Description |
string | path | | | The file path of the output pipeline definition. |
Pipeline | pipeline | | | The pipeline object to save. |
Syntax
Parameters
Name | Type | Min | Max | Description |
path | str | | | The file path of the output pipeline definition. |
pipeline | Pipeline | | | The pipeline object to save. |
Static methods details
IsClassA
Returns true if the class is a or is a descendant of the class named as the type parameter.
Syntax
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
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
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 spPipelineSerializer, and if this is the case, returns the object cast into spPipelineSerializer.
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: PipelineSerializer
Syntax
Parameters
Type | Name | Min | Max | Description |
Object | object | | | Object to cast. |
Return value
Type: PipelineSerializer
Syntax
Parameters
Name | Type | Min | Max | Description |
object | Object | | | Object to cast. |
Return value
Type: PipelineSerializer