YouBotJointParameter.hpp
Go to the documentation of this file.
1 #ifndef YOUBOT_YOUBOTJOINTPARAMETER_H
2 #define YOUBOT_YOUBOTJOINTPARAMETER_H
3 
4 /****************************************************************
5  *
6  * Copyright (c) 2011
7  * All rights reserved.
8  *
9  * Hochschule Bonn-Rhein-Sieg
10  * University of Applied Sciences
11  * Computer Science Department
12  *
13  * +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
14  *
15  * Author:
16  * Jan Paulus, Nico Hochgeschwender, Michael Reckhaus, Azamat Shakhimardanov
17  * Supervised by:
18  * Gerhard K. Kraetzschmar
19  *
20  * +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
21  *
22  * This sofware is published under a dual-license: GNU Lesser General Public
23  * License LGPL 2.1 and BSD license. The dual-license implies that users of this
24  * code may choose which terms they prefer.
25  *
26  * +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
27  *
28  * Redistribution and use in source and binary forms, with or without
29  * modification, are permitted provided that the following conditions are met:
30  *
31  * * Redistributions of source code must retain the above copyright
32  * notice, this list of conditions and the following disclaimer.
33  * * Redistributions in binary form must reproduce the above copyright
34  * notice, this list of conditions and the following disclaimer in the
35  * documentation and/or other materials provided with the distribution.
36  * * Neither the name of the Hochschule Bonn-Rhein-Sieg nor the names of its
37  * contributors may be used to endorse or promote products derived from
38  * this software without specific prior written permission.
39  *
40  * This program is free software: you can redistribute it and/or modify
41  * it under the terms of the GNU Lesser General Public License LGPL as
42  * published by the Free Software Foundation, either version 2.1 of the
43  * License, or (at your option) any later version or the BSD license.
44  *
45  * This program is distributed in the hope that it will be useful,
46  * but WITHOUT ANY WARRANTY; without even the implied warranty of
47  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
48  * GNU Lesser General Public License LGPL and the BSD license for more details.
49  *
50  * You should have received a copy of the GNU Lesser General Public
51  * License LGPL and BSD license along with this program.
52  *
53  ****************************************************************/
54 #include <boost/limits.hpp>
56 namespace youbot {
57 
61 
62 };
67 friend class YouBotJoint;
68  protected:
70 
71 
72  public:
73  virtual ~YouBotApiJointParameter();
74 
75  virtual void toString(std::string& value) = 0;
76 
77 
78  protected:
79  virtual void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const = 0;
80 
81  virtual void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage) = 0;
82 
83  virtual std::string getName() const = 0;
84 
85  virtual ParameterType getType() const = 0;
86 
87  std::string name;
88 
90 
91 };
96 friend class YouBotJoint;
97  protected:
99 
100 
101  public:
102  virtual ~YouBotJointParameter();
103 
104  virtual void toString(std::string& value) = 0;
105 
106 
107  protected:
108  virtual void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const = 0;
109 
110  virtual void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage) = 0;
111 
112  virtual std::string getName() const = 0;
113 
114  virtual ParameterType getType() const = 0;
115 
116  std::string name;
117 
119 
120 };
125 friend class YouBotJoint;
126  public:
127  JointName();
128 
129  virtual ~JointName();
130 
131  void getParameter(std::string& parameter) const;
132 
133  void setParameter(const std::string parameter);
134 
135  void toString(std::string& value);
136 
137 
138  private:
139  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const {};
140 
141  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage) {};
142 
143  std::string getName() const {return this->name;};
144 
145  ParameterType getType() const {return this->parameterType;};
146 
147  std::string value;
148 
149  std::string name;
150 
152 
153 };
158 friend class YouBotJoint;
159  public:
160  InitializeJoint();
161 
162  virtual ~InitializeJoint();
163 
164  void getParameter(bool& parameter) const;
165 
166  void setParameter(const bool parameter);
167 
168  void toString(std::string& value);
169 
170 
171  private:
172  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
173 
174  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
175 
176  std::string getName() const {return this->name;};
177 
178  ParameterType getType() const {return this->parameterType;};
179 
180  bool value;
181 
182  std::string name;
183 
185 
186 };
191 friend class YouBotJoint;
192  public:
193  CalibrateJoint();
194 
195  virtual ~CalibrateJoint();
196 
197  void getParameter(bool& doCalibration, CalibrationDirection& calibrationDirection, quantity<si::current>& maxCurrent) const;
198 
199  void setParameter(const bool doCalibration, CalibrationDirection calibrationDirection, const quantity<si::current>& maxCurrent);
200 
201  void toString(std::string& value);
202 
203 
204  private:
205  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const {};
206 
207  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage) {};
208 
209  std::string getName() const {return this->name;};
210 
211  ParameterType getType() const {return this->parameterType;};
212 
213  bool doCalibration;
214 
215  std::string name;
216 
218 
220 
221  quantity<si::current> maxCurrent;
222 
223 };
228 friend class YouBotJoint;
229  public:
230  FirmwareVersion();
231 
232  virtual ~FirmwareVersion();
233 
234  void getParameter(int& controllerType, std::string& firmwareVersion) const;
235 
236  void setParameter(const int controllerType, const std::string firmwareVersion);
237 
238  void toString(std::string& value);
239 
240 
241  private:
242  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
243 
244  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
245 
246  std::string getName() const {return this->name;};
247 
248  ParameterType getType() const {return this->parameterType;};
249 
250  int controllerType;
251 
252  std::string firmwareVersion;
253 
254  std::string name;
255 
257 
258 };
263 friend class YouBotJoint;
264  public:
265  GearRatio();
266 
267  virtual ~GearRatio();
268 
269  void getParameter(double& parameter) const;
270 
271  void setParameter(const double parameter);
272 
273  void toString(std::string& value);
274 
275 
276  private:
277  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const {};
278 
279  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage) {};
280 
281  std::string getName() const {return this->name;};
282 
283  ParameterType getType() const {return this->parameterType;};
284 
285  double value;
286 
287  std::string name;
288 
290 
291 };
296 friend class YouBotJoint;
297  public:
299 
300  virtual ~EncoderTicksPerRound();
301 
302  void getParameter(unsigned int& parameter) const;
303 
304  void setParameter(const unsigned int parameter);
305 
306  void toString(std::string& value);
307 
308 
309  private:
310  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const {};
311 
312  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage) {};
313 
314  std::string getName() const {return this->name;};
315 
316  ParameterType getType() const {return this->parameterType;};
317 
318  unsigned int value;
319 
320  std::string name;
321 
323 
324 };
329 friend class YouBotJoint;
330  public:
332 
333  virtual ~InverseMovementDirection();
334 
335  void getParameter(bool& parameter) const;
336 
337  void setParameter(const bool parameter);
338 
339  void toString(std::string& value);
340 
341 
342  private:
343  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const {};
344 
345  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage) {};
346 
347  std::string getName() const {return this->name;};
348 
349  ParameterType getType() const {return this->parameterType;};
350 
351  bool value;
352 
353  std::string name;
354 
356 
357 };
362 friend class YouBotJoint;
363  public:
364  JointLimits();
365 
366  virtual ~JointLimits();
367 
368  void getParameter(int& lowerLimit, int& upperLimit, bool& areLimitsActive) const;
369 
370  void setParameter(const int lowerLimit, const int upperLimit, const bool activateLimits);
371 
372  void toString(std::string& value);
373 
374 
375  private:
376  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const {};
377 
378  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage) {};
379 
380  std::string getName() const {return this->name;};
381 
382  ParameterType getType() const {return this->parameterType;};
383 
384  int lowerLimit;
385 
387 
388  std::string name;
389 
391 
393 
394 };
399 friend class YouBotJoint;
400  public:
402 
403  virtual ~JointLimitsRadian();
404 
405  void getParameter(quantity<plane_angle>& lowerLimit, quantity<plane_angle>& upperLimit, bool& areLimitsActive) const;
406 
407  void setParameter(const quantity<plane_angle>& lowerLimit, const quantity<plane_angle>& upperLimit, const bool activateLimits);
408 
409  void toString(std::string& value);
410 
411 
412  private:
413  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const {};
414 
415  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage) {};
416 
417  std::string getName() const {return this->name;};
418 
419  ParameterType getType() const {return this->parameterType;};
420 
421  quantity<plane_angle> lowerLimit;
422 
423  quantity<plane_angle> upperLimit;
424 
425  std::string name;
426 
428 
430 
431 };
436 friend class YouBotJoint;
437  public:
438  TorqueConstant();
439 
440  virtual ~TorqueConstant();
441 
442  void getParameter(double& parameter) const;
443 
444  void setParameter(const double parameter);
445 
446  void toString(std::string& value);
447 
448 
449  private:
450  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const {};
451 
452  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage) {};
453 
454  std::string getName() const {return this->name;};
455 
456  ParameterType getType() const {return this->parameterType;};
457 
458  double value;
459 
460  std::string name;
461 
463 
464 };
469 friend class YouBotJoint;
470  public:
472 
473  virtual ~MaximumPositioningVelocity();
474 
475  void getParameter(quantity<angular_velocity>& parameter) const;
476 
477  void setParameter(const quantity<angular_velocity>& parameter);
478 
479  void toString(std::string& value);
480 
481 
482  private:
483  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
484 
485  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
486 
487  std::string getName() const {return this->name;};
488 
489  ParameterType getType() const {return this->parameterType;};
490 
491  quantity<angular_velocity> upperLimit;
492 
493  quantity<angular_velocity> lowerLimit;
494 
495  quantity<angular_velocity> value;
496 
497  std::string name;
498 
500 
501 };
506 friend class YouBotJoint;
507  public:
509 
510  virtual ~MotorAcceleration();
511 
512  void getParameter(quantity<angular_acceleration>& parameter) const;
513 
514  void setParameter(const quantity<angular_acceleration>& parameter);
515 
516  void toString(std::string& value);
517 
518 
519  private:
520  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
521 
522  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
523 
524  std::string getName() const {return this->name;};
525 
526  ParameterType getType() const {return this->parameterType;};
527 
528  quantity<angular_acceleration> upperLimit;
529 
530  quantity<angular_acceleration> lowerLimit;
531 
532  quantity<angular_acceleration> value;
533 
534  std::string name;
535 
537 
538 };
543 friend class YouBotJoint;
544  public:
546 
548 
549  void getParameter(bool& parameter) const;
550 
551  void setParameter(const bool parameter);
552 
553  void toString(std::string& value);
554 
555 
556  private:
557  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
558 
559  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
560 
561  std::string getName() const {return this->name;};
562 
563  ParameterType getType() const {return this->parameterType;};
564 
565  bool value;
566 
567  std::string name;
568 
570 
571 };
576 friend class YouBotJoint;
577  public:
579 
581 
582  void getParameter(quantity<angular_velocity>& parameter) const;
583 
584  void setParameter(const quantity<angular_velocity>& parameter);
585 
586  void toString(std::string& value);
587 
588 
589  private:
590  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
591 
592  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
593 
594  std::string getName() const {return this->name;};
595 
596  ParameterType getType() const {return this->parameterType;};
597 
598  quantity<angular_velocity> upperLimit;
599 
600  quantity<angular_velocity> lowerLimit;
601 
602  quantity<angular_velocity> value;
603 
604  std::string name;
605 
607 
608 };
611 
614 friend class YouBotJoint;
615  public:
617 
619 
620  void getParameter(quantity<angular_velocity>& parameter) const;
621 
622  void setParameter(const quantity<angular_velocity>& parameter);
623 
624  void toString(std::string& value);
625 
626 
627  private:
628  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
629 
630  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
631 
632  std::string getName() const {return this->name;};
633 
634  ParameterType getType() const {return this->parameterType;};
635 
636  quantity<angular_velocity> upperLimit;
637 
638  quantity<angular_velocity> lowerLimit;
639 
640  quantity<angular_velocity> value;
641 
642  std::string name;
643 
645 
646 };
651 friend class YouBotJoint;
652  public:
654 
655  virtual ~VelocityThresholdForHallFX();
656 
657  void getParameter(quantity<angular_velocity>& parameter) const;
658 
659  void setParameter(const quantity<angular_velocity>& parameter);
660 
661  void toString(std::string& value);
662 
663 
664  private:
665  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
666 
667  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
668 
669  std::string getName() const {return this->name;};
670 
671  ParameterType getType() const {return this->parameterType;};
672 
673  quantity<angular_velocity> upperLimit;
674 
675  quantity<angular_velocity> lowerLimit;
676 
677  quantity<angular_velocity> value;
678 
679  std::string name;
680 
682 
683 };
688 friend class YouBotJoint;
689  public:
691 
693 
694  void getParameter(int& parameter) const;
695 
696  void setParameter(const int parameter);
697 
698  void toString(std::string& value);
699 
700 
701  private:
702  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
703 
704  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
705 
706  std::string getName() const {return this->name;};
707 
708  ParameterType getType() const {return this->parameterType;};
709 
710  int upperLimit;
711 
713 
714  int value;
715 
716  std::string name;
717 
719 
720 };
725 friend class YouBotJoint;
726  public:
728 
730 
731  void getParameter(int& parameter) const;
732 
733  void setParameter(const int parameter);
734 
735  void toString(std::string& value);
736 
737 
738  private:
739  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
740 
741  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
742 
743  std::string getName() const {return this->name;};
744 
745  ParameterType getType() const {return this->parameterType;};
746 
747  int upperLimit;
748 
750 
751  int value;
752 
753  std::string name;
754 
756 
757 };
762 friend class YouBotJoint;
763  public:
765 
767 
768  void getParameter(int& parameter) const;
769 
770  void setParameter(const int parameter);
771 
772  void toString(std::string& value);
773 
774 
775  private:
776  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
777 
778  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
779 
780  std::string getName() const {return this->name;};
781 
782  ParameterType getType() const {return this->parameterType;};
783 
784  int upperLimit;
785 
787 
788  int value;
789 
790  std::string name;
791 
793 
794 };
799 friend class YouBotJoint;
800  public:
802 
804 
805  void getParameter(int& parameter) const;
806 
807  void setParameter(const int parameter);
808 
809  void toString(std::string& value);
810 
811 
812  private:
813  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
814 
815  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
816 
817  std::string getName() const {return this->name;};
818 
819  ParameterType getType() const {return this->parameterType;};
820 
821  int upperLimit;
822 
824 
825  int value;
826 
827  std::string name;
828 
830 
831 };
836 friend class YouBotJoint;
837  public:
839 
841 
842  void getParameter(int& parameter) const;
843 
844  void setParameter(const int parameter);
845 
846  void toString(std::string& value);
847 
848 
849  private:
850  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
851 
852  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
853 
854  std::string getName() const {return this->name;};
855 
856  ParameterType getType() const {return this->parameterType;};
857 
858  int upperLimit;
859 
861 
862  int value;
863 
864  std::string name;
865 
867 
868 };
873 friend class YouBotJoint;
874  public:
876 
878 
879  void getParameter(int& parameter) const;
880 
881  void setParameter(const int parameter);
882 
883  void toString(std::string& value);
884 
885 
886  private:
887  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
888 
889  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
890 
891  std::string getName() const {return this->name;};
892 
893  ParameterType getType() const {return this->parameterType;};
894 
895  int upperLimit;
896 
898 
899  int value;
900 
901  std::string name;
902 
904 
905 };
910 friend class YouBotJoint;
911  public:
913 
915 
916  void getParameter(int& parameter) const;
917 
918  void setParameter(const int parameter);
919 
920  void toString(std::string& value);
921 
922 
923  private:
924  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
925 
926  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
927 
928  std::string getName() const {return this->name;};
929 
930  ParameterType getType() const {return this->parameterType;};
931 
932  int upperLimit;
933 
935 
936  int value;
937 
938  std::string name;
939 
941 
942 };
947 friend class YouBotJoint;
948  public:
950 
952 
953  void getParameter(int& parameter) const;
954 
955  void setParameter(const int parameter);
956 
957  void toString(std::string& value);
958 
959 
960  private:
961  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
962 
963  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
964 
965  std::string getName() const {return this->name;};
966 
967  ParameterType getType() const {return this->parameterType;};
968 
969  int upperLimit;
970 
972 
973  int value;
974 
975  std::string name;
976 
978 
979 };
984 friend class YouBotJoint;
985  public:
987 
989 
990  void getParameter(int& parameter) const;
991 
992  void setParameter(const int parameter);
993 
994  void toString(std::string& value);
995 
996 
997  private:
998  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
999 
1000  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
1001 
1002  std::string getName() const {return this->name;};
1003 
1004  ParameterType getType() const {return this->parameterType;};
1005 
1006  int upperLimit;
1007 
1009 
1010  int value;
1011 
1012  std::string name;
1013 
1015 
1016 };
1021 friend class YouBotJoint;
1022  public:
1024 
1026 
1027  void getParameter(int& parameter) const;
1028 
1029  void setParameter(const int parameter);
1030 
1031  void toString(std::string& value);
1032 
1033 
1034  private:
1035  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
1036 
1037  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
1038 
1039  std::string getName() const {return this->name;};
1040 
1041  ParameterType getType() const {return this->parameterType;};
1042 
1043  int upperLimit;
1044 
1046 
1047  int value;
1048 
1049  std::string name;
1050 
1052 
1053 };
1058 friend class YouBotJoint;
1059  public:
1061 
1063 
1064  void getParameter(int& parameter) const;
1065 
1066  void setParameter(const int parameter);
1067 
1068  void toString(std::string& value);
1069 
1070 
1071  private:
1072  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
1073 
1074  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
1075 
1076  std::string getName() const {return this->name;};
1077 
1078  ParameterType getType() const {return this->parameterType;};
1079 
1080  int upperLimit;
1081 
1083 
1084  int value;
1085 
1086  std::string name;
1087 
1089 
1090 };
1095 friend class YouBotJoint;
1096  public:
1098 
1100 
1101  void getParameter(int& parameter) const;
1102 
1103  void setParameter(const int parameter);
1104 
1105  void toString(std::string& value);
1106 
1107 
1108  private:
1109  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
1110 
1111  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
1112 
1113  std::string getName() const {return this->name;};
1114 
1115  ParameterType getType() const {return this->parameterType;};
1116 
1117  int upperLimit;
1118 
1120 
1121  int value;
1122 
1123  std::string name;
1124 
1126 
1127 };
1132 friend class YouBotJoint;
1133  public:
1135 
1137 
1138  void getParameter(int& parameter) const;
1139 
1140  void setParameter(const int parameter);
1141 
1142  void toString(std::string& value);
1143 
1144 
1145  private:
1146  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
1147 
1148  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
1149 
1150  std::string getName() const {return this->name;};
1151 
1152  ParameterType getType() const {return this->parameterType;};
1153 
1154  int upperLimit;
1155 
1157 
1158  int value;
1159 
1160  std::string name;
1161 
1163 
1164 };
1169 friend class YouBotJoint;
1170  public:
1172 
1174 
1175  void getParameter(int& parameter) const;
1176 
1177  void setParameter(const int parameter);
1178 
1179  void toString(std::string& value);
1180 
1181 
1182  private:
1183  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
1184 
1185  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
1186 
1187  std::string getName() const {return this->name;};
1188 
1189  ParameterType getType() const {return this->parameterType;};
1190 
1191  int upperLimit;
1192 
1194 
1195  int value;
1196 
1197  std::string name;
1198 
1200 
1201 };
1206 friend class YouBotJoint;
1207  public:
1209 
1211 
1212  void getParameter(int& parameter) const;
1213 
1214  void setParameter(const int parameter);
1215 
1216  void toString(std::string& value);
1217 
1218 
1219  private:
1220  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
1221 
1222  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
1223 
1224  std::string getName() const {return this->name;};
1225 
1226  ParameterType getType() const {return this->parameterType;};
1227 
1228  int upperLimit;
1229 
1231 
1232  int value;
1233 
1234  std::string name;
1235 
1237 
1238 };
1243 friend class YouBotJoint;
1244  public:
1246 
1248 
1249  void getParameter(int& parameter) const;
1250 
1251  void setParameter(const int parameter);
1252 
1253  void toString(std::string& value);
1254 
1255 
1256  private:
1257  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
1258 
1259  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
1260 
1261  std::string getName() const {return this->name;};
1262 
1263  ParameterType getType() const {return this->parameterType;};
1264 
1265  int upperLimit;
1266 
1268 
1269  int value;
1270 
1271  std::string name;
1272 
1274 
1275 };
1280 friend class YouBotJoint;
1281  public:
1283 
1284  virtual ~PParameterCurrentControl();
1285 
1286  void getParameter(int& parameter) const;
1287 
1288  void setParameter(const int parameter);
1289 
1290  void toString(std::string& value);
1291 
1292 
1293  private:
1294  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
1295 
1296  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
1297 
1298  std::string getName() const {return this->name;};
1299 
1300  ParameterType getType() const {return this->parameterType;};
1301 
1302  int upperLimit;
1303 
1305 
1306  int value;
1307 
1308  std::string name;
1309 
1311 
1312 };
1317 friend class YouBotJoint;
1318  public:
1320 
1321  virtual ~IParameterCurrentControl();
1322 
1323  void getParameter(int& parameter) const;
1324 
1325  void setParameter(const int parameter);
1326 
1327  void toString(std::string& value);
1328 
1329 
1330  private:
1331  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
1332 
1333  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
1334 
1335  std::string getName() const {return this->name;};
1336 
1337  ParameterType getType() const {return this->parameterType;};
1338 
1339  int upperLimit;
1340 
1342 
1343  int value;
1344 
1345  std::string name;
1346 
1348 
1349 };
1354 friend class YouBotJoint;
1355  public:
1357 
1358  virtual ~DParameterCurrentControl();
1359 
1360  void getParameter(int& parameter) const;
1361 
1362  void setParameter(const int parameter);
1363 
1364  void toString(std::string& value);
1365 
1366 
1367  private:
1368  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
1369 
1370  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
1371 
1372  std::string getName() const {return this->name;};
1373 
1374  ParameterType getType() const {return this->parameterType;};
1375 
1376  int upperLimit;
1377 
1379 
1380  int value;
1381 
1382  std::string name;
1383 
1385 
1386 };
1391 friend class YouBotJoint;
1392  public:
1394 
1396 
1397  void getParameter(int& parameter) const;
1398 
1399  void setParameter(const int parameter);
1400 
1401  void toString(std::string& value);
1402 
1403 
1404  private:
1405  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
1406 
1407  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
1408 
1409  std::string getName() const {return this->name;};
1410 
1411  ParameterType getType() const {return this->parameterType;};
1412 
1413  int upperLimit;
1414 
1416 
1417  int value;
1418 
1419  std::string name;
1420 
1422 
1423 };
1428 friend class YouBotJoint;
1429  public:
1431 
1432  virtual ~MaximumVelocityToSetPosition();
1433 
1434  void getParameter(quantity<angular_velocity>& parameter) const;
1435 
1436  void setParameter(const quantity<angular_velocity>& parameter);
1437 
1438  void toString(std::string& value);
1439 
1440 
1441  private:
1442  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
1443 
1444  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
1445 
1446  std::string getName() const {return this->name;};
1447 
1448  ParameterType getType() const {return this->parameterType;};
1449 
1450  quantity<angular_velocity> upperLimit;
1451 
1452  quantity<angular_velocity> lowerLimit;
1453 
1454  quantity<angular_velocity> value;
1455 
1456  std::string name;
1457 
1459 
1460 };
1465 friend class YouBotJoint;
1466  public:
1468 
1469  virtual ~PositionTargetReachedDistance();
1470 
1471  void getParameter(int& parameter) const;
1472 
1473  void setParameter(const int parameter);
1474 
1475  void toString(std::string& value);
1476 
1477 
1478  private:
1479  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
1480 
1481  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
1482 
1483  std::string getName() const {return this->name;};
1484 
1485  ParameterType getType() const {return this->parameterType;};
1486 
1487  int upperLimit;
1488 
1490 
1491  int value;
1492 
1493  std::string name;
1494 
1496 
1497 };
1502 friend class YouBotJoint;
1503  public:
1505 
1506  virtual ~ClearI2tExceededFlag();
1507 
1508  void getParameter() const;
1509 
1510  void setParameter();
1511 
1512  void toString(std::string& value);
1513 
1514 
1515  private:
1516  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
1517 
1518  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
1519 
1520  std::string getName() const {return this->name;};
1521 
1522  ParameterType getType() const {return this->parameterType;};
1523 
1524  bool value;
1525 
1526  std::string name;
1527 
1529 
1530 };
1533 
1536 friend class YouBotJoint;
1537  public:
1539 
1541 
1542  bool getParameter() const;
1543 
1544  void setParameter();
1545 
1546  void toString(std::string& value);
1547 
1548 
1549  private:
1550  void getYouBotMailboxMsg(YouBotSlaveMailboxMsg& message, TMCLCommandNumber msgType, const YouBotJointStorage& storage) const;
1551 
1552  void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg& message, const YouBotJointStorage& storage);
1553 
1554  std::string getName() const {return this->name;};
1555 
1556  ParameterType getType() const {return this->parameterType;};
1557 
1558  bool value;
1559 
1560  std::string name;
1561 
1563 
1564 };
1569 friend class YouBotJoint;
1570  public:
1572 
1573  virtual ~PParameterTrajectoryControl();
1574 
1575  void getParameter(double& parameter) const;
1576 
1577  void setParameter(const double parameter);
1578 
1579  void toString(std::string& value);
1580 
1581 
1582  private:
1583  std::string getName() const {return this->name;};
1584 
1585  ParameterType getType() const {return this->parameterType;};
1586 
1587  double upperLimit;
1588 
1589  double lowerLimit;
1590 
1591  double value;
1592 
1593  std::string name;
1594 
1596 
1597 };
1602 friend class YouBotJoint;
1603  public:
1605 
1606  virtual ~IParameterTrajectoryControl();
1607 
1608  void getParameter(double& parameter) const;
1609 
1610  void setParameter(const double parameter);
1611 
1612  void toString(std::string& value);
1613 
1614 
1615  private:
1616  std::string getName() const {return this->name;};
1617 
1618  ParameterType getType() const {return this->parameterType;};
1619 
1620  double upperLimit;
1621 
1622  double lowerLimit;
1623 
1624  double value;
1625 
1626  std::string name;
1627 
1629 
1630 };
1635 friend class YouBotJoint;
1636  public:
1638 
1639  virtual ~DParameterTrajectoryControl();
1640 
1641  void getParameter(double& parameter) const;
1642 
1643  void setParameter(const double parameter);
1644 
1645  void toString(std::string& value);
1646 
1647 
1648  private:
1649  std::string getName() const {return this->name;};
1650 
1651  ParameterType getType() const {return this->parameterType;};
1652 
1653  double upperLimit;
1654 
1655  double lowerLimit;
1656 
1657  double value;
1658 
1659  std::string name;
1660 
1662 
1663 };
1668 friend class YouBotJoint;
1669  public:
1671 
1673 
1674  void getParameter(double& parameter) const;
1675 
1676  void setParameter(const double parameter);
1677 
1678  void toString(std::string& value);
1679 
1680 
1681  private:
1682  std::string getName() const {return this->name;};
1683 
1684  ParameterType getType() const {return this->parameterType;};
1685 
1686  double upperLimit;
1687 
1688  double lowerLimit;
1689 
1690  double value;
1691 
1692  std::string name;
1693 
1695 
1696 };
1697 
1698 } // namespace youbot
1699 #endif
I-Parameter of PID velocity regulator. This PID parameter set is used at lower velocity. (first velocity parameter set)
Adjusts the limit to switch between first velocity PID parameter set and second velocity PID paramete...
Acceleration parameter for velocity control and position control.
Adjust in standstill to lowest possible value at which the motor keeps its position. A too high value causes overshooting at positioning mode. (second position parameter set)
I-Parameter of PID current regulator.
the firmware version of the joint
void getYouBotMailboxMsg(YouBotSlaveMailboxMsg &message, TMCLCommandNumber msgType, const YouBotJointStorage &storage) const
void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg &message, const YouBotJointStorage &storage)
the resolution of the encoders, it is needed for the calculations of the youBot Driver ...
D-Parameter of PID velocity regulator (second position parameter set)
the resolution of the encoders, it is needed for the calculations of the youBot Driver ...
void getYouBotMailboxMsg(YouBotSlaveMailboxMsg &message, TMCLCommandNumber msgType, const YouBotJointStorage &storage) const
P-Parameter of PID velocity regulator. This PID parameter set is used at lower velocity. (first velocity parameter set)
I-Parameter of PID velocity regulator (second position parameter set)
virtual void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg &message, const YouBotJointStorage &storage)=0
Switching threshold for position control between the first and second set of parameters. If the velocity threshold is set to zero, the parameter set 2 is used all the time.
I-Parameter of PID position regulator (first position parameter set)
ParameterType getType() const
Maximum distance at which the position end flag is set.
virtual void toString(std::string &value)=0
joint position limits in encoder ticks
quantity< angular_acceleration > upperLimit
virtual void getYouBotMailboxMsg(YouBotSlaveMailboxMsg &message, TMCLCommandNumber msgType, const YouBotJointStorage &storage) const =0
abstract youBot API joint parameter
void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg &message, const YouBotJointStorage &storage)
joint position limits in radian
the name of the joint
Velocity to switch from controlled to hallFX mode. Set this value to a realistic velocity which the m...
Switches the ramp generator for speed and position control on and off.
quantity< angular_velocity > upperLimit
P-Parameter of PID position regulator (second position parameter set)
gives a limit for the I sum part of the trajectory regulator
Adjust in standstill to lowest possible value at which the motor keeps its position. A too high value causes overshooting at positioning mode. (first position parameter set)
D-Parameter of PID trajectory regulator.
I-Parameter of PID trajectory regulator.
Clear the flag that indicates a communication timeout between the EtherCAT master and the controller...
quantity< angular_velocity > upperLimit
void getYouBotMailboxMsg(YouBotSlaveMailboxMsg &message, TMCLCommandNumber msgType, const YouBotJointStorage &storage) const
D-Parameter of PID current regulator.
ParameterType getType() const
quantity< si::current > maxCurrent
P-Parameter of PID trajectory regulator.
void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg &message, const YouBotJointStorage &storage)
Clear the flag that indicates that the I2t sum has exceeded the I2t limit.
D-Parameter of PID position regulator (first position parameter set)
P-Parameter of PID velocity regulator (second position parameter set)
std::string getName() const
the gear ratio which is needed for the calculations in the youBot driver
std::string getName() const
void getYouBotMailboxMsg(YouBotSlaveMailboxMsg &message, TMCLCommandNumber msgType, const YouBotJointStorage &storage) const
void getYouBotMailboxMsg(YouBotSlaveMailboxMsg &message, TMCLCommandNumber msgType, const YouBotJointStorage &storage) const
EtherCAT mailbox message of the youBot slaves.
abstract youBot joint parameter
virtual std::string getName() const =0
std::string getName() const
virtual ParameterType getType() const =0
abstract joint parameter
quantity< plane_angle > lowerLimit
inverse the joint movement direction
D-Parameter of PID velocity regulator. This PID parameter set is used at lower velocity. (first velocity parameter set)
The maximum velocity used for move to position command when executing a ramp to a position...
quantity< angular_velocity > value
quantity< angular_velocity > lowerLimit
This PID parameter set is used at lower velocity. (first velocity parameter set)
I-Parameter of PID position regulator (second position parameter set)
std::string getName() const
quantity< angular_velocity > value
Maximum velocity at which end position can be set. Prevents issuing of end position when the target i...
void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg &message, const YouBotJointStorage &storage)
I-Clipping Parameter of PID current regulator.
P-Parameter of PID current regulator.
std::string getName() const
CalibrationDirection calibrationDirection
abstract youBot joint parameter which can be read only
std::string getName() const
quantity< angular_acceleration > lowerLimit
void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg &message, const YouBotJointStorage &storage)
quantity< angular_velocity > lowerLimit
void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg &message, const YouBotJointStorage &storage)
Stores YouBotJoint informations which are needed in the driver.
void getYouBotMailboxMsg(YouBotSlaveMailboxMsg &message, TMCLCommandNumber msgType, const YouBotJointStorage &storage) const
void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg &message, const YouBotJointStorage &storage)
std::string getName() const
void getYouBotMailboxMsg(YouBotSlaveMailboxMsg &message, TMCLCommandNumber msgType, const YouBotJointStorage &storage) const
I-Clipping Parameter of PID current regulator. This PID parameter set is used at lower velocity...
quantity< angular_acceleration > value
P-Parameter of PID position regulator (first position parameter set)
quantity< plane_angle > upperLimit
void getYouBotMailboxMsg(YouBotSlaveMailboxMsg &message, TMCLCommandNumber msgType, const YouBotJointStorage &storage) const
D-Parameter of PID position regulator (second position parameter set)
void setYouBotMailboxMsg(const YouBotSlaveMailboxMsg &message, const YouBotJointStorage &storage)


youbot_driver
Author(s): Jan Paulus
autogenerated on Mon Jun 10 2019 15:46:26