Property: Difference between revisions

From LabRPS Documentation
Jump to navigation Jump to search
(Created page with "== Introduction == A property is a piece of information like a number or a text string that is attached to a LabRPS document or an object in a document. Public properties can be viewed and modified in the Property editor. Properties play a very important role in LabRPS. As objects in LabRPS are "parametric", this means that their behavior is defined by their properties, and how these properties are used as input for their class methods...")
 
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 28: Line 28:
|-
|-
| ColorList ||
| ColorList ||
|-
| CurrentDensity || style="text-align:center;" | A/m^2 || {{Version|0.21}}
|-
|-
| Density || style="text-align:center;" | kg/m^3
| Density || style="text-align:center;" | kg/m^3
|-
|-
| Direction ||
|-
| DissipationRate || style="text-align:center;" | m^2/s^3 || {{Version|0.21}}
|-
|-
| Distance || style="text-align:center;" | m
| Distance || style="text-align:center;" | m
|-
| DynamicViscosity || style="text-align:center;" | Pa*s || {{Version|0.21}}
|-
| ElectricalCapacitance || style="text-align:center;" | F || {{Version|0.21}}
|-
| ElectricalConductance || style="text-align:center;" | S || {{Version|0.21}}
|-
| ElectricalConductivity || style="text-align:center;" | S/m || {{Version|0.21}}
|-
| ElectricalInductance|| style="text-align:center;" | H || {{Version|0.21}}
|-
| ElectricalResistance || style="text-align:center;" | Ohm || {{Version|0.21}}
|-
| ElectricCharge || style="text-align:center;" | C || {{Version|0.21}}
|-
| ElectricCurrent || style="text-align:center;" | A || {{Version|0.21}}
|-
| ElectricPotential || style="text-align:center;" | V || {{Version|0.20}}
|-
|-
| Enumeration ||
| Enumeration ||
Line 76: Line 53:
|-
|-
| Frequency || style="text-align:center;" | Hz
| Frequency || style="text-align:center;" | Hz
|-
| HeatFlux || style="text-align:center;" | W/m^2|| {{Version|0.21}}
|-
|-
| Integer ||
| Integer ||
Line 86: Line 61:
|-
|-
| IntegerSet ||
| IntegerSet ||
|-
| InverseArea || style="text-align:center;" | 1/m^2 || {{Version|0.21}}
|-
| InverseLength || style="text-align:center;" | 1/m || {{Version|0.21}}
|-
| InverseVolume || style="text-align:center;" | 1/m^3 || {{Version|0.21}}
|-
| KinematicViscosity || style="text-align:center;" | m^2/s || {{Version|0.21}}
|-
|-
| Length || style="text-align:center;" | m
| Length || style="text-align:center;" | m
Line 128: Line 95:
|-
|-
| LinkSubListHidden ||
| LinkSubListHidden ||
|-
| LuminousIntensity || style="text-align:center;" | cd || {{Version|0.21}}
|-
| MagneticFieldStrength || style="text-align:center;" | A/m  || {{Version|0.21}}
|-
| MagneticFlux || style="text-align:center;" | Wb or V*s || {{Version|0.21}}
|-
| MagneticFluxDensity || style="text-align:center;" | T  || {{Version|0.21}}
|-
| Magnetization || style="text-align:center;" | A/m || {{Version|0.21}}
|-
|-
| Map ||
| Map ||
|-
| Mass || style="text-align:center;" | kg || {{Version|0.21}}
|-
|-
| Material ||
| Material ||
Line 164: Line 119:
|-
|-
| Position ||
| Position ||
|-
| Power || style="text-align:center;" | W || {{Version|0.21}}
|-
|-
| Precision ||
| Precision ||
Line 178: Line 131:
|-
|-
| Rotation ||
| Rotation ||
|-
| ShearModulus || style="text-align:center;" | Pa || {{Version|0.21}}
|-
| SpecificEnergy || style="text-align:center;" | m^2/s^2 or J/kg || {{Version|0.21}}
|-
| SpecificHeat || style="text-align:center;" | J/kg/K || {{Version|0.21}}
|-
|-
| Speed || style="text-align:center;" | m/s
| Speed || style="text-align:center;" | m/s
|-
|-
| Stiffness || style="text-align:center;" | m/s^2
| Stiffness || style="text-align:center;" | m/s^2
|-
| Stress || style="text-align:center;" | Pa || {{Version|0.21}}
|-
|-
| String ||
| String ||
|-
|-
| StringList ||
| StringList ||
|-
| Temperature || style="text-align:center;" | K || {{Version|0.21}}
|-
| ThermalConductivity || style="text-align:center;" | W/m/K || {{Version|0.21}}
|-
| ThermalExpansionCoefficient || style="text-align:center;" | 1/K || {{Version|0.21}}
|-
| ThermalTransferCoefficient || style="text-align:center;" | W/m^2/K || {{Version|0.21}}
|-
| Time || style="text-align:center;" | s || {{Version|0.21}}
|-
| UltimateTensileStrength || style="text-align:center;" | Pa || {{Version|0.21}}
|-
|-
| UUID ||
| UUID ||
Line 216: Line 149:
|-
|-
| VectorList ||
| VectorList ||
|-
| Velocity || style="text-align:center;" | m/s || {{Version|0.21}}
|-
|-
| Volume || style="text-align:center;" | l or m^3
| Volume || style="text-align:center;" | l or m^3
|-
| VolumeFlowRate || style="text-align:center;" | l/s or m^3/s || {{Version|0.21}}
|-
| VolumetricThermalExpansionCoefficient || style="text-align:center;" | 1/K || {{Version|0.21}}
|-
| Work || style="text-align:center;" | J || {{Version|0.21}}
|-
|-
| XLink ||
| XLink ||
Line 233: Line 158:
| XLinkSub ||
| XLinkSub ||
|-
|-
| XLinkSubList ||
| XLinkSubList
|-
| YieldStrength || style="text-align:center;" | Pa || {{Version|0.21}}
|-
| YoungsModulus || style="text-align:center;" | Pa || {{Version|0.21}}
|}
|}


Line 266: Line 187:
A [[Scripted_objects|scripted object]] is created first, and then properties are assigned.
A [[Scripted_objects|scripted object]] is created first, and then properties are assigned.
{{Code|code=
{{Code|code=
obj = App.ActiveDocument.addObject("Part::Feature", "CustomObject")
obj = App.ActiveDocument.addObject("WindLab::WindLabSimulation", "MyKaimalAlongWindSpectrum")


obj.addProperty("App::PropertyFloat", "Velocity", "Parameter", "Body speed")
obj.addProperty("App::PropertyFloat", "Velocity", "Parameter", "Mean speed value")
obj.addProperty("App::PropertyBool", "VelocityEnabled", "Parameter", "Enable body speed")
obj.addProperty("App::PropertyBool", "Stationary", "Parameter", "Set stationarity")
}}
}}


Line 288: Line 209:
In the source code, properties are located in various {{FileName|src/App/Property*}} files.
In the source code, properties are located in various {{FileName|src/App/Property*}} files.


They are imported and initialized in {{incode|[https://github.com/LabRPS/LabRPS/blob/9c27f1078e5ec516fe882aac1a27f5c6c6174554/src/App/Application.cpp#L1681-L1758 src/App/Application.cpp]}}.
They are imported and initialized in {{incode|[https://github.dev/LabRPS/LabRPS/blob/master/src/App/Application.cpp src/App/Application.cpp]}}.


{{Code|lang=cpp|code=
{{Code|lang=cpp|code=

Latest revision as of 10:48, 21 June 2024

Introduction

A property is a piece of information like a number or a text string that is attached to a LabRPS document or an object in a document. Public properties can be viewed and modified in the Property editor.

Properties play a very important role in LabRPS. As objects in LabRPS are "parametric", this means that their behavior is defined by their properties, and how these properties are used as input for their class methods. See also FeaturePython Custom Properties and PropertyLink: InList and OutList

All property types

Custom scripted objects can use any of the property types defined in the base system:

Name Unit (if any) Remark
Acceleration m/s^2
AmountOfSubstance mol
Angle °
Area m^2
Bool
BoolList
Color
ColorList
Density kg/m^3
Distance m
Enumeration
ExpressionEngine
File
FileIncluded
Float
FloatConstraint
FloatList
Font
Force N
Frequency Hz
Integer
IntegerConstraint
IntegerList
IntegerSet
Length m
Link
LinkChild
LinkGlobal
LinkHidden
LinkList
LinkListChild
LinkListGlobal
LinkListHidden
LinkSub
LinkSubChild
LinkSubGlobal
LinkSubHidden
LinkSubList
LinkSubListChild
LinkSubListGlobal
LinkSubListHidden
Map
Material
MaterialList
Matrix
PartShape a Part property, is accessed as
Part::PropertyPartShape
Path
Percent
PersistentObject
Placement
PlacementLink
PlacementList
Position
Precision
Pressure Pa
PythonObject
Quantity
QuantityConstraint
Rotation
Speed m/s
Stiffness m/s^2
String
StringList
UUID
VacuumPermittivity s^4*A^2 / (m^3*kg)
Vector
VectorDistance
VectorList
Volume l or m^3
XLink
XLinkList
XLinkSub
XLinkSubList

Internally, the property name is prefixed with App::Property: 

App::PropertyBool
App::PropertyFloat
App::PropertyFloatList
...

Remember that these are property types. A single object may have many properties of the same type, but with different names.

For example: 

obj.addProperty("App::PropertyFloat", "Length")
obj.addProperty("App::PropertyFloat", "Width")
obj.addProperty("App::PropertyFloat", "Height")

This indicates an object with three properties of type "Float", named "Length", "Width", and "Height", respectively.

Scripting

See also: LabRPS scripting basics

A scripted object is created first, and then properties are assigned. 

obj = App.ActiveDocument.addObject("WindLab::WindLabSimulation", "MyKaimalAlongWindSpectrum")

obj.addProperty("App::PropertyFloat", "Velocity", "Parameter", "Mean speed value")
obj.addProperty("App::PropertyBool", "Stationary", "Parameter", "Set stationarity")

In general, Data properties are assigned by using the object's addProperty() method. On the other hand, View properties are normally provided automatically by the parent object from which the scripted object is derived.

For example:

  • Deriving from App::FeaturePython provides only 4 View properties: "Display Mode", "On Top When Selected", "Show In Tree", and "Visibility".
  • Deriving from Part::Feature provides 17 View properties: the previous four, plus "Angular Deflection", "Bounding Box", "Deviation", "Draw Style", "Lighting", "Line Color", "Line Width", "Point Color", "Point Size", "Selectable", "Selection Style", "Shape Color", and "Transparency".

Nevertheless, View properties can also be assigned using the view provider object's addProperty() method. 

obj.ViewObject.addProperty("App::PropertyBool", "SuperVisibility", "Base", "Make the object glow")

Source code

In the source code, properties are located in various src/App/Property* files.

They are imported and initialized in src/App/Application.cpp. 

#include "Property.h"
#include "PropertyContainer.h"
#include "PropertyUnits.h"
#include "PropertyFile.h"
#include "PropertyLinks.h"
#include "PropertyPythonObject.h"
#include "PropertyExpressionEngine.h"


Power user hub.png Power user documentation
Retrieved from "https://wiki.labrps.com/index.php?title=Property&oldid=1562"