Index (lib 1.0.1 API)

A B C D F G H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages

A

addChangeEvents(ChangeEventsT) - Method in interface com.boschrexroth.api.SubscriptionPropertiesBuilder: add property changeevents
addCounting(CountingT) - Method in interface com.boschrexroth.api.SubscriptionPropertiesBuilder: add property counting
addDataChangeFilter(DataChangeFilterT) - Method in interface com.boschrexroth.api.SubscriptionPropertiesBuilder: add property datachangefilter
addExtension(String, String) - Method in interface com.boschrexroth.api.MetadataBuilder: add extension
addLocalizationDescription(String, String) - Method in interface com.boschrexroth.api.MetadataBuilder: add localization of descriptions
addLocalizationDisplayName(String, String) - Method in interface com.boschrexroth.api.MetadataBuilder: add localization of display names
addLosslessRateInterval(LosslessIntervalT) - Method in interface com.boschrexroth.api.SubscriptionPropertiesBuilder: add property losslessrateinterval
addLosslessRateLimit(LosslessRateLimitT) - Method in interface com.boschrexroth.api.SubscriptionPropertiesBuilder: add property losslessratelimit
addQueueing(QueueingT) - Method in interface com.boschrexroth.api.SubscriptionPropertiesBuilder: add property queueing
addReference(ReferenceType, String) - Method in interface com.boschrexroth.api.MetadataBuilder: add reference
addSampling(SamplingT) - Method in interface com.boschrexroth.api.SubscriptionPropertiesBuilder: add property sampling
ALL - Enum constant in enum class com.boschrexroth.api.AllowedOperation: ALL
AllowedOperation - Enum Class in com.boschrexroth.api: Allowed Operation Flags
ALREADY_EXISTS - Enum constant in enum class com.boschrexroth.api.Result: CREATE: RESOURCE ALREADY EXISTS
ARRAY_BOOL8 - Enum constant in enum class com.boschrexroth.api.VariantType: array of bool 8 bit
ARRAY_FLOAT32 - Enum constant in enum class com.boschrexroth.api.VariantType: array of float 32 bit
ARRAY_FLOAT64 - Enum constant in enum class com.boschrexroth.api.VariantType: array of float 64 bit
ARRAY_INT16 - Enum constant in enum class com.boschrexroth.api.VariantType: array of signed int 16 bit
ARRAY_INT32 - Enum constant in enum class com.boschrexroth.api.VariantType: array of signed int 32 bit
ARRAY_INT64 - Enum constant in enum class com.boschrexroth.api.VariantType: array of signed int 64 bit
ARRAY_INT8 - Enum constant in enum class com.boschrexroth.api.VariantType: array of signed int 8 bit
ARRAY_OF_TIMESTAMP - Enum constant in enum class com.boschrexroth.api.VariantType: array of timestamp (FILETIME) 64 bit 100ns since 1.1.1601 (UTC)
ARRAY_STRING - Enum constant in enum class com.boschrexroth.api.VariantType: array of string (UTF-8)
ARRAY_UINT16 - Enum constant in enum class com.boschrexroth.api.VariantType: array of unsigned int 16 bit
ARRAY_UINT32 - Enum constant in enum class com.boschrexroth.api.VariantType: array of unsigned int 32 bit
ARRAY_UINT64 - Enum constant in enum class com.boschrexroth.api.VariantType: array of unsigned int 64 bit
ARRAY_UINT8 - Enum constant in enum class com.boschrexroth.api.VariantType: array of unsigned int 8 bit

B

BOOL8 - Enum constant in enum class com.boschrexroth.api.VariantType: bool 8 bit
browse(BulkResponseCallback, String[]) - Method in interface com.boschrexroth.api.Bulk: Browses nodes using a bulk operation.
browse(String[]) - Method in interface com.boschrexroth.api.Bulk: Browses nodes using a bulk operation.
Browse(String) - Method in interface com.boschrexroth.api.Client: Browses the data layer for child nodes or elements at the specified address.
BROWSE - Enum constant in enum class com.boschrexroth.api.AllowedOperation: BROWSE
browseAsync(String, ClientResponseCallback) - Method in interface com.boschrexroth.api.Client: Asynchronously browses for data items at the specified address in the data layer.
browseSync(String, Variant) - Method in interface com.boschrexroth.api.Client: Synchronously browses for data items at the specified address in the data layer.
build() - Method in interface com.boschrexroth.api.MetadataBuilder: Build Metadata as Variant
build() - Method in interface com.boschrexroth.api.RemoteBuilder: builds the connection string: 'ipc' if running inside a snap, otherwise 'tcp'.
build() - Method in interface com.boschrexroth.api.SubscriptionPropertiesBuilder: build
Bulk - Interface in com.boschrexroth.api: creates a ctrlX Data Layer bulk
BulkCreateArg - Interface in com.boschrexroth.api: Interface for BulkCreateArg
BulkReadArg - Interface in com.boschrexroth.api: Interface for BulkReadArg
BulkResponse - Interface in com.boschrexroth.api: Interface for bulk response
BulkResponseCallback - Interface in com.boschrexroth.api: Callback interface for asynchronous Bulk calls.
BulkWriteArg - Interface in com.boschrexroth.api: Interface for BulkWriteArg

C

callback(Result, Variant) - Method in interface com.boschrexroth.api.ProviderNodeEvent: Callback
Client - Interface in com.boschrexroth.api: Represents a client interface for interacting with a data layer, providing synchronous and asynchronous operations for various data manipulation tasks.
CLIENT_NOT_CONNECTED - Enum constant in enum class com.boschrexroth.api.Result: CLIENT NOT CONNECTED
ClientResponseCallback - Interface in com.boschrexroth.api: Callback interface for asynchronous DLR_CLIENT_RESPONSE calls.
com.boschrexroth.api - package com.boschrexroth.api: This project provides interface for ctrlX Data Layer access via Java.
COMM_INVALID_HEADER - Enum constant in enum class com.boschrexroth.api.Result: INTERNAL HEADER MISMATCH
COMM_PROTOCOL_ERROR - Enum constant in enum class com.boschrexroth.api.Result: NTERNAL PROTOCOL ERROR
COMMUNICATION_ERROR - Enum constant in enum class com.boschrexroth.api.Result: LOW LEVEL COMMUNICATION ERROR OCCURRED
Converter - Interface in com.boschrexroth.api: Converter interface
create() - Static method in interface com.boschrexroth.api.RemoteBuilder: Creator of a System instance
create() - Static method in interface com.boschrexroth.api.Variant: Creator of a variant instance
create(int, String, String) - Static method in interface com.boschrexroth.api.MetadataBuilder: Creator of a MetadataBuilder instance
create(BulkCreateArg[]) - Method in interface com.boschrexroth.api.Bulk: Creates nodes using a bulk operation.
create(BulkResponseCallback, BulkCreateArg[]) - Method in interface com.boschrexroth.api.Bulk: Creates nodes using a bulk operation.
create(ProviderNodeCallback) - Static method in interface com.boschrexroth.api.ProviderNode: Creator of a ProviderNode instance
create(ProviderNodeSubCallback) - Static method in interface com.boschrexroth.api.ProviderNode: Creator of a ProviderNode instance
create(SubscriptionPropertiesT) - Static method in interface com.boschrexroth.api.SubscriptionPropertiesBuilder: Creator of a SubscriptionPropertiesBuilder instance
create(String) - Static method in interface com.boschrexroth.api.BulkCreateArg: Creator of a BulkCreateArg instance
create(String) - Static method in interface com.boschrexroth.api.BulkReadArg: Creator of a BulkReadArg instance
create(String) - Static method in interface com.boschrexroth.api.DlSystem: Creator of a System instance
create(String) - Static method in interface com.boschrexroth.api.NotifyItemPublish: Creator of a NotifyItemPublish instance
create(String) - Static method in interface com.boschrexroth.api.SubscriptionPropertiesBuilder: Creator of a SubscriptionPropertiesBuilder instance
create(String, Variant) - Static method in interface com.boschrexroth.api.BulkCreateArg: Creator of a BulkCreateArg instance
create(String, Variant) - Static method in interface com.boschrexroth.api.BulkReadArg: Creator of a BulkReadArg instance
create(String, Variant) - Static method in interface com.boschrexroth.api.BulkWriteArg: Creator of a BulkWriteArg instance
CREATE - Enum constant in enum class com.boschrexroth.api.AllowedOperation: CREATE
CREATE - Enum constant in enum class com.boschrexroth.api.ReferenceType: Type when creating a value (absolute node address).
createAsync(String, Variant, ClientResponseCallback) - Method in interface com.boschrexroth.api.Client: Asynchronously creates a new data item at the specified address in the data layer.
createBulk() - Method in interface com.boschrexroth.api.Client: Creates a ctrlX Data Layer bulk
createClient(String) - Method in interface com.boschrexroth.api.Factory: Creates a client for accessing data of the system
createMask(AllowedOperation...) - Static method in enum class com.boschrexroth.api.AllowedOperation: create allowed operation mask
createProvider(String) - Method in interface com.boschrexroth.api.Factory: Creates a provider to provide data to the datalayer
createSubscription(Variant, SubscriptionCallback) - Method in interface com.boschrexroth.api.Client: Setup a subscription
createSync(String, Variant) - Method in interface com.boschrexroth.api.Client: Synchronously creates a new data item at the specified address in the data layer.
CREATION_FAILED - Enum constant in enum class com.boschrexroth.api.Result: ERROR DURING CREATION

D

delete(BulkResponseCallback, String[]) - Method in interface com.boschrexroth.api.Bulk: Delete deletes nodes using a bulk operation.
delete(String[]) - Method in interface com.boschrexroth.api.Bulk: Delete deletes nodes using a bulk operation.
DELETE - Enum constant in enum class com.boschrexroth.api.AllowedOperation: DELETE
DEPRECATED - Enum constant in enum class com.boschrexroth.api.Result: DEPRECATED - FUNCTION NOT LONGER SUPPORTED
DIAGNOSIS - Enum constant in enum class com.boschrexroth.api.Schema: DIAGNOSIS
DlSystem - Interface in com.boschrexroth.api: Datalayer System Instance

F

Factory - Interface in com.boschrexroth.api: Factory interface
Factory() - Method in interface com.boschrexroth.api.DlSystem: Returns the datalayer factory
FAILED - Enum constant in enum class com.boschrexroth.api.Result: ONLY ALLOWED FOR TEMPORARY USE - DEFINE MATCHING ERROR CODE
FLATBUFFERS - Enum constant in enum class com.boschrexroth.api.VariantType: bytes as a complex data type encoded as a flatbuffer
FLOAT32 - Enum constant in enum class com.boschrexroth.api.VariantType: float 32 bit
FLOAT64 - Enum constant in enum class com.boschrexroth.api.VariantType: float 64 bit
fromValue(int) - Static method in enum class com.boschrexroth.api.AllowedOperation: Returns the ReferenceType Value
fromValue(int) - Static method in enum class com.boschrexroth.api.ReferenceType: convert value in ReferenceType cl
fromValue(int) - Static method in enum class com.boschrexroth.api.Result: convert value in Result cl
fromValue(int) - Static method in enum class com.boschrexroth.api.Schema: convert value in Schema cl
fromValue(int) - Static method in enum class com.boschrexroth.api.TimeoutSetting: convert value in TimeoutSetting cl
fromValue(int) - Static method in enum class com.boschrexroth.api.VariantType: convert value in VariantType

G

generateJsonComplex(byte[], byte[], int) - Method in interface com.boschrexroth.api.Converter: This function generate a JSON string out of a Variant with complex type (flatbuffers) and the metadata of this data
generateJsonSimple(Variant, int) - Method in interface com.boschrexroth.api.Converter: This function generate a JSON string out of a Variant witch have a simple data type
getAddress() - Method in interface com.boschrexroth.api.BulkCreateArg: Address for the request
getAddress() - Method in interface com.boschrexroth.api.BulkReadArg: Address for the request
getAddress() - Method in interface com.boschrexroth.api.BulkResponse: Gets the address of the node
getAddress() - Method in interface com.boschrexroth.api.NotifyItem: Node address
getAddress() - Method in interface com.boschrexroth.api.ProviderNodeEvent: get Address
getAddress() - Method in interface com.boschrexroth.api.ProviderNodeSubscription: get Address
getAddresses() - Method in interface com.boschrexroth.api.Subscription: Addresses are all currently subscribed addresses.
getArgument() - Method in interface com.boschrexroth.api.BulkReadArg: Argument of the request
getArrayOfBool8() - Method in interface com.boschrexroth.api.Variant: Returns the array of bool8, otherwise empty list otherwise 0
getArrayOfFloat32() - Method in interface com.boschrexroth.api.Variant: Returns the array of float32, otherwise empty list otherwise 0
getArrayOfFloat64() - Method in interface com.boschrexroth.api.Variant: Returns the array of double, otherwise empty list otherwise 0
getArrayOfInstant() - Method in interface com.boschrexroth.api.Variant: Returns the array of String, otherwise empty list otherwise 0
getArrayOfInt16() - Method in interface com.boschrexroth.api.Variant: Returns the array of int16, otherwise empty list otherwise 0
getArrayOfInt32() - Method in interface com.boschrexroth.api.Variant: Returns the array of int32, otherwise empty list otherwise 0
getArrayOfInt64() - Method in interface com.boschrexroth.api.Variant: Returns the array of int64, otherwise empty list otherwise 0
getArrayOfInt8() - Method in interface com.boschrexroth.api.Variant: Returns the array of int8, otherwise empty list otherwise 0
getArrayOfStrings() - Method in interface com.boschrexroth.api.Variant: Returns the array of bool8, otherwise empty list otherwise 0
getArrayOfUint16() - Method in interface com.boschrexroth.api.Variant: Returns the array of uint16, otherwise empty list otherwise 0
getArrayOfUint32() - Method in interface com.boschrexroth.api.Variant: Returns the array of uint32, otherwise empty list otherwise 0
getArrayOfUint64() - Method in interface com.boschrexroth.api.Variant: Returns the array of uint64, otherwise empty list otherwise 0
getArrayOfUint8() - Method in interface com.boschrexroth.api.Variant: Returns the array of uint8, otherwise empty list otherwise 0
getAuthToken() - Method in interface com.boschrexroth.api.Client: Returns persistent security access token for authentication
getBool8() - Method in interface com.boschrexroth.api.Variant: Returns the value of the variant as a bool (auto convert if possible) otherwise 0
getConnectStatus() - Method in interface com.boschrexroth.api.Client: Returns connect status of the client
getCount() - Method in interface com.boschrexroth.api.Variant: Returns the count of elements in the variant (scalar data types = 1, array = count of elements in array)
getData() - Method in interface com.boschrexroth.api.BulkCreateArg: Data of the request
getData() - Method in interface com.boschrexroth.api.BulkResponse: Gets the Value
getData() - Method in interface com.boschrexroth.api.NotifyItem: data of the notify item
getData() - Method in interface com.boschrexroth.api.NotifyItemPublish: Gets the data of the notify item.
getData() - Method in interface com.boschrexroth.api.ProviderNodeEventData: getData
getData() - Method in interface com.boschrexroth.api.Variant: Returns the data of the variant
getEventType() - Method in interface com.boschrexroth.api.NotifyItem: Event Type
getFlatbuffers() - Method in interface com.boschrexroth.api.Variant: Returns the flatbuffers of the variant
getFLOAT32() - Method in interface com.boschrexroth.api.Variant: Returns the value of the variant as a float (auto convert if possible) otherwise 0
getFLOAT64() - Method in interface com.boschrexroth.api.Variant: Returns the value of the variant as a double (auto convert if possible) otherwise 0
getId() - Method in interface com.boschrexroth.api.Subscription: Id of the subscription.
getInfo() - Method in interface com.boschrexroth.api.NotifyItemPublish: Gets the info of the notify item.
getInstant() - Method in interface com.boschrexroth.api.ProviderSubscription: Get Timestamp
getInstant() - Method in interface com.boschrexroth.api.Variant: Returns Instant object as timestamp (FILETIME) 64 bit 100ns since 1.1.1601 (UTC)
getInt16() - Method in interface com.boschrexroth.api.Variant: Returns the value of the variant as a int16 (auto convert if possible)
getInt32() - Method in interface com.boschrexroth.api.Variant: Returns the value of the variant as a int (auto convert if possible) otherwise 0
getInt64() - Method in interface com.boschrexroth.api.Variant: Returns the value of the variant as a long (auto convert if possible) otherwise 0
getInt8() - Method in interface com.boschrexroth.api.Variant: Returns the value of the variant as a int8 (auto convert if possible) otherwise 0
getLastError() - Method in interface com.boschrexroth.api.Client: Retrieves the last error that occurred during a client operation.
getLastError() - Method in interface com.boschrexroth.api.Converter: get last error
getLastError() - Method in interface com.boschrexroth.api.Provider: Retrieves the last error that occurred during a provider operation.
getNodes() - Method in interface com.boschrexroth.api.ProviderSubscription: Gets the list of address nodes of a subscription
getNotifyType() - Method in interface com.boschrexroth.api.NotifyItem: Notify Type
getProps() - Method in interface com.boschrexroth.api.ProviderSubscription: Gets the properties of a subscription
getReferenceNames(ReferenceType) - Static method in enum class com.boschrexroth.api.ReferenceType: Returns the ReferenceType Value
getRegisteredNodePaths() - Method in interface com.boschrexroth.api.Provider: Return the current registered node paths
getRegisteredType(String) - Method in interface com.boschrexroth.api.Provider: Get the variant of a registered type
getRejectedNodePaths() - Method in interface com.boschrexroth.api.Provider: Return the current rejected node paths
getResponses() - Method in interface com.boschrexroth.api.Bulk: Gets response value
getResult() - Method in interface com.boschrexroth.api.BulkResponse: Gets the result of the value
getSchema(Schema) - Method in interface com.boschrexroth.api.Converter: This funtion returns the type (schema)
getSequenceNumber() - Method in interface com.boschrexroth.api.NotifyItem: Sequence Number
getSize() - Method in interface com.boschrexroth.api.Variant: Returns the size in bytes of the variant
getSourceName() - Method in interface com.boschrexroth.api.NotifyItem: Source name
getSTRING() - Method in interface com.boschrexroth.api.Variant: Returns the value of the variant as a string
getSubscription() - Method in interface com.boschrexroth.api.ProviderNodeSubscription: get Subscription object
getTime() - Method in interface com.boschrexroth.api.BulkResponse: Gets timestamp of the value
getTimestamp() - Method in interface com.boschrexroth.api.NotifyItem: Timestamp
getToken() - Method in interface com.boschrexroth.api.Provider: Return the current token of the current request you can call this function during your onRead, onWrite, ...
getType() - Method in interface com.boschrexroth.api.Variant: Returns the type of the variant
getUint16() - Method in interface com.boschrexroth.api.Variant: Returns the value of the variant as a short (auto convert if possible) otherwise 0
getUint32() - Method in interface com.boschrexroth.api.Variant: Returns the value of the variant as a int (auto convert if possible) otherwise 0
getUint64() - Method in interface com.boschrexroth.api.Variant: Returns the value of the variant as a long (auto convert if possible) otherwise 0
getUint8() - Method in interface com.boschrexroth.api.Variant: Returns the value of the variant as a byte (auto convert if possible) otherwise 0
getUniqueId() - Method in interface com.boschrexroth.api.ProviderSubscription: Unambiguous identification of the subscription
getValue() - Method in enum class com.boschrexroth.api.AllowedOperation: Returns the AllowedOperation Value
getValue() - Method in enum class com.boschrexroth.api.ReferenceType: Returns the ReferenceType Value
getValue() - Method in enum class com.boschrexroth.api.Result: Returns the Result Value
getValue() - Method in enum class com.boschrexroth.api.Schema: Returns the Schema Value
getValue() - Method in enum class com.boschrexroth.api.TimeoutSetting: Returns the TimeoutSetting Value
getValue() - Method in enum class com.boschrexroth.api.VariantType: Returns the VariantType Value

H

HAS_SAVE - Enum constant in enum class com.boschrexroth.api.ReferenceType: Reference to a save node address which needs to be called after node change to persist the new value (must be <technology>/admin/cfg/save).

I

IDLE - Enum constant in enum class com.boschrexroth.api.TimeoutSetting: timeout to check whether to broker is still active when client is idle
INT16 - Enum constant in enum class com.boschrexroth.api.VariantType: signed int 16 bit
INT32 - Enum constant in enum class com.boschrexroth.api.VariantType: signed int 32 bit
INT64 - Enum constant in enum class com.boschrexroth.api.VariantType: signed int 64 bit
INT8 - Enum constant in enum class com.boschrexroth.api.VariantType: signed int 8 bit
INVALID_ADDRESS - Enum constant in enum class com.boschrexroth.api.Result: ADDRESS NOT FOUND, ADDRESS INVALID (BROWSE OF THIS NODE NOT POSSIBLE, WRITE -> ADDRESS NOT VALID)
INVALID_CONFIGURATION - Enum constant in enum class com.boschrexroth.api.Result: MISMATCH OF THIS VALUE WITH OTHER CONFIGURED VALUES
INVALID_FLOATINGPOINT - Enum constant in enum class com.boschrexroth.api.Result: INVALID FLOATING POINT NUMBER.
INVALID_HANDLE - Enum constant in enum class com.boschrexroth.api.Result: INVALID HANDLE ARGUMENT OR NULL POINTER ARGUMENT.
INVALID_OPERATION_MODE - Enum constant in enum class com.boschrexroth.api.Result: NOT ACCESSIBLE DUE TO INVALID OPERATION MODE (WRITE NOT POSSIBLE)
INVALID_VALUE - Enum constant in enum class com.boschrexroth.api.Result: INVALID VALUE
Ip(String) - Method in interface com.boschrexroth.api.RemoteBuilder: IP address of the ctrlX CORE.
Ipc() - Method in interface com.boschrexroth.api.RemoteBuilder: Use "ipc://"" to connect to a ctrlX COREvirtual, independent running inside a snap
IpVirtual() - Method in interface com.boschrexroth.api.RemoteBuilder: Use "10.0.2.2" to connect to a ctrlX COREvirtual with port forwarding
isAllowed(int) - Method in enum class com.boschrexroth.api.AllowedOperation: operation check is allowed
isConnected() - Method in interface com.boschrexroth.api.Client: Checks if the client is currently connected to the data layer.
isConnected() - Method in interface com.boschrexroth.api.Provider: Returns whether provider is connected

J

JSONConverter() - Method in interface com.boschrexroth.api.DlSystem: Returns the datalayer json converter

L

LIMIT_MAX - Enum constant in enum class com.boschrexroth.api.Result: THE MAXIMUM OF A LIMITATION IS EXCEEDED.
LIMIT_MIN - Enum constant in enum class com.boschrexroth.api.Result: THE MINIMUM OF A LIMITATION IS EXCEEDED.

M

MEMORY - Enum constant in enum class com.boschrexroth.api.Schema: MEMORY
MEMORY_MAP - Enum constant in enum class com.boschrexroth.api.Schema: MEMORY_MAP
metadata(BulkResponseCallback, String[]) - Method in interface com.boschrexroth.api.Bulk: Reads metadata of nodes using a bulk operation.
metadata(String[]) - Method in interface com.boschrexroth.api.Bulk: Reads metadata of nodes using a bulk operation.
Metadata(String) - Method in interface com.boschrexroth.api.Client: Retrieves the metadata for the specified address.
METADATA - Enum constant in enum class com.boschrexroth.api.Schema: METADATA
metadataAsync(String, ClientResponseCallback) - Method in interface com.boschrexroth.api.Client: Asynchronously retrieves metadata for the data item at the specified address.
MetadataBuilder - Interface in com.boschrexroth.api: This module provides helper classes to deal with metadata flatbuffers.
metadataSync(String, Variant) - Method in interface com.boschrexroth.api.Client: Synchronously retrieves metadata for the data item at the specified address.
MISSING_ARGUMENT - Enum constant in enum class com.boschrexroth.api.Result: MISSING ARGUMENT (EG.

N

NONE - Enum constant in enum class com.boschrexroth.api.AllowedOperation: NONE
NOT_INITIALIZED - Enum constant in enum class com.boschrexroth.api.Result: OBJECT NOT INITIALIZED YET
NotifyItem - Interface in com.boschrexroth.api: The notify item will be sent when the data value has been updated (e.g.
NotifyItemPublish - Interface in com.boschrexroth.api: NotifyItemPublish interface for publish subscription items.

O

OK - Enum constant in enum class com.boschrexroth.api.Result: FUNCTION CALL SUCCEEDED
OK_NO_CONTENT - Enum constant in enum class com.boschrexroth.api.Result: FUNCTION CALL SUCCEEDED WITH NO CONTENT
onBrowse(ProviderNodeEvent) - Method in interface com.boschrexroth.api.ProviderNodeCallback: onBrowse
onCreate(ProviderNodeEventData) - Method in interface com.boschrexroth.api.ProviderNodeCallback: onCreate
onMetadata(ProviderNodeEvent) - Method in interface com.boschrexroth.api.ProviderNodeCallback: onMetadata
onRead(ProviderNodeEventData) - Method in interface com.boschrexroth.api.ProviderNodeCallback: onRead
onRemove(ProviderNodeEvent) - Method in interface com.boschrexroth.api.ProviderNodeCallback: onRemove
onResponse(BulkResponse[]) - Method in interface com.boschrexroth.api.BulkResponseCallback: Called when an asynchronous bulk request is ready.
onResponse(Result, Variant) - Method in interface com.boschrexroth.api.ClientResponseCallback: Called when an asynchronous DLR client request is ready.
onSubscribe(ProviderNodeSubscription) - Method in interface com.boschrexroth.api.ProviderNodeSubCallback: onSubscribe
onSubscription(Result, NotifyItem[]) - Method in interface com.boschrexroth.api.SubscriptionCallback: onSubscription
onUnsubscribe(ProviderNodeSubscription) - Method in interface com.boschrexroth.api.ProviderNodeSubCallback: onUnsubscribe
onWrite(ProviderNodeEventData) - Method in interface com.boschrexroth.api.ProviderNodeCallback: onWrite
OUT_OF_MEMORY - Enum constant in enum class com.boschrexroth.api.Result: OUT OF MEMORY OR RESOURCES (RAM, SOCKETS, HANDLES, DISK SPACE ...).

P

parseJsonComplex(byte[], byte[], Variant) - Method in interface com.boschrexroth.api.Converter: This function generates a Variant out of a JSON string containing the (complex) data.
parseJsonComplex(String, byte[], Variant) - Method in interface com.boschrexroth.api.Converter: This function generates a Variant out of a JSON string containing the (complex) data.
parseJsonSimple(byte[], Variant) - Method in interface com.boschrexroth.api.Converter: This function generates out of a JSON string containing the (simple) data
parseJsonSimple(String, Variant) - Method in interface com.boschrexroth.api.Converter: This function generates out of a JSON string containing the (simple) data
Password(String) - Method in interface com.boschrexroth.api.RemoteBuilder: Password of the user
PERMISSION_DENIED - Enum constant in enum class com.boschrexroth.api.Result: REQUEST DECLINED DUE TO MISSING PERMISSION RIGHTS
PING - Enum constant in enum class com.boschrexroth.api.TimeoutSetting: timeout to wait for a response for a request - it timeout exceeds request will be aborted with DL_TIMEOUT
pingAsync(ClientResponseCallback) - Method in interface com.boschrexroth.api.Client: Performs an asynchronous ping operation to check the connectivity and responsiveness of the data layer.
pingSync() - Method in interface com.boschrexroth.api.Client: Performs a synchronous ping operation to check the connectivity and responsiveness of the data layer.
Port(int) - Method in interface com.boschrexroth.api.RemoteBuilder: Port number for a SSL connection.
Port(String) - Method in interface com.boschrexroth.api.RemoteBuilder: Port number for a SSL connection.
PortVirtual() - Method in interface com.boschrexroth.api.RemoteBuilder: ctrlX COREvirtual with port forwarding: Use the host port (default 8443) forwarded to port 22 of the ctrlX COREvirtual
PROBLEM - Enum constant in enum class com.boschrexroth.api.Schema: PROBLEM
Provider - Interface in com.boschrexroth.api: Provider interface to manage provider nodes
ProviderNode - Interface in com.boschrexroth.api: Datalayer ProviderNode Instance
ProviderNodeCallback - Interface in com.boschrexroth.api: Callback interface for Provider Node
ProviderNodeEvent - Interface in com.boschrexroth.api: ProviderNodeEvent event
ProviderNodeEventData - Interface in com.boschrexroth.api: ProviderNodeEventData
ProviderNodeSubCallback - Interface in com.boschrexroth.api: Callback interface for Provider Node Subscribe
ProviderNodeSubscription - Interface in com.boschrexroth.api: Interface ProviderNodeSubscription
ProviderSubscription - Interface in com.boschrexroth.api: Interface to manage subscription.
publish(Result, NotifyItemPublish[]) - Method in interface com.boschrexroth.api.ProviderSubscription: Publishes new data for this subscription
publishEvent(Variant, Variant) - Method in interface com.boschrexroth.api.Provider: Publishes an event

R

RAW - Enum constant in enum class com.boschrexroth.api.VariantType: raw bytes
read(BulkReadArg[]) - Method in interface com.boschrexroth.api.Bulk: Read read values using a bulk operation.
read(BulkResponseCallback, BulkReadArg[]) - Method in interface com.boschrexroth.api.Bulk: Read read values using a bulk operation.
READ - Enum constant in enum class com.boschrexroth.api.AllowedOperation: READ
READ - Enum constant in enum class com.boschrexroth.api.ReferenceType: Type when reading a value
READ_IN - Enum constant in enum class com.boschrexroth.api.ReferenceType: Input type when reading a value
READ_OUT - Enum constant in enum class com.boschrexroth.api.ReferenceType: Output type when reading a value
readAsync(String, Variant, ClientResponseCallback) - Method in interface com.boschrexroth.api.Client: Asynchronously reads a value from the specified address in the data layer.
readJsonSync(Converter, String, Variant, int) - Method in interface com.boschrexroth.api.Client: Reads a values as a JSON string
readSync(String, Variant) - Method in interface com.boschrexroth.api.Client: Synchronously reads a value from the specified address in the data layer.
RECONNECT - Enum constant in enum class com.boschrexroth.api.TimeoutSetting: timeout a reconnect attempt will be done if client looses connection to broker
ReferenceType - Enum Class in com.boschrexroth.api: List of reference types
REFLECTION - Enum constant in enum class com.boschrexroth.api.Schema: REFLECTION
registerNode(String, ProviderNode) - Method in interface com.boschrexroth.api.Provider: Register a node callback to the datalayer
registerType(String, String) - Method in interface com.boschrexroth.api.Provider: Register a type to the datalayer
registerTypeVariant(String, Variant) - Method in interface com.boschrexroth.api.Provider: Register a type to the datalayer
RemoteBuilder - Interface in com.boschrexroth.api: This type provides auxiliary methods to create ctrlX Datalayer client and provider connection strings to ctrlX CORE devices.
removeAsync(String, ClientResponseCallback) - Method in interface com.boschrexroth.api.Client: Asynchronously removes the data item at the specified address from the data layer.
removeSync(String) - Method in interface com.boschrexroth.api.Client: Synchronously removes the data item at the specified address from the data layer.
RESOURCE_UNAVAILABLE - Enum constant in enum class com.boschrexroth.api.Result: RESOURCE UNAVAILABLE
Result - Enum Class in com.boschrexroth.api: Represents the Datalayer Result Values
RT_INVALID_ERROR - Enum constant in enum class com.boschrexroth.api.Result: INTERNAL RT ERROR
RT_INVALID_MEMORY_MAP - Enum constant in enum class com.boschrexroth.api.Result: INVALID MEMORY MAP
RT_INVALID_OBJECT - Enum constant in enum class com.boschrexroth.api.Result: INVALID OBJECT
RT_INVALID_RETAIN - Enum constant in enum class com.boschrexroth.api.Result: INVALID MEMORY MAP
RT_MALLOC_FAILED - Enum constant in enum class com.boschrexroth.api.Result: allocation of shared memory failed - datalayer-shm connected?
RT_MEMORY_LOCKED - Enum constant in enum class com.boschrexroth.api.Result: MEMORY ALREADY LOCKED
RT_NO_VALID_DATA - Enum constant in enum class com.boschrexroth.api.Result: NO VALID DATA
RT_NOT_OPEN - Enum constant in enum class com.boschrexroth.api.Result: NOT OPEN
RT_WOULD_BLOCK - Enum constant in enum class com.boschrexroth.api.Result: beginAccess would block because there are no data
RT_WRONG_REVISION - Enum constant in enum class com.boschrexroth.api.Result: WRONG MEMORY REVISION

S

Schema - Enum Class in com.boschrexroth.api: Represents the Datalayer Schema Values
SEC_INVALID_SESSION - Enum constant in enum class com.boschrexroth.api.Result: token not valid (session not found)
SEC_INVALID_TOKEN_CONTENT - Enum constant in enum class com.boschrexroth.api.Result: token has wrong content
SEC_NO_TOKEN_token - Enum constant in enum class com.boschrexroth.api.Result: no token found
SEC_PAYMENT_REQUIRED - Enum constant in enum class com.boschrexroth.api.Result: payment required
SEC_UNAUTHORIZED - Enum constant in enum class com.boschrexroth.api.Result: unauthorized
setArrayOfBool8(boolean[]) - Method in interface com.boschrexroth.api.Variant: Set a array of bool
setArrayOfFloat32(float[]) - Method in interface com.boschrexroth.api.Variant: Set a array of float32
setArrayOfFloat64(double[]) - Method in interface com.boschrexroth.api.Variant: Set a array of double
setArrayOfInstant(Instant[]) - Method in interface com.boschrexroth.api.Variant: Set a array of Instant
setArrayOfInt16(short[]) - Method in interface com.boschrexroth.api.Variant: Set a array of int16
setArrayOfInt32(int[]) - Method in interface com.boschrexroth.api.Variant: Set a array of int
setArrayOfInt64(long[]) - Method in interface com.boschrexroth.api.Variant: Set a array of int64
setArrayOfInt8(byte[]) - Method in interface com.boschrexroth.api.Variant: Set a array of int8
setArrayOfStrings(String[]) - Method in interface com.boschrexroth.api.Variant: Set a array of string
setArrayOfUint16(short[]) - Method in interface com.boschrexroth.api.Variant: Set a array of uint16
setArrayOfUint32(int[]) - Method in interface com.boschrexroth.api.Variant: Set a array of uint32
setArrayOfUint64(long[]) - Method in interface com.boschrexroth.api.Variant: Set a array of uint64
setArrayOfUint8(byte[]) - Method in interface com.boschrexroth.api.Variant: Set a array of uint8
setAuthToken(String) - Method in interface com.boschrexroth.api.Client: Set persistent security access token for authentication as JWT payload
setBfbsPath(String) - Method in interface com.boschrexroth.api.DlSystem: Sets the base path to bfbs files
setBool8(boolean) - Method in interface com.boschrexroth.api.Variant: Set a bool value
setDisplayFormat(byte) - Method in interface com.boschrexroth.api.MetadataBuilder: set display format
setDisplayName(String) - Method in interface com.boschrexroth.api.MetadataBuilder: set the display name
setErrorInterval(int) - Method in interface com.boschrexroth.api.SubscriptionPropertiesBuilder: Error Interval
setEventType(String) - Method in interface com.boschrexroth.api.NotifyItemPublish: Sets eventtype of the NotifyInfoT
setFlatbuffers(byte[]) - Method in interface com.boschrexroth.api.Variant: Set a flatbuffers
setFlatbuffers(ByteBuffer) - Method in interface com.boschrexroth.api.Variant: Set a flatbuffers
setFLOAT32(float) - Method in interface com.boschrexroth.api.Variant: Set a float32 value
setFLOAT64(double) - Method in interface com.boschrexroth.api.Variant: Set a float64 value
setInstant(Instant) - Method in interface com.boschrexroth.api.Variant: Set a Instant value as timestamp (FILETIME) 64 bit 100ns since 1.1.1601 (UTC)
setInt16(short) - Method in interface com.boschrexroth.api.Variant: Set a int16 value
setInt32(int) - Method in interface com.boschrexroth.api.Variant: Set a int32 value
setInt64(long) - Method in interface com.boschrexroth.api.Variant: Set a int64 value
setInt8(byte) - Method in interface com.boschrexroth.api.Variant: Set a int8 value
setKeepAliveInterval(int) - Method in interface com.boschrexroth.api.SubscriptionPropertiesBuilder: KeepAlive Interval
setNodeClass(byte) - Method in interface com.boschrexroth.api.MetadataBuilder: set the node class
setNotifyType(int) - Method in interface com.boschrexroth.api.NotifyItemPublish: Set notify type
setOperations(int) - Method in interface com.boschrexroth.api.MetadataBuilder: set allowed operations
setPublishInterval(int) - Method in interface com.boschrexroth.api.SubscriptionPropertiesBuilder: Publish Interval
setRaw(byte[]) - Method in interface com.boschrexroth.api.Variant: Set an raw value
setRaw(ByteBuffer) - Method in interface com.boschrexroth.api.Variant: Set an raw value
setSequenceNumber(long) - Method in interface com.boschrexroth.api.NotifyItemPublish: Sets sequence number of the NotifyInfoT
setSourceName(String) - Method in interface com.boschrexroth.api.NotifyItemPublish: Sets source name of the NotifyInfoT
setSTRING(String) - Method in interface com.boschrexroth.api.Variant: Set a string value
setTimeout(TimeoutSetting, int) - Method in interface com.boschrexroth.api.Client: Sets a timeout for subsequent operations.
setTimeoutNode(ProviderNode, long) - Method in interface com.boschrexroth.api.Provider: Set timeout for a node for asynchron requests (default value is 1000ms)
setTimestamp(Instant) - Method in interface com.boschrexroth.api.NotifyItemPublish: Sets a Instant value, see NotifyInfoT
setUint16(short) - Method in interface com.boschrexroth.api.Variant: Set a uin16 value
setUint32(int) - Method in interface com.boschrexroth.api.Variant: Set a uint32 value *
setUint64(long) - Method in interface com.boschrexroth.api.Variant: Set a uint64 value
setUint8(byte) - Method in interface com.boschrexroth.api.Variant: Set a uin8 value
setUnit(String) - Method in interface com.boschrexroth.api.MetadataBuilder: set the unit
SIZE_MISMATCH - Enum constant in enum class com.boschrexroth.api.Result: SIZE MISMATCH, PRESENT SIZE DOESN'T MATCH REQUESTED SIZE.
start() - Method in interface com.boschrexroth.api.Provider: Starts the provider.
start(boolean) - Method in interface com.boschrexroth.api.DlSystem: Starts a dalayer system
stop() - Method in interface com.boschrexroth.api.Provider: Stop the provider
stop(boolean) - Method in interface com.boschrexroth.api.DlSystem: Stops a dalayer system
STRING - Enum constant in enum class com.boschrexroth.api.VariantType: string (UTF-8)
SUBMODULE_FAILURE - Enum constant in enum class com.boschrexroth.api.Result: ERROR IN SUBMODULE
subscribe(String[]) - Method in interface com.boschrexroth.api.Subscription: Subscribe registers to all passed addresses.
Subscription - Interface in com.boschrexroth.api: Represents a client subscription interface
SubscriptionCallback - Interface in com.boschrexroth.api: Callback interface for client subscriptions
SubscriptionPropertiesBuilder - Interface in com.boschrexroth.api: This module provides helper classes to deal with subscriptionproperties flatbuffers.

T

TIMEOUT - Enum constant in enum class com.boschrexroth.api.Result: REQUEST TIMEOUT
TimeoutSetting - Enum Class in com.boschrexroth.api: Represents the Datalayer TimeoutSetting Values Settings of different timeout values
TIMESTAMP - Enum constant in enum class com.boschrexroth.api.VariantType: timestamp (FILETIME) 64 bit 100ns since 1.1.1601 (UTC)
TOKEN - Enum constant in enum class com.boschrexroth.api.Schema: TOKEN
TOO_MANY_ARGUMENTS - Enum constant in enum class com.boschrexroth.api.Result: TO MANY ARGUMENT
TOO_MANY_OPERATIONS - Enum constant in enum class com.boschrexroth.api.Result: REQUEST CAN'T BE HANDLED DUE TO TOO MANY OPERATIONS
TYPE_MISMATCH - Enum constant in enum class com.boschrexroth.api.Result: WRONG FLATBUFFER TYPE, WRONG DATA TYPE

U

UINT16 - Enum constant in enum class com.boschrexroth.api.VariantType: unsigned int 16 bit
UINT32 - Enum constant in enum class com.boschrexroth.api.VariantType: unsigned int 32 bit
UINT64 - Enum constant in enum class com.boschrexroth.api.VariantType: unsigned int 64 bit
UINT8 - Enum constant in enum class com.boschrexroth.api.VariantType: unsigned int 8 bit
UNKNOWN - Enum constant in enum class com.boschrexroth.api.VariantType: unknown data type
unregisterNode(String) - Method in interface com.boschrexroth.api.Provider: Unregister a node from the datalayer
unregisterType(String) - Method in interface com.boschrexroth.api.Provider: Unregister a type from the datalayer
unsubscribe(String[]) - Method in interface com.boschrexroth.api.Subscription: Unsubscribe unregisters all passed addresses.
unsubscribeAll() - Method in interface com.boschrexroth.api.Subscription: Removes a set of nodes from a subscription id
UNSUPPORTED - Enum constant in enum class com.boschrexroth.api.Result: FUNCTION NOT IMPLEMENTED
User(String) - Method in interface com.boschrexroth.api.RemoteBuilder: Name of the user
USES - Enum constant in enum class com.boschrexroth.api.ReferenceType: Referenced (list of) absolute node addresses.

V

valueOf(String) - Static method in enum class com.boschrexroth.api.AllowedOperation: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.boschrexroth.api.ReferenceType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.boschrexroth.api.Result: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.boschrexroth.api.Schema: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.boschrexroth.api.TimeoutSetting: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.boschrexroth.api.VariantType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.boschrexroth.api.AllowedOperation: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.boschrexroth.api.ReferenceType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.boschrexroth.api.Result: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.boschrexroth.api.Schema: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.boschrexroth.api.TimeoutSetting: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.boschrexroth.api.VariantType: Returns an array containing the constants of this enum class, in the order they are declared.
Variant - Interface in com.boschrexroth.api: Variant is a container for a many types of data.
VariantType - Enum Class in com.boschrexroth.api: Represents the Datalayer VariantType Values
VERSION_MISMATCH - Enum constant in enum class com.boschrexroth.api.Result: VERSION CONFLICT

W

WOULD_BLOCK - Enum constant in enum class com.boschrexroth.api.Result: REQUEST WOULD BLOCK, YOU HAVE CALLED A SYNCHRONOUS FUNCTION IN A CALLBACK FROM A ASYNCHRONOUS FUNCTION
write(BulkResponseCallback, BulkWriteArg[]) - Method in interface com.boschrexroth.api.Bulk: Write writes nodes using a bulk operation.
write(BulkWriteArg[]) - Method in interface com.boschrexroth.api.Bulk: Write writes nodes using a bulk operation.
WRITE - Enum constant in enum class com.boschrexroth.api.AllowedOperation: WRITE
WRITE - Enum constant in enum class com.boschrexroth.api.ReferenceType: Type when writing a value (absolute node address).
WRITE_IN - Enum constant in enum class com.boschrexroth.api.ReferenceType: Input type when writing a value.
WRITE_OUT - Enum constant in enum class com.boschrexroth.api.ReferenceType: Output type when writing a value.
writeAsync(String, Variant, ClientResponseCallback) - Method in interface com.boschrexroth.api.Client: Asynchronously writes a value to the specified address in the data layer.
writeJsonSync(Converter, String, String, Variant) - Method in interface com.boschrexroth.api.Client: This function writes a JSON value
writeSync(String, Variant) - Method in interface com.boschrexroth.api.Client: Synchronously writes a value to the specified address in the data layer.

A B C D F G H I J L M N O P R S T U V W
All Classes and Interfaces|All Packages