| Description |
| Given XML file and a pipeline label, creates linestock feature and pipeline feature, according to the spec params taken from the XML for the specific label. 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 | ProPipelineCreateFromXML | ( |
| 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. |
| */ |
| ProPath xml_file | |
| /*
(In) |
| A path to XML file for schematic driven pipelines. |
| */ |
| ProName pipeline_label | |
| /*
(In) |
| A label of a pipeline for the above XML file. The spec parameters will be filled from the XML file for that label: SPEC, SIZE, SCHEDULE, MNEMONIC, NUMBER and INSULATION. Category is PIPE. GRADE (Material code) will be taken from the related spec according to the other spec params. |
| */ |
| ProBool insulation | |
| /*
(In) |
| if TRUE then insualtion will be created for the pipeline according to parameter INSULATION taken form the XML file. |
| */ |
| 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_INVALID_FILE | | XML file was not found or invalid. PRO_TK_E_NOT_FOUND The given label was not found in the XML file OR one of the spec parameters was not found. Some examples: spec is not found in pipe_spec_directory_file. size is not found in the related auto select file. A specific message will be prompt to Creo window. |
| 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_GENERAL_ERROR | | Other error. |
|