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

P_PPRAPI

 
ADDCHART
ADDSHEET
ADDPANEL
ADD_PANEL_SOURCE_USAGE
ALLOWALLCPSUPDATES
ALLOWSPECIFICCPSUPDATE
SET_CHART_ATTRIBUTE
SET_SHEET_ATTRIBUTE
SET_PANEL_ATTRIBUTE
DEL_PANEL_SOURCE_USAGE
UPDATECHART
UPDATESHEET
UPDATEPANEL
REMOVE_ALL_SOURCE_EXTRACTION
GETCHARTVERSIONATTRIBUTES
GETSHEETVERSIONATTRIBUTES
GETPANELVERSIONATTRIBUTES
GETUPDATES
GETHISTORY
CHART_OVERLAPS
RETIRE_PRODUCT_EDITION
UNRETIRE_PRODUCT_EDITION
SET_PRODUCT_UPDATE_STATUS
SET_CHART_LINK
SET_PRODUCT_GROUP

The P_PPRAPI package assists with the creation of paper chart products using API calls. There are also a number of views to support product-related operations. For more information on how to generate product information using HPD tools, see Paper Charts.

Name

Type

Description

ADDCHART

Function

Add a paper chart definition.

ADDSHEET

Function

Add a sheet to the chart. A chart may have only one sheet.

ADDPANEL

Function

Add a panel to the sheet. A sheet may have multiple panels.

ADD_PANEL_SOURCE_USAGE

Procedure

Add the specified source usage to the specified panel.

ALLOWALLCPSUPDATES

Procedure

Allow all updates from source to be available for the specified product. See ALLOWSPECIFICCPSUPDATE.

ALLOWSPECIFICCPSUPDATE

Procedure

Limit updates from source to specific features for the specified product. See ALLOWALLCPSUPDATES.

DEL_PANEL_SOURCE_USAGE

Procedure

Remove the specified source usage from the specified panel.

SET_CHART_ATTRIBUTE

Procedure

Set the value of a chart attribute.

SET_SHEET_ATTRIBUTE

Procedure

Set the value of a sheet attribute.

SET_PANEL_ATTRIBUTE

Procedure

Set the value of a panel attribute.

UPDATECHART

Function

Modify a paper chart definition.

UPDATESHEET

Function

Modify a sheet definition.

UPDATEPANEL

Function

Modify a panel definition.

REMOVE_ALL_SOURCE_EXTRACTION

Procedure

Clear source extractions from a panel so a new source extraction can be added.

GETCHARTVERSIONATTRIBUTES

Function

Return properties of a chart instance.

GETSHEETVERSIONATTRIBUTES

Function

Return properties of a sheet.

GETPANELVERSIONATTRIBUTES

Function

Return properties of a panel.

GETUPDATES

Procedure

Find all objects in the source (within panel limits) that did not get included in the panel.

GETHISTORY

Function

Retrieve the history of a feature since it was included in the product, or at least cycle back through each iteration.

CHART_OVERLAPS

Function

Return a list of charts that share the same selected feature.

SET_PRODUCT_UPDATE_STATUS

Procedure

Set a Paper Chart Update to Locked, Rejected or Active.

RETIRE_PRODUCT_EDITION

Procedure

Set a Paper Chart Edition to Retired.

UNRETIRE_PRODUCT_EDITION

Procedure

Un-retire a Paper Chart Edition.