Connectivity Software User's Guide and Reference
IsHistorical Property



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > SparkplugMetricData Class : IsHistorical Property
Determines whether this metric represents a historical value.
Syntax
'Declaration
 
Public Property IsHistorical As Boolean
'Usage
 
Dim instance As SparkplugMetricData
Dim value As Boolean
 
instance.IsHistorical = value
 
value = instance.IsHistorical
public bool IsHistorical {get; set;}
public:
property bool IsHistorical {
   bool get();
   void set (    bool value);
}

Property Value

The default value of this property is False.

Remarks

In some cases, it may be desirable to send metrics after they were acquired from a device or edge node. This can be done for batching, store and forward, or sending local backup data during network communication loses. This flag denotes that the message should not be considered a real time/current value.

This method or property does not throw any exceptions, aside from execution exceptions such as System.Threading.ThreadAbortException or System.OutOfMemoryException.

 

Sparkplug is a trademark of Eclipse Foundation, Inc. "MQTT" is a trademark of the OASIS Open standards consortium. Other related terms are trademarks of their respective owners. Any use of these terms on this site is for descriptive purposes only and does not imply any sponsorship, endorsement or affiliation.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also