User Tools

Site Tools



This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
tutorials:vec:file_structure [2019/08/12 11:36]
4soft.fehlmann created
tutorials:vec:file_structure [2019/11/22 10:31] (current)
Line 3: Line 3:
 <​(wip)>​ <​(wip)>​
 ====== VEC File Structure ====== ====== VEC File Structure ======
-===== VEC Root =====+
 ===== Head Information ===== ===== Head Information =====
-===== Project ​Information =====+The VEC container contains its own sub elements to make statements about the data contained. This includes the project details with its car classification levels, copyright information,​ the source system, a list of belonging contracts or the compliance conformance classes. 
 +<​Code:​xml linenums|Listing 2> 
 +<​vec:​VecContent ...> 
 +    <​VecVersion>​1.1.3</​VecVersion>​ 
 +    <​GeneratingSystemName>​WES-WF</​GeneratingSystemName>​ 
 +    <​DateOfCreation>​2019-01-01T12:​00:​00.000+02:​00</​DateOfCreation>​ 
 +    <​GeneratingSystemVersion>​1.1.11</​GeneratingSystemVersion>​ 
 +    <​CopyrightInformation id="​id_cpy_right_2">​ 
 +        <​CopyrightNote id="​id_cpy_right_3">​ 
 +            <​LanguageCode>​De</​LanguageCode>​ 
 +            <​Value>​Lorem Ipsum sit dolor et amet.</​Value>​ 
 +        </​CopyrightNote>​ 
 +    </​CopyrightInformation>​ 
 +    <Project id="​id_proj_10">​ 
 +        <​CarClassificationLevel2>​Sample Project</​CarClassificationLevel2>​ 
 +        <​CarClassificationLevel3>​000</​CarClassificationLevel3>​ 
 +        <​Identification>​WES</​Identification>​ 
 +        <​Description xsi:type="​vec:​LocalizedString"​ id="​id_11">​ 
 +            <​LanguageCode>​En</​LanguageCode>​ 
 +            <​Value>​This is a sample project</​Value>​ 
 +        </​Description>​ 
 +    </Project
 +    ... 
 ===== Units ===== ===== Units =====
-===== DocumentVersion for Harnesses ​===== +Because of the fact that units are stateless they can be referenced from every element that represents a physical characteristic of a part or a specific part usage. This global validity is the reason why units are placed directly underneath the VEC root element. The different systems to define units are represented by the subclasses of the unit class (e.g. SIUnit, ImperialUnit).  
-===== DocumentVersion for Modules ​===== +<​Code:​xml linenums|Listing 3> 
-===== DocumentVersion for System Schematic (Sheets) =====+<Unit xsi:type="​vec:​SIUnit"​ id="​id_unit_6000">​ 
 +        <​Exponent>​2</​Exponent>​ 
 +        <​SiUnitName>​Metre</​SiUnitName>​ 
 +        <​SiPrefix>​Milli</​SiPrefix>​ 
 +    </​Unit>​ 
 +    <Unit xsi:type="​vec:​SIUnit"​ id="​id_unit_170">​ 
 +        <​SiUnitName>​Gram</​SiUnitName>​ 
 +    </​Unit>​ 
 +    <Unit xsi:type="​vec:​SIUnit"​ id="​id_unit_7238">​ 
 +        <​Exponent>​-1</​Exponent>​ 
 +        <​SiUnitName>​Metre</​SiUnitName>​ 
 +    </​Unit>​ 
 +    <Unit xsi:type="​vec:​SIUnit"​ id="​id_unit_442">​ 
 +        <​SiUnitName>​DegreeCelsius</​SiUnitName>​ 
 +    </​Unit>​ 
 +    <Unit xsi:type="​vec:​SIUnit"​ id="​id_unit_189">​ 
 +        <​SiUnitName>​Ampere</​SiUnitName>​ 
 +    </​Unit>​ 
 +    <Unit xsi:type="​vec:​SIUnit"​ id="​id_unit_445">​ 
 +        <​SiUnitName>​Volt</​SiUnitName>​ 
 +    </​Unit>​ 
 +    <Unit xsi:type="​vec:​SIUnit"​ id="​id_unit_196">​ 
 +        <​SiUnitName>​Second</​SiUnitName>​ 
 +    </​Unit>​ 
 +===== DocumentVersions ===== 
 +The DocumentVersion ​class is the root element ​for all payload data in the VEC and all technical information about a PartVersion is contained in one or more documents.  
 +Furthermore,​ the DocumentVersion class opens up the possibility to group those data together, which came from the same approval process and are released at a same time. 
 +The payload itself is defined within specifications. Their concrete classes are used to define which type of information is included. The type of the document version can be found in the DocumentType attribute of the DocumentVersion. 
 +At the same time, a DocumentVersion is the anchor point for the unique identification of information and its status (DocumentNumber & DocumentVersion). 
 +==== DocumentVersion for Harnesses ​==== 
 +From the point of view of the VEC structure, the definition of a harness does not differ from that of a component because a harness has also a part number and is handled as a part as well (see PartVersion for Harnesses). To describe the harness with its structure and all the technical information,​ a DocumentVersion is needed and it is recommended to use one for each single harness. This creates a better structure of the data in the model and also a better overview within the VEC XML file structure. 
 +To identify a DocumentVersion as a container for a harness the literal ‘HanressDescription’ for the DocumentType attribute can be used.  
 +The technical description of a harnesss is made by its containing specifications. See Specifications for Harnesses 
 +==== DocumentVersion for Coupling Devices ==== 
 +For the instantiation of the coupling devices and their coupling with the connected harnesses a DocumentVersion is inserted below the VecContent. It has the DocumentType "​HarnessCoupling"​ and contains two types of Specifications:​ 
 +- A PartUsageSpecification that contains an instance (PartOccurrence) for each coupling device. 
 +- For each coupling device, a coupling specification which establishes the relationships between the slots of the coupling device and the connectors in the connected harness. 
 +==== DocumentVersion for System Schematic (Sheets) ==== 
 +==== DocumentVersion for Part Master Data ==== 
 +=== Parts === 
 +=== Signals and Usage Nodes === 
 +The definition of signals and usage nodes is part of the part master data. Like a single point of truth all usages of signals or usage nodes in the whole vec content should be grouped each in a single DocumentVersion,​ depending on the established release process. In case of signals underneath their DocumentVersion a SignalSpecification can be used to define signals underneath it. For usage nodes a UsageNodeSpecification is the right container for them. Prerequisite,​ however, is the common approval process like for all data in a same DocumentVersion. Specific literals for the attribute DocumentType should be used to mark the DocumentVersion containing either the ‘SignalList’ or the ‘UsageNodeNodeList’. 
 +<​DocumentVersion id="​id_docu_ver_1">​ 
 +        <​DocumentNumber>​SignalList</​DocumentNumber>​ 
 +        <​DocumentType>​SignalList</​DocumentType>​ 
 +        <​DocumentVersion>​1</​DocumentVersion>​ 
 +        <​Specification xsi:​type="​vec:​SignalSpecification"​ id="​id_signal_spec_1">​ 
 +            <​Identification>​Signals</​Identification>​ 
 +            <Signal id="​id_signal_1">​ 
 +                <​Identification>​1</​Identification>​ 
 +                <​SignalName>​1</​SignalName>​ 
 +                <​Description xsi:​type="​vec:​LocalizedString"​ id="​id_localizedString_1">​ 
 +                    <​LanguageCode>​De</​LanguageCode>​ 
 +                    <​Value>​Masse</​Value>​ 
 +                </​Description>​ 
 +                <​SignalType>​ground</​SignalType>​ 
 +            </​Signal>​ 
 +            <Signal id="​id_signal_2">​ 
 +                <​Identification>​2</​Identification>​ 
 +                <​SignalName>​2</​SignalName>​ 
 +                <​Description xsi:​type="​vec:​LocalizedString"​ id="​id_localizedString_2">​ 
 +                    <​LanguageCode>​De</​LanguageCode>​ 
 +                    <​Value>​Licht</​Value>​ 
 +                </​Description>​ 
 +            </​Signal>​ 
 +            <Signal id="​id_signal_3">​ 
 +                <​Identification>​3</​Identification>​ 
 +                <​SignalName>​3</​SignalName>​ 
 +                <​Description xsi:​type="​vec:​LocalizedString"​ id="​id_localizedString_3">​ 
 +                    <​LanguageCode>​De</​LanguageCode>​ 
 +                    <​Value>​Batterie</​Value>​ 
 +                </​Description>​ 
 +                <​SignalType>​energy</​SignalType>​ 
 +            </​Signal>​ 
 +        </​Specification>​ 
 ===== PartVersion for Harnesses ===== ===== PartVersion for Harnesses =====
 ===== PartVersion for Modules ===== ===== PartVersion for Modules =====
 {{tag>​tutorials:​vec:​v113 unpublished}} {{tag>​tutorials:​vec:​v113 unpublished}}
tutorials/vec/file_structure.1565602617.txt.gz · Last modified: 2019/08/12 11:36 by 4soft.fehlmann