iteration.hpp

Go to the documentation of this file.

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

namespace iteration {
 
// region Pathing

enum class Property : std::uint32_t {
  kAdministration = 0,
  kAnnotations = 1,
  kAssetAdministrationShells = 2,
  kAssetInformation = 3,
  kAssetKind = 4,
  kAssetType = 5,
  kCategory = 6,
  kConceptDescriptions = 7,
  kContentType = 8,
  kCreator = 9,
  kDataSpecification = 10,
  kDataSpecificationContent = 11,
  kDataType = 12,
  kDefaultThumbnail = 13,
  kDefinition = 14,
  kDerivedFrom = 15,
  kDescription = 16,
  kDirection = 17,
  kDisplayName = 18,
  kEmbeddedDataSpecifications = 19,
  kEntityType = 20,
  kExtensions = 21,
  kExternalSubjectId = 22,
  kFirst = 23,
  kGlobalAssetId = 24,
  kId = 25,
  kIdShort = 26,
  kInoutputVariables = 27,
  kInputVariables = 28,
  kIsCaseOf = 29,
  kKeys = 30,
  kKind = 31,
  kLanguage = 32,
  kLastUpdate = 33,
  kLevelType = 34,
  kMax = 35,
  kMaxInterval = 36,
  kMessageBroker = 37,
  kMessageTopic = 38,
  kMin = 39,
  kMinInterval = 40,
  kName = 41,
  kNom = 42,
  kObservableReference = 43,
  kObservableSemanticId = 44,
  kObserved = 45,
  kOrderRelevant = 46,
  kOutputVariables = 47,
  kPath = 48,
  kPayload = 49,
  kPreferredName = 50,
  kQualifiers = 51,
  kReferredSemanticId = 52,
  kRefersTo = 53,
  kRevision = 54,
  kSecond = 55,
  kSemanticId = 56,
  kSemanticIdListElement = 57,
  kShortName = 58,
  kSource = 59,
  kSourceOfDefinition = 60,
  kSourceSemanticId = 61,
  kSpecificAssetIds = 62,
  kState = 63,
  kStatements = 64,
  kSubjectId = 65,
  kSubmodelElements = 66,
  kSubmodels = 67,
  kSupplementalSemanticIds = 68,
  kSymbol = 69,
  kTemplateId = 70,
  kText = 71,
  kTimeStamp = 72,
  kTopic = 73,
  kTyp = 74,
  kType = 75,
  kTypeValueListElement = 76,
  kUnit = 77,
  kUnitId = 78,
  kValue = 79,
  kValueFormat = 80,
  kValueId = 81,
  kValueList = 82,
  kValueReferencePairs = 83,
  kValueType = 84,
  kValueTypeListElement = 85,
  kVersion = 86
};
 
std::wstring PropertyToWstring(
  Property property
);

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

struct PropertySegment : public ISegment {
  Property property;
 
  PropertySegment(
    Property a_property
  );
 
  std::wstring ToWstring() const override;
  std::unique_ptr<ISegment> Clone() const override;
 
  ~PropertySegment() override = default;
};  // struct PropertySegment

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 {
  // NOTE (mristin):
  // We did not implement the reflection at the moment since we did not have a use
  // case for it. If you need reflection, please contact the developers. It should
  // be a small step going from paths to dereferencing to getters and setters.
 
  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
 
// endregion Pathing
 
// region Iterators and descent

namespace impl {
class IIterator {
 public:
  virtual void Start() = 0;
  virtual void Next() = 0;
  virtual bool Done() const = 0;
  virtual const std::shared_ptr<types::IClass>& Get() const = 0;
  virtual long Index() const = 0;

  virtual void PrependToPath(Path* path) const = 0;
 
  virtual std::unique_ptr<IIterator> Clone() const = 0;
 
  virtual ~IIterator() = default;
};  // class IIterator
}  // namespace impl

class Iterator {
  using iterator_category = std::forward_iterator_tag;
  using difference_type = std::ptrdiff_t;
  using value_type = std::shared_ptr<types::IClass>;
  using pointer = const std::shared_ptr<types::IClass>*;
  using reference = const std::shared_ptr<types::IClass>&;
 
 public:
  Iterator(const Iterator& other);
  Iterator(Iterator&& other);
 
  Iterator& operator=(const Iterator& other);
  Iterator& operator=(Iterator&& other);
 
  reference operator*() const;
  pointer operator->();
 
  // Prefix increment
  Iterator& operator++();
 
  // Postfix increment
  Iterator operator++(int);
 
  friend bool operator==(const Iterator& a, const Iterator& b);
  friend bool operator!=(const Iterator& a, const Iterator& b);
 
  friend class Descent;
  friend class DescentOnce;
  friend Path MaterializePath(const Iterator& iterator);
  friend void PrependToPath(const Iterator& iterator, Path* path);
 
 private:
  explicit Iterator(
    std::unique_ptr<impl::IIterator> implementation
  ) :
    implementation_(std::move(implementation)) {
      // Intentionally empty.
  }
 
  std::unique_ptr<impl::IIterator> implementation_;
};
 
bool operator==(const Iterator& a, const Iterator& b);
 
bool operator!=(const Iterator& a, const Iterator& b);

Path MaterializePath(const Iterator& iterator);

class IDescent {
 public:
  virtual Iterator begin() const = 0;
  virtual const Iterator& end() const = 0;
  virtual ~IDescent() = default;
};  // class IDescent

class Descent : public IDescent {
 public:
  Descent(
    std::shared_ptr<types::IClass> instance
  );
 
  Iterator begin() const override;
  const Iterator& end() const override;
 
  ~Descent() override = default;
 
 private:
  std::shared_ptr<types::IClass> instance_;
};  // class Descent

class DescentOnce : public IDescent {
 public:
  DescentOnce(
    std::shared_ptr<types::IClass> instance
  );
 
  Iterator begin() const override;
  const Iterator& end() const override;
 
  ~DescentOnce() override = default;
 
 private:
  std::shared_ptr<types::IClass> instance_;
};  // class DescentOnce
 
// endregion Iterators and descent
 
// region Over enumerations

extern const std::vector<types::ModellingKind> kOverModellingKind;

extern const std::vector<types::QualifierKind> kOverQualifierKind;

extern const std::vector<types::AssetKind> kOverAssetKind;

extern const std::vector<types::AasSubmodelElements> kOverAasSubmodelElements;

extern const std::vector<types::EntityType> kOverEntityType;

extern const std::vector<types::Direction> kOverDirection;

extern const std::vector<types::StateOfEvent> kOverStateOfEvent;

extern const std::vector<types::ReferenceTypes> kOverReferenceTypes;

extern const std::vector<types::KeyTypes> kOverKeyTypes;

extern const std::vector<types::DataTypeDefXsd> kOverDataTypeDefXsd;

extern const std::vector<types::DataTypeIec61360> kOverDataTypeIec61360;
 
// endregion Over enumerations
 
}  // namespace iteration

 
}  // 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_ITERATION_GUARD_