ObjComponent¶

This a python binding to the C++ class Mantid::Geometry::ObjComponent.

bases: mantid.geometry.IObjComponent, mantid.geometry.Component

class mantid.geometry.ObjComponent¶

__init__()¶

Raises an exception This class cannot be instantiated from Python

getBoolParameter((Component)arg1, (str)arg2[, (bool)arg3]) → std_vector_bool¶

getDescription((Component)arg1) → str :¶

Return the description of current parameterized component

getDistance((IComponent)arg1, (IComponent)arg2) → float :¶

Returns the distance, in metres, between this and the given component

getFullName((IComponent)arg1) → str :¶

Returns full path name of component

getIntParameter((Component)arg1, (str)arg2[, (bool)arg3]) → std_vector_int¶

getName((IComponent)arg1) → str :¶

Returns the name of the component

getNumberParameter((Component)arg1, (str)arg2[, (bool)arg3]) → std_vector_dbl¶

getParamDescription((Component)arg1, (str)arg2[, (bool)arg3]) → str¶

getParamShortDescription((Component)arg1, (str)arg2[, (bool)arg3]) → str¶

getParameterNames((Component)arg1[, (bool)arg2]) → std_set_str¶

getParameterType((Component)arg1, (str)arg2[, (bool)arg3]) → str¶

getPos((IComponent)arg1) → V3D :¶

Returns the absolute position of the component

getPositionParameter((Component)arg1, (str)arg2[, (bool)arg3]) → std_vector_v3d¶

getRelativePos((Component)arg1) → V3D¶

getRelativeRot((IComponent)arg1) → Quat :¶

Returns the relative rotation as a Quat

getRotation((Component)arg1) → Quat¶

getRotationParameter((Component)arg1, (str)arg2[, (bool)arg3]) → std_vector_quat¶

getShortDescription((Component)arg1) → str :¶

Return the short description of current parameterized component

getStringParameter((Component)arg1, (str)arg2[, (bool)arg3]) → std_vector_str¶

hasParameter((Component)arg1, (str)arg2[, (bool)arg3]) → bool¶

setDescription((Component)arg1, (str)arg2) → None :¶

Set component’s description, works only if the component is parameterized component

shape((IObjComponent)arg1) → Object :¶

Get the object that represents the physical shape of this component

type((IComponent)arg1) → str :¶

Returns the type of the component represented as a string