Functions

This automatically generated page summarises the functions available in the expression language.used where data is needed. Planimate uses attribute references to specify this data. An attribute reference can include expressions containing one or more of the functions below.

These are a small subset of the Routine Operations available in Code objects. When editing an expression, type Ctrl-F to get a list of functions. If the cursor is after a ".", you get a list of Property Functions.

This page was generated using Planimate 12.8.0.

sqrt()

value = sqrt(value)

Returns square root of 'value'.

sqr()

value = sqr(value)

Returns 'value' multiplied by itself.

ceil()

value = ceil(value)

Returns smallest integer greater or equal to 'value'.

floor()

value = floor(value)

Returns largest integer not greater than 'value'.

fabs()

value = fabs(value)

Returns removes negative sign if 'value' is negative.

round()

value = round(value)

Returns the nearest integer to 'value'.

trunc()

value = trunc(value)

Returns 'value' with the fraction trimmed off.

exp()

value = exp(value)

Returns mathematical 'e' to the power of 'value'.

ln()

value = ln(value)

Returns natural logarithm of 'value'.

log10()

value = log10(value)

Returns base 10 logarithm of 'value'.

pow10()

value = pow10(value)

Returns 10 to the power of 'value'.

pow2()

value = pow2(value)

Returns 2 to the power of 'value'.

cos()

value = cos(value)

Returns trigonometric cosine where 'value' is in radians.

sin()

value = sin(value)

Returns trigonometric sine where 'value' is in radians.

tan()

value = tan(value)

Returns trigonometric tangent where 'value' is in radians.

acos()

value = acos(value)

Returns inverse of cos() function.

asin()

value = asin(value)

Returns inverse of sin() function.

atan()

value = atan(value)

Returns inverse of tan() function. atan2 is more useful if you have an x,y point.

atan2()

value = atan2(x,y)

Returns angle in radians between x axis and (x,y) on cartesian graph.

hypot()

value = hypot(x,y)

Returns sqrt(x*x + y*y).

min()

value = min(val1,val2)

Returns minimum of 'val1' and 'val2'.

max()

value = max(val1,val2)

Returns maximum of 'val1' and 'val2'.

strlen()

integer = strlen(string)

Returns length of 'string'.

strleft()

string = strleft(string,count)

Returns leftmost 'count' characters from 'string'.

strmid()

string = strmid(string,pos,count)

Returns starting at 'pos' up to 'count' characters in 'string'.

strright()

string = strright(string,count)

Returns rightmost 'count' characters from 'string'.

strreverse()

string = strreverse(string)

Returns reversed order of characters in 'string'.

strupper()

string = strupper(string)

Returns 'string' converted to lowercase.

strlower()

string = strlower(string)

Returns 'string' converted to uppercase.

strcompare()

integer = strcompare(str1,str2[,casesensitive=0])

Returns 0 if 'str1' and 'str2' are the same, 1 if 'str1' has higher ascii-sort order, -1 if 'str1' has lower ascii-sort order. Default is to ignore case unless casesensitive is provided and is not zero.

strfind()

integer = strfind(str1,str2[,casesensitive=0])

Returns character where 'str2' first starts in 'str1' or 0 if not found.

strclean()

string = strclean(string)

Returns 'string' after leading spaces, trailing spaces, new lines and tabs have been removed. Any double quotes are made single.

strinsert()

string = strinsert(str1,str2,pos)

Returns 'str1 with str2 inserted before character at position 'pos'.

strdelete()

string = strdelete(string,pos,count)

Returns 'string' after deleteing 'count' characters starting at 'pos'.

strreplace()

string = strreplace(string,str1,str2[,casesensitive=0])

Returns 'string' after all occurances of 'str1' are replaced with 'str2'. Match is not casesensitive unless 'casesensitive' is non zero.

strchar()

integer = strchar(string,pos)

Returns ASCII code of character at 'pos' of 'string'.

strasc()

string = strasc(code)

Returns a single character string containing the given 8 bit ASCII character.

BitAnd()

integer = BitAnd(value)

Returns bitwise AND of the two values.

BitOr()

integer = BitOr(value)

Returns bitwise OR of the two values.

BitXOR()

integer = BitXOR(value)

Returns bitwise X-OR of the two values.

pow()

value = pow(x,y)

Returns x to the power of y.

GetColorA()

value = GetColorA(color)

Returns Alpha component of AARRGGBB or palette index colour.

GetColorR()

value = GetColorR(color)

Returns Red component of AARRGGBB or palette index colour.

GetColorG()

value = GetColorG(color)

Returns Green component of AARRGGBB or palette index colour.

GetColorB()

value = GetColorB(color)

Returns Blue component of AARRGGBB or palette index colour.

EarthDistance()

value = EarthDistance(long1,lat1,long2,lat2)

Returns Distance between world co-ordinates on Earth's surface.