1 // ******************************************************************************
2 //
3 // Title: Force Field X.
4 // Description: Force Field X - Software for Molecular Biophysics.
5 // Copyright: Copyright (c) Michael J. Schnieders 2001-2024.
6 //
7 // This file is part of Force Field X.
8 //
9 // Force Field X is free software; you can redistribute it and/or modify it
10 // under the terms of the GNU General Public License version 3 as published by
11 // the Free Software Foundation.
12 //
13 // Force Field X is distributed in the hope that it will be useful, but WITHOUT
14 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
16 // details.
17 //
18 // You should have received a copy of the GNU General Public License along with
19 // Force Field X; if not, write to the Free Software Foundation, Inc., 59 Temple
20 // Place, Suite 330, Boston, MA 02111-1307 USA
21 //
22 // Linking this library statically or dynamically with other modules is making a
23 // combined work based on this library. Thus, the terms and conditions of the
24 // GNU General Public License cover the whole combination.
25 //
26 // As a special exception, the copyright holders of this library give you
27 // permission to link this library with independent modules to produce an
28 // executable, regardless of the license terms of these independent modules, and
29 // to copy and distribute the resulting executable under terms of your choice,
30 // provided that you also meet, for each linked independent module, the terms
31 // and conditions of the license of that module. An independent module is a
32 // module which is not derived from or based on this library. If you modify this
33 // library, you may extend this exception to your version of the library, but
34 // you are not obligated to do so. If you do not wish to do so, delete this
35 // exception statement from your version.
36 //
37 // ******************************************************************************
38 package ffx.ui.commands;
39
40 import java.io.Serializable;
41
42 /**
43 * The SimulationMessage class is used to pass simple messages between an FFXServer and its
44 * FFXClient(s).
45 *
46 * @author Michael J. Schnieders
47 */
48 public class SimulationMessage implements Serializable {
49
50 private static final long serialVersionUID = 1L;
51 /** Constant <code>SYSTEM=0</code> */
52 public static int SYSTEM = 0;
53 /** Constant <code>UPDATE=1</code> */
54 public static int UPDATE = 1;
55 /** Constant <code>CLOSING=2</code> */
56 public static int CLOSING = 2;
57 /** Constant <code>OK=3</code> */
58 public static int OK = 3;
59
60 private int message = 0;
61 private int step = -1;
62 private double time = -1.0;
63 private int type = 0;
64
65 /**
66 * Constructor for SimulationMessage.
67 *
68 * @param m a int.
69 */
70 public SimulationMessage(int m) {
71 message = m;
72 }
73
74 /**
75 * Getter for the field <code>message</code>.
76 *
77 * @return a int.
78 */
79 public int getMessage() {
80 return message;
81 }
82
83 /**
84 * Setter for the field <code>message</code>.
85 *
86 * @param m a int.
87 */
88 public void setMessage(int m) {
89 message = m;
90 }
91
92 /**
93 * Getter for the field <code>step</code>.
94 *
95 * @return a int.
96 */
97 public int getStep() {
98 return step;
99 }
100
101 /**
102 * Setter for the field <code>step</code>.
103 *
104 * @param s a int.
105 */
106 public void setStep(int s) {
107 step = s;
108 }
109
110 /**
111 * Getter for the field <code>time</code>.
112 *
113 * @return a double.
114 */
115 public double getTime() {
116 return time;
117 }
118
119 /**
120 * Setter for the field <code>time</code>.
121 *
122 * @param t a double.
123 */
124 public void setTime(double t) {
125 time = t;
126 }
127
128 /**
129 * Getter for the field <code>type</code>.
130 *
131 * @return a int.
132 */
133 public int getType() {
134 return type;
135 }
136
137 /**
138 * Setter for the field <code>type</code>.
139 *
140 * @param t a int.
141 */
142 public void setType(int t) {
143 type = t;
144 }
145
146 /** print */
147 public void print() {
148 System.out.println(this);
149 }
150
151 /**
152 * toString
153 *
154 * @return a {@link java.lang.String} object.
155 */
156 public String toString() {
157 if (message == 0) {
158 return new String("SYSTEM").intern();
159 } else if (message == 1) {
160 return new String("UPDATE").intern();
161 } else if (message == 2) {
162 return new String("CLOSING").intern();
163 } else {
164 return new String("OK").intern();
165 }
166 }
167 }