II. Server Side Services

II-7. Tracking Services

TS001 setSymbolOrientation

void setSymbolOrientation(string ck, string angle)

where "ck" is the CARIS key of a point (or labeled point) feature and "angle" is the new orientation in degrees counter-clockwise from upright.

This method changes the orientation of the symbol associated with a point or labeled point feature. The feature must be transient, i.e. previously added by the client.

TS002 movePointToNewPosition

void movePointToNewPosition(string ck, string newX, string newY)

where ck is the CARIS key of a point (or labeled point) feature and "newX" and "newY" are the coordinates of a new position. The coordinates must be respectively projected Easting and Northing (or Longitude and Latitude, if the server is in the Geodetic mode). Projected coordinates must be ASCII versions of real numbers, while Geodetic coordinates must have the form in PS007.

This method moves a point or labeled point feature to a new position. The feature must be transient, i.e. previously added by the client.

TS003 zoomToFitPoints

void zoomToFitPoints(string ckList)

where "ckList" is a comma-separated list of CARIS keys, all of which identify point or labeled point features.

This method zooms and pans the display, such that all of the specified points are visible, at the largest possible scale.

TS004 createNewLineFeature

void createNewLineFeature(string ck, string fc, string xArray, string yArray, string array3)

where "ck" is a unique CARIS key, "fc" is feature code, and "xArray", "yArray", and "array3" are comma-separated lists of coordinates. "Array3" is optional, i.e. it may be NULL, and may contain either z-components or time. If "array3" contains time, each value must be in seconds from the standard time base. The arrays contain corresponding lists of coordinates and, therefore, must contain the same number of elements. The following are valid examples:

Example 1

xArray: "x0,x1,x2,x3"
yArray: "y0,y1,y2,y3"
array3: "NULL"

Example 2

xArray: "x0,x1,x2"
yArray: "y0,y1,y2"
array3: "t0,t1,t2"

where x’s and y’s are respectively the projected Easting and Northing coordinates, (or Longitude and Latitude, if the server is in the Geodetic mode). Projected coordinates must be ASCII versions of real numbers, while Geodetic coordinates must have the form given in PS007.

This method creates a transient line feature composed of line segments connecting the the given points, i.e. (x0,y0) is connected to (x1, y1), (x1,y1) is connected to (x2,y2) etc. The display characteristics are those obtained from the CARIS master file for the given feature code.

TS005 getDimension

short getDimension(string ck)

where "ck" is the CARIS key of a previously added line feature.

This method returns the number of dimensions associated with the points of the given line. The return value is either two or three, depending on whether "array3" (See ...) was NULL or not, when the line was created.

TS006 appendPointToLineFeature

void appendPointToLineFeature(string ck, string xNew, string yNew, string c3New)

where "ck" is the CARIS key of a previously created line feature, and "xNew", "yNew", and "c3New" are the coordinates of the new point. If the line identfied by "ck" has 2D points, i.e. "array3" (See TS004) was NULL when the line was created, "c3New" is ignored. x’s and y’s are respectively the projected Easting and Northing coordinates, (or Longitude and Latitude, if the server is in the Geodetic mode). Projected coordinates must be ASCII versions of real numbers, while Geodetic coordinates must have the form given in PS007.

This method adds a point to the given line. This results in the display of a new segment from the previous end point to the new point. The new segment has the same display characteristics as the original line.

TS007 showLineAsPoints

void showLineAsPoints(string ck, short state, string symCode)

where "ck" is the CARIS key of a previously created line feature, "state" is an integer between 0 and 2, inclusive, and "symCode" is the feature code of a point feature. The values of "state" have the following meanings:

STATE MEANING

0 Display line normally
1 Display line as points, i.e. show points only
2 Display both the original line and the points

This method changes the appearance of the line identified by "ck", in accordance with the value of "state". When points are displayed (state = 1 or 2), the symbol used for the points is obtained from the CARIS master file for the feature code given by "symCode". This method may be called as many times as desired for a particular line, either to modify the state and/or the symbol used for the points.

Note: a line feature in any of the above states can be set invisible, via setFeatureVisiblity; that is, if the line is in state 1 or 2, the point symbols also become invisible; to restore the visibility of such a line and ensure that it is displayed in the desired state, use showLineAsPoints, rather than setFeatureVisibility.

 

III. Client Side Services >>>>