com.prosysopc.ua.pubsub

Class PubSubMqttUadpDataSetReaderConf

java.lang.Object

com.prosysopc.ua.pubsub.PubSubMqttUadpDataSetReaderConf

All Implemented Interfaces:

PubSubBrokerTransportSettingsConf, PubSubConf, PubSubDataSetReaderConf, PubSubNamedConf, PubSubUadpDataSetReaderConf

public final class PubSubMqttUadpDataSetReaderConf
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubSubMqttUadpDataSetReaderConf.Builder Builder for PubSubMqttUadpDataSetReaderConf.
static class	PubSubMqttUadpDataSetReaderConf.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 PubSubMqttUadpDataSetReaderConf.Builder	builder() Returns a new PubSubMqttUadpDataSetReaderConf.Builder that can be used to construct instances of this class
boolean	equals(Object obj)
UUID	getDataSetClassId()
UnsignedShort	getDataSetWriterId()
DataSetFieldContentMask	getFieldContentMask()
UadpDataSetMessageContentMask	getMessageContentMask()
String	getMetaDataQueueName() Defines the Broker's queuename for the metadata.
Duration	getMetaDataUpdateTime() Configures how often the Metadata is updated to the getMetaDataQueueName().
String	getName() Returns the name of the PubSub component.
PublisherId	getPublisherId()
String	getQueueName() Defines the Broker's queuename for the data.
BrokerTransportQualityOfService	getRequestedDeliveryGuarantee()
PubSubSecurityConf	getSecurityConf()
PubSubTargetVariablesConf	getSubscribedDataSet()
PubSubTransportProfile	getTransportProfile() Returns the TransportProfile (uri) of the reader group where this reader is or is to be added.
UnsignedShort	getWriterGroupId()
int	hashCode()
Boolean	isEnabled()
Boolean	isIgnoreMissingMetaData() If true (the default) and if the DataSetMetaData for the dataset this reader is reading is missing: the UADP message is tried to be decoded (assuming Variant or DataValue style, RawData wont work with this) and fields will be assigned index-based-names by the SDK temporarily (or forever if no metadata arrives).
PubSubConfSpecification	specification() Returns the specification of this object.
PubSubMqttUadpDataSetReaderConf.Builder	toBuilder() Returns a new PubSubMqttUadpDataSetReaderConf.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.

getName

public String getName()

Returns the name of the PubSub component. This name is unique within some context.

getMetaDataQueueName

public String getMetaDataQueueName()

Defines the Broker's queuename for the metadata. IMPORTANT! For the Publisher i.e. Writer side this shall not be a wildcard. Can be a wildcard for the Subscriber i.e. Reader side.

getMetaDataUpdateTime

public Duration getMetaDataUpdateTime()

Configures how often the Metadata is updated to the getMetaDataQueueName().

getQueueName

public String getQueueName()

Defines the Broker's queuename for the data. IMPORTANT! For the Publisher i.e. Writer side this shall not be a wildcard. Can be a wildcard for the Subscriber i.e. Reader side.

getRequestedDeliveryGuarantee

public BrokerTransportQualityOfService getRequestedDeliveryGuarantee()

getDataSetClassId

public UUID getDataSetClassId()

getDataSetWriterId

public UnsignedShort getDataSetWriterId()

getPublisherId

public PublisherId getPublisherId()

getSecurityConf

public PubSubSecurityConf getSecurityConf()

getSubscribedDataSet

public PubSubTargetVariablesConf getSubscribedDataSet()

getWriterGroupId

public UnsignedShort getWriterGroupId()

isEnabled

public Boolean isEnabled()

getFieldContentMask

public DataSetFieldContentMask getFieldContentMask()

getMessageContentMask

public UadpDataSetMessageContentMask getMessageContentMask()

isIgnoreMissingMetaData

public Boolean isIgnoreMissingMetaData()

If true (the default) and if the DataSetMetaData for the dataset this reader is reading is missing: the UADP message is tried to be decoded (assuming Variant or DataValue style, RawData wont work with this) and fields will be assigned index-based-names by the SDK temporarily (or forever if no metadata arrives). If the metadata is found the field names from there are used as mapping keys.

If this is false the Reader wont process the message if metadata was missing.

builder

public static PubSubMqttUadpDataSetReaderConf.Builder builder()

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

toBuilder

public PubSubMqttUadpDataSetReaderConf.Builder toBuilder()

Returns a new PubSubMqttUadpDataSetReaderConf.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

getTransportProfile

public final PubSubTransportProfile getTransportProfile()

Description copied from interface: PubSubDataSetReaderConf

Returns the TransportProfile (uri) of the reader group where this reader is or is to be added. This defines both the transport and encoding of the reader.

Specified by:

getTransportProfile in interface PubSubDataSetReaderConf