/**
* @cond doxygenLibsbmlInternal
*
* @file    SpatialUniqueDiffusionCoefficientsCheck.h
* @brief   Ensure that spatial compartment mappings' unit sizes sum to one.
* @author  Sarah Keating, Lucian Smith
* 
* <!--------------------------------------------------------------------------
* This file is part of libSBML.  Please visit http://sbml.org for more
* information about SBML, and the latest version of libSBML.
 *
 * Copyright (C) 2020 jointly by the following organizations:
 *     1. California Institute of Technology, Pasadena, CA, USA
 *     2. University of Heidelberg, Heidelberg, Germany
 *     3. University College London, London, UK
*
* Copyright (C) 2019 jointly by the following organizations:
*     1. California Institute of Technology, Pasadena, CA, USA
*     2. University of Heidelberg, Heidelberg, Germany
*
* Copyright (C) 2013-2018 jointly by the following organizations:
*     1. California Institute of Technology, Pasadena, CA, USA
*     2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
*     3. University of Heidelberg, Heidelberg, Germany
* 
* Copyright 2011-2012 jointly by the following organizations:
*     1. California Institute of Technology, Pasadena, CA, USA
*     2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation.  A copy of the license agreement is provided
* in the file named "LICENSE.txt" included with this software distribution
* and also available online as http://sbml.org/software/libsbml/license.html
* ---------------------------------------------------------------------- -->*/

#ifndef SpatialUniqueDiffusionCoefficientsCheck_h
#define SpatialUniqueDiffusionCoefficientsCheck_h


#ifdef __cplusplus

#include <sbml/validator/VConstraint.h>
#include <sbml/packages/spatial/validator/SpatialValidator.h>

LIBSBML_CPP_NAMESPACE_BEGIN

class DiffusionCoefficient;

class SpatialUniqueDiffusionCoefficientsCheck: public TConstraint<Model>
{
public:

  /**
  * Creates a new Constraint with the given constraint id.
  */
  SpatialUniqueDiffusionCoefficientsCheck (unsigned int id, SpatialValidator& v);

  /**
  * Destroys this Constraint.
  */
  virtual ~SpatialUniqueDiffusionCoefficientsCheck ();


protected:

  virtual void check_ (const Model& m, const Model& object);

  bool addVariableToAxisAndCheck(std::map<std::string, std::string>& axismap, 
    const std::string & var, 
    const std::string & difftype, 
    const std::string & axisOrPlane, 
    std::map<std::string, std::string>& planemap1, 
    std::map<std::string, std::string>& planemap2, 
    const DiffusionCoefficient * diff, 
    const Model & m);

  bool addVariableToPlaneAndCheck(std::map<std::string, std::string>& planemap, 
    const std::string & var, 
    const std::string & difftype, 
    const std::string & axisOrPlane, 
    std::map<std::string, std::string>& axismap1, 
    std::map<std::string, std::string>& axismap2, 
    const DiffusionCoefficient * diff, 
    const Model & m);

};

LIBSBML_CPP_NAMESPACE_END

#endif  /* __cplusplus */
#endif  /* SpatialUniqueDiffusionCoefficientsCheck_h */
/** @endcond */
