fei_FieldMask.hpp

/*--------------------------------------------------------------------*/
/*    Copyright 2005 Sandia Corporation.                              */
/*    Under the terms of Contract DE-AC04-94AL85000, there is a       */
/*    non-exclusive license for use of this work by or on behalf      */
/*    of the U.S. Government.  Export of this program may require     */
/*    a license from the United States Government.                    */
/*--------------------------------------------------------------------*/

#ifndef _fei_FieldMask_hpp_
#define _fei_FieldMask_hpp_

#include "fei_macros.hpp"

#include <vector>

namespace fei {

  class FieldMask {
  public:
    FieldMask();

    FieldMask(const FieldMask& fm);

    FieldMask(int numFields,
        const int* fieldIDs,
        const int* fieldSizes);

    virtual ~FieldMask();

    int getMaskID() { return( maskID_ ); }

    static int calculateMaskID(int numFields,
             const int* fieldIDs);

    static int calculateMaskID(const FieldMask& fm,
             int fieldID);

    void addField(int fieldID,
      int fieldSize);

    bool hasFieldID(int fieldID) const
    {
      for(size_t i=0; i<fieldIDs_.size(); ++i)
        if (fieldIDs_[i] == fieldID) return true;
      return false;
    }

    size_t getNumFields() const { return(fieldIDs_.size()); }

    int getNumIndices() const { return( numIndices_ ); }

    void setNumIndices(int numInd) { numIndices_ = numInd; }

    std::vector<int>& getFieldIDs() { return(fieldIDs_); }

    const std::vector<int>& getFieldIDs() const { return(fieldIDs_); }

    std::vector<int>& getFieldSizes() { return(fieldSizes_); }

    const std::vector<int>& getFieldSizes() const { return(fieldSizes_); }

    int getFieldEqnOffset(int fieldID, int& offset) const;

    bool operator==(const FieldMask& fm) const
      { return( maskID_ == fm.maskID_ ); }

    bool operator!=(const FieldMask& fm) const
      { return( maskID_ != fm.maskID_ ); }

    bool isSubSetOf(const FieldMask& fm) const
      {
        for(unsigned i=0; i<fieldIDs_.size(); ++i) {
          if (!fm.hasFieldID(fieldIDs_[i])) return(false);
        }
        return(true);
      }

  private:
    FieldMask& operator=(const FieldMask& src);

    int calculateMaskID();

    int maskID_;

    std::vector<int> fieldIDs_;
    std::vector<int> fieldSizes_;
    std::vector<int> fieldEqnOffsets_;

    int numFields_;
    int numIndices_;
  };

} //namespace fei

#endif // _fei_FieldMask_hpp_