fei_Pattern.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_Pattern_hpp_
#define _fei_Pattern_hpp_

#include "fei_macros.hpp"

#include <vector>

namespace snl_fei {
  class RecordCollection;
}

namespace fei {

  class Pattern {
  public:
    enum PatternType { NO_FIELD, SIMPLE, SINGLE_IDTYPE, GENERAL };

    Pattern(int numIDs, int idType, snl_fei::RecordCollection* records);

    Pattern(int numIDs, int idType, snl_fei::RecordCollection* records,
      int fieldID, int fieldSize);

    Pattern(int numIDs, int idType, snl_fei::RecordCollection* records,
      const int* numFieldsPerID,
      const int* fieldIDs, const int* fieldSizes);

    Pattern(int numIDs, const int* idTypes, snl_fei::RecordCollection*const* records,
      const int* numFieldsPerID,
      const int* fieldIDs, const int* fieldSizes);

    virtual ~Pattern();

    PatternType getPatternType() const { return( type_ ); }

    int getNumIDs() const { return( numIDs_ ); }

    const int* getIDTypes() const { return( idTypes_ ); }

    snl_fei::RecordCollection*const* getRecordCollections() const { return &recordCollections_[0]; }

    const int* getNumFieldsPerID() const { return( numFieldsPerID_ ); }

    const int* getFieldIDs() const { return( fieldIDs_ ); }

    const int* getNumIndicesPerID() const
    {
      return( numIndicesPerID_ );
    }

    int getTotalNumFields() const { return( totalNumFields_ ); }

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

    bool operator==(const Pattern& rhs) const;

    bool operator!=(const Pattern& rhs) const;

  private:
    PatternType type_;
    int numIDs_;
    int totalNumFields_;
    int numIndices_;
    std::vector<int> data_;
    std::vector<snl_fei::RecordCollection*> recordCollections_;

    const int* idTypes_;
    const int* numFieldsPerID_;
    const int* fieldIDs_;
    const int* numIndicesPerID_;
  };

} //namespace fei

#endif // _fei_Pattern_hpp_