ipxact-ruby 0.11.1

data/schemas/fileType.xsd

@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+// Description : fileType.xsd
+// Author: The SPIRIT Consortium Schema Working Group
+// 
+// Revision:    $Revision: 1525 $
+// Date:        $Date: 2009-05-27 16:15:02 -0500 (Wed, 27 May 2009) $
+// 
+// Copyright (c) 2005, 2006, 2007, 2008, 2009 The SPIRIT Consortium.
+// 
+// This work forms part of a deliverable of The SPIRIT Consortium.
+// 
+// Use of these materials are governed by the legal terms and conditions
+// outlined in the disclaimer available from www.spiritconsortium.org.
+// 
+// This source file is provided on an AS IS basis.  The SPIRIT
+// Consortium disclaims any warranty express or implied including
+// any warranty of merchantability and fitness for use for a
+// particular purpose.
+// 
+// The user of the source file shall indemnify and hold The SPIRIT
+// Consortium and its members harmless from any damages or liability.
+// Users are requested to provide feedback to The SPIRIT Consortium
+// using either mailto:feedback@lists.spiritconsortium.org or the forms at 
+// http://www.spiritconsortium.org/about/contact_us/
+// 
+// This file may be copied, and distributed, WITHOUT
+// modifications; this notice must be included on any copy.
+-->
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:spirit="http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.5" targetNamespace="http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.5" elementFormDefault="qualified" attributeFormDefault="qualified">
+	<xs:group name="fileType">
+		<xs:annotation>
+			<xs:documentation>The type of a file refenced by IP-XACT.
+Either: fileType - a known IP-XACT file type, or userFileType - a file type not yet known by IP-XACT. If multiple types are specified, the order is important. The first type is the primary type of the file and the latter types are types that may be embedded in the file. For example a Verilog file containing PSL assertions.</xs:documentation>
+		</xs:annotation>
+		<xs:choice>
+			<xs:element name="fileType">
+				<xs:annotation>
+					<xs:documentation>Enumerated file types known by IP-XACT.</xs:documentation>
+				</xs:annotation>
+				<xs:simpleType>
+					<xs:restriction base="xs:string">
+						<xs:enumeration value="unknown"/>
+						<xs:enumeration value="cSource"/>
+						<xs:enumeration value="cppSource"/>
+						<xs:enumeration value="asmSource"/>
+						<xs:enumeration value="vhdlSource"/>
+						<xs:enumeration value="vhdlSource-87"/>
+						<xs:enumeration value="vhdlSource-93"/>
+						<xs:enumeration value="verilogSource"/>
+						<xs:enumeration value="verilogSource-95"/>
+						<xs:enumeration value="verilogSource-2001"/>
+						<xs:enumeration value="swObject"/>
+						<xs:enumeration value="swObjectLibrary"/>
+						<xs:enumeration value="vhdlBinaryLibrary"/>
+						<xs:enumeration value="verilogBinaryLibrary"/>
+						<xs:enumeration value="unelaboratedHdl"/>
+						<xs:enumeration value="executableHdl"/>
+						<xs:enumeration value="systemVerilogSource"/>
+						<xs:enumeration value="systemVerilogSource-3.0"/>
+						<xs:enumeration value="systemVerilogSource-3.1"/>
+						<xs:enumeration value="systemCSource"/>
+						<xs:enumeration value="systemCSource-2.0"/>
+						<xs:enumeration value="systemCSource-2.0.1"/>
+						<xs:enumeration value="systemCSource-2.1"/>
+						<xs:enumeration value="systemCSource-2.2"/>
+						<xs:enumeration value="veraSource"/>
+						<xs:enumeration value="eSource"/>
+						<xs:enumeration value="perlSource"/>
+						<xs:enumeration value="tclSource"/>
+						<xs:enumeration value="OVASource"/>
+						<xs:enumeration value="SVASource"/>
+						<xs:enumeration value="pslSource"/>
+						<xs:enumeration value="systemVerilogSource-3.1a"/>
+						<xs:enumeration value="SDC"/>
+					</xs:restriction>
+				</xs:simpleType>
+			</xs:element>
+			<xs:element name="userFileType" type="xs:string">
+				<xs:annotation>
+					<xs:documentation>Free form file type, not - yet - known by IP-XACT .</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+		</xs:choice>
+	</xs:group>
+</xs:schema>

data/schemas/generator.xsd

@@ -0,0 +1,240 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+// Description : generator.xsd
+// Author: The SPIRIT Consortium Schema Working Group
+// 
+// Revision:    $Revision: 1506 $
+// Date:        $Date: 2009-04-26 01:51:56 -0500 (Sun, 26 Apr 2009) $
+// 
+// Copyright (c) 2005, 2006, 2007, 2008, 2009 The SPIRIT Consortium.
+// 
+// This work forms part of a deliverable of The SPIRIT Consortium.
+// 
+// Use of these materials are governed by the legal terms and conditions
+// outlined in the disclaimer available from www.spiritconsortium.org.
+// 
+// This source file is provided on an AS IS basis.  The SPIRIT
+// Consortium disclaims any warranty express or implied including
+// any warranty of merchantability and fitness for use for a
+// particular purpose.
+// 
+// The user of the source file shall indemnify and hold The SPIRIT
+// Consortium and its members harmless from any damages or liability.
+// Users are requested to provide feedback to The SPIRIT Consortium
+// using either mailto:feedback@lists.spiritconsortium.org or the forms at 
+// http://www.spiritconsortium.org/about/contact_us/
+// 
+// This file may be copied, and distributed, WITHOUT
+// modifications; this notice must be included on any copy.
+-->
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:spirit="http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.5" targetNamespace="http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.5" elementFormDefault="qualified" attributeFormDefault="qualified">
+  <xs:include schemaLocation="file.xsd"/>
+  <xs:include schemaLocation="identifier.xsd"/>
+  <xs:include schemaLocation="commonStructures.xsd"/>
+  <xs:element name="generatorChain">
+    <xs:complexType>
+      <xs:sequence>
+        <xs:group ref="spirit:versionedIdentifier"/>
+        <xs:choice maxOccurs="unbounded">
+          <xs:element name="generatorChainSelector">
+            <xs:annotation>
+              <xs:documentation>Select other generator chain files for inclusion into this chain. The boolean attribute "unique" (default false) specifies that only a single generator is valid in this context. If more that one generator is selected based on the selection criteria, DE will prompt the user to resolve to a single generator.</xs:documentation>
+            </xs:annotation>
+            <xs:complexType>
+              <xs:choice>
+                <xs:element ref="spirit:groupSelector"/>
+                <xs:element name="generatorChainRef" type="spirit:libraryRefType">
+                  <xs:annotation>
+                    <xs:documentation>Select another generator chain using the unique identifier of this generator chain.</xs:documentation>
+                  </xs:annotation>
+                </xs:element>
+              </xs:choice>
+              <xs:attribute name="unique" type="xs:boolean" use="optional" default="false">
+                <xs:annotation>
+                  <xs:documentation>Specifies that only a single generator is valid in this context. If more that one generator is selcted based on the selection criteria, DE will prompt the user to resolve to a single generator.</xs:documentation>
+                </xs:annotation>
+              </xs:attribute>
+            </xs:complexType>
+          </xs:element>
+          <xs:element name="componentGeneratorSelector" type="spirit:generatorSelectorType">
+            <xs:annotation>
+              <xs:documentation>Selects generators declared in components of the current design for inclusion into this generator chain.</xs:documentation>
+            </xs:annotation>
+          </xs:element>
+          <xs:element ref="spirit:generator"/>
+        </xs:choice>
+        <xs:element name="chainGroup" type="xs:Name" minOccurs="0" maxOccurs="unbounded">
+          <xs:annotation>
+            <xs:documentation>Identifies this generator chain as belonging to the named group. This is used by other generator chains to select this chain for programmatic inclusion.</xs:documentation>
+          </xs:annotation>
+        </xs:element>
+        <xs:element ref="spirit:displayName" minOccurs="0"/>
+        <xs:element ref="spirit:description" minOccurs="0"/>
+        <xs:element ref="spirit:choices" minOccurs="0"/>
+        <xs:element ref="spirit:vendorExtensions" minOccurs="0"/>
+      </xs:sequence>
+      <xs:attribute name="hidden" type="xs:boolean" use="optional" default="false">
+        <xs:annotation>
+          <xs:documentation>If this attribute is true then the generator should not be presented to the user, it may be part of a chain and has no useful meaning when invoked standalone.</xs:documentation>
+        </xs:annotation>
+      </xs:attribute>
+    </xs:complexType>
+  </xs:element>
+  <xs:element name="generator">
+    <xs:annotation>
+      <xs:documentation>Specifies a set of generators.</xs:documentation>
+    </xs:annotation>
+    <xs:complexType>
+      <xs:complexContent>
+        <xs:extension base="spirit:generatorType"/>
+      </xs:complexContent>
+    </xs:complexType>
+  </xs:element>
+  <xs:element name="componentGenerator">
+    <xs:annotation>
+      <xs:documentation>Specifies a set of component generators. The scope attribute applies to component generators and specifies whether the generator should be run for each instance of the entity (or module) or just once for all instances of the entity.</xs:documentation>
+    </xs:annotation>
+    <xs:complexType>
+      <xs:complexContent>
+        <xs:extension base="spirit:instanceGeneratorType"/>
+      </xs:complexContent>
+    </xs:complexType>
+  </xs:element>
+  <xs:element name="abstractorGenerator" type="spirit:instanceGeneratorType">
+    <xs:annotation>
+      <xs:documentation>Specifies a set of abstractor generators. The scope attribute applies to abstractor generators and specifies whether the generator should be run for each instance of the entity (or module) or just once for all instances of the entity.</xs:documentation>
+    </xs:annotation>
+  </xs:element>
+  <xs:element name="groupSelector">
+    <xs:annotation>
+      <xs:documentation>Specifies a set of group names used to select subsequent generators. The attribute "multipleGroupOperator" specifies the OR or AND selection operator if there is more than one group name (default=OR).</xs:documentation>
+    </xs:annotation>
+    <xs:complexType>
+      <xs:sequence>
+        <xs:element name="name" type="xs:Name" maxOccurs="unbounded">
+          <xs:annotation>
+            <xs:documentation>Specifies a generator group name or a generator chain group name to be selected for inclusion in the generator chain.</xs:documentation>
+          </xs:annotation>
+        </xs:element>
+      </xs:sequence>
+      <xs:attribute name="multipleGroupSelectionOperator" use="optional" default="or">
+        <xs:annotation>
+          <xs:documentation>Specifies the OR or AND selection operator if there is more than one group name.</xs:documentation>
+        </xs:annotation>
+        <xs:simpleType>
+          <xs:restriction base="xs:Name">
+            <xs:enumeration value="and"/>
+            <xs:enumeration value="or"/>
+          </xs:restriction>
+        </xs:simpleType>
+      </xs:attribute>
+    </xs:complexType>
+  </xs:element>
+  <xs:element name="phase">
+    <xs:annotation>
+      <xs:documentation>This is an non-negative floating point number that is used to sequence when a generator is run. The generators are run in order starting with zero. There may be multiple generators with the same phase number. In this case, the order should not matter with respect to other generators at the same phase. If no phase number is given the generator will be considered in the "last" phase and these generators will be run in the order in which they are encountered while processing generator elements.</xs:documentation>
+    </xs:annotation>
+    <xs:complexType>
+      <xs:simpleContent>
+        <xs:extension base="xs:float"/>
+      </xs:simpleContent>
+    </xs:complexType>
+  </xs:element>
+  <xs:complexType name="instanceGeneratorType">
+    <xs:complexContent>
+      <xs:extension base="spirit:generatorType">
+        <xs:sequence>
+          <xs:element name="group" type="xs:Name" minOccurs="0" maxOccurs="unbounded">
+            <xs:annotation>
+              <xs:documentation>An identifier to specify the generator group. This is used by generator chains for selecting which generators to run.</xs:documentation>
+            </xs:annotation>
+          </xs:element>
+        </xs:sequence>
+        <xs:attribute name="scope" use="optional" default="instance">
+          <xs:annotation>
+            <xs:documentation>The scope attribute applies to component generators and specifies whether the generator should be run for each instance of the entity (or module) or just once for all instances of the entity.</xs:documentation>
+          </xs:annotation>
+          <xs:simpleType>
+            <xs:restriction base="xs:string">
+              <xs:enumeration value="instance"/>
+              <xs:enumeration value="entity"/>
+            </xs:restriction>
+          </xs:simpleType>
+        </xs:attribute>
+      </xs:extension>
+    </xs:complexContent>
+  </xs:complexType>
+  <xs:complexType name="generatorSelectorType">
+    <xs:sequence>
+      <xs:element ref="spirit:groupSelector"/>
+    </xs:sequence>
+  </xs:complexType>
+  <xs:element name="componentGenerators">
+    <xs:annotation>
+      <xs:documentation>List of component generators.</xs:documentation>
+    </xs:annotation>
+    <xs:complexType>
+      <xs:sequence>
+        <xs:element ref="spirit:componentGenerator" maxOccurs="unbounded"/>
+      </xs:sequence>
+    </xs:complexType>
+  </xs:element>
+  <xs:element name="abstractorGenerators">
+    <xs:annotation>
+      <xs:documentation>List of abstractor generators.</xs:documentation>
+    </xs:annotation>
+    <xs:complexType>
+      <xs:sequence>
+        <xs:element ref="spirit:abstractorGenerator" maxOccurs="unbounded"/>
+      </xs:sequence>
+    </xs:complexType>
+  </xs:element>
+  <xs:complexType name="generatorType">
+    <xs:annotation>
+      <xs:documentation>Types of generators</xs:documentation>
+    </xs:annotation>
+    <xs:sequence>
+      <xs:group ref="spirit:nameGroup"/>
+      <xs:element ref="spirit:phase" minOccurs="0"/>
+      <xs:element ref="spirit:parameters" minOccurs="0"/>
+      <xs:element name="apiType" minOccurs="0">
+        <xs:annotation>
+          <xs:documentation>Indicates the type of API used by the generator. Valid value are TGI, and none. If this element is not present, TGI is assumed.</xs:documentation>
+        </xs:annotation>
+        <xs:simpleType>
+          <xs:restriction base="xs:token">
+            <xs:enumeration value="TGI"/>
+            <xs:enumeration value="none"/>
+          </xs:restriction>
+        </xs:simpleType>
+      </xs:element>
+      <xs:element name="transportMethods" minOccurs="0">
+        <xs:complexType>
+          <xs:sequence>
+            <xs:element name="transportMethod">
+              <xs:annotation>
+                <xs:documentation>Defines a SOAP transport protocol other than HTTP which is supported by this generator. The only other currently supported protocol is 'file'.</xs:documentation>
+              </xs:annotation>
+              <xs:simpleType>
+                <xs:restriction base="xs:token">
+                  <xs:enumeration value="file"/>
+                </xs:restriction>
+              </xs:simpleType>
+            </xs:element>
+          </xs:sequence>
+        </xs:complexType>
+      </xs:element>
+      <xs:element name="generatorExe" type="spirit:spiritURI">
+        <xs:annotation>
+          <xs:documentation>The pathname to the executable file that implements the generator</xs:documentation>
+        </xs:annotation>
+      </xs:element>
+      <xs:element ref="spirit:vendorExtensions" minOccurs="0"/>
+    </xs:sequence>
+    <xs:attribute name="hidden" type="xs:boolean" use="optional" default="false">
+      <xs:annotation>
+        <xs:documentation>If this attribute is true then the generator should not be presented to the user, it may be part of a chain and has no useful meaning when invoked standalone.</xs:documentation>
+      </xs:annotation>
+    </xs:attribute>
+  </xs:complexType>
+</xs:schema>

data/schemas/identifier.xsd

@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+// Description : identifier.xsd
+// Author: The SPIRIT Consortium Schema Working Group
+// 
+// Revision:    $Revision: 1526 $
+// Date:        $Date: 2009-05-27 16:31:29 -0500 (Wed, 27 May 2009) $
+// 
+// Copyright (c) 2005, 2006, 2007, 2008, 2009 The SPIRIT Consortium.
+// 
+// This work forms part of a deliverable of The SPIRIT Consortium.
+// 
+// Use of these materials are governed by the legal terms and conditions
+// outlined in the disclaimer available from www.spiritconsortium.org.
+// 
+// This source file is provided on an AS IS basis.  The SPIRIT
+// Consortium disclaims any warranty express or implied including
+// any warranty of merchantability and fitness for use for a
+// particular purpose.
+// 
+// The user of the source file shall indemnify and hold The SPIRIT
+// Consortium and its members harmless from any damages or liability.
+// Users are requested to provide feedback to The SPIRIT Consortium
+// using either mailto:feedback@lists.spiritconsortium.org or the forms at 
+// http://www.spiritconsortium.org/about/contact_us/
+// 
+// This file may be copied, and distributed, WITHOUT
+// modifications; this notice must be included on any copy.
+-->
+<xs:schema xmlns:spirit="http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.5" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.5" elementFormDefault="qualified" attributeFormDefault="qualified">
+	<xs:group name="baseIdentifier">
+		<xs:annotation>
+			<xs:documentation>Base IP-XACT identifier group. Identify an IP-XACT document by its by vendor, library and name.</xs:documentation>
+		</xs:annotation>
+		<xs:sequence/>
+	</xs:group>
+	<xs:group name="versionedIdentifier">
+		<xs:annotation>
+			<xs:documentation>This group of elements identifies a top level item (e.g. a component or a bus definition)  with vendor, library, name and a version number. </xs:documentation>
+		</xs:annotation>
+		<xs:sequence>
+			<xs:element name="vendor" type="xs:Name">
+				<xs:annotation>
+					<xs:documentation>Name of the vendor who supplies this file.</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element name="library" type="xs:Name">
+				<xs:annotation>
+					<xs:documentation>Name of the logical library this element belongs to.  </xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element name="name" type="xs:NMTOKEN">
+				<xs:annotation>
+					<xs:documentation>The name of the object.  </xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element name="version" type="xs:NMTOKEN">
+				<xs:annotation>
+					<xs:documentation>Indicates the version of the named element.</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+		</xs:sequence>
+	</xs:group>
+	<xs:attributeGroup name="libraryRefGroup">
+		<xs:annotation>
+			<xs:documentation>Base IP-XACT document reference.  Contains vendor, library, name and version attributes.</xs:documentation>
+		</xs:annotation>
+		<xs:attribute name="vendor" type="xs:Name" use="required"/>
+		<xs:attribute name="library" type="xs:Name" use="required"/>
+		<xs:attribute name="name" type="xs:NMTOKEN" use="required"/>
+		<xs:attribute name="version" type="xs:NMTOKEN" use="required"/>
+	</xs:attributeGroup>
+	<xs:complexType name="libraryRefType">
+		<xs:annotation>
+			<xs:documentation>Base IP-XACT document reference type. Contains vendor, library, name and version attributes.</xs:documentation>
+		</xs:annotation>
+		<xs:attributeGroup ref="spirit:libraryRefGroup">
+			<xs:annotation>
+				<xs:documentation>Base IP-XACT document reference.  Contains vendor, library, name and version attributes.</xs:documentation>
+			</xs:annotation>
+		</xs:attributeGroup>
+	</xs:complexType>
+	<xs:complexType name="resolvedLibraryRefType">
+		<xs:annotation>
+			<xs:documentation>Resolved IP-XACT document reference type. Contains vendor, library, name and version attributes and the URI of the referenced IP-XACT document</xs:documentation>
+		</xs:annotation>
+		<xs:simpleContent>
+			<xs:extension base="xs:anyURI">
+				<xs:attributeGroup ref="spirit:libraryRefGroup"/>
+			</xs:extension>
+		</xs:simpleContent>
+	</xs:complexType>
+</xs:schema>

data/schemas/index.xsd

@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+// Description: index.xsd
+// Author: The SPIRIT Consortium Schema Working Group
+// 
+// Revision:    $Revision: 1506 $
+// Date:        $Date: 2009-04-26 01:51:56 -0500 (Sun, 26 Apr 2009) $
+// 
+// Copyright (c) 2005, 2006, 2007, 2008, 2009 The SPIRIT Consortium.
+// 
+// This work forms part of a deliverable of The SPIRIT Consortium.
+// 
+// Use of these materials are governed by the legal terms and conditions
+// outlined in the disclaimer available from www.spiritconsortium.org.
+// 
+// This source file is provided on an AS IS basis.  The SPIRIT
+// Consortium disclaims any warranty express or implied including
+// any warranty of merchantability and fitness for use for a
+// particular purpose.
+// 
+// The user of the source file shall indemnify and hold The SPIRIT
+// Consortium and its members harmless from any damages or liability.
+// Users are requested to provide feedback to The SPIRIT Consortium
+// using either mailto:feedback@lists.spiritconsortium.org or the forms at 
+// http://www.spiritconsortium.org/about/contact_us/
+// 
+// This file may be copied, and distributed, WITHOUT
+// modifications; this notice must be included on any copy.
+-->
+<xs:schema xmlns:spirit="http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.5" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.spiritconsortium.org/XMLSchema/SPIRIT/1.5" elementFormDefault="qualified" attributeFormDefault="qualified">
+	<xs:include schemaLocation="busDefinition.xsd"/>
+	<xs:include schemaLocation="component.xsd"/>
+	<xs:include schemaLocation="design.xsd"/>
+	<xs:include schemaLocation="designConfig.xsd"/>
+	<xs:include schemaLocation="abstractionDefinition.xsd"/>
+	<xs:include schemaLocation="abstractor.xsd"/>
+	<xs:group name="IPXACTDocumentTypes">
+		<xs:annotation>
+			<xs:documentation>This IP-XACT schema documentation is part of the IP-XACT standard deliverables. The diagrams in this documentation represent the relationships between elements of the schema together with their attributes and expected values. Valid IP-XACT XML files must have a top-level type that is one of the elements listed here.</xs:documentation>
+		</xs:annotation>
+		<xs:choice>
+			<xs:element ref="spirit:busDefinition">
+				<xs:annotation>
+					<xs:documentation>To define all elements and attributes supported when defining a bus.</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element ref="spirit:abstractionDefinition"/>
+			<xs:element ref="spirit:component">
+				<xs:annotation>
+					<xs:documentation>To define all elements and attributes supported when defining a component.</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element ref="spirit:abstractor"/>
+			<xs:element ref="spirit:design">
+				<xs:annotation>
+					<xs:documentation>To define all elements and attributes supported when defining a design and its configured components</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element ref="spirit:generatorChain">
+				<xs:annotation>
+					<xs:documentation>To define all elements and attributes supported for defining generator chains.</xs:documentation>
+				</xs:annotation>
+			</xs:element>
+			<xs:element ref="spirit:designConfiguration"/>
+		</xs:choice>
+	</xs:group>
+</xs:schema>