Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

SharedVariableIO Properties (DSC Module)

LabVIEW 2013 Datalogging and Supervisory Control Module Help

Edition Date: June 2013

Part Number: 371618J-01

»View Product Info
Download Help (Windows Only)

June 2013, 371812F-01

Use these properties to configure shared variables. To use the properties in this class, you must have the LabVIEW Datalogging and Supervisory Control (DSC) Module and DSC Module Run-Time System installed.

If you want to set multiple SharedVariableIO properties at the same time, use the Property Set Mode property. If you do not use the Property Set Mode property in a VI that you are using to set multiple properties, when you run the VI, the VI individually loads each property to the Shared Variable Engine (SVE). This process is time intensive. The Property Set Mode property makes the process less time intensive.

Note  You can enable these properties for network-published shared variables only.
PropertyDescription
Alarming:Alarms EnabledIf TRUE, LabVIEW enables alarming for a shared variable. The default is FALSE. Details
Alarming:Bad Status:Acknowledgement TypeGets or sets how the Bad Status alarm for a shared variable is acknowledged. Details
Alarming:Bad Status:Allow LoggingIf TRUE, LabVIEW enables alarm logging for the Bad Status alarm for a shared variable. The default is FALSE. Details
Alarming:Bad Status:AreaGets or sets a descriptive area name for the Bad Status alarm for a shared variable. Details
Alarming:Bad Status:DescriptionGets or sets the description of the Bad Status alarm for a shared variable. Details
Alarming:Bad Status:EnabledIf TRUE, LabVIEW enables the Bad Status alarm for a shared variable. The default is FALSE. Details
Alarming:Bad Status:NameGets or sets the name of the Bad Status alarm for a shared variable. Details
Alarming:Bad Status:PriorityGets or sets the priority of the Bad Status alarm for a shared variable. Details
Alarming:Boolean:Acknowledgement TypeGets or sets how the Boolean alarm for a shared variable with a Data Type of Boolean is acknowledged. Details
Alarming:Boolean:Alarm OnGets or sets whether a shared variable with a Data Type of Boolean is in alarm state when the value is either high (TRUE) or low (FALSE). Details
Alarming:Boolean:Allow LoggingIf TRUE, LabVIEW enables alarm logging for the Boolean alarm for a shared variable with a Data Type of Boolean. The default is FALSE. Details
Alarming:Boolean:AreaGets or sets a descriptive area name for the Boolean alarm for a shared variable with a Data Type of Boolean. Details
Alarming:Boolean:DescriptionGets or sets the description of the Boolean alarm for a shared variable with a Data Type of Boolean. Details
Alarming:Boolean:EnabledIf TRUE, LabVIEW enables the Boolean alarm for a shared variable with a Data Type of Boolean. The default is FALSE. Details
Alarming:Boolean:NameGets or sets the name of the Boolean alarm for a shared variable with a Data Type of Boolean. Details
Alarming:Boolean:PriorityGets or sets the priority of the Boolean alarm for a shared variable with a Data Type of Boolean. Details
Alarming:EventOnDataChangeIf TRUE, LabVIEW sets an event for a shared variable when data change. The default is FALSE. Details
Alarming:EventOnUserInputOnlyIf TRUE, the value change event is generated on user input only. The default is TRUE. Details
Alarming:Hi:Acknowledgement TypeGets or sets how the HI alarm for a shared variable with a numeric data type is acknowledged. Details
Alarming:Hi:Allow LoggingIf TRUE, LabVIEW enables alarm logging for the HI alarm for a shared variable with a numeric data type. The default is FALSE. Details
Alarming:Hi:AreaGets or sets a descriptive area name for the HI alarm for a shared variable with a numeric data type. Details
Alarming:Hi:DeadbandGets or sets the HI alarm deadband for a shared variable as a percentage of the full scale range. Details
Alarming:Hi:DescriptionGets or sets the description of the HI alarm for a shared variable with a numeric data type. Details
Alarming:Hi:EnabledIf TRUE, LabVIEW enables the HI alarm for a shared variable with a numeric data type. The default is FALSE. Details
Alarming:Hi:LevelGets or sets the value, in engineering units, that evokes the HI alarm condition for a shared variable with a numeric data type. Details
Alarming:Hi:NameGets or sets the name of the HI alarm for a shared variable with a numeric data type. Details
Alarming:Hi:PriorityGets or sets the priority of the HI alarm for a shared variable with a numeric data type. Details
Alarming:HiHi:Acknowledgement TypeGets or sets how the HI_HI alarm for a shared variable with a numeric data type is acknowledged. Details
Alarming:HiHi:Allow LoggingIf TRUE, LabVIEW enables alarm logging for the HI_HI alarm for a shared variable with a numeric data type. The default is FALSE. Details
Alarming:HiHi:AreaGets or sets a descriptive area name for the HI_HI alarm for a shared variable with a numeric data type. Details
Alarming:HiHi:DeadbandGets or sets the HI_HI alarm deadband for a shared variable as a percentage of the full scale range. Details
Alarming:HiHi:DescriptionGets or sets the description of the HI_HI alarm for a shared variable with a numeric data type. Details
Alarming:HiHi:EnabledIf TRUE, LabVIEW enables the HI_HI alarm for a shared variable with a numeric data type. The default is FALSE. Details
Alarming:HiHi:LevelGets or sets the value, in engineering units, that evokes the HI_HI alarm condition for a shared variable with a numeric data type. Details
Alarming:HiHi:NameGets or sets the name of the HI_HI alarm for a shared variable with a numeric data type. Details
Alarming:HiHi:PriorityGets or sets the priority of the HI_HI alarm for a shared variable with a numeric data type. Details
Alarming:Lo:Acknowledgement TypeGets or sets how the LO alarm for a shared variable with a numeric data type is acknowledged. Details
Alarming:Lo:Allow LoggingIf TRUE, LabVIEW enables alarm logging for the LO alarm for a shared variable with a numeric data type. The default is FALSE. Details
Alarming:Lo:AreaGets or sets a descriptive area name for the LO alarm for a shared variable with a numeric data type. Details
Alarming:Lo:DeadbandGets or sets the LO alarm deadband for a shared variable as a percentage of the full scale range. Details
Alarming:Lo:DescriptionGets or sets the description of the LO alarm for a shared variable with a numeric data type. Details
Alarming:Lo:EnabledIf TRUE, LabVIEW enables the LO alarm for a shared variable with a numeric data type. The default is FALSE. Details
Alarming:Lo:LevelGets or sets the value, in engineering units, that evokes the LO alarm condition for a shared variable with a numeric data type. Details
Alarming:Lo:NameGets or sets the name of the LO alarm for a shared variable with a numeric data type. Details
Alarming:Lo:PriorityGets or sets the priority of the LO alarm for a shared variable with a numeric data type. Details
Alarming:LoLo:Acknowledgement TypeGets or sets how the LO_LO alarm for a shared variable with a numeric data type is acknowledged. Details
Alarming:LoLo:Allow LoggingIf TRUE, LabVIEW enables alarm logging for the LO_LO alarm for a shared variable with a numeric data type. The default is FALSE. Details
Alarming:LoLo:AreaGets or sets a descriptive area name for the LO_LO alarm for a shared variable with a numeric data type. Details
Alarming:LoLo:DeadbandGets or sets the LO_LO alarm deadband for a shared variable as a percentage of the full scale range. Details
Alarming:LoLo:DescriptionGets or sets the description of the LO_LO alarm for a shared variable with a numeric data type. Details
Alarming:LoLo:EnabledIf TRUE, LabVIEW enables the LO_LO alarm for a shared variable with a numeric data type. The default is FALSE. Details
Alarming:LoLo:LevelGets or sets the value, in engineering units, that evokes the LO_LO alarm condition for a shared variable with a numeric data type. Details
Alarming:LoLo:NameGets or sets the name of the LO_LO alarm for a shared variable with a numeric data type. Details
Alarming:LoLo:PriorityGets or sets the priority of the LO_LO alarm for a shared variable with a numeric data type. Details
Alarming:Rate Of Change:Acknowledgement TypeGets or sets how the Rate of Change alarm for a shared variable is acknowledged. Details
Alarming:Rate Of Change:Allow LoggingIf TRUE, LabVIEW enables alarm logging for the Rate of Change alarm for a shared variable. The default is FALSE. Details
Alarming:Rate Of Change:AreaGets or sets a descriptive area name for the Rate of Change alarm for a shared variable. Details
Alarming:Rate Of Change:ChangeGets or sets the value that a shared variable value must change in the specified time to trigger the Rate of Change alarm. Details
Alarming:Rate Of Change:DescriptionGets or sets the description of the Rate of Change alarm for a shared variable. Details
Alarming:Rate Of Change:EnabledIf TRUE, LabVIEW enables the Rate of Change alarm for a shared variable. The default is FALSE. Details
Alarming:Rate Of Change:NameGets or sets the name of the Rate of Change alarm for a shared variable. Details
Alarming:Rate Of Change:PriorityGets or sets the priority of the Rate of Change alarm for a shared variable. Details
Alarming:Rate Of Change:TimeGets or sets the amount of time, in milliseconds, in which a shared variable value must change at least the value of the Alarming:Rate Of Change:Change property to trigger the Rate of Change alarm. Details
Alarming:U32 Bit Field:Acknowledgement TypeGets or sets how the U32 Bit Field alarm for a shared variable with a Data Type of U32 Bit Field is acknowledged. Details
Alarming:U32 Bit Field:Alarm OnGets or sets whether a shared variable with a Data Type of U32 Bit Field generates an alarm when any bit (1) is in alarm state or only when all bits (0) are in alarm state. Details
Alarming:U32 Bit Field:Allow LoggingIf TRUE, LabVIEW enables alarm logging for the U32 Bit Field alarm for a shared variable with a Data Type of U32 Bit Field. The default is FALSE. Details
Alarming:U32 Bit Field:AreaGets or sets a descriptive area name for the U32 Bit Field alarm for a shared variable with a Data Type of U32 Bit Field. Details
Alarming:U32 Bit Field:DescriptionGets or sets the description of the U32 Bit Field alarm for a shared variable with a Data Type of U32 Bit Field. Details
Alarming:U32 Bit Field:EnabledIf TRUE, LabVIEW enables the U32 Bit Field alarm for a shared variable with a Data Type of U32 Bit Field. The default is FALSE. Details
Alarming:U32 Bit Field:Invert MaskGets or sets which bits of a shared variable with a Data Type of U32 Bit Field alarm on high, 1, and which bits alarm on low, 0. Details
Alarming:U32 Bit Field:NameGets or sets the name of the U32 Bit Field alarm for a shared variable with a Data Type of U32 Bit Field. Details
Alarming:U32 Bit Field:PriorityGets or sets the priority of the U32 Bit Field alarm for a shared variable with a Data Type of U32 Bit Field. Details
Alarming:U32 Bit Field:Select MaskGets or sets which bits LabVIEW uses to calculate the alarm for a shared variable with a Data Type of U32 Bit Field. Details
Data TypeReturns the data type of a shared variable. Details
DataSocket URLReturns the URL path to a shared variable on a DataSocket Server. Details
DescriptionGets or sets the description of a shared variable. Details
FullURLReturns the full URL path to a shared variable. Details
Initial Value:BooleanGets or sets the initial value for a shared variable with a Data Type of Boolean. Details
Initial Value:DoubleGets or sets the initial value for a shared variable with a Data Type of Double. Details
Initial Value:EnabledIf TRUE, you can set an initial value for a shared variable. The default is FALSE. Details
Initial Value:Int8Gets or sets the initial value for a shared variable with a Data Type of Int8. Details
Initial Value:Int16Gets or sets the initial value for a shared variable with a Data Type of Int16. Details
Initial Value:Int32Gets or sets the initial value for a shared variable with a Data Type of Int32. Details
Initial Value:Int64Gets or sets the initial value for a shared variable with a Data Type of Int64. Details
Initial Value:SingleGets or sets the initial value for a shared variable with a Data Type of Single. Details
Initial Value:StringGets or sets the initial value for a shared variable with a Data Type of String. Details
Initial Value:U32 Bit FieldGets or sets the initial value for a shared variable with a Data Type of U32 Bit Field. Details
Initial Value:UInt8Gets or sets the initial value for a shared variable with a Data Type of UInt8. Details
Initial Value:UInt16Gets or sets the initial value for a shared variable with a Data Type of UInt16. Details
Initial Value:UInt32Gets or sets the initial value for a shared variable with a Data Type of UInt32. Details
Initial Value:UInt64Gets or sets the initial value for a shared variable with a Data Type of UInt64. Details
LoadedIndicates whether a shared variable is in a loaded process. The default is FALSE. Details
Logging:EnabledIf TRUE, LabVIEW enables logging for a shared variable. The default is FALSE. Details
Logging:Log Alarms and EventsIf TRUE, LabVIEW logs alarms and events for a shared variable. The default is FALSE. Details
Logging:Log DataIf TRUE, LabVIEW logs historical data for a shared variable. The default is FALSE. Details
Logging:String Logging FormatGets or sets the format in which LabVIEW logs strings in the Citadel historical database. Details
Logging:Value DeadbandGets or sets the deadband for logging a shared variable in the Citadel historical database. Details
Logging:Value ResolutionGets or sets the resolution, in engineering units, for logging the shared variable value in the Citadel historical database. Details
NameGets the shared variable name. Details
Network:Access TypeSpecifies whether a shared variable reads, writes, or reads and writes data. Details
Network:Buffer Size LimitGets or sets the size, in bytes, of the network buffer. Details
Network:Buffer Value LimitGets or sets the size, in number of elements, of the network buffer. Details
Network:Connection TypeSets when a shared variable makes a connection to the data source. Details
Network:Single WriterSets the shared variable to accept changes in value from only one target at a time. Details
Network:URLGets 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. Details
Network:Use BindingIf TRUE, LabVIEW binds a shared variable to the URL that the Network:URL property specifies. The default is FALSE. Details
Network:Use BufferingIf TRUE, LabVIEW enables buffering for a shared variable. The default is FALSE. Details
ProcessReturns the process from which a shared variable receives data. Details
Property Set ModeSets the property mode for a shared variable. Details
RunningIndicates whether a shared variable exists and is in a running process. The default is FALSE. Details
Scaling:CoerceIf TRUE, LabVIEW coerces the shared variable data to a range you specify. The default is FALSE. Details
Scaling:EnabledIf TRUE, LabVIEW scales the shared variable. The default is FALSE. Details
Scaling:Engineering Full ScaleGets 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 scaling. Details
Scaling:Engineering Zero ScaleGets 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 scaling. Details
Scaling:InvertIf TRUE, LabVIEW inverts the data the server sends before storing it in a shared variable. The default is FALSE. Details
Scaling:Invert MaskGets or sets the 32-bit value with which the Shared Variable Engine performs an XOR operation to produce the scaled value of a shared variable. Details
Scaling:Numeric Scaling TypeGets or sets the type of scaling to perform on a shared variable. Details
Scaling:Raw Full ScaleGets or sets the full scale, or maximum value, that the server uses for a shared variable when you use linear scaling. Details
Scaling:Raw Zero ScaleGets or sets the zero scale, or minimum value, that the server uses for a shared variable when you use linear scaling. Details
Scaling:Select MaskGets or sets the 32-bit value with which the Shared Variable Engine performs an AND operation to produce the scaled value of a shared variable. Details
Scaling:UnitsGets or sets the type of units a shared variable represents. Details
Update Deadband:EnabledEnables 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. Details
Update Deadband:SourceGets or sets the deadband for updating the value of a shared variable when the value of the binding source changes. Details
Update Deadband:UserGets or sets the deadband for updating the value of a shared variable when a user writes data to the variable. Details

© 2005–2013 National Instruments. All rights reserved.


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit