Read access to the unit of a data object's Z component. Read/write access to the unit of the Z component of the current formula or FlexPro data.
Syntax
DataObject.unit_z
or
Data.unit_z
or
this.unit_z = Unit
or
Data.unit_z = Unit
The syntax of the unit_z property consists of the following elements:
Element |
Description |
|---|---|
DataObject |
Optional. The data object being accessed. If you omit this element, then the current formula is accessed. |
Data |
A flexpro.Data object to which header information of the data object from which it originates is assigned. |
Unit |
The string to be assigned as the unit for the Z component. |
Remarks
Write access to the header information of a data object is only permitted for the formula in which the Python code is located. Instead of using write access, you should preferably edit the attribute on the General tab of the Properties dialog box.
If the data does not have a composite data structure, an empty string is returned.
Available In
FlexPro Professional, Developer Suite
Examples
flexpro.object(r’\DataSet').unit_z |
Returns a string with the physical unit of the Z component of a data set object in the root folder. |
flexpro.object(r’\DataSet').data.unit_z |
Returns a string with the physical unit of the Z component of the data of a data set object in the root folder. |
this.unit_z = "%" |
Sets the unit of the Z component of the current formula to "Hz". (Only useful if unit monitoring is switched off) |