Connectivity Software User's Guide and Reference
SparkplugPayload Class Members
Properties  Methods 


OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace : SparkplugPayload Class

The following tables list the members exposed by SparkplugPayload.

Public Constructors
 NameDescription
Public ConstructorSparkplugPayload ConstructorOverloaded. Initializes a new instance of the class.  
Top
Public Properties
 NameDescription
Public Propertystatic (Shared in Visual Basic)DefaultTimestampDefault timestamp. In UTC.  
Public Propertystatic (Shared in Visual Basic)DefaultTimestampLocalDefault timestamp. In local time.  
Public PropertyMetadataDictionaryA read-only dictionary of Sparkplug metadata for metrics contained in the payload, keyed by metric name.  
Public PropertyMetricDataDictionaryA read-only dictionary of Sparkplug metric data for metrics contained in the payload, keyed by metric name.  
Public PropertyPayloadElementCollectionA read-only collection of Sparkplug payload elements, which are key-value pairs of metric names and metric elements.  
Public PropertyTemplateDefinitionDictionaryA read-only dictionary of Sparkplug template definitions for metrics in the payload, keyed by template definition name.  
Public PropertyTimestampThe timestamp of the payload. In UTC.  
Public PropertyTimestampLocalThe timestamp of the payload. In local time.  
Top
Public Methods
 NameDescription
Public MethodAddOverloaded. Adds a Sparkplug metric to the payload, specifying the metric name and data.  
Public MethodCloneOverridden.   
Public MethodEqualsOverloaded. Overridden. Determines whether the specified SparkplugPayload is equal to the current object.  
Public MethodGetEnumerator  
Public MethodGetHashCodeOverridden.   
Public MethodGetObjectDataOverridden.   
Public MethodGetSchema (Inherited from OpcLabs.BaseLib.Info)
Public MethodGetTypeGets the System.Type of the current instance. (Inherited from object)
Public MethodReadXml (Inherited from OpcLabs.BaseLib.Info)
Public MethodToStringOverridden.   
Public MethodWriteXml (Inherited from OpcLabs.BaseLib.Info)
Top
Protected Methods
 NameDescription
Protected MethodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from object)
Protected MethodMemberwiseCloneCreates a shallow copy of the current System.Object. (Inherited from object)
Protected MethodReadXmlElementInfrastructure. (Inherited from OpcLabs.BaseLib.Info)
Protected MethodWriteXmlElementInfrastructure. (Inherited from OpcLabs.BaseLib.Info)
Top
Extension Methods
 NameDescription
Public Extension MethodSetState<TNode>Sets the arbitrary object associated with the node.
Top
Public Operators
public Operator Equality Determines whether the two objects are equal.
public Operator Inequality Determines whether the two objects are not equal.
Top
See Also

Reference

SparkplugPayload Class
OpcLabs.EasySparkplug Namespace

 

 

Copyright © 2004-2025 CODE Consulting and Development, s.r.o., Plzen. All rights reserved. Web page: www.opclabs.com

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.