aas_http_client.utilities.sdk_tools Namespace Reference

Functions
list[str]	get_submodel_ids (model.AssetAdministrationShell shell)
	Get all IDs from the submodels referenced in the given AAS.
bool	add_submodel_to_aas (model.AssetAdministrationShell aas, model.Submodel submodel)
	Add a given Submodel correctly to a provided AssetAdministrationShell.
bool	remove_submodel_from_aas (model.AssetAdministrationShell aas, model.Submodel submodel)
	Remove a given Submodel correctly from a provided AssetAdministrationShell.
Any|None	convert_to_object (dict content)
	Convert a dictionary to a BaSyx SDK framework object.
dict|None	convert_to_dict (Any object)
	Convert a BaSyx SDK framework object.

Variables
	_logger

Function Documentation

add_submodel_to_aas()

bool aas_http_client.utilities.sdk_tools.add_submodel_to_aas	(	model.AssetAdministrationShell	aas,
		model.Submodel	submodel
	)

Add a given Submodel correctly to a provided AssetAdministrationShell.

Parameters

aas	provided AssetAdministrationShell to which the Submodel should be added
submodel	given Submodel to add

Returns

True if the Submodel was added, False if it was already referenced

Definition at line 39 of file sdk_tools.py.

Here is the call graph for this function:

convert_to_dict()

dict | None aas_http_client.utilities.sdk_tools.convert_to_dict

(

Any

object

)

Convert a BaSyx SDK framework object.

to a dictionary.

Parameters

object

BaSyx SDK framework object to convert

Returns

dictionary representation of the object or None

Definition at line 89 of file sdk_tools.py.

convert_to_object()

Any | None aas_http_client.utilities.sdk_tools.convert_to_object

(

dict

content

)

Convert a dictionary to a BaSyx SDK framework object.

Parameters

content

dictionary to convert

Returns

BaSyx SDK framework object or None

Definition at line 70 of file sdk_tools.py.

get_submodel_ids()

list[str] aas_http_client.utilities.sdk_tools.get_submodel_ids

(

model.AssetAdministrationShell

shell

)

Get all IDs from the submodels referenced in the given AAS.

Parameters

shell

The Asset Administration Shell to extract submodel IDs from.

Returns

A list of submodel IDs referenced in the AAS.

Definition at line 21 of file sdk_tools.py.

Here is the caller graph for this function:

remove_submodel_from_aas()

bool aas_http_client.utilities.sdk_tools.remove_submodel_from_aas	(	model.AssetAdministrationShell	aas,
		model.Submodel	submodel
	)

Remove a given Submodel correctly from a provided AssetAdministrationShell.

Parameters

aas	provided AssetAdministrationShell from which the Submodel should be removed
submodel	given Submodel to remove

Returns

True if the Submodel was removed, False if it was not referenced

Definition at line 55 of file sdk_tools.py.

Here is the call graph for this function:

Variable Documentation

_logger

aas_http_client.utilities.sdk_tools._logger

protected

Definition at line 13 of file sdk_tools.py.