aas_http_client.utilities.model_builder Namespace Reference

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="")
	Create a basic AAS.
model.AssetInformation	create_base_asset_information (str identifier)
	Return a basic AssetInformation instance.
model.ModelReference	create_reference (str id)
	Create a ModelReference.

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 = ""
	)

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 ""

Returns

AssetAdministrationShell instance

Definition at line 142 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

)

Return a basic AssetInformation instance.

Parameters

id_short	short ID of the AssetInformation
namespace	namespace of the AssetInformation, defaults to "basyx_python_aas_server"

Returns

AssetInformation instance

Definition at line 174 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 114 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 86 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_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 183 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.