MultiGridLimit.hpp

#ifndef OPALS_MULTI_GRID_LIMIT_HPP_INCLUDED
#define OPALS_MULTI_GRID_LIMIT_HPP_INCLUDED

#pragma once

//STL
#include "opals/GridLimit.hpp"
#include "opals/Vector.hpp"

namespace opals {

  /// Class describing xy-limits for grid datasets supporting multiple input datasets
  class OPALS_API MultiGridLimit : public GridLimit,  public CustomOptionType<MultiGridLimit>
  {
  public:
    MultiGridLimit();
    virtual ~MultiGridLimit();

    /// returns true if the limit denotes the common area of multiple datasets
    bool isIntersect()   const { return limType==1; };
    /// returns true if the limit denotes the overall area of multiple datasets
    bool isUnion()       const { return limType==2; };
    /// returns true if the limit denotes the limits of a specific dataset
    bool isDataset()     const { return limType==3; };

    /// set limit as intersection of multiple datasets
    void setIntersect();
    /// set limit as union of multiple datasets
    void setUnion();
    /// set limit as limit of a specific dataset (number)
    void setDataset( const unsigned char &datasetNr );

    /// query number of specified dataset (in case isDataset()==true)
    int  getDatasetNr() const { return datasetId; };
    /// query user defined limits (in case isUserDef()==true)
    ArrayD4 getLimits ( const Vector<ArrayD4> &inLimits );

    /// \name CustomOptionType interface
    ///@{
    static const char * help();
    static const char * syntax();
    static bool exportsPythonType();
    ///}@

  private:
    unsigned /*char*/ datasetId;
  };
}

#endif //OPALS_MULTI_GRID_LIMIT_HPP_INCLUDED