File size: 3,529 Bytes
bd5cb32
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
// -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab:

inline-header {
#include <cisstCommon/cmnJointType.h>
#include <sawControllers/sawControllersExport.h>
}

class {
    name mtsPIDAxisConfiguration;
    attribute CISST_EXPORT;
    member {
        name index;
        type size_t;
        visibility public;
        description Axis index, this needs to match the axis position in the configuration vector;
    }
    member {
        name name;
        type std::string;
        visibility public;
    }
    member {
        name type;
        type cmnJointType;
        visibility public;
        description 1 for prismatic or 2 for revolute;
    }
    member {
        name p_gain;
        type double;
        visibility public;
        description Gain applied to error in position;
    }
    member {
        name p_deadband;
        type double;
        default 0.0;
        visibility public;
        description Deadband around goal position;
    }
    member {
        name p_deadband_outer;
        type double;
        default 0.0;
        visibility public;
        description Outer edge of the soft position deadband.  A value less than or equal to p_deadband keeps the existing hard deadband behavior;
    }
    member {
        name d_gain;
        type double;
        visibility public;
        description Gain applied to error in velocity;
    }
    member {
        name i_gain;
        type double;
        visibility public;
        description Gain applied to error integral;
    }
    member {
        name i_forget_rate;
        type double;
        default 1.0;
        visibility public;
        description Error integral preserve rate per second (multiplied to i_error);
    }
    member {
        name i_limit;
        type double;
        default 0.0;
        visibility public;
        description Cap on error integral;
    }
    member {
        name offset;
        type double;
        default 0.0;
        visibility public;
        description constant effort offset applied to output;
    }
    member {
        name pid_max_output;
        type double;
        default 0.0;
        visibility public;
        description Maximum effort computed based on PID only (excludes user efforts);
    }
    member {
        name p_measured_setpoint_tolerance;
        type double;
        default 0.0;
        visibility public;
        description Maximum position error between setpoint and measured position;
    }
    member {
        name v_low_pass_cutoff;
        type double;
        default 1.0;
        visibility public;
        description Low pass filter applied to velocity;
    }
    member {
        name use_disturbance_observer;
        type bool;
        default false;
        visibility public;
    }
    member {
        name nominal_mass;
        type double;
        default 0.0;
        visibility public;
        description Nominal mass for disturbance observer;
    }
    member {
        name disturbance_cutoff;
        type double;
        default 0.0;
        visibility public;
        description Cutoff for disturbance observer;
    }
}

inline-header {
    typedef std::vector<mtsPIDAxisConfiguration> mtsPIDConfiguration;
    typedef mtsGenericObjectProxy<mtsPIDConfiguration> mtsPIDConfigurationProxy;
    CMN_DECLARE_SERVICES_INSTANTIATION(mtsPIDConfigurationProxy);
}

inline-code {
    CMN_IMPLEMENT_SERVICES_TEMPLATED(mtsPIDConfigurationProxy);
}