aas_core3_2.types
— WORK IN PROGRESS — Provide an implementation of the Asset Administration Shell (AAS) V3.2.
The presented version of the Metamodel is related to the work of aas-core-works, which can be found here: https://github.com/aas-core-works.
The presented content is neither related to the IDTA nor Plattform Industrie 4.0 and does not represent an official publication.
We diverge from the book in the following points.
We did not implement the following constraints as they are too general and can not be formalized as part of the core library, but affects external components such as AAS registry or AAS server:
We did not implement the following constraints since they depend on registry and
de-referencing of Reference objects:
Some constraints are not enforceable as they depend on the wider context such as language understanding, so we could not formalize them:
Constraint AASd-012: This constraint requires that the texts inside
Multi_language_propertyshall have the same meanings in the separate languages. This cannot be tested.
Furthermore, we diverge from the book in the following points regarding the enumerations. We have to implement subsets of enumerations as sets as common programming languages do not support inheritance of enumerations. The relationship between the properties and the sets is defined through invariants. This causes the following divergences:
We decided therefore to remove the enumeration
DataTypeDefRDFand keep onlyDataTypeDefXSDas enumeration. Otherwise, we would have to write redundant invariants all over the meta-model becauseDataTypeDefRDFis actually never used in any type definition.The enumeration
AASSubmodelElementsis used in two different contexts. One context is the definition of key types in a reference. Another context is the definition of element types in aSubmodelElementList.To avoid confusion, we introduce two separate enumerations for the separate contexts. Firstly, a set of
KeyTypes,constants.AAS_SUBMODEL_ELEMENTS_AS_KEYSto represent the first context (key type in a reference). Secondly, the enumerationAASSubmodelElementsis kept as designator forSubmodelElementList.type_value_list_element.The specification introduces several types of
Lang_string_set. These types differ between the allowed length of their text inside the singularLang_stringobjects. Since the native representation ofLang_string_setasListofLang_stringis required by specification, it is impossible to introduce separateLang_string_settypes. Therefore, the distinction is drawn here between theLang_stringtypes.DefinitionTypeIEC61360is represented as aListofLangStringDefinitionTypeIEC61360MultiLanguageNameTypeis represented as aListofLangStringNameTypePreferredNameTypeIEC61360is represented as aListofLangStringPreferredNameTypeIEC61360ShortNameTypeIEC61360is represented as aListofLangStringShortNameTypeIEC61360MultiLanguageTextTypeis represented as aListofLangStringTextTypeFurthermore, since
Lang_stringis not used anywhere, we rename it toAbstractLangString.
Concerning the data specifications, we embed them within
HasDataSpecification instead of referencing them via an external reference.
The working group decided to change the rules for serialization after the book was
published. The data specifications are critical in applications, but there is no
possibility to access them through a data channel as they are not part of
an environment.
- aas_core3_2.types.JsonArray
Represent a JSON-able value which is known to be an array
alias of
Sequence[Any]
- aas_core3_2.types.JsonObject
Represent a JSON-able value which is known to be an object
alias of
Mapping[str,Any]
- class aas_core3_2.types.Class[source]
Represent the most general class of the meta-model.
- abstract descend_once() Iterator[Class][source]
Iterate over all the instances referenced from this one.
- abstract descend() Iterator[Class][source]
Iterate recursively over all the instances referenced from this one.
- abstract accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.- Parameters
visitor¶ – to be dispatched
- abstract accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance withcontext.
- abstract transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.- Parameters
transformer¶ – to be dispatched
- Returns
transformed self
- abstract transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance withcontext.- Parameters
transformer¶ – to be dispatched
- Returns
transformed self
- class aas_core3_2.types.HasSemantics(semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None)[source]
Element that can have a semantic definition plus some supplemental semantic definitions.
- Constraint AASd-118
If there are ID
supplemental_semantic_idsdefined then there shall be also a main semantic IDsemantic_id.
- over_supplemental_semantic_ids_or_empty() Iterator[Reference][source]
Yield from
supplemental_semantic_idsif set.
- __init__(semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.Extension(name: str, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, value_type: Optional[DataTypeDefXSD] = None, value: Optional[str] = None, refers_to: Optional[List[Reference]] = None)[source]
Single extension of an element.
- value_type_or_default() DataTypeDefXSD[source]
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(name: str, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, value_type: Optional[DataTypeDefXSD] = None, value: Optional[str] = None, refers_to: Optional[List[Reference]] = None) None[source]
Initialize with the given values.
- name: str
Name of the extension.
- Constraint AASd-077
The name of an extension (Extension/name) within
HasExtensionsneeds to be unique.
- value_type: Optional[DataTypeDefXSD]
Data type of the
valueattribute of the extension.Default:
DataTypeDefXSD.STRING
- value: Optional[str]
Value of the extension
- class aas_core3_2.types.HasExtensions(extensions: Optional[List[Extension]] = None)[source]
Element that can be extended by proprietary extensions.
Note
Extensions are proprietary, i.e. they do not support global interoperability.
- over_extensions_or_empty() Iterator[Extension][source]
Yield from
extensionsif set.
- class aas_core3_2.types.Referable(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None)[source]
Element that is referable by its
id_short.This ID is not globally unique. This ID is unique within the name space of the element.
- Constraint AASd-022
id_shortof non-identifiable referables within the same name space shall be unique (case-sensitive).
- over_display_name_or_empty() Iterator[LangStringNameType][source]
Yield from
display_nameif set.
- over_description_or_empty() Iterator[LangStringTextType][source]
Yield from
descriptionif set.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None) None[source]
Initialize with the given values.
- id_short: Optional[str]
In case of identifiables, this attribute is a short name of the element. In case of a referable, this ID is an identifying string of the element within its name space.
Note
In case the element is a property and the property has a semantic definition (
HasSemantics.semantic_id) conformant to IEC61360 theid_shortis typically identical to the short name in English, if available.
- display_name: Optional[List[LangStringNameType]]
Display name. Can be provided in several languages.
- category: Optional[str]
The category is a value that gives further meta information w.r.t. the class of the element. It affects the expected existence of attributes and the applicability of constraints.
Note
The category is not identical to the semantic definition (
HasSemantics) of an element. The category could e.g. denote that the element is a measurement value, whereas the semantic definition of the element would denote that it is the measured temperature.Note
Deprecated.
- description: Optional[List[LangStringTextType]]
Description or comments on the element.
The description can be provided in several languages.
If no description is defined, 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.
- class aas_core3_2.types.Identifiable(id: str, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, administration: Optional[AdministrativeInformation] = None)[source]
An element that has a globally unique identifier.
- __init__(id: str, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, administration: Optional[AdministrativeInformation] = None) None[source]
Initialize with the given values.
- id: str
The globally unique identification of the element.
- administration: Optional[AdministrativeInformation]
Administrative information of an identifiable element.
Note
Some of the administrative information like the version number might need to be part of the identification.
- class aas_core3_2.types.ModellingKind(value)[source]
Enumeration for denoting whether an element is a template or an instance.
- TEMPLATE = 'Template'
Specification of the common features of a structured element in sufficient detail that such an instance can be instantiated using it
- INSTANCE = 'Instance'
Concrete, clearly identifiable element instance. Its creation and validation may be guided by a corresponding element template.
- class aas_core3_2.types.HasKind(kind: Optional[ModellingKind] = None)[source]
An element with a kind is an element that can either represent a template or an instance.
Default for an element is that it is representing an instance.
- kind_or_default() ModellingKind[source]
- __init__(kind: Optional[ModellingKind] = None) None[source]
Initialize with the given values.
- kind: Optional[ModellingKind]
Kind of the element: either template or instance.
Default:
ModellingKind.INSTANCE
- class aas_core3_2.types.HasDataSpecification(embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
Element that can be extended by using data specification templates.
A data specification template defines a named set of additional attributes an element may or shall have. The data specifications used are explicitly specified with their global ID.
- over_embedded_data_specifications_or_empty() Iterator[EmbeddedDataSpecification][source]
Yield from
embedded_data_specificationsif set.
- __init__(embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- embedded_data_specifications: Optional[List[EmbeddedDataSpecification]]
Embedded data specification.
- class aas_core3_2.types.AdministrativeInformation(embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, version: Optional[str] = None, revision: Optional[str] = None, creator: Optional[Reference] = None, created_at: Optional[str] = None, updated_at: Optional[str] = None, template_id: Optional[str] = None)[source]
Administrative metainformation for an element.
- Constraint AASd-005
If
versionis not specified,revisionshall also be unspecified. This means that a revision requires a version. If there is no version, there is no revision. Revision is optional.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, version: Optional[str] = None, revision: Optional[str] = None, creator: Optional[Reference] = None, created_at: Optional[str] = None, updated_at: Optional[str] = None, template_id: Optional[str] = None) None[source]
Initialize with the given values.
- version: Optional[str]
Version of the element.
- revision: Optional[str]
Revision of the element.
- created_at: Optional[str]
date of creation.
- updated_at: Optional[str]
date of update.
- template_id: Optional[str]
Identifier of the template that guided the creation of the element.
Note
So far,
template_idis only applicable forSubmodel’s, since template specifications are standardized for Submodels only.Note
In case of a submodel, the
template_idis the identifier of the submodel template that guided the creation of the submodelNote
The
template_idis not relevant for validation in Submodels. For validation theSubmodel.semantic_idshall be used.Note
Usage of
template_idis not restricted to submodel instances. So also the creation of submodel templates can be guided by another submodel template.
- class aas_core3_2.types.Qualifiable(qualifiers: Optional[List[Qualifier]] = None)[source]
A qualifiable element may be further qualified by one or more qualifiers.
- Constraint AASd-119
If any
Qualifier.kindvalue ofqualifiersis equal toQualifierKind.TEMPLATE_QUALIFIERand the qualified element inherits fromHasKindthen the qualified element shall be of kind Template (HasKind.kind=ModellingKind.TEMPLATE).Note
This constraint is checked at
Submodel.
- over_qualifiers_or_empty() Iterator[Qualifier][source]
Yield from
qualifiersif set.
- __init__(qualifiers: Optional[List[Qualifier]] = None) None[source]
Initialize with the given values.
- qualifiers: Optional[List[Qualifier]]
Additional qualification of a qualifiable element.
- Constraint AASd-021
Every qualifiable shall only have one qualifier with the same
Qualifier.type.
- class aas_core3_2.types.QualifierKind(value)[source]
Enumeration for kinds of qualifiers.
Note
This element is experimental and therefore may be subject to change or may be removed completely in future versions of the meta-model.
- VALUE_QUALIFIER = 'ValueQualifier'
qualifies the value of the element; the corresponding qualifier value can change over time.
Value qualifiers are only applicable to elements with kind
ModellingKind.INSTANCE.
- CONCEPT_QUALIFIER = 'ConceptQualifier'
qualifies the semantic definition (
HasSemantics.semantic_id) the element is referring to; the corresponding qualifier value is static.
- TEMPLATE_QUALIFIER = 'TemplateQualifier'
qualifies the elements within a specific submodel on concept level; the corresponding qualifier value is static.
Template qualifiers are only applicable to elements with kind
ModellingKind.TEMPLATE.
- class aas_core3_2.types.Qualifier(type: str, value_type: DataTypeDefXSD, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, kind: Optional[QualifierKind] = None, value: Optional[str] = None, value_id: Optional[Reference] = None)[source]
A qualifier is essentially a type-value-pair. Depending on the kind of qualifier, it makes additional statements:
w.r.t. the value of the qualified element,
w.r.t. the concept, i.e. semantic definition of the qualified element,
w.r.t. existence and other meta information of the qualified element type.
- Constraint AASd-006
If both the
valueand thevalue_idof aQualifierare present then thevalueneeds to be identical to the value of the referenced coded value invalue_id.- Constraint AASd-020
The value of
valueshall be consistent with the data type as defined invalue_type.
- kind_or_default() QualifierKind[source]
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(type: str, value_type: DataTypeDefXSD, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, kind: Optional[QualifierKind] = None, value: Optional[str] = None, value_id: Optional[Reference] = None) None[source]
Initialize with the given values.
- type: str
The qualifier type describes the type of qualifier that is applied to the element.
- value_type: DataTypeDefXSD
Data type of the qualifier value.
- kind: Optional[QualifierKind]
The qualifier kind describes the kind of qualifier that is applied to the element.
Default:
QualifierKind.CONCEPT_QUALIFIER
- value: Optional[str]
The qualifier value is the value of the qualifier.
- class aas_core3_2.types.AssetAdministrationShell(id: str, asset_information: AssetInformation, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, administration: Optional[AdministrativeInformation] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, derived_from: Optional[Reference] = None, submodels: Optional[List[Reference]] = None)[source]
An Asset Administration Shell.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(id: str, asset_information: AssetInformation, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, administration: Optional[AdministrativeInformation] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, derived_from: Optional[Reference] = None, submodels: Optional[List[Reference]] = None) None[source]
Initialize with the given values.
- derived_from: Optional[Reference]
The reference to the Asset Administration Shell, which the Asset Administration Shell was derived from.
- asset_information: AssetInformation
Meta information about the asset, the Asset Administration Shell is representing.
- submodels: Optional[List[Reference]]
References to submodels of the Asset Administration Shell.
A submodel is a description of an aspect of the asset, the Asset Administration Shell is representing.
The asset of an Asset Administration Shell is typically described by one or more submodels.
Temporarily, no submodel might be assigned to the Asset Administration Shell.
- class aas_core3_2.types.AssetInformation(asset_kind: AssetKind, global_asset_id: Optional[str] = None, specific_asset_ids: Optional[List[SpecificAssetID]] = None, asset_type: Optional[str] = None, default_thumbnail: Optional[Resource] = None)[source]
In
AssetInformationidentifying metadata of the asset that is represented by an Asset Administration Shell is defined.Several asset kinds are distinguished like for example type assets and instance assets.
The asset has a globally unique identifier, plus – if needed – additional domain-specific (proprietary) identifiers. However, to support the corner case of very first phase of life cycle where a stabilized/constant global asset identifier does not already exist, the corresponding attribute
global_asset_idis optional.- Constraint AASd-116
globalAssetId(case-insensitive) is a reserved key forSpecificAssetID.namewith the semantics as defined inhttps://admin-shell.io/aas/3/x/AssetInformation/globalAssetIdwherexis the minor version.Note
Constraint AASd-116 is important to enable a generic search across global and specific asset IDs (e.g. in IDTA-01002-3-0 discovery operations like GetAllAssetLinksById). In the future the constraint might become more strict in stating that the name
globalAssetIdshall not be used asSpecificAssetID.name.Note
The comparison against
globalAssetIdis ASCII case-insensitive.- Constraint AASd-131
For
AssetInformationeither theglobal_asset_idshall be defined or at least one item inspecific_asset_ids.
- over_specific_asset_ids_or_empty() Iterator[SpecificAssetID][source]
Yield from
specific_asset_idsif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(asset_kind: AssetKind, global_asset_id: Optional[str] = None, specific_asset_ids: Optional[List[SpecificAssetID]] = None, asset_type: Optional[str] = None, default_thumbnail: Optional[Resource] = None) None[source]
Initialize with the given values.
- asset_kind: AssetKind
Denotes whether the Asset is of kind
AssetKind.TYPE,AssetKind.INSTANCE,AssetKind.BATCH,AssetKind.ROLE, orAssetKind.NOT_APPLICABLE.
- global_asset_id: Optional[str]
Identifier of the asset, the Asset Administration Shell is representing.
This attribute is required as soon as the Asset Administration Shell is exchanged via partners in the life cycle of the asset. In a first phase of the life cycle, the asset might not yet have a global asset ID but already an internal identifier. The internal identifier would be modelled via
specific_asset_ids.
- specific_asset_ids: Optional[List[SpecificAssetID]]
Additional domain-specific, typically proprietary identifier for the asset like serial number, manufacturer part ID, customer part IDs, etc.
- asset_type: Optional[str]
In case
asset_kindis notAssetKind.NOT_APPLICABLEtheasset_typeis the asset ID of the type asset of the asset under consideration as identified byglobal_asset_id.Note
In case
asset_kindis “Instance” then theasset_typedenotes which “Type” the asset is of. But it is also possible to have anasset_typeof an asset of kind “Type”.
- class aas_core3_2.types.Resource(path: str, content_type: Optional[str] = None)[source]
Resource represents an address to a file (a locator). The value is a URI that can represent an absolute or relative path.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(path: str, content_type: Optional[str] = None) None[source]
Initialize with the given values.
- path: str
Path and name of the resource (with file extension).
The path can be absolute or relative.
- content_type: Optional[str]
Content type of the content of the file.
A single content type (MIME type) can have multiple file extensions associated with it.
- class aas_core3_2.types.AssetKind(value)[source]
Enumeration for denoting whether an asset is a type asset or an instance asset or a batch asset or is a role or whether this kind of classification is not applicable.
- TYPE = 'Type'
Type asset
- INSTANCE = 'Instance'
Instance asset
- BATCH = 'Batch'
Batch asset
- ROLE = 'Role'
Role asset
- NOT_APPLICABLE = 'NotApplicable'
None of the other asset kinds
- class aas_core3_2.types.SpecificAssetID(name: str, value: str, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, external_subject_id: Optional[Reference] = None)[source]
A specific asset ID describes a generic supplementary identifying attribute of the asset.
The specific asset ID is not necessarily globally unique.
- Constraint AASd-133
external_subject_idshall be an external reference, i.e.Reference.type=ReferenceTypes.EXTERNAL_REFERENCE.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(name: str, value: str, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, external_subject_id: Optional[Reference] = None) None[source]
Initialize with the given values.
- name: str
Name of the asset identifier.
- value: str
The value of the specific asset identifier with the corresponding name.
- class aas_core3_2.types.Submodel(id: str, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, administration: Optional[AdministrativeInformation] = None, kind: Optional[ModellingKind] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, submodel_elements: Optional[List[SubmodelElement]] = None)[source]
A submodel defines a specific aspect of the asset represented by the Asset Administration Shell.
A submodel is used to structure the digital representation and technical functionality of an Administration Shell into distinguishable parts. Each submodel refers to a well-defined domain or subject. Submodels can become standardized and, in turn, submodel templates.
- over_submodel_elements_or_empty() Iterator[SubmodelElement][source]
Yield from
submodel_elementsif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(id: str, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, administration: Optional[AdministrativeInformation] = None, kind: Optional[ModellingKind] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, submodel_elements: Optional[List[SubmodelElement]] = None) None[source]
Initialize with the given values.
- submodel_elements: Optional[List[SubmodelElement]]
Submodel elements contained in the submodel.
- class aas_core3_2.types.SubmodelElement(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
A submodel element is an element suitable for the description and differentiation of assets.
It is recommended to add a
HasSemantics.semantic_idto a submodel element.- Constraint AASd-129
If any
Qualifier.kindvalue ofqualifiers(attribute qualifier inherited via Qualifiable) is equal toQualifierKind.TEMPLATE_QUALIFIER, the submodel element shall be part of a submodel template, i.e. a submodel withSubmodel.kind(attribute kind inherited viaHasKind) value equal toModellingKind.TEMPLATE. Exception: the submodel element is part of anOperationVariable.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.RelationshipElement(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, first: Optional[Reference] = None, second: Optional[Reference] = None)[source]
A relationship element is used to define a relationship between two elements being either referable (model reference) or external (external reference).
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, first: Optional[Reference] = None, second: Optional[Reference] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.AASSubmodelElements(value)[source]
Enumeration of Submodel Element types including abstract Submodel Element types.
- ANNOTATED_RELATIONSHIP_ELEMENT = 'AnnotatedRelationshipElement'
- BASIC_EVENT_ELEMENT = 'BasicEventElement'
- BLOB = 'Blob'
- CAPABILITY = 'Capability'
- DATA_ELEMENT = 'DataElement'
Data element.
Note
Data Element is abstract, i.e. if a key uses
DATA_ELEMENTthe reference may be aProperty, aFileetc.
- ENTITY = 'Entity'
- EVENT_ELEMENT = 'EventElement'
Event.
Note
EventElementis abstract.
- FILE = 'File'
- MULTI_LANGUAGE_PROPERTY = 'MultiLanguageProperty'
Property with a value that can be provided in multiple languages
- OPERATION = 'Operation'
- PROPERTY = 'Property'
- RANGE = 'Range'
Range with min and max
- REFERENCE_ELEMENT = 'ReferenceElement'
Reference
- RELATIONSHIP_ELEMENT = 'RelationshipElement'
Relationship
- SUBMODEL_ELEMENT = 'SubmodelElement'
Submodel Element
Note
Submodel Element is abstract, i.e. if a key uses
SUBMODEL_ELEMENTthe reference may be aProperty, anOperationetc.
- SUBMODEL_ELEMENT_LIST = 'SubmodelElementList'
List of Submodel Elements
- SUBMODEL_ELEMENT_COLLECTION = 'SubmodelElementCollection'
Struct of Submodel Elements
- class aas_core3_2.types.SubmodelElementList(type_value_list_element: AASSubmodelElements, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, order_relevant: Optional[bool] = None, semantic_id_list_element: Optional[Reference] = None, value_type_list_element: Optional[DataTypeDefXSD] = None, value: Optional[List[SubmodelElement]] = None)[source]
A submodel element list is an ordered list of submodel elements.
Note
The list is ordered although the ordering might not be relevant (see
order_relevant).The numbering starts with zero (0).
- Constraint AASd-107
If a first level child element in a
SubmodelElementListhas aHasSemantics.semantic_idit shall be identical tosemantic_id_list_element.- Constraint AASd-114
If two first level child elements in a
SubmodelElementListhave aHasSemantics.semantic_idthen they shall be identical.- Constraint AASd-115
If a first level child element in a
SubmodelElementListdoes not specify aHasSemantics.semantic_idthen the value is assumed to be identical tosemantic_id_list_element.- Constraint AASd-108
All first level child elements in a
SubmodelElementListshall have the same submodel element type as specified intype_value_list_element.- Constraint AASd-109
If
type_value_list_elementis equal toAASSubmodelElements.PROPERTYorAASSubmodelElements.RANGEvalue_type_list_elementshall be set and all first level child elements in theSubmodelElementListshall have the value type as specified invalue_type_list_element.- Constraint AASd-138
A
SubmodelElementListwithin aSubmodelofHasKind.kind=ModellingKind.TEMPLATEor as part of anOperationVariableshall have exactly one element.
- over_value_or_empty() Iterator[SubmodelElement][source]
Yield from
valueif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(type_value_list_element: AASSubmodelElements, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, order_relevant: Optional[bool] = None, semantic_id_list_element: Optional[Reference] = None, value_type_list_element: Optional[DataTypeDefXSD] = None, value: Optional[List[SubmodelElement]] = None) None[source]
Initialize with the given values.
- type_value_list_element: AASSubmodelElements
The submodel element type of the submodel elements contained in the list.
- order_relevant: Optional[bool]
Defines whether order in list is relevant. If
order_relevant=Falsethen the list is representing a set or a bag.Default:
True
- semantic_id_list_element: Optional[Reference]
Semantic ID the submodel elements contained in the list match to.
- value_type_list_element: Optional[DataTypeDefXSD]
The value type of the submodel element contained in the list.
- value: Optional[List[SubmodelElement]]
Submodel element contained in the list.
- class aas_core3_2.types.SubmodelElementCollection(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, value: Optional[List[SubmodelElement]] = None)[source]
A submodel element collection is a kind of struct, i.e. a logical encapsulation of multiple named values.
- over_value_or_empty() Iterator[SubmodelElement][source]
Yield from
valueif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, value: Optional[List[SubmodelElement]] = None) None[source]
Initialize with the given values.
- value: Optional[List[SubmodelElement]]
Submodel element contained in the collection.
- class aas_core3_2.types.DataElement(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
A data element is a submodel element that is not further composed of other submodel elements.
A data element is a submodel element that has a value. The type of value differs for different subtypes of data elements.
Note
Categories are deprecated and should no longer be used.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.Property(value_type: DataTypeDefXSD, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, value: Optional[str] = None, value_id: Optional[Reference] = None)[source]
A property is a data element that has a single value.
- Constraint AASd-007
If both, the
valueand thevalue_idare present then the value ofvalueneeds to be identical to the value of the referenced coded value invalue_id.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(value_type: DataTypeDefXSD, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, value: Optional[str] = None, value_id: Optional[Reference] = None) None[source]
Initialize with the given values.
- value_type: DataTypeDefXSD
Data type of the
valueattribute.
- value: Optional[str]
The value of the property instance.
- class aas_core3_2.types.MultiLanguageProperty(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, value: Optional[List[LangStringTextType]] = None, value_id: Optional[Reference] = None)[source]
A property is a data element that has a multi-language value.
- Constraint AASd-012
If both the
valueand thevalue_idare present then for each string in a specific language the meaning must be the same as specified invalue_id.
- over_value_or_empty() Iterator[LangStringTextType][source]
Yield from
valueif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, value: Optional[List[LangStringTextType]] = None, value_id: Optional[Reference] = None) None[source]
Initialize with the given values.
- value: Optional[List[LangStringTextType]]
The value of the property instance.
- class aas_core3_2.types.Range(value_type: DataTypeDefXSD, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, min: Optional[str] = None, max: Optional[str] = None)[source]
A range data element is a data element that defines a range with min and max.
Note
This element is experimental and therefore may be subject to change or may be removed completely in future versions of the meta-model.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(value_type: DataTypeDefXSD, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, min: Optional[str] = None, max: Optional[str] = None) None[source]
Initialize with the given values.
- value_type: DataTypeDefXSD
- min: Optional[str]
The minimum value of the range.
- max: Optional[str]
The maximum value of the range.
- class aas_core3_2.types.ReferenceElement(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, value: Optional[Reference] = None)[source]
A reference element is a data element that defines a logical reference to another element within the same or another Asset Administration Shell or a reference to an external object or entity.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, value: Optional[Reference] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.Blob(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, value: Optional[bytes] = None, content_type: Optional[str] = None)[source]
A
Blobis a data element that represents a file that is contained in thevalueattribute with its source code.- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, value: Optional[bytes] = None, content_type: Optional[str] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.File(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, value: Optional[str] = None, content_type: Optional[str] = None)[source]
A file is a data element that represents an address to a file (a locator).
The value is a URI that can represent an absolute or relative path.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, value: Optional[str] = None, content_type: Optional[str] = None) None[source]
Initialize with the given values.
- content_type: Optional[str]
Content type of the content of the file.
- value: Optional[str]
Path and name of the file (with file extension).
The path can be absolute or relative.
- class aas_core3_2.types.AnnotatedRelationshipElement(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, first: Optional[Reference] = None, second: Optional[Reference] = None, annotations: Optional[List[DataElement]] = None)[source]
An annotated relationship element is a relationship element that can be annotated with additional data elements.
- over_annotations_or_empty() Iterator[DataElement][source]
Yield from
annotationsif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, first: Optional[Reference] = None, second: Optional[Reference] = None, annotations: Optional[List[DataElement]] = None) None[source]
Initialize with the given values.
- annotations: Optional[List[DataElement]]
A data element that represents an annotation that holds for the relationship between the two elements
- class aas_core3_2.types.Entity(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, statements: Optional[List[SubmodelElement]] = None, entity_type: Optional[EntityType] = None, global_asset_id: Optional[str] = None, specific_asset_ids: Optional[List[SpecificAssetID]] = None)[source]
An entity is a submodel element that is used to model entities.
- Constraint AASd-014
Either the attribute
global_asset_idorspecific_asset_idsof anEntitymust be set if Entity/entityType is set toEntityType.SELF_MANAGED_ENTITY.
- over_statements_or_empty() Iterator[SubmodelElement][source]
Yield from
statementsif set.
- over_specific_asset_ids_or_empty() Iterator[SpecificAssetID][source]
Yield from
specific_asset_idsif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, statements: Optional[List[SubmodelElement]] = None, entity_type: Optional[EntityType] = None, global_asset_id: Optional[str] = None, specific_asset_ids: Optional[List[SpecificAssetID]] = None) None[source]
Initialize with the given values.
- statements: Optional[List[SubmodelElement]]
Statement applicable to the entity, each statement described by a
SubmodelElement- typically with a qualified value.
- entity_type: Optional[EntityType]
Describes whether the entity is a co-managed entity or a self-managed entity.
- global_asset_id: Optional[str]
Global identifier of the asset the entity is representing.
- specific_asset_ids: Optional[List[SpecificAssetID]]
Reference to a specific asset ID representing a supplementary identifier of the asset represented by the Asset Administration Shell.
- class aas_core3_2.types.EntityType(value)[source]
Enumeration for denoting whether an entity is a self-managed entity or a co-managed entity.
- CO_MANAGED_ENTITY = 'CoManagedEntity'
There is no separate Asset Administration Shell for co-managed entities. Co-managed entities need to be part of a self-managed entity.
- SELF_MANAGED_ENTITY = 'SelfManagedEntity'
Self-managed entities have their own Asset Administration Shell but can be part of another composite self-managed entity.
The asset represented by an Asset Administration Shell is a self-managed entity per definition.
- class aas_core3_2.types.Direction(value)[source]
Note
This element is experimental and therefore may be subject to change or may be removed completely in future versions of the meta-model.
- INPUT = 'input'
Input direction
- OUTPUT = 'output'
Output direction
- class aas_core3_2.types.StateOfEvent(value)[source]
State of an event
Note
This element is experimental and therefore may be subject to change or may be removed completely in future versions of the meta-model.
- ON = 'on'
Event is on
- OFF = 'off'
Event is off
- class aas_core3_2.types.EventPayload(source: Reference, observable_reference: Reference, time_stamp: str, source_semantic_id: Optional[Reference] = None, observable_semantic_id: Optional[Reference] = None, topic: Optional[str] = None, subject_id: Optional[Reference] = None, payload: Optional[bytes] = None)[source]
Defines the necessary information of an event instance sent out or received.
Note
This element is experimental and therefore may be subject to change or may be removed completely in future versions of the meta-model.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(source: Reference, observable_reference: Reference, time_stamp: str, source_semantic_id: Optional[Reference] = None, observable_semantic_id: Optional[Reference] = None, topic: Optional[str] = None, subject_id: Optional[Reference] = None, payload: Optional[bytes] = None) None[source]
Initialize with the given values.
- time_stamp: str
Timestamp in UTC, when this event was triggered.
- source_semantic_id: Optional[Reference]
HasSemantics.semantic_idof the source event element, if availableNote
It is recommended to use an external reference.
- observable_semantic_id: Optional[Reference]
HasSemantics.semantic_idof the referable which defines the scope of the event, if available.Note
It is recommended to use an external reference.
- topic: Optional[str]
Information for the outer message infrastructure to schedule the event for the respective communication channel.
- subject_id: Optional[Reference]
Subject, who/which initiated the creation.
Note
This is an external reference.
- payload: Optional[bytes]
Event-specific payload.
- class aas_core3_2.types.EventElement(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
An event element.
Note
This element is experimental and therefore may be subject to change or may be removed completely in future versions of the meta-model.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.BasicEventElement(observed: Reference, direction: Direction, state: StateOfEvent, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, message_topic: Optional[str] = None, message_broker: Optional[Reference] = None, last_update: Optional[str] = None, min_interval: Optional[str] = None, max_interval: Optional[str] = None)[source]
A basic event element.
Note
This element is experimental and therefore may be subject to change or may be removed completely in future versions of the meta-model.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(observed: Reference, direction: Direction, state: StateOfEvent, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, message_topic: Optional[str] = None, message_broker: Optional[Reference] = None, last_update: Optional[str] = None, min_interval: Optional[str] = None, max_interval: Optional[str] = None) None[source]
Initialize with the given values.
- observed: Reference
Reference to a referable, e.g., a data element or a submodel, that is being observed.
- state: StateOfEvent
State of event.
Can be
{ On, Off }.
- message_topic: Optional[str]
Information for the outer message infrastructure to schedule the event for the respective communication channel.
- message_broker: Optional[Reference]
Information about which outer message infrastructure shall handle messages for the
EventElement. Refers to aSubmodel,SubmodelElementList,SubmodelElementCollectionorEntity, which containsDataElement’s describing the proprietary specification for the message broker.Note
This proprietary specification could be standardized by using respective
Submodel’s for different message infrastructure, e.g., OPC UA, MQTT or AMQP.
- last_update: Optional[str]
Timestamp in UTC, when the last event was received (input direction) or sent (output direction).
- min_interval: Optional[str]
For input direction reports on the maximum frequency, the software entity behind the respective
Referablecan handle input events.For output events, the maximum frequency of outputting this event to an outer infrastructure is specified.
Might be not specified, i.e. if there is no minimum interval.
- max_interval: Optional[str]
Not applicable for input direction.
For output direction: maximum interval in time, the respective
Referableshall send an update of the status of the event, even if no other trigger condition for the event was not met.Might not be specified, i.e. if there is no maximum interval.
- class aas_core3_2.types.Operation(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, input_variables: Optional[List[OperationVariable]] = None, output_variables: Optional[List[OperationVariable]] = None, inoutput_variables: Optional[List[OperationVariable]] = None)[source]
An operation is a submodel element with input and output variables.
- Constraint AASd-134
For an
OperationtheReferable.id_shortof allOperationVariable.value’s ininput_variables,output_variablesandinoutput_variablesshall be unique.
- over_input_variables_or_empty() Iterator[OperationVariable][source]
Yield from
input_variablesif set.
- over_output_variables_or_empty() Iterator[OperationVariable][source]
Yield from
output_variablesif set.
- over_inoutput_variables_or_empty() Iterator[OperationVariable][source]
Yield from
inoutput_variablesif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, input_variables: Optional[List[OperationVariable]] = None, output_variables: Optional[List[OperationVariable]] = None, inoutput_variables: Optional[List[OperationVariable]] = None) None[source]
Initialize with the given values.
- input_variables: Optional[List[OperationVariable]]
Input parameter of the operation.
- output_variables: Optional[List[OperationVariable]]
Output parameter of the operation.
- inoutput_variables: Optional[List[OperationVariable]]
Parameter that is input and output of the operation.
Note
In embedded systems inoutput variables are variables that can be read but that are also written by the system. Typically, this is implemented via a pointer (i.e. ‘by reference’ instead of ‘by value’).
- class aas_core3_2.types.OperationVariable(value: SubmodelElement)[source]
The value of an operation variable is a submodel element that is used as input and/or output variable of an operation.
Specification of operations in a
SubmodelwithHasKind.kind=ModellingKind.INSTANCEare handled identical to operations in Submodel templates (SubmodelwithHasKind.kind=ModellingKind.TEMPLATE).Note
An operation can be invoked via an API call (
InvokeOperationSyncandInvokeOperationAsync). For further explanation see Part 2 (IDTA-01002).Note
OperationVariableis introduced as a separate class to enable future extensions, e.g. for adding a default value or cardinality (optional/mandatory).- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(value: SubmodelElement) None[source]
Initialize with the given values.
- value: SubmodelElement
Describes an argument or result of an operation via a submodel element
- class aas_core3_2.types.Capability(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
A capability is the implementation-independent description of the potential of an asset to achieve a certain effect in the physical or virtual world.
Note
The
semantic_idof a capability is typically an ontology, which enables reasoning on capabilities. The mapping to one or more skills implementing the capability is done via a relationship element with the corresponding semantics. A skill is typically a property or an operation. In more complex cases, the mapping can also be a collection or a complete submodel.- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.ConceptDescription(id: str, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, administration: Optional[AdministrativeInformation] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, is_case_of: Optional[List[Reference]] = None)[source]
The semantics of a property or other elements that may have a semantic description is defined by a concept description.
The description of the concept should follow a standardized schema (realized as data specification template).
- Constraint AASc-3a-004
For a
ConceptDescriptionwithcategoryPROPERTYorVALUEusing data specification IEC61360, theDataSpecificationIEC61360.data_typeis 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.Note
Note: categories are deprecated since V3.0 of Part 1a of the document series “Details of the Asset Administration Shell”.
- Constraint AASc-3a-005
For a
ConceptDescriptionwithcategoryREFERENCEusing data specification template IEC61360, theDataSpecificationIEC61360.data_typeshall be one of:STRING,IRI,IRDI.Note
Note: categories are deprecated since V3.0 of Part 1a of the document series “Details of the Asset Administration Shell”.
- Constraint AASc-3a-006
For a
ConceptDescriptionwithcategoryDOCUMENTusing data specification IEC61360, theDataSpecificationIEC61360.data_typeshall be one ofFILE,BLOB,HTMLNote
Categories are deprecated since V3.0 of Part 1a of the document series “Details of the Asset Administration Shell”.
- Constraint AASc-3a-007
For a
ConceptDescriptionwithcategoryQUALIFIER_TYPEusing data specification IEC61360, theDataSpecificationIEC61360.data_typeis mandatory and shall be defined.Note
Categories are deprecated since V3.0 of Part 1a of the document series “Details of the Asset Administration Shell”.
- Constraint AASc-3a-008
For a
ConceptDescriptionusing data specification template IEC61360,DataSpecificationIEC61360.definitionis mandatory and shall be defined at least in English.Exception: The concept description describes a value, i.e.
DataSpecificationIEC61360.valueis defined.- Constraint AASc-3a-003
For a
ConceptDescriptionusing data specification template IEC61360, referenced viaDataSpecificationIEC61360.value_listValueReferencePair.value_idtheDataSpecificationIEC61360.valueshall be set.
- over_is_case_of_or_empty() Iterator[Reference][source]
Yield from
is_case_ofif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(id: str, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, administration: Optional[AdministrativeInformation] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, is_case_of: Optional[List[Reference]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.ReferenceTypes(value)[source]
Enumeration for denoting whether an element is an external or model reference.
- EXTERNAL_REFERENCE = 'ExternalReference'
External reference.
- MODEL_REFERENCE = 'ModelReference'
Model reference.
- class aas_core3_2.types.Reference(type: ReferenceTypes, keys: List[Key], referred_semantic_id: Optional[Reference] = None)[source]
Reference to either a model element of the same or another Asset Administration Shell or to an external entity.
A model reference is an ordered list of keys, each key referencing an element. The complete list of keys may for example be concatenated to a path that gives unique access to an element.
An external reference is a reference to an external entity.
- Constraint AASd-121
For
Reference’s the value ofKey.typeof the first key of ”keysshall be one ofconstants.GLOBALLY_IDENTIFIABLES.- Constraint AASd-122
For external references, i.e.
Reference’s withtype=ReferenceTypes.EXTERNAL_REFERENCE, the value ofKey.typeof the first key ofkeysshall be one ofconstants.GENERIC_GLOBALLY_IDENTIFIABLES.- Constraint AASd-123
For model references, i.e.
Reference’s withtype=ReferenceTypes.MODEL_REFERENCE, the value ofKey.typeof the first key ofkeysshall be one ofconstants.AAS_IDENTIFIABLES.- Constraint AASd-124
For external references, i.e.
Reference’s withtype=ReferenceTypes.EXTERNAL_REFERENCE, the last key ofkeysshall be either one ofconstants.GENERIC_GLOBALLY_IDENTIFIABLESor one ofconstants.GENERIC_FRAGMENT_KEYS.- Constraint AASd-137
For external references, i.e.
Reference’s withtype=ReferenceTypes.EXTERNAL_REFERENCE, the value ofKey.typeof any key inkeysshall not be one ofconstants.AAS_REFERABLES.- Constraint AASd-125
For model references, i.e.
Reference’s withtype=ReferenceTypes.MODEL_REFERENCE, with more than one key inkeysthe value ofKey.typeof each of the keys following the first key ofkeysshall be one ofconstants.FRAGMENT_KEYS.Note
Constraint AASd-125 ensures that the shortest path is used.
- Constraint AASd-126
For model references, i.e.
Reference’s withtype=ReferenceTypes.MODEL_REFERENCE, with more than one key inkeysthe value ofKey.typeof the last key in the reference key chain may be one ofconstants.GENERIC_FRAGMENT_KEYSor no key at all shall have a value out ofconstants.GENERIC_FRAGMENT_KEYS.- Constraint AASd-127
For model references, i.e.
Reference’s withtype=ReferenceTypes.MODEL_REFERENCE, with more than one key inkeysa key withKey.typeKeyTypes.FRAGMENT_REFERENCEshall be preceded by a key withKey.typeKeyTypes.FILEorKeyTypes.BLOB. All other AAS fragments, i.e.Key.typevalues out ofconstants.AAS_SUBMODEL_ELEMENTS_AS_KEYS, do not support fragments.Note
Which kind of fragments are supported depends on the content type and the specification of allowed fragment identifiers for the corresponding resource being referenced via the reference.
- Constraint AASd-128
For model references, i.e.
Reference’s withtype=ReferenceTypes.MODEL_REFERENCE, theKey.valueof aKeypreceded by aKeywithKey.type=KeyTypes.SUBMODEL_ELEMENT_LISTis an integer number denoting the position in the array of the submodel element list.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(type: ReferenceTypes, keys: List[Key], referred_semantic_id: Optional[Reference] = None) None[source]
Initialize with the given values.
- type: ReferenceTypes
Type of the reference.
Denotes whether the reference is an external reference or a model reference.
- referred_semantic_id: Optional[Reference]
Expected
HasSemantics.semantic_idof the referenced model element (type=ReferenceTypes.MODEL_REFERENCE); there typically is no semantic ID for the referenced object of external references (type=ReferenceTypes.EXTERNAL_REFERENCE).Note
If
referred_semantic_idis defined, theHasSemantics.semantic_idof the model element referenced should have a matching semantic ID. If this is not the case, a validator should raise a warning.
- class aas_core3_2.types.Key(type: KeyTypes, value: str)[source]
A key is a reference to an element by its ID.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- type: KeyTypes
Denotes which kind of entity is referenced.
If
type=KeyTypes.GLOBAL_REFERENCE, the key represents a reference to a source that can be globally identified.If
type=KeyTypes.FRAGMENT_REFERENCEthe key represents a bookmark or a similar local identifier within its parent element as specified by the key that precedes this key.In all other cases, the key references a model element of the same or another Asset Administration Shell. The name of the model element is explicitly listed.
- value: str
The key value, for example an IRDI or a URI or the ID-short or any other fragment value
- class aas_core3_2.types.KeyTypes(value)[source]
Enumeration of different key value types within a key.
- ANNOTATED_RELATIONSHIP_ELEMENT = 'AnnotatedRelationshipElement'
- ASSET_ADMINISTRATION_SHELL = 'AssetAdministrationShell'
- BASIC_EVENT_ELEMENT = 'BasicEventElement'
- BLOB = 'Blob'
- CAPABILITY = 'Capability'
- CONCEPT_DESCRIPTION = 'ConceptDescription'
- DATA_ELEMENT = 'DataElement'
Data element.
Note
Data elements are abstract, i.e. if a key uses
DATA_ELEMENTthe reference may be a property, file, etc.
- ENTITY = 'Entity'
- EVENT_ELEMENT = 'EventElement'
Event.
Note
EventElementis abstract.
- FILE = 'File'
- FRAGMENT_REFERENCE = 'FragmentReference'
Bookmark or a similar local identifier of a subordinate part of a primary resource
- GLOBAL_REFERENCE = 'GlobalReference'
- IDENTIFIABLE = 'Identifiable'
Identifiable.
Note
Identifiable is abstract, i.e. if a key uses “Identifiable” the reference may be an
AssetAdministrationShell, aSubmodelor aConceptDescription.
- MULTI_LANGUAGE_PROPERTY = 'MultiLanguageProperty'
Property with a value that can be provided in multiple languages
- OPERATION = 'Operation'
- PROPERTY = 'Property'
- RANGE = 'Range'
Range with min and max
- REFERABLE = 'Referable'
- REFERENCE_ELEMENT = 'ReferenceElement'
Reference
- RELATIONSHIP_ELEMENT = 'RelationshipElement'
Relationship
- SUBMODEL = 'Submodel'
- SUBMODEL_ELEMENT = 'SubmodelElement'
Submodel Element
Note
Submodel Element is abstract, i.e. if a key uses
SUBMODEL_ELEMENTthe reference may be aProperty, aSubmodelElementList, anOperationetc.
- SUBMODEL_ELEMENT_COLLECTION = 'SubmodelElementCollection'
Struct of
SubmodelElement’s
- SUBMODEL_ELEMENT_LIST = 'SubmodelElementList'
List of
SubmodelElement’s
- class aas_core3_2.types.DataTypeDefXSD(value)[source]
Enumeration listing selected XSD anySimpleTypes of XML Schema 1.0.
See: https://www.w3.org/TR/xmlschema-2/#built-in-primitive-datatypes
Note
RDF uses XML Schema Built-in data types from Version 1.1 but recommends to use only a subset of XSD data types. That is why they are excluded from the allowed data types in
DataTypeDefXSD.XSD BuildIn List types are not supported (
ENTITIES,IDREFSandNMTOKENS).XSD string BuildIn types are not supported (
normalizedString,token,language,NCName,ENTITY,ID,IDREF).The following XSD primitive types are not supported:
NOTATION,QName.
Note
Additionally, the following RDF types are not supported in
DataTypeDefXSD:HTMLandXMLLiteral.Note
Numeric data types in XML Schema are based on the definitions of IEEE 754 with slight adoptions. For instance,
FLOATandDOUBLEuse different exponent ranges. In any case, solely the XML Schema data type definitions are applicable for AAS values.- ANY_URI = 'xs:anyURI'
- BASE_64_BINARY = 'xs:base64Binary'
- BOOLEAN = 'xs:boolean'
- BYTE = 'xs:byte'
- DATE = 'xs:date'
- DATE_TIME = 'xs:dateTime'
- DECIMAL = 'xs:decimal'
- DOUBLE = 'xs:double'
- DURATION = 'xs:duration'
- FLOAT = 'xs:float'
- G_DAY = 'xs:gDay'
- G_MONTH = 'xs:gMonth'
- G_MONTH_DAY = 'xs:gMonthDay'
- G_YEAR = 'xs:gYear'
- G_YEAR_MONTH = 'xs:gYearMonth'
- HEX_BINARY = 'xs:hexBinary'
- INT = 'xs:int'
- INTEGER = 'xs:integer'
- LONG = 'xs:long'
- NEGATIVE_INTEGER = 'xs:negativeInteger'
- NON_NEGATIVE_INTEGER = 'xs:nonNegativeInteger'
- NON_POSITIVE_INTEGER = 'xs:nonPositiveInteger'
- POSITIVE_INTEGER = 'xs:positiveInteger'
- SHORT = 'xs:short'
- STRING = 'xs:string'
- TIME = 'xs:time'
- UNSIGNED_BYTE = 'xs:unsignedByte'
- UNSIGNED_INT = 'xs:unsignedInt'
- UNSIGNED_LONG = 'xs:unsignedLong'
- UNSIGNED_SHORT = 'xs:unsignedShort'
- class aas_core3_2.types.AbstractLangString(language: str, text: str)[source]
Strings with language tags
- language: str
Language tag conforming to BCP 47
- class aas_core3_2.types.LangStringNameType(language: str, text: str)[source]
String with length 128 maximum and minimum 1 characters and with language tags
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- class aas_core3_2.types.LangStringTextType(language: str, text: str)[source]
String with length 1023 maximum and minimum 1 characters and with language tags
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- class aas_core3_2.types.Environment(asset_administration_shells: Optional[List[AssetAdministrationShell]] = None, submodels: Optional[List[Submodel]] = None, concept_descriptions: Optional[List[ConceptDescription]] = None)[source]
Container for the sets of different identifiables.
Note
Environment is not an identifiable or referable element. It is introduced to enable file transfer as well as serialization.
- over_asset_administration_shells_or_empty() Iterator[AssetAdministrationShell][source]
Yield from
asset_administration_shellsif set.
- over_concept_descriptions_or_empty() Iterator[ConceptDescription][source]
Yield from
concept_descriptionsif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(asset_administration_shells: Optional[List[AssetAdministrationShell]] = None, submodels: Optional[List[Submodel]] = None, concept_descriptions: Optional[List[ConceptDescription]] = None) None[source]
Initialize with the given values.
- asset_administration_shells: Optional[List[AssetAdministrationShell]]
Asset Administration Shell
- concept_descriptions: Optional[List[ConceptDescription]]
Concept description
- class aas_core3_2.types.DataSpecificationContent[source]
Data specification content is part of a data specification template and defines which additional attributes shall be added to the element instance that references the data specification template and meta information about the template itself.
- Constraint AASc-3a-050
If the
DataSpecificationIEC61360is used for an element, the value ofHasDataSpecification.embedded_data_specificationsshall contain the global reference to the IRI of the corresponding data specification template https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIEC61360/3/0
- class aas_core3_2.types.EmbeddedDataSpecification(data_specification: Reference, data_specification_content: DataSpecificationContent)[source]
Embed the content of a data specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(data_specification: Reference, data_specification_content: DataSpecificationContent) None[source]
Initialize with the given values.
- data_specification_content: DataSpecificationContent
Actual content of the data specification
- class aas_core3_2.types.DataTypeIEC61360(value)[source]
An enumeration.
- DATE = 'DATE'
values containing a calendar date, conformant to ISO 8601:2004 Format yyyy-mm-dd Example from IEC 61360-1:2017: “1999-05-31” is the [DATE] representation of: “31 May 1999”.
- STRING = 'STRING'
values consisting of sequence of characters but cannot be translated into other languages
- STRING_TRANSLATABLE = 'STRING_TRANSLATABLE'
values containing string but shall be represented as different string in different languages
- INTEGER_MEASURE = 'INTEGER_MEASURE'
values containing values that are measure of type INTEGER. In addition such a value comes with a physical unit.
- INTEGER_COUNT = 'INTEGER_COUNT'
values containing values of type INTEGER but are no currencies or measures
- INTEGER_CURRENCY = 'INTEGER_CURRENCY'
values containing values of type INTEGER that are currencies
- REAL_MEASURE = 'REAL_MEASURE'
values containing values that are measures of type REAL. In addition such a value comes with a physical unit.
- REAL_COUNT = 'REAL_COUNT'
values containing numbers that can be written as a terminating or non-terminating decimal; a rational or irrational number but are no currencies or measures
- REAL_CURRENCY = 'REAL_CURRENCY'
values containing values of type REAL that are currencies
- BOOLEAN = 'BOOLEAN'
values representing truth of logic or Boolean algebra (TRUE, FALSE)
- IRI = 'IRI'
values containing values of type STRING conformant to Rfc 3987
Note
In IEC61360-1 (2017) only URI is supported. An IRI type allows in particular to express an URL or an URI.
- IRDI = 'IRDI'
values conforming to ISO/IEC 11179 series global identifier sequences
IRDI can be used instead of the more specific data types ICID or ISO29002_IRDI.
ICID values are value conformant to an IRDI, where the delimiter between RAI and ID is “#” while the delimiter between DI and VI is confined to “##”
ISO29002_IRDI values are values containing a global identifier that identifies an administrated item in a registry. The structure of this identifier complies with identifier syntax defined in ISO/TS 29002-5. The identifier shall fulfil the requirements specified in ISO/TS 29002-5 for an “international registration data identifier” (IRDI).
- RATIONAL = 'RATIONAL'
values containing values of type rational
- RATIONAL_MEASURE = 'RATIONAL_MEASURE'
values containing values of type rational. In addition such a value comes with a physical unit.
- TIME = 'TIME'
values containing a time, conformant to ISO 8601:2004 but restricted to what is allowed in the corresponding type in xml.
Format hh:mm (ECLASS)
Example from IEC 61360-1:2017: “13:20:00-05:00” is the [TIME] representation of: 1.20 p.m. for Eastern Standard Time, which is 5 hours behind Coordinated Universal Time (UTC).
- TIMESTAMP = 'TIMESTAMP'
values containing a time, conformant to ISO 8601:2004 but restricted to what is allowed in the corresponding type in xml.
Format yyyy-mm-dd hh:mm (ECLASS)
- FILE = 'FILE'
values containing an address to a file. The values are of type URI and can represent an absolute or relative path.
Note
IEC61360 does not support the file type.
- HTML = 'HTML'
Values containing string with any sequence of characters, using the syntax of HTML5 (see W3C Recommendation 28:2014)
- BLOB = 'BLOB'
values containing the content of a file. Values may be binaries.
HTML conformant to HTML5 is a special blob.
In IEC61360 binary is for a sequence of bits, each bit being represented by “0” and “1” only. A binary is a blob but a blob may also contain other source code.
- class aas_core3_2.types.LevelType(min: bool, nom: bool, typ: bool, max: bool)[source]
Value represented by up to four variants of a numeric value in a specific role:
MIN,NOM,TYPandMAX. True means that the value is available, false means the value is not available.EXAMPLE from [IEC61360-1]: In the case of having a property which is of the LEVEL_TYPE min/max − expressing a range − only those two values need to be provided.
Note
This is how AAS deals with the following combinations of level types:
Either all attributes are false. In this case the concept is mapped to a
Propertyand level type is ignored.At most one of the attributes is set to true. In this case the concept is mapped to a
Property.Min and max are set to true. In this case the concept is mapped to a
Range.More than one attribute is set to true but not min and max only (see second case). In this case the concept is mapped to a
SubmodelElementCollectionwith the corresponding number of Properties. Example: If attributeminandnomare set to true then the concept is mapped to aSubmodelElementCollectionwith two Properties within: min and nom. The data type of both Properties is the same.
Note
In the cases 2. and 4. the
Property.semantic_idof the Property or Properties within theSubmodelElementCollectionneeds to include information about the level type. Otherwise, the semantics is not described in a unique way. Please refer to the specification.- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(min: bool, nom: bool, typ: bool, max: bool) None[source]
Initialize with the given values.
- min: bool
Minimum of the value
- nom: bool
Nominal value (value as designated)
- typ: bool
Value as typically present
- max: bool
Maximum of the value
- class aas_core3_2.types.ValueReferencePair(value: str, value_id: Optional[Reference] = None)[source]
A value reference pair within a value list. Each value has a global unique id defining its semantic.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- class aas_core3_2.types.ValueList(value_reference_pairs: List[ValueReferencePair])[source]
A set of value reference pairs.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(value_reference_pairs: List[ValueReferencePair]) None[source]
Initialize with the given values.
- value_reference_pairs: List[ValueReferencePair]
A pair of a value together with its global unique id.
- class aas_core3_2.types.LangStringPreferredNameTypeIEC61360(language: str, text: str)[source]
String with length 255 maximum and minimum 1 characters and with language tags
Note
It is advised to keep the length of the name limited to 35 characters.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- class aas_core3_2.types.LangStringShortNameTypeIEC61360(language: str, text: str)[source]
String with length 18 maximum and minimum 1 characters and with language tags
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- class aas_core3_2.types.LangStringDefinitionTypeIEC61360(language: str, text: str)[source]
String with length 1023 maximum and minimum 1 characters and with language tags
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- class aas_core3_2.types.LangStringUom(language: str, text: str)[source]
String with length 256 maximum and minimum 1 characters and with language tags.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- class aas_core3_2.types.DefinitionTypeUom(language: str, text: str)[source]
String with length 2048 maximum and minimum 1 characters and with language tags.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- class aas_core3_2.types.DataSpecificationUom(preferred_name: List[LangStringUom], symbol: str, specific_unit_id: Optional[str] = None, definition: Optional[List[DefinitionTypeUom]] = None, preferred_name_quantity: Optional[List[LangStringUom]] = None, quantity_id: Optional[str] = None, classification_system: Optional[str] = None, classification_system_version: Optional[str] = None)[source]
Content of data specification template for concept descriptions for Units of Measurement.
- over_definition_or_empty() Iterator[DefinitionTypeUom][source]
Yield from
definitionif set.
- over_preferred_name_quantity_or_empty() Iterator[LangStringUom][source]
Yield from
preferred_name_quantityif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(preferred_name: List[LangStringUom], symbol: str, specific_unit_id: Optional[str] = None, definition: Optional[List[DefinitionTypeUom]] = None, preferred_name_quantity: Optional[List[LangStringUom]] = None, quantity_id: Optional[str] = None, classification_system: Optional[str] = None, classification_system_version: Optional[str] = None) None[source]
Initialize with the given values.
- preferred_name: List[LangStringUom]
Preferred name of the unit in different languages as defined by the classification system.
- symbol: str
Symbol of the unit.
- specific_unit_id: Optional[str]
ID of the unit defined by the classification system.
Note
This is relevant if the classification system references the unit differently from the concept description ID.
- definition: Optional[List[DefinitionTypeUom]]
Definition of the unit in different languages.
- preferred_name_quantity: Optional[List[LangStringUom]]
Preferred name of the unit’s quantity in different languages as defined by the classification system.
Note
preferred_name_quantityandquantity_idmust be consistent if both attributes are set.Note
If the classification system lists multiple quantities for the unit, exactly one of those quantities must be selected in accordance with the properties purpose.
- quantity_id: Optional[str]
ID of the unit’s quantity.
Note
preferred_name_quantityandquantity_idmust be consistent if both attributes are set.
- classification_system: Optional[str]
Name of the classification system used for the definition of units and quantities.
Note
The most prominent classification systems should be denoted as follows: “ECLASS”, “IEC CDD”, “UNECE Rec 20”, “UNECE Rec 21”, “BIPM”, “OPC UA”, “SAMM”.
This list is not exclusive.
- classification_system_version: Optional[str]
Version of the classification system used for the definition of units and quantities.
Note
The version shshould be denoted exactly as provided by the classification system.
- class aas_core3_2.types.DataSpecificationIEC61360(preferred_name: List[LangStringPreferredNameTypeIEC61360], short_name: Optional[List[LangStringShortNameTypeIEC61360]] = None, unit: Optional[str] = None, unit_id: Optional[Reference] = None, source_of_definition: Optional[str] = None, symbol: Optional[str] = None, data_type: Optional[DataTypeIEC61360] = None, definition: Optional[List[LangStringDefinitionTypeIEC61360]] = None, value_format: Optional[str] = None, value_list: Optional[ValueList] = None, value: Optional[str] = None, level_type: Optional[LevelType] = None)[source]
Content of data specification template for concept descriptions for properties, values and value lists conformant to IEC 61360.
Note
IEC61360 requires also a globally unique identifier for a concept description. This ID is not part of the data specification template. Instead the
ConceptDescription.idas inherited viaIdentifiableis used. Same holds for administrative information like the version and revision.Note
ConceptDescription.id_shortandshort_nameare very similar. However, in this case the decision was to addshort_nameexplicitly to the data specification. Same holds forConceptDescription.display_nameandpreferred_name. Same holds forConceptDescription.descriptionanddefinition.- Constraint AASc-3a-010
If
valueis not empty thenvalue_listshall be empty and vice versa.Note
It is also possible that both
valueandvalue_listare empty. This is the case for concept descriptions that define the semantics of a property but do not have an enumeration (value_list) as data type.Note
Although it is possible to define a
ConceptDescriptionfor a :attr:´value_list`, it is not possible to reuse thisvalue_list. It is only possible to directly add avalue_listas data type to a specific semantic definition of a property.- Constraint AASc-3a-009
If
data_typeone of:DataTypeIEC61360.INTEGER_MEASURE,DataTypeIEC61360.REAL_MEASURE,DataTypeIEC61360.RATIONAL_MEASURE,DataTypeIEC61360.INTEGER_CURRENCY,DataTypeIEC61360.REAL_CURRENCY, thenunitorunit_idshall be defined.
- over_short_name_or_empty() Iterator[LangStringShortNameTypeIEC61360][source]
Yield from
short_nameif set.
- over_definition_or_empty() Iterator[LangStringDefinitionTypeIEC61360][source]
Yield from
definitionif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(preferred_name: List[LangStringPreferredNameTypeIEC61360], short_name: Optional[List[LangStringShortNameTypeIEC61360]] = None, unit: Optional[str] = None, unit_id: Optional[Reference] = None, source_of_definition: Optional[str] = None, symbol: Optional[str] = None, data_type: Optional[DataTypeIEC61360] = None, definition: Optional[List[LangStringDefinitionTypeIEC61360]] = None, value_format: Optional[str] = None, value_list: Optional[ValueList] = None, value: Optional[str] = None, level_type: Optional[LevelType] = None) None[source]
Initialize with the given values.
- preferred_name: List[LangStringPreferredNameTypeIEC61360]
Preferred name
Note
It is advised to keep the length of the name limited to 35 characters.
- Constraint AASc-3a-002
preferred_nameshall be provided at least in English.
- short_name: Optional[List[LangStringShortNameTypeIEC61360]]
Short name
- unit: Optional[str]
Unit
- unit_id: Optional[Reference]
Unique unit id
unitandunit_idneed to be consistent if both attributes are setNote
It is recommended to use an external reference ID.
- source_of_definition: Optional[str]
Source of definition
- symbol: Optional[str]
Symbol
- data_type: Optional[DataTypeIEC61360]
Data Type
- definition: Optional[List[LangStringDefinitionTypeIEC61360]]
Definition in different languages
- value_format: Optional[str]
Value Format
Note
The value format is based on ISO 13584-42 and IEC 61360-2.
- value: Optional[str]
Value
- class aas_core3_2.types.SerializationFormat(value)[source]
Determines the format of serialization, for example JSON or XML.
The values are media types conformant to RFC 2046 and registered as described in RFC 6838 (IANA).
- JSON = 'application/json'
JSON serialization of the requested data object inside an AAS Environment structure
- XML = 'application/xml'
XML serialization of the requested data object inside an AAS Environment structure.
- AASX = 'application/aasx+xml'
AASX-Package (binary data) containing the requested data object
- class aas_core3_2.types.Descriptor(description: Optional[List[LangStringTextType]] = None, display_name: Optional[List[LangStringNameType]] = None, extensions: Optional[List[Extension]] = None)[source]
The self-describing information of a network resource.
This class is not part of the metamodel.
- over_description_or_empty() Iterator[LangStringTextType][source]
Yield from
descriptionif set.
- over_display_name_or_empty() Iterator[LangStringNameType][source]
Yield from
display_nameif set.
- over_extensions_or_empty() Iterator[Extension][source]
Yield from
extensionsif set.
- __init__(description: Optional[List[LangStringTextType]] = None, display_name: Optional[List[LangStringNameType]] = None, extensions: Optional[List[Extension]] = None) None[source]
Initialize with the given values.
- description: Optional[List[LangStringTextType]]
Description or comments on the element.
The description can be provided in several languages.
- display_name: Optional[List[LangStringNameType]]
Display name. Can be provided in several languages.
- class aas_core3_2.types.AssetAdministrationShellDescriptor(id: str, description: Optional[List[LangStringTextType]] = None, display_name: Optional[List[LangStringNameType]] = None, extensions: Optional[List[Extension]] = None, administration: Optional[AdministrativeInformation] = None, asset_kind: Optional[AssetKind] = None, asset_type: Optional[str] = None, endpoints: Optional[List[Endpoint]] = None, global_asset_id: Optional[str] = None, id_short: Optional[str] = None, specific_asset_ids: Optional[List[SpecificAssetID]] = None, submodel_descriptors: Optional[List[SubmodelDescriptor]] = None)[source]
Descriptor of an Asset Administration Shell.
- over_specific_asset_ids_or_empty() Iterator[SpecificAssetID][source]
Yield from
specific_asset_idsif set.
- over_submodel_descriptors_or_empty() Iterator[SubmodelDescriptor][source]
Yield from
submodel_descriptorsif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(id: str, description: Optional[List[LangStringTextType]] = None, display_name: Optional[List[LangStringNameType]] = None, extensions: Optional[List[Extension]] = None, administration: Optional[AdministrativeInformation] = None, asset_kind: Optional[AssetKind] = None, asset_type: Optional[str] = None, endpoints: Optional[List[Endpoint]] = None, global_asset_id: Optional[str] = None, id_short: Optional[str] = None, specific_asset_ids: Optional[List[SpecificAssetID]] = None, submodel_descriptors: Optional[List[SubmodelDescriptor]] = None) None[source]
Initialize with the given values.
- id: str
Globally unique identification of the Asset Administration Shell.
- administration: Optional[AdministrativeInformation]
Administrative information of the Asset Administration Shell.
- asset_kind: Optional[AssetKind]
Denotes whether the asset of the described Asset Administration Shell is of kind
AssetKind.TYPE,AssetKind.INSTANCE,AssetKind.ROLE, orAssetKind.NOT_APPLICABLE.
- asset_type: Optional[str]
The type of the asset described by the Asset Administration Shell of this descriptor.
See
AssetInformation.asset_typefor further information.
- endpoints: Optional[List[Endpoint]]
Endpoint of the network resource.
Note
The cardinality restriction for
endpointsallows a provider to skip the declaration of the location of an Asset Administration Shell and directly point to the endpoints of the contained submodels throughsubmodel_descriptors’SubmodelDescriptor.endpoints. A client, therefore, might decide to skip the lookup on the Asset Administration Shell. Nevertheless, in case the information contained in theAssetAdministrationShellDescriptordeviates from the relatedAssetAdministrationShell, or attributes are missing, theAssetAdministrationShellis always the source of truth.
- global_asset_id: Optional[str]
Global reference to the asset the Asset Administration Shell is representing.
- id_short: Optional[str]
Short name of the Asset Administration Shell.
- specific_asset_ids: Optional[List[SpecificAssetID]]
Specific asset identifier.
- submodel_descriptors: Optional[List[SubmodelDescriptor]]
Descriptor of a submodel of the Asset Administration Shell.
- class aas_core3_2.types.SubmodelDescriptor(endpoints: List[Endpoint], id: str, description: Optional[List[LangStringTextType]] = None, display_name: Optional[List[LangStringNameType]] = None, extensions: Optional[List[Extension]] = None, administration: Optional[AdministrativeInformation] = None, id_short: Optional[str] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None)[source]
A descriptor of a submodel.
- over_supplemental_semantic_ids_or_empty() Iterator[Reference][source]
Yield from
supplemental_semantic_idsif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(endpoints: List[Endpoint], id: str, description: Optional[List[LangStringTextType]] = None, display_name: Optional[List[LangStringNameType]] = None, extensions: Optional[List[Extension]] = None, administration: Optional[AdministrativeInformation] = None, id_short: Optional[str] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None) None[source]
Initialize with the given values.
- id: str
Globally unique identification of the Submodel.
- administration: Optional[AdministrativeInformation]
Administrative information of the Submodel.
- id_short: Optional[str]
Short name of the Submodel.
- class aas_core3_2.types.Endpoint(protocol_information: ProtocolInformation, interface: str)[source]
The endpoint description of a network resource.
This class is not part of the metamodel.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(protocol_information: ProtocolInformation, interface: str) None[source]
Initialize with the given values.
- protocol_information: ProtocolInformation
Protocol information of the network resource endpoint.
- interface: str
Name of the offered interface at the endpoint.
- class aas_core3_2.types.ProtocolInformation(href: str, endpoint_protocol: Optional[str] = None, endpoint_protocol_version: Optional[List[str]] = None, subprotocol: Optional[str] = None, subprotocol_body: Optional[str] = None, subprotocol_body_encoding: Optional[str] = None, security_attributes: Optional[List[SecurityAttributeObject]] = None)[source]
The protocol information of a network resource endpoint.
Note
The protocol information of a network resource endpoint is defined in DIN SPEC 16593-2. After the release of DIN SPEC 16593-2, any required updates will be made. This class is not part of the metamodel.
The information in this class is a 1:1 copy from DIN SPEC 16593-2. Required changes need to be made by the related DIN working group.
- over_endpoint_protocol_version_or_empty() Iterator[str][source]
Yield from
endpoint_protocol_versionif set.
- over_security_attributes_or_empty() Iterator[SecurityAttributeObject][source]
Yield from
security_attributesif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(href: str, endpoint_protocol: Optional[str] = None, endpoint_protocol_version: Optional[List[str]] = None, subprotocol: Optional[str] = None, subprotocol_body: Optional[str] = None, subprotocol_body_encoding: Optional[str] = None, security_attributes: Optional[List[SecurityAttributeObject]] = None) None[source]
Initialize with the given values.
- href: str
The endpoint address as a URL.
- endpoint_protocol: Optional[str]
Either scheme of
hrefor scheme plus further information.The scheme denotes the highest level of doubtless transmission.
- endpoint_protocol_version: Optional[List[str]]
Each entry represents one supported version at this very endpoint, the entry shall be formatted according to the regulations of the protocol specified in the
href
- subprotocol: Optional[str]
Allows for referencing sub-protocols that may be used in the context of that endpoint e.g. “OPC Basic SOAP” or UA Binary
- subprotocol_body: Optional[str]
If the sub-protocol field is present, a subprotocol body might be given to hold extra information, e.g. node and namespace in an OPC UA server
- subprotocol_body_encoding: Optional[str]
If
subprotocol_bodyis present, the encoding might be explicitly defined, otherwise it shall default to subprotocols encoding scheme
- security_attributes: Optional[List[SecurityAttributeObject]]
Array of
SecurityAttributeObject’s. Each attribute has three properties:SecurityAttributeObject.type: enum security type or standard:NONE;RFC_TLSA, TLSA according to RFC 6698; orW3C_DID, W3C DID document.
SecurityAttributeObject.key: security attribute key according to standard definitions of the security type.SecurityAttributeObject.value: security attribute value, e.g., DANE TLSA Resource Record.The
SecurityAttributeObject’s are treated as possible alternatives (logical “or”).
- class aas_core3_2.types.SecurityAttributeObject(type: SecurityTypeEnum, key: str, value: str)[source]
Security attributes as defined by DIN SPEC 16593-2. After the release of DIN SPEC 16593-2, any required updates will be made. This class is not part of the metamodel.
The information in this table is derived from DIN SPEC 16593-2. Required changes need to be made by the related DIN working group.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(type: SecurityTypeEnum, key: str, value: str) None[source]
Initialize with the given values.
- type: SecurityTypeEnum
Enum security type or standard.
- key: str
Security attribute key according to standard definitions of the security type.
- value: str
Security attribute value e.g. DANE TLSA Resource Record.
- class aas_core3_2.types.SecurityTypeEnum(value)[source]
The security types as defined by DIN SPEC 16593-2. After the release of DIN SPEC 16593-2, any required updates will be made. This class is not part of the metamodel.
The information in this table is derived from DIN SPEC 16593-2. Required changes need to be made by the related DIN working group.
- NO_SECURITY = 'NONE'
No predefined security type available.
- RFC_TLSA = 'RFC_TLSA'
TLSA according to RFC 6698.
- W3C_DID = 'W3C_DID'
Decentralized Identifiers according to the W3C Recommendation.
- class aas_core3_2.types.AssetLink(name: str, value: str)[source]
Asset identifier derived from either
SpecificAssetIDorAssetInformation.global_asset_id.This class is not part of the metamodel.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- name: str
Name of the Asset identifier, i.e.,
globalAssetId, a serial number, manufacturer part ID, or customer part IDs.
- value: str
Value of the Asset Identifier.
- class aas_core3_2.types.ServiceDescription(profiles: List[ServiceSpecificationProfileEnum])[source]
The self-describing information of an API Implementation. It enables servers to present their capabilities to the clients, in particular which profiles they implement. At least one defined profile is required. Additional, proprietary attributes might be included. Nevertheless, the server must not expect that a regular client understands them.
This class is not part of the metamodel.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(profiles: List[ServiceSpecificationProfileEnum]) None[source]
Initialize with the given values.
- profiles: List[ServiceSpecificationProfileEnum]
List of implemented server specification profiles.
- class aas_core3_2.types.ServiceSpecificationProfileEnum(value)[source]
The identifiers of the standardized service specification profiles. See also Clause Service Specifications and Profiles for further details.
This class is not part of the metamodel.
See also Clause Service Specifications and Profiles: https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.2/http-rest-api/service-specifications-and-profiles.html#service-specifications-and-profiles
- AAS_SERVICE_SPECIFICATION_SSP_001_V3_0 = 'https://admin-shell.io/aas/API/3/0/AssetAdministrationShellServiceSpecification/SSP-001'
Indicates that the server implemented all features of the Asset Administration Shell Service Specification Full Profile in version 3.0.
- AAS_SERVICE_SPECIFICATION_SSP_001_V3_1 = 'https://admin-shell.io/aas/API/3/1/AssetAdministrationShellServiceSpecification/SSP-001'
Indicates that the server implemented all features of the Asset Administration Shell Service Specification Full Profile in version 3.1.
- AAS_SERVICE_SPECIFICATION_SSP_001_V3_2 = 'https://admin-shell.io/aas/API/3/2/AssetAdministrationShellServiceSpecification/SSP-001'
Indicates that the server implemented all features of the Asset Administration Shell Service Specification Full Profile in version 3.2.
- AAS_SERVICE_SPECIFICATION_SSP_002_V3_0 = 'https://admin-shell.io/aas/API/3/0/AssetAdministrationShellServiceSpecification/SSP-002'
Indicates that the server implemented all features of the Asset Administration Shell Service Specification Read Profile in version 3.0.
- AAS_SERVICE_SPECIFICATION_SSP_002_V3_1 = 'https://admin-shell.io/aas/API/3/1/AssetAdministrationShellServiceSpecification/SSP-002'
Indicates that the server implemented all features of the Asset Administration Shell Service Specification Read Profile in version 3.1.
- AAS_SERVICE_SPECIFICATION_SSP_002_V3_2 = 'https://admin-shell.io/aas/API/3/2/AssetAdministrationShellServiceSpecification/SSP-002'
Indicates that the server implemented all features of the Asset Administration Shell Service Specification Read Profile in version 3.2.
- SUBMODEL_SERVICE_SPECIFICATION_SSP_001_V3_0 = 'https://admin-shell.io/aas/API/3/0/SubmodelServiceSpecification/SSP-001'
Indicates that the server implemented all features of the Submodel Service Specification Full Profile in version 3.0.
- SUBMODEL_SERVICE_SPECIFICATION_SSP_001_V3_1 = 'https://admin-shell.io/aas/API/3/1/SubmodelServiceSpecification/SSP-001'
Indicates that the server implemented all features of the Submodel Service Specification Full Profile in version 3.1.
- SUBMODEL_SERVICE_SPECIFICATION_SSP_001_V3_2 = 'https://admin-shell.io/aas/API/3/2/SubmodelServiceSpecification/SSP-001'
Indicates that the server implemented all features of the Submodel Service Specification Full Profile in version 3.2.
- SUBMODEL_SERVICE_SPECIFICATION_SSP_002_V3_0 = 'https://admin-shell.io/aas/API/3/0/SubmodelServiceSpecification/SSP-002'
Indicates that the server implemented all features of the Submodel Service Specification Value Profile in version 3.0.
- SUBMODEL_SERVICE_SPECIFICATION_SSP_002_V3_1 = 'https://admin-shell.io/aas/API/3/1/SubmodelServiceSpecification/SSP-002'
Indicates that the server implemented all features of the Submodel Service Specification Value Profile in version 3.1.
- SUBMODEL_SERVICE_SPECIFICATION_SSP_002_V3_2 = 'https://admin-shell.io/aas/API/3/2/SubmodelServiceSpecification/SSP-002'
Indicates that the server implemented all features of the Submodel Service Specification Value Profile in version 3.2.
- SUBMODEL_SERVICE_SPECIFICATION_SSP_003_V3_0 = 'https://admin-shell.io/aas/API/3/0/SubmodelServiceSpecification/SSP-003'
Indicates that the server implemented all features of the Submodel Service Specification Read Profile in version 3.0.
- SUBMODEL_SERVICE_SPECIFICATION_SSP_003_V3_1 = 'https://admin-shell.io/aas/API/3/1/SubmodelServiceSpecification/SSP-003'
Indicates that the server implemented all features of the Submodel Service Specification Read Profile in version 3.1.
- SUBMODEL_SERVICE_SPECIFICATION_SSP_003_V3_2 = 'https://admin-shell.io/aas/API/3/2/SubmodelServiceSpecification/SSP-003'
Indicates that the server implemented all features of the Submodel Service Specification Read Profile in version 3.2.
- AASX_FILE_SERVER_SERVICE_SPECIFICATION_SSP_001_V3_0 = 'https://admin-shell.io/aas/API/3/0/AasxFileServerServiceSpecification/SSP-001'
Indicates that the server implemented all details of the AASX File Server Service Specification Full Profile in version 3.0.
- AASX_FILE_SERVER_SERVICE_SPECIFICATION_SSP_001_V3_1 = 'https://admin-shell.io/aas/API/3/1/AasxFileServerServiceSpecification/SSP-001'
Indicates that the server implemented all details of the AASX File Server Service Specification Full Profile in version 3.1.
- AASX_FILE_SERVER_SERVICE_SPECIFICATION_SSP_001_V3_2 = 'https://admin-shell.io/aas/API/3/2/AasxFileServerServiceSpecification/SSP-001'
Indicates that the server implemented all details of the AASX File Server Service Specification Full Profile in version 3.2.
- AASX_FILE_SERVER_SERVICE_SPECIFICATION_SSP_002_V3_1 = 'https://admin-shell.io/aas/API/3/1/AasxFileServerServiceSpecification/SSP-002'
Indicates that the server implemented all details of the AASX File Server Service Specification Read Profile in version 3.1.
- AASX_FILE_SERVER_SERVICE_SPECIFICATION_SSP_002_V3_2 = 'https://admin-shell.io/aas/API/3/2/AasxFileServerServiceSpecification/SSP-002'
Indicates that the server implemented all details of the AASX File Server Service Specification Read Profile in version 3.2.
- AAS_REGISTRY_SERVICE_SPECIFICATION_SSP_001_V3_0 = 'https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-001'
Indicates that the server implemented all details of the Asset Administration Shell Registry Service Specification Full Profile in version 3.0.
- AAS_REGISTRY_SERVICE_SPECIFICATION_SSP_001_V3_1 = 'https://admin-shell.io/aas/API/3/1/AssetAdministrationShellRegistryServiceSpecification/SSP-001'
Indicates that the server implemented all details of the Asset Administration Shell Registry Service Specification Full Profile in version 3.1.
- AAS_REGISTRY_SERVICE_SPECIFICATION_SSP_001_V3_2 = 'https://admin-shell.io/aas/API/3/2/AssetAdministrationShellRegistryServiceSpecification/SSP-001'
Indicates that the server implemented all details of the Asset Administration Shell Registry Service Specification Full Profile in version 3.2.
- AAS_REGISTRY_SERVICE_SPECIFICATION_SSP_002_V3_0 = 'https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-002'
Indicates that the server implemented all details of the Asset Administration Shell Registry Service Specification Read Profile in version 3.0.
- AAS_REGISTRY_SERVICE_SPECIFICATION_SSP_002_V3_1 = 'https://admin-shell.io/aas/API/3/1/AssetAdministrationShellRegistryServiceSpecification/SSP-002'
Indicates that the server implemented all details of the Asset Administration Shell Registry Service Specification Read Profile in version 3.1.
- AAS_REGISTRY_SERVICE_SPECIFICATION_SSP_002_V3_2 = 'https://admin-shell.io/aas/API/3/2/AssetAdministrationShellRegistryServiceSpecification/SSP-002'
Indicates that the server implemented all details of the Asset Administration Shell Registry Service Specification Read Profile in version 3.2.
- AAS_REGISTRY_SERVICE_SPECIFICATION_SSP_003_V3_1 = 'https://admin-shell.io/aas/API/3/1/AssetAdministrationShellRegistryServiceSpecification/SSP-003'
Indicates that the server implemented all details of the Asset Administration Shell Registry Service Specification Bulk Profile in version 3.1.
- AAS_REGISTRY_SERVICE_SPECIFICATION_SSP_003_V3_2 = 'https://admin-shell.io/aas/API/3/2/AssetAdministrationShellRegistryServiceSpecification/SSP-003'
Indicates that the server implemented all details of the Asset Administration Shell Registry Service Specification Bulk Profile in version 3.2.
- AAS_REGISTRY_SERVICE_SPECIFICATION_SSP_004_V3_1 = 'https://admin-shell.io/aas/API/3/1/AssetAdministrationShellRegistryServiceSpecification/SSP-004'
Indicates that the server implemented all details of the Asset Administration Shell Registry Service Specification Query Profile in version 3.1.
- AAS_REGISTRY_SERVICE_SPECIFICATION_SSP_004_V3_2 = 'https://admin-shell.io/aas/API/3/2/AssetAdministrationShellRegistryServiceSpecification/SSP-004'
Indicates that the server implemented all details of the Asset Administration Shell Registry Service Specification Query Profile in version 3.2.
- AAS_REGISTRY_SERVICE_SPECIFICATION_SSP_005_V3_1 = 'https://admin-shell.io/aas/API/3/1/AssetAdministrationShellRegistryServiceSpecification/SSP-005'
Indicates that the server implemented all details of the Asset Administration Shell Registry Service Specification Minimal Read Profile in version 3.1.
- AAS_REGISTRY_SERVICE_SPECIFICATION_SSP_005_V3_2 = 'https://admin-shell.io/aas/API/3/2/AssetAdministrationShellRegistryServiceSpecification/SSP-005'
Indicates that the server implemented all details of the Asset Administration Shell Registry Service Specification Minimal Read Profile in version 3.2.
- SUBMODEL_REGISTRY_SERVICE_SPECIFICATION_SSP_001_V3_0 = 'https://admin-shell.io/aas/API/3/0/SubmodelRegistryServiceSpecification/SSP-001'
Indicates that the server implemented all details of the Submodel Registry Service Specification Full Profile in version 3.0.
- SUBMODEL_REGISTRY_SERVICE_SPECIFICATION_SSP_001_V3_1 = 'https://admin-shell.io/aas/API/3/1/SubmodelRegistryServiceSpecification/SSP-001'
Indicates that the server implemented all details of the Submodel Registry Service Specification Full Profile in version 3.1.
- SUBMODEL_REGISTRY_SERVICE_SPECIFICATION_SSP_001_V3_2 = 'https://admin-shell.io/aas/API/3/2/SubmodelRegistryServiceSpecification/SSP-001'
Indicates that the server implemented all details of the Submodel Registry Service Specification Full Profile in version 3.2.
- SUBMODEL_REGISTRY_SERVICE_SPECIFICATION_SSP_002_V3_0 = 'https://admin-shell.io/aas/API/3/0/SubmodelRegistryServiceSpecification/SSP-002'
Indicates that the server implemented all details of the Submodel Registry Service Specification Read Profile in version 3.0.
- SUBMODEL_REGISTRY_SERVICE_SPECIFICATION_SSP_002_V3_1 = 'https://admin-shell.io/aas/API/3/1/SubmodelRegistryServiceSpecification/SSP-002'
Indicates that the server implemented all details of the Submodel Registry Service Specification Read Profile in version 3.1.
- SUBMODEL_REGISTRY_SERVICE_SPECIFICATION_SSP_002_V3_2 = 'https://admin-shell.io/aas/API/3/2/SubmodelRegistryServiceSpecification/SSP-002'
Indicates that the server implemented all details of the Submodel Registry Service Specification Read Profile in version 3.2.
- SUBMODEL_REGISTRY_SERVICE_SPECIFICATION_SSP_003_V3_1 = 'https://admin-shell.io/aas/API/3/1/SubmodelRegistryServiceSpecification/SSP-003'
Indicates that the server implemented all details of the Submodel Registry Service Specification Bulk Profile in version 3.1.
- SUBMODEL_REGISTRY_SERVICE_SPECIFICATION_SSP_003_V3_2 = 'https://admin-shell.io/aas/API/3/2/SubmodelRegistryServiceSpecification/SSP-003'
Indicates that the server implemented all details of the Submodel Registry Service Specification Bulk Profile in version 3.2.
- SUBMODEL_REGISTRY_SERVICE_SPECIFICATION_SSP_004_V3_1 = 'https://admin-shell.io/aas/API/3/1/SubmodelRegistryServiceSpecification/SSP-004'
Indicates that the server implemented all details of the Submodel Registry Service Specification Query Profile in version 3.1.
- SUBMODEL_REGISTRY_SERVICE_SPECIFICATION_SSP_004_V3_2 = 'https://admin-shell.io/aas/API/3/2/SubmodelRegistryServiceSpecification/SSP-004'
Indicates that the server implemented all details of the Submodel Registry Service Specification Query Profile in version 3.2.
- DISCOVERY_SERVICE_SPECIFICATION_SSP_001_V3_0 = 'https://admin-shell.io/aas/API/3/0/DiscoveryServiceSpecification/SSP-001'
Indicates that the server implemented all details of the Discovery Service Specification Full Profile in version 3.0.
- DISCOVERY_SERVICE_SPECIFICATION_SSP_001_V3_1 = 'https://admin-shell.io/aas/API/3/1/DiscoveryServiceSpecification/SSP-001'
Indicates that the server implemented all details of the Discovery Service Specification Full Profile in version 3.1.
- DISCOVERY_SERVICE_SPECIFICATION_SSP_001_V3_2 = 'https://admin-shell.io/aas/API/3/2/DiscoveryServiceSpecification/SSP-001'
Indicates that the server implemented all details of the Discovery Service Specification Full Profile in version 3.2.
- DISCOVERY_SERVICE_SPECIFICATION_SSP_002_V3_2 = 'https://admin-shell.io/aas/API/3/2/DiscoveryServiceSpecification/SSP-002'
Indicates that the server implemented all details of the Discovery Service Specification Read Profile in version 3.1.
- AAS_REPOSITORY_SERVICE_SPECIFICATION_SSP_001_V3_0 = 'https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRepositoryServiceSpecification/SSP-001'
Indicates that the server implemented all details of the Asset Administration Shell Repository Service Specification Full Profile in version 3.0.
- AAS_REPOSITORY_SERVICE_SPECIFICATION_SSP_001_V3_1 = 'https://admin-shell.io/aas/API/3/1/AssetAdministrationShellRepositoryServiceSpecification/SSP-001'
Indicates that the server implemented all details of the Asset Administration Shell Repository Service Specification Full Profile in version 3.1.
- AAS_REPOSITORY_SERVICE_SPECIFICATION_SSP_001_V3_2 = 'https://admin-shell.io/aas/API/3/2/AssetAdministrationShellRepositoryServiceSpecification/SSP-001'
Indicates that the server implemented all details of the Asset Administration Shell Repository Service Specification Read Profile in version 3.2.
- AAS_REPOSITORY_SERVICE_SPECIFICATION_SSP_002_V3_0 = 'https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRepositoryServiceSpecification/SSP-002'
Indicates that the server implemented all details of the Asset Administration Shell Repository Service Specification Read Profile in version 3.0.
- AAS_REPOSITORY_SERVICE_SPECIFICATION_SSP_002_V3_1 = 'https://admin-shell.io/aas/API/3/1/AssetAdministrationShellRepositoryServiceSpecification/SSP-002'
Indicates that the server implemented all details of the Asset Administration Shell Repository Service Specification Read Profile in version 3.1.
- AAS_REPOSITORY_SERVICE_SPECIFICATION_SSP_002_V3_2 = 'https://admin-shell.io/aas/API/3/2/AssetAdministrationShellRepositoryServiceSpecification/SSP-002'
Indicates that the server implemented all details of the Asset Administration Shell Repository Service Specification Read Profile in version 3.2.
- AAS_REPOSITORY_SERVICE_SPECIFICATION_SSP_003_V3_1 = 'https://admin-shell.io/aas/API/3/1/AssetAdministrationShellRepositoryServiceSpecification/SSP-003'
Indicates that the server implemented all details of the Asset Administration Shell Repository Service Specification Query Profile in version 3.1.
- AAS_REPOSITORY_SERVICE_SPECIFICATION_SSP_003_V3_2 = 'https://admin-shell.io/aas/API/3/2/AssetAdministrationShellRepositoryServiceSpecification/SSP-003'
Indicates that the server implemented all details of the Asset Administration Shell Repository Service Specification Query Profile in version 3.2.
- AAS_REPOSITORY_SERVICE_SPECIFICATION_SSP_004_V3_2 = 'https://admin-shell.io/aas/API/3/2/AssetAdministrationShellRepositoryServiceSpecification/SSP-004'
Indicates that the server implemented all details of the Asset Administration Shell Repository Service Specification Signature Profile in version 3.2.
- AAS_REPOSITORY_SERVICE_SPECIFICATION_SSP_005_V3_2 = 'https://admin-shell.io/aas/API/3/2/AssetAdministrationShellRepositoryServiceSpecification/SSP-005'
Indicates that the server implemented all details of the Asset Administration Shell Repository Service Specification Identifiable Profile in version 3.2.
- SUBMODEL_REPOSITORY_SERVICE_SPECIFICATION_SSP_001_V3_0 = 'https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-001'
Indicates that the server implemented all details of the Submodel Service Repository Specification Full Profile in version 3.0.
- SUBMODEL_REPOSITORY_SERVICE_SPECIFICATION_SSP_001_V3_1 = 'https://admin-shell.io/aas/API/3/1/SubmodelRepositoryServiceSpecification/SSP-001'
Indicates that the server implemented all details of the Submodel Service Repository Specification Full Profile in version 3.1.
- SUBMODEL_REPOSITORY_SERVICE_SPECIFICATION_SSP_001_V3_2 = 'https://admin-shell.io/aas/API/3/2/SubmodelRepositoryServiceSpecification/SSP-001'
Indicates that the server implemented all details of the Submodel Service Repository Specification Full Profile in version 3.2.
- SUBMODEL_REPOSITORY_SERVICE_SPECIFICATION_SSP_002_V3_0 = 'https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-002'
Indicates that the server implemented all details of the Submodel Service Repository Specification Read Profile in version 3.0.
- SUBMODEL_REPOSITORY_SERVICE_SPECIFICATION_SSP_002_V3_1 = 'https://admin-shell.io/aas/API/3/1/SubmodelRepositoryServiceSpecification/SSP-002'
Indicates that the server implemented all details of the Submodel Service Repository Specification Read Profile in version 3.1.
- SUBMODEL_REPOSITORY_SERVICE_SPECIFICATION_SSP_002_V3_2 = 'https://admin-shell.io/aas/API/3/2/SubmodelRepositoryServiceSpecification/SSP-002'
Indicates that the server implemented all details of the Submodel Service Repository Specification Read Profile in version 3.2.
- SUBMODEL_REPOSITORY_SERVICE_SPECIFICATION_SSP_003_V3_0 = 'https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-003'
Indicates that the server implemented all details of the Submodel Service Repository Specification Template Profile in version 3.0.
- SUBMODEL_REPOSITORY_SERVICE_SPECIFICATION_SSP_003_V3_1 = 'https://admin-shell.io/aas/API/3/1/SubmodelRepositoryServiceSpecification/SSP-003'
Indicates that the server implemented all details of the Submodel Service Repository Specification Template Profile in version 3.1.
- SUBMODEL_REPOSITORY_SERVICE_SPECIFICATION_SSP_003_V3_2 = 'https://admin-shell.io/aas/API/3/2/SubmodelRepositoryServiceSpecification/SSP-003'
Indicates that the server implemented all details of the Submodel Service Repository Specification Template Profile in version 3.2.
- SUBMODEL_REPOSITORY_SERVICE_SPECIFICATION_SSP_004_V3_0 = 'https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-004'
Indicates that the server implemented all details of the Submodel Service Repository Specification Template Read Profile in version 3.0.
- SUBMODEL_REPOSITORY_SERVICE_SPECIFICATION_SSP_004_V3_1 = 'https://admin-shell.io/aas/API/3/1/SubmodelRepositoryServiceSpecification/SSP-004'
Indicates that the server implemented all details of the Submodel Service Repository Specification Template Read Profile in version 3.1.
- SUBMODEL_REPOSITORY_SERVICE_SPECIFICATION_SSP_004_V3_2 = 'https://admin-shell.io/aas/API/3/2/SubmodelRepositoryServiceSpecification/SSP-004'
Indicates that the server implemented all details of the Submodel Service Repository Specification Template Read Profile in version 3.2.
- SUBMODEL_REPOSITORY_SERVICE_SPECIFICATION_SSP_005_V3_1 = 'https://admin-shell.io/aas/API/3/1/SubmodelRepositoryServiceSpecification/SSP-005'
Indicates that the server implemented all details of the Submodel Service Repository Specification Query Profile in version 3.1.
- SUBMODEL_REPOSITORY_SERVICE_SPECIFICATION_SSP_005_V3_2 = 'https://admin-shell.io/aas/API/3/2/SubmodelRepositoryServiceSpecification/SSP-005'
Indicates that the server implemented all details of the Submodel Service Repository Specification Query Profile in version 3.2.
- SUBMODEL_REPOSITORY_SERVICE_SPECIFICATION_SSP_006_V3_2 = 'https://admin-shell.io/aas/API/3/2/SubmodelRepositoryServiceSpecification/SSP-006'
Indicates that the server implemented all details of the Submodel Service Repository Specification Signature Profile in version 3.2.
- CONCEPT_DESCRIPTION_REPOSITORY_SERVICE_SPECIFICATION_SSP_001_V3_0 = 'https://admin-shell.io/aas/API/3/0/ConceptDescriptionRepositoryServiceSpecification/SSP-001'
Indicates that the server implemented all details of the Concept Description Repository Service Specification Profile in version 3.0.
- CONCEPT_DESCRIPTION_REPOSITORY_SERVICE_SPECIFICATION_SSP_001_V3_1 = 'https://admin-shell.io/aas/API/3/1/ConceptDescriptionRepositoryServiceSpecification/SSP-001'
Indicates that the server implemented all details of the Concept Description Repository Service Specification Profile in version 3.1.
- CONCEPT_DESCRIPTION_REPOSITORY_SERVICE_SPECIFICATION_SSP_002_V3_2 = 'https://admin-shell.io/aas/API/3/2/ConceptDescriptionRepositoryServiceSpecification/SSP-002'
Indicates that the server implemented all details of the Concept Description Repository Service Specification Query Profile in version 3.2.
- CONCEPT_DESCRIPTION_REPOSITORY_SERVICE_SPECIFICATION_SSP_002_V3_1 = 'https://admin-shell.io/aas/API/3/1/ConceptDescriptionRepositoryServiceSpecification/SSP-002'
Indicates that the server implemented all details of the Concept Description Repository Service Specification Query Profile in version 3.1.
- CONCEPT_DESCRIPTION_REPOSITORY_SERVICE_SPECIFICATION_SSP_003_V3_2 = 'https://admin-shell.io/aas/API/3/2/ConceptDescriptionRepositoryServiceSpecification/SSP-003'
Indicates that the server implemented all details of the Concept Description Repository Service Specification Signature Profile in version 3.2.
- class aas_core3_2.types.RecentChange(created_at: str, updated_at: str)[source]
This class is not part of the metamodel.
- created_at: str
The point in time at which the Identifiable object was created
- updated_at: str
The point in time at which the Identifiable object was recently updated
- class aas_core3_2.types.AssetAdministrationShellRecentChange(created_at: str, updated_at: str, id: str, global_asset_id: Optional[str] = None, specific_asset_ids: Optional[List[SpecificAssetID]] = None)[source]
This class is not part of the metamodel.
- over_specific_asset_ids_or_empty() Iterator[SpecificAssetID][source]
Yield from
specific_asset_idsif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(created_at: str, updated_at: str, id: str, global_asset_id: Optional[str] = None, specific_asset_ids: Optional[List[SpecificAssetID]] = None) None[source]
Initialize with the given values.
- id: str
Globally unique identification of the Asset Administration Shell
- global_asset_id: Optional[str]
Global reference to the asset the AAS is representing
- specific_asset_ids: Optional[List[SpecificAssetID]]
Specific asset identifier
- class aas_core3_2.types.ConceptDescriptionRecentChange(created_at: str, updated_at: str, id: str)[source]
This class is not part of the metamodel.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- id: str
Globally unique identification of the Submodel
- class aas_core3_2.types.SubmodelRecentChange(created_at: str, updated_at: str, id: str, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None)[source]
This class is not part of the metamodel.
- over_supplemental_semantic_ids_or_empty() Iterator[Reference][source]
Yield from
supplemental_semantic_idsif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(created_at: str, updated_at: str, id: str, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None) None[source]
Initialize with the given values.
- id: str
Globally unique identification of the Submodel
- class aas_core3_2.types.StatusCode(value)[source]
Generic status codes.
- SUCCESS = 'Success'
Success
- SUCCESS_CREATED = 'SuccessCreated'
Successful creation of a new resource
- SUCCESS_ACCEPTED = 'SuccessAccepted'
The reception of the request was successful
- SUCCESS_NO_CONTENT = 'SuccessNoContent'
Success with explicitly no content in the payload
- CLIENT_ERROR_BAD_REQUEST = 'ClientErrorBadRequest'
Bad or malformed request
- CLIENT_NOT_AUTHORIZED = 'ClientNotAuthorized'
Wrong or missing authorization credentials
- CLIENT_FORBIDDEN = 'ClientForbidden'
Authorization has been refused
- CLIENT_METHOD_NOT_ALLOWED = 'ClientMethodNotAllowed'
Operation request is not allowed
- CLIENT_ERROR_RESOURCE_NOT_FOUND = 'ClientErrorResourceNotFound'
Resource not found
- CLIENT_RESOURCE_CONFLICT = 'ClientResourceConflict'
Conflict-creating resource (resource already exists)
- SERVER_INTERNAL_ERROR = 'ServerInternalError'
Unexpected error
- SERVER_NOT_IMPLEMENTED = 'ServerNotImplemented'
The server has not implemented this API Operation. Intended for cases where API Operations beyond the supported service profiles are requested.
- SERVER_ERROR_BAD_GATEWAY = 'ServerErrorBadGateway'
Bad gateway
- class aas_core3_2.types.Result(messages: Optional[List[Message]] = None)[source]
The result object.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- class aas_core3_2.types.Message(message_type: MessageTypeEnum, text: str, code: Optional[str] = None, correlation_id: Optional[str] = None, timestamp: Optional[str] = None)[source]
A message containing more information for the requester about a certain happening in the backend.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(message_type: MessageTypeEnum, text: str, code: Optional[str] = None, correlation_id: Optional[str] = None, timestamp: Optional[str] = None) None[source]
Initialize with the given values.
- message_type: MessageTypeEnum
The message type
- text: str
The message text
- code: Optional[str]
Technology-dependent status or error code
- correlation_id: Optional[str]
Identifier to relate several result messages throughout several systems
- timestamp: Optional[str]
Timestamp of the message
- class aas_core3_2.types.MessageTypeEnum(value)[source]
The message type.
- UNDEFINED = 'Undefined'
Used when the message type has not been set.
Note
Not documented in the book prose; present as a literal in the OpenAPI schema’s
messageTypeenumeration.
- INFO = 'Info'
Used to inform the user about a certain fact
- WARNING = 'Warning'
Used for warnings; warnings may lead to errors in the subsequent execution
- ERROR = 'Error'
Used for handling errors
- EXCEPTION = 'Exception'
Used in case of an internal and/or unhandled exception
- class aas_core3_2.types.OperationRequest(input_arguments: Optional[List[OperationVariable]] = None, inoutput_arguments: Optional[List[OperationVariable]] = None, client_timeout_duration: Optional[str] = None)[source]
The operation request object.
- over_input_arguments_or_empty() Iterator[OperationVariable][source]
Yield from
input_argumentsif set.
- over_inoutput_arguments_or_empty() Iterator[OperationVariable][source]
Yield from
inoutput_argumentsif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(input_arguments: Optional[List[OperationVariable]] = None, inoutput_arguments: Optional[List[OperationVariable]] = None, client_timeout_duration: Optional[str] = None) None[source]
Initialize with the given values.
- input_arguments: Optional[List[OperationVariable]]
Input argument
- inoutput_arguments: Optional[List[OperationVariable]]
InOutput argument
- client_timeout_duration: Optional[str]
Duration indicating when the client suggests the server to have finished execution of the invoked operation. The server may take this value into account to decide on its effective timeout, however, the server may or may not use by its own discretion.
- class aas_core3_2.types.OperationRequestAsync(client_timeout_duration: str, input_arguments: Optional[List[OperationVariable]] = None, inoutput_arguments: Optional[List[OperationVariable]] = None)[source]
The operation request object for asynchronous invocation.
This class is not part of the metamodel and is not itself a named class in the specification. It corresponds to the request body of the
InvokeOperationAsyncoperation, which is shaped likeOperationRequestwithOperationRequest.client_timeout_durationmade mandatory.Note
This class is deliberately not related to
OperationRequestby inheritance: a subclass constructor must exactly match argument’s type to the inherited property’s declared type, so a property declaredOptional[Duration]on a base class cannot be narrowed to a requiredDurationon a subclass. Making this a standalone class letsclient_timeout_durationbe genuinely required here.- over_input_arguments_or_empty() Iterator[OperationVariable][source]
Yield from
input_argumentsif set.
- over_inoutput_arguments_or_empty() Iterator[OperationVariable][source]
Yield from
inoutput_argumentsif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(client_timeout_duration: str, input_arguments: Optional[List[OperationVariable]] = None, inoutput_arguments: Optional[List[OperationVariable]] = None) None[source]
Initialize with the given values.
- client_timeout_duration: str
Duration indicating when the client suggests the server to have finished execution of the invoked operation. The server may take this value into account to decide on its effective timeout, however, the server may or may not use by its own discretion.
- input_arguments: Optional[List[OperationVariable]]
Input argument
- inoutput_arguments: Optional[List[OperationVariable]]
InOutput argument
- class aas_core3_2.types.OperationRequestValueOnly(input_arguments: Optional[Mapping[str, Any]] = None, inoutput_arguments: Optional[Mapping[str, Any]] = None, client_timeout_duration: Optional[str] = None)[source]
The operation request object in the ValueOnly notation.
Note
The arguments are given in the ValueOnly serialization, i.e., as a JSON object whose keys are the ID-shorts of the argument values and whose values are the ValueOnly serializations of the argument values. Their shape depends on the concrete submodel elements and can not be pinned down statically, so they are represented as open JSON objects.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(input_arguments: Optional[Mapping[str, Any]] = None, inoutput_arguments: Optional[Mapping[str, Any]] = None, client_timeout_duration: Optional[str] = None) None[source]
Initialize with the given values.
- input_arguments: Optional[Mapping[str, Any]]
Input argument
- inoutput_arguments: Optional[Mapping[str, Any]]
InOutput argument
- client_timeout_duration: Optional[str]
Duration indicating when the client suggests the server to have finished execution of the invoked operation. The server may take this value into account to decide on its effective timeout, however, the server may or may not use by its own discretion.
- class aas_core3_2.types.OperationRequestAsyncValueOnly(client_timeout_duration: str, input_arguments: Optional[Mapping[str, Any]] = None, inoutput_arguments: Optional[Mapping[str, Any]] = None)[source]
The operation request object for asynchronous invocation in the ValueOnly notation.
This class is not part of the metamodel and is not itself a named class in the specification. It corresponds to the request body of the
InvokeOperationAsyncoperation in the ValueOnly notation, which is shaped likeOperationRequestValueOnlywithOperationRequestValueOnly.client_timeout_durationmade mandatory.Note
This class is deliberately not related to
OperationRequestValueOnlyby inheritance; see the note onOperationRequestAsync.- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(client_timeout_duration: str, input_arguments: Optional[Mapping[str, Any]] = None, inoutput_arguments: Optional[Mapping[str, Any]] = None) None[source]
Initialize with the given values.
- client_timeout_duration: str
Duration indicating when the client suggests the server to have finished execution of the invoked operation. The server may take this value into account to decide on its effective timeout, however, the server may or may not use by its own discretion.
- input_arguments: Optional[Mapping[str, Any]]
Input argument
- inoutput_arguments: Optional[Mapping[str, Any]]
InOutput argument
- class aas_core3_2.types.BaseOperationResult(execution_state: ExecutionState, messages: Optional[List[Message]] = None, success: Optional[bool] = None)[source]
The object containing the intermediate state of an operation.
Note
This class is deliberately not related to
Resultby inheritance (andOperationResultbelow is, in turn, not related to this class by inheritance either). aas-core-codegen refuses to generate a schema for a concrete class with concrete descendants unless it is marked@serialization(with_model_type=True), which would introduce amodelTypediscriminator property that the official schema does not have for this hierarchy. Flattening the hierarchy avoids that mismatch, at the cost of repeatingmessageshere.- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(execution_state: ExecutionState, messages: Optional[List[Message]] = None, success: Optional[bool] = None) None[source]
Initialize with the given values.
- execution_state: ExecutionState
Execution state
- success: Optional[bool]
Flag indicating whether the business operation behind the operation was successful (true) or not (false)
- class aas_core3_2.types.OperationResult(execution_state: ExecutionState, messages: Optional[List[Message]] = None, success: Optional[bool] = None, output_arguments: Optional[List[OperationVariable]] = None, inoutput_arguments: Optional[List[OperationVariable]] = None)[source]
The operation’s invocation result object.
Note
This class is deliberately not related to
BaseOperationResultby inheritance; see the note on that class.- over_output_arguments_or_empty() Iterator[OperationVariable][source]
Yield from
output_argumentsif set.
- over_inoutput_arguments_or_empty() Iterator[OperationVariable][source]
Yield from
inoutput_argumentsif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(execution_state: ExecutionState, messages: Optional[List[Message]] = None, success: Optional[bool] = None, output_arguments: Optional[List[OperationVariable]] = None, inoutput_arguments: Optional[List[OperationVariable]] = None) None[source]
Initialize with the given values.
- execution_state: ExecutionState
Execution state
- success: Optional[bool]
Flag indicating whether the business operation behind the operation was successful (true) or not (false)
- output_arguments: Optional[List[OperationVariable]]
Output argument
- inoutput_arguments: Optional[List[OperationVariable]]
InOutput argument
- class aas_core3_2.types.OperationResultValueOnly(execution_state: ExecutionState, messages: Optional[List[Message]] = None, success: Optional[bool] = None, output_arguments: Optional[Mapping[str, Any]] = None, inoutput_arguments: Optional[Mapping[str, Any]] = None)[source]
The operation’s invocation result object in the ValueOnly notation.
Note
This class is deliberately not related to
BaseOperationResultby inheritance; see the note on that class.Note
The arguments are given in the ValueOnly serialization; see the note on
OperationRequestValueOnly.- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(execution_state: ExecutionState, messages: Optional[List[Message]] = None, success: Optional[bool] = None, output_arguments: Optional[Mapping[str, Any]] = None, inoutput_arguments: Optional[Mapping[str, Any]] = None) None[source]
Initialize with the given values.
- execution_state: ExecutionState
Execution state
- success: Optional[bool]
Flag indicating whether the business operation behind the operation was successful (true) or not (false)
- output_arguments: Optional[Mapping[str, Any]]
Output argument
- inoutput_arguments: Optional[Mapping[str, Any]]
InOutput argument
- class aas_core3_2.types.ExecutionState(value)[source]
The operation’s invocation result state.
- INITIATED = 'Initiated'
The operation is ready to be executed (initial state)
- RUNNING = 'Running'
The operation is running
- COMPLETED = 'Completed'
The operation is completed
- CANCELED = 'Canceled'
The operation was cancelled externally
- FAILED = 'Failed'
The operation failed
- TIMEOUT = 'Timeout'
The operation has timed out due to given client or server timeout
- class aas_core3_2.types.OperationHandle(handle_id: str)[source]
The returned handle of an operation’s asynchronous invocation used to request the current state of the operation’s execution.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- handle_id: str
Handle ID
- class aas_core3_2.types.Level(value)[source]
Indicates the depth of the structure of the response or input content.
Note
We follow the spelling of the literals in the Part 2 OpenAPI schema (Part2-API-Schemas/openapi.yaml),
deepandcore, rather than the spelling in the book prose, since the servers, such as BaSyx, accept only the former.- DEEP = 'deep'
All elements of a requested hierarchy level and all children on all sublevels are returned.
Children in this sense are SubmodelElements which are contained at the ‘submodelElements’ field of Submodels, the ‘value’ field of SubmodelElementCollections or SubmodelElementLists, the ‘statements’ field of Entities, or the ‘annotations’ field of AnnotatedRelationshipElements.
- CORE = 'core'
Only elements of a requested hierarchy level as well as direct children are returned. By this, a client can iterate the hierarchy step by step.
- class aas_core3_2.types.Content(value)[source]
Content indicates the kind of serialization of the response or input content.
- NORMAL = 'Normal'
The standard serialization of the model element or child elements is applied.
- METADATA = 'Metadata'
Only metadata of an element or child elements is returned; the value is not.
- VALUE = 'Value'
Only the raw value of the model element or child elements is returned; it is commonly referred to as ValueOnly-serialization.
- REFERENCE = 'Reference'
Only applicable to Referables. Only the reference to the found element is returned; potential child elements are ignored.
- PATH = 'Path'
Returns the ID-short of the requested element and a list of ID-short paths to child elements if the requested element is a Submodel, a SubmodelElementCollection, a SubmodelElementList, an AnnotatedRelationshipElement, or an Entity.
- class aas_core3_2.types.Extent(value)[source]
Indicates to which extent the response or input content is being serialized.
Note
We follow the spelling of the literals in the Part 2 OpenAPI schema (Part2-API-Schemas/openapi.yaml),
withoutBlobValueandwithBlobValue, rather than the spelling in the book prose, such asWithBLOBValue, since the servers, such as BaSyx, accept only the former.- WITHOUT_BLOB_VALUE = 'withoutBlobValue'
Only applicable to BLOB-elements; the BLOB content is not returned.
This is the default value.
- WITH_BLOB_VALUE = 'withBlobValue'
Only applicable to BLOB-elements; the BLOB content is returned as base64-encoded string.
- class aas_core3_2.types.PagedResult(paging_metadata: PagingMetadata, result: Optional[List[Referable]] = None)[source]
An object connecting the actual list of returned items with metadata information to, e.g., fetch the next part of the result set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(paging_metadata: PagingMetadata, result: Optional[List[Referable]] = None) None[source]
Initialize with the given values.
- paging_metadata: PagingMetadata
Additional information for the client to, e.g., fetch the next part of the result set.
- class aas_core3_2.types.PagingMetadata(cursor: Optional[str] = None)[source]
Additional information for the client to, e.g., fetch the next part of the result set.
Note
More attributes may be added to this class in future versions.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- cursor: Optional[str]
The cursor for the next part of the result set. No cursor attribute means that the end of the result set has been reached.
- class aas_core3_2.types.PackageDescription(package_id: str, aas_ids: Optional[List[str]] = None)[source]
The package description consists of a system-wide unique packageId and its corresponding Asset Administration Shell identifiers.
The packageId is used to identify the AASX package at the AASX file server. The package description is used to list the Asset Administration Shells in a given AASX package.
This class is not part of the metamodel.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(package_id: str, aas_ids: Optional[List[str]] = None) None[source]
Initialize with the given values.
- package_id: str
File server specific package id
- aas_ids: Optional[List[str]]
Asset Administration Shell unique identifiers
- class aas_core3_2.types.SubmodelElementAttributes(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
The attributes shared by all submodel elements, without their value.
This class is not part of the metamodel and is not itself a named class in the specification.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.SubmodelElementMetadata(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
The metadata of a submodel element, without its value.
This class is not part of the metamodel and is not itself a named class in the specification. It is the polymorphic union of all the
*Metadataclasses below.- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.PropertyMetadata(value_type: DataTypeDefXSD, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
The metadata of a
Property, without its value.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(value_type: DataTypeDefXSD, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- value_type: DataTypeDefXSD
The value type of the property.
- class aas_core3_2.types.RangeMetadata(value_type: DataTypeDefXSD, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
The metadata of a
Range, without its value.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(value_type: DataTypeDefXSD, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- value_type: DataTypeDefXSD
The value type of the range.
- class aas_core3_2.types.BlobMetadata(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
The metadata of a
Blob, without its value.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.FileMetadata(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
The metadata of a
File, without its value.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.MultiLanguagePropertyMetadata(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
The metadata of a
MultiLanguageProperty, without its value.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.ReferenceElementMetadata(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
The metadata of a
ReferenceElement, without its value.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.RelationshipElementMetadata(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
The metadata of a
RelationshipElement, without its value.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.AnnotatedRelationshipElementMetadata(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
The metadata of an
AnnotatedRelationshipElement, without its value.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.EntityMetadata(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
The metadata of an
Entity, without its value.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.CapabilityMetadata(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
The metadata of a
Capability.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.OperationMetadata(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
The metadata of an
Operation, without its input/output/inoutput variables.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.SubmodelElementCollectionMetadata(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
The metadata of a
SubmodelElementCollection, without its value.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.BasicEventElementMetadata(direction: Direction, state: StateOfEvent, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, message_topic: Optional[str] = None, message_broker: Optional[Reference] = None, last_update: Optional[str] = None, min_interval: Optional[str] = None, max_interval: Optional[str] = None)[source]
The metadata of a
BasicEventElement.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(direction: Direction, state: StateOfEvent, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, message_topic: Optional[str] = None, message_broker: Optional[Reference] = None, last_update: Optional[str] = None, min_interval: Optional[str] = None, max_interval: Optional[str] = None) None[source]
Initialize with the given values.
- state: StateOfEvent
State of event.
- message_topic: Optional[str]
Topic, to which the event’s message is published.
- last_update: Optional[str]
Timestamp of the last update of the event.
- min_interval: Optional[str]
For continuous signalling, the minimum interval between two consecutive events.
- max_interval: Optional[str]
For continuous signalling, the maximum interval between two consecutive events.
- class aas_core3_2.types.SubmodelElementListMetadata(type_value_list_element: AASSubmodelElements, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, order_relevant: Optional[bool] = None, semantic_id_list_element: Optional[Reference] = None, value_type_list_element: Optional[DataTypeDefXSD] = None)[source]
The metadata of a
SubmodelElementList, without its value.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(type_value_list_element: AASSubmodelElements, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, order_relevant: Optional[bool] = None, semantic_id_list_element: Optional[Reference] = None, value_type_list_element: Optional[DataTypeDefXSD] = None) None[source]
Initialize with the given values.
- order_relevant: Optional[bool]
Defines whether order in the list is relevant.
- semantic_id_list_element: Optional[Reference]
Semantic ID the submodel elements contained in the list match to.
- type_value_list_element: AASSubmodelElements
The submodel element type of the submodel elements contained in the list.
- value_type_list_element: Optional[DataTypeDefXSD]
The value type of the submodel elements contained in the list.
- class aas_core3_2.types.SubmodelMetadata(id: str, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, administration: Optional[AdministrativeInformation] = None, kind: Optional[ModellingKind] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None)[source]
The metadata of a
Submodel, without its submodel elements.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(id: str, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, administration: Optional[AdministrativeInformation] = None, kind: Optional[ModellingKind] = None, semantic_id: Optional[Reference] = None, supplemental_semantic_ids: Optional[List[Reference]] = None, qualifiers: Optional[List[Qualifier]] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.AssetAdministrationShellMetadata(id: str, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, administration: Optional[AdministrativeInformation] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, derived_from: Optional[Reference] = None)[source]
The metadata of an
AssetAdministrationShell, without its asset information and submodel references.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(id: str, extensions: Optional[List[Extension]] = None, category: Optional[str] = None, id_short: Optional[str] = None, display_name: Optional[List[LangStringNameType]] = None, description: Optional[List[LangStringTextType]] = None, administration: Optional[AdministrativeInformation] = None, embedded_data_specifications: Optional[List[EmbeddedDataSpecification]] = None, derived_from: Optional[Reference] = None) None[source]
Initialize with the given values.
- class aas_core3_2.types.ReferenceElementValue(type: ReferenceTypes, keys: List[Key], referred_semantic_id: Optional[Reference] = None)[source]
The value of a
ReferenceElement.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(type: ReferenceTypes, keys: List[Key], referred_semantic_id: Optional[Reference] = None) None[source]
Initialize with the given values.
- type: ReferenceTypes
Type of the reference.
Denotes whether the reference is an external reference or a model reference.
- referred_semantic_id: Optional[Reference]
Expected
HasSemantics.semantic_idof the referenced model element.
- class aas_core3_2.types.BlobValue(content_type: Optional[str] = None, value: Optional[bytes] = None)[source]
The value of a
Blob.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(content_type: Optional[str] = None, value: Optional[bytes] = None) None[source]
Initialize with the given values.
- content_type: Optional[str]
The content type of the BLOB, e.g.,
application/pdf.
- value: Optional[bytes]
The BLOB content.
- class aas_core3_2.types.FileValue(content_type: Optional[str] = None, value: Optional[str] = None)[source]
The value of a
File.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(content_type: Optional[str] = None, value: Optional[str] = None) None[source]
Initialize with the given values.
- content_type: Optional[str]
The content type of the file, e.g.,
application/pdf.
- value: Optional[str]
The path or URL to the file content.
- class aas_core3_2.types.RangeValue(min: float, max: float)[source]
The value of a
Range.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- min: float
The minimum value of the range.
- max: float
The maximum value of the range.
- class aas_core3_2.types.RelationshipElementValue(first: Optional[Reference] = None, second: Optional[Reference] = None)[source]
The value of a
RelationshipElement.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- class aas_core3_2.types.BasicEventElementValue(observed: Reference)[source]
The value of a
BasicEventElement.This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- class aas_core3_2.types.AnnotatedRelationshipElementValue(first: Optional[Reference] = None, second: Optional[Reference] = None, annotations: Optional[Mapping[str, Any]] = None)[source]
The value of an
AnnotatedRelationshipElement.This class is not part of the metamodel and is not itself a named class in the specification.
Note
The annotations are given in the ValueOnly serialization, i.e., as a JSON object whose keys are the ID-shorts of the annotations and whose values are the ValueOnly serializations of the annotations. Their shape depends on the concrete data elements and can not be pinned down statically, so they are represented as an open JSON object.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(first: Optional[Reference] = None, second: Optional[Reference] = None, annotations: Optional[Mapping[str, Any]] = None) None[source]
Initialize with the given values.
- annotations: Optional[Mapping[str, Any]]
Annotations which hold for the relationship between the two elements.
- class aas_core3_2.types.EntityValue(entity_type: Optional[EntityType] = None, global_asset_id: Optional[str] = None, specific_asset_ids: Optional[List[Mapping[str, Any]]] = None, statements: Optional[Mapping[str, Any]] = None)[source]
The value of an
Entity.This class is not part of the metamodel and is not itself a named class in the specification.
Note
The statements are given in the ValueOnly serialization, i.e., as a JSON object whose keys are the ID-shorts of the statements and whose values are the ValueOnly serializations of the statements. Their shape depends on the concrete submodel elements and can not be pinned down statically, so they are represented as an open JSON object.
- over_specific_asset_ids_or_empty() Iterator[Mapping[str, Any]][source]
Yield from
specific_asset_idsif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(entity_type: Optional[EntityType] = None, global_asset_id: Optional[str] = None, specific_asset_ids: Optional[List[Mapping[str, Any]]] = None, statements: Optional[Mapping[str, Any]] = None) None[source]
Initialize with the given values.
- entity_type: Optional[EntityType]
Describes whether the entity is a co-managed entity or a self-managed entity.
- global_asset_id: Optional[str]
Global identifier of the asset the entity is representing.
- specific_asset_ids: Optional[List[Mapping[str, Any]]]
Additional domain-specific, typically proprietary identifiers for the asset, each given as a single-entry JSON object mapping the
SpecificAssetID.nameto theSpecificAssetID.value.
- statements: Optional[Mapping[str, Any]]
Describes statements applicable to the entity by a set of submodel elements, typically with a qualified value.
- class aas_core3_2.types.GetAssetAdministrationShellsResult(paging_metadata: PagingMetadata, result: Optional[List[AssetAdministrationShell]] = None)[source]
The result of listing all Asset Administration Shells.
This class is not part of the metamodel and is not itself a named class in the specification.
- over_result_or_empty() Iterator[AssetAdministrationShell][source]
Yield from
resultif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(paging_metadata: PagingMetadata, result: Optional[List[AssetAdministrationShell]] = None) None[source]
Initialize with the given values.
- paging_metadata: PagingMetadata
Additional information for the client to, e.g., fetch the next part of the result set.
- result: Optional[List[AssetAdministrationShell]]
The returned items.
- class aas_core3_2.types.GetAssetAdministrationShellsMetadataResult(paging_metadata: PagingMetadata, result: Optional[List[AssetAdministrationShellMetadata]] = None)[source]
The result of listing the metadata of all Asset Administration Shells.
This class is not part of the metamodel and is not itself a named class in the specification.
- over_result_or_empty() Iterator[AssetAdministrationShellMetadata][source]
Yield from
resultif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(paging_metadata: PagingMetadata, result: Optional[List[AssetAdministrationShellMetadata]] = None) None[source]
Initialize with the given values.
- paging_metadata: PagingMetadata
Additional information for the client to, e.g., fetch the next part of the result set.
- result: Optional[List[AssetAdministrationShellMetadata]]
The returned items.
- class aas_core3_2.types.GetAllAssetAdministrationShellsRecentChangesResult(paging_metadata: PagingMetadata, result: Optional[List[AssetAdministrationShellRecentChange]] = None)[source]
The result of listing the recent changes of all Asset Administration Shells.
This class is not part of the metamodel and is not itself a named class in the specification.
- over_result_or_empty() Iterator[AssetAdministrationShellRecentChange][source]
Yield from
resultif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(paging_metadata: PagingMetadata, result: Optional[List[AssetAdministrationShellRecentChange]] = None) None[source]
Initialize with the given values.
- paging_metadata: PagingMetadata
Additional information for the client to, e.g., fetch the next part of the result set.
- result: Optional[List[AssetAdministrationShellRecentChange]]
The returned items.
- class aas_core3_2.types.GetAssetAdministrationShellDescriptorsResult(paging_metadata: PagingMetadata, result: Optional[List[AssetAdministrationShellDescriptor]] = None)[source]
The result of listing all Asset Administration Shell descriptors.
This class is not part of the metamodel and is not itself a named class in the specification.
- over_result_or_empty() Iterator[AssetAdministrationShellDescriptor][source]
Yield from
resultif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(paging_metadata: PagingMetadata, result: Optional[List[AssetAdministrationShellDescriptor]] = None) None[source]
Initialize with the given values.
- paging_metadata: PagingMetadata
Additional information for the client to, e.g., fetch the next part of the result set.
- result: Optional[List[AssetAdministrationShellDescriptor]]
The returned items.
- class aas_core3_2.types.GetConceptDescriptionsResult(paging_metadata: PagingMetadata, result: Optional[List[ConceptDescription]] = None)[source]
The result of listing all concept descriptions.
This class is not part of the metamodel and is not itself a named class in the specification.
- over_result_or_empty() Iterator[ConceptDescription][source]
Yield from
resultif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(paging_metadata: PagingMetadata, result: Optional[List[ConceptDescription]] = None) None[source]
Initialize with the given values.
- paging_metadata: PagingMetadata
Additional information for the client to, e.g., fetch the next part of the result set.
- result: Optional[List[ConceptDescription]]
The returned items.
- class aas_core3_2.types.GetAllConceptDescriptionsRecentChangesResult(paging_metadata: PagingMetadata, result: Optional[List[ConceptDescriptionRecentChange]] = None)[source]
The result of listing the recent changes of all concept descriptions.
This class is not part of the metamodel and is not itself a named class in the specification.
- over_result_or_empty() Iterator[ConceptDescriptionRecentChange][source]
Yield from
resultif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(paging_metadata: PagingMetadata, result: Optional[List[ConceptDescriptionRecentChange]] = None) None[source]
Initialize with the given values.
- paging_metadata: PagingMetadata
Additional information for the client to, e.g., fetch the next part of the result set.
- result: Optional[List[ConceptDescriptionRecentChange]]
The returned items.
- class aas_core3_2.types.GetPackageDescriptionsResult(paging_metadata: PagingMetadata, result: Optional[List[PackageDescription]] = None)[source]
The result of listing all AASX package descriptions.
This class is not part of the metamodel and is not itself a named class in the specification.
- over_result_or_empty() Iterator[PackageDescription][source]
Yield from
resultif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(paging_metadata: PagingMetadata, result: Optional[List[PackageDescription]] = None) None[source]
Initialize with the given values.
- paging_metadata: PagingMetadata
Additional information for the client to, e.g., fetch the next part of the result set.
- result: Optional[List[PackageDescription]]
The returned items.
- class aas_core3_2.types.GetPathItemsResult(paging_metadata: PagingMetadata, result: Optional[List[str]] = None)[source]
The result of listing idShortPaths.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(paging_metadata: PagingMetadata, result: Optional[List[str]] = None) None[source]
Initialize with the given values.
- paging_metadata: PagingMetadata
Additional information for the client to, e.g., fetch the next part of the result set.
- result: Optional[List[str]]
The returned items.
- class aas_core3_2.types.GetReferencesResult(paging_metadata: PagingMetadata, result: Optional[List[Reference]] = None)[source]
The result of listing references.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(paging_metadata: PagingMetadata, result: Optional[List[Reference]] = None) None[source]
Initialize with the given values.
- paging_metadata: PagingMetadata
Additional information for the client to, e.g., fetch the next part of the result set.
- class aas_core3_2.types.GetSubmodelDescriptorsResult(paging_metadata: PagingMetadata, result: Optional[List[SubmodelDescriptor]] = None)[source]
The result of listing all submodel descriptors.
This class is not part of the metamodel and is not itself a named class in the specification.
- over_result_or_empty() Iterator[SubmodelDescriptor][source]
Yield from
resultif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(paging_metadata: PagingMetadata, result: Optional[List[SubmodelDescriptor]] = None) None[source]
Initialize with the given values.
- paging_metadata: PagingMetadata
Additional information for the client to, e.g., fetch the next part of the result set.
- result: Optional[List[SubmodelDescriptor]]
The returned items.
- class aas_core3_2.types.GetSubmodelElementsMetadataResult(paging_metadata: PagingMetadata, result: Optional[List[SubmodelElementMetadata]] = None)[source]
The result of listing the metadata of all submodel elements.
This class is not part of the metamodel and is not itself a named class in the specification.
- over_result_or_empty() Iterator[SubmodelElementMetadata][source]
Yield from
resultif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(paging_metadata: PagingMetadata, result: Optional[List[SubmodelElementMetadata]] = None) None[source]
Initialize with the given values.
- paging_metadata: PagingMetadata
Additional information for the client to, e.g., fetch the next part of the result set.
- result: Optional[List[SubmodelElementMetadata]]
The returned items.
- class aas_core3_2.types.GetSubmodelElementsResult(paging_metadata: PagingMetadata, result: Optional[List[SubmodelElement]] = None)[source]
The result of listing all submodel elements.
This class is not part of the metamodel and is not itself a named class in the specification.
- over_result_or_empty() Iterator[SubmodelElement][source]
Yield from
resultif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(paging_metadata: PagingMetadata, result: Optional[List[SubmodelElement]] = None) None[source]
Initialize with the given values.
- paging_metadata: PagingMetadata
Additional information for the client to, e.g., fetch the next part of the result set.
- result: Optional[List[SubmodelElement]]
The returned items.
- class aas_core3_2.types.GetSubmodelElementsValueResult(paging_metadata: PagingMetadata, result: Optional[List[Mapping[str, Any]]] = None)[source]
The result of listing the submodel elements in the ValueOnly notation.
This class is not part of the metamodel and is not itself a named class in the specification.
Note
Each item of the result is a submodel element given in the ValueOnly serialization, i.e., as a JSON object with a single key, the ID-short of the submodel element, whose value is its ValueOnly serialization. The shape of the value depends on the concrete submodel element and can not be pinned down statically, so each item is represented as an open JSON object.
Unlike the OpenAPI schema, which types the result as a single JSON object since V3.0.4, we follow BaSyx Go and represent the result as an array of items. We suspect the OpenAPI schema to be buggy here.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(paging_metadata: PagingMetadata, result: Optional[List[Mapping[str, Any]]] = None) None[source]
Initialize with the given values.
- paging_metadata: PagingMetadata
Additional information for the client to, e.g., fetch the next part of the result set.
- result: Optional[List[Mapping[str, Any]]]
The returned items.
- class aas_core3_2.types.GetAllSubmodelsRecentChangesResult(paging_metadata: PagingMetadata, result: Optional[List[SubmodelRecentChange]] = None)[source]
The result of listing the recent changes of all submodels.
This class is not part of the metamodel and is not itself a named class in the specification.
- over_result_or_empty() Iterator[SubmodelRecentChange][source]
Yield from
resultif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(paging_metadata: PagingMetadata, result: Optional[List[SubmodelRecentChange]] = None) None[source]
Initialize with the given values.
- paging_metadata: PagingMetadata
Additional information for the client to, e.g., fetch the next part of the result set.
- result: Optional[List[SubmodelRecentChange]]
The returned items.
- class aas_core3_2.types.GetSubmodelsMetadataResult(paging_metadata: PagingMetadata, result: Optional[List[SubmodelMetadata]] = None)[source]
The result of listing the metadata of all submodels.
This class is not part of the metamodel and is not itself a named class in the specification.
- over_result_or_empty() Iterator[SubmodelMetadata][source]
Yield from
resultif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(paging_metadata: PagingMetadata, result: Optional[List[SubmodelMetadata]] = None) None[source]
Initialize with the given values.
- paging_metadata: PagingMetadata
Additional information for the client to, e.g., fetch the next part of the result set.
- result: Optional[List[SubmodelMetadata]]
The returned items.
- class aas_core3_2.types.GetSubmodelsResult(paging_metadata: PagingMetadata, result: Optional[List[Submodel]] = None)[source]
The result of listing all submodels.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(paging_metadata: PagingMetadata, result: Optional[List[Submodel]] = None) None[source]
Initialize with the given values.
- paging_metadata: PagingMetadata
Additional information for the client to, e.g., fetch the next part of the result set.
- class aas_core3_2.types.GetSubmodelsValueResult(paging_metadata: PagingMetadata, result: Optional[List[Mapping[str, Any]]] = None)[source]
The result of listing the submodels in the ValueOnly notation.
This class is not part of the metamodel and is not itself a named class in the specification.
Note
Each item of the result is a submodel given in the ValueOnly serialization, i.e., as a JSON object whose keys are the ID-shorts of the submodel elements and whose values are their ValueOnly serializations. Their shape depends on the concrete submodel elements and can not be pinned down statically, so each item is represented as an open JSON object.
Unlike the OpenAPI schema, which types the result as a single SubmodelValue since V3.0.4, we follow BaSyx Go and represent the result as an array of items. We suspect the OpenAPI schema to be buggy here.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(paging_metadata: PagingMetadata, result: Optional[List[Mapping[str, Any]]] = None) None[source]
Initialize with the given values.
- paging_metadata: PagingMetadata
Additional information for the client to, e.g., fetch the next part of the result set.
- result: Optional[List[Mapping[str, Any]]]
The returned items.
- class aas_core3_2.types.GlobalAttributeKind(value)[source]
Enumerate the global attributes which can be used in a query.
- LOCAL_NOW = 'LOCALNOW'
The current date and time in the local time zone of the server
- UTC_NOW = 'UTCNOW'
The current date and time in UTC
- CLIENT_NOW = 'CLIENTNOW'
The current date and time of the client
- ANONYMOUS = 'ANONYMOUS'
The anonymous user, i.e., a request without authentication
- class aas_core3_2.types.DateTimeGlobalAttributeKind(value)[source]
Enumerate the global attributes which can be used as a date-time operand in a query.
This is a subset of
GlobalAttributeKind.- LOCAL_NOW = 'LOCALNOW'
The current date and time in the local time zone of the server
- UTC_NOW = 'UTCNOW'
The current date and time in UTC
- CLIENT_NOW = 'CLIENTNOW'
The current date and time of the client
- class aas_core3_2.types.ClaimAttribute(claim: str)[source]
Refer to a claim of the requester, e.g., from an access token.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- claim: str
Name of the claim
- class aas_core3_2.types.GlobalAttribute(kind: GlobalAttributeKind)[source]
Refer to a global attribute such as the current time.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(kind: GlobalAttributeKind) None[source]
Initialize with the given values.
- kind: GlobalAttributeKind
Kind of the global attribute
- class aas_core3_2.types.ReferenceAttribute(reference: str)[source]
Refer to an attribute of a specific AAS element.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- reference: str
Reference to the attribute
- class aas_core3_2.types.DateTimeAttributeItem(kind: DateTimeGlobalAttributeKind)[source]
Refer to a global attribute which gives a date and time.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(kind: DateTimeGlobalAttributeKind) None[source]
Initialize with the given values.
- kind: DateTimeGlobalAttributeKind
Kind of the global attribute
- class aas_core3_2.types.FieldOperand(field: str)[source]
Use the value of a field as an operand.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- field: str
Identifier of the field
- class aas_core3_2.types.StringLiteral(str_val: str)[source]
Use a string literal as an operand.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- str_val: str
The string value
- class aas_core3_2.types.AttributeOperand(attribute: Union[ClaimAttribute, GlobalAttribute, ReferenceAttribute])[source]
Use an attribute as an operand.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(attribute: Union[ClaimAttribute, GlobalAttribute, ReferenceAttribute]) None[source]
Initialize with the given values.
- attribute: Union[ClaimAttribute, GlobalAttribute, ReferenceAttribute]
The attribute
- class aas_core3_2.types.NumberLiteral(num_val: float)[source]
Use a number literal as an operand.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- num_val: float
The numerical value
- class aas_core3_2.types.HexLiteral(hex_val: str)[source]
Use a hexadecimal literal as an operand.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- hex_val: str
The hexadecimal value
- class aas_core3_2.types.DateTimeLiteral(date_time_val: str)[source]
Use a date-time literal as an operand.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- date_time_val: str
The date-time value
- class aas_core3_2.types.TimeLiteral(time_val: str)[source]
Use a time literal as an operand.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- time_val: str
The time value
- class aas_core3_2.types.BooleanLiteral(boolean: bool)[source]
Use a boolean literal as an operand or as a logical expression.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- boolean: bool
The boolean value
- class aas_core3_2.types.StringCast(str_cast: Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast])[source]
Cast the operand to
xs:string.This class is not part of the metamodel and is not itself a named class in the specification.
See: https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.2/query-language.html#casting
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(str_cast: Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]) None[source]
Initialize with the given values.
- str_cast: Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]
The operand to be cast
- class aas_core3_2.types.NumberCast(num_cast: Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast])[source]
Cast the operand to a number.
This class is not part of the metamodel and is not itself a named class in the specification.
See: https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.2/query-language.html#casting
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(num_cast: Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]) None[source]
Initialize with the given values.
- num_cast: Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]
The operand to be cast
- class aas_core3_2.types.HexCast(hex_cast: Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast])[source]
Cast the operand to
xs:hexBinary.This class is not part of the metamodel and is not itself a named class in the specification.
See: https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.2/query-language.html#casting
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(hex_cast: Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]) None[source]
Initialize with the given values.
- hex_cast: Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]
The operand to be cast
- class aas_core3_2.types.BooleanCast(bool_cast: Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast])[source]
Cast the operand to
xs:boolean.This class is not part of the metamodel and is not itself a named class in the specification.
See: https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.2/query-language.html#casting
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(bool_cast: Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]) None[source]
Initialize with the given values.
- bool_cast: Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]
The operand to be cast
- class aas_core3_2.types.DateTimeCast(date_time_cast: Union[FieldOperand, StringLiteral, StringCast, AttributeOperand])[source]
Cast the string operand to
xs:dateTime.This class is not part of the metamodel and is not itself a named class in the specification.
See: https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.2/query-language.html#casting
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(date_time_cast: Union[FieldOperand, StringLiteral, StringCast, AttributeOperand]) None[source]
Initialize with the given values.
- date_time_cast: Union[FieldOperand, StringLiteral, StringCast, AttributeOperand]
The operand to be cast
- class aas_core3_2.types.TimeCast(time_cast: Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, DateTimeLiteral, DateTimeCast])[source]
Cast the string or date-time operand to
xs:time.This class is not part of the metamodel and is not itself a named class in the specification.
See: https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.2/query-language.html#casting
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(time_cast: Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, DateTimeLiteral, DateTimeCast]) None[source]
Initialize with the given values.
- time_cast: Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, DateTimeLiteral, DateTimeCast]
The operand to be cast
- class aas_core3_2.types.DayOfWeek(day_of_week: Union[DateTimeLiteral, DateTimeCast, DateTimeAttributeOperand])[source]
Extract the day of the week from the date-time operand as a number.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(day_of_week: Union[DateTimeLiteral, DateTimeCast, DateTimeAttributeOperand]) None[source]
Initialize with the given values.
- day_of_week: Union[DateTimeLiteral, DateTimeCast, DateTimeAttributeOperand]
The date-time operand
- class aas_core3_2.types.DayOfMonth(day_of_month: Union[DateTimeLiteral, DateTimeCast, DateTimeAttributeOperand])[source]
Extract the day of the month from the date-time operand as a number.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(day_of_month: Union[DateTimeLiteral, DateTimeCast, DateTimeAttributeOperand]) None[source]
Initialize with the given values.
- day_of_month: Union[DateTimeLiteral, DateTimeCast, DateTimeAttributeOperand]
The date-time operand
- class aas_core3_2.types.Month(month: Union[DateTimeLiteral, DateTimeCast, DateTimeAttributeOperand])[source]
Extract the month from the date-time operand as a number.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(month: Union[DateTimeLiteral, DateTimeCast, DateTimeAttributeOperand]) None[source]
Initialize with the given values.
- month: Union[DateTimeLiteral, DateTimeCast, DateTimeAttributeOperand]
The date-time operand
- class aas_core3_2.types.Year(year: Union[DateTimeLiteral, DateTimeCast, DateTimeAttributeOperand])[source]
Extract the year from the date-time operand as a number.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(year: Union[DateTimeLiteral, DateTimeCast, DateTimeAttributeOperand]) None[source]
Initialize with the given values.
- year: Union[DateTimeLiteral, DateTimeCast, DateTimeAttributeOperand]
The date-time operand
- class aas_core3_2.types.DateTimeAttributeOperand(attribute: DateTimeAttributeItem)[source]
Use a date-time global attribute as an operand.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(attribute: DateTimeAttributeItem) None[source]
Initialize with the given values.
- attribute: DateTimeAttributeItem
The attribute
- class aas_core3_2.types.EqualComparison(eq: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]])[source]
Check whether the two operands are equal.
This class is not part of the metamodel and is not itself a named class in the specification.
The operands must be of compatible types, see https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.2/query-language.html#_json_schema
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(eq: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]]) None[source]
Initialize with the given values.
- eq: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]]
The two operands
- class aas_core3_2.types.NotEqualComparison(ne: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]])[source]
Check whether the two operands are not equal.
This class is not part of the metamodel and is not itself a named class in the specification.
The operands must be of compatible types, see https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.2/query-language.html#_json_schema
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(ne: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]]) None[source]
Initialize with the given values.
- ne: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]]
The two operands
- class aas_core3_2.types.GreaterThanComparison(gt: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]])[source]
Check whether the first operand is greater than the second one.
This class is not part of the metamodel and is not itself a named class in the specification.
The operands must be of compatible types, see https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.2/query-language.html#_json_schema
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(gt: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]]) None[source]
Initialize with the given values.
- gt: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]]
The two operands
- class aas_core3_2.types.GreaterThanOrEqualComparison(ge: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]])[source]
Check whether the first operand is greater than or equal to the second one.
This class is not part of the metamodel and is not itself a named class in the specification.
The operands must be of compatible types, see https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.2/query-language.html#_json_schema
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(ge: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]]) None[source]
Initialize with the given values.
- ge: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]]
The two operands
- class aas_core3_2.types.LessThanComparison(lt: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]])[source]
Check whether the first operand is less than the second one.
This class is not part of the metamodel and is not itself a named class in the specification.
The operands must be of compatible types, see https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.2/query-language.html#_json_schema
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(lt: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]]) None[source]
Initialize with the given values.
- lt: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]]
The two operands
- class aas_core3_2.types.LessThanOrEqualComparison(le: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]])[source]
Check whether the first operand is less than or equal to the second one.
This class is not part of the metamodel and is not itself a named class in the specification.
The operands must be of compatible types, see https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.2/query-language.html#_json_schema
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(le: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]]) None[source]
Initialize with the given values.
- le: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand, NumberLiteral, NumberCast, DayOfWeek, DayOfMonth, Month, Year, HexLiteral, HexCast, BooleanLiteral, BooleanCast, DateTimeLiteral, DateTimeCast, TimeLiteral, TimeCast]]
The two operands
- class aas_core3_2.types.ContainsComparison(contains: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand]])[source]
Check whether the second string operand is a substring of the first one.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(contains: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand]]) None[source]
Initialize with the given values.
- contains: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand]]
The two string operands
- class aas_core3_2.types.StartsWithComparison(starts_with: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand]])[source]
Check whether the first string operand starts with the second one.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(starts_with: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand]]) None[source]
Initialize with the given values.
- starts_with: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand]]
The two string operands
- class aas_core3_2.types.EndsWithComparison(ends_with: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand]])[source]
Check whether the first string operand ends with the second one.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(ends_with: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand]]) None[source]
Initialize with the given values.
- ends_with: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand]]
The two string operands
- class aas_core3_2.types.RegexComparison(regex: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand]])[source]
Check whether the first string operand matches the regular expression given as the second one.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(regex: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand]]) None[source]
Initialize with the given values.
- regex: Tuple[Union[FieldOperand, StringLiteral, StringCast, AttributeOperand], Union[FieldOperand, StringLiteral, StringCast, AttributeOperand]]
The string operand and the regular expression
- class aas_core3_2.types.MatchClause(match_operands: List[Union[MatchClause, EqualComparison, NotEqualComparison, GreaterThanComparison, GreaterThanOrEqualComparison, LessThanComparison, LessThanOrEqualComparison, ContainsComparison, StartsWithComparison, EndsWithComparison, RegexComparison]])[source]
Check that all the operands hold for the same element of a list.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(match_operands: List[Union[MatchClause, EqualComparison, NotEqualComparison, GreaterThanComparison, GreaterThanOrEqualComparison, LessThanComparison, LessThanOrEqualComparison, ContainsComparison, StartsWithComparison, EndsWithComparison, RegexComparison]]) None[source]
Initialize with the given values.
- match_operands: List[Union[MatchClause, EqualComparison, NotEqualComparison, GreaterThanComparison, GreaterThanOrEqualComparison, LessThanComparison, LessThanOrEqualComparison, ContainsComparison, StartsWithComparison, EndsWithComparison, RegexComparison]]
The comparisons and nested matches which all need to hold
- class aas_core3_2.types.AndExpression(and_operands: List[Union[AndExpression, OrExpression, NotExpression, BooleanLiteral, MatchClause, EqualComparison, NotEqualComparison, GreaterThanComparison, GreaterThanOrEqualComparison, LessThanComparison, LessThanOrEqualComparison, ContainsComparison, StartsWithComparison, EndsWithComparison, RegexComparison]])[source]
Connect two or more expressions through a logical AND.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(and_operands: List[Union[AndExpression, OrExpression, NotExpression, BooleanLiteral, MatchClause, EqualComparison, NotEqualComparison, GreaterThanComparison, GreaterThanOrEqualComparison, LessThanComparison, LessThanOrEqualComparison, ContainsComparison, StartsWithComparison, EndsWithComparison, RegexComparison]]) None[source]
Initialize with the given values.
- and_operands: List[Union[AndExpression, OrExpression, NotExpression, BooleanLiteral, MatchClause, EqualComparison, NotEqualComparison, GreaterThanComparison, GreaterThanOrEqualComparison, LessThanComparison, LessThanOrEqualComparison, ContainsComparison, StartsWithComparison, EndsWithComparison, RegexComparison]]
The expressions to be connected
- class aas_core3_2.types.OrExpression(or_operands: List[Union[AndExpression, OrExpression, NotExpression, BooleanLiteral, MatchClause, EqualComparison, NotEqualComparison, GreaterThanComparison, GreaterThanOrEqualComparison, LessThanComparison, LessThanOrEqualComparison, ContainsComparison, StartsWithComparison, EndsWithComparison, RegexComparison]])[source]
Connect two or more expressions through a logical OR.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(or_operands: List[Union[AndExpression, OrExpression, NotExpression, BooleanLiteral, MatchClause, EqualComparison, NotEqualComparison, GreaterThanComparison, GreaterThanOrEqualComparison, LessThanComparison, LessThanOrEqualComparison, ContainsComparison, StartsWithComparison, EndsWithComparison, RegexComparison]]) None[source]
Initialize with the given values.
- or_operands: List[Union[AndExpression, OrExpression, NotExpression, BooleanLiteral, MatchClause, EqualComparison, NotEqualComparison, GreaterThanComparison, GreaterThanOrEqualComparison, LessThanComparison, LessThanOrEqualComparison, ContainsComparison, StartsWithComparison, EndsWithComparison, RegexComparison]]
The expressions to be connected
- class aas_core3_2.types.NotExpression(not_operand: Union[AndExpression, OrExpression, NotExpression, BooleanLiteral, MatchClause, EqualComparison, NotEqualComparison, GreaterThanComparison, GreaterThanOrEqualComparison, LessThanComparison, LessThanOrEqualComparison, ContainsComparison, StartsWithComparison, EndsWithComparison, RegexComparison])[source]
Negate an expression.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(not_operand: Union[AndExpression, OrExpression, NotExpression, BooleanLiteral, MatchClause, EqualComparison, NotEqualComparison, GreaterThanComparison, GreaterThanOrEqualComparison, LessThanComparison, LessThanOrEqualComparison, ContainsComparison, StartsWithComparison, EndsWithComparison, RegexComparison]) None[source]
Initialize with the given values.
- not_operand: Union[AndExpression, OrExpression, NotExpression, BooleanLiteral, MatchClause, EqualComparison, NotEqualComparison, GreaterThanComparison, GreaterThanOrEqualComparison, LessThanComparison, LessThanOrEqualComparison, ContainsComparison, StartsWithComparison, EndsWithComparison, RegexComparison]
The expression to be negated
- class aas_core3_2.types.QuerySelect(value)[source]
Enumerate what a query returns instead of the full objects.
- ID = 'id'
Return only the identifiers of the matching objects
- class aas_core3_2.types.QueryFilter(fragment: str, condition: Union[AndExpression, OrExpression, NotExpression, BooleanLiteral, MatchClause, EqualComparison, NotEqualComparison, GreaterThanComparison, GreaterThanOrEqualComparison, LessThanComparison, LessThanOrEqualComparison, ContainsComparison, StartsWithComparison, EndsWithComparison, RegexComparison])[source]
Filter a fragment of the returned data by a condition.
This class is not part of the metamodel and is not itself a named class in the specification.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(fragment: str, condition: Union[AndExpression, OrExpression, NotExpression, BooleanLiteral, MatchClause, EqualComparison, NotEqualComparison, GreaterThanComparison, GreaterThanOrEqualComparison, LessThanComparison, LessThanOrEqualComparison, ContainsComparison, StartsWithComparison, EndsWithComparison, RegexComparison]) None[source]
Initialize with the given values.
- fragment: str
The fragment of the returned data to which the filter applies
- condition: Union[AndExpression, OrExpression, NotExpression, BooleanLiteral, MatchClause, EqualComparison, NotEqualComparison, GreaterThanComparison, GreaterThanOrEqualComparison, LessThanComparison, LessThanOrEqualComparison, ContainsComparison, StartsWithComparison, EndsWithComparison, RegexComparison]
The condition which the elements of the fragment need to fulfill
- class aas_core3_2.types.Query(condition: Union[AndExpression, OrExpression, NotExpression, BooleanLiteral, MatchClause, EqualComparison, NotEqualComparison, GreaterThanComparison, GreaterThanOrEqualComparison, LessThanComparison, LessThanOrEqualComparison, ContainsComparison, StartsWithComparison, EndsWithComparison, RegexComparison], select: Optional[QuerySelect] = None, filters: Optional[List[QueryFilter]] = None)[source]
A query in the AAS Query Language.
This class is not part of the metamodel and is not itself a named class in the specification.
See: https://industrialdigitaltwin.io/aas-specifications/IDTA-01002/v3.2/query-language.html
- over_filters_or_empty() Iterator[QueryFilter][source]
Yield from
filtersif set.
- descend_once() Iterator[Class][source]
Iterate over the instances referenced from this instance.
We do not recurse into the referenced instance.
- Yield
instances directly referenced from this instance
- descend() Iterator[Class][source]
Iterate recursively over the instances referenced from this one.
- Yield
instances recursively referenced from this instance
- accept(visitor: AbstractVisitor) None[source]
Dispatch the
visitoron this instance.
- accept_with_context(visitor: AbstractVisitorWithContext[ContextT], context: ContextT) None[source]
Dispatch the
visitoron this instance incontext.
- transform(transformer: AbstractTransformer[T]) T[source]
Dispatch the
transformeron this instance.
- transform_with_context(transformer: AbstractTransformerWithContext[ContextT, T], context: ContextT) T[source]
Dispatch the
transformeron this instance incontext.
- __init__(condition: Union[AndExpression, OrExpression, NotExpression, BooleanLiteral, MatchClause, EqualComparison, NotEqualComparison, GreaterThanComparison, GreaterThanOrEqualComparison, LessThanComparison, LessThanOrEqualComparison, ContainsComparison, StartsWithComparison, EndsWithComparison, RegexComparison], select: Optional[QuerySelect] = None, filters: Optional[List[QueryFilter]] = None) None[source]
Initialize with the given values.
- condition: Union[AndExpression, OrExpression, NotExpression, BooleanLiteral, MatchClause, EqualComparison, NotEqualComparison, GreaterThanComparison, GreaterThanOrEqualComparison, LessThanComparison, LessThanOrEqualComparison, ContainsComparison, StartsWithComparison, EndsWithComparison, RegexComparison]
The condition which the returned objects need to fulfill
- select: Optional[QuerySelect]
What the query returns instead of the full objects.
If not specified, the full objects are returned.
- filters: Optional[List[QueryFilter]]
Filters to reduce the returned data
- aas_core3_2.types.AttributeItem
Represent a union of classes.
alias of
Union[ClaimAttribute,GlobalAttribute,ReferenceAttribute]
- aas_core3_2.types.StringValue
Represent a union of classes.
alias of
Union[FieldOperand,StringLiteral,StringCast,AttributeOperand]
- aas_core3_2.types.DateTimeOperand
Represent a union of classes.
alias of
Union[DateTimeLiteral,DateTimeCast,DateTimeAttributeOperand]
- aas_core3_2.types.TimeCastOperand
Represent a union of classes.
alias of
Union[FieldOperand,StringLiteral,StringCast,AttributeOperand,DateTimeLiteral,DateTimeCast]
- aas_core3_2.types.NumericalOperand
Represent a union of classes.
alias of
Union[NumberLiteral,NumberCast,DayOfWeek,DayOfMonth,Month,Year]
- aas_core3_2.types.HexOperand
Represent a union of classes.
alias of
Union[HexLiteral,HexCast]
- aas_core3_2.types.BoolOperand
Represent a union of classes.
alias of
Union[BooleanLiteral,BooleanCast]
- aas_core3_2.types.TimeOperand
Represent a union of classes.
alias of
Union[TimeLiteral,TimeCast]
- aas_core3_2.types.Value
Represent a union of classes.
alias of
Union[FieldOperand,StringLiteral,StringCast,AttributeOperand,NumberLiteral,NumberCast,DayOfWeek,DayOfMonth,Month,Year,HexLiteral,HexCast,BooleanLiteral,BooleanCast,DateTimeLiteral,DateTimeCast,TimeLiteral,TimeCast]
- aas_core3_2.types.MatchExpression
Represent a union of classes.
alias of
Union[MatchClause,EqualComparison,NotEqualComparison,GreaterThanComparison,GreaterThanOrEqualComparison,LessThanComparison,LessThanOrEqualComparison,ContainsComparison,StartsWithComparison,EndsWithComparison,RegexComparison]
- aas_core3_2.types.LogicalExpression
Represent a union of classes.
alias of
Union[AndExpression,OrExpression,NotExpression,BooleanLiteral,MatchClause,EqualComparison,NotEqualComparison,GreaterThanComparison,GreaterThanOrEqualComparison,LessThanComparison,LessThanOrEqualComparison,ContainsComparison,StartsWithComparison,EndsWithComparison,RegexComparison]
- class aas_core3_2.types.AbstractVisitor[source]
Visit the instances of the model.
- abstract visit_administrative_information(that: AdministrativeInformation) None[source]
Visit
that.
- abstract visit_asset_administration_shell(that: AssetAdministrationShell) None[source]
Visit
that.
- abstract visit_asset_information(that: AssetInformation) None[source]
Visit
that.
- abstract visit_specific_asset_id(that: SpecificAssetID) None[source]
Visit
that.
- abstract visit_relationship_element(that: RelationshipElement) None[source]
Visit
that.
- abstract visit_submodel_element_list(that: SubmodelElementList) None[source]
Visit
that.
- abstract visit_submodel_element_collection(that: SubmodelElementCollection) None[source]
Visit
that.
- abstract visit_multi_language_property(that: MultiLanguageProperty) None[source]
Visit
that.
- abstract visit_reference_element(that: ReferenceElement) None[source]
Visit
that.
- abstract visit_annotated_relationship_element(that: AnnotatedRelationshipElement) None[source]
Visit
that.
- abstract visit_event_payload(that: EventPayload) None[source]
Visit
that.
- abstract visit_basic_event_element(that: BasicEventElement) None[source]
Visit
that.
- abstract visit_operation_variable(that: OperationVariable) None[source]
Visit
that.
- abstract visit_capability(that: Capability) None[source]
Visit
that.
- abstract visit_concept_description(that: ConceptDescription) None[source]
Visit
that.
- abstract visit_lang_string_name_type(that: LangStringNameType) None[source]
Visit
that.
- abstract visit_lang_string_text_type(that: LangStringTextType) None[source]
Visit
that.
- abstract visit_environment(that: Environment) None[source]
Visit
that.
- abstract visit_embedded_data_specification(that: EmbeddedDataSpecification) None[source]
Visit
that.
- abstract visit_value_reference_pair(that: ValueReferencePair) None[source]
Visit
that.
- abstract visit_lang_string_preferred_name_type_iec_61360(that: LangStringPreferredNameTypeIEC61360) None[source]
Visit
that.
- abstract visit_lang_string_short_name_type_iec_61360(that: LangStringShortNameTypeIEC61360) None[source]
Visit
that.
- abstract visit_lang_string_definition_type_iec_61360(that: LangStringDefinitionTypeIEC61360) None[source]
Visit
that.
- abstract visit_lang_string_uom(that: LangStringUom) None[source]
Visit
that.
- abstract visit_definition_type_uom(that: DefinitionTypeUom) None[source]
Visit
that.
- abstract visit_data_specification_uom(that: DataSpecificationUom) None[source]
Visit
that.
- abstract visit_data_specification_iec_61360(that: DataSpecificationIEC61360) None[source]
Visit
that.
- abstract visit_asset_administration_shell_descriptor(that: AssetAdministrationShellDescriptor) None[source]
Visit
that.
- abstract visit_submodel_descriptor(that: SubmodelDescriptor) None[source]
Visit
that.
- abstract visit_protocol_information(that: ProtocolInformation) None[source]
Visit
that.
- abstract visit_security_attribute_object(that: SecurityAttributeObject) None[source]
Visit
that.
- abstract visit_service_description(that: ServiceDescription) None[source]
Visit
that.
- abstract visit_asset_administration_shell_recent_change(that: AssetAdministrationShellRecentChange) None[source]
Visit
that.
- abstract visit_concept_description_recent_change(that: ConceptDescriptionRecentChange) None[source]
Visit
that.
- abstract visit_submodel_recent_change(that: SubmodelRecentChange) None[source]
Visit
that.
- abstract visit_operation_request(that: OperationRequest) None[source]
Visit
that.
- abstract visit_operation_request_async(that: OperationRequestAsync) None[source]
Visit
that.
- abstract visit_operation_request_value_only(that: OperationRequestValueOnly) None[source]
Visit
that.
- abstract visit_operation_request_async_value_only(that: OperationRequestAsyncValueOnly) None[source]
Visit
that.
- abstract visit_base_operation_result(that: BaseOperationResult) None[source]
Visit
that.
- abstract visit_operation_result(that: OperationResult) None[source]
Visit
that.
- abstract visit_operation_result_value_only(that: OperationResultValueOnly) None[source]
Visit
that.
- abstract visit_operation_handle(that: OperationHandle) None[source]
Visit
that.
- abstract visit_paged_result(that: PagedResult) None[source]
Visit
that.
- abstract visit_paging_metadata(that: PagingMetadata) None[source]
Visit
that.
- abstract visit_package_description(that: PackageDescription) None[source]
Visit
that.
- abstract visit_property_metadata(that: PropertyMetadata) None[source]
Visit
that.
- abstract visit_range_metadata(that: RangeMetadata) None[source]
Visit
that.
- abstract visit_blob_metadata(that: BlobMetadata) None[source]
Visit
that.
- abstract visit_file_metadata(that: FileMetadata) None[source]
Visit
that.
- abstract visit_multi_language_property_metadata(that: MultiLanguagePropertyMetadata) None[source]
Visit
that.
- abstract visit_reference_element_metadata(that: ReferenceElementMetadata) None[source]
Visit
that.
- abstract visit_relationship_element_metadata(that: RelationshipElementMetadata) None[source]
Visit
that.
- abstract visit_annotated_relationship_element_metadata(that: AnnotatedRelationshipElementMetadata) None[source]
Visit
that.
- abstract visit_entity_metadata(that: EntityMetadata) None[source]
Visit
that.
- abstract visit_capability_metadata(that: CapabilityMetadata) None[source]
Visit
that.
- abstract visit_operation_metadata(that: OperationMetadata) None[source]
Visit
that.
- abstract visit_submodel_element_collection_metadata(that: SubmodelElementCollectionMetadata) None[source]
Visit
that.
- abstract visit_basic_event_element_metadata(that: BasicEventElementMetadata) None[source]
Visit
that.
- abstract visit_submodel_element_list_metadata(that: SubmodelElementListMetadata) None[source]
Visit
that.
- abstract visit_submodel_metadata(that: SubmodelMetadata) None[source]
Visit
that.
- abstract visit_asset_administration_shell_metadata(that: AssetAdministrationShellMetadata) None[source]
Visit
that.
- abstract visit_reference_element_value(that: ReferenceElementValue) None[source]
Visit
that.
- abstract visit_range_value(that: RangeValue) None[source]
Visit
that.
- abstract visit_relationship_element_value(that: RelationshipElementValue) None[source]
Visit
that.
- abstract visit_basic_event_element_value(that: BasicEventElementValue) None[source]
Visit
that.
- abstract visit_annotated_relationship_element_value(that: AnnotatedRelationshipElementValue) None[source]
Visit
that.
- abstract visit_entity_value(that: EntityValue) None[source]
Visit
that.
- abstract visit_get_asset_administration_shells_result(that: GetAssetAdministrationShellsResult) None[source]
Visit
that.
- abstract visit_get_asset_administration_shells_metadata_result(that: GetAssetAdministrationShellsMetadataResult) None[source]
Visit
that.
- abstract visit_get_all_asset_administration_shells_recent_changes_result(that: GetAllAssetAdministrationShellsRecentChangesResult) None[source]
Visit
that.
- abstract visit_get_asset_administration_shell_descriptors_result(that: GetAssetAdministrationShellDescriptorsResult) None[source]
Visit
that.
- abstract visit_get_concept_descriptions_result(that: GetConceptDescriptionsResult) None[source]
Visit
that.
- abstract visit_get_all_concept_descriptions_recent_changes_result(that: GetAllConceptDescriptionsRecentChangesResult) None[source]
Visit
that.
- abstract visit_get_package_descriptions_result(that: GetPackageDescriptionsResult) None[source]
Visit
that.
- abstract visit_get_path_items_result(that: GetPathItemsResult) None[source]
Visit
that.
- abstract visit_get_references_result(that: GetReferencesResult) None[source]
Visit
that.
- abstract visit_get_submodel_descriptors_result(that: GetSubmodelDescriptorsResult) None[source]
Visit
that.
- abstract visit_get_submodel_elements_metadata_result(that: GetSubmodelElementsMetadataResult) None[source]
Visit
that.
- abstract visit_get_submodel_elements_result(that: GetSubmodelElementsResult) None[source]
Visit
that.
- abstract visit_get_submodel_elements_value_result(that: GetSubmodelElementsValueResult) None[source]
Visit
that.
- abstract visit_get_all_submodels_recent_changes_result(that: GetAllSubmodelsRecentChangesResult) None[source]
Visit
that.
- abstract visit_get_submodels_metadata_result(that: GetSubmodelsMetadataResult) None[source]
Visit
that.
- abstract visit_get_submodels_result(that: GetSubmodelsResult) None[source]
Visit
that.
- abstract visit_get_submodels_value_result(that: GetSubmodelsValueResult) None[source]
Visit
that.
- abstract visit_claim_attribute(that: ClaimAttribute) None[source]
Visit
that.
- abstract visit_global_attribute(that: GlobalAttribute) None[source]
Visit
that.
- abstract visit_reference_attribute(that: ReferenceAttribute) None[source]
Visit
that.
- abstract visit_date_time_attribute_item(that: DateTimeAttributeItem) None[source]
Visit
that.
- abstract visit_field_operand(that: FieldOperand) None[source]
Visit
that.
- abstract visit_string_literal(that: StringLiteral) None[source]
Visit
that.
- abstract visit_attribute_operand(that: AttributeOperand) None[source]
Visit
that.
- abstract visit_number_literal(that: NumberLiteral) None[source]
Visit
that.
- abstract visit_hex_literal(that: HexLiteral) None[source]
Visit
that.
- abstract visit_date_time_literal(that: DateTimeLiteral) None[source]
Visit
that.
- abstract visit_time_literal(that: TimeLiteral) None[source]
Visit
that.
- abstract visit_boolean_literal(that: BooleanLiteral) None[source]
Visit
that.
- abstract visit_string_cast(that: StringCast) None[source]
Visit
that.
- abstract visit_number_cast(that: NumberCast) None[source]
Visit
that.
- abstract visit_boolean_cast(that: BooleanCast) None[source]
Visit
that.
- abstract visit_date_time_cast(that: DateTimeCast) None[source]
Visit
that.
- abstract visit_day_of_month(that: DayOfMonth) None[source]
Visit
that.
- abstract visit_date_time_attribute_operand(that: DateTimeAttributeOperand) None[source]
Visit
that.
- abstract visit_equal_comparison(that: EqualComparison) None[source]
Visit
that.
- abstract visit_not_equal_comparison(that: NotEqualComparison) None[source]
Visit
that.
- abstract visit_greater_than_comparison(that: GreaterThanComparison) None[source]
Visit
that.
- abstract visit_greater_than_or_equal_comparison(that: GreaterThanOrEqualComparison) None[source]
Visit
that.
- abstract visit_less_than_comparison(that: LessThanComparison) None[source]
Visit
that.
- abstract visit_less_than_or_equal_comparison(that: LessThanOrEqualComparison) None[source]
Visit
that.
- abstract visit_contains_comparison(that: ContainsComparison) None[source]
Visit
that.
- abstract visit_starts_with_comparison(that: StartsWithComparison) None[source]
Visit
that.
- abstract visit_ends_with_comparison(that: EndsWithComparison) None[source]
Visit
that.
- abstract visit_regex_comparison(that: RegexComparison) None[source]
Visit
that.
- abstract visit_match_clause(that: MatchClause) None[source]
Visit
that.
- abstract visit_and_expression(that: AndExpression) None[source]
Visit
that.
- abstract visit_or_expression(that: OrExpression) None[source]
Visit
that.
- abstract visit_not_expression(that: NotExpression) None[source]
Visit
that.
- abstract visit_query_filter(that: QueryFilter) None[source]
Visit
that.
- class aas_core3_2.types.AbstractVisitorWithContext[source]
Visit the instances of the model with context.
- abstract visit_extension_with_context(that: Extension, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_administrative_information_with_context(that: AdministrativeInformation, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_qualifier_with_context(that: Qualifier, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_asset_administration_shell_with_context(that: AssetAdministrationShell, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_asset_information_with_context(that: AssetInformation, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_resource_with_context(that: Resource, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_specific_asset_id_with_context(that: SpecificAssetID, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_submodel_with_context(that: Submodel, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_relationship_element_with_context(that: RelationshipElement, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_submodel_element_list_with_context(that: SubmodelElementList, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_submodel_element_collection_with_context(that: SubmodelElementCollection, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_property_with_context(that: Property, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_multi_language_property_with_context(that: MultiLanguageProperty, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_range_with_context(that: Range, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_reference_element_with_context(that: ReferenceElement, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_blob_with_context(that: Blob, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_file_with_context(that: File, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_annotated_relationship_element_with_context(that: AnnotatedRelationshipElement, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_entity_with_context(that: Entity, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_event_payload_with_context(that: EventPayload, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_basic_event_element_with_context(that: BasicEventElement, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_operation_with_context(that: Operation, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_operation_variable_with_context(that: OperationVariable, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_capability_with_context(that: Capability, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_concept_description_with_context(that: ConceptDescription, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_reference_with_context(that: Reference, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_lang_string_name_type_with_context(that: LangStringNameType, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_lang_string_text_type_with_context(that: LangStringTextType, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_environment_with_context(that: Environment, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_embedded_data_specification_with_context(that: EmbeddedDataSpecification, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_level_type_with_context(that: LevelType, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_value_reference_pair_with_context(that: ValueReferencePair, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_value_list_with_context(that: ValueList, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_lang_string_preferred_name_type_iec_61360_with_context(that: LangStringPreferredNameTypeIEC61360, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_lang_string_short_name_type_iec_61360_with_context(that: LangStringShortNameTypeIEC61360, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_lang_string_definition_type_iec_61360_with_context(that: LangStringDefinitionTypeIEC61360, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_lang_string_uom_with_context(that: LangStringUom, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_definition_type_uom_with_context(that: DefinitionTypeUom, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_data_specification_uom_with_context(that: DataSpecificationUom, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_data_specification_iec_61360_with_context(that: DataSpecificationIEC61360, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_asset_administration_shell_descriptor_with_context(that: AssetAdministrationShellDescriptor, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_submodel_descriptor_with_context(that: SubmodelDescriptor, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_endpoint_with_context(that: Endpoint, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_protocol_information_with_context(that: ProtocolInformation, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_security_attribute_object_with_context(that: SecurityAttributeObject, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_asset_link_with_context(that: AssetLink, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_service_description_with_context(that: ServiceDescription, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_asset_administration_shell_recent_change_with_context(that: AssetAdministrationShellRecentChange, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_concept_description_recent_change_with_context(that: ConceptDescriptionRecentChange, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_submodel_recent_change_with_context(that: SubmodelRecentChange, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_result_with_context(that: Result, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_message_with_context(that: Message, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_operation_request_with_context(that: OperationRequest, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_operation_request_async_with_context(that: OperationRequestAsync, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_operation_request_value_only_with_context(that: OperationRequestValueOnly, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_operation_request_async_value_only_with_context(that: OperationRequestAsyncValueOnly, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_base_operation_result_with_context(that: BaseOperationResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_operation_result_with_context(that: OperationResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_operation_result_value_only_with_context(that: OperationResultValueOnly, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_operation_handle_with_context(that: OperationHandle, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_paged_result_with_context(that: PagedResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_paging_metadata_with_context(that: PagingMetadata, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_package_description_with_context(that: PackageDescription, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_property_metadata_with_context(that: PropertyMetadata, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_range_metadata_with_context(that: RangeMetadata, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_blob_metadata_with_context(that: BlobMetadata, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_file_metadata_with_context(that: FileMetadata, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_multi_language_property_metadata_with_context(that: MultiLanguagePropertyMetadata, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_reference_element_metadata_with_context(that: ReferenceElementMetadata, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_relationship_element_metadata_with_context(that: RelationshipElementMetadata, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_annotated_relationship_element_metadata_with_context(that: AnnotatedRelationshipElementMetadata, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_entity_metadata_with_context(that: EntityMetadata, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_capability_metadata_with_context(that: CapabilityMetadata, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_operation_metadata_with_context(that: OperationMetadata, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_submodel_element_collection_metadata_with_context(that: SubmodelElementCollectionMetadata, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_basic_event_element_metadata_with_context(that: BasicEventElementMetadata, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_submodel_element_list_metadata_with_context(that: SubmodelElementListMetadata, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_submodel_metadata_with_context(that: SubmodelMetadata, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_asset_administration_shell_metadata_with_context(that: AssetAdministrationShellMetadata, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_reference_element_value_with_context(that: ReferenceElementValue, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_blob_value_with_context(that: BlobValue, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_file_value_with_context(that: FileValue, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_range_value_with_context(that: RangeValue, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_relationship_element_value_with_context(that: RelationshipElementValue, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_basic_event_element_value_with_context(that: BasicEventElementValue, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_annotated_relationship_element_value_with_context(that: AnnotatedRelationshipElementValue, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_entity_value_with_context(that: EntityValue, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_get_asset_administration_shells_result_with_context(that: GetAssetAdministrationShellsResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_get_asset_administration_shells_metadata_result_with_context(that: GetAssetAdministrationShellsMetadataResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_get_all_asset_administration_shells_recent_changes_result_with_context(that: GetAllAssetAdministrationShellsRecentChangesResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_get_asset_administration_shell_descriptors_result_with_context(that: GetAssetAdministrationShellDescriptorsResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_get_concept_descriptions_result_with_context(that: GetConceptDescriptionsResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_get_all_concept_descriptions_recent_changes_result_with_context(that: GetAllConceptDescriptionsRecentChangesResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_get_package_descriptions_result_with_context(that: GetPackageDescriptionsResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_get_path_items_result_with_context(that: GetPathItemsResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_get_references_result_with_context(that: GetReferencesResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_get_submodel_descriptors_result_with_context(that: GetSubmodelDescriptorsResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_get_submodel_elements_metadata_result_with_context(that: GetSubmodelElementsMetadataResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_get_submodel_elements_result_with_context(that: GetSubmodelElementsResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_get_submodel_elements_value_result_with_context(that: GetSubmodelElementsValueResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_get_all_submodels_recent_changes_result_with_context(that: GetAllSubmodelsRecentChangesResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_get_submodels_metadata_result_with_context(that: GetSubmodelsMetadataResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_get_submodels_result_with_context(that: GetSubmodelsResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_get_submodels_value_result_with_context(that: GetSubmodelsValueResult, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_claim_attribute_with_context(that: ClaimAttribute, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_global_attribute_with_context(that: GlobalAttribute, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_reference_attribute_with_context(that: ReferenceAttribute, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_date_time_attribute_item_with_context(that: DateTimeAttributeItem, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_field_operand_with_context(that: FieldOperand, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_string_literal_with_context(that: StringLiteral, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_attribute_operand_with_context(that: AttributeOperand, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_number_literal_with_context(that: NumberLiteral, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_hex_literal_with_context(that: HexLiteral, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_date_time_literal_with_context(that: DateTimeLiteral, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_time_literal_with_context(that: TimeLiteral, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_boolean_literal_with_context(that: BooleanLiteral, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_string_cast_with_context(that: StringCast, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_number_cast_with_context(that: NumberCast, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_hex_cast_with_context(that: HexCast, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_boolean_cast_with_context(that: BooleanCast, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_date_time_cast_with_context(that: DateTimeCast, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_time_cast_with_context(that: TimeCast, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_day_of_week_with_context(that: DayOfWeek, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_day_of_month_with_context(that: DayOfMonth, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_month_with_context(that: Month, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_year_with_context(that: Year, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_date_time_attribute_operand_with_context(that: DateTimeAttributeOperand, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_equal_comparison_with_context(that: EqualComparison, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_not_equal_comparison_with_context(that: NotEqualComparison, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_greater_than_comparison_with_context(that: GreaterThanComparison, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_greater_than_or_equal_comparison_with_context(that: GreaterThanOrEqualComparison, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_less_than_comparison_with_context(that: LessThanComparison, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_less_than_or_equal_comparison_with_context(that: LessThanOrEqualComparison, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_contains_comparison_with_context(that: ContainsComparison, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_starts_with_comparison_with_context(that: StartsWithComparison, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_ends_with_comparison_with_context(that: EndsWithComparison, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_regex_comparison_with_context(that: RegexComparison, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_match_clause_with_context(that: MatchClause, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_and_expression_with_context(that: AndExpression, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_or_expression_with_context(that: OrExpression, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_not_expression_with_context(that: NotExpression, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_query_filter_with_context(that: QueryFilter, context: ContextT) None[source]
Visit
thatincontext.
- abstract visit_query_with_context(that: Query, context: ContextT) None[source]
Visit
thatincontext.
- __orig_bases__ = (typing.Generic[~ContextT],)
- __parameters__ = (~ContextT,)
- class aas_core3_2.types.PassThroughVisitor[source]
Visit the instances of the model without action.
This visitor is not meant to be directly used. Instead, you usually inherit from it, and implement only the relevant visit methods.
- visit_administrative_information(that: AdministrativeInformation) None[source]
Visit
that.
- visit_asset_administration_shell(that: AssetAdministrationShell) None[source]
Visit
that.
- visit_asset_information(that: AssetInformation) None[source]
Visit
that.
- visit_specific_asset_id(that: SpecificAssetID) None[source]
Visit
that.
- visit_relationship_element(that: RelationshipElement) None[source]
Visit
that.
- visit_submodel_element_list(that: SubmodelElementList) None[source]
Visit
that.
- visit_submodel_element_collection(that: SubmodelElementCollection) None[source]
Visit
that.
- visit_multi_language_property(that: MultiLanguageProperty) None[source]
Visit
that.
- visit_reference_element(that: ReferenceElement) None[source]
Visit
that.
- visit_annotated_relationship_element(that: AnnotatedRelationshipElement) None[source]
Visit
that.
- visit_event_payload(that: EventPayload) None[source]
Visit
that.
- visit_basic_event_element(that: BasicEventElement) None[source]
Visit
that.
- visit_operation_variable(that: OperationVariable) None[source]
Visit
that.
- visit_capability(that: Capability) None[source]
Visit
that.
- visit_concept_description(that: ConceptDescription) None[source]
Visit
that.
- visit_lang_string_name_type(that: LangStringNameType) None[source]
Visit
that.
- visit_lang_string_text_type(that: LangStringTextType) None[source]
Visit
that.
- visit_environment(that: Environment) None[source]
Visit
that.
- visit_embedded_data_specification(that: EmbeddedDataSpecification) None[source]
Visit
that.
- visit_value_reference_pair(that: ValueReferencePair) None[source]
Visit
that.
- visit_lang_string_preferred_name_type_iec_61360(that: LangStringPreferredNameTypeIEC61360) None[source]
Visit
that.
- visit_lang_string_short_name_type_iec_61360(that: LangStringShortNameTypeIEC61360) None[source]
Visit
that.
- visit_lang_string_definition_type_iec_61360(that: LangStringDefinitionTypeIEC61360) None[source]
Visit
that.
- visit_lang_string_uom(that: LangStringUom) None[source]
Visit
that.
- visit_definition_type_uom(that: DefinitionTypeUom) None[source]
Visit
that.
- visit_data_specification_uom(that: DataSpecificationUom) None[source]
Visit
that.
- visit_data_specification_iec_61360(that: DataSpecificationIEC61360) None[source]
Visit
that.
- visit_asset_administration_shell_descriptor(that: AssetAdministrationShellDescriptor) None[source]
Visit
that.
- visit_submodel_descriptor(that: SubmodelDescriptor) None[source]
Visit
that.
- visit_protocol_information(that: ProtocolInformation) None[source]
Visit
that.
- visit_security_attribute_object(that: SecurityAttributeObject) None[source]
Visit
that.
- visit_service_description(that: ServiceDescription) None[source]
Visit
that.
- visit_asset_administration_shell_recent_change(that: AssetAdministrationShellRecentChange) None[source]
Visit
that.
- visit_concept_description_recent_change(that: ConceptDescriptionRecentChange) None[source]
Visit
that.
- visit_submodel_recent_change(that: SubmodelRecentChange) None[source]
Visit
that.
- visit_operation_request(that: OperationRequest) None[source]
Visit
that.
- visit_operation_request_async(that: OperationRequestAsync) None[source]
Visit
that.
- visit_operation_request_value_only(that: OperationRequestValueOnly) None[source]
Visit
that.
- visit_operation_request_async_value_only(that: OperationRequestAsyncValueOnly) None[source]
Visit
that.
- visit_base_operation_result(that: BaseOperationResult) None[source]
Visit
that.
- visit_operation_result(that: OperationResult) None[source]
Visit
that.
- visit_operation_result_value_only(that: OperationResultValueOnly) None[source]
Visit
that.
- visit_operation_handle(that: OperationHandle) None[source]
Visit
that.
- visit_paged_result(that: PagedResult) None[source]
Visit
that.
- visit_paging_metadata(that: PagingMetadata) None[source]
Visit
that.
- visit_package_description(that: PackageDescription) None[source]
Visit
that.
- visit_property_metadata(that: PropertyMetadata) None[source]
Visit
that.
- visit_range_metadata(that: RangeMetadata) None[source]
Visit
that.
- visit_blob_metadata(that: BlobMetadata) None[source]
Visit
that.
- visit_file_metadata(that: FileMetadata) None[source]
Visit
that.
- visit_multi_language_property_metadata(that: MultiLanguagePropertyMetadata) None[source]
Visit
that.
- visit_reference_element_metadata(that: ReferenceElementMetadata) None[source]
Visit
that.
- visit_relationship_element_metadata(that: RelationshipElementMetadata) None[source]
Visit
that.
- visit_annotated_relationship_element_metadata(that: AnnotatedRelationshipElementMetadata) None[source]
Visit
that.
- visit_entity_metadata(that: EntityMetadata) None[source]
Visit
that.
- visit_capability_metadata(that: CapabilityMetadata) None[source]
Visit
that.
- visit_operation_metadata(that: OperationMetadata) None[source]
Visit
that.
- visit_submodel_element_collection_metadata(that: SubmodelElementCollectionMetadata) None[source]
Visit
that.
- visit_basic_event_element_metadata(that: BasicEventElementMetadata) None[source]
Visit
that.
- visit_submodel_element_list_metadata(that: SubmodelElementListMetadata) None[source]
Visit
that.
- visit_submodel_metadata(that: SubmodelMetadata) None[source]
Visit
that.
- visit_asset_administration_shell_metadata(that: AssetAdministrationShellMetadata) None[source]
Visit
that.
- visit_reference_element_value(that: ReferenceElementValue) None[source]
Visit
that.
- visit_range_value(that: RangeValue) None[source]
Visit
that.
- visit_relationship_element_value(that: RelationshipElementValue) None[source]
Visit
that.
- visit_basic_event_element_value(that: BasicEventElementValue) None[source]
Visit
that.
- visit_annotated_relationship_element_value(that: AnnotatedRelationshipElementValue) None[source]
Visit
that.
- visit_entity_value(that: EntityValue) None[source]
Visit
that.
- visit_get_asset_administration_shells_result(that: GetAssetAdministrationShellsResult) None[source]
Visit
that.
- visit_get_asset_administration_shells_metadata_result(that: GetAssetAdministrationShellsMetadataResult) None[source]
Visit
that.
- visit_get_all_asset_administration_shells_recent_changes_result(that: GetAllAssetAdministrationShellsRecentChangesResult) None[source]
Visit
that.
- visit_get_asset_administration_shell_descriptors_result(that: GetAssetAdministrationShellDescriptorsResult) None[source]
Visit
that.
- visit_get_concept_descriptions_result(that: GetConceptDescriptionsResult) None[source]
Visit
that.
- visit_get_all_concept_descriptions_recent_changes_result(that: GetAllConceptDescriptionsRecentChangesResult) None[source]
Visit
that.
- visit_get_package_descriptions_result(that: GetPackageDescriptionsResult) None[source]
Visit
that.
- visit_get_path_items_result(that: GetPathItemsResult) None[source]
Visit
that.
- visit_get_references_result(that: GetReferencesResult) None[source]
Visit
that.
- visit_get_submodel_descriptors_result(that: GetSubmodelDescriptorsResult) None[source]
Visit
that.
- visit_get_submodel_elements_metadata_result(that: GetSubmodelElementsMetadataResult) None[source]
Visit
that.
- visit_get_submodel_elements_result(that: GetSubmodelElementsResult) None[source]
Visit
that.
- visit_get_submodel_elements_value_result(that: GetSubmodelElementsValueResult) None[source]
Visit
that.
- visit_get_all_submodels_recent_changes_result(that: GetAllSubmodelsRecentChangesResult) None[source]
Visit
that.
- visit_get_submodels_metadata_result(that: GetSubmodelsMetadataResult) None[source]
Visit
that.
- visit_get_submodels_result(that: GetSubmodelsResult) None[source]
Visit
that.
- visit_get_submodels_value_result(that: GetSubmodelsValueResult) None[source]
Visit
that.
- visit_claim_attribute(that: ClaimAttribute) None[source]
Visit
that.
- visit_global_attribute(that: GlobalAttribute) None[source]
Visit
that.
- visit_reference_attribute(that: ReferenceAttribute) None[source]
Visit
that.
- visit_date_time_attribute_item(that: DateTimeAttributeItem) None[source]
Visit
that.
- visit_field_operand(that: FieldOperand) None[source]
Visit
that.
- visit_string_literal(that: StringLiteral) None[source]
Visit
that.
- visit_attribute_operand(that: AttributeOperand) None[source]
Visit
that.
- visit_number_literal(that: NumberLiteral) None[source]
Visit
that.
- visit_hex_literal(that: HexLiteral) None[source]
Visit
that.
- visit_date_time_literal(that: DateTimeLiteral) None[source]
Visit
that.
- visit_time_literal(that: TimeLiteral) None[source]
Visit
that.
- visit_boolean_literal(that: BooleanLiteral) None[source]
Visit
that.
- visit_string_cast(that: StringCast) None[source]
Visit
that.
- visit_number_cast(that: NumberCast) None[source]
Visit
that.
- visit_boolean_cast(that: BooleanCast) None[source]
Visit
that.
- visit_date_time_cast(that: DateTimeCast) None[source]
Visit
that.
- visit_day_of_month(that: DayOfMonth) None[source]
Visit
that.
- visit_date_time_attribute_operand(that: DateTimeAttributeOperand) None[source]
Visit
that.
- visit_equal_comparison(that: EqualComparison) None[source]
Visit
that.
- visit_not_equal_comparison(that: NotEqualComparison) None[source]
Visit
that.
- visit_greater_than_comparison(that: GreaterThanComparison) None[source]
Visit
that.
- visit_greater_than_or_equal_comparison(that: GreaterThanOrEqualComparison) None[source]
Visit
that.
- visit_less_than_comparison(that: LessThanComparison) None[source]
Visit
that.
- visit_less_than_or_equal_comparison(that: LessThanOrEqualComparison) None[source]
Visit
that.
- visit_contains_comparison(that: ContainsComparison) None[source]
Visit
that.
- visit_starts_with_comparison(that: StartsWithComparison) None[source]
Visit
that.
- visit_ends_with_comparison(that: EndsWithComparison) None[source]
Visit
that.
- visit_regex_comparison(that: RegexComparison) None[source]
Visit
that.
- visit_match_clause(that: MatchClause) None[source]
Visit
that.
- visit_and_expression(that: AndExpression) None[source]
Visit
that.
- visit_or_expression(that: OrExpression) None[source]
Visit
that.
- visit_not_expression(that: NotExpression) None[source]
Visit
that.
- visit_query_filter(that: QueryFilter) None[source]
Visit
that.
- class aas_core3_2.types.PassThroughVisitorWithContext[source]
Visit the instances of the model without action and in context.
This visitor is not meant to be directly used. Instead, you usually inherit from it, and implement only the relevant visit methods.
- visit_extension_with_context(that: Extension, context: ContextT) None[source]
Visit
thatincontext.
- visit_administrative_information_with_context(that: AdministrativeInformation, context: ContextT) None[source]
Visit
thatincontext.
- visit_qualifier_with_context(that: Qualifier, context: ContextT) None[source]
Visit
thatincontext.
- visit_asset_administration_shell_with_context(that: AssetAdministrationShell, context: ContextT) None[source]
Visit
thatincontext.
- visit_asset_information_with_context(that: AssetInformation, context: ContextT) None[source]
Visit
thatincontext.
- visit_specific_asset_id_with_context(that: SpecificAssetID, context: ContextT) None[source]
Visit
thatincontext.
- visit_relationship_element_with_context(that: RelationshipElement, context: ContextT) None[source]
Visit
thatincontext.
- visit_submodel_element_list_with_context(that: SubmodelElementList, context: ContextT) None[source]
Visit
thatincontext.
- visit_submodel_element_collection_with_context(that: SubmodelElementCollection, context: ContextT) None[source]
Visit
thatincontext.
- visit_multi_language_property_with_context(that: MultiLanguageProperty, context: ContextT) None[source]
Visit
thatincontext.
- visit_reference_element_with_context(that: ReferenceElement, context: ContextT) None[source]
Visit
thatincontext.
- visit_annotated_relationship_element_with_context(that: AnnotatedRelationshipElement, context: ContextT) None[source]
Visit
thatincontext.
- visit_event_payload_with_context(that: EventPayload, context: ContextT) None[source]
Visit
thatincontext.
- visit_basic_event_element_with_context(that: BasicEventElement, context: ContextT) None[source]
Visit
thatincontext.
- visit_operation_with_context(that: Operation, context: ContextT) None[source]
Visit
thatincontext.
- visit_operation_variable_with_context(that: OperationVariable, context: ContextT) None[source]
Visit
thatincontext.
- visit_capability_with_context(that: Capability, context: ContextT) None[source]
Visit
thatincontext.
- visit_concept_description_with_context(that: ConceptDescription, context: ContextT) None[source]
Visit
thatincontext.
- visit_reference_with_context(that: Reference, context: ContextT) None[source]
Visit
thatincontext.
- visit_lang_string_name_type_with_context(that: LangStringNameType, context: ContextT) None[source]
Visit
thatincontext.
- visit_lang_string_text_type_with_context(that: LangStringTextType, context: ContextT) None[source]
Visit
thatincontext.
- visit_environment_with_context(that: Environment, context: ContextT) None[source]
Visit
thatincontext.
- visit_embedded_data_specification_with_context(that: EmbeddedDataSpecification, context: ContextT) None[source]
Visit
thatincontext.
- visit_level_type_with_context(that: LevelType, context: ContextT) None[source]
Visit
thatincontext.
- visit_value_reference_pair_with_context(that: ValueReferencePair, context: ContextT) None[source]
Visit
thatincontext.
- visit_value_list_with_context(that: ValueList, context: ContextT) None[source]
Visit
thatincontext.
- visit_lang_string_preferred_name_type_iec_61360_with_context(that: LangStringPreferredNameTypeIEC61360, context: ContextT) None[source]
Visit
thatincontext.
- visit_lang_string_short_name_type_iec_61360_with_context(that: LangStringShortNameTypeIEC61360, context: ContextT) None[source]
Visit
thatincontext.
- visit_lang_string_definition_type_iec_61360_with_context(that: LangStringDefinitionTypeIEC61360, context: ContextT) None[source]
Visit
thatincontext.
- visit_lang_string_uom_with_context(that: LangStringUom, context: ContextT) None[source]
Visit
thatincontext.
- visit_definition_type_uom_with_context(that: DefinitionTypeUom, context: ContextT) None[source]
Visit
thatincontext.
- visit_data_specification_uom_with_context(that: DataSpecificationUom, context: ContextT) None[source]
Visit
thatincontext.
- visit_data_specification_iec_61360_with_context(that: DataSpecificationIEC61360, context: ContextT) None[source]
Visit
thatincontext.
- visit_asset_administration_shell_descriptor_with_context(that: AssetAdministrationShellDescriptor, context: ContextT) None[source]
Visit
thatincontext.
- visit_submodel_descriptor_with_context(that: SubmodelDescriptor, context: ContextT) None[source]
Visit
thatincontext.
- visit_protocol_information_with_context(that: ProtocolInformation, context: ContextT) None[source]
Visit
thatincontext.
- visit_security_attribute_object_with_context(that: SecurityAttributeObject, context: ContextT) None[source]
Visit
thatincontext.
- visit_asset_link_with_context(that: AssetLink, context: ContextT) None[source]
Visit
thatincontext.
- visit_service_description_with_context(that: ServiceDescription, context: ContextT) None[source]
Visit
thatincontext.
- visit_asset_administration_shell_recent_change_with_context(that: AssetAdministrationShellRecentChange, context: ContextT) None[source]
Visit
thatincontext.
- visit_concept_description_recent_change_with_context(that: ConceptDescriptionRecentChange, context: ContextT) None[source]
Visit
thatincontext.
- visit_submodel_recent_change_with_context(that: SubmodelRecentChange, context: ContextT) None[source]
Visit
thatincontext.
- visit_operation_request_with_context(that: OperationRequest, context: ContextT) None[source]
Visit
thatincontext.
- visit_operation_request_async_with_context(that: OperationRequestAsync, context: ContextT) None[source]
Visit
thatincontext.
- visit_operation_request_value_only_with_context(that: OperationRequestValueOnly, context: ContextT) None[source]
Visit
thatincontext.
- visit_operation_request_async_value_only_with_context(that: OperationRequestAsyncValueOnly, context: ContextT) None[source]
Visit
thatincontext.
- visit_base_operation_result_with_context(that: BaseOperationResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_operation_result_with_context(that: OperationResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_operation_result_value_only_with_context(that: OperationResultValueOnly, context: ContextT) None[source]
Visit
thatincontext.
- visit_operation_handle_with_context(that: OperationHandle, context: ContextT) None[source]
Visit
thatincontext.
- visit_paged_result_with_context(that: PagedResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_paging_metadata_with_context(that: PagingMetadata, context: ContextT) None[source]
Visit
thatincontext.
- visit_package_description_with_context(that: PackageDescription, context: ContextT) None[source]
Visit
thatincontext.
- visit_property_metadata_with_context(that: PropertyMetadata, context: ContextT) None[source]
Visit
thatincontext.
- visit_range_metadata_with_context(that: RangeMetadata, context: ContextT) None[source]
Visit
thatincontext.
- visit_blob_metadata_with_context(that: BlobMetadata, context: ContextT) None[source]
Visit
thatincontext.
- visit_file_metadata_with_context(that: FileMetadata, context: ContextT) None[source]
Visit
thatincontext.
- visit_multi_language_property_metadata_with_context(that: MultiLanguagePropertyMetadata, context: ContextT) None[source]
Visit
thatincontext.
- visit_reference_element_metadata_with_context(that: ReferenceElementMetadata, context: ContextT) None[source]
Visit
thatincontext.
- visit_relationship_element_metadata_with_context(that: RelationshipElementMetadata, context: ContextT) None[source]
Visit
thatincontext.
- visit_annotated_relationship_element_metadata_with_context(that: AnnotatedRelationshipElementMetadata, context: ContextT) None[source]
Visit
thatincontext.
- visit_entity_metadata_with_context(that: EntityMetadata, context: ContextT) None[source]
Visit
thatincontext.
- visit_capability_metadata_with_context(that: CapabilityMetadata, context: ContextT) None[source]
Visit
thatincontext.
- visit_operation_metadata_with_context(that: OperationMetadata, context: ContextT) None[source]
Visit
thatincontext.
- visit_submodel_element_collection_metadata_with_context(that: SubmodelElementCollectionMetadata, context: ContextT) None[source]
Visit
thatincontext.
- visit_basic_event_element_metadata_with_context(that: BasicEventElementMetadata, context: ContextT) None[source]
Visit
thatincontext.
- visit_submodel_element_list_metadata_with_context(that: SubmodelElementListMetadata, context: ContextT) None[source]
Visit
thatincontext.
- visit_submodel_metadata_with_context(that: SubmodelMetadata, context: ContextT) None[source]
Visit
thatincontext.
- visit_asset_administration_shell_metadata_with_context(that: AssetAdministrationShellMetadata, context: ContextT) None[source]
Visit
thatincontext.
- visit_reference_element_value_with_context(that: ReferenceElementValue, context: ContextT) None[source]
Visit
thatincontext.
- visit_blob_value_with_context(that: BlobValue, context: ContextT) None[source]
Visit
thatincontext.
- visit_file_value_with_context(that: FileValue, context: ContextT) None[source]
Visit
thatincontext.
- visit_range_value_with_context(that: RangeValue, context: ContextT) None[source]
Visit
thatincontext.
- visit_relationship_element_value_with_context(that: RelationshipElementValue, context: ContextT) None[source]
Visit
thatincontext.
- visit_basic_event_element_value_with_context(that: BasicEventElementValue, context: ContextT) None[source]
Visit
thatincontext.
- visit_annotated_relationship_element_value_with_context(that: AnnotatedRelationshipElementValue, context: ContextT) None[source]
Visit
thatincontext.
- visit_entity_value_with_context(that: EntityValue, context: ContextT) None[source]
Visit
thatincontext.
- visit_get_asset_administration_shells_result_with_context(that: GetAssetAdministrationShellsResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_get_asset_administration_shells_metadata_result_with_context(that: GetAssetAdministrationShellsMetadataResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_get_all_asset_administration_shells_recent_changes_result_with_context(that: GetAllAssetAdministrationShellsRecentChangesResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_get_asset_administration_shell_descriptors_result_with_context(that: GetAssetAdministrationShellDescriptorsResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_get_concept_descriptions_result_with_context(that: GetConceptDescriptionsResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_get_all_concept_descriptions_recent_changes_result_with_context(that: GetAllConceptDescriptionsRecentChangesResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_get_package_descriptions_result_with_context(that: GetPackageDescriptionsResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_get_path_items_result_with_context(that: GetPathItemsResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_get_references_result_with_context(that: GetReferencesResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_get_submodel_descriptors_result_with_context(that: GetSubmodelDescriptorsResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_get_submodel_elements_metadata_result_with_context(that: GetSubmodelElementsMetadataResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_get_submodel_elements_result_with_context(that: GetSubmodelElementsResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_get_submodel_elements_value_result_with_context(that: GetSubmodelElementsValueResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_get_all_submodels_recent_changes_result_with_context(that: GetAllSubmodelsRecentChangesResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_get_submodels_metadata_result_with_context(that: GetSubmodelsMetadataResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_get_submodels_result_with_context(that: GetSubmodelsResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_get_submodels_value_result_with_context(that: GetSubmodelsValueResult, context: ContextT) None[source]
Visit
thatincontext.
- visit_claim_attribute_with_context(that: ClaimAttribute, context: ContextT) None[source]
Visit
thatincontext.
- visit_global_attribute_with_context(that: GlobalAttribute, context: ContextT) None[source]
Visit
thatincontext.
- visit_reference_attribute_with_context(that: ReferenceAttribute, context: ContextT) None[source]
Visit
thatincontext.
- visit_date_time_attribute_item_with_context(that: DateTimeAttributeItem, context: ContextT) None[source]
Visit
thatincontext.
- visit_field_operand_with_context(that: FieldOperand, context: ContextT) None[source]
Visit
thatincontext.
- visit_string_literal_with_context(that: StringLiteral, context: ContextT) None[source]
Visit
thatincontext.
- visit_attribute_operand_with_context(that: AttributeOperand, context: ContextT) None[source]
Visit
thatincontext.
- visit_number_literal_with_context(that: NumberLiteral, context: ContextT) None[source]
Visit
thatincontext.
- visit_hex_literal_with_context(that: HexLiteral, context: ContextT) None[source]
Visit
thatincontext.
- visit_date_time_literal_with_context(that: DateTimeLiteral, context: ContextT) None[source]
Visit
thatincontext.
- visit_time_literal_with_context(that: TimeLiteral, context: ContextT) None[source]
Visit
thatincontext.
- visit_boolean_literal_with_context(that: BooleanLiteral, context: ContextT) None[source]
Visit
thatincontext.
- visit_string_cast_with_context(that: StringCast, context: ContextT) None[source]
Visit
thatincontext.
- visit_number_cast_with_context(that: NumberCast, context: ContextT) None[source]
Visit
thatincontext.
- visit_boolean_cast_with_context(that: BooleanCast, context: ContextT) None[source]
Visit
thatincontext.
- visit_date_time_cast_with_context(that: DateTimeCast, context: ContextT) None[source]
Visit
thatincontext.
- visit_time_cast_with_context(that: TimeCast, context: ContextT) None[source]
Visit
thatincontext.
- visit_day_of_week_with_context(that: DayOfWeek, context: ContextT) None[source]
Visit
thatincontext.
- visit_day_of_month_with_context(that: DayOfMonth, context: ContextT) None[source]
Visit
thatincontext.
- visit_date_time_attribute_operand_with_context(that: DateTimeAttributeOperand, context: ContextT) None[source]
Visit
thatincontext.
- visit_equal_comparison_with_context(that: EqualComparison, context: ContextT) None[source]
Visit
thatincontext.
- visit_not_equal_comparison_with_context(that: NotEqualComparison, context: ContextT) None[source]
Visit
thatincontext.
- visit_greater_than_comparison_with_context(that: GreaterThanComparison, context: ContextT) None[source]
Visit
thatincontext.
- visit_greater_than_or_equal_comparison_with_context(that: GreaterThanOrEqualComparison, context: ContextT) None[source]
Visit
thatincontext.
- visit_less_than_comparison_with_context(that: LessThanComparison, context: ContextT) None[source]
Visit
thatincontext.
- visit_less_than_or_equal_comparison_with_context(that: LessThanOrEqualComparison, context: ContextT) None[source]
Visit
thatincontext.
- visit_contains_comparison_with_context(that: ContainsComparison, context: ContextT) None[source]
Visit
thatincontext.
- visit_starts_with_comparison_with_context(that: StartsWithComparison, context: ContextT) None[source]
Visit
thatincontext.
- visit_ends_with_comparison_with_context(that: EndsWithComparison, context: ContextT) None[source]
Visit
thatincontext.
- visit_regex_comparison_with_context(that: RegexComparison, context: ContextT) None[source]
Visit
thatincontext.
- visit_match_clause_with_context(that: MatchClause, context: ContextT) None[source]
Visit
thatincontext.
- visit_and_expression_with_context(that: AndExpression, context: ContextT) None[source]
Visit
thatincontext.
- visit_or_expression_with_context(that: OrExpression, context: ContextT) None[source]
Visit
thatincontext.
- visit_not_expression_with_context(that: NotExpression, context: ContextT) None[source]
Visit
thatincontext.
- visit_query_filter_with_context(that: QueryFilter, context: ContextT) None[source]
Visit
thatincontext.
- __orig_bases__ = (aas_core3_2.types.AbstractVisitorWithContext[~ContextT],)
- __parameters__ = (~ContextT,)
- class aas_core3_2.types.AbstractTransformer[source]
Transform the instances of the model.
- abstract transform_administrative_information(that: AdministrativeInformation) T[source]
Transform
that.
- abstract transform_asset_administration_shell(that: AssetAdministrationShell) T[source]
Transform
that.
- abstract transform_asset_information(that: AssetInformation) T[source]
Transform
that.
- abstract transform_specific_asset_id(that: SpecificAssetID) T[source]
Transform
that.
- abstract transform_relationship_element(that: RelationshipElement) T[source]
Transform
that.
- abstract transform_submodel_element_list(that: SubmodelElementList) T[source]
Transform
that.
- abstract transform_submodel_element_collection(that: SubmodelElementCollection) T[source]
Transform
that.
- abstract transform_multi_language_property(that: MultiLanguageProperty) T[source]
Transform
that.
- abstract transform_reference_element(that: ReferenceElement) T[source]
Transform
that.
- abstract transform_annotated_relationship_element(that: AnnotatedRelationshipElement) T[source]
Transform
that.
- abstract transform_event_payload(that: EventPayload) T[source]
Transform
that.
- abstract transform_basic_event_element(that: BasicEventElement) T[source]
Transform
that.
- abstract transform_operation_variable(that: OperationVariable) T[source]
Transform
that.
- abstract transform_capability(that: Capability) T[source]
Transform
that.
- abstract transform_concept_description(that: ConceptDescription) T[source]
Transform
that.
- abstract transform_lang_string_name_type(that: LangStringNameType) T[source]
Transform
that.
- abstract transform_lang_string_text_type(that: LangStringTextType) T[source]
Transform
that.
- abstract transform_environment(that: Environment) T[source]
Transform
that.
- abstract transform_embedded_data_specification(that: EmbeddedDataSpecification) T[source]
Transform
that.
- abstract transform_value_reference_pair(that: ValueReferencePair) T[source]
Transform
that.
- abstract transform_lang_string_preferred_name_type_iec_61360(that: LangStringPreferredNameTypeIEC61360) T[source]
Transform
that.
- abstract transform_lang_string_short_name_type_iec_61360(that: LangStringShortNameTypeIEC61360) T[source]
Transform
that.
- abstract transform_lang_string_definition_type_iec_61360(that: LangStringDefinitionTypeIEC61360) T[source]
Transform
that.
- abstract transform_lang_string_uom(that: LangStringUom) T[source]
Transform
that.
- abstract transform_definition_type_uom(that: DefinitionTypeUom) T[source]
Transform
that.
- abstract transform_data_specification_uom(that: DataSpecificationUom) T[source]
Transform
that.
- abstract transform_data_specification_iec_61360(that: DataSpecificationIEC61360) T[source]
Transform
that.
- abstract transform_asset_administration_shell_descriptor(that: AssetAdministrationShellDescriptor) T[source]
Transform
that.
- abstract transform_submodel_descriptor(that: SubmodelDescriptor) T[source]
Transform
that.
- abstract transform_protocol_information(that: ProtocolInformation) T[source]
Transform
that.
- abstract transform_security_attribute_object(that: SecurityAttributeObject) T[source]
Transform
that.
- abstract transform_service_description(that: ServiceDescription) T[source]
Transform
that.
- abstract transform_asset_administration_shell_recent_change(that: AssetAdministrationShellRecentChange) T[source]
Transform
that.
- abstract transform_concept_description_recent_change(that: ConceptDescriptionRecentChange) T[source]
Transform
that.
- abstract transform_submodel_recent_change(that: SubmodelRecentChange) T[source]
Transform
that.
- abstract transform_operation_request(that: OperationRequest) T[source]
Transform
that.
- abstract transform_operation_request_async(that: OperationRequestAsync) T[source]
Transform
that.
- abstract transform_operation_request_value_only(that: OperationRequestValueOnly) T[source]
Transform
that.
- abstract transform_operation_request_async_value_only(that: OperationRequestAsyncValueOnly) T[source]
Transform
that.
- abstract transform_base_operation_result(that: BaseOperationResult) T[source]
Transform
that.
- abstract transform_operation_result(that: OperationResult) T[source]
Transform
that.
- abstract transform_operation_result_value_only(that: OperationResultValueOnly) T[source]
Transform
that.
- abstract transform_operation_handle(that: OperationHandle) T[source]
Transform
that.
- abstract transform_paged_result(that: PagedResult) T[source]
Transform
that.
- abstract transform_paging_metadata(that: PagingMetadata) T[source]
Transform
that.
- abstract transform_package_description(that: PackageDescription) T[source]
Transform
that.
- abstract transform_property_metadata(that: PropertyMetadata) T[source]
Transform
that.
- abstract transform_range_metadata(that: RangeMetadata) T[source]
Transform
that.
- abstract transform_blob_metadata(that: BlobMetadata) T[source]
Transform
that.
- abstract transform_file_metadata(that: FileMetadata) T[source]
Transform
that.
- abstract transform_multi_language_property_metadata(that: MultiLanguagePropertyMetadata) T[source]
Transform
that.
- abstract transform_reference_element_metadata(that: ReferenceElementMetadata) T[source]
Transform
that.
- abstract transform_relationship_element_metadata(that: RelationshipElementMetadata) T[source]
Transform
that.
- abstract transform_annotated_relationship_element_metadata(that: AnnotatedRelationshipElementMetadata) T[source]
Transform
that.
- abstract transform_entity_metadata(that: EntityMetadata) T[source]
Transform
that.
- abstract transform_capability_metadata(that: CapabilityMetadata) T[source]
Transform
that.
- abstract transform_operation_metadata(that: OperationMetadata) T[source]
Transform
that.
- abstract transform_submodel_element_collection_metadata(that: SubmodelElementCollectionMetadata) T[source]
Transform
that.
- abstract transform_basic_event_element_metadata(that: BasicEventElementMetadata) T[source]
Transform
that.
- abstract transform_submodel_element_list_metadata(that: SubmodelElementListMetadata) T[source]
Transform
that.
- abstract transform_submodel_metadata(that: SubmodelMetadata) T[source]
Transform
that.
- abstract transform_asset_administration_shell_metadata(that: AssetAdministrationShellMetadata) T[source]
Transform
that.
- abstract transform_reference_element_value(that: ReferenceElementValue) T[source]
Transform
that.
- abstract transform_range_value(that: RangeValue) T[source]
Transform
that.
- abstract transform_relationship_element_value(that: RelationshipElementValue) T[source]
Transform
that.
- abstract transform_basic_event_element_value(that: BasicEventElementValue) T[source]
Transform
that.
- abstract transform_annotated_relationship_element_value(that: AnnotatedRelationshipElementValue) T[source]
Transform
that.
- abstract transform_entity_value(that: EntityValue) T[source]
Transform
that.
- abstract transform_get_asset_administration_shells_result(that: GetAssetAdministrationShellsResult) T[source]
Transform
that.
- abstract transform_get_asset_administration_shells_metadata_result(that: GetAssetAdministrationShellsMetadataResult) T[source]
Transform
that.
- abstract transform_get_all_asset_administration_shells_recent_changes_result(that: GetAllAssetAdministrationShellsRecentChangesResult) T[source]
Transform
that.
- abstract transform_get_asset_administration_shell_descriptors_result(that: GetAssetAdministrationShellDescriptorsResult) T[source]
Transform
that.
- abstract transform_get_concept_descriptions_result(that: GetConceptDescriptionsResult) T[source]
Transform
that.
- abstract transform_get_all_concept_descriptions_recent_changes_result(that: GetAllConceptDescriptionsRecentChangesResult) T[source]
Transform
that.
- abstract transform_get_package_descriptions_result(that: GetPackageDescriptionsResult) T[source]
Transform
that.
- abstract transform_get_path_items_result(that: GetPathItemsResult) T[source]
Transform
that.
- abstract transform_get_references_result(that: GetReferencesResult) T[source]
Transform
that.
- abstract transform_get_submodel_descriptors_result(that: GetSubmodelDescriptorsResult) T[source]
Transform
that.
- abstract transform_get_submodel_elements_metadata_result(that: GetSubmodelElementsMetadataResult) T[source]
Transform
that.
- abstract transform_get_submodel_elements_result(that: GetSubmodelElementsResult) T[source]
Transform
that.
- abstract transform_get_submodel_elements_value_result(that: GetSubmodelElementsValueResult) T[source]
Transform
that.
- abstract transform_get_all_submodels_recent_changes_result(that: GetAllSubmodelsRecentChangesResult) T[source]
Transform
that.
- abstract transform_get_submodels_metadata_result(that: GetSubmodelsMetadataResult) T[source]
Transform
that.
- abstract transform_get_submodels_result(that: GetSubmodelsResult) T[source]
Transform
that.
- abstract transform_get_submodels_value_result(that: GetSubmodelsValueResult) T[source]
Transform
that.
- abstract transform_claim_attribute(that: ClaimAttribute) T[source]
Transform
that.
- abstract transform_global_attribute(that: GlobalAttribute) T[source]
Transform
that.
- abstract transform_reference_attribute(that: ReferenceAttribute) T[source]
Transform
that.
- abstract transform_date_time_attribute_item(that: DateTimeAttributeItem) T[source]
Transform
that.
- abstract transform_field_operand(that: FieldOperand) T[source]
Transform
that.
- abstract transform_string_literal(that: StringLiteral) T[source]
Transform
that.
- abstract transform_attribute_operand(that: AttributeOperand) T[source]
Transform
that.
- abstract transform_number_literal(that: NumberLiteral) T[source]
Transform
that.
- abstract transform_hex_literal(that: HexLiteral) T[source]
Transform
that.
- abstract transform_date_time_literal(that: DateTimeLiteral) T[source]
Transform
that.
- abstract transform_time_literal(that: TimeLiteral) T[source]
Transform
that.
- abstract transform_boolean_literal(that: BooleanLiteral) T[source]
Transform
that.
- abstract transform_string_cast(that: StringCast) T[source]
Transform
that.
- abstract transform_number_cast(that: NumberCast) T[source]
Transform
that.
- abstract transform_boolean_cast(that: BooleanCast) T[source]
Transform
that.
- abstract transform_date_time_cast(that: DateTimeCast) T[source]
Transform
that.
- abstract transform_day_of_month(that: DayOfMonth) T[source]
Transform
that.
- abstract transform_date_time_attribute_operand(that: DateTimeAttributeOperand) T[source]
Transform
that.
- abstract transform_equal_comparison(that: EqualComparison) T[source]
Transform
that.
- abstract transform_not_equal_comparison(that: NotEqualComparison) T[source]
Transform
that.
- abstract transform_greater_than_comparison(that: GreaterThanComparison) T[source]
Transform
that.
- abstract transform_greater_than_or_equal_comparison(that: GreaterThanOrEqualComparison) T[source]
Transform
that.
- abstract transform_less_than_comparison(that: LessThanComparison) T[source]
Transform
that.
- abstract transform_less_than_or_equal_comparison(that: LessThanOrEqualComparison) T[source]
Transform
that.
- abstract transform_contains_comparison(that: ContainsComparison) T[source]
Transform
that.
- abstract transform_starts_with_comparison(that: StartsWithComparison) T[source]
Transform
that.
- abstract transform_ends_with_comparison(that: EndsWithComparison) T[source]
Transform
that.
- abstract transform_regex_comparison(that: RegexComparison) T[source]
Transform
that.
- abstract transform_match_clause(that: MatchClause) T[source]
Transform
that.
- abstract transform_and_expression(that: AndExpression) T[source]
Transform
that.
- abstract transform_or_expression(that: OrExpression) T[source]
Transform
that.
- abstract transform_not_expression(that: NotExpression) T[source]
Transform
that.
- abstract transform_query_filter(that: QueryFilter) T[source]
Transform
that.
- __orig_bases__ = (typing.Generic[~T],)
- __parameters__ = (~T,)
- class aas_core3_2.types.AbstractTransformerWithContext[source]
Transform the instances of the model in context.
- abstract transform_extension_with_context(that: Extension, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_administrative_information_with_context(that: AdministrativeInformation, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_qualifier_with_context(that: Qualifier, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_asset_administration_shell_with_context(that: AssetAdministrationShell, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_asset_information_with_context(that: AssetInformation, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_resource_with_context(that: Resource, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_specific_asset_id_with_context(that: SpecificAssetID, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_submodel_with_context(that: Submodel, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_relationship_element_with_context(that: RelationshipElement, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_submodel_element_list_with_context(that: SubmodelElementList, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_submodel_element_collection_with_context(that: SubmodelElementCollection, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_property_with_context(that: Property, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_multi_language_property_with_context(that: MultiLanguageProperty, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_range_with_context(that: Range, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_reference_element_with_context(that: ReferenceElement, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_blob_with_context(that: Blob, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_file_with_context(that: File, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_annotated_relationship_element_with_context(that: AnnotatedRelationshipElement, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_entity_with_context(that: Entity, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_event_payload_with_context(that: EventPayload, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_basic_event_element_with_context(that: BasicEventElement, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_operation_with_context(that: Operation, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_operation_variable_with_context(that: OperationVariable, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_capability_with_context(that: Capability, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_concept_description_with_context(that: ConceptDescription, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_reference_with_context(that: Reference, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_key_with_context(that: Key, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_lang_string_name_type_with_context(that: LangStringNameType, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_lang_string_text_type_with_context(that: LangStringTextType, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_environment_with_context(that: Environment, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_embedded_data_specification_with_context(that: EmbeddedDataSpecification, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_level_type_with_context(that: LevelType, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_value_reference_pair_with_context(that: ValueReferencePair, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_value_list_with_context(that: ValueList, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_lang_string_preferred_name_type_iec_61360_with_context(that: LangStringPreferredNameTypeIEC61360, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_lang_string_short_name_type_iec_61360_with_context(that: LangStringShortNameTypeIEC61360, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_lang_string_definition_type_iec_61360_with_context(that: LangStringDefinitionTypeIEC61360, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_lang_string_uom_with_context(that: LangStringUom, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_definition_type_uom_with_context(that: DefinitionTypeUom, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_data_specification_uom_with_context(that: DataSpecificationUom, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_data_specification_iec_61360_with_context(that: DataSpecificationIEC61360, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_asset_administration_shell_descriptor_with_context(that: AssetAdministrationShellDescriptor, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_submodel_descriptor_with_context(that: SubmodelDescriptor, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_endpoint_with_context(that: Endpoint, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_protocol_information_with_context(that: ProtocolInformation, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_security_attribute_object_with_context(that: SecurityAttributeObject, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_asset_link_with_context(that: AssetLink, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_service_description_with_context(that: ServiceDescription, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_asset_administration_shell_recent_change_with_context(that: AssetAdministrationShellRecentChange, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_concept_description_recent_change_with_context(that: ConceptDescriptionRecentChange, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_submodel_recent_change_with_context(that: SubmodelRecentChange, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_result_with_context(that: Result, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_message_with_context(that: Message, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_operation_request_with_context(that: OperationRequest, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_operation_request_async_with_context(that: OperationRequestAsync, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_operation_request_value_only_with_context(that: OperationRequestValueOnly, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_operation_request_async_value_only_with_context(that: OperationRequestAsyncValueOnly, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_base_operation_result_with_context(that: BaseOperationResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_operation_result_with_context(that: OperationResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_operation_result_value_only_with_context(that: OperationResultValueOnly, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_operation_handle_with_context(that: OperationHandle, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_paged_result_with_context(that: PagedResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_paging_metadata_with_context(that: PagingMetadata, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_package_description_with_context(that: PackageDescription, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_property_metadata_with_context(that: PropertyMetadata, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_range_metadata_with_context(that: RangeMetadata, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_blob_metadata_with_context(that: BlobMetadata, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_file_metadata_with_context(that: FileMetadata, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_multi_language_property_metadata_with_context(that: MultiLanguagePropertyMetadata, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_reference_element_metadata_with_context(that: ReferenceElementMetadata, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_relationship_element_metadata_with_context(that: RelationshipElementMetadata, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_annotated_relationship_element_metadata_with_context(that: AnnotatedRelationshipElementMetadata, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_entity_metadata_with_context(that: EntityMetadata, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_capability_metadata_with_context(that: CapabilityMetadata, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_operation_metadata_with_context(that: OperationMetadata, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_submodel_element_collection_metadata_with_context(that: SubmodelElementCollectionMetadata, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_basic_event_element_metadata_with_context(that: BasicEventElementMetadata, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_submodel_element_list_metadata_with_context(that: SubmodelElementListMetadata, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_submodel_metadata_with_context(that: SubmodelMetadata, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_asset_administration_shell_metadata_with_context(that: AssetAdministrationShellMetadata, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_reference_element_value_with_context(that: ReferenceElementValue, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_blob_value_with_context(that: BlobValue, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_file_value_with_context(that: FileValue, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_range_value_with_context(that: RangeValue, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_relationship_element_value_with_context(that: RelationshipElementValue, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_basic_event_element_value_with_context(that: BasicEventElementValue, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_annotated_relationship_element_value_with_context(that: AnnotatedRelationshipElementValue, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_entity_value_with_context(that: EntityValue, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_get_asset_administration_shells_result_with_context(that: GetAssetAdministrationShellsResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_get_asset_administration_shells_metadata_result_with_context(that: GetAssetAdministrationShellsMetadataResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_get_all_asset_administration_shells_recent_changes_result_with_context(that: GetAllAssetAdministrationShellsRecentChangesResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_get_asset_administration_shell_descriptors_result_with_context(that: GetAssetAdministrationShellDescriptorsResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_get_concept_descriptions_result_with_context(that: GetConceptDescriptionsResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_get_all_concept_descriptions_recent_changes_result_with_context(that: GetAllConceptDescriptionsRecentChangesResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_get_package_descriptions_result_with_context(that: GetPackageDescriptionsResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_get_path_items_result_with_context(that: GetPathItemsResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_get_references_result_with_context(that: GetReferencesResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_get_submodel_descriptors_result_with_context(that: GetSubmodelDescriptorsResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_get_submodel_elements_metadata_result_with_context(that: GetSubmodelElementsMetadataResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_get_submodel_elements_result_with_context(that: GetSubmodelElementsResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_get_submodel_elements_value_result_with_context(that: GetSubmodelElementsValueResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_get_all_submodels_recent_changes_result_with_context(that: GetAllSubmodelsRecentChangesResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_get_submodels_metadata_result_with_context(that: GetSubmodelsMetadataResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_get_submodels_result_with_context(that: GetSubmodelsResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_get_submodels_value_result_with_context(that: GetSubmodelsValueResult, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_claim_attribute_with_context(that: ClaimAttribute, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_global_attribute_with_context(that: GlobalAttribute, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_reference_attribute_with_context(that: ReferenceAttribute, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_date_time_attribute_item_with_context(that: DateTimeAttributeItem, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_field_operand_with_context(that: FieldOperand, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_string_literal_with_context(that: StringLiteral, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_attribute_operand_with_context(that: AttributeOperand, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_number_literal_with_context(that: NumberLiteral, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_hex_literal_with_context(that: HexLiteral, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_date_time_literal_with_context(that: DateTimeLiteral, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_time_literal_with_context(that: TimeLiteral, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_boolean_literal_with_context(that: BooleanLiteral, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_string_cast_with_context(that: StringCast, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_number_cast_with_context(that: NumberCast, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_hex_cast_with_context(that: HexCast, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_boolean_cast_with_context(that: BooleanCast, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_date_time_cast_with_context(that: DateTimeCast, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_time_cast_with_context(that: TimeCast, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_day_of_week_with_context(that: DayOfWeek, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_day_of_month_with_context(that: DayOfMonth, context: ContextT) T[source]
Transform
thatincontext.
- __orig_bases__ = (typing.Generic[~ContextT, ~T],)
- __parameters__ = (~ContextT, ~T)
- abstract transform_month_with_context(that: Month, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_year_with_context(that: Year, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_date_time_attribute_operand_with_context(that: DateTimeAttributeOperand, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_equal_comparison_with_context(that: EqualComparison, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_not_equal_comparison_with_context(that: NotEqualComparison, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_greater_than_comparison_with_context(that: GreaterThanComparison, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_greater_than_or_equal_comparison_with_context(that: GreaterThanOrEqualComparison, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_less_than_comparison_with_context(that: LessThanComparison, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_less_than_or_equal_comparison_with_context(that: LessThanOrEqualComparison, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_contains_comparison_with_context(that: ContainsComparison, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_starts_with_comparison_with_context(that: StartsWithComparison, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_ends_with_comparison_with_context(that: EndsWithComparison, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_regex_comparison_with_context(that: RegexComparison, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_match_clause_with_context(that: MatchClause, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_and_expression_with_context(that: AndExpression, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_or_expression_with_context(that: OrExpression, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_not_expression_with_context(that: NotExpression, context: ContextT) T[source]
Transform
thatincontext.
- abstract transform_query_filter_with_context(that: QueryFilter, context: ContextT) T[source]
Transform
thatincontext.
- class aas_core3_2.types.TransformerWithDefault(default: T)[source]
Transform the instances of the model.
If you do not override the transformation methods, they simply return
default.- __orig_bases__ = (aas_core3_2.types.AbstractTransformer[~T],)
- __parameters__ = (~T,)
- default: T
Default value which is returned if no override of the transformation
- transform_administrative_information(that: AdministrativeInformation) T[source]
Transform
that.
- transform_asset_administration_shell(that: AssetAdministrationShell) T[source]
Transform
that.
- transform_asset_information(that: AssetInformation) T[source]
Transform
that.
- transform_specific_asset_id(that: SpecificAssetID) T[source]
Transform
that.
- transform_relationship_element(that: RelationshipElement) T[source]
Transform
that.
- transform_submodel_element_list(that: SubmodelElementList) T[source]
Transform
that.
- transform_submodel_element_collection(that: SubmodelElementCollection) T[source]
Transform
that.
- transform_multi_language_property(that: MultiLanguageProperty) T[source]
Transform
that.
- transform_reference_element(that: ReferenceElement) T[source]
Transform
that.
- transform_annotated_relationship_element(that: AnnotatedRelationshipElement) T[source]
Transform
that.
- transform_event_payload(that: EventPayload) T[source]
Transform
that.
- transform_basic_event_element(that: BasicEventElement) T[source]
Transform
that.
- transform_operation_variable(that: OperationVariable) T[source]
Transform
that.
- transform_capability(that: Capability) T[source]
Transform
that.
- transform_concept_description(that: ConceptDescription) T[source]
Transform
that.
- transform_lang_string_name_type(that: LangStringNameType) T[source]
Transform
that.
- transform_lang_string_text_type(that: LangStringTextType) T[source]
Transform
that.
- transform_environment(that: Environment) T[source]
Transform
that.
- transform_embedded_data_specification(that: EmbeddedDataSpecification) T[source]
Transform
that.
- transform_value_reference_pair(that: ValueReferencePair) T[source]
Transform
that.
- transform_lang_string_preferred_name_type_iec_61360(that: LangStringPreferredNameTypeIEC61360) T[source]
Transform
that.
- transform_lang_string_short_name_type_iec_61360(that: LangStringShortNameTypeIEC61360) T[source]
Transform
that.
- transform_lang_string_definition_type_iec_61360(that: LangStringDefinitionTypeIEC61360) T[source]
Transform
that.
- transform_lang_string_uom(that: LangStringUom) T[source]
Transform
that.
- transform_definition_type_uom(that: DefinitionTypeUom) T[source]
Transform
that.
- transform_data_specification_uom(that: DataSpecificationUom) T[source]
Transform
that.
- transform_data_specification_iec_61360(that: DataSpecificationIEC61360) T[source]
Transform
that.
- transform_asset_administration_shell_descriptor(that: AssetAdministrationShellDescriptor) T[source]
Transform
that.
- transform_submodel_descriptor(that: SubmodelDescriptor) T[source]
Transform
that.
- transform_protocol_information(that: ProtocolInformation) T[source]
Transform
that.
- transform_security_attribute_object(that: SecurityAttributeObject) T[source]
Transform
that.
- transform_service_description(that: ServiceDescription) T[source]
Transform
that.
- transform_asset_administration_shell_recent_change(that: AssetAdministrationShellRecentChange) T[source]
Transform
that.
- transform_concept_description_recent_change(that: ConceptDescriptionRecentChange) T[source]
Transform
that.
- transform_submodel_recent_change(that: SubmodelRecentChange) T[source]
Transform
that.
- transform_operation_request(that: OperationRequest) T[source]
Transform
that.
- transform_operation_request_async(that: OperationRequestAsync) T[source]
Transform
that.
- transform_operation_request_value_only(that: OperationRequestValueOnly) T[source]
Transform
that.
- transform_operation_request_async_value_only(that: OperationRequestAsyncValueOnly) T[source]
Transform
that.
- transform_base_operation_result(that: BaseOperationResult) T[source]
Transform
that.
- transform_operation_result(that: OperationResult) T[source]
Transform
that.
- transform_operation_result_value_only(that: OperationResultValueOnly) T[source]
Transform
that.
- transform_operation_handle(that: OperationHandle) T[source]
Transform
that.
- transform_paged_result(that: PagedResult) T[source]
Transform
that.
- transform_paging_metadata(that: PagingMetadata) T[source]
Transform
that.
- transform_package_description(that: PackageDescription) T[source]
Transform
that.
- transform_property_metadata(that: PropertyMetadata) T[source]
Transform
that.
- transform_range_metadata(that: RangeMetadata) T[source]
Transform
that.
- transform_blob_metadata(that: BlobMetadata) T[source]
Transform
that.
- transform_file_metadata(that: FileMetadata) T[source]
Transform
that.
- transform_multi_language_property_metadata(that: MultiLanguagePropertyMetadata) T[source]
Transform
that.
- transform_reference_element_metadata(that: ReferenceElementMetadata) T[source]
Transform
that.
- transform_relationship_element_metadata(that: RelationshipElementMetadata) T[source]
Transform
that.
- transform_annotated_relationship_element_metadata(that: AnnotatedRelationshipElementMetadata) T[source]
Transform
that.
- transform_entity_metadata(that: EntityMetadata) T[source]
Transform
that.
- transform_capability_metadata(that: CapabilityMetadata) T[source]
Transform
that.
- transform_operation_metadata(that: OperationMetadata) T[source]
Transform
that.
- transform_submodel_element_collection_metadata(that: SubmodelElementCollectionMetadata) T[source]
Transform
that.
- transform_basic_event_element_metadata(that: BasicEventElementMetadata) T[source]
Transform
that.
- transform_submodel_element_list_metadata(that: SubmodelElementListMetadata) T[source]
Transform
that.
- transform_submodel_metadata(that: SubmodelMetadata) T[source]
Transform
that.
- transform_asset_administration_shell_metadata(that: AssetAdministrationShellMetadata) T[source]
Transform
that.
- transform_reference_element_value(that: ReferenceElementValue) T[source]
Transform
that.
- transform_range_value(that: RangeValue) T[source]
Transform
that.
- transform_relationship_element_value(that: RelationshipElementValue) T[source]
Transform
that.
- transform_basic_event_element_value(that: BasicEventElementValue) T[source]
Transform
that.
- transform_annotated_relationship_element_value(that: AnnotatedRelationshipElementValue) T[source]
Transform
that.
- transform_entity_value(that: EntityValue) T[source]
Transform
that.
- transform_get_asset_administration_shells_result(that: GetAssetAdministrationShellsResult) T[source]
Transform
that.
- transform_get_asset_administration_shells_metadata_result(that: GetAssetAdministrationShellsMetadataResult) T[source]
Transform
that.
- transform_get_all_asset_administration_shells_recent_changes_result(that: GetAllAssetAdministrationShellsRecentChangesResult) T[source]
Transform
that.
- transform_get_asset_administration_shell_descriptors_result(that: GetAssetAdministrationShellDescriptorsResult) T[source]
Transform
that.
- transform_get_concept_descriptions_result(that: GetConceptDescriptionsResult) T[source]
Transform
that.
- transform_get_all_concept_descriptions_recent_changes_result(that: GetAllConceptDescriptionsRecentChangesResult) T[source]
Transform
that.
- transform_get_package_descriptions_result(that: GetPackageDescriptionsResult) T[source]
Transform
that.
- transform_get_path_items_result(that: GetPathItemsResult) T[source]
Transform
that.
- transform_get_references_result(that: GetReferencesResult) T[source]
Transform
that.
- transform_get_submodel_descriptors_result(that: GetSubmodelDescriptorsResult) T[source]
Transform
that.
- transform_get_submodel_elements_metadata_result(that: GetSubmodelElementsMetadataResult) T[source]
Transform
that.
- transform_get_submodel_elements_result(that: GetSubmodelElementsResult) T[source]
Transform
that.
- transform_get_submodel_elements_value_result(that: GetSubmodelElementsValueResult) T[source]
Transform
that.
- transform_get_all_submodels_recent_changes_result(that: GetAllSubmodelsRecentChangesResult) T[source]
Transform
that.
- transform_get_submodels_metadata_result(that: GetSubmodelsMetadataResult) T[source]
Transform
that.
- transform_get_submodels_result(that: GetSubmodelsResult) T[source]
Transform
that.
- transform_get_submodels_value_result(that: GetSubmodelsValueResult) T[source]
Transform
that.
- transform_claim_attribute(that: ClaimAttribute) T[source]
Transform
that.
- transform_global_attribute(that: GlobalAttribute) T[source]
Transform
that.
- transform_reference_attribute(that: ReferenceAttribute) T[source]
Transform
that.
- transform_date_time_attribute_item(that: DateTimeAttributeItem) T[source]
Transform
that.
- transform_field_operand(that: FieldOperand) T[source]
Transform
that.
- transform_string_literal(that: StringLiteral) T[source]
Transform
that.
- transform_attribute_operand(that: AttributeOperand) T[source]
Transform
that.
- transform_number_literal(that: NumberLiteral) T[source]
Transform
that.
- transform_hex_literal(that: HexLiteral) T[source]
Transform
that.
- transform_date_time_literal(that: DateTimeLiteral) T[source]
Transform
that.
- transform_time_literal(that: TimeLiteral) T[source]
Transform
that.
- transform_boolean_literal(that: BooleanLiteral) T[source]
Transform
that.
- transform_string_cast(that: StringCast) T[source]
Transform
that.
- transform_number_cast(that: NumberCast) T[source]
Transform
that.
- transform_boolean_cast(that: BooleanCast) T[source]
Transform
that.
- transform_date_time_cast(that: DateTimeCast) T[source]
Transform
that.
- transform_day_of_month(that: DayOfMonth) T[source]
Transform
that.
- transform_date_time_attribute_operand(that: DateTimeAttributeOperand) T[source]
Transform
that.
- transform_equal_comparison(that: EqualComparison) T[source]
Transform
that.
- transform_not_equal_comparison(that: NotEqualComparison) T[source]
Transform
that.
- transform_greater_than_comparison(that: GreaterThanComparison) T[source]
Transform
that.
- transform_greater_than_or_equal_comparison(that: GreaterThanOrEqualComparison) T[source]
Transform
that.
- transform_less_than_comparison(that: LessThanComparison) T[source]
Transform
that.
- transform_less_than_or_equal_comparison(that: LessThanOrEqualComparison) T[source]
Transform
that.
- transform_contains_comparison(that: ContainsComparison) T[source]
Transform
that.
- transform_starts_with_comparison(that: StartsWithComparison) T[source]
Transform
that.
- transform_ends_with_comparison(that: EndsWithComparison) T[source]
Transform
that.
- transform_regex_comparison(that: RegexComparison) T[source]
Transform
that.
- transform_match_clause(that: MatchClause) T[source]
Transform
that.
- transform_and_expression(that: AndExpression) T[source]
Transform
that.
- transform_or_expression(that: OrExpression) T[source]
Transform
that.
- transform_not_expression(that: NotExpression) T[source]
Transform
that.
- transform_query_filter(that: QueryFilter) T[source]
Transform
that.
- class aas_core3_2.types.TransformerWithDefaultAndContext(default: T)[source]
Transform the instances of the model in context.
If you do not override the transformation methods, they simply return
default.- __orig_bases__ = (aas_core3_2.types.AbstractTransformerWithContext[~ContextT, ~T],)
- __parameters__ = (~ContextT, ~T)
- default: T
Default value which is returned if no override of the transformation
- transform_extension_with_context(that: Extension, context: ContextT) T[source]
Transform
thatincontext.
- transform_administrative_information_with_context(that: AdministrativeInformation, context: ContextT) T[source]
Transform
thatincontext.
- transform_qualifier_with_context(that: Qualifier, context: ContextT) T[source]
Transform
thatincontext.
- transform_asset_administration_shell_with_context(that: AssetAdministrationShell, context: ContextT) T[source]
Transform
thatincontext.
- transform_asset_information_with_context(that: AssetInformation, context: ContextT) T[source]
Transform
thatincontext.
- transform_resource_with_context(that: Resource, context: ContextT) T[source]
Transform
thatincontext.
- transform_specific_asset_id_with_context(that: SpecificAssetID, context: ContextT) T[source]
Transform
thatincontext.
- transform_submodel_with_context(that: Submodel, context: ContextT) T[source]
Transform
thatincontext.
- transform_relationship_element_with_context(that: RelationshipElement, context: ContextT) T[source]
Transform
thatincontext.
- transform_submodel_element_list_with_context(that: SubmodelElementList, context: ContextT) T[source]
Transform
thatincontext.
- transform_submodel_element_collection_with_context(that: SubmodelElementCollection, context: ContextT) T[source]
Transform
thatincontext.
- transform_property_with_context(that: Property, context: ContextT) T[source]
Transform
thatincontext.
- transform_multi_language_property_with_context(that: MultiLanguageProperty, context: ContextT) T[source]
Transform
thatincontext.
- transform_reference_element_with_context(that: ReferenceElement, context: ContextT) T[source]
Transform
thatincontext.
- transform_annotated_relationship_element_with_context(that: AnnotatedRelationshipElement, context: ContextT) T[source]
Transform
thatincontext.
- transform_entity_with_context(that: Entity, context: ContextT) T[source]
Transform
thatincontext.
- transform_event_payload_with_context(that: EventPayload, context: ContextT) T[source]
Transform
thatincontext.
- transform_basic_event_element_with_context(that: BasicEventElement, context: ContextT) T[source]
Transform
thatincontext.
- transform_operation_with_context(that: Operation, context: ContextT) T[source]
Transform
thatincontext.
- transform_operation_variable_with_context(that: OperationVariable, context: ContextT) T[source]
Transform
thatincontext.
- transform_capability_with_context(that: Capability, context: ContextT) T[source]
Transform
thatincontext.
- transform_concept_description_with_context(that: ConceptDescription, context: ContextT) T[source]
Transform
thatincontext.
- transform_reference_with_context(that: Reference, context: ContextT) T[source]
Transform
thatincontext.
- transform_lang_string_name_type_with_context(that: LangStringNameType, context: ContextT) T[source]
Transform
thatincontext.
- transform_lang_string_text_type_with_context(that: LangStringTextType, context: ContextT) T[source]
Transform
thatincontext.
- transform_environment_with_context(that: Environment, context: ContextT) T[source]
Transform
thatincontext.
- transform_embedded_data_specification_with_context(that: EmbeddedDataSpecification, context: ContextT) T[source]
Transform
thatincontext.
- transform_level_type_with_context(that: LevelType, context: ContextT) T[source]
Transform
thatincontext.
- transform_value_reference_pair_with_context(that: ValueReferencePair, context: ContextT) T[source]
Transform
thatincontext.
- transform_value_list_with_context(that: ValueList, context: ContextT) T[source]
Transform
thatincontext.
- transform_lang_string_preferred_name_type_iec_61360_with_context(that: LangStringPreferredNameTypeIEC61360, context: ContextT) T[source]
Transform
thatincontext.
- transform_lang_string_short_name_type_iec_61360_with_context(that: LangStringShortNameTypeIEC61360, context: ContextT) T[source]
Transform
thatincontext.
- transform_lang_string_definition_type_iec_61360_with_context(that: LangStringDefinitionTypeIEC61360, context: ContextT) T[source]
Transform
thatincontext.
- transform_lang_string_uom_with_context(that: LangStringUom, context: ContextT) T[source]
Transform
thatincontext.
- transform_definition_type_uom_with_context(that: DefinitionTypeUom, context: ContextT) T[source]
Transform
thatincontext.
- transform_data_specification_uom_with_context(that: DataSpecificationUom, context: ContextT) T[source]
Transform
thatincontext.
- transform_data_specification_iec_61360_with_context(that: DataSpecificationIEC61360, context: ContextT) T[source]
Transform
thatincontext.
- transform_asset_administration_shell_descriptor_with_context(that: AssetAdministrationShellDescriptor, context: ContextT) T[source]
Transform
thatincontext.
- transform_submodel_descriptor_with_context(that: SubmodelDescriptor, context: ContextT) T[source]
Transform
thatincontext.
- transform_endpoint_with_context(that: Endpoint, context: ContextT) T[source]
Transform
thatincontext.
- transform_protocol_information_with_context(that: ProtocolInformation, context: ContextT) T[source]
Transform
thatincontext.
- transform_security_attribute_object_with_context(that: SecurityAttributeObject, context: ContextT) T[source]
Transform
thatincontext.
- transform_asset_link_with_context(that: AssetLink, context: ContextT) T[source]
Transform
thatincontext.
- transform_service_description_with_context(that: ServiceDescription, context: ContextT) T[source]
Transform
thatincontext.
- transform_asset_administration_shell_recent_change_with_context(that: AssetAdministrationShellRecentChange, context: ContextT) T[source]
Transform
thatincontext.
- transform_concept_description_recent_change_with_context(that: ConceptDescriptionRecentChange, context: ContextT) T[source]
Transform
thatincontext.
- transform_submodel_recent_change_with_context(that: SubmodelRecentChange, context: ContextT) T[source]
Transform
thatincontext.
- transform_result_with_context(that: Result, context: ContextT) T[source]
Transform
thatincontext.
- transform_message_with_context(that: Message, context: ContextT) T[source]
Transform
thatincontext.
- transform_operation_request_with_context(that: OperationRequest, context: ContextT) T[source]
Transform
thatincontext.
- transform_operation_request_async_with_context(that: OperationRequestAsync, context: ContextT) T[source]
Transform
thatincontext.
- transform_operation_request_value_only_with_context(that: OperationRequestValueOnly, context: ContextT) T[source]
Transform
thatincontext.
- transform_operation_request_async_value_only_with_context(that: OperationRequestAsyncValueOnly, context: ContextT) T[source]
Transform
thatincontext.
- transform_base_operation_result_with_context(that: BaseOperationResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_operation_result_with_context(that: OperationResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_operation_result_value_only_with_context(that: OperationResultValueOnly, context: ContextT) T[source]
Transform
thatincontext.
- transform_operation_handle_with_context(that: OperationHandle, context: ContextT) T[source]
Transform
thatincontext.
- transform_paged_result_with_context(that: PagedResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_paging_metadata_with_context(that: PagingMetadata, context: ContextT) T[source]
Transform
thatincontext.
- transform_package_description_with_context(that: PackageDescription, context: ContextT) T[source]
Transform
thatincontext.
- transform_property_metadata_with_context(that: PropertyMetadata, context: ContextT) T[source]
Transform
thatincontext.
- transform_range_metadata_with_context(that: RangeMetadata, context: ContextT) T[source]
Transform
thatincontext.
- transform_blob_metadata_with_context(that: BlobMetadata, context: ContextT) T[source]
Transform
thatincontext.
- transform_file_metadata_with_context(that: FileMetadata, context: ContextT) T[source]
Transform
thatincontext.
- transform_multi_language_property_metadata_with_context(that: MultiLanguagePropertyMetadata, context: ContextT) T[source]
Transform
thatincontext.
- transform_reference_element_metadata_with_context(that: ReferenceElementMetadata, context: ContextT) T[source]
Transform
thatincontext.
- transform_relationship_element_metadata_with_context(that: RelationshipElementMetadata, context: ContextT) T[source]
Transform
thatincontext.
- transform_annotated_relationship_element_metadata_with_context(that: AnnotatedRelationshipElementMetadata, context: ContextT) T[source]
Transform
thatincontext.
- transform_entity_metadata_with_context(that: EntityMetadata, context: ContextT) T[source]
Transform
thatincontext.
- transform_capability_metadata_with_context(that: CapabilityMetadata, context: ContextT) T[source]
Transform
thatincontext.
- transform_operation_metadata_with_context(that: OperationMetadata, context: ContextT) T[source]
Transform
thatincontext.
- transform_submodel_element_collection_metadata_with_context(that: SubmodelElementCollectionMetadata, context: ContextT) T[source]
Transform
thatincontext.
- transform_basic_event_element_metadata_with_context(that: BasicEventElementMetadata, context: ContextT) T[source]
Transform
thatincontext.
- transform_submodel_element_list_metadata_with_context(that: SubmodelElementListMetadata, context: ContextT) T[source]
Transform
thatincontext.
- transform_submodel_metadata_with_context(that: SubmodelMetadata, context: ContextT) T[source]
Transform
thatincontext.
- transform_asset_administration_shell_metadata_with_context(that: AssetAdministrationShellMetadata, context: ContextT) T[source]
Transform
thatincontext.
- transform_reference_element_value_with_context(that: ReferenceElementValue, context: ContextT) T[source]
Transform
thatincontext.
- transform_blob_value_with_context(that: BlobValue, context: ContextT) T[source]
Transform
thatincontext.
- transform_file_value_with_context(that: FileValue, context: ContextT) T[source]
Transform
thatincontext.
- transform_range_value_with_context(that: RangeValue, context: ContextT) T[source]
Transform
thatincontext.
- transform_relationship_element_value_with_context(that: RelationshipElementValue, context: ContextT) T[source]
Transform
thatincontext.
- transform_basic_event_element_value_with_context(that: BasicEventElementValue, context: ContextT) T[source]
Transform
thatincontext.
- transform_annotated_relationship_element_value_with_context(that: AnnotatedRelationshipElementValue, context: ContextT) T[source]
Transform
thatincontext.
- transform_entity_value_with_context(that: EntityValue, context: ContextT) T[source]
Transform
thatincontext.
- transform_get_asset_administration_shells_result_with_context(that: GetAssetAdministrationShellsResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_get_asset_administration_shells_metadata_result_with_context(that: GetAssetAdministrationShellsMetadataResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_get_all_asset_administration_shells_recent_changes_result_with_context(that: GetAllAssetAdministrationShellsRecentChangesResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_get_asset_administration_shell_descriptors_result_with_context(that: GetAssetAdministrationShellDescriptorsResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_get_concept_descriptions_result_with_context(that: GetConceptDescriptionsResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_get_all_concept_descriptions_recent_changes_result_with_context(that: GetAllConceptDescriptionsRecentChangesResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_get_package_descriptions_result_with_context(that: GetPackageDescriptionsResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_get_path_items_result_with_context(that: GetPathItemsResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_get_references_result_with_context(that: GetReferencesResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_get_submodel_descriptors_result_with_context(that: GetSubmodelDescriptorsResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_get_submodel_elements_metadata_result_with_context(that: GetSubmodelElementsMetadataResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_get_submodel_elements_result_with_context(that: GetSubmodelElementsResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_get_submodel_elements_value_result_with_context(that: GetSubmodelElementsValueResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_get_all_submodels_recent_changes_result_with_context(that: GetAllSubmodelsRecentChangesResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_get_submodels_metadata_result_with_context(that: GetSubmodelsMetadataResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_get_submodels_result_with_context(that: GetSubmodelsResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_get_submodels_value_result_with_context(that: GetSubmodelsValueResult, context: ContextT) T[source]
Transform
thatincontext.
- transform_claim_attribute_with_context(that: ClaimAttribute, context: ContextT) T[source]
Transform
thatincontext.
- transform_global_attribute_with_context(that: GlobalAttribute, context: ContextT) T[source]
Transform
thatincontext.
- transform_reference_attribute_with_context(that: ReferenceAttribute, context: ContextT) T[source]
Transform
thatincontext.
- transform_date_time_attribute_item_with_context(that: DateTimeAttributeItem, context: ContextT) T[source]
Transform
thatincontext.
- transform_field_operand_with_context(that: FieldOperand, context: ContextT) T[source]
Transform
thatincontext.
- transform_string_literal_with_context(that: StringLiteral, context: ContextT) T[source]
Transform
thatincontext.
- transform_attribute_operand_with_context(that: AttributeOperand, context: ContextT) T[source]
Transform
thatincontext.
- transform_number_literal_with_context(that: NumberLiteral, context: ContextT) T[source]
Transform
thatincontext.
- transform_hex_literal_with_context(that: HexLiteral, context: ContextT) T[source]
Transform
thatincontext.
- transform_date_time_literal_with_context(that: DateTimeLiteral, context: ContextT) T[source]
Transform
thatincontext.
- transform_time_literal_with_context(that: TimeLiteral, context: ContextT) T[source]
Transform
thatincontext.
- transform_boolean_literal_with_context(that: BooleanLiteral, context: ContextT) T[source]
Transform
thatincontext.
- transform_string_cast_with_context(that: StringCast, context: ContextT) T[source]
Transform
thatincontext.
- transform_number_cast_with_context(that: NumberCast, context: ContextT) T[source]
Transform
thatincontext.
- transform_hex_cast_with_context(that: HexCast, context: ContextT) T[source]
Transform
thatincontext.
- transform_boolean_cast_with_context(that: BooleanCast, context: ContextT) T[source]
Transform
thatincontext.
- transform_date_time_cast_with_context(that: DateTimeCast, context: ContextT) T[source]
Transform
thatincontext.
- transform_time_cast_with_context(that: TimeCast, context: ContextT) T[source]
Transform
thatincontext.
- transform_day_of_week_with_context(that: DayOfWeek, context: ContextT) T[source]
Transform
thatincontext.
- transform_day_of_month_with_context(that: DayOfMonth, context: ContextT) T[source]
Transform
thatincontext.
- transform_date_time_attribute_operand_with_context(that: DateTimeAttributeOperand, context: ContextT) T[source]
Transform
thatincontext.
- transform_equal_comparison_with_context(that: EqualComparison, context: ContextT) T[source]
Transform
thatincontext.
- transform_not_equal_comparison_with_context(that: NotEqualComparison, context: ContextT) T[source]
Transform
thatincontext.
- transform_greater_than_comparison_with_context(that: GreaterThanComparison, context: ContextT) T[source]
Transform
thatincontext.
- transform_greater_than_or_equal_comparison_with_context(that: GreaterThanOrEqualComparison, context: ContextT) T[source]
Transform
thatincontext.
- transform_less_than_comparison_with_context(that: LessThanComparison, context: ContextT) T[source]
Transform
thatincontext.
- transform_less_than_or_equal_comparison_with_context(that: LessThanOrEqualComparison, context: ContextT) T[source]
Transform
thatincontext.
- transform_contains_comparison_with_context(that: ContainsComparison, context: ContextT) T[source]
Transform
thatincontext.
- transform_starts_with_comparison_with_context(that: StartsWithComparison, context: ContextT) T[source]
Transform
thatincontext.
- transform_ends_with_comparison_with_context(that: EndsWithComparison, context: ContextT) T[source]
Transform
thatincontext.
- transform_regex_comparison_with_context(that: RegexComparison, context: ContextT) T[source]
Transform
thatincontext.
- transform_match_clause_with_context(that: MatchClause, context: ContextT) T[source]
Transform
thatincontext.
- transform_and_expression_with_context(that: AndExpression, context: ContextT) T[source]
Transform
thatincontext.
- transform_or_expression_with_context(that: OrExpression, context: ContextT) T[source]
Transform
thatincontext.
- transform_not_expression_with_context(that: NotExpression, context: ContextT) T[source]
Transform
thatincontext.
- transform_query_filter_with_context(that: QueryFilter, context: ContextT) T[source]
Transform
thatincontext.