Functions
str	create_unique_short_id (str id_short)
	Generate a unique identifier string by appending a UUID to the provided ID short.

model.Submodel	create_submodel_from_file (str json_file="")
	Creates a submodel from a JSON file file.

model.Property	create_base_submodel_element_property (str\|None id_short, model.datatypes type, Any value, str display_name="", str description="")
	Create a basic SubmodelElement of type Property.

model.SubmodelElementCollection	create_base_submodel_element_collection (str id_short, list[model.SubmodelElement] value, str display_name="", str description="")
	Create a basic SubmodelElement of type SubmodelElementCollection.

model.Submodel	create_base_submodel (str identifier, str id_short, str display_name="", str description="")
	Create a basic Submodel.

model.AssetAdministrationShell	create_base_aas (str identifier, str id_short, str global_asset_identifier, str display_name="", str description="", model.AssetKind asset_kind=model.AssetKind.INSTANCE)
	Create a basic AAS.

model.AssetInformation	create_base_asset_information (str identifier, model.AssetKind asset_kind=model.AssetKind.INSTANCE)
	Return a basic AssetInformation instance.

model.ModelReference	create_reference (str id)
	Create a ModelReference.

model.EmbeddedDataSpecification\|None	create_embedded_data_specification (model.PreferredNameTypeIEC61360 preferred_name, model.DefinitionTypeIEC61360\|None definition, model.ShortNameTypeIEC61360\|None short_name, str\|None unit, model.Reference\|None unit_id, model.DataTypeIEC61360\|None data_type, str\|None source_of_definition, str\|None symbol, str\|None value_format, set[model.ValueReferencePair]\|None value_list, str\|None value, list[model.IEC61360LevelType]\|None level_types)
	Create an embedded data specification with the given parameters.

Variables
	_logger

Function Documentation

◆ create_base_aas()

model.AssetAdministrationShell aas_http_client.utilities.model_builder.create_base_aas	(	str	identifier,
		str	id_short,
		str	global_asset_identifier,
		str	display_name = `""`,
		str	description = `""`,
		model.AssetKind	asset_kind = `model.AssetKind.INSTANCE`
	)

Create a basic AAS.

Parameters

identifier	identifier of the AAS
id_short	ID short of the AAS
global_asset_identifier	identifier of the global Asset
display_name	display name of the AAS, defaults to ""
description	description of the AAS, defaults to ""
asset_kind	kind of the Asset, defaults to AssetKind.INSTANCE

Returns: AssetAdministrationShell instance

Definition at line 131 of file model_builder.py.

Here is the call graph for this function:

◆ create_base_asset_information()

model.AssetInformation aas_http_client.utilities.model_builder.create_base_asset_information	(	str	identifier,
		model.AssetKind	asset_kind = `model.AssetKind.INSTANCE`
	)

Return a basic AssetInformation instance.

Parameters

identifier	identifier of the AssetInformation
asset_kind	kind of the Asset, defaults to AssetKind.INSTANCE

Returns: AssetInformation instance

Definition at line 164 of file model_builder.py.

Here is the caller graph for this function:

◆ create_base_submodel()

model.Submodel aas_http_client.utilities.model_builder.create_base_submodel	(	str	identifier,
		str	id_short,
		str	display_name = `""`,
		str	description = `""`
	)

Create a basic Submodel.

Parameters

identifier	identifier of the Submodel
id_short	ID short of the Submodel
display_name	display name of the Submodel, defaults to ""
description	description of the Submodel, defaults to ""

Returns: Submodel instance

Definition at line 106 of file model_builder.py.

◆ create_base_submodel_element_collection()

model.SubmodelElementCollection aas_http_client.utilities.model_builder.create_base_submodel_element_collection	(	str	id_short,
		list[model.SubmodelElement]	value,
		str	display_name = `""`,
		str	description = `""`
	)

Create a basic SubmodelElement of type SubmodelElementCollection.

Definition at line 82 of file model_builder.py.

◆ create_base_submodel_element_property()

model.Property aas_http_client.utilities.model_builder.create_base_submodel_element_property	(	str \| None	id_short,
		model.datatypes	type,
		Any	value,
		str	display_name = `""`,
		str	description = `""`
	)

Create a basic SubmodelElement of type Property.

Definition at line 65 of file model_builder.py.

◆ create_embedded_data_specification()

model.EmbeddedDataSpecification \| None aas_http_client.utilities.model_builder.create_embedded_data_specification	(	model.PreferredNameTypeIEC61360	preferred_name,
		model.DefinitionTypeIEC61360 \| None	definition,
		model.ShortNameTypeIEC61360 \| None	short_name,
		str \| None	unit,
		model.Reference \| None	unit_id,
		model.DataTypeIEC61360 \| None	data_type,
		str \| None	source_of_definition,
		str \| None	symbol,
		str \| None	value_format,
		set[model.ValueReferencePair] \| None	value_list,
		str \| None	value,
		list[model.IEC61360LevelType] \| None	level_types
	)

Create an embedded data specification with the given parameters.

Parameters

preferred_name	The preferred name of the concept description.
definition	The definition of the concept description.
short_name	The short name of the concept description.
unit	The unit of the concept description.
unit_id	The unit reference of the concept description.
data_type	The data type of the concept description.
source_of_definition	The source of definition of the concept description.
symbol	The symbol of the concept description.
value_format	The value format of the concept description.
value_list	The value list of the concept description.
value	The value of the concept description.
level_types	The level types of the concept description.

Returns: An instance of EmbeddedDataSpecification if successful, None otherwise.

Definition at line 193 of file model_builder.py.

◆ create_reference()

model.ModelReference aas_http_client.utilities.model_builder.create_reference ( str id )

Create a ModelReference.

Parameters

id	ID of the Submodel to reference

Returns: ModelReference instance

Definition at line 173 of file model_builder.py.

◆ create_submodel_from_file()

model.Submodel aas_http_client.utilities.model_builder.create_submodel_from_file ( str json_file = "" )

Creates a submodel from a JSON file file.

Parameters

id	ID of the submodel. If empty, the template's ID is used

Definition at line 36 of file model_builder.py.

◆ create_unique_short_id()

str aas_http_client.utilities.model_builder.create_unique_short_id ( str id_short )

Generate a unique identifier string by appending a UUID to the provided ID short.

Parameters

id_short provided ID short

Returns: unique identifier

Definition at line 27 of file model_builder.py.

Variable Documentation

◆ _logger

aas_http_client.utilities.model_builder._logger

protected

Definition at line 19 of file model_builder.py.

Functions

Variables

Function Documentation

◆ create_base_aas()

◆ create_base_asset_information()

◆ create_base_submodel()

◆ create_base_submodel_element_collection()

◆ create_base_submodel_element_property()

◆ create_embedded_data_specification()

◆ create_reference()

◆ create_submodel_from_file()

◆ create_unique_short_id()

Variable Documentation

◆ _logger