sawControllers / data /core /components /code /mtsPIDConfiguration.cdg
introvoyz045's picture
Migrated from GitHub
bd5cb32 verified
Raw History Blame Contribute Delete
3.53 kB
// -*- 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);
}