material.h++

Go to the documentation of this file.

/*
 * materials.h++

 Copyright (C) 2009 Joseph Pingenot

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef MATERIAL_HPP__
#define MATERIAL_HPP__

#include <string>
#include <glib.h>
#include <libmodelxx/matdb.h++>

namespace kdotp {
  namespace libmodelxx {
    namespace structure {

      enum material_property {
      };

      class material {
      public:
  material(const struct matdb* mdb, const char* mat1, const char* mat2, double x);
  /*For some reason, this dosn't work as a const.*/
  char* get_name();
  /**
   *Gets a property for this material. If you need speed, use
   *  the int version.
   *\param ppt property name
   *\param err pointer to int to store the error code
   *\return the property, or NaN if lookup failed
   *\note error values are 0 for success, and 1 for failure to
   *  find the property
   */
  double get_property(const char* ppt, int* err);
  inline double get_property(int ppt) {return indexed_properties[ppt];}
  int get_property_index(const char* ppt, int* err);
  char* matname1;
  char* matname2;
  double m_x;
  /*This stores an array of properties*/
  double* indexed_properties;
  /*This stores the corresponding index into the array (char* -> int*)*/
  GHashTable* property_indices;
  /*This stores the original properties hash (char* -> double*) from matdb.*/
  GHashTable* properties;
  /**comparison operator for material classes
   *\note compares string-wise matnames, and directly (i.e. ==) 
   *\note use lenient-compare if you want to specify a tolerance
   */
  bool operator==(const material& m2);
  bool operator!=(const material& m2);
  /**compares two materials like the operator, but uses a tolerance to compare the percentage of material1.
   */
  bool lenient_equals(const material& m2, double tolerance=1e-10);
      private:
  material() {}
      };

      bool operator==(const material& m1, const material& m2);
      bool operator!=(const material& m1, const material& m2);

    }
  }
}

#endif //MATERIALS_HPP__