xmlization.hpp

Go to the documentation of this file.

#ifndef AAS_CORE_AAS_3_0_XMLIZATION_GUARD_
#define AAS_CORE_AAS_3_0_XMLIZATION_GUARD_
 
// This code has been automatically generated by aas-core-codegen.
// Do NOT edit or append.
 
#include "aas_core/aas_3_0/common.hpp"
#include "aas_core/aas_3_0/iteration.hpp"
#include "aas_core/aas_3_0/types.hpp"
 
#pragma warning(push, 0)
#include <deque>
#include <memory>
#include <string>
#pragma warning(pop)
 
namespace aas_core {
namespace aas_3_0 {

namespace xmlization {

extern const std::string kNamespace;

class ISegment {
 public:
  virtual std::wstring ToWstring() const = 0;
 
  virtual std::unique_ptr<ISegment> Clone() const = 0;
 
  virtual ~ISegment() = default;
};  // class ISegment

struct ElementSegment : public ISegment {
  std::wstring name;
 
  ElementSegment(
    std::wstring a_name
  );
 
  std::wstring ToWstring() const override;
 
  std::unique_ptr<ISegment> Clone() const override;
 
  ~ElementSegment() override = default;
};  // struct ElementSegment

struct IndexSegment : public ISegment {
  size_t index;
 
  explicit IndexSegment(
    size_t an_index
  );
 
  std::wstring ToWstring() const override;
 
  std::unique_ptr<ISegment> Clone() const override;
 
  ~IndexSegment() override = default;
};  // struct IndexSegment

struct Path {
  std::deque<std::unique_ptr<ISegment> > segments;
 
  Path();
  Path(const Path& other);
  Path(Path&& other);
  Path& operator=(const Path& other);
  Path& operator=(Path&& other);
 
  std::wstring ToWstring() const;
};  // struct Path
 
// region De-serialization

struct DeserializationError {
  std::wstring cause;

  Path path;
 
  explicit DeserializationError(std::wstring a_cause);
  DeserializationError(std::wstring a_cause, Path a_path);
};  // struct DeserializationError
 
struct ReadingOptions {
  bool additional_attributes = false;

  size_t buffer_size = 1024;
};  // struct ReadingOptions

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 = {}
);
 
// endregion Deserialization
 
// region Serialization

class SerializationException : public std::exception {
 public:
  SerializationException(
    std::wstring cause
  );
 
  SerializationException(
    std::wstring cause,
    iteration::Path path
  );
 
  const char* what() const noexcept override;
 
  const std::wstring& cause() const noexcept;
  const iteration::Path& path() const noexcept;
 
  ~SerializationException() noexcept override = default;
 
 private:
  const std::wstring cause_;
  const iteration::Path path_;
  const std::string msg_;
};  // class SerializationException

struct WritingOptions {
  bool write_declaration = true;

  bool write_namespace = true;

   std::string prefix = "";
};  // struct WritingOptions

void Serialize(
  const types::IClass& that,
  const WritingOptions& options,
  std::ostream& os
);
 
// endregion Serialization
 
}  // namespace xmlization

 
}  // namespace aas_3_0
}  // namespace aas_core
 
// This code has been automatically generated by aas-core-codegen.
// Do NOT edit or append.
 
#endif  // AAS_CORE_AAS_3_0_XMLIZATION_GUARD_