Eclipse BaSyx Python SDK
stable
Contents:
1. Tutorials for working with the Eclipse BaSyx Python SDK
2. aas.model - Python Model of the AssetAdministrationShell Metamodel
3. adapter: Adapter of AAS-objects from and to different file-formats
4. aas.backend - Storing and Retrieving of AAS-objects in Backends
5. aas.examples - Example classes
6. aas.compliance_tool - Tool for Creating and Checking JSON, XML and AASX Files’ compliance
7. aas.util - Provide helpful utilities
8. Metamodel-Constraints
Eclipse BaSyx Python SDK
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
A
AASConstraintViolation
AASFromJsonDecoder (class in basyx.aas.adapter.json.json_deserialization)
AASFromXmlDecoder (class in basyx.aas.adapter.xml.xml_deserialization)
AASToJsonEncoder (class in basyx.aas.adapter.json.json_serialization)
AASXReader (class in basyx.aas.adapter.aasx)
AASXWriter (class in basyx.aas.adapter.aasx)
AbstractIdentifierGenerator (class in basyx.aas.util.identification)
AbstractObjectProvider (class in basyx.aas.model.provider)
AbstractObjectStore (class in basyx.aas.model.provider)
AbstractSupplementaryFileContainer (class in basyx.aas.adapter.aasx)
add() (basyx.aas.backend.couchdb.CouchDBObjectStore method)
(basyx.aas.model.base.NamespaceSet method)
(basyx.aas.model.base.OrderedNamespaceSet method)
(basyx.aas.model.provider.DictObjectStore method)
add_extension() (basyx.aas.model.base.HasExtension method)
add_file() (basyx.aas.adapter.aasx.AbstractSupplementaryFileContainer method)
(basyx.aas.adapter.aasx.DictSupplementaryFileContainer method)
add_log_record() (basyx.aas.compliance_tool.state_manager.ComplianceToolStateManager method)
add_log_records_from_data_checker() (basyx.aas.compliance_tool.state_manager.ComplianceToolStateManager method)
add_qualifier() (basyx.aas.model.base.Qualifiable method)
add_referable() (basyx.aas.model.base.UniqueIdShortNamespace method)
add_step() (basyx.aas.compliance_tool.state_manager.ComplianceToolStateManager method)
AdministrativeInformation (class in basyx.aas.model.base)
AnnotatedRelationshipElement (class in basyx.aas.model.submodel)
AnyURI (class in basyx.aas.model.datatypes)
AssetAdministrationShell (class in basyx.aas.model.aas)
AssetInformation (class in basyx.aas.model.aas)
AssetKind (class in basyx.aas.model.base)
B
Backend (class in basyx.aas.backend.backends)
BackendError
BackendNotAvailableException
Base64Binary (class in basyx.aas.model.datatypes)
BasicEventElement (class in basyx.aas.model.submodel)
basyx.aas.adapter.__init__
module
basyx.aas.adapter.aasx
module
basyx.aas.adapter.json.__init__
module
basyx.aas.adapter.json.json_deserialization
module
basyx.aas.adapter.json.json_serialization
module
basyx.aas.adapter.xml.__init__
module
basyx.aas.adapter.xml.xml_deserialization
module
basyx.aas.adapter.xml.xml_serialization
module
basyx.aas.backend.__init__
module
basyx.aas.backend.backends
module
basyx.aas.backend.couchdb
module
basyx.aas.compliance_tool.compliance_check_aasx
module
basyx.aas.compliance_tool.compliance_check_json
module
basyx.aas.compliance_tool.compliance_check_xml
module
basyx.aas.compliance_tool.state_manager
module
basyx.aas.examples.data.example_aas
module
basyx.aas.examples.data.example_aas_mandatory_attributes
module
basyx.aas.examples.data.example_aas_missing_attributes
module
basyx.aas.examples.data.example_submodel_template
module
basyx.aas.model.__init__
module
basyx.aas.model.aas
module
basyx.aas.model.base
module
basyx.aas.model.concept
module
basyx.aas.model.datatypes
module
basyx.aas.model.provider
module
basyx.aas.model.submodel
module
basyx.aas.util.__init__
module
basyx.aas.util.identification
module
basyx.aas.util.traversal
module
Blob (class in basyx.aas.model.submodel)
Byte (class in basyx.aas.model.datatypes)
C
Capability (class in basyx.aas.model.submodel)
check_aas_example() (in module basyx.aas.compliance_tool.compliance_check_aasx)
(in module basyx.aas.compliance_tool.compliance_check_json)
(in module basyx.aas.compliance_tool.compliance_check_xml)
check_aasx_files_equivalence() (in module basyx.aas.compliance_tool.compliance_check_aasx)
check_database() (basyx.aas.backend.couchdb.CouchDBObjectStore method)
check_deserialization() (in module basyx.aas.compliance_tool.compliance_check_aasx)
(in module basyx.aas.compliance_tool.compliance_check_json)
(in module basyx.aas.compliance_tool.compliance_check_xml)
check_json_files_equivalence() (in module basyx.aas.compliance_tool.compliance_check_json)
check_schema() (in module basyx.aas.compliance_tool.compliance_check_aasx)
(in module basyx.aas.compliance_tool.compliance_check_json)
(in module basyx.aas.compliance_tool.compliance_check_xml)
check_xml_files_equivalence() (in module basyx.aas.compliance_tool.compliance_check_xml)
clear() (basyx.aas.model.base.ConstrainedList method)
(basyx.aas.model.base.LangStringSet method)
(basyx.aas.model.base.NamespaceSet method)
(basyx.aas.model.base.OrderedNamespaceSet method)
close() (basyx.aas.adapter.aasx.AASXReader method)
(basyx.aas.adapter.aasx.AASXWriter method)
commit() (basyx.aas.model.base.Referable method)
commit_object() (basyx.aas.backend.backends.Backend class method)
(basyx.aas.backend.couchdb.CouchDBBackend class method)
ComplianceToolStateManager (class in basyx.aas.compliance_tool.state_manager)
ConceptDescription (class in basyx.aas.model.concept)
ConstrainedLangStringSet (class in basyx.aas.model.base)
ConstrainedList (class in basyx.aas.model.base)
CouchDBBackend (class in basyx.aas.backend.couchdb)
CouchDBConflictError
CouchDBConnectionError
CouchDBError
CouchDBObjectStore (class in basyx.aas.backend.couchdb)
CouchDBResponseError
CouchDBServerError
CouchDBSourceError
create_example_asset_administration_shell() (in module basyx.aas.examples.data.example_aas)
(in module basyx.aas.examples.data.example_aas_mandatory_attributes)
(in module basyx.aas.examples.data.example_aas_missing_attributes)
create_example_asset_identification_submodel() (in module basyx.aas.examples.data.example_aas)
create_example_bill_of_material_submodel() (in module basyx.aas.examples.data.example_aas)
create_example_concept_description() (in module basyx.aas.examples.data.example_aas)
(in module basyx.aas.examples.data.example_aas_mandatory_attributes)
(in module basyx.aas.examples.data.example_aas_missing_attributes)
create_example_empty_asset_administration_shell() (in module basyx.aas.examples.data.example_aas_mandatory_attributes)
create_example_empty_submodel() (in module basyx.aas.examples.data.example_aas_mandatory_attributes)
create_example_submodel() (in module basyx.aas.examples.data.example_aas)
(in module basyx.aas.examples.data.example_aas_mandatory_attributes)
(in module basyx.aas.examples.data.example_aas_missing_attributes)
create_example_submodel_template() (in module basyx.aas.examples.data.example_submodel_template)
create_full_example() (in module basyx.aas.examples.data.example_aas)
(in module basyx.aas.examples.data.example_aas_mandatory_attributes)
(in module basyx.aas.examples.data.example_aas_missing_attributes)
D
DataElement (class in basyx.aas.model.submodel)
DataSpecificationContent (class in basyx.aas.model.base)
DataSpecificationIEC61360 (class in basyx.aas.model.base)
DataTypeIEC61360 (class in basyx.aas.model.base)
Date (class in basyx.aas.model.datatypes)
default() (basyx.aas.adapter.json.json_serialization.AASToJsonEncoder method)
DefinitionTypeIEC61360 (class in basyx.aas.model.base)
delete_couchdb_revision() (in module basyx.aas.backend.couchdb)
DictObjectStore (class in basyx.aas.model.provider)
DictSupplementaryFileContainer (class in basyx.aas.adapter.aasx)
Direction (class in basyx.aas.model.base)
discard() (basyx.aas.backend.couchdb.CouchDBObjectStore method)
(basyx.aas.model.base.NamespaceSet method)
(basyx.aas.model.provider.DictObjectStore method)
do_request() (basyx.aas.backend.couchdb.CouchDBBackend class method)
E
EmbeddedDataSpecification (class in basyx.aas.model.base)
emit() (basyx.aas.compliance_tool.state_manager.ComplianceToolStateManager method)
Entity (class in basyx.aas.model.submodel)
EntityType (class in basyx.aas.model.base)
EventElement (class in basyx.aas.model.submodel)
extend() (basyx.aas.model.base.ConstrainedList method)
Extension (class in basyx.aas.model.base)
ExternalReference (class in basyx.aas.model.base)
F
File (class in basyx.aas.model.submodel)
find_source() (basyx.aas.model.base.Referable method)
Float (class in basyx.aas.model.datatypes)
format_state_manager() (basyx.aas.compliance_tool.state_manager.ComplianceToolStateManager method)
format_step() (basyx.aas.compliance_tool.state_manager.ComplianceToolStateManager method)
from_referable() (basyx.aas.model.base.Key static method)
(basyx.aas.model.base.ModelReference static method)
from_string() (basyx.aas.model.datatypes.NormalizedString class method)
from_xsd() (in module basyx.aas.model.datatypes)
G
generate_id() (basyx.aas.util.identification.AbstractIdentifierGenerator method)
(basyx.aas.util.identification.NamespaceIRIGenerator method)
(basyx.aas.util.identification.UUIDGenerator method)
generate_source() (basyx.aas.backend.couchdb.CouchDBObjectStore method)
get() (basyx.aas.model.base.NamespaceSet method)
(basyx.aas.model.provider.AbstractObjectProvider method)
get_backend() (in module basyx.aas.backend.backends)
get_content_type() (basyx.aas.adapter.aasx.AbstractSupplementaryFileContainer method)
(basyx.aas.adapter.aasx.DictSupplementaryFileContainer method)
get_core_properties() (basyx.aas.adapter.aasx.AASXReader method)
get_couchdb_revision() (in module basyx.aas.backend.couchdb)
get_error_logs_from_step() (basyx.aas.compliance_tool.state_manager.ComplianceToolStateManager method)
get_extension_by_name() (basyx.aas.model.base.HasExtension method)
get_friendly_name() (basyx.aas.adapter.aasx.NameFriendlyfier method)
get_identifiable() (basyx.aas.backend.couchdb.CouchDBObjectStore method)
(basyx.aas.model.provider.AbstractObjectProvider method)
(basyx.aas.model.provider.DictObjectStore method)
(basyx.aas.model.provider.ObjectProviderMultiplexer method)
get_identifiable_by_couchdb_id() (basyx.aas.backend.couchdb.CouchDBObjectStore method)
get_identifier() (basyx.aas.model.base.Key method)
(basyx.aas.model.base.ModelReference method)
get_object_by_attribute() (basyx.aas.model.base.NamespaceSet method)
get_object_by_semantic_id() (basyx.aas.model.base.UniqueSemanticIdNamespace method)
get_qualifier_by_type() (basyx.aas.model.base.Qualifiable method)
get_referable() (basyx.aas.model.base.UniqueIdShortNamespace method)
get_sha256() (basyx.aas.adapter.aasx.AbstractSupplementaryFileContainer method)
(basyx.aas.adapter.aasx.DictSupplementaryFileContainer method)
get_thumbnail() (basyx.aas.adapter.aasx.AASXReader method)
H
HasDataSpecification (class in basyx.aas.model.base)
HasExtension (class in basyx.aas.model.base)
HasKind (class in basyx.aas.model.base)
HasSemantics (class in basyx.aas.model.base)
HexBinary (class in basyx.aas.model.datatypes)
I
Identifiable (class in basyx.aas.model.base)
IEC61360LevelType (class in basyx.aas.model.base)
insert() (basyx.aas.model.base.ConstrainedList method)
(basyx.aas.model.base.OrderedNamespaceSet method)
Int (class in basyx.aas.model.datatypes)
K
Key (class in basyx.aas.model.base)
KeyTypes (class in basyx.aas.model.base)
L
LangStringSet (class in basyx.aas.model.base)
,
[1]
Long (class in basyx.aas.model.datatypes)
M
ModellingKind (class in basyx.aas.model.base)
ModelReference (class in basyx.aas.model.base)
module
basyx.aas.adapter.__init__
basyx.aas.adapter.aasx
basyx.aas.adapter.json.__init__
basyx.aas.adapter.json.json_deserialization
basyx.aas.adapter.json.json_serialization
basyx.aas.adapter.xml.__init__
basyx.aas.adapter.xml.xml_deserialization
basyx.aas.adapter.xml.xml_serialization
basyx.aas.backend.__init__
basyx.aas.backend.backends
basyx.aas.backend.couchdb
basyx.aas.compliance_tool.compliance_check_aasx
basyx.aas.compliance_tool.compliance_check_json
basyx.aas.compliance_tool.compliance_check_xml
basyx.aas.compliance_tool.state_manager
basyx.aas.examples.data.example_aas
basyx.aas.examples.data.example_aas_mandatory_attributes
basyx.aas.examples.data.example_aas_missing_attributes
basyx.aas.examples.data.example_submodel_template
basyx.aas.model.__init__
basyx.aas.model.aas
basyx.aas.model.base
basyx.aas.model.concept
basyx.aas.model.datatypes
basyx.aas.model.provider
basyx.aas.model.submodel
basyx.aas.util.__init__
basyx.aas.util.identification
basyx.aas.util.traversal
MultiLanguageNameType (class in basyx.aas.model.base)
MultiLanguageProperty (class in basyx.aas.model.submodel)
MultiLanguageTextType (class in basyx.aas.model.base)
N
NameFriendlyfier (class in basyx.aas.adapter.aasx)
Namespace (class in basyx.aas.model.base)
NamespaceIRIGenerator (class in basyx.aas.util.identification)
NamespaceSet (class in basyx.aas.model.base)
NegativeInteger (class in basyx.aas.model.datatypes)
NonNegativeInteger (class in basyx.aas.model.datatypes)
NonPositiveInteger (class in basyx.aas.model.datatypes)
NormalizedString (class in basyx.aas.model.datatypes)
O
object_store_to_json() (in module basyx.aas.adapter.json.json_serialization)
ObjectProviderMultiplexer (class in basyx.aas.model.provider)
Operation (class in basyx.aas.model.submodel)
OrderedNamespaceSet (class in basyx.aas.model.base)
P
pop() (basyx.aas.model.base.NamespaceSet method)
(basyx.aas.model.base.OrderedNamespaceSet method)
PositiveInteger (class in basyx.aas.model.datatypes)
PreferredNameTypeIEC61360 (class in basyx.aas.model.base)
Property (class in basyx.aas.model.submodel)
Q
Qualifiable (class in basyx.aas.model.base)
Qualifier (class in basyx.aas.model.base)
QualifierKind (class in basyx.aas.model.base)
R
Range (class in basyx.aas.model.submodel)
read_aas_json_file() (in module basyx.aas.adapter.json.json_deserialization)
read_aas_json_file_into() (in module basyx.aas.adapter.json.json_deserialization)
read_aas_xml_element() (in module basyx.aas.adapter.xml.xml_deserialization)
read_aas_xml_file() (in module basyx.aas.adapter.xml.xml_deserialization)
read_aas_xml_file_into() (in module basyx.aas.adapter.xml.xml_deserialization)
read_into() (basyx.aas.adapter.aasx.AASXReader method)
Referable (class in basyx.aas.model.base)
Reference (class in basyx.aas.model.base)
ReferenceElement (class in basyx.aas.model.submodel)
register_backend() (in module basyx.aas.backend.backends)
register_credentials() (in module basyx.aas.backend.couchdb)
RelationshipElement (class in basyx.aas.model.submodel)
remove() (basyx.aas.model.base.NamespaceSet method)
(basyx.aas.model.base.OrderedNamespaceSet method)
remove_extension_by_name() (basyx.aas.model.base.HasExtension method)
remove_object_by_semantic_id() (basyx.aas.model.base.UniqueSemanticIdNamespace method)
remove_qualifier_by_type() (basyx.aas.model.base.Qualifiable method)
remove_referable() (basyx.aas.model.base.UniqueIdShortNamespace method)
resolve() (basyx.aas.model.base.ModelReference method)
Resource (class in basyx.aas.model.base)
S
set_couchdb_revision() (in module basyx.aas.backend.couchdb)
set_step_status() (basyx.aas.compliance_tool.state_manager.ComplianceToolStateManager method)
set_step_status_from_log() (basyx.aas.compliance_tool.state_manager.ComplianceToolStateManager method)
Short (class in basyx.aas.model.datatypes)
ShortNameTypeIEC61360 (class in basyx.aas.model.base)
SpecificAssetId (class in basyx.aas.model.base)
StateOfEvent (class in basyx.aas.model.base)
status (basyx.aas.compliance_tool.state_manager.ComplianceToolStateManager property)
Status (class in basyx.aas.compliance_tool.state_manager)
Step (class in basyx.aas.compliance_tool.state_manager)
StrictAASFromJsonDecoder (class in basyx.aas.adapter.json.json_deserialization)
StrictAASFromXmlDecoder (class in basyx.aas.adapter.xml.xml_deserialization)
StrictStrippedAASFromJsonDecoder (class in basyx.aas.adapter.json.json_deserialization)
StrictStrippedAASFromXmlDecoder (class in basyx.aas.adapter.xml.xml_deserialization)
StrippedAASFromJsonDecoder (class in basyx.aas.adapter.json.json_deserialization)
StrippedAASFromXmlDecoder (class in basyx.aas.adapter.xml.xml_deserialization)
StrippedAASToJsonEncoder (class in basyx.aas.adapter.json.json_serialization)
Submodel (class in basyx.aas.model.submodel)
SubmodelElement (class in basyx.aas.model.submodel)
SubmodelElementCollection (class in basyx.aas.model.submodel)
SubmodelElementList (class in basyx.aas.model.submodel)
T
trivial_cast() (in module basyx.aas.model.datatypes)
tzinfo (basyx.aas.model.datatypes.Date property)
U
UnexpectedTypeError
UniqueIdShortNamespace (class in basyx.aas.model.base)
UniqueSemanticIdNamespace (class in basyx.aas.model.base)
UnknownBackendException
UnsignedByte (class in basyx.aas.model.datatypes)
UnsignedInt (class in basyx.aas.model.datatypes)
UnsignedLong (class in basyx.aas.model.datatypes)
UnsignedShort (class in basyx.aas.model.datatypes)
update() (basyx.aas.model.base.Referable method)
update_from() (basyx.aas.model.base.Referable method)
update_nss_from() (basyx.aas.model.base.NamespaceSet method)
update_object() (basyx.aas.backend.backends.Backend class method)
(basyx.aas.backend.couchdb.CouchDBBackend class method)
utcoffset() (basyx.aas.model.datatypes.Date method)
UUIDGenerator (class in basyx.aas.util.identification)
V
ValueList (class in basyx.aas.model.base)
ValueReferencePair (class in basyx.aas.model.base)
W
walk_semantic_ids_recursive() (in module basyx.aas.util.traversal)
walk_submodel() (in module basyx.aas.util.traversal)
write_aas() (basyx.aas.adapter.aasx.AASXWriter method)
write_aas_json_file() (in module basyx.aas.adapter.json.json_serialization)
write_aas_objects() (basyx.aas.adapter.aasx.AASXWriter method)
write_aas_xml_file() (in module basyx.aas.adapter.xml.xml_serialization)
write_all_aas_objects() (basyx.aas.adapter.aasx.AASXWriter method)
write_core_properties() (basyx.aas.adapter.aasx.AASXWriter method)
write_file() (basyx.aas.adapter.aasx.AbstractSupplementaryFileContainer method)
(basyx.aas.adapter.aasx.DictSupplementaryFileContainer method)
write_thumbnail() (basyx.aas.adapter.aasx.AASXWriter method)
X
xsd_repr() (in module basyx.aas.model.datatypes)