Label¶

This is a Python binding to the C++ class Mantid::Kernel::Label.

bases: mantid.kernel.Unit

class mantid.kernel.Label¶

caption((Unit)self) → str :¶

Return the full name of the unit

label((Unit)self) → str :¶

Returns a plain-text label to be used as the symbol for the unit (deprecated, use symbol())

name((Unit)self) → str :¶

Return the full name of the unit (deprecated, use caption)

quickConversion((Unit)self, (Unit)destUnitName) → tuple :¶

Check whether the unit can be converted to another via a simple factor

quickConversion( (Unit)self, (str)destination) -> tuple :

Check whether the unit can be converted to another via a simple factor

setLabel((Label)self, (str)caption, (str)label) → None :¶

Set the caption (e.g.Temperature) & label (K) on the unit

setLabel( (Label)self, (str)caption, (UnitLabel)label) -> None :

Set the caption (e.g.Temperature) & label (K) on the unit, See the UnitLabel class

symbol((Unit)self) → UnitLabel :¶

Returns a UnitLabel object that holds information on the symbol to use for unit

unitID((Unit)self) → str :¶

Returns the string ID of the unit. This may/may not match its name