Package de.iip_ecosphere.platform.support.aas.basyx

Class BaSyxSubmodel

java.lang.Object

de.iip_ecosphere.platform.support.aas.basyx.AbstractSubmodel<org.eclipse.basyx.submodel.metamodel.map.SubModel>

de.iip_ecosphere.platform.support.aas.basyx.BaSyxSubmodel

All Implemented Interfaces:

BaSyxElementTranslator.DataElementsRegistrar, BaSyxElementTranslator.OperationsRegistrar, BaSyxElementTranslator.RemainingSubmodelElementsRegistrar, BaSyxElementTranslator.SubmodelElementsRegistrar, de.iip_ecosphere.platform.support.aas.Element, de.iip_ecosphere.platform.support.aas.ElementContainer, de.iip_ecosphere.platform.support.aas.HasDataSpecification, de.iip_ecosphere.platform.support.aas.HasKind, de.iip_ecosphere.platform.support.aas.HasSemantics, de.iip_ecosphere.platform.support.aas.Identifiable, de.iip_ecosphere.platform.support.aas.Qualifiable, de.iip_ecosphere.platform.support.aas.Referable, de.iip_ecosphere.platform.support.aas.Submodel

public class BaSyxSubmodel
extends AbstractSubmodel<org.eclipse.basyx.submodel.metamodel.map.SubModel>

Wraps a BaSyx sub-model.

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	BaSyxSubmodel.BaSyxSubmodelBuilder	Builder for BaSyxSubmodel.

Nested classes/interfaces inherited from interface de.iip_ecosphere.platform.support.aas.Submodel

de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder

Field Summary

Fields

Modifier and Type	Field	Description
private AbstractAas.BaSyxSubmodelParent	parent

Constructor Summary

Constructors

Modifier	Constructor	Description
(package private)	BaSyxSubmodel(AbstractAas.BaSyxSubmodelParent parent, org.eclipse.basyx.submodel.metamodel.map.SubModel instance)	Creates an instance based on a given instance.
private	BaSyxSubmodel(org.eclipse.basyx.submodel.metamodel.map.SubModel subModel)	Creates an instance.

Method Summary

Modifier and Type	Method	Description
de.iip_ecosphere.platform.support.aas.SubmodelElementCollection.SubmodelElementCollectionBuilder	createSubmodelElementCollectionBuilder(String idShort, boolean ordered, boolean allowDuplicates)
private de.iip_ecosphere.platform.support.aas.SubmodelElementCollection.SubmodelElementCollectionBuilder	obtainSubmodelElementCollectionBuilder(BaSyxSubmodelElementContainerBuilder<?> parent, String idShort, boolean ordered, boolean allowDuplicates)	Creates a builder for a contained sub-model element collection.

Methods inherited from class de.iip_ecosphere.platform.support.aas.basyx.AbstractSubmodel

accept, createReference, dataElements, delete, getDataElement, getDataElementsCount, getIdShort, getOperation, getOperationsCount, getPropertiesCount, getProperty, getReferenceElement, getSubmodel, getSubmodelElement, getSubmodelElementCollection, getSubmodelElementsCount, getSubmodelEndpoint, operations, properties, register, register, register, register, submodelElements

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

parent

private AbstractAas.BaSyxSubmodelParent parent

Constructor Details

BaSyxSubmodel

private BaSyxSubmodel(org.eclipse.basyx.submodel.metamodel.map.SubModel subModel)

Creates an instance. Prevents external creation.

Parameters:

subModel - the sub-model instance

BaSyxSubmodel

BaSyxSubmodel(AbstractAas.BaSyxSubmodelParent parent, org.eclipse.basyx.submodel.metamodel.map.SubModel instance)

Creates an instance based on a given instance.

Parameters:

parent - the parent instance

instance - the BaSyx submodel instance

Method Details

obtainSubmodelElementCollectionBuilder

private de.iip_ecosphere.platform.support.aas.SubmodelElementCollection.SubmodelElementCollectionBuilder obtainSubmodelElementCollectionBuilder(BaSyxSubmodelElementContainerBuilder<?> parent, String idShort, boolean ordered, boolean allowDuplicates)

Creates a builder for a contained sub-model element collection. Calling this method again with the same name shall lead to a builder that allows for modifying the sub-model.

Parameters:

parent - the parent builder

idShort - the short name of the reference element

ordered - whether the collection is ordered

allowDuplicates - whether the collection allows duplicates

Returns:

the builder

Throws:

IllegalArgumentException - if idShort is null or empty; or if modification is not possible

createSubmodelElementCollectionBuilder

public de.iip_ecosphere.platform.support.aas.SubmodelElementCollection.SubmodelElementCollectionBuilder createSubmodelElementCollectionBuilder(String idShort, boolean ordered, boolean allowDuplicates)