smia.aas_model.extended_submodel module

class smia.aas_model.extended_submodel.ExtendedSubmodel(id_: str, submodel_element: Iterable[SubmodelElement] = (), id_short: str | None = None, display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, administration: AdministrativeInformation | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), kind: ModellingKind = ModellingKind.INSTANCE, extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: Submodel

This class contains methods to be added to Submodel class of Basyx Python SDK model.

print_submodel_information()

class smia.aas_model.extended_submodel.ExtendedSubmodelElement(id_short: str | None, display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: SubmodelElement

This class contains methods to be added to SubmodelElement class of Basyx Python SDK model.

print_submodel_element_information()

get_qualifier_by_semantic_id(semantic_id_reference)

get_parent_submodel()

This method gets the submodel where the self SubmodelElement is defined.

Returns:

parent submodel in form of a Python object.

Return type:

basyx.aas.model.Submodel

check_cap_skill_ontology_semantics_and_qualifiers()

This method checks if the SubmodelElement of the Skill has the required semanticIDs and qualifiers defined in the Capability-Skill ontology.

Returns:

result of the check (only True if both semanticIDs and qualifiers of Capability-Skill ontology exist).

Return type:

bool

check_cap_skill_ontology_qualifier_for_skills()

This method checks if the SubmodelElement of the Skill has valid qualifiers defined in the Capability-Skil ontology.

Returns:

result of the check (only True if the qualifier of Capability-Skill ontology exists).

Return type:

bool

get_parent_ref_by_semantic_id(semantic_id)

This method gets the reference of a parent element of the SubmodelElement by the semanticID.

Parameters:

semantic_id (str) – semantic identifier of the parent element.

Returns:

model reference of the parent element (None if the parent does not exist)

Return type:

basyx.aas.model.ModelReference

class smia.aas_model.extended_submodel.ExtendedRelationshipElement(id_short: str | None, first: Reference, second: Reference, display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: RelationshipElement

print_submodel_element_information()

class smia.aas_model.extended_submodel.ExtendedAnnotatedRelationshipElement(id_short: str | None, first: Reference, second: Reference, display_name: MultiLanguageNameType | None = None, annotation: Iterable[DataElement] = (), category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: AnnotatedRelationshipElement

print_submodel_element_information()

check_cap_skill_ontology_semantic_id()

This method checks if the Capability has one of the required semanticIDs defined in the Capability-Skill ontology, exactly for Capabilities.

Returns:

result of the check (only True if the semanticID of Capability-Skill ontology exists).

Return type:

bool

check_cap_skill_ontology_qualifiers()

This method checks if the Capability has valid qualifiers, defined in the Capability-Skil ontology.

Returns:

result of the check (only True if the qualifier of Capability-Skill ontology exists).

Return type:

bool

get_capability_type_in_ontology()

This method gets the type of the capability within the Capability-Skill ontology.

Returns:

value of the type of the capability within the Capability-Skill ontology.

Return type:

str

get_semantic_id_of_css_ontology()

This method gets the semanticID of the capability within the Capability-Skill ontology.

Returns:

value of the semanticID of the capability within the Capability-Skill ontology.

Return type:

str

class smia.aas_model.extended_submodel.ExtendedOperation(id_short: str | None, input_variable: Iterable[SubmodelElement] = (), output_variable: Iterable[SubmodelElement] = (), in_output_variable: Iterable[SubmodelElement] = (), display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: Operation

print_submodel_element_information()

get_variable_value_id(value_id)

This method gets the variable of the Operation that matches with the given valueId.

Parameters:

value_id (str) – the value id of the variable to find.

Returns:

id_short of the variable

Return type:

(str)

get_operation_variables_by_semantic_id(semantic_id)

This method gets all operation variables that have the given semanticID.

Parameters:

semantic_id (str) – semantic identifier of the operation variables to find.

Returns:

all valid operation variables in form of a list of SubmodelElements.

Return type:

list

class smia.aas_model.extended_submodel.ExtendedBasicEventElement(id_short: str | None, observed: ModelReference[aas.AssetAdministrationShell | Submodel | SubmodelElement], direction: Direction, state: StateOfEvent, message_topic: str | None = None, message_broker: ModelReference[Submodel | SubmodelElementList | SubmodelElementCollection | Entity] | None = None, last_update: datetime | None = None, min_interval: relativedelta | None = None, max_interval: relativedelta | None = None, display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: BasicEventElement

print_submodel_element_information()

class smia.aas_model.extended_submodel.ExtendedEntity

Bases: object

print_submodel_element_information()

class smia.aas_model.extended_submodel.ExtendedSubmodelElementList(id_short: str | None, type_value_list_element: Type[_SE], value: Iterable[_SE] = (), semantic_id_list_element: Reference | None = None, value_type_list_element: Type[relativedelta | datetime | Date | time | GYearMonth | GYear | GMonthDay | GMonth | GDay | bool | Base64Binary | HexBinary | Float | float | Decimal | int | Long | Int | Short | Byte | NonPositiveInteger | NegativeInteger | NonNegativeInteger | PositiveInteger | UnsignedLong | UnsignedInt | UnsignedShort | UnsignedByte | AnyURI | str | NormalizedString] | None = None, order_relevant: bool = True, display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: SubmodelElementList

print_submodel_element_information()

class smia.aas_model.extended_submodel.ExtendedSubmodelElementCollection(id_short: str | None, value: Iterable[SubmodelElement] = (), display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: SubmodelElementCollection

print_submodel_element_information()

get_sm_element_by_id_short(id_short)

This method gets a submodel element inside a SubmodelElementCollection by its id_short. :param id_short: id_short of the submodel element to find. :type id_short: str

Returns:

submodel element in form of Python object.

Return type:

basyx.aas.model.SubmodelElement

get_sm_element_by_semantic_id(semantic_id_ref)

This method gets a submodel element inside a SubmodelElementCollection by its semantic identifier. :param semantic_id_ref: semantic identifier of the submodel element to find. :type semantic_id_ref: str

Returns:

submodel element in form of Python object.

Return type:

basyx.aas.model.SubmodelElement

class smia.aas_model.extended_submodel.ExtendedProperty(id_short: str | None, value_type: Type[relativedelta | datetime | Date | time | GYearMonth | GYear | GMonthDay | GMonth | GDay | bool | Base64Binary | HexBinary | Float | float | Decimal | int | Long | Int | Short | Byte | NonPositiveInteger | NegativeInteger | NonNegativeInteger | PositiveInteger | UnsignedLong | UnsignedInt | UnsignedShort | UnsignedByte | AnyURI | str | NormalizedString], value: relativedelta | datetime | Date | time | GYearMonth | GYear | GMonthDay | GMonth | GDay | bool | Base64Binary | HexBinary | Float | float | Decimal | int | Long | Int | Short | Byte | NonPositiveInteger | NegativeInteger | NonNegativeInteger | PositiveInteger | UnsignedLong | UnsignedInt | UnsignedShort | UnsignedByte | AnyURI | str | NormalizedString | None = None, value_id: Reference | None = None, display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: Property

This class contains methods to be added to Property class of Basyx Python SDK model.

print_submodel_element_information()

class smia.aas_model.extended_submodel.ExtendedMultiLanguageProperty(id_short: str | None, value: MultiLanguageTextType | None = None, value_id: Reference | None = None, display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: MultiLanguageProperty

print_submodel_element_information()

class smia.aas_model.extended_submodel.ExtendedRange(id_short: str | None, value_type: Type[relativedelta | datetime | Date | time | GYearMonth | GYear | GMonthDay | GMonth | GDay | bool | Base64Binary | HexBinary | Float | float | Decimal | int | Long | Int | Short | Byte | NonPositiveInteger | NegativeInteger | NonNegativeInteger | PositiveInteger | UnsignedLong | UnsignedInt | UnsignedShort | UnsignedByte | AnyURI | str | NormalizedString], min: relativedelta | datetime | Date | time | GYearMonth | GYear | GMonthDay | GMonth | GDay | bool | Base64Binary | HexBinary | Float | float | Decimal | int | Long | Int | Short | Byte | NonPositiveInteger | NegativeInteger | NonNegativeInteger | PositiveInteger | UnsignedLong | UnsignedInt | UnsignedShort | UnsignedByte | AnyURI | str | NormalizedString | None = None, max: relativedelta | datetime | Date | time | GYearMonth | GYear | GMonthDay | GMonth | GDay | bool | Base64Binary | HexBinary | Float | float | Decimal | int | Long | Int | Short | Byte | NonPositiveInteger | NegativeInteger | NonNegativeInteger | PositiveInteger | UnsignedLong | UnsignedInt | UnsignedShort | UnsignedByte | AnyURI | str | NormalizedString | None = None, display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: Range

print_submodel_element_information()

class smia.aas_model.extended_submodel.ExtendedBlob(id_short: str | None, content_type: str, value: bytes | None = None, display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: Blob

print_submodel_element_information()

class smia.aas_model.extended_submodel.ExtendedFile(id_short: str | None, content_type: str, value: str | None = None, display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: File

print_submodel_element_information()

class smia.aas_model.extended_submodel.ExtendedReferenceElement(id_short: str | None, value: Reference | None = None, display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: ReferenceElement

print_submodel_element_information()

class smia.aas_model.extended_submodel.ExtendedGenericCSSClass

Bases: object

add_old_sme_class(sme_class)

This method adds the old Basyx SubmodelElement class to be stored to the correct execution of the software.

Parameters:

sme_class (basyx.aas.model.SubmodelElement) – old submodel element class in BaSyx Python structure.

get_semantic_id_of_css_ontology()

This method checks the semanticID of the skill within the Capability-Skill ontology.

class smia.aas_model.extended_submodel.ExtendedCapability(id_short: str | None, display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: ExtendedGenericCSSClass, Capability

print_submodel_element_information()

check_cap_skill_ontology_semantics_and_qualifiers()

This method checks if the Capability has the required semanticIDs and qualifiers defined in the Capability-Skill ontology, exactly for Capabilities.

Returns:

result of the check (only True if both semanticIDs and qualifiers of Capability-Skill ontology exist).

Return type:

bool

class smia.aas_model.extended_submodel.ExtendedSkill

Bases: ExtendedGenericCSSClass

class smia.aas_model.extended_submodel.ExtendedSkillInterface

Bases: ExtendedGenericCSSClass

get_associated_asset_interface()

This method gets the asset interface AAS SubmodelElement associated with this skill interface.

Returns:

submodel element of the asset interface.

Return type:

basyx.aas.model.SubmodelElement

class smia.aas_model.extended_submodel.ExtendedCapabilityConstraint(id_short: str | None, value_type: Type[relativedelta | datetime | Date | time | GYearMonth | GYear | GMonthDay | GMonth | GDay | bool | Base64Binary | HexBinary | Float | float | Decimal | int | Long | Int | Short | Byte | NonPositiveInteger | NegativeInteger | NonNegativeInteger | PositiveInteger | UnsignedLong | UnsignedInt | UnsignedShort | UnsignedByte | AnyURI | str | NormalizedString], value: relativedelta | datetime | Date | time | GYearMonth | GYear | GMonthDay | GMonth | GDay | bool | Base64Binary | HexBinary | Float | float | Decimal | int | Long | Int | Short | Byte | NonPositiveInteger | NegativeInteger | NonNegativeInteger | PositiveInteger | UnsignedLong | UnsignedInt | UnsignedShort | UnsignedByte | AnyURI | str | NormalizedString | None = None, value_id: Reference | None = None, display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: ExtendedGenericCSSClass, ExtendedSubmodelElement, ExtendedProperty

get_semantic_id_of_css_ontology()

This method checks the semanticID of the skill within the Capability-Skill ontology.

class smia.aas_model.extended_submodel.ExtendedSimpleSkill(id_short: str | None, input_variable: Iterable[SubmodelElement] = (), output_variable: Iterable[SubmodelElement] = (), in_output_variable: Iterable[SubmodelElement] = (), display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: ExtendedSkill, ExtendedSubmodelElement, ExtendedOperation

get_semantic_id_of_css_ontology()

This method checks the semanticID of the skill within the Capability-Skill ontology.

class smia.aas_model.extended_submodel.ExtendedComplexSkill(id_: str, submodel_element: Iterable[SubmodelElement] = (), id_short: str | None = None, display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, administration: AdministrativeInformation | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), kind: ModellingKind = ModellingKind.INSTANCE, extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: ExtendedSkill, ExtendedSubmodel

get_semantic_id_of_css_ontology()

This method checks the semanticID of the skill within the Capability-Skill ontology.

class smia.aas_model.extended_submodel.ExtendedSkillParameter(id_short: str | None, value_type: Type[relativedelta | datetime | Date | time | GYearMonth | GYear | GMonthDay | GMonth | GDay | bool | Base64Binary | HexBinary | Float | float | Decimal | int | Long | Int | Short | Byte | NonPositiveInteger | NegativeInteger | NonNegativeInteger | PositiveInteger | UnsignedLong | UnsignedInt | UnsignedShort | UnsignedByte | AnyURI | str | NormalizedString], value: relativedelta | datetime | Date | time | GYearMonth | GYear | GMonthDay | GMonth | GDay | bool | Base64Binary | HexBinary | Float | float | Decimal | int | Long | Int | Short | Byte | NonPositiveInteger | NegativeInteger | NonNegativeInteger | PositiveInteger | UnsignedLong | UnsignedInt | UnsignedShort | UnsignedByte | AnyURI | str | NormalizedString | None = None, value_id: Reference | None = None, display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: ExtendedGenericCSSClass, ExtendedProperty

class smia.aas_model.extended_submodel.ExtendedSimpleSkillInterface(id_short: str | None, input_variable: Iterable[SubmodelElement] = (), output_variable: Iterable[SubmodelElement] = (), in_output_variable: Iterable[SubmodelElement] = (), display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: ExtendedSkillInterface, ExtendedOperation, ExtendedSubmodelElement

get_semantic_id_of_css_ontology()

This method checks the semanticID of the skill within the Capability-Skill ontology.

class smia.aas_model.extended_submodel.ExtendedComplexSkillInterface(id_short: str | None, value: Iterable[SubmodelElement] = (), display_name: MultiLanguageNameType | None = None, category: str | None = None, description: MultiLanguageTextType | None = None, parent: UniqueIdShortNamespace | None = None, semantic_id: Reference | None = None, qualifier: Iterable[Qualifier] = (), extension: Iterable[Extension] = (), supplemental_semantic_id: Iterable[Reference] = (), embedded_data_specifications: Iterable[EmbeddedDataSpecification] = ())

Bases: ExtendedSkillInterface, ExtendedSubmodelElementCollection

get_semantic_id_of_css_ontology()

This method checks the semanticID of the skill within the Capability-Skill ontology.

get_associated_asset_interface()

This method gets the asset interface AAS SubmodelElement associated with this skill interface.

Returns:

submodel element of the asset interface.

Return type:

basyx.aas.model.SubmodelElement