Template: StockItem

This section specifies the template StockItem.

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 StockItem template.

The specification comprises the following sections:

Section Description provides a description of the template;
Section Template Block specifies the SysML Block that represents the template;
Section Template Properties specifies the properties, i.e. the SysML Part, Reference and Value properties of the templates SysML Block;
Section Template Output Ports specifies the SysML Output Ports of the templates SysML Block. These bind to the templates and PLCS PSM objects instantiated by the StockItem template as described in section Template Parametric Diagram;
Section Template Constraints specifies the constraints on PLCS PSMTemplate objects instantiated by the StockItem template;
Section Template Parametric Diagram specifies the templates and PLCS PSMTemplate objects instantiated by the StockItem template;
Section Instantiated blocks specifies the templates and PLCS PSMTemplate objects instantiated by the StockItem template and bound to private parts of the template;
Section Default instances species the instances that have been instantiated in the template. These are used to set the default value of blocks.
Section Constraint blocks identifies the constraint blocks that have been specified in this template;
Section Example data provides example XML data sets that have been instantiated in accordance with this template.

NOTE An explanation of a template and its specification is provided in the Template overview

Description

The StockItem template describes how to represent the identification of a stock item.

Related Templates

No templates have been explicitly defined as being related to the StockItem template.

NOTE The StockItem template may make reference to other templates as part of the Parametric Diagram. These are not listed here.

Template Block

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 StockItem

Template Properties

The following SysML Part, Reference, and Value properties are defined for this template:

Parts:

ids [1..*] (Template: OASIS:Identification)

The identifiers of the stock item.

The reference data used in Template: OASIS:Identification is restricted as follows:

RDL constraint 1:

The ids must be classified as a stock number code or sub class of stock number code.

The reference data for:

OASIS:Identification.role -> ExternalOwlClass.class

is restricted to the following class or a subclass:

http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#Stock_number_code

Example reference data is:

http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#NSN_code

used to identify resource items by NATO Stock Numbers

resourceItemSelect [0..*] (Block: Ap239Ap233Psm:ResourceRealizationSelect)

The item that is identified as a stock item. Normally a Part.

names [0..*] (Template: OASIS:Name)

The names of the Stock Item

descriptions [0..*] (Template: OASIS:Descriptor)

The descriptions of the Stock Item.

classifications [0..*] (Template: OASIS:Classifier)

The classifications of the Stock Item

The reference data used in Template: OASIS:Classifier is restricted as follows:

RDL constraint 1:

The reference data for:

OASIS:Classifier.class -> ExternalOwlClass.class

is restricted to classes that are subclasses of the following class:

http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/plcs/plcs-psm/refdata/plcs-psm#ResourceItem

Template Output Ports

The following output ports are defined for this template:

resourceItem (Block: Ap239Ap233Psm:ResourceItem)

Enables the Block: Ap239Ap233Psm:ResourceItem instantiated by this template to be referenced when the template is used.

resourceRealization [0..*] (Block: Ap239Ap233Psm:ResourceItemRealization)

Enables the Block: Ap239Ap233Psm:ResourceItemRealization instantiated by this template to be referenced when the template is used.

Template constraints

There are no constraints defined for this template.

Template Parametric diagram

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 StockItem.

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 - Parametric diagram for StockItem

Instantiated Blocks

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:resourceItem [1] (Block: Ap239Ap233Psm:ResourceItem)

Private Part Property:resourceItemRealization [0..*] (Block: Ap239Ap233Psm:ResourceItemRealization)

Private Part Property:combNameAndDesc [1] (Constraint Block: OASIS:Name:CombineNamesAndDescriptors)

Default instances

Figure 3 shows the instances that have been instantiated in the template. These are used to set the default value of blocks.

Figure 3 - Model instance diagram for StockItem

Instances

The following instances have been created:

classStockNumberCode instance of Block: Ap239Ap233Psm:ExternalOwlClass.

ExternalOwlClass.class = http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#Stock_number_code

This is the standard classification of a stock number code and is used as constraint on the id.

classNSNCode instance of Block: Ap239Ap233Psm:ExternalOwlClass.

ExternalOwlClass.class = http://docs.oasis-open.org/plcs/ns/plcslib/v1.0/data/contexts/OASIS/refdata/plcs-rdl#NSN_code

This is the NATO Stock Number code and is a standard id classification in the defense industries.

Constraint Blocks

There are no constraint blocks defined in this template.

Example data

The following section provides an example XML dataset that has been instantiated in accordance with this template.

Data set: NSN number

NSN number

stock_item.xml

View

download

This example shows the XML instantiated to represent an NSN code assigned to a Part.