Espressioni

From FreeCAD Documentation
Jump to navigation Jump to search
This page is a translated version of the page Expressions and the translation is 17% complete.
Outdated translations are marked like this.
Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎polski • ‎português do Brasil • ‎русский

Descrizione

È possibile definire le proprietà utilizzando espressioni matematiche. Nella GUI, gli spin box o i campi di input che sono legati alle proprietà contengono un'icona blu Sketcher Expressions.png. Cliccando sull'icona, oppure digitando il segno di uguale =, si porta in primo piano l'editor delle espressioni per quella particolare proprietà.

Una espressione di FreeCAD è un'espressione matematica che segue la notazione per gli operatori matematici standard e le funzioni come descritto in seguito. Inoltre, l'espressione può fare riferimento ad altre proprietà, e anche utilizzare le condizioni. I numeri di un'espressione possono opzionalmente essere collegati ad una unità di misura.

I numeri possono usare una virgola ',' o un punto '.' per separare le cifre intere dai decimali. Quando viene utilizzato il separatore decimale, esso "deve" essere seguito da almeno una cifra. Pertanto, le espressioni 1.+2. e 1,+2, non sono valide, ma 1.0+2.0 e 1,0+2,0 sono validi.

Gli operatori e le funzioni sono unit-aware (consapevoli delle unità), e richiedono combinazioni di unità valide, se sono fornite. Ad esempio, 2mm + 4mm è un'espressione valida, mentre 2mm + 4 non lo è (il motivo di questo è che un'espressione come 1in + 4 molto probabilmente viene interpretata come 1in + 4in da un umano, ma tutte le unità vengono convertite nel sistema SI interno, e il sistema non è in grado di indovinare questo). Queste unità sono attualmente riconosciute.

Si possono usare le costanti predefinite e le funzioni.

Function arguments

Quando una funzione accetta più argomenti, questi possono essere separati da un punto e virgola (';') o da una virgola seguita da uno spazio (", "). In quest'ultimo caso, la virgola viene convertita in un punto e virgola dopo la voce. Quando si utilizza un punto e virgola, non è necessario terminare la riga con uno spazio.

Arguments may include references to cells in a spreadsheet. A cell reference consists of the cell's uppercase row letter followed by its column number, for example A1. A cell may also be referenced by using the cell's alias instead, for example Spreadsheet.MyPartWidth.

Riferimenti a oggetti

Si può fare riferimento a un oggetto tramite il suo Name o la sua Label. Nel caso di una Label, essa deve essere racchiusa tra i simboli << e >>, come questa: <<Label>>.

È possibile fare riferimento a qualsiasi proprietà numerica di un oggetto. Ad esempio, per fare riferimento all'altezza di un cilindro, è possibile utilizzare Cylinder.Height o <<Long_name_of_cylinder>>.Height.

Per fare riferimento agli oggetti dell'elenco, la sintassi è <<object_label>>.list[list_index] o object_name.list[list_index]. Se ad esempio si desidera fare riferimento a un vincolo in uno schizzo, si può farlo usando questa sintassi

<<MySketch>>.Constraints[16]. Se il riferimento si trova nello stesso schizzo, si può ometterne il nome e utilizzare solo Constraints[16].

Nota: L'indice inizia con 0, quindi il vincolo 17 ha l'indice 16.

Per ulteriori informazioni sul riferimento a oggetti, vedere questa sezione.

Costanti supportate

Sono supportate le seguenti costanti:

Constante Descrizione
e Numero di Eulero
pi Pi greco

Supported operators

Sono supportati i seguenti operatori:

Operatore Descrizione
+ Addizione
- Sottrazione
* Multiplicazione
/ Divisione virgola mobile
% Resto
^ Potenze

Funzioni supportate

Funzioni matematiche generali

Le funzioni matematiche elencate di seguito sono disponibili.

Le funzioni trigonometriche usano i gradi come unità predefinita. Per le misure in radianti aggiungere rad dopo il primo valore in una espressione. Per esempio cos(45) è la stessa cosa di cos(pi rad / 4). Se un'espressione è senza unità e per compatibilità deve essere convertita in gradi o radianti,, moltiplicare per 1 deg, 1 ° o 1 rad secondo il caso, ad es. (360 - X) * 1deg; (360 - X) * 1°; (0.5 + pi / 2) * 1rad.
Sono supportate le seguenti funzioni trigonometriche:

Funzione Descrizione Intervallo di valori
acos(x) Arc cosine -1 <= x <= 1
asin(x) Arc sine -1 <= x <= 1
atan(x) Arc tangent tutti
atan2(x, y) Arc tangent of x/y tutti, eccetto y = 0
cos(x) Cosine tutti
cosh(x) Hyperbolic cosine tutti
sin(x) Sine tutti
sinh(x) Hyperbolic sine tutti
tan(x) Tangent tutti, eccetto x = n·90 con n = intero
tanh(x) Hyperbolic tangent tutti

Per esponenziazione e logaritmizzazione sono supportate le seguenti funzioni:

Funzione Descrizione Intervallo di valori
exp(x) Exponential function tutti
log(x) Natural logarithm x > 0
log10(x) Common logarithm x > 0
pow(x, y) Exponentiation all
sqrt(x) Square root x >= 0

Per arrotondamento, troncamento e resto sono supportate queste funzioni :

Funzione Descrizione Intervallo di valori
abs(x) Valore assoluto tutti
ceil(x) Parte intera superiore valore intero più piccolo maggiore o uguale a x tutti
floor(x) Parte intera inferiore, valore intero più grande minore o uguale a x tutti
mod(x, y) Resto dopo aver diviso x per y tutti, eccetto y = 0
round(x) Arrotondamento al numero intero più vicino tutti
trunc(x) Troncamento al numero intero più vicino tutti

Statistical / aggregate functions

Statistica e Funzioni di aggregazione

Le funzioni di aggregazione accettano uno o più argomenti, separati da un punto e virgola ';' o da una virgola e uno spazio ', '.
Gli argomenti possono includere riferimenti a celle di un foglio di calcolo. I riferimenti alla cella sono costituiti dalla lettera maiuscola seguita dal numero della colonna.
Gli argomenti possono includere intervalli di celle usando due riferimenti di cella separati da due punti, ad esempio average(B1:B8).

Individual arguments to aggregate functions may consist of ranges of cells. A range of cells is expressed as two cell references separated by a colon :, for example average(B1:B8) or sum(A1:A4; B1:B4). The cell references may also use cell aliases, for example average(StartTemp:EndTemp).

Sono supportate queste funzioni aggregate :

Funzione Descrizione Intervallo di valori
average(x:y) Media aritmetica dei valori nelle celle da x a y; sum(x:y) / count(x:y) tutti
count(x:y) Conteggio di celle da x a y tutti
max(x:y) Massimo valore nelle celle da x a y tutti
min(x:y) Minimo valore nelle celle da x a y tutti
stddev(x:y) Deviazione standard dei valori nelle celle da x a y tutti
sum(x: y) Somma dei valori nelle celle da x a y tutti

String manipulation

String identification

Strings are identified in expressions by surrounding them with opening/closing double chevrons (as are labels).

In following example, "TEXT" is recognized as a string : <<TEXT>>

String concatenation

Strings can be concatenated using the '+' sign.

Following example <<MY>> + <<TEXT>> will be concatenated to "MYTEXT".

String formatting

String formatting is supported using the (old) %-style Python way.

All %-specifiers as defined in Python documentation.

As an example, supposing you have a default 10mm-side cube named 'Box' --default FreeCAD naming--, following expression <<Cube length : %s>> % Box.Length will expand to "Cube length : 10.0 mm"

A limitation is that only one %-specifier is allowed in string, thus you have to use string concatenation if more than one is needed. With same above situation, expression <<Cube length is %s>> % Box.Length + << and width is %s>> % Box.Width will expand to "Cube length is 10.0 mm and width is 10.0 mm".

A FreeCAD sample file using string formatting is available in the forum

Create function

The following objects may be created in expressions via the create function:

  • Vector
  • Matrix
  • Rotation
  • Placement

The create function passes subsequent arguments to the underlying Python constructor when creating the object.

Various mathematical operations such as multiplication, addition, and subtraction are supported via standard mathematical operators (e.g. *, +, -).

Vector

When create is passed <<vector>> as the 1st argument, the next 3 arguments are the X, Y, and Z coordinates for the Vector respectively.

Example:

create(<<vector>>; 2; 1; 2)

Matrix

When create is passed <<matrix>> as the 1st argument, the next 16 arguments are the elements for the Matrix in row-major order.

Example:

create(<<matrix>>; 1; 2; 3; 4; 5; 6; 7; 8; 9; 10; 11; 12; 13; 14; 15; 16)

Rotation

When create is passed <<rotation>> as the 1st argument, there are two ways to create a Rotation:

1. Specify an axis vector and a rotation angle.

Example:

create(<<rotation>>; create(<<vector>>; 0; 1; 0); 45)

2. Specify 3 rotations about the X, Y, and Z axes as Euler angles.

Example:

create(<<rotation>>; 30; 30; 30)

Placement

When create is passed <<placement>> as the 1st argument, there are five ways to create a Placement.

These possible combinations are documented in the below table and are based on the Placement API page.

Number of arguments Description
2 create(<<placement>>; Placement)
2 create(<<placement>>; Matrix)
3 create(<<placement>>; Base; Rotation)
4 create(<<placement>>; Base; Rotation; Center)
4 create(<<placement>>; Base; Axis; Angle)

The following example shows the syntax for creating a Placement from a Base (vector) and a Rotation:

create(<<placement>>; create(<<vector>>; 2; 1; 2); create(<<rotation>>; create(<<vector>>; 0; 1; 0); 45))

For readability, you can define vectors and rotations in separate cells, and then reference the cells in your expression.

Matrix functions

mscale

Scale a Matrix with a given Vector.

mscale(Matrix; Vector)

mscale(Matrix; x; y; z)

minvert

Invert the given Matrix, Rotation, or Placement.

minvert(Matrix)

minvert(Rotation)

minvert(Placement)

Tuple & list

You can create Python tuple or list objects via their respective functions.

tuple(2; 1; 2)

list(2; 1; 2)

Espressioni condizionali

Le espressioni condizionali sono nella forma condition ? resultTrue : resultFalse. La condizione è definita come un'espressione il cui risultato è '0' (falso) o diverso da zero (vero). Notare che racchiudere l'espressione condizionale tra parentesi è attualmente considerato un errore. versione 0.19 e precedenti

Sono definiti i seguenti operatori relazionali:

Operatore Descrizione
== uguale
!= diverso
> maggiore
< minore
>= maggiore o uguale
<= minore o uguale

Unità

Le unità possono essere utilizzate direttamente nelle espressioni. Il parser le collega al valore precedente. Quindi '2mm' o '2 mm' è valido mentre 'mm' non è valido perché non esiste un valore precedente.

Tutti i valori devono avere un'unità. Pertanto, in generale è necessario utilizzare un'unità per i valori nei fogli di calcolo.
In alcuni casi funziona anche senza un'unità, ad esempio se nella cella B1 del foglio di calcolo si ha solo il numero 1,5 e si fa riferimento ad esso per l'altezza del pad. Questo funziona perché l'altezza del pad predispone l'unità mm che viene utilizzata quando non viene fornita alcuna unità. Però fallisce se si utilizza per l'altezza del pad, ad es. Sketch1.Constraints.Width - Spreadsheet.B1 perché Sketch1.Constraints.Width ha un'unità e Spreadsheet.B1 no.

Le unità con esponenti possono essere inserite direttamente. Quindi ad es. mm^3 viene riconosciuto come mm³ e m^3 viene riconosciuto come m³.

Se una variabile ha il nome di un'unità di misura, bisogna inserire la variabile in << >> per impedire che venga riconosciuta come unità di misura. Ad esempio, la dimensione 'Sketch.Constraints.A' verrebbe riconosciuta come unità Ampere. Pertanto è necessario scriverla nell'espressione in questo modo 'Sketch.Constraints.<<A>>'.

Il parser delle espressioni riconosce le seguenti unità:

Quantità di sostanza:

Unità Descrizione
mmol Millimole
mol Mole

Angolo:

Unità Descrizione
° Grado; alternativa all'unità deg
deg Grado; alternativa all'unità °
rad Radiante
gon Gradiante
S Secondo di arco
Secondo di arco; alternativa all'unità S
M Minuto di arco
Minuto di arco; alternativa all'unità M

Corrente:

Unità Descrizione
mA Milliampere
A Ampere
kA Kiloampere
MA Megaampere

Electrical capacitance:

Unit Description
pF Picofarad
nF Nanofarad
uF Microfarad; alternative to the unit µF
µF Microfarad; alternative to the unit uF
mF Millifarad
F Farad; 1 F = 1 s^4·A^2/m^2/kg

Electrical conductance:

Unit Description
uS Microsiemens; alternative to the unit µS
µS Microsiemens; alternative to the unit uS
mS Millisiemens
S Siemens; 1 S = 1 s^3·A^2/kg/m^2
kS Kilosiemens, introduced in version 0.20
MS Megasiemens, introduced in version 0.20

Electrical inductance:

Unit Description
nH Nanohenry
uH Microhenry; alternative to the unit µH
µH Microhenry; alternative to the unit uH
mH Millihenry
H Henry; 1 H = 1 kg·m^2/s^2/A^2

Electrical resistance:

Unit Description
Ohm Ohm; 1 Ohm = 1 kg·m^2/s^3/A^2
kOhm Kiloohm
MOhm Megaohm

Electric charge:

Unit Description
C Coulomb; 1 C = 1 A·s

Electric potential:

Unit Description
mV Millivolt
V Volt
kV Kilovolt

Energia / Lavoro:

Unità Descrizione
mJ Millijoule
J Joule
kJ Kilojoule, Disponibile dalla versione 0.19
eV Elettronvolt; 1 ev = 1.602176634e-19 J, Disponibile dalla versione 0.19
keV Kiloelettronvolt, Disponibile dalla versione 0.19
MeV Megaelettronvolt, Disponibile dalla versione 0.19
kWh Kilowattora; 1 kWh = 3.6e6 J, Disponibile dalla versione 0.19
Ws Watt second; alternativa all'unità Joule
VAs Volt-ampere-second; alternativa all'unità Joule
CV Coulomb-volt; alternativa all'unità Joule
cal Calorie; 1 cal = 4.184 J, Disponibile dalla versione 0.19
kcal Kilocalorie, Disponibile dalla versione 0.19

Forza:

Unità Descrizione
mN Millinewton
N Newton
kN Kilonewton
MN Meganewton
lbf Pound of force

Lunghezza:

Unità Descrizione
nm Nanometer
um Micrometer; alternativa all'unità µm
µm Micrometer; alternativa all'unità mu
mm Millimeter
cm Centimeter
mm Millimeter
dm Decimeter
m Meter
km Kilometer
mil Thousandth of an inch; alternativa all'unità thou
thou Thousandth of an inch; alternativa all'unità mil
in Inch
ft Foot; alternativa all'unità '
' Foot; alternativa all'unità ft
yd Yard
mi Mile

Intensità luminosa:

Unità Descrizione
cd Candela

Magnetic field strength:

Unit Description
Oe Oersted; 1 Oe = 79.57747 A/m

Magnetic flux:

Unit Description
Wb Weber; 1 Wb = 1 kg*m^2/s^2/A

Magnetic flux density:

Unit Description
G Gauss; 1 G = 1 e-4 T
T Tesla; 1 T = 1 kg/s^2/A

Massa:

Unità Descrizione
ug Microgram; alternativa all'unità µg
µg Microgram; alternativa all'unità ug
mg Milligram
g Gram
kg Kilogram
t Tonne
oz Ounce
lb Pound; alternativa all'unità lbm
lbm Pound; alternativa all'unità lb
st Stone
cwt Hundredweight

Potenza:

Unità Descrizione
W Watt
kW Kilowatt, Disponibile dalla versione 0.19
VA Volt-ampere

Pressione:

Unità Descrizione
Pa pascal
kPa Kilopascal
MPa Megapascal
GPa Gigapascal
mbar Millibar, Disponibile dalla versione 0.19
bar bar, Disponibile dalla versione 0.19
uTorr Microtorr; alternativa all'unità µTorr
µTorr Microtorr; alternativa all'unità uTorr
mTorr Millitorr
Torr torr; 1 Torr = 133.32 Pa
psi libbre per pollice quadrato; 1 psi = 6.895 kPa
ksi Kilolibbre per pollice quadrato
Mpsi Megalibbre per pollice quadrato, Disponibile dalla versione 0.19

Temperatura:

Unità Descrizione
uK Microkelvin; alternativa all'unità µK
µK Microkelvin; alternativa all'unità uK
mK Millikelvin
K Kelvin

Volume:

Unità Descrizione
ml Millilitro, Disponibile dalla versione 0.19
l litro
cft Cubicfoot (piede cubico), Disponibile dalla versione 0.19

Special imperial units:

Unit Description
mph Miles per hour
sqft Square foot

Le seguenti unità comunemente utilizzate non sono ancora supportate:

Unità Descrizione Alternativa
°C Celsius [°C] + 273.15 K
°F Fahrenheit; ([°F] + 459.67) × ​5/9
u Atomic mass unit; alternative to the unit 'Da' 1.66053906660e-27 kg
Da Dalton; alternative to the unit 'u' 1.66053906660e-27 kg
sr Steradian not directly
lm Lumen not directly
lx Lux not directly
px Pixel not directly

Invalid characters and names

The expression feature is very powerful but to achieve this power it has some limitations concerning some characters. To overcome this, FreeCAD offers to use labels and reference them instead of the object names. In labels you can use almost all special characters.

In cases where you cannot use a label, such as the name of a sketch's constraints, you must be aware what characters are not allowed.

Labels

For labels there are no invalid characters, however some characters need to be escaped:

Characters Description
', \, " Need to be escaped by adding \ in front of them.

For example, the label Sketch\002 must be referenced as <<Sketch\\002>>.

Names

Names of objects like dimensions, sketches, etc. may not have the characters or character sequences listed below, otherwise the name is invalid:

Characters / Character sequences Description
+, -, *, /, ^, _, <, >, (, ), {, }, [, ], ., ,, = Characters that are math operators or part of mathematical constructs
A, kA, mA, MA, C, G, F, uF, µF, J, K, ' , ft , °, and many more! Characters and character sequences that are units
#, !, ?, §, $, %, &, :, ;, \, |, ~, , ¿, and many more! Characters used as placeholder or to trigger special operations
pi, e Mathematical constants
´, `, ' , " Characters used for accents
space A space defines the end of a name and can therefore not be used

For example, the following name is valid: <<Sketch>>.Constraints.T2üßµ@. While these are invalid names: <<Sketch>>.Constraints.test\result_2 (\r means "carriage return") or <<Sketch>>.Constraints.mol (mol is a unit).

Since shorter names (especially if they have only one or two characters) can easily result in invalid names, consider using longer names and/or establishing a suitable naming convention.

Cell aliases

For spreadsheet cell aliases only alphanumeric characters and underscores (A to Z, a to z, 0 to 9 and _) are allowed.

Riferimento ai dati CAD

In un'espressione è possibile utilizzare i dati del modello stesso. Per fare riferimento a una proprietà usare object.property. Se la proprietà è un composto di campi, è possibile accedere ai singoli campi come object.property.field.

La tabella seguente mostra alcuni esempi:

Dati CAD Chiamata nell'espressione Risultato
Lunghezza parametrica di un Cubo di Parte Cube.Length Length Lunghezza con unità in mm
Volume del Cubo Cube.Shape.Volume Volume in mm³ senza unità
Tipo di forma del Cubo Cube.Shape.ShapeType Stringa: Solid
Etichetta del Cubo Cube.Label Stringa: Label
Coordinata x del centro di massa del Cubo Cube.Shape.CenterOfMass.x Coordinata x in mm senza unità
Valore di un vincolo in uno schizzo Constraints.Width Valore numerico del vincolo di nome 'Width' nello schizzo, se l'espressione è utilizzata nello schizzo stesso.
Valore di un vincolo in uno schizzo MySketch.Constraints.Width Valore numerico del vincolo di nome 'Width' nello schizzo, se l'espressione è usata al di fuori dello schizzo.
Valore di un alias in spreadsheet Spreadsheet.Depth Valore dell'alias "Depth" nel foglio "Spreadsheet"
Valore di una proprietà locale Length Valore della proprietà Length ad es. di un oggetto Pad, se l'espressione viene utilizzata, ad esempio, in Length2 nello stesso oggetto.

Variabili globali nell'ambito del documento

Al momento in FreeCAD non esiste il concetto di variabili globali. Invece, utilizzando l'ambiente Spreadsheet, si possono definire delle variabili arbitrarie come celle in un foglio di calcolo, e poi assegnare loro un nome utilizzando la proprietà alias della cella (tasto destro del mouse sulla cella). Dopo si può accedere alla variabile da qualsiasi espressione, come per qualsiasi altra proprietà di un oggetto.

Riferimenti incrociati nel documento

È possibile (con limitazioni) definire una proprietà di un oggetto nel documento corrente (file ".FCstd") utilizzando un'espressione per fare riferimento a una proprietà di un oggetto contenuto in un documento diverso (file ".FCstd"). Ad esempio, una cella in un foglio di calcolo o la lunghezza di un cubo di Part, ecc. in un documento può essere definita da un'espressione che fa riferimento al valore di posizionamento X o ad un'altra proprietà di un oggetto contenuto in un documento diverso.

È possibile utilizzare il nome di un documento per fare riferimento ad esso da altri documenti. Quando si salva un documento per la prima volta, si sceglie un nome per il file; questo di solito è diverso dal default iniziale "Unnamed1" (o il suo equivalente tradotto). Per evitare la perdita dei collegamenti quando il documento master viene rinominato al momento del salvataggio, si consiglia di creare prima il documento master, creare un foglio di calcolo al suo interno e salvarlo. Successivamente è ancora possibile apportare modifiche e salvare il file, ma non si deve rinominarlo.

Una volta creato e salvato (e denominato) il documento master con il foglio di calcolo, è possibile creare dei documenti dipendenti. Supponendo che il documento master sia stato denominato "master", il foglio di calcolo sia stato rinominato "modelConstants" e a una cella sia stato assegnato un nome alias "Length", si può quindi accedere al valore con:

master#modelConstants.Length

Notare che il documento master deve sempre essere caricato affinché i valori del master siano disponibili per il documento dipendente.

Purtroppo, il checker integrato a volte afferma che un nome valido non esiste. Continuare comunque a digitare. Quando il riferimento è completato, il pulsante OK diventa attivo.

Naturalmente, dopo spetta all'utente il compito di caricare i documenti corrispondenti, quando si desidera cambiare qualcosa.

Problemi noti / attività rimanenti

  • I grafici delle dipendenze si basano sul rapporto tra gli oggetti del documento, non sulle proprietà. Questo significa che non è possibile fornire i dati a un oggetto e interrogare lo stesso oggetto per i risultati. Ad esempio, anche se non ci sono dipendenze cicliche quando vengono considerate solo le proprietà, non si può avere un oggetto che ottiene le sue dimensioni da un foglio di calcolo e quindi visualizza il volume di tale oggetto nello stesso foglio di calcolo. Per aggirare il problema, utilizzare più fogli di calcolo, ad esempio uno per sviluppare il modello, e uno per i rapporti.
  • Il parser delle espressioni non gestisce bene le parentesi e non è in grado di analizzare correttamente alcune espressioni. Ad esempio: "= (A1 > A2) ? 1 : 0" restituisce un errore, mentre "= A1 > A2 ? 1 : 0" è accettato. L'espressione "= 5 + ((A1>A2) ? 1 : 0)" non può essere inserita in nessuna forma.
  • Come affermato sopra, sfortunatamente, a volte il controllo integrato afferma che non esiste un nome valido. Continuare comunque a digitare. Dopo aver completato il riferimento completo, il pulsante OK diventerà attivo.
  • Non è implementato nessun gestore delle espressioni in cui siano elencate tutte le espressioni di un documento, e possano essere create, eliminate, interrogate, ecc.
  • I nomi dei vincoli di Sketcher non devono contenere spazi vuoti quando il valore è calcolato da un'espressione, vedere questa discussione nel forum.
  • I bug aperti per le espressioni si trovano in FreeCAD Bugtracker Expressions category