Name | Description | |
---|---|---|
UADataVariable Constructor | Overloaded. |
The following tables list the members exposed by UADataVariable.
Name | Description | |
---|---|---|
UADataVariable Constructor | Overloaded. |
Name | Description | |
---|---|---|
DefaultAccessLevels | Default value of the AccessLevels property. Equals to OpcLabs.EasyOpc.UA.UAAccessLevels.CurrentReadAndWrite. | |
DefaultBuiltInType | Default value of the BuiltInType property. Equals to OpcLabs.EasyOpc.UA.UABuiltInType.Variant. |
Name | Description | |
---|---|---|
AccessLevels | The access levels of this variable (e.g. readable, writable). | |
AreDataSubscribed | Determines whether there is currently any data subscription to this data variable. | |
ArrayDimensions | The size of each dimension of the array value. | |
BuiltInType | The built-in type of this variable. | |
Container | (Inherited from System.ComponentModel.Component) | |
CustomReference | Can be used to distinguish otherwise equal widgets. (Inherited from OpcLabs.BaseLib.Widgets.Widget) | |
DataSubscriptionCount | The current number of data subscriptions to this data variable. | |
DataSubscriptionSet | The current set of data subscriptions to this data variable. | |
DataTypeId | Specifies the OPC UA data type of the variable value. | |
DeclarationString | Overridden. Describes the basic external characteristics of the node, such as its name. | |
EffectiveNodeDescriptor | The effective node descriptor by which this node is addressable in the OPC UA server. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
HandleChildNodes | Overridden. Determines whether the events from child nodes will be handled on this node as well. | |
IsBranch | Determines whether this node is a branch. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
IsClsCompliant | Determines whether the value type of the OPC variable is CLS-compliant. | |
IsLeaf | Determines whether this node is a leaf. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
IsReadable | Determines whether the variable data is readable. | |
IsRoot | Determines whether this node is a root. (Inherited from OpcLabs.BaseLib.NodeSpace.Node) | |
IsStarted | Determines whether the component is currently started. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
IsWritable | Determines whether the variable value is writable. | |
Item | Indexer to get a sub-node by name. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
MinimumSamplingInterval | Specifies the minimum sampling interval that can be provided for this data variable. In milliseconds. | |
Name | The name of this node in the node space. (Inherited from OpcLabs.BaseLib.NodeSpace.Node) | |
NodeKind | Overridden. Determines whether the node is a data variable, folder, or a root. | |
Nodes | A collection of sub-nodes in this node (branch). (Inherited from OpcLabs.BaseLib.NodeSpace.Node) | |
ParentNode | The server node that is the parent of this node. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
PropagateConversionError | Determines whether UAServerNode.ConversionError events propagate to the parent node (defaults to True). (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
PropagateDataSubscriptionChanged | Determines whether UAServerNode.DataSubscriptionChanged events propagate to the parent node (defaults to True). (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
PropagateRead | Determines whether UAServerNode.Read events propagate to the parent node (defaults to True). (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
PropagateSamplingIntervalChanged | Determines whether UAServerNode.SamplingIntervalChanged events propagate to the parent node (defaults to True). (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
PropagateWrite | Determines whether UAServerNode.Write events propagate to the parent node (defaults to True). (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
ReadAttributeData | The variable data (value, timestamp, status code) seen by OPC reads. | |
SamplingInterval | The current sampling interval, computed as the shortest of the sampling intervals of current data subscriptions. In milliseconds. | |
Site | (Inherited from System.ComponentModel.Component) | |
State | An arbitrary object associated with the node. (Inherited from OpcLabs.BaseLib.NodeSpace.Node) | |
UseDataPolling | Determines whether data polling (internally invoked reads) will be used to handle data subscriptions to this variable. | |
ValueRank | The OPC UA value rank of the variable value. | |
WritableSourceTimestamp | Determines whether the source timestamp of the variable is writable. | |
WritableStatusCode | Determines whether the status code of the variable is writable. | |
WriteAttributeData | The variable data (value, timestamp, status code) modified by OPC writes. | |
WriteLoopback | Determines whether successfully written data will become the read data for subsequent operations. |
Name | Description | |
---|---|---|
CanRaiseEvents | (Inherited from System.ComponentModel.Component) | |
DesignMode | (Inherited from System.ComponentModel.Component) | |
Events | (Inherited from System.ComponentModel.Component) | |
IsLocked | Determines whether the node is locked. (Inherited from OpcLabs.BaseLib.NodeSpace.Node) | |
ServiceContainer | The service container provided by this widget to inheritors. (Inherited from OpcLabs.BaseLib.Widgets.Widget) | |
ValidBranchTypeList | Overridden. The types of branch sub-nodes that can be added to this node. | |
ValidLeafTypeList | Overridden. The types of leaf sub-nodes that can be added to this node. |
Name | Description | |
---|---|---|
Add | Adds a sub-node to this node. (Inherited from OpcLabs.BaseLib.NodeSpace.Node) | |
Clear | Removes all sub-nodes. (Inherited from OpcLabs.BaseLib.NodeSpace.Node) | |
Clone | Overridden. | |
CreateIn | Overloaded. Creates and returns a data variable (with given name) in the specified parent data variable. | |
CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject) | |
Dispose | Overloaded. (Inherited from OpcLabs.BaseLib.NodeSpace.NodeFrontEnd) | |
Equals | Overloaded. Overridden. Determines whether the specified object is equal to the current object. | |
GetEnumerator | (Inherited from OpcLabs.BaseLib.NodeSpace.Node) | |
GetHashCode | Overridden. Serves as the default hash function. | |
GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject) | |
GetNewNodeNameBase | Infrastructure. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
GetObjectData | (Inherited from OpcLabs.BaseLib.NodeSpace.NodeFrontEnd) | |
GetSchema | (Inherited from OpcLabs.BaseLib.Widgets.Widget) | |
GetService | (Inherited from OpcLabs.BaseLib.Widgets.Widget) | |
GetTreeTraverser | Returns a tree traverser that iterates through the tree. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
GetType | Gets the System.Type of the current instance. (Inherited from object) | |
InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject) | |
Lock | Locks the node. (Inherited from OpcLabs.BaseLib.NodeSpace.Node) | |
ReadXml | (Inherited from OpcLabs.BaseLib.Widgets.Widget) | |
Remove | Removes the specified sub-node from this node. (Inherited from OpcLabs.BaseLib.NodeSpace.Node) | |
ToString | (Inherited from OpcLabs.BaseLib.NodeSpace.Node) | |
Unlock | Unlocks the node. (Inherited from OpcLabs.BaseLib.NodeSpace.Node) | |
UpdateReadAttributeData | Overloaded. Updates the value of the data variable as seen by OPC reads, and sets its source timestamp to the current time. | |
UpdateWriteAttributeData | Updates the write attribute data. | |
ValueEquals | Overloaded. Determines whether the specified OpcLabs.BaseLib.NodeSpace.NodeFrontEnd is value equal to the current object. (Inherited from OpcLabs.BaseLib.NodeSpace.NodeFrontEnd) | |
WriteXml | (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
Name | Description | |
---|---|---|
Finalize | (Inherited from System.ComponentModel.Component) | |
MemberwiseClone | Overloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject) | |
OnAreDataSubscribedChanged | Called when the value of the AreDataSubscribed property has changed. | |
OnContextTypesChanged | Infrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget) | |
OnConversionError | Raises the UAServerNode.ConversionError event, indicating when data cannot be converted from Read, for Write, or in IUADataSubscription.OnNext. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
OnDataSubscriptionChanged | Overloaded. Called when a data subscription has been added to, removed from, or modified in the DataSubscriptionSet of this data variable. | |
OnFirstUnlock | Called when the lock count becomes non-zero. (Inherited from OpcLabs.BaseLib.NodeSpace.NodeFrontEnd) | |
OnLastUnlock | Called when the lock count becomes zero. (Inherited from OpcLabs.BaseLib.NodeSpace.NodeFrontEnd) | |
OnNodeBackEndChange | Called after the branch back-end has changed. (Inherited from OpcLabs.BaseLib.NodeSpace.NodeFrontEnd) | |
OnRead | Raises the UAServerNode.Read event to obtain the data for OPC UA read. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
OnReadAttributeDataChanged | Called when the value of the ReadAttributeData property has changed. | |
OnSamplingIntervalChanged | Overloaded. Called when the value of the SamplingInterval property has changed. | |
OnStarting | Raises the UAServerNode.Starting event, indicating when the component is starting. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
OnStopped | Raises the UAServerNode.Stopped event, indicating when the component has stopped. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
OnWrite | Raises the UAServerNode.Write event, supplying the OPC UA write data. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
OnWriteAttributeDataChanged | Called when the value of the WriteAttributeData property has changed. | |
ReadXmlElement | Infrastructure. (Inherited from OpcLabs.BaseLib.NodeSpace.NodeFrontEnd) | |
WriteXmlElement | Infrastructure. (Inherited from OpcLabs.BaseLib.NodeSpace.NodeFrontEnd) |
Name | Description | |
---|---|---|
Constant | Overloaded. Modifies the data variable to provide the specified constant attribute data (value, status code, timestamp), non-writable.
For reads and subscriptions, the data variable will provide always the same data, specified in this method call. The data variable will not be writable. | |
ConstantValue | Overloaded. Modifies the data variable to provide the specified constant value, non-writable.
For reads and subscriptions, the data variable will provide always the same value, specified in this method call. The data variable will not be writable. The status code will be "Good", and the timestamp will be the current time of this method call. | |
ProcessRead | Specifies that reads of this data variable will be processed by the specified read function. | |
ProcessWrite | Specifies that writes of this data variable will be processed by the specified write function. | |
Readable | Overloaded. Makes the data variable readable. | |
ReadFunction | Overloaded. Modifies the data variable to provide attribute data for the pull data provision model by a specified function.
This method always makes the data variable readable, but that does not mean it automatically makes it non-writable. If you need a data variable that is readable and non-writable, combine this method with calling Writable(UADataVariable,Boolean) method with the 'writable' parameter set to | |
ReadValueFunction | Overloaded. Modifies the data variable to provide value for the pull data provision model by a specified function.
This method always makes the data variable readable, but that does not mean it automatically makes it non-writable. If you need a data variable that is readable and non-writable, combine this method with calling Writable(UADataVariable,Boolean) method with the 'writable' parameter set to The status code will be "Good", and the timestamp will be the current time after the read function has been called. | |
ReadWrite | Overloaded. Modifies the data variable to behave as read-write register, with specified initial attribute data (value, status code, timestamp).
This method makes the data variable both readable and writable. The data written to the data variable will become the data subsequently read from the data variable. This method also makes the status code and source timestamp of the data variable writable, i.e. OPC UA clients will be able to modify their values. If you need a different behavior, call the Writable(UADataVariable,Boolean,Boolean,Boolean) method subsequently, with desired parameters, or modify the UADataVariable.WritableStatusCode and/or UADataVariable.WritableSourceTimestamp accordingly (set one or both to In order to make a read-write register of certain type, but without having to specify initial data, consider simply using one of the ValueType(UADataVariable,Type) overloads. | |
ReadWriteValue | Overloaded. Modifies the data variable to behave as read-write register, with specified initial value.
This method makes the data variable both readable and writable. The data written to the data variable will become the data subsequently read from the data variable. This method keeps the settings of UADataVariable.WritableStatusCode and UADataVariable.WritableSourceTimestamp. This means that by default, the status code and source timestamp of the data variable will not writable. i.e. OPC UA clients will not be able to modify them. If you need a different behavior, call the Writable(UADataVariable,Boolean,Boolean,Boolean) method subsequently, with desired parameters, or modify the UADataVariable.WritableStatusCode and/or UADataVariable.WritableSourceTimestamp accordingly (set one or both to In order to make a read-write register of certain type, but without having to specify initial data, consider simply using one of the ValueType(UADataVariable,Type) overloads. | |
SetArrayDimensions | Sets the array dimensions of this data variable. | |
SetArrayRank | Sets the array rank of this data variable. | |
SetMinimumSamplingInterval | Sets the minimum sampling interval of this data variable. | |
SetState<TNode> | Sets the arbitrary object associated with the node. | |
UpdateWriteAttributeData | Updates the write attribute data with given value, and current time for the timestamp. | |
ValueType | Overloaded. Modifies the data variable to use certain value type. | |
Writable | Overloaded. Makes the data variable writable. | |
WriteFunction | Overloaded. Modifies the data variable for consuming attribute data by a specified function, for the push data consumption model.
This method always makes the data variable writable, including its status code and source timestamp, i.e. OPC UA clients will be able to modify them. If you need a different behavior, call the Writable(UADataVariable,Boolean,Boolean,Boolean) method subsequently, with desired parameters, or modify the UADataVariable.WritableStatusCode and/or UADataVariable.WritableSourceTimestamp accordingly (set one or both to This method does not change the readability access of the data variable. By default, data variables are readable. If you need a data variable that is writable but non-readable, combine this method with calling Readable(UADataVariable,Boolean) method with the 'readable' parameter set to The write function returns a OpcLabs.EasyOpc.UA.UAStatusCode that indicates the outcome of the OPC UA write operation. The WriteFunction(UADataVariable,Type,Func<UAAttributeData,UAStatusCode>) method overloads are the most generic extensions methods for writing. If you only need to deal with the data variable value (and not its status code and/or timestamp), consider using one of the WriteValueFunction<TValue>(UADataVariable,Type,Func<TValue,UAStatusCode>) or WriteValueAction<TValue>(UADataVariable,Type,Action<TValue>) method overloads, for shorter code and easier programming. | |
WriteValueAction | Overloaded. Modifies the data variable for consuming values by a specified action, for the push data consumption model.
This method always makes the data variable writable; however, its status code and source timestamp will not be writable, i.e. OPC UA clients will not be able to modify them. If you need a different behavior, use one of the WriteFunction(UADataVariable,Type,Func<UAAttributeData,UAStatusCode>) method overloads instead. This method does not change the readability access of the data variable. By default, data variables are readable. If you need a data variable that is writable but non-readable, combine this method with calling Readable(UADataVariable,Boolean) method with the 'readable' parameter set to Unless the write value action throws a OpcLabs.EasyOpc.UA.UAStatusCodeException, a "Good" status code will be returned as the outcome of the OPC UA write operation. If the write value action function throws OpcLabs.EasyOpc.UA.UAStatusCodeException, the OpcLabs.EasyOpc.UA.UAStatusCodeException.StatusCode of the exception will become the outcome of the OPC UA write operation. For performance reasons, however, if you want to return status codes other than "Good" as OPC UA write operation outcomes, it is recommended that you use one of the WriteValueFunction<TValue>(UADataVariable,Type,Func<TValue,UAStatusCode>) method overloads instead. With these methods, you specify a write value function that returns the OpcLabs.EasyOpc.UA.UAStatusCode that is the OPC UA write operation outcome, allowing the status code be passed without the ineffective throwing and catching of the OpcLabs.EasyOpc.UA.UAStatusCodeException. | |
WriteValueFunction | Overloaded. Modifies the data variable for consuming values by a specified function, for the push data consumption model.
This method always makes the data variable writable; however, its status code and source timestamp will not be writable, i.e. OPC UA clients will not be able to modify them. If you need a different behavior, use one of the WriteFunction(UADataVariable,Type,Func<UAAttributeData,UAStatusCode>) method overloads instead. This method does not change the readability access of the data variable. By default, data variables are readable. If you need a data variable that is writable but non-readable, combine this method with calling Readable(UADataVariable,Boolean) method with the 'readable' parameter set to The write function returns a OpcLabs.EasyOpc.UA.UAStatusCode that indicates the outcome of the OPC UA write operation. If the outcome of your write operation should always be "Good", you can make your code a bit simpler by using one of WriteValueAction<TValue>(UADataVariable,Type,Action<TValue>) method overloads instead. |
Name | Description | |
---|---|---|
ConversionError | Raised when data cannot be converted from Read, for Write, or in data subscription's OpcLabs.BaseLib.ISink<T>.OnNext. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
DataSubscriptionChanged | Raised when data subscription has been added, removed, or modified. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
Disposed | (Inherited from System.ComponentModel.Component) | |
PropertyChanged | (Inherited from OpcLabs.BaseLib.NodeSpace.Node) | |
PropertyChanging | (Inherited from OpcLabs.BaseLib.NodeSpace.Node) | |
Read | Raised to obtain the OPC UA read data. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
SamplingIntervalChanged | Raised when the sampling interval of a data variable has changed. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
Starting | Raised when the component is starting. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
Stopped | Raised when the component has stopped. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) | |
Write | Raised to supply the OPC UA write data. (Inherited from OpcLabs.EasyOpc.UA.NodeSpace.UAServerNode) |
Equality | Determines whether the two objects are equal. |
Inequality | Determines whether the two objects are not equal. |