Interface IReferable

An element that is referable by its IdShort.

Inherited Members

IHasExtensions.Extensions

IHasExtensions.OverExtensionsOrEmpty()

IClass.DescendOnce()

IClass.Descend()

IClass.Accept(Visitation.IVisitor)

IClass.Accept<TContext>(Visitation.IVisitorWithContext<TContext>, TContext)

IClass.Transform<T>(Visitation.ITransformer<T>)

IClass.Transform<TContext, T>(Visitation.ITransformerWithContext<TContext, T>, TContext)

Namespace: AasCore.Aas3_0_RC02

Assembly: AasCore.Aas3_0_RC02.dll

Syntax

public interface IReferable : IHasExtensions, IClass

Remarks

This ID is not globally unique. This ID is unique within the name space of the element.

Properties

Category

The category is a value that gives further meta information w.r.t. to the class of the element. It affects the expected existence of attributes and the applicability of constraints.

Declaration

string Category { get; set; }

Property Value

Type	Description
System.String

Remarks

The category is not identical to the semantic definition (IHasSemantics) of an element. The category e.g. could denote that the element is a measurement value whereas the semantic definition of the element would denote that it is the measured temperature.

Checksum

Checksum to be used to determine if an Referable (including its aggregated child elements) has changed.

Declaration

string Checksum { get; set; }

Property Value

Type	Description
System.String

Remarks

The checksum is calculated by the user's tool environment. The checksum has no semantic meaning for an asset administration shell model and there is no requirement for asset administration shell tools to manage the checksum

Description

Description or comments on the element.

Declaration

List<ILangString> Description { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ILangString>

Remarks

The description can be provided in several languages.

If no description is defined, then the definition of the concept description that defines the semantics of the element is used.

Additional information can be provided, e.g., if the element is qualified and which qualifier types can be expected in which context or which additional data specification templates are provided.

DisplayName

Display name. Can be provided in several languages.

Declaration

List<ILangString> DisplayName { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ILangString>

Remarks

If no display name is defined in the language requested by the application, then the display name is selected in the following order if available:

• the preferred name in the requested language of the concept description defining the semantics of the element
• If there is a default language list defined in the application, then the corresponding preferred name in the language is chosen according to this order.
• the English preferred name of the concept description defining the semantics of the element
• the short name of the concept description
• the IdShort of the element

IdShort

In case of identifiables this attribute is a short name of the element. In case of referable this ID is an identifying string of the element within its name space.

Declaration

string IdShort { get; set; }

Property Value

Type	Description
System.String

Remarks

In case the element is a property and the property has a semantic definition (SemanticId) conformant to IEC61360 the IdShort is typically identical to the short name in English.

Methods

OverDescriptionOrEmpty()

Iterate over Description, if set, and otherwise return an empty enumerable.

Declaration

IEnumerable<ILangString> OverDescriptionOrEmpty()

Returns

Type	Description
System.Collections.Generic.IEnumerable<ILangString>

OverDisplayNameOrEmpty()

Iterate over DisplayName, if set, and otherwise return an empty enumerable.

Declaration

IEnumerable<ILangString> OverDisplayNameOrEmpty()

Returns

Type	Description
System.Collections.Generic.IEnumerable<ILangString>