CARIS HPD : HPD® Server API : Paper Product Data : P_PPRAPI : UPDATEPANEL
 

UPDATEPANEL

Modify a panel definition.

Input

Parameter

Type

Description

p_panelver_id

NUMBER

Primary key of the panel version.

p_datumname

VARCHAR2

Horizontal datum name. This is the 4-character code from the datum.dat file.

p_helmert

HELMERT TYPE

Ellipsoid and projection information. The HELMERT_TYPE type contains the semi major axis, semi minor axis, origin_x, origin_y, origin_z, rotation_x, rotation_y, rotation_z, and scaling factor from the datum.dat file. If the panel is using a Helmert transformation to relate it to WGS- 84 then these values will be used for the Helmert transformation. Even if a block shift is being used to relate the panel to WGS-84, the semi-major and semi-minor axes listed here should be set to the values in the datum.dat entry, because those values affect the panel's geographic (lat/long) calculations.

p_xyshift

SHIFT_XY TYPE

Shift specified in meters. An x/y shift can not be specified if a latitude/longitude shift is also specified.

p_latlongshift

SHIFTLATLONG_TYPE

Shift specified in decimal degrees. A latitude/longitude shift can not be specified if an x/y shift is also specified.

p_pannam

VARCHAR2

Panel name.

p_pannum

NUMBER

Panel number.

p_panpos

VARCHAR2

XY offset from the lower left corner in mm. The format is X,Y where both values are positive.

p_pscale

NUMBER

Scale denominator.

p_bdrtyp

VARCHAR2

Border type.

p_depdat

VARCHAR2

Depth datum.

p_depunt

VARCHAR2

Depth unit.

p_hghtda

VARCHAR2

Height datum.

p_hghtun

VARCHAR2

Height unit.

p_pantit

VARCHAR2

Panel title.

p_pantyp

NUMBER

Type of panel.

NULL = Undefined

1 = Index

2 = Base

3 = Inset

4 = Extension

5 = Graphic

p_parusd

VARCHAR2

Parameter used.

p_prjctn

VARCHAR2

Projection information. This is a composite string composed of the projection name, central meridian, latitude of y coordinate origin, scale factor, scaling latitude 1, scaling latitude 2, and skew azimuth separated by commas.

The following projection names are supported:

AZIMUTHAL EQUIDISTANT

CASSINI

GNOMONIC

LAMBERT CONFORMAL CONIC

MERCATOR

POLAR STEREOGRAPHIC

POLYCONIC

RECTIFIED SKEW ORTHOMORPHIC

STEREOGRAPHIC

TRANSVERSE MERCATOR

Different projections require a different subset of the values - the non-required values can be set to zeroes.

p_pronam

VARCHAR2

Project name.

p_pusage

VARCHAR2

Deprecated - this parameter is not used.

p_shftns

NUMBER

Shift North/South.

p_shftew

NUMBER

Shift East/West.

p_srchdp

VARCHAR2

Source of the horizontal datum parameters.

p_srchdt

VARCHAR2

Source horizontal datum name.

p_symlib

VARCHAR2

Symbol library used.

p_sdgfc

VARCHAR2

Sounding feature code.

p_sdgsz

NUMBER

Sounding size in millimetres.

p_annoid

VARCHAR2

Identifier for annotations display.

p_presid

VARCHAR2

Identifier for display.

p_profile

NUMBER

ID of the profile.

p_rotate

NUMBER

Rotation angle of the panel, in degrees. 0, 90 and 270 are valid values.

p_panord

NUMBER

Order the panel will be drawn in.

p_sndrnd

VARCHAR2

Valid name from the Soundingrounding. xml file.

p_frcdsp

VARCHAR2

Fractional display value ('Y', 'N').

p_grtint

INTEGER

Latitude graticule interval, expressed in minutes. This is needed for BSB production.

p_test_mode

BOOLEAN

True to validate that the attribute can be set but not actually set the attribute.

Defaults to false.

Example

exec P_pprapi.updatepanel(&panelver_id, p_pannam => 'New Panel Name');

exec P_pprapi.updatepanel(&panelver_id, p_grtint => 10);

Exceptions

Not a valid panel version.

Panel attribute 'PSCALE' must be a positive integer

Panel attribute 'PANPOS' format is invalid. Format: (A,B) where A and B are numeric.

Projection format is invalid. Format sample: 'PROJECTION NAME,X.XXX,X.XXX,X.XXX,X.XXX,X.XXX,X.XXX' where X is numeric values only.

The Projection Name '<name>' is invalid or does not exist in the current list.

Empty or Null value found in Projection Parameter <X>.

Projection Parameter <X> contains multiple decimal points - only 1 is permitted.

Projection Parameter <X> is invalid or not numeric.

Profile '<profile>' does not belong to the '<editor_name>' editor.

Panel attribute 'PROFILE' must be a number. It is the profile id.

Panel attribute 'GRTINT' must be an integer in the range of 1 through 10800.

Value '<value>' for panel attribute 'PANORD' must be an integer in the range of 1 through 9999.

Value '<value>' for panel attribute 'PANORD' is already in use by another panel of the chart.

Value '<value>' for panel attribute '<acronym>' is already in use by another panel of the chart.

Panel attribute '<acronym>' cannot be UNDEFINED.

Panel attributes PANPOS, PSCALE, PRJCTN and PROFILE cannot be UNDEFINED.

Panel attributes PSCALE, PRJCTN, DATUM, and PROFILE cannot be changed when the panel contains data.

Panel attributes 'sndrnd', 'frcdsp', and 'PROFILE' cannot be set when there are multiple panel versions.

Value '<value>' is not valid for attribute '<acronym>'. Date format is YYYYMMDD, e.g. 20081231.

Value '<value>' is not valid for attribute '<acronym>'. It should be an integer.

Value '<value>' is not valid for attribute '<acronym>'. It should be a number.

Panel version identifier '<panelver_id>' is invalid or does not currently exist.

Chart 'p_chart_id' is inactive and can not be modified. (Yes, it'll say the chart_id, not the panelver_id).

Attribute '<ACRONYM>' is not an attribute of panel version '<PANELVER_ID>'.

Type '<TYPE>' was not expected. Acronym: '<ACRONYM>'. <--- this one is probably an internal error that you will never see.

List attributes are not supported.

Profile p_profile does not belong to the p_editor_name editor.

Invalid rotation value. Rotation can only be 0, 90, or 270.