View Javadoc
1   /*******************************************************************************
2    * jArduino: Arduino C++ Code Generation From Java
3    * Copyright 2020 Tony Washer
4    *
5    * Licensed under the Apache License, Version 2.0 (the "License");
6    * you may not use this file except in compliance with the License.
7    * You may obtain a copy of the License at
8    *
9    *   http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   ******************************************************************************/
17  package net.sourceforge.jarduino.message;
18  
19  /**
20   * Arduino template variables.
21   */
22  public final class ArduinoVar {
23      /**
24       * Private constructor.
25       */
26      private ArduinoVar() {
27      }
28  
29      /**
30       * The variable name header.
31       */
32      private static final String HDR_VAR = "${";
33  
34      /**
35       * The systemName variable.
36       */
37      static final String SYSNAME = HDR_VAR + "systemName" + ArduinoChar.ENDBRACE;
38  
39      /**
40       * The systemCName variable.
41       */
42      static final String SYSCNAME = HDR_VAR + "systemCName" + ArduinoChar.ENDBRACE;
43  
44      /**
45       * The msgName variable.
46       */
47      static final String MSGNAME = HDR_VAR + "msgName" + ArduinoChar.ENDBRACE;
48  
49      /**
50       * The msgId variable.
51       */
52      static final String MSGID = HDR_VAR + "msgId" + ArduinoChar.ENDBRACE;
53  
54      /**
55       * The msgLen variable.
56       */
57      static final String MSGLEN = HDR_VAR + "msgLen" + ArduinoChar.ENDBRACE;
58  
59      /**
60       * The className variable.
61       */
62      static final String CLASSNAME = HDR_VAR + "className" + ArduinoChar.ENDBRACE;
63  
64      /**
65       * The hdrClasses variable.
66       */
67      static final String HDRCLASSES = HDR_VAR + "headerClasses" + ArduinoChar.ENDBRACE;
68  
69      /**
70       * The hdrSetters variable.
71       */
72      static final String HDRSETTERS = HDR_VAR + "headerSetters" + ArduinoChar.ENDBRACE;
73  
74      /**
75       * The hdrGetters variable.
76       */
77      static final String HDRGETTERS = HDR_VAR + "headerGetters" + ArduinoChar.ENDBRACE;
78  
79      /**
80       * The hdrFields variable.
81       */
82      static final String HDRFIELDS = HDR_VAR + "headerFields" + ArduinoChar.ENDBRACE;
83  
84      /**
85       * The publicFields variable.
86       */
87      static final String PUBFIELDS = HDR_VAR + "pubFields" + ArduinoChar.ENDBRACE;
88  
89      /**
90       * The privateFields variable.
91       */
92      static final String PRIVFIELDS = HDR_VAR + "privFields" + ArduinoChar.ENDBRACE;
93  
94      /**
95       * The hdrFieldDefs variable.
96       */
97      static final String HDRFIELDDEFS = HDR_VAR + "headerFieldDefs" + ArduinoChar.ENDBRACE;
98  
99      /**
100      * The muxSetter variable.
101      */
102     static final String MUXSETTER = HDR_VAR + "muxSetter" + ArduinoChar.ENDBRACE;
103 
104     /**
105      * The muxSet variable.
106      */
107     static final String MUXSET = HDR_VAR + "muxSet" + ArduinoChar.ENDBRACE;
108 
109     /**
110      * The muxValue variable.
111      */
112     static final String MUXVALUE = HDR_VAR + "muxValue" + ArduinoChar.ENDBRACE;
113 
114     /**
115      * The muxSwitch variable.
116      */
117     static final String MUXSWITCH = HDR_VAR + "muxSwitch" + ArduinoChar.ENDBRACE;
118 
119     /**
120      * The bodyClasses variable.
121      */
122     static final String BDYCLASSES = HDR_VAR + "bodyClasses" + ArduinoChar.ENDBRACE;
123 
124     /**
125      * The bodyParsers variable.
126      */
127     static final String BDYREADERS = HDR_VAR + "bodyParsers" + ArduinoChar.ENDBRACE;
128 
129     /**
130      * The bodyWriters variable.
131      */
132     static final String BDYWRITERS = HDR_VAR + "bodyWriters" + ArduinoChar.ENDBRACE;
133 
134     /**
135      * The bdyFieldDefs variable.
136      */
137     static final String BDYFIELDDEFS = HDR_VAR + "bodyFieldDefs" + ArduinoChar.ENDBRACE;
138 
139     /**
140      * The fieldType variable.
141      */
142     static final String FIELDTYPE = HDR_VAR + "fieldType" + ArduinoChar.ENDBRACE;
143 
144     /**
145      * The fieldClass variable.
146      */
147     static final String FIELDCLASS = HDR_VAR + "fieldClass" + ArduinoChar.ENDBRACE;
148 
149     /**
150      * The fieldName variable.
151      */
152     static final String FIELDNAME = HDR_VAR + "fieldName" + ArduinoChar.ENDBRACE;
153 
154     /**
155      * The fieldBounded variable.
156      */
157     static final String FIELDBOUND = HDR_VAR + "fieldBound" + ArduinoChar.ENDBRACE;
158 
159     /**
160      * The startBit variable.
161      */
162     static final String DEFSTART = HDR_VAR + "startBit" + ArduinoChar.ENDBRACE;
163 
164     /**
165      * The bitLength variable.
166      */
167     static final String DEFLENGTH = HDR_VAR + "bitLength" + ArduinoChar.ENDBRACE;
168 
169     /**
170      * The endian variable.
171      */
172     static final String DEFENDIAN = HDR_VAR + "littleEndian" + ArduinoChar.ENDBRACE;
173 
174     /**
175      * The signed variable.
176      */
177     static final String DEFSIGNED = HDR_VAR + "signed" + ArduinoChar.ENDBRACE;
178 
179     /**
180      * The factor variable.
181      */
182     static final String DEFFACTOR = HDR_VAR + "factor" + ArduinoChar.ENDBRACE;
183 
184     /**
185      * The offset variable.
186      */
187     static final String DEFOFFSET = HDR_VAR + "offset" + ArduinoChar.ENDBRACE;
188 
189     /**
190      * The min variable.
191      */
192     static final String DEFMIN = HDR_VAR + "min" + ArduinoChar.ENDBRACE;
193 
194     /**
195      * The max variable.
196      */
197     static final String DEFMAX = HDR_VAR + "max" + ArduinoChar.ENDBRACE;
198 
199     /**
200      * The msgCases variable.
201      */
202     static final String MSGCASES = HDR_VAR + "msgCases" + ArduinoChar.ENDBRACE;
203 
204     /**
205      * The max variable.
206      */
207     static final String MUXCASES = HDR_VAR + "muxCases" + ArduinoChar.ENDBRACE;
208 
209     /**
210      * The parseHeader variable.
211      */
212     static final String PARSEHDR = HDR_VAR + "parseHeader" + ArduinoChar.ENDBRACE;
213 
214     /**
215      * The buildHeader variable.
216      */
217     static final String BUILDHDR = HDR_VAR + "buildHeader" + ArduinoChar.ENDBRACE;
218 
219     /**
220      * The parseBody variable.
221      */
222     static final String PARSEBDY = HDR_VAR + "parseBody" + ArduinoChar.ENDBRACE;
223 
224     /**
225      * The buildBody variable.
226      */
227     static final String BUILDBDY = HDR_VAR + "buildBody" + ArduinoChar.ENDBRACE;
228 }