get ID of the current or top design The ID of the current design or the top design if the 'top' argument is true. Vendor Library Name Version of the design components instances IDs of the given design return the component instance ID of the named component instance in the given design List of interconnection element IDs Returns the active interfaces as a list: componentRef interfaceRef componentRef interfaceRef 1.5 List of abstractor instances IDs for this interconnection List of monitorInterconnection element IDs 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. 1.5 List of ad-hoc connection element IDs Get the tied value for an ad-hoc connection List of internal ad-hoc port reference element IDs List for an internal connection containing the componentRef, portRef, left, and right attribute values List of external ad-hoc port reference element IDs List for an external connection containing the portRef, left, and right attribute values List of hierarchical connection element IDs List containing the interface name, component reference, and interface reference Instance name of the component Vendor Library Name Version of the component (from the design file) ID for the component associated with given instance (crossing from design to component file) Return the component XML in text format. Schema version is DE dependent. Instance name of the abstractor Vendor Library Name Version of the abstractor (from the design file) ID for the abstractor associated with given instance (crossing from design configuration to abstractor file) Return the abstractor XML in text format. Schema version is DE dependent. List of VLNV of the bus definition List of VLNV of the abstraction definition Mode of the interface: master, slave, system, mirroredMaster, mirroredSlave, mirroredSystem or monitor list of interface port map IDs list of the logical and physical port map IDs list of left and right range of the port map The return array value is in the format of logical vector left, right, physical vector left, right ID of the master addressSpace Base address of the master addressSpace ID of the memoryMap referenced from a slave interface List of slave bridge IDs The slave interface master interface reference ID Value of the opaque attribute List of fileSetGroup IDs Name of file set group list of file set IDs in this file set group Group name of a system, mirroredSystem, or monitor bus interface List of remap address IDs of the mirrored slave interface remap address of the given remap address element remap state ID of the given remap address element The address range of the mirrored slave interface Indicates the mode of interface being monitored, slave, master, system, mirrorslave, mirrormaster or mirrorslave connection required for this bus interface Bit steering description of the bus interface: on or off the endianess of the bus interface, big or little. The default is little. the number bits in the least addressable unit. If none exists, the default 8 bits is returned. get the mode that the abstractor can be master, slave, direct or system. List of VLNV of the bus definition List of 2 interface IDs a list of model view IDs If true returns only the view configured by a designConfiguration. If false returns all views. 1.5 a list of abstractor model port IDs a list of model parameter IDs Restrict returned parameters to those that match the given usageType. nontyped or typed or all if not specified. list of generator IDs of the abstractor list of choices IDs list of file set IDs Vendor Library Name Version of the component (from the component file) 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). list of busInterface IDs in this channel list of IDs for the logical address spaces in the component. a list of remap state IDs a list of model view IDs If true returns only the view configured by a designConfiguration or NULL if not configured. If false returns all views. List of interface IDs a list of channel IDs a list of component model port IDs a list of model parameter IDs Restrict returned parameters to those that match the given usageType. nontyped or typed or userdefined or all if not specified. list of generator IDs of the component list of choices IDs list of file set IDs list of whitebox element IDs of the component list of cpu IDs of the component list of address space reference IDs of the cpu list of clock driver IDs of the component dimensions of a register file array. 1.5 the offset from the base address. 1.5 the register file range in number of addressable units. 1.5 set the register file range in addressable units. 1.5 list of IDs for the registers of the given register file 1.5 list of IDs for the register files of the given register file 1.5 dimensions of a register array. the offset from the base address. list of IDs for the alternate registers of the given register 1.5 the accessibility of the data in the register the register size in bits. set the register size in bits. indicates whether or not the data is volatile. returns "true", "false" or "". 1.5 register value at reset. 1.5 set register value at reset. 1.5 mask to be ANDed with the value before comparing to reset value. 1.5 set the mask to be ANDed with the value before comparing to reset value. 1.5 list of IDs for the fields of the given register 1.5 indicates the group names for an alternate register. 1.5 bit offset of the fields LSB inside the register. width of the field in bits. set the width of the field in bits. indicates whether or not the data is volatile. The presumed value is 'false' if the element is not present. returns "true" or "false" 1.5 the accessibility of the data in the field. list of IDs for field values for the given register field. enumerated bit field usage. 1.5 enumerated bit field value. Enumerated name for this register field value. Deprecated - use getName. The modified write value for the field one of "", "onetoClear", "oneToSet", "oneToToggle", "zeroToClear", "zeroToSet","zeroToToggle", "clear", "set" or "modified" 1.5 the write value constraint is write as read. 1.5 the write value constraint shall use the enumerated values. 1.5 the value of a write constraint. array of minimum and maximum or zero element array if not specified 1.5 The read action for the field one of "", "clear", "set" or "modify" 1.5 true if the field can be tested with a simple register test. 1.5 the test constraint required if the field can be tested with a simple register test. 1.5 list of remap port IDs of a remap state port ID for the remap state index of the port if a vector for the remap state value of the port for the remap state the address range of an address block expressed as the number of accessable and addressable units. the bit width of an address block. the ID for the local memory map of the address space. 1.5 list of IDs for address block segments for the address space. 1.5 the address offset of an address space segment in an address space 1.5 set the address offset of an address space segment expressed in the number addressable units. 1.5 the address range of an address space segment expressed as the number of accessable addressable units. 1.5 set the address range of an address space segment expressed as the number of accessable addressable units. 1.5 the number bits in an addressable unit. If none exists, the default 8 bits is returned. the IDs of the executable images belonging to the specified address space. the type of the executable image if existent. the linker command for the current executable image. the flags of the current executable image linker command. element ID of linkerCommandFile associated with given executable image. list of default file builder IDs of the executable image the group of file set reference IDs complying with the tool set of the current executable image. the name of the linker command file. the command line switch to specify with the linker command file. indicates whether or not to generate and enable the linker command file. reference IDs to the generator elements for generating the linker command file. List of element IDs (addressBlockID, bankID, subspaceMapID) within a memory map, memory remap, local memory map, or bank 1.5 Indicates type of memory map element: addressBlock, bank or subspaceMap The return value is one of "addressBlock", "bank", "subspaceMap" or "" for unknown the number bits in an addressable unit for a memory map. If none exists, the default 8 bits is returned. the base address of an address block the address range of an address block expressed as the number of accessable and addressable units. the bit width of an address block in the local memory map. indicates the usage of this address block. one of "memory", "register", "reserved" or "" if not set. indicates whether or not the data is volatile. returns "true", "false" or "". the accessibility of the data in the local address block. the IDs of the available registers in the address block. the IDs of the available register files in the address block. 1.5 indicates the type identifier of an addressBlock, registerFile, register or field. 1.5 the bank alignment value, serial or parallel the base address of an address bank indicates the usage of this address bank. indicates whether or not the data is volatile. returns "true", "false" or "". the accessibility of the data in the local address bank. master bus interface ID on the other side of a bus bridge . address space segment ID on the other side of a bus bridge . 1.5 the base address of a memory subspace List of IDs for memory map elements in the given component List of IDs for memory map 'remap' elements of the given memory map Remap State ID for which this remap is applicable ID of the design associated with a hierarchical view list of environment identifiers of the view view Language value of 'strict' attribute on view language element get the model name for this view list of default file builder IDs of the view list of fileSet IDs for fileSets referenced by the view constraint set ID for the port referenced by the view 1.5 list of whitebox element reference IDs of the view Returns 'wire' or 'transactional' to indicate the port style get the value of the allLogicalDirectionAllowed attribute 1.5 direction of the port list of the left and right range of the port array of left and right or zero element array if not specified list of typeDefs for a wire portID 1.5 the type definition for a transactional portID 1.5 ID of element representing the service of a transactional port indicates the access type for this port 1.5 Alternate name to be used when accessing this port 1.5 max allowed connections for this transactional port min allowed connections for this transactional port default value of the port, if not set returns "" element ID of clock driver element, if present clock period of the given clock units of the clock period of the given clock 1.5 clock pulse offset of the given clock units of the clock pulse offset of the given clock 1.5 clock pulse value of the given clock clock period of the given clock units of the clock pulse duration of the given clock 1.5 name of the clock driver source name of the clock driver element ID of single shot driver element, if present clock pulse offset of the port clock pulse value of the port clock period of the port list of constraint sets IDs of the port name of the type 1.5 is the type name constrained 1.5 is the type name implicit 1.5 list of type definition for the given type 1.5 list of type viewIDs for the given type 1.5 port service initiative from the abstraction definition list of typeDefs for an abstractionServiceID 1.5 list of type definitions for an abstractionServiceID 1.5 initiative of the service list of typeDefs for a serviceID 1.5 reference name of the given port constraint set list of the left and right range of a port referenced by this constraint set list of drive constraint IDs of the port list of load constraint IDs of the port list of timing constraint IDs of the port indicates the type of drive constraint: function class Returns the drive constraint. Format depends on the constraint type. indicates the type of load constraint: function class Returns the load constraint. Format is cell function and strength or cell class and strength. Returns the load constraint count, the number of loads. indicates the clock name, clock edge, and delay type Returns the timing constraint value (cycle time percentage). Get name of the given fileID. True=DE shall return an absolute file path, False=actual XML text returned fileType or userFileType of the file builder command of the file builder flags of the file builder value of the replaceDefaultFlags element of the file builder list of group names of the file set list of file IDs of the file set fileType or userFileType of the file indicates that the given file is an include file indicates that the file includes external declarations required by the top-level netlist file logical name of the file default attribute of logical name of the file list of exported names of the file name of the build command of the file flags of the file build command value of append attribute on the flag element indicates whether or not to replace default flags target name of the file build command list of dependent locations for the file, typically directories list of define symbol IDs used in the file list of image types of the file list of file builder IDs used for this fileSet list of dependent locations for the fileSet, typically directories list of function IDs value of replicate attribute on function element entry point of the function file ID containing the function entry point return type of the function list of argument IDs of the function of the file set data type of the argument indicates whether or not the function is disabled list of source file IDs of the function of the file set name of the source file fileType or userFileType of the source file white box element reference ID list of path IDs of the white box element reference Name of the whitebox reference path element list of left and right range of the whitebox reference path element type of the whitebox element indicates whether or not the whitebox element is drivable register reference ID of the whitebox element 1.5 register reference IDs of the whitebox element 1.5 scope of the generator value of hidden attribute on the generator phase number of the generator api type of the generator executable name associated with the generator List of group names of the generator list of transport methods of the generator ID for the bus definition with the given VLNV Vendor Library Name Version of the bus definition indicates whether or not the bus definition supports direct connections indicates whether or not the bus definition is an addressable bus Vendor Library Name Version of the bus definition being extended maximum # of masters supported by this bus definition -1 indicates unbounded maximum # of slaves supported by this bus definition -1 indicates unbounded list of system group names for this bus definition ID for the abstraction definition with the given VLNV Vendor Library Name Version of the abstraction definition get VLNV of the bus definition Vendor Library Name Version of the abstraction definition being extended 1.5 List of abstraction definition port element IDs logical name of this abstraction definition port does this port require a driver required driver type for this port Returns 'wire' or 'transactional' to indicate the port style is this port an address port is this port a data port is this port a clock port is this port a reset port Returns an ID for accessing the given port in the given interface mode modeValue should be one of master, slave or system 1.5 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. modeValue should be one of master, slave or system 1.5 group name when present on a system interface bit width constraint when present on an interface of the given type a return value of 0 indicates unbounded port direction constraint when present on an interface of the given type list of constraint IDs for a non-mirrored port list of constraint IDs for a mirrored port list of drive constraint IDs of the port list of load constraint IDs of the port list of timing constraint IDs of the port default value for port when not connected existence requirement for this port on an interface of the given type abstractionDef service IDs on a transactional port 1.5 abstractionDef service ID on a transactional port 1.5 Returns the complete XML text of the vendor extension element including the spirit:vendorExtension tag, as a well formed XML document. get vendor defined attribute from the given element list of parameter IDs from the given element (any which contains spirit:parameter elements) Get the value of a parameterID, fileDefineIDs or argumentIDs. Returns the value of the given attribute name on the elementID/value element This is a namespace qualified attribute data type of the model parameter usage type of the model parameter possible values are nontyped and typed Return the value of the spirit:id attribute on a ID 1.5 Return the name of the specified element 1.5 Return the description of the specified element 1.5 Return the displayName of the specified element 1.5 Return the unconfigured ID from a configured ID Unconfigured ID 1.5 name of the choice list of choice enumeration IDs of the choice value of the enumeration element value of the enumeration text attribute value of the enumeration help attribute Indicate to DE where the file resides for the IP-XACT element with the given VLNV. True=VLNV registered, False=VLNV not registered True=always register, False=do not register if the VLNV already exists Return XML of the IP-XACT object identified by the given VLNV. ID for the component instance associated with the currently invoked generator Generator name for use within DE in case of errors API initialization function. Must be called before any other API call. Indicates the API version the generator is defined to work with. 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 Message which the DE may display to the user. Send message level and message text to Design Environment. Get error message from prior callback. ID string for debugging calls to this command within the DE. Any value is okay. Return count of how many potentially incompatible API calls have been made. ID string for debugging calls to this command within the DE. Any value is okay. Terminate connection to the Design Environment. Status indicator from the DE. Non-zero implies an error. Status indicator from the generator. Non-zero implies an error. Message which the DE may display to the user. Set left/right range of an interface port map. Set base address of the master bus interface. Set remap address value for the associated interface. Set address range for the associated interface. Set bus interface bit steering value. Set name of the given file. File name may be not be a relative path. Set command name for the given file builder. Set command flags for the given file builder. Set replace default flags for the given file builder. Set target name for build command for the given file Set command associated with file builder. Set flags associated with the given file builder. Set value of replace default flags in file builder. Set disable flag on function. Set left/right range for the given port. Set default value of the given port. Set period of the given clock port. Set pulse offset value of the given clock port. Set pulse value of the given clock port. Set pulse duration of the given clock port. Set pulse offset of given single shot port. Set pulse value of given single shot port. Set pulse duration of given single shot port. Add new component instance. Element ID of the newly added component instance. Remove specified component instance. Replace specified component with new provided component. Append a new abstractor instance to the interconnection. Element ID of the newly added abstractor instance. Remove specified abstractor instance. Replace specified abstractor with new provided abstractor. Add new interconnection between components. Element ID of the newly added interconnection. The component instance name. The component instance name. Remove interconnection between components, and any abstractors if present. The component instance name. The component instance name. 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. Element ID of the new/modified monitor interconnection. The design that contains the interconnection. The component instance name. The component instance name with the monitor interface. 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. Element ID of the new/modified monitor interconnection. The design that contains the interconnection. The instance name path to the design that contains the component instance. The component instance name. The instance name path to the design that contains the monitor instance. The component instance name with the monitor interface. 1.5 Remove interconnection between a component and monitor. When the last monitor reference is removed, the entire monitorInterconnection element will be removed. The component instance name. The component instance name with the monitor interface. Remove a hierarchical interconnection between a component and monitor. When the last monitor reference is removed, the entire monitorInterconnection element will be removed. The instance name path to the design that contains the component instance. The component instance name. The instance name path to the design that contains the monitor instance. The component instance name with the monitor interface. 1.5 Add new hierarchical connection. Element ID of the newly added hierarchical connection. Remove existing hierarchical connection. Add new ad-hoc connection. Element ID of the newly added ad hoc connection. Tied value for this connection, if blank no tied value. Add an internal port reference to an existing ad-hoc connection. An identical port reference must not already exist in the ad-hoc connection. Element ID of the newly added internal port reference. Add an external port reference to an existing ad-hoc connection. Element ID of the newly added external port reference. Remove an internal port from existing ad-hoc connection. The ad-hoc connection is removed when the last port reference is removed. Remove an external port reference from existing ad-hoc connection. set the address range of an address block expressed as the number of accessable and addressable units. set the bit width of an address block. set the linker command for the current executable image. set the flags of the current executable image linker command. set the name of the linker command file. set the command line switch to specify with the linker command file. set whether or not to generate and enable the linker command file. set the base address of an address block set the address range of an address block expressed as the number of accessable and addressable units. set the bit width of an address block set the base address of an address bank set the base address of a memory subspace Set vendor extensions. NOTE: This call is only supported for elements within a spirit:design. Complete vendor extension text as a well formed XML document with top-level element of spirit:vendorExtensions set vendor defined attribute on the given element Set the value of a parameterID, fileDefineIDs or argumentIDs.