Documentation for obj_object_profiled_data_schema

Complex Type: obj_productVolume

[Table of contents]

Super-types: abstractSingularDataObject < obj_productVolume (by extension)
Sub-types: None
Name obj_productVolume
Used by (from the same schema document) Complex Type obj_productVolumes
Abstract no
XML Instance Representation
<...
uid=" witsml:uidString [0..1]

'The unique identifier of a container element. This attribute is generally required within the context of a WITSML server. There should be no assumption as to the semantic content of this attribute. This should only be used with recurring container types (i.e., maxOccurs greater than one). The value is only required to be unique within the context of the nearest recurring parent element.'

"
>
<witsml:name> witsml:nameStruct </witsml:name> [1]

'Human recognizable context for the Product Volume Report.'

<witsml:installation> witsml:facilityIdentifierStruct </witsml:installation> [0..1]

'The name of the facility which is represented by this report. The name can be qualified by a naming system. This also defines the kind of facility.'

<witsml:contextFacility> witsml:facilityIdentifierStruct </witsml:contextFacility> [0..*]

'The name and type of a facility whose context is relevant to the represented installation.'

<witsml:kind> witsml:kindString </witsml:kind> [0..1]

'The type of report.'

<witsml:periodKind> witsml:ReportingPeriod </witsml:periodKind> [0..1]

'The type of period that is being reported. This value must be consistent with the reporting start and end values.'

Start Choice [0..1]

'The reporting period. If one value from a pair are given the both values must be given.'


<witsml:dTimStart> witsml:timestamp </witsml:dTimStart> [0..1]

'The beginning date and time that the report represents.'

<witsml:dTimEnd> witsml:timestamp </witsml:dTimEnd> [0..1]

'The ending date and time that the report represents.'

<witsml:dateStart> witsml:date </witsml:dateStart> [0..1]

'The beginning date that the report represents.'

<witsml:dateEnd> witsml:date </witsml:dateEnd> [0..1]

'The ending date that the report represents.'

<witsml:month> witsml:month </witsml:month> [0..1]

'The ending date that the report represents.'

End Choice
<witsml:dTimMin> witsml:endpointQualifiedDateTime </witsml:dTimMin> [0..1]

'The minimum time index contained within the report. For the purposes of this parameter, a \"period\" or \"facility parameter\" without any time data should be assumed to have the time associated with the overall report. The minimum and maximum indexes are server query parameters and will be populated with valid values in a \"get\" result. See the WITSML API Specification appendix on \"Special Handling\" of growing objects for a description of the behavior related to this parameter.'

<witsml:dTimMax> witsml:endpointQualifiedDateTime </witsml:dTimMax> [0..1]

'The maximum time index contained within the report. For the purposes of this parameter, a \"period\" or \"facility parameter\" without any time data should be assumed to have the time associated with the overall report. The minimum and maximum indexes are server query parameters and will be populated with valid values in a \"get\" result. See the WITSML API Specification appendix on \"Special Handling\" of growing objects for a description of the behavior related to this parameter.'

<witsml:dTimCurrent> witsml:timestamp </witsml:dTimCurrent> [0..1]

'The definition of the \"current time\" index for this report. The current time index is a server query parameter which requests the selection of a single node from a recurring \"period\" set (e.g., the data related to one point in a time series). For the purposes of this parameter, a \"period\" without any time data should be assumed to have the time associated with the overall report. See the WITSML API Specification appendix on \"Special Handling\" of growing objects for a description of the behavior related to this parameter.'

<witsml:calculationMethod> witsml:CalculationMethod </witsml:calculationMethod> [0..1]

'The calculation method for for \"filling in\" values in an indexed set. If not given, the default is that no calculations are performed to create data where none exists within an existing set. This is not to be construed as to prevent concepts such as simulation and forcasting from being applied in order to create a new set. This is a server query parameter.'

<witsml:operator> witsml:cs_businessAssociate </witsml:operator> [0..1]

'The operator of the facilities in the report.'

<witsml:title> witsml:nameStruct </witsml:title> [0..1]

'The tile of the report if different from the name of the report.'

<witsml:geographicContext> witsml:cs_geographicContext </witsml:geographicContext> [0..1]

'The geographic context of the report.'

<witsml:issueDate> witsml:date </witsml:issueDate> [0..1]

'The date that the report was issued.'

<witsml:issuedBy> witsml:cs_businessAssociate </witsml:issuedBy> [0..1]

'The person or company that issued the report. This may contain the role of the person or company within the context of the report.'

<witsml:approvalDate> witsml:date </witsml:approvalDate> [0..1]

'The date that the report was approved.'

<witsml:approver> witsml:cs_businessAssociate </witsml:approver> [0..1]

'The person or company that approved the report. This may contain the role of the person or company within the context of the report.'

<witsml:productFlowModel> witsml:refNameString </witsml:productFlowModel> [0..1]

'The Product Flow Model for the overall installation. This model represents all Product Flow Units referenced within this report.'

<witsml:standardTempPres> witsml:StandardTempPress </witsml:standardTempPres> [0..1]

'DEPRECATED. The elements which reference this have been DEPRECATED. Defines the standard temperature and pressure to which all standard volumes in this report have been corrected. This applies to all elements whose name is suffixed by Std and documented to be corrected to conditions of standard temperature and pressure.'

<witsml:businessUnit> witsml:cs_productVolumeBusinessUnit </witsml:businessUnit> [0..*]

'A business unit and related account or ownership share information.'

<witsml:facility> witsml:cs_productVolumeFacility </witsml:facility> [1..*]

'A facility for which product information is being reported.'

<witsml:commonData> witsml:cs_commonData </witsml:commonData> [0..1]

'A container element that contains elements that are common to all data objects.'

<witsml:customData> witsml:cs_customData </witsml:customData> [0..1]

'A container element that can contain custom or user defined data elements.'

</...>
Diagram
Schema Component Representation
<xsd:complexType name="obj_productVolume">
<xsd:complexContent>
<xsd:extension base=" witsml:abstractSingularDataObject ">
<xsd:sequence>
<xsd:element name="name" type=" witsml:nameStruct " minOccurs="1" maxOccurs="1"/>
<xsd:group ref=" witsml:grp_productVolume "/>
<xsd:element name="commonData" type=" witsml:cs_commonData " minOccurs="0" maxOccurs="1"/>
<xsd:element name="customData" type=" witsml:cs_customData " minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
<xsd:attributeGroup ref=" witsml:attgrp_uid "/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>