AutomationML - 7.3 AutomationMLBaseRoleClassLib

This Instance is a child of RoleClassLibs. It is defined in Table 42.

It consists of the Standard AutomationML Base Role Class Library (Part 1). The content is extended with Part 3 and Part 4 of the AutomationML standard specification.

Table 42 - AutomationMLBaseRoleClassLib Instance Definition

Name	TypeDefinition
AutomationMLBaseRoleClassLib	FolderType

7.3.2 ObjectTypes

7.3.2.1 AutomationMLBaseRoleClassLib

7.3.2.1.1 General

The role class “AutomationMLBaseRole” is a basic abstract role type and the base class for all standard or user-defined role classes.

7.3.2.1.2 ObjectType Definition

The AutomationMLBaseRole is formally defined in Table 43.

Table 43 - AutomationMLBaseRole Definition

Attribute	Value
BrowseName	AutomationMLBaseRole
IsAbstract	False
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Inherit the components of the CAEXObjectType

HasProperty	Variable	ID	BaseDataType	PropertyType	Optional
HasProperty	Variable	Version	BaseDataType	PropertyType	Optional

7.3.2.2 Group

7.3.2.2.1 General

The role class “Group” is a role type for objects that serve for the grouping of mirror objects that belong together from a certain engineering perspective. AML Group objects shall reference this role.

7.3.2.2.2 ObjectType Definition

The Group is formally defined in Table 44.

Table 44 - Group Definition

Attribute	Value
BrowseName	Group
IsAbstract	False
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Inherit the components of the AutomationMLBaseRole

HasComponent	Variable	AssociatedFacet	String	BaseDataVariableType	Optional
HasProperty	Variable	ID	BaseDataType	PropertyType	Optional
HasProperty	Variable	Version	BaseDataType	PropertyType	Optional

7.3.2.2.3 ObjectType Description

7.3.2.2.3.1 AssociatedFacet

The attribute “AssociatedFacet” shall be used for the definition of the name of the corresponding Facet. Example: AssociatedFacet = “PLCFacet”

7.3.2.3 Facet

7.3.2.3.1 General

The role class “Facet” is a role type for objects that serve as sub-view on attributes or interfaces of an AML object. AML Facet objects shall reference this role. Details and examples are specified in 8.3.

7.3.2.3.2 ObjectType Definition

The Facet is formally defined in Table 45

Table 45 - Facet Definition

Attribute	Value
BrowseName	Facet
IsAbstract	False
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Inherit the components of the AutomationMLBaseRole

HasProperty	Variable	ID	BaseDataType	PropertyType	Optional
HasProperty	Variable	Version	BaseDataType	PropertyType	Optional

7.3.2.4 Port

7.3.2.4.1 General

The role class “Port” is a role type for objects that groups a number of interfaces and allows describing complex interfaces in this way. AML Port objects shall reference this role. Details and examples are specified in 8.2.

7.3.2.4.2 ObjectType Definition

The Port is formally defined in Table 46.

Table 46 - Port Definition

Attribute	Value
BrowseName	Port
IsAbstract	False
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Inherit the components of the AutomationMLBaseRole

HasComponent	Variable	Cardinality	String	BaseDataVariableType	Optional
HasComponent	Variable	Category	String	BaseDataVariableType	Optional
HasComponent	Object	ConnectionPoint		PortConnector	Optional
HasComponent	Variable	Direction	String	BaseDataVariableType	Optional
HasProperty	Variable	ID	BaseDataType	PropertyType	Optional
HasProperty	Variable	Version	BaseDataType	PropertyType	Optional

7.3.2.4.3 ObjectType Description

7.3.2.4.3.1 Cardinality

This attribute is a complex attribute which can describe MaxOccur or MinOccur.

7.3.2.4.3.2 Category

The category attribute describes the Port type. The value of this attribute is user-defined. Only ports with the same category value are allowed to be connected. Example: category = “MaterialFlow”

7.3.2.4.3.3 ConnectionPoint

This CAEX Interface allows connecting this Port with a number of other ports on an abstract level. The internal relations between single Port interfaces are not described in this way.

7.3.2.4.3.4 Direction

This attribute shall be used to describe the direction of the Port. Values shall be one of the following: “In” or “Out” or “InOut”. Ports with the direction “In” can only be connected to ports with the direction “Out” or “InOut” and ports with the direction “Out” can only be connected with ports with the direction “In” or “InOut”. Ports with the direction “InOut” can be connected to Ports of arbitrary direction. Examples: Direction =”Out” (e.g. a plug) Direction = “In” (e.g. a socket) Direction = “InOut” This information can be used e.g. in order to prove the validity of a connection.

7.3.2.5 Resource

7.3.2.5.1 General

The role class “Resource” is a basic abstract role type and the base class for all AML resource roles. It describes plants, equipment or other production resources. AML resource objects shall directly or indirectly reference this role.

7.3.2.5.2 ObjectType Definition

The Resource is formally defined in Table 47

Table 47 - Resource Definition

Attribute	Value
BrowseName	Resource
IsAbstract	False
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Inherit the components of the AutomationMLBaseRole

HasProperty	Variable	ID	BaseDataType	PropertyType	Optional
HasProperty	Variable	Version	BaseDataType	PropertyType	Optional

7.3.2.6 Product

7.3.2.6.1 General

The role class “Product” is a basic abstract role type and the base class for all AML product roles. It describes products, product parts or product related materials that are processed in the described plant. AML product objects shall directly or indirectly reference this role.

7.3.2.6.2 ObjectType Definition

The Product is formally defined in Table 48.

Table 48 - Product Definition

Attribute	Value
BrowseName	Product
IsAbstract	False
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Inherit the components of the AutomationMLBaseRole

HasProperty	Variable	ID	BaseDataType	PropertyType	Optional
HasProperty	Variable	Version	BaseDataType	PropertyType	Optional

7.3.2.7 Process

7.3.2.7.1 General

The role class “Process” is a basic abstract role type and the base class for all AML process roles. It describes production related processes. AML process objects shall directly or indirectly reference this role.

7.3.2.7.2 ObjectType Definition

The Process is formally defined in Table 49.

Table 49 - Process Definition

Attribute	Value
BrowseName	Process
IsAbstract	False
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Inherit the components of the AutomationMLBaseRole

HasProperty	Variable	ID	BaseDataType	PropertyType	Optional
HasProperty	Variable	Version	BaseDataType	PropertyType	Optional

7.3.2.8 Structure

7.3.2.8.1 General

The role class “Structure” is a basic abstract role type for objects that serve as structure elements in the plant hierarchy, e.g. a folder, a site or a manufacturing line. AML structure objects shall directly or indirectly reference this role.

7.3.2.8.2 ObjectType Definition

The Structure is formally defined in Table 50.

Table 50 - Structure Definition

Attribute	Value
BrowseName	Structure
IsAbstract	False
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Inherit the components of the AutomationMLBaseRole

HasProperty	Variable	ID	BaseDataType	PropertyType	Optional
HasProperty	Variable	Version	BaseDataType	PropertyType	Optional

7.3.2.9 ResourceStructure

7.3.2.9.1 General

The role class “ResourceStructure” is an abstract role type for a resource oriented object hierarchy. AML resource structure objects shall directly or indirectly reference this role

7.3.2.9.2 ObjectType Definition

The ResourceStructure is formally defined in Table 51.

Table 51 - ResourceStructure Definition

Attribute	Value
BrowseName	ResourceStructure
IsAbstract	False
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Inherit the components of the Structure

HasProperty	Variable	ID	BaseDataType	PropertyType	Optional
HasProperty	Variable	Version	BaseDataType	PropertyType	Optional

7.3.2.10 ProductStructure

7.3.2.10.1 General

The role class “ProductStructure” is an abstract role type for a product oriented object hierarchy. AML product structure objects shall directly or indirectly reference this role.

7.3.2.10.2 ObjectType Definition

The ProductStructure is formally defined in Table 52.

Table 52 - ProductStructure Definition

Attribute	Value
BrowseName	ProductStructure
IsAbstract	False
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Inherit the components of the Structure

HasProperty	Variable	ID	BaseDataType	PropertyType	Optional
HasProperty	Variable	Version	BaseDataType	PropertyType	Optional

7.3.2.11 ProcessStructure

7.3.2.11.1 General

The role class “ProcessStructure” is an abstract role type for a process oriented object hierarchy. AML process structure objects shall directly or indirectly reference this role.

7.3.2.11.2 ObjectType Definition

The ProcessStructure is formally defined in Table 53.

Table 53 - ProcessStructure Definition

Attribute	Value
BrowseName	ProcessStructure
IsAbstract	False
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Inherit the components of the Structure

HasProperty	Variable	ID	BaseDataType	PropertyType	Optional
HasProperty	Variable	Version	BaseDataType	PropertyType	Optional

7.3.2.12 Frame

7.3.2.12.1 General

The role class “Frame” denotes a distinct coordinate system. This coordinate system is explicitly accentuated for special usage.

7.3.2.12.2 ObjectType Definition

The Frame is formally defined in Table 54.

Table 54 - Frame Definition

Attribute	Value
BrowseName	Frame
IsAbstract	False
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Inherit the components of the AutomationMLBaseRole

HasProperty	Variable	ID	BaseDataType	PropertyType	Optional
HasProperty	Variable	Version	BaseDataType	PropertyType	Optional

7.3.2.13 ComponentGroup

7.3.2.13.1 General

The role class “ComponentGroup” is a role type for objects that group objects belonging to one component group according to the interlocking definition of AutomationML.

7.3.2.13.2 ObjectType Definition

The ComponentGroup is formally defined in Table 55.

Table 55 - ComponentGroup Definition

Attribute	Value
BrowseName	ComponentGroup
IsAbstract	False
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Inherit the components of the Group

HasProperty	Variable	ID	BaseDataType	PropertyType	Optional
HasProperty	Variable	Version	BaseDataType	PropertyType	Optional

7.3.2.14 SignalGroup

7.3.2.14.1 General

The role class “SignalGroup” is a role type for objects that group objects belonging to one signal group according to the interlocking definition of AutomationML.

7.3.2.14.2 ObjectType Definition

The SignalGroup is formally defined in Table 56.

Table 56 - SignalGroup Definition

Attribute	Value
BrowseName	SignalGroup
IsAbstract	False
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Inherit the components of the Group

HasProperty	Variable	ID	BaseDataType	PropertyType	Optional
HasProperty	Variable	Version	BaseDataType	PropertyType	Optional

7.3.2.15 PropertySet

7.3.2.15.1 General

The role class “PropertySet” is an abstract role type that serves for the definition of sets of properties corresponding to a certain engineering aspect. AML property set objects shall directly or indirectly reference this role.

7.3.2.15.2 ObjectType Definition

The PropertySet is formally defined in Table 57.

Table 57 - PropertySet Definition

Attribute	Value
BrowseName	PropertySet
IsAbstract	False
References	NodeClass	BrowseName	DataType	TypeDefinition	ModellingRule
Inherit the components of the AutomationMLBaseRole

HasProperty	Variable	ID	BaseDataType	PropertyType	Optional
HasProperty	Variable	Version	BaseDataType	PropertyType	Optional