URL
https://opencores.org/ocsvn/socgen/socgen/trunk
Subversion Repositories socgen
[/] [socgen/] [trunk/] [tools/] [ip-xact/] [1685-2009/] [TGI/] [TGI.html] - Rev 135
Compare with Previous | Blame | View Log
<HTML>
<HEAD>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<TITLE>TGI API Documentation</TITLE>
<style>
<!--
body,td,th,a,p,.h{font-family:arial,sans-serif}
.h{font-size:20px}
.q{color:#00c}
th{background-color:#b8b8ff}
td{padding:4}
-->
</style>
</HEAD>
<BODY>
<H1><CENTER>TGI API Documentation</CENTER></H1>
<CENTER>Generated on Tue Jun 2 11:30:29 CDT 2009</CENTER>
<H2>Category Index</H2>
<TABLE BORDER=1>
<TR>
<TD><A HREF="#AbstractionDefinition Operations">Abstraction Definition Operations</A></TD>
<TD><A HREF="#AbstractorInstance Operations">Abstractor Instance Operations</A></TD>
<TD><A HREF="#AbstractorOperations">Abstractor Operations</A></TD>
</TR><TR>
<TD><A HREF="#AddressMap Operations">Address Map Operations</A></TD>
<TD><A HREF="#BusDefinition Operations">Bus Definition Operations</A></TD>
<TD><A HREF="#BusInterface Operations">Bus Interface Operations</A></TD>
</TR><TR>
<TD><A HREF="#ComponentInstance Operations">Component Instance Operations</A></TD>
<TD><A HREF="#ComponentOperations">Component Operations</A></TD>
<TD><A HREF="#ConstraintOperations">Constraint Operations</A></TD>
</TR><TR>
<TD><A HREF="#DesignOperations">Design Operations</A></TD>
<TD><A HREF="#FieldOperations">Field Operations</A></TD>
<TD><A HREF="#Fileand Fileset Operations">File and Fileset Operations</A></TD>
</TR><TR>
<TD><A HREF="#GeneratorOperations">Generator Operations</A></TD>
<TD><A HREF="#InterfaceOperations">Interface Operations</A></TD>
<TD><A HREF="#MiscellaneousOperations">Miscellaneous Operations</A></TD>
</TR><TR>
<TD><A HREF="#PortOperations">Port Operations</A></TD>
<TD><A HREF="#RegisterFile Operations">Register File Operations</A></TD>
<TD><A HREF="#RegisterOperations">Register Operations</A></TD>
</TR><TR>
<TD><A HREF="#RemapOperations">Remap Operations</A></TD>
<TD><A HREF="#ServiceOperations">Service Operations</A></TD>
<TD><A HREF="#TypeDefOperations">TypeDef Operations</A></TD>
</TR><TR>
<TD><A HREF="#ViewOperations">View Operations</A></TD>
<TD><A HREF="#WhiteboxOperations">Whitebox Operations</A></TD>
<TD><A HREF="#elementID0">All ID Types</A></TD>
</TR></TABLE>
<P>
<H2><A NAME="AbstractionDefinition Operations">Abstraction Definition Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getAbstractionDefID">getAbstractionDefID</A></TD>
<TD>ID for the abstraction definition with the given VLNV</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefVLNV">getAbstractionDefVLNV</A></TD>
<TD>Vendor Library Name Version of the abstraction definition</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefBusTypeVLNV">getAbstractionDefBusTypeVLNV</A></TD>
<TD>Get VLNV of the bus definition</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefExtends">getAbstractionDefExtends</A></TD>
<TD>Vendor Library Name Version of the abstraction definition being extended</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortIDs">getAbstractionDefPortIDs</A></TD>
<TD>List of abstraction definition port element IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortLogicalName">getAbstractionDefPortLogicalName</A></TD>
<TD>Logical name of this abstraction definition port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortRequiresDriver">getAbstractionDefPortRequiresDriver</A></TD>
<TD>Does this port require a driver</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortRequiredDriverType">getAbstractionDefPortRequiredDriverType</A></TD>
<TD>Required driver type for this port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortStyle">getAbstractionDefPortStyle</A></TD>
<TD>Returns 'wire' or 'transactional' to indicate the port style</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortIsAddress">getAbstractionDefPortIsAddress</A></TD>
<TD>Is this port an address port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortIsData">getAbstractionDefPortIsData</A></TD>
<TD>Is this port a data port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortIsClock">getAbstractionDefPortIsClock</A></TD>
<TD>Is this port a clock port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortIsReset">getAbstractionDefPortIsReset</A></TD>
<TD>Is this port a reset port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortModeID">getAbstractionDefPortModeID</A></TD>
<TD>Returns an ID for accessing the given port in the given interface mode</TD>
<TD><FONT color=#ff0000>Invalid in 1.5</FONT></TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortModeIDs">getAbstractionDefPortModeIDs</A></TD>
<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>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortModeGroup">getAbstractionDefPortModeGroup</A></TD>
<TD>Group name when present on a system interface</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortModeBitWidth">getAbstractionDefPortModeBitWidth</A></TD>
<TD>Bit width constraint when present on an interface of the given type</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortModeDirection">getAbstractionDefPortModeDirection</A></TD>
<TD>Port direction constraint when present on an interface of the given type</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortNonMirroredConstraintIDs">getAbstractionDefPortNonMirroredConstraintIDs</A></TD>
<TD>List of constraint IDs for a non-mirrored port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortMirroredConstraintIDs">getAbstractionDefPortMirroredConstraintIDs</A></TD>
<TD>List of constraint IDs for a mirrored port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortDriveConstraintIDs">getAbstractionDefPortDriveConstraintIDs</A></TD>
<TD>List of drive constraint IDs of the port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortLoadConstraintIDs">getAbstractionDefPortLoadConstraintIDs</A></TD>
<TD>List of load constraint IDs of the port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortTimingConstraintIDs">getAbstractionDefPortTimingConstraintIDs</A></TD>
<TD>List of timing constraint IDs of the port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortDefaultValue">getAbstractionDefPortDefaultValue</A></TD>
<TD>Default value for port when not connected</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortModePresence">getAbstractionDefPortModePresence</A></TD>
<TD>Existence requirement for this port on an interface of the given type</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortModeServiceIDs">getAbstractionDefPortModeServiceIDs</A></TD>
<TD>AbstractionDef service IDs on a transactional port</TD>
<TD><FONT color=#ff0000>Invalid in 1.5</FONT></TD></TR>
<TR><TD><A HREF="#getAbstractionDefPortModeServiceID">getAbstractionDefPortModeServiceID</A></TD>
<TD>AbstractionDef service ID on a transactional port</TD>
<TD>New in 1.5</TD></TR>
</TABLE>
<P>
<H2><A NAME="AbstractorInstance Operations">Abstractor Instance Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getAbstractorInstanceName">getAbstractorInstanceName</A></TD>
<TD>Instance name of the abstractor</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractorInstanceVLNV">getAbstractorInstanceVLNV</A></TD>
<TD>Vendor Library Name Version of the abstractor (from the design file)</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractorInstanceAbstractorID">getAbstractorInstanceAbstractorID</A></TD>
<TD>ID for the abstractor associated with given instance (crossing from design configuration to abstractor file)</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractorInstanceXML">getAbstractorInstanceXML</A></TD>
<TD>Return the abstractor XML in text format. Schema version is DE dependent.</TD>
<TD> </TD></TR>
</TABLE>
<P>
<H2><A NAME="AbstractorOperations">Abstractor Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getAbstractorAbstractorMode">getAbstractorAbstractorMode</A></TD>
<TD>Get the mode that the abstractor can be master, slave, direct or system.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractorBusTypeVLNV">getAbstractorBusTypeVLNV</A></TD>
<TD>List of VLNV of the bus definition</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractorAbstractorInterfaceIDs">getAbstractorAbstractorInterfaceIDs</A></TD>
<TD>List of 2 interface IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractorViewIDs">getAbstractorViewIDs</A></TD>
<TD>A list of model view IDs</TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getAbstractorPortIDs">getAbstractorPortIDs</A></TD>
<TD>A list of abstractor model port IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractorModelParameterIDs">getAbstractorModelParameterIDs</A></TD>
<TD>A list of model parameter IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractorGeneratorIDs">getAbstractorGeneratorIDs</A></TD>
<TD>List of generator IDs of the abstractor</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractorChoiceIDs">getAbstractorChoiceIDs</A></TD>
<TD>List of choices IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractorFileSetIDs">getAbstractorFileSetIDs</A></TD>
<TD>List of file set IDs</TD>
<TD> </TD></TR>
</TABLE>
<P>
<H2><A NAME="AddressMap Operations">Address Map Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getAddressSpaceRange">getAddressSpaceRange</A></TD>
<TD>The address range of an address block expressed as the number of accessable and addressable units., <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAddressSpaceWidth">getAddressSpaceWidth</A></TD>
<TD>The bit width of an address block., <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAddressSpaceLocalMemoryMapID">getAddressSpaceLocalMemoryMapID</A></TD>
<TD>The ID for the local memory map of the address space.</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getAddressSpaceSegmentIDs">getAddressSpaceSegmentIDs</A></TD>
<TD>List of IDs for address block segments for the address space.</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getSegmentAddressOffset">getSegmentAddressOffset</A></TD>
<TD>The address offset of an address space segment in an address space, <B>Configurable</B></TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#setSegmentAddressOffset">setSegmentAddressOffset</A></TD>
<TD>Set the address offset of an address space segment expressed in the number addressable units.</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getSegmentRange">getSegmentRange</A></TD>
<TD>The address range of an address space segment expressed as the number of accessable addressable units., <B>Configurable</B></TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#setSegmentRange">setSegmentRange</A></TD>
<TD>Set the address range of an address space segment expressed as the number of accessable addressable units.</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getAddressSpaceAddressUnitBits">getAddressSpaceAddressUnitBits</A></TD>
<TD>The number bits in an addressable unit. If none exists, the default 8 bits is returned.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getExecutableImageIDs">getExecutableImageIDs</A></TD>
<TD>The IDs of the executable images belonging to the specified address space.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getExecutableImageType">getExecutableImageType</A></TD>
<TD>The type of the executable image if existent.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getExecutableImageLinkerCommand">getExecutableImageLinkerCommand</A></TD>
<TD>The linker command for the current executable image., <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getExecutableImageLinkerFlags">getExecutableImageLinkerFlags</A></TD>
<TD>The flags of the current executable image linker command., <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getExecutableImageLinkerCommandFileID">getExecutableImageLinkerCommandFileID</A></TD>
<TD>Element ID of linkerCommandFile associated with given executable image.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getExecutableImageFileBuilderIDs">getExecutableImageFileBuilderIDs</A></TD>
<TD>List of default file builder IDs of the executable image</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getExecutableImageFileSetIDs">getExecutableImageFileSetIDs</A></TD>
<TD>The group of file set reference IDs complying with the tool set of the current executable image.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getLinkerCommandFileName">getLinkerCommandFileName</A></TD>
<TD>The name of the linker command file., <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getLinkerCommandFileLineSwitch">getLinkerCommandFileLineSwitch</A></TD>
<TD>The command line switch to specify with the linker command file., <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getLinkerCommandFileEnable">getLinkerCommandFileEnable</A></TD>
<TD>Indicates whether or not to generate and enable the linker command file., <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getLinkerCommandGeneratorIDs">getLinkerCommandGeneratorIDs</A></TD>
<TD>Reference IDs to the generator elements for generating the linker command file.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getMemoryMapElementIDs">getMemoryMapElementIDs</A></TD>
<TD>List of element IDs (addressBlockID, bankID, subspaceMapID) within a memory map, memory remap, local memory map, or bank</TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getMemoryMapElementType">getMemoryMapElementType</A></TD>
<TD>Indicates type of memory map element: addressBlock, bank or subspaceMap</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getMemoryMapAddressUnitBits">getMemoryMapAddressUnitBits</A></TD>
<TD>The number bits in an addressable unit for a memory map. If none exists, the default 8 bits is returned.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAddressBlockBaseAddress">getAddressBlockBaseAddress</A></TD>
<TD>The base address of an address block, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAddressBlockRange">getAddressBlockRange</A></TD>
<TD>The address range of an address block expressed as the number of accessable and addressable units., <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAddressBlockWidth">getAddressBlockWidth</A></TD>
<TD>The bit width of an address block in the local memory map., <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAddressBlockUsage">getAddressBlockUsage</A></TD>
<TD>Indicates the usage of this address block.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAddressBlockVolatility">getAddressBlockVolatility</A></TD>
<TD>Indicates whether or not the data is volatile.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAddressBlockAccess">getAddressBlockAccess</A></TD>
<TD>The accessibility of the data in the local address block.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAddressBlockRegisterIDs">getAddressBlockRegisterIDs</A></TD>
<TD>The IDs of the available registers in the address block.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAddressBlockRegisterFileIDs">getAddressBlockRegisterFileIDs</A></TD>
<TD>The IDs of the available register files in the address block.</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getTypeIdentifier">getTypeIdentifier</A></TD>
<TD>Indicates the type identifier of an addressBlock, registerFile, register or field.</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getBankAlignment">getBankAlignment</A></TD>
<TD>The bank alignment value, serial or parallel</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBankBaseAddress">getBankBaseAddress</A></TD>
<TD>The base address of an address bank, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBankUsage">getBankUsage</A></TD>
<TD>Indicates the usage of this address bank.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBankVolatility">getBankVolatility</A></TD>
<TD>Indicates whether or not the data is volatile.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBankAccess">getBankAccess</A></TD>
<TD>The accessibility of the data in the local address bank.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getSubspaceMapMasterID">getSubspaceMapMasterID</A></TD>
<TD>Master bus interface ID on the other side of a bus bridge .</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getSubspaceMapSegmentID">getSubspaceMapSegmentID</A></TD>
<TD>Address space segment ID on the other side of a bus bridge .</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getSubspaceMapBaseAddress">getSubspaceMapBaseAddress</A></TD>
<TD>The base address of a memory subspace, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getMemoryMapRemapElementIDs">getMemoryMapRemapElementIDs</A></TD>
<TD>List of IDs for memory map 'remap' elements of the given memory map</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getMemoryRemapStateID">getMemoryRemapStateID</A></TD>
<TD>Remap State ID for which this remap is applicable</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setAddressSpaceRange">setAddressSpaceRange</A></TD>
<TD>Set the address range of an address block expressed as the number of accessable and addressable units.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setAddressSpaceWidth">setAddressSpaceWidth</A></TD>
<TD>Set the bit width of an address block.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setExecutableImageLinkerCommand">setExecutableImageLinkerCommand</A></TD>
<TD>Set the linker command for the current executable image.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setExecutableImageLinkerFlags">setExecutableImageLinkerFlags</A></TD>
<TD>Set the flags of the current executable image linker command.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setLinkerCommandFileName">setLinkerCommandFileName</A></TD>
<TD>Set the name of the linker command file.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setLinkerCommandFileLineSwitch">setLinkerCommandFileLineSwitch</A></TD>
<TD>Set the command line switch to specify with the linker command file.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setLinkerCommandFileEnable">setLinkerCommandFileEnable</A></TD>
<TD>Set whether or not to generate and enable the linker command file.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setAddressBlockBaseAddress">setAddressBlockBaseAddress</A></TD>
<TD>Set the base address of an address block</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setAddressBlockRange">setAddressBlockRange</A></TD>
<TD>Set the address range of an address block expressed as the number of accessable and addressable units.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setAddressBlockWidth">setAddressBlockWidth</A></TD>
<TD>Set the bit width of an address block</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setBankBaseAddress">setBankBaseAddress</A></TD>
<TD>Set the base address of an address bank</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setSubspaceMapBaseAddress">setSubspaceMapBaseAddress</A></TD>
<TD>Set the base address of a memory subspace</TD>
<TD> </TD></TR>
</TABLE>
<P>
<H2><A NAME="BusDefinition Operations">Bus Definition Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getBusDefinitionID">getBusDefinitionID</A></TD>
<TD>ID for the bus definition with the given VLNV</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusDefinitionVLNV">getBusDefinitionVLNV</A></TD>
<TD>Vendor Library Name Version of the bus definition</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusDefinitionDirectConnection">getBusDefinitionDirectConnection</A></TD>
<TD>Indicates whether or not the bus definition supports direct connections</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusDefinitionIsAddressable">getBusDefinitionIsAddressable</A></TD>
<TD>Indicates whether or not the bus definition is an addressable bus</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusDefinitionExtends">getBusDefinitionExtends</A></TD>
<TD>Vendor Library Name Version of the bus definition being extended</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusDefinitionMaxMasters">getBusDefinitionMaxMasters</A></TD>
<TD>Maximum # of masters supported by this bus definition</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusDefinitionMaxSlaves">getBusDefinitionMaxSlaves</A></TD>
<TD>Maximum # of slaves supported by this bus definition</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusDefinitionSystemGroupNames">getBusDefinitionSystemGroupNames</A></TD>
<TD>List of system group names for this bus definition</TD>
<TD> </TD></TR>
</TABLE>
<P>
<H2><A NAME="BusInterface Operations">Bus Interface Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getBusInterfaceMasterAddressSpaceID">getBusInterfaceMasterAddressSpaceID</A></TD>
<TD>ID of the master addressSpace</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusInterfaceMasterBaseAddress">getBusInterfaceMasterBaseAddress</A></TD>
<TD>Base address of the master addressSpace, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusInterfaceSlaveMemoryMapID">getBusInterfaceSlaveMemoryMapID</A></TD>
<TD>ID of the memoryMap referenced from a slave interface</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusInterfaceSlaveBridgeIDs">getBusInterfaceSlaveBridgeIDs</A></TD>
<TD>List of slave bridge IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBridgeMasterID">getBridgeMasterID</A></TD>
<TD>The slave interface master interface reference ID</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBridgeIsOpaque">getBridgeIsOpaque</A></TD>
<TD>Value of the opaque attribute</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusInterfaceSlaveFileSetGroupIDs">getBusInterfaceSlaveFileSetGroupIDs</A></TD>
<TD>List of fileSetGroup IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusInterfaceGroupName">getBusInterfaceGroupName</A></TD>
<TD>Group name of a system, mirroredSystem, or monitor bus interface</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusInterfaceMirroredSlaveRemapAddressIDs">getBusInterfaceMirroredSlaveRemapAddressIDs</A></TD>
<TD>List of remap address IDs of the mirrored slave interface</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getRemapAddressValue">getRemapAddressValue</A></TD>
<TD>Remap address of the given remap address element</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getRemapAddressRemapStateID">getRemapAddressRemapStateID</A></TD>
<TD>Remap state ID of the given remap address element</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusInterfaceMirroredSlaveRange">getBusInterfaceMirroredSlaveRange</A></TD>
<TD>The address range of the mirrored slave interface</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusInterfaceMonitorInterfaceMode">getBusInterfaceMonitorInterfaceMode</A></TD>
<TD>Indicates the mode of interface being monitored, slave, master, system, mirrorslave, mirrormaster or mirrorslave</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusInterfaceConnectionRequired">getBusInterfaceConnectionRequired</A></TD>
<TD>Connection required for this bus interface</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusInterfaceBitSteering">getBusInterfaceBitSteering</A></TD>
<TD>Bit steering description of the bus interface: on or off, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusInterfaceEndianness">getBusInterfaceEndianness</A></TD>
<TD>The endianess of the bus interface, big or little. The default is little.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getBusInterfaceBitsInLAU">getBusInterfaceBitsInLAU</A></TD>
<TD>The number bits in the least addressable unit. If none exists, the default 8 bits is returned.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setBusInterfaceMasterBaseAddress">setBusInterfaceMasterBaseAddress</A></TD>
<TD>Set base address of the master bus interface.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setRemapAddressValue">setRemapAddressValue</A></TD>
<TD>Set remap address value for the associated interface.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setBusInterfaceMirroredSlaveRange">setBusInterfaceMirroredSlaveRange</A></TD>
<TD>Set address range for the associated interface.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setBusInterfaceBitSteering">setBusInterfaceBitSteering</A></TD>
<TD>Set bus interface bit steering value.</TD>
<TD> </TD></TR>
</TABLE>
<P>
<H2><A NAME="ComponentInstance Operations">Component Instance Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getComponentInstanceName">getComponentInstanceName</A></TD>
<TD>Instance name of the component</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentInstanceVLNV">getComponentInstanceVLNV</A></TD>
<TD>Vendor Library Name Version of the component (from the design file)</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentInstanceComponentID">getComponentInstanceComponentID</A></TD>
<TD>ID for the component associated with given instance (crossing from design to component file)</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentInstanceXML">getComponentInstanceXML</A></TD>
<TD>Return the component XML in text format. Schema version is DE dependent.</TD>
<TD> </TD></TR>
</TABLE>
<P>
<H2><A NAME="ComponentOperations">Component Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getComponentVLNV">getComponentVLNV</A></TD>
<TD>Vendor Library Name Version of the component (from the component file)</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentElementType">getComponentElementType</A></TD>
<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>
<TD> </TD></TR>
<TR><TD><A HREF="#getChannelBusInterfaceIDs">getChannelBusInterfaceIDs</A></TD>
<TD>List of busInterface IDs in this channel</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentAddressSpaceIDs">getComponentAddressSpaceIDs</A></TD>
<TD>List of IDs for the logical address spaces in the component.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentRemapStateIDs">getComponentRemapStateIDs</A></TD>
<TD>A list of remap state IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentViewIDs">getComponentViewIDs</A></TD>
<TD>A list of model view IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentBusInterfaceIDs">getComponentBusInterfaceIDs</A></TD>
<TD>List of interface IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentChannelIDs">getComponentChannelIDs</A></TD>
<TD>A list of channel IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentPortIDs">getComponentPortIDs</A></TD>
<TD>A list of component model port IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentModelParameterIDs">getComponentModelParameterIDs</A></TD>
<TD>A list of model parameter IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentGeneratorIDs">getComponentGeneratorIDs</A></TD>
<TD>List of generator IDs of the component</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentChoiceIDs">getComponentChoiceIDs</A></TD>
<TD>List of choices IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentFileSetIDs">getComponentFileSetIDs</A></TD>
<TD>List of file set IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentWhiteboxElementIDs">getComponentWhiteboxElementIDs</A></TD>
<TD>List of whitebox element IDs of the component</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentCpuIDs">getComponentCpuIDs</A></TD>
<TD>List of cpu IDs of the component</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getCpuAddressSpaceIDs">getCpuAddressSpaceIDs</A></TD>
<TD>List of address space reference IDs of the cpu</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentOtherClockDriverIDs">getComponentOtherClockDriverIDs</A></TD>
<TD>List of clock driver IDs of the component</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentMemoryMapIDs">getComponentMemoryMapIDs</A></TD>
<TD>List of IDs for memory map elements in the given component</TD>
<TD> </TD></TR>
</TABLE>
<P>
<H2><A NAME="ConstraintOperations">Constraint Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getPortConstraintSetReferenceName">getPortConstraintSetReferenceName</A></TD>
<TD>Reference name of the given port constraint set</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getPortConstraintSetRange">getPortConstraintSetRange</A></TD>
<TD>List of the left and right range of a port referenced by this constraint set</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getPortConstraintSetDriveConstraintIDs">getPortConstraintSetDriveConstraintIDs</A></TD>
<TD>List of drive constraint IDs of the port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getPortConstraintSetLoadConstraintIDs">getPortConstraintSetLoadConstraintIDs</A></TD>
<TD>List of load constraint IDs of the port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getPortConstraintSetTimingConstraintIDs">getPortConstraintSetTimingConstraintIDs</A></TD>
<TD>List of timing constraint IDs of the port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getDriveConstraintType">getDriveConstraintType</A></TD>
<TD>Indicates the type of drive constraint: function class</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getDriveConstraintValue">getDriveConstraintValue</A></TD>
<TD>Returns the drive constraint. Format depends on the constraint type.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getLoadConstraintType">getLoadConstraintType</A></TD>
<TD>Indicates the type of load constraint: function class</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getLoadConstraintValue">getLoadConstraintValue</A></TD>
<TD>Returns the load constraint. Format is cell function and strength or cell class and strength.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getLoadConstraintCount">getLoadConstraintCount</A></TD>
<TD>Returns the load constraint count, the number of loads.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getTimingConstraintClockDetails">getTimingConstraintClockDetails</A></TD>
<TD>Indicates the clock name, clock edge, and delay type</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getTimingConstraintValue">getTimingConstraintValue</A></TD>
<TD>Returns the timing constraint value (cycle time percentage).</TD>
<TD> </TD></TR>
</TABLE>
<P>
<H2><A NAME="DesignOperations">Design Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getDesignID">getDesignID</A></TD>
<TD>Get ID of the current or top design</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getDesignVLNV">getDesignVLNV</A></TD>
<TD>Vendor Library Name Version of the design</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getDesignComponentInstanceIDs">getDesignComponentInstanceIDs</A></TD>
<TD>Components instances IDs of the given design</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getComponentInstanceID">getComponentInstanceID</A></TD>
<TD>Return the component instance ID of the named component instance in the given design</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getDesignInterconnectionIDs">getDesignInterconnectionIDs</A></TD>
<TD>List of interconnection element IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getInterconnectionActiveInterfaces">getInterconnectionActiveInterfaces</A></TD>
<TD>Returns the active interfaces as a list: componentRef interfaceRef componentRef interfaceRef</TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getDesignInterconnectionAbstractorInstanceIDs">getDesignInterconnectionAbstractorInstanceIDs</A></TD>
<TD>List of abstractor instances IDs for this interconnection</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getDesignMonitorInterconnectionIDs">getDesignMonitorInterconnectionIDs</A></TD>
<TD>List of monitorInterconnection element IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getMonitorInterconnectionInterfaces">getMonitorInterconnectionInterfaces</A></TD>
<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>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getDesignAdHocConnectionIDs">getDesignAdHocConnectionIDs</A></TD>
<TD>List of ad-hoc connection element IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAdHocConnectionTiedValue">getAdHocConnectionTiedValue</A></TD>
<TD>Get the tied value for an ad-hoc connection</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAdHocConnectionInternalPortReferenceIDs">getAdHocConnectionInternalPortReferenceIDs</A></TD>
<TD>List of internal ad-hoc port reference element IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAdHocConnectionInternalPortReferenceDetails">getAdHocConnectionInternalPortReferenceDetails</A></TD>
<TD>List for an internal connection containing the componentRef, portRef, left, and right attribute values</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAdHocConnectionExternalPortReferenceIDs">getAdHocConnectionExternalPortReferenceIDs</A></TD>
<TD>List of external ad-hoc port reference element IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAdHocConnectionExternalPortDetails">getAdHocConnectionExternalPortDetails</A></TD>
<TD>List for an external connection containing the portRef, left, and right attribute values</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getDesignHierConnectionIDs">getDesignHierConnectionIDs</A></TD>
<TD>List of hierarchical connection element IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getHierConnectionDetails">getHierConnectionDetails</A></TD>
<TD>List containing the interface name, component reference, and interface reference</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#addComponentInstance">addComponentInstance</A></TD>
<TD>Add new component instance.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#removeComponentInstance">removeComponentInstance</A></TD>
<TD>Remove specified component instance.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#replaceComponentInstance">replaceComponentInstance</A></TD>
<TD>Replace specified component with new provided component.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#appendAbstractorInstance">appendAbstractorInstance</A></TD>
<TD>Append a new abstractor instance to the interconnection.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#removeAbstractorInstance">removeAbstractorInstance</A></TD>
<TD>Remove specified abstractor instance.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#replaceAbstractorInstance">replaceAbstractorInstance</A></TD>
<TD>Replace specified abstractor with new provided abstractor.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#addInterconnection">addInterconnection</A></TD>
<TD>Add new interconnection between components.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#removeInterconnection">removeInterconnection</A></TD>
<TD>Remove interconnection between components, and any abstractors if present.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#addMonitorInterconnection">addMonitorInterconnection</A></TD>
<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>
<TD> </TD></TR>
<TR><TD><A HREF="#addHierarchicalMonitorInterconnection">addHierarchicalMonitorInterconnection</A></TD>
<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>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#removeMonitorInterconnection">removeMonitorInterconnection</A></TD>
<TD>Remove interconnection between a component and monitor. When the last monitor reference is removed, the entire monitorInterconnection element will be removed.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#removeHierarchicalMonitorInterconnection">removeHierarchicalMonitorInterconnection</A></TD>
<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>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#addHierConnection">addHierConnection</A></TD>
<TD>Add new hierarchical connection.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#removeHierConnection">removeHierConnection</A></TD>
<TD>Remove existing hierarchical connection.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#addAdHocConnection">addAdHocConnection</A></TD>
<TD>Add new ad-hoc connection.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#addAdHocInternalPortReference">addAdHocInternalPortReference</A></TD>
<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>
<TD> </TD></TR>
<TR><TD><A HREF="#addAdHocExternalPortReference">addAdHocExternalPortReference</A></TD>
<TD>Add an external port reference to an existing ad-hoc connection.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#removeAdHocInternalPortReference">removeAdHocInternalPortReference</A></TD>
<TD>Remove an internal port from existing ad-hoc connection. The ad-hoc connection is removed when the last port reference is removed.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#removeAdHocExternalPortReference">removeAdHocExternalPortReference</A></TD>
<TD>Remove an external port reference from existing ad-hoc connection.</TD>
<TD> </TD></TR>
</TABLE>
<P>
<H2><A NAME="FieldOperations">Field Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getRegisterFieldBitOffset">getRegisterFieldBitOffset</A></TD>
<TD>Bit offset of the fields LSB inside the register.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getRegisterFieldBitWidth">getRegisterFieldBitWidth</A></TD>
<TD>Width of the field in bits., <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setRegisterFieldBitWidth">setRegisterFieldBitWidth</A></TD>
<TD>Set the width of the field in bits., <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getRegisterFieldVolatility">getRegisterFieldVolatility</A></TD>
<TD>Indicates whether or not the data is volatile. The presumed value is 'false' if the element is not present.</TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getRegisterFieldAccess">getRegisterFieldAccess</A></TD>
<TD>The accessibility of the data in the field.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getRegisterFieldValueIDs">getRegisterFieldValueIDs</A></TD>
<TD>List of IDs for field values for the given register field.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getRegisterFieldValueUsage">getRegisterFieldValueUsage</A></TD>
<TD>Enumerated bit field usage.</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getRegisterFieldValue">getRegisterFieldValue</A></TD>
<TD>Enumerated bit field value.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getRegisterFieldValueName">getRegisterFieldValueName</A></TD>
<TD>Enumerated name for this register field value. Deprecated - use getName.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getRegisterFieldModifiedWriteValue">getRegisterFieldModifiedWriteValue</A></TD>
<TD>The modified write value for the field</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getRegisterFieldWriteValueConstraintWriteAsRead">getRegisterFieldWriteValueConstraintWriteAsRead</A></TD>
<TD>The write value constraint is write as read.</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getRegisterFieldWriteValueConstraintUseEnumeratedValues">getRegisterFieldWriteValueConstraintUseEnumeratedValues</A></TD>
<TD>The write value constraint shall use the enumerated values.</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getRegisterFieldWriteValueConstraintMinMax">getRegisterFieldWriteValueConstraintMinMax</A></TD>
<TD>The value of a write constraint.</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getRegisterFieldReadAction">getRegisterFieldReadAction</A></TD>
<TD>The read action for the field</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getRegisterFieldTestable">getRegisterFieldTestable</A></TD>
<TD>True if the field can be tested with a simple register test.</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getRegisterFieldTestConstraint">getRegisterFieldTestConstraint</A></TD>
<TD>The test constraint required if the field can be tested with a simple register test.</TD>
<TD>New in 1.5</TD></TR>
</TABLE>
<P>
<H2><A NAME="Fileand Fileset Operations">File and Fileset Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getFileSetGroupName">getFileSetGroupName</A></TD>
<TD>Name of file set group</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileSetGroupFileSetIDs">getFileSetGroupFileSetIDs</A></TD>
<TD>List of file set IDs in this file set group</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileName">getFileName</A></TD>
<TD>Get name of the given fileID., <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileBuilderFileType">getFileBuilderFileType</A></TD>
<TD>FileType or userFileType of the file builder</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileBuilderCommand">getFileBuilderCommand</A></TD>
<TD>Command of the file builder, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileBuilderFlags">getFileBuilderFlags</A></TD>
<TD>Flags of the file builder, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileBuilderReplaceDefaultFlags">getFileBuilderReplaceDefaultFlags</A></TD>
<TD>Value of the replaceDefaultFlags element of the file builder, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileSetGroups">getFileSetGroups</A></TD>
<TD>List of group names of the file set</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileSetFileIDs">getFileSetFileIDs</A></TD>
<TD>List of file IDs of the file set</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileType">getFileType</A></TD>
<TD>FileType or userFileType of the file</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileIsIncludeFile">getFileIsIncludeFile</A></TD>
<TD>Indicates that the given file is an include file</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileHasExternalDeclarations">getFileHasExternalDeclarations</A></TD>
<TD>Indicates that the file includes external declarations required by the top-level netlist file</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileLogicalName">getFileLogicalName</A></TD>
<TD>Logical name of the file</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileLogicalNameDefault">getFileLogicalNameDefault</A></TD>
<TD>Default attribute of logical name of the file</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileExportedNames">getFileExportedNames</A></TD>
<TD>List of exported names of the file</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileBuildCommandName">getFileBuildCommandName</A></TD>
<TD>Name of the build command of the file, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileBuildCommandFlags">getFileBuildCommandFlags</A></TD>
<TD>Flags of the file build command, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileBuildCommandFlagsIsAppend">getFileBuildCommandFlagsIsAppend</A></TD>
<TD>Value of append attribute on the flag element</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileBuildCommandReplaceDefaultFlags">getFileBuildCommandReplaceDefaultFlags</A></TD>
<TD>Indicates whether or not to replace default flags, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileBuildCommandTargetName">getFileBuildCommandTargetName</A></TD>
<TD>Target name of the file build command, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileDependencies">getFileDependencies</A></TD>
<TD>List of dependent locations for the file, typically directories</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileDefineSymbolIDs">getFileDefineSymbolIDs</A></TD>
<TD>List of define symbol IDs used in the file</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileImageTypes">getFileImageTypes</A></TD>
<TD>List of image types of the file</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileSetFileBuilderIDs">getFileSetFileBuilderIDs</A></TD>
<TD>List of file builder IDs used for this fileSet</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileSetDependencies">getFileSetDependencies</A></TD>
<TD>List of dependent locations for the fileSet, typically directories</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFileSetFunctionIDs">getFileSetFunctionIDs</A></TD>
<TD>List of function IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFunctionReplicate">getFunctionReplicate</A></TD>
<TD>Value of replicate attribute on function element</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFunctionEntryPoint">getFunctionEntryPoint</A></TD>
<TD>Entry point of the function</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFunctionFileID">getFunctionFileID</A></TD>
<TD>File ID containing the function entry point</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFunctionReturnType">getFunctionReturnType</A></TD>
<TD>Return type of the function</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFunctionArgumentIDs">getFunctionArgumentIDs</A></TD>
<TD>List of argument IDs of the function of the file set</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFunctionArgumentDataType">getFunctionArgumentDataType</A></TD>
<TD>Data type of the argument</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFunctionDisabled">getFunctionDisabled</A></TD>
<TD>Indicates whether or not the function is disabled, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFunctionSourceFileIDs">getFunctionSourceFileIDs</A></TD>
<TD>List of source file IDs of the function of the file set</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFunctionSourceFileName">getFunctionSourceFileName</A></TD>
<TD>Name of the source file</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getFunctionSourceFileType">getFunctionSourceFileType</A></TD>
<TD>FileType or userFileType of the source file</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setFileName">setFileName</A></TD>
<TD>Set name of the given file.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setFileBuildCommandName">setFileBuildCommandName</A></TD>
<TD>Set command name for the given file builder.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setFileBuildCommandFlags">setFileBuildCommandFlags</A></TD>
<TD>Set command flags for the given file builder.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setFileBuildCommandReplaceDefaultFlags">setFileBuildCommandReplaceDefaultFlags</A></TD>
<TD>Set replace default flags for the given file builder.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setFileBuildCommandTargetName">setFileBuildCommandTargetName</A></TD>
<TD>Set target name for build command for the given file</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setFileBuilderCommand">setFileBuilderCommand</A></TD>
<TD>Set command associated with file builder.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setFileBuilderFlags">setFileBuilderFlags</A></TD>
<TD>Set flags associated with the given file builder.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setFileBuilderReplaceDefaultFlags">setFileBuilderReplaceDefaultFlags</A></TD>
<TD>Set value of replace default flags in file builder.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setFunctionDisabled">setFunctionDisabled</A></TD>
<TD>Set disable flag on function.</TD>
<TD> </TD></TR>
</TABLE>
<P>
<H2><A NAME="GeneratorOperations">Generator Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getGeneratorScope">getGeneratorScope</A></TD>
<TD>Scope of the generator</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getGeneratorIsHidden">getGeneratorIsHidden</A></TD>
<TD>Value of hidden attribute on the generator</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getGeneratorPhase">getGeneratorPhase</A></TD>
<TD>Phase number of the generator</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getGeneratorApiType">getGeneratorApiType</A></TD>
<TD>Api type of the generator</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getGeneratorExecutable">getGeneratorExecutable</A></TD>
<TD>Executable name associated with the generator </TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getGeneratorGroups">getGeneratorGroups</A></TD>
<TD>List of group names of the generator</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getGeneratorTransportMethods">getGeneratorTransportMethods</A></TD>
<TD>List of transport methods of the generator</TD>
<TD> </TD></TR>
</TABLE>
<P>
<H2><A NAME="InterfaceOperations">Interface Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getInterfaceBusTypeVLNV">getInterfaceBusTypeVLNV</A></TD>
<TD>List of VLNV of the bus definition</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getInterfaceAbstractionTypeVLNV">getInterfaceAbstractionTypeVLNV</A></TD>
<TD>List of VLNV of the abstraction definition</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getInterfaceMode">getInterfaceMode</A></TD>
<TD>Mode of the interface: master, slave, system, mirroredMaster, mirroredSlave, mirroredSystem or monitor</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getInterfacePortMapIDs">getInterfacePortMapIDs</A></TD>
<TD>List of interface port map IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getLogicalPhysicalMapIDs">getLogicalPhysicalMapIDs</A></TD>
<TD>List of the logical and physical port map IDs</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getPortMapRange">getPortMapRange</A></TD>
<TD>List of left and right range of the port map, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setPortMapRange">setPortMapRange</A></TD>
<TD>Set left/right range of an interface port map.</TD>
<TD> </TD></TR>
</TABLE>
<P>
<H2><A NAME="MiscellaneousOperations">Miscellaneous Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getVendorExtensions">getVendorExtensions</A></TD>
<TD>Returns the complete XML text of the vendor extension element including the spirit:vendorExtension tag, as a well formed XML document.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getVendorAttribute">getVendorAttribute</A></TD>
<TD>Get vendor defined attribute from the given element</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getParameterIDs">getParameterIDs</A></TD>
<TD>List of parameter IDs from the given element (any which contains spirit:parameter elements)</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getValue">getValue</A></TD>
<TD>Get the value of a parameterID, fileDefineIDs or argumentIDs., <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getValueAttribute">getValueAttribute</A></TD>
<TD>Returns the value of the given attribute name on the elementID/value element</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getModelParameterDataType">getModelParameterDataType</A></TD>
<TD>Data type of the model parameter</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getModelParameterUsageType">getModelParameterUsageType</A></TD>
<TD>Usage type of the model parameter</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getIdValue">getIdValue</A></TD>
<TD>Return the value of the spirit:id attribute on a ID</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getName">getName</A></TD>
<TD>Return the name of the specified element</TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getDescription">getDescription</A></TD>
<TD>Return the description of the specified element</TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getDisplayName">getDisplayName</A></TD>
<TD>Return the displayName of the specified element</TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getUnconfiguredID">getUnconfiguredID</A></TD>
<TD>Return the unconfigured ID from a configured ID</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getChoiceName">getChoiceName</A></TD>
<TD>Name of the choice</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getChoiceEnumerationIDs">getChoiceEnumerationIDs</A></TD>
<TD>List of choice enumeration IDs of the choice</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getChoiceEnumerationValue">getChoiceEnumerationValue</A></TD>
<TD>Value of the enumeration element</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getChoiceEnumerationText">getChoiceEnumerationText</A></TD>
<TD>Value of the enumeration text attribute</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getChoiceEnumerationHelp">getChoiceEnumerationHelp</A></TD>
<TD>Value of the enumeration help attribute</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#registerVLNV">registerVLNV</A></TD>
<TD>Indicate to DE where the file resides for the IP-XACT element with the given VLNV.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getXMLForVLNV">getXMLForVLNV</A></TD>
<TD>Return XML of the IP-XACT object identified by the given VLNV.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getGeneratorContextComponentInstanceID">getGeneratorContextComponentInstanceID</A></TD>
<TD>ID for the component instance associated with the currently invoked generator</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#init">init</A></TD>
<TD>API initialization function. Must be called before any other API call.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#message">message</A></TD>
<TD>Send message level and message text to Design Environment.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getErrorMessage">getErrorMessage</A></TD>
<TD>Get error message from prior callback.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getWarningCount">getWarningCount</A></TD>
<TD>Return count of how many potentially incompatible API calls have been made.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#end">end</A></TD>
<TD>Terminate connection to the Design Environment.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setVendorExtensions">setVendorExtensions</A></TD>
<TD>Set vendor extensions. NOTE: This call is only supported for elements within a spirit:design.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setVendorAttribute">setVendorAttribute</A></TD>
<TD>Set vendor defined attribute on the given element</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setValue">setValue</A></TD>
<TD>Set the value of a parameterID, fileDefineIDs or argumentIDs.</TD>
<TD> </TD></TR>
</TABLE>
<P>
<H2><A NAME="PortOperations">Port Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getPortStyle">getPortStyle</A></TD>
<TD>Returns 'wire' or 'transactional' to indicate the port style</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAllLogicalDirectionsAllowed">getAllLogicalDirectionsAllowed</A></TD>
<TD>Get the value of the allLogicalDirectionAllowed attribute</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getPortDirection">getPortDirection</A></TD>
<TD>Direction of the port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getPortRange">getPortRange</A></TD>
<TD>List of the left and right range of the port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getPortWireTypeDefIDs">getPortWireTypeDefIDs</A></TD>
<TD>List of typeDefs for a wire portID</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getPortTransactionalTypeDefID">getPortTransactionalTypeDefID</A></TD>
<TD>The type definition for a transactional portID</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getPortServiceID">getPortServiceID</A></TD>
<TD>ID of element representing the service of a transactional port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getPortAccessType">getPortAccessType</A></TD>
<TD>Indicates the access type for this port</TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getPortAccessHandle">getPortAccessHandle</A></TD>
<TD>Alternate name to be used when accessing this port</TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getPortMaxAllowedConnections">getPortMaxAllowedConnections</A></TD>
<TD>Max allowed connections for this transactional port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getPortMinAllowedConnections">getPortMinAllowedConnections</A></TD>
<TD>Min allowed connections for this transactional port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getPortDefaultValue">getPortDefaultValue</A></TD>
<TD>Default value of the port, if not set returns "", <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getPortClockDriverID">getPortClockDriverID</A></TD>
<TD>Element ID of clock driver element, if present</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getClockDriverPeriod">getClockDriverPeriod</A></TD>
<TD>Clock period of the given clock, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getClockDriverPeriodUnits">getClockDriverPeriodUnits</A></TD>
<TD>Units of the clock period of the given clock</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getClockDriverPulseOffset">getClockDriverPulseOffset</A></TD>
<TD>Clock pulse offset of the given clock, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getClockDriverPulseOffsetUnits">getClockDriverPulseOffsetUnits</A></TD>
<TD>Units of the clock pulse offset of the given clock</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getClockDriverPulseValue">getClockDriverPulseValue</A></TD>
<TD>Clock pulse value of the given clock, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getClockDriverPulseDuration">getClockDriverPulseDuration</A></TD>
<TD>Clock period of the given clock, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getClockDriverPulseDurationUnits">getClockDriverPulseDurationUnits</A></TD>
<TD>Units of the clock pulse duration of the given clock</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getClockDriverName">getClockDriverName</A></TD>
<TD>Name of the clock driver</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getClockDriverSource">getClockDriverSource</A></TD>
<TD>Source name of the clock driver</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getPortSingleShotDriverID">getPortSingleShotDriverID</A></TD>
<TD>Element ID of single shot driver element, if present</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getPortSingleShotPulseOffset">getPortSingleShotPulseOffset</A></TD>
<TD>Clock pulse offset of the port, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getPortSingleShotPulseValue">getPortSingleShotPulseValue</A></TD>
<TD>Clock pulse value of the port, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getPortSingleShotPulseDuration">getPortSingleShotPulseDuration</A></TD>
<TD>Clock period of the port, <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getPortConstraintSetIDs">getPortConstraintSetIDs</A></TD>
<TD>List of constraint sets IDs of the port</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setPortRange">setPortRange</A></TD>
<TD>Set left/right range for the given port.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setPortDefaultValue">setPortDefaultValue</A></TD>
<TD>Set default value of the given port.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setClockDriverPeriod">setClockDriverPeriod</A></TD>
<TD>Set period of the given clock port.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setClockDriverPulseOffset">setClockDriverPulseOffset</A></TD>
<TD>Set pulse offset value of the given clock port.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setClockDriverPulseValue">setClockDriverPulseValue</A></TD>
<TD>Set pulse value of the given clock port.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setClockDriverPulseDuration">setClockDriverPulseDuration</A></TD>
<TD>Set pulse duration of the given clock port.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setPortSingleShotPulseOffset">setPortSingleShotPulseOffset</A></TD>
<TD>Set pulse offset of given single shot port.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setPortSingleShotPulseValue">setPortSingleShotPulseValue</A></TD>
<TD>Set pulse value of given single shot port.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setPortSingleShotPulseDuration">setPortSingleShotPulseDuration</A></TD>
<TD>Set pulse duration of given single shot port.</TD>
<TD> </TD></TR>
</TABLE>
<P>
<H2><A NAME="RegisterFile Operations">Register File Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getRegisterFileDimensions">getRegisterFileDimensions</A></TD>
<TD>Dimensions of a register file array.</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getRegisterFileAddressOffset">getRegisterFileAddressOffset</A></TD>
<TD>The offset from the base address.</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getRegisterFileRange">getRegisterFileRange</A></TD>
<TD>The register file range in number of addressable units., <B>Configurable</B></TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#setRegisterFileRange">setRegisterFileRange</A></TD>
<TD>Set the register file range in addressable units., <B>Configurable</B></TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getRegisterFileRegisterIDs">getRegisterFileRegisterIDs</A></TD>
<TD>List of IDs for the registers of the given register file</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getRegisterFileRegisterFileIDs">getRegisterFileRegisterFileIDs</A></TD>
<TD>List of IDs for the register files of the given register file</TD>
<TD>New in 1.5</TD></TR>
</TABLE>
<P>
<H2><A NAME="RegisterOperations">Register Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getRegisterDimensions">getRegisterDimensions</A></TD>
<TD>Dimensions of a register array.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getRegisterAddressOffset">getRegisterAddressOffset</A></TD>
<TD>The offset from the base address.</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getRegisterAlternateRegisterIDs">getRegisterAlternateRegisterIDs</A></TD>
<TD>List of IDs for the alternate registers of the given register</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getRegisterAccess">getRegisterAccess</A></TD>
<TD>The accessibility of the data in the register</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getRegisterSize">getRegisterSize</A></TD>
<TD>The register size in bits., <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#setRegisterSize">setRegisterSize</A></TD>
<TD>Set the register size in bits., <B>Configurable</B></TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getRegisterVolatility">getRegisterVolatility</A></TD>
<TD>Indicates whether or not the data is volatile.</TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getRegisterResetValue">getRegisterResetValue</A></TD>
<TD>Register value at reset., <B>Configurable</B></TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#setRegisterResetValue">setRegisterResetValue</A></TD>
<TD>Set register value at reset., <B>Configurable</B></TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getRegisterResetMask">getRegisterResetMask</A></TD>
<TD>Mask to be ANDed with the value before comparing to reset value., <B>Configurable</B></TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#setRegisterResetMask">setRegisterResetMask</A></TD>
<TD>Set the mask to be ANDed with the value before comparing to reset value., <B>Configurable</B></TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getRegisterFieldIDs">getRegisterFieldIDs</A></TD>
<TD>List of IDs for the fields of the given register</TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getRegisterAlternateGroups">getRegisterAlternateGroups</A></TD>
<TD>Indicates the group names for an alternate register.</TD>
<TD>New in 1.5</TD></TR>
</TABLE>
<P>
<H2><A NAME="RemapOperations">Remap Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getRemapStatePortIDs">getRemapStatePortIDs</A></TD>
<TD>List of remap port IDs of a remap state</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getRemapStatePortPortID">getRemapStatePortPortID</A></TD>
<TD>Port ID for the remap state</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getRemapStatePortPortIndex">getRemapStatePortPortIndex</A></TD>
<TD>Index of the port if a vector for the remap state</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getRemapStatePortPortValue">getRemapStatePortPortValue</A></TD>
<TD>Value of the port for the remap state</TD>
<TD> </TD></TR>
</TABLE>
<P>
<H2><A NAME="ServiceOperations">Service Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getAbstractionDefServiceInitiative">getAbstractionDefServiceInitiative</A></TD>
<TD>Port service initiative from the abstraction definition</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getAbstractionDefServiceIDs">getAbstractionDefServiceIDs</A></TD>
<TD>List of typeDefs for an abstractionServiceID</TD>
<TD><FONT color=#ff0000>Invalid in 1.5</FONT></TD></TR>
<TR><TD><A HREF="#getAbstractionDefAbstractionServiceTypeDefIDs">getAbstractionDefAbstractionServiceTypeDefIDs</A></TD>
<TD>List of type definitions for an abstractionServiceID</TD>
<TD>New in 1.5</TD></TR>
<TR><TD><A HREF="#getServiceInitiative">getServiceInitiative</A></TD>
<TD>Initiative of the service</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getServiceTypeDefIDs">getServiceTypeDefIDs</A></TD>
<TD>List of typeDefs for a serviceID</TD>
<TD>Modified in 1.5</TD></TR>
</TABLE>
<P>
<H2><A NAME="TypeDefOperations">TypeDef Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getTypeDefTypeName">getTypeDefTypeName</A></TD>
<TD>Name of the type</TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getTypeDefConstrained">getTypeDefConstrained</A></TD>
<TD>Is the type name constrained</TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getTypeDefImplicit">getTypeDefImplicit</A></TD>
<TD>Is the type name implicit</TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getTypeDefTypeDefinitions">getTypeDefTypeDefinitions</A></TD>
<TD>List of type definition for the given type</TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getTypeDefTypeViewIDs">getTypeDefTypeViewIDs</A></TD>
<TD>List of type viewIDs for the given type</TD>
<TD>Modified in 1.5</TD></TR>
</TABLE>
<P>
<H2><A NAME="ViewOperations">View Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getViewDesignID">getViewDesignID</A></TD>
<TD>ID of the design associated with a hierarchical view</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getViewEnvIdentifiers">getViewEnvIdentifiers</A></TD>
<TD>List of environment identifiers of the view</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getViewLanguage">getViewLanguage</A></TD>
<TD>View Language</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getViewLanguageIsStrict">getViewLanguageIsStrict</A></TD>
<TD>Value of 'strict' attribute on view language element</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getViewModelName">getViewModelName</A></TD>
<TD>Get the model name for this view</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getViewDefaultFileBuilderIDs">getViewDefaultFileBuilderIDs</A></TD>
<TD>List of default file builder IDs of the view</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getViewFileSetIDs">getViewFileSetIDs</A></TD>
<TD>List of fileSet IDs for fileSets referenced by the view</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getViewPortConstraintSetIDs">getViewPortConstraintSetIDs</A></TD>
<TD>Constraint set ID for the port referenced by the view</TD>
<TD>Modified in 1.5</TD></TR>
<TR><TD><A HREF="#getViewWhiteboxElementRefIDs">getViewWhiteboxElementRefIDs</A></TD>
<TD>List of whitebox element reference IDs of the view</TD>
<TD> </TD></TR>
</TABLE>
<P>
<H2><A NAME="WhiteboxOperations">Whitebox Operations</A></H2>
<TABLE BORDER=1 WIDTH="100%">
<TR><TH>Name</TH><TH>Description</TH><TH>Compatability<BR>Restrictions</TH></TR>
<TR><TD><A HREF="#getWhiteboxElementRefID">getWhiteboxElementRefID</A></TD>
<TD>White box element reference ID</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getWhiteboxRefPathIDs">getWhiteboxRefPathIDs</A></TD>
<TD>List of path IDs of the white box element reference</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getWhiteboxRefPathName">getWhiteboxRefPathName</A></TD>
<TD>Name of the whitebox reference path element</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getWhiteboxRefPathRange">getWhiteboxRefPathRange</A></TD>
<TD>List of left and right range of the whitebox reference path element</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getWhiteboxElementType">getWhiteboxElementType</A></TD>
<TD>Type of the whitebox element</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getWhiteboxElementDrivable">getWhiteboxElementDrivable</A></TD>
<TD>Indicates whether or not the whitebox element is drivable</TD>
<TD> </TD></TR>
<TR><TD><A HREF="#getWhiteboxElementRegisterID">getWhiteboxElementRegisterID</A></TD>
<TD>Register reference ID of the whitebox element</TD>
<TD><FONT color=#ff0000>Invalid in 1.5</FONT></TD></TR>
<TR><TD><A HREF="#getWhiteboxElementRegisterIDs">getWhiteboxElementRegisterIDs</A></TD>
<TD>Register reference IDs of the whitebox element</TD>
<TD>New in 1.5</TD></TR>
</TABLE>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Abstraction Definition Operations</H2>
</TD></TR></TABLE>
<A NAME ="abstractionDefID0">
<BR><H3><A NAME="getAbstractionDefID">getAbstractionDefID</A></H3>
Description: ID for the abstraction definition with the given VLNV<B> </B>
<UL>
<LI>Returns: <I>abstractionDefID</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
</UL>
<A NAME ="vlnvValue0">
<BR><H3><A NAME="getAbstractionDefVLNV">getAbstractionDefVLNV</A></H3>
Description: Vendor Library Name Version of the abstraction definition<B> </B>
<UL>
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="vlnvValue1">
<BR><H3><A NAME="getAbstractionDefBusTypeVLNV">getAbstractionDefBusTypeVLNV</A></H3>
Description: Get VLNV of the bus definition<B> </B>
<UL>
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="vlnvValue2">
<BR><H3><A NAME="getAbstractionDefExtends">getAbstractionDefExtends</A></H3>
Description: Vendor Library Name Version of the abstraction definition being extended<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="abstractionDefPortID0">
<BR><H3><A NAME="getAbstractionDefPortIDs">getAbstractionDefPortIDs</A></H3>
Description: List of abstraction definition port element IDs<B> </B>
<UL>
<LI>Returns: <I>abstractionDefPortIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="value0">
<BR><H3><A NAME="getAbstractionDefPortLogicalName">getAbstractionDefPortLogicalName</A></H3>
Description: Logical name of this abstraction definition port<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="booleanValue0">
<BR><H3><A NAME="getAbstractionDefPortRequiresDriver">getAbstractionDefPortRequiresDriver</A></H3>
Description: Does this port require a driver<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="value1">
<BR><H3><A NAME="getAbstractionDefPortRequiredDriverType">getAbstractionDefPortRequiredDriverType</A></H3>
Description: Required driver type for this port<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="value2">
<BR><H3><A NAME="getAbstractionDefPortStyle">getAbstractionDefPortStyle</A></H3>
Description: Returns 'wire' or 'transactional' to indicate the port style<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="booleanValue1">
<BR><H3><A NAME="getAbstractionDefPortIsAddress">getAbstractionDefPortIsAddress</A></H3>
Description: Is this port an address port<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="booleanValue2">
<BR><H3><A NAME="getAbstractionDefPortIsData">getAbstractionDefPortIsData</A></H3>
Description: Is this port a data port<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="booleanValue3">
<BR><H3><A NAME="getAbstractionDefPortIsClock">getAbstractionDefPortIsClock</A></H3>
Description: Is this port a clock port<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="booleanValue4">
<BR><H3><A NAME="getAbstractionDefPortIsReset">getAbstractionDefPortIsReset</A></H3>
Description: Is this port a reset port<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="abstractionDefPortModeID0">
<FONT color=#ff0000><BR><H3><A NAME="getAbstractionDefPortModeID">getAbstractionDefPortModeID</A></H3></FONT>
Description: Returns an ID for accessing the given port in the given interface mode<B>- Invalid in 1.5</B>
<UL>
<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>
<LI>Input: <I>modeValue</I> of type <I>xsd:string</I> -- modeValue should be one of master, slave or system</LI>
<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>
</UL>
<A NAME ="abstractionDefPortModeID1">
<BR><H3><A NAME="getAbstractionDefPortModeIDs">getAbstractionDefPortModeIDs</A></H3>
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>
<UL>
<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>
<LI>Input: <I>modeValue</I> of type <I>xsd:string</I> -- modeValue should be one of master, slave or system</LI>
<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>
</UL>
<A NAME ="value3">
<BR><H3><A NAME="getAbstractionDefPortModeGroup">getAbstractionDefPortModeGroup</A></H3>
Description: Group name when present on a system interface<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="nonNegativeIntegerValue0">
<BR><H3><A NAME="getAbstractionDefPortModeBitWidth">getAbstractionDefPortModeBitWidth</A></H3>
Description: Bit width constraint when present on an interface of the given type<B> </B>
<UL>
<LI>Returns: <I>nonNegativeIntegerValue</I> of type <I>xsd:nonNegativeInteger</I> -- a return value of 0 indicates unbounded</LI>
<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>
</UL>
<A NAME ="direction0">
<BR><H3><A NAME="getAbstractionDefPortModeDirection">getAbstractionDefPortModeDirection</A></H3>
Description: Port direction constraint when present on an interface of the given type<B> </B>
<UL>
<LI>Returns: <I>direction</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="abstractionDefPortModeConstraintID0">
<BR><H3><A NAME="getAbstractionDefPortNonMirroredConstraintIDs">getAbstractionDefPortNonMirroredConstraintIDs</A></H3>
Description: List of constraint IDs for a non-mirrored port<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="abstractionDefPortModeConstraintID1">
<BR><H3><A NAME="getAbstractionDefPortMirroredConstraintIDs">getAbstractionDefPortMirroredConstraintIDs</A></H3>
Description: List of constraint IDs for a mirrored port<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="driveConstraintID0">
<BR><H3><A NAME="getAbstractionDefPortDriveConstraintIDs">getAbstractionDefPortDriveConstraintIDs</A></H3>
Description: List of drive constraint IDs of the port<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="loadConstraintID0">
<BR><H3><A NAME="getAbstractionDefPortLoadConstraintIDs">getAbstractionDefPortLoadConstraintIDs</A></H3>
Description: List of load constraint IDs of the port<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="timingConstraintID0">
<BR><H3><A NAME="getAbstractionDefPortTimingConstraintIDs">getAbstractionDefPortTimingConstraintIDs</A></H3>
Description: List of timing constraint IDs of the port<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="value4">
<BR><H3><A NAME="getAbstractionDefPortDefaultValue">getAbstractionDefPortDefaultValue</A></H3>
Description: Default value for port when not connected<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="presence0">
<BR><H3><A NAME="getAbstractionDefPortModePresence">getAbstractionDefPortModePresence</A></H3>
Description: Existence requirement for this port on an interface of the given type<B> </B>
<UL>
<LI>Returns: <I>presence</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="abstractionServiceID0">
<FONT color=#ff0000><BR><H3><A NAME="getAbstractionDefPortModeServiceIDs">getAbstractionDefPortModeServiceIDs</A></H3></FONT>
Description: AbstractionDef service IDs on a transactional port<B>- Invalid in 1.5</B>
<UL>
<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>
<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>
</UL>
<A NAME ="abstractionServiceID1">
<BR><H3><A NAME="getAbstractionDefPortModeServiceID">getAbstractionDefPortModeServiceID</A></H3>
Description: AbstractionDef service ID on a transactional port<B>- New in 1.5</B>
<UL>
<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>
<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>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Abstractor Instance Operations</H2>
</TD></TR></TABLE>
<A NAME ="value5">
<BR><H3><A NAME="getAbstractorInstanceName">getAbstractorInstanceName</A></H3>
Description: Instance name of the abstractor<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="vlnvValue3">
<BR><H3><A NAME="getAbstractorInstanceVLNV">getAbstractorInstanceVLNV</A></H3>
Description: Vendor Library Name Version of the abstractor (from the design file)<B> </B>
<UL>
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="abstractorID0">
<BR><H3><A NAME="getAbstractorInstanceAbstractorID">getAbstractorInstanceAbstractorID</A></H3>
Description: ID for the abstractor associated with given instance (crossing from design configuration to abstractor file)<B> </B>
<UL>
<LI>Returns: <I>abstractorID</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="xmlText0">
<BR><H3><A NAME="getAbstractorInstanceXML">getAbstractorInstanceXML</A></H3>
Description: Return the abstractor XML in text format. Schema version is DE dependent.<B> </B>
<UL>
<LI>Returns: <I>xmlText</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Abstractor Operations</H2>
</TD></TR></TABLE>
<A NAME ="value6">
<BR><H3><A NAME="getAbstractorAbstractorMode">getAbstractorAbstractorMode</A></H3>
Description: Get the mode that the abstractor can be master, slave, direct or system.<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="vlnvValue4">
<BR><H3><A NAME="getAbstractorBusTypeVLNV">getAbstractorBusTypeVLNV</A></H3>
Description: List of VLNV of the bus definition<B> </B>
<UL>
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="interfaceID0">
<BR><H3><A NAME="getAbstractorAbstractorInterfaceIDs">getAbstractorAbstractorInterfaceIDs</A></H3>
Description: List of 2 interface IDs<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="viewID0">
<BR><H3><A NAME="getAbstractorViewIDs">getAbstractorViewIDs</A></H3>
Description: A list of model view IDs<B>- Modified in 1.5</B>
<UL>
<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>
<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>
<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>
</UL>
<A NAME ="portID0">
<BR><H3><A NAME="getAbstractorPortIDs">getAbstractorPortIDs</A></H3>
Description: A list of abstractor model port IDs<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="parameterID0">
<BR><H3><A NAME="getAbstractorModelParameterIDs">getAbstractorModelParameterIDs</A></H3>
Description: A list of model parameter IDs<B> </B>
<UL>
<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>
<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>
<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>
</UL>
<A NAME ="generatorID0">
<BR><H3><A NAME="getAbstractorGeneratorIDs">getAbstractorGeneratorIDs</A></H3>
Description: List of generator IDs of the abstractor<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="choiceID0">
<BR><H3><A NAME="getAbstractorChoiceIDs">getAbstractorChoiceIDs</A></H3>
Description: List of choices IDs<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="fileSetID0">
<BR><H3><A NAME="getAbstractorFileSetIDs">getAbstractorFileSetIDs</A></H3>
Description: List of file set IDs<B> </B>
<UL>
<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>
<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>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Address Map Operations</H2>
</TD></TR></TABLE>
<A NAME ="range0">
<BR><H3><A NAME="getAddressSpaceRange">getAddressSpaceRange</A></H3>
Description: The address range of an address block expressed as the number of accessable and addressable units.<B> </B>
<UL>
<LI>Returns: <I>range</I> of type <I>spirit:spiritNumberType</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="width0">
<BR><H3><A NAME="getAddressSpaceWidth">getAddressSpaceWidth</A></H3>
Description: The bit width of an address block.<B> </B>
<UL>
<LI>Returns: <I>width</I> of type <I>xsd:nonNegativeInteger</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="localMemoryMapID0">
<BR><H3><A NAME="getAddressSpaceLocalMemoryMapID">getAddressSpaceLocalMemoryMapID</A></H3>
Description: The ID for the local memory map of the address space.<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>localMemoryMapID</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="segmentID0">
<BR><H3><A NAME="getAddressSpaceSegmentIDs">getAddressSpaceSegmentIDs</A></H3>
Description: List of IDs for address block segments for the address space.<B>- New in 1.5</B>
<UL>
<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>
<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>
</UL>
<A NAME ="addressOffset0">
<BR><H3><A NAME="getSegmentAddressOffset">getSegmentAddressOffset</A></H3>
Description: The address offset of an address space segment in an address space<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>addressOffset</I> of type <I>spirit:spiritNumberType</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="status0">
<BR><H3><A NAME="setSegmentAddressOffset">setSegmentAddressOffset</A></H3>
Description: Set the address offset of an address space segment expressed in the number addressable units.<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
<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>
<LI>Input: <I>addressOffset</I> of type <I>spirit:spiritNumberType</I> </LI>
</UL>
<A NAME ="range1">
<BR><H3><A NAME="getSegmentRange">getSegmentRange</A></H3>
Description: The address range of an address space segment expressed as the number of accessable addressable units.<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>range</I> of type <I>spirit:spiritNumberType</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="status1">
<BR><H3><A NAME="setSegmentRange">setSegmentRange</A></H3>
Description: Set the address range of an address space segment expressed as the number of accessable addressable units.<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
<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>
<LI>Input: <I>range</I> of type <I>spirit:spiritNumberType</I> </LI>
</UL>
<A NAME ="addressUnitBits0">
<BR><H3><A NAME="getAddressSpaceAddressUnitBits">getAddressSpaceAddressUnitBits</A></H3>
Description: The number bits in an addressable unit. If none exists, the default 8 bits is returned.<B> </B>
<UL>
<LI>Returns: <I>addressUnitBits</I> of type <I>xsd:positiveInteger</I> </LI>
<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>
</UL>
<A NAME ="executableImageID0">
<BR><H3><A NAME="getExecutableImageIDs">getExecutableImageIDs</A></H3>
Description: The IDs of the executable images belonging to the specified address space.<B> </B>
<UL>
<LI>Returns: <I>executableImageIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="value7">
<BR><H3><A NAME="getExecutableImageType">getExecutableImageType</A></H3>
Description: The type of the executable image if existent.<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="value8">
<BR><H3><A NAME="getExecutableImageLinkerCommand">getExecutableImageLinkerCommand</A></H3>
Description: The linker command for the current executable image.<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="value9">
<BR><H3><A NAME="getExecutableImageLinkerFlags">getExecutableImageLinkerFlags</A></H3>
Description: The flags of the current executable image linker command.<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="linkerCommandFileID0">
<BR><H3><A NAME="getExecutableImageLinkerCommandFileID">getExecutableImageLinkerCommandFileID</A></H3>
Description: Element ID of linkerCommandFile associated with given executable image.<B> </B>
<UL>
<LI>Returns: <I>linkerCommandFileID</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="fileBuilderID0">
<BR><H3><A NAME="getExecutableImageFileBuilderIDs">getExecutableImageFileBuilderIDs</A></H3>
Description: List of default file builder IDs of the executable image<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="fileSetID1">
<BR><H3><A NAME="getExecutableImageFileSetIDs">getExecutableImageFileSetIDs</A></H3>
Description: The group of file set reference IDs complying with the tool set of the current executable image.<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="fileName0">
<BR><H3><A NAME="getLinkerCommandFileName">getLinkerCommandFileName</A></H3>
Description: The name of the linker command file.<B> </B>
<UL>
<LI>Returns: <I>fileName</I> of type <I>spirit:spiritURI</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="value10">
<BR><H3><A NAME="getLinkerCommandFileLineSwitch">getLinkerCommandFileLineSwitch</A></H3>
Description: The command line switch to specify with the linker command file.<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="booleanValue5">
<BR><H3><A NAME="getLinkerCommandFileEnable">getLinkerCommandFileEnable</A></H3>
Description: Indicates whether or not to generate and enable the linker command file.<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="generatorID1">
<BR><H3><A NAME="getLinkerCommandGeneratorIDs">getLinkerCommandGeneratorIDs</A></H3>
Description: Reference IDs to the generator elements for generating the linker command file.<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="memoryMapElementID0">
<A NAME ="addressBlockID0">
<A NAME ="bankID0">
<A NAME ="subspaceMapID0">
<BR><H3><A NAME="getMemoryMapElementIDs">getMemoryMapElementIDs</A></H3>
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>
<UL>
<LI>Returns: <I>memoryMapElementIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<UL>
<LI>Possible value(s): <I>addressBlockID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>bankID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>subspaceMapID</I> of type <I>xsd:string</I></LI>
</UL>
<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>
<UL>
<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>
<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>
<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>
<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>
</UL>
</UL>
<A NAME ="type0">
<BR><H3><A NAME="getMemoryMapElementType">getMemoryMapElementType</A></H3>
Description: Indicates type of memory map element: addressBlock, bank or subspaceMap<B> </B>
<UL>
<LI>Returns: <I>type</I> of type <I>xsd:string</I> -- The return value is one of "addressBlock", "bank", "subspaceMap" or "" for unknown</LI>
<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>
<UL>
<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>
<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>
<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>
</UL>
</UL>
<A NAME ="addressUnitBits1">
<BR><H3><A NAME="getMemoryMapAddressUnitBits">getMemoryMapAddressUnitBits</A></H3>
Description: The number bits in an addressable unit for a memory map. If none exists, the default 8 bits is returned.<B> </B>
<UL>
<LI>Returns: <I>addressUnitBits</I> of type <I>xsd:positiveInteger</I> </LI>
<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>
</UL>
<A NAME ="baseAddress0">
<BR><H3><A NAME="getAddressBlockBaseAddress">getAddressBlockBaseAddress</A></H3>
Description: The base address of an address block<B> </B>
<UL>
<LI>Returns: <I>baseAddress</I> of type <I>spirit:spiritNumberType</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="range2">
<BR><H3><A NAME="getAddressBlockRange">getAddressBlockRange</A></H3>
Description: The address range of an address block expressed as the number of accessable and addressable units.<B> </B>
<UL>
<LI>Returns: <I>range</I> of type <I>spirit:spiritNumberType</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="width1">
<BR><H3><A NAME="getAddressBlockWidth">getAddressBlockWidth</A></H3>
Description: The bit width of an address block in the local memory map.<B> </B>
<UL>
<LI>Returns: <I>width</I> of type <I>xsd:nonNegativeInteger</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="usage0">
<BR><H3><A NAME="getAddressBlockUsage">getAddressBlockUsage</A></H3>
Description: Indicates the usage of this address block.<B> </B>
<UL>
<LI>Returns: <I>usage</I> of type <I>xsd:string</I> -- one of "memory", "register", "reserved" or "" if not set.</LI>
<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>
</UL>
<A NAME ="value11">
<BR><H3><A NAME="getAddressBlockVolatility">getAddressBlockVolatility</A></H3>
Description: Indicates whether or not the data is volatile.<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> -- returns "true", "false" or "".</LI>
<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>
</UL>
<A NAME ="value12">
<BR><H3><A NAME="getAddressBlockAccess">getAddressBlockAccess</A></H3>
Description: The accessibility of the data in the local address block.<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="registerID0">
<BR><H3><A NAME="getAddressBlockRegisterIDs">getAddressBlockRegisterIDs</A></H3>
Description: The IDs of the available registers in the address block.<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="registerFileID0">
<BR><H3><A NAME="getAddressBlockRegisterFileIDs">getAddressBlockRegisterFileIDs</A></H3>
Description: The IDs of the available register files in the address block.<B>- New in 1.5</B>
<UL>
<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>
<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>
</UL>
<A NAME ="identifier0">
<BR><H3><A NAME="getTypeIdentifier">getTypeIdentifier</A></H3>
Description: Indicates the type identifier of an addressBlock, registerFile, register or field.<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>identifier</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
<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>
<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>
<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>
</UL>
</UL>
<A NAME ="value13">
<BR><H3><A NAME="getBankAlignment">getBankAlignment</A></H3>
Description: The bank alignment value, serial or parallel<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="value14">
<BR><H3><A NAME="getBankBaseAddress">getBankBaseAddress</A></H3>
Description: The base address of an address bank<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>spirit:spiritNumberType</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="usage1">
<BR><H3><A NAME="getBankUsage">getBankUsage</A></H3>
Description: Indicates the usage of this address bank.<B> </B>
<UL>
<LI>Returns: <I>usage</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="value15">
<BR><H3><A NAME="getBankVolatility">getBankVolatility</A></H3>
Description: Indicates whether or not the data is volatile.<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> -- returns "true", "false" or "".</LI>
<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>
</UL>
<A NAME ="value16">
<BR><H3><A NAME="getBankAccess">getBankAccess</A></H3>
Description: The accessibility of the data in the local address bank.<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="interfaceID1">
<BR><H3><A NAME="getSubspaceMapMasterID">getSubspaceMapMasterID</A></H3>
Description: Master bus interface ID on the other side of a bus bridge .<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="segmentID1">
<BR><H3><A NAME="getSubspaceMapSegmentID">getSubspaceMapSegmentID</A></H3>
Description: Address space segment ID on the other side of a bus bridge .<B>- New in 1.5</B>
<UL>
<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>
<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>
</UL>
<A NAME ="value17">
<BR><H3><A NAME="getSubspaceMapBaseAddress">getSubspaceMapBaseAddress</A></H3>
Description: The base address of a memory subspace<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>spirit:spiritNumberType</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="memoryRemapID0">
<BR><H3><A NAME="getMemoryMapRemapElementIDs">getMemoryMapRemapElementIDs</A></H3>
Description: List of IDs for memory map 'remap' elements of the given memory map<B> </B>
<UL>
<LI>Returns: <I>memoryRemapIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="remapStateID0">
<BR><H3><A NAME="getMemoryRemapStateID">getMemoryRemapStateID</A></H3>
Description: Remap State ID for which this remap is applicable<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="status2">
<BR><H3><A NAME="setAddressSpaceRange">setAddressSpaceRange</A></H3>
Description: Set the address range of an address block expressed as the number of accessable and addressable units.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
<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>
<LI>Input: <I>range</I> of type <I>spirit:spiritNumberType</I> </LI>
</UL>
<A NAME ="status3">
<BR><H3><A NAME="setAddressSpaceWidth">setAddressSpaceWidth</A></H3>
Description: Set the bit width of an address block.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
<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>
<LI>Input: <I>width</I> of type <I>xsd:nonNegativeInteger</I> </LI>
</UL>
<A NAME ="status4">
<BR><H3><A NAME="setExecutableImageLinkerCommand">setExecutableImageLinkerCommand</A></H3>
Description: Set the linker command for the current executable image.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
<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>
<LI>Input: <I>value</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="status5">
<BR><H3><A NAME="setExecutableImageLinkerFlags">setExecutableImageLinkerFlags</A></H3>
Description: Set the flags of the current executable image linker command.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
<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>
<LI>Input: <I>value</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="status6">
<BR><H3><A NAME="setLinkerCommandFileName">setLinkerCommandFileName</A></H3>
Description: Set the name of the linker command file.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
<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>
<LI>Input: <I>fileName</I> of type <I>spirit:spiritURI</I> </LI>
</UL>
<A NAME ="status7">
<BR><H3><A NAME="setLinkerCommandFileLineSwitch">setLinkerCommandFileLineSwitch</A></H3>
Description: Set the command line switch to specify with the linker command file.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
<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>
<LI>Input: <I>value</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="status8">
<BR><H3><A NAME="setLinkerCommandFileEnable">setLinkerCommandFileEnable</A></H3>
Description: Set whether or not to generate and enable the linker command file.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
<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>
<LI>Input: <I>value</I> of type <I>xsd:boolean</I> </LI>
</UL>
<A NAME ="status9">
<BR><H3><A NAME="setAddressBlockBaseAddress">setAddressBlockBaseAddress</A></H3>
Description: Set the base address of an address block<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
<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>
<LI>Input: <I>baseAddress</I> of type <I>spirit:spiritNumberType</I> </LI>
</UL>
<A NAME ="status10">
<BR><H3><A NAME="setAddressBlockRange">setAddressBlockRange</A></H3>
Description: Set the address range of an address block expressed as the number of accessable and addressable units.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
<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>
<LI>Input: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
</UL>
<A NAME ="status11">
<BR><H3><A NAME="setAddressBlockWidth">setAddressBlockWidth</A></H3>
Description: Set the bit width of an address block<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
<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>
<LI>Input: <I>nonNegativeIntegerValue</I> of type <I>xsd:nonNegativeInteger</I> </LI>
</UL>
<A NAME ="status12">
<BR><H3><A NAME="setBankBaseAddress">setBankBaseAddress</A></H3>
Description: Set the base address of an address bank<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
<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>
<LI>Input: <I>baseAddress</I> of type <I>spirit:spiritNumberType</I> </LI>
</UL>
<A NAME ="status13">
<BR><H3><A NAME="setSubspaceMapBaseAddress">setSubspaceMapBaseAddress</A></H3>
Description: Set the base address of a memory subspace<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
<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>
<LI>Input: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Bus Definition Operations</H2>
</TD></TR></TABLE>
<A NAME ="busdefID0">
<BR><H3><A NAME="getBusDefinitionID">getBusDefinitionID</A></H3>
Description: ID for the bus definition with the given VLNV<B> </B>
<UL>
<LI>Returns: <I>busdefID</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
</UL>
<A NAME ="vlnvValue5">
<BR><H3><A NAME="getBusDefinitionVLNV">getBusDefinitionVLNV</A></H3>
Description: Vendor Library Name Version of the bus definition<B> </B>
<UL>
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="booleanValue6">
<BR><H3><A NAME="getBusDefinitionDirectConnection">getBusDefinitionDirectConnection</A></H3>
Description: Indicates whether or not the bus definition supports direct connections<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="booleanValue7">
<BR><H3><A NAME="getBusDefinitionIsAddressable">getBusDefinitionIsAddressable</A></H3>
Description: Indicates whether or not the bus definition is an addressable bus<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="vlnvValue6">
<BR><H3><A NAME="getBusDefinitionExtends">getBusDefinitionExtends</A></H3>
Description: Vendor Library Name Version of the bus definition being extended<B> </B>
<UL>
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="value18">
<BR><H3><A NAME="getBusDefinitionMaxMasters">getBusDefinitionMaxMasters</A></H3>
Description: Maximum # of masters supported by this bus definition<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:integer</I> -- -1 indicates unbounded</LI>
<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>
</UL>
<A NAME ="value19">
<BR><H3><A NAME="getBusDefinitionMaxSlaves">getBusDefinitionMaxSlaves</A></H3>
Description: Maximum # of slaves supported by this bus definition<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:integer</I> -- -1 indicates unbounded</LI>
<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>
</UL>
<A NAME ="groupNames0">
<BR><H3><A NAME="getBusDefinitionSystemGroupNames">getBusDefinitionSystemGroupNames</A></H3>
Description: List of system group names for this bus definition<B> </B>
<UL>
<LI>Returns: <I>groupNames</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Bus Interface Operations</H2>
</TD></TR></TABLE>
<A NAME ="addressSpaceID0">
<BR><H3><A NAME="getBusInterfaceMasterAddressSpaceID">getBusInterfaceMasterAddressSpaceID</A></H3>
Description: ID of the master addressSpace<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="spiritNumberTypeValue0">
<BR><H3><A NAME="getBusInterfaceMasterBaseAddress">getBusInterfaceMasterBaseAddress</A></H3>
Description: Base address of the master addressSpace<B> </B>
<UL>
<LI>Returns: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="memoryMapID0">
<BR><H3><A NAME="getBusInterfaceSlaveMemoryMapID">getBusInterfaceSlaveMemoryMapID</A></H3>
Description: ID of the memoryMap referenced from a slave interface<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="bridgeID0">
<BR><H3><A NAME="getBusInterfaceSlaveBridgeIDs">getBusInterfaceSlaveBridgeIDs</A></H3>
Description: List of slave bridge IDs<B> </B>
<UL>
<LI>Returns: <I>bridgeIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="interfaceID2">
<BR><H3><A NAME="getBridgeMasterID">getBridgeMasterID</A></H3>
Description: The slave interface master interface reference ID<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="booleanValue8">
<BR><H3><A NAME="getBridgeIsOpaque">getBridgeIsOpaque</A></H3>
Description: Value of the opaque attribute<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="fileSetGroupID0">
<BR><H3><A NAME="getBusInterfaceSlaveFileSetGroupIDs">getBusInterfaceSlaveFileSetGroupIDs</A></H3>
Description: List of fileSetGroup IDs<B> </B>
<UL>
<LI>Returns: <I>fileSetGroupIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="value20">
<BR><H3><A NAME="getBusInterfaceGroupName">getBusInterfaceGroupName</A></H3>
Description: Group name of a system, mirroredSystem, or monitor bus interface<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="remapAddressID0">
<BR><H3><A NAME="getBusInterfaceMirroredSlaveRemapAddressIDs">getBusInterfaceMirroredSlaveRemapAddressIDs</A></H3>
Description: List of remap address IDs of the mirrored slave interface<B> </B>
<UL>
<LI>Returns: <I>remapAddressIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="spiritNumberTypeValue1">
<BR><H3><A NAME="getRemapAddressValue">getRemapAddressValue</A></H3>
Description: Remap address of the given remap address element<B> </B>
<UL>
<LI>Returns: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
<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>
</UL>
<A NAME ="remapStateID1">
<BR><H3><A NAME="getRemapAddressRemapStateID">getRemapAddressRemapStateID</A></H3>
Description: Remap state ID of the given remap address element<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="spiritNumberTypeValue2">
<BR><H3><A NAME="getBusInterfaceMirroredSlaveRange">getBusInterfaceMirroredSlaveRange</A></H3>
Description: The address range of the mirrored slave interface<B> </B>
<UL>
<LI>Returns: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
<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>
</UL>
<A NAME ="value21">
<BR><H3><A NAME="getBusInterfaceMonitorInterfaceMode">getBusInterfaceMonitorInterfaceMode</A></H3>
Description: Indicates the mode of interface being monitored, slave, master, system, mirrorslave, mirrormaster or mirrorslave<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="booleanValue9">
<BR><H3><A NAME="getBusInterfaceConnectionRequired">getBusInterfaceConnectionRequired</A></H3>
Description: Connection required for this bus interface<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="bitSteeringValue0">
<BR><H3><A NAME="getBusInterfaceBitSteering">getBusInterfaceBitSteering</A></H3>
Description: Bit steering description of the bus interface: on or off<B> </B>
<UL>
<LI>Returns: <I>bitSteeringValue</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="spiritEndianessValue0">
<BR><H3><A NAME="getBusInterfaceEndianness">getBusInterfaceEndianness</A></H3>
Description: The endianess of the bus interface, big or little. The default is little.<B> </B>
<UL>
<LI>Returns: <I>spiritEndianessValue</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="bitsInLau0">
<BR><H3><A NAME="getBusInterfaceBitsInLAU">getBusInterfaceBitsInLAU</A></H3>
Description: The number bits in the least addressable unit. If none exists, the default 8 bits is returned.<B> </B>
<UL>
<LI>Returns: <I>bitsInLau</I> of type <I>xsd:positiveInteger</I> </LI>
<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>
</UL>
<A NAME ="status14">
<BR><H3><A NAME="setBusInterfaceMasterBaseAddress">setBusInterfaceMasterBaseAddress</A></H3>
Description: Set base address of the master bus interface.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>baseAddressValue</I> of type <I>spirit:spiritNumberType</I> </LI>
</UL>
<A NAME ="status15">
<BR><H3><A NAME="setRemapAddressValue">setRemapAddressValue</A></H3>
Description: Set remap address value for the associated interface.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
</UL>
<A NAME ="status16">
<BR><H3><A NAME="setBusInterfaceMirroredSlaveRange">setBusInterfaceMirroredSlaveRange</A></H3>
Description: Set address range for the associated interface.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
</UL>
<A NAME ="status17">
<BR><H3><A NAME="setBusInterfaceBitSteering">setBusInterfaceBitSteering</A></H3>
Description: Set bus interface bit steering value.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>bitSteeringValue</I> of type <I>xsd:string</I> </LI>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Component Instance Operations</H2>
</TD></TR></TABLE>
<A NAME ="value22">
<BR><H3><A NAME="getComponentInstanceName">getComponentInstanceName</A></H3>
Description: Instance name of the component<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="vlnvValue7">
<BR><H3><A NAME="getComponentInstanceVLNV">getComponentInstanceVLNV</A></H3>
Description: Vendor Library Name Version of the component (from the design file)<B> </B>
<UL>
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="componentID0">
<BR><H3><A NAME="getComponentInstanceComponentID">getComponentInstanceComponentID</A></H3>
Description: ID for the component associated with given instance (crossing from design to component file)<B> </B>
<UL>
<LI>Returns: <I>componentID</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="xmlText1">
<BR><H3><A NAME="getComponentInstanceXML">getComponentInstanceXML</A></H3>
Description: Return the component XML in text format. Schema version is DE dependent.<B> </B>
<UL>
<LI>Returns: <I>xmlText</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Component Operations</H2>
</TD></TR></TABLE>
<A NAME ="vlnvValue8">
<BR><H3><A NAME="getComponentVLNV">getComponentVLNV</A></H3>
Description: Vendor Library Name Version of the component (from the component file)<B> </B>
<UL>
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="componentElementType0">
<BR><H3><A NAME="getComponentElementType">getComponentElementType</A></H3>
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> </B>
<UL>
<LI>Returns: <I>componentElementType</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="interfaceID3">
<BR><H3><A NAME="getChannelBusInterfaceIDs">getChannelBusInterfaceIDs</A></H3>
Description: List of busInterface IDs in this channel<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="addressSpaceID1">
<BR><H3><A NAME="getComponentAddressSpaceIDs">getComponentAddressSpaceIDs</A></H3>
Description: List of IDs for the logical address spaces in the component.<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="remapStateID2">
<BR><H3><A NAME="getComponentRemapStateIDs">getComponentRemapStateIDs</A></H3>
Description: A list of remap state IDs<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="viewID1">
<BR><H3><A NAME="getComponentViewIDs">getComponentViewIDs</A></H3>
Description: A list of model view IDs<B> </B>
<UL>
<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>
<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>
<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>
</UL>
<A NAME ="interfaceID4">
<BR><H3><A NAME="getComponentBusInterfaceIDs">getComponentBusInterfaceIDs</A></H3>
Description: List of interface IDs<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="channelID0">
<BR><H3><A NAME="getComponentChannelIDs">getComponentChannelIDs</A></H3>
Description: A list of channel IDs<B> </B>
<UL>
<LI>Returns: <I>channelIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="portID1">
<BR><H3><A NAME="getComponentPortIDs">getComponentPortIDs</A></H3>
Description: A list of component model port IDs<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="parameterID1">
<BR><H3><A NAME="getComponentModelParameterIDs">getComponentModelParameterIDs</A></H3>
Description: A list of model parameter IDs<B> </B>
<UL>
<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>
<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>
<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>
</UL>
<A NAME ="generatorID2">
<BR><H3><A NAME="getComponentGeneratorIDs">getComponentGeneratorIDs</A></H3>
Description: List of generator IDs of the component<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="choiceID1">
<BR><H3><A NAME="getComponentChoiceIDs">getComponentChoiceIDs</A></H3>
Description: List of choices IDs<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="fileSetID2">
<BR><H3><A NAME="getComponentFileSetIDs">getComponentFileSetIDs</A></H3>
Description: List of file set IDs<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="whiteboxElementID0">
<BR><H3><A NAME="getComponentWhiteboxElementIDs">getComponentWhiteboxElementIDs</A></H3>
Description: List of whitebox element IDs of the component<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="cpuID0">
<BR><H3><A NAME="getComponentCpuIDs">getComponentCpuIDs</A></H3>
Description: List of cpu IDs of the component<B> </B>
<UL>
<LI>Returns: <I>cpuIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="addressSpaceID2">
<BR><H3><A NAME="getCpuAddressSpaceIDs">getCpuAddressSpaceIDs</A></H3>
Description: List of address space reference IDs of the cpu<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="clockDriverID0">
<BR><H3><A NAME="getComponentOtherClockDriverIDs">getComponentOtherClockDriverIDs</A></H3>
Description: List of clock driver IDs of the component<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="memoryMapID1">
<BR><H3><A NAME="getComponentMemoryMapIDs">getComponentMemoryMapIDs</A></H3>
Description: List of IDs for memory map elements in the given component<B> </B>
<UL>
<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>
<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>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Constraint Operations</H2>
</TD></TR></TABLE>
<A NAME ="value23">
<BR><H3><A NAME="getPortConstraintSetReferenceName">getPortConstraintSetReferenceName</A></H3>
Description: Reference name of the given port constraint set<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="integerArrayValue0">
<BR><H3><A NAME="getPortConstraintSetRange">getPortConstraintSetRange</A></H3>
Description: List of the left and right range of a port referenced by this constraint set<B> </B>
<UL>
<LI>Returns: <I>integerArrayValue</I> of type <I>spirit:integerArrayType</I> </LI>
<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>
</UL>
<A NAME ="driveConstraintID1">
<BR><H3><A NAME="getPortConstraintSetDriveConstraintIDs">getPortConstraintSetDriveConstraintIDs</A></H3>
Description: List of drive constraint IDs of the port<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="loadConstraintID1">
<BR><H3><A NAME="getPortConstraintSetLoadConstraintIDs">getPortConstraintSetLoadConstraintIDs</A></H3>
Description: List of load constraint IDs of the port<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="timingConstraintID1">
<BR><H3><A NAME="getPortConstraintSetTimingConstraintIDs">getPortConstraintSetTimingConstraintIDs</A></H3>
Description: List of timing constraint IDs of the port<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="driveConstraintTypeValue0">
<BR><H3><A NAME="getDriveConstraintType">getDriveConstraintType</A></H3>
Description: Indicates the type of drive constraint: function class<B> </B>
<UL>
<LI>Returns: <I>driveConstraintTypeValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="value24">
<BR><H3><A NAME="getDriveConstraintValue">getDriveConstraintValue</A></H3>
Description: Returns the drive constraint. Format depends on the constraint type.<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="loadConstraintTypeValue0">
<BR><H3><A NAME="getLoadConstraintType">getLoadConstraintType</A></H3>
Description: Indicates the type of load constraint: function class<B> </B>
<UL>
<LI>Returns: <I>loadConstraintTypeValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="value25">
<BR><H3><A NAME="getLoadConstraintValue">getLoadConstraintValue</A></H3>
Description: Returns the load constraint. Format is cell function and strength or cell class and strength.<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="value26">
<BR><H3><A NAME="getLoadConstraintCount">getLoadConstraintCount</A></H3>
Description: Returns the load constraint count, the number of loads.<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:integer</I> </LI>
<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>
</UL>
<A NAME ="clockDetailsValue0">
<BR><H3><A NAME="getTimingConstraintClockDetails">getTimingConstraintClockDetails</A></H3>
Description: Indicates the clock name, clock edge, and delay type<B> </B>
<UL>
<LI>Returns: <I>clockDetailsValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="floatValue0">
<BR><H3><A NAME="getTimingConstraintValue">getTimingConstraintValue</A></H3>
Description: Returns the timing constraint value (cycle time percentage).<B> </B>
<UL>
<LI>Returns: <I>floatValue</I> of type <I>xsd:float</I> </LI>
<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>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Design Operations</H2>
</TD></TR></TABLE>
<A NAME ="designID0">
<BR><H3><A NAME="getDesignID">getDesignID</A></H3>
Description: Get ID of the current or top design<B> </B>
<UL>
<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>
<LI>Input: <I>top</I> of type <I>xsd:boolean</I> </LI>
</UL>
<A NAME ="vlnvValue9">
<BR><H3><A NAME="getDesignVLNV">getDesignVLNV</A></H3>
Description: Vendor Library Name Version of the design<B> </B>
<UL>
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="componentInstanceID0">
<BR><H3><A NAME="getDesignComponentInstanceIDs">getDesignComponentInstanceIDs</A></H3>
Description: Components instances IDs of the given design<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="componentInstanceID1">
<BR><H3><A NAME="getComponentInstanceID">getComponentInstanceID</A></H3>
Description: Return the component instance ID of the named component instance in the given design<B> </B>
<UL>
<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>
<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>
<LI>Input: <I>instanceName</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="interconnectionID0">
<BR><H3><A NAME="getDesignInterconnectionIDs">getDesignInterconnectionIDs</A></H3>
Description: List of interconnection element IDs<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="activeInterfaceValue0">
<BR><H3><A NAME="getInterconnectionActiveInterfaces">getInterconnectionActiveInterfaces</A></H3>
Description: Returns the active interfaces as a list: componentRef interfaceRef componentRef interfaceRef<B>- Modified in 1.5</B>
<UL>
<LI>Returns: <I>activeInterfaceValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="abstractorInstanceID0">
<BR><H3><A NAME="getDesignInterconnectionAbstractorInstanceIDs">getDesignInterconnectionAbstractorInstanceIDs</A></H3>
Description: List of abstractor instances IDs for this interconnection<B> </B>
<UL>
<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>
<LI>Input: <I>interconnectName</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="monitorInterconnectionID0">
<BR><H3><A NAME="getDesignMonitorInterconnectionIDs">getDesignMonitorInterconnectionIDs</A></H3>
Description: List of monitorInterconnection element IDs<B> </B>
<UL>
<LI>Returns: <I>monitorInterconnectionIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="interconnectInterfaceValue0">
<BR><H3><A NAME="getMonitorInterconnectionInterfaces">getMonitorInterconnectionInterfaces</A></H3>
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>
<UL>
<LI>Returns: <I>interconnectInterfaceValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="adHocConnectionID0">
<BR><H3><A NAME="getDesignAdHocConnectionIDs">getDesignAdHocConnectionIDs</A></H3>
Description: List of ad-hoc connection element IDs<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="value27">
<BR><H3><A NAME="getAdHocConnectionTiedValue">getAdHocConnectionTiedValue</A></H3>
Description: Get the tied value for an ad-hoc connection<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="adHocInternalPortReferenceID0">
<BR><H3><A NAME="getAdHocConnectionInternalPortReferenceIDs">getAdHocConnectionInternalPortReferenceIDs</A></H3>
Description: List of internal ad-hoc port reference element IDs<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="details0">
<BR><H3><A NAME="getAdHocConnectionInternalPortReferenceDetails">getAdHocConnectionInternalPortReferenceDetails</A></H3>
Description: List for an internal connection containing the componentRef, portRef, left, and right attribute values<B> </B>
<UL>
<LI>Returns: <I>details</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="adHocExternalPortReferenceID0">
<BR><H3><A NAME="getAdHocConnectionExternalPortReferenceIDs">getAdHocConnectionExternalPortReferenceIDs</A></H3>
Description: List of external ad-hoc port reference element IDs<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="details1">
<BR><H3><A NAME="getAdHocConnectionExternalPortDetails">getAdHocConnectionExternalPortDetails</A></H3>
Description: List for an external connection containing the portRef, left, and right attribute values<B> </B>
<UL>
<LI>Returns: <I>details</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="hierConnectionID0">
<BR><H3><A NAME="getDesignHierConnectionIDs">getDesignHierConnectionIDs</A></H3>
Description: List of hierarchical connection element IDs<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="values0">
<BR><H3><A NAME="getHierConnectionDetails">getHierConnectionDetails</A></H3>
Description: List containing the interface name, component reference, and interface reference<B> </B>
<UL>
<LI>Returns: <I>values</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="componentInstanceID2">
<BR><H3><A NAME="addComponentInstance">addComponentInstance</A></H3>
Description: Add new component instance.<B> </B>
<UL>
<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>
<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>
<LI>Input: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<LI>Input: <I>instanceName</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>displayName</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>description</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="status18">
<BR><H3><A NAME="removeComponentInstance">removeComponentInstance</A></H3>
Description: Remove specified component instance.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="status19">
<BR><H3><A NAME="replaceComponentInstance">replaceComponentInstance</A></H3>
Description: Replace specified component with new provided component.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<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>
<LI>Input: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
</UL>
<A NAME ="abstractorInstanceID1">
<BR><H3><A NAME="appendAbstractorInstance">appendAbstractorInstance</A></H3>
Description: Append a new abstractor instance to the interconnection.<B> </B>
<UL>
<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>
<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>
<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>
<LI>Input: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<LI>Input: <I>instanceName</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>displayName</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>description</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="status20">
<BR><H3><A NAME="removeAbstractorInstance">removeAbstractorInstance</A></H3>
Description: Remove specified abstractor instance.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="status21">
<BR><H3><A NAME="replaceAbstractorInstance">replaceAbstractorInstance</A></H3>
Description: Replace specified abstractor with new provided abstractor.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<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>
<LI>Input: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
</UL>
<A NAME ="interconnectionID1">
<BR><H3><A NAME="addInterconnection">addInterconnection</A></H3>
Description: Add new interconnection between components.<B> </B>
<UL>
<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>
<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>
<LI>Input: <I>component1Ref</I> of type <I>xsd:string</I> -- The component instance name.</LI>
<LI>Input: <I>interface1Ref</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>component2Ref</I> of type <I>xsd:string</I> -- The component instance name.</LI>
<LI>Input: <I>interface2Ref</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>name</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>displayName</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>description</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="status22">
<BR><H3><A NAME="removeInterconnection">removeInterconnection</A></H3>
Description: Remove interconnection between components, and any abstractors if present.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>component1Ref</I> of type <I>xsd:string</I> -- The component instance name.</LI>
<LI>Input: <I>interface1Ref</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>component2Ref</I> of type <I>xsd:string</I> -- The component instance name.</LI>
<LI>Input: <I>interface2Ref</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="interconnectionID2">
<BR><H3><A NAME="addMonitorInterconnection">addMonitorInterconnection</A></H3>
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> </B>
<UL>
<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>
<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>
<LI>Input: <I>componentRef</I> of type <I>xsd:string</I> -- The component instance name.</LI>
<LI>Input: <I>componentInterfaceRef</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>monitorRef</I> of type <I>xsd:string</I> -- The component instance name with the monitor interface.</LI>
<LI>Input: <I>monitorInterfaceRef</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>name</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>displayName</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>description</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="interconnectionID3">
<BR><H3><A NAME="addHierarchicalMonitorInterconnection">addHierarchicalMonitorInterconnection</A></H3>
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>
<UL>
<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>
<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>
<LI>Input: <I>componentPath</I> of type <I>xsd:string</I> -- The instance name path to the design that contains the component instance.</LI>
<LI>Input: <I>componentRef</I> of type <I>xsd:string</I> -- The component instance name.</LI>
<LI>Input: <I>componentInterfaceRef</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>monitorPath</I> of type <I>xsd:string</I> -- The instance name path to the design that contains the monitor instance.</LI>
<LI>Input: <I>monitorRef</I> of type <I>xsd:string</I> -- The component instance name with the monitor interface.</LI>
<LI>Input: <I>monitorInterfaceRef</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>name</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>displayName</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>description</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="status23">
<BR><H3><A NAME="removeMonitorInterconnection">removeMonitorInterconnection</A></H3>
Description: Remove interconnection between a component and monitor. When the last monitor reference is removed, the entire monitorInterconnection element will be removed.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>componentRef</I> of type <I>xsd:string</I> -- The component instance name.</LI>
<LI>Input: <I>componentInterfaceRef</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>monitorRef</I> of type <I>xsd:string</I> -- The component instance name with the monitor interface.</LI>
<LI>Input: <I>monitorInterfaceRef</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="status24">
<BR><H3><A NAME="removeHierarchicalMonitorInterconnection">removeHierarchicalMonitorInterconnection</A></H3>
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>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>componentPath</I> of type <I>xsd:string</I> -- The instance name path to the design that contains the component instance.</LI>
<LI>Input: <I>componentRef</I> of type <I>xsd:string</I> -- The component instance name.</LI>
<LI>Input: <I>componentInterfaceRef</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>monitorPath</I> of type <I>xsd:string</I> -- The instance name path to the design that contains the monitor instance.</LI>
<LI>Input: <I>monitorRef</I> of type <I>xsd:string</I> -- The component instance name with the monitor interface.</LI>
<LI>Input: <I>monitorInterfaceRef</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="hierConnectionID1">
<BR><H3><A NAME="addHierConnection">addHierConnection</A></H3>
Description: Add new hierarchical connection.<B> </B>
<UL>
<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>
<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>
<LI>Input: <I>interfaceRef</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>componentRef</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>busRef</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="status25">
<BR><H3><A NAME="removeHierConnection">removeHierConnection</A></H3>
Description: Remove existing hierarchical connection.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>componentRef</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>busRef</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="adHocConnectionID1">
<BR><H3><A NAME="addAdHocConnection">addAdHocConnection</A></H3>
Description: Add new ad-hoc connection.<B> </B>
<UL>
<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>
<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>
<LI>Input: <I>name</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>displayName</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>description</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>componentRef</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>portRef</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>left</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>right</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>tiedValue</I> of type <I>spirit:spiritNumberType</I> -- Tied value for this connection, if blank no tied value.</LI>
</UL>
<A NAME ="adHocInternalPortReferenceID1">
<BR><H3><A NAME="addAdHocInternalPortReference">addAdHocInternalPortReference</A></H3>
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> </B>
<UL>
<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>
<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>
<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>
<LI>Input: <I>componentRef</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>portRef</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>left</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>right</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="adHocExternalPortReferenceID1">
<BR><H3><A NAME="addAdHocExternalPortReference">addAdHocExternalPortReference</A></H3>
Description: Add an external port reference to an existing ad-hoc connection.<B> </B>
<UL>
<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>
<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>
<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>
<LI>Input: <I>portRef</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>left</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>right</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="status26">
<BR><H3><A NAME="removeAdHocInternalPortReference">removeAdHocInternalPortReference</A></H3>
Description: Remove an internal port from existing ad-hoc connection. The ad-hoc connection is removed when the last port reference is removed.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<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>
<LI>Input: <I>componentRef</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>portRef</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="status27">
<BR><H3><A NAME="removeAdHocExternalPortReference">removeAdHocExternalPortReference</A></H3>
Description: Remove an external port reference from existing ad-hoc connection.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<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>
<LI>Input: <I>portRef</I> of type <I>xsd:string</I> </LI>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Field Operations</H2>
</TD></TR></TABLE>
<A NAME ="value28">
<BR><H3><A NAME="getRegisterFieldBitOffset">getRegisterFieldBitOffset</A></H3>
Description: Bit offset of the fields LSB inside the register.<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:integer</I> </LI>
<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>
</UL>
<A NAME ="width2">
<BR><H3><A NAME="getRegisterFieldBitWidth">getRegisterFieldBitWidth</A></H3>
Description: Width of the field in bits.<B> </B>
<UL>
<LI>Returns: <I>width</I> of type <I>xsd:positiveInteger</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="status28">
<BR><H3><A NAME="setRegisterFieldBitWidth">setRegisterFieldBitWidth</A></H3>
Description: Set the width of the field in bits.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
<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>
<LI>Input: <I>width</I> of type <I>xsd:positiveInteger</I> </LI>
</UL>
<A NAME ="value29">
<BR><H3><A NAME="getRegisterFieldVolatility">getRegisterFieldVolatility</A></H3>
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>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> -- returns "true" or "false"</LI>
<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>
</UL>
<A NAME ="value30">
<BR><H3><A NAME="getRegisterFieldAccess">getRegisterFieldAccess</A></H3>
Description: The accessibility of the data in the field.<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="regFieldValueID0">
<BR><H3><A NAME="getRegisterFieldValueIDs">getRegisterFieldValueIDs</A></H3>
Description: List of IDs for field values for the given register field.<B> </B>
<UL>
<LI>Returns: <I>regFieldValueIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="usage2">
<BR><H3><A NAME="getRegisterFieldValueUsage">getRegisterFieldValueUsage</A></H3>
Description: Enumerated bit field usage.<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>usage</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="value31">
<BR><H3><A NAME="getRegisterFieldValue">getRegisterFieldValue</A></H3>
Description: Enumerated bit field value.<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>spirit:spiritNumberType</I> </LI>
<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>
</UL>
<A NAME ="value32">
<BR><H3><A NAME="getRegisterFieldValueName">getRegisterFieldValueName</A></H3>
Description: Enumerated name for this register field value. Deprecated - use getName.<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="type1">
<BR><H3><A NAME="getRegisterFieldModifiedWriteValue">getRegisterFieldModifiedWriteValue</A></H3>
Description: The modified write value for the field<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>type</I> of type <I>xsd:string</I> -- one of "", "onetoClear", "oneToSet", "oneToToggle", "zeroToClear", "zeroToSet","zeroToToggle", "clear", "set" or "modified"</LI>
<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>
</UL>
<A NAME ="boolean0">
<BR><H3><A NAME="getRegisterFieldWriteValueConstraintWriteAsRead">getRegisterFieldWriteValueConstraintWriteAsRead</A></H3>
Description: The write value constraint is write as read.<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>boolean</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="boolean1">
<BR><H3><A NAME="getRegisterFieldWriteValueConstraintUseEnumeratedValues">getRegisterFieldWriteValueConstraintUseEnumeratedValues</A></H3>
Description: The write value constraint shall use the enumerated values.<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>boolean</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="integerArrayValue1">
<BR><H3><A NAME="getRegisterFieldWriteValueConstraintMinMax">getRegisterFieldWriteValueConstraintMinMax</A></H3>
Description: The value of a write constraint.<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>integerArrayValue</I> of type <I>spirit:integerArrayType</I> -- array of minimum and maximum or zero element array if not specified</LI>
<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>
</UL>
<A NAME ="type2">
<BR><H3><A NAME="getRegisterFieldReadAction">getRegisterFieldReadAction</A></H3>
Description: The read action for the field<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>type</I> of type <I>xsd:string</I> -- one of "", "clear", "set" or "modify"</LI>
<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>
</UL>
<A NAME ="booleanValue10">
<BR><H3><A NAME="getRegisterFieldTestable">getRegisterFieldTestable</A></H3>
Description: True if the field can be tested with a simple register test.<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="value33">
<BR><H3><A NAME="getRegisterFieldTestConstraint">getRegisterFieldTestConstraint</A></H3>
Description: The test constraint required if the field can be tested with a simple register test.<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>File and Fileset Operations</H2>
</TD></TR></TABLE>
<A NAME ="value34">
<BR><H3><A NAME="getFileSetGroupName">getFileSetGroupName</A></H3>
Description: Name of file set group<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="fileSetID3">
<BR><H3><A NAME="getFileSetGroupFileSetIDs">getFileSetGroupFileSetIDs</A></H3>
Description: List of file set IDs in this file set group<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="name0">
<BR><H3><A NAME="getFileName">getFileName</A></H3>
Description: Get name of the given fileID.<B> </B>
<UL>
<LI>Returns: <I>name</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
<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>
</UL>
<A NAME ="value35">
<BR><H3><A NAME="getFileBuilderFileType">getFileBuilderFileType</A></H3>
Description: FileType or userFileType of the file builder<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="value36">
<BR><H3><A NAME="getFileBuilderCommand">getFileBuilderCommand</A></H3>
Description: Command of the file builder<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="value37">
<BR><H3><A NAME="getFileBuilderFlags">getFileBuilderFlags</A></H3>
Description: Flags of the file builder<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="booleanValue11">
<BR><H3><A NAME="getFileBuilderReplaceDefaultFlags">getFileBuilderReplaceDefaultFlags</A></H3>
Description: Value of the replaceDefaultFlags element of the file builder<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="fileSetGroupsValue0">
<BR><H3><A NAME="getFileSetGroups">getFileSetGroups</A></H3>
Description: List of group names of the file set<B> </B>
<UL>
<LI>Returns: <I>fileSetGroupsValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="fileID0">
<BR><H3><A NAME="getFileSetFileIDs">getFileSetFileIDs</A></H3>
Description: List of file IDs of the file set<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="value38">
<BR><H3><A NAME="getFileType">getFileType</A></H3>
Description: FileType or userFileType of the file<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="booleanValue12">
<BR><H3><A NAME="getFileIsIncludeFile">getFileIsIncludeFile</A></H3>
Description: Indicates that the given file is an include file<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="booleanValue13">
<BR><H3><A NAME="getFileHasExternalDeclarations">getFileHasExternalDeclarations</A></H3>
Description: Indicates that the file includes external declarations required by the top-level netlist file<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="value39">
<BR><H3><A NAME="getFileLogicalName">getFileLogicalName</A></H3>
Description: Logical name of the file<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="booleanValue14">
<BR><H3><A NAME="getFileLogicalNameDefault">getFileLogicalNameDefault</A></H3>
Description: Default attribute of logical name of the file<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="exportedNamesValue0">
<BR><H3><A NAME="getFileExportedNames">getFileExportedNames</A></H3>
Description: List of exported names of the file<B> </B>
<UL>
<LI>Returns: <I>exportedNamesValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="value40">
<BR><H3><A NAME="getFileBuildCommandName">getFileBuildCommandName</A></H3>
Description: Name of the build command of the file<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="value41">
<BR><H3><A NAME="getFileBuildCommandFlags">getFileBuildCommandFlags</A></H3>
Description: Flags of the file build command<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="booleanValue15">
<BR><H3><A NAME="getFileBuildCommandFlagsIsAppend">getFileBuildCommandFlagsIsAppend</A></H3>
Description: Value of append attribute on the flag element<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="booleanValue16">
<BR><H3><A NAME="getFileBuildCommandReplaceDefaultFlags">getFileBuildCommandReplaceDefaultFlags</A></H3>
Description: Indicates whether or not to replace default flags<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="value42">
<BR><H3><A NAME="getFileBuildCommandTargetName">getFileBuildCommandTargetName</A></H3>
Description: Target name of the file build command<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="fileDependencyValue0">
<BR><H3><A NAME="getFileDependencies">getFileDependencies</A></H3>
Description: List of dependent locations for the file, typically directories<B> </B>
<UL>
<LI>Returns: <I>fileDependencyValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="fileDefineID0">
<BR><H3><A NAME="getFileDefineSymbolIDs">getFileDefineSymbolIDs</A></H3>
Description: List of define symbol IDs used in the file<B> </B>
<UL>
<LI>Returns: <I>fileDefineIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="fileImageTypesValue0">
<BR><H3><A NAME="getFileImageTypes">getFileImageTypes</A></H3>
Description: List of image types of the file<B> </B>
<UL>
<LI>Returns: <I>fileImageTypesValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="fileBuilderID1">
<BR><H3><A NAME="getFileSetFileBuilderIDs">getFileSetFileBuilderIDs</A></H3>
Description: List of file builder IDs used for this fileSet<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="fileDependencyValue1">
<BR><H3><A NAME="getFileSetDependencies">getFileSetDependencies</A></H3>
Description: List of dependent locations for the fileSet, typically directories<B> </B>
<UL>
<LI>Returns: <I>fileDependencyValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="functionID0">
<BR><H3><A NAME="getFileSetFunctionIDs">getFileSetFunctionIDs</A></H3>
Description: List of function IDs<B> </B>
<UL>
<LI>Returns: <I>functionIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="booleanValue17">
<BR><H3><A NAME="getFunctionReplicate">getFunctionReplicate</A></H3>
Description: Value of replicate attribute on function element<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="value43">
<BR><H3><A NAME="getFunctionEntryPoint">getFunctionEntryPoint</A></H3>
Description: Entry point of the function<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="fileID1">
<BR><H3><A NAME="getFunctionFileID">getFunctionFileID</A></H3>
Description: File ID containing the function entry point<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="value44">
<BR><H3><A NAME="getFunctionReturnType">getFunctionReturnType</A></H3>
Description: Return type of the function<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="argumentID0">
<BR><H3><A NAME="getFunctionArgumentIDs">getFunctionArgumentIDs</A></H3>
Description: List of argument IDs of the function of the file set<B> </B>
<UL>
<LI>Returns: <I>argumentIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="value45">
<BR><H3><A NAME="getFunctionArgumentDataType">getFunctionArgumentDataType</A></H3>
Description: Data type of the argument<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="booleanValue18">
<BR><H3><A NAME="getFunctionDisabled">getFunctionDisabled</A></H3>
Description: Indicates whether or not the function is disabled<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="functionSourceFileID0">
<BR><H3><A NAME="getFunctionSourceFileIDs">getFunctionSourceFileIDs</A></H3>
Description: List of source file IDs of the function of the file set<B> </B>
<UL>
<LI>Returns: <I>functionSourceFileIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="value46">
<BR><H3><A NAME="getFunctionSourceFileName">getFunctionSourceFileName</A></H3>
Description: Name of the source file<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="value47">
<BR><H3><A NAME="getFunctionSourceFileType">getFunctionSourceFileType</A></H3>
Description: FileType or userFileType of the source file<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="status29">
<BR><H3><A NAME="setFileName">setFileName</A></H3>
Description: Set name of the given file.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>value</I> of type <I>xsd:string</I> -- File name may be not be a relative path.</LI>
</UL>
<A NAME ="status30">
<BR><H3><A NAME="setFileBuildCommandName">setFileBuildCommandName</A></H3>
Description: Set command name for the given file builder.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>value</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="status31">
<BR><H3><A NAME="setFileBuildCommandFlags">setFileBuildCommandFlags</A></H3>
Description: Set command flags for the given file builder.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>value</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="status32">
<BR><H3><A NAME="setFileBuildCommandReplaceDefaultFlags">setFileBuildCommandReplaceDefaultFlags</A></H3>
Description: Set replace default flags for the given file builder.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
</UL>
<A NAME ="status33">
<BR><H3><A NAME="setFileBuildCommandTargetName">setFileBuildCommandTargetName</A></H3>
Description: Set target name for build command for the given file<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>value</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="status34">
<BR><H3><A NAME="setFileBuilderCommand">setFileBuilderCommand</A></H3>
Description: Set command associated with file builder.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>command</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="status35">
<BR><H3><A NAME="setFileBuilderFlags">setFileBuilderFlags</A></H3>
Description: Set flags associated with the given file builder.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>flags</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="status36">
<BR><H3><A NAME="setFileBuilderReplaceDefaultFlags">setFileBuilderReplaceDefaultFlags</A></H3>
Description: Set value of replace default flags in file builder.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>replaceDefaultFlags</I> of type <I>xsd:boolean</I> </LI>
</UL>
<A NAME ="status37">
<BR><H3><A NAME="setFunctionDisabled">setFunctionDisabled</A></H3>
Description: Set disable flag on function.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Generator Operations</H2>
</TD></TR></TABLE>
<A NAME ="value48">
<BR><H3><A NAME="getGeneratorScope">getGeneratorScope</A></H3>
Description: Scope of the generator<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="booleanValue19">
<BR><H3><A NAME="getGeneratorIsHidden">getGeneratorIsHidden</A></H3>
Description: Value of hidden attribute on the generator<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="floatValue1">
<BR><H3><A NAME="getGeneratorPhase">getGeneratorPhase</A></H3>
Description: Phase number of the generator<B> </B>
<UL>
<LI>Returns: <I>floatValue</I> of type <I>xsd:float</I> </LI>
<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>
</UL>
<A NAME ="value49">
<BR><H3><A NAME="getGeneratorApiType">getGeneratorApiType</A></H3>
Description: Api type of the generator<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="value50">
<BR><H3><A NAME="getGeneratorExecutable">getGeneratorExecutable</A></H3>
Description: Executable name associated with the generator <B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="generatorGroupValue0">
<BR><H3><A NAME="getGeneratorGroups">getGeneratorGroups</A></H3>
Description: List of group names of the generator<B> </B>
<UL>
<LI>Returns: <I>generatorGroupValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="transportValue0">
<BR><H3><A NAME="getGeneratorTransportMethods">getGeneratorTransportMethods</A></H3>
Description: List of transport methods of the generator<B> </B>
<UL>
<LI>Returns: <I>transportValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Interface Operations</H2>
</TD></TR></TABLE>
<A NAME ="vlnvValue10">
<BR><H3><A NAME="getInterfaceBusTypeVLNV">getInterfaceBusTypeVLNV</A></H3>
Description: List of VLNV of the bus definition<B> </B>
<UL>
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="vlnvValue11">
<BR><H3><A NAME="getInterfaceAbstractionTypeVLNV">getInterfaceAbstractionTypeVLNV</A></H3>
Description: List of VLNV of the abstraction definition<B> </B>
<UL>
<LI>Returns: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="value51">
<BR><H3><A NAME="getInterfaceMode">getInterfaceMode</A></H3>
Description: Mode of the interface: master, slave, system, mirroredMaster, mirroredSlave, mirroredSystem or monitor<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="interfacePortMapID0">
<BR><H3><A NAME="getInterfacePortMapIDs">getInterfacePortMapIDs</A></H3>
Description: List of interface port map IDs<B> </B>
<UL>
<LI>Returns: <I>interfacePortMapIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="portMapID0">
<BR><H3><A NAME="getLogicalPhysicalMapIDs">getLogicalPhysicalMapIDs</A></H3>
Description: List of the logical and physical port map IDs<B> </B>
<UL>
<LI>Returns: <I>portMapIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="nonNegativeIntegerArrayValue0">
<BR><H3><A NAME="getPortMapRange">getPortMapRange</A></H3>
Description: List of left and right range of the port map<B> </B>
<UL>
<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>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="status38">
<BR><H3><A NAME="setPortMapRange">setPortMapRange</A></H3>
Description: Set left/right range of an interface port map.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>nonNegativeIntegerArrayMessage</I> of type <I>spirit:nonNegativeIntegerArrayType</I> </LI>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Miscellaneous Operations</H2>
</TD></TR></TABLE>
<A NAME ="value52">
<BR><H3><A NAME="getVendorExtensions">getVendorExtensions</A></H3>
Description: Returns the complete XML text of the vendor extension element including the spirit:vendorExtension tag, as a well formed XML document.<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
</UL>
</UL>
<A NAME ="attrValue0">
<BR><H3><A NAME="getVendorAttribute">getVendorAttribute</A></H3>
Description: Get vendor defined attribute from the given element<B> </B>
<UL>
<LI>Returns: <I>attrValue</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
<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>
<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>
<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>
</UL>
<LI>Input: <I>attrName</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="parameterID2">
<BR><H3><A NAME="getParameterIDs">getParameterIDs</A></H3>
Description: List of parameter IDs from the given element (any which contains spirit:parameter elements)<B> </B>
<UL>
<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>
<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>
<UL>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
</UL>
</UL>
<A NAME ="value53">
<BR><H3><A NAME="getValue">getValue</A></H3>
Description: Get the value of a parameterID, fileDefineIDs or argumentIDs.<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
<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>
<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>
<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>
<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>
</UL>
</UL>
<A NAME ="value54">
<BR><H3><A NAME="getValueAttribute">getValueAttribute</A></H3>
Description: Returns the value of the given attribute name on the elementID/value element<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
<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>
</UL>
<LI>Input: <I>attrName</I> of type <I>xsd:string</I> -- This is a namespace qualified attribute</LI>
</UL>
<A NAME ="value55">
<BR><H3><A NAME="getModelParameterDataType">getModelParameterDataType</A></H3>
Description: Data type of the model parameter<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="value56">
<BR><H3><A NAME="getModelParameterUsageType">getModelParameterUsageType</A></H3>
Description: Usage type of the model parameter<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> -- possible values are nontyped and typed</LI>
<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>
</UL>
<A NAME ="id0">
<BR><H3><A NAME="getIdValue">getIdValue</A></H3>
Description: Return the value of the spirit:id attribute on a ID<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>id</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
</UL>
</UL>
<A NAME ="name1">
<BR><H3><A NAME="getName">getName</A></H3>
Description: Return the name of the specified element<B>- Modified in 1.5</B>
<UL>
<LI>Returns: <I>name</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
</UL>
</UL>
<A NAME ="description0">
<BR><H3><A NAME="getDescription">getDescription</A></H3>
Description: Return the description of the specified element<B>- Modified in 1.5</B>
<UL>
<LI>Returns: <I>description</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
</UL>
</UL>
<A NAME ="displayName0">
<BR><H3><A NAME="getDisplayName">getDisplayName</A></H3>
Description: Return the displayName of the specified element<B>- Modified in 1.5</B>
<UL>
<LI>Returns: <I>displayName</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
</UL>
</UL>
<A NAME ="elementID0">
<A NAME ="addressBlockUID0">
<A NAME ="addressSpaceUID0">
<A NAME ="alternateRegisterUID0">
<A NAME ="argumentUID0">
<A NAME ="bankUID0">
<A NAME ="clockDriverUID0">
<A NAME ="executableImageUID0">
<A NAME ="fileBuilderUID0">
<A NAME ="fileDefineUID0">
<A NAME ="fileUID0">
<A NAME ="functionUID0">
<A NAME ="interfaceUID0">
<A NAME ="linkerCommandFileUID0">
<A NAME ="parameterUID0">
<A NAME ="portUID0">
<A NAME ="portMapUID0">
<A NAME ="regFieldUID0">
<A NAME ="registerUID0">
<A NAME ="registerFileUID0">
<A NAME ="segmentUID0">
<A NAME ="singleShotDriverUID0">
<A NAME ="subspaceMapUID0">
<BR><H3><A NAME="getUnconfiguredID">getUnconfiguredID</A></H3>
Description: Return the unconfigured ID from a configured ID<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>elementID</I> of type <I>xsd:string</I> -- Unconfigured ID</LI>
<UL>
<LI>Possible value(s): <I>addressBlockUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>addressSpaceUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>alternateRegisterUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>argumentUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>bankUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>clockDriverUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>executableImageUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>fileBuilderUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>fileDefineUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>fileUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>functionUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>interfaceUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>linkerCommandFileUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>parameterUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>portUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>portMapUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>regFieldUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>registerUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>registerFileUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>segmentUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>singleShotDriverUID</I> of type <I>xsd:string</I></LI>
</UL>
<UL>
<LI>Possible value(s): <I>subspaceMapUID</I> of type <I>xsd:string</I></LI>
</UL>
<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>
<UL>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
</UL>
</UL>
<A NAME ="value57">
<BR><H3><A NAME="getChoiceName">getChoiceName</A></H3>
Description: Name of the choice<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="choiceEnumerationID0">
<BR><H3><A NAME="getChoiceEnumerationIDs">getChoiceEnumerationIDs</A></H3>
Description: List of choice enumeration IDs of the choice<B> </B>
<UL>
<LI>Returns: <I>choiceEnumerationIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="value58">
<BR><H3><A NAME="getChoiceEnumerationValue">getChoiceEnumerationValue</A></H3>
Description: Value of the enumeration element<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="text0">
<BR><H3><A NAME="getChoiceEnumerationText">getChoiceEnumerationText</A></H3>
Description: Value of the enumeration text attribute<B> </B>
<UL>
<LI>Returns: <I>text</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="help0">
<BR><H3><A NAME="getChoiceEnumerationHelp">getChoiceEnumerationHelp</A></H3>
Description: Value of the enumeration help attribute<B> </B>
<UL>
<LI>Returns: <I>help</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="status39">
<BR><H3><A NAME="registerVLNV">registerVLNV</A></H3>
Description: Indicate to DE where the file resides for the IP-XACT element with the given VLNV.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> -- True=VLNV registered, False=VLNV not registered</LI>
<LI>Input: <I>fileName</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>replace</I> of type <I>xsd:boolean</I> -- True=always register, False=do not register if the VLNV already exists</LI>
</UL>
<A NAME ="xmlText2">
<BR><H3><A NAME="getXMLForVLNV">getXMLForVLNV</A></H3>
Description: Return XML of the IP-XACT object identified by the given VLNV.<B> </B>
<UL>
<LI>Returns: <I>xmlText</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>vlnvValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
</UL>
<A NAME ="componentInstanceID3">
<BR><H3><A NAME="getGeneratorContextComponentInstanceID">getGeneratorContextComponentInstanceID</A></H3>
Description: ID for the component instance associated with the currently invoked generator<B> </B>
<UL>
<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>
<LI>Input: <I>generatorName</I> of type <I>xsd:string</I> -- Generator name for use within DE in case of errors</LI>
</UL>
<A NAME ="status40">
<BR><H3><A NAME="init">init</A></H3>
Description: API initialization function. Must be called before any other API call.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<LI>Input: <I>apiVersion</I> of type <I>xsd:string</I> -- Indicates the API version the generator is defined to work with.</LI>
<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>
<LI>Input: <I>message</I> of type <I>xsd:string</I> -- Message which the DE may display to the user.</LI>
</UL>
<A NAME ="status41">
<BR><H3><A NAME="message">message</A></H3>
Description: Send message level and message text to Design Environment.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<LI>Input: <I>severity</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>message</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="message0">
<BR><H3><A NAME="getErrorMessage">getErrorMessage</A></H3>
Description: Get error message from prior callback.<B> </B>
<UL>
<LI>Returns: <I>message</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="count0">
<BR><H3><A NAME="getWarningCount">getWarningCount</A></H3>
Description: Return count of how many potentially incompatible API calls have been made.<B> </B>
<UL>
<LI>Returns: <I>count</I> of type <I>xsd:integer</I> </LI>
<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>
</UL>
<A NAME ="de_status0">
<BR><H3><A NAME="end">end</A></H3>
Description: Terminate connection to the Design Environment.<B> </B>
<UL>
<LI>Returns: <I>de_status</I> of type <I>xsd:integer</I> -- Status indicator from the DE. Non-zero implies an error.</LI>
<LI>Input: <I>gen_status</I> of type <I>xsd:integer</I> -- Status indicator from the generator. Non-zero implies an error.</LI>
<LI>Input: <I>message</I> of type <I>xsd:string</I> -- Message which the DE may display to the user.</LI>
</UL>
<A NAME ="status42">
<BR><H3><A NAME="setVendorExtensions">setVendorExtensions</A></H3>
Description: Set vendor extensions. NOTE: This call is only supported for elements within a spirit:design.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<UL>
<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>
<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>
<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>
</UL>
<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>
</UL>
<A NAME ="status43">
<BR><H3><A NAME="setVendorAttribute">setVendorAttribute</A></H3>
Description: Set vendor defined attribute on the given element<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
<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>
<UL>
<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>
<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>
<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>
<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>
<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>
</UL>
<LI>Input: <I>attrName</I> of type <I>xsd:string</I> </LI>
<LI>Input: <I>attrValue</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="status44">
<BR><H3><A NAME="setValue">setValue</A></H3>
Description: Set the value of a parameterID, fileDefineIDs or argumentIDs.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<UL>
<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>
<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>
<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>
</UL>
<LI>Input: <I>value</I> of type <I>xsd:string</I> </LI>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Port Operations</H2>
</TD></TR></TABLE>
<A NAME ="value59">
<BR><H3><A NAME="getPortStyle">getPortStyle</A></H3>
Description: Returns 'wire' or 'transactional' to indicate the port style<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="booleanValue20">
<BR><H3><A NAME="getAllLogicalDirectionsAllowed">getAllLogicalDirectionsAllowed</A></H3>
Description: Get the value of the allLogicalDirectionAllowed attribute<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="value60">
<BR><H3><A NAME="getPortDirection">getPortDirection</A></H3>
Description: Direction of the port<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="integerArrayValue2">
<BR><H3><A NAME="getPortRange">getPortRange</A></H3>
Description: List of the left and right range of the port<B> </B>
<UL>
<LI>Returns: <I>integerArrayValue</I> of type <I>spirit:integerArrayType</I> -- array of left and right or zero element array if not specified</LI>
<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>
</UL>
<A NAME ="wireTypeDefID0">
<BR><H3><A NAME="getPortWireTypeDefIDs">getPortWireTypeDefIDs</A></H3>
Description: List of typeDefs for a wire portID<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>wireTypeDefIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="transactionalTypeDefID0">
<BR><H3><A NAME="getPortTransactionalTypeDefID">getPortTransactionalTypeDefID</A></H3>
Description: The type definition for a transactional portID<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>transactionalTypeDefID</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="serviceID0">
<BR><H3><A NAME="getPortServiceID">getPortServiceID</A></H3>
Description: ID of element representing the service of a transactional port<B> </B>
<UL>
<LI>Returns: <I>serviceID</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="accessType0">
<BR><H3><A NAME="getPortAccessType">getPortAccessType</A></H3>
Description: Indicates the access type for this port<B>- Modified in 1.5</B>
<UL>
<LI>Returns: <I>accessType</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="accessHandle0">
<BR><H3><A NAME="getPortAccessHandle">getPortAccessHandle</A></H3>
Description: Alternate name to be used when accessing this port<B>- Modified in 1.5</B>
<UL>
<LI>Returns: <I>accessHandle</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="value61">
<BR><H3><A NAME="getPortMaxAllowedConnections">getPortMaxAllowedConnections</A></H3>
Description: Max allowed connections for this transactional port<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="value62">
<BR><H3><A NAME="getPortMinAllowedConnections">getPortMinAllowedConnections</A></H3>
Description: Min allowed connections for this transactional port<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="value63">
<BR><H3><A NAME="getPortDefaultValue">getPortDefaultValue</A></H3>
Description: Default value of the port, if not set returns ""<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="clockDriverID1">
<BR><H3><A NAME="getPortClockDriverID">getPortClockDriverID</A></H3>
Description: Element ID of clock driver element, if present<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="floatValue2">
<BR><H3><A NAME="getClockDriverPeriod">getClockDriverPeriod</A></H3>
Description: Clock period of the given clock<B> </B>
<UL>
<LI>Returns: <I>floatValue</I> of type <I>xsd:float</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="units0">
<BR><H3><A NAME="getClockDriverPeriodUnits">getClockDriverPeriodUnits</A></H3>
Description: Units of the clock period of the given clock<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>units</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="floatValue3">
<BR><H3><A NAME="getClockDriverPulseOffset">getClockDriverPulseOffset</A></H3>
Description: Clock pulse offset of the given clock<B> </B>
<UL>
<LI>Returns: <I>floatValue</I> of type <I>xsd:float</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="units1">
<BR><H3><A NAME="getClockDriverPulseOffsetUnits">getClockDriverPulseOffsetUnits</A></H3>
Description: Units of the clock pulse offset of the given clock<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>units</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="spiritNumberTypeValue3">
<BR><H3><A NAME="getClockDriverPulseValue">getClockDriverPulseValue</A></H3>
Description: Clock pulse value of the given clock<B> </B>
<UL>
<LI>Returns: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="floatValue4">
<BR><H3><A NAME="getClockDriverPulseDuration">getClockDriverPulseDuration</A></H3>
Description: Clock period of the given clock<B> </B>
<UL>
<LI>Returns: <I>floatValue</I> of type <I>xsd:float</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="units2">
<BR><H3><A NAME="getClockDriverPulseDurationUnits">getClockDriverPulseDurationUnits</A></H3>
Description: Units of the clock pulse duration of the given clock<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>units</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="value64">
<BR><H3><A NAME="getClockDriverName">getClockDriverName</A></H3>
Description: Name of the clock driver<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="value65">
<BR><H3><A NAME="getClockDriverSource">getClockDriverSource</A></H3>
Description: Source name of the clock driver<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="singleShotDriverID0">
<BR><H3><A NAME="getPortSingleShotDriverID">getPortSingleShotDriverID</A></H3>
Description: Element ID of single shot driver element, if present<B> </B>
<UL>
<LI>Returns: <I>singleShotDriverID</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="floatValue5">
<BR><H3><A NAME="getPortSingleShotPulseOffset">getPortSingleShotPulseOffset</A></H3>
Description: Clock pulse offset of the port<B> </B>
<UL>
<LI>Returns: <I>floatValue</I> of type <I>xsd:float</I> </LI>
<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>
</UL>
<A NAME ="spiritNumberTypeValue4">
<BR><H3><A NAME="getPortSingleShotPulseValue">getPortSingleShotPulseValue</A></H3>
Description: Clock pulse value of the port<B> </B>
<UL>
<LI>Returns: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
<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>
</UL>
<A NAME ="floatValue6">
<BR><H3><A NAME="getPortSingleShotPulseDuration">getPortSingleShotPulseDuration</A></H3>
Description: Clock period of the port<B> </B>
<UL>
<LI>Returns: <I>floatValue</I> of type <I>xsd:float</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="portConstraintSetID0">
<BR><H3><A NAME="getPortConstraintSetIDs">getPortConstraintSetIDs</A></H3>
Description: List of constraint sets IDs of the port<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="status45">
<BR><H3><A NAME="setPortRange">setPortRange</A></H3>
Description: Set left/right range for the given port.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>integerArrayMessage</I> of type <I>spirit:integerArrayType</I> </LI>
</UL>
<A NAME ="status46">
<BR><H3><A NAME="setPortDefaultValue">setPortDefaultValue</A></H3>
Description: Set default value of the given port.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>value</I> of type <I>xsd:string</I> </LI>
</UL>
<A NAME ="status47">
<BR><H3><A NAME="setClockDriverPeriod">setClockDriverPeriod</A></H3>
Description: Set period of the given clock port.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>floatValue</I> of type <I>xsd:float</I> </LI>
</UL>
<A NAME ="status48">
<BR><H3><A NAME="setClockDriverPulseOffset">setClockDriverPulseOffset</A></H3>
Description: Set pulse offset value of the given clock port.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>floatValue</I> of type <I>xsd:float</I> </LI>
</UL>
<A NAME ="status49">
<BR><H3><A NAME="setClockDriverPulseValue">setClockDriverPulseValue</A></H3>
Description: Set pulse value of the given clock port.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
</UL>
<A NAME ="status50">
<BR><H3><A NAME="setClockDriverPulseDuration">setClockDriverPulseDuration</A></H3>
Description: Set pulse duration of the given clock port.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>floatValue</I> of type <I>xsd:float</I> </LI>
</UL>
<A NAME ="status51">
<BR><H3><A NAME="setPortSingleShotPulseOffset">setPortSingleShotPulseOffset</A></H3>
Description: Set pulse offset of given single shot port.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>floatValue</I> of type <I>xsd:float</I> </LI>
</UL>
<A NAME ="status52">
<BR><H3><A NAME="setPortSingleShotPulseValue">setPortSingleShotPulseValue</A></H3>
Description: Set pulse value of given single shot port.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
</UL>
<A NAME ="status53">
<BR><H3><A NAME="setPortSingleShotPulseDuration">setPortSingleShotPulseDuration</A></H3>
Description: Set pulse duration of given single shot port.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>floatValue</I> of type <I>xsd:float</I> </LI>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Register File Operations</H2>
</TD></TR></TABLE>
<A NAME ="dimensions0">
<BR><H3><A NAME="getRegisterFileDimensions">getRegisterFileDimensions</A></H3>
Description: Dimensions of a register file array.<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>dimensions</I> of type <I>spirit:nonNegativeIntegerArrayType</I> </LI>
<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>
</UL>
<A NAME ="offset0">
<BR><H3><A NAME="getRegisterFileAddressOffset">getRegisterFileAddressOffset</A></H3>
Description: The offset from the base address.<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>offset</I> of type <I>spirit:spiritNumberType</I> </LI>
<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>
</UL>
<A NAME ="range3">
<BR><H3><A NAME="getRegisterFileRange">getRegisterFileRange</A></H3>
Description: The register file range in number of addressable units.<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>range</I> of type <I>xsd:positiveInteger</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="status54">
<BR><H3><A NAME="setRegisterFileRange">setRegisterFileRange</A></H3>
Description: Set the register file range in addressable units.<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>range</I> of type <I>xsd:positiveInteger</I> </LI>
</UL>
<A NAME ="registerID1">
<BR><H3><A NAME="getRegisterFileRegisterIDs">getRegisterFileRegisterIDs</A></H3>
Description: List of IDs for the registers of the given register file<B>- New in 1.5</B>
<UL>
<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>
<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>
</UL>
<A NAME ="registerFileID1">
<BR><H3><A NAME="getRegisterFileRegisterFileIDs">getRegisterFileRegisterFileIDs</A></H3>
Description: List of IDs for the register files of the given register file<B>- New in 1.5</B>
<UL>
<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>
<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>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Register Operations</H2>
</TD></TR></TABLE>
<A NAME ="dimensions1">
<BR><H3><A NAME="getRegisterDimensions">getRegisterDimensions</A></H3>
Description: Dimensions of a register array.<B> </B>
<UL>
<LI>Returns: <I>dimensions</I> of type <I>spirit:nonNegativeIntegerArrayType</I> </LI>
<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>
</UL>
<A NAME ="offset1">
<BR><H3><A NAME="getRegisterAddressOffset">getRegisterAddressOffset</A></H3>
Description: The offset from the base address.<B> </B>
<UL>
<LI>Returns: <I>offset</I> of type <I>spirit:spiritNumberType</I> </LI>
<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>
</UL>
<A NAME ="alternateRegisterID0">
<BR><H3><A NAME="getRegisterAlternateRegisterIDs">getRegisterAlternateRegisterIDs</A></H3>
Description: List of IDs for the alternate registers of the given register<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>alternateRegisterIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="value66">
<BR><H3><A NAME="getRegisterAccess">getRegisterAccess</A></H3>
Description: The accessibility of the data in the register<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="size0">
<BR><H3><A NAME="getRegisterSize">getRegisterSize</A></H3>
Description: The register size in bits.<B> </B>
<UL>
<LI>Returns: <I>size</I> of type <I>xsd:positiveInteger</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="status55">
<BR><H3><A NAME="setRegisterSize">setRegisterSize</A></H3>
Description: Set the register size in bits.<B> </B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:boolean</I> </LI>
<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>
<LI>Input: <I>size</I> of type <I>xsd:positiveInteger</I> </LI>
</UL>
<A NAME ="value67">
<BR><H3><A NAME="getRegisterVolatility">getRegisterVolatility</A></H3>
Description: Indicates whether or not the data is volatile.<B>- Modified in 1.5</B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> -- returns "true", "false" or "".</LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="value68">
<BR><H3><A NAME="getRegisterResetValue">getRegisterResetValue</A></H3>
Description: Register value at reset.<B>- Modified in 1.5</B>
<UL>
<LI>Returns: <I>value</I> of type <I>spirit:spiritNumberType</I> </LI>
<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>
<UL>
<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>
<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>
<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>
<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>
</UL>
</UL>
<A NAME ="status56">
<BR><H3><A NAME="setRegisterResetValue">setRegisterResetValue</A></H3>
Description: Set register value at reset.<B>- Modified in 1.5</B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
<LI>Input: <I>value</I> of type <I>spirit:spiritNumberType</I> </LI>
</UL>
<A NAME ="mask0">
<BR><H3><A NAME="getRegisterResetMask">getRegisterResetMask</A></H3>
Description: Mask to be ANDed with the value before comparing to reset value.<B>- Modified in 1.5</B>
<UL>
<LI>Returns: <I>mask</I> of type <I>spirit:spiritNumberType</I> </LI>
<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>
<UL>
<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>
<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>
<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>
<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>
</UL>
</UL>
<A NAME ="status57">
<BR><H3><A NAME="setRegisterResetMask">setRegisterResetMask</A></H3>
Description: Set the mask to be ANDed with the value before comparing to reset value.<B>- Modified in 1.5</B>
<UL>
<LI>Returns: <I>status</I> of type <I>xsd:integer</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
<LI>Input: <I>mask</I> of type <I>spirit:spiritNumberType</I> </LI>
</UL>
<A NAME ="regFieldID0">
<BR><H3><A NAME="getRegisterFieldIDs">getRegisterFieldIDs</A></H3>
Description: List of IDs for the fields of the given register<B>- Modified in 1.5</B>
<UL>
<LI>Returns: <I>regFieldIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
<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>
</UL>
<A NAME ="groupNames1">
<BR><H3><A NAME="getRegisterAlternateGroups">getRegisterAlternateGroups</A></H3>
Description: Indicates the group names for an alternate register.<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>groupNames</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Remap Operations</H2>
</TD></TR></TABLE>
<A NAME ="remapStatePortID0">
<BR><H3><A NAME="getRemapStatePortIDs">getRemapStatePortIDs</A></H3>
Description: List of remap port IDs of a remap state<B> </B>
<UL>
<LI>Returns: <I>remapStatePortIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="portID2">
<BR><H3><A NAME="getRemapStatePortPortID">getRemapStatePortPortID</A></H3>
Description: Port ID for the remap state<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="value69">
<BR><H3><A NAME="getRemapStatePortPortIndex">getRemapStatePortPortIndex</A></H3>
Description: Index of the port if a vector for the remap state<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="spiritNumberTypeValue5">
<BR><H3><A NAME="getRemapStatePortPortValue">getRemapStatePortPortValue</A></H3>
Description: Value of the port for the remap state<B> </B>
<UL>
<LI>Returns: <I>spiritNumberTypeValue</I> of type <I>spirit:spiritNumberType</I> </LI>
<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>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Service Operations</H2>
</TD></TR></TABLE>
<A NAME ="initiative0">
<BR><H3><A NAME="getAbstractionDefServiceInitiative">getAbstractionDefServiceInitiative</A></H3>
Description: Port service initiative from the abstraction definition<B> </B>
<UL>
<LI>Returns: <I>initiative</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="typeDefID0">
<FONT color=#ff0000><BR><H3><A NAME="getAbstractionDefServiceIDs">getAbstractionDefServiceIDs</A></H3></FONT>
Description: List of typeDefs for an abstractionServiceID<B>- Invalid in 1.5</B>
<UL>
<LI>Returns: <I>typeDefIDs</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="abstractionServiceTypeDefID0">
<BR><H3><A NAME="getAbstractionDefAbstractionServiceTypeDefIDs">getAbstractionDefAbstractionServiceTypeDefIDs</A></H3>
Description: List of type definitions for an abstractionServiceID<B>- New in 1.5</B>
<UL>
<LI>Returns: <I>abstractionServiceTypeDefIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="initiative1">
<BR><H3><A NAME="getServiceInitiative">getServiceInitiative</A></H3>
Description: Initiative of the service<B> </B>
<UL>
<LI>Returns: <I>initiative</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="serviceTypeDefID0">
<BR><H3><A NAME="getServiceTypeDefIDs">getServiceTypeDefIDs</A></H3>
Description: List of typeDefs for a serviceID<B>- Modified in 1.5</B>
<UL>
<LI>Returns: <I>serviceTypeDefIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>TypeDef Operations</H2>
</TD></TR></TABLE>
<A NAME ="value70">
<BR><H3><A NAME="getTypeDefTypeName">getTypeDefTypeName</A></H3>
Description: Name of the type<B>- Modified in 1.5</B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
<UL>
<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>
<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>
<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>
<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>
</UL>
</UL>
<A NAME ="booleanValue21">
<BR><H3><A NAME="getTypeDefConstrained">getTypeDefConstrained</A></H3>
Description: Is the type name constrained<B>- Modified in 1.5</B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
<UL>
<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>
<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>
<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>
</UL>
</UL>
<A NAME ="booleanValue22">
<BR><H3><A NAME="getTypeDefImplicit">getTypeDefImplicit</A></H3>
Description: Is the type name implicit<B>- Modified in 1.5</B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
<UL>
<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>
<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>
</UL>
</UL>
<A NAME ="typeDefinitions0">
<BR><H3><A NAME="getTypeDefTypeDefinitions">getTypeDefTypeDefinitions</A></H3>
Description: List of type definition for the given type<B>- Modified in 1.5</B>
<UL>
<LI>Returns: <I>typeDefinitions</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
<UL>
<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>
<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>
<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>
</UL>
</UL>
<A NAME ="viewID2">
<BR><H3><A NAME="getTypeDefTypeViewIDs">getTypeDefTypeViewIDs</A></H3>
Description: List of type viewIDs for the given type<B>- Modified in 1.5</B>
<UL>
<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>
<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>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>View Operations</H2>
</TD></TR></TABLE>
<A NAME ="designID1">
<BR><H3><A NAME="getViewDesignID">getViewDesignID</A></H3>
Description: ID of the design associated with a hierarchical view<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="envIdentifiersValue0">
<BR><H3><A NAME="getViewEnvIdentifiers">getViewEnvIdentifiers</A></H3>
Description: List of environment identifiers of the view<B> </B>
<UL>
<LI>Returns: <I>envIdentifiersValue</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="value71">
<BR><H3><A NAME="getViewLanguage">getViewLanguage</A></H3>
Description: View Language<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="booleanValue23">
<BR><H3><A NAME="getViewLanguageIsStrict">getViewLanguageIsStrict</A></H3>
Description: Value of 'strict' attribute on view language element<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="modelName0">
<BR><H3><A NAME="getViewModelName">getViewModelName</A></H3>
Description: Get the model name for this view<B> </B>
<UL>
<LI>Returns: <I>modelName</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="fileBuilderID2">
<BR><H3><A NAME="getViewDefaultFileBuilderIDs">getViewDefaultFileBuilderIDs</A></H3>
Description: List of default file builder IDs of the view<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="fileSetID4">
<BR><H3><A NAME="getViewFileSetIDs">getViewFileSetIDs</A></H3>
Description: List of fileSet IDs for fileSets referenced by the view<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="portConstraintSetID1">
<BR><H3><A NAME="getViewPortConstraintSetIDs">getViewPortConstraintSetIDs</A></H3>
Description: Constraint set ID for the port referenced by the view<B>- Modified in 1.5</B>
<UL>
<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>
<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>
<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>
</UL>
<A NAME ="whiteboxRefID0">
<BR><H3><A NAME="getViewWhiteboxElementRefIDs">getViewWhiteboxElementRefIDs</A></H3>
Description: List of whitebox element reference IDs of the view<B> </B>
<UL>
<LI>Returns: <I>whiteboxRefIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<P>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2>Whitebox Operations</H2>
</TD></TR></TABLE>
<A NAME ="whiteboxElementID1">
<BR><H3><A NAME="getWhiteboxElementRefID">getWhiteboxElementRefID</A></H3>
Description: White box element reference ID<B> </B>
<UL>
<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>
<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>
</UL>
<A NAME ="whiteboxRefPathID0">
<BR><H3><A NAME="getWhiteboxRefPathIDs">getWhiteboxRefPathIDs</A></H3>
Description: List of path IDs of the white box element reference<B> </B>
<UL>
<LI>Returns: <I>whiteboxRefPathIDs</I> of type <I>spirit:soapStringArrayType</I> </LI>
<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>
</UL>
<A NAME ="value72">
<BR><H3><A NAME="getWhiteboxRefPathName">getWhiteboxRefPathName</A></H3>
Description: Name of the whitebox reference path element<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="nonNegativeIntegerArrayValue1">
<BR><H3><A NAME="getWhiteboxRefPathRange">getWhiteboxRefPathRange</A></H3>
Description: List of left and right range of the whitebox reference path element<B> </B>
<UL>
<LI>Returns: <I>nonNegativeIntegerArrayValue</I> of type <I>spirit:nonNegativeIntegerArrayType</I> </LI>
<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>
</UL>
<A NAME ="value73">
<BR><H3><A NAME="getWhiteboxElementType">getWhiteboxElementType</A></H3>
Description: Type of the whitebox element<B> </B>
<UL>
<LI>Returns: <I>value</I> of type <I>xsd:string</I> </LI>
<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>
</UL>
<A NAME ="booleanValue24">
<BR><H3><A NAME="getWhiteboxElementDrivable">getWhiteboxElementDrivable</A></H3>
Description: Indicates whether or not the whitebox element is drivable<B> </B>
<UL>
<LI>Returns: <I>booleanValue</I> of type <I>xsd:boolean</I> </LI>
<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>
</UL>
<A NAME ="registerID2">
<FONT color=#ff0000><BR><H3><A NAME="getWhiteboxElementRegisterID">getWhiteboxElementRegisterID</A></H3></FONT>
Description: Register reference ID of the whitebox element<B>- Invalid in 1.5</B>
<UL>
<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>
<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>
</UL>
<A NAME ="registerID3">
<BR><H3><A NAME="getWhiteboxElementRegisterIDs">getWhiteboxElementRegisterIDs</A></H3>
Description: Register reference IDs of the whitebox element<B>- New in 1.5</B>
<UL>
<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>
<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>
</UL>
<table width="100%"><TR><TD bgcolor=#b8b8ff>
<BR><H2><A NAME="elementID0">All ID Types</A></H2>
</TD></TR></TABLE>
<P>
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.
<P><TABLE BORDER=1>
<TR>
<TD><A HREF="#abstractionDefID0">abstractionDefID</A></TD>
<TD><A HREF="#abstractionDefPortID0">abstractionDefPortID</A></TD>
<TD><A HREF="#abstractionDefPortModeConstraintID0">abstractionDefPortModeConstraintID</A></TD>
<TD><A HREF="#abstractionDefPortModeID0">abstractionDefPortModeID</A></TD>
</TR><TR>
<TD><A HREF="#abstractionServiceID0">abstractionServiceID</A></TD>
<TD><A HREF="#abstractionServiceTypeDefID0">abstractionServiceTypeDefID</A></TD>
<TD><A HREF="#abstractorID0">abstractorID</A></TD>
<TD><A HREF="#abstractorInstanceID0">abstractorInstanceID</A></TD>
</TR><TR>
<TD><A HREF="#adHocConnectionID0">adHocConnectionID</A></TD>
<TD><A HREF="#adHocExternalPortReferenceID0">adHocExternalPortReferenceID</A></TD>
<TD><A HREF="#adHocInternalPortReferenceID0">adHocInternalPortReferenceID</A></TD>
<TD><A HREF="#addressBlockID0">addressBlockID</A></TD>
</TR><TR>
<TD><A HREF="#addressBlockUID0">addressBlockUID</A></TD>
<TD><A HREF="#addressSpaceID0">addressSpaceID</A></TD>
<TD><A HREF="#addressSpaceUID0">addressSpaceUID</A></TD>
<TD><A HREF="#alternateRegisterID0">alternateRegisterID</A></TD>
</TR><TR>
<TD><A HREF="#alternateRegisterUID0">alternateRegisterUID</A></TD>
<TD><A HREF="#argumentID0">argumentID</A></TD>
<TD><A HREF="#argumentUID0">argumentUID</A></TD>
<TD><A HREF="#bankID0">bankID</A></TD>
</TR><TR>
<TD><A HREF="#bankUID0">bankUID</A></TD>
<TD><A HREF="#bridgeID0">bridgeID</A></TD>
<TD><A HREF="#busdefID0">busdefID</A></TD>
<TD><A HREF="#channelID0">channelID</A></TD>
</TR><TR>
<TD><A HREF="#choiceEnumerationID0">choiceEnumerationID</A></TD>
<TD><A HREF="#choiceID0">choiceID</A></TD>
<TD><A HREF="#clockDriverID0">clockDriverID</A></TD>
<TD><A HREF="#clockDriverUID0">clockDriverUID</A></TD>
</TR><TR>
<TD><A HREF="#componentID0">componentID</A></TD>
<TD><A HREF="#componentInstanceID0">componentInstanceID</A></TD>
<TD><A HREF="#cpuID0">cpuID</A></TD>
<TD><A HREF="#designID0">designID</A></TD>
</TR><TR>
<TD><A HREF="#driveConstraintID0">driveConstraintID</A></TD>
<TD><A HREF="#elementID0">elementID</A></TD>
<TD><A HREF="#executableImageID0">executableImageID</A></TD>
<TD><A HREF="#executableImageUID0">executableImageUID</A></TD>
</TR><TR>
<TD><A HREF="#fileBuilderID0">fileBuilderID</A></TD>
<TD><A HREF="#fileBuilderUID0">fileBuilderUID</A></TD>
<TD><A HREF="#fileDefineID0">fileDefineID</A></TD>
<TD><A HREF="#fileDefineUID0">fileDefineUID</A></TD>
</TR><TR>
<TD><A HREF="#fileID0">fileID</A></TD>
<TD><A HREF="#fileSetGroupID0">fileSetGroupID</A></TD>
<TD><A HREF="#fileSetID0">fileSetID</A></TD>
<TD><A HREF="#fileUID0">fileUID</A></TD>
</TR><TR>
<TD><A HREF="#functionID0">functionID</A></TD>
<TD><A HREF="#functionSourceFileID0">functionSourceFileID</A></TD>
<TD><A HREF="#functionUID0">functionUID</A></TD>
<TD><A HREF="#generatorID0">generatorID</A></TD>
</TR><TR>
<TD><A HREF="#hierConnectionID0">hierConnectionID</A></TD>
<TD><A HREF="#interconnectionID0">interconnectionID</A></TD>
<TD><A HREF="#interfaceID0">interfaceID</A></TD>
<TD><A HREF="#interfacePortMapID0">interfacePortMapID</A></TD>
</TR><TR>
<TD><A HREF="#interfaceUID0">interfaceUID</A></TD>
<TD><A HREF="#linkerCommandFileID0">linkerCommandFileID</A></TD>
<TD><A HREF="#linkerCommandFileUID0">linkerCommandFileUID</A></TD>
<TD><A HREF="#loadConstraintID0">loadConstraintID</A></TD>
</TR><TR>
<TD><A HREF="#localMemoryMapID0">localMemoryMapID</A></TD>
<TD><A HREF="#memoryMapElementID0">memoryMapElementID</A></TD>
<TD><A HREF="#memoryMapID0">memoryMapID</A></TD>
<TD><A HREF="#memoryRemapID0">memoryRemapID</A></TD>
</TR><TR>
<TD><A HREF="#monitorInterconnectionID0">monitorInterconnectionID</A></TD>
<TD><A HREF="#parameterID0">parameterID</A></TD>
<TD><A HREF="#parameterUID0">parameterUID</A></TD>
<TD><A HREF="#portConstraintSetID0">portConstraintSetID</A></TD>
</TR><TR>
<TD><A HREF="#portID0">portID</A></TD>
<TD><A HREF="#portMapID0">portMapID</A></TD>
<TD><A HREF="#portMapUID0">portMapUID</A></TD>
<TD><A HREF="#portUID0">portUID</A></TD>
</TR><TR>
<TD><A HREF="#regFieldID0">regFieldID</A></TD>
<TD><A HREF="#regFieldUID0">regFieldUID</A></TD>
<TD><A HREF="#regFieldValueID0">regFieldValueID</A></TD>
<TD><A HREF="#registerFileID0">registerFileID</A></TD>
</TR><TR>
<TD><A HREF="#registerFileUID0">registerFileUID</A></TD>
<TD><A HREF="#registerID0">registerID</A></TD>
<TD><A HREF="#registerUID0">registerUID</A></TD>
<TD><A HREF="#remapAddressID0">remapAddressID</A></TD>
</TR><TR>
<TD><A HREF="#remapStateID0">remapStateID</A></TD>
<TD><A HREF="#remapStatePortID0">remapStatePortID</A></TD>
<TD><A HREF="#segmentID0">segmentID</A></TD>
<TD><A HREF="#segmentUID0">segmentUID</A></TD>
</TR><TR>
<TD><A HREF="#serviceID0">serviceID</A></TD>
<TD><A HREF="#serviceTypeDefID0">serviceTypeDefID</A></TD>
<TD><A HREF="#singleShotDriverID0">singleShotDriverID</A></TD>
<TD><A HREF="#singleShotDriverUID0">singleShotDriverUID</A></TD>
</TR><TR>
<TD><A HREF="#subspaceMapID0">subspaceMapID</A></TD>
<TD><A HREF="#subspaceMapUID0">subspaceMapUID</A></TD>
<TD><A HREF="#timingConstraintID0">timingConstraintID</A></TD>
<TD><A HREF="#transactionalTypeDefID0">transactionalTypeDefID</A></TD>
</TR><TR>
<TD><A HREF="#typeDefID0">typeDefID</A></TD>
<TD><A HREF="#viewID0">viewID</A></TD>
<TD><A HREF="#whiteboxElementID0">whiteboxElementID</A></TD>
<TD><A HREF="#whiteboxRefID0">whiteboxRefID</A></TD>
</TR><TR>
<TD><A HREF="#whiteboxRefPathID0">whiteboxRefPathID</A></TD>
<TD><A HREF="#wireTypeDefID0">wireTypeDefID</A></TD>
</TR></TABLE>
<P>
<small>
Copyright (c) 2009 The SPIRIT Consortium. All rights reserved.
www.spiritconsortium.org
<P>
THIS WORK CONTAINS TRADE SECRETS AND PROPRIETARY
INFORMATION WHICH IS THE PROPERTY OF ANY OF THE CONTRIBUTING
MEMBERS OF THE SPIRIT CONSORTIUM, AND MAY BE LICENSED TO
OTHER MEMBERS OF THE SPIRIT CONSORTIUM SUBJECT TO THE
TERMS AND CONDITIONS OF THE IP POLICY, WHICH IP POLICY FORMS
PART OF THE SPIRIT CONSORTIUM AGREEMENT AND THE SPIRIT
MEMBERSHIP AGREEMENTS
</small>
</BODY></HTML>