A

Action - Variable in class com.scaleoutsoftware.digitaltwin.datasource.aws.RegistrationMessage

 

addAlertProvider(AlertProviderConfiguration) - Method in class com.scaleoutsoftware.digitaltwin.deployment.ExecutionEnvironmentBuilder

Add an AlertProvider to this execution environment

addAlertProvider(String, AlertProviderConfiguration) - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench

Adds an alert provider configuration to the specified model on this workbench.

addAlertProvider(String, AlertProviderConfiguration, boolean) - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench

Adds an alert provider configuration to the specified model on this workbench.

addAzureDigitalTwinPersistence(String, String) - Method in class com.scaleoutsoftware.digitaltwin.deployment.ExecutionEnvironmentBuilder

 

addDefaultPersistence(String) - Method in class com.scaleoutsoftware.digitaltwin.deployment.ExecutionEnvironmentBuilder

 

addDependencyJar(String) - Method in class com.scaleoutsoftware.digitaltwin.deployment.ExecutionEnvironmentBuilder

Adds a JAR that contains DigitalTwin class definitions, MessageProcessor definitions, Message definitions, or other dependencies.

addDigitalTwin(String, MessageProcessor<T, V>, SimulationProcessor<T>, Class<T>, Class<V>) - Method in class com.scaleoutsoftware.digitaltwin.deployment.ExecutionEnvironmentBuilder

Adds a digital twin model to this ExecutionEnvironment

addDigitalTwin(String, MessageProcessor<T, V>, Class<T>, Class<V>) - Method in class com.scaleoutsoftware.digitaltwin.deployment.ExecutionEnvironmentBuilder

Adds a digital twin model to this ExecutionEnvironment

addInstance(String, String, DigitalTwinBase) - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench

Adds a digital twin instance to the workbench.

addJar(String) - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotEndpointBuilder

Used to add any third party JARs to the classpath of the aws iot endpoint.

addRealTimeModel(String, MessageProcessor<T, V>, Class<T>, Class<V>) - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench

Adds a real-time digital twin model to the workbench.

addSimulationModel(String, MessageProcessor<T, V>, SimulationProcessor<T>, Class<T>, Class<V>) - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench

Adds a simulation digital twin model to the workbench.

addSqlitePersistence(String) - Method in class com.scaleoutsoftware.digitaltwin.deployment.ExecutionEnvironmentBuilder

 

addSqlServerPersistence(String) - Method in class com.scaleoutsoftware.digitaltwin.deployment.ExecutionEnvironmentBuilder

 

addSubscription(String, String, String) - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotSubscriptionManager

 

addTopic(String, String, String) - Method in class com.scaleoutsoftware.digitaltwin.datasource.kafka.KafkaEndpointBuilder

Adds consume and produce data source topics for a DigitalTwin model.

AlertMessage - Class in com.scaleoutsoftware.digitaltwin.core

A message that should be sent to a configured alert provider.

AlertMessage(String, String, String) - Constructor for class com.scaleoutsoftware.digitaltwin.core.AlertMessage

Construct an alert message with a title, severity, and custom message.

AlertMessage(String, String, String, HashMap<String, String>) - Constructor for class com.scaleoutsoftware.digitaltwin.core.AlertMessage

Construct an alert message with a title, severity, and custom message.

AlertProviderConfiguration - Class in com.scaleoutsoftware.digitaltwin.core

Configuration for an alert provider.

AlertProviderConfiguration(String, String, String, String, String, String) - Constructor for class com.scaleoutsoftware.digitaltwin.core.AlertProviderConfiguration

Construct an alert provider configuration.

AppEndpoint - Class in com.scaleoutsoftware.digitaltwin.datasource

The MessageDispatcher sends messages to a DigitalTwin

AppEndpoint() - Constructor for class com.scaleoutsoftware.digitaltwin.datasource.AppEndpoint

 

AppEndpointException - Exception in com.scaleoutsoftware.digitaltwin.datasource

Thrown if an error occurs while sending a message to a DigitalTwin

AppEndpointException(Exception) - Constructor for exception com.scaleoutsoftware.digitaltwin.datasource.AppEndpointException

Creates a AppEndpointException with the parameter message

AppEndpointException(String) - Constructor for exception com.scaleoutsoftware.digitaltwin.datasource.AppEndpointException

Creates a AppEndpointException with the parameter message and inner exception

AppEndpointException(String, Exception) - Constructor for exception com.scaleoutsoftware.digitaltwin.datasource.AppEndpointException

Creates a AppEndpointException with the parameter message and inner exception

AwsIotAction - Enum in com.scaleoutsoftware.digitaltwin.datasource.aws

Enum AwsIotAction defines the supported actions when registering a device through the AwsIotHub with ScaleOut StreamServer.

AwsIotEndpoint - Class in com.scaleoutsoftware.digitaltwin.datasource.aws

The AwsIotEndpoint is used to establish a running grid that connects into AwsIoT Core.

AwsIotEndpointBuilder - Class in com.scaleoutsoftware.digitaltwin.datasource.aws

The AwsIotEndpointBuilder is used to create an endpoint between AWS IoT Core and the digital twin's ExecutionEnvironment (Deployed Model).

AwsIotEndpointBuilder(String, String, String, String, String) - Constructor for class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotEndpointBuilder

Creates an AwsIotEndpointBuilder

AwsIotEndpointException - Exception in com.scaleoutsoftware.digitaltwin.datasource.aws

Thrown if an error occurs while establishing the AwsIotEndpoint grid.

AwsIotEndpointException(Exception) - Constructor for exception com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotEndpointException

Creates a AwsIotEndpointException with the parameter message

AwsIotEndpointException(String) - Constructor for exception com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotEndpointException

Creates a AwsIotEndpointException with the parameter message and inner exception

AwsIotEndpointException(String, Exception) - Constructor for exception com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotEndpointException

Creates a AwsIotEndpointException with the parameter message and inner exception

AwsIotMultiplexer - Class in com.scaleoutsoftware.digitaltwin.datasource.aws

The AwsIotMultiplexer handles incoming messages from AWS IoT core

AwsIotObservingSubscriber - Class in com.scaleoutsoftware.digitaltwin.datasource.aws

The AwsIotObservingSubscriber handles establishing new connections with AWS IoT core and reposting messages from AWS IoT core to established DigitalTwins.

AwsIotSubscriptionManager - Class in com.scaleoutsoftware.digitaltwin.datasource.aws

Manages subscriptions to AWS IoT hub.

AwsIotSubscriptionManager() - Constructor for class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotSubscriptionManager

 

AwsIotSubscriptionMetadata - Class in com.scaleoutsoftware.digitaltwin.datasource.aws

The AwsIotSubscription metadata stored information about a connected data source.

AwsIotSubscriptionMetadata(String, String, String) - Constructor for class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotSubscriptionMetadata

 

AzureDigitalTwinPersistentStorage<V extends DigitalTwinBase> - Class in com.scaleoutsoftware.digitaltwin.persistentstorage

Persistent storage for AzureDigitalTwins - transparently store and load digital twins to and from Azure Digital Twins.

AzureDigitalTwinPersistentStorage(String, Class<V>) - Constructor for class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinPersistentStorage

 

AzureDigitalTwinsPersistenceProvider - Class in com.scaleoutsoftware.digitaltwin.persistentstorage

AzureDigitalTwinsPersistenceProvider is a persistence provider implementation that is backed by Azure Digital Twins.

AzureDigitalTwinsPersistenceProvider(String) - Constructor for class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinsPersistenceProvider

 

AzureDigitalTwinsService - com.scaleoutsoftware.digitaltwin.core.PersistenceProviderType

Enum for the Azure Digital Twin service.

B

build() - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotEndpointBuilder

Loads the AwsIotEndpoint and establishes the registration topic listener.

build() - Method in class com.scaleoutsoftware.digitaltwin.datasource.kafka.KafkaEndpointBuilder

Starts the execution environment which will consume and produce messages from Kafka.

build() - Method in class com.scaleoutsoftware.digitaltwin.deployment.ExecutionEnvironmentBuilder

Initializes the ExecutionEnvironment and hosts all attached digital twins.

C

com.scaleoutsoftware.digitaltwin.core - package com.scaleoutsoftware.digitaltwin.core

Digital twin model API - Create a digital twin model.

com.scaleoutsoftware.digitaltwin.datasource - package com.scaleoutsoftware.digitaltwin.datasource

Digital twin connector API - Application endpoint used to send messages to digital twin instances from a Java client

com.scaleoutsoftware.digitaltwin.datasource.aws - package com.scaleoutsoftware.digitaltwin.datasource.aws

Digital twin connector API - AwsIoTEndpoint used to allow DigitalTwins to send and receive messages using AWS IoT core

com.scaleoutsoftware.digitaltwin.datasource.kafka - package com.scaleoutsoftware.digitaltwin.datasource.kafka

Digital twin connector API - KafkaEndpoint used to allow DigitalTwins to send and receive messages using a Kafka deployment

com.scaleoutsoftware.digitaltwin.deployment - package com.scaleoutsoftware.digitaltwin.deployment

Digital twin deployment API - Deploys Digital Twin models for message processing

com.scaleoutsoftware.digitaltwin.development - package com.scaleoutsoftware.digitaltwin.development

Digital twin development API - Develop and test simulation/real-time digital twins.

com.scaleoutsoftware.digitaltwin.persistentstorage - package com.scaleoutsoftware.digitaltwin.persistentstorage

Digital twin persistent storage APIs - Persists digital twin state.

createInstance(String, String, T) - Method in interface com.scaleoutsoftware.digitaltwin.core.SimulationController

Create a new digital twin instance for simulation processing.

createInstance(String, String, T) - Static method in class com.scaleoutsoftware.digitaltwin.datasource.AppEndpoint

Creates a digital twin instance.

createInstanceFromPersistenceStore(String, String) - Method in interface com.scaleoutsoftware.digitaltwin.core.SimulationController

Create a new digital twin instance for simulation processing from a persistence store.

createInstanceFromPersistenceStore(String, String) - Static method in class com.scaleoutsoftware.digitaltwin.datasource.AppEndpoint

Creates a digital twin instance.

createInstanceFromPersistenceStore(String, String, T) - Method in interface com.scaleoutsoftware.digitaltwin.core.SimulationController

The twin instance will be loaded via model name and id from a persistence store.

createInstanceFromPersistenceStore(String, String, T) - Static method in class com.scaleoutsoftware.digitaltwin.datasource.AppEndpoint

Creates a digital twin instance.

D

DefaultPersistentStorage<V extends DigitalTwinBase> - Class in com.scaleoutsoftware.digitaltwin.persistentstorage

Default persistent storage - transparently store and load digital twins to and from the configured default persistent storage.

DefaultPersistentStorage(String, Class<V>) - Constructor for class com.scaleoutsoftware.digitaltwin.persistentstorage.DefaultPersistentStorage

 

delay(Duration) - Method in interface com.scaleoutsoftware.digitaltwin.core.SimulationController

Delay simulation processing for this DigitalTwin instance for a duration of time.

deleteInstance(String, String) - Method in interface com.scaleoutsoftware.digitaltwin.core.SimulationController

Delete and remove a digital twin instance from simulation processing.

deleteInstance(String, String) - Static method in class com.scaleoutsoftware.digitaltwin.datasource.AppEndpoint

Creates a digital twin instance.

deleteThisInstance() - Method in interface com.scaleoutsoftware.digitaltwin.core.SimulationController

Delete and remove this digital twin instance from simulation processing.

Deregister - com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotAction

 

DigitalTwinBase - Class in com.scaleoutsoftware.digitaltwin.core

A real-time digital twin of a data source.

DigitalTwinBase() - Constructor for class com.scaleoutsoftware.digitaltwin.core.DigitalTwinBase

 

DigitalTwinTimerMessage - Class in com.scaleoutsoftware.digitaltwin.core

A message sent to a digital twin instance's message processor.

DigitalTwinTimerMessage(String, String, int, String, TimerType) - Constructor for class com.scaleoutsoftware.digitaltwin.core.DigitalTwinTimerMessage

Construct a digital twin timer message.

E

emitTelemetry(String, byte[]) - Method in interface com.scaleoutsoftware.digitaltwin.core.SimulationController

Asynchronously send a JSON serialized message to a DigitalTwin instance that will be processed by the DigitalTwin models MessageProcessor.processMessages(ProcessingContext, DigitalTwinBase, Iterable) method.

emitTelemetry(String, Object) - Method in interface com.scaleoutsoftware.digitaltwin.core.SimulationController

Asynchronously send a JSON serializable message to a DigitalTwin instance that will be processed by the DigitalTwin models MessageProcessor.processMessages(ProcessingContext, DigitalTwinBase, Iterable) method.

EndTimeReached - com.scaleoutsoftware.digitaltwin.core.SimulationStatus

 

Enqueued - com.scaleoutsoftware.digitaltwin.core.SendingResult

Enqueued indicates that a message was successfully formed and then sent to an internal messaging service

ExecutionEnvironment - Class in com.scaleoutsoftware.digitaltwin.deployment

Creates an ExecutionEnvironment for hosting DigitalTwins

ExecutionEnvironmentBuilder - Class in com.scaleoutsoftware.digitaltwin.deployment

The ExecutionEnvironmentBuilder is used to create and deploy the ExecutionEnvironment for hosting digital twins

ExecutionEnvironmentBuilder() - Constructor for class com.scaleoutsoftware.digitaltwin.deployment.ExecutionEnvironmentBuilder

Instantiates this builder

ExecutionEnvironmentException - Exception in com.scaleoutsoftware.digitaltwin.deployment

Thrown if an error occurs while establishing the ExecutionEnvironment

ExecutionEnvironmentException(Exception) - Constructor for exception com.scaleoutsoftware.digitaltwin.deployment.ExecutionEnvironmentException

Instantiates a ExecutionEnvironmentException with the parameter inner exception

ExecutionEnvironmentException(String) - Constructor for exception com.scaleoutsoftware.digitaltwin.deployment.ExecutionEnvironmentException

Instantiates a ExecutionEnvironmentException with the parameter message

ExecutionEnvironmentException(String, Exception) - Constructor for exception com.scaleoutsoftware.digitaltwin.deployment.ExecutionEnvironmentException

Instantiates a ExecutionEnvironmentException with the parameter message and inner exception

F

FailedInternalError - com.scaleoutsoftware.digitaltwin.core.TimerActionResult

Failed to start/stop timer due to an internal error.

FailedNoSuchTimer - com.scaleoutsoftware.digitaltwin.core.TimerActionResult

Failed to stop the existing timer, the timer is no longer active.

FailedTimerAlreadyExists - com.scaleoutsoftware.digitaltwin.core.TimerActionResult

Failed to start the timer, the timer with the specified name already exists.

FailedTooManyTimers - com.scaleoutsoftware.digitaltwin.core.TimerActionResult

Failed to start a new timer due to reaching the limit for a number of active timers.

fromOrdinal(int) - Static method in enum com.scaleoutsoftware.digitaltwin.core.PersistenceProviderType

Return the PersistenceProviderType from an ordinal value.

fromOrdinal(int) - Static method in enum com.scaleoutsoftware.digitaltwin.core.TimerActionResult

Convert an ordinal into a TimerActionResult.

fromString(String) - Static method in enum com.scaleoutsoftware.digitaltwin.core.PersistenceProviderType

Return the PersistenceProviderType from a string value.

G

generateModelSchema(String) - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench

Generates a ModelSchema for the defined model

generateModelSchema(String, String) - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench

Generates a ModelSchema for the parameter modelName and writes the schema to a file on the file system.

getAlertMessages() - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench

Retrieves alert messages from digital twin instances.

getAlertProviders() - Method in class com.scaleoutsoftware.digitaltwin.core.ModelSchema

Retrieve the alert provider configurations.

getAlertProviderType() - Method in class com.scaleoutsoftware.digitaltwin.core.AlertProviderConfiguration

Retrieve the alert provider type for this configuration.

getAssemblyName() - Method in class com.scaleoutsoftware.digitaltwin.core.ModelSchema

NOT USED BY JAVA MODEL SCHEMA

getAzureDigitalTwinModelName() - Method in class com.scaleoutsoftware.digitaltwin.core.ModelSchema

Retrieve the Azure Digital Twin model name.

getCurrentTime() - Method in class com.scaleoutsoftware.digitaltwin.core.ProcessingContext

Retrieves the current time.

getDataSourceId() - Method in class com.scaleoutsoftware.digitaltwin.core.ProcessingContext

Retrieve the unique Identifier for a DataSource (matches the Device/Datasource/Real-time twin ID)

getDigitalTwinModel() - Method in class com.scaleoutsoftware.digitaltwin.core.ProcessingContext

Retrieve the model for a DigitalTwin (matches the model of a Device/Datasource/real-time twin)

getEntityId() - Method in class com.scaleoutsoftware.digitaltwin.core.AlertProviderConfiguration

Retrieve the entity ID for this alert provider configuration.

getId() - Method in class com.scaleoutsoftware.digitaltwin.core.DigitalTwinBase

The identifier of this DigitalTwin.

getId() - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotSubscriptionMetadata

 

getIncomingMessages() - Method in interface com.scaleoutsoftware.digitaltwin.core.MessageFactory

Returns all incoming messages

getInstance(String, String) - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider

Retrieves an instance or null if it doesn't exist.

getInstance(String, String) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinsPersistenceProvider

Retrieves a twin instance or null if it doesn't exist.

getInstanceAsync(String, String) - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider

Retrieves a future that when complete will return an instance or null if it doesn't exist.

getInstanceAsync(String, String) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinsPersistenceProvider

Retrieves a future that when complete will return a twin instance or null if it doesn't exist.

getInstanceIds(String) - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider

Retrieves the instance IDs stored in a container, or an empty list if no instances exist.

getInstanceIds(String) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinsPersistenceProvider

Retrieves a list of instance IDs for a DTMI otherwise returns an empty list if no instances exist.

getInstanceIdsAsync(String) - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider

Retrieves a future that when complete will return the instance IDs stored in a container, or an empty list if no instances exist.

getInstanceIdsAsync(String) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinsPersistenceProvider

Retrieves a future that when complete will return a list of instance IDs for a DTMI otherwise returns an empty list if no instances exist.

getInstances(String) - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench

Retrieves DigitalTwin instances for a given model.

getIntegrationKey() - Method in class com.scaleoutsoftware.digitaltwin.core.AlertProviderConfiguration

Retrieve the integration key for this alert provider configuration.

getLoggedMessages(long) - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench

Retrieves messages logged by digital twin instances.

getMessage() - Method in class com.scaleoutsoftware.digitaltwin.core.AlertMessage

Retrieve the message for this alert message.

getMessage() - Method in exception com.scaleoutsoftware.digitaltwin.datasource.AppEndpointException

 

getMessage() - Method in exception com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotEndpointException

 

getMessage() - Method in exception com.scaleoutsoftware.digitaltwin.datasource.kafka.KafkaDeploymentException

 

getMessage() - Method in exception com.scaleoutsoftware.digitaltwin.deployment.ExecutionEnvironmentException

 

getMessage() - Method in exception com.scaleoutsoftware.digitaltwin.development.WorkbenchException

 

getMessageProcessorType() - Method in class com.scaleoutsoftware.digitaltwin.core.ModelSchema

Retrieve the message processor type (a MessageProcessor implementation).

getMessageType() - Method in class com.scaleoutsoftware.digitaltwin.core.ModelSchema

Retrieve the message type (JSON serializable message implementation).

getModel() - Method in class com.scaleoutsoftware.digitaltwin.core.DigitalTwinBase

The model for this DigitalTwin.

getModel() - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotSubscriptionMetadata

 

getModelName() - Method in class com.scaleoutsoftware.digitaltwin.core.DigitalTwinTimerMessage

Retrieve the digital twin model name.

getModelType() - Method in class com.scaleoutsoftware.digitaltwin.core.ModelSchema

Retrieve the digital twin model type (a DigitalTwinBase implementation).

getName() - Method in class com.scaleoutsoftware.digitaltwin.core.AlertProviderConfiguration

Retrieve the name of this alert provider configuration.

getNextSimulationTimeMs() - Method in class com.scaleoutsoftware.digitaltwin.core.DigitalTwinBase

 

getOptionalTwinInstanceProperties() - Method in class com.scaleoutsoftware.digitaltwin.core.AlertMessage

Retrieve the optional twin instance properties for this alert message.

getPersistencePolicy() - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinPersistentStorage

 

getPersistencePolicy() - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.DefaultPersistentStorage

 

getPersistencePolicy() - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.PersistentStorage

 

getPersistencePolicy() - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.SqlitePersistentStorage

 

getPersistencePolicy() - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.SqlServerPersistentStorage

 

getPersistenceProvider() - Method in class com.scaleoutsoftware.digitaltwin.core.ModelSchema

Retrieve the persistence provider type.

getPersistenceProvider() - Method in class com.scaleoutsoftware.digitaltwin.core.ProcessingContext

Returns the configured persistence provider or null if no persistence provider configuration can be found.

getProperty(String, String, String, Class<T>) - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider

Retrieves a property or null if the property does not exist.

getProperty(String, String, String, Class<T>) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinsPersistenceProvider

Retrieves a property or null if the property does not exist.

getPropertyAsync(String, String, String, Class<T>) - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider

Retrieves a future that will return a property or null if the property does not exist.

getPropertyAsync(String, String, String, Class<T>) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinsPersistenceProvider

Retrieves a future that will return a property or null if the property does not exist.

getPropertyMap(String) - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider

Retrieves a map of property names to property types, or an empty map.

getPropertyMap(String) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinsPersistenceProvider

Retrieves a map of property names to property, or an empty map.

getPropertyMapAsync(String) - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider

Retrieves a future that will return a map of property names to property, or an empty map.

getPropertyMapAsync(String) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinsPersistenceProvider

Retrieves a future that will return a map of property names to property, or an empty map.

getProviderType() - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider

Retrieves this persistence providers type.

getProviderType() - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinsPersistenceProvider

Retrieves this persistence providers type.

getResponseTopic() - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotSubscriptionMetadata

 

getRoutingKey() - Method in class com.scaleoutsoftware.digitaltwin.core.AlertProviderConfiguration

Retrieve the routing key for this alert provider configuration.

getRtdtProperty(String, String, Class<T>) - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider

Retrieves a property for a RTDT instance or null if the property does not exist.

getRtdtProperty(String, String, Class<T>) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinsPersistenceProvider

Retrieves a property for a RTDT instance or null if the property does not exist.

getRtdtPropertyAsync(String, String, Class<T>) - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider

Retrieves a future that will return a property value for a RTDT instance or null if the property doesn't exist.

getRtdtPropertyAsync(String, String, Class<T>) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinsPersistenceProvider

Retrieves a future that will return a property value for a RTDT instance or null if the property doesn't exist.

getSeverity() - Method in class com.scaleoutsoftware.digitaltwin.core.AlertMessage

Retrieve the severity for this alert message.

getSimulationController() - Method in class com.scaleoutsoftware.digitaltwin.core.ProcessingContext

Retrieve the running SimulationController or null if no simulation is running.

getSimulationProcessorType() - Method in class com.scaleoutsoftware.digitaltwin.core.ModelSchema

Retrieve the simulation processor type (a SimulationProcessor implementation).

getSimulationTimeIncrement() - Method in interface com.scaleoutsoftware.digitaltwin.core.SimulationController

Retrieves the current simulation time increment.

getStatus() - Method in class com.scaleoutsoftware.digitaltwin.development.SimulationStep

Retrieve the SimulationStatus of the simulation interval.

getSubscription(String, String) - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotSubscriptionManager

 

getTime() - Method in class com.scaleoutsoftware.digitaltwin.development.SimulationStep

Retrieve the time of the simulation interval.

getTime() - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench

Retrieves the current time interval of the simulation.

getTimerHandlerClass() - Method in class com.scaleoutsoftware.digitaltwin.core.TimerMetadata

Retrieves the timer handler class name.

getTimerId() - Method in class com.scaleoutsoftware.digitaltwin.core.DigitalTwinTimerMessage

Retrieve the timer ID.

getTimerId() - Method in class com.scaleoutsoftware.digitaltwin.core.TimerMetadata

Retrieves the timer ID.

getTimerInterval() - Method in class com.scaleoutsoftware.digitaltwin.core.TimerMetadata

Retrieves the timer interval.

getTimerName() - Method in class com.scaleoutsoftware.digitaltwin.core.DigitalTwinTimerMessage

Retrieve the timer name.

getTimerType() - Method in class com.scaleoutsoftware.digitaltwin.core.DigitalTwinTimerMessage

Retrieve the TimerType.

getTimerType() - Method in class com.scaleoutsoftware.digitaltwin.core.TimerMetadata

Retrieves the timer type.

getTitle() - Method in class com.scaleoutsoftware.digitaltwin.core.AlertMessage

Retrieve the title for this alert message.

getTwinId() - Method in class com.scaleoutsoftware.digitaltwin.core.DigitalTwinTimerMessage

Retrieve the digital twin ID.

getURL() - Method in class com.scaleoutsoftware.digitaltwin.core.AlertProviderConfiguration

Retrieve the URL for this alert provider configuration.

H

Handled - com.scaleoutsoftware.digitaltwin.core.SendingResult

Handled indicates that a message was successfully sent and processed

I

Id - Variable in class com.scaleoutsoftware.digitaltwin.core.DigitalTwinBase

The identifier for this twin instance

Id - Variable in class com.scaleoutsoftware.digitaltwin.datasource.aws.RegistrationMessage

 

init(String, String) - Method in class com.scaleoutsoftware.digitaltwin.core.DigitalTwinBase

Initialization method to set the identifier and model for a DigitalTwin instance.

initialize(HashMap<String, String>) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinPersistentStorage

 

initialize(HashMap<String, String>) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.DefaultPersistentStorage

 

initialize(HashMap<String, String>) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.PersistentStorage

 

initialize(HashMap<String, String>) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.SqlitePersistentStorage

 

initialize(HashMap<String, String>) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.SqlServerPersistentStorage

 

initializeSimulation(long, long, long) - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench

Initializes the simulation so that each interval can be run separately by calling the Workbench.step() function.

initializeSqliteConnection() - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.SqlitePersistentStorage

 

initializeSqlServerConnection() - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.SqlServerPersistentStorage

 

InstanceRequestedStop - com.scaleoutsoftware.digitaltwin.core.SimulationStatus

 

isActive() - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider

Returns true if this PersistenceProvider is active, false otherwise.

isActive() - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinPersistentStorage

 

isActive() - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinsPersistenceProvider

Returns true if this PersistenceProvider is active, false otherwise.

isActive() - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.DefaultPersistentStorage

 

isActive() - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.PersistentStorage

 

isActive() - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.SqlitePersistentStorage

 

isActive() - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.SqlServerPersistentStorage

 

isLocal() - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotSubscriptionMetadata

 

isSubscribed() - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotSubscriptionMetadata

 

K

KafkaDeploymentException - Exception in com.scaleoutsoftware.digitaltwin.datasource.kafka

Thrown if an error occurs connecting to Kafka, establishing the connector grid, or other exception occurs

KafkaDeploymentException(Exception) - Constructor for exception com.scaleoutsoftware.digitaltwin.datasource.kafka.KafkaDeploymentException

Creates a wrapper KafkaDeploymentException around an inner exception

KafkaDeploymentException(String) - Constructor for exception com.scaleoutsoftware.digitaltwin.datasource.kafka.KafkaDeploymentException

Creates a KafkaDeploymentException with no inner exception and message

KafkaDeploymentException(String, Exception) - Constructor for exception com.scaleoutsoftware.digitaltwin.datasource.kafka.KafkaDeploymentException

Creates a new KafkaDeploymentException with parameter message and inner exception

KafkaEndpoint - Class in com.scaleoutsoftware.digitaltwin.datasource.kafka

Creates a KafkaEndpoint which can be used to consume and produce messages from and to Kafka.

KafkaEndpointBuilder - Class in com.scaleoutsoftware.digitaltwin.datasource.kafka

The KafkaEndpointBuilder is used to create an endpoint between a Kafka server and the DigitalTwin execution environment.

KafkaEndpointBuilder(String, File) - Constructor for class com.scaleoutsoftware.digitaltwin.datasource.kafka.KafkaEndpointBuilder

Instantiates a KafkaEndpointBuilder with server properties to connect to Kafka.

KafkaEndpointBuilder(String, String) - Constructor for class com.scaleoutsoftware.digitaltwin.datasource.kafka.KafkaEndpointBuilder

Instantiates a KafkaEndpointBuilder with an azure connection string for connecting to Azure Kafka enabled EventHub.

KafkaRecordPosterAsJsonArray - Class in com.scaleoutsoftware.digitaltwin.datasource.kafka

The KafkaRecordPosterAsJsonArray concatenates consumed messages for a given DigitalTwin and posts the list of messages to the DigitalTwin.

KafkaRecordPosterAsJsonArray(String, String, int) - Constructor for class com.scaleoutsoftware.digitaltwin.datasource.kafka.KafkaRecordPosterAsJsonArray

 

L

load(String) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinPersistentStorage

 

load(String) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.DefaultPersistentStorage

 

load(String) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.PersistentStorage

 

load(String) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.SqlitePersistentStorage

 

load(String) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.SqlServerPersistentStorage

 

logMessage(Level, String) - Method in class com.scaleoutsoftware.digitaltwin.core.ProcessingContext

Logs a message to the real-time digital twin cloud service.

M

MembershipState - Enum in com.scaleoutsoftware.digitaltwin.datasource.aws

 

MessageFactory - Interface in com.scaleoutsoftware.digitaltwin.core

Message list factory retrieves message lists for a MessageProcessor

MessageProcessor<T extends DigitalTwinBase,​V> - Class in com.scaleoutsoftware.digitaltwin.core

Processes messages for a real-time digital twin.

MessageProcessor() - Constructor for class com.scaleoutsoftware.digitaltwin.core.MessageProcessor

 

MessageProcessorBase<T extends DigitalTwinBase> - Class in com.scaleoutsoftware.digitaltwin.core

Base class for the MessageProcessor to help with typing.

MessageProcessorBase() - Constructor for class com.scaleoutsoftware.digitaltwin.core.MessageProcessorBase

 

Model - Variable in class com.scaleoutsoftware.digitaltwin.core.DigitalTwinBase

The model this twin instance belongs to.

Model - Variable in class com.scaleoutsoftware.digitaltwin.datasource.aws.RegistrationMessage

 

ModelSchema - Class in com.scaleoutsoftware.digitaltwin.core

The ModelSchema class is used as a Java object representation of the model.json schema file used for deploying a digital twin model to the real-time digital twin cloud service.

ModelSchema(String, String, String) - Constructor for class com.scaleoutsoftware.digitaltwin.core.ModelSchema

Creates a model schema from a digital twin class, a message processor class, and a message class.

ModelSchema(String, String, String, String, PersistenceProviderType, List<AlertProviderConfiguration>) - Constructor for class com.scaleoutsoftware.digitaltwin.core.ModelSchema

Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.

ModelSchema(String, String, String, String, String, PersistenceProviderType, List<AlertProviderConfiguration>) - Constructor for class com.scaleoutsoftware.digitaltwin.core.ModelSchema

 

ModelSchema(String, String, String, String, List<AlertProviderConfiguration>) - Constructor for class com.scaleoutsoftware.digitaltwin.core.ModelSchema

Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.

ModelSchema(String, String, String, List<AlertProviderConfiguration>) - Constructor for class com.scaleoutsoftware.digitaltwin.core.ModelSchema

Creates a model schema from a digital twin class, a message processor class, a message class, and alert provider configurations.

N

NextSimulationTime - Variable in class com.scaleoutsoftware.digitaltwin.core.DigitalTwinBase

 

NoRemainingWork - com.scaleoutsoftware.digitaltwin.core.SimulationStatus

 

NotHandled - com.scaleoutsoftware.digitaltwin.core.SendingResult

NotHandled indicates that the message was not handled.

NotSet - com.scaleoutsoftware.digitaltwin.core.SimulationStatus

 

NoUpdate - com.scaleoutsoftware.digitaltwin.core.ProcessingResult

Do not update the digital twin.

O

onComplete() - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotObservingSubscriber

Called by reactiveX if the subscriber unsubscribes

onError(Throwable) - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotObservingSubscriber

Called by reactiveX if an error occurs.

OneTime - com.scaleoutsoftware.digitaltwin.core.TimerType

This timer should trigger one time.

onNext(Event) - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotObservingSubscriber

Handles each incoming event

onSubscribe(Disposable) - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotObservingSubscriber

Handles one-time initialization for this observer.

onTimedMessage(String, T, ProcessingContext) - Method in interface com.scaleoutsoftware.digitaltwin.core.TimerHandler

Callback to handle a timer message.

P

peek() - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench

Retrieves the next interval time of the simulation.

persistenceEnabled() - Method in class com.scaleoutsoftware.digitaltwin.core.ModelSchema

Retrieve persistence status.

PersistenceProvider - Interface in com.scaleoutsoftware.digitaltwin.core

An interface that can be used for persisting/retrieving the state of real-time digital twins.

PersistenceProviderType - Enum in com.scaleoutsoftware.digitaltwin.core

Available PersistenceProvider types.

PersistentStorage<V extends DigitalTwinBase> - Class in com.scaleoutsoftware.digitaltwin.persistentstorage

Persistent storage base class

PersistentStorage() - Constructor for class com.scaleoutsoftware.digitaltwin.persistentstorage.PersistentStorage

 

processAndPostRecords(NamedCache, Pipeline, ConsumerRecords) - Method in class com.scaleoutsoftware.digitaltwin.datasource.kafka.KafkaRecordPosterAsJsonArray

 

ProcessingContext - Class in com.scaleoutsoftware.digitaltwin.core

Context object that allows the user to send a message to a DataSource.

ProcessingContext() - Constructor for class com.scaleoutsoftware.digitaltwin.core.ProcessingContext

 

ProcessingResult - Enum in com.scaleoutsoftware.digitaltwin.core

The result from a message processor which indicates to update the state object or to ignore

processMessages(ProcessingContext, T, MessageFactory) - Method in class com.scaleoutsoftware.digitaltwin.core.MessageProcessor

Helper method to ensure proper typing for user methods.

processMessages(ProcessingContext, T, MessageFactory) - Method in class com.scaleoutsoftware.digitaltwin.core.MessageProcessorBase

Helper method to ensure proper typing for the user methods.

processMessages(ProcessingContext, T, Iterable<V>) - Method in class com.scaleoutsoftware.digitaltwin.core.MessageProcessor

Processes a set of incoming messages and determines whether to update the real-time digital twin.

processModel(ProcessingContext, T, Date) - Method in class com.scaleoutsoftware.digitaltwin.core.SimulationProcessor

Processes simulation events for a real-time digital twin.

R

rebalance() - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotSubscriptionManager

 

rebalanceSubscriptions() - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotMultiplexer

 

Recurring - com.scaleoutsoftware.digitaltwin.core.TimerType

This timer should reoccur on a schedule.

refreshStatus(String) - Static method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotMultiplexer

 

refreshStatus(String) - Static method in class com.scaleoutsoftware.digitaltwin.datasource.kafka.KafkaRecordPosterAsJsonArray

 

Register - com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotAction

 

RegistrationMessage - Class in com.scaleoutsoftware.digitaltwin.datasource.aws

The RegisterMessage is used to register and deregister devices with the AWS IoT core connector.

RegistrationMessage(String, String, String, String) - Constructor for class com.scaleoutsoftware.digitaltwin.datasource.aws.RegistrationMessage

Constructs a RegisterMessage which is sent to the "Registration" topic to Register or Deregister a data source.

Relaxed - com.scaleoutsoftware.digitaltwin.datasource.aws.MembershipState

 

removeSubscription(String, String) - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotSubscriptionManager

 

ResponseTopic - Variable in class com.scaleoutsoftware.digitaltwin.datasource.aws.RegistrationMessage

 

restartTimers(String, Class<T>) - Method in class com.scaleoutsoftware.digitaltwin.deployment.ExecutionEnvironment

 

Running - com.scaleoutsoftware.digitaltwin.core.SimulationStatus

 

runSimulation(long, long, double, long) - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench

Runs a simulation from the given startTime until the given endTime OR there is no more work to do.

S

send(String, String, byte[]) - Static method in class com.scaleoutsoftware.digitaltwin.datasource.AppEndpoint

Sends a list of JSON message

send(String, String, String) - Static method in class com.scaleoutsoftware.digitaltwin.datasource.AppEndpoint

Sends a list of JSON message

send(String, String, List<byte[]>) - Static method in class com.scaleoutsoftware.digitaltwin.datasource.AppEndpoint

Sends a list of JSON message

send(String, String, List<Object>) - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench

Send a list of messages to a real-time or simulation model.

sendAlert(String, AlertMessage) - Method in class com.scaleoutsoftware.digitaltwin.core.ProcessingContext

This method sends an alert message to supported systems.

SendingResult - Enum in com.scaleoutsoftware.digitaltwin.core

Marks a message as Delivered or not Delivered

sendToDataSource(byte[]) - Method in class com.scaleoutsoftware.digitaltwin.core.ProcessingContext

Sends a message to a data source.

sendToDataSource(Object) - Method in class com.scaleoutsoftware.digitaltwin.core.ProcessingContext

Sends a message to a data source.

sendToDataSource(List<Object>) - Method in class com.scaleoutsoftware.digitaltwin.core.ProcessingContext

Sends a list of messages to a data source.

SendToDataSource - com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotAction

 

sendToDigitalTwin(String, String, byte[]) - Method in class com.scaleoutsoftware.digitaltwin.core.ProcessingContext

This method sends a serialized JSON message to a real-time digital twin

sendToDigitalTwin(String, String, Object) - Method in class com.scaleoutsoftware.digitaltwin.core.ProcessingContext

This method sends a serialized JSON message to a real-time digital twin

sendToDigitalTwin(String, String, String) - Method in class com.scaleoutsoftware.digitaltwin.core.ProcessingContext

This method sends a JSON message to a real-time digital twin

sendToDigitalTwin(String, String, List<byte[]>) - Method in class com.scaleoutsoftware.digitaltwin.core.ProcessingContext

This method sends a list of serialized JSON message to a real-time digital twin

setNextSimulationTime(long) - Method in class com.scaleoutsoftware.digitaltwin.core.DigitalTwinBase

 

setObserver(Observer<Event>) - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotMultiplexer

 

setStatus(boolean, boolean) - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotSubscriptionMetadata

 

shutdown() - Method in class com.scaleoutsoftware.digitaltwin.deployment.ExecutionEnvironment

Tears down the ExecutionEnvironment

shutdown(String) - Method in class com.scaleoutsoftware.digitaltwin.deployment.ExecutionEnvironment

 

SimulationController - Interface in com.scaleoutsoftware.digitaltwin.core

The SimulationController interface is used to interact with the running DigitalTwin simulation.

SimulationProcessor<T extends DigitalTwinBase> - Class in com.scaleoutsoftware.digitaltwin.core

Processes simulation events for a digital twin.

SimulationProcessor() - Constructor for class com.scaleoutsoftware.digitaltwin.core.SimulationProcessor

 

SimulationStatus - Enum in com.scaleoutsoftware.digitaltwin.core

 

SimulationStep - Class in com.scaleoutsoftware.digitaltwin.development

The simulation step class encases the metadata for a completed interval of a simulation.

simulationSupportEnabled() - Method in class com.scaleoutsoftware.digitaltwin.core.ModelSchema

Retrieve simulation support enabled status.

SQLite - com.scaleoutsoftware.digitaltwin.core.PersistenceProviderType

Enum for SQLite

SqlitePersistentStorage<V extends DigitalTwinBase> - Class in com.scaleoutsoftware.digitaltwin.persistentstorage

SQLite persistent storage - transparently store and load digital twins to and from the a SQLite database (single-server only).

SqlitePersistentStorage(String, Class<V>) - Constructor for class com.scaleoutsoftware.digitaltwin.persistentstorage.SqlitePersistentStorage

 

SQLServer - com.scaleoutsoftware.digitaltwin.core.PersistenceProviderType

Enum for SQLServer

SqlServerPersistentStorage<V extends DigitalTwinBase> - Class in com.scaleoutsoftware.digitaltwin.persistentstorage

SQLServer persistent storage - transparently store and load digital twins to and from a SQL Server database.

SqlServerPersistentStorage(String, Class<V>) - Constructor for class com.scaleoutsoftware.digitaltwin.persistentstorage.SqlServerPersistentStorage

 

startTimer(String, Duration, TimerType, TimerHandler<T>) - Method in class com.scaleoutsoftware.digitaltwin.core.ProcessingContext

Starts a new timer for the digital twin

step() - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench

Run the next simulation interval.

stopSimulation() - Method in interface com.scaleoutsoftware.digitaltwin.core.SimulationController

Stop the simulation.

stopTimer(String) - Method in class com.scaleoutsoftware.digitaltwin.core.ProcessingContext

Stops the specified timer.

store(V) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinPersistentStorage

 

store(V) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.DefaultPersistentStorage

 

store(V) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.PersistentStorage

 

store(V) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.SqlitePersistentStorage

 

store(V) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.SqlServerPersistentStorage

 

Success - com.scaleoutsoftware.digitaltwin.core.TimerActionResult

The operation completed successfully.

T

teardown() - Method in class com.scaleoutsoftware.digitaltwin.datasource.kafka.KafkaEndpoint

Tears down the KafkaEndpoint which disables all consuming and producing from Kafka

TimerActionResult - Enum in com.scaleoutsoftware.digitaltwin.core

 

timerHandler - Variable in class com.scaleoutsoftware.digitaltwin.core.TimerMetadata

 

TimerHandler<T extends DigitalTwinBase> - Interface in com.scaleoutsoftware.digitaltwin.core

Callback to a handle a timer message for a DigitalTwinBase.

TimerHandlers - Variable in class com.scaleoutsoftware.digitaltwin.core.DigitalTwinBase

The timer handlers for this twin instance.

timerId - Variable in class com.scaleoutsoftware.digitaltwin.core.TimerMetadata

 

timerInterval - Variable in class com.scaleoutsoftware.digitaltwin.core.TimerMetadata

 

TimerMetadata<T extends DigitalTwinBase> - Class in com.scaleoutsoftware.digitaltwin.core

Metadata class for a timer.

TimerMetadata(TimerHandler<T>, TimerType, Duration, int) - Constructor for class com.scaleoutsoftware.digitaltwin.core.TimerMetadata

Constructs a timer metadata.

timerType - Variable in class com.scaleoutsoftware.digitaltwin.core.TimerMetadata

 

TimerType - Enum in com.scaleoutsoftware.digitaltwin.core

Enum representation of the available timer types

toString() - Method in class com.scaleoutsoftware.digitaltwin.core.AlertMessage

 

toString() - Method in class com.scaleoutsoftware.digitaltwin.core.AlertProviderConfiguration

 

toString() - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinPersistentStorage

 

toString() - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.DefaultPersistentStorage

 

toString() - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.SqlitePersistentStorage

 

toString() - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.SqlServerPersistentStorage

 

Turbulent - com.scaleoutsoftware.digitaltwin.datasource.aws.MembershipState

 

U

Unconfigured - com.scaleoutsoftware.digitaltwin.core.PersistenceProviderType

 

UnexpectedChangeInConfiguration - com.scaleoutsoftware.digitaltwin.core.SimulationStatus

 

unload() - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotEndpoint

 

update(Observable, Object) - Method in class com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotObservingSubscriber

Called when the SOSS store membership changes and we need to reevaluate our AWS IoT Core connections.

UpdateDigitalTwin - com.scaleoutsoftware.digitaltwin.core.ProcessingResult

Update the digital twin.

updateProperty(String, String, String, Object) - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider

Updates a property for the provided instance id in the provided container specified by the property name and property value.

updateProperty(String, String, String, Object) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinsPersistenceProvider

Updates a property for the provided instance id in the provided container specified by the property name and property value.

updatePropertyAsync(String, String, String, Object) - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider

Retrieves a future that will complete exceptionally or return void if the instance's property was successfully updated.

updatePropertyAsync(String, String, String, Object) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinsPersistenceProvider

Retrieves a future that will complete exceptionally or return void if the twin instance's property was successfully updated.

updateRtdtProperty(String, String, Object) - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider

Updates a RTDT property for the provided instance id specified by the property name and property value.

updateRtdtProperty(String, String, Object) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinsPersistenceProvider

Updates a RTDT property for the provided instance id specified by the property name and property value.

updateRtdtPropertyAsync(String, String, Object) - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider

Retrieves a future that will complete exceptionally or return void if the RTDT's property was successfully updated.

updateRtdtPropertyAsync(String, String, Object) - Method in class com.scaleoutsoftware.digitaltwin.persistentstorage.AzureDigitalTwinsPersistenceProvider

Retrieves a future that will complete exceptionally or return void if the RTDT's property was successfully updated.

UserRequested - com.scaleoutsoftware.digitaltwin.core.SimulationStatus

 

V

valueOf(String) - Static method in enum com.scaleoutsoftware.digitaltwin.core.PersistenceProviderType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.scaleoutsoftware.digitaltwin.core.ProcessingResult

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.scaleoutsoftware.digitaltwin.core.SendingResult

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.scaleoutsoftware.digitaltwin.core.SimulationStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.scaleoutsoftware.digitaltwin.core.TimerActionResult

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.scaleoutsoftware.digitaltwin.core.TimerType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotAction

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.scaleoutsoftware.digitaltwin.datasource.aws.MembershipState

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.scaleoutsoftware.digitaltwin.core.PersistenceProviderType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.scaleoutsoftware.digitaltwin.core.ProcessingResult

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.scaleoutsoftware.digitaltwin.core.SendingResult

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.scaleoutsoftware.digitaltwin.core.SimulationStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.scaleoutsoftware.digitaltwin.core.TimerActionResult

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.scaleoutsoftware.digitaltwin.core.TimerType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.scaleoutsoftware.digitaltwin.datasource.aws.AwsIotAction

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.scaleoutsoftware.digitaltwin.datasource.aws.MembershipState

Returns an array containing the constants of this enum type, in the order they are declared.

W

Workbench - Class in com.scaleoutsoftware.digitaltwin.development

The Workbench is used to represent an environment where developers can test real-time and simulated digital twins.

Workbench() - Constructor for class com.scaleoutsoftware.digitaltwin.development.Workbench

Instantiate the workbench.

WorkbenchException - Exception in com.scaleoutsoftware.digitaltwin.development

A Workbench exception indicates that a real-time or simulated twin caused an exception.

WorkbenchException(Exception) - Constructor for exception com.scaleoutsoftware.digitaltwin.development.WorkbenchException

Instantiates a WorkbenchException with the parameter inner exception

WorkbenchException(String) - Constructor for exception com.scaleoutsoftware.digitaltwin.development.WorkbenchException

Instantiates a WorkbenchException with the parameter message

WorkbenchException(String, Exception) - Constructor for exception com.scaleoutsoftware.digitaltwin.development.WorkbenchException

Instantiates a WorkbenchException with the parameter message and inner exception