Libraries
PointList Source Code
 previous   up   next 

Types
pointList
Describes a list of 2-D point coordinates.

pointList

const type: pointList

Describes a list of 2-D point coordinates.


Operator Summary
boolean
(in pointList: pointList1) = (in pointList: pointList2)
Checks if two pointList values are equal.
boolean
(in pointList: pointList1) <> (in pointList: pointList2)
Checks if two pointList values are not equal.

Function Summary
bstring
bstring (in pointList: aPointList)
Converts a pointList value to a bstring value.
pointList
pointList (in bstring: bstri)
Converts a bstring value to a pointList value.
integer
compare (in pointList: pointList1, in pointList: pointList2)
Compares two pointList values.
integer
hashCode (in pointList: aPointList)
Computes the hash value of a pointList.
pointList
genPointList (ref array integer: coordinates)
The function 'genPointList' creates a 'pointList'.
array integer
xyArray (ref pointList: aPointList)
Converts a 'pointList' to an array of (X,Y) coordinates.

Operator Detail

=

const func boolean: (in pointList: pointList1) = (in pointList: pointList2)

Checks if two pointList values are equal.

Returns:
TRUE if both values are equal, FALSE otherwise.

<>

const func boolean: (in pointList: pointList1) <> (in pointList: pointList2)

Checks if two pointList values are not equal.

Returns:
FALSE if both values are equal, TRUE otherwise.

Function Detail

bstring

const func bstring: bstring (in pointList: aPointList)

Converts a pointList value to a bstring value.

Returns:
the converted value as pointList.

pointList

const func pointList: pointList (in bstring: bstri)

Converts a bstring value to a pointList value.

Returns:
the converted value as bstring.

compare

const func integer: compare (in pointList: pointList1, in pointList: pointList2)

Compares two pointList values.

Returns:
-1, 0 or 1 if the first argument is considered to be respectively less than, equal to, or greater than the second.

hashCode

const func integer: hashCode (in pointList: aPointList)

Computes the hash value of a pointList.

Returns:
The hash value.

genPointList

const func pointList: genPointList (ref array integer: coordinates)

The function 'genPointList' creates a 'pointList'. It converts an array of alternate x and y values to a 'pointList'.

Returns:
a pointList with the points from the array.
Raises:
RANGE_ERROR - If the length of the array is odd.

xyArray

const func array integer: xyArray (ref pointList: aPointList)

Converts a 'pointList' to an array of (X,Y) coordinates.

Returns:
an array of alternate x and y values.


 previous   up   next