implementations.sm_registry_implementation.SubmodelRegistryImplementation Class Reference

Implementation of Submodel Registry related API calls. More...

Inheritance diagram for implementations.sm_registry_implementation.SubmodelRegistryImplementation:

Collaboration diagram for implementations.sm_registry_implementation.SubmodelRegistryImplementation:

Public Member Functions
	__init__ (self, "AasHttpClient" client)
	Initializes the SubmodelRegistryImplementation with the given client.
dict|None	get_submodel_descriptor_by_id (self, str submodel_identifier)
	Returns the Submodel Descriptor for the given submodel identifier.
bool	put_submodel_descriptor_by_id (self, str submodel_identifier, dict request_body)
	Creates or updates an existing Submodel Descriptor.
bool	delete_submodel_descriptor_by_id (self, str submodel_identifier)
	Deletes a Submodel Descriptor, i.e.
dict|None	get_all_submodel_descriptors (self, int limit=100, str cursor="")
	Returns all Submodel Descriptors.
dict|None	post_submodel_descriptor (self, dict request_body)
	Creates a new Submodel Descriptor, i.e.
bool	delete_all_submodel_descriptors (self)
	Deletes all Submodel Descriptors.
dict|None	get_self_description (self)
	Returns the self-describing information of a network resource (ServiceDescription).

Protected Attributes
	_client

Detailed Description

Implementation of Submodel Registry related API calls.

Definition at line 30 of file sm_registry_implementation.py.

Constructor & Destructor Documentation

__init__()

implementations.sm_registry_implementation.SubmodelRegistryImplementation.__init__	(		self,
		"AasHttpClient"	client
	)

Initializes the SubmodelRegistryImplementation with the given client.

Definition at line 33 of file sm_registry_implementation.py.

Member Function Documentation

delete_all_submodel_descriptors()

bool implementations.sm_registry_implementation.SubmodelRegistryImplementation.delete_all_submodel_descriptors

(

self

)

Deletes all Submodel Descriptors.

Returns

True if deletion was successful, False otherwise

Definition at line 209 of file sm_registry_implementation.py.

delete_submodel_descriptor_by_id()

bool implementations.sm_registry_implementation.SubmodelRegistryImplementation.delete_submodel_descriptor_by_id	(		self,
		str	submodel_identifier
	)

Deletes a Submodel Descriptor, i.e.

de-registers a submodel.

Parameters

submodel_identifier

The unique identifier of the Submodel Descriptor

Returns

True if deletion was successful, False otherwise

Definition at line 118 of file sm_registry_implementation.py.

get_all_submodel_descriptors()

dict | None implementations.sm_registry_implementation.SubmodelRegistryImplementation.get_all_submodel_descriptors	(		self,
		int	limit = 100,
		str	cursor = ""
	)

Returns all Submodel Descriptors.

Parameters

limit	The maximum number of elements in the response array
cursor	A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue

Returns

Submodel Descriptors data or None if an error occurred

Definition at line 152 of file sm_registry_implementation.py.

get_self_description()

dict | None implementations.sm_registry_implementation.SubmodelRegistryImplementation.get_self_description

(

self

)

Returns the self-describing information of a network resource (ServiceDescription).

Returns

self-describing information of a network resource

Definition at line 233 of file sm_registry_implementation.py.

get_submodel_descriptor_by_id()

dict | None implementations.sm_registry_implementation.SubmodelRegistryImplementation.get_submodel_descriptor_by_id	(		self,
		str	submodel_identifier
	)

Returns the Submodel Descriptor for the given submodel identifier.

Parameters

submodel_identifier

The unique identifier of the Submodel Descriptor

Returns

Submodel Descriptor data or None if an error occurred

Definition at line 50 of file sm_registry_implementation.py.

post_submodel_descriptor()

dict | None implementations.sm_registry_implementation.SubmodelRegistryImplementation.post_submodel_descriptor	(		self,
		dict	request_body
	)

Creates a new Submodel Descriptor, i.e.

registers a submodel.

Parameters

request_body

Submodel Descriptor object

Returns

Created Submodel Descriptor data or None if an error occurred

Definition at line 184 of file sm_registry_implementation.py.

put_submodel_descriptor_by_id()

bool implementations.sm_registry_implementation.SubmodelRegistryImplementation.put_submodel_descriptor_by_id	(		self,
		str	submodel_identifier,
		dict	request_body
	)

Creates or updates an existing Submodel Descriptor.

Parameters

submodel_identifier	The unique identifier of the Submodel Descriptor
request_body	Submodel Descriptor object

Returns

Updated Submodel Descriptor data or None if an error occurred

Definition at line 85 of file sm_registry_implementation.py.

Member Data Documentation

_client

implementations.sm_registry_implementation.SubmodelRegistryImplementation._client

protected

Definition at line 34 of file sm_registry_implementation.py.

---

The documentation for this class was generated from the following file:

• aas_http_client/classes/client/implementations/sm_registry_implementation.py