-
Notifications
You must be signed in to change notification settings - Fork 331
/
MatrixSignalMast.java
553 lines (503 loc) · 21.2 KB
/
MatrixSignalMast.java
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
package jmri.implementation;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import jmri.NamedBeanHandle;
import jmri.Turnout;
import jmri.util.ThreadingUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* SignalMast implemented via a Binary Matrix (Truth Table) of Apects x Turnout objects.
* <p>
* A MatrixSignalMast is built up from an array of turnouts to control each aspect.
* System name specifies the creation information (except for the actual output beans):
* <pre>
* IF$xsm:basic:one-searchlight:($0001)-3t
* </pre> The name is a colon-separated series of terms:
* <ul>
* <li>IF$xsm - defines signal masts of this type (x for matri<b>X</b>)
* <li>basic - name of the signaling system
* <li>one-searchlight - name of the particular aspect map/mast model
* <li>($0001) - small ordinal number for telling various matrix signal masts apart
* <li>name ending in -nt for (binary) Turnout outputs
* where n = the number of binary outputs, between 1 and mastBitNum i.e. -3t</li>
* </ul>
*
* @author Bob Jacobsen Copyright (C) 2009, 2014, 2020
* @author Egbert Broerse Copyright (C) 2016, 2018, 2020
*/
public class MatrixSignalMast extends AbstractSignalMast {
/**
* Number of columns in logix matrix, default to 6, set in Matrix Mast panel & on loading xml.
* Used to set size of char[] bitString.
* See MAXMATRIXBITS in {@link jmri.jmrit.beantable.signalmast.MatrixSignalMastAddPane}.
*/
private int mastBitNum = 6;
private int mDelay = 0;
private static final String errorChars = "nnnnnn";
private final char[] errorBits = errorChars.toCharArray();
private static final String emptyChars = "000000"; // default starting value
private final char[] emptyBits = emptyChars.toCharArray();
public MatrixSignalMast(String systemName, String userName) {
super(systemName, userName);
configureFromName(systemName);
}
public MatrixSignalMast(String systemName) {
super(systemName);
configureFromName(systemName);
}
private static final String mastType = "IF$xsm";
private void configureFromName(@Nonnull String systemName) {
// split out the basic information
String[] parts = systemName.split(":");
if (parts.length < 3) {
log.error("SignalMast system name needs at least three parts: {}", systemName);
throw new IllegalArgumentException("System name needs at least three parts: " + systemName);
}
if (!parts[0].equals(mastType)) {
log.warn("SignalMast system name should start with \"{}\" but is \"{}\"", mastType, systemName);
}
String system = parts[1];
String mast = parts[2];
mast = mast.substring(0, mast.indexOf("("));
setMastType(mast);
String tmp = parts[2].substring(parts[2].indexOf("($") + 2, parts[2].indexOf(")")); // retrieve ordinal from name
try {
int autoNumber = Integer.parseInt(tmp);
if (autoNumber > getLastRef()) {
setLastRef(autoNumber);
}
} catch (NumberFormatException e) {
log.warn("Auto generated SystemName \"{}\" is not in the correct format", systemName);
}
configureSignalSystemDefinition(system); // (checks for system) in AbstractSignalMast
configureAspectTable(system, mast); // (create -default- appmapping in var "map") in AbstractSignalMast
}
private final HashMap<String, char[]> aspectToOutput = new HashMap<>(16); // "Clear" - 01001 char[] pairs
private char[] unLitBits;
/**
* Store bits in aspectToOutput hashmap, synchronized.
* <p>
* Length of bitArray should match the number of outputs defined, so one digit per output.
*
* @param aspect String valid aspect to define
* @param bitArray char[] of on/off outputs for the aspect, like "00010"
*/
public synchronized void setBitsForAspect(String aspect, char[] bitArray) {
if (aspectToOutput.containsKey(aspect)) {
log.debug("Aspect {} is already defined as {}", aspect, java.util.Arrays.toString(aspectToOutput.get(aspect)));
aspectToOutput.remove(aspect);
}
aspectToOutput.put(aspect, bitArray); // store keypair aspectname - bitArray in hashmap
}
/**
* Look up the pattern for an aspect.
*
* @param aspect String describing a (valid) signal mast aspect, like "Clear"
* only called for an already existing mast
* @return char[] of on/off outputs per aspect, like "00010"
* length of array should match the number of outputs defined
* when a mast is changed in the interface, extra 0's are added or superfluous elements deleted by the Add Mast panel
*/
public synchronized char[] getBitsForAspect(String aspect) {
if (!aspectToOutput.containsKey(aspect) || aspectToOutput.get(aspect) == null) {
log.error("Trying to get aspect {} but it has not been configured", aspect);
return errorBits; // error flag
}
return aspectToOutput.get(aspect);
}
@Override
public void setAspect(@Nonnull String aspect) {
// check it's a valid choice
if (!map.checkAspect(aspect)) {
// not a valid aspect
log.warn("attempting to set invalid Aspect: {} on mast {}", aspect, getDisplayName());
throw new IllegalArgumentException("attempting to set invalid Aspect: " + aspect + " on mast: " + getDisplayName());
} else if (disabledAspects.contains(aspect)) {
log.warn("attempting to set an Aspect that has been Disabled: {} on mast {}", aspect, getDisplayName());
throw new IllegalArgumentException("attempting to set an Aspect that has been Disabled: " + aspect + " on mast: " + getDisplayName());
}
if (getLit()) {
synchronized (this) {
// If the signalmast is lit, then send the commands to change the aspect.
if (resetPreviousStates) {
// Clear all the current states, this will result in the signalmast going "Stop" or unLit for a while
if (aspectToOutput.containsKey("Stop")) {
updateOutputs(getBitsForAspect("Stop")); // show Red
} else {
if (unLitBits != null) {
updateOutputs(unLitBits); // Dark (instead of Red), always available
}
}
}
// add a timer here to wait a while before setting new aspect?
if (aspectToOutput.containsKey(aspect) && aspectToOutput.get(aspect) != errorBits) {
char[] bitArray = getBitsForAspect(aspect);
// for MatrixMast nest a loop, using setBitsForAspect(), provides extra check on value
updateOutputs(bitArray);
// Set the new Signal Mast state
} else {
log.error("Trying to set an aspect ({}) on signal mast {} which has not been configured", aspect, getDisplayName());
}
}
} else {
log.debug("Mast set to unlit, will not send aspect change to hardware");
}
super.setAspect(aspect);
}
@Override
public void setLit(boolean newLit) {
if (!allowUnLit() || newLit == getLit()) {
return;
}
super.setLit(newLit);
if (newLit) {
if (getAspect() != null) {
setAspect(getAspect());
}
// if true, activate prior aspect
} else {
if (unLitBits != null) {
updateOutputs(unLitBits); // directly set outputs
//c.sendPacket(NmraPacket.altAccSignalDecoderPkt(dccSignalDecoderAddress, unLitId), packetRepeatCount);
}
}
}
public void setUnLitBits(@Nonnull char[] bits) {
unLitBits = bits;
}
/**
* Receive unLitBits from xml and store.
*
* @param bitString String for 1-n 1/0 chararacters setting an unlit aspect
*/
public void setUnLitBits(@Nonnull String bitString) {
setUnLitBits(bitString.toCharArray());
}
/**
* Provide Unlit bits to panel for editing.
*
* @return char[] containing a series of 1's and 0's set for Unlit mast
*/
@Nonnull public char[] getUnLitBits() {
if (unLitBits != null) {
return unLitBits;
} else {
return emptyBits;
}
}
/**
* Hand unLitBits to xml.
*
* @return String for 1-n 1/0 chararacters setting an unlit aspect
*/
@Nonnull public String getUnLitChars() {
if (unLitBits != null) {
return String.valueOf(unLitBits);
} else {
log.error("Returning 0 values because unLitBits is empty");
return emptyChars.substring(0, (mastBitNum)); // should only be called when Unlit = true
}
}
/**
* Fetch output as Turnout from outputsToBeans hashmap.
*
* @param colNum int index (1 up to mastBitNum) for the column of the desired output
* @return Turnout object connected to configured output
*/
@CheckForNull private Turnout getOutputBean(int colNum) { // as bean
String key = "output" + colNum;
if (colNum > 0 && colNum <= outputsToBeans.size()) {
return outputsToBeans.get(key).getBean();
}
log.error("Trying to read bean for output {} which has not been configured", colNum);
return null;
}
/**
* Fetch output from outputsToBeans hashmap.
* Used?
*
* @param colNum int index (1 up to mastBitNum) for the column of the desired output
* @return NamedBeanHandle to the configured turnout output
*/
@CheckForNull public NamedBeanHandle<Turnout> getOutputHandle(int colNum) {
String key = "output" + colNum;
if (colNum > 0 && colNum <= outputsToBeans.size()) {
return outputsToBeans.get(key);
}
log.error("Trying to read output NamedBeanHandle {} which has not been configured", key);
return null;
}
/**
* Fetch output from outputsToBeans hashmap and provide to xml.
*
* @see jmri.implementation.configurexml.MatrixSignalMastXml#store(java.lang.Object)
* @param colnum int index (1 up to mastBitNum) for the column of the desired output
* @return String with the desplay name of the configured turnout output
*/
@Nonnull public String getOutputName(int colnum) {
String key = "output" + colnum;
if (colnum > 0 && colnum <= outputsToBeans.size()) {
return outputsToBeans.get(key).getName();
}
log.error("Trying to read name of output {} which has not been configured", colnum);
return "";
}
/**
* Receive aspect name from xml and store matching setting in outputsToBeans hashmap.
*
* @see jmri.implementation.configurexml.MatrixSignalMastXml#load(org.jdom2.Element, org.jdom2.Element)
* @param aspect String describing (valid) signal mast aspect, like "Clear"
* @param bitString String of 1/0 digits representing on/off outputs per aspect, like "00010"
*/
public synchronized void setBitstring(@Nonnull String aspect, @Nonnull String bitString) {
if (aspectToOutput.containsKey(aspect)) {
log.debug("Aspect {} is already defined so will override", aspect);
aspectToOutput.remove(aspect);
}
char[] bitArray = bitString.toCharArray(); // for faster lookup, stored as char[] array
aspectToOutput.put(aspect, bitArray);
}
/**
* Receive aspect name from xml and store matching setting in outputsToBeans hashmap.
*
* @param aspect String describing (valid) signal mast aspect, like "Clear"
* @param bitArray char[] of 1/0 digits representing on/off outputs per aspect, like {0,0,0,1,0}
*/
public synchronized void setBitstring(String aspect, char[] bitArray) {
if (aspectToOutput.containsKey(aspect)) {
log.debug("Aspect {} is already defined so will override", aspect);
aspectToOutput.remove(aspect);
}
// is supplied as char array, no conversion needed
aspectToOutput.put(aspect, bitArray);
}
/**
* Provide one series of on/off digits from aspectToOutput hashmap to xml.
*
* @return bitString String of 1 (= on) and 0 (= off) chars
* @param aspect String describing valid signal mast aspect, like "Clear"
*/
@Nonnull public synchronized String getBitstring(@Nonnull String aspect) {
if (aspectToOutput.containsKey(aspect)) { // hashtable
return new String(aspectToOutput.get(aspect)); // convert char[] to string
}
return "";
}
/**
* Provide the names of the on/off turnout outputs from outputsToBeans hashmap to xml.
*
* @return outputlist List<String> of display names for the outputs in order 1 to (max) mastBitNum
*/
@Nonnull public List<String> getOutputs() { // provide to xml
// to do: use for loop
ArrayList<String> outputlist = new ArrayList<>();
//list = outputsToBeans.keySet();
int index = 1;
while (outputsToBeans.containsKey("output"+index)) {
outputlist.add(outputsToBeans.get("output"+index).getName());
index++;
}
return outputlist;
}
protected HashMap<String, NamedBeanHandle<Turnout>> outputsToBeans = new HashMap<>(); // output# - bean pairs
/**
* Receive properties from xml, convert name to NamedBeanHandle, store in hashmap outputsToBeans.
*
* @param colname String describing the name of the corresponding output, like "output1"
* @param turnoutname String for the display name of the output, like "LT1"
*/
public void setOutput(@Nonnull String colname, @Nonnull String turnoutname) {
Turnout turn = jmri.InstanceManager.turnoutManagerInstance().getTurnout(turnoutname);
if (turn == null) {
log.error("setOutput couldn't locate turnout {}", turnoutname);
return;
}
NamedBeanHandle<Turnout> namedTurnout = jmri.InstanceManager.getDefault(jmri.NamedBeanHandleManager.class).getNamedBeanHandle(turnoutname, turn);
if (outputsToBeans.containsKey(colname)) {
log.debug("Output {} is already defined so will override", colname);
outputsToBeans.remove(colname);
}
outputsToBeans.put(colname, namedTurnout);
}
/**
* Send hardware instruction.
*
* @param bits char[] of on/off outputs per aspect, like "00010"
* Length of array should match the number of outputs defined
*/
public void updateOutputs(char[] bits) {
int newState;
if (bits == null){
log.debug("Empty char[] received");
} else {
for (int i = 0; i < outputsToBeans.size(); i++) {
log.debug("Setting bits[1] = {} for output #{}", bits[i], i);
Turnout t = getOutputBean(i + 1);
if (t != null) {
t.setBinaryOutput(true); // prevent feedback etc.
}
if (bits[i] == '1' && t != null && t.getCommandedState() != Turnout.CLOSED) {
// no need to set a state already set
newState = Turnout.CLOSED;
} else if (bits[i] == '0' && t != null && t.getCommandedState() != Turnout.THROWN) {
newState = Turnout.THROWN;
} else if (bits[i] == 'n' || bits[i] == 'u') {
// let pass, extra chars up to mastBitNum are not defined
newState = -1;
} else {
// invalid char or state is already set
newState = -2;
log.debug("Element {} not converted to state for output #{}", bits[i], i);
}
// wait mast specific delay before sending each (valid) state change to a (valid) output
if (newState >= 0) {
final int toState = newState;
final Turnout setTurnout = t;
ThreadingUtil.runOnLayoutEventually(() -> { // eventually, even though we have timing here, should be soon
setTurnout.setCommandedStateAtInterval(toState); // delayed on specific connection by its turnoutManager
});
try {
Thread.sleep(mDelay); // only the Mast specific user defined delay is applied here
} catch (InterruptedException e) {
Thread.currentThread().interrupt(); // retain if needed later
}
}
}
}
}
private boolean resetPreviousStates = false;
/**
* If the signal mast driver requires the previous state to be cleared down
* before the next state is set.
*
* @param boo true to configure for intermediate reset step
*/
public void resetPreviousStates(boolean boo) {
resetPreviousStates = boo;
}
public boolean resetPreviousStates() {
return resetPreviousStates;
}
/* Turnout getTurnoutBean(int i) { // as bean
String key = "output" + Integer.toString(i);
if (i < 1 || i > outputsToBeans.size() ) {
return null;
}
if (outputsToBeans.containsKey(key) && outputsToBeans.get(key) != null){
return outputsToBeans.get(key).getBean();
}
return null;
}*/
/* public String getTurnoutName(int i) {
String key = "output" + Integer.toString(i);
if (i < 1 || i > outputsToBeans.size() ) {
return null;
}
if (outputsToBeans.containsKey(key) && outputsToBeans.get(key) != null) {
return outputsToBeans.get(key).getName();
}
return null;
}*/
boolean isTurnoutUsed(Turnout t) {
for (int i = 1; i <= outputsToBeans.size(); i++) {
if (t.equals(getOutputBean(i))) {
return true;
}
}
return false;
}
/**
* @return highest ordinal of all MatrixSignalMasts in use
*/
public static int getLastRef() {
return lastRef;
}
/**
*
* @param newVal for ordinal of all MatrixSignalMasts in use
*/
protected static void setLastRef(int newVal) {
lastRef = newVal;
}
/**
* Ordinal of all MatrixSignalMasts to create unique system name.
*/
private static volatile int lastRef = 0;
@Override
public void vetoableChange(java.beans.PropertyChangeEvent evt) throws java.beans.PropertyVetoException {
if ("CanDelete".equals(evt.getPropertyName())) { // NOI18N
if (evt.getOldValue() instanceof Turnout) {
if (isTurnoutUsed((Turnout) evt.getOldValue())) {
java.beans.PropertyChangeEvent e = new java.beans.PropertyChangeEvent(this, "DoNotDelete", null, null);
throw new java.beans.PropertyVetoException(Bundle.getMessage("InUseTurnoutSignalMastVeto", getDisplayName()), e);
}
}
}
}
/**
* Store number of outputs from integer.
*
* @param number int for the number of outputs defined for this mast
* @see #mastBitNum
*/
public void setBitNum(int number) {
mastBitNum = number;
}
/**
* Store number of outputs from integer.
*
* @param bits char[] for outputs defined for this mast
* @see #mastBitNum
*/
public void setBitNum(char[] bits) {
mastBitNum = bits.length;
}
public int getBitNum() {
return mastBitNum;
}
@Override
public void setAspectDisabled(String aspect) {
if (aspect == null || aspect.equals("")) {
return;
}
if (!map.checkAspect(aspect)) {
log.warn("attempting to disable an aspect: {} that is not on mast {}", aspect, getDisplayName());
return;
}
if (!disabledAspects.contains(aspect)) {
disabledAspects.add(aspect);
firePropertyChange("aspectDisabled", null, aspect);
}
}
/**
* Set the delay between issuing Matrix Output commands to the outputs on this specific mast.
* Mast Delay will be extended by a connection specific Output Delay set in the connection config.
*
* @see jmri.implementation.configurexml.MatrixSignalMastXml#load(org.jdom2.Element, org.jdom2.Element)
* @param delay the new delay in milliseconds
*/
public void setMatrixMastCommandDelay(int delay) {
if (delay >= 0) {
mDelay = delay;
}
}
/**
* Get the delay between issuing Matrix Output commands to the outputs on this specific mast.
* Delay be extended by a connection specific Output Delay set in the connection config.
*
* @see jmri.implementation.configurexml.MatrixSignalMastXml#load(org.jdom2.Element, org.jdom2.Element)
* @return the delay in milliseconds
*/
public int getMatrixMastCommandDelay() {
return mDelay;
}
@Override
public void dispose() {
super.dispose();
}
private final static Logger log = LoggerFactory.getLogger(MatrixSignalMast.class);
}