29.14.27 ProductVolumeParameterSet

Topic Version1Published12/09/2016
For StandardPRODML v2.0
Type:ClassStereotype:«XSDcomplexType»

Product Volume Facility Parameter Set Schema.

Table 29.14.27-1 Attributes

Name

Type

Notes

ChildFacilityIdentifier

ProdmlRelativeIdentifier

The PRODML Relative Identifier (or URI) of a child of the parent facility. The identifier path is presumed to begin with the identity of the parent facility. This identifies a sub-facility which is identified within the context of the parent facilityParent2/facilityParent1/name identification hierarchy. The property is only expected to be defined for this child and not for the parent.

For more information about URIs, see the Energistics Identifier Specification, which is available in the zip file when download PRODML.

Comment

String2000

A comment about the parameter.

CoordinateReferenceSystem

String64

The pointer to the coordinate reference system (CRS). This is needed for coordinates such as measured depth to specify the reference datum.

MeasureClass

MeasureClass

If the value is a measure (value with unit of measure), this defines the measurement class of the value. The units of measure for the value must conform to the list allowed by the measurement class in the unit dictionary file. Mutually exclusive with curveDefinition.

Name

FacilityParameter

The name of the facility parameter. This should reflect the business semantics of all values in the set and not the underlying kind. For example, specify "diameter" rather than "length" or "distance".

PeriodKind

ReportingDurationKind

The type of period that is being reported.

Port

String64

The port to which this parameter is assigned. This must be a port on the unit representing the parent facility of this parameter. If not specified then the parameter represents the unit.

Product

ReportingProduct

The type of product that is being reported. This would be useful for something like specifying a tank product volume or level.

Qualifier

FlowQualifier

Qualifies the type of parameter that is being reported.

SubQualifier

FlowSubQualifier

Defines a specialization of the qualifier value. This should only be given if a qualifier is given.

uid

String64

A unique identifier for this data element. It is not globally unique (not a uuid) and only need be unique within the context of the parent top-level object.

Version

dateTime

A timestamp representing the version of this data. A parameter set with a more recent timestamp will represent the "current" version.

VersionSource

String64

Identifies the source of the version. This will commonly be the name of the software which created the version.

Table 29.14.27-2 Associations

Association

Notes

From: ProductVolumeParameterSet.

To: ReportingProduct

Dependency

 

From: ProductVolumeParameterSet.

To: ReportingDurationKind

Dependency

 

From: ProductVolumeParameterSet.

To: ProdmlRelativeIdentifier

Dependency

 

From: ProductVolumeParameterSet.

To: FlowSubQualifier

Dependency

 

From: ProductVolumeParameterSet.CurveDefinition

0..*To: CurveDefinition

Association

 

From: ProductVolumeParameterSet.Parameter

1..*To: ProductVolumeParameterValue

Association

 

From: ProductVolumeParameterSet.

To: FacilityParameter

Dependency

 

From: ProductVolumeParameterSet.

To: FlowQualifier

Dependency

 

From: ProductVolumeFacility.ParameterSet

0..*To: ProductVolumeParameterSet

Association