OverlapDef.hpp

#ifndef OPALS_OVERLAP_DEF_HPP_INCLUDED
#define OPALS_OVERLAP_DEF_HPP_INCLUDED

#pragma once

//OPALS
#include "opals/config.hpp"
#include "opals/String.hpp"

namespace opals {

  /// Class implementing the potential specification of overlap areas as relative and/or absolute measures
  class OPALS_API OverlapDef
  {
  public:
    OverlapDef() : relArea(0.), absArea(0.), logAnd(true) {};
    virtual ~OverlapDef() {};

    /// returns the minimum relative Area
    double getRelArea() const { return relArea; };
    /// returns the minimum absolute area
    double getAbsArea() const { return absArea; };
    /// returns true if a user defined limit is set
    opals::String getLogOperator() const { return logAnd ? "and" : "or"; };

    /// set minimum relative area
    void setRelArea( const double& area );
    /// set minimum absolute area
    void setAbsArea( const double& area );
    /// set logical operator
    void setLogOperator( const opals::String& logOp ) { logAnd = logOp == "and" ? true : false; };

    /// validate two polygon areas and their respective overlap area
    /// returns true if the overlap area fullfills the minimum absolute and relative area
    /// of 'this '
    bool b_checkOverlap( const double& area1,
                         const double& area2,
                         const double& area3 ) const;

  protected: 
    bool logAnd;
    double relArea, absArea;
  };
}

#endif //OPALS_OVERLAP_DEF_HPP_INCLUDED