OpenCores
URL https://opencores.org/ocsvn/socgen/socgen/trunk

Subversion Repositories socgen

[/] [socgen/] [trunk/] [tools/] [ip-xact/] [1685-2009/] [TGI/] [TGI.html] - Blame information for rev 135

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 135 jt_eaton
<HTML>
2
 
3
 
4
<HEAD>
5
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
6
<TITLE>TGI API Documentation</TITLE>
7
<style>
8
<!--
9
body,td,th,a,p,.h{font-family:arial,sans-serif}
10
.h{font-size:20px}
11
.q{color:#00c}
12
th{background-color:#b8b8ff}
13
td{padding:4}
14
-->
15
</style>
16
</HEAD>
17
 
18
  <BODY>
19
  <H1><CENTER>TGI API Documentation</CENTER></H1>
20
  <CENTER>Generated on Tue Jun  2 11:30:29 CDT 2009</CENTER>
21
<H2>Category Index</H2>
22
<TABLE BORDER=1>
23
<TR>
24
<TD><A HREF="#AbstractionDefinition Operations">Abstraction Definition Operations</A></TD>
25
<TD><A HREF="#AbstractorInstance Operations">Abstractor Instance Operations</A></TD>
26
<TD><A HREF="#AbstractorOperations">Abstractor Operations</A></TD>
27
</TR><TR>
28
<TD><A HREF="#AddressMap Operations">Address Map Operations</A></TD>
29
<TD><A HREF="#BusDefinition Operations">Bus Definition Operations</A></TD>
30
<TD><A HREF="#BusInterface Operations">Bus Interface Operations</A></TD>
31
</TR><TR>
32
<TD><A HREF="#ComponentInstance Operations">Component Instance Operations</A></TD>
33
<TD><A HREF="#ComponentOperations">Component Operations</A></TD>
34
<TD><A HREF="#ConstraintOperations">Constraint Operations</A></TD>
35
</TR><TR>
36
<TD><A HREF="#DesignOperations">Design Operations</A></TD>
37
<TD><A HREF="#FieldOperations">Field Operations</A></TD>
38
<TD><A HREF="#Fileand Fileset Operations">File and Fileset Operations</A></TD>
39
</TR><TR>
40
<TD><A HREF="#GeneratorOperations">Generator Operations</A></TD>
41
<TD><A HREF="#InterfaceOperations">Interface Operations</A></TD>
42
<TD><A HREF="#MiscellaneousOperations">Miscellaneous Operations</A></TD>
43
</TR><TR>
44
<TD><A HREF="#PortOperations">Port Operations</A></TD>
45
<TD><A HREF="#RegisterFile Operations">Register File Operations</A></TD>
46
<TD><A HREF="#RegisterOperations">Register Operations</A></TD>
47
</TR><TR>
48
<TD><A HREF="#RemapOperations">Remap Operations</A></TD>
49
<TD><A HREF="#ServiceOperations">Service Operations</A></TD>
50
<TD><A HREF="#TypeDefOperations">TypeDef Operations</A></TD>
51
</TR><TR>
52
<TD><A HREF="#ViewOperations">View Operations</A></TD>
53
<TD><A HREF="#WhiteboxOperations">Whitebox Operations</A></TD>
54
<TD><A HREF="#elementID0">All ID Types</A></TD>
55
</TR></TABLE>
56
<P>
57
<H2><A NAME="AbstractionDefinition Operations">Abstraction Definition Operations</A></H2>
58
<TABLE BORDER=1 WIDTH="100%">
59
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
60
<TR><TD><A HREF="#getAbstractionDefID">getAbstractionDefID</A></TD>
61
<TD>ID for the abstraction definition with the given VLNV</TD>
62
<TD>&nbsp;</TD></TR>
63
<TR><TD><A HREF="#getAbstractionDefVLNV">getAbstractionDefVLNV</A></TD>
64
<TD>Vendor Library Name Version of the abstraction definition</TD>
65
<TD>&nbsp;</TD></TR>
66
<TR><TD><A HREF="#getAbstractionDefBusTypeVLNV">getAbstractionDefBusTypeVLNV</A></TD>
67
<TD>Get VLNV of the bus definition</TD>
68
<TD>&nbsp;</TD></TR>
69
<TR><TD><A HREF="#getAbstractionDefExtends">getAbstractionDefExtends</A></TD>
70
<TD>Vendor Library Name Version of the abstraction definition being extended</TD>
71
<TD>New in 1.5</TD></TR>
72
<TR><TD><A HREF="#getAbstractionDefPortIDs">getAbstractionDefPortIDs</A></TD>
73
<TD>List of abstraction definition port element IDs</TD>
74
<TD>&nbsp;</TD></TR>
75
<TR><TD><A HREF="#getAbstractionDefPortLogicalName">getAbstractionDefPortLogicalName</A></TD>
76
<TD>Logical name of this abstraction definition port</TD>
77
<TD>&nbsp;</TD></TR>
78
<TR><TD><A HREF="#getAbstractionDefPortRequiresDriver">getAbstractionDefPortRequiresDriver</A></TD>
79
<TD>Does this port require a driver</TD>
80
<TD>&nbsp;</TD></TR>
81
<TR><TD><A HREF="#getAbstractionDefPortRequiredDriverType">getAbstractionDefPortRequiredDriverType</A></TD>
82
<TD>Required driver type for this port</TD>
83
<TD>&nbsp;</TD></TR>
84
<TR><TD><A HREF="#getAbstractionDefPortStyle">getAbstractionDefPortStyle</A></TD>
85
<TD>Returns 'wire' or 'transactional' to indicate the port style</TD>
86
<TD>&nbsp;</TD></TR>
87
<TR><TD><A HREF="#getAbstractionDefPortIsAddress">getAbstractionDefPortIsAddress</A></TD>
88
<TD>Is this port an address port</TD>
89
<TD>&nbsp;</TD></TR>
90
<TR><TD><A HREF="#getAbstractionDefPortIsData">getAbstractionDefPortIsData</A></TD>
91
<TD>Is this port a data port</TD>
92
<TD>&nbsp;</TD></TR>
93
<TR><TD><A HREF="#getAbstractionDefPortIsClock">getAbstractionDefPortIsClock</A></TD>
94
<TD>Is this port a clock port</TD>
95
<TD>&nbsp;</TD></TR>
96
<TR><TD><A HREF="#getAbstractionDefPortIsReset">getAbstractionDefPortIsReset</A></TD>
97
<TD>Is this port a reset port</TD>
98
<TD>&nbsp;</TD></TR>
99
<TR><TD><A HREF="#getAbstractionDefPortModeID">getAbstractionDefPortModeID</A></TD>
100
<TD>Returns an ID for accessing the given port in the given interface mode</TD>
101
<TD><FONT color=#ff0000>Invalid in 1.5</FONT></TD></TR>
102
<TR><TD><A HREF="#getAbstractionDefPortModeIDs">getAbstractionDefPortModeIDs</A></TD>
103
<TD>Returns an array of IDs for accessing the given port in the given interface mode. The array shall only contain one element if the modeValue input is master or slave. The array may contain multiple elements for modeValue system.</TD>
104
<TD>New in 1.5</TD></TR>
105
<TR><TD><A HREF="#getAbstractionDefPortModeGroup">getAbstractionDefPortModeGroup</A></TD>
106
<TD>Group name when present on a system interface</TD>
107
<TD>&nbsp;</TD></TR>
108
<TR><TD><A HREF="#getAbstractionDefPortModeBitWidth">getAbstractionDefPortModeBitWidth</A></TD>
109
<TD>Bit width constraint when present on an interface of the given type</TD>
110
<TD>&nbsp;</TD></TR>
111
<TR><TD><A HREF="#getAbstractionDefPortModeDirection">getAbstractionDefPortModeDirection</A></TD>
112
<TD>Port direction constraint when present on an interface of the given type</TD>
113
<TD>&nbsp;</TD></TR>
114
<TR><TD><A HREF="#getAbstractionDefPortNonMirroredConstraintIDs">getAbstractionDefPortNonMirroredConstraintIDs</A></TD>
115
<TD>List of constraint IDs for a non-mirrored port</TD>
116
<TD>&nbsp;</TD></TR>
117
<TR><TD><A HREF="#getAbstractionDefPortMirroredConstraintIDs">getAbstractionDefPortMirroredConstraintIDs</A></TD>
118
<TD>List of constraint IDs for a mirrored port</TD>
119
<TD>&nbsp;</TD></TR>
120
<TR><TD><A HREF="#getAbstractionDefPortDriveConstraintIDs">getAbstractionDefPortDriveConstraintIDs</A></TD>
121
<TD>List of drive constraint IDs of the port</TD>
122
<TD>&nbsp;</TD></TR>
123
<TR><TD><A HREF="#getAbstractionDefPortLoadConstraintIDs">getAbstractionDefPortLoadConstraintIDs</A></TD>
124
<TD>List of load constraint IDs of the port</TD>
125
<TD>&nbsp;</TD></TR>
126
<TR><TD><A HREF="#getAbstractionDefPortTimingConstraintIDs">getAbstractionDefPortTimingConstraintIDs</A></TD>
127
<TD>List of timing constraint IDs of the port</TD>
128
<TD>&nbsp;</TD></TR>
129
<TR><TD><A HREF="#getAbstractionDefPortDefaultValue">getAbstractionDefPortDefaultValue</A></TD>
130
<TD>Default value for port when not connected</TD>
131
<TD>&nbsp;</TD></TR>
132
<TR><TD><A HREF="#getAbstractionDefPortModePresence">getAbstractionDefPortModePresence</A></TD>
133
<TD>Existence requirement for this port on an interface of the given type</TD>
134
<TD>&nbsp;</TD></TR>
135
<TR><TD><A HREF="#getAbstractionDefPortModeServiceIDs">getAbstractionDefPortModeServiceIDs</A></TD>
136
<TD>AbstractionDef service IDs on a transactional port</TD>
137
<TD><FONT color=#ff0000>Invalid in 1.5</FONT></TD></TR>
138
<TR><TD><A HREF="#getAbstractionDefPortModeServiceID">getAbstractionDefPortModeServiceID</A></TD>
139
<TD>AbstractionDef service ID on a transactional port</TD>
140
<TD>New in 1.5</TD></TR>
141
</TABLE>
142
<P>
143
<H2><A NAME="AbstractorInstance Operations">Abstractor Instance Operations</A></H2>
144
<TABLE BORDER=1 WIDTH="100%">
145
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
146
<TR><TD><A HREF="#getAbstractorInstanceName">getAbstractorInstanceName</A></TD>
147
<TD>Instance name of the abstractor</TD>
148
<TD>&nbsp;</TD></TR>
149
<TR><TD><A HREF="#getAbstractorInstanceVLNV">getAbstractorInstanceVLNV</A></TD>
150
<TD>Vendor Library Name Version of the abstractor (from the design file)</TD>
151
<TD>&nbsp;</TD></TR>
152
<TR><TD><A HREF="#getAbstractorInstanceAbstractorID">getAbstractorInstanceAbstractorID</A></TD>
153
<TD>ID for the abstractor associated with given instance (crossing from design configuration to abstractor file)</TD>
154
<TD>&nbsp;</TD></TR>
155
<TR><TD><A HREF="#getAbstractorInstanceXML">getAbstractorInstanceXML</A></TD>
156
<TD>Return the abstractor XML in text format. Schema version is DE dependent.</TD>
157
<TD>&nbsp;</TD></TR>
158
</TABLE>
159
<P>
160
<H2><A NAME="AbstractorOperations">Abstractor Operations</A></H2>
161
<TABLE BORDER=1 WIDTH="100%">
162
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
163
<TR><TD><A HREF="#getAbstractorAbstractorMode">getAbstractorAbstractorMode</A></TD>
164
<TD>Get the mode that the abstractor can be master, slave, direct or system.</TD>
165
<TD>&nbsp;</TD></TR>
166
<TR><TD><A HREF="#getAbstractorBusTypeVLNV">getAbstractorBusTypeVLNV</A></TD>
167
<TD>List of VLNV of the bus definition</TD>
168
<TD>&nbsp;</TD></TR>
169
<TR><TD><A HREF="#getAbstractorAbstractorInterfaceIDs">getAbstractorAbstractorInterfaceIDs</A></TD>
170
<TD>List of 2 interface IDs</TD>
171
<TD>&nbsp;</TD></TR>
172
<TR><TD><A HREF="#getAbstractorViewIDs">getAbstractorViewIDs</A></TD>
173
<TD>A list of model view IDs</TD>
174
<TD>Modified in 1.5</TD></TR>
175
<TR><TD><A HREF="#getAbstractorPortIDs">getAbstractorPortIDs</A></TD>
176
<TD>A list of abstractor model port IDs</TD>
177
<TD>&nbsp;</TD></TR>
178
<TR><TD><A HREF="#getAbstractorModelParameterIDs">getAbstractorModelParameterIDs</A></TD>
179
<TD>A list of model parameter IDs</TD>
180
<TD>&nbsp;</TD></TR>
181
<TR><TD><A HREF="#getAbstractorGeneratorIDs">getAbstractorGeneratorIDs</A></TD>
182
<TD>List of generator IDs of the abstractor</TD>
183
<TD>&nbsp;</TD></TR>
184
<TR><TD><A HREF="#getAbstractorChoiceIDs">getAbstractorChoiceIDs</A></TD>
185
<TD>List of choices IDs</TD>
186
<TD>&nbsp;</TD></TR>
187
<TR><TD><A HREF="#getAbstractorFileSetIDs">getAbstractorFileSetIDs</A></TD>
188
<TD>List of file set IDs</TD>
189
<TD>&nbsp;</TD></TR>
190
</TABLE>
191
<P>
192
<H2><A NAME="AddressMap Operations">Address Map Operations</A></H2>
193
<TABLE BORDER=1 WIDTH="100%">
194
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
195
<TR><TD><A HREF="#getAddressSpaceRange">getAddressSpaceRange</A></TD>
196
<TD>The address range of an address block expressed as the number of accessable and addressable units., <B>Configurable</B></TD>
197
<TD>&nbsp;</TD></TR>
198
<TR><TD><A HREF="#getAddressSpaceWidth">getAddressSpaceWidth</A></TD>
199
<TD>The bit width of an address block., <B>Configurable</B></TD>
200
<TD>&nbsp;</TD></TR>
201
<TR><TD><A HREF="#getAddressSpaceLocalMemoryMapID">getAddressSpaceLocalMemoryMapID</A></TD>
202
<TD>The ID for the local memory map of the address space.</TD>
203
<TD>New in 1.5</TD></TR>
204
<TR><TD><A HREF="#getAddressSpaceSegmentIDs">getAddressSpaceSegmentIDs</A></TD>
205
<TD>List of IDs for address block segments for the address space.</TD>
206
<TD>New in 1.5</TD></TR>
207
<TR><TD><A HREF="#getSegmentAddressOffset">getSegmentAddressOffset</A></TD>
208
<TD>The address offset of an address space segment in an address space, <B>Configurable</B></TD>
209
<TD>New in 1.5</TD></TR>
210
<TR><TD><A HREF="#setSegmentAddressOffset">setSegmentAddressOffset</A></TD>
211
<TD>Set the address offset of an address space segment expressed in the number addressable units.</TD>
212
<TD>New in 1.5</TD></TR>
213
<TR><TD><A HREF="#getSegmentRange">getSegmentRange</A></TD>
214
<TD>The address range of an address space segment expressed as the number of accessable addressable units., <B>Configurable</B></TD>
215
<TD>New in 1.5</TD></TR>
216
<TR><TD><A HREF="#setSegmentRange">setSegmentRange</A></TD>
217
<TD>Set the address range of an address space segment expressed as the number of accessable addressable units.</TD>
218
<TD>New in 1.5</TD></TR>
219
<TR><TD><A HREF="#getAddressSpaceAddressUnitBits">getAddressSpaceAddressUnitBits</A></TD>
220
<TD>The number bits in an addressable unit.  If none exists, the default 8 bits is returned.</TD>
221
<TD>&nbsp;</TD></TR>
222
<TR><TD><A HREF="#getExecutableImageIDs">getExecutableImageIDs</A></TD>
223
<TD>The IDs of the executable images belonging to the specified address space.</TD>
224
<TD>&nbsp;</TD></TR>
225
<TR><TD><A HREF="#getExecutableImageType">getExecutableImageType</A></TD>
226
<TD>The type of the executable image if existent.</TD>
227
<TD>&nbsp;</TD></TR>
228
<TR><TD><A HREF="#getExecutableImageLinkerCommand">getExecutableImageLinkerCommand</A></TD>
229
<TD>The linker command for the current executable image., <B>Configurable</B></TD>
230
<TD>&nbsp;</TD></TR>
231
<TR><TD><A HREF="#getExecutableImageLinkerFlags">getExecutableImageLinkerFlags</A></TD>
232
<TD>The flags of the current executable image linker command., <B>Configurable</B></TD>
233
<TD>&nbsp;</TD></TR>
234
<TR><TD><A HREF="#getExecutableImageLinkerCommandFileID">getExecutableImageLinkerCommandFileID</A></TD>
235
<TD>Element ID of linkerCommandFile associated with given executable image.</TD>
236
<TD>&nbsp;</TD></TR>
237
<TR><TD><A HREF="#getExecutableImageFileBuilderIDs">getExecutableImageFileBuilderIDs</A></TD>
238
<TD>List of default file builder IDs of the executable image</TD>
239
<TD>&nbsp;</TD></TR>
240
<TR><TD><A HREF="#getExecutableImageFileSetIDs">getExecutableImageFileSetIDs</A></TD>
241
<TD>The group of file set reference IDs complying with the tool set of the current executable image.</TD>
242
<TD>&nbsp;</TD></TR>
243
<TR><TD><A HREF="#getLinkerCommandFileName">getLinkerCommandFileName</A></TD>
244
<TD>The name of the linker command file., <B>Configurable</B></TD>
245
<TD>&nbsp;</TD></TR>
246
<TR><TD><A HREF="#getLinkerCommandFileLineSwitch">getLinkerCommandFileLineSwitch</A></TD>
247
<TD>The command line switch to specify with the linker command file., <B>Configurable</B></TD>
248
<TD>&nbsp;</TD></TR>
249
<TR><TD><A HREF="#getLinkerCommandFileEnable">getLinkerCommandFileEnable</A></TD>
250
<TD>Indicates whether or not to generate and enable the linker command file., <B>Configurable</B></TD>
251
<TD>&nbsp;</TD></TR>
252
<TR><TD><A HREF="#getLinkerCommandGeneratorIDs">getLinkerCommandGeneratorIDs</A></TD>
253
<TD>Reference IDs to the generator elements for generating the linker command file.</TD>
254
<TD>&nbsp;</TD></TR>
255
<TR><TD><A HREF="#getMemoryMapElementIDs">getMemoryMapElementIDs</A></TD>
256
<TD>List of element IDs (addressBlockID, bankID, subspaceMapID) within a memory map, memory remap, local memory map, or bank</TD>
257
<TD>Modified in 1.5</TD></TR>
258
<TR><TD><A HREF="#getMemoryMapElementType">getMemoryMapElementType</A></TD>
259
<TD>Indicates type of memory map element: addressBlock, bank or subspaceMap</TD>
260
<TD>&nbsp;</TD></TR>
261
<TR><TD><A HREF="#getMemoryMapAddressUnitBits">getMemoryMapAddressUnitBits</A></TD>
262
<TD>The number bits in an addressable unit for a memory map.  If none exists, the default 8 bits is returned.</TD>
263
<TD>&nbsp;</TD></TR>
264
<TR><TD><A HREF="#getAddressBlockBaseAddress">getAddressBlockBaseAddress</A></TD>
265
<TD>The base address of an address block, <B>Configurable</B></TD>
266
<TD>&nbsp;</TD></TR>
267
<TR><TD><A HREF="#getAddressBlockRange">getAddressBlockRange</A></TD>
268
<TD>The address range of an address block expressed as the number of accessable and addressable units., <B>Configurable</B></TD>
269
<TD>&nbsp;</TD></TR>
270
<TR><TD><A HREF="#getAddressBlockWidth">getAddressBlockWidth</A></TD>
271
<TD>The bit width of an address block in the local memory map., <B>Configurable</B></TD>
272
<TD>&nbsp;</TD></TR>
273
<TR><TD><A HREF="#getAddressBlockUsage">getAddressBlockUsage</A></TD>
274
<TD>Indicates the usage of this address block.</TD>
275
<TD>&nbsp;</TD></TR>
276
<TR><TD><A HREF="#getAddressBlockVolatility">getAddressBlockVolatility</A></TD>
277
<TD>Indicates whether or not the data is volatile.</TD>
278
<TD>&nbsp;</TD></TR>
279
<TR><TD><A HREF="#getAddressBlockAccess">getAddressBlockAccess</A></TD>
280
<TD>The accessibility of the data in the local address block.</TD>
281
<TD>&nbsp;</TD></TR>
282
<TR><TD><A HREF="#getAddressBlockRegisterIDs">getAddressBlockRegisterIDs</A></TD>
283
<TD>The IDs of the available registers in the address block.</TD>
284
<TD>&nbsp;</TD></TR>
285
<TR><TD><A HREF="#getAddressBlockRegisterFileIDs">getAddressBlockRegisterFileIDs</A></TD>
286
<TD>The IDs of the available register files in the address block.</TD>
287
<TD>New in 1.5</TD></TR>
288
<TR><TD><A HREF="#getTypeIdentifier">getTypeIdentifier</A></TD>
289
<TD>Indicates the type identifier of an addressBlock, registerFile, register or field.</TD>
290
<TD>New in 1.5</TD></TR>
291
<TR><TD><A HREF="#getBankAlignment">getBankAlignment</A></TD>
292
<TD>The bank alignment value, serial or parallel</TD>
293
<TD>&nbsp;</TD></TR>
294
<TR><TD><A HREF="#getBankBaseAddress">getBankBaseAddress</A></TD>
295
<TD>The base address of an address bank, <B>Configurable</B></TD>
296
<TD>&nbsp;</TD></TR>
297
<TR><TD><A HREF="#getBankUsage">getBankUsage</A></TD>
298
<TD>Indicates the usage of this address bank.</TD>
299
<TD>&nbsp;</TD></TR>
300
<TR><TD><A HREF="#getBankVolatility">getBankVolatility</A></TD>
301
<TD>Indicates whether or not the data is volatile.</TD>
302
<TD>&nbsp;</TD></TR>
303
<TR><TD><A HREF="#getBankAccess">getBankAccess</A></TD>
304
<TD>The accessibility of the data in the local address bank.</TD>
305
<TD>&nbsp;</TD></TR>
306
<TR><TD><A HREF="#getSubspaceMapMasterID">getSubspaceMapMasterID</A></TD>
307
<TD>Master bus interface ID on the other side of a bus bridge .</TD>
308
<TD>&nbsp;</TD></TR>
309
<TR><TD><A HREF="#getSubspaceMapSegmentID">getSubspaceMapSegmentID</A></TD>
310
<TD>Address space segment ID on the other side of a bus bridge .</TD>
311
<TD>New in 1.5</TD></TR>
312
<TR><TD><A HREF="#getSubspaceMapBaseAddress">getSubspaceMapBaseAddress</A></TD>
313
<TD>The base address of a memory subspace, <B>Configurable</B></TD>
314
<TD>&nbsp;</TD></TR>
315
<TR><TD><A HREF="#getMemoryMapRemapElementIDs">getMemoryMapRemapElementIDs</A></TD>
316
<TD>List of IDs for memory map 'remap' elements of the given memory map</TD>
317
<TD>&nbsp;</TD></TR>
318
<TR><TD><A HREF="#getMemoryRemapStateID">getMemoryRemapStateID</A></TD>
319
<TD>Remap State ID for which this remap is applicable</TD>
320
<TD>&nbsp;</TD></TR>
321
<TR><TD><A HREF="#setAddressSpaceRange">setAddressSpaceRange</A></TD>
322
<TD>Set the address range of an address block expressed as the number of accessable and addressable units.</TD>
323
<TD>&nbsp;</TD></TR>
324
<TR><TD><A HREF="#setAddressSpaceWidth">setAddressSpaceWidth</A></TD>
325
<TD>Set the bit width of an address block.</TD>
326
<TD>&nbsp;</TD></TR>
327
<TR><TD><A HREF="#setExecutableImageLinkerCommand">setExecutableImageLinkerCommand</A></TD>
328
<TD>Set the linker command for the current executable image.</TD>
329
<TD>&nbsp;</TD></TR>
330
<TR><TD><A HREF="#setExecutableImageLinkerFlags">setExecutableImageLinkerFlags</A></TD>
331
<TD>Set the flags of the current executable image linker command.</TD>
332
<TD>&nbsp;</TD></TR>
333
<TR><TD><A HREF="#setLinkerCommandFileName">setLinkerCommandFileName</A></TD>
334
<TD>Set the name of the linker command file.</TD>
335
<TD>&nbsp;</TD></TR>
336
<TR><TD><A HREF="#setLinkerCommandFileLineSwitch">setLinkerCommandFileLineSwitch</A></TD>
337
<TD>Set the command line switch to specify with the linker command file.</TD>
338
<TD>&nbsp;</TD></TR>
339
<TR><TD><A HREF="#setLinkerCommandFileEnable">setLinkerCommandFileEnable</A></TD>
340
<TD>Set whether or not to generate and enable the linker command file.</TD>
341
<TD>&nbsp;</TD></TR>
342
<TR><TD><A HREF="#setAddressBlockBaseAddress">setAddressBlockBaseAddress</A></TD>
343
<TD>Set the base address of an address block</TD>
344
<TD>&nbsp;</TD></TR>
345
<TR><TD><A HREF="#setAddressBlockRange">setAddressBlockRange</A></TD>
346
<TD>Set the address range of an address block expressed as the number of accessable and addressable units.</TD>
347
<TD>&nbsp;</TD></TR>
348
<TR><TD><A HREF="#setAddressBlockWidth">setAddressBlockWidth</A></TD>
349
<TD>Set the bit width of an address block</TD>
350
<TD>&nbsp;</TD></TR>
351
<TR><TD><A HREF="#setBankBaseAddress">setBankBaseAddress</A></TD>
352
<TD>Set the base address of an address bank</TD>
353
<TD>&nbsp;</TD></TR>
354
<TR><TD><A HREF="#setSubspaceMapBaseAddress">setSubspaceMapBaseAddress</A></TD>
355
<TD>Set the base address of a memory subspace</TD>
356
<TD>&nbsp;</TD></TR>
357
</TABLE>
358
<P>
359
<H2><A NAME="BusDefinition Operations">Bus Definition Operations</A></H2>
360
<TABLE BORDER=1 WIDTH="100%">
361
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
362
<TR><TD><A HREF="#getBusDefinitionID">getBusDefinitionID</A></TD>
363
<TD>ID for the bus definition with the given VLNV</TD>
364
<TD>&nbsp;</TD></TR>
365
<TR><TD><A HREF="#getBusDefinitionVLNV">getBusDefinitionVLNV</A></TD>
366
<TD>Vendor Library Name Version of the bus definition</TD>
367
<TD>&nbsp;</TD></TR>
368
<TR><TD><A HREF="#getBusDefinitionDirectConnection">getBusDefinitionDirectConnection</A></TD>
369
<TD>Indicates whether or not the bus definition supports direct connections</TD>
370
<TD>&nbsp;</TD></TR>
371
<TR><TD><A HREF="#getBusDefinitionIsAddressable">getBusDefinitionIsAddressable</A></TD>
372
<TD>Indicates whether or not the bus definition is an addressable bus</TD>
373
<TD>&nbsp;</TD></TR>
374
<TR><TD><A HREF="#getBusDefinitionExtends">getBusDefinitionExtends</A></TD>
375
<TD>Vendor Library Name Version of the bus definition being extended</TD>
376
<TD>&nbsp;</TD></TR>
377
<TR><TD><A HREF="#getBusDefinitionMaxMasters">getBusDefinitionMaxMasters</A></TD>
378
<TD>Maximum # of masters supported by this bus definition</TD>
379
<TD>&nbsp;</TD></TR>
380
<TR><TD><A HREF="#getBusDefinitionMaxSlaves">getBusDefinitionMaxSlaves</A></TD>
381
<TD>Maximum # of slaves supported by this bus definition</TD>
382
<TD>&nbsp;</TD></TR>
383
<TR><TD><A HREF="#getBusDefinitionSystemGroupNames">getBusDefinitionSystemGroupNames</A></TD>
384
<TD>List of system group names for this bus definition</TD>
385
<TD>&nbsp;</TD></TR>
386
</TABLE>
387
<P>
388
<H2><A NAME="BusInterface Operations">Bus Interface Operations</A></H2>
389
<TABLE BORDER=1 WIDTH="100%">
390
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
391
<TR><TD><A HREF="#getBusInterfaceMasterAddressSpaceID">getBusInterfaceMasterAddressSpaceID</A></TD>
392
<TD>ID of the master addressSpace</TD>
393
<TD>&nbsp;</TD></TR>
394
<TR><TD><A HREF="#getBusInterfaceMasterBaseAddress">getBusInterfaceMasterBaseAddress</A></TD>
395
<TD>Base address of the master addressSpace, <B>Configurable</B></TD>
396
<TD>&nbsp;</TD></TR>
397
<TR><TD><A HREF="#getBusInterfaceSlaveMemoryMapID">getBusInterfaceSlaveMemoryMapID</A></TD>
398
<TD>ID of the memoryMap referenced from a slave interface</TD>
399
<TD>&nbsp;</TD></TR>
400
<TR><TD><A HREF="#getBusInterfaceSlaveBridgeIDs">getBusInterfaceSlaveBridgeIDs</A></TD>
401
<TD>List of slave bridge IDs</TD>
402
<TD>&nbsp;</TD></TR>
403
<TR><TD><A HREF="#getBridgeMasterID">getBridgeMasterID</A></TD>
404
<TD>The slave interface master interface reference ID</TD>
405
<TD>&nbsp;</TD></TR>
406
<TR><TD><A HREF="#getBridgeIsOpaque">getBridgeIsOpaque</A></TD>
407
<TD>Value of the opaque attribute</TD>
408
<TD>&nbsp;</TD></TR>
409
<TR><TD><A HREF="#getBusInterfaceSlaveFileSetGroupIDs">getBusInterfaceSlaveFileSetGroupIDs</A></TD>
410
<TD>List of fileSetGroup IDs</TD>
411
<TD>&nbsp;</TD></TR>
412
<TR><TD><A HREF="#getBusInterfaceGroupName">getBusInterfaceGroupName</A></TD>
413
<TD>Group name of a system, mirroredSystem, or monitor bus interface</TD>
414
<TD>&nbsp;</TD></TR>
415
<TR><TD><A HREF="#getBusInterfaceMirroredSlaveRemapAddressIDs">getBusInterfaceMirroredSlaveRemapAddressIDs</A></TD>
416
<TD>List of remap address IDs of the mirrored slave interface</TD>
417
<TD>&nbsp;</TD></TR>
418
<TR><TD><A HREF="#getRemapAddressValue">getRemapAddressValue</A></TD>
419
<TD>Remap address of the given remap address element</TD>
420
<TD>&nbsp;</TD></TR>
421
<TR><TD><A HREF="#getRemapAddressRemapStateID">getRemapAddressRemapStateID</A></TD>
422
<TD>Remap state ID of the given remap address element</TD>
423
<TD>&nbsp;</TD></TR>
424
<TR><TD><A HREF="#getBusInterfaceMirroredSlaveRange">getBusInterfaceMirroredSlaveRange</A></TD>
425
<TD>The address range of the mirrored slave interface</TD>
426
<TD>&nbsp;</TD></TR>
427
<TR><TD><A HREF="#getBusInterfaceMonitorInterfaceMode">getBusInterfaceMonitorInterfaceMode</A></TD>
428
<TD>Indicates the mode of interface being monitored, slave, master, system, mirrorslave, mirrormaster or mirrorslave</TD>
429
<TD>&nbsp;</TD></TR>
430
<TR><TD><A HREF="#getBusInterfaceConnectionRequired">getBusInterfaceConnectionRequired</A></TD>
431
<TD>Connection required for this bus interface</TD>
432
<TD>&nbsp;</TD></TR>
433
<TR><TD><A HREF="#getBusInterfaceBitSteering">getBusInterfaceBitSteering</A></TD>
434
<TD>Bit steering description of the bus interface: on or off, <B>Configurable</B></TD>
435
<TD>&nbsp;</TD></TR>
436
<TR><TD><A HREF="#getBusInterfaceEndianness">getBusInterfaceEndianness</A></TD>
437
<TD>The endianess of the bus interface, big or little. The default is little.</TD>
438
<TD>&nbsp;</TD></TR>
439
<TR><TD><A HREF="#getBusInterfaceBitsInLAU">getBusInterfaceBitsInLAU</A></TD>
440
<TD>The number bits in the least addressable unit.  If none exists, the default 8 bits is returned.</TD>
441
<TD>&nbsp;</TD></TR>
442
<TR><TD><A HREF="#setBusInterfaceMasterBaseAddress">setBusInterfaceMasterBaseAddress</A></TD>
443
<TD>Set base address of the master bus interface.</TD>
444
<TD>&nbsp;</TD></TR>
445
<TR><TD><A HREF="#setRemapAddressValue">setRemapAddressValue</A></TD>
446
<TD>Set remap address value for the associated interface.</TD>
447
<TD>&nbsp;</TD></TR>
448
<TR><TD><A HREF="#setBusInterfaceMirroredSlaveRange">setBusInterfaceMirroredSlaveRange</A></TD>
449
<TD>Set address range for the associated interface.</TD>
450
<TD>&nbsp;</TD></TR>
451
<TR><TD><A HREF="#setBusInterfaceBitSteering">setBusInterfaceBitSteering</A></TD>
452
<TD>Set bus interface bit steering value.</TD>
453
<TD>&nbsp;</TD></TR>
454
</TABLE>
455
<P>
456
<H2><A NAME="ComponentInstance Operations">Component Instance Operations</A></H2>
457
<TABLE BORDER=1 WIDTH="100%">
458
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
459
<TR><TD><A HREF="#getComponentInstanceName">getComponentInstanceName</A></TD>
460
<TD>Instance name of the component</TD>
461
<TD>&nbsp;</TD></TR>
462
<TR><TD><A HREF="#getComponentInstanceVLNV">getComponentInstanceVLNV</A></TD>
463
<TD>Vendor Library Name Version of the component (from the design file)</TD>
464
<TD>&nbsp;</TD></TR>
465
<TR><TD><A HREF="#getComponentInstanceComponentID">getComponentInstanceComponentID</A></TD>
466
<TD>ID for the component associated with given instance (crossing from design to component file)</TD>
467
<TD>&nbsp;</TD></TR>
468
<TR><TD><A HREF="#getComponentInstanceXML">getComponentInstanceXML</A></TD>
469
<TD>Return the component XML in text format. Schema version is DE dependent.</TD>
470
<TD>&nbsp;</TD></TR>
471
</TABLE>
472
<P>
473
<H2><A NAME="ComponentOperations">Component Operations</A></H2>
474
<TABLE BORDER=1 WIDTH="100%">
475
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
476
<TR><TD><A HREF="#getComponentVLNV">getComponentVLNV</A></TD>
477
<TD>Vendor Library Name Version of the component (from the component file)</TD>
478
<TD>&nbsp;</TD></TR>
479
<TR><TD><A HREF="#getComponentElementType">getComponentElementType</A></TD>
480
<TD>Returns the name of the XML element associated with the component (currently only 'component'). This call is being provided to cover a future scenario where there can be different types of component elements instantiated in a design (e.g. macroComponent elements).</TD>
481
<TD>&nbsp;</TD></TR>
482
<TR><TD><A HREF="#getChannelBusInterfaceIDs">getChannelBusInterfaceIDs</A></TD>
483
<TD>List of busInterface IDs in this channel</TD>
484
<TD>&nbsp;</TD></TR>
485
<TR><TD><A HREF="#getComponentAddressSpaceIDs">getComponentAddressSpaceIDs</A></TD>
486
<TD>List of IDs for the logical address spaces in the component.</TD>
487
<TD>&nbsp;</TD></TR>
488
<TR><TD><A HREF="#getComponentRemapStateIDs">getComponentRemapStateIDs</A></TD>
489
<TD>A list of remap state IDs</TD>
490
<TD>&nbsp;</TD></TR>
491
<TR><TD><A HREF="#getComponentViewIDs">getComponentViewIDs</A></TD>
492
<TD>A list of model view IDs</TD>
493
<TD>&nbsp;</TD></TR>
494
<TR><TD><A HREF="#getComponentBusInterfaceIDs">getComponentBusInterfaceIDs</A></TD>
495
<TD>List of interface IDs</TD>
496
<TD>&nbsp;</TD></TR>
497
<TR><TD><A HREF="#getComponentChannelIDs">getComponentChannelIDs</A></TD>
498
<TD>A list of channel IDs</TD>
499
<TD>&nbsp;</TD></TR>
500
<TR><TD><A HREF="#getComponentPortIDs">getComponentPortIDs</A></TD>
501
<TD>A list of component model port IDs</TD>
502
<TD>&nbsp;</TD></TR>
503
<TR><TD><A HREF="#getComponentModelParameterIDs">getComponentModelParameterIDs</A></TD>
504
<TD>A list of model parameter IDs</TD>
505
<TD>&nbsp;</TD></TR>
506
<TR><TD><A HREF="#getComponentGeneratorIDs">getComponentGeneratorIDs</A></TD>
507
<TD>List of generator IDs of the component</TD>
508
<TD>&nbsp;</TD></TR>
509
<TR><TD><A HREF="#getComponentChoiceIDs">getComponentChoiceIDs</A></TD>
510
<TD>List of choices IDs</TD>
511
<TD>&nbsp;</TD></TR>
512
<TR><TD><A HREF="#getComponentFileSetIDs">getComponentFileSetIDs</A></TD>
513
<TD>List of file set IDs</TD>
514
<TD>&nbsp;</TD></TR>
515
<TR><TD><A HREF="#getComponentWhiteboxElementIDs">getComponentWhiteboxElementIDs</A></TD>
516
<TD>List of whitebox element IDs of the component</TD>
517
<TD>&nbsp;</TD></TR>
518
<TR><TD><A HREF="#getComponentCpuIDs">getComponentCpuIDs</A></TD>
519
<TD>List of cpu IDs of the component</TD>
520
<TD>&nbsp;</TD></TR>
521
<TR><TD><A HREF="#getCpuAddressSpaceIDs">getCpuAddressSpaceIDs</A></TD>
522
<TD>List of address space reference IDs of the cpu</TD>
523
<TD>&nbsp;</TD></TR>
524
<TR><TD><A HREF="#getComponentOtherClockDriverIDs">getComponentOtherClockDriverIDs</A></TD>
525
<TD>List of clock driver IDs of the component</TD>
526
<TD>&nbsp;</TD></TR>
527
<TR><TD><A HREF="#getComponentMemoryMapIDs">getComponentMemoryMapIDs</A></TD>
528
<TD>List of IDs for memory map elements in the given component</TD>
529
<TD>&nbsp;</TD></TR>
530
</TABLE>
531
<P>
532
<H2><A NAME="ConstraintOperations">Constraint Operations</A></H2>
533
<TABLE BORDER=1 WIDTH="100%">
534
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
535
<TR><TD><A HREF="#getPortConstraintSetReferenceName">getPortConstraintSetReferenceName</A></TD>
536
<TD>Reference name of the given port constraint set</TD>
537
<TD>&nbsp;</TD></TR>
538
<TR><TD><A HREF="#getPortConstraintSetRange">getPortConstraintSetRange</A></TD>
539
<TD>List of the left and right range of a port referenced by this constraint set</TD>
540
<TD>&nbsp;</TD></TR>
541
<TR><TD><A HREF="#getPortConstraintSetDriveConstraintIDs">getPortConstraintSetDriveConstraintIDs</A></TD>
542
<TD>List of drive constraint IDs of the port</TD>
543
<TD>&nbsp;</TD></TR>
544
<TR><TD><A HREF="#getPortConstraintSetLoadConstraintIDs">getPortConstraintSetLoadConstraintIDs</A></TD>
545
<TD>List of load constraint IDs of the port</TD>
546
<TD>&nbsp;</TD></TR>
547
<TR><TD><A HREF="#getPortConstraintSetTimingConstraintIDs">getPortConstraintSetTimingConstraintIDs</A></TD>
548
<TD>List of timing constraint IDs of the port</TD>
549
<TD>&nbsp;</TD></TR>
550
<TR><TD><A HREF="#getDriveConstraintType">getDriveConstraintType</A></TD>
551
<TD>Indicates the type of drive constraint: function class</TD>
552
<TD>&nbsp;</TD></TR>
553
<TR><TD><A HREF="#getDriveConstraintValue">getDriveConstraintValue</A></TD>
554
<TD>Returns the drive constraint. Format depends on the constraint type.</TD>
555
<TD>&nbsp;</TD></TR>
556
<TR><TD><A HREF="#getLoadConstraintType">getLoadConstraintType</A></TD>
557
<TD>Indicates the type of load constraint: function class</TD>
558
<TD>&nbsp;</TD></TR>
559
<TR><TD><A HREF="#getLoadConstraintValue">getLoadConstraintValue</A></TD>
560
<TD>Returns the load constraint. Format is cell function and strength or cell class and strength.</TD>
561
<TD>&nbsp;</TD></TR>
562
<TR><TD><A HREF="#getLoadConstraintCount">getLoadConstraintCount</A></TD>
563
<TD>Returns the load constraint count, the number of loads.</TD>
564
<TD>&nbsp;</TD></TR>
565
<TR><TD><A HREF="#getTimingConstraintClockDetails">getTimingConstraintClockDetails</A></TD>
566
<TD>Indicates the clock name, clock edge, and delay type</TD>
567
<TD>&nbsp;</TD></TR>
568
<TR><TD><A HREF="#getTimingConstraintValue">getTimingConstraintValue</A></TD>
569
<TD>Returns the timing constraint value (cycle time percentage).</TD>
570
<TD>&nbsp;</TD></TR>
571
</TABLE>
572
<P>
573
<H2><A NAME="DesignOperations">Design Operations</A></H2>
574
<TABLE BORDER=1 WIDTH="100%">
575
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
576
<TR><TD><A HREF="#getDesignID">getDesignID</A></TD>
577
<TD>Get ID of the current or top design</TD>
578
<TD>&nbsp;</TD></TR>
579
<TR><TD><A HREF="#getDesignVLNV">getDesignVLNV</A></TD>
580
<TD>Vendor Library Name Version of the design</TD>
581
<TD>&nbsp;</TD></TR>
582
<TR><TD><A HREF="#getDesignComponentInstanceIDs">getDesignComponentInstanceIDs</A></TD>
583
<TD>Components instances IDs of the given design</TD>
584
<TD>&nbsp;</TD></TR>
585
<TR><TD><A HREF="#getComponentInstanceID">getComponentInstanceID</A></TD>
586
<TD>Return the component instance ID of the named component instance in the given design</TD>
587
<TD>&nbsp;</TD></TR>
588
<TR><TD><A HREF="#getDesignInterconnectionIDs">getDesignInterconnectionIDs</A></TD>
589
<TD>List of interconnection element IDs</TD>
590
<TD>&nbsp;</TD></TR>
591
<TR><TD><A HREF="#getInterconnectionActiveInterfaces">getInterconnectionActiveInterfaces</A></TD>
592
<TD>Returns the active interfaces as a list: componentRef interfaceRef componentRef interfaceRef</TD>
593
<TD>Modified in 1.5</TD></TR>
594
<TR><TD><A HREF="#getDesignInterconnectionAbstractorInstanceIDs">getDesignInterconnectionAbstractorInstanceIDs</A></TD>
595
<TD>List of abstractor instances IDs for this interconnection</TD>
596
<TD>&nbsp;</TD></TR>
597
<TR><TD><A HREF="#getDesignMonitorInterconnectionIDs">getDesignMonitorInterconnectionIDs</A></TD>
598
<TD>List of monitorInterconnection element IDs</TD>
599
<TD>&nbsp;</TD></TR>
600
<TR><TD><A HREF="#getMonitorInterconnectionInterfaces">getMonitorInterconnectionInterfaces</A></TD>
601
<TD>Returns the active interface and monitor interfaces as a list in componentPathRef, componentRef, componentInterface, monitorPathRef, monitorRef, monitorInterface format, the active interface comes first in the list.</TD>
602
<TD>Modified in 1.5</TD></TR>
603
<TR><TD><A HREF="#getDesignAdHocConnectionIDs">getDesignAdHocConnectionIDs</A></TD>
604
<TD>List of ad-hoc connection element IDs</TD>
605
<TD>&nbsp;</TD></TR>
606
<TR><TD><A HREF="#getAdHocConnectionTiedValue">getAdHocConnectionTiedValue</A></TD>
607
<TD>Get the tied value for an ad-hoc connection</TD>
608
<TD>&nbsp;</TD></TR>
609
<TR><TD><A HREF="#getAdHocConnectionInternalPortReferenceIDs">getAdHocConnectionInternalPortReferenceIDs</A></TD>
610
<TD>List of internal ad-hoc port reference element IDs</TD>
611
<TD>&nbsp;</TD></TR>
612
<TR><TD><A HREF="#getAdHocConnectionInternalPortReferenceDetails">getAdHocConnectionInternalPortReferenceDetails</A></TD>
613
<TD>List for an internal connection containing the componentRef, portRef, left, and right attribute values</TD>
614
<TD>&nbsp;</TD></TR>
615
<TR><TD><A HREF="#getAdHocConnectionExternalPortReferenceIDs">getAdHocConnectionExternalPortReferenceIDs</A></TD>
616
<TD>List of external ad-hoc port reference element IDs</TD>
617
<TD>&nbsp;</TD></TR>
618
<TR><TD><A HREF="#getAdHocConnectionExternalPortDetails">getAdHocConnectionExternalPortDetails</A></TD>
619
<TD>List for an external connection containing the portRef, left, and right attribute values</TD>
620
<TD>&nbsp;</TD></TR>
621
<TR><TD><A HREF="#getDesignHierConnectionIDs">getDesignHierConnectionIDs</A></TD>
622
<TD>List of hierarchical connection element IDs</TD>
623
<TD>&nbsp;</TD></TR>
624
<TR><TD><A HREF="#getHierConnectionDetails">getHierConnectionDetails</A></TD>
625
<TD>List containing the interface name, component reference, and interface reference</TD>
626
<TD>&nbsp;</TD></TR>
627
<TR><TD><A HREF="#addComponentInstance">addComponentInstance</A></TD>
628
<TD>Add new component instance.</TD>
629
<TD>&nbsp;</TD></TR>
630
<TR><TD><A HREF="#removeComponentInstance">removeComponentInstance</A></TD>
631
<TD>Remove specified component instance.</TD>
632
<TD>&nbsp;</TD></TR>
633
<TR><TD><A HREF="#replaceComponentInstance">replaceComponentInstance</A></TD>
634
<TD>Replace specified component with new provided component.</TD>
635
<TD>&nbsp;</TD></TR>
636
<TR><TD><A HREF="#appendAbstractorInstance">appendAbstractorInstance</A></TD>
637
<TD>Append a new abstractor instance to the interconnection.</TD>
638
<TD>&nbsp;</TD></TR>
639
<TR><TD><A HREF="#removeAbstractorInstance">removeAbstractorInstance</A></TD>
640
<TD>Remove specified abstractor instance.</TD>
641
<TD>&nbsp;</TD></TR>
642
<TR><TD><A HREF="#replaceAbstractorInstance">replaceAbstractorInstance</A></TD>
643
<TD>Replace specified abstractor with new provided abstractor.</TD>
644
<TD>&nbsp;</TD></TR>
645
<TR><TD><A HREF="#addInterconnection">addInterconnection</A></TD>
646
<TD>Add new interconnection between components.</TD>
647
<TD>&nbsp;</TD></TR>
648
<TR><TD><A HREF="#removeInterconnection">removeInterconnection</A></TD>
649
<TD>Remove interconnection between components, and any abstractors if present.</TD>
650
<TD>&nbsp;</TD></TR>
651
<TR><TD><A HREF="#addMonitorInterconnection">addMonitorInterconnection</A></TD>
652
<TD>Add new interconnection between a component and monitor. If there is already a monitorInterconnection for the given componentRef/componentInterfaceRef, then the monitor connection is added to that element.</TD>
653
<TD>&nbsp;</TD></TR>
654
<TR><TD><A HREF="#addHierarchicalMonitorInterconnection">addHierarchicalMonitorInterconnection</A></TD>
655
<TD>Add new hierarchical interconnection between a component and monitor. If there is already a monitorInterconnection for the given componentRef/componentInterfaceRef, then the monitor connection is added to that element.</TD>
656
<TD>New in 1.5</TD></TR>
657
<TR><TD><A HREF="#removeMonitorInterconnection">removeMonitorInterconnection</A></TD>
658
<TD>Remove interconnection between a component and monitor. When the last monitor reference is removed, the entire monitorInterconnection element will be removed.</TD>
659
<TD>&nbsp;</TD></TR>
660
<TR><TD><A HREF="#removeHierarchicalMonitorInterconnection">removeHierarchicalMonitorInterconnection</A></TD>
661
<TD>Remove a hierarchical interconnection between a component and monitor. When the last monitor reference is removed, the entire monitorInterconnection element will be removed.</TD>
662
<TD>New in 1.5</TD></TR>
663
<TR><TD><A HREF="#addHierConnection">addHierConnection</A></TD>
664
<TD>Add new hierarchical connection.</TD>
665
<TD>&nbsp;</TD></TR>
666
<TR><TD><A HREF="#removeHierConnection">removeHierConnection</A></TD>
667
<TD>Remove existing hierarchical connection.</TD>
668
<TD>&nbsp;</TD></TR>
669
<TR><TD><A HREF="#addAdHocConnection">addAdHocConnection</A></TD>
670
<TD>Add new ad-hoc connection.</TD>
671
<TD>&nbsp;</TD></TR>
672
<TR><TD><A HREF="#addAdHocInternalPortReference">addAdHocInternalPortReference</A></TD>
673
<TD>Add an internal port reference to an existing ad-hoc connection. An identical port reference must not already exist in the ad-hoc connection.</TD>
674
<TD>&nbsp;</TD></TR>
675
<TR><TD><A HREF="#addAdHocExternalPortReference">addAdHocExternalPortReference</A></TD>
676
<TD>Add an external port reference to an existing ad-hoc connection.</TD>
677
<TD>&nbsp;</TD></TR>
678
<TR><TD><A HREF="#removeAdHocInternalPortReference">removeAdHocInternalPortReference</A></TD>
679
<TD>Remove an internal port from existing ad-hoc connection. The ad-hoc connection is removed when the last port reference is removed.</TD>
680
<TD>&nbsp;</TD></TR>
681
<TR><TD><A HREF="#removeAdHocExternalPortReference">removeAdHocExternalPortReference</A></TD>
682
<TD>Remove an external port reference from existing ad-hoc connection.</TD>
683
<TD>&nbsp;</TD></TR>
684
</TABLE>
685
<P>
686
<H2><A NAME="FieldOperations">Field Operations</A></H2>
687
<TABLE BORDER=1 WIDTH="100%">
688
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
689
<TR><TD><A HREF="#getRegisterFieldBitOffset">getRegisterFieldBitOffset</A></TD>
690
<TD>Bit offset of the fields LSB inside the register.</TD>
691
<TD>&nbsp;</TD></TR>
692
<TR><TD><A HREF="#getRegisterFieldBitWidth">getRegisterFieldBitWidth</A></TD>
693
<TD>Width of the field in bits., <B>Configurable</B></TD>
694
<TD>&nbsp;</TD></TR>
695
<TR><TD><A HREF="#setRegisterFieldBitWidth">setRegisterFieldBitWidth</A></TD>
696
<TD>Set the width of the field in bits., <B>Configurable</B></TD>
697
<TD>&nbsp;</TD></TR>
698
<TR><TD><A HREF="#getRegisterFieldVolatility">getRegisterFieldVolatility</A></TD>
699
<TD>Indicates whether or not the data is volatile. The presumed value is 'false' if the element is not present.</TD>
700
<TD>Modified in 1.5</TD></TR>
701
<TR><TD><A HREF="#getRegisterFieldAccess">getRegisterFieldAccess</A></TD>
702
<TD>The accessibility of the data in the field.</TD>
703
<TD>&nbsp;</TD></TR>
704
<TR><TD><A HREF="#getRegisterFieldValueIDs">getRegisterFieldValueIDs</A></TD>
705
<TD>List of IDs for field values for the given register field.</TD>
706
<TD>&nbsp;</TD></TR>
707
<TR><TD><A HREF="#getRegisterFieldValueUsage">getRegisterFieldValueUsage</A></TD>
708
<TD>Enumerated bit field usage.</TD>
709
<TD>New in 1.5</TD></TR>
710
<TR><TD><A HREF="#getRegisterFieldValue">getRegisterFieldValue</A></TD>
711
<TD>Enumerated bit field value.</TD>
712
<TD>&nbsp;</TD></TR>
713
<TR><TD><A HREF="#getRegisterFieldValueName">getRegisterFieldValueName</A></TD>
714
<TD>Enumerated name for this register field value. Deprecated - use getName.</TD>
715
<TD>&nbsp;</TD></TR>
716
<TR><TD><A HREF="#getRegisterFieldModifiedWriteValue">getRegisterFieldModifiedWriteValue</A></TD>
717
<TD>The modified write value for the field</TD>
718
<TD>New in 1.5</TD></TR>
719
<TR><TD><A HREF="#getRegisterFieldWriteValueConstraintWriteAsRead">getRegisterFieldWriteValueConstraintWriteAsRead</A></TD>
720
<TD>The write value constraint is write as read.</TD>
721
<TD>New in 1.5</TD></TR>
722
<TR><TD><A HREF="#getRegisterFieldWriteValueConstraintUseEnumeratedValues">getRegisterFieldWriteValueConstraintUseEnumeratedValues</A></TD>
723
<TD>The write value constraint shall use the enumerated values.</TD>
724
<TD>New in 1.5</TD></TR>
725
<TR><TD><A HREF="#getRegisterFieldWriteValueConstraintMinMax">getRegisterFieldWriteValueConstraintMinMax</A></TD>
726
<TD>The value of a write constraint.</TD>
727
<TD>New in 1.5</TD></TR>
728
<TR><TD><A HREF="#getRegisterFieldReadAction">getRegisterFieldReadAction</A></TD>
729
<TD>The read action for the field</TD>
730
<TD>New in 1.5</TD></TR>
731
<TR><TD><A HREF="#getRegisterFieldTestable">getRegisterFieldTestable</A></TD>
732
<TD>True if the field can be tested with a simple register test.</TD>
733
<TD>New in 1.5</TD></TR>
734
<TR><TD><A HREF="#getRegisterFieldTestConstraint">getRegisterFieldTestConstraint</A></TD>
735
<TD>The test constraint required if the field can be tested with a simple register test.</TD>
736
<TD>New in 1.5</TD></TR>
737
</TABLE>
738
<P>
739
<H2><A NAME="Fileand Fileset Operations">File and Fileset Operations</A></H2>
740
<TABLE BORDER=1 WIDTH="100%">
741
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
742
<TR><TD><A HREF="#getFileSetGroupName">getFileSetGroupName</A></TD>
743
<TD>Name of file set group</TD>
744
<TD>&nbsp;</TD></TR>
745
<TR><TD><A HREF="#getFileSetGroupFileSetIDs">getFileSetGroupFileSetIDs</A></TD>
746
<TD>List of file set IDs in this file set group</TD>
747
<TD>&nbsp;</TD></TR>
748
<TR><TD><A HREF="#getFileName">getFileName</A></TD>
749
<TD>Get name of the given fileID., <B>Configurable</B></TD>
750
<TD>&nbsp;</TD></TR>
751
<TR><TD><A HREF="#getFileBuilderFileType">getFileBuilderFileType</A></TD>
752
<TD>FileType or userFileType of the file builder</TD>
753
<TD>&nbsp;</TD></TR>
754
<TR><TD><A HREF="#getFileBuilderCommand">getFileBuilderCommand</A></TD>
755
<TD>Command of the file builder, <B>Configurable</B></TD>
756
<TD>&nbsp;</TD></TR>
757
<TR><TD><A HREF="#getFileBuilderFlags">getFileBuilderFlags</A></TD>
758
<TD>Flags of the file builder, <B>Configurable</B></TD>
759
<TD>&nbsp;</TD></TR>
760
<TR><TD><A HREF="#getFileBuilderReplaceDefaultFlags">getFileBuilderReplaceDefaultFlags</A></TD>
761
<TD>Value of the replaceDefaultFlags element of the file builder, <B>Configurable</B></TD>
762
<TD>&nbsp;</TD></TR>
763
<TR><TD><A HREF="#getFileSetGroups">getFileSetGroups</A></TD>
764
<TD>List of group names of the file set</TD>
765
<TD>&nbsp;</TD></TR>
766
<TR><TD><A HREF="#getFileSetFileIDs">getFileSetFileIDs</A></TD>
767
<TD>List of file IDs of the file set</TD>
768
<TD>&nbsp;</TD></TR>
769
<TR><TD><A HREF="#getFileType">getFileType</A></TD>
770
<TD>FileType or userFileType  of the file</TD>
771
<TD>&nbsp;</TD></TR>
772
<TR><TD><A HREF="#getFileIsIncludeFile">getFileIsIncludeFile</A></TD>
773
<TD>Indicates that the given file is an include file</TD>
774
<TD>&nbsp;</TD></TR>
775
<TR><TD><A HREF="#getFileHasExternalDeclarations">getFileHasExternalDeclarations</A></TD>
776
<TD>Indicates that the file includes external declarations required by the top-level netlist file</TD>
777
<TD>&nbsp;</TD></TR>
778
<TR><TD><A HREF="#getFileLogicalName">getFileLogicalName</A></TD>
779
<TD>Logical name of the file</TD>
780
<TD>&nbsp;</TD></TR>
781
<TR><TD><A HREF="#getFileLogicalNameDefault">getFileLogicalNameDefault</A></TD>
782
<TD>Default attribute of logical name of the file</TD>
783
<TD>&nbsp;</TD></TR>
784
<TR><TD><A HREF="#getFileExportedNames">getFileExportedNames</A></TD>
785
<TD>List of exported names of the file</TD>
786
<TD>&nbsp;</TD></TR>
787
<TR><TD><A HREF="#getFileBuildCommandName">getFileBuildCommandName</A></TD>
788
<TD>Name of the build command of the file, <B>Configurable</B></TD>
789
<TD>&nbsp;</TD></TR>
790
<TR><TD><A HREF="#getFileBuildCommandFlags">getFileBuildCommandFlags</A></TD>
791
<TD>Flags of the file build command, <B>Configurable</B></TD>
792
<TD>&nbsp;</TD></TR>
793
<TR><TD><A HREF="#getFileBuildCommandFlagsIsAppend">getFileBuildCommandFlagsIsAppend</A></TD>
794
<TD>Value of append attribute on the flag element</TD>
795
<TD>&nbsp;</TD></TR>
796
<TR><TD><A HREF="#getFileBuildCommandReplaceDefaultFlags">getFileBuildCommandReplaceDefaultFlags</A></TD>
797
<TD>Indicates whether or not to replace default flags, <B>Configurable</B></TD>
798
<TD>&nbsp;</TD></TR>
799
<TR><TD><A HREF="#getFileBuildCommandTargetName">getFileBuildCommandTargetName</A></TD>
800
<TD>Target name of the file build command, <B>Configurable</B></TD>
801
<TD>&nbsp;</TD></TR>
802
<TR><TD><A HREF="#getFileDependencies">getFileDependencies</A></TD>
803
<TD>List of dependent locations for the file, typically directories</TD>
804
<TD>&nbsp;</TD></TR>
805
<TR><TD><A HREF="#getFileDefineSymbolIDs">getFileDefineSymbolIDs</A></TD>
806
<TD>List of define symbol IDs used in the file</TD>
807
<TD>&nbsp;</TD></TR>
808
<TR><TD><A HREF="#getFileImageTypes">getFileImageTypes</A></TD>
809
<TD>List of image types of the file</TD>
810
<TD>&nbsp;</TD></TR>
811
<TR><TD><A HREF="#getFileSetFileBuilderIDs">getFileSetFileBuilderIDs</A></TD>
812
<TD>List of file builder IDs used for this fileSet</TD>
813
<TD>&nbsp;</TD></TR>
814
<TR><TD><A HREF="#getFileSetDependencies">getFileSetDependencies</A></TD>
815
<TD>List of dependent locations for the fileSet, typically directories</TD>
816
<TD>&nbsp;</TD></TR>
817
<TR><TD><A HREF="#getFileSetFunctionIDs">getFileSetFunctionIDs</A></TD>
818
<TD>List of function IDs</TD>
819
<TD>&nbsp;</TD></TR>
820
<TR><TD><A HREF="#getFunctionReplicate">getFunctionReplicate</A></TD>
821
<TD>Value of replicate attribute on function element</TD>
822
<TD>&nbsp;</TD></TR>
823
<TR><TD><A HREF="#getFunctionEntryPoint">getFunctionEntryPoint</A></TD>
824
<TD>Entry point of the function</TD>
825
<TD>&nbsp;</TD></TR>
826
<TR><TD><A HREF="#getFunctionFileID">getFunctionFileID</A></TD>
827
<TD>File ID containing the function entry point</TD>
828
<TD>&nbsp;</TD></TR>
829
<TR><TD><A HREF="#getFunctionReturnType">getFunctionReturnType</A></TD>
830
<TD>Return type of the function</TD>
831
<TD>&nbsp;</TD></TR>
832
<TR><TD><A HREF="#getFunctionArgumentIDs">getFunctionArgumentIDs</A></TD>
833
<TD>List of argument IDs of the function of the file set</TD>
834
<TD>&nbsp;</TD></TR>
835
<TR><TD><A HREF="#getFunctionArgumentDataType">getFunctionArgumentDataType</A></TD>
836
<TD>Data type of the argument</TD>
837
<TD>&nbsp;</TD></TR>
838
<TR><TD><A HREF="#getFunctionDisabled">getFunctionDisabled</A></TD>
839
<TD>Indicates whether or not the function is disabled, <B>Configurable</B></TD>
840
<TD>&nbsp;</TD></TR>
841
<TR><TD><A HREF="#getFunctionSourceFileIDs">getFunctionSourceFileIDs</A></TD>
842
<TD>List of source file IDs of the function of the file set</TD>
843
<TD>&nbsp;</TD></TR>
844
<TR><TD><A HREF="#getFunctionSourceFileName">getFunctionSourceFileName</A></TD>
845
<TD>Name of the source file</TD>
846
<TD>&nbsp;</TD></TR>
847
<TR><TD><A HREF="#getFunctionSourceFileType">getFunctionSourceFileType</A></TD>
848
<TD>FileType or userFileType of the source file</TD>
849
<TD>&nbsp;</TD></TR>
850
<TR><TD><A HREF="#setFileName">setFileName</A></TD>
851
<TD>Set name of the given file.</TD>
852
<TD>&nbsp;</TD></TR>
853
<TR><TD><A HREF="#setFileBuildCommandName">setFileBuildCommandName</A></TD>
854
<TD>Set command name for the given file builder.</TD>
855
<TD>&nbsp;</TD></TR>
856
<TR><TD><A HREF="#setFileBuildCommandFlags">setFileBuildCommandFlags</A></TD>
857
<TD>Set command flags for the given file builder.</TD>
858
<TD>&nbsp;</TD></TR>
859
<TR><TD><A HREF="#setFileBuildCommandReplaceDefaultFlags">setFileBuildCommandReplaceDefaultFlags</A></TD>
860
<TD>Set replace default flags for the given file builder.</TD>
861
<TD>&nbsp;</TD></TR>
862
<TR><TD><A HREF="#setFileBuildCommandTargetName">setFileBuildCommandTargetName</A></TD>
863
<TD>Set target name for build command for the given file</TD>
864
<TD>&nbsp;</TD></TR>
865
<TR><TD><A HREF="#setFileBuilderCommand">setFileBuilderCommand</A></TD>
866
<TD>Set command associated with file builder.</TD>
867
<TD>&nbsp;</TD></TR>
868
<TR><TD><A HREF="#setFileBuilderFlags">setFileBuilderFlags</A></TD>
869
<TD>Set flags associated with the given file builder.</TD>
870
<TD>&nbsp;</TD></TR>
871
<TR><TD><A HREF="#setFileBuilderReplaceDefaultFlags">setFileBuilderReplaceDefaultFlags</A></TD>
872
<TD>Set value of replace default flags in file builder.</TD>
873
<TD>&nbsp;</TD></TR>
874
<TR><TD><A HREF="#setFunctionDisabled">setFunctionDisabled</A></TD>
875
<TD>Set disable flag on function.</TD>
876
<TD>&nbsp;</TD></TR>
877
</TABLE>
878
<P>
879
<H2><A NAME="GeneratorOperations">Generator Operations</A></H2>
880
<TABLE BORDER=1 WIDTH="100%">
881
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
882
<TR><TD><A HREF="#getGeneratorScope">getGeneratorScope</A></TD>
883
<TD>Scope of the generator</TD>
884
<TD>&nbsp;</TD></TR>
885
<TR><TD><A HREF="#getGeneratorIsHidden">getGeneratorIsHidden</A></TD>
886
<TD>Value of hidden attribute on the generator</TD>
887
<TD>&nbsp;</TD></TR>
888
<TR><TD><A HREF="#getGeneratorPhase">getGeneratorPhase</A></TD>
889
<TD>Phase number of the generator</TD>
890
<TD>&nbsp;</TD></TR>
891
<TR><TD><A HREF="#getGeneratorApiType">getGeneratorApiType</A></TD>
892
<TD>Api type of the generator</TD>
893
<TD>&nbsp;</TD></TR>
894
<TR><TD><A HREF="#getGeneratorExecutable">getGeneratorExecutable</A></TD>
895
<TD>Executable name associated with the generator  </TD>
896
<TD>&nbsp;</TD></TR>
897
<TR><TD><A HREF="#getGeneratorGroups">getGeneratorGroups</A></TD>
898
<TD>List of group names of the generator</TD>
899
<TD>&nbsp;</TD></TR>
900
<TR><TD><A HREF="#getGeneratorTransportMethods">getGeneratorTransportMethods</A></TD>
901
<TD>List of transport methods of the generator</TD>
902
<TD>&nbsp;</TD></TR>
903
</TABLE>
904
<P>
905
<H2><A NAME="InterfaceOperations">Interface Operations</A></H2>
906
<TABLE BORDER=1 WIDTH="100%">
907
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
908
<TR><TD><A HREF="#getInterfaceBusTypeVLNV">getInterfaceBusTypeVLNV</A></TD>
909
<TD>List of VLNV of the bus definition</TD>
910
<TD>&nbsp;</TD></TR>
911
<TR><TD><A HREF="#getInterfaceAbstractionTypeVLNV">getInterfaceAbstractionTypeVLNV</A></TD>
912
<TD>List of VLNV of the abstraction definition</TD>
913
<TD>&nbsp;</TD></TR>
914
<TR><TD><A HREF="#getInterfaceMode">getInterfaceMode</A></TD>
915
<TD>Mode of the interface: master, slave, system, mirroredMaster, mirroredSlave, mirroredSystem or monitor</TD>
916
<TD>&nbsp;</TD></TR>
917
<TR><TD><A HREF="#getInterfacePortMapIDs">getInterfacePortMapIDs</A></TD>
918
<TD>List of interface port map IDs</TD>
919
<TD>&nbsp;</TD></TR>
920
<TR><TD><A HREF="#getLogicalPhysicalMapIDs">getLogicalPhysicalMapIDs</A></TD>
921
<TD>List of the logical and physical port map IDs</TD>
922
<TD>&nbsp;</TD></TR>
923
<TR><TD><A HREF="#getPortMapRange">getPortMapRange</A></TD>
924
<TD>List of left and right range of the port map, <B>Configurable</B></TD>
925
<TD>&nbsp;</TD></TR>
926
<TR><TD><A HREF="#setPortMapRange">setPortMapRange</A></TD>
927
<TD>Set left/right range of an interface port map.</TD>
928
<TD>&nbsp;</TD></TR>
929
</TABLE>
930
<P>
931
<H2><A NAME="MiscellaneousOperations">Miscellaneous Operations</A></H2>
932
<TABLE BORDER=1 WIDTH="100%">
933
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
934
<TR><TD><A HREF="#getVendorExtensions">getVendorExtensions</A></TD>
935
<TD>Returns the complete XML text of the vendor extension element including the spirit:vendorExtension tag, as a well formed XML document.</TD>
936
<TD>&nbsp;</TD></TR>
937
<TR><TD><A HREF="#getVendorAttribute">getVendorAttribute</A></TD>
938
<TD>Get vendor defined attribute from the given element</TD>
939
<TD>&nbsp;</TD></TR>
940
<TR><TD><A HREF="#getParameterIDs">getParameterIDs</A></TD>
941
<TD>List of parameter IDs from the given element (any which contains spirit:parameter elements)</TD>
942
<TD>&nbsp;</TD></TR>
943
<TR><TD><A HREF="#getValue">getValue</A></TD>
944
<TD>Get the value of a parameterID, fileDefineIDs or argumentIDs., <B>Configurable</B></TD>
945
<TD>&nbsp;</TD></TR>
946
<TR><TD><A HREF="#getValueAttribute">getValueAttribute</A></TD>
947
<TD>Returns the value of the given attribute name on the elementID/value element</TD>
948
<TD>&nbsp;</TD></TR>
949
<TR><TD><A HREF="#getModelParameterDataType">getModelParameterDataType</A></TD>
950
<TD>Data type of the model parameter</TD>
951
<TD>&nbsp;</TD></TR>
952
<TR><TD><A HREF="#getModelParameterUsageType">getModelParameterUsageType</A></TD>
953
<TD>Usage type of the model parameter</TD>
954
<TD>&nbsp;</TD></TR>
955
<TR><TD><A HREF="#getIdValue">getIdValue</A></TD>
956
<TD>Return the value of the spirit:id attribute on a ID</TD>
957
<TD>New in 1.5</TD></TR>
958
<TR><TD><A HREF="#getName">getName</A></TD>
959
<TD>Return the name of the specified element</TD>
960
<TD>Modified in 1.5</TD></TR>
961
<TR><TD><A HREF="#getDescription">getDescription</A></TD>
962
<TD>Return the description of the specified element</TD>
963
<TD>Modified in 1.5</TD></TR>
964
<TR><TD><A HREF="#getDisplayName">getDisplayName</A></TD>
965
<TD>Return the displayName of the specified element</TD>
966
<TD>Modified in 1.5</TD></TR>
967
<TR><TD><A HREF="#getUnconfiguredID">getUnconfiguredID</A></TD>
968
<TD>Return the unconfigured ID from a configured ID</TD>
969
<TD>New in 1.5</TD></TR>
970
<TR><TD><A HREF="#getChoiceName">getChoiceName</A></TD>
971
<TD>Name of the choice</TD>
972
<TD>&nbsp;</TD></TR>
973
<TR><TD><A HREF="#getChoiceEnumerationIDs">getChoiceEnumerationIDs</A></TD>
974
<TD>List of choice enumeration IDs of the choice</TD>
975
<TD>&nbsp;</TD></TR>
976
<TR><TD><A HREF="#getChoiceEnumerationValue">getChoiceEnumerationValue</A></TD>
977
<TD>Value of the enumeration element</TD>
978
<TD>&nbsp;</TD></TR>
979
<TR><TD><A HREF="#getChoiceEnumerationText">getChoiceEnumerationText</A></TD>
980
<TD>Value of the enumeration text attribute</TD>
981
<TD>&nbsp;</TD></TR>
982
<TR><TD><A HREF="#getChoiceEnumerationHelp">getChoiceEnumerationHelp</A></TD>
983
<TD>Value of the enumeration help attribute</TD>
984
<TD>&nbsp;</TD></TR>
985
<TR><TD><A HREF="#registerVLNV">registerVLNV</A></TD>
986
<TD>Indicate to DE where the file resides for the IP-XACT element with the given VLNV.</TD>
987
<TD>&nbsp;</TD></TR>
988
<TR><TD><A HREF="#getXMLForVLNV">getXMLForVLNV</A></TD>
989
<TD>Return XML of the IP-XACT object identified by the given VLNV.</TD>
990
<TD>&nbsp;</TD></TR>
991
<TR><TD><A HREF="#getGeneratorContextComponentInstanceID">getGeneratorContextComponentInstanceID</A></TD>
992
<TD>ID for the component instance associated with the currently invoked generator</TD>
993
<TD>&nbsp;</TD></TR>
994
<TR><TD><A HREF="#init">init</A></TD>
995
<TD>API initialization function. Must be called before any other API call.</TD>
996
<TD>&nbsp;</TD></TR>
997
<TR><TD><A HREF="#message">message</A></TD>
998
<TD>Send message level and message text to Design Environment.</TD>
999
<TD>&nbsp;</TD></TR>
1000
<TR><TD><A HREF="#getErrorMessage">getErrorMessage</A></TD>
1001
<TD>Get error message from prior callback.</TD>
1002
<TD>&nbsp;</TD></TR>
1003
<TR><TD><A HREF="#getWarningCount">getWarningCount</A></TD>
1004
<TD>Return count of how many potentially incompatible API calls have been made.</TD>
1005
<TD>&nbsp;</TD></TR>
1006
<TR><TD><A HREF="#end">end</A></TD>
1007
<TD>Terminate connection to the Design Environment.</TD>
1008
<TD>&nbsp;</TD></TR>
1009
<TR><TD><A HREF="#setVendorExtensions">setVendorExtensions</A></TD>
1010
<TD>Set vendor extensions. NOTE: This call is only supported for elements within a spirit:design.</TD>
1011
<TD>&nbsp;</TD></TR>
1012
<TR><TD><A HREF="#setVendorAttribute">setVendorAttribute</A></TD>
1013
<TD>Set vendor defined attribute on the given element</TD>
1014
<TD>&nbsp;</TD></TR>
1015
<TR><TD><A HREF="#setValue">setValue</A></TD>
1016
<TD>Set the value of a parameterID, fileDefineIDs or argumentIDs.</TD>
1017
<TD>&nbsp;</TD></TR>
1018
</TABLE>
1019
<P>
1020
<H2><A NAME="PortOperations">Port Operations</A></H2>
1021
<TABLE BORDER=1 WIDTH="100%">
1022
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
1023
<TR><TD><A HREF="#getPortStyle">getPortStyle</A></TD>
1024
<TD>Returns 'wire' or 'transactional' to indicate the port style</TD>
1025
<TD>&nbsp;</TD></TR>
1026
<TR><TD><A HREF="#getAllLogicalDirectionsAllowed">getAllLogicalDirectionsAllowed</A></TD>
1027
<TD>Get the value of the allLogicalDirectionAllowed attribute</TD>
1028
<TD>New in 1.5</TD></TR>
1029
<TR><TD><A HREF="#getPortDirection">getPortDirection</A></TD>
1030
<TD>Direction of the port</TD>
1031
<TD>&nbsp;</TD></TR>
1032
<TR><TD><A HREF="#getPortRange">getPortRange</A></TD>
1033
<TD>List of the left and right range of the port</TD>
1034
<TD>&nbsp;</TD></TR>
1035
<TR><TD><A HREF="#getPortWireTypeDefIDs">getPortWireTypeDefIDs</A></TD>
1036
<TD>List of typeDefs for a wire portID</TD>
1037
<TD>New in 1.5</TD></TR>
1038
<TR><TD><A HREF="#getPortTransactionalTypeDefID">getPortTransactionalTypeDefID</A></TD>
1039
<TD>The type definition for a transactional portID</TD>
1040
<TD>New in 1.5</TD></TR>
1041
<TR><TD><A HREF="#getPortServiceID">getPortServiceID</A></TD>
1042
<TD>ID of element representing the service of a transactional port</TD>
1043
<TD>&nbsp;</TD></TR>
1044
<TR><TD><A HREF="#getPortAccessType">getPortAccessType</A></TD>
1045
<TD>Indicates the access type for this port</TD>
1046
<TD>Modified in 1.5</TD></TR>
1047
<TR><TD><A HREF="#getPortAccessHandle">getPortAccessHandle</A></TD>
1048
<TD>Alternate name to be used when accessing this port</TD>
1049
<TD>Modified in 1.5</TD></TR>
1050
<TR><TD><A HREF="#getPortMaxAllowedConnections">getPortMaxAllowedConnections</A></TD>
1051
<TD>Max allowed connections for this transactional port</TD>
1052
<TD>&nbsp;</TD></TR>
1053
<TR><TD><A HREF="#getPortMinAllowedConnections">getPortMinAllowedConnections</A></TD>
1054
<TD>Min allowed connections for this transactional port</TD>
1055
<TD>&nbsp;</TD></TR>
1056
<TR><TD><A HREF="#getPortDefaultValue">getPortDefaultValue</A></TD>
1057
<TD>Default value of the port, if not set returns "", <B>Configurable</B></TD>
1058
<TD>&nbsp;</TD></TR>
1059
<TR><TD><A HREF="#getPortClockDriverID">getPortClockDriverID</A></TD>
1060
<TD>Element ID of clock driver element, if present</TD>
1061
<TD>&nbsp;</TD></TR>
1062
<TR><TD><A HREF="#getClockDriverPeriod">getClockDriverPeriod</A></TD>
1063
<TD>Clock period of the given clock, <B>Configurable</B></TD>
1064
<TD>&nbsp;</TD></TR>
1065
<TR><TD><A HREF="#getClockDriverPeriodUnits">getClockDriverPeriodUnits</A></TD>
1066
<TD>Units of the clock period of the given clock</TD>
1067
<TD>New in 1.5</TD></TR>
1068
<TR><TD><A HREF="#getClockDriverPulseOffset">getClockDriverPulseOffset</A></TD>
1069
<TD>Clock pulse offset of the given clock, <B>Configurable</B></TD>
1070
<TD>&nbsp;</TD></TR>
1071
<TR><TD><A HREF="#getClockDriverPulseOffsetUnits">getClockDriverPulseOffsetUnits</A></TD>
1072
<TD>Units of the clock pulse offset of the given clock</TD>
1073
<TD>New in 1.5</TD></TR>
1074
<TR><TD><A HREF="#getClockDriverPulseValue">getClockDriverPulseValue</A></TD>
1075
<TD>Clock pulse value of the given clock, <B>Configurable</B></TD>
1076
<TD>&nbsp;</TD></TR>
1077
<TR><TD><A HREF="#getClockDriverPulseDuration">getClockDriverPulseDuration</A></TD>
1078
<TD>Clock period of the given clock, <B>Configurable</B></TD>
1079
<TD>&nbsp;</TD></TR>
1080
<TR><TD><A HREF="#getClockDriverPulseDurationUnits">getClockDriverPulseDurationUnits</A></TD>
1081
<TD>Units of the clock pulse duration of the given clock</TD>
1082
<TD>New in 1.5</TD></TR>
1083
<TR><TD><A HREF="#getClockDriverName">getClockDriverName</A></TD>
1084
<TD>Name of the clock driver</TD>
1085
<TD>&nbsp;</TD></TR>
1086
<TR><TD><A HREF="#getClockDriverSource">getClockDriverSource</A></TD>
1087
<TD>Source name of the clock driver</TD>
1088
<TD>&nbsp;</TD></TR>
1089
<TR><TD><A HREF="#getPortSingleShotDriverID">getPortSingleShotDriverID</A></TD>
1090
<TD>Element ID of single shot driver element, if present</TD>
1091
<TD>&nbsp;</TD></TR>
1092
<TR><TD><A HREF="#getPortSingleShotPulseOffset">getPortSingleShotPulseOffset</A></TD>
1093
<TD>Clock pulse offset of the port, <B>Configurable</B></TD>
1094
<TD>&nbsp;</TD></TR>
1095
<TR><TD><A HREF="#getPortSingleShotPulseValue">getPortSingleShotPulseValue</A></TD>
1096
<TD>Clock pulse value of the port, <B>Configurable</B></TD>
1097
<TD>&nbsp;</TD></TR>
1098
<TR><TD><A HREF="#getPortSingleShotPulseDuration">getPortSingleShotPulseDuration</A></TD>
1099
<TD>Clock period of the port, <B>Configurable</B></TD>
1100
<TD>&nbsp;</TD></TR>
1101
<TR><TD><A HREF="#getPortConstraintSetIDs">getPortConstraintSetIDs</A></TD>
1102
<TD>List of constraint sets IDs of the port</TD>
1103
<TD>&nbsp;</TD></TR>
1104
<TR><TD><A HREF="#setPortRange">setPortRange</A></TD>
1105
<TD>Set left/right range for the given port.</TD>
1106
<TD>&nbsp;</TD></TR>
1107
<TR><TD><A HREF="#setPortDefaultValue">setPortDefaultValue</A></TD>
1108
<TD>Set default value of the given port.</TD>
1109
<TD>&nbsp;</TD></TR>
1110
<TR><TD><A HREF="#setClockDriverPeriod">setClockDriverPeriod</A></TD>
1111
<TD>Set period of the given clock port.</TD>
1112
<TD>&nbsp;</TD></TR>
1113
<TR><TD><A HREF="#setClockDriverPulseOffset">setClockDriverPulseOffset</A></TD>
1114
<TD>Set pulse offset value of the given clock port.</TD>
1115
<TD>&nbsp;</TD></TR>
1116
<TR><TD><A HREF="#setClockDriverPulseValue">setClockDriverPulseValue</A></TD>
1117
<TD>Set pulse value of the given clock port.</TD>
1118
<TD>&nbsp;</TD></TR>
1119
<TR><TD><A HREF="#setClockDriverPulseDuration">setClockDriverPulseDuration</A></TD>
1120
<TD>Set pulse duration of the given clock port.</TD>
1121
<TD>&nbsp;</TD></TR>
1122
<TR><TD><A HREF="#setPortSingleShotPulseOffset">setPortSingleShotPulseOffset</A></TD>
1123
<TD>Set pulse offset of given single shot port.</TD>
1124
<TD>&nbsp;</TD></TR>
1125
<TR><TD><A HREF="#setPortSingleShotPulseValue">setPortSingleShotPulseValue</A></TD>
1126
<TD>Set pulse value of given single shot port.</TD>
1127
<TD>&nbsp;</TD></TR>
1128
<TR><TD><A HREF="#setPortSingleShotPulseDuration">setPortSingleShotPulseDuration</A></TD>
1129
<TD>Set pulse duration of given single shot port.</TD>
1130
<TD>&nbsp;</TD></TR>
1131
</TABLE>
1132
<P>
1133
<H2><A NAME="RegisterFile Operations">Register File Operations</A></H2>
1134
<TABLE BORDER=1 WIDTH="100%">
1135
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
1136
<TR><TD><A HREF="#getRegisterFileDimensions">getRegisterFileDimensions</A></TD>
1137
<TD>Dimensions of a register file array.</TD>
1138
<TD>New in 1.5</TD></TR>
1139
<TR><TD><A HREF="#getRegisterFileAddressOffset">getRegisterFileAddressOffset</A></TD>
1140
<TD>The offset from the base address.</TD>
1141
<TD>New in 1.5</TD></TR>
1142
<TR><TD><A HREF="#getRegisterFileRange">getRegisterFileRange</A></TD>
1143
<TD>The register file range in number of addressable units., <B>Configurable</B></TD>
1144
<TD>New in 1.5</TD></TR>
1145
<TR><TD><A HREF="#setRegisterFileRange">setRegisterFileRange</A></TD>
1146
<TD>Set the register file range in addressable units., <B>Configurable</B></TD>
1147
<TD>New in 1.5</TD></TR>
1148
<TR><TD><A HREF="#getRegisterFileRegisterIDs">getRegisterFileRegisterIDs</A></TD>
1149
<TD>List of IDs for the registers of the given register file</TD>
1150
<TD>New in 1.5</TD></TR>
1151
<TR><TD><A HREF="#getRegisterFileRegisterFileIDs">getRegisterFileRegisterFileIDs</A></TD>
1152
<TD>List of IDs for the register files of the given register file</TD>
1153
<TD>New in 1.5</TD></TR>
1154
</TABLE>
1155
<P>
1156
<H2><A NAME="RegisterOperations">Register Operations</A></H2>
1157
<TABLE BORDER=1 WIDTH="100%">
1158
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
1159
<TR><TD><A HREF="#getRegisterDimensions">getRegisterDimensions</A></TD>
1160
<TD>Dimensions of a register array.</TD>
1161
<TD>&nbsp;</TD></TR>
1162
<TR><TD><A HREF="#getRegisterAddressOffset">getRegisterAddressOffset</A></TD>
1163
<TD>The offset from the base address.</TD>
1164
<TD>&nbsp;</TD></TR>
1165
<TR><TD><A HREF="#getRegisterAlternateRegisterIDs">getRegisterAlternateRegisterIDs</A></TD>
1166
<TD>List of IDs for the alternate registers of the given register</TD>
1167
<TD>New in 1.5</TD></TR>
1168
<TR><TD><A HREF="#getRegisterAccess">getRegisterAccess</A></TD>
1169
<TD>The accessibility of the data in the register</TD>
1170
<TD>&nbsp;</TD></TR>
1171
<TR><TD><A HREF="#getRegisterSize">getRegisterSize</A></TD>
1172
<TD>The register size in bits., <B>Configurable</B></TD>
1173
<TD>&nbsp;</TD></TR>
1174
<TR><TD><A HREF="#setRegisterSize">setRegisterSize</A></TD>
1175
<TD>Set the register size in bits., <B>Configurable</B></TD>
1176
<TD>&nbsp;</TD></TR>
1177
<TR><TD><A HREF="#getRegisterVolatility">getRegisterVolatility</A></TD>
1178
<TD>Indicates whether or not the data is volatile.</TD>
1179
<TD>Modified in 1.5</TD></TR>
1180
<TR><TD><A HREF="#getRegisterResetValue">getRegisterResetValue</A></TD>
1181
<TD>Register value at reset., <B>Configurable</B></TD>
1182
<TD>Modified in 1.5</TD></TR>
1183
<TR><TD><A HREF="#setRegisterResetValue">setRegisterResetValue</A></TD>
1184
<TD>Set register value at reset., <B>Configurable</B></TD>
1185
<TD>Modified in 1.5</TD></TR>
1186
<TR><TD><A HREF="#getRegisterResetMask">getRegisterResetMask</A></TD>
1187
<TD>Mask to be ANDed with the value before comparing to reset value., <B>Configurable</B></TD>
1188
<TD>Modified in 1.5</TD></TR>
1189
<TR><TD><A HREF="#setRegisterResetMask">setRegisterResetMask</A></TD>
1190
<TD>Set the mask to be ANDed with the value before comparing to reset value., <B>Configurable</B></TD>
1191
<TD>Modified in 1.5</TD></TR>
1192
<TR><TD><A HREF="#getRegisterFieldIDs">getRegisterFieldIDs</A></TD>
1193
<TD>List of IDs for the fields of the given register</TD>
1194
<TD>Modified in 1.5</TD></TR>
1195
<TR><TD><A HREF="#getRegisterAlternateGroups">getRegisterAlternateGroups</A></TD>
1196
<TD>Indicates the group names for an alternate register.</TD>
1197
<TD>New in 1.5</TD></TR>
1198
</TABLE>
1199
<P>
1200
<H2><A NAME="RemapOperations">Remap Operations</A></H2>
1201
<TABLE BORDER=1 WIDTH="100%">
1202
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
1203
<TR><TD><A HREF="#getRemapStatePortIDs">getRemapStatePortIDs</A></TD>
1204
<TD>List of remap port IDs of a remap state</TD>
1205
<TD>&nbsp;</TD></TR>
1206
<TR><TD><A HREF="#getRemapStatePortPortID">getRemapStatePortPortID</A></TD>
1207
<TD>Port ID for the remap state</TD>
1208
<TD>&nbsp;</TD></TR>
1209
<TR><TD><A HREF="#getRemapStatePortPortIndex">getRemapStatePortPortIndex</A></TD>
1210
<TD>Index of the port if a vector for the remap state</TD>
1211
<TD>&nbsp;</TD></TR>
1212
<TR><TD><A HREF="#getRemapStatePortPortValue">getRemapStatePortPortValue</A></TD>
1213
<TD>Value of the port for the remap state</TD>
1214
<TD>&nbsp;</TD></TR>
1215
</TABLE>
1216
<P>
1217
<H2><A NAME="ServiceOperations">Service Operations</A></H2>
1218
<TABLE BORDER=1 WIDTH="100%">
1219
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
1220
<TR><TD><A HREF="#getAbstractionDefServiceInitiative">getAbstractionDefServiceInitiative</A></TD>
1221
<TD>Port service initiative from the abstraction definition</TD>
1222
<TD>&nbsp;</TD></TR>
1223
<TR><TD><A HREF="#getAbstractionDefServiceIDs">getAbstractionDefServiceIDs</A></TD>
1224
<TD>List of typeDefs for an abstractionServiceID</TD>
1225
<TD><FONT color=#ff0000>Invalid in 1.5</FONT></TD></TR>
1226
<TR><TD><A HREF="#getAbstractionDefAbstractionServiceTypeDefIDs">getAbstractionDefAbstractionServiceTypeDefIDs</A></TD>
1227
<TD>List of type definitions for an abstractionServiceID</TD>
1228
<TD>New in 1.5</TD></TR>
1229
<TR><TD><A HREF="#getServiceInitiative">getServiceInitiative</A></TD>
1230
<TD>Initiative of the service</TD>
1231
<TD>&nbsp;</TD></TR>
1232
<TR><TD><A HREF="#getServiceTypeDefIDs">getServiceTypeDefIDs</A></TD>
1233
<TD>List of typeDefs for a serviceID</TD>
1234
<TD>Modified in 1.5</TD></TR>
1235
</TABLE>
1236
<P>
1237
<H2><A NAME="TypeDefOperations">TypeDef Operations</A></H2>
1238
<TABLE BORDER=1 WIDTH="100%">
1239
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
1240
<TR><TD><A HREF="#getTypeDefTypeName">getTypeDefTypeName</A></TD>
1241
<TD>Name of the type</TD>
1242
<TD>Modified in 1.5</TD></TR>
1243
<TR><TD><A HREF="#getTypeDefConstrained">getTypeDefConstrained</A></TD>
1244
<TD>Is the type name constrained</TD>
1245
<TD>Modified in 1.5</TD></TR>
1246
<TR><TD><A HREF="#getTypeDefImplicit">getTypeDefImplicit</A></TD>
1247
<TD>Is the type name implicit</TD>
1248
<TD>Modified in 1.5</TD></TR>
1249
<TR><TD><A HREF="#getTypeDefTypeDefinitions">getTypeDefTypeDefinitions</A></TD>
1250
<TD>List of type definition for the given type</TD>
1251
<TD>Modified in 1.5</TD></TR>
1252
<TR><TD><A HREF="#getTypeDefTypeViewIDs">getTypeDefTypeViewIDs</A></TD>
1253
<TD>List of type viewIDs for the given type</TD>
1254
<TD>Modified in 1.5</TD></TR>
1255
</TABLE>
1256
<P>
1257
<H2><A NAME="ViewOperations">View Operations</A></H2>
1258
<TABLE BORDER=1 WIDTH="100%">
1259
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
1260
<TR><TD><A HREF="#getViewDesignID">getViewDesignID</A></TD>
1261
<TD>ID of the design associated with a hierarchical view</TD>
1262
<TD>&nbsp;</TD></TR>
1263
<TR><TD><A HREF="#getViewEnvIdentifiers">getViewEnvIdentifiers</A></TD>
1264
<TD>List of environment identifiers of the view</TD>
1265
<TD>&nbsp;</TD></TR>
1266
<TR><TD><A HREF="#getViewLanguage">getViewLanguage</A></TD>
1267
<TD>View Language</TD>
1268
<TD>&nbsp;</TD></TR>
1269
<TR><TD><A HREF="#getViewLanguageIsStrict">getViewLanguageIsStrict</A></TD>
1270
<TD>Value of 'strict' attribute on view language element</TD>
1271
<TD>&nbsp;</TD></TR>
1272
<TR><TD><A HREF="#getViewModelName">getViewModelName</A></TD>
1273
<TD>Get the model name for this view</TD>
1274
<TD>&nbsp;</TD></TR>
1275
<TR><TD><A HREF="#getViewDefaultFileBuilderIDs">getViewDefaultFileBuilderIDs</A></TD>
1276
<TD>List of default file builder IDs of the view</TD>
1277
<TD>&nbsp;</TD></TR>
1278
<TR><TD><A HREF="#getViewFileSetIDs">getViewFileSetIDs</A></TD>
1279
<TD>List of fileSet IDs for fileSets referenced by the view</TD>
1280
<TD>&nbsp;</TD></TR>
1281
<TR><TD><A HREF="#getViewPortConstraintSetIDs">getViewPortConstraintSetIDs</A></TD>
1282
<TD>Constraint set ID for the port referenced by the view</TD>
1283
<TD>Modified in 1.5</TD></TR>
1284
<TR><TD><A HREF="#getViewWhiteboxElementRefIDs">getViewWhiteboxElementRefIDs</A></TD>
1285
<TD>List of whitebox element reference IDs of the view</TD>
1286
<TD>&nbsp;</TD></TR>
1287
</TABLE>
1288
<P>
1289
<H2><A NAME="WhiteboxOperations">Whitebox Operations</A></H2>
1290
<TABLE BORDER=1 WIDTH="100%">
1291
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
1292
<TR><TD><A HREF="#getWhiteboxElementRefID">getWhiteboxElementRefID</A></TD>
1293
<TD>White box element reference ID</TD>
1294
<TD>&nbsp;</TD></TR>
1295
<TR><TD><A HREF="#getWhiteboxRefPathIDs">getWhiteboxRefPathIDs</A></TD>
1296
<TD>List of path IDs of the white box element reference</TD>
1297
<TD>&nbsp;</TD></TR>
1298
<TR><TD><A HREF="#getWhiteboxRefPathName">getWhiteboxRefPathName</A></TD>
1299
<TD>Name of the whitebox reference path element</TD>
1300
<TD>&nbsp;</TD></TR>
1301
<TR><TD><A HREF="#getWhiteboxRefPathRange">getWhiteboxRefPathRange</A></TD>
1302
<TD>List of left and right range of the whitebox reference path element</TD>
1303
<TD>&nbsp;</TD></TR>
1304
<TR><TD><A HREF="#getWhiteboxElementType">getWhiteboxElementType</A></TD>
1305
<TD>Type of the whitebox element</TD>
1306
<TD>&nbsp;</TD></TR>
1307
<TR><TD><A HREF="#getWhiteboxElementDrivable">getWhiteboxElementDrivable</A></TD>
1308
<TD>Indicates whether or not the whitebox element is drivable</TD>
1309
<TD>&nbsp;</TD></TR>
1310
<TR><TD><A HREF="#getWhiteboxElementRegisterID">getWhiteboxElementRegisterID</A></TD>
1311
<TD>Register reference ID of the whitebox element</TD>
1312
<TD><FONT color=#ff0000>Invalid in 1.5</FONT></TD></TR>
1313
<TR><TD><A HREF="#getWhiteboxElementRegisterIDs">getWhiteboxElementRegisterIDs</A></TD>
1314
<TD>Register reference IDs of the whitebox element</TD>
1315
<TD>New in 1.5</TD></TR>
1316
</TABLE>
1317
<P>
1318
<table width="100%"><TR><TD bgcolor=#b8b8ff>
1319
<BR><H2>Abstraction Definition Operations</H2>
1320
</TD></TR></TABLE>
1321
<A NAME ="abstractionDefID0">
1322
<BR><H3><A NAME="getAbstractionDefID">getAbstractionDefID</A></H3>
1323
Description: ID for the abstraction definition with the given VLNV<B>&nbsp;</B>
1324
<UL>
1325
<LI>Returns: <I>abstractionDefID</I> of type <I>xsd:string</I> </LI>
1326
<LI>Input: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
1327
</UL>
1328
<A NAME ="vlnvValue0">
1329
<BR><H3><A NAME="getAbstractionDefVLNV">getAbstractionDefVLNV</A></H3>
1330
Description: Vendor Library Name Version of the abstraction definition<B>&nbsp;</B>
1331
<UL>
1332
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
1333
<LI>Input: <A HREF="#abstractionDefID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefID</I></A> of type <I>xsd:string</I> </LI>
1334
</UL>
1335
<A NAME ="vlnvValue1">
1336
<BR><H3><A NAME="getAbstractionDefBusTypeVLNV">getAbstractionDefBusTypeVLNV</A></H3>
1337
Description: Get VLNV of the bus definition<B>&nbsp;</B>
1338
<UL>
1339
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
1340
<LI>Input: <A HREF="#abstractionDefID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefID</I></A> of type <I>xsd:string</I> </LI>
1341
</UL>
1342
<A NAME ="vlnvValue2">
1343
<BR><H3><A NAME="getAbstractionDefExtends">getAbstractionDefExtends</A></H3>
1344
Description: Vendor Library Name Version of the abstraction definition being extended<B>- New in 1.5</B>
1345
<UL>
1346
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
1347
<LI>Input: <A HREF="#abstractionDefID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefID</I></A> of type <I>xsd:string</I> </LI>
1348
</UL>
1349
<A NAME ="abstractionDefPortID0">
1350
<BR><H3><A NAME="getAbstractionDefPortIDs">getAbstractionDefPortIDs</A></H3>
1351
Description: List of abstraction definition port element IDs<B>&nbsp;</B>
1352
<UL>
1353
<LI>Returns: <I>abstractionDefPortIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
1354
<LI>Input: <A HREF="#abstractionDefID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefID</I></A> of type <I>xsd:string</I> </LI>
1355
</UL>
1356
<A NAME ="value0">
1357
<BR><H3><A NAME="getAbstractionDefPortLogicalName">getAbstractionDefPortLogicalName</A></H3>
1358
Description: Logical name of this abstraction definition port<B>&nbsp;</B>
1359
<UL>
1360
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
1361
<LI>Input: <A HREF="#abstractionDefPortID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortID</I></A> of type <I>xsd:string</I> </LI>
1362
</UL>
1363
<A NAME ="booleanValue0">
1364
<BR><H3><A NAME="getAbstractionDefPortRequiresDriver">getAbstractionDefPortRequiresDriver</A></H3>
1365
Description: Does this port require a driver<B>&nbsp;</B>
1366
<UL>
1367
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
1368
<LI>Input: <A HREF="#abstractionDefPortID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortID</I></A> of type <I>xsd:string</I> </LI>
1369
</UL>
1370
<A NAME ="value1">
1371
<BR><H3><A NAME="getAbstractionDefPortRequiredDriverType">getAbstractionDefPortRequiredDriverType</A></H3>
1372
Description: Required driver type for this port<B>&nbsp;</B>
1373
<UL>
1374
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
1375
<LI>Input: <A HREF="#abstractionDefPortID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortID</I></A> of type <I>xsd:string</I> </LI>
1376
</UL>
1377
<A NAME ="value2">
1378
<BR><H3><A NAME="getAbstractionDefPortStyle">getAbstractionDefPortStyle</A></H3>
1379
Description: Returns 'wire' or 'transactional' to indicate the port style<B>&nbsp;</B>
1380
<UL>
1381
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
1382
<LI>Input: <A HREF="#abstractionDefPortID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortID</I></A> of type <I>xsd:string</I> </LI>
1383
</UL>
1384
<A NAME ="booleanValue1">
1385
<BR><H3><A NAME="getAbstractionDefPortIsAddress">getAbstractionDefPortIsAddress</A></H3>
1386
Description: Is this port an address port<B>&nbsp;</B>
1387
<UL>
1388
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
1389
<LI>Input: <A HREF="#abstractionDefPortID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortID</I></A> of type <I>xsd:string</I> </LI>
1390
</UL>
1391
<A NAME ="booleanValue2">
1392
<BR><H3><A NAME="getAbstractionDefPortIsData">getAbstractionDefPortIsData</A></H3>
1393
Description: Is this port a data port<B>&nbsp;</B>
1394
<UL>
1395
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
1396
<LI>Input: <A HREF="#abstractionDefPortID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortID</I></A> of type <I>xsd:string</I> </LI>
1397
</UL>
1398
<A NAME ="booleanValue3">
1399
<BR><H3><A NAME="getAbstractionDefPortIsClock">getAbstractionDefPortIsClock</A></H3>
1400
Description: Is this port a clock port<B>&nbsp;</B>
1401
<UL>
1402
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
1403
<LI>Input: <A HREF="#abstractionDefPortID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortID</I></A> of type <I>xsd:string</I> </LI>
1404
</UL>
1405
<A NAME ="booleanValue4">
1406
<BR><H3><A NAME="getAbstractionDefPortIsReset">getAbstractionDefPortIsReset</A></H3>
1407
Description: Is this port a reset port<B>&nbsp;</B>
1408
<UL>
1409
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
1410
<LI>Input: <A HREF="#abstractionDefPortID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortID</I></A> of type <I>xsd:string</I> </LI>
1411
</UL>
1412
<A NAME ="abstractionDefPortModeID0">
1413
<FONT color=#ff0000><BR><H3><A NAME="getAbstractionDefPortModeID">getAbstractionDefPortModeID</A></H3></FONT>
1414
Description: Returns an ID for accessing the given port in the given interface mode<B>- Invalid in 1.5</B>
1415
<UL>
1416
<LI>Returns: <A HREF="#abstractionDefPortModeID1" TITLE="link to another function that returns this type ID"><I>abstractionDefPortModeID</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
1417
<LI>Input: <I>modeValue</I> of type <I>xsd:string</I> -- modeValue should be one of master, slave or system</LI>
1418
<LI>Input: <A HREF="#abstractionDefPortID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortID</I></A> of type <I>xsd:string</I> </LI>
1419
</UL>
1420
<A NAME ="abstractionDefPortModeID1">
1421
<BR><H3><A NAME="getAbstractionDefPortModeIDs">getAbstractionDefPortModeIDs</A></H3>
1422
Description: Returns an array of IDs for accessing the given port in the given interface mode. The array shall only contain one element if the modeValue input is master or slave. The array may contain multiple elements for modeValue system.<B>- New in 1.5</B>
1423
<UL>
1424
<LI>Returns: <B><A HREF="#abstractionDefPortModeID0" TITLE="last function the returns this type ID in list"><I>abstractionDefPortModeID</I></A></B> of type <I>spirit:soapStringArrayType</I> </LI>
1425
<LI>Input: <I>modeValue</I> of type <I>xsd:string</I> -- modeValue should be one of master, slave or system</LI>
1426
<LI>Input: <A HREF="#abstractionDefPortID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortID</I></A> of type <I>xsd:string</I> </LI>
1427
</UL>
1428
<A NAME ="value3">
1429
<BR><H3><A NAME="getAbstractionDefPortModeGroup">getAbstractionDefPortModeGroup</A></H3>
1430
Description: Group name when present on a system interface<B>&nbsp;</B>
1431
<UL>
1432
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
1433
<LI>Input: <A HREF="#abstractionDefPortModeID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortModeID</I></A> of type <I>xsd:string</I> </LI>
1434
</UL>
1435
<A NAME ="nonNegativeIntegerValue0">
1436
<BR><H3><A NAME="getAbstractionDefPortModeBitWidth">getAbstractionDefPortModeBitWidth</A></H3>
1437
Description: Bit width constraint when present on an interface of the given type<B>&nbsp;</B>
1438
<UL>
1439
<LI>Returns: <I>nonNegativeIntegerValue</I> of type <I>xsd:nonNegativeInteger</I> -- a return value of 0 indicates unbounded</LI>
1440
<LI>Input: <A HREF="#abstractionDefPortModeID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortModeID</I></A> of type <I>xsd:string</I> </LI>
1441
</UL>
1442
<A NAME ="direction0">
1443
<BR><H3><A NAME="getAbstractionDefPortModeDirection">getAbstractionDefPortModeDirection</A></H3>
1444
Description: Port direction constraint when present on an interface of the given type<B>&nbsp;</B>
1445
<UL>
1446
<LI>Returns: <I>direction</I> of type <I>xsd:string</I> </LI>
1447
<LI>Input: <A HREF="#abstractionDefPortModeID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortModeID</I></A> of type <I>xsd:string</I> </LI>
1448
</UL>
1449
<A NAME ="abstractionDefPortModeConstraintID0">
1450
<BR><H3><A NAME="getAbstractionDefPortNonMirroredConstraintIDs">getAbstractionDefPortNonMirroredConstraintIDs</A></H3>
1451
Description: List of constraint IDs for a non-mirrored port<B>&nbsp;</B>
1452
<UL>
1453
<LI>Returns: <A HREF="#abstractionDefPortModeConstraintID1" TITLE="link to another function that returns this type ID"><I>abstractionDefPortModeConstraintIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
1454
<LI>Input: <A HREF="#abstractionDefPortModeID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortModeID</I></A> of type <I>xsd:string</I> </LI>
1455
</UL>
1456
<A NAME ="abstractionDefPortModeConstraintID1">
1457
<BR><H3><A NAME="getAbstractionDefPortMirroredConstraintIDs">getAbstractionDefPortMirroredConstraintIDs</A></H3>
1458
Description: List of constraint IDs for a mirrored port<B>&nbsp;</B>
1459
<UL>
1460
<LI>Returns: <B><A HREF="#abstractionDefPortModeConstraintID0" TITLE="last function the returns this type ID in list"><I>abstractionDefPortModeConstraintIDs</I></A></B> of type <I>spirit:soapStringArrayType</I> </LI>
1461
<LI>Input: <A HREF="#abstractionDefPortModeID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortModeID</I></A> of type <I>xsd:string</I> </LI>
1462
</UL>
1463
<A NAME ="driveConstraintID0">
1464
<BR><H3><A NAME="getAbstractionDefPortDriveConstraintIDs">getAbstractionDefPortDriveConstraintIDs</A></H3>
1465
Description: List of drive constraint IDs of the port<B>&nbsp;</B>
1466
<UL>
1467
<LI>Returns: <A HREF="#driveConstraintID1" TITLE="link to another function that returns this type ID"><I>driveConstraintIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
1468
<LI>Input: <A HREF="#abstractionDefPortModeConstraintID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortModeConstraintID</I></A> of type <I>xsd:string</I> </LI>
1469
</UL>
1470
<A NAME ="loadConstraintID0">
1471
<BR><H3><A NAME="getAbstractionDefPortLoadConstraintIDs">getAbstractionDefPortLoadConstraintIDs</A></H3>
1472
Description: List of load constraint IDs of the port<B>&nbsp;</B>
1473
<UL>
1474
<LI>Returns: <A HREF="#loadConstraintID1" TITLE="link to another function that returns this type ID"><I>loadConstraintIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
1475
<LI>Input: <A HREF="#abstractionDefPortModeConstraintID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortModeConstraintID</I></A> of type <I>xsd:string</I> </LI>
1476
</UL>
1477
<A NAME ="timingConstraintID0">
1478
<BR><H3><A NAME="getAbstractionDefPortTimingConstraintIDs">getAbstractionDefPortTimingConstraintIDs</A></H3>
1479
Description: List of timing constraint IDs of the port<B>&nbsp;</B>
1480
<UL>
1481
<LI>Returns: <A HREF="#timingConstraintID1" TITLE="link to another function that returns this type ID"><I>timingConstraintIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
1482
<LI>Input: <A HREF="#abstractionDefPortModeConstraintID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortModeConstraintID</I></A> of type <I>xsd:string</I> </LI>
1483
</UL>
1484
<A NAME ="value4">
1485
<BR><H3><A NAME="getAbstractionDefPortDefaultValue">getAbstractionDefPortDefaultValue</A></H3>
1486
Description: Default value for port when not connected<B>&nbsp;</B>
1487
<UL>
1488
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
1489
<LI>Input: <A HREF="#abstractionDefPortID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortID</I></A> of type <I>xsd:string</I> </LI>
1490
</UL>
1491
<A NAME ="presence0">
1492
<BR><H3><A NAME="getAbstractionDefPortModePresence">getAbstractionDefPortModePresence</A></H3>
1493
Description: Existence requirement for this port on an interface of the given type<B>&nbsp;</B>
1494
<UL>
1495
<LI>Returns: <I>presence</I> of type <I>xsd:string</I> </LI>
1496
<LI>Input: <A HREF="#abstractionDefPortModeID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortModeID</I></A> of type <I>xsd:string</I> </LI>
1497
</UL>
1498
<A NAME ="abstractionServiceID0">
1499
<FONT color=#ff0000><BR><H3><A NAME="getAbstractionDefPortModeServiceIDs">getAbstractionDefPortModeServiceIDs</A></H3></FONT>
1500
Description: AbstractionDef service IDs on a transactional port<B>- Invalid in 1.5</B>
1501
<UL>
1502
<LI>Returns: <A HREF="#abstractionServiceID1" TITLE="link to another function that returns this type ID"><I>abstractionServiceIDs</I></A> of type <I>xsd:string</I> </LI>
1503
<LI>Input: <A HREF="#abstractionDefPortModeID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortModeID</I></A> of type <I>xsd:string</I> </LI>
1504
</UL>
1505
<A NAME ="abstractionServiceID1">
1506
<BR><H3><A NAME="getAbstractionDefPortModeServiceID">getAbstractionDefPortModeServiceID</A></H3>
1507
Description: AbstractionDef service ID on a transactional port<B>- New in 1.5</B>
1508
<UL>
1509
<LI>Returns: <B><A HREF="#abstractionServiceID0" TITLE="last function the returns this type ID in list"><I>abstractionServiceID</I></A></B> of type <I>xsd:string</I> </LI>
1510
<LI>Input: <A HREF="#abstractionDefPortModeID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortModeID</I></A> of type <I>xsd:string</I> </LI>
1511
</UL>
1512
<P>
1513
<table width="100%"><TR><TD bgcolor=#b8b8ff>
1514
<BR><H2>Abstractor Instance Operations</H2>
1515
</TD></TR></TABLE>
1516
<A NAME ="value5">
1517
<BR><H3><A NAME="getAbstractorInstanceName">getAbstractorInstanceName</A></H3>
1518
Description: Instance name of the abstractor<B>&nbsp;</B>
1519
<UL>
1520
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
1521
<LI>Input: <A HREF="#abstractorInstanceID0" TITLE="link to list of functions that return this type ID"><I>abstractorInstanceID</I></A> of type <I>xsd:string</I> </LI>
1522
</UL>
1523
<A NAME ="vlnvValue3">
1524
<BR><H3><A NAME="getAbstractorInstanceVLNV">getAbstractorInstanceVLNV</A></H3>
1525
Description: Vendor Library Name Version of the abstractor (from the design file)<B>&nbsp;</B>
1526
<UL>
1527
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
1528
<LI>Input: <A HREF="#abstractorInstanceID0" TITLE="link to list of functions that return this type ID"><I>abstractorInstanceID</I></A> of type <I>xsd:string</I> </LI>
1529
</UL>
1530
<A NAME ="abstractorID0">
1531
<BR><H3><A NAME="getAbstractorInstanceAbstractorID">getAbstractorInstanceAbstractorID</A></H3>
1532
Description: ID for the abstractor associated with given instance (crossing from design configuration to abstractor file)<B>&nbsp;</B>
1533
<UL>
1534
<LI>Returns: <I>abstractorID</I> of type <I>xsd:string</I> </LI>
1535
<LI>Input: <A HREF="#abstractorInstanceID0" TITLE="link to list of functions that return this type ID"><I>abstractorInstanceID</I></A> of type <I>xsd:string</I> </LI>
1536
</UL>
1537
<A NAME ="xmlText0">
1538
<BR><H3><A NAME="getAbstractorInstanceXML">getAbstractorInstanceXML</A></H3>
1539
Description: Return the abstractor XML in text format. Schema version is DE dependent.<B>&nbsp;</B>
1540
<UL>
1541
<LI>Returns: <I>xmlText</I> of type <I>xsd:string</I> </LI>
1542
<LI>Input: <A HREF="#abstractorInstanceID0" TITLE="link to list of functions that return this type ID"><I>abstractorInstanceID</I></A> of type <I>xsd:string</I> </LI>
1543
</UL>
1544
<P>
1545
<table width="100%"><TR><TD bgcolor=#b8b8ff>
1546
<BR><H2>Abstractor Operations</H2>
1547
</TD></TR></TABLE>
1548
<A NAME ="value6">
1549
<BR><H3><A NAME="getAbstractorAbstractorMode">getAbstractorAbstractorMode</A></H3>
1550
Description: Get the mode that the abstractor can be master, slave, direct or system.<B>&nbsp;</B>
1551
<UL>
1552
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
1553
<LI>Input: <A HREF="#abstractorID0" TITLE="link to list of functions that return this type ID"><I>abstractorID</I></A> of type <I>xsd:string</I> </LI>
1554
</UL>
1555
<A NAME ="vlnvValue4">
1556
<BR><H3><A NAME="getAbstractorBusTypeVLNV">getAbstractorBusTypeVLNV</A></H3>
1557
Description: List of VLNV of the bus definition<B>&nbsp;</B>
1558
<UL>
1559
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
1560
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
1561
</UL>
1562
<A NAME ="interfaceID0">
1563
<BR><H3><A NAME="getAbstractorAbstractorInterfaceIDs">getAbstractorAbstractorInterfaceIDs</A></H3>
1564
Description: List of 2 interface IDs<B>&nbsp;</B>
1565
<UL>
1566
<LI>Returns: <A HREF="#interfaceID1" TITLE="link to another function that returns this type ID"><I>interfaceIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
1567
<LI>Input: <A HREF="#abstractorID0" TITLE="link to list of functions that return this type ID"><I>abstractorID</I></A> of type <I>xsd:string</I> </LI>
1568
</UL>
1569
<A NAME ="viewID0">
1570
<BR><H3><A NAME="getAbstractorViewIDs">getAbstractorViewIDs</A></H3>
1571
Description: A list of model view IDs<B>- Modified in 1.5</B>
1572
<UL>
1573
<LI>Returns: <A HREF="#viewID1" TITLE="link to another function that returns this type ID"><I>viewIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
1574
<LI>Input: <A HREF="#abstractorID0" TITLE="link to list of functions that return this type ID"><I>abstractorID</I></A> of type <I>xsd:string</I> </LI>
1575
<LI>Input: <I>configured</I> of type <I>xsd:boolean</I> -- If true returns only the view configured by a designConfiguration. If false returns all views.</LI>
1576
</UL>
1577
<A NAME ="portID0">
1578
<BR><H3><A NAME="getAbstractorPortIDs">getAbstractorPortIDs</A></H3>
1579
Description: A list of abstractor model port IDs<B>&nbsp;</B>
1580
<UL>
1581
<LI>Returns: <A HREF="#portID1" TITLE="link to another function that returns this type ID"><I>portIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
1582
<LI>Input: <A HREF="#abstractorID0" TITLE="link to list of functions that return this type ID"><I>abstractorID</I></A> of type <I>xsd:string</I> </LI>
1583
</UL>
1584
<A NAME ="parameterID0">
1585
<BR><H3><A NAME="getAbstractorModelParameterIDs">getAbstractorModelParameterIDs</A></H3>
1586
Description: A list of model parameter IDs<B>&nbsp;</B>
1587
<UL>
1588
<LI>Returns: <A HREF="#parameterID1" TITLE="link to another function that returns this type ID"><I>parameterIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
1589
<LI>Input: <A HREF="#abstractorID0" TITLE="link to list of functions that return this type ID"><I>abstractorID</I></A> of type <I>xsd:string</I> </LI>
1590
<LI>Input: <I>usageType</I> of type <I>xsd:string</I> -- Restrict returned parameters to those that match the given usageType. nontyped or typed or all if not specified.</LI>
1591
</UL>
1592
<A NAME ="generatorID0">
1593
<BR><H3><A NAME="getAbstractorGeneratorIDs">getAbstractorGeneratorIDs</A></H3>
1594
Description: List of generator IDs of the abstractor<B>&nbsp;</B>
1595
<UL>
1596
<LI>Returns: <A HREF="#generatorID1" TITLE="link to another function that returns this type ID"><I>generatorIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
1597
<LI>Input: <A HREF="#abstractorID0" TITLE="link to list of functions that return this type ID"><I>abstractorID</I></A> of type <I>xsd:string</I> </LI>
1598
</UL>
1599
<A NAME ="choiceID0">
1600
<BR><H3><A NAME="getAbstractorChoiceIDs">getAbstractorChoiceIDs</A></H3>
1601
Description: List of choices IDs<B>&nbsp;</B>
1602
<UL>
1603
<LI>Returns: <A HREF="#choiceID1" TITLE="link to another function that returns this type ID"><I>choiceIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
1604
<LI>Input: <A HREF="#abstractorID0" TITLE="link to list of functions that return this type ID"><I>abstractorID</I></A> of type <I>xsd:string</I> </LI>
1605
</UL>
1606
<A NAME ="fileSetID0">
1607
<BR><H3><A NAME="getAbstractorFileSetIDs">getAbstractorFileSetIDs</A></H3>
1608
Description: List of file set IDs<B>&nbsp;</B>
1609
<UL>
1610
<LI>Returns: <A HREF="#fileSetID1" TITLE="link to another function that returns this type ID"><I>fileSetIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
1611
<LI>Input: <A HREF="#abstractorID0" TITLE="link to list of functions that return this type ID"><I>abstractorID</I></A> of type <I>xsd:string</I> </LI>
1612
</UL>
1613
<P>
1614
<table width="100%"><TR><TD bgcolor=#b8b8ff>
1615
<BR><H2>Address Map Operations</H2>
1616
</TD></TR></TABLE>
1617
<A NAME ="range0">
1618
<BR><H3><A NAME="getAddressSpaceRange">getAddressSpaceRange</A></H3>
1619
Description: The address range of an address block expressed as the number of accessable and addressable units.<B>&nbsp;</B>
1620
<UL>
1621
<LI>Returns: <I>range</I> of type <I>spirit:spiritNumberType</I> </LI>
1622
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
1623
<UL>
1624
<LI>Legal value: <A HREF="#addressSpaceID0" TITLE="link to list of functions that return this type ID"><I>addressSpaceID</I></A> of type <I>xsd:string</I></LI>
1625
<LI>Legal value: <A HREF="#addressSpaceUID0" TITLE="link to list of functions that return this type ID"><I>addressSpaceUID</I></A> of type <I>xsd:string</I></LI>
1626
</UL>
1627
</UL>
1628
<A NAME ="width0">
1629
<BR><H3><A NAME="getAddressSpaceWidth">getAddressSpaceWidth</A></H3>
1630
Description: The bit width of an address block.<B>&nbsp;</B>
1631
<UL>
1632
<LI>Returns: <I>width</I> of type <I>xsd:nonNegativeInteger</I> </LI>
1633
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
1634
<UL>
1635
<LI>Legal value: <A HREF="#addressSpaceID0" TITLE="link to list of functions that return this type ID"><I>addressSpaceID</I></A> of type <I>xsd:string</I></LI>
1636
<LI>Legal value: <A HREF="#addressSpaceUID0" TITLE="link to list of functions that return this type ID"><I>addressSpaceUID</I></A> of type <I>xsd:string</I></LI>
1637
</UL>
1638
</UL>
1639
<A NAME ="localMemoryMapID0">
1640
<BR><H3><A NAME="getAddressSpaceLocalMemoryMapID">getAddressSpaceLocalMemoryMapID</A></H3>
1641
Description: The ID for the local memory map of the address space.<B>- New in 1.5</B>
1642
<UL>
1643
<LI>Returns: <I>localMemoryMapID</I> of type <I>xsd:string</I> </LI>
1644
<LI>Input: <A HREF="#addressSpaceID0" TITLE="link to list of functions that return this type ID"><I>addressSpaceID</I></A> of type <I>xsd:string</I> </LI>
1645
</UL>
1646
<A NAME ="segmentID0">
1647
<BR><H3><A NAME="getAddressSpaceSegmentIDs">getAddressSpaceSegmentIDs</A></H3>
1648
Description: List of IDs for address block segments for the address space.<B>- New in 1.5</B>
1649
<UL>
1650
<LI>Returns: <A HREF="#segmentID1" TITLE="link to another function that returns this type ID"><I>segmentIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
1651
<LI>Input: <A HREF="#addressSpaceID0" TITLE="link to list of functions that return this type ID"><I>addressSpaceID</I></A> of type <I>xsd:string</I> </LI>
1652
</UL>
1653
<A NAME ="addressOffset0">
1654
<BR><H3><A NAME="getSegmentAddressOffset">getSegmentAddressOffset</A></H3>
1655
Description: The address offset of an address space segment in an address space<B>- New in 1.5</B>
1656
<UL>
1657
<LI>Returns: <I>addressOffset</I> of type <I>spirit:spiritNumberType</I> </LI>
1658
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
1659
<UL>
1660
<LI>Legal value: <A HREF="#segmentID0" TITLE="link to list of functions that return this type ID"><I>segmentID</I></A> of type <I>xsd:string</I></LI>
1661
<LI>Legal value: <A HREF="#segmentUID0" TITLE="link to list of functions that return this type ID"><I>segmentUID</I></A> of type <I>xsd:string</I></LI>
1662
</UL>
1663
</UL>
1664
<A NAME ="status0">
1665
<BR><H3><A NAME="setSegmentAddressOffset">setSegmentAddressOffset</A></H3>
1666
Description: Set the address offset of an address space segment expressed in the number addressable units.<B>- New in 1.5</B>
1667
<UL>
1668
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
1669
<LI>Input: <A HREF="#segmentID0" TITLE="link to list of functions that return this type ID"><I>segmentID</I></A> of type <I>xsd:string</I> </LI>
1670
<LI>Input: <I>addressOffset</I> of type <I>spirit:spiritNumberType</I> </LI>
1671
</UL>
1672
<A NAME ="range1">
1673
<BR><H3><A NAME="getSegmentRange">getSegmentRange</A></H3>
1674
Description: The address range of an address space segment expressed as the number of accessable addressable units.<B>- New in 1.5</B>
1675
<UL>
1676
<LI>Returns: <I>range</I> of type <I>spirit:spiritNumberType</I> </LI>
1677
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
1678
<UL>
1679
<LI>Legal value: <A HREF="#segmentID0" TITLE="link to list of functions that return this type ID"><I>segmentID</I></A> of type <I>xsd:string</I></LI>
1680
<LI>Legal value: <A HREF="#segmentUID0" TITLE="link to list of functions that return this type ID"><I>segmentUID</I></A> of type <I>xsd:string</I></LI>
1681
</UL>
1682
</UL>
1683
<A NAME ="status1">
1684
<BR><H3><A NAME="setSegmentRange">setSegmentRange</A></H3>
1685
Description: Set the address range of an address space segment expressed as the number of accessable addressable units.<B>- New in 1.5</B>
1686
<UL>
1687
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
1688
<LI>Input: <A HREF="#segmentID0" TITLE="link to list of functions that return this type ID"><I>segmentID</I></A> of type <I>xsd:string</I> </LI>
1689
<LI>Input: <I>range</I> of type <I>spirit:spiritNumberType</I> </LI>
1690
</UL>
1691
<A NAME ="addressUnitBits0">
1692
<BR><H3><A NAME="getAddressSpaceAddressUnitBits">getAddressSpaceAddressUnitBits</A></H3>
1693
Description: The number bits in an addressable unit.  If none exists, the default 8 bits is returned.<B>&nbsp;</B>
1694
<UL>
1695
<LI>Returns: <I>addressUnitBits</I> of type <I>xsd:positiveInteger</I> </LI>
1696
<LI>Input: <A HREF="#addressSpaceID0" TITLE="link to list of functions that return this type ID"><I>addressSpaceID</I></A> of type <I>xsd:string</I> </LI>
1697
</UL>
1698
<A NAME ="executableImageID0">
1699
<BR><H3><A NAME="getExecutableImageIDs">getExecutableImageIDs</A></H3>
1700
Description: The IDs of the executable images belonging to the specified address space.<B>&nbsp;</B>
1701
<UL>
1702
<LI>Returns: <I>executableImageIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
1703
<LI>Input: <A HREF="#addressSpaceID0" TITLE="link to list of functions that return this type ID"><I>addressSpaceID</I></A> of type <I>xsd:string</I> </LI>
1704
</UL>
1705
<A NAME ="value7">
1706
<BR><H3><A NAME="getExecutableImageType">getExecutableImageType</A></H3>
1707
Description: The type of the executable image if existent.<B>&nbsp;</B>
1708
<UL>
1709
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
1710
<LI>Input: <A HREF="#executableImageID0" TITLE="link to list of functions that return this type ID"><I>executableImageID</I></A> of type <I>xsd:string</I> </LI>
1711
</UL>
1712
<A NAME ="value8">
1713
<BR><H3><A NAME="getExecutableImageLinkerCommand">getExecutableImageLinkerCommand</A></H3>
1714
Description: The linker command for the current executable image.<B>&nbsp;</B>
1715
<UL>
1716
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
1717
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
1718
<UL>
1719
<LI>Legal value: <A HREF="#executableImageID0" TITLE="link to list of functions that return this type ID"><I>executableImageID</I></A> of type <I>xsd:string</I></LI>
1720
<LI>Legal value: <A HREF="#executableImageUID0" TITLE="link to list of functions that return this type ID"><I>executableImageUID</I></A> of type <I>xsd:string</I></LI>
1721
</UL>
1722
</UL>
1723
<A NAME ="value9">
1724
<BR><H3><A NAME="getExecutableImageLinkerFlags">getExecutableImageLinkerFlags</A></H3>
1725
Description: The flags of the current executable image linker command.<B>&nbsp;</B>
1726
<UL>
1727
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
1728
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
1729
<UL>
1730
<LI>Legal value: <A HREF="#executableImageID0" TITLE="link to list of functions that return this type ID"><I>executableImageID</I></A> of type <I>xsd:string</I></LI>
1731
<LI>Legal value: <A HREF="#executableImageUID0" TITLE="link to list of functions that return this type ID"><I>executableImageUID</I></A> of type <I>xsd:string</I></LI>
1732
</UL>
1733
</UL>
1734
<A NAME ="linkerCommandFileID0">
1735
<BR><H3><A NAME="getExecutableImageLinkerCommandFileID">getExecutableImageLinkerCommandFileID</A></H3>
1736
Description: Element ID of linkerCommandFile associated with given executable image.<B>&nbsp;</B>
1737
<UL>
1738
<LI>Returns: <I>linkerCommandFileID</I> of type <I>xsd:string</I> </LI>
1739
<LI>Input: <A HREF="#executableImageID0" TITLE="link to list of functions that return this type ID"><I>executableImageID</I></A> of type <I>xsd:string</I> </LI>
1740
</UL>
1741
<A NAME ="fileBuilderID0">
1742
<BR><H3><A NAME="getExecutableImageFileBuilderIDs">getExecutableImageFileBuilderIDs</A></H3>
1743
Description: List of default file builder IDs of the executable image<B>&nbsp;</B>
1744
<UL>
1745
<LI>Returns: <A HREF="#fileBuilderID1" TITLE="link to another function that returns this type ID"><I>fileBuilderIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
1746
<LI>Input: <A HREF="#executableImageID0" TITLE="link to list of functions that return this type ID"><I>executableImageID</I></A> of type <I>xsd:string</I> </LI>
1747
</UL>
1748
<A NAME ="fileSetID1">
1749
<BR><H3><A NAME="getExecutableImageFileSetIDs">getExecutableImageFileSetIDs</A></H3>
1750
Description: The group of file set reference IDs complying with the tool set of the current executable image.<B>&nbsp;</B>
1751
<UL>
1752
<LI>Returns: <A HREF="#fileSetID2" TITLE="link to another function that returns this type ID"><I>fileSetIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
1753
<LI>Input: <A HREF="#executableImageID0" TITLE="link to list of functions that return this type ID"><I>executableImageID</I></A> of type <I>xsd:string</I> </LI>
1754
</UL>
1755
<A NAME ="fileName0">
1756
<BR><H3><A NAME="getLinkerCommandFileName">getLinkerCommandFileName</A></H3>
1757
Description: The name of the linker command file.<B>&nbsp;</B>
1758
<UL>
1759
<LI>Returns: <I>fileName</I> of type <I>spirit:spiritURI</I> </LI>
1760
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
1761
<UL>
1762
<LI>Legal value: <A HREF="#linkerCommandFileID0" TITLE="link to list of functions that return this type ID"><I>linkerCommandFileID</I></A> of type <I>xsd:string</I></LI>
1763
<LI>Legal value: <A HREF="#linkerCommandFileUID0" TITLE="link to list of functions that return this type ID"><I>linkerCommandFileUID</I></A> of type <I>xsd:string</I></LI>
1764
</UL>
1765
</UL>
1766
<A NAME ="value10">
1767
<BR><H3><A NAME="getLinkerCommandFileLineSwitch">getLinkerCommandFileLineSwitch</A></H3>
1768
Description: The command line switch to specify with the linker command file.<B>&nbsp;</B>
1769
<UL>
1770
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
1771
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
1772
<UL>
1773
<LI>Legal value: <A HREF="#linkerCommandFileID0" TITLE="link to list of functions that return this type ID"><I>linkerCommandFileID</I></A> of type <I>xsd:string</I></LI>
1774
<LI>Legal value: <A HREF="#linkerCommandFileUID0" TITLE="link to list of functions that return this type ID"><I>linkerCommandFileUID</I></A> of type <I>xsd:string</I></LI>
1775
</UL>
1776
</UL>
1777
<A NAME ="booleanValue5">
1778
<BR><H3><A NAME="getLinkerCommandFileEnable">getLinkerCommandFileEnable</A></H3>
1779
Description: Indicates whether or not to generate and enable the linker command file.<B>&nbsp;</B>
1780
<UL>
1781
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
1782
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
1783
<UL>
1784
<LI>Legal value: <A HREF="#linkerCommandFileID0" TITLE="link to list of functions that return this type ID"><I>linkerCommandFileID</I></A> of type <I>xsd:string</I></LI>
1785
<LI>Legal value: <A HREF="#linkerCommandFileUID0" TITLE="link to list of functions that return this type ID"><I>linkerCommandFileUID</I></A> of type <I>xsd:string</I></LI>
1786
</UL>
1787
</UL>
1788
<A NAME ="generatorID1">
1789
<BR><H3><A NAME="getLinkerCommandGeneratorIDs">getLinkerCommandGeneratorIDs</A></H3>
1790
Description: Reference IDs to the generator elements for generating the linker command file.<B>&nbsp;</B>
1791
<UL>
1792
<LI>Returns: <A HREF="#generatorID2" TITLE="link to another function that returns this type ID"><I>generatorIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
1793
<LI>Input: <A HREF="#linkerCommandFileID0" TITLE="link to list of functions that return this type ID"><I>linkerCommandFileID</I></A> of type <I>xsd:string</I> </LI>
1794
</UL>
1795
<A NAME ="memoryMapElementID0">
1796
<A NAME ="addressBlockID0">
1797
<A NAME ="bankID0">
1798
<A NAME ="subspaceMapID0">
1799
<BR><H3><A NAME="getMemoryMapElementIDs">getMemoryMapElementIDs</A></H3>
1800
Description: List of element IDs (addressBlockID, bankID, subspaceMapID) within a memory map, memory remap, local memory map, or bank<B>- Modified in 1.5</B>
1801
<UL>
1802
<LI>Returns: <I>memoryMapElementIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
1803
<UL>
1804
<LI>Possible value(s): <I>addressBlockID</I> of type <I>xsd:string</I></LI>
1805
</UL>
1806
<UL>
1807
<LI>Possible value(s): <I>bankID</I> of type <I>xsd:string</I></LI>
1808
</UL>
1809
<UL>
1810
<LI>Possible value(s): <I>subspaceMapID</I> of type <I>xsd:string</I></LI>
1811
</UL>
1812
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
1813
<UL>
1814
<LI>Legal value: <A HREF="#localMemoryMapID0" TITLE="link to list of functions that return this type ID"><I>localMemoryMapID</I></A> of type <I>xsd:string</I></LI>
1815
<LI>Legal value: <A HREF="#bankID0" TITLE="link to list of functions that return this type ID"><I>bankID</I></A> of type <I>xsd:string</I></LI>
1816
<LI>Legal value: <A HREF="#memoryMapID0" TITLE="link to list of functions that return this type ID"><I>memoryMapID</I></A> of type <I>xsd:string</I></LI>
1817
<LI>Legal value: <A HREF="#memoryRemapID0" TITLE="link to list of functions that return this type ID"><I>memoryRemapID</I></A> of type <I>xsd:string</I></LI>
1818
</UL>
1819
</UL>
1820
<A NAME ="type0">
1821
<BR><H3><A NAME="getMemoryMapElementType">getMemoryMapElementType</A></H3>
1822
Description: Indicates type of memory map element: addressBlock, bank or subspaceMap<B>&nbsp;</B>
1823
<UL>
1824
<LI>Returns: <I>type</I> of type <I>xsd:string</I> -- The return value is one of "addressBlock", "bank", "subspaceMap" or "" for unknown</LI>
1825
<LI>Input: <A HREF="#memoryMapElementID0" TITLE="link to list of functions that return this type ID"><I>memoryMapElementID</I></A> of type <I>xsd:string</I> </LI>
1826
<UL>
1827
<LI>Legal value: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I></LI>
1828
<LI>Legal value: <A HREF="#bankID0" TITLE="link to list of functions that return this type ID"><I>bankID</I></A> of type <I>xsd:string</I></LI>
1829
<LI>Legal value: <A HREF="#subspaceMapID0" TITLE="link to list of functions that return this type ID"><I>subspaceMapID</I></A> of type <I>xsd:string</I></LI>
1830
</UL>
1831
</UL>
1832
<A NAME ="addressUnitBits1">
1833
<BR><H3><A NAME="getMemoryMapAddressUnitBits">getMemoryMapAddressUnitBits</A></H3>
1834
Description: The number bits in an addressable unit for a memory map.  If none exists, the default 8 bits is returned.<B>&nbsp;</B>
1835
<UL>
1836
<LI>Returns: <I>addressUnitBits</I> of type <I>xsd:positiveInteger</I> </LI>
1837
<LI>Input: <A HREF="#memoryMapID0" TITLE="link to list of functions that return this type ID"><I>memoryMapID</I></A> of type <I>xsd:string</I> </LI>
1838
</UL>
1839
<A NAME ="baseAddress0">
1840
<BR><H3><A NAME="getAddressBlockBaseAddress">getAddressBlockBaseAddress</A></H3>
1841
Description: The base address of an address block<B>&nbsp;</B>
1842
<UL>
1843
<LI>Returns: <I>baseAddress</I> of type <I>spirit:spiritNumberType</I> </LI>
1844
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
1845
<UL>
1846
<LI>Legal value: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I></LI>
1847
<LI>Legal value: <A HREF="#addressBlockUID0" TITLE="link to list of functions that return this type ID"><I>addressBlockUID</I></A> of type <I>xsd:string</I></LI>
1848
</UL>
1849
</UL>
1850
<A NAME ="range2">
1851
<BR><H3><A NAME="getAddressBlockRange">getAddressBlockRange</A></H3>
1852
Description: The address range of an address block expressed as the number of accessable and addressable units.<B>&nbsp;</B>
1853
<UL>
1854
<LI>Returns: <I>range</I> of type <I>spirit:spiritNumberType</I> </LI>
1855
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
1856
<UL>
1857
<LI>Legal value: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I></LI>
1858
<LI>Legal value: <A HREF="#addressBlockUID0" TITLE="link to list of functions that return this type ID"><I>addressBlockUID</I></A> of type <I>xsd:string</I></LI>
1859
</UL>
1860
</UL>
1861
<A NAME ="width1">
1862
<BR><H3><A NAME="getAddressBlockWidth">getAddressBlockWidth</A></H3>
1863
Description: The bit width of an address block in the local memory map.<B>&nbsp;</B>
1864
<UL>
1865
<LI>Returns: <I>width</I> of type <I>xsd:nonNegativeInteger</I> </LI>
1866
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
1867
<UL>
1868
<LI>Legal value: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I></LI>
1869
<LI>Legal value: <A HREF="#addressBlockUID0" TITLE="link to list of functions that return this type ID"><I>addressBlockUID</I></A> of type <I>xsd:string</I></LI>
1870
</UL>
1871
</UL>
1872
<A NAME ="usage0">
1873
<BR><H3><A NAME="getAddressBlockUsage">getAddressBlockUsage</A></H3>
1874
Description: Indicates the usage of this address block.<B>&nbsp;</B>
1875
<UL>
1876
<LI>Returns: <I>usage</I> of type <I>xsd:string</I> -- one of "memory", "register", "reserved" or "" if not set.</LI>
1877
<LI>Input: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I> </LI>
1878
</UL>
1879
<A NAME ="value11">
1880
<BR><H3><A NAME="getAddressBlockVolatility">getAddressBlockVolatility</A></H3>
1881
Description: Indicates whether or not the data is volatile.<B>&nbsp;</B>
1882
<UL>
1883
<LI>Returns: <I>value</I> of type <I>xsd:string</I> -- returns "true", "false" or "".</LI>
1884
<LI>Input: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I> </LI>
1885
</UL>
1886
<A NAME ="value12">
1887
<BR><H3><A NAME="getAddressBlockAccess">getAddressBlockAccess</A></H3>
1888
Description: The accessibility of the data in the local address block.<B>&nbsp;</B>
1889
<UL>
1890
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
1891
<LI>Input: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I> </LI>
1892
</UL>
1893
<A NAME ="registerID0">
1894
<BR><H3><A NAME="getAddressBlockRegisterIDs">getAddressBlockRegisterIDs</A></H3>
1895
Description: The IDs of the available registers in the address block.<B>&nbsp;</B>
1896
<UL>
1897
<LI>Returns: <A HREF="#registerID1" TITLE="link to another function that returns this type ID"><I>registerIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
1898
<LI>Input: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I> </LI>
1899
</UL>
1900
<A NAME ="registerFileID0">
1901
<BR><H3><A NAME="getAddressBlockRegisterFileIDs">getAddressBlockRegisterFileIDs</A></H3>
1902
Description: The IDs of the available register files in the address block.<B>- New in 1.5</B>
1903
<UL>
1904
<LI>Returns: <A HREF="#registerFileID1" TITLE="link to another function that returns this type ID"><I>registerFileIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
1905
<LI>Input: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I> </LI>
1906
</UL>
1907
<A NAME ="identifier0">
1908
<BR><H3><A NAME="getTypeIdentifier">getTypeIdentifier</A></H3>
1909
Description: Indicates the type identifier of an addressBlock, registerFile, register or field.<B>- New in 1.5</B>
1910
<UL>
1911
<LI>Returns: <I>identifier</I> of type <I>xsd:string</I> </LI>
1912
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
1913
<UL>
1914
<LI>Legal value: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I></LI>
1915
<LI>Legal value: <A HREF="#registerFileID0" TITLE="link to list of functions that return this type ID"><I>registerFileID</I></A> of type <I>xsd:string</I></LI>
1916
<LI>Legal value: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I></LI>
1917
<LI>Legal value: <A HREF="#alternateRegisterID0" TITLE="link to list of functions that return this type ID"><I>alternateRegisterID</I></A> of type <I>xsd:string</I></LI>
1918
<LI>Legal value: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I></LI>
1919
</UL>
1920
</UL>
1921
<A NAME ="value13">
1922
<BR><H3><A NAME="getBankAlignment">getBankAlignment</A></H3>
1923
Description: The bank alignment value, serial or parallel<B>&nbsp;</B>
1924
<UL>
1925
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
1926
<LI>Input: <A HREF="#bankID0" TITLE="link to list of functions that return this type ID"><I>bankID</I></A> of type <I>xsd:string</I> </LI>
1927
</UL>
1928
<A NAME ="value14">
1929
<BR><H3><A NAME="getBankBaseAddress">getBankBaseAddress</A></H3>
1930
Description: The base address of an address bank<B>&nbsp;</B>
1931
<UL>
1932
<LI>Returns: <I>value</I> of type <I>spirit:spiritNumberType</I> </LI>
1933
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
1934
<UL>
1935
<LI>Legal value: <A HREF="#bankID0" TITLE="link to list of functions that return this type ID"><I>bankID</I></A> of type <I>xsd:string</I></LI>
1936
<LI>Legal value: <A HREF="#bankUID0" TITLE="link to list of functions that return this type ID"><I>bankUID</I></A> of type <I>xsd:string</I></LI>
1937
</UL>
1938
</UL>
1939
<A NAME ="usage1">
1940
<BR><H3><A NAME="getBankUsage">getBankUsage</A></H3>
1941
Description: Indicates the usage of this address bank.<B>&nbsp;</B>
1942
<UL>
1943
<LI>Returns: <I>usage</I> of type <I>xsd:string</I> </LI>
1944
<LI>Input: <A HREF="#bankID0" TITLE="link to list of functions that return this type ID"><I>bankID</I></A> of type <I>xsd:string</I> </LI>
1945
</UL>
1946
<A NAME ="value15">
1947
<BR><H3><A NAME="getBankVolatility">getBankVolatility</A></H3>
1948
Description: Indicates whether or not the data is volatile.<B>&nbsp;</B>
1949
<UL>
1950
<LI>Returns: <I>value</I> of type <I>xsd:string</I> -- returns "true", "false" or "".</LI>
1951
<LI>Input: <A HREF="#bankID0" TITLE="link to list of functions that return this type ID"><I>bankID</I></A> of type <I>xsd:string</I> </LI>
1952
</UL>
1953
<A NAME ="value16">
1954
<BR><H3><A NAME="getBankAccess">getBankAccess</A></H3>
1955
Description: The accessibility of the data in the local address bank.<B>&nbsp;</B>
1956
<UL>
1957
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
1958
<LI>Input: <A HREF="#bankID0" TITLE="link to list of functions that return this type ID"><I>bankID</I></A> of type <I>xsd:string</I> </LI>
1959
</UL>
1960
<A NAME ="interfaceID1">
1961
<BR><H3><A NAME="getSubspaceMapMasterID">getSubspaceMapMasterID</A></H3>
1962
Description: Master bus interface ID on the other side of a bus bridge .<B>&nbsp;</B>
1963
<UL>
1964
<LI>Returns: <A HREF="#interfaceID2" TITLE="link to another function that returns this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
1965
<LI>Input: <A HREF="#subspaceMapID0" TITLE="link to list of functions that return this type ID"><I>subspaceMapID</I></A> of type <I>xsd:string</I> </LI>
1966
</UL>
1967
<A NAME ="segmentID1">
1968
<BR><H3><A NAME="getSubspaceMapSegmentID">getSubspaceMapSegmentID</A></H3>
1969
Description: Address space segment ID on the other side of a bus bridge .<B>- New in 1.5</B>
1970
<UL>
1971
<LI>Returns: <B><A HREF="#segmentID0" TITLE="last function the returns this type ID in list"><I>segmentID</I></A></B> of type <I>xsd:string</I> </LI>
1972
<LI>Input: <A HREF="#subspaceMapID0" TITLE="link to list of functions that return this type ID"><I>subspaceMapID</I></A> of type <I>xsd:string</I> </LI>
1973
</UL>
1974
<A NAME ="value17">
1975
<BR><H3><A NAME="getSubspaceMapBaseAddress">getSubspaceMapBaseAddress</A></H3>
1976
Description: The base address of a memory subspace<B>&nbsp;</B>
1977
<UL>
1978
<LI>Returns: <I>value</I> of type <I>spirit:spiritNumberType</I> </LI>
1979
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
1980
<UL>
1981
<LI>Legal value: <A HREF="#subspaceMapID0" TITLE="link to list of functions that return this type ID"><I>subspaceMapID</I></A> of type <I>xsd:string</I></LI>
1982
<LI>Legal value: <A HREF="#subspaceMapUID0" TITLE="link to list of functions that return this type ID"><I>subspaceMapUID</I></A> of type <I>xsd:string</I></LI>
1983
</UL>
1984
</UL>
1985
<A NAME ="memoryRemapID0">
1986
<BR><H3><A NAME="getMemoryMapRemapElementIDs">getMemoryMapRemapElementIDs</A></H3>
1987
Description: List of IDs for memory map 'remap' elements of the given memory map<B>&nbsp;</B>
1988
<UL>
1989
<LI>Returns: <I>memoryRemapIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
1990
<LI>Input: <A HREF="#memoryMapID0" TITLE="link to list of functions that return this type ID"><I>memoryMapID</I></A> of type <I>xsd:string</I> </LI>
1991
</UL>
1992
<A NAME ="remapStateID0">
1993
<BR><H3><A NAME="getMemoryRemapStateID">getMemoryRemapStateID</A></H3>
1994
Description: Remap State ID for which this remap is applicable<B>&nbsp;</B>
1995
<UL>
1996
<LI>Returns: <A HREF="#remapStateID1" TITLE="link to another function that returns this type ID"><I>remapStateID</I></A> of type <I>xsd:string</I> </LI>
1997
<LI>Input: <A HREF="#memoryRemapID0" TITLE="link to list of functions that return this type ID"><I>memoryRemapID</I></A> of type <I>xsd:string</I> </LI>
1998
</UL>
1999
<A NAME ="status2">
2000
<BR><H3><A NAME="setAddressSpaceRange">setAddressSpaceRange</A></H3>
2001
Description: Set the address range of an address block expressed as the number of accessable and addressable units.<B>&nbsp;</B>
2002
<UL>
2003
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
2004
<LI>Input: <A HREF="#addressSpaceID0" TITLE="link to list of functions that return this type ID"><I>addressSpaceID</I></A> of type <I>xsd:string</I> </LI>
2005
<LI>Input: <I>range</I> of type <I>spirit:spiritNumberType</I> </LI>
2006
</UL>
2007
<A NAME ="status3">
2008
<BR><H3><A NAME="setAddressSpaceWidth">setAddressSpaceWidth</A></H3>
2009
Description: Set the bit width of an address block.<B>&nbsp;</B>
2010
<UL>
2011
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
2012
<LI>Input: <A HREF="#addressSpaceID0" TITLE="link to list of functions that return this type ID"><I>addressSpaceID</I></A> of type <I>xsd:string</I> </LI>
2013
<LI>Input: <I>width</I> of type <I>xsd:nonNegativeInteger</I> </LI>
2014
</UL>
2015
<A NAME ="status4">
2016
<BR><H3><A NAME="setExecutableImageLinkerCommand">setExecutableImageLinkerCommand</A></H3>
2017
Description: Set the linker command for the current executable image.<B>&nbsp;</B>
2018
<UL>
2019
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
2020
<LI>Input: <A HREF="#executableImageID0" TITLE="link to list of functions that return this type ID"><I>executableImageID</I></A> of type <I>xsd:string</I> </LI>
2021
<LI>Input: <I>value</I> of type <I>xsd:string</I> </LI>
2022
</UL>
2023
<A NAME ="status5">
2024
<BR><H3><A NAME="setExecutableImageLinkerFlags">setExecutableImageLinkerFlags</A></H3>
2025
Description: Set the flags of the current executable image linker command.<B>&nbsp;</B>
2026
<UL>
2027
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
2028
<LI>Input: <A HREF="#executableImageID0" TITLE="link to list of functions that return this type ID"><I>executableImageID</I></A> of type <I>xsd:string</I> </LI>
2029
<LI>Input: <I>value</I> of type <I>xsd:string</I> </LI>
2030
</UL>
2031
<A NAME ="status6">
2032
<BR><H3><A NAME="setLinkerCommandFileName">setLinkerCommandFileName</A></H3>
2033
Description: Set the name of the linker command file.<B>&nbsp;</B>
2034
<UL>
2035
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
2036
<LI>Input: <A HREF="#linkerCommandFileID0" TITLE="link to list of functions that return this type ID"><I>linkerCommandFileID</I></A> of type <I>xsd:string</I> </LI>
2037
<LI>Input: <I>fileName</I> of type <I>spirit:spiritURI</I> </LI>
2038
</UL>
2039
<A NAME ="status7">
2040
<BR><H3><A NAME="setLinkerCommandFileLineSwitch">setLinkerCommandFileLineSwitch</A></H3>
2041
Description: Set the command line switch to specify with the linker command file.<B>&nbsp;</B>
2042
<UL>
2043
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
2044
<LI>Input: <A HREF="#linkerCommandFileID0" TITLE="link to list of functions that return this type ID"><I>linkerCommandFileID</I></A> of type <I>xsd:string</I> </LI>
2045
<LI>Input: <I>value</I> of type <I>xsd:string</I> </LI>
2046
</UL>
2047
<A NAME ="status8">
2048
<BR><H3><A NAME="setLinkerCommandFileEnable">setLinkerCommandFileEnable</A></H3>
2049
Description: Set whether or not to generate and enable the linker command file.<B>&nbsp;</B>
2050
<UL>
2051
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
2052
<LI>Input: <A HREF="#linkerCommandFileID0" TITLE="link to list of functions that return this type ID"><I>linkerCommandFileID</I></A> of type <I>xsd:string</I> </LI>
2053
<LI>Input: <I>value</I> of type <I>xsd:boolean</I> </LI>
2054
</UL>
2055
<A NAME ="status9">
2056
<BR><H3><A NAME="setAddressBlockBaseAddress">setAddressBlockBaseAddress</A></H3>
2057
Description: Set the base address of an address block<B>&nbsp;</B>
2058
<UL>
2059
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
2060
<LI>Input: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I> </LI>
2061
<LI>Input: <I>baseAddress</I> of type <I>spirit:spiritNumberType</I> </LI>
2062
</UL>
2063
<A NAME ="status10">
2064
<BR><H3><A NAME="setAddressBlockRange">setAddressBlockRange</A></H3>
2065
Description: Set the address range of an address block expressed as the number of accessable and addressable units.<B>&nbsp;</B>
2066
<UL>
2067
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
2068
<LI>Input: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I> </LI>
2069
<LI>Input: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
2070
</UL>
2071
<A NAME ="status11">
2072
<BR><H3><A NAME="setAddressBlockWidth">setAddressBlockWidth</A></H3>
2073
Description: Set the bit width of an address block<B>&nbsp;</B>
2074
<UL>
2075
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
2076
<LI>Input: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I> </LI>
2077
<LI>Input: <I>nonNegativeIntegerValue</I> of type <I>xsd:nonNegativeInteger</I> </LI>
2078
</UL>
2079
<A NAME ="status12">
2080
<BR><H3><A NAME="setBankBaseAddress">setBankBaseAddress</A></H3>
2081
Description: Set the base address of an address bank<B>&nbsp;</B>
2082
<UL>
2083
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
2084
<LI>Input: <A HREF="#bankID0" TITLE="link to list of functions that return this type ID"><I>bankID</I></A> of type <I>xsd:string</I> </LI>
2085
<LI>Input: <I>baseAddress</I> of type <I>spirit:spiritNumberType</I> </LI>
2086
</UL>
2087
<A NAME ="status13">
2088
<BR><H3><A NAME="setSubspaceMapBaseAddress">setSubspaceMapBaseAddress</A></H3>
2089
Description: Set the base address of a memory subspace<B>&nbsp;</B>
2090
<UL>
2091
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
2092
<LI>Input: <A HREF="#subspaceMapID0" TITLE="link to list of functions that return this type ID"><I>subspaceMapID</I></A> of type <I>xsd:string</I> </LI>
2093
<LI>Input: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
2094
</UL>
2095
<P>
2096
<table width="100%"><TR><TD bgcolor=#b8b8ff>
2097
<BR><H2>Bus Definition Operations</H2>
2098
</TD></TR></TABLE>
2099
<A NAME ="busdefID0">
2100
<BR><H3><A NAME="getBusDefinitionID">getBusDefinitionID</A></H3>
2101
Description: ID for the bus definition with the given VLNV<B>&nbsp;</B>
2102
<UL>
2103
<LI>Returns: <I>busdefID</I> of type <I>xsd:string</I> </LI>
2104
<LI>Input: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
2105
</UL>
2106
<A NAME ="vlnvValue5">
2107
<BR><H3><A NAME="getBusDefinitionVLNV">getBusDefinitionVLNV</A></H3>
2108
Description: Vendor Library Name Version of the bus definition<B>&nbsp;</B>
2109
<UL>
2110
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
2111
<LI>Input: <A HREF="#busdefID0" TITLE="link to list of functions that return this type ID"><I>busdefID</I></A> of type <I>xsd:string</I> </LI>
2112
</UL>
2113
<A NAME ="booleanValue6">
2114
<BR><H3><A NAME="getBusDefinitionDirectConnection">getBusDefinitionDirectConnection</A></H3>
2115
Description: Indicates whether or not the bus definition supports direct connections<B>&nbsp;</B>
2116
<UL>
2117
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
2118
<LI>Input: <A HREF="#busdefID0" TITLE="link to list of functions that return this type ID"><I>busdefID</I></A> of type <I>xsd:string</I> </LI>
2119
</UL>
2120
<A NAME ="booleanValue7">
2121
<BR><H3><A NAME="getBusDefinitionIsAddressable">getBusDefinitionIsAddressable</A></H3>
2122
Description: Indicates whether or not the bus definition is an addressable bus<B>&nbsp;</B>
2123
<UL>
2124
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
2125
<LI>Input: <A HREF="#busdefID0" TITLE="link to list of functions that return this type ID"><I>busdefID</I></A> of type <I>xsd:string</I> </LI>
2126
</UL>
2127
<A NAME ="vlnvValue6">
2128
<BR><H3><A NAME="getBusDefinitionExtends">getBusDefinitionExtends</A></H3>
2129
Description: Vendor Library Name Version of the bus definition being extended<B>&nbsp;</B>
2130
<UL>
2131
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
2132
<LI>Input: <A HREF="#busdefID0" TITLE="link to list of functions that return this type ID"><I>busdefID</I></A> of type <I>xsd:string</I> </LI>
2133
</UL>
2134
<A NAME ="value18">
2135
<BR><H3><A NAME="getBusDefinitionMaxMasters">getBusDefinitionMaxMasters</A></H3>
2136
Description: Maximum # of masters supported by this bus definition<B>&nbsp;</B>
2137
<UL>
2138
<LI>Returns: <I>value</I> of type <I>xsd:integer</I> -- -1 indicates unbounded</LI>
2139
<LI>Input: <A HREF="#busdefID0" TITLE="link to list of functions that return this type ID"><I>busdefID</I></A> of type <I>xsd:string</I> </LI>
2140
</UL>
2141
<A NAME ="value19">
2142
<BR><H3><A NAME="getBusDefinitionMaxSlaves">getBusDefinitionMaxSlaves</A></H3>
2143
Description: Maximum # of slaves supported by this bus definition<B>&nbsp;</B>
2144
<UL>
2145
<LI>Returns: <I>value</I> of type <I>xsd:integer</I> -- -1 indicates unbounded</LI>
2146
<LI>Input: <A HREF="#busdefID0" TITLE="link to list of functions that return this type ID"><I>busdefID</I></A> of type <I>xsd:string</I> </LI>
2147
</UL>
2148
<A NAME ="groupNames0">
2149
<BR><H3><A NAME="getBusDefinitionSystemGroupNames">getBusDefinitionSystemGroupNames</A></H3>
2150
Description: List of system group names for this bus definition<B>&nbsp;</B>
2151
<UL>
2152
<LI>Returns: <I>groupNames</I> of type <I>spirit:soapStringArrayType</I> </LI>
2153
<LI>Input: <A HREF="#busdefID0" TITLE="link to list of functions that return this type ID"><I>busdefID</I></A> of type <I>xsd:string</I> </LI>
2154
</UL>
2155
<P>
2156
<table width="100%"><TR><TD bgcolor=#b8b8ff>
2157
<BR><H2>Bus Interface Operations</H2>
2158
</TD></TR></TABLE>
2159
<A NAME ="addressSpaceID0">
2160
<BR><H3><A NAME="getBusInterfaceMasterAddressSpaceID">getBusInterfaceMasterAddressSpaceID</A></H3>
2161
Description: ID of the master addressSpace<B>&nbsp;</B>
2162
<UL>
2163
<LI>Returns: <A HREF="#addressSpaceID1" TITLE="link to another function that returns this type ID"><I>addressSpaceID</I></A> of type <I>xsd:string</I> </LI>
2164
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
2165
</UL>
2166
<A NAME ="spiritNumberTypeValue0">
2167
<BR><H3><A NAME="getBusInterfaceMasterBaseAddress">getBusInterfaceMasterBaseAddress</A></H3>
2168
Description: Base address of the master addressSpace<B>&nbsp;</B>
2169
<UL>
2170
<LI>Returns: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
2171
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
2172
<UL>
2173
<LI>Legal value: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I></LI>
2174
<LI>Legal value: <A HREF="#interfaceUID0" TITLE="link to list of functions that return this type ID"><I>interfaceUID</I></A> of type <I>xsd:string</I></LI>
2175
</UL>
2176
</UL>
2177
<A NAME ="memoryMapID0">
2178
<BR><H3><A NAME="getBusInterfaceSlaveMemoryMapID">getBusInterfaceSlaveMemoryMapID</A></H3>
2179
Description: ID of the memoryMap referenced from a slave interface<B>&nbsp;</B>
2180
<UL>
2181
<LI>Returns: <A HREF="#memoryMapID1" TITLE="link to another function that returns this type ID"><I>memoryMapID</I></A> of type <I>xsd:string</I> </LI>
2182
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
2183
</UL>
2184
<A NAME ="bridgeID0">
2185
<BR><H3><A NAME="getBusInterfaceSlaveBridgeIDs">getBusInterfaceSlaveBridgeIDs</A></H3>
2186
Description: List of slave bridge IDs<B>&nbsp;</B>
2187
<UL>
2188
<LI>Returns: <I>bridgeIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
2189
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
2190
</UL>
2191
<A NAME ="interfaceID2">
2192
<BR><H3><A NAME="getBridgeMasterID">getBridgeMasterID</A></H3>
2193
Description: The slave interface master interface reference ID<B>&nbsp;</B>
2194
<UL>
2195
<LI>Returns: <A HREF="#interfaceID3" TITLE="link to another function that returns this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
2196
<LI>Input: <A HREF="#bridgeID0" TITLE="link to list of functions that return this type ID"><I>bridgeID</I></A> of type <I>xsd:string</I> </LI>
2197
</UL>
2198
<A NAME ="booleanValue8">
2199
<BR><H3><A NAME="getBridgeIsOpaque">getBridgeIsOpaque</A></H3>
2200
Description: Value of the opaque attribute<B>&nbsp;</B>
2201
<UL>
2202
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
2203
<LI>Input: <A HREF="#bridgeID0" TITLE="link to list of functions that return this type ID"><I>bridgeID</I></A> of type <I>xsd:string</I> </LI>
2204
</UL>
2205
<A NAME ="fileSetGroupID0">
2206
<BR><H3><A NAME="getBusInterfaceSlaveFileSetGroupIDs">getBusInterfaceSlaveFileSetGroupIDs</A></H3>
2207
Description: List of fileSetGroup IDs<B>&nbsp;</B>
2208
<UL>
2209
<LI>Returns: <I>fileSetGroupIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
2210
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
2211
</UL>
2212
<A NAME ="value20">
2213
<BR><H3><A NAME="getBusInterfaceGroupName">getBusInterfaceGroupName</A></H3>
2214
Description: Group name of a system, mirroredSystem, or monitor bus interface<B>&nbsp;</B>
2215
<UL>
2216
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
2217
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
2218
</UL>
2219
<A NAME ="remapAddressID0">
2220
<BR><H3><A NAME="getBusInterfaceMirroredSlaveRemapAddressIDs">getBusInterfaceMirroredSlaveRemapAddressIDs</A></H3>
2221
Description: List of remap address IDs of the mirrored slave interface<B>&nbsp;</B>
2222
<UL>
2223
<LI>Returns: <I>remapAddressIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
2224
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
2225
</UL>
2226
<A NAME ="spiritNumberTypeValue1">
2227
<BR><H3><A NAME="getRemapAddressValue">getRemapAddressValue</A></H3>
2228
Description: Remap address of the given remap address element<B>&nbsp;</B>
2229
<UL>
2230
<LI>Returns: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
2231
<LI>Input: <A HREF="#remapAddressID0" TITLE="link to list of functions that return this type ID"><I>remapAddressID</I></A> of type <I>xsd:string</I> </LI>
2232
</UL>
2233
<A NAME ="remapStateID1">
2234
<BR><H3><A NAME="getRemapAddressRemapStateID">getRemapAddressRemapStateID</A></H3>
2235
Description: Remap state ID of the given remap address element<B>&nbsp;</B>
2236
<UL>
2237
<LI>Returns: <A HREF="#remapStateID2" TITLE="link to another function that returns this type ID"><I>remapStateID</I></A> of type <I>xsd:string</I> </LI>
2238
<LI>Input: <A HREF="#remapAddressID0" TITLE="link to list of functions that return this type ID"><I>remapAddressID</I></A> of type <I>xsd:string</I> </LI>
2239
</UL>
2240
<A NAME ="spiritNumberTypeValue2">
2241
<BR><H3><A NAME="getBusInterfaceMirroredSlaveRange">getBusInterfaceMirroredSlaveRange</A></H3>
2242
Description: The address range of the mirrored slave interface<B>&nbsp;</B>
2243
<UL>
2244
<LI>Returns: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
2245
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
2246
</UL>
2247
<A NAME ="value21">
2248
<BR><H3><A NAME="getBusInterfaceMonitorInterfaceMode">getBusInterfaceMonitorInterfaceMode</A></H3>
2249
Description: Indicates the mode of interface being monitored, slave, master, system, mirrorslave, mirrormaster or mirrorslave<B>&nbsp;</B>
2250
<UL>
2251
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
2252
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
2253
</UL>
2254
<A NAME ="booleanValue9">
2255
<BR><H3><A NAME="getBusInterfaceConnectionRequired">getBusInterfaceConnectionRequired</A></H3>
2256
Description: Connection required for this bus interface<B>&nbsp;</B>
2257
<UL>
2258
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
2259
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
2260
</UL>
2261
<A NAME ="bitSteeringValue0">
2262
<BR><H3><A NAME="getBusInterfaceBitSteering">getBusInterfaceBitSteering</A></H3>
2263
Description: Bit steering description of the bus interface: on or off<B>&nbsp;</B>
2264
<UL>
2265
<LI>Returns: <I>bitSteeringValue</I> of type <I>xsd:string</I> </LI>
2266
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
2267
<UL>
2268
<LI>Legal value: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I></LI>
2269
<LI>Legal value: <A HREF="#interfaceUID0" TITLE="link to list of functions that return this type ID"><I>interfaceUID</I></A> of type <I>xsd:string</I></LI>
2270
</UL>
2271
</UL>
2272
<A NAME ="spiritEndianessValue0">
2273
<BR><H3><A NAME="getBusInterfaceEndianness">getBusInterfaceEndianness</A></H3>
2274
Description: The endianess of the bus interface, big or little. The default is little.<B>&nbsp;</B>
2275
<UL>
2276
<LI>Returns: <I>spiritEndianessValue</I> of type <I>xsd:string</I> </LI>
2277
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
2278
</UL>
2279
<A NAME ="bitsInLau0">
2280
<BR><H3><A NAME="getBusInterfaceBitsInLAU">getBusInterfaceBitsInLAU</A></H3>
2281
Description: The number bits in the least addressable unit.  If none exists, the default 8 bits is returned.<B>&nbsp;</B>
2282
<UL>
2283
<LI>Returns: <I>bitsInLau</I> of type <I>xsd:positiveInteger</I> </LI>
2284
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
2285
</UL>
2286
<A NAME ="status14">
2287
<BR><H3><A NAME="setBusInterfaceMasterBaseAddress">setBusInterfaceMasterBaseAddress</A></H3>
2288
Description: Set base address of the master bus interface.<B>&nbsp;</B>
2289
<UL>
2290
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
2291
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
2292
<LI>Input: <I>baseAddressValue</I> of type <I>spirit:spiritNumberType</I> </LI>
2293
</UL>
2294
<A NAME ="status15">
2295
<BR><H3><A NAME="setRemapAddressValue">setRemapAddressValue</A></H3>
2296
Description: Set remap address value for the associated interface.<B>&nbsp;</B>
2297
<UL>
2298
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
2299
<LI>Input: <A HREF="#remapAddressID0" TITLE="link to list of functions that return this type ID"><I>remapAddressID</I></A> of type <I>xsd:string</I> </LI>
2300
<LI>Input: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
2301
</UL>
2302
<A NAME ="status16">
2303
<BR><H3><A NAME="setBusInterfaceMirroredSlaveRange">setBusInterfaceMirroredSlaveRange</A></H3>
2304
Description: Set address range for the associated interface.<B>&nbsp;</B>
2305
<UL>
2306
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
2307
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
2308
<LI>Input: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
2309
</UL>
2310
<A NAME ="status17">
2311
<BR><H3><A NAME="setBusInterfaceBitSteering">setBusInterfaceBitSteering</A></H3>
2312
Description: Set bus interface bit steering value.<B>&nbsp;</B>
2313
<UL>
2314
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
2315
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
2316
<LI>Input: <I>bitSteeringValue</I> of type <I>xsd:string</I> </LI>
2317
</UL>
2318
<P>
2319
<table width="100%"><TR><TD bgcolor=#b8b8ff>
2320
<BR><H2>Component Instance Operations</H2>
2321
</TD></TR></TABLE>
2322
<A NAME ="value22">
2323
<BR><H3><A NAME="getComponentInstanceName">getComponentInstanceName</A></H3>
2324
Description: Instance name of the component<B>&nbsp;</B>
2325
<UL>
2326
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
2327
<LI>Input: <A HREF="#componentInstanceID0" TITLE="link to list of functions that return this type ID"><I>componentInstanceID</I></A> of type <I>xsd:string</I> </LI>
2328
</UL>
2329
<A NAME ="vlnvValue7">
2330
<BR><H3><A NAME="getComponentInstanceVLNV">getComponentInstanceVLNV</A></H3>
2331
Description: Vendor Library Name Version of the component (from the design file)<B>&nbsp;</B>
2332
<UL>
2333
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
2334
<LI>Input: <A HREF="#componentInstanceID0" TITLE="link to list of functions that return this type ID"><I>componentInstanceID</I></A> of type <I>xsd:string</I> </LI>
2335
</UL>
2336
<A NAME ="componentID0">
2337
<BR><H3><A NAME="getComponentInstanceComponentID">getComponentInstanceComponentID</A></H3>
2338
Description: ID for the component associated with given instance (crossing from design to component file)<B>&nbsp;</B>
2339
<UL>
2340
<LI>Returns: <I>componentID</I> of type <I>xsd:string</I> </LI>
2341
<LI>Input: <A HREF="#componentInstanceID0" TITLE="link to list of functions that return this type ID"><I>componentInstanceID</I></A> of type <I>xsd:string</I> </LI>
2342
</UL>
2343
<A NAME ="xmlText1">
2344
<BR><H3><A NAME="getComponentInstanceXML">getComponentInstanceXML</A></H3>
2345
Description: Return the component XML in text format. Schema version is DE dependent.<B>&nbsp;</B>
2346
<UL>
2347
<LI>Returns: <I>xmlText</I> of type <I>xsd:string</I> </LI>
2348
<LI>Input: <A HREF="#componentInstanceID0" TITLE="link to list of functions that return this type ID"><I>componentInstanceID</I></A> of type <I>xsd:string</I> </LI>
2349
</UL>
2350
<P>
2351
<table width="100%"><TR><TD bgcolor=#b8b8ff>
2352
<BR><H2>Component Operations</H2>
2353
</TD></TR></TABLE>
2354
<A NAME ="vlnvValue8">
2355
<BR><H3><A NAME="getComponentVLNV">getComponentVLNV</A></H3>
2356
Description: Vendor Library Name Version of the component (from the component file)<B>&nbsp;</B>
2357
<UL>
2358
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
2359
<LI>Input: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I> </LI>
2360
</UL>
2361
<A NAME ="componentElementType0">
2362
<BR><H3><A NAME="getComponentElementType">getComponentElementType</A></H3>
2363
Description: Returns the name of the XML element associated with the component (currently only 'component'). This call is being provided to cover a future scenario where there can be different types of component elements instantiated in a design (e.g. macroComponent elements).<B>&nbsp;</B>
2364
<UL>
2365
<LI>Returns: <I>componentElementType</I> of type <I>xsd:string</I> </LI>
2366
<LI>Input: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I> </LI>
2367
</UL>
2368
<A NAME ="interfaceID3">
2369
<BR><H3><A NAME="getChannelBusInterfaceIDs">getChannelBusInterfaceIDs</A></H3>
2370
Description: List of busInterface IDs in this channel<B>&nbsp;</B>
2371
<UL>
2372
<LI>Returns: <A HREF="#interfaceID4" TITLE="link to another function that returns this type ID"><I>interfaceIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
2373
<LI>Input: <A HREF="#channelID0" TITLE="link to list of functions that return this type ID"><I>channelID</I></A> of type <I>xsd:string</I> </LI>
2374
</UL>
2375
<A NAME ="addressSpaceID1">
2376
<BR><H3><A NAME="getComponentAddressSpaceIDs">getComponentAddressSpaceIDs</A></H3>
2377
Description: List of IDs for the logical address spaces in the component.<B>&nbsp;</B>
2378
<UL>
2379
<LI>Returns: <A HREF="#addressSpaceID2" TITLE="link to another function that returns this type ID"><I>addressSpaceIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
2380
<LI>Input: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I> </LI>
2381
</UL>
2382
<A NAME ="remapStateID2">
2383
<BR><H3><A NAME="getComponentRemapStateIDs">getComponentRemapStateIDs</A></H3>
2384
Description: A list of remap state IDs<B>&nbsp;</B>
2385
<UL>
2386
<LI>Returns: <B><A HREF="#remapStateID0" TITLE="last function the returns this type ID in list"><I>remapStateIDs</I></A></B> of type <I>spirit:soapStringArrayType</I> </LI>
2387
<LI>Input: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I> </LI>
2388
</UL>
2389
<A NAME ="viewID1">
2390
<BR><H3><A NAME="getComponentViewIDs">getComponentViewIDs</A></H3>
2391
Description: A list of model view IDs<B>&nbsp;</B>
2392
<UL>
2393
<LI>Returns: <A HREF="#viewID2" TITLE="link to another function that returns this type ID"><I>viewIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
2394
<LI>Input: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I> </LI>
2395
<LI>Input: <I>configured</I> of type <I>xsd:boolean</I> -- If true returns only the view configured by a designConfiguration or NULL if not configured. If false returns all views.</LI>
2396
</UL>
2397
<A NAME ="interfaceID4">
2398
<BR><H3><A NAME="getComponentBusInterfaceIDs">getComponentBusInterfaceIDs</A></H3>
2399
Description: List of interface IDs<B>&nbsp;</B>
2400
<UL>
2401
<LI>Returns: <B><A HREF="#interfaceID0" TITLE="last function the returns this type ID in list"><I>interfaceIDs</I></A></B> of type <I>spirit:soapStringArrayType</I> </LI>
2402
<LI>Input: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I> </LI>
2403
</UL>
2404
<A NAME ="channelID0">
2405
<BR><H3><A NAME="getComponentChannelIDs">getComponentChannelIDs</A></H3>
2406
Description: A list of channel IDs<B>&nbsp;</B>
2407
<UL>
2408
<LI>Returns: <I>channelIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
2409
<LI>Input: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I> </LI>
2410
</UL>
2411
<A NAME ="portID1">
2412
<BR><H3><A NAME="getComponentPortIDs">getComponentPortIDs</A></H3>
2413
Description: A list of component model port IDs<B>&nbsp;</B>
2414
<UL>
2415
<LI>Returns: <A HREF="#portID2" TITLE="link to another function that returns this type ID"><I>portIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
2416
<LI>Input: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I> </LI>
2417
</UL>
2418
<A NAME ="parameterID1">
2419
<BR><H3><A NAME="getComponentModelParameterIDs">getComponentModelParameterIDs</A></H3>
2420
Description: A list of model parameter IDs<B>&nbsp;</B>
2421
<UL>
2422
<LI>Returns: <A HREF="#parameterID2" TITLE="link to another function that returns this type ID"><I>parameterIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
2423
<LI>Input: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I> </LI>
2424
<LI>Input: <I>usageType</I> of type <I>xsd:string</I> -- Restrict returned parameters to those that match the given usageType. nontyped or typed or userdefined or all if not specified.</LI>
2425
</UL>
2426
<A NAME ="generatorID2">
2427
<BR><H3><A NAME="getComponentGeneratorIDs">getComponentGeneratorIDs</A></H3>
2428
Description: List of generator IDs of the component<B>&nbsp;</B>
2429
<UL>
2430
<LI>Returns: <B><A HREF="#generatorID0" TITLE="last function the returns this type ID in list"><I>generatorIDs</I></A></B> of type <I>spirit:soapStringArrayType</I> </LI>
2431
<LI>Input: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I> </LI>
2432
</UL>
2433
<A NAME ="choiceID1">
2434
<BR><H3><A NAME="getComponentChoiceIDs">getComponentChoiceIDs</A></H3>
2435
Description: List of choices IDs<B>&nbsp;</B>
2436
<UL>
2437
<LI>Returns: <B><A HREF="#choiceID0" TITLE="last function the returns this type ID in list"><I>choiceIDs</I></A></B> of type <I>spirit:soapStringArrayType</I> </LI>
2438
<LI>Input: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I> </LI>
2439
</UL>
2440
<A NAME ="fileSetID2">
2441
<BR><H3><A NAME="getComponentFileSetIDs">getComponentFileSetIDs</A></H3>
2442
Description: List of file set IDs<B>&nbsp;</B>
2443
<UL>
2444
<LI>Returns: <A HREF="#fileSetID3" TITLE="link to another function that returns this type ID"><I>fileSetIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
2445
<LI>Input: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I> </LI>
2446
</UL>
2447
<A NAME ="whiteboxElementID0">
2448
<BR><H3><A NAME="getComponentWhiteboxElementIDs">getComponentWhiteboxElementIDs</A></H3>
2449
Description: List of whitebox element IDs of the component<B>&nbsp;</B>
2450
<UL>
2451
<LI>Returns: <A HREF="#whiteboxElementID1" TITLE="link to another function that returns this type ID"><I>whiteboxElementIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
2452
<LI>Input: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I> </LI>
2453
</UL>
2454
<A NAME ="cpuID0">
2455
<BR><H3><A NAME="getComponentCpuIDs">getComponentCpuIDs</A></H3>
2456
Description: List of cpu IDs of the component<B>&nbsp;</B>
2457
<UL>
2458
<LI>Returns: <I>cpuIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
2459
<LI>Input: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I> </LI>
2460
</UL>
2461
<A NAME ="addressSpaceID2">
2462
<BR><H3><A NAME="getCpuAddressSpaceIDs">getCpuAddressSpaceIDs</A></H3>
2463
Description: List of address space reference IDs of the cpu<B>&nbsp;</B>
2464
<UL>
2465
<LI>Returns: <B><A HREF="#addressSpaceID0" TITLE="last function the returns this type ID in list"><I>addressSpaceIDs</I></A></B> of type <I>spirit:soapStringArrayType</I> </LI>
2466
<LI>Input: <A HREF="#cpuID0" TITLE="link to list of functions that return this type ID"><I>cpuID</I></A> of type <I>xsd:string</I> </LI>
2467
</UL>
2468
<A NAME ="clockDriverID0">
2469
<BR><H3><A NAME="getComponentOtherClockDriverIDs">getComponentOtherClockDriverIDs</A></H3>
2470
Description: List of clock driver IDs of the component<B>&nbsp;</B>
2471
<UL>
2472
<LI>Returns: <A HREF="#clockDriverID1" TITLE="link to another function that returns this type ID"><I>clockDriverIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
2473
<LI>Input: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I> </LI>
2474
</UL>
2475
<A NAME ="memoryMapID1">
2476
<BR><H3><A NAME="getComponentMemoryMapIDs">getComponentMemoryMapIDs</A></H3>
2477
Description: List of IDs for memory map elements in the given component<B>&nbsp;</B>
2478
<UL>
2479
<LI>Returns: <B><A HREF="#memoryMapID0" TITLE="last function the returns this type ID in list"><I>memoryMapIDs</I></A></B> of type <I>spirit:soapStringArrayType</I> </LI>
2480
<LI>Input: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I> </LI>
2481
</UL>
2482
<P>
2483
<table width="100%"><TR><TD bgcolor=#b8b8ff>
2484
<BR><H2>Constraint Operations</H2>
2485
</TD></TR></TABLE>
2486
<A NAME ="value23">
2487
<BR><H3><A NAME="getPortConstraintSetReferenceName">getPortConstraintSetReferenceName</A></H3>
2488
Description: Reference name of the given port constraint set<B>&nbsp;</B>
2489
<UL>
2490
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
2491
<LI>Input: <A HREF="#portConstraintSetID0" TITLE="link to list of functions that return this type ID"><I>portConstraintSetID</I></A> of type <I>xsd:string</I> </LI>
2492
</UL>
2493
<A NAME ="integerArrayValue0">
2494
<BR><H3><A NAME="getPortConstraintSetRange">getPortConstraintSetRange</A></H3>
2495
Description: List of the left and right range of a port referenced by this constraint set<B>&nbsp;</B>
2496
<UL>
2497
<LI>Returns: <I>integerArrayValue</I> of type <I>spirit:integerArrayType</I> </LI>
2498
<LI>Input: <A HREF="#portConstraintSetID0" TITLE="link to list of functions that return this type ID"><I>portConstraintSetID</I></A> of type <I>xsd:string</I> </LI>
2499
</UL>
2500
<A NAME ="driveConstraintID1">
2501
<BR><H3><A NAME="getPortConstraintSetDriveConstraintIDs">getPortConstraintSetDriveConstraintIDs</A></H3>
2502
Description: List of drive constraint IDs of the port<B>&nbsp;</B>
2503
<UL>
2504
<LI>Returns: <B><A HREF="#driveConstraintID0" TITLE="last function the returns this type ID in list"><I>driveConstraintIDs</I></A></B> of type <I>spirit:soapStringArrayType</I> </LI>
2505
<LI>Input: <A HREF="#portConstraintSetID0" TITLE="link to list of functions that return this type ID"><I>portConstraintSetID</I></A> of type <I>xsd:string</I> </LI>
2506
</UL>
2507
<A NAME ="loadConstraintID1">
2508
<BR><H3><A NAME="getPortConstraintSetLoadConstraintIDs">getPortConstraintSetLoadConstraintIDs</A></H3>
2509
Description: List of load constraint IDs of the port<B>&nbsp;</B>
2510
<UL>
2511
<LI>Returns: <B><A HREF="#loadConstraintID0" TITLE="last function the returns this type ID in list"><I>loadConstraintIDs</I></A></B> of type <I>spirit:soapStringArrayType</I> </LI>
2512
<LI>Input: <A HREF="#portConstraintSetID0" TITLE="link to list of functions that return this type ID"><I>portConstraintSetID</I></A> of type <I>xsd:string</I> </LI>
2513
</UL>
2514
<A NAME ="timingConstraintID1">
2515
<BR><H3><A NAME="getPortConstraintSetTimingConstraintIDs">getPortConstraintSetTimingConstraintIDs</A></H3>
2516
Description: List of timing constraint IDs of the port<B>&nbsp;</B>
2517
<UL>
2518
<LI>Returns: <B><A HREF="#timingConstraintID0" TITLE="last function the returns this type ID in list"><I>timingConstraintIDs</I></A></B> of type <I>spirit:soapStringArrayType</I> </LI>
2519
<LI>Input: <A HREF="#portConstraintSetID0" TITLE="link to list of functions that return this type ID"><I>portConstraintSetID</I></A> of type <I>xsd:string</I> </LI>
2520
</UL>
2521
<A NAME ="driveConstraintTypeValue0">
2522
<BR><H3><A NAME="getDriveConstraintType">getDriveConstraintType</A></H3>
2523
Description: Indicates the type of drive constraint: function class<B>&nbsp;</B>
2524
<UL>
2525
<LI>Returns: <I>driveConstraintTypeValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
2526
<LI>Input: <A HREF="#driveConstraintID0" TITLE="link to list of functions that return this type ID"><I>driveConstraintID</I></A> of type <I>xsd:string</I> </LI>
2527
</UL>
2528
<A NAME ="value24">
2529
<BR><H3><A NAME="getDriveConstraintValue">getDriveConstraintValue</A></H3>
2530
Description: Returns the drive constraint. Format depends on the constraint type.<B>&nbsp;</B>
2531
<UL>
2532
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
2533
<LI>Input: <A HREF="#driveConstraintID0" TITLE="link to list of functions that return this type ID"><I>driveConstraintID</I></A> of type <I>xsd:string</I> </LI>
2534
</UL>
2535
<A NAME ="loadConstraintTypeValue0">
2536
<BR><H3><A NAME="getLoadConstraintType">getLoadConstraintType</A></H3>
2537
Description: Indicates the type of load constraint: function class<B>&nbsp;</B>
2538
<UL>
2539
<LI>Returns: <I>loadConstraintTypeValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
2540
<LI>Input: <A HREF="#loadConstraintID0" TITLE="link to list of functions that return this type ID"><I>loadConstraintID</I></A> of type <I>xsd:string</I> </LI>
2541
</UL>
2542
<A NAME ="value25">
2543
<BR><H3><A NAME="getLoadConstraintValue">getLoadConstraintValue</A></H3>
2544
Description: Returns the load constraint. Format is cell function and strength or cell class and strength.<B>&nbsp;</B>
2545
<UL>
2546
<LI>Returns: <I>value</I> of type <I>spirit:soapStringArrayType</I> </LI>
2547
<LI>Input: <A HREF="#loadConstraintID0" TITLE="link to list of functions that return this type ID"><I>loadConstraintID</I></A> of type <I>xsd:string</I> </LI>
2548
</UL>
2549
<A NAME ="value26">
2550
<BR><H3><A NAME="getLoadConstraintCount">getLoadConstraintCount</A></H3>
2551
Description: Returns the load constraint count, the number of loads.<B>&nbsp;</B>
2552
<UL>
2553
<LI>Returns: <I>value</I> of type <I>xsd:integer</I> </LI>
2554
<LI>Input: <A HREF="#loadConstraintID0" TITLE="link to list of functions that return this type ID"><I>loadConstraintID</I></A> of type <I>xsd:string</I> </LI>
2555
</UL>
2556
<A NAME ="clockDetailsValue0">
2557
<BR><H3><A NAME="getTimingConstraintClockDetails">getTimingConstraintClockDetails</A></H3>
2558
Description: Indicates the clock name, clock edge, and delay type<B>&nbsp;</B>
2559
<UL>
2560
<LI>Returns: <I>clockDetailsValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
2561
<LI>Input: <A HREF="#timingConstraintID0" TITLE="link to list of functions that return this type ID"><I>timingConstraintID</I></A> of type <I>xsd:string</I> </LI>
2562
</UL>
2563
<A NAME ="floatValue0">
2564
<BR><H3><A NAME="getTimingConstraintValue">getTimingConstraintValue</A></H3>
2565
Description: Returns the timing constraint value (cycle time percentage).<B>&nbsp;</B>
2566
<UL>
2567
<LI>Returns: <I>floatValue</I> of type <I>xsd:float</I> </LI>
2568
<LI>Input: <A HREF="#timingConstraintID0" TITLE="link to list of functions that return this type ID"><I>timingConstraintID</I></A> of type <I>xsd:string</I> </LI>
2569
</UL>
2570
<P>
2571
<table width="100%"><TR><TD bgcolor=#b8b8ff>
2572
<BR><H2>Design Operations</H2>
2573
</TD></TR></TABLE>
2574
<A NAME ="designID0">
2575
<BR><H3><A NAME="getDesignID">getDesignID</A></H3>
2576
Description: Get ID of the current or top design<B>&nbsp;</B>
2577
<UL>
2578
<LI>Returns: <A HREF="#designID1" TITLE="link to another function that returns this type ID"><I>designID</I></A> of type <I>xsd:string</I> -- The ID of the current design or the top design if the 'top' argument is true.</LI>
2579
<LI>Input: <I>top</I> of type <I>xsd:boolean</I> </LI>
2580
</UL>
2581
<A NAME ="vlnvValue9">
2582
<BR><H3><A NAME="getDesignVLNV">getDesignVLNV</A></H3>
2583
Description: Vendor Library Name Version of the design<B>&nbsp;</B>
2584
<UL>
2585
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
2586
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2587
</UL>
2588
<A NAME ="componentInstanceID0">
2589
<BR><H3><A NAME="getDesignComponentInstanceIDs">getDesignComponentInstanceIDs</A></H3>
2590
Description: Components instances IDs of the given design<B>&nbsp;</B>
2591
<UL>
2592
<LI>Returns: <A HREF="#componentInstanceID1" TITLE="link to another function that returns this type ID"><I>componentInstanceIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
2593
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2594
</UL>
2595
<A NAME ="componentInstanceID1">
2596
<BR><H3><A NAME="getComponentInstanceID">getComponentInstanceID</A></H3>
2597
Description: Return the component instance ID of the named component instance in the given design<B>&nbsp;</B>
2598
<UL>
2599
<LI>Returns: <A HREF="#componentInstanceID2" TITLE="link to another function that returns this type ID"><I>componentInstanceID</I></A> of type <I>xsd:string</I> </LI>
2600
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2601
<LI>Input: <I>instanceName</I> of type <I>xsd:string</I> </LI>
2602
</UL>
2603
<A NAME ="interconnectionID0">
2604
<BR><H3><A NAME="getDesignInterconnectionIDs">getDesignInterconnectionIDs</A></H3>
2605
Description: List of interconnection element IDs<B>&nbsp;</B>
2606
<UL>
2607
<LI>Returns: <A HREF="#interconnectionID1" TITLE="link to another function that returns this type ID"><I>interconnectionIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
2608
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2609
</UL>
2610
<A NAME ="activeInterfaceValue0">
2611
<BR><H3><A NAME="getInterconnectionActiveInterfaces">getInterconnectionActiveInterfaces</A></H3>
2612
Description: Returns the active interfaces as a list: componentRef interfaceRef componentRef interfaceRef<B>- Modified in 1.5</B>
2613
<UL>
2614
<LI>Returns: <I>activeInterfaceValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
2615
<LI>Input: <A HREF="#interconnectionID0" TITLE="link to list of functions that return this type ID"><I>interconnectionID</I></A> of type <I>xsd:string</I> </LI>
2616
</UL>
2617
<A NAME ="abstractorInstanceID0">
2618
<BR><H3><A NAME="getDesignInterconnectionAbstractorInstanceIDs">getDesignInterconnectionAbstractorInstanceIDs</A></H3>
2619
Description: List of abstractor instances IDs for this interconnection<B>&nbsp;</B>
2620
<UL>
2621
<LI>Returns: <A HREF="#abstractorInstanceID1" TITLE="link to another function that returns this type ID"><I>abstractorInstanceIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
2622
<LI>Input: <I>interconnectName</I> of type <I>xsd:string</I> </LI>
2623
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2624
</UL>
2625
<A NAME ="monitorInterconnectionID0">
2626
<BR><H3><A NAME="getDesignMonitorInterconnectionIDs">getDesignMonitorInterconnectionIDs</A></H3>
2627
Description: List of monitorInterconnection element IDs<B>&nbsp;</B>
2628
<UL>
2629
<LI>Returns: <I>monitorInterconnectionIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
2630
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2631
</UL>
2632
<A NAME ="interconnectInterfaceValue0">
2633
<BR><H3><A NAME="getMonitorInterconnectionInterfaces">getMonitorInterconnectionInterfaces</A></H3>
2634
Description: Returns the active interface and monitor interfaces as a list in componentPathRef, componentRef, componentInterface, monitorPathRef, monitorRef, monitorInterface format, the active interface comes first in the list.<B>- Modified in 1.5</B>
2635
<UL>
2636
<LI>Returns: <I>interconnectInterfaceValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
2637
<LI>Input: <A HREF="#monitorInterconnectionID0" TITLE="link to list of functions that return this type ID"><I>monitorInterconnectionID</I></A> of type <I>xsd:string</I> </LI>
2638
</UL>
2639
<A NAME ="adHocConnectionID0">
2640
<BR><H3><A NAME="getDesignAdHocConnectionIDs">getDesignAdHocConnectionIDs</A></H3>
2641
Description: List of ad-hoc connection element IDs<B>&nbsp;</B>
2642
<UL>
2643
<LI>Returns: <A HREF="#adHocConnectionID1" TITLE="link to another function that returns this type ID"><I>adHocConnectionIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
2644
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2645
</UL>
2646
<A NAME ="value27">
2647
<BR><H3><A NAME="getAdHocConnectionTiedValue">getAdHocConnectionTiedValue</A></H3>
2648
Description: Get the tied value for an ad-hoc connection<B>&nbsp;</B>
2649
<UL>
2650
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
2651
<LI>Input: <A HREF="#adHocConnectionID0" TITLE="link to list of functions that return this type ID"><I>adHocConnectionID</I></A> of type <I>xsd:string</I> </LI>
2652
</UL>
2653
<A NAME ="adHocInternalPortReferenceID0">
2654
<BR><H3><A NAME="getAdHocConnectionInternalPortReferenceIDs">getAdHocConnectionInternalPortReferenceIDs</A></H3>
2655
Description: List of internal ad-hoc port reference element IDs<B>&nbsp;</B>
2656
<UL>
2657
<LI>Returns: <A HREF="#adHocInternalPortReferenceID1" TITLE="link to another function that returns this type ID"><I>adHocInternalPortReferenceIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
2658
<LI>Input: <A HREF="#adHocConnectionID0" TITLE="link to list of functions that return this type ID"><I>adHocConnectionID</I></A> of type <I>xsd:string</I> </LI>
2659
</UL>
2660
<A NAME ="details0">
2661
<BR><H3><A NAME="getAdHocConnectionInternalPortReferenceDetails">getAdHocConnectionInternalPortReferenceDetails</A></H3>
2662
Description: List for an internal connection containing the componentRef, portRef, left, and right attribute values<B>&nbsp;</B>
2663
<UL>
2664
<LI>Returns: <I>details</I> of type <I>spirit:soapStringArrayType</I> </LI>
2665
<LI>Input: <A HREF="#adHocInternalPortReferenceID0" TITLE="link to list of functions that return this type ID"><I>adHocInternalPortReferenceID</I></A> of type <I>xsd:string</I> </LI>
2666
</UL>
2667
<A NAME ="adHocExternalPortReferenceID0">
2668
<BR><H3><A NAME="getAdHocConnectionExternalPortReferenceIDs">getAdHocConnectionExternalPortReferenceIDs</A></H3>
2669
Description: List of external ad-hoc port reference element IDs<B>&nbsp;</B>
2670
<UL>
2671
<LI>Returns: <A HREF="#adHocExternalPortReferenceID1" TITLE="link to another function that returns this type ID"><I>adHocExternalPortReferenceIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
2672
<LI>Input: <A HREF="#adHocConnectionID0" TITLE="link to list of functions that return this type ID"><I>adHocConnectionID</I></A> of type <I>xsd:string</I> </LI>
2673
</UL>
2674
<A NAME ="details1">
2675
<BR><H3><A NAME="getAdHocConnectionExternalPortDetails">getAdHocConnectionExternalPortDetails</A></H3>
2676
Description: List for an external connection containing the portRef, left, and right attribute values<B>&nbsp;</B>
2677
<UL>
2678
<LI>Returns: <I>details</I> of type <I>spirit:soapStringArrayType</I> </LI>
2679
<LI>Input: <A HREF="#adHocExternalPortReferenceID0" TITLE="link to list of functions that return this type ID"><I>adHocExternalPortReferenceID</I></A> of type <I>xsd:string</I> </LI>
2680
</UL>
2681
<A NAME ="hierConnectionID0">
2682
<BR><H3><A NAME="getDesignHierConnectionIDs">getDesignHierConnectionIDs</A></H3>
2683
Description: List of hierarchical connection element IDs<B>&nbsp;</B>
2684
<UL>
2685
<LI>Returns: <A HREF="#hierConnectionID1" TITLE="link to another function that returns this type ID"><I>hierConnectionIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
2686
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2687
</UL>
2688
<A NAME ="values0">
2689
<BR><H3><A NAME="getHierConnectionDetails">getHierConnectionDetails</A></H3>
2690
Description: List containing the interface name, component reference, and interface reference<B>&nbsp;</B>
2691
<UL>
2692
<LI>Returns: <I>values</I> of type <I>spirit:soapStringArrayType</I> </LI>
2693
<LI>Input: <A HREF="#hierConnectionID0" TITLE="link to list of functions that return this type ID"><I>hierConnectionID</I></A> of type <I>xsd:string</I> </LI>
2694
</UL>
2695
<A NAME ="componentInstanceID2">
2696
<BR><H3><A NAME="addComponentInstance">addComponentInstance</A></H3>
2697
Description: Add new component instance.<B>&nbsp;</B>
2698
<UL>
2699
<LI>Returns: <A HREF="#componentInstanceID3" TITLE="link to another function that returns this type ID"><I>componentInstanceID</I></A> of type <I>xsd:string</I> -- Element ID of the newly added component instance.</LI>
2700
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2701
<LI>Input: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
2702
<LI>Input: <I>instanceName</I> of type <I>xsd:string</I> </LI>
2703
<LI>Input: <I>displayName</I> of type <I>xsd:string</I> </LI>
2704
<LI>Input: <I>description</I> of type <I>xsd:string</I> </LI>
2705
</UL>
2706
<A NAME ="status18">
2707
<BR><H3><A NAME="removeComponentInstance">removeComponentInstance</A></H3>
2708
Description: Remove specified component instance.<B>&nbsp;</B>
2709
<UL>
2710
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
2711
<LI>Input: <A HREF="#componentInstanceID0" TITLE="link to list of functions that return this type ID"><I>componentInstanceID</I></A> of type <I>xsd:string</I> </LI>
2712
</UL>
2713
<A NAME ="status19">
2714
<BR><H3><A NAME="replaceComponentInstance">replaceComponentInstance</A></H3>
2715
Description: Replace specified component with new provided component.<B>&nbsp;</B>
2716
<UL>
2717
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
2718
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2719
<LI>Input: <A HREF="#componentInstanceID0" TITLE="link to list of functions that return this type ID"><I>componentInstanceID</I></A> of type <I>xsd:string</I> </LI>
2720
<LI>Input: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
2721
</UL>
2722
<A NAME ="abstractorInstanceID1">
2723
<BR><H3><A NAME="appendAbstractorInstance">appendAbstractorInstance</A></H3>
2724
Description: Append a new abstractor instance to the interconnection.<B>&nbsp;</B>
2725
<UL>
2726
<LI>Returns: <B><A HREF="#abstractorInstanceID0" TITLE="last function the returns this type ID in list"><I>abstractorInstanceID</I></A></B> of type <I>xsd:string</I> -- Element ID of the newly added abstractor instance.</LI>
2727
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2728
<LI>Input: <A HREF="#interconnectionID0" TITLE="link to list of functions that return this type ID"><I>interconnectionID</I></A> of type <I>xsd:string</I> </LI>
2729
<LI>Input: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
2730
<LI>Input: <I>instanceName</I> of type <I>xsd:string</I> </LI>
2731
<LI>Input: <I>displayName</I> of type <I>xsd:string</I> </LI>
2732
<LI>Input: <I>description</I> of type <I>xsd:string</I> </LI>
2733
</UL>
2734
<A NAME ="status20">
2735
<BR><H3><A NAME="removeAbstractorInstance">removeAbstractorInstance</A></H3>
2736
Description: Remove specified abstractor instance.<B>&nbsp;</B>
2737
<UL>
2738
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
2739
<LI>Input: <A HREF="#abstractorInstanceID0" TITLE="link to list of functions that return this type ID"><I>abstractorInstanceID</I></A> of type <I>xsd:string</I> </LI>
2740
</UL>
2741
<A NAME ="status21">
2742
<BR><H3><A NAME="replaceAbstractorInstance">replaceAbstractorInstance</A></H3>
2743
Description: Replace specified abstractor with new provided abstractor.<B>&nbsp;</B>
2744
<UL>
2745
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
2746
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2747
<LI>Input: <A HREF="#abstractorInstanceID0" TITLE="link to list of functions that return this type ID"><I>abstractorInstanceID</I></A> of type <I>xsd:string</I> </LI>
2748
<LI>Input: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
2749
</UL>
2750
<A NAME ="interconnectionID1">
2751
<BR><H3><A NAME="addInterconnection">addInterconnection</A></H3>
2752
Description: Add new interconnection between components.<B>&nbsp;</B>
2753
<UL>
2754
<LI>Returns: <A HREF="#interconnectionID2" TITLE="link to another function that returns this type ID"><I>interconnectionID</I></A> of type <I>xsd:string</I> -- Element ID of the newly added interconnection.</LI>
2755
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2756
<LI>Input: <I>component1Ref</I> of type <I>xsd:string</I> -- The component instance name.</LI>
2757
<LI>Input: <I>interface1Ref</I> of type <I>xsd:string</I> </LI>
2758
<LI>Input: <I>component2Ref</I> of type <I>xsd:string</I> -- The component instance name.</LI>
2759
<LI>Input: <I>interface2Ref</I> of type <I>xsd:string</I> </LI>
2760
<LI>Input: <I>name</I> of type <I>xsd:string</I> </LI>
2761
<LI>Input: <I>displayName</I> of type <I>xsd:string</I> </LI>
2762
<LI>Input: <I>description</I> of type <I>xsd:string</I> </LI>
2763
</UL>
2764
<A NAME ="status22">
2765
<BR><H3><A NAME="removeInterconnection">removeInterconnection</A></H3>
2766
Description: Remove interconnection between components, and any abstractors if present.<B>&nbsp;</B>
2767
<UL>
2768
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
2769
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2770
<LI>Input: <I>component1Ref</I> of type <I>xsd:string</I> -- The component instance name.</LI>
2771
<LI>Input: <I>interface1Ref</I> of type <I>xsd:string</I> </LI>
2772
<LI>Input: <I>component2Ref</I> of type <I>xsd:string</I> -- The component instance name.</LI>
2773
<LI>Input: <I>interface2Ref</I> of type <I>xsd:string</I> </LI>
2774
</UL>
2775
<A NAME ="interconnectionID2">
2776
<BR><H3><A NAME="addMonitorInterconnection">addMonitorInterconnection</A></H3>
2777
Description: Add new interconnection between a component and monitor. If there is already a monitorInterconnection for the given componentRef/componentInterfaceRef, then the monitor connection is added to that element.<B>&nbsp;</B>
2778
<UL>
2779
<LI>Returns: <A HREF="#interconnectionID3" TITLE="link to another function that returns this type ID"><I>interconnectionID</I></A> of type <I>xsd:string</I> -- Element ID of the new/modified monitor interconnection.</LI>
2780
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> -- The design that contains the interconnection.</LI>
2781
<LI>Input: <I>componentRef</I> of type <I>xsd:string</I> -- The component instance name.</LI>
2782
<LI>Input: <I>componentInterfaceRef</I> of type <I>xsd:string</I> </LI>
2783
<LI>Input: <I>monitorRef</I> of type <I>xsd:string</I> -- The component instance name with the monitor interface.</LI>
2784
<LI>Input: <I>monitorInterfaceRef</I> of type <I>xsd:string</I> </LI>
2785
<LI>Input: <I>name</I> of type <I>xsd:string</I> </LI>
2786
<LI>Input: <I>displayName</I> of type <I>xsd:string</I> </LI>
2787
<LI>Input: <I>description</I> of type <I>xsd:string</I> </LI>
2788
</UL>
2789
<A NAME ="interconnectionID3">
2790
<BR><H3><A NAME="addHierarchicalMonitorInterconnection">addHierarchicalMonitorInterconnection</A></H3>
2791
Description: Add new hierarchical interconnection between a component and monitor. If there is already a monitorInterconnection for the given componentRef/componentInterfaceRef, then the monitor connection is added to that element.<B>- New in 1.5</B>
2792
<UL>
2793
<LI>Returns: <B><A HREF="#interconnectionID0" TITLE="last function the returns this type ID in list"><I>interconnectionID</I></A></B> of type <I>xsd:string</I> -- Element ID of the new/modified monitor interconnection.</LI>
2794
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> -- The design that contains the interconnection.</LI>
2795
<LI>Input: <I>componentPath</I> of type <I>xsd:string</I> -- The instance name path to the design that contains the component instance.</LI>
2796
<LI>Input: <I>componentRef</I> of type <I>xsd:string</I> -- The component instance name.</LI>
2797
<LI>Input: <I>componentInterfaceRef</I> of type <I>xsd:string</I> </LI>
2798
<LI>Input: <I>monitorPath</I> of type <I>xsd:string</I> -- The instance name path to the design that contains the monitor instance.</LI>
2799
<LI>Input: <I>monitorRef</I> of type <I>xsd:string</I> -- The component instance name with the monitor interface.</LI>
2800
<LI>Input: <I>monitorInterfaceRef</I> of type <I>xsd:string</I> </LI>
2801
<LI>Input: <I>name</I> of type <I>xsd:string</I> </LI>
2802
<LI>Input: <I>displayName</I> of type <I>xsd:string</I> </LI>
2803
<LI>Input: <I>description</I> of type <I>xsd:string</I> </LI>
2804
</UL>
2805
<A NAME ="status23">
2806
<BR><H3><A NAME="removeMonitorInterconnection">removeMonitorInterconnection</A></H3>
2807
Description: Remove interconnection between a component and monitor. When the last monitor reference is removed, the entire monitorInterconnection element will be removed.<B>&nbsp;</B>
2808
<UL>
2809
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
2810
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2811
<LI>Input: <I>componentRef</I> of type <I>xsd:string</I> -- The component instance name.</LI>
2812
<LI>Input: <I>componentInterfaceRef</I> of type <I>xsd:string</I> </LI>
2813
<LI>Input: <I>monitorRef</I> of type <I>xsd:string</I> -- The component instance name with the monitor interface.</LI>
2814
<LI>Input: <I>monitorInterfaceRef</I> of type <I>xsd:string</I> </LI>
2815
</UL>
2816
<A NAME ="status24">
2817
<BR><H3><A NAME="removeHierarchicalMonitorInterconnection">removeHierarchicalMonitorInterconnection</A></H3>
2818
Description: Remove a hierarchical interconnection between a component and monitor. When the last monitor reference is removed, the entire monitorInterconnection element will be removed.<B>- New in 1.5</B>
2819
<UL>
2820
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
2821
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2822
<LI>Input: <I>componentPath</I> of type <I>xsd:string</I> -- The instance name path to the design that contains the component instance.</LI>
2823
<LI>Input: <I>componentRef</I> of type <I>xsd:string</I> -- The component instance name.</LI>
2824
<LI>Input: <I>componentInterfaceRef</I> of type <I>xsd:string</I> </LI>
2825
<LI>Input: <I>monitorPath</I> of type <I>xsd:string</I> -- The instance name path to the design that contains the monitor instance.</LI>
2826
<LI>Input: <I>monitorRef</I> of type <I>xsd:string</I> -- The component instance name with the monitor interface.</LI>
2827
<LI>Input: <I>monitorInterfaceRef</I> of type <I>xsd:string</I> </LI>
2828
</UL>
2829
<A NAME ="hierConnectionID1">
2830
<BR><H3><A NAME="addHierConnection">addHierConnection</A></H3>
2831
Description: Add new hierarchical connection.<B>&nbsp;</B>
2832
<UL>
2833
<LI>Returns: <B><A HREF="#hierConnectionID0" TITLE="last function the returns this type ID in list"><I>hierConnectionID</I></A></B> of type <I>xsd:string</I> -- Element ID of the newly added hierarchical connection.</LI>
2834
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2835
<LI>Input: <I>interfaceRef</I> of type <I>xsd:string</I> </LI>
2836
<LI>Input: <I>componentRef</I> of type <I>xsd:string</I> </LI>
2837
<LI>Input: <I>busRef</I> of type <I>xsd:string</I> </LI>
2838
</UL>
2839
<A NAME ="status25">
2840
<BR><H3><A NAME="removeHierConnection">removeHierConnection</A></H3>
2841
Description: Remove existing hierarchical connection.<B>&nbsp;</B>
2842
<UL>
2843
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
2844
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2845
<LI>Input: <I>componentRef</I> of type <I>xsd:string</I> </LI>
2846
<LI>Input: <I>busRef</I> of type <I>xsd:string</I> </LI>
2847
</UL>
2848
<A NAME ="adHocConnectionID1">
2849
<BR><H3><A NAME="addAdHocConnection">addAdHocConnection</A></H3>
2850
Description: Add new ad-hoc connection.<B>&nbsp;</B>
2851
<UL>
2852
<LI>Returns: <B><A HREF="#adHocConnectionID0" TITLE="last function the returns this type ID in list"><I>adHocConnectionID</I></A></B> of type <I>xsd:string</I> -- Element ID of the newly added ad hoc connection.</LI>
2853
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2854
<LI>Input: <I>name</I> of type <I>xsd:string</I> </LI>
2855
<LI>Input: <I>displayName</I> of type <I>xsd:string</I> </LI>
2856
<LI>Input: <I>description</I> of type <I>xsd:string</I> </LI>
2857
<LI>Input: <I>componentRef</I> of type <I>xsd:string</I> </LI>
2858
<LI>Input: <I>portRef</I> of type <I>xsd:string</I> </LI>
2859
<LI>Input: <I>left</I> of type <I>xsd:string</I> </LI>
2860
<LI>Input: <I>right</I> of type <I>xsd:string</I> </LI>
2861
<LI>Input: <I>tiedValue</I> of type <I>spirit:spiritNumberType</I> -- Tied value for this connection, if blank no tied value.</LI>
2862
</UL>
2863
<A NAME ="adHocInternalPortReferenceID1">
2864
<BR><H3><A NAME="addAdHocInternalPortReference">addAdHocInternalPortReference</A></H3>
2865
Description: Add an internal port reference to an existing ad-hoc connection. An identical port reference must not already exist in the ad-hoc connection.<B>&nbsp;</B>
2866
<UL>
2867
<LI>Returns: <B><A HREF="#adHocInternalPortReferenceID0" TITLE="last function the returns this type ID in list"><I>adHocInternalPortReferenceID</I></A></B> of type <I>xsd:string</I> -- Element ID of the newly added internal port reference.</LI>
2868
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2869
<LI>Input: <A HREF="#adHocConnectionID0" TITLE="link to list of functions that return this type ID"><I>adHocConnectionID</I></A> of type <I>xsd:string</I> </LI>
2870
<LI>Input: <I>componentRef</I> of type <I>xsd:string</I> </LI>
2871
<LI>Input: <I>portRef</I> of type <I>xsd:string</I> </LI>
2872
<LI>Input: <I>left</I> of type <I>xsd:string</I> </LI>
2873
<LI>Input: <I>right</I> of type <I>xsd:string</I> </LI>
2874
</UL>
2875
<A NAME ="adHocExternalPortReferenceID1">
2876
<BR><H3><A NAME="addAdHocExternalPortReference">addAdHocExternalPortReference</A></H3>
2877
Description: Add an external port reference to an existing ad-hoc connection.<B>&nbsp;</B>
2878
<UL>
2879
<LI>Returns: <B><A HREF="#adHocExternalPortReferenceID0" TITLE="last function the returns this type ID in list"><I>adHocExternalPortReferenceID</I></A></B> of type <I>xsd:string</I> -- Element ID of the newly added external port reference.</LI>
2880
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2881
<LI>Input: <A HREF="#adHocConnectionID0" TITLE="link to list of functions that return this type ID"><I>adHocConnectionID</I></A> of type <I>xsd:string</I> </LI>
2882
<LI>Input: <I>portRef</I> of type <I>xsd:string</I> </LI>
2883
<LI>Input: <I>left</I> of type <I>xsd:string</I> </LI>
2884
<LI>Input: <I>right</I> of type <I>xsd:string</I> </LI>
2885
</UL>
2886
<A NAME ="status26">
2887
<BR><H3><A NAME="removeAdHocInternalPortReference">removeAdHocInternalPortReference</A></H3>
2888
Description: Remove an internal port from existing ad-hoc connection. The ad-hoc connection is removed when the last port reference is removed.<B>&nbsp;</B>
2889
<UL>
2890
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
2891
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2892
<LI>Input: <A HREF="#adHocConnectionID0" TITLE="link to list of functions that return this type ID"><I>adHocConnectionID</I></A> of type <I>xsd:string</I> </LI>
2893
<LI>Input: <I>componentRef</I> of type <I>xsd:string</I> </LI>
2894
<LI>Input: <I>portRef</I> of type <I>xsd:string</I> </LI>
2895
</UL>
2896
<A NAME ="status27">
2897
<BR><H3><A NAME="removeAdHocExternalPortReference">removeAdHocExternalPortReference</A></H3>
2898
Description: Remove an external port reference from existing ad-hoc connection.<B>&nbsp;</B>
2899
<UL>
2900
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
2901
<LI>Input: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I> </LI>
2902
<LI>Input: <A HREF="#adHocConnectionID0" TITLE="link to list of functions that return this type ID"><I>adHocConnectionID</I></A> of type <I>xsd:string</I> </LI>
2903
<LI>Input: <I>portRef</I> of type <I>xsd:string</I> </LI>
2904
</UL>
2905
<P>
2906
<table width="100%"><TR><TD bgcolor=#b8b8ff>
2907
<BR><H2>Field Operations</H2>
2908
</TD></TR></TABLE>
2909
<A NAME ="value28">
2910
<BR><H3><A NAME="getRegisterFieldBitOffset">getRegisterFieldBitOffset</A></H3>
2911
Description: Bit offset of the fields LSB inside the register.<B>&nbsp;</B>
2912
<UL>
2913
<LI>Returns: <I>value</I> of type <I>xsd:integer</I> </LI>
2914
<LI>Input: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I> </LI>
2915
</UL>
2916
<A NAME ="width2">
2917
<BR><H3><A NAME="getRegisterFieldBitWidth">getRegisterFieldBitWidth</A></H3>
2918
Description: Width of the field in bits.<B>&nbsp;</B>
2919
<UL>
2920
<LI>Returns: <I>width</I> of type <I>xsd:positiveInteger</I> </LI>
2921
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
2922
<UL>
2923
<LI>Legal value: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I></LI>
2924
<LI>Legal value: <A HREF="#regFieldUID0" TITLE="link to list of functions that return this type ID"><I>regFieldUID</I></A> of type <I>xsd:string</I></LI>
2925
</UL>
2926
</UL>
2927
<A NAME ="status28">
2928
<BR><H3><A NAME="setRegisterFieldBitWidth">setRegisterFieldBitWidth</A></H3>
2929
Description: Set the width of the field in bits.<B>&nbsp;</B>
2930
<UL>
2931
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
2932
<LI>Input: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I> </LI>
2933
<LI>Input: <I>width</I> of type <I>xsd:positiveInteger</I> </LI>
2934
</UL>
2935
<A NAME ="value29">
2936
<BR><H3><A NAME="getRegisterFieldVolatility">getRegisterFieldVolatility</A></H3>
2937
Description: Indicates whether or not the data is volatile. The presumed value is 'false' if the element is not present.<B>- Modified in 1.5</B>
2938
<UL>
2939
<LI>Returns: <I>value</I> of type <I>xsd:string</I> -- returns "true" or "false"</LI>
2940
<LI>Input: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I> </LI>
2941
</UL>
2942
<A NAME ="value30">
2943
<BR><H3><A NAME="getRegisterFieldAccess">getRegisterFieldAccess</A></H3>
2944
Description: The accessibility of the data in the field.<B>&nbsp;</B>
2945
<UL>
2946
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
2947
<LI>Input: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I> </LI>
2948
</UL>
2949
<A NAME ="regFieldValueID0">
2950
<BR><H3><A NAME="getRegisterFieldValueIDs">getRegisterFieldValueIDs</A></H3>
2951
Description: List of IDs for field values for the given register field.<B>&nbsp;</B>
2952
<UL>
2953
<LI>Returns: <I>regFieldValueIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
2954
<LI>Input: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I> </LI>
2955
</UL>
2956
<A NAME ="usage2">
2957
<BR><H3><A NAME="getRegisterFieldValueUsage">getRegisterFieldValueUsage</A></H3>
2958
Description: Enumerated bit field usage.<B>- New in 1.5</B>
2959
<UL>
2960
<LI>Returns: <I>usage</I> of type <I>xsd:string</I> </LI>
2961
<LI>Input: <A HREF="#regFieldValueID0" TITLE="link to list of functions that return this type ID"><I>regFieldValueID</I></A> of type <I>xsd:string</I> </LI>
2962
</UL>
2963
<A NAME ="value31">
2964
<BR><H3><A NAME="getRegisterFieldValue">getRegisterFieldValue</A></H3>
2965
Description: Enumerated bit field value.<B>&nbsp;</B>
2966
<UL>
2967
<LI>Returns: <I>value</I> of type <I>spirit:spiritNumberType</I> </LI>
2968
<LI>Input: <A HREF="#regFieldValueID0" TITLE="link to list of functions that return this type ID"><I>regFieldValueID</I></A> of type <I>xsd:string</I> </LI>
2969
</UL>
2970
<A NAME ="value32">
2971
<BR><H3><A NAME="getRegisterFieldValueName">getRegisterFieldValueName</A></H3>
2972
Description: Enumerated name for this register field value. Deprecated - use getName.<B>&nbsp;</B>
2973
<UL>
2974
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
2975
<LI>Input: <A HREF="#regFieldValueID0" TITLE="link to list of functions that return this type ID"><I>regFieldValueID</I></A> of type <I>xsd:string</I> </LI>
2976
</UL>
2977
<A NAME ="type1">
2978
<BR><H3><A NAME="getRegisterFieldModifiedWriteValue">getRegisterFieldModifiedWriteValue</A></H3>
2979
Description: The modified write value for the field<B>- New in 1.5</B>
2980
<UL>
2981
<LI>Returns: <I>type</I> of type <I>xsd:string</I> -- one of "", "onetoClear", "oneToSet", "oneToToggle", "zeroToClear", "zeroToSet","zeroToToggle", "clear", "set" or "modified"</LI>
2982
<LI>Input: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I> </LI>
2983
</UL>
2984
<A NAME ="boolean0">
2985
<BR><H3><A NAME="getRegisterFieldWriteValueConstraintWriteAsRead">getRegisterFieldWriteValueConstraintWriteAsRead</A></H3>
2986
Description: The write value constraint is write as read.<B>- New in 1.5</B>
2987
<UL>
2988
<LI>Returns: <I>boolean</I> of type <I>xsd:boolean</I> </LI>
2989
<LI>Input: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I> </LI>
2990
</UL>
2991
<A NAME ="boolean1">
2992
<BR><H3><A NAME="getRegisterFieldWriteValueConstraintUseEnumeratedValues">getRegisterFieldWriteValueConstraintUseEnumeratedValues</A></H3>
2993
Description: The write value constraint shall use the enumerated values.<B>- New in 1.5</B>
2994
<UL>
2995
<LI>Returns: <I>boolean</I> of type <I>xsd:boolean</I> </LI>
2996
<LI>Input: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I> </LI>
2997
</UL>
2998
<A NAME ="integerArrayValue1">
2999
<BR><H3><A NAME="getRegisterFieldWriteValueConstraintMinMax">getRegisterFieldWriteValueConstraintMinMax</A></H3>
3000
Description: The value of a write constraint.<B>- New in 1.5</B>
3001
<UL>
3002
<LI>Returns: <I>integerArrayValue</I> of type <I>spirit:integerArrayType</I> -- array of minimum and maximum or zero element array if not specified</LI>
3003
<LI>Input: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I> </LI>
3004
</UL>
3005
<A NAME ="type2">
3006
<BR><H3><A NAME="getRegisterFieldReadAction">getRegisterFieldReadAction</A></H3>
3007
Description: The read action for the field<B>- New in 1.5</B>
3008
<UL>
3009
<LI>Returns: <I>type</I> of type <I>xsd:string</I> -- one of "", "clear", "set" or "modify"</LI>
3010
<LI>Input: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I> </LI>
3011
</UL>
3012
<A NAME ="booleanValue10">
3013
<BR><H3><A NAME="getRegisterFieldTestable">getRegisterFieldTestable</A></H3>
3014
Description: True if the field can be tested with a simple register test.<B>- New in 1.5</B>
3015
<UL>
3016
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
3017
<LI>Input: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I> </LI>
3018
</UL>
3019
<A NAME ="value33">
3020
<BR><H3><A NAME="getRegisterFieldTestConstraint">getRegisterFieldTestConstraint</A></H3>
3021
Description: The test constraint required if the field can be tested with a simple register test.<B>- New in 1.5</B>
3022
<UL>
3023
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3024
<LI>Input: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I> </LI>
3025
</UL>
3026
<P>
3027
<table width="100%"><TR><TD bgcolor=#b8b8ff>
3028
<BR><H2>File and Fileset Operations</H2>
3029
</TD></TR></TABLE>
3030
<A NAME ="value34">
3031
<BR><H3><A NAME="getFileSetGroupName">getFileSetGroupName</A></H3>
3032
Description: Name of file set group<B>&nbsp;</B>
3033
<UL>
3034
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3035
<LI>Input: <A HREF="#fileSetGroupID0" TITLE="link to list of functions that return this type ID"><I>fileSetGroupID</I></A> of type <I>xsd:string</I> </LI>
3036
</UL>
3037
<A NAME ="fileSetID3">
3038
<BR><H3><A NAME="getFileSetGroupFileSetIDs">getFileSetGroupFileSetIDs</A></H3>
3039
Description: List of file set IDs in this file set group<B>&nbsp;</B>
3040
<UL>
3041
<LI>Returns: <A HREF="#fileSetID4" TITLE="link to another function that returns this type ID"><I>fileSetIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
3042
<LI>Input: <A HREF="#fileSetGroupID0" TITLE="link to list of functions that return this type ID"><I>fileSetGroupID</I></A> of type <I>xsd:string</I> </LI>
3043
</UL>
3044
<A NAME ="name0">
3045
<BR><H3><A NAME="getFileName">getFileName</A></H3>
3046
Description: Get name of the given fileID.<B>&nbsp;</B>
3047
<UL>
3048
<LI>Returns: <I>name</I> of type <I>xsd:string</I> </LI>
3049
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3050
<UL>
3051
<LI>Legal value: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I></LI>
3052
<LI>Legal value: <A HREF="#fileUID0" TITLE="link to list of functions that return this type ID"><I>fileUID</I></A> of type <I>xsd:string</I></LI>
3053
</UL>
3054
<LI>Input: <I>resolve</I> of type <I>xsd:boolean</I> -- True=DE shall return an absolute file path, False=actual XML text returned</LI>
3055
</UL>
3056
<A NAME ="value35">
3057
<BR><H3><A NAME="getFileBuilderFileType">getFileBuilderFileType</A></H3>
3058
Description: FileType or userFileType of the file builder<B>&nbsp;</B>
3059
<UL>
3060
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3061
<LI>Input: <A HREF="#fileBuilderID0" TITLE="link to list of functions that return this type ID"><I>fileBuilderID</I></A> of type <I>xsd:string</I> </LI>
3062
</UL>
3063
<A NAME ="value36">
3064
<BR><H3><A NAME="getFileBuilderCommand">getFileBuilderCommand</A></H3>
3065
Description: Command of the file builder<B>&nbsp;</B>
3066
<UL>
3067
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3068
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3069
<UL>
3070
<LI>Legal value: <A HREF="#fileBuilderID0" TITLE="link to list of functions that return this type ID"><I>fileBuilderID</I></A> of type <I>xsd:string</I></LI>
3071
<LI>Legal value: <A HREF="#fileBuilderUID0" TITLE="link to list of functions that return this type ID"><I>fileBuilderUID</I></A> of type <I>xsd:string</I></LI>
3072
</UL>
3073
</UL>
3074
<A NAME ="value37">
3075
<BR><H3><A NAME="getFileBuilderFlags">getFileBuilderFlags</A></H3>
3076
Description: Flags of the file builder<B>&nbsp;</B>
3077
<UL>
3078
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3079
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3080
<UL>
3081
<LI>Legal value: <A HREF="#fileBuilderID0" TITLE="link to list of functions that return this type ID"><I>fileBuilderID</I></A> of type <I>xsd:string</I></LI>
3082
<LI>Legal value: <A HREF="#fileBuilderUID0" TITLE="link to list of functions that return this type ID"><I>fileBuilderUID</I></A> of type <I>xsd:string</I></LI>
3083
</UL>
3084
</UL>
3085
<A NAME ="booleanValue11">
3086
<BR><H3><A NAME="getFileBuilderReplaceDefaultFlags">getFileBuilderReplaceDefaultFlags</A></H3>
3087
Description: Value of the replaceDefaultFlags element of the file builder<B>&nbsp;</B>
3088
<UL>
3089
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
3090
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3091
<UL>
3092
<LI>Legal value: <A HREF="#fileBuilderID0" TITLE="link to list of functions that return this type ID"><I>fileBuilderID</I></A> of type <I>xsd:string</I></LI>
3093
<LI>Legal value: <A HREF="#fileBuilderUID0" TITLE="link to list of functions that return this type ID"><I>fileBuilderUID</I></A> of type <I>xsd:string</I></LI>
3094
</UL>
3095
</UL>
3096
<A NAME ="fileSetGroupsValue0">
3097
<BR><H3><A NAME="getFileSetGroups">getFileSetGroups</A></H3>
3098
Description: List of group names of the file set<B>&nbsp;</B>
3099
<UL>
3100
<LI>Returns: <I>fileSetGroupsValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
3101
<LI>Input: <A HREF="#fileSetID0" TITLE="link to list of functions that return this type ID"><I>fileSetID</I></A> of type <I>xsd:string</I> </LI>
3102
</UL>
3103
<A NAME ="fileID0">
3104
<BR><H3><A NAME="getFileSetFileIDs">getFileSetFileIDs</A></H3>
3105
Description: List of file IDs of the file set<B>&nbsp;</B>
3106
<UL>
3107
<LI>Returns: <A HREF="#fileID1" TITLE="link to another function that returns this type ID"><I>fileIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
3108
<LI>Input: <A HREF="#fileSetID0" TITLE="link to list of functions that return this type ID"><I>fileSetID</I></A> of type <I>xsd:string</I> </LI>
3109
</UL>
3110
<A NAME ="value38">
3111
<BR><H3><A NAME="getFileType">getFileType</A></H3>
3112
Description: FileType or userFileType  of the file<B>&nbsp;</B>
3113
<UL>
3114
<LI>Returns: <I>value</I> of type <I>spirit:soapStringArrayType</I> </LI>
3115
<LI>Input: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I> </LI>
3116
</UL>
3117
<A NAME ="booleanValue12">
3118
<BR><H3><A NAME="getFileIsIncludeFile">getFileIsIncludeFile</A></H3>
3119
Description: Indicates that the given file is an include file<B>&nbsp;</B>
3120
<UL>
3121
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
3122
<LI>Input: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I> </LI>
3123
</UL>
3124
<A NAME ="booleanValue13">
3125
<BR><H3><A NAME="getFileHasExternalDeclarations">getFileHasExternalDeclarations</A></H3>
3126
Description: Indicates that the file includes external declarations required by the top-level netlist file<B>&nbsp;</B>
3127
<UL>
3128
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
3129
<LI>Input: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I> </LI>
3130
</UL>
3131
<A NAME ="value39">
3132
<BR><H3><A NAME="getFileLogicalName">getFileLogicalName</A></H3>
3133
Description: Logical name of the file<B>&nbsp;</B>
3134
<UL>
3135
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3136
<LI>Input: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I> </LI>
3137
</UL>
3138
<A NAME ="booleanValue14">
3139
<BR><H3><A NAME="getFileLogicalNameDefault">getFileLogicalNameDefault</A></H3>
3140
Description: Default attribute of logical name of the file<B>&nbsp;</B>
3141
<UL>
3142
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
3143
<LI>Input: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I> </LI>
3144
</UL>
3145
<A NAME ="exportedNamesValue0">
3146
<BR><H3><A NAME="getFileExportedNames">getFileExportedNames</A></H3>
3147
Description: List of exported names of the file<B>&nbsp;</B>
3148
<UL>
3149
<LI>Returns: <I>exportedNamesValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
3150
<LI>Input: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I> </LI>
3151
</UL>
3152
<A NAME ="value40">
3153
<BR><H3><A NAME="getFileBuildCommandName">getFileBuildCommandName</A></H3>
3154
Description: Name of the build command of the file<B>&nbsp;</B>
3155
<UL>
3156
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3157
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3158
<UL>
3159
<LI>Legal value: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I></LI>
3160
<LI>Legal value: <A HREF="#fileUID0" TITLE="link to list of functions that return this type ID"><I>fileUID</I></A> of type <I>xsd:string</I></LI>
3161
</UL>
3162
</UL>
3163
<A NAME ="value41">
3164
<BR><H3><A NAME="getFileBuildCommandFlags">getFileBuildCommandFlags</A></H3>
3165
Description: Flags of the file build command<B>&nbsp;</B>
3166
<UL>
3167
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3168
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3169
<UL>
3170
<LI>Legal value: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I></LI>
3171
<LI>Legal value: <A HREF="#fileUID0" TITLE="link to list of functions that return this type ID"><I>fileUID</I></A> of type <I>xsd:string</I></LI>
3172
</UL>
3173
</UL>
3174
<A NAME ="booleanValue15">
3175
<BR><H3><A NAME="getFileBuildCommandFlagsIsAppend">getFileBuildCommandFlagsIsAppend</A></H3>
3176
Description: Value of append attribute on the flag element<B>&nbsp;</B>
3177
<UL>
3178
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
3179
<LI>Input: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I> </LI>
3180
</UL>
3181
<A NAME ="booleanValue16">
3182
<BR><H3><A NAME="getFileBuildCommandReplaceDefaultFlags">getFileBuildCommandReplaceDefaultFlags</A></H3>
3183
Description: Indicates whether or not to replace default flags<B>&nbsp;</B>
3184
<UL>
3185
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
3186
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3187
<UL>
3188
<LI>Legal value: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I></LI>
3189
<LI>Legal value: <A HREF="#fileUID0" TITLE="link to list of functions that return this type ID"><I>fileUID</I></A> of type <I>xsd:string</I></LI>
3190
</UL>
3191
</UL>
3192
<A NAME ="value42">
3193
<BR><H3><A NAME="getFileBuildCommandTargetName">getFileBuildCommandTargetName</A></H3>
3194
Description: Target name of the file build command<B>&nbsp;</B>
3195
<UL>
3196
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3197
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3198
<UL>
3199
<LI>Legal value: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I></LI>
3200
<LI>Legal value: <A HREF="#fileUID0" TITLE="link to list of functions that return this type ID"><I>fileUID</I></A> of type <I>xsd:string</I></LI>
3201
</UL>
3202
</UL>
3203
<A NAME ="fileDependencyValue0">
3204
<BR><H3><A NAME="getFileDependencies">getFileDependencies</A></H3>
3205
Description: List of dependent locations for the file, typically directories<B>&nbsp;</B>
3206
<UL>
3207
<LI>Returns: <I>fileDependencyValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
3208
<LI>Input: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I> </LI>
3209
</UL>
3210
<A NAME ="fileDefineID0">
3211
<BR><H3><A NAME="getFileDefineSymbolIDs">getFileDefineSymbolIDs</A></H3>
3212
Description: List of define symbol IDs used in the file<B>&nbsp;</B>
3213
<UL>
3214
<LI>Returns: <I>fileDefineIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
3215
<LI>Input: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I> </LI>
3216
</UL>
3217
<A NAME ="fileImageTypesValue0">
3218
<BR><H3><A NAME="getFileImageTypes">getFileImageTypes</A></H3>
3219
Description: List of image types of the file<B>&nbsp;</B>
3220
<UL>
3221
<LI>Returns: <I>fileImageTypesValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
3222
<LI>Input: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I> </LI>
3223
</UL>
3224
<A NAME ="fileBuilderID1">
3225
<BR><H3><A NAME="getFileSetFileBuilderIDs">getFileSetFileBuilderIDs</A></H3>
3226
Description: List of file builder IDs used for this fileSet<B>&nbsp;</B>
3227
<UL>
3228
<LI>Returns: <A HREF="#fileBuilderID2" TITLE="link to another function that returns this type ID"><I>fileBuilderIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
3229
<LI>Input: <A HREF="#fileSetID0" TITLE="link to list of functions that return this type ID"><I>fileSetID</I></A> of type <I>xsd:string</I> </LI>
3230
</UL>
3231
<A NAME ="fileDependencyValue1">
3232
<BR><H3><A NAME="getFileSetDependencies">getFileSetDependencies</A></H3>
3233
Description: List of dependent locations for the fileSet, typically directories<B>&nbsp;</B>
3234
<UL>
3235
<LI>Returns: <I>fileDependencyValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
3236
<LI>Input: <A HREF="#fileSetID0" TITLE="link to list of functions that return this type ID"><I>fileSetID</I></A> of type <I>xsd:string</I> </LI>
3237
</UL>
3238
<A NAME ="functionID0">
3239
<BR><H3><A NAME="getFileSetFunctionIDs">getFileSetFunctionIDs</A></H3>
3240
Description: List of function IDs<B>&nbsp;</B>
3241
<UL>
3242
<LI>Returns: <I>functionIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
3243
<LI>Input: <A HREF="#fileSetID0" TITLE="link to list of functions that return this type ID"><I>fileSetID</I></A> of type <I>xsd:string</I> </LI>
3244
</UL>
3245
<A NAME ="booleanValue17">
3246
<BR><H3><A NAME="getFunctionReplicate">getFunctionReplicate</A></H3>
3247
Description: Value of replicate attribute on function element<B>&nbsp;</B>
3248
<UL>
3249
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
3250
<LI>Input: <A HREF="#functionID0" TITLE="link to list of functions that return this type ID"><I>functionID</I></A> of type <I>xsd:string</I> </LI>
3251
</UL>
3252
<A NAME ="value43">
3253
<BR><H3><A NAME="getFunctionEntryPoint">getFunctionEntryPoint</A></H3>
3254
Description: Entry point of the function<B>&nbsp;</B>
3255
<UL>
3256
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3257
<LI>Input: <A HREF="#functionID0" TITLE="link to list of functions that return this type ID"><I>functionID</I></A> of type <I>xsd:string</I> </LI>
3258
</UL>
3259
<A NAME ="fileID1">
3260
<BR><H3><A NAME="getFunctionFileID">getFunctionFileID</A></H3>
3261
Description: File ID containing the function entry point<B>&nbsp;</B>
3262
<UL>
3263
<LI>Returns: <B><A HREF="#fileID0" TITLE="last function the returns this type ID in list"><I>fileID</I></A></B> of type <I>xsd:string</I> </LI>
3264
<LI>Input: <A HREF="#functionID0" TITLE="link to list of functions that return this type ID"><I>functionID</I></A> of type <I>xsd:string</I> </LI>
3265
</UL>
3266
<A NAME ="value44">
3267
<BR><H3><A NAME="getFunctionReturnType">getFunctionReturnType</A></H3>
3268
Description: Return type of the function<B>&nbsp;</B>
3269
<UL>
3270
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3271
<LI>Input: <A HREF="#functionID0" TITLE="link to list of functions that return this type ID"><I>functionID</I></A> of type <I>xsd:string</I> </LI>
3272
</UL>
3273
<A NAME ="argumentID0">
3274
<BR><H3><A NAME="getFunctionArgumentIDs">getFunctionArgumentIDs</A></H3>
3275
Description: List of argument IDs of the function of the file set<B>&nbsp;</B>
3276
<UL>
3277
<LI>Returns: <I>argumentIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
3278
<LI>Input: <A HREF="#functionID0" TITLE="link to list of functions that return this type ID"><I>functionID</I></A> of type <I>xsd:string</I> </LI>
3279
</UL>
3280
<A NAME ="value45">
3281
<BR><H3><A NAME="getFunctionArgumentDataType">getFunctionArgumentDataType</A></H3>
3282
Description: Data type of the argument<B>&nbsp;</B>
3283
<UL>
3284
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3285
<LI>Input: <A HREF="#argumentID0" TITLE="link to list of functions that return this type ID"><I>argumentID</I></A> of type <I>xsd:string</I> </LI>
3286
</UL>
3287
<A NAME ="booleanValue18">
3288
<BR><H3><A NAME="getFunctionDisabled">getFunctionDisabled</A></H3>
3289
Description: Indicates whether or not the function is disabled<B>&nbsp;</B>
3290
<UL>
3291
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
3292
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3293
<UL>
3294
<LI>Legal value: <A HREF="#functionID0" TITLE="link to list of functions that return this type ID"><I>functionID</I></A> of type <I>xsd:string</I></LI>
3295
<LI>Legal value: <A HREF="#functionUID0" TITLE="link to list of functions that return this type ID"><I>functionUID</I></A> of type <I>xsd:string</I></LI>
3296
</UL>
3297
</UL>
3298
<A NAME ="functionSourceFileID0">
3299
<BR><H3><A NAME="getFunctionSourceFileIDs">getFunctionSourceFileIDs</A></H3>
3300
Description: List of source file IDs of the function of the file set<B>&nbsp;</B>
3301
<UL>
3302
<LI>Returns: <I>functionSourceFileIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
3303
<LI>Input: <A HREF="#functionID0" TITLE="link to list of functions that return this type ID"><I>functionID</I></A> of type <I>xsd:string</I> </LI>
3304
</UL>
3305
<A NAME ="value46">
3306
<BR><H3><A NAME="getFunctionSourceFileName">getFunctionSourceFileName</A></H3>
3307
Description: Name of the source file<B>&nbsp;</B>
3308
<UL>
3309
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3310
<LI>Input: <A HREF="#functionSourceFileID0" TITLE="link to list of functions that return this type ID"><I>functionSourceFileID</I></A> of type <I>xsd:string</I> </LI>
3311
</UL>
3312
<A NAME ="value47">
3313
<BR><H3><A NAME="getFunctionSourceFileType">getFunctionSourceFileType</A></H3>
3314
Description: FileType or userFileType of the source file<B>&nbsp;</B>
3315
<UL>
3316
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3317
<LI>Input: <A HREF="#functionSourceFileID0" TITLE="link to list of functions that return this type ID"><I>functionSourceFileID</I></A> of type <I>xsd:string</I> </LI>
3318
</UL>
3319
<A NAME ="status29">
3320
<BR><H3><A NAME="setFileName">setFileName</A></H3>
3321
Description: Set name of the given file.<B>&nbsp;</B>
3322
<UL>
3323
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
3324
<LI>Input: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I> </LI>
3325
<LI>Input: <I>value</I> of type <I>xsd:string</I> -- File name may be not be a relative path.</LI>
3326
</UL>
3327
<A NAME ="status30">
3328
<BR><H3><A NAME="setFileBuildCommandName">setFileBuildCommandName</A></H3>
3329
Description: Set command name for the given file builder.<B>&nbsp;</B>
3330
<UL>
3331
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
3332
<LI>Input: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I> </LI>
3333
<LI>Input: <I>value</I> of type <I>xsd:string</I> </LI>
3334
</UL>
3335
<A NAME ="status31">
3336
<BR><H3><A NAME="setFileBuildCommandFlags">setFileBuildCommandFlags</A></H3>
3337
Description: Set command flags for the given file builder.<B>&nbsp;</B>
3338
<UL>
3339
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
3340
<LI>Input: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I> </LI>
3341
<LI>Input: <I>value</I> of type <I>xsd:string</I> </LI>
3342
</UL>
3343
<A NAME ="status32">
3344
<BR><H3><A NAME="setFileBuildCommandReplaceDefaultFlags">setFileBuildCommandReplaceDefaultFlags</A></H3>
3345
Description: Set replace default flags for the given file builder.<B>&nbsp;</B>
3346
<UL>
3347
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
3348
<LI>Input: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I> </LI>
3349
<LI>Input: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
3350
</UL>
3351
<A NAME ="status33">
3352
<BR><H3><A NAME="setFileBuildCommandTargetName">setFileBuildCommandTargetName</A></H3>
3353
Description: Set target name for build command for the given file<B>&nbsp;</B>
3354
<UL>
3355
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
3356
<LI>Input: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I> </LI>
3357
<LI>Input: <I>value</I> of type <I>xsd:string</I> </LI>
3358
</UL>
3359
<A NAME ="status34">
3360
<BR><H3><A NAME="setFileBuilderCommand">setFileBuilderCommand</A></H3>
3361
Description: Set command associated with file builder.<B>&nbsp;</B>
3362
<UL>
3363
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
3364
<LI>Input: <A HREF="#fileBuilderID0" TITLE="link to list of functions that return this type ID"><I>fileBuilderID</I></A> of type <I>xsd:string</I> </LI>
3365
<LI>Input: <I>command</I> of type <I>xsd:string</I> </LI>
3366
</UL>
3367
<A NAME ="status35">
3368
<BR><H3><A NAME="setFileBuilderFlags">setFileBuilderFlags</A></H3>
3369
Description: Set flags associated with the given file builder.<B>&nbsp;</B>
3370
<UL>
3371
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
3372
<LI>Input: <A HREF="#fileBuilderID0" TITLE="link to list of functions that return this type ID"><I>fileBuilderID</I></A> of type <I>xsd:string</I> </LI>
3373
<LI>Input: <I>flags</I> of type <I>xsd:string</I> </LI>
3374
</UL>
3375
<A NAME ="status36">
3376
<BR><H3><A NAME="setFileBuilderReplaceDefaultFlags">setFileBuilderReplaceDefaultFlags</A></H3>
3377
Description: Set value of replace default flags in file builder.<B>&nbsp;</B>
3378
<UL>
3379
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
3380
<LI>Input: <A HREF="#fileBuilderID0" TITLE="link to list of functions that return this type ID"><I>fileBuilderID</I></A> of type <I>xsd:string</I> </LI>
3381
<LI>Input: <I>replaceDefaultFlags</I> of type <I>xsd:boolean</I> </LI>
3382
</UL>
3383
<A NAME ="status37">
3384
<BR><H3><A NAME="setFunctionDisabled">setFunctionDisabled</A></H3>
3385
Description: Set disable flag on function.<B>&nbsp;</B>
3386
<UL>
3387
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
3388
<LI>Input: <A HREF="#functionID0" TITLE="link to list of functions that return this type ID"><I>functionID</I></A> of type <I>xsd:string</I> </LI>
3389
<LI>Input: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
3390
</UL>
3391
<P>
3392
<table width="100%"><TR><TD bgcolor=#b8b8ff>
3393
<BR><H2>Generator Operations</H2>
3394
</TD></TR></TABLE>
3395
<A NAME ="value48">
3396
<BR><H3><A NAME="getGeneratorScope">getGeneratorScope</A></H3>
3397
Description: Scope of the generator<B>&nbsp;</B>
3398
<UL>
3399
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3400
<LI>Input: <A HREF="#generatorID0" TITLE="link to list of functions that return this type ID"><I>generatorID</I></A> of type <I>xsd:string</I> </LI>
3401
</UL>
3402
<A NAME ="booleanValue19">
3403
<BR><H3><A NAME="getGeneratorIsHidden">getGeneratorIsHidden</A></H3>
3404
Description: Value of hidden attribute on the generator<B>&nbsp;</B>
3405
<UL>
3406
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
3407
<LI>Input: <A HREF="#generatorID0" TITLE="link to list of functions that return this type ID"><I>generatorID</I></A> of type <I>xsd:string</I> </LI>
3408
</UL>
3409
<A NAME ="floatValue1">
3410
<BR><H3><A NAME="getGeneratorPhase">getGeneratorPhase</A></H3>
3411
Description: Phase number of the generator<B>&nbsp;</B>
3412
<UL>
3413
<LI>Returns: <I>floatValue</I> of type <I>xsd:float</I> </LI>
3414
<LI>Input: <A HREF="#generatorID0" TITLE="link to list of functions that return this type ID"><I>generatorID</I></A> of type <I>xsd:string</I> </LI>
3415
</UL>
3416
<A NAME ="value49">
3417
<BR><H3><A NAME="getGeneratorApiType">getGeneratorApiType</A></H3>
3418
Description: Api type of the generator<B>&nbsp;</B>
3419
<UL>
3420
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3421
<LI>Input: <A HREF="#generatorID0" TITLE="link to list of functions that return this type ID"><I>generatorID</I></A> of type <I>xsd:string</I> </LI>
3422
</UL>
3423
<A NAME ="value50">
3424
<BR><H3><A NAME="getGeneratorExecutable">getGeneratorExecutable</A></H3>
3425
Description: Executable name associated with the generator  <B>&nbsp;</B>
3426
<UL>
3427
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3428
<LI>Input: <A HREF="#generatorID0" TITLE="link to list of functions that return this type ID"><I>generatorID</I></A> of type <I>xsd:string</I> </LI>
3429
</UL>
3430
<A NAME ="generatorGroupValue0">
3431
<BR><H3><A NAME="getGeneratorGroups">getGeneratorGroups</A></H3>
3432
Description: List of group names of the generator<B>&nbsp;</B>
3433
<UL>
3434
<LI>Returns: <I>generatorGroupValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
3435
<LI>Input: <A HREF="#generatorID0" TITLE="link to list of functions that return this type ID"><I>generatorID</I></A> of type <I>xsd:string</I> </LI>
3436
</UL>
3437
<A NAME ="transportValue0">
3438
<BR><H3><A NAME="getGeneratorTransportMethods">getGeneratorTransportMethods</A></H3>
3439
Description: List of transport methods of the generator<B>&nbsp;</B>
3440
<UL>
3441
<LI>Returns: <I>transportValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
3442
<LI>Input: <A HREF="#generatorID0" TITLE="link to list of functions that return this type ID"><I>generatorID</I></A> of type <I>xsd:string</I> </LI>
3443
</UL>
3444
<P>
3445
<table width="100%"><TR><TD bgcolor=#b8b8ff>
3446
<BR><H2>Interface Operations</H2>
3447
</TD></TR></TABLE>
3448
<A NAME ="vlnvValue10">
3449
<BR><H3><A NAME="getInterfaceBusTypeVLNV">getInterfaceBusTypeVLNV</A></H3>
3450
Description: List of VLNV of the bus definition<B>&nbsp;</B>
3451
<UL>
3452
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
3453
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
3454
</UL>
3455
<A NAME ="vlnvValue11">
3456
<BR><H3><A NAME="getInterfaceAbstractionTypeVLNV">getInterfaceAbstractionTypeVLNV</A></H3>
3457
Description: List of VLNV of the abstraction definition<B>&nbsp;</B>
3458
<UL>
3459
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
3460
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
3461
</UL>
3462
<A NAME ="value51">
3463
<BR><H3><A NAME="getInterfaceMode">getInterfaceMode</A></H3>
3464
Description: Mode of the interface: master, slave, system, mirroredMaster, mirroredSlave, mirroredSystem or monitor<B>&nbsp;</B>
3465
<UL>
3466
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3467
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
3468
</UL>
3469
<A NAME ="interfacePortMapID0">
3470
<BR><H3><A NAME="getInterfacePortMapIDs">getInterfacePortMapIDs</A></H3>
3471
Description: List of interface port map IDs<B>&nbsp;</B>
3472
<UL>
3473
<LI>Returns: <I>interfacePortMapIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
3474
<LI>Input: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I> </LI>
3475
</UL>
3476
<A NAME ="portMapID0">
3477
<BR><H3><A NAME="getLogicalPhysicalMapIDs">getLogicalPhysicalMapIDs</A></H3>
3478
Description: List of the logical and physical port map IDs<B>&nbsp;</B>
3479
<UL>
3480
<LI>Returns: <I>portMapIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
3481
<LI>Input: <A HREF="#interfacePortMapID0" TITLE="link to list of functions that return this type ID"><I>interfacePortMapID</I></A> of type <I>xsd:string</I> </LI>
3482
</UL>
3483
<A NAME ="nonNegativeIntegerArrayValue0">
3484
<BR><H3><A NAME="getPortMapRange">getPortMapRange</A></H3>
3485
Description: List of left and right range of the port map<B>&nbsp;</B>
3486
<UL>
3487
<LI>Returns: <I>nonNegativeIntegerArrayValue</I> of type <I>spirit:nonNegativeIntegerArrayType</I> -- The return array value is in the format of logical vector left, right, physical vector left, right</LI>
3488
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3489
<UL>
3490
<LI>Legal value: <A HREF="#portMapID0" TITLE="link to list of functions that return this type ID"><I>portMapID</I></A> of type <I>xsd:string</I></LI>
3491
<LI>Legal value: <A HREF="#portMapUID0" TITLE="link to list of functions that return this type ID"><I>portMapUID</I></A> of type <I>xsd:string</I></LI>
3492
</UL>
3493
</UL>
3494
<A NAME ="status38">
3495
<BR><H3><A NAME="setPortMapRange">setPortMapRange</A></H3>
3496
Description: Set left/right range of an interface port map.<B>&nbsp;</B>
3497
<UL>
3498
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
3499
<LI>Input: <A HREF="#portMapID0" TITLE="link to list of functions that return this type ID"><I>portMapID</I></A> of type <I>xsd:string</I> </LI>
3500
<LI>Input: <I>nonNegativeIntegerArrayMessage</I> of type <I>spirit:nonNegativeIntegerArrayType</I> </LI>
3501
</UL>
3502
<P>
3503
<table width="100%"><TR><TD bgcolor=#b8b8ff>
3504
<BR><H2>Miscellaneous Operations</H2>
3505
</TD></TR></TABLE>
3506
<A NAME ="value52">
3507
<BR><H3><A NAME="getVendorExtensions">getVendorExtensions</A></H3>
3508
Description: Returns the complete XML text of the vendor extension element including the spirit:vendorExtension tag, as a well formed XML document.<B>&nbsp;</B>
3509
<UL>
3510
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3511
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3512
<UL>
3513
<LI>Legal value: <A HREF="#abstractionDefID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefID</I></A> of type <I>xsd:string</I></LI>
3514
<LI>Legal value: <A HREF="#abstractionDefPortID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefPortID</I></A> of type <I>xsd:string</I></LI>
3515
<LI>Legal value: <A HREF="#abstractionServiceID0" TITLE="link to list of functions that return this type ID"><I>abstractionServiceID</I></A> of type <I>xsd:string</I></LI>
3516
<LI>Legal value: <A HREF="#abstractorID0" TITLE="link to list of functions that return this type ID"><I>abstractorID</I></A> of type <I>xsd:string</I></LI>
3517
<LI>Legal value: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I></LI>
3518
<LI>Legal value: <A HREF="#addressSpaceID0" TITLE="link to list of functions that return this type ID"><I>addressSpaceID</I></A> of type <I>xsd:string</I></LI>
3519
<LI>Legal value: <A HREF="#alternateRegisterID0" TITLE="link to list of functions that return this type ID"><I>alternateRegisterID</I></A> of type <I>xsd:string</I></LI>
3520
<LI>Legal value: <A HREF="#argumentID0" TITLE="link to list of functions that return this type ID"><I>argumentID</I></A> of type <I>xsd:string</I></LI>
3521
<LI>Legal value: <A HREF="#bankID0" TITLE="link to list of functions that return this type ID"><I>bankID</I></A> of type <I>xsd:string</I></LI>
3522
<LI>Legal value: <A HREF="#busdefID0" TITLE="link to list of functions that return this type ID"><I>busdefID</I></A> of type <I>xsd:string</I></LI>
3523
<LI>Legal value: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I></LI>
3524
<LI>Legal value: <A HREF="#componentInstanceID0" TITLE="link to list of functions that return this type ID"><I>componentInstanceID</I></A> of type <I>xsd:string</I></LI>
3525
<LI>Legal value: <A HREF="#cpuID0" TITLE="link to list of functions that return this type ID"><I>cpuID</I></A> of type <I>xsd:string</I></LI>
3526
<LI>Legal value: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I></LI>
3527
<LI>Legal value: <A HREF="#executableImageID0" TITLE="link to list of functions that return this type ID"><I>executableImageID</I></A> of type <I>xsd:string</I></LI>
3528
<LI>Legal value: <A HREF="#fileBuilderID0" TITLE="link to list of functions that return this type ID"><I>fileBuilderID</I></A> of type <I>xsd:string</I></LI>
3529
<LI>Legal value: <A HREF="#fileDefineID0" TITLE="link to list of functions that return this type ID"><I>fileDefineID</I></A> of type <I>xsd:string</I></LI>
3530
<LI>Legal value: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I></LI>
3531
<LI>Legal value: <A HREF="#fileSetID0" TITLE="link to list of functions that return this type ID"><I>fileSetID</I></A> of type <I>xsd:string</I></LI>
3532
<LI>Legal value: <A HREF="#generatorID0" TITLE="link to list of functions that return this type ID"><I>generatorID</I></A> of type <I>xsd:string</I></LI>
3533
<LI>Legal value: <A HREF="#hierConnectionID0" TITLE="link to list of functions that return this type ID"><I>hierConnectionID</I></A> of type <I>xsd:string</I></LI>
3534
<LI>Legal value: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I></LI>
3535
<LI>Legal value: <A HREF="#linkerCommandFileID0" TITLE="link to list of functions that return this type ID"><I>linkerCommandFileID</I></A> of type <I>xsd:string</I></LI>
3536
<LI>Legal value: <A HREF="#memoryMapID0" TITLE="link to list of functions that return this type ID"><I>memoryMapID</I></A> of type <I>xsd:string</I></LI>
3537
<LI>Legal value: <A HREF="#parameterID0" TITLE="link to list of functions that return this type ID"><I>parameterID</I></A> of type <I>xsd:string</I></LI>
3538
<LI>Legal value: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I></LI>
3539
<LI>Legal value: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I></LI>
3540
<LI>Legal value: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I></LI>
3541
<LI>Legal value: <A HREF="#registerFileID0" TITLE="link to list of functions that return this type ID"><I>registerFileID</I></A> of type <I>xsd:string</I></LI>
3542
<LI>Legal value: <A HREF="#segmentID0" TITLE="link to list of functions that return this type ID"><I>segmentID</I></A> of type <I>xsd:string</I></LI>
3543
<LI>Legal value: <A HREF="#subspaceMapID0" TITLE="link to list of functions that return this type ID"><I>subspaceMapID</I></A> of type <I>xsd:string</I></LI>
3544
<LI>Legal value: <A HREF="#serviceID0" TITLE="link to list of functions that return this type ID"><I>serviceID</I></A> of type <I>xsd:string</I></LI>
3545
<LI>Legal value: <A HREF="#viewID0" TITLE="link to list of functions that return this type ID"><I>viewID</I></A> of type <I>xsd:string</I></LI>
3546
<LI>Legal value: <A HREF="#whiteboxElementID0" TITLE="link to list of functions that return this type ID"><I>whiteboxElementID</I></A> of type <I>xsd:string</I></LI>
3547
</UL>
3548
</UL>
3549
<A NAME ="attrValue0">
3550
<BR><H3><A NAME="getVendorAttribute">getVendorAttribute</A></H3>
3551
Description: Get vendor defined attribute from the given element<B>&nbsp;</B>
3552
<UL>
3553
<LI>Returns: <I>attrValue</I> of type <I>xsd:string</I> </LI>
3554
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3555
<UL>
3556
<LI>Legal value: <A HREF="#argumentID0" TITLE="link to list of functions that return this type ID"><I>argumentID</I></A> of type <I>xsd:string</I></LI>
3557
<LI>Legal value: <A HREF="#fileDefineID0" TITLE="link to list of functions that return this type ID"><I>fileDefineID</I></A> of type <I>xsd:string</I></LI>
3558
<LI>Legal value: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I></LI>
3559
<LI>Legal value: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I></LI>
3560
<LI>Legal value: <A HREF="#parameterID0" TITLE="link to list of functions that return this type ID"><I>parameterID</I></A> of type <I>xsd:string</I></LI>
3561
</UL>
3562
<LI>Input: <I>attrName</I> of type <I>xsd:string</I> </LI>
3563
</UL>
3564
<A NAME ="parameterID2">
3565
<BR><H3><A NAME="getParameterIDs">getParameterIDs</A></H3>
3566
Description: List of parameter IDs from the given element (any which contains spirit:parameter elements)<B>&nbsp;</B>
3567
<UL>
3568
<LI>Returns: <B><A HREF="#parameterID0" TITLE="last function the returns this type ID in list"><I>parameterIDs</I></A></B> of type <I>spirit:soapStringArrayType</I> </LI>
3569
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3570
<UL>
3571
<LI>Legal value: <A HREF="#abstractorID0" TITLE="link to list of functions that return this type ID"><I>abstractorID</I></A> of type <I>xsd:string</I></LI>
3572
<LI>Legal value: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I></LI>
3573
<LI>Legal value: <A HREF="#addressSpaceID0" TITLE="link to list of functions that return this type ID"><I>addressSpaceID</I></A> of type <I>xsd:string</I></LI>
3574
<LI>Legal value: <A HREF="#alternateRegisterID0" TITLE="link to list of functions that return this type ID"><I>alternateRegisterID</I></A> of type <I>xsd:string</I></LI>
3575
<LI>Legal value: <A HREF="#bankID0" TITLE="link to list of functions that return this type ID"><I>bankID</I></A> of type <I>xsd:string</I></LI>
3576
<LI>Legal value: <A HREF="#cpuID0" TITLE="link to list of functions that return this type ID"><I>cpuID</I></A> of type <I>xsd:string</I></LI>
3577
<LI>Legal value: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I></LI>
3578
<LI>Legal value: <A HREF="#executableImageID0" TITLE="link to list of functions that return this type ID"><I>executableImageID</I></A> of type <I>xsd:string</I></LI>
3579
<LI>Legal value: <A HREF="#generatorID0" TITLE="link to list of functions that return this type ID"><I>generatorID</I></A> of type <I>xsd:string</I></LI>
3580
<LI>Legal value: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I></LI>
3581
<LI>Legal value: <A HREF="#linkerCommandFileID0" TITLE="link to list of functions that return this type ID"><I>linkerCommandFileID</I></A> of type <I>xsd:string</I></LI>
3582
<LI>Legal value: <A HREF="#memoryMapID0" TITLE="link to list of functions that return this type ID"><I>memoryMapID</I></A> of type <I>xsd:string</I></LI>
3583
<LI>Legal value: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I></LI>
3584
<LI>Legal value: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I></LI>
3585
<LI>Legal value: <A HREF="#registerFileID0" TITLE="link to list of functions that return this type ID"><I>registerFileID</I></A> of type <I>xsd:string</I></LI>
3586
<LI>Legal value: <A HREF="#subspaceMapID0" TITLE="link to list of functions that return this type ID"><I>subspaceMapID</I></A> of type <I>xsd:string</I></LI>
3587
<LI>Legal value: <A HREF="#serviceTypeDefID0" TITLE="link to list of functions that return this type ID"><I>serviceTypeDefID</I></A> of type <I>xsd:string</I></LI>
3588
<LI>Legal value: <A HREF="#viewID0" TITLE="link to list of functions that return this type ID"><I>viewID</I></A> of type <I>xsd:string</I></LI>
3589
<LI>Legal value: <A HREF="#whiteboxElementID0" TITLE="link to list of functions that return this type ID"><I>whiteboxElementID</I></A> of type <I>xsd:string</I></LI>
3590
</UL>
3591
</UL>
3592
<A NAME ="value53">
3593
<BR><H3><A NAME="getValue">getValue</A></H3>
3594
Description: Get the value of a parameterID, fileDefineIDs or argumentIDs.<B>&nbsp;</B>
3595
<UL>
3596
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3597
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3598
<UL>
3599
<LI>Legal value: <A HREF="#argumentID0" TITLE="link to list of functions that return this type ID"><I>argumentID</I></A> of type <I>xsd:string</I></LI>
3600
<LI>Legal value: <A HREF="#argumentUID0" TITLE="link to list of functions that return this type ID"><I>argumentUID</I></A> of type <I>xsd:string</I></LI>
3601
<LI>Legal value: <A HREF="#fileDefineID0" TITLE="link to list of functions that return this type ID"><I>fileDefineID</I></A> of type <I>xsd:string</I></LI>
3602
<LI>Legal value: <A HREF="#fileDefineUID0" TITLE="link to list of functions that return this type ID"><I>fileDefineUID</I></A> of type <I>xsd:string</I></LI>
3603
<LI>Legal value: <A HREF="#parameterID0" TITLE="link to list of functions that return this type ID"><I>parameterID</I></A> of type <I>xsd:string</I></LI>
3604
<LI>Legal value: <A HREF="#parameterUID0" TITLE="link to list of functions that return this type ID"><I>parameterUID</I></A> of type <I>xsd:string</I></LI>
3605
</UL>
3606
</UL>
3607
<A NAME ="value54">
3608
<BR><H3><A NAME="getValueAttribute">getValueAttribute</A></H3>
3609
Description: Returns the value of the given attribute name on the elementID/value element<B>&nbsp;</B>
3610
<UL>
3611
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3612
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3613
<UL>
3614
<LI>Legal value: <A HREF="#argumentID0" TITLE="link to list of functions that return this type ID"><I>argumentID</I></A> of type <I>xsd:string</I></LI>
3615
<LI>Legal value: <A HREF="#fileDefineID0" TITLE="link to list of functions that return this type ID"><I>fileDefineID</I></A> of type <I>xsd:string</I></LI>
3616
<LI>Legal value: <A HREF="#parameterID0" TITLE="link to list of functions that return this type ID"><I>parameterID</I></A> of type <I>xsd:string</I></LI>
3617
</UL>
3618
<LI>Input: <I>attrName</I> of type <I>xsd:string</I> -- This is a namespace qualified attribute</LI>
3619
</UL>
3620
<A NAME ="value55">
3621
<BR><H3><A NAME="getModelParameterDataType">getModelParameterDataType</A></H3>
3622
Description: Data type of the model parameter<B>&nbsp;</B>
3623
<UL>
3624
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3625
<LI>Input: <A HREF="#parameterID0" TITLE="link to list of functions that return this type ID"><I>parameterID</I></A> of type <I>xsd:string</I> </LI>
3626
</UL>
3627
<A NAME ="value56">
3628
<BR><H3><A NAME="getModelParameterUsageType">getModelParameterUsageType</A></H3>
3629
Description: Usage type of the model parameter<B>&nbsp;</B>
3630
<UL>
3631
<LI>Returns: <I>value</I> of type <I>xsd:string</I> -- possible values are nontyped and typed</LI>
3632
<LI>Input: <A HREF="#parameterID0" TITLE="link to list of functions that return this type ID"><I>parameterID</I></A> of type <I>xsd:string</I> </LI>
3633
</UL>
3634
<A NAME ="id0">
3635
<BR><H3><A NAME="getIdValue">getIdValue</A></H3>
3636
Description: Return the value of the spirit:id attribute on a ID<B>- New in 1.5</B>
3637
<UL>
3638
<LI>Returns: <I>id</I> of type <I>xsd:string</I> </LI>
3639
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3640
<UL>
3641
<LI>Legal value: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I></LI>
3642
<LI>Legal value: <A HREF="#alternateRegisterID0" TITLE="link to list of functions that return this type ID"><I>alternateRegisterID</I></A> of type <I>xsd:string</I></LI>
3643
<LI>Legal value: <A HREF="#localMemoryMapID0" TITLE="link to list of functions that return this type ID"><I>localMemoryMapID</I></A> of type <I>xsd:string</I></LI>
3644
<LI>Legal value: <A HREF="#memoryMapID0" TITLE="link to list of functions that return this type ID"><I>memoryMapID</I></A> of type <I>xsd:string</I></LI>
3645
<LI>Legal value: <A HREF="#memoryRemapID0" TITLE="link to list of functions that return this type ID"><I>memoryRemapID</I></A> of type <I>xsd:string</I></LI>
3646
<LI>Legal value: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I></LI>
3647
<LI>Legal value: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I></LI>
3648
<LI>Legal value: <A HREF="#registerFileID0" TITLE="link to list of functions that return this type ID"><I>registerFileID</I></A> of type <I>xsd:string</I></LI>
3649
</UL>
3650
</UL>
3651
<A NAME ="name1">
3652
<BR><H3><A NAME="getName">getName</A></H3>
3653
Description: Return the name of the specified element<B>- Modified in 1.5</B>
3654
<UL>
3655
<LI>Returns: <I>name</I> of type <I>xsd:string</I> </LI>
3656
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3657
<UL>
3658
<LI>Legal value: <A HREF="#adHocConnectionID0" TITLE="link to list of functions that return this type ID"><I>adHocConnectionID</I></A> of type <I>xsd:string</I></LI>
3659
<LI>Legal value: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I></LI>
3660
<LI>Legal value: <A HREF="#addressSpaceID0" TITLE="link to list of functions that return this type ID"><I>addressSpaceID</I></A> of type <I>xsd:string</I></LI>
3661
<LI>Legal value: <A HREF="#alternateRegisterID0" TITLE="link to list of functions that return this type ID"><I>alternateRegisterID</I></A> of type <I>xsd:string</I></LI>
3662
<LI>Legal value: <A HREF="#argumentID0" TITLE="link to list of functions that return this type ID"><I>argumentID</I></A> of type <I>xsd:string</I></LI>
3663
<LI>Legal value: <A HREF="#bankID0" TITLE="link to list of functions that return this type ID"><I>bankID</I></A> of type <I>xsd:string</I></LI>
3664
<LI>Legal value: <A HREF="#channelID0" TITLE="link to list of functions that return this type ID"><I>channelID</I></A> of type <I>xsd:string</I></LI>
3665
<LI>Legal value: <A HREF="#cpuID0" TITLE="link to list of functions that return this type ID"><I>cpuID</I></A> of type <I>xsd:string</I></LI>
3666
<LI>Legal value: <A HREF="#executableImageID0" TITLE="link to list of functions that return this type ID"><I>executableImageID</I></A> of type <I>xsd:string</I></LI>
3667
<LI>Legal value: <A HREF="#fileDefineID0" TITLE="link to list of functions that return this type ID"><I>fileDefineID</I></A> of type <I>xsd:string</I></LI>
3668
<LI>Legal value: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I></LI>
3669
<LI>Legal value: <A HREF="#fileSetID0" TITLE="link to list of functions that return this type ID"><I>fileSetID</I></A> of type <I>xsd:string</I></LI>
3670
<LI>Legal value: <A HREF="#generatorID0" TITLE="link to list of functions that return this type ID"><I>generatorID</I></A> of type <I>xsd:string</I></LI>
3671
<LI>Legal value: <A HREF="#interconnectionID0" TITLE="link to list of functions that return this type ID"><I>interconnectionID</I></A> of type <I>xsd:string</I></LI>
3672
<LI>Legal value: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I></LI>
3673
<LI>Legal value: <A HREF="#linkerCommandFileID0" TITLE="link to list of functions that return this type ID"><I>linkerCommandFileID</I></A> of type <I>xsd:string</I></LI>
3674
<LI>Legal value: <A HREF="#localMemoryMapID0" TITLE="link to list of functions that return this type ID"><I>localMemoryMapID</I></A> of type <I>xsd:string</I></LI>
3675
<LI>Legal value: <A HREF="#memoryMapID0" TITLE="link to list of functions that return this type ID"><I>memoryMapID</I></A> of type <I>xsd:string</I></LI>
3676
<LI>Legal value: <A HREF="#memoryRemapID0" TITLE="link to list of functions that return this type ID"><I>memoryRemapID</I></A> of type <I>xsd:string</I></LI>
3677
<LI>Legal value: <A HREF="#monitorInterconnectionID0" TITLE="link to list of functions that return this type ID"><I>monitorInterconnectionID</I></A> of type <I>xsd:string</I></LI>
3678
<LI>Legal value: <A HREF="#parameterID0" TITLE="link to list of functions that return this type ID"><I>parameterID</I></A> of type <I>xsd:string</I></LI>
3679
<LI>Legal value: <A HREF="#portConstraintSetID0" TITLE="link to list of functions that return this type ID"><I>portConstraintSetID</I></A> of type <I>xsd:string</I></LI>
3680
<LI>Legal value: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I></LI>
3681
<LI>Legal value: <A HREF="#portMapID0" TITLE="link to list of functions that return this type ID"><I>portMapID</I></A> of type <I>xsd:string</I></LI>
3682
<LI>Legal value: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I></LI>
3683
<LI>Legal value: <A HREF="#regFieldValueID0" TITLE="link to list of functions that return this type ID"><I>regFieldValueID</I></A> of type <I>xsd:string</I></LI>
3684
<LI>Legal value: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I></LI>
3685
<LI>Legal value: <A HREF="#registerFileID0" TITLE="link to list of functions that return this type ID"><I>registerFileID</I></A> of type <I>xsd:string</I></LI>
3686
<LI>Legal value: <A HREF="#remapStateID0" TITLE="link to list of functions that return this type ID"><I>remapStateID</I></A> of type <I>xsd:string</I></LI>
3687
<LI>Legal value: <A HREF="#segmentID0" TITLE="link to list of functions that return this type ID"><I>segmentID</I></A> of type <I>xsd:string</I></LI>
3688
<LI>Legal value: <A HREF="#subspaceMapID0" TITLE="link to list of functions that return this type ID"><I>subspaceMapID</I></A> of type <I>xsd:string</I></LI>
3689
<LI>Legal value: <A HREF="#viewID0" TITLE="link to list of functions that return this type ID"><I>viewID</I></A> of type <I>xsd:string</I></LI>
3690
<LI>Legal value: <A HREF="#whiteboxElementID0" TITLE="link to list of functions that return this type ID"><I>whiteboxElementID</I></A> of type <I>xsd:string</I></LI>
3691
</UL>
3692
</UL>
3693
<A NAME ="description0">
3694
<BR><H3><A NAME="getDescription">getDescription</A></H3>
3695
Description: Return the description of the specified element<B>- Modified in 1.5</B>
3696
<UL>
3697
<LI>Returns: <I>description</I> of type <I>xsd:string</I> </LI>
3698
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3699
<UL>
3700
<LI>Legal value: <A HREF="#abstractionDefID0" TITLE="link to list of functions that return this type ID"><I>abstractionDefID</I></A> of type <I>xsd:string</I></LI>
3701
<LI>Legal value: <A HREF="#abstractorID0" TITLE="link to list of functions that return this type ID"><I>abstractorID</I></A> of type <I>xsd:string</I></LI>
3702
<LI>Legal value: <A HREF="#abstractorInstanceID0" TITLE="link to list of functions that return this type ID"><I>abstractorInstanceID</I></A> of type <I>xsd:string</I></LI>
3703
<LI>Legal value: <A HREF="#adHocConnectionID0" TITLE="link to list of functions that return this type ID"><I>adHocConnectionID</I></A> of type <I>xsd:string</I></LI>
3704
<LI>Legal value: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I></LI>
3705
<LI>Legal value: <A HREF="#addressSpaceID0" TITLE="link to list of functions that return this type ID"><I>addressSpaceID</I></A> of type <I>xsd:string</I></LI>
3706
<LI>Legal value: <A HREF="#alternateRegisterID0" TITLE="link to list of functions that return this type ID"><I>alternateRegisterID</I></A> of type <I>xsd:string</I></LI>
3707
<LI>Legal value: <A HREF="#argumentID0" TITLE="link to list of functions that return this type ID"><I>argumentID</I></A> of type <I>xsd:string</I></LI>
3708
<LI>Legal value: <A HREF="#bankID0" TITLE="link to list of functions that return this type ID"><I>bankID</I></A> of type <I>xsd:string</I></LI>
3709
<LI>Legal value: <A HREF="#busdefID0" TITLE="link to list of functions that return this type ID"><I>busdefID</I></A> of type <I>xsd:string</I></LI>
3710
<LI>Legal value: <A HREF="#channelID0" TITLE="link to list of functions that return this type ID"><I>channelID</I></A> of type <I>xsd:string</I></LI>
3711
<LI>Legal value: <A HREF="#componentID0" TITLE="link to list of functions that return this type ID"><I>componentID</I></A> of type <I>xsd:string</I></LI>
3712
<LI>Legal value: <A HREF="#componentInstanceID0" TITLE="link to list of functions that return this type ID"><I>componentInstanceID</I></A> of type <I>xsd:string</I></LI>
3713
<LI>Legal value: <A HREF="#cpuID0" TITLE="link to list of functions that return this type ID"><I>cpuID</I></A> of type <I>xsd:string</I></LI>
3714
<LI>Legal value: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I></LI>
3715
<LI>Legal value: <A HREF="#executableImageID0" TITLE="link to list of functions that return this type ID"><I>executableImageID</I></A> of type <I>xsd:string</I></LI>
3716
<LI>Legal value: <A HREF="#fileDefineID0" TITLE="link to list of functions that return this type ID"><I>fileDefineID</I></A> of type <I>xsd:string</I></LI>
3717
<LI>Legal value: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I></LI>
3718
<LI>Legal value: <A HREF="#fileSetID0" TITLE="link to list of functions that return this type ID"><I>fileSetID</I></A> of type <I>xsd:string</I></LI>
3719
<LI>Legal value: <A HREF="#generatorID0" TITLE="link to list of functions that return this type ID"><I>generatorID</I></A> of type <I>xsd:string</I></LI>
3720
<LI>Legal value: <A HREF="#interconnectionID0" TITLE="link to list of functions that return this type ID"><I>interconnectionID</I></A> of type <I>xsd:string</I></LI>
3721
<LI>Legal value: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I></LI>
3722
<LI>Legal value: <A HREF="#localMemoryMapID0" TITLE="link to list of functions that return this type ID"><I>localMemoryMapID</I></A> of type <I>xsd:string</I></LI>
3723
<LI>Legal value: <A HREF="#memoryMapID0" TITLE="link to list of functions that return this type ID"><I>memoryMapID</I></A> of type <I>xsd:string</I></LI>
3724
<LI>Legal value: <A HREF="#memoryRemapID0" TITLE="link to list of functions that return this type ID"><I>memoryRemapID</I></A> of type <I>xsd:string</I></LI>
3725
<LI>Legal value: <A HREF="#monitorInterconnectionID0" TITLE="link to list of functions that return this type ID"><I>monitorInterconnectionID</I></A> of type <I>xsd:string</I></LI>
3726
<LI>Legal value: <A HREF="#parameterID0" TITLE="link to list of functions that return this type ID"><I>parameterID</I></A> of type <I>xsd:string</I></LI>
3727
<LI>Legal value: <A HREF="#portConstraintSetID0" TITLE="link to list of functions that return this type ID"><I>portConstraintSetID</I></A> of type <I>xsd:string</I></LI>
3728
<LI>Legal value: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I></LI>
3729
<LI>Legal value: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I></LI>
3730
<LI>Legal value: <A HREF="#regFieldValueID0" TITLE="link to list of functions that return this type ID"><I>regFieldValueID</I></A> of type <I>xsd:string</I></LI>
3731
<LI>Legal value: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I></LI>
3732
<LI>Legal value: <A HREF="#registerFileID0" TITLE="link to list of functions that return this type ID"><I>registerFileID</I></A> of type <I>xsd:string</I></LI>
3733
<LI>Legal value: <A HREF="#remapStateID0" TITLE="link to list of functions that return this type ID"><I>remapStateID</I></A> of type <I>xsd:string</I></LI>
3734
<LI>Legal value: <A HREF="#segmentID0" TITLE="link to list of functions that return this type ID"><I>segmentID</I></A> of type <I>xsd:string</I></LI>
3735
<LI>Legal value: <A HREF="#subspaceMapID0" TITLE="link to list of functions that return this type ID"><I>subspaceMapID</I></A> of type <I>xsd:string</I></LI>
3736
<LI>Legal value: <A HREF="#viewID0" TITLE="link to list of functions that return this type ID"><I>viewID</I></A> of type <I>xsd:string</I></LI>
3737
<LI>Legal value: <A HREF="#whiteboxElementID0" TITLE="link to list of functions that return this type ID"><I>whiteboxElementID</I></A> of type <I>xsd:string</I></LI>
3738
</UL>
3739
</UL>
3740
<A NAME ="displayName0">
3741
<BR><H3><A NAME="getDisplayName">getDisplayName</A></H3>
3742
Description: Return the displayName of the specified element<B>- Modified in 1.5</B>
3743
<UL>
3744
<LI>Returns: <I>displayName</I> of type <I>xsd:string</I> </LI>
3745
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3746
<UL>
3747
<LI>Legal value: <A HREF="#adHocConnectionID0" TITLE="link to list of functions that return this type ID"><I>adHocConnectionID</I></A> of type <I>xsd:string</I></LI>
3748
<LI>Legal value: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I></LI>
3749
<LI>Legal value: <A HREF="#addressSpaceID0" TITLE="link to list of functions that return this type ID"><I>addressSpaceID</I></A> of type <I>xsd:string</I></LI>
3750
<LI>Legal value: <A HREF="#alternateRegisterID0" TITLE="link to list of functions that return this type ID"><I>alternateRegisterID</I></A> of type <I>xsd:string</I></LI>
3751
<LI>Legal value: <A HREF="#argumentID0" TITLE="link to list of functions that return this type ID"><I>argumentID</I></A> of type <I>xsd:string</I></LI>
3752
<LI>Legal value: <A HREF="#bankID0" TITLE="link to list of functions that return this type ID"><I>bankID</I></A> of type <I>xsd:string</I></LI>
3753
<LI>Legal value: <A HREF="#channelID0" TITLE="link to list of functions that return this type ID"><I>channelID</I></A> of type <I>xsd:string</I></LI>
3754
<LI>Legal value: <A HREF="#cpuID0" TITLE="link to list of functions that return this type ID"><I>cpuID</I></A> of type <I>xsd:string</I></LI>
3755
<LI>Legal value: <A HREF="#fileDefineID0" TITLE="link to list of functions that return this type ID"><I>fileDefineID</I></A> of type <I>xsd:string</I></LI>
3756
<LI>Legal value: <A HREF="#fileSetID0" TITLE="link to list of functions that return this type ID"><I>fileSetID</I></A> of type <I>xsd:string</I></LI>
3757
<LI>Legal value: <A HREF="#generatorID0" TITLE="link to list of functions that return this type ID"><I>generatorID</I></A> of type <I>xsd:string</I></LI>
3758
<LI>Legal value: <A HREF="#interconnectionID0" TITLE="link to list of functions that return this type ID"><I>interconnectionID</I></A> of type <I>xsd:string</I></LI>
3759
<LI>Legal value: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I></LI>
3760
<LI>Legal value: <A HREF="#localMemoryMapID0" TITLE="link to list of functions that return this type ID"><I>localMemoryMapID</I></A> of type <I>xsd:string</I></LI>
3761
<LI>Legal value: <A HREF="#memoryMapID0" TITLE="link to list of functions that return this type ID"><I>memoryMapID</I></A> of type <I>xsd:string</I></LI>
3762
<LI>Legal value: <A HREF="#memoryRemapID0" TITLE="link to list of functions that return this type ID"><I>memoryRemapID</I></A> of type <I>xsd:string</I></LI>
3763
<LI>Legal value: <A HREF="#monitorInterconnectionID0" TITLE="link to list of functions that return this type ID"><I>monitorInterconnectionID</I></A> of type <I>xsd:string</I></LI>
3764
<LI>Legal value: <A HREF="#parameterID0" TITLE="link to list of functions that return this type ID"><I>parameterID</I></A> of type <I>xsd:string</I></LI>
3765
<LI>Legal value: <A HREF="#portConstraintSetID0" TITLE="link to list of functions that return this type ID"><I>portConstraintSetID</I></A> of type <I>xsd:string</I></LI>
3766
<LI>Legal value: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I></LI>
3767
<LI>Legal value: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I></LI>
3768
<LI>Legal value: <A HREF="#regFieldValueID0" TITLE="link to list of functions that return this type ID"><I>regFieldValueID</I></A> of type <I>xsd:string</I></LI>
3769
<LI>Legal value: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I></LI>
3770
<LI>Legal value: <A HREF="#registerFileID0" TITLE="link to list of functions that return this type ID"><I>registerFileID</I></A> of type <I>xsd:string</I></LI>
3771
<LI>Legal value: <A HREF="#remapStateID0" TITLE="link to list of functions that return this type ID"><I>remapStateID</I></A> of type <I>xsd:string</I></LI>
3772
<LI>Legal value: <A HREF="#segmentID0" TITLE="link to list of functions that return this type ID"><I>segmentID</I></A> of type <I>xsd:string</I></LI>
3773
<LI>Legal value: <A HREF="#subspaceMapID0" TITLE="link to list of functions that return this type ID"><I>subspaceMapID</I></A> of type <I>xsd:string</I></LI>
3774
<LI>Legal value: <A HREF="#viewID0" TITLE="link to list of functions that return this type ID"><I>viewID</I></A> of type <I>xsd:string</I></LI>
3775
<LI>Legal value: <A HREF="#whiteboxElementID0" TITLE="link to list of functions that return this type ID"><I>whiteboxElementID</I></A> of type <I>xsd:string</I></LI>
3776
</UL>
3777
</UL>
3778
<A NAME ="elementID0">
3779
<A NAME ="addressBlockUID0">
3780
<A NAME ="addressSpaceUID0">
3781
<A NAME ="alternateRegisterUID0">
3782
<A NAME ="argumentUID0">
3783
<A NAME ="bankUID0">
3784
<A NAME ="clockDriverUID0">
3785
<A NAME ="executableImageUID0">
3786
<A NAME ="fileBuilderUID0">
3787
<A NAME ="fileDefineUID0">
3788
<A NAME ="fileUID0">
3789
<A NAME ="functionUID0">
3790
<A NAME ="interfaceUID0">
3791
<A NAME ="linkerCommandFileUID0">
3792
<A NAME ="parameterUID0">
3793
<A NAME ="portUID0">
3794
<A NAME ="portMapUID0">
3795
<A NAME ="regFieldUID0">
3796
<A NAME ="registerUID0">
3797
<A NAME ="registerFileUID0">
3798
<A NAME ="segmentUID0">
3799
<A NAME ="singleShotDriverUID0">
3800
<A NAME ="subspaceMapUID0">
3801
<BR><H3><A NAME="getUnconfiguredID">getUnconfiguredID</A></H3>
3802
Description: Return the unconfigured ID from a configured ID<B>- New in 1.5</B>
3803
<UL>
3804
<LI>Returns: <I>elementID</I> of type <I>xsd:string</I> -- Unconfigured ID</LI>
3805
<UL>
3806
<LI>Possible value(s): <I>addressBlockUID</I> of type <I>xsd:string</I></LI>
3807
</UL>
3808
<UL>
3809
<LI>Possible value(s): <I>addressSpaceUID</I> of type <I>xsd:string</I></LI>
3810
</UL>
3811
<UL>
3812
<LI>Possible value(s): <I>alternateRegisterUID</I> of type <I>xsd:string</I></LI>
3813
</UL>
3814
<UL>
3815
<LI>Possible value(s): <I>argumentUID</I> of type <I>xsd:string</I></LI>
3816
</UL>
3817
<UL>
3818
<LI>Possible value(s): <I>bankUID</I> of type <I>xsd:string</I></LI>
3819
</UL>
3820
<UL>
3821
<LI>Possible value(s): <I>clockDriverUID</I> of type <I>xsd:string</I></LI>
3822
</UL>
3823
<UL>
3824
<LI>Possible value(s): <I>executableImageUID</I> of type <I>xsd:string</I></LI>
3825
</UL>
3826
<UL>
3827
<LI>Possible value(s): <I>fileBuilderUID</I> of type <I>xsd:string</I></LI>
3828
</UL>
3829
<UL>
3830
<LI>Possible value(s): <I>fileDefineUID</I> of type <I>xsd:string</I></LI>
3831
</UL>
3832
<UL>
3833
<LI>Possible value(s): <I>fileUID</I> of type <I>xsd:string</I></LI>
3834
</UL>
3835
<UL>
3836
<LI>Possible value(s): <I>functionUID</I> of type <I>xsd:string</I></LI>
3837
</UL>
3838
<UL>
3839
<LI>Possible value(s): <I>interfaceUID</I> of type <I>xsd:string</I></LI>
3840
</UL>
3841
<UL>
3842
<LI>Possible value(s): <I>linkerCommandFileUID</I> of type <I>xsd:string</I></LI>
3843
</UL>
3844
<UL>
3845
<LI>Possible value(s): <I>parameterUID</I> of type <I>xsd:string</I></LI>
3846
</UL>
3847
<UL>
3848
<LI>Possible value(s): <I>portUID</I> of type <I>xsd:string</I></LI>
3849
</UL>
3850
<UL>
3851
<LI>Possible value(s): <I>portMapUID</I> of type <I>xsd:string</I></LI>
3852
</UL>
3853
<UL>
3854
<LI>Possible value(s): <I>regFieldUID</I> of type <I>xsd:string</I></LI>
3855
</UL>
3856
<UL>
3857
<LI>Possible value(s): <I>registerUID</I> of type <I>xsd:string</I></LI>
3858
</UL>
3859
<UL>
3860
<LI>Possible value(s): <I>registerFileUID</I> of type <I>xsd:string</I></LI>
3861
</UL>
3862
<UL>
3863
<LI>Possible value(s): <I>segmentUID</I> of type <I>xsd:string</I></LI>
3864
</UL>
3865
<UL>
3866
<LI>Possible value(s): <I>singleShotDriverUID</I> of type <I>xsd:string</I></LI>
3867
</UL>
3868
<UL>
3869
<LI>Possible value(s): <I>subspaceMapUID</I> of type <I>xsd:string</I></LI>
3870
</UL>
3871
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3872
<UL>
3873
<LI>Legal value: <A HREF="#addressBlockID0" TITLE="link to list of functions that return this type ID"><I>addressBlockID</I></A> of type <I>xsd:string</I></LI>
3874
<LI>Legal value: <A HREF="#addressSpaceID0" TITLE="link to list of functions that return this type ID"><I>addressSpaceID</I></A> of type <I>xsd:string</I></LI>
3875
<LI>Legal value: <A HREF="#alternateRegisterID0" TITLE="link to list of functions that return this type ID"><I>alternateRegisterID</I></A> of type <I>xsd:string</I></LI>
3876
<LI>Legal value: <A HREF="#argumentID0" TITLE="link to list of functions that return this type ID"><I>argumentID</I></A> of type <I>xsd:string</I></LI>
3877
<LI>Legal value: <A HREF="#bankID0" TITLE="link to list of functions that return this type ID"><I>bankID</I></A> of type <I>xsd:string</I></LI>
3878
<LI>Legal value: <A HREF="#clockDriverID0" TITLE="link to list of functions that return this type ID"><I>clockDriverID</I></A> of type <I>xsd:string</I></LI>
3879
<LI>Legal value: <A HREF="#executableImageID0" TITLE="link to list of functions that return this type ID"><I>executableImageID</I></A> of type <I>xsd:string</I></LI>
3880
<LI>Legal value: <A HREF="#fileDefineID0" TITLE="link to list of functions that return this type ID"><I>fileDefineID</I></A> of type <I>xsd:string</I></LI>
3881
<LI>Legal value: <A HREF="#fileBuilderID0" TITLE="link to list of functions that return this type ID"><I>fileBuilderID</I></A> of type <I>xsd:string</I></LI>
3882
<LI>Legal value: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I></LI>
3883
<LI>Legal value: <A HREF="#functionID0" TITLE="link to list of functions that return this type ID"><I>functionID</I></A> of type <I>xsd:string</I></LI>
3884
<LI>Legal value: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I></LI>
3885
<LI>Legal value: <A HREF="#linkerCommandFileID0" TITLE="link to list of functions that return this type ID"><I>linkerCommandFileID</I></A> of type <I>xsd:string</I></LI>
3886
<LI>Legal value: <A HREF="#parameterID0" TITLE="link to list of functions that return this type ID"><I>parameterID</I></A> of type <I>xsd:string</I></LI>
3887
<LI>Legal value: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I></LI>
3888
<LI>Legal value: <A HREF="#portMapID0" TITLE="link to list of functions that return this type ID"><I>portMapID</I></A> of type <I>xsd:string</I></LI>
3889
<LI>Legal value: <A HREF="#regFieldID0" TITLE="link to list of functions that return this type ID"><I>regFieldID</I></A> of type <I>xsd:string</I></LI>
3890
<LI>Legal value: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I></LI>
3891
<LI>Legal value: <A HREF="#registerFileID0" TITLE="link to list of functions that return this type ID"><I>registerFileID</I></A> of type <I>xsd:string</I></LI>
3892
<LI>Legal value: <A HREF="#segmentID0" TITLE="link to list of functions that return this type ID"><I>segmentID</I></A> of type <I>xsd:string</I></LI>
3893
<LI>Legal value: <A HREF="#singleShotDriverID0" TITLE="link to list of functions that return this type ID"><I>singleShotDriverID</I></A> of type <I>xsd:string</I></LI>
3894
<LI>Legal value: <A HREF="#subspaceMapID0" TITLE="link to list of functions that return this type ID"><I>subspaceMapID</I></A> of type <I>xsd:string</I></LI>
3895
</UL>
3896
</UL>
3897
<A NAME ="value57">
3898
<BR><H3><A NAME="getChoiceName">getChoiceName</A></H3>
3899
Description: Name of the choice<B>&nbsp;</B>
3900
<UL>
3901
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3902
<LI>Input: <A HREF="#choiceID0" TITLE="link to list of functions that return this type ID"><I>choiceID</I></A> of type <I>xsd:string</I> </LI>
3903
</UL>
3904
<A NAME ="choiceEnumerationID0">
3905
<BR><H3><A NAME="getChoiceEnumerationIDs">getChoiceEnumerationIDs</A></H3>
3906
Description: List of choice enumeration IDs of the choice<B>&nbsp;</B>
3907
<UL>
3908
<LI>Returns: <I>choiceEnumerationIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
3909
<LI>Input: <A HREF="#choiceID0" TITLE="link to list of functions that return this type ID"><I>choiceID</I></A> of type <I>xsd:string</I> </LI>
3910
</UL>
3911
<A NAME ="value58">
3912
<BR><H3><A NAME="getChoiceEnumerationValue">getChoiceEnumerationValue</A></H3>
3913
Description: Value of the enumeration element<B>&nbsp;</B>
3914
<UL>
3915
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
3916
<LI>Input: <A HREF="#choiceEnumerationID0" TITLE="link to list of functions that return this type ID"><I>choiceEnumerationID</I></A> of type <I>xsd:string</I> </LI>
3917
</UL>
3918
<A NAME ="text0">
3919
<BR><H3><A NAME="getChoiceEnumerationText">getChoiceEnumerationText</A></H3>
3920
Description: Value of the enumeration text attribute<B>&nbsp;</B>
3921
<UL>
3922
<LI>Returns: <I>text</I> of type <I>xsd:string</I> </LI>
3923
<LI>Input: <A HREF="#choiceEnumerationID0" TITLE="link to list of functions that return this type ID"><I>choiceEnumerationID</I></A> of type <I>xsd:string</I> </LI>
3924
</UL>
3925
<A NAME ="help0">
3926
<BR><H3><A NAME="getChoiceEnumerationHelp">getChoiceEnumerationHelp</A></H3>
3927
Description: Value of the enumeration help attribute<B>&nbsp;</B>
3928
<UL>
3929
<LI>Returns: <I>help</I> of type <I>xsd:string</I> </LI>
3930
<LI>Input: <A HREF="#choiceEnumerationID0" TITLE="link to list of functions that return this type ID"><I>choiceEnumerationID</I></A> of type <I>xsd:string</I> </LI>
3931
</UL>
3932
<A NAME ="status39">
3933
<BR><H3><A NAME="registerVLNV">registerVLNV</A></H3>
3934
Description: Indicate to DE where the file resides for the IP-XACT element with the given VLNV.<B>&nbsp;</B>
3935
<UL>
3936
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> -- True=VLNV registered, False=VLNV not registered</LI>
3937
<LI>Input: <I>fileName</I> of type <I>xsd:string</I> </LI>
3938
<LI>Input: <I>replace</I> of type <I>xsd:boolean</I> -- True=always register, False=do not register if the VLNV already exists</LI>
3939
</UL>
3940
<A NAME ="xmlText2">
3941
<BR><H3><A NAME="getXMLForVLNV">getXMLForVLNV</A></H3>
3942
Description: Return XML of the IP-XACT object identified by the given VLNV.<B>&nbsp;</B>
3943
<UL>
3944
<LI>Returns: <I>xmlText</I> of type <I>xsd:string</I> </LI>
3945
<LI>Input: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
3946
</UL>
3947
<A NAME ="componentInstanceID3">
3948
<BR><H3><A NAME="getGeneratorContextComponentInstanceID">getGeneratorContextComponentInstanceID</A></H3>
3949
Description: ID for the component instance associated with the currently invoked generator<B>&nbsp;</B>
3950
<UL>
3951
<LI>Returns: <B><A HREF="#componentInstanceID0" TITLE="last function the returns this type ID in list"><I>componentInstanceID</I></A></B> of type <I>xsd:string</I> </LI>
3952
<LI>Input: <I>generatorName</I> of type <I>xsd:string</I> -- Generator name for use within DE in case of errors</LI>
3953
</UL>
3954
<A NAME ="status40">
3955
<BR><H3><A NAME="init">init</A></H3>
3956
Description: API initialization function. Must be called before any other API call.<B>&nbsp;</B>
3957
<UL>
3958
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
3959
<LI>Input: <I>apiVersion</I> of type <I>xsd:string</I> -- Indicates the API version the generator is defined to work with.</LI>
3960
<LI>Input: <I>failureMode</I> of type <I>spirit:apiFailureMode</I> -- Compatability failure mode: fail -- DE should return an error on the init call if it's API version does not match the one passed to the init call, error -- DE should return an error each time a potentially incompatible API call is made, warning -- DE should increment a warning count each time a potentially incompatible API call is made</LI>
3961
<LI>Input: <I>message</I> of type <I>xsd:string</I> -- Message which the DE may display to the user.</LI>
3962
</UL>
3963
<A NAME ="status41">
3964
<BR><H3><A NAME="message">message</A></H3>
3965
Description: Send message level and message text to Design Environment.<B>&nbsp;</B>
3966
<UL>
3967
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
3968
<LI>Input: <I>severity</I> of type <I>xsd:string</I> </LI>
3969
<LI>Input: <I>message</I> of type <I>xsd:string</I> </LI>
3970
</UL>
3971
<A NAME ="message0">
3972
<BR><H3><A NAME="getErrorMessage">getErrorMessage</A></H3>
3973
Description: Get error message from prior callback.<B>&nbsp;</B>
3974
<UL>
3975
<LI>Returns: <I>message</I> of type <I>xsd:string</I> </LI>
3976
<LI>Input: <I>callerIdent</I> of type <I>xsd:string</I> -- ID string for debugging calls to this command within the DE. Any value is okay.</LI>
3977
</UL>
3978
<A NAME ="count0">
3979
<BR><H3><A NAME="getWarningCount">getWarningCount</A></H3>
3980
Description: Return count of how many potentially incompatible API calls have been made.<B>&nbsp;</B>
3981
<UL>
3982
<LI>Returns: <I>count</I> of type <I>xsd:integer</I> </LI>
3983
<LI>Input: <I>callerIdent</I> of type <I>xsd:string</I> -- ID string for debugging calls to this command within the DE. Any value is okay.</LI>
3984
</UL>
3985
<A NAME ="de_status0">
3986
<BR><H3><A NAME="end">end</A></H3>
3987
Description: Terminate connection to the Design Environment.<B>&nbsp;</B>
3988
<UL>
3989
<LI>Returns: <I>de_status</I> of type <I>xsd:integer</I> -- Status indicator from the DE. Non-zero implies an error.</LI>
3990
<LI>Input: <I>gen_status</I> of type <I>xsd:integer</I> -- Status indicator from the generator. Non-zero implies an error.</LI>
3991
<LI>Input: <I>message</I> of type <I>xsd:string</I> -- Message which the DE may display to the user.</LI>
3992
</UL>
3993
<A NAME ="status42">
3994
<BR><H3><A NAME="setVendorExtensions">setVendorExtensions</A></H3>
3995
Description: Set vendor extensions. NOTE: This call is only supported for elements within a spirit:design.<B>&nbsp;</B>
3996
<UL>
3997
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
3998
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
3999
<UL>
4000
<LI>Legal value: <A HREF="#componentInstanceID0" TITLE="link to list of functions that return this type ID"><I>componentInstanceID</I></A> of type <I>xsd:string</I></LI>
4001
<LI>Legal value: <A HREF="#designID0" TITLE="link to list of functions that return this type ID"><I>designID</I></A> of type <I>xsd:string</I></LI>
4002
<LI>Legal value: <A HREF="#hierConnectionID0" TITLE="link to list of functions that return this type ID"><I>hierConnectionID</I></A> of type <I>xsd:string</I></LI>
4003
</UL>
4004
<LI>Input: <I>extensionText</I> of type <I>xsd:string</I> -- Complete vendor extension text as a well formed XML document with top-level element of spirit:vendorExtensions</LI>
4005
</UL>
4006
<A NAME ="status43">
4007
<BR><H3><A NAME="setVendorAttribute">setVendorAttribute</A></H3>
4008
Description: Set vendor defined attribute on the given element<B>&nbsp;</B>
4009
<UL>
4010
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
4011
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4012
<UL>
4013
<LI>Legal value: <A HREF="#argumentID0" TITLE="link to list of functions that return this type ID"><I>argumentID</I></A> of type <I>xsd:string</I></LI>
4014
<LI>Legal value: <A HREF="#fileDefineID0" TITLE="link to list of functions that return this type ID"><I>fileDefineID</I></A> of type <I>xsd:string</I></LI>
4015
<LI>Legal value: <A HREF="#fileID0" TITLE="link to list of functions that return this type ID"><I>fileID</I></A> of type <I>xsd:string</I></LI>
4016
<LI>Legal value: <A HREF="#interfaceID0" TITLE="link to list of functions that return this type ID"><I>interfaceID</I></A> of type <I>xsd:string</I></LI>
4017
<LI>Legal value: <A HREF="#parameterID0" TITLE="link to list of functions that return this type ID"><I>parameterID</I></A> of type <I>xsd:string</I></LI>
4018
</UL>
4019
<LI>Input: <I>attrName</I> of type <I>xsd:string</I> </LI>
4020
<LI>Input: <I>attrValue</I> of type <I>xsd:string</I> </LI>
4021
</UL>
4022
<A NAME ="status44">
4023
<BR><H3><A NAME="setValue">setValue</A></H3>
4024
Description: Set the value of a parameterID, fileDefineIDs or argumentIDs.<B>&nbsp;</B>
4025
<UL>
4026
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
4027
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4028
<UL>
4029
<LI>Legal value: <A HREF="#argumentID0" TITLE="link to list of functions that return this type ID"><I>argumentID</I></A> of type <I>xsd:string</I></LI>
4030
<LI>Legal value: <A HREF="#fileDefineID0" TITLE="link to list of functions that return this type ID"><I>fileDefineID</I></A> of type <I>xsd:string</I></LI>
4031
<LI>Legal value: <A HREF="#parameterID0" TITLE="link to list of functions that return this type ID"><I>parameterID</I></A> of type <I>xsd:string</I></LI>
4032
</UL>
4033
<LI>Input: <I>value</I> of type <I>xsd:string</I> </LI>
4034
</UL>
4035
<P>
4036
<table width="100%"><TR><TD bgcolor=#b8b8ff>
4037
<BR><H2>Port Operations</H2>
4038
</TD></TR></TABLE>
4039
<A NAME ="value59">
4040
<BR><H3><A NAME="getPortStyle">getPortStyle</A></H3>
4041
Description: Returns 'wire' or 'transactional' to indicate the port style<B>&nbsp;</B>
4042
<UL>
4043
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
4044
<LI>Input: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I> </LI>
4045
</UL>
4046
<A NAME ="booleanValue20">
4047
<BR><H3><A NAME="getAllLogicalDirectionsAllowed">getAllLogicalDirectionsAllowed</A></H3>
4048
Description: Get the value of the allLogicalDirectionAllowed attribute<B>- New in 1.5</B>
4049
<UL>
4050
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
4051
<LI>Input: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I> </LI>
4052
</UL>
4053
<A NAME ="value60">
4054
<BR><H3><A NAME="getPortDirection">getPortDirection</A></H3>
4055
Description: Direction of the port<B>&nbsp;</B>
4056
<UL>
4057
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
4058
<LI>Input: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I> </LI>
4059
</UL>
4060
<A NAME ="integerArrayValue2">
4061
<BR><H3><A NAME="getPortRange">getPortRange</A></H3>
4062
Description: List of the left and right range of the port<B>&nbsp;</B>
4063
<UL>
4064
<LI>Returns: <I>integerArrayValue</I> of type <I>spirit:integerArrayType</I> -- array of left and right or zero element array if not specified</LI>
4065
<LI>Input: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I> </LI>
4066
</UL>
4067
<A NAME ="wireTypeDefID0">
4068
<BR><H3><A NAME="getPortWireTypeDefIDs">getPortWireTypeDefIDs</A></H3>
4069
Description: List of typeDefs for a wire portID<B>- New in 1.5</B>
4070
<UL>
4071
<LI>Returns: <I>wireTypeDefIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
4072
<LI>Input: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I> </LI>
4073
</UL>
4074
<A NAME ="transactionalTypeDefID0">
4075
<BR><H3><A NAME="getPortTransactionalTypeDefID">getPortTransactionalTypeDefID</A></H3>
4076
Description: The type definition for a transactional portID<B>- New in 1.5</B>
4077
<UL>
4078
<LI>Returns: <I>transactionalTypeDefID</I> of type <I>xsd:string</I> </LI>
4079
<LI>Input: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I> </LI>
4080
</UL>
4081
<A NAME ="serviceID0">
4082
<BR><H3><A NAME="getPortServiceID">getPortServiceID</A></H3>
4083
Description: ID of element representing the service of a transactional port<B>&nbsp;</B>
4084
<UL>
4085
<LI>Returns: <I>serviceID</I> of type <I>xsd:string</I> </LI>
4086
<LI>Input: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I> </LI>
4087
</UL>
4088
<A NAME ="accessType0">
4089
<BR><H3><A NAME="getPortAccessType">getPortAccessType</A></H3>
4090
Description: Indicates the access type for this port<B>- Modified in 1.5</B>
4091
<UL>
4092
<LI>Returns: <I>accessType</I> of type <I>xsd:string</I> </LI>
4093
<LI>Input: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I> </LI>
4094
</UL>
4095
<A NAME ="accessHandle0">
4096
<BR><H3><A NAME="getPortAccessHandle">getPortAccessHandle</A></H3>
4097
Description: Alternate name to be used when accessing this port<B>- Modified in 1.5</B>
4098
<UL>
4099
<LI>Returns: <I>accessHandle</I> of type <I>xsd:string</I> </LI>
4100
<LI>Input: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I> </LI>
4101
</UL>
4102
<A NAME ="value61">
4103
<BR><H3><A NAME="getPortMaxAllowedConnections">getPortMaxAllowedConnections</A></H3>
4104
Description: Max allowed connections for this transactional port<B>&nbsp;</B>
4105
<UL>
4106
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
4107
<LI>Input: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I> </LI>
4108
</UL>
4109
<A NAME ="value62">
4110
<BR><H3><A NAME="getPortMinAllowedConnections">getPortMinAllowedConnections</A></H3>
4111
Description: Min allowed connections for this transactional port<B>&nbsp;</B>
4112
<UL>
4113
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
4114
<LI>Input: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I> </LI>
4115
</UL>
4116
<A NAME ="value63">
4117
<BR><H3><A NAME="getPortDefaultValue">getPortDefaultValue</A></H3>
4118
Description: Default value of the port, if not set returns ""<B>&nbsp;</B>
4119
<UL>
4120
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
4121
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4122
<UL>
4123
<LI>Legal value: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I></LI>
4124
<LI>Legal value: <A HREF="#portUID0" TITLE="link to list of functions that return this type ID"><I>portUID</I></A> of type <I>xsd:string</I></LI>
4125
</UL>
4126
</UL>
4127
<A NAME ="clockDriverID1">
4128
<BR><H3><A NAME="getPortClockDriverID">getPortClockDriverID</A></H3>
4129
Description: Element ID of clock driver element, if present<B>&nbsp;</B>
4130
<UL>
4131
<LI>Returns: <B><A HREF="#clockDriverID0" TITLE="last function the returns this type ID in list"><I>clockDriverID</I></A></B> of type <I>xsd:string</I> </LI>
4132
<LI>Input: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I> </LI>
4133
</UL>
4134
<A NAME ="floatValue2">
4135
<BR><H3><A NAME="getClockDriverPeriod">getClockDriverPeriod</A></H3>
4136
Description: Clock period of the given clock<B>&nbsp;</B>
4137
<UL>
4138
<LI>Returns: <I>floatValue</I> of type <I>xsd:float</I> </LI>
4139
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4140
<UL>
4141
<LI>Legal value: <A HREF="#clockDriverID0" TITLE="link to list of functions that return this type ID"><I>clockDriverID</I></A> of type <I>xsd:string</I></LI>
4142
<LI>Legal value: <A HREF="#clockDriverUID0" TITLE="link to list of functions that return this type ID"><I>clockDriverUID</I></A> of type <I>xsd:string</I></LI>
4143
</UL>
4144
</UL>
4145
<A NAME ="units0">
4146
<BR><H3><A NAME="getClockDriverPeriodUnits">getClockDriverPeriodUnits</A></H3>
4147
Description: Units of the clock period of the given clock<B>- New in 1.5</B>
4148
<UL>
4149
<LI>Returns: <I>units</I> of type <I>xsd:string</I> </LI>
4150
<LI>Input: <A HREF="#clockDriverID0" TITLE="link to list of functions that return this type ID"><I>clockDriverID</I></A> of type <I>xsd:string</I> </LI>
4151
</UL>
4152
<A NAME ="floatValue3">
4153
<BR><H3><A NAME="getClockDriverPulseOffset">getClockDriverPulseOffset</A></H3>
4154
Description: Clock pulse offset of the given clock<B>&nbsp;</B>
4155
<UL>
4156
<LI>Returns: <I>floatValue</I> of type <I>xsd:float</I> </LI>
4157
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4158
<UL>
4159
<LI>Legal value: <A HREF="#clockDriverID0" TITLE="link to list of functions that return this type ID"><I>clockDriverID</I></A> of type <I>xsd:string</I></LI>
4160
<LI>Legal value: <A HREF="#clockDriverUID0" TITLE="link to list of functions that return this type ID"><I>clockDriverUID</I></A> of type <I>xsd:string</I></LI>
4161
</UL>
4162
</UL>
4163
<A NAME ="units1">
4164
<BR><H3><A NAME="getClockDriverPulseOffsetUnits">getClockDriverPulseOffsetUnits</A></H3>
4165
Description: Units of the clock pulse offset of the given clock<B>- New in 1.5</B>
4166
<UL>
4167
<LI>Returns: <I>units</I> of type <I>xsd:string</I> </LI>
4168
<LI>Input: <A HREF="#clockDriverID0" TITLE="link to list of functions that return this type ID"><I>clockDriverID</I></A> of type <I>xsd:string</I> </LI>
4169
</UL>
4170
<A NAME ="spiritNumberTypeValue3">
4171
<BR><H3><A NAME="getClockDriverPulseValue">getClockDriverPulseValue</A></H3>
4172
Description: Clock pulse value of the given clock<B>&nbsp;</B>
4173
<UL>
4174
<LI>Returns: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
4175
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4176
<UL>
4177
<LI>Legal value: <A HREF="#clockDriverID0" TITLE="link to list of functions that return this type ID"><I>clockDriverID</I></A> of type <I>xsd:string</I></LI>
4178
<LI>Legal value: <A HREF="#clockDriverUID0" TITLE="link to list of functions that return this type ID"><I>clockDriverUID</I></A> of type <I>xsd:string</I></LI>
4179
</UL>
4180
</UL>
4181
<A NAME ="floatValue4">
4182
<BR><H3><A NAME="getClockDriverPulseDuration">getClockDriverPulseDuration</A></H3>
4183
Description: Clock period of the given clock<B>&nbsp;</B>
4184
<UL>
4185
<LI>Returns: <I>floatValue</I> of type <I>xsd:float</I> </LI>
4186
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4187
<UL>
4188
<LI>Legal value: <A HREF="#clockDriverID0" TITLE="link to list of functions that return this type ID"><I>clockDriverID</I></A> of type <I>xsd:string</I></LI>
4189
<LI>Legal value: <A HREF="#clockDriverUID0" TITLE="link to list of functions that return this type ID"><I>clockDriverUID</I></A> of type <I>xsd:string</I></LI>
4190
</UL>
4191
</UL>
4192
<A NAME ="units2">
4193
<BR><H3><A NAME="getClockDriverPulseDurationUnits">getClockDriverPulseDurationUnits</A></H3>
4194
Description: Units of the clock pulse duration of the given clock<B>- New in 1.5</B>
4195
<UL>
4196
<LI>Returns: <I>units</I> of type <I>xsd:string</I> </LI>
4197
<LI>Input: <A HREF="#clockDriverID0" TITLE="link to list of functions that return this type ID"><I>clockDriverID</I></A> of type <I>xsd:string</I> </LI>
4198
</UL>
4199
<A NAME ="value64">
4200
<BR><H3><A NAME="getClockDriverName">getClockDriverName</A></H3>
4201
Description: Name of the clock driver<B>&nbsp;</B>
4202
<UL>
4203
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
4204
<LI>Input: <A HREF="#clockDriverID0" TITLE="link to list of functions that return this type ID"><I>clockDriverID</I></A> of type <I>xsd:string</I> </LI>
4205
</UL>
4206
<A NAME ="value65">
4207
<BR><H3><A NAME="getClockDriverSource">getClockDriverSource</A></H3>
4208
Description: Source name of the clock driver<B>&nbsp;</B>
4209
<UL>
4210
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
4211
<LI>Input: <A HREF="#clockDriverID0" TITLE="link to list of functions that return this type ID"><I>clockDriverID</I></A> of type <I>xsd:string</I> </LI>
4212
</UL>
4213
<A NAME ="singleShotDriverID0">
4214
<BR><H3><A NAME="getPortSingleShotDriverID">getPortSingleShotDriverID</A></H3>
4215
Description: Element ID of single shot driver element, if present<B>&nbsp;</B>
4216
<UL>
4217
<LI>Returns: <I>singleShotDriverID</I> of type <I>xsd:string</I> </LI>
4218
<LI>Input: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I> </LI>
4219
</UL>
4220
<A NAME ="floatValue5">
4221
<BR><H3><A NAME="getPortSingleShotPulseOffset">getPortSingleShotPulseOffset</A></H3>
4222
Description: Clock pulse offset of the port<B>&nbsp;</B>
4223
<UL>
4224
<LI>Returns: <I>floatValue</I> of type <I>xsd:float</I> </LI>
4225
<LI>Input: <A HREF="#singleShotDriverID0" TITLE="link to list of functions that return this type ID"><I>singleShotDriverID</I></A> of type <I>xsd:string</I> </LI>
4226
</UL>
4227
<A NAME ="spiritNumberTypeValue4">
4228
<BR><H3><A NAME="getPortSingleShotPulseValue">getPortSingleShotPulseValue</A></H3>
4229
Description: Clock pulse value of the port<B>&nbsp;</B>
4230
<UL>
4231
<LI>Returns: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
4232
<LI>Input: <A HREF="#singleShotDriverID0" TITLE="link to list of functions that return this type ID"><I>singleShotDriverID</I></A> of type <I>xsd:string</I> </LI>
4233
</UL>
4234
<A NAME ="floatValue6">
4235
<BR><H3><A NAME="getPortSingleShotPulseDuration">getPortSingleShotPulseDuration</A></H3>
4236
Description: Clock period of the port<B>&nbsp;</B>
4237
<UL>
4238
<LI>Returns: <I>floatValue</I> of type <I>xsd:float</I> </LI>
4239
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4240
<UL>
4241
<LI>Legal value: <A HREF="#singleShotDriverID0" TITLE="link to list of functions that return this type ID"><I>singleShotDriverID</I></A> of type <I>xsd:string</I></LI>
4242
<LI>Legal value: <A HREF="#singleShotDriverUID0" TITLE="link to list of functions that return this type ID"><I>singleShotDriverUID</I></A> of type <I>xsd:string</I></LI>
4243
</UL>
4244
</UL>
4245
<A NAME ="portConstraintSetID0">
4246
<BR><H3><A NAME="getPortConstraintSetIDs">getPortConstraintSetIDs</A></H3>
4247
Description: List of constraint sets IDs of the port<B>&nbsp;</B>
4248
<UL>
4249
<LI>Returns: <A HREF="#portConstraintSetID1" TITLE="link to another function that returns this type ID"><I>portConstraintSetIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
4250
<LI>Input: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I> </LI>
4251
</UL>
4252
<A NAME ="status45">
4253
<BR><H3><A NAME="setPortRange">setPortRange</A></H3>
4254
Description: Set left/right range for the given port.<B>&nbsp;</B>
4255
<UL>
4256
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
4257
<LI>Input: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I> </LI>
4258
<LI>Input: <I>integerArrayMessage</I> of type <I>spirit:integerArrayType</I> </LI>
4259
</UL>
4260
<A NAME ="status46">
4261
<BR><H3><A NAME="setPortDefaultValue">setPortDefaultValue</A></H3>
4262
Description: Set default value of the given port.<B>&nbsp;</B>
4263
<UL>
4264
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
4265
<LI>Input: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I> </LI>
4266
<LI>Input: <I>value</I> of type <I>xsd:string</I> </LI>
4267
</UL>
4268
<A NAME ="status47">
4269
<BR><H3><A NAME="setClockDriverPeriod">setClockDriverPeriod</A></H3>
4270
Description: Set period of the given clock port.<B>&nbsp;</B>
4271
<UL>
4272
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
4273
<LI>Input: <A HREF="#clockDriverID0" TITLE="link to list of functions that return this type ID"><I>clockDriverID</I></A> of type <I>xsd:string</I> </LI>
4274
<LI>Input: <I>floatValue</I> of type <I>xsd:float</I> </LI>
4275
</UL>
4276
<A NAME ="status48">
4277
<BR><H3><A NAME="setClockDriverPulseOffset">setClockDriverPulseOffset</A></H3>
4278
Description: Set pulse offset value of the given clock port.<B>&nbsp;</B>
4279
<UL>
4280
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
4281
<LI>Input: <A HREF="#clockDriverID0" TITLE="link to list of functions that return this type ID"><I>clockDriverID</I></A> of type <I>xsd:string</I> </LI>
4282
<LI>Input: <I>floatValue</I> of type <I>xsd:float</I> </LI>
4283
</UL>
4284
<A NAME ="status49">
4285
<BR><H3><A NAME="setClockDriverPulseValue">setClockDriverPulseValue</A></H3>
4286
Description: Set pulse value of the given clock port.<B>&nbsp;</B>
4287
<UL>
4288
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
4289
<LI>Input: <A HREF="#clockDriverID0" TITLE="link to list of functions that return this type ID"><I>clockDriverID</I></A> of type <I>xsd:string</I> </LI>
4290
<LI>Input: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
4291
</UL>
4292
<A NAME ="status50">
4293
<BR><H3><A NAME="setClockDriverPulseDuration">setClockDriverPulseDuration</A></H3>
4294
Description: Set pulse duration of the given clock port.<B>&nbsp;</B>
4295
<UL>
4296
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
4297
<LI>Input: <A HREF="#clockDriverID0" TITLE="link to list of functions that return this type ID"><I>clockDriverID</I></A> of type <I>xsd:string</I> </LI>
4298
<LI>Input: <I>floatValue</I> of type <I>xsd:float</I> </LI>
4299
</UL>
4300
<A NAME ="status51">
4301
<BR><H3><A NAME="setPortSingleShotPulseOffset">setPortSingleShotPulseOffset</A></H3>
4302
Description: Set pulse offset of given single shot port.<B>&nbsp;</B>
4303
<UL>
4304
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
4305
<LI>Input: <A HREF="#singleShotDriverID0" TITLE="link to list of functions that return this type ID"><I>singleShotDriverID</I></A> of type <I>xsd:string</I> </LI>
4306
<LI>Input: <I>floatValue</I> of type <I>xsd:float</I> </LI>
4307
</UL>
4308
<A NAME ="status52">
4309
<BR><H3><A NAME="setPortSingleShotPulseValue">setPortSingleShotPulseValue</A></H3>
4310
Description: Set pulse value of given single shot port.<B>&nbsp;</B>
4311
<UL>
4312
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
4313
<LI>Input: <A HREF="#singleShotDriverID0" TITLE="link to list of functions that return this type ID"><I>singleShotDriverID</I></A> of type <I>xsd:string</I> </LI>
4314
<LI>Input: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
4315
</UL>
4316
<A NAME ="status53">
4317
<BR><H3><A NAME="setPortSingleShotPulseDuration">setPortSingleShotPulseDuration</A></H3>
4318
Description: Set pulse duration of given single shot port.<B>&nbsp;</B>
4319
<UL>
4320
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
4321
<LI>Input: <A HREF="#singleShotDriverID0" TITLE="link to list of functions that return this type ID"><I>singleShotDriverID</I></A> of type <I>xsd:string</I> </LI>
4322
<LI>Input: <I>floatValue</I> of type <I>xsd:float</I> </LI>
4323
</UL>
4324
<P>
4325
<table width="100%"><TR><TD bgcolor=#b8b8ff>
4326
<BR><H2>Register File Operations</H2>
4327
</TD></TR></TABLE>
4328
<A NAME ="dimensions0">
4329
<BR><H3><A NAME="getRegisterFileDimensions">getRegisterFileDimensions</A></H3>
4330
Description: Dimensions of a register file array.<B>- New in 1.5</B>
4331
<UL>
4332
<LI>Returns: <I>dimensions</I> of type <I>spirit:nonNegativeIntegerArrayType</I> </LI>
4333
<LI>Input: <A HREF="#registerFileID0" TITLE="link to list of functions that return this type ID"><I>registerFileID</I></A> of type <I>xsd:string</I> </LI>
4334
</UL>
4335
<A NAME ="offset0">
4336
<BR><H3><A NAME="getRegisterFileAddressOffset">getRegisterFileAddressOffset</A></H3>
4337
Description: The offset from the base address.<B>- New in 1.5</B>
4338
<UL>
4339
<LI>Returns: <I>offset</I> of type <I>spirit:spiritNumberType</I> </LI>
4340
<LI>Input: <A HREF="#registerFileID0" TITLE="link to list of functions that return this type ID"><I>registerFileID</I></A> of type <I>xsd:string</I> </LI>
4341
</UL>
4342
<A NAME ="range3">
4343
<BR><H3><A NAME="getRegisterFileRange">getRegisterFileRange</A></H3>
4344
Description: The register file range in number of addressable units.<B>- New in 1.5</B>
4345
<UL>
4346
<LI>Returns: <I>range</I> of type <I>xsd:positiveInteger</I> </LI>
4347
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4348
<UL>
4349
<LI>Legal value: <A HREF="#registerFileID0" TITLE="link to list of functions that return this type ID"><I>registerFileID</I></A> of type <I>xsd:string</I></LI>
4350
<LI>Legal value: <A HREF="#registerFileUID0" TITLE="link to list of functions that return this type ID"><I>registerFileUID</I></A> of type <I>xsd:string</I></LI>
4351
</UL>
4352
</UL>
4353
<A NAME ="status54">
4354
<BR><H3><A NAME="setRegisterFileRange">setRegisterFileRange</A></H3>
4355
Description: Set the register file range in addressable units.<B>- New in 1.5</B>
4356
<UL>
4357
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
4358
<LI>Input: <A HREF="#registerFileID0" TITLE="link to list of functions that return this type ID"><I>registerFileID</I></A> of type <I>xsd:string</I> </LI>
4359
<LI>Input: <I>range</I> of type <I>xsd:positiveInteger</I> </LI>
4360
</UL>
4361
<A NAME ="registerID1">
4362
<BR><H3><A NAME="getRegisterFileRegisterIDs">getRegisterFileRegisterIDs</A></H3>
4363
Description: List of IDs for the registers of the given register file<B>- New in 1.5</B>
4364
<UL>
4365
<LI>Returns: <A HREF="#registerID2" TITLE="link to another function that returns this type ID"><I>registerIDs</I></A> of type <I>spirit:soapStringArrayType</I> </LI>
4366
<LI>Input: <A HREF="#registerFileID0" TITLE="link to list of functions that return this type ID"><I>registerFileID</I></A> of type <I>xsd:string</I> </LI>
4367
</UL>
4368
<A NAME ="registerFileID1">
4369
<BR><H3><A NAME="getRegisterFileRegisterFileIDs">getRegisterFileRegisterFileIDs</A></H3>
4370
Description: List of IDs for the register files of the given register file<B>- New in 1.5</B>
4371
<UL>
4372
<LI>Returns: <B><A HREF="#registerFileID0" TITLE="last function the returns this type ID in list"><I>registerFileIDs</I></A></B> of type <I>spirit:soapStringArrayType</I> </LI>
4373
<LI>Input: <A HREF="#registerFileID0" TITLE="link to list of functions that return this type ID"><I>registerFileID</I></A> of type <I>xsd:string</I> </LI>
4374
</UL>
4375
<P>
4376
<table width="100%"><TR><TD bgcolor=#b8b8ff>
4377
<BR><H2>Register Operations</H2>
4378
</TD></TR></TABLE>
4379
<A NAME ="dimensions1">
4380
<BR><H3><A NAME="getRegisterDimensions">getRegisterDimensions</A></H3>
4381
Description: Dimensions of a register array.<B>&nbsp;</B>
4382
<UL>
4383
<LI>Returns: <I>dimensions</I> of type <I>spirit:nonNegativeIntegerArrayType</I> </LI>
4384
<LI>Input: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I> </LI>
4385
</UL>
4386
<A NAME ="offset1">
4387
<BR><H3><A NAME="getRegisterAddressOffset">getRegisterAddressOffset</A></H3>
4388
Description: The offset from the base address.<B>&nbsp;</B>
4389
<UL>
4390
<LI>Returns: <I>offset</I> of type <I>spirit:spiritNumberType</I> </LI>
4391
<LI>Input: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I> </LI>
4392
</UL>
4393
<A NAME ="alternateRegisterID0">
4394
<BR><H3><A NAME="getRegisterAlternateRegisterIDs">getRegisterAlternateRegisterIDs</A></H3>
4395
Description: List of IDs for the alternate registers of the given register<B>- New in 1.5</B>
4396
<UL>
4397
<LI>Returns: <I>alternateRegisterIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
4398
<LI>Input: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I> </LI>
4399
</UL>
4400
<A NAME ="value66">
4401
<BR><H3><A NAME="getRegisterAccess">getRegisterAccess</A></H3>
4402
Description: The accessibility of the data in the register<B>&nbsp;</B>
4403
<UL>
4404
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
4405
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4406
<UL>
4407
<LI>Legal value: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I></LI>
4408
<LI>Legal value: <A HREF="#alternateRegisterID0" TITLE="link to list of functions that return this type ID"><I>alternateRegisterID</I></A> of type <I>xsd:string</I></LI>
4409
</UL>
4410
</UL>
4411
<A NAME ="size0">
4412
<BR><H3><A NAME="getRegisterSize">getRegisterSize</A></H3>
4413
Description: The register size in bits.<B>&nbsp;</B>
4414
<UL>
4415
<LI>Returns: <I>size</I> of type <I>xsd:positiveInteger</I> </LI>
4416
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4417
<UL>
4418
<LI>Legal value: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I></LI>
4419
<LI>Legal value: <A HREF="#registerUID0" TITLE="link to list of functions that return this type ID"><I>registerUID</I></A> of type <I>xsd:string</I></LI>
4420
</UL>
4421
</UL>
4422
<A NAME ="status55">
4423
<BR><H3><A NAME="setRegisterSize">setRegisterSize</A></H3>
4424
Description: Set the register size in bits.<B>&nbsp;</B>
4425
<UL>
4426
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
4427
<LI>Input: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I> </LI>
4428
<LI>Input: <I>size</I> of type <I>xsd:positiveInteger</I> </LI>
4429
</UL>
4430
<A NAME ="value67">
4431
<BR><H3><A NAME="getRegisterVolatility">getRegisterVolatility</A></H3>
4432
Description: Indicates whether or not the data is volatile.<B>- Modified in 1.5</B>
4433
<UL>
4434
<LI>Returns: <I>value</I> of type <I>xsd:string</I> -- returns "true", "false" or "".</LI>
4435
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4436
<UL>
4437
<LI>Legal value: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I></LI>
4438
<LI>Legal value: <A HREF="#alternateRegisterID0" TITLE="link to list of functions that return this type ID"><I>alternateRegisterID</I></A> of type <I>xsd:string</I></LI>
4439
</UL>
4440
</UL>
4441
<A NAME ="value68">
4442
<BR><H3><A NAME="getRegisterResetValue">getRegisterResetValue</A></H3>
4443
Description: Register value at reset.<B>- Modified in 1.5</B>
4444
<UL>
4445
<LI>Returns: <I>value</I> of type <I>spirit:spiritNumberType</I> </LI>
4446
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4447
<UL>
4448
<LI>Legal value: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I></LI>
4449
<LI>Legal value: <A HREF="#registerUID0" TITLE="link to list of functions that return this type ID"><I>registerUID</I></A> of type <I>xsd:string</I></LI>
4450
<LI>Legal value: <A HREF="#alternateRegisterID0" TITLE="link to list of functions that return this type ID"><I>alternateRegisterID</I></A> of type <I>xsd:string</I></LI>
4451
<LI>Legal value: <A HREF="#alternateRegisterUID0" TITLE="link to list of functions that return this type ID"><I>alternateRegisterUID</I></A> of type <I>xsd:string</I></LI>
4452
</UL>
4453
</UL>
4454
<A NAME ="status56">
4455
<BR><H3><A NAME="setRegisterResetValue">setRegisterResetValue</A></H3>
4456
Description: Set register value at reset.<B>- Modified in 1.5</B>
4457
<UL>
4458
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
4459
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4460
<UL>
4461
<LI>Legal value: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I></LI>
4462
<LI>Legal value: <A HREF="#alternateRegisterID0" TITLE="link to list of functions that return this type ID"><I>alternateRegisterID</I></A> of type <I>xsd:string</I></LI>
4463
</UL>
4464
<LI>Input: <I>value</I> of type <I>spirit:spiritNumberType</I> </LI>
4465
</UL>
4466
<A NAME ="mask0">
4467
<BR><H3><A NAME="getRegisterResetMask">getRegisterResetMask</A></H3>
4468
Description: Mask to be ANDed with the value before comparing to reset value.<B>- Modified in 1.5</B>
4469
<UL>
4470
<LI>Returns: <I>mask</I> of type <I>spirit:spiritNumberType</I> </LI>
4471
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4472
<UL>
4473
<LI>Legal value: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I></LI>
4474
<LI>Legal value: <A HREF="#registerUID0" TITLE="link to list of functions that return this type ID"><I>registerUID</I></A> of type <I>xsd:string</I></LI>
4475
<LI>Legal value: <A HREF="#alternateRegisterID0" TITLE="link to list of functions that return this type ID"><I>alternateRegisterID</I></A> of type <I>xsd:string</I></LI>
4476
<LI>Legal value: <A HREF="#alternateRegisterUID0" TITLE="link to list of functions that return this type ID"><I>alternateRegisterUID</I></A> of type <I>xsd:string</I></LI>
4477
</UL>
4478
</UL>
4479
<A NAME ="status57">
4480
<BR><H3><A NAME="setRegisterResetMask">setRegisterResetMask</A></H3>
4481
Description: Set the mask to be ANDed with the value before comparing to reset value.<B>- Modified in 1.5</B>
4482
<UL>
4483
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
4484
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4485
<UL>
4486
<LI>Legal value: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I></LI>
4487
<LI>Legal value: <A HREF="#alternateRegisterID0" TITLE="link to list of functions that return this type ID"><I>alternateRegisterID</I></A> of type <I>xsd:string</I></LI>
4488
</UL>
4489
<LI>Input: <I>mask</I> of type <I>spirit:spiritNumberType</I> </LI>
4490
</UL>
4491
<A NAME ="regFieldID0">
4492
<BR><H3><A NAME="getRegisterFieldIDs">getRegisterFieldIDs</A></H3>
4493
Description: List of IDs for the fields of the given register<B>- Modified in 1.5</B>
4494
<UL>
4495
<LI>Returns: <I>regFieldIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
4496
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4497
<UL>
4498
<LI>Legal value: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I></LI>
4499
<LI>Legal value: <A HREF="#alternateRegisterID0" TITLE="link to list of functions that return this type ID"><I>alternateRegisterID</I></A> of type <I>xsd:string</I></LI>
4500
</UL>
4501
<LI>Input: <A HREF="#registerID0" TITLE="link to list of functions that return this type ID"><I>registerID</I></A> of type <I>xsd:string</I> </LI>
4502
</UL>
4503
<A NAME ="groupNames1">
4504
<BR><H3><A NAME="getRegisterAlternateGroups">getRegisterAlternateGroups</A></H3>
4505
Description: Indicates the group names for an alternate register.<B>- New in 1.5</B>
4506
<UL>
4507
<LI>Returns: <I>groupNames</I> of type <I>spirit:soapStringArrayType</I> </LI>
4508
<LI>Input: <A HREF="#alternateRegisterID0" TITLE="link to list of functions that return this type ID"><I>alternateRegisterID</I></A> of type <I>xsd:string</I> </LI>
4509
</UL>
4510
<P>
4511
<table width="100%"><TR><TD bgcolor=#b8b8ff>
4512
<BR><H2>Remap Operations</H2>
4513
</TD></TR></TABLE>
4514
<A NAME ="remapStatePortID0">
4515
<BR><H3><A NAME="getRemapStatePortIDs">getRemapStatePortIDs</A></H3>
4516
Description: List of remap port IDs of a remap state<B>&nbsp;</B>
4517
<UL>
4518
<LI>Returns: <I>remapStatePortIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
4519
<LI>Input: <A HREF="#remapStateID0" TITLE="link to list of functions that return this type ID"><I>remapStateID</I></A> of type <I>xsd:string</I> </LI>
4520
</UL>
4521
<A NAME ="portID2">
4522
<BR><H3><A NAME="getRemapStatePortPortID">getRemapStatePortPortID</A></H3>
4523
Description: Port ID for the remap state<B>&nbsp;</B>
4524
<UL>
4525
<LI>Returns: <B><A HREF="#portID0" TITLE="last function the returns this type ID in list"><I>portID</I></A></B> of type <I>xsd:string</I> </LI>
4526
<LI>Input: <A HREF="#remapStatePortID0" TITLE="link to list of functions that return this type ID"><I>remapStatePortID</I></A> of type <I>xsd:string</I> </LI>
4527
</UL>
4528
<A NAME ="value69">
4529
<BR><H3><A NAME="getRemapStatePortPortIndex">getRemapStatePortPortIndex</A></H3>
4530
Description: Index of the port if a vector for the remap state<B>&nbsp;</B>
4531
<UL>
4532
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
4533
<LI>Input: <A HREF="#remapStatePortID0" TITLE="link to list of functions that return this type ID"><I>remapStatePortID</I></A> of type <I>xsd:string</I> </LI>
4534
</UL>
4535
<A NAME ="spiritNumberTypeValue5">
4536
<BR><H3><A NAME="getRemapStatePortPortValue">getRemapStatePortPortValue</A></H3>
4537
Description: Value of the port for the remap state<B>&nbsp;</B>
4538
<UL>
4539
<LI>Returns: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
4540
<LI>Input: <A HREF="#remapStatePortID0" TITLE="link to list of functions that return this type ID"><I>remapStatePortID</I></A> of type <I>xsd:string</I> </LI>
4541
</UL>
4542
<P>
4543
<table width="100%"><TR><TD bgcolor=#b8b8ff>
4544
<BR><H2>Service Operations</H2>
4545
</TD></TR></TABLE>
4546
<A NAME ="initiative0">
4547
<BR><H3><A NAME="getAbstractionDefServiceInitiative">getAbstractionDefServiceInitiative</A></H3>
4548
Description: Port service initiative from the abstraction definition<B>&nbsp;</B>
4549
<UL>
4550
<LI>Returns: <I>initiative</I> of type <I>xsd:string</I> </LI>
4551
<LI>Input: <A HREF="#abstractionServiceID0" TITLE="link to list of functions that return this type ID"><I>abstractionServiceID</I></A> of type <I>xsd:string</I> </LI>
4552
</UL>
4553
<A NAME ="typeDefID0">
4554
<FONT color=#ff0000><BR><H3><A NAME="getAbstractionDefServiceIDs">getAbstractionDefServiceIDs</A></H3></FONT>
4555
Description: List of typeDefs for an abstractionServiceID<B>- Invalid in 1.5</B>
4556
<UL>
4557
<LI>Returns: <I>typeDefIDs</I> of type <I>xsd:string</I> </LI>
4558
<LI>Input: <A HREF="#abstractionServiceID0" TITLE="link to list of functions that return this type ID"><I>abstractionServiceID</I></A> of type <I>xsd:string</I> </LI>
4559
</UL>
4560
<A NAME ="abstractionServiceTypeDefID0">
4561
<BR><H3><A NAME="getAbstractionDefAbstractionServiceTypeDefIDs">getAbstractionDefAbstractionServiceTypeDefIDs</A></H3>
4562
Description: List of type definitions for an abstractionServiceID<B>- New in 1.5</B>
4563
<UL>
4564
<LI>Returns: <I>abstractionServiceTypeDefIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
4565
<LI>Input: <A HREF="#abstractionServiceID0" TITLE="link to list of functions that return this type ID"><I>abstractionServiceID</I></A> of type <I>xsd:string</I> </LI>
4566
</UL>
4567
<A NAME ="initiative1">
4568
<BR><H3><A NAME="getServiceInitiative">getServiceInitiative</A></H3>
4569
Description: Initiative of the service<B>&nbsp;</B>
4570
<UL>
4571
<LI>Returns: <I>initiative</I> of type <I>xsd:string</I> </LI>
4572
<LI>Input: <A HREF="#serviceID0" TITLE="link to list of functions that return this type ID"><I>serviceID</I></A> of type <I>xsd:string</I> </LI>
4573
</UL>
4574
<A NAME ="serviceTypeDefID0">
4575
<BR><H3><A NAME="getServiceTypeDefIDs">getServiceTypeDefIDs</A></H3>
4576
Description: List of typeDefs for a serviceID<B>- Modified in 1.5</B>
4577
<UL>
4578
<LI>Returns: <I>serviceTypeDefIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
4579
<LI>Input: <A HREF="#serviceID0" TITLE="link to list of functions that return this type ID"><I>serviceID</I></A> of type <I>xsd:string</I> </LI>
4580
</UL>
4581
<P>
4582
<table width="100%"><TR><TD bgcolor=#b8b8ff>
4583
<BR><H2>TypeDef Operations</H2>
4584
</TD></TR></TABLE>
4585
<A NAME ="value70">
4586
<BR><H3><A NAME="getTypeDefTypeName">getTypeDefTypeName</A></H3>
4587
Description: Name of the type<B>- Modified in 1.5</B>
4588
<UL>
4589
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
4590
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4591
<UL>
4592
<LI>Legal value: <A HREF="#wireTypeDefID0" TITLE="link to list of functions that return this type ID"><I>wireTypeDefID</I></A> of type <I>xsd:string</I></LI>
4593
<LI>Legal value: <A HREF="#transactionalTypeDefID0" TITLE="link to list of functions that return this type ID"><I>transactionalTypeDefID</I></A> of type <I>xsd:string</I></LI>
4594
<LI>Legal value: <A HREF="#serviceTypeDefID0" TITLE="link to list of functions that return this type ID"><I>serviceTypeDefID</I></A> of type <I>xsd:string</I></LI>
4595
<LI>Legal value: <A HREF="#abstractionServiceTypeDefID0" TITLE="link to list of functions that return this type ID"><I>abstractionServiceTypeDefID</I></A> of type <I>xsd:string</I></LI>
4596
</UL>
4597
</UL>
4598
<A NAME ="booleanValue21">
4599
<BR><H3><A NAME="getTypeDefConstrained">getTypeDefConstrained</A></H3>
4600
Description: Is the type name constrained<B>- Modified in 1.5</B>
4601
<UL>
4602
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
4603
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4604
<UL>
4605
<LI>Legal value: <A HREF="#wireTypeDefID0" TITLE="link to list of functions that return this type ID"><I>wireTypeDefID</I></A> of type <I>xsd:string</I></LI>
4606
<LI>Legal value: <A HREF="#transactionalTypeDefID0" TITLE="link to list of functions that return this type ID"><I>transactionalTypeDefID</I></A> of type <I>xsd:string</I></LI>
4607
<LI>Legal value: <A HREF="#serviceTypeDefID0" TITLE="link to list of functions that return this type ID"><I>serviceTypeDefID</I></A> of type <I>xsd:string</I></LI>
4608
</UL>
4609
</UL>
4610
<A NAME ="booleanValue22">
4611
<BR><H3><A NAME="getTypeDefImplicit">getTypeDefImplicit</A></H3>
4612
Description: Is the type name implicit<B>- Modified in 1.5</B>
4613
<UL>
4614
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
4615
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4616
<UL>
4617
<LI>Legal value: <A HREF="#serviceTypeDefID0" TITLE="link to list of functions that return this type ID"><I>serviceTypeDefID</I></A> of type <I>xsd:string</I></LI>
4618
<LI>Legal value: <A HREF="#abstractionServiceTypeDefID0" TITLE="link to list of functions that return this type ID"><I>abstractionServiceTypeDefID</I></A> of type <I>xsd:string</I></LI>
4619
</UL>
4620
</UL>
4621
<A NAME ="typeDefinitions0">
4622
<BR><H3><A NAME="getTypeDefTypeDefinitions">getTypeDefTypeDefinitions</A></H3>
4623
Description: List of type definition for the given type<B>- Modified in 1.5</B>
4624
<UL>
4625
<LI>Returns: <I>typeDefinitions</I> of type <I>spirit:soapStringArrayType</I> </LI>
4626
<LI>Input: <A HREF="#elementID0" TITLE="link to list of functions that return this type ID"><I>elementID</I></A> of type <I>xsd:string</I> </LI>
4627
<UL>
4628
<LI>Legal value: <A HREF="#wireTypeDefID0" TITLE="link to list of functions that return this type ID"><I>wireTypeDefID</I></A> of type <I>xsd:string</I></LI>
4629
<LI>Legal value: <A HREF="#transactionalTypeDefID0" TITLE="link to list of functions that return this type ID"><I>transactionalTypeDefID</I></A> of type <I>xsd:string</I></LI>
4630
<LI>Legal value: <A HREF="#serviceTypeDefID0" TITLE="link to list of functions that return this type ID"><I>serviceTypeDefID</I></A> of type <I>xsd:string</I></LI>
4631
</UL>
4632
</UL>
4633
<A NAME ="viewID2">
4634
<BR><H3><A NAME="getTypeDefTypeViewIDs">getTypeDefTypeViewIDs</A></H3>
4635
Description: List of type viewIDs for the given type<B>- Modified in 1.5</B>
4636
<UL>
4637
<LI>Returns: <B><A HREF="#viewID0" TITLE="last function the returns this type ID in list"><I>viewIDs</I></A></B> of type <I>spirit:soapStringArrayType</I> </LI>
4638
<LI>Input: <A HREF="#wireTypeDefID0" TITLE="link to list of functions that return this type ID"><I>wireTypeDefID</I></A> of type <I>xsd:string</I> </LI>
4639
</UL>
4640
<P>
4641
<table width="100%"><TR><TD bgcolor=#b8b8ff>
4642
<BR><H2>View Operations</H2>
4643
</TD></TR></TABLE>
4644
<A NAME ="designID1">
4645
<BR><H3><A NAME="getViewDesignID">getViewDesignID</A></H3>
4646
Description: ID of the design associated with a hierarchical view<B>&nbsp;</B>
4647
<UL>
4648
<LI>Returns: <B><A HREF="#designID0" TITLE="last function the returns this type ID in list"><I>designID</I></A></B> of type <I>xsd:string</I> </LI>
4649
<LI>Input: <A HREF="#viewID0" TITLE="link to list of functions that return this type ID"><I>viewID</I></A> of type <I>xsd:string</I> </LI>
4650
</UL>
4651
<A NAME ="envIdentifiersValue0">
4652
<BR><H3><A NAME="getViewEnvIdentifiers">getViewEnvIdentifiers</A></H3>
4653
Description: List of environment identifiers of the view<B>&nbsp;</B>
4654
<UL>
4655
<LI>Returns: <I>envIdentifiersValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
4656
<LI>Input: <A HREF="#viewID0" TITLE="link to list of functions that return this type ID"><I>viewID</I></A> of type <I>xsd:string</I> </LI>
4657
</UL>
4658
<A NAME ="value71">
4659
<BR><H3><A NAME="getViewLanguage">getViewLanguage</A></H3>
4660
Description: View Language<B>&nbsp;</B>
4661
<UL>
4662
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
4663
<LI>Input: <A HREF="#viewID0" TITLE="link to list of functions that return this type ID"><I>viewID</I></A> of type <I>xsd:string</I> </LI>
4664
</UL>
4665
<A NAME ="booleanValue23">
4666
<BR><H3><A NAME="getViewLanguageIsStrict">getViewLanguageIsStrict</A></H3>
4667
Description: Value of 'strict' attribute on view language element<B>&nbsp;</B>
4668
<UL>
4669
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
4670
<LI>Input: <A HREF="#viewID0" TITLE="link to list of functions that return this type ID"><I>viewID</I></A> of type <I>xsd:string</I> </LI>
4671
</UL>
4672
<A NAME ="modelName0">
4673
<BR><H3><A NAME="getViewModelName">getViewModelName</A></H3>
4674
Description: Get the model name for this view<B>&nbsp;</B>
4675
<UL>
4676
<LI>Returns: <I>modelName</I> of type <I>xsd:string</I> </LI>
4677
<LI>Input: <A HREF="#viewID0" TITLE="link to list of functions that return this type ID"><I>viewID</I></A> of type <I>xsd:string</I> </LI>
4678
</UL>
4679
<A NAME ="fileBuilderID2">
4680
<BR><H3><A NAME="getViewDefaultFileBuilderIDs">getViewDefaultFileBuilderIDs</A></H3>
4681
Description: List of default file builder IDs of the view<B>&nbsp;</B>
4682
<UL>
4683
<LI>Returns: <B><A HREF="#fileBuilderID0" TITLE="last function the returns this type ID in list"><I>fileBuilderIDs</I></A></B> of type <I>spirit:soapStringArrayType</I> </LI>
4684
<LI>Input: <A HREF="#viewID0" TITLE="link to list of functions that return this type ID"><I>viewID</I></A> of type <I>xsd:string</I> </LI>
4685
</UL>
4686
<A NAME ="fileSetID4">
4687
<BR><H3><A NAME="getViewFileSetIDs">getViewFileSetIDs</A></H3>
4688
Description: List of fileSet IDs for fileSets referenced by the view<B>&nbsp;</B>
4689
<UL>
4690
<LI>Returns: <B><A HREF="#fileSetID0" TITLE="last function the returns this type ID in list"><I>fileSetIDs</I></A></B> of type <I>spirit:soapStringArrayType</I> </LI>
4691
<LI>Input: <A HREF="#viewID0" TITLE="link to list of functions that return this type ID"><I>viewID</I></A> of type <I>xsd:string</I> </LI>
4692
</UL>
4693
<A NAME ="portConstraintSetID1">
4694
<BR><H3><A NAME="getViewPortConstraintSetIDs">getViewPortConstraintSetIDs</A></H3>
4695
Description: Constraint set ID for the port referenced by the view<B>- Modified in 1.5</B>
4696
<UL>
4697
<LI>Returns: <B><A HREF="#portConstraintSetID0" TITLE="last function the returns this type ID in list"><I>portConstraintSetIDs</I></A></B> of type <I>spirit:soapStringArrayType</I> </LI>
4698
<LI>Input: <A HREF="#portID0" TITLE="link to list of functions that return this type ID"><I>portID</I></A> of type <I>xsd:string</I> </LI>
4699
<LI>Input: <A HREF="#viewID0" TITLE="link to list of functions that return this type ID"><I>viewID</I></A> of type <I>xsd:string</I> </LI>
4700
</UL>
4701
<A NAME ="whiteboxRefID0">
4702
<BR><H3><A NAME="getViewWhiteboxElementRefIDs">getViewWhiteboxElementRefIDs</A></H3>
4703
Description: List of whitebox element reference IDs of the view<B>&nbsp;</B>
4704
<UL>
4705
<LI>Returns: <I>whiteboxRefIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
4706
<LI>Input: <A HREF="#viewID0" TITLE="link to list of functions that return this type ID"><I>viewID</I></A> of type <I>xsd:string</I> </LI>
4707
</UL>
4708
<P>
4709
<table width="100%"><TR><TD bgcolor=#b8b8ff>
4710
<BR><H2>Whitebox Operations</H2>
4711
</TD></TR></TABLE>
4712
<A NAME ="whiteboxElementID1">
4713
<BR><H3><A NAME="getWhiteboxElementRefID">getWhiteboxElementRefID</A></H3>
4714
Description: White box element reference ID<B>&nbsp;</B>
4715
<UL>
4716
<LI>Returns: <B><A HREF="#whiteboxElementID0" TITLE="last function the returns this type ID in list"><I>whiteboxElementID</I></A></B> of type <I>xsd:string</I> </LI>
4717
<LI>Input: <A HREF="#whiteboxRefID0" TITLE="link to list of functions that return this type ID"><I>whiteboxRefID</I></A> of type <I>xsd:string</I> </LI>
4718
</UL>
4719
<A NAME ="whiteboxRefPathID0">
4720
<BR><H3><A NAME="getWhiteboxRefPathIDs">getWhiteboxRefPathIDs</A></H3>
4721
Description: List of path IDs of the white box element reference<B>&nbsp;</B>
4722
<UL>
4723
<LI>Returns: <I>whiteboxRefPathIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
4724
<LI>Input: <A HREF="#whiteboxRefID0" TITLE="link to list of functions that return this type ID"><I>whiteboxRefID</I></A> of type <I>xsd:string</I> </LI>
4725
</UL>
4726
<A NAME ="value72">
4727
<BR><H3><A NAME="getWhiteboxRefPathName">getWhiteboxRefPathName</A></H3>
4728
Description: Name of the whitebox reference path element<B>&nbsp;</B>
4729
<UL>
4730
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
4731
<LI>Input: <A HREF="#whiteboxRefPathID0" TITLE="link to list of functions that return this type ID"><I>whiteboxRefPathID</I></A> of type <I>xsd:string</I> </LI>
4732
</UL>
4733
<A NAME ="nonNegativeIntegerArrayValue1">
4734
<BR><H3><A NAME="getWhiteboxRefPathRange">getWhiteboxRefPathRange</A></H3>
4735
Description: List of left and right range of the whitebox reference path element<B>&nbsp;</B>
4736
<UL>
4737
<LI>Returns: <I>nonNegativeIntegerArrayValue</I> of type <I>spirit:nonNegativeIntegerArrayType</I> </LI>
4738
<LI>Input: <A HREF="#whiteboxRefPathID0" TITLE="link to list of functions that return this type ID"><I>whiteboxRefPathID</I></A> of type <I>xsd:string</I> </LI>
4739
</UL>
4740
<A NAME ="value73">
4741
<BR><H3><A NAME="getWhiteboxElementType">getWhiteboxElementType</A></H3>
4742
Description: Type of the whitebox element<B>&nbsp;</B>
4743
<UL>
4744
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
4745
<LI>Input: <A HREF="#whiteboxElementID0" TITLE="link to list of functions that return this type ID"><I>whiteboxElementID</I></A> of type <I>xsd:string</I> </LI>
4746
</UL>
4747
<A NAME ="booleanValue24">
4748
<BR><H3><A NAME="getWhiteboxElementDrivable">getWhiteboxElementDrivable</A></H3>
4749
Description: Indicates whether or not the whitebox element is drivable<B>&nbsp;</B>
4750
<UL>
4751
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
4752
<LI>Input: <A HREF="#whiteboxElementID0" TITLE="link to list of functions that return this type ID"><I>whiteboxElementID</I></A> of type <I>xsd:string</I> </LI>
4753
</UL>
4754
<A NAME ="registerID2">
4755
<FONT color=#ff0000><BR><H3><A NAME="getWhiteboxElementRegisterID">getWhiteboxElementRegisterID</A></H3></FONT>
4756
Description: Register reference ID of the whitebox element<B>- Invalid in 1.5</B>
4757
<UL>
4758
<LI>Returns: <A HREF="#registerID3" TITLE="link to another function that returns this type ID"><I>registerIDs</I></A> of type <I>xsd:string</I> </LI>
4759
<LI>Input: <A HREF="#whiteboxElementID0" TITLE="link to list of functions that return this type ID"><I>whiteboxElementID</I></A> of type <I>xsd:string</I> </LI>
4760
</UL>
4761
<A NAME ="registerID3">
4762
<BR><H3><A NAME="getWhiteboxElementRegisterIDs">getWhiteboxElementRegisterIDs</A></H3>
4763
Description: Register reference IDs of the whitebox element<B>- New in 1.5</B>
4764
<UL>
4765
<LI>Returns: <B><A HREF="#registerID0" TITLE="last function the returns this type ID in list"><I>registerIDs</I></A></B> of type <I>spirit:soapStringArrayType</I> </LI>
4766
<LI>Input: <A HREF="#whiteboxElementID0" TITLE="link to list of functions that return this type ID"><I>whiteboxElementID</I></A> of type <I>xsd:string</I> </LI>
4767
</UL>
4768
<table width="100%"><TR><TD bgcolor=#b8b8ff>
4769
<BR><H2><A NAME="elementID0">All ID Types</A></H2>
4770
</TD></TR></TABLE>
4771
<P>
4772
Each item is a link to a function call that can return this type of ID. If there is more than one function then the return variable will be a link to the second function in the list, and so on. The last function in the list will be a <B>BOLD</B> link and will return to the first function.
4773
<P><TABLE BORDER=1>
4774
<TR>
4775
<TD><A HREF="#abstractionDefID0">abstractionDefID</A></TD>
4776
<TD><A HREF="#abstractionDefPortID0">abstractionDefPortID</A></TD>
4777
<TD><A HREF="#abstractionDefPortModeConstraintID0">abstractionDefPortModeConstraintID</A></TD>
4778
<TD><A HREF="#abstractionDefPortModeID0">abstractionDefPortModeID</A></TD>
4779
</TR><TR>
4780
<TD><A HREF="#abstractionServiceID0">abstractionServiceID</A></TD>
4781
<TD><A HREF="#abstractionServiceTypeDefID0">abstractionServiceTypeDefID</A></TD>
4782
<TD><A HREF="#abstractorID0">abstractorID</A></TD>
4783
<TD><A HREF="#abstractorInstanceID0">abstractorInstanceID</A></TD>
4784
</TR><TR>
4785
<TD><A HREF="#adHocConnectionID0">adHocConnectionID</A></TD>
4786
<TD><A HREF="#adHocExternalPortReferenceID0">adHocExternalPortReferenceID</A></TD>
4787
<TD><A HREF="#adHocInternalPortReferenceID0">adHocInternalPortReferenceID</A></TD>
4788
<TD><A HREF="#addressBlockID0">addressBlockID</A></TD>
4789
</TR><TR>
4790
<TD><A HREF="#addressBlockUID0">addressBlockUID</A></TD>
4791
<TD><A HREF="#addressSpaceID0">addressSpaceID</A></TD>
4792
<TD><A HREF="#addressSpaceUID0">addressSpaceUID</A></TD>
4793
<TD><A HREF="#alternateRegisterID0">alternateRegisterID</A></TD>
4794
</TR><TR>
4795
<TD><A HREF="#alternateRegisterUID0">alternateRegisterUID</A></TD>
4796
<TD><A HREF="#argumentID0">argumentID</A></TD>
4797
<TD><A HREF="#argumentUID0">argumentUID</A></TD>
4798
<TD><A HREF="#bankID0">bankID</A></TD>
4799
</TR><TR>
4800
<TD><A HREF="#bankUID0">bankUID</A></TD>
4801
<TD><A HREF="#bridgeID0">bridgeID</A></TD>
4802
<TD><A HREF="#busdefID0">busdefID</A></TD>
4803
<TD><A HREF="#channelID0">channelID</A></TD>
4804
</TR><TR>
4805
<TD><A HREF="#choiceEnumerationID0">choiceEnumerationID</A></TD>
4806
<TD><A HREF="#choiceID0">choiceID</A></TD>
4807
<TD><A HREF="#clockDriverID0">clockDriverID</A></TD>
4808
<TD><A HREF="#clockDriverUID0">clockDriverUID</A></TD>
4809
</TR><TR>
4810
<TD><A HREF="#componentID0">componentID</A></TD>
4811
<TD><A HREF="#componentInstanceID0">componentInstanceID</A></TD>
4812
<TD><A HREF="#cpuID0">cpuID</A></TD>
4813
<TD><A HREF="#designID0">designID</A></TD>
4814
</TR><TR>
4815
<TD><A HREF="#driveConstraintID0">driveConstraintID</A></TD>
4816
<TD><A HREF="#elementID0">elementID</A></TD>
4817
<TD><A HREF="#executableImageID0">executableImageID</A></TD>
4818
<TD><A HREF="#executableImageUID0">executableImageUID</A></TD>
4819
</TR><TR>
4820
<TD><A HREF="#fileBuilderID0">fileBuilderID</A></TD>
4821
<TD><A HREF="#fileBuilderUID0">fileBuilderUID</A></TD>
4822
<TD><A HREF="#fileDefineID0">fileDefineID</A></TD>
4823
<TD><A HREF="#fileDefineUID0">fileDefineUID</A></TD>
4824
</TR><TR>
4825
<TD><A HREF="#fileID0">fileID</A></TD>
4826
<TD><A HREF="#fileSetGroupID0">fileSetGroupID</A></TD>
4827
<TD><A HREF="#fileSetID0">fileSetID</A></TD>
4828
<TD><A HREF="#fileUID0">fileUID</A></TD>
4829
</TR><TR>
4830
<TD><A HREF="#functionID0">functionID</A></TD>
4831
<TD><A HREF="#functionSourceFileID0">functionSourceFileID</A></TD>
4832
<TD><A HREF="#functionUID0">functionUID</A></TD>
4833
<TD><A HREF="#generatorID0">generatorID</A></TD>
4834
</TR><TR>
4835
<TD><A HREF="#hierConnectionID0">hierConnectionID</A></TD>
4836
<TD><A HREF="#interconnectionID0">interconnectionID</A></TD>
4837
<TD><A HREF="#interfaceID0">interfaceID</A></TD>
4838
<TD><A HREF="#interfacePortMapID0">interfacePortMapID</A></TD>
4839
</TR><TR>
4840
<TD><A HREF="#interfaceUID0">interfaceUID</A></TD>
4841
<TD><A HREF="#linkerCommandFileID0">linkerCommandFileID</A></TD>
4842
<TD><A HREF="#linkerCommandFileUID0">linkerCommandFileUID</A></TD>
4843
<TD><A HREF="#loadConstraintID0">loadConstraintID</A></TD>
4844
</TR><TR>
4845
<TD><A HREF="#localMemoryMapID0">localMemoryMapID</A></TD>
4846
<TD><A HREF="#memoryMapElementID0">memoryMapElementID</A></TD>
4847
<TD><A HREF="#memoryMapID0">memoryMapID</A></TD>
4848
<TD><A HREF="#memoryRemapID0">memoryRemapID</A></TD>
4849
</TR><TR>
4850
<TD><A HREF="#monitorInterconnectionID0">monitorInterconnectionID</A></TD>
4851
<TD><A HREF="#parameterID0">parameterID</A></TD>
4852
<TD><A HREF="#parameterUID0">parameterUID</A></TD>
4853
<TD><A HREF="#portConstraintSetID0">portConstraintSetID</A></TD>
4854
</TR><TR>
4855
<TD><A HREF="#portID0">portID</A></TD>
4856
<TD><A HREF="#portMapID0">portMapID</A></TD>
4857
<TD><A HREF="#portMapUID0">portMapUID</A></TD>
4858
<TD><A HREF="#portUID0">portUID</A></TD>
4859
</TR><TR>
4860
<TD><A HREF="#regFieldID0">regFieldID</A></TD>
4861
<TD><A HREF="#regFieldUID0">regFieldUID</A></TD>
4862
<TD><A HREF="#regFieldValueID0">regFieldValueID</A></TD>
4863
<TD><A HREF="#registerFileID0">registerFileID</A></TD>
4864
</TR><TR>
4865
<TD><A HREF="#registerFileUID0">registerFileUID</A></TD>
4866
<TD><A HREF="#registerID0">registerID</A></TD>
4867
<TD><A HREF="#registerUID0">registerUID</A></TD>
4868
<TD><A HREF="#remapAddressID0">remapAddressID</A></TD>
4869
</TR><TR>
4870
<TD><A HREF="#remapStateID0">remapStateID</A></TD>
4871
<TD><A HREF="#remapStatePortID0">remapStatePortID</A></TD>
4872
<TD><A HREF="#segmentID0">segmentID</A></TD>
4873
<TD><A HREF="#segmentUID0">segmentUID</A></TD>
4874
</TR><TR>
4875
<TD><A HREF="#serviceID0">serviceID</A></TD>
4876
<TD><A HREF="#serviceTypeDefID0">serviceTypeDefID</A></TD>
4877
<TD><A HREF="#singleShotDriverID0">singleShotDriverID</A></TD>
4878
<TD><A HREF="#singleShotDriverUID0">singleShotDriverUID</A></TD>
4879
</TR><TR>
4880
<TD><A HREF="#subspaceMapID0">subspaceMapID</A></TD>
4881
<TD><A HREF="#subspaceMapUID0">subspaceMapUID</A></TD>
4882
<TD><A HREF="#timingConstraintID0">timingConstraintID</A></TD>
4883
<TD><A HREF="#transactionalTypeDefID0">transactionalTypeDefID</A></TD>
4884
</TR><TR>
4885
<TD><A HREF="#typeDefID0">typeDefID</A></TD>
4886
<TD><A HREF="#viewID0">viewID</A></TD>
4887
<TD><A HREF="#whiteboxElementID0">whiteboxElementID</A></TD>
4888
<TD><A HREF="#whiteboxRefID0">whiteboxRefID</A></TD>
4889
</TR><TR>
4890
<TD><A HREF="#whiteboxRefPathID0">whiteboxRefPathID</A></TD>
4891
<TD><A HREF="#wireTypeDefID0">wireTypeDefID</A></TD>
4892
</TR></TABLE>
4893
 
4894
<P>
4895
<small>
4896
Copyright (c) 2009 The SPIRIT Consortium.  All rights reserved.
4897
www.spiritconsortium.org
4898
<P>
4899
THIS WORK CONTAINS TRADE SECRETS AND PROPRIETARY
4900
INFORMATION WHICH IS THE PROPERTY OF ANY OF THE CONTRIBUTING
4901
MEMBERS OF THE SPIRIT CONSORTIUM, AND MAY BE  LICENSED TO
4902
OTHER MEMBERS OF THE SPIRIT CONSORTIUM SUBJECT TO THE
4903
TERMS AND CONDITIONS OF THE IP POLICY, WHICH IP POLICY FORMS
4904
PART OF THE SPIRIT CONSORTIUM AGREEMENT AND THE SPIRIT
4905
MEMBERSHIP AGREEMENTS
4906
</small>
4907
 
4908
</BODY></HTML>

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.