Float with Unit property This is a property for float with a predefined Unit associated . More...
#include <PropertyUnits.h>
Public Member Functions | |
| virtual const char * | getEditorName (void) const |
| Get the class name of the associated property editor item. More... | |
| virtual const boost::any | getPathValue (const App::ObjectIdentifier &path) const |
| Get value of property. More... | |
| virtual PyObject * | getPyObject (void) |
| This method returns the Python wrapper for a C++ object. More... | |
| Base::Quantity | getQuantityValue (void) const |
| const Base::Unit & | getUnit (void) const |
| double | getValue (void) const |
| PropertyQuantity (void) | |
| virtual void | setPathValue (const App::ObjectIdentifier &path, const boost::any &value) |
| Set value of property. More... | |
| virtual void | setPyObject (PyObject *) |
| void | setUnit (const Base::Unit &u) |
| void | setValue (double lValue) |
| virtual | ~PropertyQuantity () |
 Public Member Functions inherited from App::PropertyFloat | |
| virtual Property * | Copy (void) const |
| Returns a new copy of the property (mainly for Undo/Redo and transactions) More... | |
| virtual unsigned int | getMemSize (void) const |
| This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? This method is defined in Base::Persistence. More... | |
| double | getValue (void) const |
| virtual void | Paste (const Property &from) |
| Paste the value from the property (mainly for Undo/Redo and transactions) More... | |
| PropertyFloat (void) | |
| Value Constructor Construct with explicit Values. More... | |
| virtual void | Restore (Base::XMLReader &reader) |
| This method is used to restore properties from an XML document. More... | |
| virtual void | Save (Base::Writer &writer) const |
| This method is used to save properties to an XML document. More... | |
| void | setValue (double lValue) |
| virtual | ~PropertyFloat () |
| A destructor. More... | |
| Public Member Functions inherited from App::Property | |
| virtual void | aboutToSetChildValue (Property &) |
| Called before a child property changing value. More... | |
| virtual void | afterRestore () |
| Called at the beginning of Document::afterRestore() More... | |
| virtual App::ObjectIdentifier | canonicalPath (const App::ObjectIdentifier &p) const |
| Convert p to a canonical representation of it. More... | |
| PropertyContainer * | getContainer (void) const |
| Get a pointer to the PropertyContainer derived class the property belongs to. More... | |
| const char * | getDocumentation (void) const |
| Get the documentation of this property. More... | |
| std::string | getFullName () const |
| const char * | getGroup (void) const |
| Get the group of this property. More... | |
| const char * | getName (void) const |
| get the name of this property in the belonging container More... | |
| virtual void | getPaths (std::vector< App::ObjectIdentifier > &paths) const |
| Get valid paths for this property; used by auto completer. More... | |
| virtual bool | getPyPathValue (const App::ObjectIdentifier &, Py::Object &) const |
| Get Python value of property. More... | |
| unsigned long | getStatus () const |
| return the status bits More... | |
| short | getType (void) const |
| Get the type of the property in the container. More... | |
| virtual void | hasSetChildValue (Property &) |
| Called when a child property has changed value. More... | |
| bool | isReadOnly () const |
| bool | isSinglePrecision () const |
| Gets precision of properties using floating point numbers. More... | |
| bool | isTouched (void) const |
| Test if this property is touched. More... | |
| virtual void | onContainerRestored () |
| Called before calling DocumentObject::onDocumentRestored() More... | |
| Property () | |
| void | purgeTouched (void) |
| Reset this property touched. More... | |
| void | setContainer (PropertyContainer *Father) |
| Is called by the framework to set the father (container) More... | |
| void | setReadOnly (bool readOnly) |
| Sets property editable/grayed out in property editor. More... | |
| void | setSinglePrecision (bool single) |
| Sets precision of properties using floating point numbers to single, the default is double. More... | |
| void | setStatus (Status pos, bool on) |
| void | setStatusValue (unsigned long status) |
| bool | testStatus (Status pos) const |
| void | touch () |
| Property status handling. More... | |
| virtual | ~Property () |
| Public Member Functions inherited from Base::Persistence | |
| void | dumpToStream (std::ostream &stream, int compression) |
| virtual Base::Type | getTypeId (void) const |
| virtual void | RestoreDocFile (Reader &) |
| This method is used to restore large amounts of data from a file In this method you simply stream in your SaveDocFile() saved data. More... | |
| void | restoreFromStream (std::istream &stream) |
| virtual void | SaveDocFile (Writer &) const |
| This method is used to save large amounts of data to a binary file. More... | |
| Public Member Functions inherited from Base::BaseClass | |
| BaseClass () | |
| Construction. More... | |
| bool | isDerivedFrom (const Type type) const |
| virtual | ~BaseClass () |
| Destruction. More... | |
Protected Member Functions | |
| Base::Quantity | createQuantityFromPy (PyObject *value) |
| Protected Member Functions inherited from App::Property | |
| virtual void | aboutToSetValue (void) |
| Gets called by all setValue() methods before the value has changed. More... | |
| virtual void | hasSetValue (void) |
| Gets called by all setValue() methods after the value has changed. More... | |
| virtual void | verifyPath (const App::ObjectIdentifier &p) const |
| Verify a path for the current property. More... | |
Additional Inherited Members | |
| Public Types inherited from App::Property | |
| enum | Status { Touched = 0, Immutable = 1, ReadOnly = 2, Hidden = 3, Transient = 4, MaterialEdit = 5, NoMaterialListEdit = 6, Output = 7, LockDynamic = 8, NoModify = 9, PartialTrigger = 10, NoRecompute = 11, Single = 12, Ordered = 13, EvalOnRestore = 14, PropStaticBegin = 21, PropDynamic = 21, PropNoPersist = 22, PropNoRecompute = 23, PropReadOnly = 24, PropTransient = 25, PropHidden = 26, PropOutput = 27, PropStaticEnd = 28, User1 = 28, User2 = 29, User3 = 30, User4 = 31 } |
| Static Public Member Functions inherited from App::Property | |
| static void | destroy (Property *p) |
| For safe deleting of a dynamic property. More... | |
| Static Public Member Functions inherited from Base::Persistence | |
| static void * | create (void) |
| static std::string | encodeAttribute (const std::string &) |
| Encodes an attribute upon saving. More... | |
| static Base::Type | getClassTypeId (void) |
| static void | init (void) |
| Static Public Member Functions inherited from Base::BaseClass | |
| static void * | create (void) |
| static Type | getClassTypeId (void) |
| static void | init (void) |
| Static Protected Member Functions inherited from Base::BaseClass | |
| static void | initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=nullptr) |
| Protected Attributes inherited from App::Property | |
| std::bitset< 32 > | StatusBits |
| Status bits of the property The first 8 bits are used for the base system the rest can be used in descendent classes to mark special statuses on the objects. More... | |
Detailed Description
Float with Unit property This is a property for float with a predefined Unit associated .
Constructor & Destructor Documentation
◆ PropertyQuantity()
| App::PropertyQuantity::PropertyQuantity | ( | void | ) |
◆ ~PropertyQuantity()
|
virtual |
Member Function Documentation
◆ createQuantityFromPy()
|
protected |
◆ getEditorName()
|
virtual |
Get the class name of the associated property editor item.
Reimplemented from App::PropertyFloat.
Reimplemented in App::PropertyAngle, and App::PropertyQuantityConstraint.
◆ getPathValue()
|
virtual |
Get value of property.
Reimplemented from App::PropertyFloat.
◆ getPyObject()
|
virtual |
This method returns the Python wrapper for a C++ object.
It's in the responsibility of the programmer to do the correct reference counting. Basically there are two ways how to implement that: Either always return a new Python object then reference counting is not a matter or return always the same Python object then the reference counter must be incremented by one. However, it's absolutely forbidden to return always the same Python object without incrementing the reference counter.
The default implementation returns 'None'.
Reimplemented from App::PropertyFloat.
◆ getQuantityValue()
| Base::Quantity PropertyQuantity::getQuantityValue | ( | void | ) | const |
◆ getUnit()
| const Base::Unit& App::PropertyQuantity::getUnit | ( | void | ) | const |
Referenced by SpreadsheetGui::SheetModel::data(), and Spreadsheet::Cell::getFormattedQuantity().
◆ getValue()
| double App::PropertyQuantity::getValue | ( | void | ) | const |
References App::PropertyFloat::getValue().
Referenced by Gui::InputField::bind(), TechDraw::DrawViewPart::buildGeometryObject(), TechDraw::DrawProjGroup::calculateAutomaticScale(), PartDesignGui::TaskHoleParameters::changedObject(), Part::Extrusion::computeFinalParameters(), Gui::PointMarker::customEvent(), SpreadsheetGui::SheetModel::data(), TechDrawGui::QGILeaderLine::draw(), TechDrawGui::QGIViewBalloon::draw(), TechDrawGui::QGIViewClip::drawClip(), TechDrawGui::QGIViewPart::drawHighlight(), TechDrawGui::QGIViewPart::drawPainterPath(), TechDrawGui::QGIViewSection::drawSectionFace(), TechDrawGui::QGIViewPart::drawSectionLine(), TechDrawGui::QGIViewPart::drawViewPart(), PartDesign::Hole::execute(), Part::Circle::execute(), PartDesign::Fillet::execute(), Part::Box::execute(), Part::Vertex::execute(), PartDesign::Chamfer::execute(), PartDesign::Thickness::execute(), PartDesign::Pocket::execute(), PartDesign::Revolution::execute(), PartDesign::Groove::execute(), PartDesign::Pad::execute(), PartDesign::Box::execute(), Part::Line::execute(), Part::Plane::execute(), PartDesign::Cylinder::execute(), Part::Thickness::execute(), Part::Sphere::execute(), PartDesign::Sphere::execute(), Part::Ellipsoid::execute(), Part::Cylinder::execute(), PartDesign::Cone::execute(), Part::Prism::execute(), Part::RegularPolygon::execute(), PartDesign::Ellipsoid::execute(), Part::Cone::execute(), PartDesign::Torus::execute(), Part::Torus::execute(), Part::Helix::execute(), PartDesign::Prism::execute(), Part::Spiral::execute(), PartDesign::Wedge::execute(), Part::Wedge::execute(), Part::Ellipse::execute(), TechDrawGui::TaskDetail::getAnchorScene(), TechDrawGui::QGILeaderLine::getAttachFromFeature(), TechDraw::DrawLeaderLine::getAttachPoint(), TechDraw::DrawProjGroup::getBoundingBox(), TechDrawGui::TaskCenterLine::getCenterWidth(), TechDraw::DrawViewBalloon::getOriginOffset(), TechDraw::DrawProjGroup::getRect(), PartDesign::LinearPattern::getTransformations(), PartDesign::PolarPattern::getTransformations(), TechDraw::DrawProjGroup::getXYPosition(), TechDraw::DrawViewBalloon::handleChangedPropertyType(), TechDraw::DrawView::handleChangedPropertyType(), PartGui::ViewProviderPartExt::loadParameter(), TechDraw::DrawViewPart::makeGeometryForShape(), TechDrawGui::QGVPage::mouseReleaseEvent(), Gui::ViewProviderAnnotation::onChanged(), TechDraw::DrawProjGroup::onChanged(), TechDrawGui::TaskDetail::onHighlightMoved(), TechDrawGui::TaskCosVertex::onTrackerFinished(), PartDesignGui::ViewProviderTransformed::recomputeFeature(), Part::Box::Restore(), TechDrawGui::QGIViewAnnotation::rotateView(), TechDrawGui::QGIViewImage::rotateView(), TechDrawGui::QGIViewSymbol::rotateView(), TechDrawGui::QGIView::rotateView(), TechDrawGui::TaskLeaderLine::saveState(), PartDesignGui::ViewProviderDatumLine::setExtents(), PartDesignGui::ViewProviderDatumPlane::setExtents(), TechDrawGui::QGILeaderLine::setLeaderFeature(), TechDrawGui::TaskRichAnno::setUiEdit(), TechDrawGui::TaskLeaderLine::setUiEdit(), TechDrawGui::QGIViewBalloon::setViewPartFeature(), TechDrawGui::TaskBalloon::TaskBalloon(), PartDesignGui::TaskBoxPrimitives::TaskBoxPrimitives(), PartDesignGui::TaskDraftParameters::TaskDraftParameters(), PartDesignGui::TaskFilletParameters::TaskFilletParameters(), TechDrawGui::TaskLeaderLine::TaskLeaderLine(), PartDesignGui::TaskRevolutionParameters::TaskRevolutionParameters(), TechDrawGui::TaskRichAnno::TaskRichAnno(), SketcherGui::TaskSketcherGeneral::TaskSketcherGeneral(), PartDesignGui::TaskThicknessParameters::TaskThicknessParameters(), RobotGui::TaskTrajectoryDressUpParameter::TaskTrajectoryDressUpParameter(), PartGui::ThicknessWidget::ThicknessWidget(), PartDesignGui::ViewProviderAddSub::updateAddSubShapeIndicator(), PartDesignGui::ViewProviderDatumLine::updateData(), ImageGui::ViewProviderImagePlane::updateData(), PartDesignGui::ViewProviderDatumPlane::updateData(), TechDrawGui::QGIView::updateView(), and PartGui::ViewProviderPartExt::updateVisual().
◆ setPathValue()
|
virtual |
◆ setPyObject()
|
virtual |
Reimplemented from App::PropertyFloat.
Reimplemented in App::PropertyQuantityConstraint.
References Base::Quantity::getUnit(), Base::UnitPy::getUnitPtr(), Base::Quantity::getValue(), and App::PropertyFloat::setValue().
◆ setUnit()
| void App::PropertyQuantity::setUnit | ( | const Base::Unit & | u | ) |
◆ setValue()
| void App::PropertyQuantity::setValue | ( | double | lValue | ) |
References App::PropertyFloat::setValue().
Referenced by TechDrawGui::TaskBalloon::accept(), TechDraw::DrawProjGroupItem::autoPosition(), TechDrawGui::TaskRichAnno::createAnnoFeature(), App::MeasureDistance::execute(), TechDraw::DrawViewBalloon::handleChangedPropertyType(), TechDraw::DrawView::handleChangedPropertyType(), Part::Thickness::handleChangedPropertyType(), TechDraw::DrawProjGroup::handleChangedPropertyType(), PartGui::ViewProviderPartExt::loadParameter(), TechDrawGui::QGVPage::mouseReleaseEvent(), PartDesignGui::TaskBoxPrimitives::onBoxHeightChanged(), PartDesignGui::TaskBoxPrimitives::onBoxLengthChanged(), PartDesignGui::TaskBoxPrimitives::onBoxWidthChanged(), PartDesign::Hole::onChanged(), TechDraw::DrawProjGroup::onChanged(), PartDesignGui::TaskBoxPrimitives::onConeAngleChanged(), PartDesignGui::TaskBoxPrimitives::onConeHeightChanged(), PartDesignGui::TaskBoxPrimitives::onConeRadius1Changed(), PartDesignGui::TaskBoxPrimitives::onConeRadius2Changed(), PartDesignGui::TaskBoxPrimitives::onCylinderAngleChanged(), PartDesignGui::TaskBoxPrimitives::onCylinderHeightChanged(), PartDesignGui::TaskBoxPrimitives::onCylinderRadiusChanged(), PartDesignGui::TaskBoxPrimitives::onEllipsoidAngle1Changed(), PartDesignGui::TaskBoxPrimitives::onEllipsoidAngle2Changed(), PartDesignGui::TaskBoxPrimitives::onEllipsoidAngle3Changed(), PartDesignGui::TaskBoxPrimitives::onEllipsoidRadius1Changed(), PartDesignGui::TaskBoxPrimitives::onEllipsoidRadius2Changed(), PartDesignGui::TaskBoxPrimitives::onEllipsoidRadius3Changed(), PartDesignGui::TaskBoxPrimitives::onPrismCircumradiusChanged(), PartDesignGui::TaskBoxPrimitives::onPrismHeightChanged(), SketcherGui::TaskSketcherGeneral::onSetGridSize(), PartDesignGui::TaskBoxPrimitives::onSphereAngle1Changed(), PartDesignGui::TaskBoxPrimitives::onSphereAngle2Changed(), PartDesignGui::TaskBoxPrimitives::onSphereAngle3Changed(), PartDesignGui::TaskBoxPrimitives::onSphereRadiusChanged(), PartDesignGui::TaskBoxPrimitives::onTorusAngle1Changed(), PartDesignGui::TaskBoxPrimitives::onTorusAngle2Changed(), PartDesignGui::TaskBoxPrimitives::onTorusAngle3Changed(), PartDesignGui::TaskBoxPrimitives::onTorusRadius1Changed(), PartDesignGui::TaskBoxPrimitives::onTorusRadius2Changed(), PartDesignGui::TaskBoxPrimitives::onWedgeX2maxChanged(), PartDesignGui::TaskBoxPrimitives::onWedgeX2minChanged(), PartDesignGui::TaskBoxPrimitives::onWedgeXmaxChanged(), PartDesignGui::TaskBoxPrimitives::onWedgeXminChanged(), PartDesignGui::TaskBoxPrimitives::onWedgeYmaxChanged(), PartDesignGui::TaskBoxPrimitives::onWedgeYminChanged(), PartDesignGui::TaskBoxPrimitives::onWedgeZ2maxChanged(), PartDesignGui::TaskBoxPrimitives::onWedgeZ2minChanged(), PartDesignGui::TaskBoxPrimitives::onWedgeZmaxChanged(), PartDesignGui::TaskBoxPrimitives::onWedgeZminChanged(), Part::Box::Restore(), TechDrawGui::TaskLeaderLine::restoreState(), PartDesignGui::ViewProviderDatumPlane::setExtents(), TechDraw::DrawViewBalloon::setOrigin(), TechDraw::DrawView::setPosition(), Spreadsheet::Sheet::setQuantityProperty(), TechDrawGui::TaskRichAnno::updateAnnoFeature(), TechDrawGui::TaskLeaderLine::updateLeaderFeature(), and RobotGui::TaskTrajectoryDressUpParameter::writeValues().
The documentation for this class was generated from the following files:
- src/App/PropertyUnits.h
- src/App/PropertyUnits.cpp
