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] = ())[source]

Bases: Submodel

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

print_submodel_information()[source]
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] = ())[source]

Bases: SubmodelElement

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

print_submodel_element_information()[source]
get_qualifier_by_semantic_id(semantic_id_reference)[source]
get_parent_submodel()[source]

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()[source]

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()[source]

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)[source]

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] = ())[source]

Bases: RelationshipElement

print_submodel_element_information()[source]
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] = ())[source]

Bases: AnnotatedRelationshipElement

print_submodel_element_information()[source]
check_cap_skill_ontology_semantic_id()[source]

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()[source]

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()[source]

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()[source]

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] = ())[source]

Bases: Operation

print_submodel_element_information()[source]
get_variable_value_id(value_id)[source]

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)[source]

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] = ())[source]

Bases: BasicEventElement

print_submodel_element_information()[source]
class smia.aas_model.extended_submodel.ExtendedEntity[source]

Bases: object

print_submodel_element_information()[source]
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] = ())[source]

Bases: SubmodelElementList

print_submodel_element_information()[source]
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] = ())[source]

Bases: SubmodelElementCollection

print_submodel_element_information()[source]
get_sm_element_by_id_short(id_short)[source]

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)[source]

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] = ())[source]

Bases: Property

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

print_submodel_element_information()[source]
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] = ())[source]

Bases: MultiLanguageProperty

print_submodel_element_information()[source]
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] = ())[source]

Bases: Range

print_submodel_element_information()[source]
check_value_within_range(value)[source]

This method checks whether a given value is within the range defined in this element.

Parameters:

value – data to be checked.

Returns:

the result of the check.

Return type:

bool

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] = ())[source]

Bases: Blob

print_submodel_element_information()[source]
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] = ())[source]

Bases: File

print_submodel_element_information()[source]
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] = ())[source]

Bases: ReferenceElement

print_submodel_element_information()[source]
class smia.aas_model.extended_submodel.ExtendedGenericCSSClass[source]

Bases: object

add_old_sme_class(sme_class)[source]

This method adds the old Basyx SubmodelElement class to be stored to the correct execution of the software. It also adds the inheritance to the Extended SMIA class with the method ‘add_inheritance_of_extended_class’.

Parameters:

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

add_inheritance_of_extended_class()[source]

This method adds inheritance to SMIA Extended classes from the original BaSyx classes, to add the SMIA methods specific to the associated class. To do so, it uses the old_sme_class attribute added during the creation of any ExtendedGenericCSSClass.

get_semantic_id_of_css_ontology()[source]

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] = ())[source]

Bases: ExtendedGenericCSSClass, Capability

print_submodel_element_information()[source]
check_cap_skill_ontology_semantics_and_qualifiers()[source]

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[source]

Bases: ExtendedGenericCSSClass

class smia.aas_model.extended_submodel.ExtendedSkillInterface[source]

Bases: ExtendedGenericCSSClass

get_associated_asset_interface()[source]

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, 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] = ())[source]

Bases: ExtendedGenericCSSClass, ExtendedSubmodelElement

get_semantic_id_of_css_ontology()[source]

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

check_constraint(constraint_data)[source]

This method checks the Capability Constraint against the given data to ensure that it is valid.

Parameters:

constraint_data – data to be checked with the Capability Constraint

Returns:

the result of the check

Return type:

bool

class smia.aas_model.extended_submodel.ExtendedSimpleSkill(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] = ())[source]

Bases: ExtendedSkill, ExtendedSubmodelElement

get_semantic_id_of_css_ontology()[source]

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] = ())[source]

Bases: ExtendedSkill, ExtendedSubmodel

get_semantic_id_of_css_ontology()[source]

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

class smia.aas_model.extended_submodel.ExtendedSkillParameter[source]

Bases: ExtendedGenericCSSClass

class smia.aas_model.extended_submodel.ExtendedSimpleSkillInterface(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] = ())[source]

Bases: ExtendedSkillInterface, ExtendedSubmodelElement

get_semantic_id_of_css_ontology()[source]

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] = ())[source]

Bases: ExtendedSkillInterface, ExtendedSubmodelElementCollection

get_semantic_id_of_css_ontology()[source]

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

get_associated_asset_interface()[source]

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