| Name | Description | |
|---|---|---|
![]() | SparkplugMetric Constructor | Overloaded. Initializes a new instance of the class. |
The following tables list the members exposed by SparkplugMetric.
| Name | Description | |
|---|---|---|
![]() | SparkplugMetric Constructor | Overloaded. Initializes a new instance of the class. |
| Name | Description | |
|---|---|---|
![]() | DefaultDataType | The default value of DataType property.
This is a constant, and its value is |
![]() | DefaultIsReadable | The default value of IsReadable property.
This is a constant, and its value is |
![]() | DefaultIsWritable | The default value of IsWritable property.
This is a constant, and its value is |
![]() | DefaultName | The default value of Name property.
This is a constant, and its value is |
![]() | DefaultPropagateRead | The default value of PropagateRead property.
This is a constant, and its value is |
![]() | DefaultPropagateWrite | The default value of PropagateWrite property.
This is a constant, and its value is |
![]() | DefaultWritableTimestamp | The default value of WritableTimestamp property.
This is a constant, and its value is |
![]() | DefaultWriteLoopback | The default value of WriteLoopback property.
This is a constant, and its value is |
| Name | Description | |
|---|---|---|
![]() | Container | (Inherited from System.ComponentModel.Component) |
![]() | CustomReference | Can be used to distinguish otherwise equal widgets. (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
![]() | DataType | Specifies the Sparkplug data type of the metric value. |
![]() | DeclarationString | Describes the basic external characteristics of the metric, such as its name. |
![]() | Device | The device this metric belongs to, if available. |
![]() | EdgeNode | The edge node this metric belongs to, if available. |
![]() | IsReadable | Determines whether the metric data is readable. |
![]() | IsStarted | Determines whether the component is currently started. |
![]() | IsValid | Determines whether the configuration of this metric is valid. |
![]() | IsWritable | Determines whether the metric data is writable. |
![]() | Name | The friendly name of this metric. |
![]() | PropagateRead | Determines whether Read events propagate to the parent node (defaults to True). |
![]() | PropagateWrite | Determines whether Write events propagate to the parent node (defaults to True). |
![]() | ReadData | The metric data (value, timestamp) used for publishing. |
![]() | Site | (Inherited from System.ComponentModel.Component) |
![]() | State | An arbitrary object associated with the metric. |
![]() | WritableTimestamp | Determines whether the timestamp of the metric is writable. |
![]() | WriteData | The metric data (value, timestamp) modified by Sparkplug commands. |
![]() | 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) |
![]() | IsDisposed | Determines whether the object has been disposed. (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
![]() | ServiceContainer | The service container provided by this widget to inheritors. (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
| Name | Description | |
|---|---|---|
![]() | Clone | Overridden. |
![]() ![]() | CreateIn | Overloaded. Creates and returns a metric (with given name) in the specified edge node. |
![]() | 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.Widgets.Widget) |
![]() | Equals | (Inherited from object) |
![]() | GetHashCode | Serves as the default hash function. (Inherited from object) |
![]() | GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject) |
![]() | GetObjectData | Overridden. |
![]() | GetSchema | (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
![]() | GetService | (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
![]() | 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) |
![]() | PerformPoll | Performs a poll operation on the metric. |
![]() | PerformRead | Performs a read operation on the metric. |
![]() | PerformWrite | Performs a write operation on the metric. |
![]() | ReadXml | (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
![]() | ToString | Overridden. |
![]() | UpdateReadData | Updates the value of the metric (used for publishing), and sets its timestamp to the current time. |
![]() | UpdateWriteData | Updates the write data. |
![]() | ValueEquals | Overloaded. Defines a generalized method that classes must implement to create type-specific method for determining value equality of instances. Determines whether this instance has the same value as a given other instance. (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
![]() | 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) |
![]() | OnContextTypesChanged | Infrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
![]() | OnRead | Raises the Read event to obtain the metric read data. |
![]() | OnReadDataChanged | Called when the value of the ReadData property has changed. |
![]() | OnStarting | Raises the Starting event, indicating when the component is starting. |
![]() | OnStopped | Raises the Stopped event, indicating when the component has stopped. |
![]() | OnWrite | Raises the Write event, supplying the metric write data. |
![]() | OnWriteDataChanged | Called when the value of the WriteData property has changed. |
![]() | ReadXmlElement | Infrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
![]() | WriteXmlElement | Infrastructure. (Inherited from OpcLabs.BaseLib.Widgets.Widget) |
| Name | Description | |
|---|---|---|
![]() | Constant | Overloaded. Modifies the metric to provide the specified constant data (value, timestamp), non-writable.
The metric will not be writable. |
![]() | ConstantValue | Overloaded. Modifies the metric to provide the specified constant value, non-writable.
The metric will not be writable. The timestamp will be the current time of this method call. |
![]() | ProcessRead | Specifies that reads of this metric will be processed by the specified read function. |
![]() | ProcessWrite | Specifies that writes of this metric will be processed by the specified write function. |
![]() | Readable | Overloaded. Makes the metric readable. |
![]() | ReadFunction | Overloaded. Modifies the metric to provide Sparkplug data for the pull data provision model by a specified function.
This method always makes the metric readable, but that does not mean it automatically makes it non-writable. If you need a metric that is readable and non-writable, combine this method with calling Writable(SparkplugMetric,Boolean) method with the 'writable' parameter set to |
![]() | ReadValueFunction | Overloaded. Modifies the metric to provide value for the pull data provision model by a specified function.
This method always makes the metric readable, but that does not mean it automatically makes it non-writable. If you need a metric that is readable and non-writable, combine this method with calling Writable(SparkplugMetric,Boolean) method with the 'writable' parameter set to |
![]() | ReadWrite | Overloaded. Modifies the metric to behave as read-write register, with specified initial data (value, timestamp).
This method makes the metric both readable and writable. The data written to the metric will become the data subsequently read from the metric. This method also makes the timestamp of the metric writable, i.e. Sparkplug host applications will be able to modify its value. If you need a different behavior, call the Writable(SparkplugMetric,Boolean) method subsequently, with the desired parameter, or modify the WritableTimestamp accordingly (set it 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(SparkplugMetric,Type) overloads. |
![]() | ReadWriteValue | Overloaded. Modifies the metric to behave as read-write register, with specified initial value.
This method makes the metric both readable and writable. The data written to the metric will become the data subsequently read from the metric. This method keeps the settings of WritableTimestamp. This means that by default, the timestamp of the metric will not writable. i.e. Sparkplug host applications will not be able to modify it. If you need a different behavior, call the Writable(SparkplugMetric,Boolean) method subsequently, with desired parameter, or modify the WritableTimestamp 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(SparkplugMetric,Type) overloads. |
![]() | SetState<TNode> | Sets the arbitrary object associated with the node. |
![]() | SetState | Sets the arbitrary object associated with the metric. |
![]() | ValueType | Overloaded. Modifies the metric to use certain value type. |
![]() | Writable | Overloaded. Makes the metric writable. |
![]() | WriteFunction | Overloaded. Modifies the metric for consuming Sparkplug data by a specified function, for the push data consumption model.
This method always makes the metric writable, including its timestamp, i.e. Sparkplug host applications will be able to modify them. If you need a different behavior, call the Writable(SparkplugMetric,Boolean) method subsequently, with desired parameter, or modify the WritableTimestamp accordingly (set it to This method does not change the readability access of the metric. By default, metrics are readable. If you need a metric that is writable but non-readable, combine this method with calling Readable(SparkplugMetric,Boolean) method with the 'readable' parameter set to The write function returns a boolean value that indicates the outcome of the Sparkplug write operation. The WriteFunction(SparkplugMetric,Type,Func<SparkplugData,Boolean>) method overloads are the most generic extensions methods for writing. If you only need to deal with the metric value (and not its timestamp), consider using one of the WriteValueFunction<TValue>(SparkplugMetric,Type,Func<TValue,Boolean>) or WriteValueAction<TValue>(SparkplugMetric,Type,Action<TValue>) method overloads, for shorter code and easier programming. |
![]() | WriteValueAction | Overloaded. Modifies the metric for consuming values by a specified action, for the push data consumption model.
This method always makes the metric writable; however, its timestamp will not be writable, i.e. Sparkplug host applications will not be able to modify them. If you need a different behavior, use one of the WriteFunction(SparkplugMetric,Type,Func<SparkplugData,Boolean>) method overloads instead. This method does not change the readability access of the metric. By default, metrics are readable. If you need a metric that is writable but non-readable, combine this method with calling Readable(SparkplugMetric,Boolean) method with the 'readable' parameter set to The write operation defined by this method always succeeds. If you need support the option of failing the write operation to fail, use one of the WriteValueFunction<TValue>(SparkplugMetric,Type,Func<TValue,Boolean>) method overloads instead. |
![]() | WriteValueFunction | Overloaded. Modifies the metric for consuming values by a specified function, for the push data consumption model.
This method always makes the metric writable; however, its timestamp will not be writable, i.e. Sparkplug host application will not be able to modify them. If you need a different behavior, use one of the WriteFunction(SparkplugMetric,Type,Func<SparkplugData,Boolean>) method overloads instead. This method does not change the readability access of the metric. By default, metrics are readable. If you need a metric that is writable but non-readable, combine this method with calling Readable(SparkplugMetric,Boolean) method with the 'readable' parameter set to The write function returns a boolean that indicates the outcome of the Sparkplug write operation. If the outcome of your write operation should always be successful, you can make your code a bit simpler by using one of WriteValueAction<TValue>(SparkplugMetric,Type,Action<TValue>) method overloads instead. |
| Name | Description | |
|---|---|---|
![]() | Disposed | (Inherited from System.ComponentModel.Component) |
![]() | Read | Raised for obtaining the Sparkplug metric read data. |
![]() | Starting | Raised when the component is starting. |
![]() | Stopped | Raised when the component has stopped. |
![]() | Write | Raised for supplying the Sparkplug metric write data. |