IAddInfoContainer.hpp

#ifndef DM_IADDINFO_CONTAINER_HPP_INCLUDED
#define DM_IADDINFO_CONTAINER_HPP_INCLUDED

#ifdef _MSC_VER
  #pragma once
#endif

#include "DM/config.hpp"
#include "DM/IAddInfo.hpp"

DM_NAMESPACE_BEGIN

/// \brief Interface of an add info container object (used by geometry objects)
/**
  Managing attributes, layout and views is a core feature of the DM library. Please refer to the
  \ref dm_attributes section for implementation concepts and to the <a href="examples.html">examples</a>
  section (attribute handling) for further details.
*/
class DM_API IAddInfoContainer
{
public:
  virtual ~IAddInfoContainer() {}

  virtual bool hasInfo() const = 0;
  virtual const IAddInfo &info() const = 0;
  virtual IAddInfo       &info() = 0;

  virtual AddInfoHandle getAddInfo() const = 0;
  virtual void          setAddInfo(const AddInfoHandle &) = 0;
 
  /// \brief applies a certain layout view onto the current addinfo object
  /**
    for further details see IAddInfo::setView
    @param[in] layout    view layout that should be set
    @param[in] readOnly  flag if the layout of storage object should be changed, in case the view layout is not a true subset of the storage layout
  */
  virtual void setAddInfoView(const AddInfoLayoutHandle &layout, bool readOnly) = 0;
  /// \brief removes any view layout and sets the true storage layout as (internal) layout
  virtual void restoreAddInfoFullLayout() = 0;

  /// \brief internal creates a new addinfo object with the provide view layout that refers to the same storage object
  /**
    for further details see IAddInfo::cloneView
    @param[in] layout    view layout that should be set
    @param[in] readOnly  flag if the layout of storage object should be changed, in case the view layout is not a true subset of the storage layout
  */
  virtual void cloneAddInfoView(const AddInfoLayoutHandle &layout, bool readOnly) const = 0;
  /// \brief internal creates a new addinfo object with the provide view layout and secures that the storage object contains the dataLayout
  /**
    for further details see IAddInfo::cloneView
    @param[in] viewLayout    view layout that should be set
    @param[in] dataLayout    defines columns that have to exist in the storage object
  */
  virtual void cloneAddInfoView(const AddInfoLayoutHandle &viewLayout, const AddInfoLayoutHandle &dataLayout) const = 0;
  /// \brief internal creates a new addinfo object using the true storage layout that referring to the same storage object
  virtual void cloneAddInfoFullLayout() const = 0;

  ///optimised variante to access a view column
  /// \return true is value is not null otherwise false
  virtual bool getAsDoubleByView(const AddInfoLayoutHandle &, unsigned index, double &value) const = 0;
  virtual bool getAsLLongByView(const AddInfoLayoutHandle &, unsigned index, long long &value) const = 0;

  /// removes the specified attributs from current object
  virtual void eraseLayout(const AddInfoLayoutHandle &) = 0;

};

DM_NAMESPACE_END


#endif //DM_IADDINFO_CONTAINER_HPP_INCLUDED