User Tools

Site Tools


models:vec_v1_1_0:classes:documentversion



Class DocumentVersion

Documentation

The DocumentVersion is one of the two anchors for PDM information in the VEC. All technical information about a PartVersion is contained in one or more documents. The documents are containing the actual content of the VEC since all Specifications are an element of a document.

General Information
Owner core
Applied Stereotype
Base ClassifierItemVersion
Is Abstractfalse
Derived Classifiers

Attributes

Classifier Name Type Mult. Description
ItemVersion abbreviation LocalizedString 0..*

Room for a short name of the Item. In case of a document the attribute is wanted to contain its title.

ItemVersion description AbstractLocalizedString 0..*

Room for additional, human readable information about the ItemVersion. e.g. Buchsengehäuse 26-polig

ItemVersion companyName String 1

Defines the publishing company of the ItemVersion. The companyName is part of the main identifier of an ItemVersion together with the corresponding number (partNumber or documentNumber) and version (partVersion or documentVersion).

ItemVersion processingInstruction Instruction 0..*

Processing instructions for the application of the part or the document.

DocumentVersion documentNumber String 1

The documentNumber is the major identifier of a DocumentVersion. The format is user defined and respectively company specific. Over all VEC-documents a DocumentVersion-instance can be trusted to be identical if the combination of documentNumber, documentVersion and companyName is identical.

DocumentVersion documentType String 0..1

The type of the document. This should be an enumeration of values defined in a conformance class. Typical values would be example: WiringDiagram, HarnessDrawing, etc.

DocumentVersion documentVersion String 1

The documentVersion specifies the version index of a document (see also documentNumber).

DocumentVersion creatingSystem String 0..1

The creatingSystem specifies the computer application or the machine which is used to create the document.

DocumentVersion dataFormat String 0..1

The dataFormat specifies the convention that was used to structure the information in the document. This is useful if the DocumentVersion is actually a pointer to an external document, which is not contained in the VEC or if the content of this DocumentVersion was automatically generated by the extraction of the information out of the original document.

DocumentVersion fileName String 0..1

If this DocumentVersion is a link to an external document (e.g. a ComponentSymbol), then the fileName attribute points to the file containing the original document. To use this attribute is only valid, if the original document is distributed along with the VEC-file e.g. in a ZIP-archive. It must not point to any file location which is not part of the bundle provided together with the VEC-file (e.g. a File on a central server file share).

DocumentVersion location String 0..1

The location specifies where a document can be found in a digital or physical data storage system.

DocumentVersion numberOfSheets String 0..1

The number of sheets contained in the document.

Outgoing Relations

Other End This General
Type Role Mult. Mult. Description
Specification specification 0..* 1 icon_442847519.jpg Specifies the Specifications contained in the DocumentVersion. All structured, technical information in the VEC is described by such Specifications.
ItemEquivalence itemEquivalence 0..* 1 icon_442847519.jpg Specifies ItemEquivalances defined by the DocumentVersion.
DocumentVersion relatedDocument 0..* 0..* icon_238031219.jpg The association is an informative link which DocumentVersion are related to each other (e.g. by derivation, A Harness-Drawing is related to a 3D-Model).
SheetOrChapter sheetOrChapter 0..* 1 icon_442847519.jpg Specifies SheetOrChapters defined in this DocumentVersion. These are especially useful if the DocumentVersion represents an external reference.
PartVersion referencedPart 0..* 0..* icon_238031219.jpg The association is an informative link which PartVersions are described by the DocumentVersion.

Incoming Relations

Other End This General
Type Mult. Role Mult. Description
VecContent 1 documentVersion 0..* icon_442847519.jpg Specifies the DocumentVersions contained in the VEC-file.
ExternalMappingSpecification 0..* mappedDocument 1 icon_238031219.jpg

Reference to the DocumentVersion that represents the external data source that connected to the VEC content by the ExternalMappingSpecification.

DocumentBasedInstruction 0..* referencedDocument 1 icon_238031219.jpg References the DocumentVersion that is used as an Instruction.
DocumentVersion 0..* relatedDocument 0..* icon_238031219.jpg The association is an informative link which DocumentVersion are related to each other (e.g. by derivation, A Harness-Drawing is related to a 3D-Model).
models/vec_v1_1_0/classes/documentversion.txt · Last modified: 2014/02/28 17:12 (external edit)