CSOGroupRules.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
 
 
#pragma once
 
#include "MLCSOIncludes.h"
 
 
ML_START_NAMESPACE
 
class CSO;
class CSOGroup;
 
 
enum CSOGroupOverflowHandling
{
  OVERFLOW_DELETE_FIRST = 0, 
  OVERFLOW_DELETE_LAST  = 1, 
  OVERFLOW_DELETE_ALL   = 2, 
  OVERFLOW_IGNORE_NEW   = 3, 
  NUM_OVERFLOW_MODES    = 4  
};
 
enum CSORemoveHandling
{
  REMOVE_ALWAYS         = 0, 
  REMOVE_NEVER          = 1, 
  REMOVE_IF_IN_NO_GROUP = 2, 
  NUM_REMOVE_MODES      = 3  
};
 
enum MLCSO_EXPORT CSOGroupMergeHandling
{
  MERGE_MODE_NONE       = 0,
  MERGE_MODE_BY_ID      = 1,
  MERGE_MODE_BY_LABEL   = 2
};
 
class MLCSO_EXPORT CSOGroupRules
{
 
public:
 
  CSOGroupRules(unsigned int numMaxCSOs = 0);
  ~CSOGroupRules();
 
  void reset();
 
  void setNumMaximumCSOs(unsigned int numMaxCSOs)             { _numMaxCSOs = numMaxCSOs;             }
  unsigned int getNumMaximumCSOs() const                      { return _numMaxCSOs;                   }
  void setOverflowHandling(CSOGroupOverflowHandling handling) { _overflowHandling = handling;         }
  CSOGroupOverflowHandling getOverflowHandling() const        { return _overflowHandling;             }
  void setRemoveFromGroupHandling(CSORemoveHandling handling) { _removeFromGroupHandling = handling;  }
  CSORemoveHandling getRemoveFromGroupHandling() const        { return _removeFromGroupHandling;      }
  void setDeleteGroupCSOHandling(CSORemoveHandling handling)  { _deleteGroupCSOHandling = handling;  }
  CSORemoveHandling getDeleteGroupCSOHandling() const         { return _deleteGroupCSOHandling;      }
  bool mayAddCSO(CSOGroup& csoGroup) const;
 
  void applyTo(CSOGroup& csoGroup);
  CSO* addNewCSO(CSOGroup& csoGroup, bool useUndoRedo=true);
  bool addCSO(CSO& cso, CSOGroup& csoGroup, bool useUndoRedo=true);
  void removeCSO(CSO& cso, CSOGroup& csoGroup, bool useUndoRedo=true);
  void applyDeletionRule(CSOGroup& csoGroup);
  void applyRemoveFromGroupRule(CSO& cso, bool useUndoRedo);
 
  static unsigned int getDefaultNumMaximumCSOs()                { return 0;                     }
  static CSOGroupOverflowHandling getDefaultOverflowHandling () { return OVERFLOW_DELETE_FIRST; }
  static CSORemoveHandling getDefaultRemoveFromGroupHandling () { return REMOVE_NEVER; }
  static CSORemoveHandling getDefaultDeleteGroupCSOHandling ()  { return REMOVE_IF_IN_NO_GROUP; }
 
protected:
 
  void _removeAllCSO(CSOGroup& csoGroup, bool useUndoRedo=true);
 
  void _combineCSOAndGroup(CSO& cso, CSOGroup& csoGroup);
  void _breakCSOandGroup(CSO& cso, CSOGroup& csoGroup);
private:
 
 
  unsigned int _numMaxCSOs;
 
  CSOGroupOverflowHandling  _overflowHandling;
 
  CSORemoveHandling _removeFromGroupHandling;
 
  CSORemoveHandling _deleteGroupCSOHandling;
 
};
 
 
ML_END_NAMESPACE