Property - Revision history

LabRPS at 18:48, 21 June 2024

2024-06-21T18:48:41Z

← Older revision		Revision as of 11:48, 21 June 2024
Line 187:		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 209:		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=

LabRPS at 18:12, 21 June 2024

2024-06-21T18:12:07Z

← Older revision		Revision as of 11:12, 21 June 2024
Line 33:		Line 33:
	\|-		\|-
	\| Distance \|\| style="text-align:center;" \| m		\| Distance \|\| style="text-align:center;" \| m
	\|-
	~~\| ElectricPotential \|\| style="text-align:center;" \| V \|\| {{Version\|0.20}}~~
	\|-		\|-
	\| Enumeration \|\|		\| Enumeration \|\|

LabRPS at 18:06, 21 June 2024

2024-06-21T18:06:00Z

@@ Line 28: / Line 28: @@
 |-
 | ColorList ||
 |-
 | Density || style="text-align:center;" | kg/m^3
 |-
 |-
 | Distance || style="text-align:center;" | m
 |-
 | ElectricPotential || style="text-align:center;" | V || {{Version|0.20}}
@@ Line 76: / Line 55: @@
 |-
 | Frequency || style="text-align:center;" | Hz
 |-
 | Integer ||
@@ Line 86: / Line 63: @@
 |-
 | IntegerSet ||
 |-
 | Length || style="text-align:center;" | m
@@ Line 128: / Line 97: @@
 |-
 | LinkSubListHidden ||
 |-
 | Map ||
 |-
 | Material ||
@@ Line 164: / Line 121: @@
 |-
 | Position ||
 |-
 | Precision ||
@@ Line 178: / Line 133: @@
 |-
 | Rotation ||
 |-
 | Speed || style="text-align:center;" | m/s
 |-
 | Stiffness || style="text-align:center;" | m/s^2
 |-
 | String ||
 |-
 | StringList ||
 |-
 | UUID ||
@@ Line 216: / Line 151: @@
 |-
 | VectorList ||
 |-
 | Volume || style="text-align:center;" | l or m^3
 |-
 | XLink ||
@@ Line 233: / Line 160: @@
 | XLinkSub ||
 |-
-| XLinkSubList ||
+| XLinkSubList
 |}

LabRPS: 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..."

2024-06-21T15:54:39Z

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..."

New page

== Introduction ==

A [[Property|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|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|FeaturePython Custom Properties]] and [[PropertyLink:_InList_and_OutList|PropertyLink: InList and OutList]]

== All property types ==

Custom [[Scripted_objects|scripted objects]] can use any of the property types defined in the base system:

{| class="sortable wikitable"
|-
! Name !! Unit (if any) !! Remark
|-
| Acceleration || style="text-align:center;" | m/s^2
|-
| AmountOfSubstance || style="text-align:center;" | mol
|-
| Angle || style="text-align:center;" | °
|-
| Area || style="text-align:center;" | m^2
|-
| Bool ||
|-
| BoolList ||
|-
| Color ||
|-
| ColorList ||
|-
| CurrentDensity || style="text-align:center;" | A/m^2 || {{Version|0.21}}
|-
| 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
|-
| 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 ||
|-
| ExpressionEngine ||
|-
| File ||
|-
| FileIncluded ||
|-
| Float ||
|-
| FloatConstraint ||
|-
| FloatList ||
|-
| Font ||
|-
| Force || style="text-align:center;" | N
|-
| Frequency || style="text-align:center;" | Hz
|-
| HeatFlux || style="text-align:center;" | W/m^2|| {{Version|0.21}}
|-
| Integer ||
|-
| IntegerConstraint ||
|-
| IntegerList ||
|-
| 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
|-
| Link ||
|-
| LinkChild ||
|-
| LinkGlobal ||
|-
| LinkHidden ||
|-
| LinkList ||
|-
| LinkListChild ||
|-
| LinkListGlobal ||
|-
| LinkListHidden ||
|-
| LinkSub ||
|-
| LinkSubChild ||
|-
| LinkSubGlobal ||
|-
| LinkSubHidden ||
|-
| LinkSubList ||
|-
| LinkSubListChild ||
|-
| LinkSubListGlobal ||
|-
| 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 ||
|-
| Mass || style="text-align:center;" | kg || {{Version|0.21}}
|-
| Material ||
|-
| MaterialList ||
|-
| Matrix ||
|-
| PartShape || || a Part property, is accessed as</br>{{incode|Part::PropertyPartShape}}
|-
| Path ||
|-
| Percent ||
|-
| PersistentObject ||
|-
| Placement ||
|-
| PlacementLink ||
|-
| PlacementList ||
|-
| Position ||
|-
| Power || style="text-align:center;" | W || {{Version|0.21}}
|-
| Precision ||
|-
| Pressure || style="text-align:center;" | Pa
|-
| PythonObject ||
|-
| Quantity ||
|-
| QuantityConstraint ||
|-
| 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
|-
| Stiffness || style="text-align:center;" | m/s^2
|-
| Stress || style="text-align:center;" | Pa || {{Version|0.21}}
|-
| String ||
|-
| 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 ||
|-
| VacuumPermittivity || style="text-align:center;" | s^4*A^2 / (m^3*kg)
|-
| Vector ||
|-
| VectorDistance ||
|-
| VectorList ||
|-
| Velocity || style="text-align:center;" | m/s || {{Version|0.21}}
|-
| 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 ||
|-
| XLinkList ||
|-
| XLinkSub ||
|-
| XLinkSubList ||
|-
| YieldStrength || style="text-align:center;" | Pa || {{Version|0.21}}
|-
| YoungsModulus || style="text-align:center;" | Pa || {{Version|0.21}}
|}

Internally, the property name is prefixed with {{incode|App::Property}}:
{{Code|code=
App::PropertyBool
App::PropertyFloat
App::PropertyFloatList
...
}}

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

For example:

{{Code|code=
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 ==

{{Emphasis|See also:}} [[LabRPS_Scripting_Basics|LabRPS scripting basics]]

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

obj.addProperty("App::PropertyFloat", "Velocity", "Parameter", "Body speed")
obj.addProperty("App::PropertyBool", "VelocityEnabled", "Parameter", "Enable body speed")
}}

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

For example:
* Deriving from {{incode|App::FeaturePython}} provides only 4 {{Emphasis|View}} properties: "Display Mode", "On Top When Selected", "Show In Tree", and "Visibility".
* Deriving from {{incode|Part::Feature}} provides 17 {{Emphasis|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, {{Emphasis|View}} properties can also be assigned using the view provider object's {{incode|addProperty()}} method.

{{Code|code=
obj.ViewObject.addProperty("App::PropertyBool", "SuperVisibility", "Base", "Make the object glow")
}}

== Source code ==

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]}}.

{{Code|lang=cpp|code=
#include "Property.h"
#include "PropertyContainer.h"
#include "PropertyUnits.h"
#include "PropertyFile.h"
#include "PropertyLinks.h"
#include "PropertyPythonObject.h"
#include "PropertyExpressionEngine.h"
}}

{{Powerdocnavi}}
[[Category:Developer Documentation]]
[[Category:Python Code]]