mlFieldAddOnList.h

Go to the documentation of this file.

// Copyright (c) Fraunhofer MEVIS, Germany. All rights reserved.
// **InsertLicense** code
//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------
#pragma once
 
#include "MLReleaseToolsSystem.h"
#include <mlFieldAddOnBase.h>
 
ML_START_NAMESPACE
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
template <typename FIELD_ADD_ON_BASE_CLASS, typename PIMPL_OBJ_TYPE=void*>
class FieldAddOnList : public FIELD_ADD_ON_BASE_CLASS
{
public:
  
  typedef std::vector<FIELD_ADD_ON_BASE_CLASS*> FieldAddOnContainer;

  FieldAddOnList(FieldContainer &fieldContainerRef): 
    FIELD_ADD_ON_BASE_CLASS(fieldContainerRef),
    _pImpl(),
    _fieldAddOns()
  {}
  
  ~FieldAddOnList() override
  {
    // FieldAddOns are not owned by this container, thus do nothing here but container resetting.
    getFieldAddOns().clear();
  }
  
  inline       FieldAddOnContainer &getFieldAddOns(){ return _fieldAddOns; }

  inline const FieldAddOnContainer &getFieldAddOns() const { return _fieldAddOns; }

  virtual void registerFieldAddOn(FIELD_ADD_ON_BASE_CLASS *fieldAddOn)
  {
    if (fieldAddOn){
      getFieldAddOns().push_back(fieldAddOn);
    }
  }

  virtual bool             hasFieldAddOn(FIELD_ADD_ON_BASE_CLASS *fieldAddOn) const
  {
    for (size_t c=0; c < getFieldAddOns().size(); ++c){
      if (getFieldAddOns()[c] == fieldAddOn){
        return true;
      }
    }
    return false;
  }

  
  void addFields() override
  {
    auto it = _fieldAddOns.begin();
    for (; it != getFieldAddOns().end(); it++){ (*it)->addFields(); }
  }

  void handleFieldActivationChanges() override
  {
    auto it = getFieldAddOns().begin();
    for (; it != getFieldAddOns().end(); it++){ (*it)->handleFieldActivationChanges(); }
  }
  
  FieldAddOnBase::FieldChangeState handleFieldChanges(Field *field) override
  {
    FieldAddOnBase::FieldChangeState retVal = FieldAddOnBase::NoChange;
 
    auto it = _fieldAddOns.begin();
    for (; it != getFieldAddOns().end(); it++){
      // Handle changes of each FieldAddOn and make the "strongest" change state survive.
      const FieldAddOnBase::FieldChangeState currState = (*it)->handleFieldChanges(field);
      retVal = FieldAddOnBase::getMergedFieldChangeState(currState, retVal);
    }
    return retVal;
  }

   
  PIMPL_OBJ_TYPE _pImpl;
  
private:
  FieldAddOnContainer _fieldAddOns;
  
  FieldAddOnList(const FieldAddOnList&);

  FieldAddOnList & operator=(const FieldAddOnList&);
};
 
ML_END_NAMESPACE