-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathallclasses-index.html
More file actions
175 lines (175 loc) · 16.3 KB
/
allclasses-index.html
File metadata and controls
175 lines (175 loc) · 16.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>All Classes and Interfaces (digitaltwin-core-docs 3.0.4 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="class index">
<meta name="generator" content="javadoc/AllClassesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head>
<body class="all-classes-index-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "./";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html#all-classes">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1>
</div>
<div id="all-classes-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab1" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab1', 2)" class="table-tab">Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab3" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab3', 2)" class="table-tab">Enum Classes</button><button id="all-classes-table-tab5" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab5', 2)" class="table-tab">Exceptions</button></div>
<div id="all-classes-table.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="all-classes-table-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/scaleoutsoftware/digitaltwin/core/AlertMessage.html" title="class in com.scaleoutsoftware.digitaltwin.core">AlertMessage</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">A message that should be sent to a configured alert provider.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/scaleoutsoftware/digitaltwin/core/AlertProviderConfiguration.html" title="class in com.scaleoutsoftware.digitaltwin.core">AlertProviderConfiguration</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Configuration for an alert provider.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/scaleoutsoftware/digitaltwin/core/DigitalTwinBase.html" title="class in com.scaleoutsoftware.digitaltwin.core">DigitalTwinBase</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">A real-time digital twin of a data source.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/scaleoutsoftware/digitaltwin/core/DigitalTwinTimerMessage.html" title="class in com.scaleoutsoftware.digitaltwin.core">DigitalTwinTimerMessage</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">A message sent to a digital twin instance's message processor.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/scaleoutsoftware/digitaltwin/core/InitContext.html" title="class in com.scaleoutsoftware.digitaltwin.core">InitContext</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">The InitContext is passed as a parameter to the <a href="com/scaleoutsoftware/digitaltwin/core/DigitalTwinBase.html#init(com.scaleoutsoftware.digitaltwin.core.InitContext)"><code>DigitalTwinBase.init(InitContext)</code></a> method of an initializing
digital twin.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/scaleoutsoftware/digitaltwin/development/LogMessage.html" title="class in com.scaleoutsoftware.digitaltwin.development">LogMessage</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">A messaged that was logged by a digital twin.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="com/scaleoutsoftware/digitaltwin/core/MessageFactory.html" title="interface in com.scaleoutsoftware.digitaltwin.core">MessageFactory</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
<div class="block">Message list factory retrieves message lists for a MessageProcessor</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/scaleoutsoftware/digitaltwin/core/MessageProcessor.html" title="class in com.scaleoutsoftware.digitaltwin.core">MessageProcessor</a><<a href="com/scaleoutsoftware/digitaltwin/core/MessageProcessor.html" title="type parameter in MessageProcessor">T</a> extends <a href="com/scaleoutsoftware/digitaltwin/core/DigitalTwinBase.html" title="class in com.scaleoutsoftware.digitaltwin.core">DigitalTwinBase</a>,<wbr><a href="com/scaleoutsoftware/digitaltwin/core/MessageProcessor.html" title="type parameter in MessageProcessor">V</a>></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Processes messages for a real-time digital twin.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/scaleoutsoftware/digitaltwin/core/MessageProcessorBase.html" title="class in com.scaleoutsoftware.digitaltwin.core">MessageProcessorBase</a><<a href="com/scaleoutsoftware/digitaltwin/core/MessageProcessorBase.html" title="type parameter in MessageProcessorBase">T</a> extends <a href="com/scaleoutsoftware/digitaltwin/core/DigitalTwinBase.html" title="class in com.scaleoutsoftware.digitaltwin.core">DigitalTwinBase</a>></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Base class for the MessageProcessor to help with typing.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/scaleoutsoftware/digitaltwin/core/ModelSchema.html" title="class in com.scaleoutsoftware.digitaltwin.core">ModelSchema</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">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.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="com/scaleoutsoftware/digitaltwin/core/PersistenceProvider.html" title="interface in com.scaleoutsoftware.digitaltwin.core">PersistenceProvider</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab1">
<div class="block">An interface that can be used for persisting/retrieving the state of real-time digital twins.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="com/scaleoutsoftware/digitaltwin/core/PersistenceProviderType.html" title="enum class in com.scaleoutsoftware.digitaltwin.core">PersistenceProviderType</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
<div class="block">Available <a href="com/scaleoutsoftware/digitaltwin/core/PersistenceProvider.html" title="interface in com.scaleoutsoftware.digitaltwin.core"><code>PersistenceProvider</code></a> types.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/scaleoutsoftware/digitaltwin/core/ProcessingContext.html" title="class in com.scaleoutsoftware.digitaltwin.core">ProcessingContext</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Context object that allows the user to send a message to a DataSource.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="com/scaleoutsoftware/digitaltwin/core/ProcessingResult.html" title="enum class in com.scaleoutsoftware.digitaltwin.core">ProcessingResult</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
<div class="block">The result from a message processor which indicates to update the state object or to ignore</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="com/scaleoutsoftware/digitaltwin/core/SendingResult.html" title="enum class in com.scaleoutsoftware.digitaltwin.core">SendingResult</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
<div class="block">Marks a message as Delivered or not Delivered</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/scaleoutsoftware/digitaltwin/core/SimulationController.html" title="interface in com.scaleoutsoftware.digitaltwin.core">SimulationController</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="block">The SimulationController interface is used to interact with the running DigitalTwin simulation.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/scaleoutsoftware/digitaltwin/development/SimulationEventResult.html" title="class in com.scaleoutsoftware.digitaltwin.development">SimulationEventResult</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">A simulation event result.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/scaleoutsoftware/digitaltwin/core/SimulationProcessor.html" title="class in com.scaleoutsoftware.digitaltwin.core">SimulationProcessor</a><<a href="com/scaleoutsoftware/digitaltwin/core/SimulationProcessor.html" title="type parameter in SimulationProcessor">T</a> extends <a href="com/scaleoutsoftware/digitaltwin/core/DigitalTwinBase.html" title="class in com.scaleoutsoftware.digitaltwin.core">DigitalTwinBase</a>></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Processes simulation events for a digital twin.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="com/scaleoutsoftware/digitaltwin/core/SimulationStatus.html" title="enum class in com.scaleoutsoftware.digitaltwin.core">SimulationStatus</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
<div class="block">The status of a simulation.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="com/scaleoutsoftware/digitaltwin/development/SimulationStep.html" title="class in com.scaleoutsoftware.digitaltwin.development">SimulationStep</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">The simulation step class encases the metadata for a completed interval of a simulation.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="com/scaleoutsoftware/digitaltwin/core/TimerActionResult.html" title="enum class in com.scaleoutsoftware.digitaltwin.core">TimerActionResult</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
<div class="block">The result of a timer action.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/scaleoutsoftware/digitaltwin/core/TimerHandler.html" title="interface in com.scaleoutsoftware.digitaltwin.core">TimerHandler</a><<a href="com/scaleoutsoftware/digitaltwin/core/TimerHandler.html" title="type parameter in TimerHandler">T</a> extends <a href="com/scaleoutsoftware/digitaltwin/core/DigitalTwinBase.html" title="class in com.scaleoutsoftware.digitaltwin.core">DigitalTwinBase</a>></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
<div class="block">Callback to a handle a timer message for a <a href="com/scaleoutsoftware/digitaltwin/core/DigitalTwinBase.html" title="class in com.scaleoutsoftware.digitaltwin.core"><code>DigitalTwinBase</code></a>.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/scaleoutsoftware/digitaltwin/core/TimerMetadata.html" title="class in com.scaleoutsoftware.digitaltwin.core">TimerMetadata</a><<a href="com/scaleoutsoftware/digitaltwin/core/TimerMetadata.html" title="type parameter in TimerMetadata">T</a> extends <a href="com/scaleoutsoftware/digitaltwin/core/DigitalTwinBase.html" title="class in com.scaleoutsoftware.digitaltwin.core">DigitalTwinBase</a>></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Metadata class for a timer.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="com/scaleoutsoftware/digitaltwin/core/TimerType.html" title="enum class in com.scaleoutsoftware.digitaltwin.core">TimerType</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
<div class="block">Enum representation of the available timer types</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/scaleoutsoftware/digitaltwin/development/Workbench.html" title="class in com.scaleoutsoftware.digitaltwin.development">Workbench</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">The Workbench is used to represent an environment where developers can test real-time and simulated digital twins.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab5"><a href="com/scaleoutsoftware/digitaltwin/development/WorkbenchException.html" title="class in com.scaleoutsoftware.digitaltwin.development">WorkbenchException</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab5">
<div class="block">A Workbench exception indicates that a real-time or simulated twin caused an exception.</div>
</div>
</div>
</div>
</div>
</main>
</div>
</div>
</body>
</html>