com.prosysopc.ua.pubsub

Class PubSubPublishedVariableConf

java.lang.Object

com.prosysopc.ua.pubsub.PubSubPublishedVariableConf

All Implemented Interfaces:

PubSubConf

public final class PubSubPublishedVariableConf
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubSubPublishedVariableConf.Builder Builder for PubSubPublishedVariableConf.
static class	PubSubPublishedVariableConf.Fields

Nested classes/interfaces inherited from interface com.prosysopc.ua.pubsub.PubSubConf

PubSubConf.MapKind<T>

Field Summary

Fields

Modifier and Type	Field and Description
static PubSubConfSpecification	SPECIFICATION

Method Summary

Modifier and Type	Method and Description
static PubSubPublishedVariableConf.Builder	builder() Returns a new PubSubPublishedVariableConf.Builder that can be used to construct instances of this class
boolean	equals(Object obj)
UaArrayDimensions	getArrayDimensions() The ArrayDimensions of the field, note that these define maximum number of elements per dimension (0 if unknown).
UnsignedInteger	getAttributeId() Configures which Attribute of the getPublishedVariable() node is published, this shall be configured if getPublishedVariable() is non-null.
UaNodeId	getDataType() The DataType of the field.
DeadbandType	getDeadbandType()
Double	getDeadbandValue()
LocalizedText	getDescription() If non-null used as the description of the published variable.
NumericRange	getIndexRange() If non-null allows selecting a part of the getPublishedVariable() multidimensional Value.
Map<UaQualifiedName,Object>	getMetaDataPropertyMap()
String	getName() If non-null used as the name of the publisher variable.
UaNodeId	getPublishedVariable() Configures which node to publish.
Duration	getSamplingIntervalHint() A hint for which sampling interval should be used when sampling getPublishedVariable().
Object	getSubstituteValue() If the data received by Reading the getPublishedVariable() is StatusCode#isBad(), use this value instead with StatusCodes#Uncertain_SubstituteValue.
Integer	getValueRank() The ValueRank of the field.
int	hashCode()
Boolean	isPreferSubscription() If true (the default), tries to use client-server Subscriptions if the data source is an OPC UA Client.
PubSubConfSpecification	specification() Returns the specification of this object.
PubSubPublishedVariableConf.Builder	toBuilder() Returns a new PubSubPublishedVariableConf.Builder that is initialized with the state of this object.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.prosysopc.ua.pubsub.PubSubConf

get, get, toMap

Field Detail

SPECIFICATION

public static final PubSubConfSpecification SPECIFICATION

Method Detail

specification

public PubSubConfSpecification specification()

Description copied from interface: PubSubConf

Returns the specification of this object. Can be used to dynamically display the fields of the PubSubConf object.

getArrayDimensions

public UaArrayDimensions getArrayDimensions()

The ArrayDimensions of the field, note that these define maximum number of elements per dimension (0 if unknown). Shall be set if getPublishedVariable() is null. If null and getValueRank() is not scalar then the ArrayDimensions is taken from the node defined by getPublishedVariable().

getAttributeId

public UnsignedInteger getAttributeId()

Configures which Attribute of the getPublishedVariable() node is published, this shall be configured if getPublishedVariable() is non-null.

getDataType

public UaNodeId getDataType()

The DataType of the field. Shall be set if getPublishedVariable() is null. If null, then the DataType is taken from the node defined by getPublishedVariable().

getDeadbandType

public DeadbandType getDeadbandType()

getDeadbandValue

public Double getDeadbandValue()

getDescription

public LocalizedText getDescription()

If non-null used as the description of the published variable. This information will be part of the so called DataSetMetaData. If null (the default), the Description Attribute of the node is used.

getIndexRange

public NumericRange getIndexRange()

If non-null allows selecting a part of the getPublishedVariable() multidimensional Value. Only has a meaning if getPublishedVariable() is non-null and getAttributeId() equals Attributes#Value.

getMetaDataPropertyMap

public Map<UaQualifiedName,Object> getMetaDataPropertyMap()

getName

public String getName()

If non-null used as the name of the publisher variable. This information will be part of the so called DataSetMetaData. If null (the default), the name part of the BrowseName of the node is used. Shall be defined if getPublishedVariable() is not defined.

getPublishedVariable

public UaNodeId getPublishedVariable()

Configures which node to publish. The getAttributeId() defines which Attribute of the node is published. If non-null, the getAttributeId() also shall be non-null. If this is null, then getDataType(), getArrayDimensions(), getValueRank(), getSubstituteValue() shall be configured and the field behaves as a constant value.

getSamplingIntervalHint

public Duration getSamplingIntervalHint()

A hint for which sampling interval should be used when sampling getPublishedVariable().

getSubstituteValue

public Object getSubstituteValue()

If the data received by Reading the getPublishedVariable() is StatusCode#isBad(), use this value instead with StatusCodes#Uncertain_SubstituteValue.

getValueRank

public Integer getValueRank()

The ValueRank of the field. Shall be set if getPublishedVariable() is null. If null, then the ValueRank is taken from the node defined by getPublishedVariable().

isPreferSubscription

public Boolean isPreferSubscription()

If true (the default), tries to use client-server Subscriptions if the data source is an OPC UA Client.

builder

public static PubSubPublishedVariableConf.Builder builder()

Returns a new PubSubPublishedVariableConf.Builder that can be used to construct instances of this class

toBuilder

public PubSubPublishedVariableConf.Builder toBuilder()

Returns a new PubSubPublishedVariableConf.Builder that is initialized with the state of this object.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object