Skip to content

Commit 18c94c3

Browse files
committed
Updated comments
1 parent f25e017 commit 18c94c3

File tree

10 files changed

+45
-55
lines changed

10 files changed

+45
-55
lines changed

MinimalApp.xml

Lines changed: 0 additions & 10 deletions
This file was deleted.

control_cpp/src/AppClient.cpp

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1165,7 +1165,7 @@ DataTypes::MotionState AppClient::UnloadLogicProgram()
11651165
/**
11661166
* @brief Starts a joint motion to the given position
11671167
* @param velocityPercent velocity in percent, 0.0..100.0
1168-
* @param acceleration acceleration in percent, currently not used
1168+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
11691169
* @param a1 A1 target in degrees or mm
11701170
* @param a2 A2 target in degrees or mm
11711171
* @param a3 A3 target in degrees or mm
@@ -1212,7 +1212,7 @@ DataTypes::MotionState AppClient::MoveToJoint(float velocityPercent, float accel
12121212
/**
12131213
* @brief Starts a relative joint motion to the given position
12141214
* @param velocityPercent velocity in percent, 0.0..100.0
1215-
* @param acceleration acceleration in percent, currently not used
1215+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
12161216
* @param a1 A1 target in degrees or mm
12171217
* @param a2 A2 target in degrees or mm
12181218
* @param a3 A3 target in degrees or mm
@@ -1259,7 +1259,7 @@ DataTypes::MotionState AppClient::MoveToJointRelative(float velocityPercent, flo
12591259
/**
12601260
* @brief Starts a linear motion to the given position
12611261
* @param velocityMms velocity in mm/s
1262-
* @param acceleration acceleration in percent, currently not used
1262+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
12631263
* @param x X position in mm
12641264
* @param y Y position in mm
12651265
* @param z Z position in mm
@@ -1308,7 +1308,7 @@ DataTypes::MotionState AppClient::MoveToLinear(float velocityMms, float accelera
13081308
/**
13091309
* @brief Starts a linear motion to the given position
13101310
* @param velocityMms velocity in mm/s
1311-
* @param acceleration acceleration in percent, currently not used
1311+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
13121312
* @param x X position in mm
13131313
* @param y Y position in mm
13141314
* @param z Z position in mm
@@ -1356,7 +1356,7 @@ DataTypes::MotionState AppClient::MoveToLinearRelativeBase(float velocityMms, fl
13561356
/**
13571357
* @brief Starts a linear motion to the given position
13581358
* @param velocityMms velocity in mm/s
1359-
* @param acceleration acceleration in percent, currently not used
1359+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
13601360
* @param x X position in mm
13611361
* @param y Y position in mm
13621362
* @param z Z position in mm

control_cpp/src/AppClient.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ class AppClient
382382
/**
383383
* @brief Starts a joint motion to the given position
384384
* @param velocityPercent velocity in percent, 0.0..100.0
385-
* @param acceleration acceleration in percent, currently not used
385+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
386386
* @param a1 A1 target in degrees or mm
387387
* @param a2 A2 target in degrees or mm
388388
* @param a3 A3 target in degrees or mm
@@ -399,7 +399,7 @@ class AppClient
399399
/**
400400
* @brief Starts a relative joint motion to the given position
401401
* @param velocityPercent velocity in percent, 0.0..100.0
402-
* @param acceleration acceleration in percent, currently not used
402+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
403403
* @param a1 A1 target in degrees or mm
404404
* @param a2 A2 target in degrees or mm
405405
* @param a3 A3 target in degrees or mm
@@ -416,7 +416,7 @@ class AppClient
416416
/**
417417
* @brief Starts a linear motion to the given position
418418
* @param velocityMms velocity in mm/s
419-
* @param acceleration acceleration in percent, currently not used
419+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
420420
* @param x X position in mm
421421
* @param y Y position in mm
422422
* @param z Z position in mm
@@ -434,7 +434,7 @@ class AppClient
434434
/**
435435
* @brief Starts a linear motion to the given position
436436
* @param velocityMms velocity in mm/s
437-
* @param acceleration acceleration in percent, currently not used
437+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
438438
* @param x X position in mm
439439
* @param y Y position in mm
440440
* @param z Z position in mm
@@ -452,7 +452,7 @@ class AppClient
452452
/**
453453
* @brief Starts a linear motion to the given position
454454
* @param velocityMms velocity in mm/s
455-
* @param acceleration acceleration in percent, currently not used
455+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
456456
* @param x X position in mm
457457
* @param y Y position in mm
458458
* @param z Z position in mm

control_python/AppClient.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -862,7 +862,7 @@ def MoveToJoint(
862862
Starts a joint motion to the given position
863863
Parameters:
864864
velocityPercent: velocity in percent, 0.0..100.0
865-
acceleration: acceleration in percent, currently not used
865+
acceleration: acceleration in percent, 0.0..100.0, negative values result in default value 40%
866866
a1: A1 target in degrees or mm
867867
a2: A2 target in degrees or mm
868868
a3: A3 target in degrees or mm
@@ -911,7 +911,7 @@ def MoveToJointRelative(
911911
Starts a relative joint motion to the given position
912912
Parameters:
913913
velocityPercent: velocity in percent, 0.0..100.0
914-
acceleration: acceleration in percent, currently not used
914+
acceleration: acceleration in percent, 0.0..100.0, negative values result in default value 40%
915915
a1: A1 target in degrees or mm
916916
a2: A2 target in degrees or mm
917917
a3: A3 target in degrees or mm
@@ -961,7 +961,7 @@ def MoveToLinear(
961961
Starts a linear motion to the given position
962962
Parameters:
963963
velocityMms: velocity in mm/s
964-
acceleration: acceleration in percent, currently not used
964+
acceleration: acceleration in percent, 0.0..100.0, negative values result in default value 40%
965965
x: X position in mm
966966
y: Y position in mm
967967
z: Z position in mm
@@ -1013,7 +1013,7 @@ def MoveToLinearRelativeBase(
10131013
Starts a linear motion to the given position
10141014
Parameters:
10151015
velocityMms: velocity in mm/s
1016-
acceleration: acceleration in percent, currently not used
1016+
acceleration: acceleration in percent, 0.0..100.0, negative values result in default value 40%
10171017
x: X position in mm
10181018
y: Y position in mm
10191019
z: Z position in mm
@@ -1064,7 +1064,7 @@ def MoveToLinearRelativeTool(
10641064
Starts a linear motion to the given position
10651065
Parameters:
10661066
velocityMms: velocity in mm/s
1067-
acceleration: acceleration in percent, currently not used
1067+
acceleration: acceleration in percent, 0.0..100.0, negative values result in default value 40%
10681068
x: X position in mm
10691069
y: Y position in mm
10701070
z: Z position in mm

minimal_cpp/src/AppClient.cpp

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1165,7 +1165,7 @@ DataTypes::MotionState AppClient::UnloadLogicProgram()
11651165
/**
11661166
* @brief Starts a joint motion to the given position
11671167
* @param velocityPercent velocity in percent, 0.0..100.0
1168-
* @param acceleration acceleration in percent, currently not used
1168+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
11691169
* @param a1 A1 target in degrees or mm
11701170
* @param a2 A2 target in degrees or mm
11711171
* @param a3 A3 target in degrees or mm
@@ -1212,7 +1212,7 @@ DataTypes::MotionState AppClient::MoveToJoint(float velocityPercent, float accel
12121212
/**
12131213
* @brief Starts a relative joint motion to the given position
12141214
* @param velocityPercent velocity in percent, 0.0..100.0
1215-
* @param acceleration acceleration in percent, currently not used
1215+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
12161216
* @param a1 A1 target in degrees or mm
12171217
* @param a2 A2 target in degrees or mm
12181218
* @param a3 A3 target in degrees or mm
@@ -1259,7 +1259,7 @@ DataTypes::MotionState AppClient::MoveToJointRelative(float velocityPercent, flo
12591259
/**
12601260
* @brief Starts a linear motion to the given position
12611261
* @param velocityMms velocity in mm/s
1262-
* @param acceleration acceleration in percent, currently not used
1262+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
12631263
* @param x X position in mm
12641264
* @param y Y position in mm
12651265
* @param z Z position in mm
@@ -1308,7 +1308,7 @@ DataTypes::MotionState AppClient::MoveToLinear(float velocityMms, float accelera
13081308
/**
13091309
* @brief Starts a linear motion to the given position
13101310
* @param velocityMms velocity in mm/s
1311-
* @param acceleration acceleration in percent, currently not used
1311+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
13121312
* @param x X position in mm
13131313
* @param y Y position in mm
13141314
* @param z Z position in mm
@@ -1356,7 +1356,7 @@ DataTypes::MotionState AppClient::MoveToLinearRelativeBase(float velocityMms, fl
13561356
/**
13571357
* @brief Starts a linear motion to the given position
13581358
* @param velocityMms velocity in mm/s
1359-
* @param acceleration acceleration in percent, currently not used
1359+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
13601360
* @param x X position in mm
13611361
* @param y Y position in mm
13621362
* @param z Z position in mm

minimal_cpp/src/AppClient.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ class AppClient
382382
/**
383383
* @brief Starts a joint motion to the given position
384384
* @param velocityPercent velocity in percent, 0.0..100.0
385-
* @param acceleration acceleration in percent, currently not used
385+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
386386
* @param a1 A1 target in degrees or mm
387387
* @param a2 A2 target in degrees or mm
388388
* @param a3 A3 target in degrees or mm
@@ -399,7 +399,7 @@ class AppClient
399399
/**
400400
* @brief Starts a relative joint motion to the given position
401401
* @param velocityPercent velocity in percent, 0.0..100.0
402-
* @param acceleration acceleration in percent, currently not used
402+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
403403
* @param a1 A1 target in degrees or mm
404404
* @param a2 A2 target in degrees or mm
405405
* @param a3 A3 target in degrees or mm
@@ -416,7 +416,7 @@ class AppClient
416416
/**
417417
* @brief Starts a linear motion to the given position
418418
* @param velocityMms velocity in mm/s
419-
* @param acceleration acceleration in percent, currently not used
419+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
420420
* @param x X position in mm
421421
* @param y Y position in mm
422422
* @param z Z position in mm
@@ -434,7 +434,7 @@ class AppClient
434434
/**
435435
* @brief Starts a linear motion to the given position
436436
* @param velocityMms velocity in mm/s
437-
* @param acceleration acceleration in percent, currently not used
437+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
438438
* @param x X position in mm
439439
* @param y Y position in mm
440440
* @param z Z position in mm
@@ -452,7 +452,7 @@ class AppClient
452452
/**
453453
* @brief Starts a linear motion to the given position
454454
* @param velocityMms velocity in mm/s
455-
* @param acceleration acceleration in percent, currently not used
455+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
456456
* @param x X position in mm
457457
* @param y Y position in mm
458458
* @param z Z position in mm

minimal_python/AppClient.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -862,7 +862,7 @@ def MoveToJoint(
862862
Starts a joint motion to the given position
863863
Parameters:
864864
velocityPercent: velocity in percent, 0.0..100.0
865-
acceleration: acceleration in percent, currently not used
865+
acceleration: acceleration in percent, 0.0..100.0, negative values result in default value 40%
866866
a1: A1 target in degrees or mm
867867
a2: A2 target in degrees or mm
868868
a3: A3 target in degrees or mm
@@ -911,7 +911,7 @@ def MoveToJointRelative(
911911
Starts a relative joint motion to the given position
912912
Parameters:
913913
velocityPercent: velocity in percent, 0.0..100.0
914-
acceleration: acceleration in percent, currently not used
914+
acceleration: acceleration in percent, 0.0..100.0, negative values result in default value 40%
915915
a1: A1 target in degrees or mm
916916
a2: A2 target in degrees or mm
917917
a3: A3 target in degrees or mm
@@ -961,7 +961,7 @@ def MoveToLinear(
961961
Starts a linear motion to the given position
962962
Parameters:
963963
velocityMms: velocity in mm/s
964-
acceleration: acceleration in percent, currently not used
964+
acceleration: acceleration in percent, 0.0..100.0, negative values result in default value 40%
965965
x: X position in mm
966966
y: Y position in mm
967967
z: Z position in mm
@@ -1013,7 +1013,7 @@ def MoveToLinearRelativeBase(
10131013
Starts a linear motion to the given position
10141014
Parameters:
10151015
velocityMms: velocity in mm/s
1016-
acceleration: acceleration in percent, currently not used
1016+
acceleration: acceleration in percent, 0.0..100.0, negative values result in default value 40%
10171017
x: X position in mm
10181018
y: Y position in mm
10191019
z: Z position in mm
@@ -1064,7 +1064,7 @@ def MoveToLinearRelativeTool(
10641064
Starts a linear motion to the given position
10651065
Parameters:
10661066
velocityMms: velocity in mm/s
1067-
acceleration: acceleration in percent, currently not used
1067+
acceleration: acceleration in percent, 0.0..100.0, negative values result in default value 40%
10681068
x: X position in mm
10691069
y: Y position in mm
10701070
z: Z position in mm

monitor_cpp/src/AppClient.cpp

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1165,7 +1165,7 @@ DataTypes::MotionState AppClient::UnloadLogicProgram()
11651165
/**
11661166
* @brief Starts a joint motion to the given position
11671167
* @param velocityPercent velocity in percent, 0.0..100.0
1168-
* @param acceleration acceleration in percent, currently not used
1168+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
11691169
* @param a1 A1 target in degrees or mm
11701170
* @param a2 A2 target in degrees or mm
11711171
* @param a3 A3 target in degrees or mm
@@ -1212,7 +1212,7 @@ DataTypes::MotionState AppClient::MoveToJoint(float velocityPercent, float accel
12121212
/**
12131213
* @brief Starts a relative joint motion to the given position
12141214
* @param velocityPercent velocity in percent, 0.0..100.0
1215-
* @param acceleration acceleration in percent, currently not used
1215+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
12161216
* @param a1 A1 target in degrees or mm
12171217
* @param a2 A2 target in degrees or mm
12181218
* @param a3 A3 target in degrees or mm
@@ -1259,7 +1259,7 @@ DataTypes::MotionState AppClient::MoveToJointRelative(float velocityPercent, flo
12591259
/**
12601260
* @brief Starts a linear motion to the given position
12611261
* @param velocityMms velocity in mm/s
1262-
* @param acceleration acceleration in percent, currently not used
1262+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
12631263
* @param x X position in mm
12641264
* @param y Y position in mm
12651265
* @param z Z position in mm
@@ -1308,7 +1308,7 @@ DataTypes::MotionState AppClient::MoveToLinear(float velocityMms, float accelera
13081308
/**
13091309
* @brief Starts a linear motion to the given position
13101310
* @param velocityMms velocity in mm/s
1311-
* @param acceleration acceleration in percent, currently not used
1311+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
13121312
* @param x X position in mm
13131313
* @param y Y position in mm
13141314
* @param z Z position in mm
@@ -1356,7 +1356,7 @@ DataTypes::MotionState AppClient::MoveToLinearRelativeBase(float velocityMms, fl
13561356
/**
13571357
* @brief Starts a linear motion to the given position
13581358
* @param velocityMms velocity in mm/s
1359-
* @param acceleration acceleration in percent, currently not used
1359+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
13601360
* @param x X position in mm
13611361
* @param y Y position in mm
13621362
* @param z Z position in mm

monitor_cpp/src/AppClient.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ class AppClient
382382
/**
383383
* @brief Starts a joint motion to the given position
384384
* @param velocityPercent velocity in percent, 0.0..100.0
385-
* @param acceleration acceleration in percent, currently not used
385+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
386386
* @param a1 A1 target in degrees or mm
387387
* @param a2 A2 target in degrees or mm
388388
* @param a3 A3 target in degrees or mm
@@ -399,7 +399,7 @@ class AppClient
399399
/**
400400
* @brief Starts a relative joint motion to the given position
401401
* @param velocityPercent velocity in percent, 0.0..100.0
402-
* @param acceleration acceleration in percent, currently not used
402+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
403403
* @param a1 A1 target in degrees or mm
404404
* @param a2 A2 target in degrees or mm
405405
* @param a3 A3 target in degrees or mm
@@ -416,7 +416,7 @@ class AppClient
416416
/**
417417
* @brief Starts a linear motion to the given position
418418
* @param velocityMms velocity in mm/s
419-
* @param acceleration acceleration in percent, currently not used
419+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
420420
* @param x X position in mm
421421
* @param y Y position in mm
422422
* @param z Z position in mm
@@ -434,7 +434,7 @@ class AppClient
434434
/**
435435
* @brief Starts a linear motion to the given position
436436
* @param velocityMms velocity in mm/s
437-
* @param acceleration acceleration in percent, currently not used
437+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
438438
* @param x X position in mm
439439
* @param y Y position in mm
440440
* @param z Z position in mm
@@ -452,7 +452,7 @@ class AppClient
452452
/**
453453
* @brief Starts a linear motion to the given position
454454
* @param velocityMms velocity in mm/s
455-
* @param acceleration acceleration in percent, currently not used
455+
* @param acceleration acceleration in percent, 0.0..100.0, negative values result in default value 40%
456456
* @param x X position in mm
457457
* @param y Y position in mm
458458
* @param z Z position in mm

0 commit comments

Comments
 (0)