カルトスクリプト用 SML 関数解説 for TNTmips ver6.6

Math functions (65)

Absolute value

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

none

Returns:

number
|x| in same format as input value,
that is, float for input gives float for output

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     a = -6
     b = abs(2 * a)   # b = 12
     print(b)

trigonometric arccosine

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

x must be between -1 and 1, inclusive

Returns:

number
an angle in radians

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     b = acos(0.5)
     print(b)
     # b = 1.0471975511965979

trigonometric arccosine (degree version)

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

x must be between -1 and 1, inclusive

Returns:

number
an angle in degrees

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

hyperbolic arccosine

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

none

Returns:

number
an angle in radians

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     b = acosh(0.5)
     print(b)
     # b = NULL

hyperbolic arccotangent

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

When values outside the domain are used, the solution is defined
as either Infinity or -Infinity.

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     b = acoth(0)
     print(b)
     # b = NULL

hyperbolic arccosecant

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

The solution at zero is taken to be the limit as one approaches
zero from the positive x axis.

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     b = acsch(0)
     print(b)
     # b = Infinity

hyperbolic arcsecant

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     b = asech(1)
     print(b)   # b = 0

trigonometric arcsine

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

x must be between -1 and 1, inclusive

Returns:

number
an angle in radians

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     a = sqrt(3) / 2
     b = deg * asin(a)
     print(b)
     # b = 59.99999999999999

trigonometric arcsine (degree version)

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

x must be between -1 and 1, inclusive

Returns:

number
an angle in degrees

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

hyperbolic arcsine

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

none

Returns:

number
a number in the same format as the input parameter

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     a = (exp(0) - exp(-0)) / 2
     b = asinh(a)
     print(b)   # b = 0

trigonometric arctangent

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

none

Returns:

number
an angle in radians

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     a = 1 ; b = deg * atan(a)
     print(b)   # b = 45

trigonometric arctangent

Where:

[Function / Math]

Parameters:

y : number

any expression evaluating to a number corresponding
to the non-hypotenuse side of a right triangle
opposite the angle of interest

x : number

any expression evaluating to a number corresponding
to the non-hypotenuse side of a right triangle
adjacent to the angle of interest

Details:

none

Returns:

number
an angle in radians such that 0 <= angle <= 360. The quadrant
of the unit circle in which the triangle falls is maintained.

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     a = sqrt(3) / 2 ; b = -.5
     c = deg * atan2(a, b)
     print(c)   # c = 120

trigonometric arctangent (degree version)

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

none

Returns:

number
an angle in degrees

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

hyperbolic arctangent

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

none

Returns:

number
a number in the same format as the input parameter

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     a = exp(0) - exp(-0)
     b = exp(0) + exp(-0)
     c = atanh(a/b)
     print(c)   # c = 0

Force a value into given range.

Where:

[Function / math]

Parameters:

val : number

the value to bound

min : number

minimum value to bound to

max : number

maximum value to bound to

Details:

none

Returns:

number
number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of Bound()

Round decimal up to integer

Where:

[Function / Math]

Parameters:

x : number

any expression evaluating to a number

Details:

none

Returns:

number
an integer

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     a = ceil(7.499)   # a = 8
     b = ceil(7.001)   # b = 8
     c = ceil(-7.01)   # c = -7
     d = ceil(-7.99)   # d = -7
     print(a, b, c, d)

Converts polar coordinates to rectangular (radians).

Where:

[Function / math]

Parameters:

theta : number

theta value

r : number

r value

x : numeric variable

the x coordinate of the point

y : numeric variable

the x coordinate of the point

Details:

none

Returns:

nothing

Create Date: 16-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of ConvertPolartoXY()

Converts polar coordinates to rectangular (degrees).

Where:

[Function / math]

Parameters:

theta : number

theta value

r : number

r value

x : numeric variable

the x coordinate of the point

y : numeric variable

the x coordinate of the point

Details:

none

Returns:

nothing

Create Date: 16-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of ConvertPolartoXYd()

Converts polar coordinates to rectangular (radians).

Where:

[Function / math]

Parameters:

rho : number

rho value

theta : number

theta value

phi : number

phi

x : numeric variable

the x coordinate of the point

y : numeric variable

the y coordinate of the point

z : numeric variable

the z coordinate of the point

Details:

none

Returns:

nothing

Create Date: 17-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of ConvertSphericaltoXYZ()

Converts polar coordinates to rectangular (degrees).

Where:

[Function / math]

Parameters:

rho : number

rho value

theta : number

theta value

phi : number

phi

x : numeric variable

the x coordinate of the point

y : numeric variable

the y coordinate of the point

z : numeric variable

the z coordinate of the point

Details:

none

Returns:

nothing

Create Date: 17-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of ConvertSphericaltoXYZd()

Converts rectangular coordinates to polar (radians).

Where:

[Function / math]

Parameters:

x : number

the x coordinate of the point

y : number

the y coordinate of the point

theta : numeric variable

theta value

r : numeric variable

r value

Details:

none

Returns:

nothing

Create Date: 16-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of ConvertXYtoPolar()

Converts rectangular coordinates to polar (degrees).

Where:

[Function / math]

Parameters:

x : number

the x coordinate of the point

y : number

the y coordinate of the point

theta : numeric variable

theta value

r : numeric variable

r value

Details:

none

Returns:

nothing

Create Date: 16-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of ConvertXYtoPolard()

Converts rectangular coordinates to spherical (radians).

Where:

[Function / math]

Parameters:

x : number

the x coordinate of the point

y : number

the y coordinate of the point

z : number

Z coordinate

rho : numeric variable

rho value

theta : numeric variable

theta value

phi : numeric variable

phi value

Details:

none

Returns:

nothing

Create Date: 17-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of ConvertXYZtoSpherical()

Converts rectangular coordinates to spherical (degrees).

Where:

[Function / math]

Parameters:

x : number

the x coordinate of the point

y : number

the y coordinate of the point

z : number

Z coordinate

rho : numeric variable

rho value

theta : numeric variable

theta value

phi : numeric variable

phi value

Details:

none

Returns:

nothing

Create Date: 17-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of ConvertXYZtoSphericald()

Copies a given range of elements form one array into another.

Where:

[Function / Math]

Parameters:

dest : array

Array that you want values copied into

source : array

Array that you want values copied from

dest_start : number

Destination start position

dest_end : number

Destination end position

source_start : number

Source start position

source_end : number

Source end position

Details:

The copy ranges must be equal and all values in the range must be valid.

Returns:

nothing

Create Date: 22-Jul-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     clear();
     Array a1[10];
     Array a2[10];
     for x=1 to 10{
     	a1[x]=20+x;
     	a2[x]=x;
     }
     CopyArrayElements(a2,a1,3,6,5,8);
     for x=1 to 10{
     	print(a2[x]);
     }

trigonometric cosine

Where:

[Function / Math]

Parameters:

x : number

any expression that evaluates to a number

Details:

x is in radians

Returns:

number
a floating point number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(cos(60 / deg))   # prints .500000000000001

trigonometric cosine (degree version)

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

x is in degrees

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

hyperbolic cosine

Where:

[Function / Math]

Parameters:

x : number

any expression that evaluates to a number

Details:

none

Returns:

number
a floating point number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(cosh(0))   # prints 1

trigonometric cosecant

Where:

[Function / Math]

Parameters:

x : number

any expression that evaluates to a number

Details:

x is in radians

Returns:

number
a floating point number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(csc(30 / deg))   # prints 2

trigonometric cosecant (degree version)

Where:

[Function / Math]

Parameters:

x : number

any expression that evaluates to a number

Details:

x is in degrees

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

trigonometric cotangent

Where:

[Function / Math]

Parameters:

x : number

any expression that evaluates to a number

Details:

x is in radians

Returns:

number
a floating point number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(ctn(0 / deg))   # prints Infinity

trigonometric cotangent (degree version)

Where:

[Function / Math]

Parameters:

x : number

any expression that evaluates to a number

Details:

x is in degrees

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Calculate the distance, azimuth, and elevation from the first point to the second (radians).

Where:

[Function / math]

Parameters:

x1 : number

the x coordinate of the first point

y1 : number

the y coordinate of the first point

z1 : number

First z coordinate

x2 : number

Second x coordinate

y2 : number

Second y coordinate

z2 : number

Second z coordinate

distance : numeric variable

distance value

azimuth : numeric variable

azimuth value

elevation : numeric variable

elevation value

Details:

none

Returns:

nothing

Create Date: 17-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of Displacement3D()

Calculate the distance, azimuth, and elevation from the first point to the second (degrees).

Where:

[Function / math]

Parameters:

x1 : number

the x coordinate of the first point

y1 : number

the y coordinate of the first point

z1 : number

First z coordinate

x2 : number

Second x coordinate

y2 : number

Second y coordinate

z2 : number

Second z coordinate

distance : numeric variable

distance value

azimuth : numeric variable

azimuth value

elevation : numeric variable

elevation value

Details:

none

Returns:

nothing

Create Date: 17-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of Displacement3Dd()

Exponential (e to the power of x)

Where:

[Function / Math]

Parameters:

x : number

any expression that evaluates to a number

Details:

none

Returns:

number
a floating point number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(exp(-1/0))   # prints 0

Exponential (10 to the power of x)

Where:

[Function / Math]

Parameters:

x : number

any expression that evaluates to a number

Details:

none

Returns:

number
a floating point number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(exp10(3))   # prints 1000

Round decimal down to integer

Where:

[Function / Math]

Parameters:

x : number

any expression that evaluates to a number

Details:

none

Returns:

number
the next lower integer value

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(floor(7.5))   # prints 7
     print(floor(-7.5))   # prints -8

Get scale factor for angle unit conversions.

Where:

[Function / math]

Parameters:

from$ : string

named unit conversion

to$ : string

named unit conversion

Details:

none

Returns:

number
number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of GetUnitConvAngle()

Get scale factor for area unit conversions.

Where:

[Function / math]

Parameters:

from$ : string

named unit conversion

to$ : string

named unit conversion

Details:

none

Returns:

number
number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of GetUnitConvArea()

Get scale factor for distance unit conversions.

Where:

[Function / math]

Parameters:

from$ : string

named unit conversion

to$ : string

named unit conversion

Details:

none

Returns:

number
number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of GetUnitConvDist()

Get scale factor for volume unit.

Where:

[Function / math]

Parameters:

from$ : string

named unit conversion

to$ : string

named unit conversion

Details:

none

Returns:

number
number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of GetUnitConvVolume()

Find hypotenuse of right triangle

Where:

[Function / Math]

Parameters:

dx : number

a number representing the horizontal component of
the right triangle

dy : number

a number representing the vertical component of
the right triangle

Details:

none

Returns:

number
a number (sqrt((sqr(dx)+sqr(dy)))

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear(); dx = 3; dy = 4
     print(hypot(dx, dy))   # 5

Integer portion of argument (truncate)

Where:

[Function / Math]

Parameters:

x : number

a decimal number

Details:

none

Returns:

number
a base 10 integer rounded down

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     a = int(7.7)   # a = 7
     a = int(-7.7)   # a = -8

Does the argument have the value NULL?

Where:

[Function / Math]

Parameters:

x : list of numbers

a number(or infinity or NULL)

Details:

NULL is by definition unknown. Therefore it cannot be
compared to any value, including NULL. Therefore
IsNull() is used to determine if a numerical value is
NULL.

Returns:

number
TRUE(1) if num is NULL
FALSE(0) if num is not NULL

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(IsNull(NULL))

Calculate the linear regression coeficients for a group of points.

Where:

[Function / math]

Parameters:

x : array

the x coordinates of the points

y : array

the y coordinates of the points

num : number

the number of points

slope : numeric variable (optional)

slope returned

intercept : numeric variable (optional)

intercept returned

omit : number (optional)

use to create "jack-knife" slope

Details:

none

Returns:

number
number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of LinearRegression()

Natural logarithm of argument

Where:

[Function / Math]

Parameters:

x : number

a number

Details:

log(0) = -infinity
log(-1) = -infinity (normally undefined)
log(infinity) = infinity

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print("Enter a number.") ; a=input
     print("log(x)=", log(x))

Base 10 logarithm of argument

Where:

[Function / Math]

Parameters:

x : number

XXX

Details:

log10(0) = -infinity
log10(-1) = -infinity (normally undefined)
log10(infinity) = infinity

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print("Enter a number.") ; a=input
     print("log10(x)=", log10(x))

Computes an equation of given power that best fits the given points.

Where:

[Function / math]

Parameters:

x : array

Array of the x coordinates

y : array

Array of the y coordinates

num : number

Number of points

power : number

Power to wich the polynomial should be

carray : array (optional)

Array to store the coeffecients of the polynomial

r : numeric variable (optional)

The multiple correlation coefficient, basically how well the polynomial fits the points
A value between 0 and 1 with 1 being a perfect fit and 0 being absolutely no correlation

Details:

Power must be less then 15

Returns:

string
String containing the function.

Create Date: 22-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of PolynomialCurveFit()
     clear();
     array xpoints[4];
     array ypoints[4];
     array carray[3];
     xpoints[1]=-1;
     xpoints[2]=0;
     xpoints[3]=1;
     xpoints[4]=2;
     ypoints[1]=4;
     ypoints[2]=10;
     ypoints[3]=20;
     ypoints[4]=34;
     string$=PolynomialCurveFit(xpoints,ypoints,4,2,carray,r);
     printf("%s\n",string$);
     printf("%f %f %f\n",carray[1],carray[2],carray[3]);
     printf("r = %f\n",r);

return x to the power of y

Where:

[Function / Math]

Parameters:

x : number

a number

y : number

a number

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(pow(2, 3))   # 8

Returns random value between zero (0) and x

Where:

[Function / Math]

Parameters:

x : number

a number, positive or negative

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     print(rand(1))

Computes a pair of random numbers based on a normal distibution.

Where:

[Function / math]

Parameters:

mu : number

mu value (the value you want your random numbers around)

sigma : number

standard deviation

x1 : numeric variable

first number in the pair of numbers returned

x2 : numeric variable

second number

Details:

none

Returns:

nothing

Create Date: 21-Jun-1999
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of RandomGaussian()

Resize a one dimensional array ( a[col] ), or two dimensional array ( a[row, col] )

Where:

[Function / Miscellaneous]

Parameters:

array : array

the array to resize

index1Size : number

New index size (column for one dimensional array, row for dimensional dim array)

index2Size : number (optional)

New column size (two dimensional array only)

Details:

the new array is set to all zeros

Returns:

nothing

Create Date: 08-Oct-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of ResizeArrayClear()
 
       array a[3];
       array a2[3, 4];
 
       ResizeArrayClear(a, 5); # increase size of one dimensional array
       ResizeArrayClear(a, 2); # decrease size of one dimensional array
 
       ResizeArrayClear(a2, 5, 6); # increase size of two dimensional array
       ResizeArrayClear(a2, 2, 3); # decrease size of two dimensional array

Resize a one dimensional array ( a[col] ), or two dimensional array ( a[row, col] )

Where:

[Function / Miscellaneous]

Parameters:

array : array

the array to resize

index1Size : number

New index size (column for one dimensional array, row for two dimensional array)

index2Size : number (optional)

New column size (two dimensional array only)

Details:

if the array is enlarged the extra values will be set to zero
but the origional values will be preserved

Returns:

nothing

Create Date: 08-Oct-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of ResizeArrayPreserve()
 
       array a[3];
       array a2[3, 4];
 
       ResizeArrayPreserve(a, 5); # increase size of one dimensional array
       ResizeArrayPreserve(a, 2); # decrease size of one dimensional array
 
       ResizeArrayPreserve(a2, 5, 6); # increase size of two dimensional array
       ResizeArrayPreserve(a2, 2, 3); # decrease size of two dimensional array

Round x to nearest integer

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

Values ending with .5 are rounded up.

Returns:

number
an integer

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     print(round(10.5))   # 11
     print(round(-10.5)   #-10

trigonometric secant

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

x is in radians

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     print(sec(60/deg))

trigonometric secant (degree version)

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

x is in degrees

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Return -1, 0 or 1 depending on sign of argument

Where:

[Function / math]

Parameters:

x : number

XXX

Details:

none

Returns:

number
number

Create Date: 20-Jun-2000
Modify Date: none
Available in SML for Windows: Yes

trigonometric sine

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

x is in radians

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(sin(30/deg))   #.5

trigonometric sine (degree version)

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

x is in degrees

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

hyperbolic sine

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

x is in radians

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(sinh(0))   # 0

Return the square of the argument

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(sqr(-3))   # 9

Returns the (positive) square root of the argument

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

x >= 0. If x < 0 then zero will be returned, which may
result in unexpected results.

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(sqrt(9))   # 3
     print(sqrt(-9))   # 0

trigonometric tangent

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

x is in radians

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

      clear()
      print(tan(90/deg))   # -2147483648 (roundoff error)

trigonometric tangent (degree version)

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

x is in degrees

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

hyperbolic tangent

Where:

[Function / Math]

Parameters:

x : number

any expression which evaluates to a number

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

      clear()
      print(tanh(0))   # 0

Date functions (6)

Returns the current date in YYYYMMDD format

Where:

[Function / Date]

Details:

YYYYMMDD is the format used internally in TNT databases.

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     x=Date() ; print(x)

Returns number of days between two dates

Where:

[Function / Date]

Parameters:

yyyymmdd1 : number

a number in YYYYMMDD format

yyyymmdd2 : number

a number in YYYYMMDD format

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     x=DateDiff(19960101, 19970101)
     print(x)   # 365

Converts YYYYMMDD format to Julian date

Where:

[Function / Date]

Parameters:

yyyymmdd : number

a number in YYYYMMDD format

Details:

YYYYMMDD is the format used internally in TNT databases.

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     x=DateToJulian(19960101)
     print(x) ; print(JulianToDate(x))

Convert a number date to a string.

Where:

[Function / date]

Parameters:

yyyymmdd : number

the date to convert

format$ : string (optional)

the format to convert to

Details:

If the format parameter is omitted, a default format will be
used. Otherwise, the format string can have any of the following
special codes:

%% Same as %
%a abbreviated weekday name
%A full weekday name
%b abbreviated month name

Returns:

string
string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of DateToString()

Returns the current Julian date

Where:

[Function / Date]

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     x=JulianDate() ; print(x)

Converts Julian date to YYYYMMDD format

Where:

[Function / Date]

Parameters:

julian : number

a number

Details:

YYYYMMDD is the format used internally in TNT databases.

Returns:

number
a number in YYYYMMDD format

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     x=DateToJulian(19960101)
     print(x) ; print(JulianToDate(x))

Set functions (11)

Most frequently occurring value among arguments

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

In a tie, the first item encountered is returned.

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetMajority(1, 3, 3, 4, 4, 5))   # prints 3

Returns the largest of argument values

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetMax(1, 3, 3, 4, 4, 5))   # prints 5

Returns average of argument values

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetMean(1, 3, 5))   # prints 3

Returns the median of argument values

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetMean(1, 3, 7))   # prints 3

Returns minimum value among arguments

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetMean(1, 3, 5))   # prints 1

Least frequently occurring value among arguments

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

In a tie, the first item encountered is returned.

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetMinority(1, 3, 3, 4, 4, 5))   # prints 1

Returns the total number of elements

Where:

[Function / Set]

Parameters:

x1 : list of numbers or strings

First value

x2 : list of numbers or strings (optional)

Second value

... : list of numbers or strings (optional)

(any number of values)

Details:

none

Returns:

number
an integer

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetNum(2, 1, 3, 4, 99))   # returns 5

Returns standard deviation of argument values

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetSD(2, 1, 3, 4, 99))

Returns sum of arguments

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetSum(2, 1, 3, 4, 99))   # prints 109

Returns statistical variance of argument values

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetVariance(2, 1, 3, 4, 99))

Returns number of different values among arguments

Where:

[Function / Set]

Parameters:

x1 : list of numbers

First value

x2 : list of numbers (optional)

Second value

... : list of numbers (optional)

(any number of values)

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print(SetVariety(2, 1, 3, 4, 99))

String functions (15)

Convert an angle in degress to an angle in degress, minutes, seconds format.

Where:

[Function / String]

Parameters:

num : number

angle in degrees

Details:

none

Returns:

string
A string containing degrees, minutes, and seconds of the angle.

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear();
     print(DegToStr(94.345));

Returns file extension portion of path qualified filename

Where:

[Function / string]

Parameters:

filename$ : string

the path qualified filename

Details:

none

Returns:

string
string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of FileNameGetExt()

Returns filename portion of path qualified filename

Where:

[Function / string]

Parameters:

filename$ : string

the path qualified filename

Details:

none

Returns:

string
string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of FileNameGetName()

Returns path portion of path qualified filename

Where:

[Function / string]

Parameters:

filename$ : string

the path qualified filename

Details:

none

Returns:

string
string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of FileNameGetPath()

Get the nth token from a string

Where:

[Function / string]

Parameters:

string$ : string

the string to get the token from

delimiters$ : string

the characters that delimit tokens

tokenNumber : number

the token number to get

compress : number (optional)

1 (default) to treat multiple consecutive tokens as one, 0 to accept each one

Details:

none

Returns:

string
string

Create Date: 25-Sep-1998
Modify Date: 05-Jun-2001
Available in SML for Windows: Yes

Example:

       # Example of GetToken()
       clear();
 
       str$ = "a  b c,d";
       delimit$ = " ,";
 
       n = NumberTokens(str$, delimit$);
 
       for i = 1 to n {
          token$ = GetToken(str$, delimit$, i);
          print(i, token$);
          }

Return leftmost n characters of string

Where:

[Function / String]

Parameters:

str$ : string

a string

length : number

an integer

Details:

1 <= n - if n is longer than Len(string$), then the
entire string is returned.

Returns:

string
a string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print("Enter a sentence.") ; a$=input$()
     print("Enter # of chars to get.")) ; n=input()
     print(left$(a$, n))

Return n characters of string$ starting at m

Where:

[Function / String]

Parameters:

str$ : string

a string

start : number

an integer

length : number

an integer

Details:

1 <= m , n <= length of string, 1 <= m+n <= length of string
If m is greater then the length of str$, then nothing is returned.
If m is in the normal range, but m+n is greater than the length of
str$, then the entire string to the right of m is returned.

Returns:

string
a string, starting with the mth character

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print("Enter a sentence.") ; a$=input$()
     print("Enter start position.")) ; m=input()
     print("Enter # of chars to get.")) ; n=input()
     print(mid$, m, n))

Returns number of tokens in a string

Where:

[Function / string]

Parameters:

string$ : string

the string to find tokens in

delimiters$ : string

the characters that delimit tokens

Details:

none

Returns:

number
number

Create Date: 25-Sep-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of NumberTokens()
       clear();
 
       str$ = "a  b c,d";
       delimit$ = " ,";
 
       n = NumberTokens(str$, delimit$);
 
       for i = 1 to n {
          token$ = GetToken(str$, delimit$, i);
          print(i, token$);
          }

Convert a number to a string

Where:

[Function / math]

Parameters:

num : number

Number to convert

Details:

none

Returns:

string
string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

       # Example of NumToStr()

Return right-most n characters of string$

Where:

[Function / String]

Parameters:

str$ : string

a string

length : number

an integer

Details:

1 <= n - If n is greater than the length of string$, then
the entire string is returned.

Returns:

string
a string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     a$="Reenter this sentence."
     print(a$) ; b$=input$()
     print("Enter n.")
     n=input()
     print(right$(a$, n))
     print(right$(b$, n))

Assign formatted text to a string variable

Where:

[Function / String]

Parameters:

format$ : string

printf-style format string.

The format string is scanned for format specification fields, which all start with
a percent sign (%). Each format specification is replaced by the value of the next
parameter passed after the format string. There should be a value passed for each
format specification field.

Format Specification fields have the following form (parts in square brackets are
optional)

%[flags][width][.precision]type

flags
Optional characters to control justification and sign display
- : Left align the result within the field
+ : Prefix numeric value with a sign (+ or -), even if positive
0 : If with is prefixed with a zero, the number will have leading zeros

width
Optional number that specifies the minimum number of characters output

precision
Optional number that specifies the maximum number of digits after the
decimal place for floating point numbers

type
Required character specifying the type of parameter to output
s : String
d : Signed decimal integer
u : Unsigned decimal integer
o : Unsigned octal integer
x : Unsigned hexadecimal integer, using "abcdef"
X : Unsigned hexadecimal integer, using "ABCDEF"
c : A single character, specified the ASCII value.
e : Floating point value in scientific notation (e.g.: 1e6 for 1,000,000)
f : Floating point value, not in scientific notation
g : Floating point value in e or f format, whichever is more compact


value : any value (optional)

etc. one or more numbers or strings

... : any value (optional)

optional additional strings or numbers

Details:

This function allows formatting to be applied to
strings which may then be used in regular print
statements. This helps prevent formatted printf()
statements from becoming unwieldy. Specifications for
the format string are too numerous to list here - see the
reference manual for information on format strings.

Returns:

string
a (formatted) string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     format$="%s%d%s\n%s"
     str1$="This is line " ; str2$="you see."
     str3$="This is line 2" ; number=1
     s4$=sprintf(format$, str1$, 1, str2$, str3$)
     print(s4$)

Returns number of characters in string variable

Where:

[Function / Math]

Parameters:

str$ : string

a string

Details:

none

Returns:

number
an integer

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

      clear()
      print("Enter a string. ") ; a$=input$()
      print(strlen(a$))

Return numerical value of string with number in it

Where:

[Function / Math]

Parameters:

str$ : string

a string

Details:

The first non-whitespace characters encountered must be
numerical for a number to be returned.

Returns:

number
a number in base 10

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     print("Enter a string. ") ; a$=input$()
     b=StrToNum(a$) ; print(b/10)

Convert string to lower case

Where:

[Function / string]

Parameters:

string$ : string

input string

Details:

none

Returns:

string
string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

       # Example of tolower$()

Convert string to upper case

Where:

[Function / string]

Parameters:

string$ : string

input string

Details:

none

Returns:

string
string

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

       # Example of toupper$()

Database functions (32)

Get database table information

Where:

[Function / database]

Parameters:

database : class DATABASE

the database

name : any value

name of the table

Details:

none

Returns:

class DBTABLEINFO
class DBTABLEINFO

Create Date: 29-May-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of DatabaseGetTableInfo()

Returns a field class.

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the table to query

name$ : string

name of the field

Details:

none

Returns:

class DBFIELDINFO


Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of FieldGetInfoByName()



Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the table to query

number : number

number of the field

Details:

none

Returns:

class DBFIELDINFO

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of FieldGetInfoByNumber()

Returns number of records in database table

Where:

[Function / Math]

Parameters:

table : class DBTABLEINFO

a database table from a Raster of Vector object

Details:

The table name must be spelled exactly as it appears
when examining it in Spatial Data Display. If may NOT
be placed in a string and substituted in the table
name, as in 'V.poly.table$'.

Returns:

number
an integer

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     GetInputVector(V)
     # assume you know the table name, here we used the
     # Crow Butte Soils Vector object.  Note that 'YIELD'
     # is the correct field name,not 'yield'.
     n=NumRecords(V.poly.YIELD)
     print("Record count:", n)

Open the database subobject of a CAD object

Where:

[Function / database]

Parameters:

CADVar : CAD

The CAD object to open the database of

Details:

none

Returns:

class DATABASE


Create Date: 20-Jun-2000
Modify Date: none
Available in SML for Windows: Yes

Example:

 XXX

Open a main level database

Where:

[Function / database]

Parameters:

filename$ : string

RVC filename

objectname$ : string

Object name

Details:

none

Returns:

class DATABASE

Create Date: 11-Sep-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of OpenDatabase()

Returns a database class for functions that need one.

Where:

[Function / database]

Parameters:

Rast : Raster

Raster object

Returns:

class DATABASE

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of OpenRasterDatabase()

Open the database subobject of a TIN object

Where:

[Function / database]

Parameters:

TINVar : TIN

The TIN object to open the database of

Details:

none

Returns:

class DATABASE

Create Date: 20-Jun-2000
Modify Date: none
Available in SML for Windows: Yes

Returns a database class for functions that need one.

Where:

[Function / database]

Parameters:

Vect : Vector

Vector object

Details:

Note: If you are opening the database just to get a DBTABLEINFO for one of its
tables, there is an easier way. See the example for TableGetInfo() for details.

Returns:

class DATABASE


Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of OpenVectorLineDatabase()

Open a Vector point database

Where:

[Function / database]

Parameters:

Vect : Vector

The Vector

Details:

Note: If you are opening the database just to get a DBTABLEINFO for one of its
tables, there is an easier way. See the example for TableGetInfo() for details.

Returns:

class DATABASE
class DATABASE

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of OpenVectorPointDatabase()

Returns a database class for functions that need one.

Where:

[Function / database]

Parameters:

Vect : Vector

Vector object

Details:

Note: If you are opening the database just to get a DBTABLEINFO for one of its
tables, there is an easier way. See the example for TableGetInfo() for details.

Returns:

class DATABASE


Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of OpenVectorPolyDatabase()

Delete one or more records.

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the table to delete from

recordnum1 : list of numbers

the record list to delete

recordnum2 : list of numbers (optional)

optional record list to delete

... : list of numbers (optional)

optional record list to delete

Details:

none

Returns:

nothing

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of RecordDelete()

Append a field to a table

Where:

[Function / Database]

Parameters:

table : class DBTABLEINFO

Table to add the field to

field : class DBFIELDINFO

Information about the field to add

Details:

none

Returns:

class DBFIELDINFO

Create Date: 08-Jun-2001
Modify Date: none
Available in SML for Windows: Yes

Add a new field of type float but inserts it before field "before".

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the table to insert into

name$ : string

field name

dispwidth : number (optional)

number of digits to display

places : number (optional)

number of decimal places to display

Details:

none

Returns:

class DBFIELDINFO

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of TableAddFieldFloat()

Add a new field of type integer but inserts it before field "before".

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the table to insert into

name$ : string

field name

dispwidth : number (optional)

number of digits to display

Details:

none

Returns:

class DBFIELDINFO

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of TableAddFieldInteger()

Add a new field of type string.

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the table to insert into

name$ : string

field name

maxlength : number

maximum length of string field

dispwidth : number (optional)

number of characters to display

Details:

none

Returns:

class DBFIELDINFO

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of TableAddFieldString()

Copy a database table to a DBASE file

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

The table

filename$ : string

DBASE file name

Details:

none

Returns:

nothing

Create Date: 11-Sep-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of TableCopyToDBASE()

Creates an empty table. Use TableAddField???() functions to add fields to it.

Where:

[Function / database]

Parameters:

database : class DATABASE

the database to add the table to

name$ : string

name of the table

description$ : string (optional)

description of the table

Details:

none

Returns:

class DBTABLEINFO

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of TableCreate()

returns 1 if table exists, -1 if table doesn't exist

Where:

[Function / database]

Parameters:

database : class DATABASE

Open database handle

name : any value

Table Name or number

Details:

The "name" parameter will also take a number, in which case, it checks to see if
there is a table with that number. This is useful when looping through all the
tables in a database. A database may claim to have 3 tables, but that really only
means that the highest valid table number is 3. TableExists() will return false
for any tables which have been dropped.

Returns:

number
1 if the table exists, 0 if it doesn't

Create Date: 27-Nov-2000
Modify Date: none
Available in SML for Windows: Yes

Example:

 XXX

Returns a table class.

Where:

[Function / database]

Parameters:

Table : table

the table to get info about

Details:

none

Returns:

class DBTABLEINFO


Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

 # Example of TableGetInfo()
 # (Assume Vect is a vector object)
 
 class DBTABLEINFO table;
 table = TableGetInvo(Vect.poly.YIELD);
 
 # Another example:
 tablename$ = "YIELD";
 table = TableGetInfo(Vect.poly.(tablename$));
 

Add a new field of type float but inserts it before field "before".

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the table to insert into

name$ : string

field name

before : class DBFIELDINFO

the field to insert before

dispwidth : number (optional)

number of digits display

places : number (optional)

number of decimal places to display

Details:

none

Returns:

class DBFIELDINFO

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of TableInsertFieldFloat()

Add a new field of type integer but inserts it before field "before".

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the table to insert into

name$ : string

field name

before : class DBFIELDINFO

the field to insert before

dispwidth : number (optional)

number of digits to display

Details:

none

Returns:

class DBFIELDINFO

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of TableInsertFieldInteger()

Add a new field of type string but inserts it before field "before".

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the table to insert into

name$ : string

field name

before : class DBFIELDINFO

the field to insert before

maxlength : number

maximum length of string field

dispwidth : number (optional)

number of characters to display

Details:

none

Returns:

class DBFIELDINFO

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of TableInsertFieldString()

Find the first record in a table that matches a given key

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

The table

fieldName$ : any value

Can pass field name or field number

fieldValue1 : any value

The field value to match. Should be numeric or string, depending on the type of the
field you're doing the lookup on.

Details:

If more than one record in a table matches the given field value, the record number of
the first match will be returned.

Note, that if the field you're doing the comparison on is not indexed, this will end up
doing a linear search through the table, which is very slow.

Returns:

number
A record number or 0 if none related.

Create Date: 13-Jul-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of TableKeyFieldLookup()

Makes a link to a dBase file.

Where:

[Function / database]

Parameters:

database : class DATABASE

the database

filename$ : string

RVC file name

name$ : string

table name

description$ : string (optional)

table description

Details:

none

Returns:

class DBTABLEINFO

Create Date: 06-Apr-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

     # Example of TableLinkDBASE()

Add new record to a database

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

the database

fieldValue1 : any value (optional)

record to add

fieldValue2 : any value (optional)

optional record to add

... : any value (optional)

optional record to add

Details:

none

Returns:

number
number - record number

Create Date: 29-May-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of TableNewRecord()

Open a database table

Where:

[Function / database]

Parameters:

database : class DATABASE

the database

tablename$ : string

the table to open

Details:

none

Returns:

class DBTABLEVAR
class DBTABLEVAR

Create Date: 26-May-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of TableOpen()

Returns records that are attached to or related to a given element in a object

Where:

[Function / database]

Parameters:

table : class class

The table to get attachments for

element_number : number

number of element

records : array

array that records are returned in

element_type$ : string (optional)

the type of element to read attachment from
"node" Vector node
"point" Vector point
"line" Vector line
"polygon" Vector polygon
"CAD" CAD element
"rastercell" Raster cell value

Details:

Note: TableReadAttachment() will work for tables which are related only as well as
ones which have direct attachments. TableWriteAttachment() only works for tables
which have direct attachments.

Returns:

number
The number of records from the specified table that were attached to the element

Create Date: 14-Nov-2000
Modify Date: none
Available in SML for Windows: Yes

Example:

 XXX

Read a number from a table (using DBTABLEINFO)

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

The table

fieldName$ : any value

Can pass field name or field number

recordNum : number

Record number

Details:

none

Returns:

number
number

Create Date: 12-Jun-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of TableReadFieldNum()

Read a string from a table (using DBTABLEINFO)

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

The table

fieldName$ : any value

Can pass field name or field number

recordNum : number

Record number

Details:

none

Returns:

string
string

Create Date: 12-Jun-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of TableReadFieldStr()

Attaches records in a table to an element in a object

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

The table to attach to

element_number : number

number of element to attach to

records : array

array holding the list of record numbers to attach

num_records : number

number of records listed in the records array

element_type$ : string (optional)

the type of element to write attachment to
"node" Vector node
"point" Vector point
"line" Vector line
"polygon" Vector polygon
"CAD" CAD element
"rastercell" Raster cell value

Details:

The table must be in a database which is a subobject of the object that it is being attached to.

The behavior of this function depends on the attachment type of the table being
attached.

If it is "Related Only" you can't attach anything directly. In this case, the records
are related via a key field to another table which is directly attached to elements.
This relationship doesn't have to be a direct one. A table can be related to a table
which is related to another table until eventually one of them is directly attached
object elements. Note that TableReadAttachments() still works for tables which
are "Related Only", you just can't force the attachment with this function.
If it is "One Record per Element" or "One to One", you can only attach one record.
If there is already a record from this table attached to the element, that
attachment will be broken in favor of the new attachment.
If the table is "Implied One to One", attachment is implied (hence the name) and
you don't need to attach anything. In the Implied case, record 1 is attached to
element 1, record 2 to element 2, etc...

Returns:

number
The number of records attached to the element after the operation

Create Date: 14-Nov-2000
Modify Date: none
Available in SML for Windows: Yes

Example:

 # Example:
 # Have the user select a vector object.
 # attach records 5 and 7 to polygon number 12.
 
 VECTOR Vect;
 class DBTABLEINFO table;
 array records[2];
 
 GetInputVector(Vect);
 table = TableGetInfo(Vect.poly.YIELD);
 records[1] = 5;
 records[2] = 7;
 TableWriteAttachment(table, 12, records, 2, "polygon");
 

Write values to an existing database record

Where:

[Function / database]

Parameters:

table : class DBTABLEINFO

The table

recordNum : number

Record number to write. 0 for new record

fieldValue1 : any value (optional)

Value to write

fieldValue2 : any value (optional)

Value to write

... : any value (optional)

Value to write

Details:

none

Returns:

number
number

Create Date: 15-Jun-1998
Modify Date: none
Available in SML for Windows: Yes

Example:

       # Example of TableWriteRecord()

Raster functions (5)

Use a File/Object selection dialog to select an input Raster

Where:

[Function / Raster]

Parameters:

Raster : Raster

a valid Raster object name

lins : number (optional)

optional - the number of lines allowed in the
raster to be chosen

cols : number (optional)

optional - the number of lines allowed in the
raster to be chosen

datatype$ : string (optional)

optional - a string containing the data type
requirement for the selected raster.
"binary"
"4-bit unsigned"
"8-bit unsigned"
"16-bit unsigned"
"16-bit color RGB"
"16-bit color BGR"
"24-bit color RGB"
"24-bit color BGR"
"32-bit signed"
"32-bit float"
"64-bit float"

Details:

If they are used, lines and columns must be used together.
If it is used, type$ must follow lines and columns. If you
do not care about the dimensions of the raster, but
only the type, then set lines and columns to 0

Returns:

nothing
none

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     lines=488 ; columns=361   # Crow Butte TM raster dimensions
     type$="8-bit unsigned"
     # allow only specific raster size and type
     GetInputRaster(R, lines, columns, type$) ; CloseRaster(R)
     # allow any size, but only a specific type
     GetInputRaster(R, 0, 0, type$) ; CloseRaster(R)

Get more than one raster.

Where:

[Function / raster]

Parameters:

Raster : Raster

first Raster object

... : Raster (optional)

additional Raster objects

Details:

none

Returns:

nothing

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of GetInputRasters()

Use a File/Object selection dialog to select an output Raster

Where:

[Function / Raster]

Parameters:

Raster : Raster

any valid raster variable

lins : number (optional)

optional - a number, use to force number of
lines in output raster

cols : number (optional)

optional - a number, use to force number of
columns in output raster

datatype$ : string (optional)

optional - a string, use to force data type
of output raster, (see below)
"binary"
"4-bit unsigned"
"8-bit unsigned"
"16-bit unsigned"
"16-bit color RGB"
"16-bit color BGR"
"24-bit color RGB"
"24-bit color BGR"
"32-bit signed"
"32-bit float"
"64-bit float"

Details:

If they are used, lines and columns must be used together.
If it is used, type$ must follow lines and columns. If you
do not care about the dimensions of the raster, but
only the type, then set lines and columns to 0.
This function allows you to select an existing object
to overwrite, or to create a new object. Once it has
been selected, writing to the object on disk is handled
transparently.

Returns:

nothing
none

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     GetInputRaster(R)
     lines=NumLins(R) ; columns=NumCols(R) ; type$=RastType(R)
     # allow selection or creation of a raster identical
     # in size and type to R.
     GetOutputRaster(R2, lines, columns, type$)
     CloseRaster(R) ; CloseRaster(R2)

Determine if a Raster exists. Made obsolete by ObjectExists()

Where:

[Function / raster]

Parameters:

filename$ : string

RVC filename

objectname$ : string

Raster object name

Details:

none

Returns:

number
number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

       # Example of RasterExists()

Popup dialog to select an object

Where:

[Function / raster]

Parameters:

type$ : string

object type ("RASTER", "VECTOR" ...)

prompt$ : string (optional)

Prompt string to use

filename$ : string (optional)

Default filename

objname$ : string (optional)

Default object name

Details:

none

Returns:

class OBJECT
class OBJECT

Create Date: 18-Nov-1998
Modify Date: 17-May-2000
Available in SML for Windows: Yes

Example:

       # Example of SelectInputObject()

Vector functions (33)

Close a Vector object.

Where:

[Function / vector]

Parameters:

Vector : Vector

Vector object

Details:

none

Returns:

nothing

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

      # example of CloseVector()
      GetInputVector(V);
      # do something with V
      CloseVector(V);

Create a temporary Vector object.

Where:

[Function / vector]

Parameters:

Vector : Vector

Vector object

flag1$ : string (optional)

optional - see below
"VectorToolkit" Opens the Vector object for use with the Vector toolkit
"Polygonal" Vector object has polygons and full polygon-line-node topology
"Planar" Vector object has no polygons and full line-node topology
"Network" Vector object has no polygons and connected line-node topology
"NoTopology" Vector object has no topology, lines only
"3DVector" Create a 3D Vector object

flag2$ : string (optional)

optional - see below
"NoQtree" Do not maintain qtrees
"NoDBStatTable" Do not update Database Statistics tables
"KeepAttachedLabels" Keep labels that become unattached
"IsContour" Vector data is a contour set
"NoStyle" Do not open / create a style table
"NoDatabase" Do not maintain databases
"NoHyper" Do not update hyper object
"NoCreateTables" Do not create databases
"NoCreateStyle" Do not create a style object
"IgnoreBadMinMax" Ignore bad min/max values - (only use with validated topo)
"NoValidateNodes" Do not validate nodes during open
"NoSaveQTree" Do not save search tree at close
"NoPolyQTree" Do not generate a polygon qtree
"NoLineQTree" Do not generate a line qtree
"NoPointQTree" Do not generate a point qtree
"NoLabelQTree" Do not generate a label qtree
"NoNodeQTree" Do not generate a node qtree
"NoElemQTree" Do not generate an element qtree

Details:

flag1$ and flag2$ are optional - use for creating VectorToolkit Vector

Returns:

nothing

Create Date: 10-Apr-1998
Modify Date: 19-May-1998
Available in SML for Windows: Yes

Example:

     # Example of CreateTempVector()
      CreateTempVector(VTemp)
      # do something with it
      CloseVector(VTemp)

Create a Vector without using a dialog using same flags as GetOutputVector().

Where:

[Function / vector]

Parameters:

Vector : Vector

Vector object

filename$ : string

RVC file name

objname$ : string

Vector object name

desc$ : string

Vector object description

flag1$ : string (optional)

optional - see below
"VectorToolkit" Opens the Vector object for use with the Vector toolkit
"Polygonal" Vector object has polygons and full polygon-line-node topology
"Planar" Vector object has no polygons and full line-node topology
"Network" Vector object has no polygons and connected line-node topology
"NoTopology" Vector object has no topology, lines only
"3DVector" Create a 3D Vector object

flag2$ : string (optional)

optional - see below
"NoQtree" Do not maintain qtrees
"NoDBStatTable" Do not update Database Statistics tables
"KeepAttachedLabels" Keep labels that become unattached
"IsContour" Vector data is a contour set
"NoStyle" Do not open / create a style table
"NoDatabase" Do not maintain databases
"NoHyper" Do not update hyper object
"NoCreateTables" Do not create databases
"NoCreateStyle" Do not create a style object
"IgnoreBadMinMax" Ignore bad min/max values - (only use with validated topo)
"NoValidateNodes" Do not validate nodes during open
"NoSaveQTree" Do not save search tree at close
"NoPolyQTree" Do not generate a polygon qtree
"NoLineQTree" Do not generate a line qtree
"NoPointQTree" Do not generate a point qtree
"NoLabelQTree" Do not generate a label qtree
"NoNodeQTree" Do not generate a node qtree
"NoElemQTree" Do not generate an element qtree

Details:

none

Returns:

nothing

Create Date: 07-May-1998
Modify Date: 19-May-1998
Available in SML for Windows: Yes

Example:

     # Example of CreateVector()
      CreateVector(Vpoly,    "c:/tnt/win32/createV.rvc", "Vpoly",    "Polygonal",  "Polygonal")
      CreateVector(Vplanar,  "c:/tnt/win32/createV.rvc", "Vplanar",  "Planar",     "Planar")
      CreateVector(Vnetwork, "c:/tnt/win32/createV.rvc", "Vnetwork", "Network",    "Network")
      CreateVector(Vnotopo,  "c:/tnt/win32/createV.rvc", "Vnotopo",  "NoTopology", "NoTopology")

Find closest Vector label.

Where:

[Function / vector]

Parameters:

Vector : Vector

Vector object

x : number

x coordinate

y : number

y coordinate

georef : class Georef (optional)

georef object

maxdist : number (optional)

the maximum distance to search

distance : numeric variable (optional)

Returned distance

Details:

none

Returns:

number
number

Create Date: 22-Jun-1981
Modify Date: 24-Jun-1999
Available in SML for Windows: Yes

Example:

      # example of FindClosestLabel()
      GetOutputVector(VIn, 1)
      georef = GetGeorefObject(VIn)
      numberLabels = NumVectorLabels(VIn)
      label = FindClosestLabel(VIn, 150000, 335000, georef, 1000000)
      VectorDeleteLabel(Vin, label)
      print("number, closest", numberLabels, label)

Return line element closest to x,y coordinates

Where:

[Function / Vector]

Parameters:

Vector : Vector

a valid vector object

x : number

any expression that evaluates to a number
representing the horizontal coordinate of interest

y : number

any expression that evaluates to a number
representing the vertical coordinate of interest

georef : class Georef (optional)

the georeference number returned from
GetGeorefObject() applied to Vvar

maxdist : number (optional)

the maximum distance (in the selected
georeference coordinate system) to search for
a line before giving up

distance : numeric variable (optional)

Optional variable to store the distance to the line

Details:

x and y must be in the same system of units specified
by the georef object you are prompted to select.

Returns:

number
the number of the closest line to (x,y) in the vector
object, using the selected georeference subobject's
coordinate system. Returns NULL if no nodes fall within
maxDistance of (x,y).

Create Date: 01-Dec-1997
Modify Date: 24-Jun-1999
Available in SML for Windows: Yes

Example:

     clear()
     GetInputVector(Vvar)
     georef = GetGeorefObject(Vvar)
     print("Enter x.") ; x = input()
     print("Enter y.") ; y = input()
     print("Enter maxDistance.") ; maxDistance = input()
     num = FindClosestLine(Vvar, x, y, georef, maxDistance)
     print(num)

Return node element closest to x,y coordinates

Where:

[Function / Vector]

Parameters:

Vector : Vector

a valid vector object

x : number

any expression that evaluates to a number
representing the horizontal coordinate of interest

y : number

any expression that evaluates to a number
representing the vertical coordinate of interest

georef : class Georef (optional)

the georeference number returned from
GetGeorefObject() applied to Vvar

maxdist : number (optional)

the maximum distance (in the selected
georeference coordinate system) to search for
a node before giving up

distance : numeric variable (optional)

Optional variable to store the distance to the node

Details:

x and y must be in the same system of units specified
by the georef object you are prompted to select.

Returns:

number
the number of the closest node to (x,y) in the vector
object, using the selected georeference subobject's
coordinate system. Returns NULL if no nodes fall within
maxDistance of (x,y).

Create Date: 01-Dec-1997
Modify Date: 24-Jun-1999
Available in SML for Windows: Yes

Example:

     clear()
     GetInputVector(Vvar)
     georef = GetGeorefObject(Vvar)
     print("Enter x.") ; x = input()
     print("Enter y.") ; y = input()
     print("Enter maxDistance.") ; maxDistance = input()
     num=FindClosestNode(Vvar, x, y, georef, maxDistance)
     print(num)

Return point element closest to x,y coordinates

Where:

[Function / Vector]

Parameters:

Vector : Vector

a valid vector object

x : number

any expression that evaluates to a number
representing the horizontal coordinate of interest

y : number

any expression that evaluates to a number
representing the vertical coordinate of interest

georef : class Georef (optional)

the georeference number returned from
GetGeorefObject() applied to Vvar

maxdist : number (optional)

the maximum distance (in the selected
georeference coordinate system) to search for
a point before giving up

distance : numeric variable (optional)

Optional variable to store the distance to the point

Details:

x and y must be in the same system of units specified
by the georef object you are prompted to select.

Returns:

number
the closest point to (x,y) in the vector object, using the
selected georeference subobject's coordinate system. Returns NULL
if no points fall within maxDistance of (x,y).

Create Date: 01-Dec-1997
Modify Date: 24-Jun-1999
Available in SML for Windows: Yes

Example:

     clear()
     GetInputVector(Vvar)
     georef = GetGeorefObject(Vvar)
     print("Enter x.") ; x = input()
     print("Enter y.") ; y = input()
     print("Enter maxDistance.") ; maxDistance = input()
     num = FindClosestPoint(Vvar, x, y, georef, maxDistance)
     print(num)

Return polygon element closest to x,y coordinates

Where:

[Function / Vector]

Parameters:

Vector : Vector

a valid vector object

x : number

any expression that evaluates to a number
representing the horizontal coordinate of interest

y : number

any expression that evaluates to a number
representing the vertical coordinate of interest

georef : class Georef (optional)

the georeference number returned from
GetGeorefObject() applied to Vvar

maxdist : number (optional)

the maximum distance (in the selected
georeference coordinate system) to search for
a point before giving up

distance : numeric variable (optional)

Optional variable to store the distance to the polygon

Details:

x and y must be in the same system of units specified
by the georef object you are prompted to select.

Returns:

number
the closest polygon to (x, y) in the vector object,
using the selected georeference subobject's
coordinate system. Returns NULL if no polygons fall
within maxDistance of (x, y).

Create Date: 01-Dec-1997
Modify Date: 24-Jun-1999
Available in SML for Windows: Yes

Example:

     clear()
     GetInputVector(Vvar)
     georef = GetGeorefObject(Vvar)
     print("Enter x.") ; x = input()
     print("Enter y.") ; y = input()
     print("Enter maxDistance.") ; maxDistance = input()
     num=FindClosestPoly(Vvar, x, y, georef, maxDistance)
     print(num)

Use a File/Object selection dialog to select an input Vector

Where:

[Function / Vector]

Parameters:

Vector : Vector

a valid vector variable

Details:

none

Returns:

nothing
none

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     GetInputVector(Vvar)
     # do something with it

Get multiple Vector objects.

Where:

[Function / vector]

Parameters:

VectorList : Vector List

Vector object list

prompt$ : string (optional)

prompt string

Details:

none

Returns:

number
number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of GetInputVectorList()

Open a vector object for use with vector toolkit funtions

Where:

[Function / Vector Toolkit]

Parameters:

Vector : Vector

A valid vector variable

flag1$ : string (optional)

optional - see below
"VectorToolkit" Opens the Vector object for use with the Vector toolkit
"Polygonal" Vector object has polygons and full polygon-line-node topology
"Planar" Vector object has no polygons and full line-node topology
"Network" Vector object has no polygons and connected line-node topology
"NoTopology" Vector object has no topology, lines only
"3DVector" Create a 3D Vector object

flag2$ : string (optional)

optional - see below
"NoQtree" Do not maintain qtrees
"NoDBStatTable" Do not update Database Statistics tables
"KeepAttachedLabels" Keep labels that become unattached
"IsContour" Vector data is a contour set
"NoStyle" Do not open / create a style table
"NoDatabase" Do not maintain databases
"NoHyper" Do not update hyper object
"NoCreateTables" Do not create databases
"NoCreateStyle" Do not create a style object
"IgnoreBadMinMax" Ignore bad min/max values - (only use with validated topo)
"NoValidateNodes" Do not validate nodes during open
"NoSaveQTree" Do not save search tree at close
"NoPolyQTree" Do not generate a polygon qtree
"NoLineQTree" Do not generate a line qtree
"NoPointQTree" Do not generate a point qtree
"NoLabelQTree" Do not generate a label qtree
"NoNodeQTree" Do not generate a node qtree
"NoElemQTree" Do not generate an element qtree

Details:

Use of GetOutputVector() without the optional parameters defaults
to original non-vector toolkit version.

Returns:

nothing
none

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     array xPoints[10], yPoints[10]
     clear()
     # for multiple flags simply comma seperate them as below
     GetOutputVector(V, "VectorToolkit", "NoQtree,NoDBStatTable")
     # draw some boxes  - this will create polygons
     # all closed lines are converted to polygons
     xPoints[1] = 0
     yPoints[1] = 0
     xPoints[2] = 100
     yPoints[2] = 0
     xPoints[3] = 100
     yPoints[3] = 100
     xPoints[4] = 0
     yPoints[4] = 100
     xPoints[5] = 0
     yPoints[5] = 0
     VectorAddLine(V, 5, xPoints, yPoints)
     # now add some points
     for i = 1 to 4 {
        VectorAddPoint(V, xPoints[i] + 150, yPoints[i] + 150)
        }
     numPolys = NumVectorPolys(V)
     numberPoints = NumVectorPoints(V)
     print("number of polygons, points: ", numPolys, numberPoints)

Returns (via arrays xArray and yArray, and optional zArray) a list of points in a line.

Where:

[Function / Vector]

Parameters:

Vector : Vector

a vector variable

xarray : array

an array for holding x values of point list

yarray : array

an array for holding y values of point list

line : number (optional)

optional - a node number

zarray : array (optional)

optional - an array for holding z values of point list

Details:

The xArray and yArray variables are defined before calling
GetVectorLinePointList(). If used in a query on nodes, or in a
"for each node" loop, then node is implied and may be omitted.
The xArray and yArray variables will be resized automatically.

Returns:

number
a number - the number of points attached to the node

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     array xArray[10], yArray[10], zArray[10]   # will be resized automatically
     GetInputVector(Vvar)
     numLines = NumVectorLines(Vvar)
     nPoints = GetVectorLinePointList(Vvar, xArray, yArray, 1, zArray)
     for i = 1 to nPoints {
        print(xArray[i], yArray[i], zArray[i])
        }

Returns (via array linesArray) a list of lines attached to node.

Where:

[Function / Vector]

Parameters:

Vector : Vector

a vector variable

lines : array

an array for holding line list

node : number (optional)

optional - a node number

Details:

The linesArray variable is defined before calling
GetVectorNodeLineList(). If used in a query on nodes, or in a
"for each node" loop, then node is implied and may be omitted.
The linesArray variable will be resized automatically.

Returns:

number
a number - the number of lines attached to the node

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     array linelist[10]   # will be resized automatically
     GetVectorNodeLineList(Vvar, linelist, 1)

Returns list of all polygons that share a common line with a given polygon in a vector object

Where:

[Function / Vector]

Parameters:

Vector : Vector

a valid vector object

polygonList : array

one dimensional array of polygons returned

polygonNumber : number (optional)

optional - the polygon to search around

Details:

does not return polygons that only share a single node

Returns:

number
number of adjacent polygons

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # reads the poly list of all adjacent polygons to a given polygon
     # it only returns polygons that have common lines !!!
     # not a single common node
     array polygonList[10] # array to hold poly list
     clear()
     GetInputVector(V)
     polygonNumber = 150 # polygonNumber = 150 works for cb_soils/CBSOILS_Lite
     numadjacent = GetVectorPolyAdjacentPolyList(V, polygonList, polygonNumber)
     temp$ = "number of polygons adjacent to polygon:"
     print(temp$, polygonNumber, " = ", numadjacent)
     for i = 1 to numadjacent {
        print(i, ":", polygonList[i])
        }
     print("Done")

Returns (via array islandsArray) a list of islands of a polygon.

Where:

[Function / Vector]

Parameters:

Vector : Vector

a vector variable

islands : array

an array for holding island list

polygon : number (optional)

optional - a polygon number

Details:

The islandsArray variable is defined before calling
GetVectorNodeLineList(). If used in a query on polygons, or in a
"for each polygon" loop, then polygon is implied and may be
omitted. The linesArray variable will be resized automatically.

Returns:

number
a number - the number of islands attached to the polygon

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     array islandlist[10]   # will be resized automatically
     GetVectorPolyIslandList(Vvar, islandlist, 1)

Returns (via array linesArray) a list of lines forming a polygon

Where:

[Function / Vector]

Parameters:

Vector : Vector

a vector

lines : array

an array for holding line list

polygon : number (optional)

optional - a line number

Details:

The linesArray variable is defined before calling
GetVectorNodeLineList(). If used in a query on polygons, or in a
"for each polygon" loop, then polygon is implied and may be
omitted. The linesArray variable will be resized automatically.

Returns:

number
a number - the number of lines attached to the polygon(s)

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     array linelist[10]   # will be resized automatically
     GetVectorPolyLineList(Vvar, linelist, 1)

Returns number of labels in a vector object

Where:

[Function / Vector]

Parameters:

Vector : Vector

a valid vector object

Details:

none

Returns:

number
number of labels in a vector object

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     GetInputVector(Vin)
     numLabels = NumVectorLabels(Vin)
     print("number of labels: ", numLabels)

Returns number of lines in vector object

Where:

[Function / Vector]

Parameters:

Vector : Vector

a valid Vector object

Details:

none

Returns:

number
an integer

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     GetInputVector(V)
     n=NumVectorLines(V)
     print("Line count: ", n)

Returns number of nodes in vector object

Where:

[Function / Vector]

Parameters:

Vector : Vector

a valid Vector object

Details:

none

Returns:

number
an integer

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     GetInputVector(V)
     n=NumVectorNodes(V)
     print("Node count: ", n)

Returns number of points in vector object

Where:

[Function / Vector]

Parameters:

Vector : Vector

a valid Vector object

Details:

none

Returns:

number
an integer

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     GetInputVector(V)
     n=NumVectorPoints(V)
     print("Point count: ", n)

Returns number of polygons in vector object

Where:

[Function / Vector]

Parameters:

Vector : Vector

a valid Vector object

Details:

none

Returns:

number
an integer

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     GetInputVector(V)
     n=NumVectorPolys(V)
     print("Polygon count: ", n)

Open multiple Vector objects

Where:

[Function / vector]

Parameters:

VectorList : Vector List

list of Vectors

filename1$ : string

file name of first Vector

objname1$ : string

object name of first Vector

filename2$ : string (optional)

file name of optional Vector

objname2$ : string (optional)

object name of optional Vector

... : string (optional)

additional file name / object name pairs

Details:

none

Returns:

number
number

Create Date: 19-May-1998
Modify Date: 19-May-1998
Available in SML for Windows: Yes

Example:

       # Example of OpenInputVectorList()

Open a Vector without using a dialog using same flags as GetOutputVector().

Where:

[Function / vector]

Parameters:

Vector : Vector

Vector object

filename$ : string

RVC file name

objname$ : string

Vector object name

flag1$ : string (optional)

optional - see below
"VectorToolkit" Opens the Vector object for use with the Vector toolkit
"Polygonal" Vector object has polygons and full polygon-line-node topology
"Planar" Vector object has no polygons and full line-node topology
"Network" Vector object has no polygons and connected line-node topology
"NoTopology" Vector object has no topology, lines only
"3DVector" Create a 3D Vector object

flag2$ : string (optional)

optional - see below
"NoQtree" Do not maintain qtrees
"NoDBStatTable" Do not update Database Statistics tables
"KeepAttachedLabels" Keep labels that become unattached
"IsContour" Vector data is a contour set
"NoStyle" Do not open / create a style table
"NoDatabase" Do not maintain databases
"NoHyper" Do not update hyper object
"NoCreateTables" Do not create databases
"NoCreateStyle" Do not create a style object
"IgnoreBadMinMax" Ignore bad min/max values - (only use with validated topo)
"NoValidateNodes" Do not validate nodes during open
"NoSaveQTree" Do not save search tree at close
"NoPolyQTree" Do not generate a polygon qtree
"NoLineQTree" Do not generate a line qtree
"NoPointQTree" Do not generate a point qtree
"NoLabelQTree" Do not generate a label qtree
"NoNodeQTree" Do not generate a node qtree
"NoElemQTree" Do not generate an element qtree

Returns:

nothing

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of OpenVector()
      fileName$ = "c:/tnt/win32/vcBound/bound/Create.rvc"
      objectName$ = "VCreate"
      OpenVector(VOut, fileName$, objectName$, "VectorToolkit")

Merge two or more Vector objects

Where:

[Function / vector]

Parameters:

Obj1 : Vector

Vector object one

Obj2 : Vector (optional)

Vector object two

... : Vector (optional)

additional Vector objects

Details:

none

Returns:

Vector Function
number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     # Example of VectMerge()

Returns Vector that is the logical result of two input vectors

Where:

[Function / Vector]

Parameters:

OperatorVector : Vector

Vector object

SourceVector : Vector

Vector object

flags$ : string (optional)

optional - if used must be a string with one or
more of the following seperated by commas
"RemExRecords" Remove excess (unattached) database records
"TableJoinNameStruct" Join tables in append functions if names
are alike and structures are compatible
"TableJoinStruct" Join tables in append functions if
structures are compatible
"TableRemoveDupRec" Do not copy over records if the existing is
destination table

Details:

The operator, source, and destination Vector objects exist. The
operator Vector object must consist of polygons only, the source
Vector object does not have this restriction.

Returns:

Vector Function
Vector object

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     See example for VectorOR()

Tests a Vector element against a region.

Where:

[Function / vector]

Parameters:

Rgnvar : Region

the Region object

Vectvar : Vector

the TIN object

element : number

the element number to text

flag1$ : string

the element type
"node" - the element is a node
"point" - the element is a point
"line" - the element is a line
"poly" - the element is a poly
"label" - the element is a label

flag2$ : string

the Region test type
"CompletelyInside" - Is the element completely inside the region
"PartlyInside" - Is the element partially inside the region
"CompletelyOutside" - Is the element completely outside the region
"PartlyOutside" - Is the element partially outside the region

Details:

none

Returns:

number
number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

      # example of VectorElementInRegion()
      clear()
      GetInputVector(VIn)
      GetInputRegion(Region1)
      elementNumber = 1
      inRegion = VectorElementInRegion(Region1, VIn, elementNumber, "line", "CompletelyInside")
      if (inRegion)
         print( "element ", elem, "is CompletelyInside\n")

Determines if vector object exists in project file. Made obsolete by ObjectExists()

Where:

[Function / Vector]

Parameters:

filename$ : string

a string containing path and filename

objectname$ : string

a string containing objects name

Details:

none

Returns:

number
a number

Create Date: 01-Dec-1997
Modify Date: none
Available in SML for Windows: No

Example:

     clear()
     file$="d:/sf_data/haywsoil" ; ob$="hsoils"
     if (VectorExists(file$, ob$)) then
         print("Vector ", ob$, "Exists in ", file$)

Returns Vector that is the result of the operator applied to the source

Where:

[Function / Vector]

Parameters:

OperatorVector : Vector

Vector object - template applied to SourceVector

SourceVector : Vector

Vector object - the vector to extract from

operation : any value

must be set to one of the following:
"CompInside" Extract elements completely inside Operator
"PartInside" Extract elements partly inside Operator
"InsideBorder" Extract inside and add Operator as a border
"InsideClip" Extract inside and clip to Operator
"CompOutside" Extract elemts completely outside Operator
"PartOutside" Extract partly outside
"OutsideBorder" Extract outside and add border

flags$ : string (optional)

optional - if used must be a string with one or
more of the following seperated by commas
"RemExRecords" Remove excess (unattached) database records
"TableJoinNameStruct" Join tables in append functions if names
are alike and structures are compatible
"TableJoinStruct" Join tables in append functions if
structures are compatible
"TableRemoveDupRec" Do not copy over records if the existing is
destination table

pointQuery$ : string (optional)

Point selection query. Default is "1" which will select all points.

lineQuery$ : string (optional)

Line selection query. Default is "1" which will select all lines.

polyQuery$ : string (optional)

Polygon selection query. Default is "1" which will select all polygons.