Inherits from
- HasPrivateTraits: enthought.traits.has_traits.HasPrivateTraits
Attributes
- data
A scalar value array of values.
data = Any
- family_name
Family to use for unit system conversion.
family_name = FamilyNameTrait
- name
The displayable name of the quantity (e.g., used as label on plots).
name = Str
- units
A units object that defines the type of units for values in data.
units = Any
Inherited from base classes
Method summary
- __init__(self, data, units = None, name = '', **traits)
- __repr__(self)
- change_unit_system(self, new_unit_system = None, **kw)
- clone(self)
- edit_traits(self, view = None, context = None, naming_context = None, **args)
- get_original(self)
- get_unit_converter(self)
- invert(self, unit_system = None)
- propagate_data_changes(self)
- trait_view(self, name = None, view_element = None)
Inherited from base classes
- __deepcopy__(self, memo)
- __getstate__(self)
- __prefix_trait__(self, name, is_set)
- __reduce_ex__(self, protocol)
- __setstate__(self, state, trait_change_notify = True)
- add_class_trait(cls, name, *trait)
- add_trait(self, name, *trait)
- add_trait_category(cls, category)
- add_trait_listener(self, object, prefix = '')
- all_trait_names(self)
- base_trait(self, name)
- class_default_traits_view(cls)
- class_editable_traits(cls)
- class_trait_names(cls, **metadata)
- class_trait_view(cls, name = None, view_element = None)
- class_trait_view_elements(cls)
- class_traits(cls, **metadata)
- clone_traits(self, traits = None, memo = None, copy = None, **metadata)
- configure_traits(self, filename = None, view = None, kind = None, edit = True, context = None, handler = None, id = '', scrollable = None, **args)
- copy_traits(self, other, traits = None, memo = None, copy = None, **metadata)
- copyable_trait_names(self, **metadata)
- default_traits_view(self)
- editable_traits(self)
- has_traits_interface(self, *interfaces)
- on_trait_change(self, handler, name = None, remove = False, dispatch = 'same', priority = False, deferred = False)
- print_traits(self, show_help = False, **metadata)
- remove_trait(self, name)
- remove_trait_listener(self, object, prefix = '')
- reset_traits(self, traits = None, **metadata)
- set_trait_dispatch_handler(cls, name, klass, override = False)
- sync_trait(self, trait_name, object, alias = None, mutual = True, remove = False)
- trait(self, name, force = False, copy = False)
- trait_context(self)
- trait_get(self, *names, **metadata)
- trait_monitor(cls, handler, remove = False)
- trait_names(self, **metadata)
- trait_set(self, trait_change_notify = True, **traits)
- trait_setq(self, **traits)
- trait_subclasses(cls, all = False)
- trait_view_elements(self)
- trait_views(self, klass = None)
- traits(self, **metadata)
- validate_trait(self, name, value)
Methods
- __init__(self, data, units = None, name = '', **traits)
Constructor.
- __repr__(self)
Return the string representation of this quantity.
- change_unit_system(self, new_unit_system = None, **kw)
Convenience method for changing a quantity's units according to a given unit system. This just calls the unit_manager's method to do this. Keyword args are passed on to the converter.
- clone(self)
Returns a clone of the object.
- edit_traits(self, view = None, context = None, naming_context = None, **args)
Displays a user interface window for editing trait attribute values.
- naming_context - context in which the quantity is bound. Editor will
- use this to ensure name uniqueness.
- get_original(self)
Returns the original quantity in the conversion stack.
- get_unit_converter(self)
Convenience function to lookup converter
- invert(self, unit_system = None)
Inverts quantity to units, family and name listed by unit manager as the quantity inverse.
- propagate_data_changes(self)
Propagate data changes up the conversion stack.
Unit conversions create a stack of quantities in different unit systems, represented by the _converted_from trait. This method propagates changes to the data trait back up that conversion stack by converting the units from the current quantity to the units of the predecessor quantity and replacing the data trait. Propagation continues until an original quantity is encountered.
In theory, this method could raise an exception if the units cannot be converted back. This would imply the unit_family has been changed back to None.
- trait_view(self, name = None, view_element = None)
Return view object for self.