Index
All Classes and Interfaces|All Packages|Serialized Form
A
- addAlertProvider(String, AlertProviderConfiguration) - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench
-
Adds an alert provider configuration to the specified model on this workbench.
- addInstance(String, String, DigitalTwinBase) - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench
-
Adds a digital twin instance to the workbench.
- 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.
- 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.
- AzureDigitalTwinsService - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.PersistenceProviderType
-
Enum for the Azure Digital Twin service.
C
- close() - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench
- com.scaleoutsoftware.digitaltwin.core - package com.scaleoutsoftware.digitaltwin.core
-
Digital twin model API - Create a digital twin model.
- com.scaleoutsoftware.digitaltwin.development - package com.scaleoutsoftware.digitaltwin.development
-
Digital twin development API - Develop and test simulation/real-time digital twins.
- createInstance(String, String, T) - Method in interface com.scaleoutsoftware.digitaltwin.core.SimulationController
-
Create a new digital twin instance for simulation processing.
- 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, T) - Method in interface com.scaleoutsoftware.digitaltwin.core.SimulationController
-
The twin instance will be loaded via model name and id from a persistence store.
D
- 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.
- deleteThisInstance() - Method in interface com.scaleoutsoftware.digitaltwin.core.SimulationController
-
Delete and remove this digital twin instance from simulation processing.
- 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 - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.SimulationStatus
-
The simulation end time has been reached.
- Enqueued - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.SendingResult
-
Enqueued indicates that a message was successfully formed and then sent to an internal messaging service
F
- FailedInternalError - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.TimerActionResult
-
Failed to start/stop timer due to an internal error.
- FailedNoSuchTimer - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.TimerActionResult
-
Failed to stop the existing timer, the timer is no longer active.
- FailedTimerAlreadyExists - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.TimerActionResult
-
Failed to start the timer, the timer with the specified name already exists.
- FailedTooManyTimers - Enum constant in enum class 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 class com.scaleoutsoftware.digitaltwin.core.PersistenceProviderType
-
Return the PersistenceProviderType from an ordinal value.
- fromOrdinal(int) - Static method in enum class com.scaleoutsoftware.digitaltwin.core.TimerActionResult
-
Convert an ordinal into a
TimerActionResult
. - fromString(String) - Static method in enum class 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(String, String) - 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.core.InitContext
-
Get the model-unique Id identifier of the initializing digital twin instance.
- 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.
- 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.
- 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.
- 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.
- 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(String, long) - Method in class com.scaleoutsoftware.digitaltwin.development.Workbench
-
Retrieves messages logged by digital twin instances for a specified mdoel.
- getMessage() - Method in class com.scaleoutsoftware.digitaltwin.core.AlertMessage
-
Retrieve the message for this alert message.
- getMessage() - Method in class com.scaleoutsoftware.digitaltwin.development.LogMessage
-
Retrieve the string message associated with this log message.
- 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.core.InitContext
-
Get the Model identifier of the initializing digital twin instance.
- 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
-
Retrieve the next simulation time in milliseconds.
- getOptionalTwinInstanceProperties() - Method in class com.scaleoutsoftware.digitaltwin.core.AlertMessage
-
Retrieve the optional twin instance properties for this alert message.
- 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.
- 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.
- getPropertyMap(String) - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider
-
Retrieves a map of property names to property types, 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.
- getProviderType() - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider
-
Retrieves this persistence providers type.
- 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.
- 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.
- getSeverity() - Method in class com.scaleoutsoftware.digitaltwin.core.AlertMessage
-
Retrieve the severity for this alert message.
- getSeverity() - Method in class com.scaleoutsoftware.digitaltwin.development.LogMessage
-
Retrieve the severity of this log 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. - 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.
- getTimerIntervalMs() - 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.
- getTimestamp() - Method in class com.scaleoutsoftware.digitaltwin.development.LogMessage
-
Retrieve the timestamp from when this message was generated.
- 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 - Enum constant in enum class 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
- init(InitContext) - Method in class com.scaleoutsoftware.digitaltwin.core.DigitalTwinBase
-
Initialization method to set the identifier and model for a DigitalTwin instance.
- InitContext - Class in com.scaleoutsoftware.digitaltwin.core
-
The InitContext is passed as a parameter to the
DigitalTwinBase.init(InitContext)
method of an initializing digital twin. - InitContext() - Constructor for class com.scaleoutsoftware.digitaltwin.core.InitContext
- 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. - InstanceRequestedStop - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.SimulationStatus
-
A digital twin instance has requested the simulation to stop by calling
SimulationController.stopSimulation()
- isActive() - Method in interface com.scaleoutsoftware.digitaltwin.core.PersistenceProvider
-
Returns true if this PersistenceProvider is active, false otherwise.
L
- logMessage(Level, String) - Method in class com.scaleoutsoftware.digitaltwin.core.ProcessingContext
-
Logs a message to the real-time digital twin cloud service.
- LogMessage - Class in com.scaleoutsoftware.digitaltwin.development
-
A messaged that was logged by a digital twin.
M
- 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.
- 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
-
Note: Simulation only.
- NoRemainingWork - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.SimulationStatus
-
There is no remaining work for the simulation.
- NotHandled - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.SendingResult
-
NotHandled indicates that the message was not handled.
- NotSet - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.SimulationStatus
-
The simulation status is not set.
- NoUpdate - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.ProcessingResult
-
Do not update the digital twin.
O
- OneTime - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.TimerType
-
This timer should trigger one time.
- 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 Class in com.scaleoutsoftware.digitaltwin.core
-
Available
PersistenceProvider
types. - 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 Class 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
- Recurring - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.TimerType
-
This timer should reoccur on a schedule.
- Running - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.SimulationStatus
-
The simulation is running.
- 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, 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 Class 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.
- 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
-
Set the next simulation time in milliseconds.
- SimulationController - Interface in com.scaleoutsoftware.digitaltwin.core
-
The SimulationController interface is used to interact with the running DigitalTwin simulation.
- SimulationEventResult - Class in com.scaleoutsoftware.digitaltwin.development
-
A simulation event result.
- SimulationEventResult() - Constructor for class com.scaleoutsoftware.digitaltwin.development.SimulationEventResult
- 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 Class in com.scaleoutsoftware.digitaltwin.core
-
The status of a simulation.
- 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 - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.PersistenceProviderType
-
Enum for SQLite
- SQLServer - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.PersistenceProviderType
-
Enum for SQLServer
- startTimer(String, Duration, TimerType, TimerHandler<T>) - Method in class com.scaleoutsoftware.digitaltwin.core.InitContext
-
Starts a new timer for the digital twin
- 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.
- Success - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.TimerActionResult
-
The operation completed successfully.
T
- TimerActionResult - Enum Class in com.scaleoutsoftware.digitaltwin.core
-
The result of a timer action.
- 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.
- TimerMetadata<T extends DigitalTwinBase> - Class in com.scaleoutsoftware.digitaltwin.core
-
Metadata class for a timer.
- TimerMetadata(TimerHandler<T>, TimerType, long, int) - Constructor for class com.scaleoutsoftware.digitaltwin.core.TimerMetadata
-
Constructs a timer metadata.
- TimerType - Enum Class 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
U
- Unconfigured - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.PersistenceProviderType
- UnexpectedChangeInConfiguration - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.SimulationStatus
-
There was a runtime-change of simulation configuration.
- UpdateDigitalTwin - Enum constant in enum class 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.
- 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.
- 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.
- 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.
- UserRequested - Enum constant in enum class com.scaleoutsoftware.digitaltwin.core.SimulationStatus
-
The user requested a stop.
V
- valueOf(String) - Static method in enum class com.scaleoutsoftware.digitaltwin.core.PersistenceProviderType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.scaleoutsoftware.digitaltwin.core.ProcessingResult
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.scaleoutsoftware.digitaltwin.core.SendingResult
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.scaleoutsoftware.digitaltwin.core.SimulationStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.scaleoutsoftware.digitaltwin.core.TimerActionResult
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.scaleoutsoftware.digitaltwin.core.TimerType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.scaleoutsoftware.digitaltwin.core.PersistenceProviderType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.scaleoutsoftware.digitaltwin.core.ProcessingResult
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.scaleoutsoftware.digitaltwin.core.SendingResult
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.scaleoutsoftware.digitaltwin.core.SimulationStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.scaleoutsoftware.digitaltwin.core.TimerActionResult
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.scaleoutsoftware.digitaltwin.core.TimerType
-
Returns an array containing the constants of this enum class, 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
All Classes and Interfaces|All Packages|Serialized Form