mlFieldAddOnBase.h

Go to the documentation of this file.

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

//----------------------------------------------------------------------------------
#pragma once
 
#include "MLReleaseToolsSystem.h"
#include <mlModuleIncludes.h>
 
ML_START_NAMESPACE
 
//----------------------------------------------------------------------------------
//----------------------------------------------------------------------------------
class MLRELEASE_TOOLS_EXPORT FieldAddOnBase
{
public:
  enum FieldChangeState {
    NoChange = 0,         
    StatusOnlyChange,     
    RecalculationRequired 
  };
  
  inline FieldAddOnBase(FieldContainer &fieldContainerRef):
    _referencedContainer(fieldContainerRef),
  _fieldPointers(){};
  
  virtual ~FieldAddOnBase(){};

  inline FieldContainer    &getFieldContainer(){ return _referencedContainer; }

  inline const FieldContainer &getFieldContainer() const { return _referencedContainer; }

  inline std::vector<Field*> &getFields() { return _fieldPointers; }

  inline const std::vector<Field*> &getFields() const { return _fieldPointers; }

  virtual void             addFields() = 0;

  virtual void             handleFieldActivationChanges(){};

  virtual FieldChangeState handleFieldChanges(Field *field)
  { 
    return hasField(field) ? RecalculationRequired : NoChange; 
  } 

  virtual FieldChangeState getMergedFieldChangeState(FieldChangeState state1, 
                                                     FieldChangeState state2) const
  { 
    if ((state1 == RecalculationRequired) || (state2 == RecalculationRequired)){
      return RecalculationRequired;
    }
    else if ((state1 == StatusOnlyChange) || (state2 == StatusOnlyChange)){
      return StatusOnlyChange;
    }
    else{
      return NoChange;
    }
  } 

  virtual bool             hasField(Field *field) const;
 
protected:
  void                     _addFieldPointer(Field* field);
  
private:
  FieldContainer &_referencedContainer;

  std::vector<Field*> _fieldPointers;
  
  FieldAddOnBase(const FieldAddOnBase&);

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