| Description |
| Creates a linestock feature according to the spec parameters, and a pipeline feature with those spec params, referencing the linestock. The pipeline features name would be generated according to the spec params and config option "pipeline_label_format". The linestock features name would be generated according to the spec params. |
| Synopsis |
| #include <ProPiping.h> |
| ProError | ProPipelineSpecDrivenCreate | ( |
| ProSelection model | |
| /*
(In) |
| The model where the pipeline will be create in. Must be a spec driven model or under confic option piping_design_method spec driven. |
| */ |
| ProPipingSpecParams spec_params | |
| /*
(In) |
| The parameters according to which the pipeline and linestock features will be created. |
| */ |
| ProName Mnemonic | |
| /*
(In) |
| May be NULL or empty. If NULL then the default mnemonic will be used, according to the spec params. (use an empty string to specify that no mnemonic shall be used). |
| */ |
| ProName number | |
| /*
(In) |
| May be NULL or empty. |
| */ |
| ProName insulation | |
| /*
(In) |
| May be NULL or empty. If NULL then the default insulation will be used, according to the spec params. (use an empty string to specify that no insulation shall be used). |
| */ |
| ProBool CreateSubAsm | |
| /*
(In) |
| If PRO_B_TRUE then the sub assembly will be created for that pipeline (using a template model defined in config option pipeline_start_assembly_name). |
| */ |
| ProName SubAsmName | |
| /*
(In) |
| The name of the sub assembly. Used if CreateSubAsm is TRUE. May be NULL. If NULL or empty, then the name of the sub assembly will be generated according to the config option pipeline_assembly_name_format. |
| */ |
| ProSelection csys_reference | |
| /*
(In) |
| A csys in the given model, to which the sub assembly will reference. May be NULL. If NULL then the first csys of the model will be used for placement reference. |
| */ |
| ProLnstk* pro_lnstk | |
| /*
(Out) |
| The linestock created during this process. |
| */ |
| ProFeature* pro_pipeline | |
| /*
(Out) |
| The pipeline created during this process. |
| */ |
| ProSelection* pro_new_model | |
| /*
(Out) |
| The sub assembly created during this process (if CreateSubAsm is TRUE). |
| */ |
| ) |
| Returns |
|
| PRO_TK_NO_ERROR | | The function successfully creates the pipeline, the linestock, and the sub assembly (when relevant). |
| PRO_TK_BAD_INPUTS | | One or more of the arguments are invalid. |
| PRO_TK_E_FOUND | | Pipeline with those exact params already exists or Sub assembly with the given name or the generated names exists. PRO_TK_E_NOT_FOUND One of the spec parameters was not found. Some examples: SPEC not found in pipe_spec_directory_file. SIZE not found in the related auto select file. A specific message will be prompt to Creo window. |
| PRO_TK_GENERAL_ERROR | | Other error. |
|