Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: bda5f2919d0baa6599b240bfd189931d6bcdf77c (plain) (blame)
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
/*******************************************************************************
 * Copyright (c) 2012 protos software gmbh (http://www.protos.de).
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * CONTRIBUTORS:
 * 		Juergen Haug (initial contribution)
 * 
 *******************************************************************************/

package org.eclipse.etrice.core.etphys.postprocessing

import org.eclipse.xtext.GeneratedMetamodel

import static extension org.eclipse.etrice.core.common.postprocessing.PostprocessingHelpers.*

class DocuPostprocessor {
		
	def process(GeneratedMetamodel metamodel) {
		val pckg = metamodel.EPackage
		
		//------------------------------------------------------------------
		var cls = pckg.getClass("PhysicalModel")
		cls.setDocumentation(
			'''
				The root object for the physical model. It gives access to the systems, node classes
				and runtimes defined.
			''')
		
		cls.getAttribute("name").setDocumentation(
			'''
				The model name is a dot separated fully qualified name and is
				used to provide a name space.
			''')
		
		cls.getReference("imports").setDocumentation(
			'''
				A list of all imported models.
			''')
		
		cls.getReference("systems").setDocumentation(
			'''
				A list of all defined physical systems.
			''')
		
		cls.getReference("nodeClasses").setDocumentation(
			'''
				A list of all defined node classes.
			''')
			
		cls.getReference("runtimeClasses").setDocumentation(
			'''
				A list of all defined runtime classes.
			''')
		
		//------------------------------------------------------------------
		cls = pckg.getClass("PhysicalSystem")
		cls.setDocumentation(
			'''
				This model object represents a complete physical system.
			''')
		
		cls.getAttribute("name").setDocumentation(
			'''
				The name of the physical system by which it is referred to in the model.
			''')
			
		cls.getReference("nodeRefs").setDocumentation(
			'''
				A list of referenced nodes.
			''')
		
		cls.getReference("docu").setDocumentation(
			'''
				This is an optional documentation.
			''')
		
		//------------------------------------------------------------------
		cls = pckg.getClass("NodeRef")
		cls.setDocumentation(
			'''
				This stands for a node instance in a specific role.
			''')
		
		cls.getAttribute("name").setDocumentation(
			'''
				The name of the reference by which it is referred to in the model.
			''')
			
		cls.getReference("type").setDocumentation(
			'''
				The node class of this reference.
			''')
		
		cls.getReference("docu").setDocumentation(
			'''
				This is an optional documentation.
			''')
		
		//------------------------------------------------------------------
		cls = pckg.getClass("NodeClass")
		cls.setDocumentation(
			'''
				This defines a node class.
			''')
		
		cls.getAttribute("name").setDocumentation(
			'''
				The name of the node class by which it is referred to in the model.
			''')
		
		cls.getReference("docu").setDocumentation(
			'''
				This is an optional documentation.
			''')
		
		cls.getReference("runtime").setDocumentation(
			'''
				This is the associated runtime class.
			''')
		
		cls.getAttribute("priomin").setDocumentation(
			'''
				This is the minimal thread priority for this node type.
			''')
		
		cls.getAttribute("priomax").setDocumentation(
			'''
				This is the maximum thread priority for this node type.
			''')
			
		cls.getReference("threads").setDocumentation(
			'''
				This is a list of all threads defined for this node.
			''')
		
		//------------------------------------------------------------------
		cls = pckg.getClass("PhysicalThread")
		cls.setDocumentation(
			'''
				This defines a physical thread running in a node.
			''')
		
		cls.getAttribute("name").setDocumentation(
			'''
				The name of the thread by which it is referred to in the model.
			''')
		
		cls.getAttribute("default").setDocumentation(
			'''
				If this is {@code true} then this is the default thread.
			''')
		
		cls.getAttribute("execmode").setDocumentation(
			'''
				This is the execution mode of the thread.
			''')
		
		cls.getAttribute("prio").setDocumentation(
			'''
				This is the priority of the thread.
			''')
		
		cls.getAttribute("stacksize").setDocumentation(
			'''
				This is the stacksize of the thread.
			''')
		
		cls.getAttribute("msgblocksize").setDocumentation(
			'''
				This is the msgblocksize of the thread.
			''')
		
		cls.getAttribute("msgpoolsize").setDocumentation(
			'''
				This is the msgpoolsize of the thread.
			''')
		
		//------------------------------------------------------------------
		cls = pckg.getClass("RuntimeClass")
		cls.setDocumentation(
			'''
				This defines a runtime class.
			''')
		
		cls.getAttribute("name").setDocumentation(
			'''
				The name of the runtime class by which it is referred to in the model.
			''')
		
		cls.getReference("docu").setDocumentation(
			'''
				This is an optional documentation.
			''')
		
		cls.getAttribute("threadModel").setDocumentation(
			'''
				This distinguishes single and multi threaded.
			''')

	}
	
}

Back to the top