-
al.schwinn authored- creation of "BlockType" to simplify XSD
al.schwinn authored- creation of "BlockType" to simplify XSD
DesignSchema.xsd 16.68 KiB
<?xml version="1.0" encoding="UTF-8"?>
<!-- Copyright 2016 CERN and GSI
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see http://www.gnu.org/licenses/.-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:include schemaLocation="shared.xsd" />
<xs:element name="SILECS-Design">
<xs:annotation>
<xs:documentation>A SILECS configuration contains the class designs, the memory mapping and the hardware distribution for a given set of PLCs.</xs:documentation>
<xs:appinfo>
<doc>
The SILECS configuration defines the data structure and the communication parameters required for the interconnection of the PLCs and the Front-End clients. It consists of 3 parts:
<ol>
<li> Design: to define the structure of the exchanged data
<li> Mapping: to define the PLC memory mapping and the protocol parameters
<li> Generation: to define a the hardware on which we will deployed the different Mapping
</ol>
Generally under the responsability of a unique expert entity, an SILECS configuration is done for a set of classes and PLCs in the scope of a particular project or set of equipments.
</doc>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Information">
<xs:complexType>
<xs:sequence>
<xs:element name="Owner">
<xs:annotation>
<xs:documentation>Owner is the one who created the class. He has write-access on the Design document and can deploy the corresponding class course. Owner can add Editors and Users on his class.</xs:documentation>
<xs:appinfo>
<doc>Owner is the one who created the class. He has write-access on the Design document and can deploy the corresponding class course. Owner can add Editors and Users on his class.</doc>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:attribute name="user-login" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
<xs:choice maxOccurs="unbounded">
<xs:element name="Editor" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Editor has write-access on the Design document and can deploy the corresponding class. He cannot add Editors or Users on the class.</xs:documentation>
<xs:appinfo>
<doc>Editor has write-access on the Design document and can deploy the corresponding class. He cannot add Editors or Users on the class.</doc>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:attribute name="user-login" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="User" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>User has read-only access on the Design document but can deploy the corresponding class. He cannot add Editors or Users on the class.</xs:documentation>
<xs:appinfo>
<doc>User has read-only access on the Design document but can deploy the corresponding class. He cannot add Editors or Users on the class.</doc>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:attribute name="user-login" type="xs:string" use="required"/> </xs:complexType>
</xs:element>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="SILECS-Class">
<xs:annotation>
<xs:documentation>The Class node contains the definition of a particular class</xs:documentation>
<xs:appinfo>
<doc>
The Class node contains the definition of a particular class. Designing a class means:
<ol>
<li> Defining a unique class name in the scope of the all configuration
<li> Providing list of variables which will be exchanged with the target PLC
<li> Identifying coherent groups of variables according to their nature and access mode
</ol>
The SILECS tool assists the expert in specifying the data blocks from this abstract point of view.
</doc>
</xs:appinfo>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Description" type="xs:string" minOccurs="0"/>
<xs:element name="Block" type="BlockType" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="name" type="SilecsClassNameType" use="required"/>
<xs:attribute name="version" type="VersionType" use="required"/>
<xs:attribute name="domain" use="required">
<xs:annotation>
<xs:documentation>Defines the domain of use of the class: Operation or Test</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="TEST"/>
<xs:enumeration value="OPERATIONAL"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
<xs:unique name="Register-name-has-to-be-unique-per-class">
<xs:selector xpath="Block/Register"/>
<xs:field xpath="@name"/>
</xs:unique>
<xs:unique name="Block-name-has-to-be-unique-per-class">
<xs:selector xpath="Block"/>
<xs:field xpath="@name"/>
</xs:unique>
<xs:unique name="Property-name-has-to-be-unique-per-class">
<xs:selector xpath="Block"/>
<xs:field xpath="@fesaPropertyName"/>
</xs:unique>
<xs:unique name="Field-name-has-to-be-unique-per-class">
<xs:selector xpath="Block/Register"/>
<xs:field xpath="@fesaFieldName"/>
</xs:unique>
</xs:element>
</xs:sequence>
<xs:attribute name="silecs-version" type="VersionType" use="required"/>
<xs:attribute name="created" type="xs:string" use="required"/>
<xs:attribute name="updated" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
<xs:complexType name="BlockType">
<xs:sequence>
<xs:element name="Description" type="xs:string" minOccurs="0"/>
<xs:element name="Register" type="RegisterType" maxOccurs="unbounded">
<xs:annotation>
<xs:appinfo> <doc>
The Register is the elementary component of the SILECS data model.
<br>Each variable has a unique name in the scope of the class (including all blocks).
</doc>
</xs:appinfo>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="name" type="BlockNameType" use="required">
<xs:annotation>
<xs:appinfo>
Defines the name of the block that must be unique in all the class.
Must not exceed 12 characters.
</xs:appinfo>
</xs:annotation>
</xs:attribute>
<xs:attribute name="mode" use="required">
<xs:annotation>
<xs:documentation>Defines the access-mode of the block and finally of its related variables.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="READ-ONLY"/>
<xs:enumeration value="WRITE-ONLY"/>
<xs:enumeration value="READ-WRITE"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="generateFesaProperty" type="xs:boolean" use="required">
<xs:annotation>
<xs:appinfo>
Defines if the code-generation will generate a FESA-Property and the related Actions/Events/etc for this block
</xs:appinfo>
</xs:annotation>
</xs:attribute>
<xs:attribute name="fesaPropertyName" type="BlockNameType" use="optional">
<xs:annotation>
<xs:appinfo>Defines the name of the generated Fesa-Property. If not set, the Blockname will be used.</xs:appinfo>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="RegisterType">
<xs:sequence>
<xs:element name="Description" type="xs:string" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="name" type="RegisterNameType" use="required">
<xs:annotation>
<xs:appinfo>
<doc>Name must be unique and must respect the following standard: [_A-Za-z]+[_A-Za-z0-9]*</doc>
</xs:appinfo>
</xs:annotation>
</xs:attribute>
<xs:attribute name="format" type="FormatType" use="required">
<xs:annotation>
<xs:appinfo>
<doc>
<table border = "1">
<tr>
<th align="center"> Hardware types </th>
<th align="center"> Client process types </th>
</tr>
<tr>
<td align="center"> uint8 / byte </td>
<td align="center"> uint8_t </td>
</tr>
<tr>
<td align="center"> int8 / char </td>
<td align="center"> int8_t </td>
</tr> <tr>
<td align="center"> uint16 / word </td>
<td align="center"> uint16_t </td>
</tr>
<tr>
<td align="center"> int16 / int </td>
<td align="center"> int16_t </td>
</tr>
<tr>
<td align="center"> uint32 / dword </td>
<td align="center"> uint32_t </td>
</tr>
<tr>
<td align="center"> int32 / dint </td>
<td align="center"> int32_t </td>
</tr>
<tr>
<td align="center"> uint64 </td>
<td align="center"> uint64_t </td>
</tr>
<tr>
<td align="center"> int64 </td>
<td align="center"> int64_t </td>
</tr>
<tr>
<td align="center"> float32 / real </td>
<td align="center"> float </td>
</tr>
<tr>
<td align="center"> float64 </td>
<td align="center"> double </td>
</tr>
<tr>
<td align="center"> date / dt </td>
<td align="center"> double </td>
</tr>
<tr>
<td align="center"> string / char[] </td>
<td align="center"> string </td>
</tr>
</table>
</doc>
</xs:appinfo>
</xs:annotation>
</xs:attribute>
<xs:attribute name="synchro" use="required">
<xs:annotation>
<xs:appinfo>
<doc>
initial value or processing value of persistent data must be up-to-date each time a connection is established.
<br/>SILECS library supports automatic synchronization.
<ul>
<li>MASTER: PLC overwrites FEC register values. </li>
<li>SLAVE: FEC overwrites PLC register values. </li>
<li>NONE: no automatic synchronization performed. (volatile data) </li>
</ul>
</doc>
</xs:appinfo>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="MASTER"/>
<xs:enumeration value="SLAVE"/>
<xs:enumeration value="NONE"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="array-dim1" type="DimensionType" use="optional" default="1">
<xs:annotation>
<xs:appinfo> <doc>
specify register dimension.
<br/> if array-dim1 = 1 the register is a scalar. If array-dim1 > 1 the register is an array.
</doc>
</xs:appinfo>
</xs:annotation>
</xs:attribute>
<xs:attribute name="array-dim2" type="DimensionType" use="optional" default="1">
<xs:annotation>
<xs:appinfo>
<doc>
specify second register dimension.
<br/> if array-dim2 = 1 the register is monodimensional. If array-dim2 > 1 the register is bidimensional.
</doc>
</xs:appinfo>
</xs:annotation>
</xs:attribute>
<xs:attribute name="string-len" type="LengthType" use="optional">
<xs:annotation>
<xs:appinfo>
<doc>specify length of string. If not specified, default value is 64.</doc>
</xs:appinfo>
</xs:annotation>
</xs:attribute>
<xs:attribute name="generateFesaValueItem" type="xs:boolean" use="required">
<xs:annotation>
<xs:appinfo>
Defines if the code-generation will generate a FESA-Value-Item for this Register
</xs:appinfo>
</xs:annotation>
</xs:attribute>
<xs:attribute name="fesaFieldName" type="RegisterNameType" use="optional">
<xs:annotation>
<xs:appinfo>Defines the name of the generated Fesa-Field. If not set, the Registername will be used.</xs:appinfo>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:simpleType name="BlockNameType">
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
<xs:maxLength value="30"/>
<!-- Siemens Support bezüglich der maximalen Zeichenlänge für PLC- Tags : S7-300/1200/1500er bei 128 Zeichen -->
<!-- FESA PropertyNames have max. 30 characters. Since For each Block a prop is generated, we have to use this limit -->
<xs:pattern value="[_A-Za-z]+[_A-Za-z0-9]*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="RegisterNameType">
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
<xs:maxLength value="60"/>
<!-- FESA Fields have max. 60 characters. Since For each Register a field is generated, we have to use this limit -->
<xs:pattern value="[_A-Za-z]+[_A-Za-z0-9]*"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="FormatType">
<xs:restriction base="xs:string">
<xs:enumeration value="uint8"/>
<xs:enumeration value="int8"/>
<xs:enumeration value="uint16"/>
<xs:enumeration value="int16"/>
<xs:enumeration value="uint32"/>
<xs:enumeration value="int32"/>
<xs:enumeration value="uint64"/>
<xs:enumeration value="int64"/>
<xs:enumeration value="float32"/>
<xs:enumeration value="float64"/>
<xs:enumeration value="string"/>
<xs:enumeration value="date"/> <xs:enumeration value="char"/>
<xs:enumeration value="byte"/>
<xs:enumeration value="word"/>
<xs:enumeration value="dword"/>
<xs:enumeration value="int"/>
<xs:enumeration value="dint"/>
<xs:enumeration value="real"/>
<xs:enumeration value="dt"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="DimensionType">
<xs:restriction base="xs:unsignedInt">
<xs:minInclusive value="1"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="LengthType">
<xs:restriction base="xs:unsignedInt">
<xs:minInclusive value="2"/>
<xs:maxInclusive value="254"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>