This section specifies the template Document.
The specification comprises a SysML Block that represents the template and an
associated Parametric Diagram that defines the templates and
PLCS PSMTemplate objects
instantiated by the Document template.
The specification comprises the following sections:
NOTE
An explanation of a template and its specification is provided in
the
Template
overviewThe Document template represents a document, i.e. a set of information that constitutes
a whole, and that is published or versioned as a whole (a document). It allows for
identification and naming of documents and their versions (revisions).
No templates have been explicitly defined as being related to the Document template.
NOTE
The Document template may make reference
to other templates as part of the Parametric Diagram. These are not listed
here.
Figure 1 shows the SysML Block that represents the template. The Block is an abstraction
representing a pattern of templates and PLCS PSMTemplate objects.
The properties, i.e. the SysML Block Part, Reference and Value properties, of the
template's SysML Block are described in the Template
Properties section.
The output ports shown on the template's SysML Block are described in the template output ports section.
The SysML Parametric diagrams for the template Block are shown in template parametric diagram section.
Figure 1 - Template block definition diagram for Document
The following SysML Part, Reference, and Value properties are defined for this template:
References:
files [0..*] (Block: Ap239Ap233Psm:
DigitalFile)
The content of a digital document.
Parts:
documentId [1] (Template: OASIS:
Identification)
Identification of the document.
The reference data used in Template: OASIS:
Identification is restricted as follows:
RDL constraint 1:documentId constraint
The reference data for:
OASIS:Identification.role -> ExternalOwlClass.class
is restricted to the following class or a subclass:
documentTitle [0..1] (Template: OASIS:
Descriptor)
Title of the document.
The reference data used in Template: OASIS:
Descriptor is restricted as follows:
RDL constraint 1:documentTitle constraint
The reference data for:
OASIS:Descriptor.classifiedAs -> ExternalOwlClass.class
is restricted to the following class or a subclass:
documentRevisionId [0..1] (Template: OASIS:
Identification)
Identification of the document revision.
The reference data used in Template: OASIS:
Identification is restricted as follows:
RDL constraint 1:documentRevisionId constraint
The reference data for:
OASIS:Identification.role -> ExternalOwlClass.class
is restricted to the following class or a subclass:
documentType [0..1] (ValueType:
ExternalOwlClass)
The type of document (optional).
The reference data used is restricted to the following set:
The following output ports are defined for this template:
PSMdocument (Block: Ap239Ap233Psm:
Document)
Enables the
Block: Ap239Ap233Psm:
Document instantiated by this template to be referenced
when the template is used.
OASISdocument (Template: OASIS:
Document)
Enables the
Template: OASIS:
Document instantiated by this template to be referenced
when the template is used.
There are no constraints defined for this template.
This section describes the template's Parametric Diagram. The diagram details
the pattern of templates and PLCS PSMTemplate objects that are required to
represent the template Document.
The public properties, i.e. those visible in the template's SysML block (See Figure 1) are shown on the left of a
Parametric Diagram.
NOTE
Restrictions on the reference data to be set on the public properties is
defined in the
Template Properties section.
The output ports are shown on the right of a Parametric Diagram.
PLCS PSM
objects are shaded khaki and
Templates
are shaded light green in a Parametric Diagram.
Figure 2 - Document
The following blocks are instantiated by this template and bound to private parts
of the
template as shown in the Parametric Diagram
section:
Private Part Property:
Document [1] (Template: OASIS:
Document)
Private Part Property:
documentTypeClass [0..1] (Template: OASIS:
Classifier)
There are no instances that have been instantiated in this template.
There are no constraint blocks defined in this template.
No example data sets have been provided for this Template.
