Functions ID Description

Calculation and Comparison Operators

by Andre Szagesh 2/10/2021
+ +

Sum of two numbers or character strings

- -

Difference between numbers

* *

Product of two numbers

/ /

Quotient of two numbers

** **

Power of two numbers

< <

Logical value form 'a smaller than b'

> >

Logical Value from 'a greater than b'

<> <>

Logical value from 'a not equal to b'

== ==

Logical value from 'a equals b'

>= >=

Logical Value from 'a greater than or equal to b'

<= <=

Logical value from 'a smaller than or equal to b'

Mathematical Functions
abs abs(number)

Amount
angle angle(degree angle[,minutes][,seconds])

Conversion of angle in degrees-minutes-seconds to decimal degrees

arccos arccos(number)

Arc cosine in degrees

arcsin arcsin(number)

Arc sine in degrees

arctan2 arctan(number)

Arc tangent in degrees

CalculatePointOnHelix calculatePointOnHelix(Radius,index,pitch,trapezoid angle,cone angle)

Generate nominal data for 3D curve on cylinder or cone

Cos cos(DegreeAngle)

Cosine value from degree angle

CosRad cosRad(RadianAngle)

Cosine value from radian angle

deg deg(RadianAngle)

Degree value of radian angle

exp exp(number)

e^Number
int int(number)

Integer part of number

int ln(Number)

Natural logarithm from number

log log(Number)

Decimal logarithm of number

max max(Number1[,Number2,...])

Maximum of numbers transferred

min min(Number1[,Number2,...])

Minimum of transferred numbers

mod mod(Number1,Number2)

Number1 modulo Number2

not not(Boolean value)

Negation of the default value (false with true , true with false)
ord ord(BooleanValue)

supplies 1 (for true) or 0 (for false)

point point(x,y,z[,nx,ny,nz])

Point with X, Y, and Z coordinates and optimum normal vector

 rad rad(DegreeAngle)

Radian value from degree angle

radArccos radArccos(Number)

Arccosine in radians
radArcsin radArcsin(Number)

Arc sine in radians

radArctan radArctan(Number)

Arctangent in radians
radArctan2 radArctan2(Number1,Number2)

Arctangent from quotient from Number1 and Number2 in radians

round round(Number[,NumberDecimalPlaces])

Number rounded off to no. of decimal places

sign sign(Number1[,Number2])

Sign for Number1 or Number1*sign(Number2)

signWithZero signWithZero(Number1[,Number2])

Sign for Number1 or 0 orNumber1*signWithZero(Number2)

sin sin(DegreeAngle)

Sine value of degree angle

sinRad sinRad(RadianAngle)

Sine value of radian angle

sqrt sqrt(Number)

Square root of number

squared squared(Number)

Number to square
tan tan(DegreeAngle)

Tangent value from degree angle

tanRad tanRad(RadianAngle)

Tangent value from radian angle

vector vector(x,y,z)

Vector with X, Y and Z coordinates

Character String Functions
asc asc(character)

ASCII code (number) of characters

chr chr(number)

Character with the given ASCII code

cr cr()

Line Break
format format(number)

Conversion of numeral to character string

formatL formatL (Number [,Total Number Places [,NumberDecimalPlaces]])

creates a left-justified format for a floating comma number.

formatR formatR(Number [,Total Number Places [,NumberDecimalPlaces]])

creates a right-justified format for a floating comma number.

inStr inStr([n1,]CharacterString1,CharacterString2)

Index of character string1 within character string2 after the n1-th or the first character
len len(CharacterString)

Length of character string

mid mid(CharacterString,n1[,Length])

Copy of character string from the n1th character to the end or to the given length
qm qm()

Inserts double inverted commas in a character string

strElement strElement(n,Character,CharacterString)

nth element of the character string with character as separator

subStr subStr(CharacterString,Index1,Index2)

Copy of character string from Index1 to Index2

text text(value1[,Value2,Value3])

Character string from all transferred parameters

val val(CharacterString)

Conversion of character string to number

Input and Output
confirm confirm(([condition])

Dialog for requesting a Boolean value

display display(value)

Character string or number is output in separate window

 inquireList inquireList(Title,Point1[,Point2,...])

Dialog for selecting from a list

inquireNumber inquireNumber([Title])

Dialog for requesting a number

inquireParameterList inquireParameterList([p1,c1,p2,c2,...])

Dialog for entering several parameters p1... with comment c1…

inquirePasswordText inquirePasswordText([Title])

Dialog for requesting a character string. Input is encrypted.

inquireText inquireText([Title])

Dialog for requesting a character string

list list([Value1,Value2,...])

Generates a list of all transferred parameters

message message([Value1,Value2,...])

Output Dialog
print print([Value1,Value2,...])

Output of character string or numbers in default printout

redrawCAD redrawCAD()

Recalculates all Features and updates the CAD window

File Commands
addToFile addToFile(Filename

Adds new line to file

copyFile copyFile(OldfFilename,NewFilename)

Copy a File
deleteFile deleteFile(filename)

Delete file specified

directoryPath directoryPath(Character string)

Directory of Actual values: 'actuals', Results: 'results', Printout template: 'protform', Form plots: 'formplot', Program data: 'programFiles'
exportCharacteristicsHierarchy exportCharacteristicsHierarchy()

Export Characteristic Heirarchy

exportFrequencyParameters exportFrequencyParameters([Merkmalsgruppe or 'complete'])

Export of the frequency parameters

exportPoints exportPoints(Feature name,file name)

Export actual values and if necessary nominals and deviations of the feature to the file
fileExist fileExists(filename)

Checks whether a file or a directory exists

generateTableColumn generateTableColumn(column ID, function name)

Write Table Columns

getActualInspectionDir getActualInspectionDir()

Directory of current Measurement Plan.

getRESULTS getRESULTS()

Result Directory
getWD getWD()

Current Directory
readListFile readListFile(filename)

Read list from ASCII file

readPCMFile readPCMFile(Filename)

Read a PCM File

readUserAttributes readUserAttributes(filename)

Read Characteristic Attributes

renameFile renameFile(OldFilename,NewFilename)

Rename a File
runPCMFile runPCMFile(filename)

Process a text file with PCM commands

saveViewToFile saveViewToFile(View name,File name)

Saves a CAD view as jpg file

selectFileDialog selectFileDialog([path (or path symbol such as directoryPath)[,Filter[,Dialogtext[,Return mode]]]]

Dialog for file selection

waitForFile waitForFile(file name [,message, show file name (0 or 1), Timeout, printout text, check directory (0 or 1)])

Wait till file exists

writeActualsToFile writeActualsToFile([Characteristic,touch points true/false,Alignment]File)

Export of actuals with Point state.

writeActualsToVDA writeActualsToVDA([Characteristic,touch points true/false,Alignment]File)

Export of actuals in VDA format

 writeBliskFinishFile writeBliskFinishFile(Blisk name [,'EXCEL1' [,'EXCEL2' [,'ASCII']]])

Writes the file [Link] [possibly with additional output parameters]for the communication with BladePro
writeBliskStartFile writeBliskStartFile(Blisk name)

Writes the file [Link] for the communication with BladePro

writeCurveDistanceAsPlaneToFile writeCurveDistanceAsPlaneToFile(characteristic,plane axis 1 or 2 or 3,file)

Curve distance as coordinates for a plane. (Plane axis coordinates correspond to the curve distance)
writeDiffCoordSysToFile writeDiffCoordSysToFile([System1[Loop index][Act system true/false]]System2[Loop index][Act system true/false]File)

Export of a difference system of two alignments as 4x4 matrix

writePointsCloudToFile writePointsCloudToFile([characteristic]file)

Export of point set from CALYPSO session file

writeUserAttributes writeUserAttributes([filename[,[Link][,[Link]...]]])

Export of characteristic attributes

Measurement and Measurement Plan
Specific Functions
addCF addCF(characteristic name[,PMName2,...])

Activated characteristics to be measured

addME addME(feature name[,MEName2,...])

Activates features to be measured

baseSystem baseSystem()

Access to properties of Base Alignment

clearParameter clearParameter([Parametername1, ..2, ...])

Delete all or individual parameters

compute compute(character string)

Calculates the value of a term or a PCM parameter

defineFunctionEnd defineFunctionEnd(return value)

Define Function End

defineFunctionStart defineFunctionStart(function name)

Define Function Start

defineRecheckPartNumber defineRecheckPartNumber(part number)

Set the special part number for the repeat measurement

differenceSystem differenceSystem()

Access to properties of the difference system of an iterative alignment

endInspection endInspection()

Measurement Plan run will be concluded

executeFunctionNamed executeFunctionNamed(function name)

Execute Function
getActual getActual([FeatureName,LoopIndex])

Access to actual values of Characteristic/Feature

getActualCurvePoint getActualCurvePoint( curvename [,loopindex],pointnumber )

Access to the deviation of each individual curve point

getCFAttribute getCFAttribute(AttributeName) or (Characteristic name, Attribute name)

Request Attributes
getCFGroupname getCFGroupname () or (characteristic name)

Access to current highest group name

getCFGroupname2 getCFGroupname2 () or (characteristic name)

Access to current lowest group name

getCFNames getCFNames()

Returns a list with characteristic names

getCornerPointFromCAD getCornerPointFromCAD('min'or 'max')

Corner Points of CAD Model

getFunctionObjectName getFunctionObjectName()

Can only be used between defineFunctionStart and defineFunctionEnd!

Access to the name of the current characteristic

getMaxActual getMaxActual([bore pattern name])

Access to actual value of a bore pattern with the greatest deviation

getMinActual getMinActual(FeatureName[,LoopIndex])

Access to actual value of a bore pattern or 2 point diameter with the smallest actual value
getNominal getNominal(FeatureName[,LoopIndex])

Access to nominal values of Characteristic/Feature

getParameterNamed getParameterNamed(Parameter name)[,loop index])

PCM access to PCM parameters using parameter name

getRecheckMode getRecheckMode()

Access to the mode for repeat measurements

 getRunID getRunID()

Request Selected Characteristic Name (Run).

getStartSetting getStartSetting()

CNC start parameters query

inspectionToloranceState inspectionToleranceState()

supplies the tolerance status of the Measurement Plan

isParameterDefined isParameterDefined(Parameter name[,loop index])

Inquiry whether parameter assigned (Boolean return)

measure measure(FeatureName[,LoopIndex])

Measurement of a Feature
measuringForce measuringForce([Feature name or force,Feature name])

Set or read measuring force

numberOfPointDistanceExceed numberOfPointDistanceExceed(curveformname, comparative value)

Number of curve points with a deviation greater than

numberOfPointDistanceLessThan numberOfPointDistanceLessThan(curveformname, comparative value

Number of curve points with a deviation less than

outputMultiQdas outputMultiQdas (AttributeName)

Separate Q-DAS evaluation

setCF setCF(characteristic name[,PMName2,...]) or (List name)

Resets characteristics to be measured

setCFAttribute setCFAttribute(AttributeName,Value)

Set Attribute for Current Characteristic

setCurveJump setCurveJump('Characteristic', 'CurveJumpType', CJRange, CJTolerance, [Overlapping])

Defining the curve jump tolerance (CJT):

E.g.: setCurveJump( 'CurveJump1', 'point', 15, 0.05, 0.5)
Feature = featureElement
CurveJumpType = point, angle, length
CJRange = Value as no. of points, angle range or length of the curve range
Tolerance = Tolerance value
Overlapping = Value: 0, 0.1, 0.2 ... 0.9, 1.0

setElementStrategy setElementStrategy([feature name],strategy name)

Set the Multiple Strategy for an Element

setFilter setFilter(['Characteristic'],'Feature','Filter method','Filter type','Filter criteria',Value1,[Value2],[Connect seg.])

Setting and activating the settings for filters with the following selection option:

Feature element = featureElement, featureElement1, featureElement2, primaryDatum, secondaryDatum...

Filter method = gauss, spline, 2 RC, off, fromFeature
Filter type = low, band, high
Filter criteria = undulation, wavelength
Connect seg. = true,false
By deactivating the filter using 'off' or by accepting the settings of the features with
'fromFeature', all further parameters can also be omitted.

setGeometryInnerOuter setGeometryInnerOuter('INNER' or 'OUTER')

Set inside/outside code for an element

setInspectionStrategy setInspectionStrategy(strategy name)

Set Multiple Strategy for Measurement Plan

setLineScanGlobalSetting setLineScanGlobalSetting(Name of setting,Folder of settings)

Set Global settings of LineScan

setMissingBore setMissingBore([feature name],search distance)

Set Missing Bore for Feature

setOutlier setOutlier(['Characteristic'],'Feature',Factor i.P,Factor o.P,'Area data red.',[Value],[To [Link]],No. of iterations,'Prefilter',Value1,Value2)

Setting and activating the settings for outliers with the following selection option:

Feature = featureElement, featureElement1, featureElement2, primaryDatum, secondaryDatum...

Factor i. P (inside part) = number, off, fromFeature
Factor o.P (outside part) = number
Area data red. = onlyOutliers, adjacentPoints
To [Link] = true,false
No. of iterations = number
Prefilter = undulation, wavelength

If no characteristic is used, a meas. feature should be used instead of the characteristic.

By deactivating the outlier using 'off' or by accepting the settings of the features with
'fromFeature', all further parameters can also be omitted.

setParameterNamed setParameterNamed(Parametername,Value[,Index])

Assignment using parameter name (with index default assignment in list)

setRecheckMode setRecheckMode(Modus [, reset the part number] [, maximum number of repeat measurements])

Set the mode for repeat measurements

setRunID setRunID(characteristic group[,Name2,...])

Reset the characteristic group selected (or more)

CMM-Specific functions and travel
commands
cmmCanUseNavigator cmmCanUseNavigator()

Inquire whether CMM NAVIGATOR capable

cncBreak cncBreak()

CNC run cancelled

displayPositionCMM displayPositionCMM()

Dial Gage Dialog

getActualSide getActualSide()

Current clearance plane (for flexible path selection during stylus change)
getCNCMode getCNCMode()

Current travel mode of machine

getNextStylusSystemName getNextStylusSystemName()

Next stylus system during stylus change

getPositionCMM getPositionCMM()

Current position in machine coordinates

getProbe getProbe([stylus,stylus system])

Access to properties of stylus

getProbeRadiusFromActual getProbeRadiusFromActual(Featurename[,Pointindex[,Elementindex]])

Stylus radius from probing point of a measured feature

getRackAssignment getRackAssignment()

Active rack assignment (for flexible path selection during stylus change)
getRTData getRTData()

Query for diverse RT data

getRTOffset getRTOffset()

Access to the rotary table offset

getRTPosition getRTPosition()

Access to the actual value of the last rotary table position

getRTPositionCMM getRTPositionCMM()

Access to the actual value of the last rotary table position in machine coordinates
getRunMode getRunMode()

Query for diverse run statuses

getTemperatureCorrection getTemperatureCorrection()

Access to properties of temperature correction object

isManProbeChange isManProbeChange()

Request for manual stylus change (for flexible path selection during stylus change)
lowerableRT lowerableRT(['UP'] ['DOWN'] ['STATUS'])

Raise lowerable RT, lower, request status (UP or DOWN)

measureMTMValue measureMTMValue()

Measurement of mass moment of inertia (part incl. RT) and then setting
measVolumeIlluminationOff measVolumeIlluminationOff()

Deactivates the measuring volume illumination

measVolumeIlluminationOn measVolumeIlluminationOn()

Activates the measuring volume illumination

positionCMM positionCMM(x,y,z[,Axis1,Axis2,Axis3])

Travel to given machine position in given axes sequence

positionRS positionRS(x,y,z[,Alignment,Stylus])

Travel to given position in given Alignment with given stylus

readActualWPTemperature readActualWPTemperature(blank = selected sensor or temp. sensor as character string) e.g. ('1') , ('1+2')

Reading of part sensor temperature (only for control output, without considering the temperature compensation)
readWPTemperature readWPTemperature()

Premature reading of sensor temperature

rtAxisDefinition rtAxisDefinition('load' or 'measure')

Set the setting to load or qualify the rotary table axis

searchDistance searchDistance(Number)

Sets the probing search path to a new numerical value

setCNCMode setCNCMode(Mode)

Set Machine Travel Mode

setInspectionDrivingSpeed setInspectionDrivingSpeed(speed. in mm/s)

Change All Travel Speeds

setMTMValue setMTMValue(MTM value in kg m²)

Setting of mass moment of inertia (part incl. RT)

setNavigationPath setNavigationPath('toProbeChange' 'fromProbeChange' , path name)

Select path before/after stylus change

 setWPTemperature setWPTemperature(workpiece temp. in degrees Celsius)

Input of part temperature for temperature compensation

stepRS stepRS(x,y,z[,Alignment])

Step around given coordinates in given Alignment

System Commands
actCalypsoWindowName actCalypsoWindowName()

Current window name for CALYPSO

closeSocket closeSocket()

Closes communication channel between CALYPSO and external application

date date()

Access to current date

dateAndTime dateAndTime()

Access to current date and time

dateInNumbers dateInNumbers()

Access to current date with numerical values

expandNumbers expandCalypso()

Bring CALYPSO window to front

facslsActive facsIsActive()

Query whether FACS active

language language()

Access to the abbreviation for the user interface language

millisecondClockValue millisecondClockValue()

Access to millisecond counter

openSocket openSocket()

Opens communication channel between CALYPSO and external application

systemCall systemCall(Command)

System Commands Call

systemCallForResultAccess systemCallForResultAccess(Command)

Call system commands and wait until they have been processed. External programs CALYPSO access
systemCollIcon systemCallIcon(command)

Call system commands and wait for processing. Program will be started as icon
systemCallWithWait systemCallWithWait(Command)

Call system commands and wait until they have been processed
time time()

Access to current time

timeInSeconds timeInSeconds()

Access to current time in seconds

wait wait(nSeconds)

CNC run will be stopped for nseconds

Custom Printout
defineProtocol defineProtocol(keyword,function value(s))

Flexible Printout Output with PCM

getRecHdForFil getRecHdForFil(Printout header variable)

Access to printout header variables. All characters not permitted in filenames will be replaced
getRecordHead getRecordHead(PrintoutHeaderVariable)

Access to printout header variables

getRecordHeadM getRecordHeadM(printoutheadervariable)

With subsequent evaluation: Access to printout header variables of the measurement

getRecordHeadUnchanged getRecordHeadUnchanged(Printoutheadervariable)

Access to printout header variables without character setting for file definitions
presentationOff presentationOff()

Custom printout will not be displayed

presentationOn presentationOn()

Custom printout will be displayed

setElementsForProtocol setElementsForProtocol(characteristic name[,PMName2,...])

Defines which characteristics will be output

setProtocolOutput setProtocolOutput(printout type, output function)

Set printout independent of CNC start settings

setProtocolSetting setProtocolSetting(Setting,Value)

Access to custom printout settings

setRecordHead setRecordHead(PrintoutHeaderVariable,Value)

Printout header variable settings

setViewsForProtocol setViewsForProtocol(View name1 [,View name2, ...)

Defines which CAD views are to be output in the printout

Conditions/Loops
for_next for i=1 to 4 [step 2] \... \next i

Specific loops
if_else_endif if i<10 then \... \else \... \endif

Condition with alternative

if_endif if i<10 then \... \endif

Simple condition
repeat_until repeat \... \until i>10

Conditioned loop
selectCase_endselect selectCase i \case 10 \... \[case 1 to 5 \...] \[caseElse \...] \endSelect

Condition with several alternatives

CAD
clearCAD clearCAD()

Clear contents of CAD window

deleteTechnologyPoints deleteTechnologyPoints

extractCADPoints extractCADPoints(probe, stylus,alignment,upper tolerance, lower tolerance, offset in direction of normal, group name, 3D point mode,name of
the assigned best fit feature,clearance group,clearance distance, retract distance, mask points, start name for characteristics, start name for
features)

Extracts CAD points

loadCADFile loadCADFile(filename)

Load CAD file of type *.sab or *.sat

moveCADModel moveCADModel(x,y,z)

CAD model moved around x, y, z coordinates

reflectCADModel reflectCADModel

reorderBanner reorderBanner()

Recalculate banners
rotateCADModel rotateCADModel(angle in degrees[,axis as number1-3])

CAD model rotated about an angle around an axis, given by the number 1,2,3. If no axis information is given, then rotation around Z.
saveView saveView(View name)

Saving a CAD view

setArrowLength setArrowLength(value)

Sets the arrow length in relation to the height of the CAD window (0-1)
setCoordSysVisible setCoordSysVisible(true or false)

Display of the alignment

setFit setFit()

Display of all features in the CAD view

setShaded setShaded()

Set edges of CAD-Model

setTarget setTarget(x,y,z)

Setting the rotation point

setViewDirection setViewDirection(nx,ny,nz)

Setting the direction of view

setWireframe setWireframe()

View of the CAD model as a wireframe

showBanner showBanner

Displays the flags for all characteristics.

stitchingCAD stitchingCAD(value)

StitchingTolerance in mm
Edit
addCircularPath addCircularPath(feature, measuring height, no. of measured points, step width, speed[,angle segment])

Adds a circle segment strategy to a feature

computeId computeId(text expansion)

Compiles a new name from Measurement plan name + . + text expansion

deleteCharacteristic deleteCharacteristic(name of characteristic)

Deletes a characteristic
deleteFeature deleteFeature(name of feature)

Deletes a feature
deleteTechnology deleteStrategy(feature,index of the strategy segment to be deleted)

Deletes a strategy segment of a feature

getFeatureElement getFeatureElement

getTechnology getStrategy(feature)

Reads the strategy of a feature

getTechnologySegment getStrategySegment(strategy, Segment number)

Reads the segment of a strategy

renameFeature renameFeature(old name, new name)

Rename feature
setGeometryToCircle setGeometryToCircle(feature)

Converts the feature to a circle

setGeometryToCone setGeometryToCone(feature)

Converts the feature to a cone

setGeometeryToCylinder setGeometryToCylinder(Feature)

Converts the feature to a cylinder

setNumberOfPoints setNumberOfPoints(strategy segment, no. of points)

Sets the number of points in a strategy segment

setStep setStep(Strategy segment, step width)

Sets the step width in a strategy segment