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

SET_PANEL_ATTRIBUTE

Set the value of a panel attribute. Panel attributes PSCALE, PRJCTN, DATUM and PROFILE can only be changed when the panel does not contain any data. PANNAM, PANNUM and PANORD must be unique for a chart.

Input

Parameter

Type

Description

panelver_id

NUMBER

Panel version id. The panel version id is available from the view chart_sheet_panel_vw.

acronym

VARCHAR2

Attribute acronym.

Common attributes include PANPOS, PSCALE, CRS, PROFILE, SCAMIN_FILTER, PANNAM, PANNUM, sndrnd, and frcdsp.

value

VARCHAR2

New attribute value. NULL to set the value to undefined.

The following attributes cannot be set to undefined: PANPOS, PSCALE, CRS, PROFILE, sndrnd, frcdsp.

test_mode

BOOLEAN

True to validate that the attribute can be set but not actually set the attribute. Additional information will also be listed via DBMS_OUTPUT.

Defaults to false.

Example

exec p_pprapi.set_panel_attribute(&panelver_id,'PANNAM','CARIS CITY DOCKS');

Exceptions

• 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' can not 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 '<chart_id>' is inactive and cannot be modified.

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

• Type '<TYPE>' was not expected. Acronym: '<ACRONYM>'.

• List attributes are not supported.