/**
 * @file:   DynExtension.h
 * @brief:  Implementation of the DynExtension class
 * @author: SBMLTeam
 *
 * <!--------------------------------------------------------------------------
 * This file is part of libSBML.  Please visit http://sbml.org for more
 * information about SBML, and the latest version of libSBML.
 *
 * Copyright (C) 2013-2017 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 (C) 2009-2013 jointly by the following organizations:
 *     1. California Institute of Technology, Pasadena, CA, USA
 *     2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
 *
 * Copyright (C) 2006-2008 by the California Institute of Technology,
 *     Pasadena, CA, USA 
 *
 * Copyright (C) 2002-2005 jointly by the following organizations:
 *     1. California Institute of Technology, Pasadena, CA, USA
 *     2. Japan Science and Technology Agency, Japan
 *
 * 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 DynExtension_H__
#define DynExtension_H__


#include <sbml/common/extern.h>
#include <sbml/SBMLTypeCodes.h>


#ifdef __cplusplus


#include <sbml/extension/SBMLExtension.h>
#include <sbml/extension/SBMLExtensionNamespaces.h>
#include <sbml/extension/SBMLExtensionRegister.h>


#ifndef DYN_CREATE_NS
  #define DYN_CREATE_NS(variable, sbmlns)\
    EXTENSION_CREATE_NS(DynPkgNamespaces, variable, sbmlns);
#endif


#include <vector>


LIBSBML_CPP_NAMESPACE_BEGIN


class LIBSBML_EXTERN DynExtension : public SBMLExtension
{
public:

  //---------------------------------------------------------------
  //
  // Required class methods
  //
  //---------------------------------------------------------------

  /**
   * Returns the package name of this extension.
   */
  static const std::string& getPackageName ();


  /**
   * Returns the default SBML Level this extension.
   */
  static unsigned int getDefaultLevel();


  /**
   * Returns the default SBML Version this extension.
   */
  static unsigned int getDefaultVersion();


  /**
   * Returns the default SBML version this extension.
   */
  static unsigned int getDefaultPackageVersion();


  /**
   * Returns URI of supported versions of this package.
   */
  static const std::string&  getXmlnsL3V1V1();


  //
  // Other URI needed in this package (if any)
  //
  //---------------------------------------------------------------


  /**
   * Creates a new DynExtension   */
  DynExtension();


  /**
   * Copy constructor for DynExtension.
   *
   * @param orig; the DynExtension instance to copy.
   */
  DynExtension(const DynExtension& orig);


   /**
   * Assignment operator for DynExtension.
   *
   * @param rhs; the object whose values are used as the basis
   * of the assignment
   */
  DynExtension& operator=(const DynExtension& rhs);


   /**
   * Creates and returns a deep copy of this DynExtension object.
   *
   * @return a (deep) copy of this DynExtension object.
   */
  virtual DynExtension* clone () const;


   /**
   * Destructor for DynExtension.
   */
  virtual ~DynExtension();


   /**
   * Returns the name of this package ("dyn")
   *
   * @return a string representing the name of this package ("dyn")
   */
  virtual const std::string& getName() const;


  /**
   * Returns the URI (namespace) of the package corresponding to the combination of 
   * the given sbml level, sbml version, and package version.
   * Empty string will be returned if no corresponding URI exists.
   *
   * @param sbmlLevel the level of SBML
   * @param sbmlVersion the version of SBML
   * @param pkgVersion the version of package
   *
   * @return a string of the package URI
   */
  virtual const std::string& getURI(unsigned int sbmlLevel,
                                    unsigned int sbmlVersion,
                                    unsigned int pkgVersion) const;


  /**
   * Returns the SBML level with the given URI of this package.
   *
   * @param uri the string of URI that represents one of versions of dyn package
   *
   * @return the SBML level with the given URI of this package. 0 will be returned
   * if the given URI is invalid.
   *
   */
  virtual unsigned int getLevel(const std::string &uri) const;


  /**
   * Returns the SBML version with the given URI of this package.
   *
   * @param uri the string of URI that represents one of versions of dyn package
   *
   * @return the SBML version with the given URI of this package. 0 will be returned
   * if the given URI is invalid.
   *
   */
  virtual unsigned int getVersion(const std::string &uri) const;


  /**
   * Returns the package version with the given URI of this package.
   *
   * @param uri the string of URI that represents one of versions of dyn package
   *
   * @return the package version with the given URI of this package. 0 will be returned
   * if the given URI is invalid.
   *
   */
  virtual unsigned int getPackageVersion(const std::string &uri) const;


  /**
   * Returns an SBMLExtensionNamespaces<DynExtension> object whose alias type is 
   * DynPkgNamespace.
   * Null will be returned if the given uri is not defined in the dyn package.
   *
   * @param uri the string of URI that represents one of versions of dyn package
   *
   * @return an DynPkgNamespace object corresponding to the given uri. NULL will
   * be returned if the given URI is not defined in dyn package.
   */
  virtual SBMLNamespaces* getSBMLExtensionNamespaces(const std::string &uri) const;


  /**
   * This method takes a type code from the Dyn package and returns a string representing 
   * the code.
   */
  virtual const char* getStringFromTypeCode(int typeCode) const;


  /** @cond doxygenLibsbmlInternal */

  /**
   * Initializes dyn extension by creating an object of this class with 
   * required SBasePlugin derived objects and registering the object 
   * to the SBMLExtensionRegistry class.
   *
   * (NOTE) This function is automatically invoked when creating the following
   *        global object in DynExtension.cpp
   *
   *        static SBMLExtensionRegister<DynExtension> dynExtensionRegistry;
   *
   */
  static void init();


  /** @endcond doxygenLibsbmlInternal */


  /** @cond doxygenLibsbmlInternal */

  /**
   * Return the entry in the error table at this index. 
   *
   * @param index an unsigned intgere representing the index of the error in the DynSBMLErrorTable
   *
   * @return packageErrorTableEntry object in the DynSBMLErrorTable corresponding to the index given.
   */
  virtual packageErrorTableEntry getErrorTable(unsigned int index) const;


  /** @endcond doxygenLibsbmlInternal */


  /** @cond doxygenLibsbmlInternal */

  /**
   * Return the index in the error table with the given errorId. 
   *
   * @param errorId an unsigned intgere representing the errorId of the error in the DynSBMLErrorTable
   *
   * @return unsigned integer representing the index in the DynSBMLErrorTable corresponding to the errorId given.
   */
  virtual unsigned int getErrorTableIndex(unsigned int errorId) const;


  /** @endcond doxygenLibsbmlInternal */


  /** @cond doxygenLibsbmlInternal */

  /**
   * Return the offset for the errorId range for the dyn L3 package. 
   *
   * @return unsigned intege representing the  offset for errors DynSBMLErrorTable.
   */
  virtual unsigned int getErrorIdOffset() const;


  /** @endcond doxygenLibsbmlInternal */


};


// --------------------------------------------------------------------
//
// Required typedef definitions
//
// DynPkgNamespaces is derived from the SBMLNamespaces class and
// used when creating an object of SBase derived classes defined in
// dyn package.
//
// --------------------------------------------------------------------
//
// (NOTE)
//
// SBMLExtensionNamespaces<DynExtension> must be instantiated
// in DynExtension.cpp for DLL.
//
typedef SBMLExtensionNamespaces<DynExtension> DynPkgNamespaces;

typedef enum
{
    SBML_DYN_ELEMENT  = 400
  , SBML_DYN_SPATIALCOMPONENT      = 401
} SBMLDynTypeCode_t;


typedef enum
{
    SPATIALKIND_UNKNOWN  /*!< Unknown SpatialKind */
  , DYN_SPATIALKIND_CARTESIANX /*!< cartesianX */
  , DYN_SPATIALKIND_CARTESIANY /*!< cartesianY */
  , DYN_SPATIALKIND_CARTESIANZ /*!< cartesianZ */
  , DYN_SPATIALKIND_ALPHA /*!< alpha */
  , DYN_SPATIALKIND_BETA /*!< beta */
  , DYN_SPATIALKIND_GAMMA /*!< gamma */
  , DYN_SPATIALKIND_FX /*!< F_x */
  , DYN_SPATIALKIND_FY /*!< F_y */
  , DYN_SPATIALKIND_FZ /*!< F_z */
} SpatialKind_t;


LIBSBML_EXTERN
const char *
SpatialKind_toString(SpatialKind_t code);


LIBSBML_EXTERN
SpatialKind_t
SpatialKind_parse(const char* code);




LIBSBML_CPP_NAMESPACE_END


#endif /* __cplusplus */
#endif /* DynExtension_H__ */


