|
|
| (2 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| {{VIServerClass|name=Variable|id=81|scope=basic|class_0=Variable}} | | {{VIServerClass|81}} |
|
| |
|
| {{stub}} | | {{stub}} |
| Line 7: |
Line 7: |
| {{TOCright}} | | {{TOCright}} |
|
| |
|
| ==Properties==
| | <!--Edit Properties, Methods, or Events in the appropriate table in one on the VI Server Templates--> |
| <span class="mw-customtoggle-propertiestable">Show/Hide Variable Properties Table</span> | | {{VIServerClassTables|81}} |
| <div class="mw-collapsible" id="mw-customcollapsible-propertiestable">
| |
| {{VIServerLegend|showrw=TRUE|showrte=TRUE}}
| |
| {| class="wikitable sortable"
| |
| |+ Variable Properties Table
| |
| ! Property ID
| |
| ! Short Name (English)
| |
| ! Description
| |
| ! R/W
| |
| ! RTE | |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C63
| |
| | [[Variable class/Alarming.BadStatus.AckType property|Alarming.BadStatus.AckType]]
| |
| |Gets or sets how the Bad Status alarm for a shared variable is acknowledged. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Ack Type</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C66
| |
| | [[Variable class/Alarming.BadStatus.AllowLog property|Alarming.BadStatus.AllowLog]]
| |
| |If TRUE, LabVIEW enables alarm logging for the Bad Status alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Log?</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C64
| |
| | [[Variable class/Alarming.BadStatus.Area property|Alarming.BadStatus.Area]]
| |
| |Gets or sets a descriptive area name for the Bad Status alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Create alarm areas to acknowledge an entire area of alarms as a single batch operation.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Area</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C65
| |
| | [[Variable class/Alarming.BadStatus.Desc property|Alarming.BadStatus.Desc]]
| |
| |Gets or sets the description of the Bad Status alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Description</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C60
| |
| | [[Variable class/Alarming.BadStatus.Enabled property|Alarming.BadStatus.Enabled]]
| |
| |If TRUE, LabVIEW enables the Bad Status alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Enable Alarm</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C61
| |
| | [[Variable class/Alarming.BadStatus.Name property|Alarming.BadStatus.Name]]
| |
| |Gets or sets the name of the Bad Status alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Name</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C62
| |
| | [[Variable class/Alarming.BadStatus.Priority property|Alarming.BadStatus.Priority]]
| |
| |Gets or sets the priority of the Bad Status alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Valid values are between 1 and 1000, where 1000 is the highest priority.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Priority</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C54
| |
| | [[Variable class/Alarming.Boolean.AckType property|Alarming.Boolean.AckType]]
| |
| |Gets or sets how the DISCRETE alarm for a shared variable is acknowledged. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Ack Type</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C52
| |
| | [[Variable class/Alarming.Boolean.AlarmOn property|Alarming.Boolean.AlarmOn]]
| |
| |Gets or sets whether a shared variable is in alarm state when the value is either high (TRUE) or low (FALSE). To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Alarm On</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C57
| |
| | [[Variable class/Alarming.Boolean.AllowLog property|Alarming.Boolean.AllowLog]]
| |
| |If TRUE, LabVIEW enables alarm logging for the DISCRETE alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.This property is similar to the <b>Log?</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C55
| |
| | [[Variable class/Alarming.Boolean.Area property|Alarming.Boolean.Area]]
| |
| |Gets or sets a descriptive area name for the DISCRETE alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Create alarm areas to acknowledge an entire area of alarms as a single batch operation.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.This property is similar to the <b>Area</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C56
| |
| | [[Variable class/Alarming.Boolean.Desc property|Alarming.Boolean.Desc]]
| |
| |Gets or sets the description of the DISCRETE alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.This property is similar to the <b>Description</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C50
| |
| | [[Variable class/Alarming.Boolean.Enabled property|Alarming.Boolean.Enabled]]
| |
| |If TRUE, LabVIEW enables the DISCRETE alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Enable Alarm</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C51
| |
| | [[Variable class/Alarming.Boolean.Name property|Alarming.Boolean.Name]]
| |
| |Gets or sets the name of the DISCRETE alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Name</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C53
| |
| | [[Variable class/Alarming.Boolean.Priority property|Alarming.Boolean.Priority]]
| |
| |Gets or sets the priority of the DISCRETE alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Valid values are between 1 and 1000, where 1000 is the highest priority.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Priority</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C5C
| |
| | [[Variable class/Alarming.Custom.AckType property|Alarming.Custom.AckType]]
| |
| |
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C5F
| |
| | [[Variable class/Alarming.Custom.AllowLog property|Alarming.Custom.AllowLog]]
| |
| |
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C5D
| |
| | [[Variable class/Alarming.Custom.Area property|Alarming.Custom.Area]]
| |
| |
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C5E
| |
| | [[Variable class/Alarming.Custom.Desc property|Alarming.Custom.Desc]]
| |
| |
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C58
| |
| | [[Variable class/Alarming.Custom.Enabled property|Alarming.Custom.Enabled]]
| |
| |
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C59
| |
| | [[Variable class/Alarming.Custom.Name property|Alarming.Custom.Name]]
| |
| |
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C5B
| |
| | [[Variable class/Alarming.Custom.Priority property|Alarming.Custom.Priority]]
| |
| |
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C5A
| |
| | [[Variable class/Alarming.Custom.VIPath property|Alarming.Custom.VIPath]]
| |
| |
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C21
| |
| | [[Variable class/Alarming.Enabled property|Alarming.Enabled]]
| |
| |If TRUE, LabVIEW enables alarming for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Enable Alarming</b> option on the Alarming page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C70
| |
| | [[Variable class/Alarming.EventOnDataChange property|Alarming.EventOnDataChange]]
| |
| |If TRUE, LabVIEW sets an event for a shared variable when data changes. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C71
| |
| | [[Variable class/Alarming.EventOnUserInputOnly property|Alarming.EventOnUserInputOnly]]
| |
| |If TRUE, the value change event is generated on user input only. The default is TRUE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C30
| |
| | [[Variable class/Alarming.Hi.AckType property|Alarming.Hi.AckType]]
| |
| |Gets or sets how the HI alarm for a shared variable is acknowledged. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Ack Type</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C33
| |
| | [[Variable class/Alarming.Hi.AllowLog property|Alarming.Hi.AllowLog]]
| |
| |If TRUE, LabVIEW enables alarm logging for the HI alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Log?</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C31
| |
| | [[Variable class/Alarming.Hi.Area property|Alarming.Hi.Area]]
| |
| |Gets or sets a descriptive area name for the HI alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Create alarm areas to acknowledge an entire area of alarms as a single batch operation.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Area</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C2E
| |
| | [[Variable class/Alarming.Hi.Deadband property|Alarming.Hi.Deadband]]
| |
| |Gets or sets the HI alarm deadband as a percentage of the full scale range. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| A shared variable does not return to a normal state until it has left the alarm condition set by the value of the Alarming:Hi:Level property by at least the value of the deadband. If you set the deadband too high, the shared variable value might not clear the alarm.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Deadband/Time</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C32
| |
| | [[Variable class/Alarming.Hi.Desc property|Alarming.Hi.Desc]]
| |
| |Gets or sets the description of the HI alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Description</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C2B
| |
| | [[Variable class/Alarming.Hi.Enabled property|Alarming.Hi.Enabled]]
| |
| |If TRUE, LabVIEW enables the HI alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Enable Alarm</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C2D
| |
| | [[Variable class/Alarming.Hi.Level property|Alarming.Hi.Level]]
| |
| |Gets or sets the value, in engineering units, that evokes the HI alarm condition for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| The shared variable remains in the alarm state until the shared variable value goes below this value minus the deadband value.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Level/Change</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C2C
| |
| | [[Variable class/Alarming.Hi.Name property|Alarming.Hi.Name]]
| |
| |Gets or sets the name of the HI alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Name</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C2F
| |
| | [[Variable class/Alarming.Hi.Priority property|Alarming.Hi.Priority]]
| |
| |Gets or sets the priority of the HI alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Valid values are between 1 and 1000, where 1000 is the highest priority.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Priority</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C27
| |
| | [[Variable class/Alarming.HiHi.AckType property|Alarming.HiHi.AckType]]
| |
| |Gets or sets how the HI_HI alarm for a shared variable is acknowledged. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Ack Type</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C2A
| |
| | [[Variable class/Alarming.HiHi.Allow Log property|Alarming.HiHi.Allow Log]]
| |
| |If TRUE, LabVIEW enables alarm logging for the HI_HI alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Log?</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C28
| |
| | [[Variable class/Alarming.HiHi.Area property|Alarming.HiHi.Area]]
| |
| |Gets or sets a descriptive area name for the HI_HI alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Create alarm areas to acknowledge an entire area of alarms as a single batch operation.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Area</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C25
| |
| | [[Variable class/Alarming.HiHi.Deadband property|Alarming.HiHi.Deadband]]
| |
| |Gets or sets the HI_HI alarm deadband as a percentage of the full scale range. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| A shared variable does not return to a normal state until it has left the alarm condition set by the value of the Alarming:HiHi:Level property by at least the value of the deadband. If you set the deadband too high, the shared variable value might not clear the alarm.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Deadband/Time</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C29
| |
| | [[Variable class/Alarming.HiHi.Desc property|Alarming.HiHi.Desc]]
| |
| |Gets or sets the description of the HI_HI alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Description</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C22
| |
| | [[Variable class/Alarming.HiHi.Enabled property|Alarming.HiHi.Enabled]]
| |
| |If TRUE, LabVIEW enables the HI_HI alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Enable Alarm</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C24
| |
| | [[Variable class/Alarming.HiHi.Level property|Alarming.HiHi.Level]]
| |
| |Gets or sets the value, in engineering units, that evokes the HI_HI alarm condition for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| The shared variable remains in the alarm state until the shared variable value goes below this value minus the deadband value.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Level/Change</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C23
| |
| | [[Variable class/Alarming.HiHi.Name property|Alarming.HiHi.Name]]
| |
| |Gets or sets the name of the HI_HI alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Name</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C26
| |
| | [[Variable class/Alarming.HiHi.Priority property|Alarming.HiHi.Priority]]
| |
| |Gets or sets the priority of the HI_HI alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Valid values are between 1 and 1000, where 1000 is the highest priority.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Priority</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C39
| |
| | [[Variable class/Alarming.Lo.AckType property|Alarming.Lo.AckType]]
| |
| |Gets or sets how the LO alarm for a shared variable is acknowledged. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Ack Type</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C3C
| |
| | [[Variable class/Alarming.Lo.AllowLog property|Alarming.Lo.AllowLog]]
| |
| |If TRUE, LabVIEW enables alarm logging for the LO alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Log?</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C3A
| |
| | [[Variable class/Alarming.Lo.Area property|Alarming.Lo.Area]]
| |
| |Gets or sets a descriptive area name for the LO alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Create alarm areas to acknowledge an entire area of alarms as a single batch operation.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Area</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C37
| |
| | [[Variable class/Alarming.Lo.Deadband property|Alarming.Lo.Deadband]]
| |
| |Gets or sets the LO alarm deadband as a percentage of the full scale range. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| A shared variable does not return to a normal state until it has left the alarm condition set by the value of the Alarming:Lo:Level property by at least the value of the deadband. If you set the deadband too high, the shared variable value might not clear the alarm.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Deadband/Time</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C3B
| |
| | [[Variable class/Alarming.Lo.Desc property|Alarming.Lo.Desc]]
| |
| |Gets or sets the description of the LO alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Description</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C34
| |
| | [[Variable class/Alarming.Lo.Enabled property|Alarming.Lo.Enabled]]
| |
| |If TRUE, LabVIEW enables the LO alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Enable Alarm</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C36
| |
| | [[Variable class/Alarming.Lo.Level property|Alarming.Lo.Level]]
| |
| |Gets or sets the value, in engineering units, that evokes the LO alarm condition for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| The shared variable remains in the alarm state until the shared variable value exceeds this value plus the deadband value.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Level/Change</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C35
| |
| | [[Variable class/Alarming.Lo.Name property|Alarming.Lo.Name]]
| |
| |Gets or sets the name of the LO alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Name</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C38
| |
| | [[Variable class/Alarming.Lo.Priority property|Alarming.Lo.Priority]]
| |
| |Gets or sets the priority of the LO alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Valid values are between 1 and 1000, where 1000 is the highest priority.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Priority</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C42
| |
| | [[Variable class/Alarming.LoLo.AckType property|Alarming.LoLo.AckType]]
| |
| |Gets or sets how the LO_LO alarm for a shared variable is acknowledged. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Ack Type</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C45
| |
| | [[Variable class/Alarming.LoLo.AllowLog property|Alarming.LoLo.AllowLog]]
| |
| |If TRUE, LabVIEW enables alarm logging for the LO_LO alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Log?</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C43
| |
| | [[Variable class/Alarming.LoLo.Area property|Alarming.LoLo.Area]]
| |
| |Gets or sets a descriptive area name for the LO_LO alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Create alarm areas to acknowledge an entire area of alarms as a single batch operation.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Area</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C40
| |
| | [[Variable class/Alarming.LoLo.Deadband property|Alarming.LoLo.Deadband]]
| |
| |Gets or sets the LO_LO alarm deadband as a percentage of the full scale range. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| A shared variable does not return to a normal state until it has left the alarm condition set by the value of the Alarming:LoLo:Level property by at least the value of the deadband. If you set the deadband too high, the shared variable value might not clear the alarm.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Deadband/Time</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C44
| |
| | [[Variable class/Alarming.LoLo.Desc property|Alarming.LoLo.Desc]]
| |
| |Gets or sets the description of the LO_LO alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Description</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C3D
| |
| | [[Variable class/Alarming.LoLo.Enabled property|Alarming.LoLo.Enabled]]
| |
| |If TRUE, LabVIEW enables the LO_LO alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Enable Alarm</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C3F
| |
| | [[Variable class/Alarming.LoLo.Level property|Alarming.LoLo.Level]]
| |
| |Gets or sets the value, in engineering units, that evokes the LO_LO alarm condition for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| The shared variable remains in the alarm state until the shared variable value exceeds this value plus the deadband value.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Level/Change</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C3E
| |
| | [[Variable class/Alarming.LoLo.Name property|Alarming.LoLo.Name]]
| |
| |Gets or sets the name of the LO_LO alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Name</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C41
| |
| | [[Variable class/Alarming.LoLo.Priority property|Alarming.LoLo.Priority]]
| |
| |Gets or sets the priority of the LO_LO alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Valid values are between 1 and 1000, where 1000 is the highest priority.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Priority</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C6C
| |
| | [[Variable class/Alarming.ROC.AckType property|Alarming.ROC.AckType]]
| |
| |Gets or sets how the Rate of Change alarm for a shared variable is acknowledged. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Ack Type</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C6F
| |
| | [[Variable class/Alarming.ROC.AllowLog property|Alarming.ROC.AllowLog]]
| |
| |If TRUE, LabVIEW enables alarm logging for the Rate of Change alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Log?</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C6D
| |
| | [[Variable class/Alarming.ROC.Area property|Alarming.ROC.Area]]
| |
| |Gets or sets a descriptive area name for the Rate of Change alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Create alarm areas to acknowledge an entire area of alarms as a single batch operation.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Area</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C69
| |
| | [[Variable class/Alarming.ROC.Change property|Alarming.ROC.Change]]
| |
| |Gets or sets the value that a shared variable value must change in the specified time to trigger the Rate of Change alarm. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Level/Change</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C6E
| |
| | [[Variable class/Alarming.ROC.Desc property|Alarming.ROC.Desc]]
| |
| |Gets or sets the description of the Rate of Change alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Description</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C67
| |
| | [[Variable class/Alarming.ROC.Enabled property|Alarming.ROC.Enabled]]
| |
| |If TRUE, LabVIEW enables the Rate of Change alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Enable Alarm</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C68
| |
| | [[Variable class/Alarming.ROC.Name property|Alarming.ROC.Name]]
| |
| |Gets or sets the name of the Rate of Change alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Name</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C6B
| |
| | [[Variable class/Alarming.ROC.Priority property|Alarming.ROC.Priority]]
| |
| |Gets or sets the priority of the Rate of Change alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Valid values are between 1 and 1000, where 1000 is the highest priority.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Priority</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C6A
| |
| | [[Variable class/Alarming.ROC.Time property|Alarming.ROC.Time]]
| |
| |Gets or sets the amount of time, in milliseconds, in which a shared variable value must change at least the value of the Alarming:RateOfChange:Change property to trigger the Rate of Change alarm. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Deadband/Time</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C4C
| |
| | [[Variable class/Alarming.U32BitField.AckType property|Alarming.U32BitField.AckType]]
| |
| |Gets or sets how the BIT_ARRAY alarm for a shared variable is acknowledged. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Ack Type</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C4A
| |
| | [[Variable class/Alarming.U32BitField.AlarmOn property|Alarming.U32BitField.AlarmOn]]
| |
| |Gets or sets whether a shared variable generates an alarm when any bit (1) is in alarm state or only when all bits (0) are in alarm state. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| This option is valid only when the Alarming:U32BitField:Enabled property is TRUE.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Alarm On</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C4F
| |
| | [[Variable class/Alarming.U32BitField.AllowLog property|Alarming.U32BitField.AllowLog]]
| |
| |If TRUE, LabVIEW enables alarm logging for the BIT_ARRAY alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Log?</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C4D
| |
| | [[Variable class/Alarming.U32BitField.Area property|Alarming.U32BitField.Area]]
| |
| |Gets or sets a descriptive area name for the BIT_ARRAY alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Create alarm areas to acknowledge an entire area of alarms as a single batch operation.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Area</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C4E
| |
| | [[Variable class/Alarming.U32BitField.Desc property|Alarming.U32BitField.Desc]]
| |
| |Gets or sets the description of the BIT_ARRAY alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Description</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C46
| |
| | [[Variable class/Alarming.U32BitField.Enabled property|Alarming.U32BitField.Enabled]]
| |
| |If TRUE, LabVIEW enables the BIT_ARRAY alarm for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Enable Alarm</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C48
| |
| | [[Variable class/Alarming.U32BitField.InvertMask property|Alarming.U32BitField.InvertMask]]
| |
| |Gets or sets which bits of a shared variable alarm on high, 1, and which bits alarm on low, 0. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Enter the value 1 if you want that bit to alarm when low. In bitwise terminology, the Shared Variable Engine performs an XOR with the invert mask value to produce the alarm state. LabVIEW applies the invert mask value to the scaled value after applying any relevant scaling masks.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Invert</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C47
| |
| | [[Variable class/Alarming.U32BitField.Name property|Alarming.U32BitField.Name]]
| |
| |Gets or sets the name of the BIT_ARRAY alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Name</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C4B
| |
| | [[Variable class/Alarming.U32BitField.Priority property|Alarming.U32BitField.Priority]]
| |
| |Gets or sets the priority of the BIT_ARRAY alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Valid values are between 1 and 1000, where 1000 is the highest priority.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Priority</b> option on the Alarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C49
| |
| | [[Variable class/Alarming.U32BitField.SelectMask property|Alarming.U32BitField.SelectMask]]
| |
| |Gets or sets which bits LabVIEW uses to calculate the alarm for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| LabVIEW uses bits that are 1 in the alarm calculation. Bits that are 0 do not cause an alarm, regardless of their value. In bitwise terminology, the Shared Variable Engine performs an AND with the select mask value to produce the alarm state. LabVIEW applies the select mask value to the scaled value after applying any relevant scaling masks.
| |
| | |
| <b>Note</b> You can enable alarming only for network-published shared variables.
| |
| This property is similar to the <b>Mask</b> option on theAlarming page of the <b>Shared Variable Properties</b> dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C83
| |
| | [[Variable class/Data Type (Variant) property|Data Type (Variant)]]
| |
| |Sets the data type of the variable to the data type you wire to this property.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| | |
| This property is similar to the <b>Data Type</b> option on the Variable page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C03
| |
| | [[Variable class/Description property|Description]]
| |
| |Gets or sets the description of a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| This property is similar to the Description option on the <b>Description</b> page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C91
| |
| | [[Variable class/I/O.AliasAccessType property|I/O.AliasAccessType]]
| |
| |
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C8D
| |
| | [[Variable class/I/O.AliasProjectPath property|I/O.AliasProjectPath]]
| |
| |
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C8F
| |
| | [[Variable class/I/O.BufferSize property|I/O.BufferSize]]
| |
| |
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C8E
| |
| | [[Variable class/I/O.BufferingEnabled property|I/O.BufferingEnabled]]
| |
| |
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C8B
| |
| | [[Variable class/I/O.ChannelIndex property|I/O.ChannelIndex]]
| |
| |
| |
| |R
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C8C
| |
| | [[Variable class/I/O.Direction property|I/O.Direction]]
| |
| |
| |
| |R
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C88
| |
| | [[Variable class/I/O.EnableTimestamp property|I/O.EnableTimestamp]]
| |
| |
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C8A
| |
| | [[Variable class/I/O.Mode property|I/O.Mode]]
| |
| |
| |
| |R
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C89
| |
| | [[Variable class/I/O.NetworkPublished property|I/O.NetworkPublished]]
| |
| |
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C90
| |
| | [[Variable class/I/O.RSI property|I/O.RSI]]
| |
| |
| |
| |R
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C7C
| |
| | [[Variable class/InitialValue.Enabled property|InitialValue.Enabled]]
| |
| |If TRUE, LabVIEW enables initial value setting for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| This property is similar to the <b>Enable Initial Value</b> option on the <b>Initial Value</b> page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C7D
| |
| | [[Variable class/InitialValue.Initial Value property|InitialValue.Initial Value]]
| |
| |Gets or sets the initial value for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| This property is similar to the <b>Initial Value</b> option on the <b>Initial Value</b> page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C20
| |
| | [[Variable class/Logging.Deadband property|Logging.Deadband]]
| |
| |Gets or sets the deadband for logging a shared variable in the Citadel historical database. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Use this option to improve the performance of an application by limiting unnecessary datalogging. LabVIEW logs a new shared variable value only if that value differs by at least the deadband value from the value previously logged. The default value is 0%, which logs each new value for the shared variable. This option is available only for shared variables with a <b>Data Type</b> of <b>Double</b> or <b>Single</b>.
| |
| | |
| <b>Note</b> You can enable logging only for network-published shared variables.
| |
| This property is similar to the <b>Value Deadband</b> option on the Logging page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C1B
| |
| | [[Variable class/Logging.Enabled property|Logging.Enabled]]
| |
| |If TRUE, LabVIEW enables logging for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable logging only for network-published shared variables.
| |
| This property is similar to the <b>Enable Logging</b> option on the Logging page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C1D
| |
| | [[Variable class/Logging.LogData property|Logging.LogData]]
| |
| |If TRUE, LabVIEW logs data for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable logging only for network-published shared variables.
| |
| This property is similar to the <b>Log Data</b> option on the Logging page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C1C
| |
| | [[Variable class/Logging.LogEvents property|Logging.LogEvents]]
| |
| |If TRUE, LabVIEW logs events for a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable logging only for network-published shared variables.
| |
| This property is similar to the <b>Log Events</b> option on the Logging page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C86
| |
| | [[Variable class/Logging.StringFormat property|Logging.StringFormat]]
| |
| |Sets the logging string format. LabVIEW ignores this property if the data type of the variable is not a string. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C1E
| |
| | [[Variable class/Logging.TimeRes property|Logging.TimeRes]]
| |
| |Gets or sets the resolution, in seconds, for logging a shared variable value in the Citadel historical database. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can enable logging only for network-published shared variables.
| |
| This property is similar to the <b>Time Resolution (sec)</b> option on the Logging page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C1F
| |
| | [[Variable class/Logging.ValueRes property|Logging.ValueRes]]
| |
| |Gets or sets the resolution, in engineering units, for logging the shared variable value in the Citadel historical database. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| LabVIEW writes shared variables to the Citadel historical database in compressed format with the specified resolution. The default value is 0.1. Enter a value of 0.0 to write the exact value of the shared variable to the Citadel historical database. Logging the exact value requires more time and disk space. This option is available only for shared variables with a <b>Data Type</b> of <b>Double</b> or <b>Single</b>.
| |
| | |
| <b>Note</b> You can enable logging only for network-published shared variables.
| |
| This property is similar to the <b>Value Resolution</b> option on the Logging page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C00
| |
| | [[Variable class/Name property|Name]]
| |
| |Gets or sets the shared variable name.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| | |
| This property is similar to the <b>Name</b> option on the Variable page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C08
| |
| | [[Variable class/Network.AccessType property|Network.AccessType]]
| |
| |Specifies whether a shared variable reads, writes, or reads and writes data.
| |
| | |
| Valid values are 0 (read only), 1 (write only), and 2 (read/write).
| |
| | |
| If you set this property to 0 (read only) or 1 (write only), you can create shared variables that are configured only to read data or write data, respectively. When you right-click a shared variable that is bound to a source that is read or write only, the <b>Change to Write</b> and <b>Change to Read</b> options are disabled in the shortcut menu.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| | |
| This property is similar to the <b>Access Type</b> option on the Variable page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C05
| |
| | [[Variable class/Network.BuffSize property|Network.BuffSize]]
| |
| |Gets or sets the size of the network buffer.
| |
| | |
| LabVIEW returns the size of the buffer in bytes. However, if the buffer data type is an Integer, such as an 8-bit signed integer, an 8-bit unsigned integer, a 16-bit signed integer, a 16-bit unsigned integer, and so on; a Boolean; a single-precision floating-point or double-precision floating-point; a 16-bit integer of waveforms or double waveforms; a 1D array of all types; or strings, LabVIEW returns the buffer size in those data types. For example, for a 16-bit integer, LabVIEW returns the number of 16-bit integers. For a 1D array, LabVIEW returns the number of arrays.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| | |
| Use the Network:Element Size property to set the size of arrays or strings, and use the Network:Points Per Waveform property to set the size of waveforms.
| |
| | |
| This property is similar to the <b>Size</b> option on the Network page of the Shared Variable Properties dialog box.
| |
| | |
| LabVIEW uses the Network:Buffer Size, Network:Element Size, and Network:Points Per Waveform properties as appropriate to calculate the network buffer size for a network-published shared variable.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C06
| |
| | [[Variable class/Network.ElemSize property|Network.ElemSize]]
| |
| |Gets or sets the size, in number of values, of the network buffer. For arrays, gets or sets the number of elements in the array. For strings, gets or sets the number of characters in the string.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| | |
| This property is similar to the <b>Number of</b> option on the Network page of the Shared Variable Properties dialog box.
| |
| | |
| LabVIEW uses the Network:Buffer Size, Network:Element Size, and Network:Points Per Waveform properties as appropriate to calculate the network buffer size for a network-published shared variable.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C7F
| |
| | [[Variable class/Network.OnScan property|Network.OnScan]]
| |
| |
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C7B
| |
| | [[Variable class/Network.PointsPerWaveform property|Network.PointsPerWaveform]]
| |
| |The number of points in each waveform in the buffer.
| |
| | |
| LabVIEW uses the Network:Buffer Size, Network:Element Size, and Network:Points Per Waveform properties as appropriate to calculate the network buffer size for a network-published shared variable.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| | |
| This property is similar to the <b>Waveform Size</b> option on the Network page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C7E
| |
| | [[Variable class/Network.ProjectBinding property|Network.ProjectBinding]]
| |
| |Indicates if the variable is bound to a project item or a URL. If TRUE, the variable is bound to a project item. If FALSE, the variable is bound to a URL.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| | |
| This property is similar to the <b>Enable Aliasing</b> option on the Variable page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C0A
| |
| | [[Variable class/Network.ProjectPath property|Network.ProjectPath]]
| |
| |Gets or sets the path to a shared variable in the active LabVIEW project to which you want to bind the shared variable you are configuring.
| |
| | |
| The project path consists of the library in which the shared variable resides and the shared variable name: library\project_variable.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| | |
| This property is similar to the <b>Project Path</b> option on the Variable page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C09
| |
| | [[Variable class/Network.URL property|Network.URL]]
| |
| |Gets or sets the path to a shared variable inside another project or to the data item to which you want to bind the shared variable you are configuring.
| |
| | |
| The network path to shared variables in other projects consists of the computer name, the name of the library in which the shared variable resides, and the shared variable name: \\computer\library\project_variable. The network path to an NI Publish-Subscribe Protocol (NI-PSP) data item consists of the computer name, the name of the process in which the data item resides, and the data item name: \\computer\process\data_item.
| |
| | |
| This property is similar to the <b>Network Path</b> option on the Variable page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C07
| |
| | [[Variable class/Network.UseBinding property|Network.UseBinding]]
| |
| |If TRUE, LabVIEW binds a shared variable to an existing shared variable in the active project, an existing shared variable in another project, or an NI Publish-Subscribe Protocol data item on the network. The default is FALSE.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| | |
| This property is similar to the <b>Enable Aliasing</b> option on the Variable page of the Shared Variable Properties dialog box.
| |
| | |
| <b>Note</b> You can bind front panel objects only to network-published shared variables.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C04
| |
| | [[Variable class/Network.UseBuffering property|Network.UseBuffering]]
| |
| |If TRUE, LabVIEW enables buffering for a shared variable. The default is FALSE.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| | |
| This property is similar to the <b>Use Buffering</b> option on the Network page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C92
| |
| | [[Variable class/P2P.BufferSize property|P2P.BufferSize]]
| |
| |
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C94
| |
| | [[Variable class/P2P.IsWriter property|P2P.IsWriter]]
| |
| |
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C96
| |
| | [[Variable class/P2P.IsP2P property|P2P.IsP2P]]
| |
| |
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C97
| |
| | [[Variable class/P2P.TimeStampEnabled property|P2P.TimeStampEnabled]]
| |
| |
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C93
| |
| | [[Variable class/P2P.OtherEndpointURL property|P2P.OtherEndpointURL]]
| |
| |
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C95
| |
| | [[Variable class/P2P.URLString property|P2P.URLString]]
| |
| |
| |
| |R/W
| |
| |X
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C0E
| |
| | [[Variable class/RT.ArrayLength property|RT.ArrayLength]]
| |
| |Gets or sets the length of the array for a shared variable with a fixed length array data type. You can only use this property in the LabVIEW development system, but you must install the LabVIEW Real-Time Module to make this property available.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C0D
| |
| | [[Variable class/RT.BufferLength property|RT.BufferLength]]
| |
| |Gets or sets the length of the real-time first-in-first-out (FIFO) buffer for a shared variable. You can only use this property in the LabVIEW development system, but you must install the LabVIEW Real-Time Module to make this property available.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C0F
| |
| | [[Variable class/RT.DatapointsInWaveform property|RT.DatapointsInWaveform]]
| |
| |Gets or sets the number of data points for a shared variable with a <b>Data Type</b> of <b>Waveform</b>. You can only use this property in the LabVIEW development system, but you must install the LabVIEW Real-Time Module to make this property available.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C0B
| |
| | [[Variable class/RT.Enabled property|RT.Enabled]]
| |
| |If TRUE, LabVIEW enables the real-time first-in-first-out (FIFO) features for a shared variable. The default is FALSE. You can only use this property in the LabVIEW development system, but you must install the LabVIEW Real-Time Module to make this property available.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C0C
| |
| | [[Variable class/RT.UseBuffering property|RT.UseBuffering]]
| |
| |If TRUE, LabVIEW uses the configuration you specify in the <b>Use Buffering</b> section of the Network page of the Shared Variable Properties dialog box to configure the size and elements of a real-time first-in-first-out (FIFO) buffer for a shared variable. The default is FALSE. You can only use this property in the LabVIEW development system, but you must install the LabVIEW Real-Time Module to make this property available.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C16
| |
| | [[Variable class/Scaling.Coerce property|Scaling.Coerce]]
| |
| |If TRUE, LabVIEW coerces the shared variable data to a range you specify. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| You can use this property for shared variables with a <b>Scale Type</b> of <b>Linear</b>.
| |
| | |
| If you scale the data for a shared variable you can write, the data must be between the Scaling:Raw Min and Scaling:Raw Max values. If you scale the data for a shared variable you can read, the data must be between the Scaling:Engineering Min and Scaling:Engineering Max values.
| |
| | |
| This property is similar to the <b>Coerce to Range</b> option on the Scaling page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C1A
| |
| | [[Variable class/Scaling.CustomVI property|Scaling.CustomVI]]
| |
| |
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C10
| |
| | [[Variable class/Scaling.Enabled property|Scaling.Enabled]]
| |
| |If TRUE, LabVIEW scales the shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| <b>Note</b> You can use scaling only for network-published shared variables, I/O variables, or I/O aliases. When the shared variable you want to scale is a network-published shared variable, it must also have a data source. Configure a network-published shared variable to have a data source by placing a checkmark in the <b>Enable Aliasing</b> checkbox on the Variable page of the <b>Shared Variable Properties</b> dialog box.
| |
| This property is similar to the <b>Enable Scaling</b> option on the Scaling page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C87
| |
| | [[Variable class/Scaling.EngUnit property|Scaling.EngUnit]]
| |
| |Specifies the engineering unit for the shared variable.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C15
| |
| | [[Variable class/Scaling.EngMax property|Scaling.EngMax]]
| |
| |Gets or sets the full scale, or maximum value, that the Shared Variable Engine and Human Machine Interface (HMI) application use for a shared variable when you use linear or square root scaling. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| You can use this property for shared variables with a <b>Scale Type</b> of <b>Linear</b>.
| |
| | |
| This property is similar to the <b>Engineering Full Scale</b> option on the Scaling page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C14
| |
| | [[Variable class/Scaling.EngMin property|Scaling.EngMin]]
| |
| |Gets or sets the zero scale, or minimum value, that the Shared Variable Engine and Human Machine Interface (HMI) application use for a shared variable when you use linear or square root scaling. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| You can use this property for shared variables with a <b>Scale Type</b> of <b>Linear</b>.
| |
| | |
| This property is similar to the <b>Engineering Zero Scale</b> option on the Scaling page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C17
| |
| | [[Variable class/Scaling.Invert property|Scaling.Invert]]
| |
| |If TRUE, LabVIEW inverts the data the server sends before storing it in a shared variable. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| You can use this property for shared variables with a <b>Data Type</b> of <b>Boolean</b>.
| |
| | |
| This property is similar to the <b>Invert</b> option on the Scaling page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C18
| |
| | [[Variable class/Scaling.InvertMask property|Scaling.InvertMask]]
| |
| |Gets or sets the bits that the Shared Variable Engine inverts before storing them in a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| The Shared Variable Engine inverts bits in the mask with value 1 but does not invert bits with value 0. The default invert mask is 0, indicating that the Shared Variable Engine inverts none of the bits. In bitwise logic terminology, the Shared Variable Engine performs an XOR with this value to produce the scaled value.
| |
| | |
| You can use this property for shared variables with a <b>Data Type</b> of <b>U32BitField</b>.
| |
| | |
| This property is similar to the <b>Scaling Invert Mask</b> option on the Scaling page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C13
| |
| | [[Variable class/Scaling.RawMax property|Scaling.RawMax]]
| |
| |Gets or sets the full scale, or maximum value, that the server uses for a shared variable when you use linear or square root scaling. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| You can use this property for shared variables with a <b>Scale Type</b> of <b>Linear</b>.
| |
| | |
| This property is similar to the <b>Raw Full Scale</b> option on the Scaling page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C12
| |
| | [[Variable class/Scaling.RawMin property|Scaling.RawMin]]
| |
| |Gets or sets the zero scale, or minimum value, that the server uses for a shared variable when you use linear or square root scaling. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| You can use this property for shared variables with a <b>Scale Type</b> of <b>Linear</b>.
| |
| | |
| This property is similar to the <b>Raw Zero Scale</b> option on the Scaling page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C19
| |
| | [[Variable class/Scaling.SelectMask property|Scaling.SelectMask]]
| |
| |Gets or sets the bits the Shared Variable Engine uses for a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| The Shared Variable Engine stores bits in the mask with value 1 in the shared variable. The Shared Variable Engine sets bits in the mask with value 0 to 0, regardless of the value received from the server. In bitwise logic terminology, the Shared Variable Engine performs an AND with this value to produce the scaled value.
| |
| | |
| You can use this property for shared variables with a <b>Data Type</b> of <b>U32BitField</b>.
| |
| | |
| This property is similar to the <b>Scaling Select Mask</b> option on the Scaling page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C11
| |
| | [[Variable class/Scaling.Type property|Scaling.Type]]
| |
| |Gets or sets the type of scaling to perform on a shared variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| Valid values are 0 (Linear), 1 (Square Root), 2 (Bitwise), 3 (Invert), and 4 (Custom).
| |
| | |
| Use a value of 0 or 1 for shared variables with a <b>Data Type</b> of <b>Double</b>, <b>Single</b>, or <b>Integer</b>. Use a value of 2 for shared variables with a <b>Data Type</b> of <b>U32BitField</b>. Use a value of 3 for shared variables with a <b>Data Type</b> of <b>Boolean</b>. Use a value of 4 to perform custom scaling on a shared variable.
| |
| | |
| This property is similar to the <b>Scale Type</b> option on the Scaling page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C84
| |
| | [[Variable class/Single-Process.EnableTimestamp property|Single-Process.EnableTimestamp]]
| |
| |If TRUE, a timestamp value is recorded each time the single-process shared variable reads data. (Real-Time, Windows) To view timestamp information and add a <b>timestamp</b> output to the Shared Variable node, right-click the Shared Variable node and select <b>Show Timestamp</b> from the shortcut menu. If this property is FALSE, the <b>timestamp</b> output is hidden. You can use this property only with single-process shared variables. The default value is FALSE.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| | |
| This property is similar to the <b>Enable timestamp</b> checkbox on the Variable page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C72
| |
| | [[Variable class/Time-Triggered.Enabled property|Time-Triggered.Enabled]]
| |
| |If TRUE, LabVIEW enables the deterministic features for a shared variable. The default is FALSE. You can only use this property in the LabVIEW development system, but you must install the LabVIEW Real-Time Module to make this property available.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| | |
| This property is similar to selecting <b>Time-Triggered</b> for the <b>Variable Type</b> option on the Variable page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C78
| |
| | [[Variable class/Time-Triggered.GUID property|Time-Triggered.GUID]]
| |
| |Gets or sets a globally unique identifier for a time-triggered shared variable. You can only use this property in the LabVIEW development system, but you must install the LabVIEW Real-Time Module to make this property available.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C74
| |
| | [[Variable class/Time-Triggered.MaxSize property|Time-Triggered.MaxSize]]
| |
| |Gets or sets the maximum size, in bytes, for the data type of a time-triggered shared variable. You can only use this property in the LabVIEW development system, but you must install the LabVIEW Real-Time Module to make this property available.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C79
| |
| | [[Variable class/Time-Triggered.SMBArrayNumberOfElements property|Time-Triggered.SMBArrayNumberOfElements]]
| |
| |Gets or sets the number of elements in an array or a string for a time-triggered shared variable. You can only use this property in the LabVIEW development system, but you must install the LabVIEW Real-Time Module to make this property available.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| | |
| This property is similar to the <b>Size of the Variable</b> option on the Variable page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C73
| |
| | [[Variable class/Time-Triggered.SMBVariable property|Time-Triggered.SMBVariable]]
| |
| |If TRUE, specifies that the deterministic shared variable is of the shared memory block variety. The default is FALSE. You can only use this property in the LabVIEW development system, but you must install the LabVIEW Real-Time Module to make this property available.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| | |
| This property is similar to the <b>Variable Communication Style</b> option on the Variable page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C75
| |
| | [[Variable class/Time-Triggered.SlotOffset property|Time-Triggered.SlotOffset]]
| |
| |Gets or sets the number of microseconds you want LabVIEW to wait before writing to a slot-based, time-triggered shared variable. You can only use this property in the LabVIEW development system, but you must install the LabVIEW Real-Time Module to make this property available.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| | |
| This property is similar to the <b>Microseconds into the network cycle</b> option on the Variable page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C77
| |
| | [[Variable class/Time-Triggered.TableIndex property|Time-Triggered.TableIndex]]
| |
| |Gets or sets the table index of a time-triggered shared variable. You can only use this property in the LabVIEW development system, but you must install the LabVIEW Real-Time Module to make this property available.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#D1BB80;"
| |
| |4F483C76
| |
| | [[Variable class/Time-Triggered.TransmissionTime property|Time-Triggered.TransmissionTime]]
| |
| |Gets or sets the time, in microseconds, that LabVIEW takes to send a deterministic shared variable. You can only use this property in the LabVIEW development system, but you must install the LabVIEW Real-Time Module to make this property available.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C02
| |
| | [[Variable class/Type property|Type]]
| |
| |Gets or sets the scope of a shared variable.
| |
| | |
| An error occurs if you attempt to set this property when the VI is running.
| |
| | |
| This property is similar to the <b>Variable Type</b> option on the Variable page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C80
| |
| | [[Variable class/UpdateDeadband.Enabled property|UpdateDeadband.Enabled]]
| |
| |Enables the update deadband for a shared variable. If TRUE, LabVIEW updates the value of a shared variable only if the percentage difference between the new value and the previous value equals or exceeds the deadband. The default is FALSE. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| This property is similar to the <b>Enable Update Deadband</b> option on the <b>Update Deadband</b> page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C81
| |
| | [[Variable class/UpdateDeadband.Source property|UpdateDeadband.Source]]
| |
| |Gets or sets the deadband for updating the value of a shared variable when the value for the binding source changes. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| This property is similar to the <b>Source Deadband (% of range)</b> option on the <b>Update Deadband</b> page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483C82
| |
| | [[Variable class/UpdateDeadband.User property|UpdateDeadband.User]]
| |
| |Gets or sets the deadband for updating the value of a shared variable when a user writes data to the variable. To use this property, you must install the LabVIEW Datalogging and Supervisory Control Module.
| |
| | |
| This property is similar to the <b>User Deadband (% of range)</b> option on the <b>Update Deadband</b> page of the Shared Variable Properties dialog box.
| |
| |R/W
| |
| |
| |
| |}
| |
| </div>
| |
| | |
| ==Methods==
| |
| <span class="mw-customtoggle-methodstable">Show/Hide Variable Methods Table</span>
| |
| <div class="mw-collapsible" id="mw-customcollapsible-methodstable">
| |
| {{VIServerLegend|showrte=TRUE}} | |
| {| class="wikitable sortable"
| |
| |+ Variable Methods Table
| |
| ! Method ID
| |
| ! Short Name (English)
| |
| ! Description
| |
| ! RTE
| |
| |- style="background-color:#FFFFCC;"
| |
| |4F483800
| |
| | [[Variable class/DisconnectFromTypedefs method|DisconnectFromTypedefs]]
| |
| |Disconnects the variable from the type definition.
| |
| |X
| |
| |}
| |
| </div>
| |
| | |
| ==Events==
| |
| ''No Events for this class.''
| |
|
| |
|
| == History == | | == History == |
| {{ambox|text=History information is needed. What changes have occured over previous versions?}} | | {{ambox|text=History information is needed. What changes have occurred over previous versions?}} |
| {| class="wikitable" | | {| class="wikitable" |
| ! Version | | ! Version |
| Line 1,397: |
Line 24: |
| *[[VI Server]] | | *[[VI Server]] |
|
| |
|
| [[Category:VI Server]]
| | |
| [[Category:VI Server Class]] | | [[Category:VI Server Class]] |