The SDM_server permits a client to do the following [services are categorized as program, window, view, feature, visibility/color, wild card, tracking or client-side services.]:
Program ServicesWindow ServicesPS001: initSvc — initializes the two-way communication between the client and the SDM.
PS002: testSvc — tests the readiness of the SDM server service
PS003: exitApp — terminates the SDM
PS004 doComposition — invokes the SICOM Composition Plug-in
PS005: setClientMenu — appends a new pop-up menu to the SDM menu bar
PS006: modifyMenuText — replaces each text string in "oldTextList" for the existing menu with the text string in the corresponding position in "newTextList"
PS007: setForGeodeticPositions — places the SDM in geodetic position mode
PS008: openNewViewForFile — causes the SDM to load the given file for display
WS001: orderFront — brings the SDM main window to the front of all other applications
WS002: setCurrentViewByIndex — selects the subwindow of an MDI app as the current view, and brings it to the front of all other views
WS003: viewCount — returns the number of views (the number of maps currently open) in an MDI app
WS004: maximizeMainWnd — moves the SDM window to an x,y pixel location and to a size of nwidth, nheight in pixels
WS005: moveMainWnd — moves the SDM window to an x,y pixel location and to a size of n-width, n-height in pixels
WS006 minimizeMainWnd — minimizes or iconizes the SDM window
WS007: :restoreMainWnd — restores the SDM window to its normal size
WS008: minimizeOverviewWnd — minimizes or iconizes the SDM overview window. It is placed in the bottom of the SDM main window
WS009: restoreOverviewWnd — restores the SDM overview window to its normal size
WS010: openNewViewForFile — replaces the currently displayed map with the one given by "Path" in the SDI mode; opens a new child window (view) and loads with the map in the MDI mode
WS011: openNewViewForFile — copies the area displayed in the view to a device independent bitmap (DIB) on the system clipboard
View ServicesVS001: Picking Points
VS001-1: setSendPoint — sets SDM to accept a user’s mouse click and connect it to the earth coordinates.
VS001-2 getPoint — a one-way version of VS001-1. The Client will remain idle until a confirmation from the Server.
VS001-3 getX — gets the UTM easting coordinate associated with the user’s mouse click
VS001-4 getY — gets the UTM Northing coordinate associated with the user’s mouse click (
VS001-5 isOpComplete — confirms if the user clicks the mouse or not
VS002: View Modification
VS002-1 setOverview — resets the current view so as to display the entire map.
VS002-2 centerAtPoint — centers the current view on the given point
VS002-3.. zoomByPercent — zooms the current view by the given percentage, either in or out, as given by the second argument.
VS002-4 setDisplayedMapExtent sets the geographical area to be displayed
VS002-5 setZoomByRectMode — sets up the state of the SDM to allow a user to click and drag a rectangle of any size, on an SDM graphic window.
VS002-6 getDisplayScale — returns the denominator of the scale, i.e. if the scale is 1:n, n is returned, rounded to the nearest integer of the current view.
VS002-7 printCurrentDisplay — invokes the SDM print dialog.
VS002-8 openNewView — invokes the file Open dialog, the user is allowed to browse and select a file.
VS002-9 setSymbolizationOn — turns symbolization on or off in the current view, depending on whether "flag" is TRUE or FALSE, respectively.
VS002-10 redrawCurrent — redraws (refreshes) the current view
VS003 View Query
Feature ServicesVS003-1 getDisplayedMapExtent – provides the extent of the displayed map
FS001 Feature Selection and Query
FS001-1 setSelectFeatCode — sets up the state of SDM to accept a user’s mouse click on an SDM graphic window.
FS001-1a setSelectSingleFeature — allows the user to make a single feature selection, with automatic notification to the Client
FS001-1b setSelectFeatureCollection — allows the user to make a multiple feature selection, with automatic notification to the Client
FS001-2 selectFeature — is the same as FS001-1, except that a confirmation of mouse click is required.
FS001-2a selectSingleFeature — allows the user to make a single feature selection, without automatic notification to the Client
FS001-2b selectFeatureCollection — allows the user to make a multiple feature selection, without automatic notification to the Client
FS001-3 getPoint — Same as VS001-2, included here for completeness.
FS001-4 getX — Same as VS001-3, included here for completeness.
FS001-5 getY — Same as VS001-4, included here for completeness.
FS001-6 getStatus - confirms if a feature with the designated feature code is found
FS001-7 isOpenComplete — Same as VS001-6, included here for completeness
FS001-8 getKey — returns a comma-separated list of CARIS keys, one for each feature selected by any of the methods described in FS001-1a, FS001-1b, FS001-2a, and FS001-2b.
FS001-9 deselectAll — deselects any features selected by the user.
FS001-10 getFeaturesInsideShape — queries a specific closed shape to obtain a list of all POINT features, having a given feature code, that lie within the shape.
FS001-11 querySelectionByKey — returns a comma-separated list of name/value pairs of GIS properties for the feature with key "ck".
FS001-12 querySelectionByIndex — similar to FS001-11, please see RITI_SICOM2.0_TECH_99004.doc
FS001-13 setSelectionColor — changes the selection color (default is red) to the color defined by the parameter "colorIndex"
FS002 View Modification
FS002-1 zoomTofitFeature — pans and zooms, such that the feature identified by "ck" fills the display.
FS002-2 centerAt Feature — pans, such that the feature identified by "ck" is centered in the display.
FS003 Feature Addition/Deletion
FS003-1 createNewPointFeature — create a feature with the pre-determined symbol
FS003-2 createNewLabeledPointFeature — create a feature with the pre-determined symbol and label
FS003-3 addCircleToFeature — a circle feature with the given characteristics, centered at the feature identified by "ck"
FS003-4 addSmokeField — creates a smoke field (a special closed shape) for chemical fire application
FS003-6 deleteFeature — deletes the specific feature identified by "ck".
FS003-7 deleteFeatureAll — deletes all features having feature code "fcode".
Visibility/Color ServicesVCS001 setFeatureColor — sets the color of a feature defined by CARISKey "ck" to the color specified by "color"
VCS002 resetFeatureColor — resets the color of a feature with CARISKey "ck" back to its default color.
VCS003 setFeatureColorAll — sets the color of all features with the Feature Code "fcode" to the to the color specified by "color".
VCS004 resetFeatureColorAll — resets the color of all features with the Feature Code "fcode" back to the default color for "fcode".
VCS005 setFeatureVisibilityAll — sets the visibility for a given feature code, which may contain wild cards
VCS006 setFeatureVisibility — sets the visibility on or off for the feature identified by "ck".
VCS007 setLayerVisibility — sets the visibility on or off for the feature identified by a layer name.
VCS008 setSymbolizationOn — turns symbolization of features on and off.
Wild Card ServicesThe following API functions support wild cards:
FS001-1a setSelectSingleFeature
FS001-1b setSelectFeatureCollection
FS001-2a selectSingleFeature
FS001-2b selectFeatureCollection
FS001-10 getFeaturesInsideShape
VCS003 setFeatureColorAll
VCS004 resetFeatureColorAll
VCS005 setFeatureVisibilityAll
VCS006 resetFeatureVisibilityAll
TS001 setSymbolOrientation — changes the orientation of the symbol associated with a point or labeled point feature.
TS002 movePointToNewPosition — moves a point or labeled point feature to a new position.
TS003 zoomToFitPoints — zooms and pans the display, such that all of the specified points are visible, at the largest possible scale.
TS004 createNewLineFeature — creates a transient line feature composed of line segments connecting the the given points
TS005 getDimension — returns the number of dimensions associated with the points of the given line.
TS006 appendPointToLineFeature — adds a point to the given line.
TS007 showLineAsPoints — changes the appearance of the line identified by "ck", in accordance with the value of "state".
Client Side ServicesC-001: receiveSelectedFeature — receives CARIS key and UTM coordinates from the Server after the user’s click..
C-001a receiveSelectionStatus — receives the status of the selection
C-002: receivePoint — receives UTM coordinates from the Server after the user’s click.
C-003: receiveNewPointFeature — receive identifying information for a new point feature created by the user, via the SDM feature menu
C-004: quit
C005: receiveMenuAction — exposed by the client in order to provide a meaningful response to menu items in the popup menu installed via setClientMenu
C006: receivePointList — exposed by the client
[review services: program| window| view| feature| visibility/color| wild card | tracking | client-side ]