Class ConceptDescription

The semantics of a property or other elements that may have a semantic description is defined by a concept description.

Inheritance
System.Object
ConceptDescription
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: AasCore.Aas3_0_RC02
Assembly: AasCore.Aas3_0_RC02.dll
Syntax
public class ConceptDescription : IConceptDescription, IIdentifiable, IReferable, IHasExtensions, IHasDataSpecification, IClass
Remarks

The description of the concept should follow a standardized schema (realized as data specification template).

Constraints:

  • Constraint AASd-051: A ConceptDescription shall have one of the following categories VALUE, PROPERTY, REFERENCE, DOCUMENT, CAPABILITY, RELATIONSHIP, COLLECTION, FUNCTION, EVENT, ENTITY, APPLICATION_CLASS, QUALIFIER, VIEW.

    Default: PROPERTY.

  • Constraint AASc-004: For a ConceptDescription with Category PROPERTY or VALUE using data specification IEC61360, the DataType is mandatory and shall be one of: DATE, STRING, STRING_TRANSLATABLE, INTEGER_MEASURE, INTEGER_COUNT, INTEGER_CURRENCY, REAL_MEASURE, REAL_COUNT, REAL_CURRENCY, BOOLEAN, RATIONAL, RATIONAL_MEASURE, TIME, TIMESTAMP.
  • Constraint AASc-005: For a ConceptDescription with Category REFERENCE using data specification IEC61360, the DataType is mandatory and shall be one of: STRING, IRI, IRDI.
  • Constraint AASc-006: For a ConceptDescription with Category DOCUMENT using data specification IEC61360, the DataType is mandatory and shall be defined.
  • Constraint AASc-007: For a ConceptDescription with Category QUALIFIER_TYPE using data specification IEC61360, the DataType is mandatory and shall be
  • Constraint AASc-008: For all ConceptDescription's with a category except Category VALUE using data specification IEC61360, Definition is mandatory and shall be defined at least in English.
  • Constraint AASc-003: For a ConceptDescription with Category VALUE using data specification IEC61360, the Value shall be set.

Constructors

| Improve this Doc View Source

ConceptDescription(String, List<IExtension>, String, String, List<ILangString>, List<ILangString>, String, IAdministrativeInformation, List<IEmbeddedDataSpecification>, List<IReference>)

Declaration
public ConceptDescription(string id, List<IExtension> extensions = null, string category = null, string idShort = null, List<ILangString> displayName = null, List<ILangString> description = null, string checksum = null, IAdministrativeInformation administration = null, List<IEmbeddedDataSpecification> embeddedDataSpecifications = null, List<IReference> isCaseOf = null)
Parameters
Type Name Description
System.String id
System.Collections.Generic.List<IExtension> extensions
System.String category
System.String idShort
System.Collections.Generic.List<ILangString> displayName
System.Collections.Generic.List<ILangString> description
System.String checksum
IAdministrativeInformation administration
System.Collections.Generic.List<IEmbeddedDataSpecification> embeddedDataSpecifications
System.Collections.Generic.List<IReference> isCaseOf

Properties

| Improve this Doc View Source

Administration

Administrative information of an identifiable element.

Declaration
public IAdministrativeInformation Administration { get; set; }
Property Value
Type Description
IAdministrativeInformation
Remarks

Some of the administrative information like the version number might need to be part of the identification.

| Improve this Doc View Source

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

| Improve this Doc View Source

Checksum

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

Declaration
public 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

| Improve this Doc View Source

Description

Description or comments on the element.

Declaration
public 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.

| Improve this Doc View Source

DisplayName

Display name. Can be provided in several languages.

Declaration
public 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
| Improve this Doc View Source

EmbeddedDataSpecifications

Embedded data specification.

Declaration
public List<IEmbeddedDataSpecification> EmbeddedDataSpecifications { get; set; }
Property Value
Type Description
System.Collections.Generic.List<IEmbeddedDataSpecification>
| Improve this Doc View Source

Extensions

An extension of the element.

Declaration
public List<IExtension> Extensions { get; set; }
Property Value
Type Description
System.Collections.Generic.List<IExtension>
| Improve this Doc View Source

Id

The globally unique identification of the element.

Declaration
public string Id { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

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

| Improve this Doc View Source

IsCaseOf

Reference to an external definition the concept is compatible to or was derived from.

Declaration
public List<IReference> IsCaseOf { get; set; }
Property Value
Type Description
System.Collections.Generic.List<IReference>
Remarks

It is recommended to use a global reference.

Compare to is-case-of relationship in ISO 13584-32 & IEC EN 61360"

Methods

| Improve this Doc View Source

Accept(Visitation.IVisitor)

Accept the visitor to visit this instance for double dispatch.

Declaration
public void Accept(Visitation.IVisitor visitor)
Parameters
Type Name Description
Visitation.IVisitor visitor
| Improve this Doc View Source

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

Accept the visitor to visit this instance for double dispatch with the context.

Declaration
public void Accept<TContext>(Visitation.IVisitorWithContext<TContext> visitor, TContext context)
Parameters
Type Name Description
Visitation.IVisitorWithContext<TContext> visitor
TContext context
Type Parameters
Name Description
TContext
| Improve this Doc View Source

CategoryOrDefault()

Return the Category or the default value if it has not been set.

Declaration
public string CategoryOrDefault()
Returns
Type Description
System.String
| Improve this Doc View Source

Descend()

Iterate recursively over all the class instances referenced from this instance.

Declaration
public IEnumerable<IClass> Descend()
Returns
Type Description
System.Collections.Generic.IEnumerable<IClass>
| Improve this Doc View Source

DescendOnce()

Iterate over all the class instances referenced from this instance without further recursion.

Declaration
public IEnumerable<IClass> DescendOnce()
Returns
Type Description
System.Collections.Generic.IEnumerable<IClass>
| Improve this Doc View Source

OverDescriptionOrEmpty()

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

Declaration
public IEnumerable<ILangString> OverDescriptionOrEmpty()
Returns
Type Description
System.Collections.Generic.IEnumerable<ILangString>
| Improve this Doc View Source

OverDisplayNameOrEmpty()

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

Declaration
public IEnumerable<ILangString> OverDisplayNameOrEmpty()
Returns
Type Description
System.Collections.Generic.IEnumerable<ILangString>
| Improve this Doc View Source

OverEmbeddedDataSpecificationsOrEmpty()

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

Declaration
public IEnumerable<IEmbeddedDataSpecification> OverEmbeddedDataSpecificationsOrEmpty()
Returns
Type Description
System.Collections.Generic.IEnumerable<IEmbeddedDataSpecification>
| Improve this Doc View Source

OverExtensionsOrEmpty()

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

Declaration
public IEnumerable<IExtension> OverExtensionsOrEmpty()
Returns
Type Description
System.Collections.Generic.IEnumerable<IExtension>
| Improve this Doc View Source

OverIsCaseOfOrEmpty()

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

Declaration
public IEnumerable<IReference> OverIsCaseOfOrEmpty()
Returns
Type Description
System.Collections.Generic.IEnumerable<IReference>
| Improve this Doc View Source

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

Accept the transformer to transform this instance for double dispatch.

Declaration
public T Transform<T>(Visitation.ITransformer<T> transformer)
Parameters
Type Name Description
Visitation.ITransformer<T> transformer
Returns
Type Description
T
Type Parameters
Name Description
T
| Improve this Doc View Source

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

Accept the transformer to visit this instance for double dispatch with the context.

Declaration
public T Transform<TContext, T>(Visitation.ITransformerWithContext<TContext, T> transformer, TContext context)
Parameters
Type Name Description
Visitation.ITransformerWithContext<TContext, T> transformer
TContext context
Returns
Type Description
T
Type Parameters
Name Description
TContext
T

Implements