4.3.1.13. CoatedPipe (FV)¶
Note
CoatedPipe is identified as Fully Validated.
4.3.1.13.1. Example CoatedPipe¶
{
"pdef_id": "3d1324d7-9c16-4b7f-951d-0d93b3678e9a",
"pdef_type": "coated_pipe",
"meta_data": {},
"additional_data": {},
"overall_thickness_avg": {
"val": 3.0,
"unit": "mm"
},
"overall_thickness_min": {
"val": 2.85,
"unit": "mm"
},
"overall_thickness_max": {
"val": 3.1,
"unit": "mm"
},
"cut_back_length": [
[
"pipe_end_1",
{
"val": 150.0,
"unit": "mm"
}
]
],
"related_pipe_coating_spec": null,
"related_bare_pipe": [
"934ac741-ff38-4623-9c4e-dd1ef5eaf16d"
],
"records_of_coating_layer": [
{
"pdef_id": "7fccbcee-6e59-4a00-b50e-1acb99c00b09",
"pdef_type": "coating_layer",
"meta_data": {},
"additional_data": {},
"material_type": "FBE",
"length": null,
"thickness_avg": null,
"thickness_min": null,
"thickness_max": null
},
{
"pdef_id": "109fef71-563a-4150-b184-ff7fa3334f36",
"pdef_type": "coating_layer",
"meta_data": {},
"additional_data": {},
"material_type": "Adhesive",
"length": null,
"thickness_avg": null,
"thickness_min": null,
"thickness_max": null
},
{
"pdef_id": "78c4ebd4-b2c7-47f1-a0db-fc75fd09b487",
"pdef_type": "coating_layer",
"meta_data": {},
"additional_data": {},
"material_type": "Polypropylene",
"length": null,
"thickness_avg": null,
"thickness_min": null,
"thickness_max": null
}
]
}
4.3.1.13.2. Documentation CoatedPipe¶
CoatedPipe (FV) refer to a coated pipe. It describes the property of a unique tube, or instance of linepipe with its coating applied.
Each coated tube has its own measurements, properties etc. They are made according to a generic specification, see PipeCoatingSpec (PV). Each CoatedPipe (FV) object can reference such specifications.
For example, if a PDEF dataset reports a pipeline that required 1000 tubes to be coated, then the PDEF dataset will report 1000 instances of CoatedPipe (FV) in this collection.
If those tubes have the same coating type, meaning they are all produced to the same PipeCoatingSpec (PV), then only one PipeCoatingSpec (PV) instance will probably be reported in the dedicated PipeCoatingSpec (PV) collection.
4.3.1.13.3. Schema CoatedPipe¶
-
pdef.model.coated_pipe.CoatedPipe CoatedPipe object stores data related to one coated pipe, ie more or less a 12m long metallic tube with its applied parent coating.
Show JSON schema
{ "title": "CoatedPipe", "description": "`CoatedPipe` object stores data related to one coated pipe, ie more or less a 12m long metallic tube with its applied parent coating.", "type": "object", "properties": { "pdef_id": { "title": "PDEF id", "description": ":ref:`pdef_id` is the unique identifier for the object.", "example": "14474720-db23-453a-b9c0-6a9fc9b03ef3", "type": "string" }, "pdef_type": { "title": "Pdef Type", "const": "coated_pipe", "type": "string" }, "meta_data": { "title": "Metadata", "description": "Optional user free structured :ref:`Metadata` object.", "example": "{'created':'2021-09-03'}", "allOf": [ { "$ref": "#/definitions/MetaData" } ] }, "additional_data": { "title": "Additional Data", "description": "Optional user free structured :ref:`Additional Data` object.", "example": "{'color':'grey'}", "allOf": [ { "$ref": "#/definitions/AdditionalData" } ] }, "overall_thickness_avg": { "title": "Overall Thickness, average, measured", "description": "Actual overall coating thickness, average, measured. ", "example": { "val": 3, "unit": "mm" }, "allOf": [ { "$ref": "#/definitions/Length" } ] }, "overall_thickness_min": { "title": "Minimum overall thickness, measured", "description": "Actual minimum overall coating thicknes, measured. ", "example": { "val": 2.85, "unit": "mm" }, "allOf": [ { "$ref": "#/definitions/Length" } ] }, "overall_thickness_max": { "title": "Maximum overall thickness, measured ", "description": "Actual maximum overall coating thicknes, measured. ", "example": { "val": 3.1, "unit": "mm" }, "allOf": [ { "$ref": "#/definitions/Length" } ] }, "cut_back_length": { "title": "Coating Cut-Back Length, measured associated to a pipeline end.", "description": "Actual coating Cut-Back :ref:`Length`, measured provided as array of :ref:`PipeEnd` :ref:`pdef_id` and coating cut-back length.", "example": [ [ "37e682a2-e4e5-497a-b252-ea4b4ea54bc0", { "val": 150, "unit": "mm" } ] ], "type": "array", "items": { "type": "array", "items": [ { "type": "string" }, { "$ref": "#/definitions/Length" } ] } }, "related_pipe_coating_spec": { "title": "Relations to Pipe Coating Specification", "description": "Related instances of :ref:`PipeCoatingSpec`, provided as array of :ref:`pdef_id`.", "example": [ "37e682a2-e4e5-497a-b252-ea4b4ea54bc0" ], "type": "array", "items": { "type": "string" } }, "related_bare_pipe": { "title": "Relation to :ref:`BarePipe`", "description": "Related instances of :ref:`BarePipe`, provided as array of :ref:`pdef_id`.", "example": [ "37e682a2-e4e5-497a-b252-ea4b4ea54bc0" ], "type": "array", "items": { "type": "string" } }, "records_of_coating_layer": { "title": "Records of Coating Layers", "description": "Embedded records of coating layer, :ref:`CoatingLayer`. The order in which it is provided in the array is explicitly the order of physical application for the layer. The first CoatingLayer in the array corresponds to the first layer on top of the bare steel, and so on.", "type": "array", "items": { "$ref": "#/definitions/CoatingLayer" } } }, "additionalProperties": false, "definitions": { "MetaData": { "title": "MetaData", "description": "Optional base JSON-fragment used to report meta data. User free structure.", "type": "object", "properties": {} }, "AdditionalData": { "title": "AdditionalData", "description": "Optional base JSON-fragment used to report additional user specific data. User free structure.", "type": "object", "properties": {} }, "Length": { "title": "Length", "description": ":ref:`Measure` of a length, distance, thickness, diameter, etc", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "km", "hm", "dam", "m", "dm", "cm", "mm", "microm", "ft", "in" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false }, "CoatingLayer": { "title": "CoatingLayer", "description": "`CoatingLayer` object stores data related to one layer of coating.", "type": "object", "properties": { "pdef_id": { "title": "PDEF id", "description": ":ref:`pdef_id` is the unique identifier for the object.", "example": "14474720-db23-453a-b9c0-6a9fc9b03ef3", "type": "string" }, "pdef_type": { "title": "Pdef Type", "const": "coating_layer", "type": "string" }, "meta_data": { "title": "Metadata", "description": "Optional user free structured :ref:`Metadata` object.", "example": "{'created':'2021-09-03'}", "allOf": [ { "$ref": "#/definitions/MetaData" } ] }, "additional_data": { "title": "Additional Data", "description": "Optional user free structured :ref:`Additional Data` object.", "example": "{'color':'grey'}", "allOf": [ { "$ref": "#/definitions/AdditionalData" } ] }, "material_type": { "title": "Material Type", "description": "Material type used to make the layer.", "maxLength": 256, "examples": [ "FBE", "Adhesive", "PP" ], "type": "string" }, "length": { "title": "Layer Length measured", "description": "Actual layer length, measured. ", "example": { "val": 150, "unit": "mm" }, "allOf": [ { "$ref": "#/definitions/Length" } ] }, "thickness_avg": { "title": "Thickness, average, measured", "description": "Actual layer thickness, average, measured. ", "example": { "val": 0.5, "unit": "mm" }, "allOf": [ { "$ref": "#/definitions/Length" } ] }, "thickness_min": { "title": "Minimum thickness, measured", "description": "Actual minimum layer thicknes, measured. ", "example": { "val": 0.2, "unit": "mm" }, "allOf": [ { "$ref": "#/definitions/Length" } ] }, "thickness_max": { "title": "Maximum thickness, measured ", "description": "Actual maximum layer thicknes, measured. ", "example": { "val": 0.6, "unit": "mm" }, "allOf": [ { "$ref": "#/definitions/Length" } ] } }, "additionalProperties": false } } }
- Config
extra: str = forbid
-
cut_back_length: Optional[List[Tuple[str, pdef.model.measure.Length]]] = PydanticUndefined Actual coating Cut-Back Length, measured provided as array of PipeEnd (FV) pdef_id and coating cut-back length.
- Constraints and examples:
example = [(‘37e682a2-e4e5-497a-b252-ea4b4ea54bc0’, {‘val’: 150, ‘unit’: ‘mm’})]
-
overall_thickness_avg: Optional[pdef.model.measure.Length] = PydanticUndefined Actual overall coating thickness, average, measured.
- Constraints and examples:
example = {‘val’: 3, ‘unit’: ‘mm’}
-
overall_thickness_max: Optional[pdef.model.measure.Length] = PydanticUndefined Actual maximum overall coating thicknes, measured.
- Constraints and examples:
example = {‘val’: 3.1, ‘unit’: ‘mm’}
-
overall_thickness_min: Optional[pdef.model.measure.Length] = PydanticUndefined Actual minimum overall coating thicknes, measured.
- Constraints and examples:
example = {‘val’: 2.85, ‘unit’: ‘mm’}
-
pdef_type: str = 'coated_pipe' - Constraints and examples:
const = coated_pipe
-
records_of_coating_layer: Optional[List[pdef.model.coated_pipe.CoatingLayer]] = PydanticUndefined Embedded records of coating layer, CoatingLayer. The order in which it is provided in the array is explicitly the order of physical application for the layer. The first CoatingLayer in the array corresponds to the first layer on top of the bare steel, and so on.
-
related_bare_pipe: Optional[List[str]] = PydanticUndefined Related instances of BarePipe (FV), provided as array of pdef_id.
- Constraints and examples:
example = [‘37e682a2-e4e5-497a-b252-ea4b4ea54bc0’]
-
related_pipe_coating_spec: Optional[List[str]] = PydanticUndefined Related instances of PipeCoatingSpec (PV), provided as array of pdef_id.
- Constraints and examples:
example = [‘37e682a2-e4e5-497a-b252-ea4b4ea54bc0’]
4.3.1.13.4. List CoatedPipe¶
Variable |
Type |
Description |
|---|---|---|
pdef_id |
<class ‘str’> |
pdef_id is the unique identifier for the object. |
pdef_type |
<class ‘str’> |
|
meta_data |
<class ‘pdef.model.metadata.MetaData’> |
Optional user free structured MetaData object. |
additional_data |
<class ‘pdef.model.additional_data.AdditionalData’> |
Optional user free structured Additional Data object. |
overall_thickness_avg |
<class ‘pdef.model.measure.Length’> |
Actual overall coating thickness, average, measured. |
overall_thickness_min |
<class ‘pdef.model.measure.Length’> |
Actual minimum overall coating thicknes, measured. |
overall_thickness_max |
<class ‘pdef.model.measure.Length’> |
Actual maximum overall coating thicknes, measured. |
cut_back_length |
typing.Tuple[str, pdef.model.measure.Length] |
Actual coating Cut-Back Length, measured provided as array of PipeEnd (FV) pdef_id and coating cut-back length. |
related_pipe_coating_spec |
<class ‘str’> |
Related instances of PipeCoatingSpec (PV), provided as array of pdef_id. |
related_bare_pipe |
<class ‘str’> |
Related instances of BarePipe (FV), provided as array of pdef_id. |
records_of_coating_layer |
<class ‘pdef.model.coated_pipe.CoatingLayer’> |
Embedded records of coating layer, CoatingLayer. The order in which it is provided in the array is explicitly the order of physical application for the layer. The first CoatingLayer in the array corresponds to the first layer on top of the bare steel, and so on. |
4.3.1.13.5. CoatingLayer¶
4.3.1.13.5.1. Example CoatingLayer¶
{
"pdef_id": "7fccbcee-6e59-4a00-b50e-1acb99c00b09",
"pdef_type": "coating_layer",
"meta_data": {},
"additional_data": {},
"material_type": "FBE",
"length": null,
"thickness_avg": null,
"thickness_min": null,
"thickness_max": null
}
4.3.1.13.5.2. Documentation CoatingLayer¶
CoatingLayer stands for coating layer.
The various CoatingLayer relevant for one CoatedPipe (FV) are reported as an Nested Object into CoatedPipe (FV).
A coating is typically made in one or more layers. For example, a 3-layer polypropylene coating is made of one layer of fusion bonded epoxy (FBE), one layer of adhesive and one layer of polypropylene.
Each layer will have its dedicated properties: in PDEF, those layer specific properties are bundled in a CoatingLayer object, Nested in CoatedPipe (FV) under the coating_layer member.
CoatingLayer is an Nested Object. Therefore, the order in which it is provided in the JSON array is explicitly the order of physical application for the layer. The first CoatingLayer in the array corresponds to the first layer on top of the bare steel, and so on.
4.3.1.13.5.3. Schema CoatingLayer¶
-
pdef.model.coated_pipe.CoatingLayer CoatingLayer object stores data related to one layer of coating.
Show JSON schema
{ "title": "CoatingLayer", "description": "`CoatingLayer` object stores data related to one layer of coating.", "type": "object", "properties": { "pdef_id": { "title": "PDEF id", "description": ":ref:`pdef_id` is the unique identifier for the object.", "example": "14474720-db23-453a-b9c0-6a9fc9b03ef3", "type": "string" }, "pdef_type": { "title": "Pdef Type", "const": "coating_layer", "type": "string" }, "meta_data": { "title": "Metadata", "description": "Optional user free structured :ref:`Metadata` object.", "example": "{'created':'2021-09-03'}", "allOf": [ { "$ref": "#/definitions/MetaData" } ] }, "additional_data": { "title": "Additional Data", "description": "Optional user free structured :ref:`Additional Data` object.", "example": "{'color':'grey'}", "allOf": [ { "$ref": "#/definitions/AdditionalData" } ] }, "material_type": { "title": "Material Type", "description": "Material type used to make the layer.", "maxLength": 256, "examples": [ "FBE", "Adhesive", "PP" ], "type": "string" }, "length": { "title": "Layer Length measured", "description": "Actual layer length, measured. ", "example": { "val": 150, "unit": "mm" }, "allOf": [ { "$ref": "#/definitions/Length" } ] }, "thickness_avg": { "title": "Thickness, average, measured", "description": "Actual layer thickness, average, measured. ", "example": { "val": 0.5, "unit": "mm" }, "allOf": [ { "$ref": "#/definitions/Length" } ] }, "thickness_min": { "title": "Minimum thickness, measured", "description": "Actual minimum layer thicknes, measured. ", "example": { "val": 0.2, "unit": "mm" }, "allOf": [ { "$ref": "#/definitions/Length" } ] }, "thickness_max": { "title": "Maximum thickness, measured ", "description": "Actual maximum layer thicknes, measured. ", "example": { "val": 0.6, "unit": "mm" }, "allOf": [ { "$ref": "#/definitions/Length" } ] } }, "additionalProperties": false, "definitions": { "MetaData": { "title": "MetaData", "description": "Optional base JSON-fragment used to report meta data. User free structure.", "type": "object", "properties": {} }, "AdditionalData": { "title": "AdditionalData", "description": "Optional base JSON-fragment used to report additional user specific data. User free structure.", "type": "object", "properties": {} }, "Length": { "title": "Length", "description": ":ref:`Measure` of a length, distance, thickness, diameter, etc", "type": "object", "properties": { "val": { "title": "Value", "description": "The value taken by the Measure.", "examples": [ 1.0, -25.1, 1000000.0 ], "type": "number" }, "unit": { "title": "unit of measure", "description": "Unit of measure.", "enum": [ "km", "hm", "dam", "m", "dm", "cm", "mm", "microm", "ft", "in" ], "type": "string" } }, "required": [ "val", "unit" ], "additionalProperties": false } } }
- Config
extra: str = forbid
-
length: Optional[pdef.model.measure.Length] = PydanticUndefined Actual layer length, measured.
- Constraints and examples:
example = {‘val’: 150, ‘unit’: ‘mm’}
-
material_type: Optional[str] = PydanticUndefined Material type used to make the layer.
- Constraints and examples:
maxLength = 256
examples = [‘FBE’, ‘Adhesive’, ‘PP’]
-
pdef_type: str = 'coating_layer' - Constraints and examples:
const = coating_layer
-
thickness_avg: Optional[pdef.model.measure.Length] = PydanticUndefined Actual layer thickness, average, measured.
- Constraints and examples:
example = {‘val’: 0.5, ‘unit’: ‘mm’}
-
thickness_max: Optional[pdef.model.measure.Length] = PydanticUndefined Actual maximum layer thicknes, measured.
- Constraints and examples:
example = {‘val’: 0.6, ‘unit’: ‘mm’}
-
thickness_min: Optional[pdef.model.measure.Length] = PydanticUndefined Actual minimum layer thicknes, measured.
- Constraints and examples:
example = {‘val’: 0.2, ‘unit’: ‘mm’}
4.3.1.13.5.4. List CoatingLayer¶
Variable |
Type |
Description |
|---|---|---|
pdef_id |
<class ‘str’> |
pdef_id is the unique identifier for the object. |
pdef_type |
<class ‘str’> |
|
meta_data |
<class ‘pdef.model.metadata.MetaData’> |
Optional user free structured MetaData object. |
additional_data |
<class ‘pdef.model.additional_data.AdditionalData’> |
Optional user free structured Additional Data object. |
material_type |
<class ‘pdef.model.coated_pipe.ConstrainedStrValue’> |
Material type used to make the layer. |
length |
<class ‘pdef.model.measure.Length’> |
Actual layer length, measured. |
thickness_avg |
<class ‘pdef.model.measure.Length’> |
Actual layer thickness, average, measured. |
thickness_min |
<class ‘pdef.model.measure.Length’> |
Actual minimum layer thicknes, measured. |
thickness_max |
<class ‘pdef.model.measure.Length’> |
Actual maximum layer thicknes, measured. |