\(\renewcommand\AA{\unicode{x212B}}\)
This is a Python binding to the C++ class Mantid::Geometry::Component.
bases: mantid.geometry.IComponent
mantid.geometry.Component¶getBoolParameter((Component)self, (str)pname[, (bool)recursive=True]) → std_vector_bool¶getDescription((Component)self) → str :¶Return the description of current parameterized component
getDistance((IComponent)self, (IComponent)other) → float :¶Returns the distance, in metres, between this and the given component
getFullName((IComponent)self) → str :¶Returns full path name of component
getIntParameter((Component)self, (str)pname[, (bool)recursive=True]) → std_vector_int¶getName((IComponent)self) → str :¶Returns the name of the component
getNumberParameter((Component)self, (str)pname[, (bool)recursive=True]) → std_vector_dbl¶getParamDescription((Component)self, (str)pname[, (bool)recursive=True]) → str¶getParamShortDescription((Component)self, (str)pname[, (bool)recursive=True]) → str¶getParameterNames((Component)self[, (bool)recursive=True]) → std_set_str¶getParameterType((Component)self, (str)pname[, (bool)recursive=True]) → str¶getPos((IComponent)self) → V3D :¶Returns the absolute position of the component
getPositionParameter((Component)self, (str)pname[, (bool)recursive=True]) → std_vector_v3d¶getRelativePos((Component)self) → V3D¶getRelativeRot((IComponent)self) → Quat :¶Returns the relative rotation as a Quat
getRotation((Component)self) → Quat¶getRotationParameter((Component)self, (str)pname[, (bool)recursive=True]) → std_vector_quat¶getShortDescription((Component)self) → str :¶Return the short description of current parameterized component
getStringParameter((Component)self, (str)pname[, (bool)recursive=True]) → std_vector_str¶hasParameter((Component)self, (str)name[, (bool)recursive=True]) → bool¶setDescription((Component)self, (str)descr) → None :¶Set component’s description, works only if the component is parameterized component
type((IComponent)self) → str :¶Returns the type of the component represented as a string