CARIS HPD : HPD® Server API : Vector Product Data : P_GPEAPI : ADDGPEDEFINITION
 

ADDGPEDEFINITION

Add a GML product definition.

Input

Parameter

Type

Description

v_attfle

NUMBER

ATTF lexical level.

v_natfle

NUMBER

NATF lexical level.

v_hordat

NUMBER

Horizontal datum.

v_sdatum

NUMBER

Sounding datum.

v_verdat

NUMBER

Vertical datum.

v_hunits

NUMBER

Height/length units.

v_dunits

NUMBER

Depth units.

v_punits

NUMBER

Positional accuracy units.

v_navpur

NUMBER

Navigational purpose.

v_prcode

VARCHAR2

The binary code for producer.

v_edinum

NUMBER

Product edition number.

v_updnum

VARCHAR2

Product update number.

v_compsc

NUMBER

Compilation scale of data.

v_datset

VARCHAR2

Data set file name.

v_name

VARCHAR2

Product name.

v_commen

VARCHAR2

Product comments.

v_isudat

DATE

Product issued date.

v_geom

sdo geometry

Coverage area.

v_profile

NUMBER

ID of profile.

v_productgroup

VARCHAR2

The name of a product group. The product is assigned to this product group. This defaults to NULL which is valid if access control is not being used.

Example

DECLARE

  -- GPE Product Parameters and Attributes.

  v_ATTFLE        NUMBER              := 1;

  v_NATFLE        NUMBER              := 2;

  v_HORDAT        NUMBER              := 9;

  v_SDATUM        NUMBER              := 1; -- enumeration

  v_VERDAT        NUMBER              := 1; -- enumeration

  v_HUNITS        NUMBER              := 2; -- enumeration

  v_DUNITS        NUMBER              := 1; -- enumeration

  v_PUNITS        NUMBER              := 1; -- enumeration

  v_NAVPUR        NUMBER              := 1;

  v_EDINUM        VARCHAR2(1)         := '1';

  v_PRCODE        VARCHAR2(3)         := '042';

  v_UPDNUM        VARCHAR2(3)         := '1.0';

  v_DATSET        VARCHAR2(3)         := 'GPE';

  v_NAME          VARCHAR2(255)       := 'API Created GPE Product.';

  v_COMMEN        VARCHAR2(255)       := 'This is a API created GPE Product.';

  v_COMPSC        NUMBER              := 10000;

  v_ISUDAT        DATE                := SYSDATE;

  v_PROFILE       NUMBER(38)          := 6; -- S-57 ENC Profile.

  v_PRODUCTGROUP  VARCHAR2(100)       := NULL; -- Use the default Product Group.

  v_GEOM          SDO_GEOMETRY        := NULL;

 

  -- Source Extraction Parameters.

  v_usage_name    VARCHAR2(800)       := 'Berthing(1-2499)';

  v_product_id    NUMBER;

 

BEGIN

 

  -- Geometry for product boundary

  v_GEOM:= SDO_GEOMETRY(2003, NULL, NULL,

       SDO_ELEM_INFO_ARRAY(1, 1003, 3),

       SDO_ORDINATE_ARRAY(-74.44668703,39.87196662,

                          -72.94862913,41.43018760));

 

  -- Create new GPE product

  v_product_id := P_GPEAPI.ADDGPEDEFINITION (

  v_ATTFLE, v_NATFLE, v_HORDAT, v_SDATUM, v_VERDAT, v_HUNITS, v_DUNITS,

  v_PUNITS, v_NAVPUR, v_PRCODE, v_EDINUM, v_UPDNUM, v_COMPSC, v_DATSET,

  v_NAME, v_COMMEN,   v_ISUDAT,   v_GEOM, v_PROFILE, v_PRODUCTGROUP);

 

 

  -- Add a source usage to the product.

  P_VECTORAPI.ADD_SOURCE_USAGE(v_product_id, v_usage_name);

 

  -- Add Source Extraction

  P_ENCAPI.ADD_SOURCE_EXTRACTION(v_product_id, v_GEOM);

 

  -- Display the ID for the newly created product

  DBMS_OUTPUT.PUT_LINE('--*-- Created GPE Product ID: ' || v_product_id);

END;

/

Exceptions

Not a valid product version ID

The product version is already cut

Attribute ’%%’ is required.

No matched INTEGER type for ’%%’

No matched Enumeration type for ’%%’

Wrong enumeration value for ’%%’

No matched String type for ’%%’

Profile ID p_profile_id is invalid or does not currently exist.

Profile p_profile does not belong to the p_editor_name editor.

The Edition Number provided EDITION_NUMBER is invalid. This value must be a whole Number greater than 0.