# 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

spString GetClass();

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# IsA

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

# Syntax

bool IsA( const char * type );

# 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

# IsNull

Returns true if the PipelineSerializer object is invalid.

# Syntax

bool IsNull();

# 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

spPipeline LoadPipelineFromFile( const char * path );

# Parameters

Type Name Min Max Description
const char * path 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

void SavePipelineToFile( const char * path , spPipeline pipeline );

# Parameters

Type Name Min Max Description
const char * path 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

static bool IsClassA( const char * type );

# 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

# 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

static spPipelineSerializer SafeCast( spObject object );

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: PipelineSerializer