aas-core3 1.0.0
Manipulate, verify and de/serialize asset administration shells in C++.
Loading...
Searching...
No Matches
aas_core::aas_3_0::jsonization Namespace Reference

Classes

struct  DeserializationError
 
struct  IndexSegment
 
class  ISegment
 
struct  Path
 
struct  PropertySegment
 
class  SerializationException
 

Functions

common::expected< std::shared_ptr< types::IHasSemantics >, DeserializationErrorHasSemanticsFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IHasSemantics.
 
common::expected< std::shared_ptr< types::IExtension >, DeserializationErrorExtensionFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IExtension.
 
common::expected< std::shared_ptr< types::IHasExtensions >, DeserializationErrorHasExtensionsFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IHasExtensions.
 
common::expected< std::shared_ptr< types::IReferable >, DeserializationErrorReferableFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IReferable.
 
common::expected< std::shared_ptr< types::IIdentifiable >, DeserializationErrorIdentifiableFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IIdentifiable.
 
common::expected< std::shared_ptr< types::IHasKind >, DeserializationErrorHasKindFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IHasKind.
 
common::expected< std::shared_ptr< types::IHasDataSpecification >, DeserializationErrorHasDataSpecificationFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IHasDataSpecification.
 
common::expected< std::shared_ptr< types::IAdministrativeInformation >, DeserializationErrorAdministrativeInformationFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IAdministrativeInformation.
 
common::expected< std::shared_ptr< types::IQualifiable >, DeserializationErrorQualifiableFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IQualifiable.
 
common::expected< std::shared_ptr< types::IQualifier >, DeserializationErrorQualifierFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IQualifier.
 
common::expected< std::shared_ptr< types::IAssetAdministrationShell >, DeserializationErrorAssetAdministrationShellFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IAssetAdministrationShell.
 
common::expected< std::shared_ptr< types::IAssetInformation >, DeserializationErrorAssetInformationFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IAssetInformation.
 
common::expected< std::shared_ptr< types::IResource >, DeserializationErrorResourceFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IResource.
 
common::expected< std::shared_ptr< types::ISpecificAssetId >, DeserializationErrorSpecificAssetIdFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::ISpecificAssetId.
 
common::expected< std::shared_ptr< types::ISubmodel >, DeserializationErrorSubmodelFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::ISubmodel.
 
common::expected< std::shared_ptr< types::ISubmodelElement >, DeserializationErrorSubmodelElementFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::ISubmodelElement.
 
common::expected< std::shared_ptr< types::IRelationshipElement >, DeserializationErrorRelationshipElementFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IRelationshipElement.
 
common::expected< std::shared_ptr< types::ISubmodelElementList >, DeserializationErrorSubmodelElementListFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::ISubmodelElementList.
 
common::expected< std::shared_ptr< types::ISubmodelElementCollection >, DeserializationErrorSubmodelElementCollectionFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::ISubmodelElementCollection.
 
common::expected< std::shared_ptr< types::IDataElement >, DeserializationErrorDataElementFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IDataElement.
 
common::expected< std::shared_ptr< types::IProperty >, DeserializationErrorPropertyFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IProperty.
 
common::expected< std::shared_ptr< types::IMultiLanguageProperty >, DeserializationErrorMultiLanguagePropertyFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IMultiLanguageProperty.
 
common::expected< std::shared_ptr< types::IRange >, DeserializationErrorRangeFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IRange.
 
common::expected< std::shared_ptr< types::IReferenceElement >, DeserializationErrorReferenceElementFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IReferenceElement.
 
common::expected< std::shared_ptr< types::IBlob >, DeserializationErrorBlobFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IBlob.
 
common::expected< std::shared_ptr< types::IFile >, DeserializationErrorFileFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IFile.
 
common::expected< std::shared_ptr< types::IAnnotatedRelationshipElement >, DeserializationErrorAnnotatedRelationshipElementFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IAnnotatedRelationshipElement.
 
common::expected< std::shared_ptr< types::IEntity >, DeserializationErrorEntityFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IEntity.
 
common::expected< std::shared_ptr< types::IEventPayload >, DeserializationErrorEventPayloadFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IEventPayload.
 
common::expected< std::shared_ptr< types::IEventElement >, DeserializationErrorEventElementFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IEventElement.
 
common::expected< std::shared_ptr< types::IBasicEventElement >, DeserializationErrorBasicEventElementFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IBasicEventElement.
 
common::expected< std::shared_ptr< types::IOperation >, DeserializationErrorOperationFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IOperation.
 
common::expected< std::shared_ptr< types::IOperationVariable >, DeserializationErrorOperationVariableFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IOperationVariable.
 
common::expected< std::shared_ptr< types::ICapability >, DeserializationErrorCapabilityFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::ICapability.
 
common::expected< std::shared_ptr< types::IConceptDescription >, DeserializationErrorConceptDescriptionFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IConceptDescription.
 
common::expected< std::shared_ptr< types::IReference >, DeserializationErrorReferenceFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IReference.
 
common::expected< std::shared_ptr< types::IKey >, DeserializationErrorKeyFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IKey.
 
common::expected< std::shared_ptr< types::IAbstractLangString >, DeserializationErrorAbstractLangStringFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IAbstractLangString.
 
common::expected< std::shared_ptr< types::ILangStringNameType >, DeserializationErrorLangStringNameTypeFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::ILangStringNameType.
 
common::expected< std::shared_ptr< types::ILangStringTextType >, DeserializationErrorLangStringTextTypeFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::ILangStringTextType.
 
common::expected< std::shared_ptr< types::IEnvironment >, DeserializationErrorEnvironmentFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IEnvironment.
 
common::expected< std::shared_ptr< types::IDataSpecificationContent >, DeserializationErrorDataSpecificationContentFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IDataSpecificationContent.
 
common::expected< std::shared_ptr< types::IEmbeddedDataSpecification >, DeserializationErrorEmbeddedDataSpecificationFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IEmbeddedDataSpecification.
 
common::expected< std::shared_ptr< types::ILevelType >, DeserializationErrorLevelTypeFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::ILevelType.
 
common::expected< std::shared_ptr< types::IValueReferencePair >, DeserializationErrorValueReferencePairFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IValueReferencePair.
 
common::expected< std::shared_ptr< types::IValueList >, DeserializationErrorValueListFrom (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IValueList.
 
common::expected< std::shared_ptr< types::ILangStringPreferredNameTypeIec61360 >, DeserializationErrorLangStringPreferredNameTypeIec61360From (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::ILangStringPreferredNameTypeIec61360.
 
common::expected< std::shared_ptr< types::ILangStringShortNameTypeIec61360 >, DeserializationErrorLangStringShortNameTypeIec61360From (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::ILangStringShortNameTypeIec61360.
 
common::expected< std::shared_ptr< types::ILangStringDefinitionTypeIec61360 >, DeserializationErrorLangStringDefinitionTypeIec61360From (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::ILangStringDefinitionTypeIec61360.
 
common::expected< std::shared_ptr< types::IDataSpecificationIec61360 >, DeserializationErrorDataSpecificationIec61360From (const nlohmann::json &json, bool additional_properties=false)
 Deserialize json value to an instance of types::IDataSpecificationIec61360.
 
nlohmann::json Serialize (const types::IClass &that)
 Serialize that instance to a JSON value.
 

Function Documentation

◆ AbstractLangStringFrom()

common::expected< std::shared_ptr< types::IAbstractLangString >, DeserializationError > aas_core::aas_3_0::jsonization::AbstractLangStringFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IAbstractLangString.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ AdministrativeInformationFrom()

common::expected< std::shared_ptr< types::IAdministrativeInformation >, DeserializationError > aas_core::aas_3_0::jsonization::AdministrativeInformationFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IAdministrativeInformation.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ AnnotatedRelationshipElementFrom()

common::expected< std::shared_ptr< types::IAnnotatedRelationshipElement >, DeserializationError > aas_core::aas_3_0::jsonization::AnnotatedRelationshipElementFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IAnnotatedRelationshipElement.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ AssetAdministrationShellFrom()

common::expected< std::shared_ptr< types::IAssetAdministrationShell >, DeserializationError > aas_core::aas_3_0::jsonization::AssetAdministrationShellFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IAssetAdministrationShell.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ AssetInformationFrom()

common::expected< std::shared_ptr< types::IAssetInformation >, DeserializationError > aas_core::aas_3_0::jsonization::AssetInformationFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IAssetInformation.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ BasicEventElementFrom()

common::expected< std::shared_ptr< types::IBasicEventElement >, DeserializationError > aas_core::aas_3_0::jsonization::BasicEventElementFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IBasicEventElement.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ BlobFrom()

common::expected< std::shared_ptr< types::IBlob >, DeserializationError > aas_core::aas_3_0::jsonization::BlobFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IBlob.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ CapabilityFrom()

common::expected< std::shared_ptr< types::ICapability >, DeserializationError > aas_core::aas_3_0::jsonization::CapabilityFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::ICapability.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ ConceptDescriptionFrom()

common::expected< std::shared_ptr< types::IConceptDescription >, DeserializationError > aas_core::aas_3_0::jsonization::ConceptDescriptionFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IConceptDescription.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ DataElementFrom()

common::expected< std::shared_ptr< types::IDataElement >, DeserializationError > aas_core::aas_3_0::jsonization::DataElementFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IDataElement.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ DataSpecificationContentFrom()

common::expected< std::shared_ptr< types::IDataSpecificationContent >, DeserializationError > aas_core::aas_3_0::jsonization::DataSpecificationContentFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IDataSpecificationContent.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ DataSpecificationIec61360From()

common::expected< std::shared_ptr< types::IDataSpecificationIec61360 >, DeserializationError > aas_core::aas_3_0::jsonization::DataSpecificationIec61360From ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IDataSpecificationIec61360.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ EmbeddedDataSpecificationFrom()

common::expected< std::shared_ptr< types::IEmbeddedDataSpecification >, DeserializationError > aas_core::aas_3_0::jsonization::EmbeddedDataSpecificationFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IEmbeddedDataSpecification.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ EntityFrom()

common::expected< std::shared_ptr< types::IEntity >, DeserializationError > aas_core::aas_3_0::jsonization::EntityFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IEntity.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ EnvironmentFrom()

common::expected< std::shared_ptr< types::IEnvironment >, DeserializationError > aas_core::aas_3_0::jsonization::EnvironmentFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IEnvironment.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ EventElementFrom()

common::expected< std::shared_ptr< types::IEventElement >, DeserializationError > aas_core::aas_3_0::jsonization::EventElementFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IEventElement.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ EventPayloadFrom()

common::expected< std::shared_ptr< types::IEventPayload >, DeserializationError > aas_core::aas_3_0::jsonization::EventPayloadFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IEventPayload.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ ExtensionFrom()

common::expected< std::shared_ptr< types::IExtension >, DeserializationError > aas_core::aas_3_0::jsonization::ExtensionFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IExtension.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ FileFrom()

common::expected< std::shared_ptr< types::IFile >, DeserializationError > aas_core::aas_3_0::jsonization::FileFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IFile.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ HasDataSpecificationFrom()

common::expected< std::shared_ptr< types::IHasDataSpecification >, DeserializationError > aas_core::aas_3_0::jsonization::HasDataSpecificationFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IHasDataSpecification.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ HasExtensionsFrom()

common::expected< std::shared_ptr< types::IHasExtensions >, DeserializationError > aas_core::aas_3_0::jsonization::HasExtensionsFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IHasExtensions.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ HasKindFrom()

common::expected< std::shared_ptr< types::IHasKind >, DeserializationError > aas_core::aas_3_0::jsonization::HasKindFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IHasKind.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ HasSemanticsFrom()

common::expected< std::shared_ptr< types::IHasSemantics >, DeserializationError > aas_core::aas_3_0::jsonization::HasSemanticsFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IHasSemantics.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ IdentifiableFrom()

common::expected< std::shared_ptr< types::IIdentifiable >, DeserializationError > aas_core::aas_3_0::jsonization::IdentifiableFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IIdentifiable.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ KeyFrom()

common::expected< std::shared_ptr< types::IKey >, DeserializationError > aas_core::aas_3_0::jsonization::KeyFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IKey.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ LangStringDefinitionTypeIec61360From()

common::expected< std::shared_ptr< types::ILangStringDefinitionTypeIec61360 >, DeserializationError > aas_core::aas_3_0::jsonization::LangStringDefinitionTypeIec61360From ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::ILangStringDefinitionTypeIec61360.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ LangStringNameTypeFrom()

common::expected< std::shared_ptr< types::ILangStringNameType >, DeserializationError > aas_core::aas_3_0::jsonization::LangStringNameTypeFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::ILangStringNameType.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ LangStringPreferredNameTypeIec61360From()

common::expected< std::shared_ptr< types::ILangStringPreferredNameTypeIec61360 >, DeserializationError > aas_core::aas_3_0::jsonization::LangStringPreferredNameTypeIec61360From ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::ILangStringPreferredNameTypeIec61360.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ LangStringShortNameTypeIec61360From()

common::expected< std::shared_ptr< types::ILangStringShortNameTypeIec61360 >, DeserializationError > aas_core::aas_3_0::jsonization::LangStringShortNameTypeIec61360From ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::ILangStringShortNameTypeIec61360.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ LangStringTextTypeFrom()

common::expected< std::shared_ptr< types::ILangStringTextType >, DeserializationError > aas_core::aas_3_0::jsonization::LangStringTextTypeFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::ILangStringTextType.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ LevelTypeFrom()

common::expected< std::shared_ptr< types::ILevelType >, DeserializationError > aas_core::aas_3_0::jsonization::LevelTypeFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::ILevelType.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ MultiLanguagePropertyFrom()

common::expected< std::shared_ptr< types::IMultiLanguageProperty >, DeserializationError > aas_core::aas_3_0::jsonization::MultiLanguagePropertyFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IMultiLanguageProperty.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ OperationFrom()

common::expected< std::shared_ptr< types::IOperation >, DeserializationError > aas_core::aas_3_0::jsonization::OperationFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IOperation.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ OperationVariableFrom()

common::expected< std::shared_ptr< types::IOperationVariable >, DeserializationError > aas_core::aas_3_0::jsonization::OperationVariableFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IOperationVariable.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ PropertyFrom()

common::expected< std::shared_ptr< types::IProperty >, DeserializationError > aas_core::aas_3_0::jsonization::PropertyFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IProperty.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ QualifiableFrom()

common::expected< std::shared_ptr< types::IQualifiable >, DeserializationError > aas_core::aas_3_0::jsonization::QualifiableFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IQualifiable.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ QualifierFrom()

common::expected< std::shared_ptr< types::IQualifier >, DeserializationError > aas_core::aas_3_0::jsonization::QualifierFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IQualifier.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ RangeFrom()

common::expected< std::shared_ptr< types::IRange >, DeserializationError > aas_core::aas_3_0::jsonization::RangeFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IRange.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ ReferableFrom()

common::expected< std::shared_ptr< types::IReferable >, DeserializationError > aas_core::aas_3_0::jsonization::ReferableFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IReferable.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ ReferenceElementFrom()

common::expected< std::shared_ptr< types::IReferenceElement >, DeserializationError > aas_core::aas_3_0::jsonization::ReferenceElementFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IReferenceElement.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ ReferenceFrom()

common::expected< std::shared_ptr< types::IReference >, DeserializationError > aas_core::aas_3_0::jsonization::ReferenceFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IReference.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ RelationshipElementFrom()

common::expected< std::shared_ptr< types::IRelationshipElement >, DeserializationError > aas_core::aas_3_0::jsonization::RelationshipElementFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IRelationshipElement.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ ResourceFrom()

common::expected< std::shared_ptr< types::IResource >, DeserializationError > aas_core::aas_3_0::jsonization::ResourceFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IResource.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ Serialize()

nlohmann::json aas_core::aas_3_0::jsonization::Serialize ( const types::IClass & that)

Serialize that instance to a JSON value.

Parameters
thatinstance to be serialized
Returns
The corresponding JSON value
Exceptions

ref SerializationException if a value within that instance could not be serialized

◆ SpecificAssetIdFrom()

common::expected< std::shared_ptr< types::ISpecificAssetId >, DeserializationError > aas_core::aas_3_0::jsonization::SpecificAssetIdFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::ISpecificAssetId.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ SubmodelElementCollectionFrom()

common::expected< std::shared_ptr< types::ISubmodelElementCollection >, DeserializationError > aas_core::aas_3_0::jsonization::SubmodelElementCollectionFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::ISubmodelElementCollection.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ SubmodelElementFrom()

common::expected< std::shared_ptr< types::ISubmodelElement >, DeserializationError > aas_core::aas_3_0::jsonization::SubmodelElementFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::ISubmodelElement.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ SubmodelElementListFrom()

common::expected< std::shared_ptr< types::ISubmodelElementList >, DeserializationError > aas_core::aas_3_0::jsonization::SubmodelElementListFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::ISubmodelElementList.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ SubmodelFrom()

common::expected< std::shared_ptr< types::ISubmodel >, DeserializationError > aas_core::aas_3_0::jsonization::SubmodelFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::ISubmodel.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ ValueListFrom()

common::expected< std::shared_ptr< types::IValueList >, DeserializationError > aas_core::aas_3_0::jsonization::ValueListFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IValueList.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.

◆ ValueReferencePairFrom()

common::expected< std::shared_ptr< types::IValueReferencePair >, DeserializationError > aas_core::aas_3_0::jsonization::ValueReferencePairFrom ( const nlohmann::json & json,
bool additional_properties = false )

Deserialize json value to an instance of types::IValueReferencePair.

Parameters
jsonvalue to be de-serialized
additional_propertiesif not set, check that json contains no additional properties
Returns
The deserialized instance, or a de-serialization error, if any.