Composite.hpp

/*
 * Copyright (c) 2011-2021, The DART development contributors
 * All rights reserved.
 *
 * The list of contributors can be found at:
 *   https://github.com/dartsim/dart/blob/master/LICENSE
 *
 * This file is provided under the following "BSD-style" License:
 *   Redistribution and use in source and binary forms, with or
 *   without modification, are permitted provided that the following
 *   conditions are met:
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 *   CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 *   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 *   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 *   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 *   AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *   LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *   ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *   POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef DART_COMMON_COMPOSITE_HPP_
#define DART_COMMON_COMPOSITE_HPP_

#include "dart/common/ClassWithVirtualBase.hpp"
#include "dart/common/detail/CompositeData.hpp"

namespace dart {
namespace common {

class Composite
{
public:
  using State = detail::CompositeState;
  using Properties = detail::CompositeProperties;

  using AspectMap = std::map<std::type_index, std::unique_ptr<Aspect> >;
  using RequiredAspectSet = std::unordered_set<std::type_index>;

  template <typename... Aspects>
  using MakeState = detail::MakeCompositeState<Aspects...>;

  template <typename... Aspects>
  using MakeProperties = detail::MakeCompositeProperties<Aspects...>;

  virtual ~Composite() = default;

  Composite() = default;

  // TODO(MXG): Consider making this safe by cloning Aspects into the new copy
  Composite(const Composite&) = delete;

  Composite(Composite&&) = delete;

  Composite& operator=(const Composite&) = delete;

  Composite& operator=(Composite&&) = delete;

  template <class T>
  bool has() const;

  template <class T>
  T* get();

  template <class T>
  const T* get() const;

  template <class T>
  void set(const T* aspect);

  template <class T>
  void set(std::unique_ptr<T>&& aspect);

  template <class T, typename... Args>
  T* createAspect(Args&&... args);

  template <class T>
  void removeAspect();

  template <class T>
  std::unique_ptr<T> releaseAspect();

  template <class T>
  static constexpr bool isSpecializedFor();

  template <class T>
  bool requiresAspect() const;

  void setCompositeState(const State& newStates);

  State getCompositeState() const;

  void copyCompositeStateTo(State& outgoingStates) const;

  void setCompositeProperties(const Properties& newProperties);

  Properties getCompositeProperties() const;

  void copyCompositePropertiesTo(Properties& outgoingProperties) const;

  void duplicateAspects(const Composite* fromComposite);

  void matchAspects(const Composite* otherComposite);

protected:
  void addToComposite(Aspect* aspect);

  void removeFromComposite(Aspect* aspect);

  void _set(std::type_index type_idx, const Aspect* aspect);

  void _set(std::type_index type_idx, std::unique_ptr<Aspect> aspect);

  AspectMap mAspectMap;

  RequiredAspectSet mRequiredAspects;
};

//==============================================================================
// TODO(MXG): Consider putting this functionality into the Composite class
// itself. Also consider allowing the user to specify arguments for the
// constructors of the Aspects.
template <class T>
void createAspects(T* /*comp*/);

//==============================================================================
template <class T, class NextAspect, class... Aspects>
void createAspects(T* comp);

} // namespace common
} // namespace dart

#include "dart/common/detail/Composite.hpp"

#endif // DART_COMMON_COMPOSITE_HPP_