Classes
struct	DeserializationError

struct	ElementSegment

struct	IndexSegment

class	ISegment

struct	Path

struct	ReadingOptions

class	SerializationException

struct	WritingOptions
	Customize how instances should be serialized to XML. More...

Functions
common::expected< std::shared_ptr< types::IClass >, DeserializationError >	From (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IHasSemantics >, DeserializationError >	HasSemanticsFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IExtension >, DeserializationError >	ExtensionFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IHasExtensions >, DeserializationError >	HasExtensionsFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IReferable >, DeserializationError >	ReferableFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IIdentifiable >, DeserializationError >	IdentifiableFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IHasKind >, DeserializationError >	HasKindFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IHasDataSpecification >, DeserializationError >	HasDataSpecificationFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IAdministrativeInformation >, DeserializationError >	AdministrativeInformationFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IQualifiable >, DeserializationError >	QualifiableFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IQualifier >, DeserializationError >	QualifierFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IAssetAdministrationShell >, DeserializationError >	AssetAdministrationShellFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IAssetInformation >, DeserializationError >	AssetInformationFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IResource >, DeserializationError >	ResourceFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::ISpecificAssetId >, DeserializationError >	SpecificAssetIdFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::ISubmodel >, DeserializationError >	SubmodelFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::ISubmodelElement >, DeserializationError >	SubmodelElementFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IRelationshipElement >, DeserializationError >	RelationshipElementFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::ISubmodelElementList >, DeserializationError >	SubmodelElementListFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::ISubmodelElementCollection >, DeserializationError >	SubmodelElementCollectionFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IDataElement >, DeserializationError >	DataElementFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IProperty >, DeserializationError >	PropertyFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IMultiLanguageProperty >, DeserializationError >	MultiLanguagePropertyFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IRange >, DeserializationError >	RangeFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IReferenceElement >, DeserializationError >	ReferenceElementFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IBlob >, DeserializationError >	BlobFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IFile >, DeserializationError >	FileFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IAnnotatedRelationshipElement >, DeserializationError >	AnnotatedRelationshipElementFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IEntity >, DeserializationError >	EntityFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IEventPayload >, DeserializationError >	EventPayloadFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IEventElement >, DeserializationError >	EventElementFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IBasicEventElement >, DeserializationError >	BasicEventElementFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IOperation >, DeserializationError >	OperationFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IOperationVariable >, DeserializationError >	OperationVariableFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::ICapability >, DeserializationError >	CapabilityFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IConceptDescription >, DeserializationError >	ConceptDescriptionFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IReference >, DeserializationError >	ReferenceFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IKey >, DeserializationError >	KeyFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IAbstractLangString >, DeserializationError >	AbstractLangStringFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::ILangStringNameType >, DeserializationError >	LangStringNameTypeFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::ILangStringTextType >, DeserializationError >	LangStringTextTypeFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IEnvironment >, DeserializationError >	EnvironmentFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IDataSpecificationContent >, DeserializationError >	DataSpecificationContentFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IEmbeddedDataSpecification >, DeserializationError >	EmbeddedDataSpecificationFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::ILevelType >, DeserializationError >	LevelTypeFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IValueReferencePair >, DeserializationError >	ValueReferencePairFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IValueList >, DeserializationError >	ValueListFrom (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::ILangStringPreferredNameTypeIec61360 >, DeserializationError >	LangStringPreferredNameTypeIec61360From (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::ILangStringShortNameTypeIec61360 >, DeserializationError >	LangStringShortNameTypeIec61360From (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::ILangStringDefinitionTypeIec61360 >, DeserializationError >	LangStringDefinitionTypeIec61360From (std::istream &is, const ReadingOptions &options={})

common::expected< std::shared_ptr< types::IDataSpecificationIec61360 >, DeserializationError >	DataSpecificationIec61360From (std::istream &is, const ReadingOptions &options={})

void	Serialize (const types::IClass &that, const WritingOptions &options, std::ostream &os)
	Serialize `that` instance to XML.

Variables
const std::string	kNamespace

Function Documentation

◆ AbstractLangStringFrom()

common::expected< std::shared_ptr< types::IAbstractLangString >, DeserializationError > aas_core::aas_3_0::xmlization::AbstractLangStringFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IAbstractLangString from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IAbstractLangString, or an error if any

◆ AdministrativeInformationFrom()

common::expected< std::shared_ptr< types::IAdministrativeInformation >, DeserializationError > aas_core::aas_3_0::xmlization::AdministrativeInformationFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IAdministrativeInformation from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IAdministrativeInformation, or an error if any

◆ AnnotatedRelationshipElementFrom()

common::expected< std::shared_ptr< types::IAnnotatedRelationshipElement >, DeserializationError > aas_core::aas_3_0::xmlization::AnnotatedRelationshipElementFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IAnnotatedRelationshipElement from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IAnnotatedRelationshipElement, or an error if any

◆ AssetAdministrationShellFrom()

common::expected< std::shared_ptr< types::IAssetAdministrationShell >, DeserializationError > aas_core::aas_3_0::xmlization::AssetAdministrationShellFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IAssetAdministrationShell from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IAssetAdministrationShell, or an error if any

◆ AssetInformationFrom()

common::expected< std::shared_ptr< types::IAssetInformation >, DeserializationError > aas_core::aas_3_0::xmlization::AssetInformationFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IAssetInformation from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IAssetInformation, or an error if any

◆ BasicEventElementFrom()

common::expected< std::shared_ptr< types::IBasicEventElement >, DeserializationError > aas_core::aas_3_0::xmlization::BasicEventElementFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IBasicEventElement from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IBasicEventElement, or an error if any

◆ BlobFrom()

common::expected< std::shared_ptr< types::IBlob >, DeserializationError > aas_core::aas_3_0::xmlization::BlobFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IBlob from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IBlob, or an error if any

◆ CapabilityFrom()

common::expected< std::shared_ptr< types::ICapability >, DeserializationError > aas_core::aas_3_0::xmlization::CapabilityFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::ICapability from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::ICapability, or an error if any

◆ ConceptDescriptionFrom()

common::expected< std::shared_ptr< types::IConceptDescription >, DeserializationError > aas_core::aas_3_0::xmlization::ConceptDescriptionFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IConceptDescription from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IConceptDescription, or an error if any

◆ DataElementFrom()

common::expected< std::shared_ptr< types::IDataElement >, DeserializationError > aas_core::aas_3_0::xmlization::DataElementFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IDataElement from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IDataElement, or an error if any

◆ DataSpecificationContentFrom()

common::expected< std::shared_ptr< types::IDataSpecificationContent >, DeserializationError > aas_core::aas_3_0::xmlization::DataSpecificationContentFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IDataSpecificationContent from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IDataSpecificationContent, or an error if any

◆ DataSpecificationIec61360From()

common::expected< std::shared_ptr< types::IDataSpecificationIec61360 >, DeserializationError > aas_core::aas_3_0::xmlization::DataSpecificationIec61360From	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IDataSpecificationIec61360 from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IDataSpecificationIec61360, or an error if any

◆ EmbeddedDataSpecificationFrom()

common::expected< std::shared_ptr< types::IEmbeddedDataSpecification >, DeserializationError > aas_core::aas_3_0::xmlization::EmbeddedDataSpecificationFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IEmbeddedDataSpecification from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IEmbeddedDataSpecification, or an error if any

◆ EntityFrom()

common::expected< std::shared_ptr< types::IEntity >, DeserializationError > aas_core::aas_3_0::xmlization::EntityFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IEntity from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IEntity, or an error if any

◆ EnvironmentFrom()

common::expected< std::shared_ptr< types::IEnvironment >, DeserializationError > aas_core::aas_3_0::xmlization::EnvironmentFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IEnvironment from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IEnvironment, or an error if any

◆ EventElementFrom()

common::expected< std::shared_ptr< types::IEventElement >, DeserializationError > aas_core::aas_3_0::xmlization::EventElementFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IEventElement from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IEventElement, or an error if any

◆ EventPayloadFrom()

common::expected< std::shared_ptr< types::IEventPayload >, DeserializationError > aas_core::aas_3_0::xmlization::EventPayloadFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IEventPayload from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IEventPayload, or an error if any

◆ ExtensionFrom()

common::expected< std::shared_ptr< types::IExtension >, DeserializationError > aas_core::aas_3_0::xmlization::ExtensionFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IExtension from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IExtension, or an error if any

◆ FileFrom()

common::expected< std::shared_ptr< types::IFile >, DeserializationError > aas_core::aas_3_0::xmlization::FileFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IFile from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IFile, or an error if any

◆ From()

common::expected< std::shared_ptr< types::IClass >, DeserializationError > aas_core::aas_3_0::xmlization::From	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize the instance from an XML read from the stream is.

Parameters

is	stream of ASCII, ISO-8859-1 or UTF-8-encoded characters to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed instance, or an error if any

◆ HasDataSpecificationFrom()

common::expected< std::shared_ptr< types::IHasDataSpecification >, DeserializationError > aas_core::aas_3_0::xmlization::HasDataSpecificationFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IHasDataSpecification from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IHasDataSpecification, or an error if any

◆ HasExtensionsFrom()

common::expected< std::shared_ptr< types::IHasExtensions >, DeserializationError > aas_core::aas_3_0::xmlization::HasExtensionsFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IHasExtensions from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IHasExtensions, or an error if any

◆ HasKindFrom()

common::expected< std::shared_ptr< types::IHasKind >, DeserializationError > aas_core::aas_3_0::xmlization::HasKindFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IHasKind from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IHasKind, or an error if any

◆ HasSemanticsFrom()

common::expected< std::shared_ptr< types::IHasSemantics >, DeserializationError > aas_core::aas_3_0::xmlization::HasSemanticsFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IHasSemantics from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IHasSemantics, or an error if any

◆ IdentifiableFrom()

common::expected< std::shared_ptr< types::IIdentifiable >, DeserializationError > aas_core::aas_3_0::xmlization::IdentifiableFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IIdentifiable from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IIdentifiable, or an error if any

◆ KeyFrom()

common::expected< std::shared_ptr< types::IKey >, DeserializationError > aas_core::aas_3_0::xmlization::KeyFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IKey from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IKey, or an error if any

◆ LangStringDefinitionTypeIec61360From()

common::expected< std::shared_ptr< types::ILangStringDefinitionTypeIec61360 >, DeserializationError > aas_core::aas_3_0::xmlization::LangStringDefinitionTypeIec61360From	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::ILangStringDefinitionTypeIec61360 from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::ILangStringDefinitionTypeIec61360, or an error if any

◆ LangStringNameTypeFrom()

common::expected< std::shared_ptr< types::ILangStringNameType >, DeserializationError > aas_core::aas_3_0::xmlization::LangStringNameTypeFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::ILangStringNameType from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::ILangStringNameType, or an error if any

◆ LangStringPreferredNameTypeIec61360From()

common::expected< std::shared_ptr< types::ILangStringPreferredNameTypeIec61360 >, DeserializationError > aas_core::aas_3_0::xmlization::LangStringPreferredNameTypeIec61360From	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::ILangStringPreferredNameTypeIec61360 from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::ILangStringPreferredNameTypeIec61360, or an error if any

◆ LangStringShortNameTypeIec61360From()

common::expected< std::shared_ptr< types::ILangStringShortNameTypeIec61360 >, DeserializationError > aas_core::aas_3_0::xmlization::LangStringShortNameTypeIec61360From	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::ILangStringShortNameTypeIec61360 from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::ILangStringShortNameTypeIec61360, or an error if any

◆ LangStringTextTypeFrom()

common::expected< std::shared_ptr< types::ILangStringTextType >, DeserializationError > aas_core::aas_3_0::xmlization::LangStringTextTypeFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::ILangStringTextType from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::ILangStringTextType, or an error if any

◆ LevelTypeFrom()

common::expected< std::shared_ptr< types::ILevelType >, DeserializationError > aas_core::aas_3_0::xmlization::LevelTypeFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::ILevelType from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::ILevelType, or an error if any

◆ MultiLanguagePropertyFrom()

common::expected< std::shared_ptr< types::IMultiLanguageProperty >, DeserializationError > aas_core::aas_3_0::xmlization::MultiLanguagePropertyFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IMultiLanguageProperty from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IMultiLanguageProperty, or an error if any

◆ OperationFrom()

common::expected< std::shared_ptr< types::IOperation >, DeserializationError > aas_core::aas_3_0::xmlization::OperationFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IOperation from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IOperation, or an error if any

◆ OperationVariableFrom()

common::expected< std::shared_ptr< types::IOperationVariable >, DeserializationError > aas_core::aas_3_0::xmlization::OperationVariableFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IOperationVariable from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IOperationVariable, or an error if any

◆ PropertyFrom()

common::expected< std::shared_ptr< types::IProperty >, DeserializationError > aas_core::aas_3_0::xmlization::PropertyFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IProperty from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IProperty, or an error if any

◆ QualifiableFrom()

common::expected< std::shared_ptr< types::IQualifiable >, DeserializationError > aas_core::aas_3_0::xmlization::QualifiableFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IQualifiable from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IQualifiable, or an error if any

◆ QualifierFrom()

common::expected< std::shared_ptr< types::IQualifier >, DeserializationError > aas_core::aas_3_0::xmlization::QualifierFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IQualifier from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IQualifier, or an error if any

◆ RangeFrom()

common::expected< std::shared_ptr< types::IRange >, DeserializationError > aas_core::aas_3_0::xmlization::RangeFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IRange from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IRange, or an error if any

◆ ReferableFrom()

common::expected< std::shared_ptr< types::IReferable >, DeserializationError > aas_core::aas_3_0::xmlization::ReferableFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IReferable from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IReferable, or an error if any

◆ ReferenceElementFrom()

common::expected< std::shared_ptr< types::IReferenceElement >, DeserializationError > aas_core::aas_3_0::xmlization::ReferenceElementFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IReferenceElement from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IReferenceElement, or an error if any

◆ ReferenceFrom()

common::expected< std::shared_ptr< types::IReference >, DeserializationError > aas_core::aas_3_0::xmlization::ReferenceFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IReference from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IReference, or an error if any

◆ RelationshipElementFrom()

common::expected< std::shared_ptr< types::IRelationshipElement >, DeserializationError > aas_core::aas_3_0::xmlization::RelationshipElementFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IRelationshipElement from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IRelationshipElement, or an error if any

◆ ResourceFrom()

common::expected< std::shared_ptr< types::IResource >, DeserializationError > aas_core::aas_3_0::xmlization::ResourceFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IResource from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IResource, or an error if any

◆ Serialize()

void aas_core::aas_3_0::xmlization::Serialize	(	const types::IClass &	that,
		const WritingOptions &	options,
		std::ostream &	os )

Serialize that instance to XML.

Parameters

that	instance to be serialized
options	to be tweaked for special cases. The defaults should work in most cases.
os	The UTF8-encoded output stream where XML will be written

Exceptions

ref SerializationException if that instance could not be serialized

◆ SpecificAssetIdFrom()

common::expected< std::shared_ptr< types::ISpecificAssetId >, DeserializationError > aas_core::aas_3_0::xmlization::SpecificAssetIdFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::ISpecificAssetId from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::ISpecificAssetId, or an error if any

◆ SubmodelElementCollectionFrom()

common::expected< std::shared_ptr< types::ISubmodelElementCollection >, DeserializationError > aas_core::aas_3_0::xmlization::SubmodelElementCollectionFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::ISubmodelElementCollection from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::ISubmodelElementCollection, or an error if any

◆ SubmodelElementFrom()

common::expected< std::shared_ptr< types::ISubmodelElement >, DeserializationError > aas_core::aas_3_0::xmlization::SubmodelElementFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::ISubmodelElement from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::ISubmodelElement, or an error if any

◆ SubmodelElementListFrom()

common::expected< std::shared_ptr< types::ISubmodelElementList >, DeserializationError > aas_core::aas_3_0::xmlization::SubmodelElementListFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::ISubmodelElementList from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::ISubmodelElementList, or an error if any

◆ SubmodelFrom()

common::expected< std::shared_ptr< types::ISubmodel >, DeserializationError > aas_core::aas_3_0::xmlization::SubmodelFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::ISubmodel from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::ISubmodel, or an error if any

◆ ValueListFrom()

common::expected< std::shared_ptr< types::IValueList >, DeserializationError > aas_core::aas_3_0::xmlization::ValueListFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IValueList from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IValueList, or an error if any

◆ ValueReferencePairFrom()

common::expected< std::shared_ptr< types::IValueReferencePair >, DeserializationError > aas_core::aas_3_0::xmlization::ValueReferencePairFrom	(	std::istream &	is,
		const ReadingOptions &	options = {} )

Deserialize an instance of types::IValueReferencePair from an XML read from the stream is.

Parameters

is	stream to read XML from
options	reading options to be tweaked for special cases. The defaults should work in most cases.

Returns: the parsed types::IValueReferencePair, or an error if any

Variable Documentation

◆ kNamespace

const std::string aas_core::aas_3_0::xmlization::kNamespace

extern

Specify the expected XML namespace of all the XML elements.

Classes

Functions

Variables

Function Documentation

◆ AbstractLangStringFrom()

◆ AdministrativeInformationFrom()

◆ AnnotatedRelationshipElementFrom()

◆ AssetAdministrationShellFrom()

◆ AssetInformationFrom()

◆ BasicEventElementFrom()

◆ BlobFrom()

◆ CapabilityFrom()

◆ ConceptDescriptionFrom()

◆ DataElementFrom()

◆ DataSpecificationContentFrom()

◆ DataSpecificationIec61360From()

◆ EmbeddedDataSpecificationFrom()

◆ EntityFrom()

◆ EnvironmentFrom()

◆ EventElementFrom()

◆ EventPayloadFrom()

◆ ExtensionFrom()

◆ FileFrom()

◆ From()

◆ HasDataSpecificationFrom()

◆ HasExtensionsFrom()

◆ HasKindFrom()

◆ HasSemanticsFrom()

◆ IdentifiableFrom()

◆ KeyFrom()

◆ LangStringDefinitionTypeIec61360From()

◆ LangStringNameTypeFrom()

◆ LangStringPreferredNameTypeIec61360From()

◆ LangStringShortNameTypeIec61360From()

◆ LangStringTextTypeFrom()

◆ LevelTypeFrom()

◆ MultiLanguagePropertyFrom()

◆ OperationFrom()

◆ OperationVariableFrom()

◆ PropertyFrom()

◆ QualifiableFrom()

◆ QualifierFrom()

◆ RangeFrom()

◆ ReferableFrom()

◆ ReferenceElementFrom()

◆ ReferenceFrom()

◆ RelationshipElementFrom()

◆ ResourceFrom()

◆ Serialize()

◆ SpecificAssetIdFrom()

◆ SubmodelElementCollectionFrom()

◆ SubmodelElementFrom()

◆ SubmodelElementListFrom()

◆ SubmodelFrom()

◆ ValueListFrom()

◆ ValueReferencePairFrom()

Variable Documentation

◆ kNamespace