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


OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug.System Namespace : EasySparkplugSystem Class

The following tables list the members exposed by EasySparkplugSystem.

Public Fields
 NameDescription
Public FieldThe default value of AutoCreateHostApplication property.

This is a constant, and its value is True.

 
Public FieldThe default value of EdgeNodeIdTemplateString property.

This is a constant, and its value is "$(CanonicalizedHostName):$(ModuleName);$(CanonicalizedHostName):$(VersionInfoTokens);$(CanonicalizedHostName):$(AssemblyTokens)".

 
Public FieldThe default value of HostIdTemplateString property.

This is a constant, and its value is "$(CanonicalizedHostName):$(ModuleName);$(CanonicalizedHostName):$(VersionInfoTokens);$(CanonicalizedHostName):$(AssemblyTokens)".

 
Public FieldThe default value of SparkplugVersion property.

This is a constant, and its value is OpcLabs.EasySparkplug.SparkplugVersions.PayloadB.

 
Top
Public Properties
 NameDescription
Public PropertyDetermines whether the system can automatically create a Sparkplug host application when it is not found.  
Public PropertyThe edge node ID that will be used when an edge node component is created in this Sparkplug system, and no specific edge node ID is given.  
Public PropertyThe host ID that will be used when a host application component is created in this Sparkplug system, and no specific host ID is given.  
Public PropertyA Sparkplug connection descriptor that the components in this system use to connect to the Sparkplug broker.  
Public PropertyThe host application used when no specific host ID is specified.  
Public PropertySpecifies the edge node ID template string, which is used unless a non-empty edge node ID is given in the for the edge node.  
Public PropertyA collection of Sparkplug host applications that participate in this Sparkplug system.  
Public PropertySpecifies the host ID template string, which is used unless a non-empty host ID is given in the for the host application.  
Public PropertyThe Sparkplug version used by this Sparkplug system.  
Public PropertyThe system ID of this Sparkplug system.  
Top
Public Methods
 NameDescription
Public MethodCreates a new Sparkplug host application with the specified host ID and adds it to the Sparkplug system.  
Public MethodDestroys the Sparkplug host application with the specified host ID and removes it from the system.  
Public MethodOverloaded. Overridden. Determines whether the specified EasySparkplugSystem is equal to the current object.  
Public MethodFinds a Sparkplug host application by its host ID.  
Public MethodFind an existing Sparkplug host application by its host ID, or create a new one (and add it to the system) if it does not exist.  
Public MethodOverridden.   
Public MethodGets the System.Type of the current instance. (Inherited from object)
Public Methodstatic (Shared in Visual Basic)Creates a Sparkplug system descriptor for the specified Sparkplug system.  
Public MethodOverridden.   
Public MethodCreates a Sparkplug system descriptor for this Sparkplug system.  
Top
Protected Methods
 NameDescription
Protected MethodAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from object)
Protected MethodCreates a shallow copy of the current System.Object. (Inherited from object)
Top
Extension Methods
 NameDescription
Public Extension MethodSets the arbitrary object associated with the node.
Top
Public Operators
Determines whether the two objects are equal.
Converts the specified Sparkplug system to a Sparkplug system descriptor.
Determines whether the two objects are not equal.
Top
See Also

Reference

EasySparkplugSystem Class
OpcLabs.EasySparkplug.System Namespace