/**
 * @file ParametricObject.h
 * @brief Definition of the ParametricObject 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) 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 (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
 * ------------------------------------------------------------------------ -->
 *
 * @class ParametricObject
 * @sbmlbrief{spatial} The ParametricObject element represents a single
 * parametric geometry object. It contains a list of point indices from the
 * parent ParametricGeometry's SpatialPoints, which collectively define the faces
 * of the object.
 */

/**
 * <!-- ~ ~ ~ ~ ~ Start of common documentation strings ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~
 * The following text is used as common documentation blocks copied multiple
 * times elsewhere in this file. The use of @class is a hack needed because
 * Doxygen's @copydetails command has limited functionality. Symbols
 * beginning with "doc_" are marked as ignored in our Doxygen configuration.
 * ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ -->
 *
 *
 * @class doc_parametricobject_polygonType
 *
 * @par
 * The attribute "polygonType" on a ParametricObject object is used to TODO:add
 * explanation
 *
 * In the SBML
 * Level&nbsp;3 Version&nbsp;1 Spatial specification, the following are the
 * allowable values for "polygonType":
 * <ul>
 * <li> @c "triangle", TODO:add description
 *
 * </ul>
 *
 * @class doc_parametricobject_compression
 *
 * @par
 * The attribute "compression" on a ParametricObject object is used to TODO:add
 * explanation
 *
 * In the SBML
 * Level&nbsp;3 Version&nbsp;1 Spatial specification, the following are the
 * allowable values for "compression":
 * <ul>
 * <li> @c "uncompressed", TODO:add description
 *
 * <li> @c "deflated", TODO:add description
 *
 * </ul>
 *
 * @class doc_parametricobject_dataType
 *
 * @par
 * The attribute "dataType" on a ParametricObject object is used to TODO:add
 * explanation
 *
 * In the SBML
 * Level&nbsp;3 Version&nbsp;1 Spatial specification, the following are the
 * allowable values for "dataType":
 * <ul>
 * <li> @c "double", TODO:add description
 *
 * <li> @c "float", TODO:add description
 *
 * <li> @c "uint8", TODO:add description
 *
 * <li> @c "uint16", TODO:add description
 *
 * <li> @c "uint32", TODO:add description
 *
 * </ul>
 */


#ifndef ParametricObject_H__
#define ParametricObject_H__


#include <sbml/common/extern.h>
#include <sbml/common/sbmlfwd.h>
#include <sbml/packages/spatial/common/spatialfwd.h>


#ifdef __cplusplus


#include <string>


#include <sbml/SBase.h>
#include <sbml/packages/spatial/extension/SpatialExtension.h>


LIBSBML_CPP_NAMESPACE_BEGIN


class LIBSBML_EXTERN ParametricObject : public SBase
{
protected:

  /** @cond doxygenLibsbmlInternal */

  PolygonKind_t mPolygonType;
  std::string mDomainType;
  std::string mPointIndex;
  mutable int* mPointIndexCompressed;
  mutable int* mPointIndexUncompressed;
  mutable size_t mPointIndexCompressedLength;
  mutable size_t mPointIndexUncompressedLength;
  int mPointIndexLength;
  bool mIsSetPointIndexLength;
  CompressionKind_t mCompression;
  DataKind_t mDataType;

  /** @endcond */

public:

  /**
   * Creates a new ParametricObject using the given SBML Level, Version and
   * &ldquo;spatial&rdquo; package version.
   *
   * @param level an unsigned int, the SBML Level to assign to this
   * ParametricObject.
   *
   * @param version an unsigned int, the SBML Version to assign to this
   * ParametricObject.
   *
   * @param pkgVersion an unsigned int, the SBML Spatial Version to assign to
   * this ParametricObject.
   *
   * @copydetails doc_note_setting_lv_pkg
   */
  ParametricObject(unsigned int level = SpatialExtension::getDefaultLevel(),
                   unsigned int version =
                     SpatialExtension::getDefaultVersion(),
                   unsigned int pkgVersion =
                     SpatialExtension::getDefaultPackageVersion());


  /**
   * Creates a new ParametricObject using the given SpatialPkgNamespaces
   * object.
   *
   * @copydetails doc_what_are_sbml_package_namespaces
   *
   * @param spatialns the SpatialPkgNamespaces object.
   *
   * @copydetails doc_note_setting_lv_pkg
   */
  ParametricObject(SpatialPkgNamespaces *spatialns);


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


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


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


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


  /**
   * Returns the value of the "id" attribute of this ParametricObject.
   *
   * @return the value of the "id" attribute of this ParametricObject as a
   * string.
   */
  virtual const std::string& getId() const;


  /**
   * Returns the value of the "name" attribute of this ParametricObject.
   *
   * @return the value of the "name" attribute of this ParametricObject as a
   * string.
   */
  virtual const std::string& getName() const;


  /**
   * Returns the value of the "polygonType" attribute of this ParametricObject.
   *
   * @return the value of the "polygonType" attribute of this ParametricObject
   * as a PolygonKind_t.
   *
   * @copydetails doc_parametricobject_polygonType
   * @if clike The value is drawn from the enumeration @ref PolygonKind_t
   * @endif
   * The possible values returned by this method are:
   * @li @sbmlconstant{SPATIAL_POLYGONKIND_TRIANGLE, PolygonKind_t}
   * @li @sbmlconstant{SPATIAL_POLYGONKIND_INVALID, PolygonKind_t}
   */
  PolygonKind_t getPolygonType() const;


  /**
   * Returns the value of the "polygonType" attribute of this ParametricObject.
   *
   * @return the value of the "polygonType" attribute of this ParametricObject
   * as a string.
   *
   * @copydetails doc_parametricobject_polygonType
   * The possible values returned by this method are:
   * @li @c "triangle"
   * @li @c "invalid PolygonKind value"
   */
  std::string getPolygonTypeAsString() const;


  /**
   * Returns the value of the "domainType" attribute of this ParametricObject.
   *
   * @return the value of the "domainType" attribute of this ParametricObject
   * as a string.
   */
  const std::string& getDomainType() const;


  /**
   * Stores the value of the "pointIndex" attribute of this ParametricObject
   * as an int* array in @p outArray.  The values may be compressed or not
   * compressed, depending on the state of the object.
   *
   * @param outArray int* array that will be used to return the value of the
   * "pointIndex" attribute of this ParametricObject.
   *
   * @note the value of the "pointIndex" attribute of this ParametricObject is
   * returned in the argument array.
   */
  void getPointIndex(int* outArray) const;


  /**
   * Stores the value of the "pointIndex" attribute of this ParametricObject
   * as an int* array in @p outVector.  The values may be compressed or not
   * compressed, depending on the state of the object.
   *
   * @param outVector int vector that will be used to return the value of the
   * "pointIndex" attribute of this ParametricObject.
   *
   * @note the value of the "pointIndex" attribute of this ParametricObject is
   * returned in the argument array.
   */
  void getPointIndex(std::vector<int>& outVector) const;


  /**
   * Returns the value of the "pointIndex" attribute of this ParametricObject
   * as a string.
   *
   * @param outArray int* array that will be used to return the value of the
   * "pointIndex" attribute of this ParametricObject.
   *
   * @note the value of the "pointIndex" attribute of this ParametricObject is
   * returned in the argument array.
   */
  std::string getPointIndex();


  /**
   * Returns the value of the "pointIndexLength" attribute of this
   * ParametricObject.
   *
   * @return the value of the "pointIndexLength" attribute of this
   * ParametricObject as a integer.
   */
  int getPointIndexLength() const;


  /**
   * Returns the number of entries of the child vector of this
   * ParametricObject.  In the uncompressed case, this should equal
   * the 'pointIndexLength' attribute.
   *
   * @return the number of entries of the child vector of this
   * ParametricObject. 
   */
  size_t getActualPointIndexLength() const;


  /**
   * Returns the value of the "compression" attribute of this ParametricObject.
   *
   * @return the value of the "compression" attribute of this ParametricObject
   * as a CompressionKind_t.
   *
   * @copydetails doc_parametricobject_compression
   * @if clike The value is drawn from the enumeration @ref CompressionKind_t
   * @endif
   * The possible values returned by this method are:
   * @li @sbmlconstant{SPATIAL_COMPRESSIONKIND_UNCOMPRESSED, CompressionKind_t}
   * @li @sbmlconstant{SPATIAL_COMPRESSIONKIND_DEFLATED, CompressionKind_t}
   * @li @sbmlconstant{SPATIAL_COMPRESSIONKIND_INVALID, CompressionKind_t}
   */
  CompressionKind_t getCompression() const;


  /**
   * Returns the value of the "compression" attribute of this ParametricObject.
   *
   * @return the value of the "compression" attribute of this ParametricObject
   * as a string.
   *
   * @copydetails doc_parametricobject_compression
   * The possible values returned by this method are:
   * @li @c "uncompressed"
   * @li @c "deflated"
   * @li @c "invalid CompressionKind value"
   */
  const std::string& getCompressionAsString() const;


  /**
   * Returns the value of the "dataType" attribute of this ParametricObject.
   *
   * @return the value of the "dataType" attribute of this ParametricObject as
   * a DataKind_t.
   *
   * @copydetails doc_parametricobject_dataType
   * @if clike The value is drawn from the enumeration @ref DataKind_t @endif
   * The possible values returned by this method are:
   * @li @sbmlconstant{SPATIAL_DATAKIND_UINT, DataKind_t}
   * @li @sbmlconstant{SPATIAL_DATAKIND_INT, DataKind_t}
   * @li @sbmlconstant{SPATIAL_DATAKIND_DOUBLE, DataKind_t}
   * @li @sbmlconstant{SPATIAL_DATAKIND_FLOAT, DataKind_t}
   * @li @sbmlconstant{SPATIAL_DATAKIND_UINT8, DataKind_t}
   * @li @sbmlconstant{SPATIAL_DATAKIND_UINT16, DataKind_t}
   * @li @sbmlconstant{SPATIAL_DATAKIND_UINT32, DataKind_t}
   * @li @sbmlconstant{SPATIAL_DATAKIND_INVALID, DataKind_t}
   */
  DataKind_t getDataType() const;


  /**
   * Returns the value of the "dataType" attribute of this ParametricObject.
   *
   * @return the value of the "dataType" attribute of this ParametricObject as
   * a string.
   *
   * @copydetails doc_parametricobject_dataType
   * The possible values returned by this method are:
   * @li @c "uint"
   * @li @c "int"
   * @li @c "double"
   * @li @c "float"
   * @li @c "uint8"
   * @li @c "uint16"
   * @li @c "uint32"
   * @li @c "invalid DataKind value"
   */
  std::string getDataTypeAsString() const;


  /**
   * Predicate returning @c true if this ParametricObject's "id" attribute is
   * set.
   *
   * @return @c true if this ParametricObject's "id" attribute has been set,
   * otherwise @c false is returned.
   */
  virtual bool isSetId() const;


  /**
   * Predicate returning @c true if this ParametricObject's "name" attribute is
   * set.
   *
   * @return @c true if this ParametricObject's "name" attribute has been set,
   * otherwise @c false is returned.
   */
  virtual bool isSetName() const;


  /**
   * Predicate returning @c true if this ParametricObject's "polygonType"
   * attribute is set.
   *
   * @return @c true if this ParametricObject's "polygonType" attribute has
   * been set, otherwise @c false is returned.
   *
   * @copydetails doc_parametricobject_polygonType
   */
  bool isSetPolygonType() const;


  /**
   * Predicate returning @c true if this ParametricObject's "domainType"
   * attribute is set.
   *
   * @return @c true if this ParametricObject's "domainType" attribute has been
   * set, otherwise @c false is returned.
   */
  bool isSetDomainType() const;


  /**
   * Predicate returning @c true if this ParametricObject's "pointIndex"
   * attribute is set.
   *
   * @return @c true if this ParametricObject's "pointIndex" attribute has been
   * set, otherwise @c false is returned.
   */
  bool isSetPointIndex() const;


  /**
   * Predicate returning @c true if this ParametricObject's "pointIndexLength"
   * attribute is set.
   *
   * @return @c true if this ParametricObject's "pointIndexLength" attribute
   * has been set, otherwise @c false is returned.
   */
  bool isSetPointIndexLength() const;


  /**
   * Predicate returning @c true if this ParametricObject's "compression"
   * attribute is set.
   *
   * @return @c true if this ParametricObject's "compression" attribute has
   * been set, otherwise @c false is returned.
   *
   * @copydetails doc_parametricobject_compression
   */
  bool isSetCompression() const;


  /**
   * Predicate returning @c true if this ParametricObject's "dataType"
   * attribute is set.
   *
   * @return @c true if this ParametricObject's "dataType" attribute has been
   * set, otherwise @c false is returned.
   *
   * @copydetails doc_parametricobject_dataType
   */
  bool isSetDataType() const;


  /**
   * Sets the value of the "id" attribute of this ParametricObject.
   *
   * @param id std::string& value of the "id" attribute to be set.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE,
   * OperationReturnValues_t}
   *
   * Calling this function with @p id = @c NULL or an empty string is
   * equivalent to calling unsetId().
   */
  virtual int setId(const std::string& id);


  /**
   * Sets the value of the "name" attribute of this ParametricObject.
   *
   * @param name std::string& value of the "name" attribute to be set.
   *
   * @copydetails doc_returns_one_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   *
   * Calling this function with @p name = @c NULL or an empty string is
   * equivalent to calling unsetName().
   */
  virtual int setName(const std::string& name);


  /**
   * Sets the value of the "polygonType" attribute of this ParametricObject.
   *
   * @param polygonType @if clike PolygonKind_t@else int@endif value of the
   * "polygonType" attribute to be set.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE,
   * OperationReturnValues_t}
   *
   * @copydetails doc_parametricobject_polygonType
   */
  int setPolygonType(const PolygonKind_t polygonType);


  /**
   * Sets the value of the "polygonType" attribute of this ParametricObject.
   *
   * @param polygonType std::string& of the "polygonType" attribute to be set.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE,
   * OperationReturnValues_t}
   *
   * @copydetails doc_parametricobject_polygonType
   */
  int setPolygonType(const std::string& polygonType);


  /**
   * Sets the value of the "domainType" attribute of this ParametricObject.
   *
   * @param domainType std::string& value of the "domainType" attribute to be
   * set.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE,
   * OperationReturnValues_t}
   */
  int setDomainType(const std::string& domainType);


  /**
   * Sets the value of the "pointIndex" attribute of this ParametricObject.
   *
   * @param inArray int* array value of the "pointIndex" attribute to be set.
   *
   * @param arrayLength int value for the length of the "pointIndex" attribute
   * to be set.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE,
   * OperationReturnValues_t}
   */
  int setPointIndex(const std::string& pointIndex);


  /**
   * Sets the value of the "pointIndex" attribute of this ParametricObject.
   *
   * This function assumes that the 'compression' value is already set, and
   * that the array matches that value:  if the 'compression' value
   * is set to 'deflated', the @p inArray will be assumed to be compressed,
   * and if the 'compression' value is set to 'uncompressed', the @p inArray
   * will be assumed to be uncompressed.  If the value is unset, the @p inArray
   * will also be assumed to be uncompressed.
   *
   * This function will also set 'pointIndexLength' to @p arrayLength.
   *
   * @param inArray int* array value of the "pointIndex" attribute to be set.
   *
   * @param arrayLength int value for the length of @p inArray, and the value 
   * to set the "pointIndex" attribute to.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE,
   * OperationReturnValues_t}
   */
  int setPointIndex(int* inArray, size_t arrayLength);


  /**
   * Sets the value of the "pointIndex" attribute of this ParametricObject.
   *
   * This function assumes that the 'compression' value is already set, and
   * that the array matches that value:  if the 'compression' value
   * is set to 'deflated', the @p inArray will be assumed to be compressed,
   * and if the 'compression' value is set to 'uncompressed', the @p inArray
   * will be assumed to be uncompressed.  If the value is unset, the @p inArray
   * will also be assumed to be uncompressed.
   *
   * This function will also set 'pointIndexLength' to @p arrayLength.
   *
   * @param inArray int* array value of the "pointIndex" attribute to be set.
   *
   * @param arrayLength int value for the length of @p inArray, and the value 
   * to set the "pointIndex" attribute to.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE,
   * OperationReturnValues_t}
   */
  int setPointIndex(const std::vector<int>& inArray);


  /**
   * Sets the value of the "pointIndexLength" attribute of this
   * ParametricObject.  This value should match the actual number
   * of entries in the array of point indexes.
   *
   * @param pointIndexLength int value of the "pointIndexLength" attribute to
   * be set.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE,
   * OperationReturnValues_t}
   */
  int setPointIndexLength(int pointIndexLength);


  /**
   * Sets the value of the "compression" attribute of this ParametricObject.
   *
   * @param compression @if clike CompressionKind_t@else int@endif value of the
   * "compression" attribute to be set.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE,
   * OperationReturnValues_t}
   *
   * @copydetails doc_parametricobject_compression
   */
  int setCompression(const CompressionKind_t compression);


  /**
   * Sets the value of the "compression" attribute of this ParametricObject.
   *
   * @param compression std::string& of the "compression" attribute to be set.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE,
   * OperationReturnValues_t}
   *
   * @copydetails doc_parametricobject_compression
   */
  int setCompression(const std::string& compression);


  /**
   * Sets the value of the "dataType" attribute of this ParametricObject.
   *
   * @param dataType @if clike DataKind_t@else int@endif value of the
   * "dataType" attribute to be set.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE,
   * OperationReturnValues_t}
   *
   * @copydetails doc_parametricobject_dataType
   */
  int setDataType(const DataKind_t dataType);


  /**
   * Sets the value of the "dataType" attribute of this ParametricObject.
   *
   * @param dataType std::string& of the "dataType" attribute to be set.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE,
   * OperationReturnValues_t}
   *
   * @copydetails doc_parametricobject_dataType
   */
  int setDataType(const std::string& dataType);


  /**
   * Unsets the value of the "id" attribute of this ParametricObject.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
   */
  virtual int unsetId();


  /**
   * Unsets the value of the "name" attribute of this ParametricObject.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
   */
  virtual int unsetName();


  /**
   * Unsets the value of the "polygonType" attribute of this ParametricObject.
   *
   * @copydetails doc_returns_one_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   *
   * @copydetails doc_parametricobject_polygonType
   */
  int unsetPolygonType();


  /**
   * Unsets the value of the "domainType" attribute of this ParametricObject.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
   */
  int unsetDomainType();


  /**
   * Unsets the value of the "pointIndex" attribute of this ParametricObject.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
   */
  int unsetPointIndex();


  /**
   * Unsets the value of the "pointIndexLength" attribute of this
   * ParametricObject.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
   */
  int unsetPointIndexLength();


  /**
   * Unsets the value of the "compression" attribute of this ParametricObject.
   *
   * @copydetails doc_returns_one_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   *
   * @copydetails doc_parametricobject_compression
   */
  int unsetCompression();


  /**
   * Unsets the value of the "dataType" attribute of this ParametricObject.
   *
   * @copydetails doc_returns_one_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   *
   * @copydetails doc_parametricobject_dataType
   */
  int unsetDataType();


  /**
   * @copydoc doc_renamesidref_common
   */
  virtual void renameSIdRefs(const std::string& oldid,
                             const std::string& newid);


  /**
   * Returns the XML element name of this ParametricObject object.
   *
   * For ParametricObject, the XML element name is always
   * @c "parametricObject".
   *
   * @return the name of this element, i.e. @c "parametricObject".
   */
  virtual const std::string& getElementName() const;


  /**
   * Returns the libSBML type code for this ParametricObject object.
   *
   * @copydetails doc_what_are_typecodes
   *
   * @return the SBML type code for this object:
   * @sbmlconstant{SBML_SPATIAL_PARAMETRICOBJECT, SBMLSpatialTypeCode_t}.
   *
   * @copydetails doc_warning_typecodes_not_unique
   *
   * @see getElementName()
   * @see getPackageName()
   */
  virtual int getTypeCode() const;


  /**
   * Predicate returning @c true if all the required attributes for this
   * ParametricObject object have been set.
   *
   * @return @c true to indicate that all the required attributes of this
   * ParametricObject have been set, otherwise @c false is returned.
   *
   *
   * @note The required attributes for the ParametricObject object are:
   * @li "id"
   * @li "polygonType"
   * @li "domainType"
   * @li "pointIndex"
   * @li "pointIndexLength"
   * @li "compression"
   */
  virtual bool hasRequiredAttributes() const;



  /** @cond doxygenLibsbmlInternal */

  /**
   * Write any contained elements
   */
  virtual void writeElements(XMLOutputStream& stream) const;

  /** @endcond */



  /** @cond doxygenLibsbmlInternal */

  /**
   * Accepts the given SBMLVisitor
   */
  virtual bool accept(SBMLVisitor& v) const;

  /** @endcond */



  /** @cond doxygenLibsbmlInternal */

  /**
   * Sets the parent SBMLDocument
   */
  virtual void setSBMLDocument(SBMLDocument* d);

  /** @endcond */



  /** @cond doxygenLibsbmlInternal */

  /**
   * used to write arrays
   */
  virtual void write(XMLOutputStream& stream) const;

  /** @endcond */



  /** @cond doxygenLibsbmlInternal */

  /**
   * Enables/disables the given package with this element
   */
  virtual void enablePackageInternal(const std::string& pkgURI,
                                     const std::string& pkgPrefix,
                                     bool flag);

  /** @endcond */




  #ifndef SWIG



  /** @cond doxygenLibsbmlInternal */

  /**
   * Gets the value of the "attributeName" attribute of this ParametricObject.
   *
   * @param attributeName, the name of the attribute to retrieve.
   *
   * @param value, the address of the value to record.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
   */
  virtual int getAttribute(const std::string& attributeName, bool& value)
    const;

  /** @endcond */



  /** @cond doxygenLibsbmlInternal */

  /**
   * Gets the value of the "attributeName" attribute of this ParametricObject.
   *
   * @param attributeName, the name of the attribute to retrieve.
   *
   * @param value, the address of the value to record.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
   */
  virtual int getAttribute(const std::string& attributeName, int& value) const;

  /** @endcond */



  /** @cond doxygenLibsbmlInternal */

  /**
   * Gets the value of the "attributeName" attribute of this ParametricObject.
   *
   * @param attributeName, the name of the attribute to retrieve.
   *
   * @param value, the address of the value to record.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
   */
  virtual int getAttribute(const std::string& attributeName,
                           double& value) const;

  /** @endcond */



  /** @cond doxygenLibsbmlInternal */

  /**
   * Gets the value of the "attributeName" attribute of this ParametricObject.
   *
   * @param attributeName, the name of the attribute to retrieve.
   *
   * @param value, the address of the value to record.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
   */
  virtual int getAttribute(const std::string& attributeName,
                           unsigned int& value) const;

  /** @endcond */



  /** @cond doxygenLibsbmlInternal */

  /**
   * Gets the value of the "attributeName" attribute of this ParametricObject.
   *
   * @param attributeName, the name of the attribute to retrieve.
   *
   * @param value, the address of the value to record.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
   */
  virtual int getAttribute(const std::string& attributeName,
                           std::string& value) const;

  /** @endcond */



  /** @cond doxygenLibsbmlInternal */

  /**
   * Predicate returning @c true if this ParametricObject's attribute
   * "attributeName" is set.
   *
   * @param attributeName, the name of the attribute to query.
   *
   * @return @c true if this ParametricObject's attribute "attributeName" has
   * been set, otherwise @c false is returned.
   */
  virtual bool isSetAttribute(const std::string& attributeName) const;

  /** @endcond */



  /** @cond doxygenLibsbmlInternal */

  /**
   * Sets the value of the "attributeName" attribute of this ParametricObject.
   *
   * @param attributeName, the name of the attribute to set.
   *
   * @param value, the value of the attribute to set.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
   */
  virtual int setAttribute(const std::string& attributeName, bool value);

  /** @endcond */



  /** @cond doxygenLibsbmlInternal */

  /**
   * Sets the value of the "attributeName" attribute of this ParametricObject.
   *
   * @param attributeName, the name of the attribute to set.
   *
   * @param value, the value of the attribute to set.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
   */
  virtual int setAttribute(const std::string& attributeName, int value);

  /** @endcond */



  /** @cond doxygenLibsbmlInternal */

  /**
   * Sets the value of the "attributeName" attribute of this ParametricObject.
   *
   * @param attributeName, the name of the attribute to set.
   *
   * @param value, the value of the attribute to set.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
   */
  virtual int setAttribute(const std::string& attributeName, double value);

  /** @endcond */



  /** @cond doxygenLibsbmlInternal */

  /**
   * Sets the value of the "attributeName" attribute of this ParametricObject.
   *
   * @param attributeName, the name of the attribute to set.
   *
   * @param value, the value of the attribute to set.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
   */
  virtual int setAttribute(const std::string& attributeName,
                           unsigned int value);

  /** @endcond */



  /** @cond doxygenLibsbmlInternal */

  /**
   * Sets the value of the "attributeName" attribute of this ParametricObject.
   *
   * @param attributeName, the name of the attribute to set.
   *
   * @param value, the value of the attribute to set.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
   */
  virtual int setAttribute(const std::string& attributeName,
                           const std::string& value);

  /** @endcond */



  /** @cond doxygenLibsbmlInternal */

  /**
   * Unsets the value of the "attributeName" attribute of this
   * ParametricObject.
   *
   * @param attributeName, the name of the attribute to query.
   *
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
   */
  virtual int unsetAttribute(const std::string& attributeName);

  /** @endcond */




  #endif /* !SWIG */


protected:


  /** @cond doxygenLibsbmlInternal */

  /**
   * Adds the expected attributes for this element
   */
  virtual void addExpectedAttributes(ExpectedAttributes& attributes);

  /** @endcond */



  /** @cond doxygenLibsbmlInternal */

  /**
   * Reads the expected attributes into the member data variables
   */
  virtual void readAttributes(const XMLAttributes& attributes,
                              const ExpectedAttributes& expectedAttributes);

  /** @endcond */



  /** @cond doxygenLibsbmlInternal */

  /**
   * Writes the attributes to the stream
   */
  virtual void writeAttributes(XMLOutputStream& stream) const;

  /** @endcond */



  /** @cond doxygenLibsbmlInternal */

  /**
   * Writes the array data as a text element
   */
  virtual void setElementText(const std::string& text);

  /** @endcond */


  /** @cond doxygenLibsbmlInternal */

  /* Store the PointIndex string as ints, either compressed or not.*/
  void store() const;

  /* Uncompress the data, but don't store the change.*/
  void uncompressInternal(std::string & sampleString, size_t & length) const;

  /** @endcond */


public:

  /**
  * Returns the number of uncompressed samples of this ParametricObject.
  * Will uncompress the samples if need be.
  *
  * @return the number of uncompressed samples of this ParametricObject.
  */
  unsigned int getUncompressedLength() const;

  /**
   * The "samples" attribute of this ParametricObject is returned in an int array (pointer) 
   * that is passed as argument to the method (this is needed while using SWIG to
   * convert int[] from C++ to Java). This method returns the uncompressed sample field.
   * Will uncompress the samples if need be.
   *
   * @return void.
   */
  void getUncompressed(int* outputPoints) const;

  /**
   * The "samples" attribute of this ParametricObject is returned in a std::vector of int
   * that is passed as argument to the method. This method returns the uncompressed sample field.
   * Will uncompress the samples if need be.
   *
   * @return void.
   */
  void getUncompressed(std::vector<int>& outputPoints) const;

  /** 
  * utility function freeing the uncompressed data. 
  */
  void freeUncompressed() const;

  /** 
  * utility function freeing the compressed data. 
  */
  void freeCompressed() const;

  /** 
  * If the samples stored are compressed (i.e: the flag set to DEFLATED), then
  * this function decompresses the samples and alters the samples, changing the 
  * compression flag to uncompressed. 
  *
  * @copydetails doc_returns_success_code
  * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
  * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
  */
  int uncompress();

  /**
   * compresses the samples stored, if the flag is set to UNCOMPRESSED, then 
   * changes the flag to compressed. 
   * 
   * Returns failure if libsbml was built without zlib linked.
   *
   * @param compression level 0 (store) ... 9 (max compression)
   * 
   * @copydetails doc_returns_success_code
   * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
   * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
   */
  int compress(int level);

  /**  
   * Returns the data of this image as uncompressed array of integers.
   * Will uncompress the samples if need be.
   *
   * @param data the output array of integers (it will be allocated using
   *             malloc and will have to be freed using free)
   * @param length the output length of the array
   *
   */
  void getUncompressedData(int* &data, size_t& length);



};



LIBSBML_CPP_NAMESPACE_END




#endif /* __cplusplus */




#ifndef SWIG




LIBSBML_CPP_NAMESPACE_BEGIN




BEGIN_C_DECLS


/**
 * Creates a new ParametricObject_t using the given SBML Level, Version and
 * &ldquo;spatial&rdquo; package version.
 *
 * @param level an unsigned int, the SBML Level to assign to this
 * ParametricObject_t.
 *
 * @param version an unsigned int, the SBML Version to assign to this
 * ParametricObject_t.
 *
 * @param pkgVersion an unsigned int, the SBML Spatial Version to assign to
 * this ParametricObject_t.
 *
 * @copydetails doc_note_setting_lv_pkg
 *
 * @copydetails doc_returned_owned_pointer
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
ParametricObject_t *
ParametricObject_create(unsigned int level,
                        unsigned int version,
                        unsigned int pkgVersion);


/**
 * Creates and returns a deep copy of this ParametricObject_t object.
 *
 * @param po the ParametricObject_t structure.
 *
 * @return a (deep) copy of this ParametricObject_t object.
 *
 * @copydetails doc_returned_owned_pointer
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
ParametricObject_t*
ParametricObject_clone(const ParametricObject_t* po);


/**
 * Frees this ParametricObject_t object.
 *
 * @param po the ParametricObject_t structure.
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
void
ParametricObject_free(ParametricObject_t* po);


/**
 * Returns the value of the "id" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure whose id is sought.
 *
 * @return the value of the "id" attribute of this ParametricObject_t as a
 * pointer to a string.
 *
 * @copydetails doc_returned_owned_char
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
char *
ParametricObject_getId(const ParametricObject_t * po);


/**
 * Returns the value of the "name" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure whose name is sought.
 *
 * @return the value of the "name" attribute of this ParametricObject_t as a
 * pointer to a string.
 *
 * @copydetails doc_returned_owned_char
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
char *
ParametricObject_getName(const ParametricObject_t * po);


/**
 * Returns the value of the "polygonType" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure whose polygonType is sought.
 *
 * @return the value of the "polygonType" attribute of this ParametricObject_t
 * as a PolygonKind_t.
 *
 * @copydetails doc_parametricobject_polygonType
 * @if clike The value is drawn from the enumeration @ref PolygonKind_t @endif
 * The possible values returned by this method are:
 * @li @sbmlconstant{SPATIAL_POLYGONKIND_TRIANGLE, PolygonKind_t}
 * @li @sbmlconstant{SPATIAL_POLYGONKIND_INVALID, PolygonKind_t}
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
PolygonKind_t
ParametricObject_getPolygonType(const ParametricObject_t * po);


/**
 * Returns the value of the "polygonType" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure whose polygonType is sought.
 *
 * @return the value of the "polygonType" attribute of this ParametricObject_t
 * as a const char *.
 *
 * @copydetails doc_returned_unowned_char
 *
 * @copydetails doc_parametricobject_polygonType
 * The possible values returned by this method are:
 * @li @c "triangle"
 * @li @c "invalid PolygonKind value"
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
char *
ParametricObject_getPolygonTypeAsString(const ParametricObject_t * po);


/**
 * Returns the value of the "domainType" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure whose domainType is sought.
 *
 * @return the value of the "domainType" attribute of this ParametricObject_t
 * as a pointer to a string.
 *
 * @copydetails doc_returned_owned_char
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
char *
ParametricObject_getDomainType(const ParametricObject_t * po);


/**
 * Returns the value of the "pointIndexLength" attribute of this
 * ParametricObject_t.
 *
 * @param po the ParametricObject_t structure whose pointIndexLength is sought.
 *
 * @return the value of the "pointIndexLength" attribute of this
 * ParametricObject_t as a integer.
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_getPointIndexLength(const ParametricObject_t * po);


/**
 * Returns the value of the "compression" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure whose compression is sought.
 *
 * @return the value of the "compression" attribute of this ParametricObject_t
 * as a CompressionKind_t.
 *
 * @copydetails doc_parametricobject_compression
 * @if clike The value is drawn from the enumeration @ref CompressionKind_t
 * @endif
 * The possible values returned by this method are:
 * @li @sbmlconstant{SPATIAL_COMPRESSIONKIND_UNCOMPRESSED, CompressionKind_t}
 * @li @sbmlconstant{SPATIAL_COMPRESSIONKIND_DEFLATED, CompressionKind_t}
 * @li @sbmlconstant{SPATIAL_COMPRESSIONKIND_INVALID, CompressionKind_t}
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
CompressionKind_t
ParametricObject_getCompression(const ParametricObject_t * po);


/**
 * Returns the value of the "compression" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure whose compression is sought.
 *
 * @return the value of the "compression" attribute of this ParametricObject_t
 * as a const char *.
 *
 * @copydetails doc_returned_unowned_char
 *
 * @copydetails doc_parametricobject_compression
 * The possible values returned by this method are:
 * @li @c "uncompressed"
 * @li @c "deflated"
 * @li @c "invalid CompressionKind value"
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
char *
ParametricObject_getCompressionAsString(const ParametricObject_t * po);


/**
 * Returns the value of the "dataType" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure whose dataType is sought.
 *
 * @return the value of the "dataType" attribute of this ParametricObject_t as
 * a DataKind_t.
 *
 * @copydetails doc_parametricobject_dataType
 * @if clike The value is drawn from the enumeration @ref DataKind_t @endif
 * The possible values returned by this method are:
 * @li @sbmlconstant{SPATIAL_DATAKIND_UINT, DataKind_t}
 * @li @sbmlconstant{SPATIAL_DATAKIND_INT, DataKind_t}
 * @li @sbmlconstant{SPATIAL_DATAKIND_DOUBLE, DataKind_t}
 * @li @sbmlconstant{SPATIAL_DATAKIND_FLOAT, DataKind_t}
 * @li @sbmlconstant{SPATIAL_DATAKIND_UINT8, DataKind_t}
 * @li @sbmlconstant{SPATIAL_DATAKIND_UINT16, DataKind_t}
 * @li @sbmlconstant{SPATIAL_DATAKIND_UINT32, DataKind_t}
 * @li @sbmlconstant{SPATIAL_DATAKIND_INVALID, DataKind_t}
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
DataKind_t
ParametricObject_getDataType(const ParametricObject_t * po);


/**
 * Returns the value of the "dataType" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure whose dataType is sought.
 *
 * @return the value of the "dataType" attribute of this ParametricObject_t as
 * a const char *.
 *
 * @copydetails doc_returned_unowned_char
 *
 * @copydetails doc_parametricobject_dataType
 * The possible values returned by this method are:
 * @li @c "uint"
 * @li @c "int"
 * @li @c "double"
 * @li @c "float"
 * @li @c "uint8"
 * @li @c "uint16"
 * @li @c "uint32"
 * @li @c "invalid DataKind value"
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
char *
ParametricObject_getDataTypeAsString(const ParametricObject_t * po);


/**
 * Predicate returning @c 1 (true) if this ParametricObject_t's "id" attribute
 * is set.
 *
 * @param po the ParametricObject_t structure.
 *
 * @return @c 1 (true) if this ParametricObject_t's "id" attribute has been
 * set, otherwise @c 0 (false) is returned.
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_isSetId(const ParametricObject_t * po);


/**
 * Predicate returning @c 1 (true) if this ParametricObject_t's "name"
 * attribute is set.
 *
 * @param po the ParametricObject_t structure.
 *
 * @return @c 1 (true) if this ParametricObject_t's "name" attribute has been
 * set, otherwise @c 0 (false) is returned.
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_isSetName(const ParametricObject_t * po);


/**
 * Predicate returning @c 1 (true) if this ParametricObject_t's "polygonType"
 * attribute is set.
 *
 * @param po the ParametricObject_t structure.
 *
 * @return @c 1 (true) if this ParametricObject_t's "polygonType" attribute has
 * been set, otherwise @c 0 (false) is returned.
 *
 * @copydetails doc_parametricobject_polygonType
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_isSetPolygonType(const ParametricObject_t * po);


/**
 * Predicate returning @c 1 (true) if this ParametricObject_t's "domainType"
 * attribute is set.
 *
 * @param po the ParametricObject_t structure.
 *
 * @return @c 1 (true) if this ParametricObject_t's "domainType" attribute has
 * been set, otherwise @c 0 (false) is returned.
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_isSetDomainType(const ParametricObject_t * po);


/**
 * Predicate returning @c 1 (true) if this ParametricObject_t's "pointIndex"
 * attribute is set.
 *
 * @param po the ParametricObject_t structure.
 *
 * @return @c 1 (true) if this ParametricObject_t's "pointIndex" attribute has
 * been set, otherwise @c 0 (false) is returned.
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_isSetPointIndex(const ParametricObject_t * po);


/**
 * Predicate returning @c 1 (true) if this ParametricObject_t's
 * "pointIndexLength" attribute is set.
 *
 * @param po the ParametricObject_t structure.
 *
 * @return @c 1 (true) if this ParametricObject_t's "pointIndexLength"
 * attribute has been set, otherwise @c 0 (false) is returned.
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_isSetPointIndexLength(const ParametricObject_t * po);


/**
 * Predicate returning @c 1 (true) if this ParametricObject_t's "compression"
 * attribute is set.
 *
 * @param po the ParametricObject_t structure.
 *
 * @return @c 1 (true) if this ParametricObject_t's "compression" attribute has
 * been set, otherwise @c 0 (false) is returned.
 *
 * @copydetails doc_parametricobject_compression
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_isSetCompression(const ParametricObject_t * po);


/**
 * Predicate returning @c 1 (true) if this ParametricObject_t's "dataType"
 * attribute is set.
 *
 * @param po the ParametricObject_t structure.
 *
 * @return @c 1 (true) if this ParametricObject_t's "dataType" attribute has
 * been set, otherwise @c 0 (false) is returned.
 *
 * @copydetails doc_parametricobject_dataType
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_isSetDataType(const ParametricObject_t * po);


/**
 * Sets the value of the "id" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @param id const char * value of the "id" attribute to be set.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
 *
 * Calling this function with @p id = @c NULL or an empty string is equivalent
 * to calling ParametricObject_unsetId().
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_setId(ParametricObject_t * po, const char * id);


/**
 * Sets the value of the "name" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @param name const char * value of the "name" attribute to be set.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
 *
 * Calling this function with @p name = @c NULL or an empty string is
 * equivalent to calling ParametricObject_unsetName().
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_setName(ParametricObject_t * po, const char * name);


/**
 * Sets the value of the "polygonType" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @param polygonType PolygonKind_t value of the "polygonType" attribute to be
 * set.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
 *
 * @copydetails doc_parametricobject_polygonType
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_setPolygonType(ParametricObject_t * po,
                                PolygonKind_t polygonType);


/**
 * Sets the value of the "polygonType" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @param polygonType const char * of the "polygonType" attribute to be set.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
 *
 * @copydetails doc_parametricobject_polygonType
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_setPolygonTypeAsString(ParametricObject_t * po,
                                        const char * polygonType);


/**
 * Sets the value of the "domainType" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @param domainType const char * value of the "domainType" attribute to be
 * set.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_setDomainType(ParametricObject_t * po,
                               const char * domainType);


/**
 * Sets the value of the "pointIndex" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @param pointIndex pointer value of the "pointIndex" attribute to be set.
 *
 * @param arrayLength int value for the length of the "pointIndex" attribute to
 * be set.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_setPointIndex(ParametricObject_t* po,
                               int* pointIndex,
                               int arrayLength);


/**
 * Sets the value of the "pointIndexLength" attribute of this
 * ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @param pointIndexLength int value of the "pointIndexLength" attribute to be
 * set.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_setPointIndexLength(ParametricObject_t * po,
                                     int pointIndexLength);


/**
 * Sets the value of the "compression" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @param compression CompressionKind_t value of the "compression" attribute to
 * be set.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
 *
 * @copydetails doc_parametricobject_compression
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_setCompression(ParametricObject_t * po,
                                CompressionKind_t compression);


/**
 * Sets the value of the "compression" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @param compression const char * of the "compression" attribute to be set.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
 *
 * @copydetails doc_parametricobject_compression
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_setCompressionAsString(ParametricObject_t * po,
                                        const char * compression);


/**
 * Sets the value of the "dataType" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @param dataType DataKind_t value of the "dataType" attribute to be set.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
 *
 * @copydetails doc_parametricobject_dataType
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_setDataType(ParametricObject_t * po, DataKind_t dataType);


/**
 * Sets the value of the "dataType" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @param dataType const char * of the "dataType" attribute to be set.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_ATTRIBUTE_VALUE, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
 *
 * @copydetails doc_parametricobject_dataType
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_setDataTypeAsString(ParametricObject_t * po,
                                     const char * dataType);


/**
 * Unsets the value of the "id" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_unsetId(ParametricObject_t * po);


/**
 * Unsets the value of the "name" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_unsetName(ParametricObject_t * po);


/**
 * Unsets the value of the "polygonType" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
 *
 * @copydetails doc_parametricobject_polygonType
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_unsetPolygonType(ParametricObject_t * po);


/**
 * Unsets the value of the "domainType" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_unsetDomainType(ParametricObject_t * po);


/**
 * Unsets the value of the "pointIndex" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_unsetPointIndex(ParametricObject_t * po);


/**
 * Unsets the value of the "pointIndexLength" attribute of this
 * ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_OPERATION_FAILED, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_unsetPointIndexLength(ParametricObject_t * po);


/**
 * Unsets the value of the "compression" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
 *
 * @copydetails doc_parametricobject_compression
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_unsetCompression(ParametricObject_t * po);


/**
 * Unsets the value of the "dataType" attribute of this ParametricObject_t.
 *
 * @param po the ParametricObject_t structure.
 *
 * @copydetails doc_returns_success_code
 * @li @sbmlconstant{LIBSBML_OPERATION_SUCCESS, OperationReturnValues_t}
 * @li @sbmlconstant{LIBSBML_INVALID_OBJECT, OperationReturnValues_t}
 *
 * @copydetails doc_parametricobject_dataType
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_unsetDataType(ParametricObject_t * po);


/**
 * Predicate returning @c 1 (true) if all the required attributes for this
 * ParametricObject_t object have been set.
 *
 * @param po the ParametricObject_t structure.
 *
 * @return @c 1 (true) to indicate that all the required attributes of this
 * ParametricObject_t have been set, otherwise @c 0 (false) is returned.
 *
 *
 * @note The required attributes for the ParametricObject_t object are:
 * @li "id"
 * @li "polygonType"
 * @li "domainType"
 * @li "pointIndex"
 * @li "pointIndexLength"
 * @li "compression"
 *
 * @memberof ParametricObject_t
 */
LIBSBML_EXTERN
int
ParametricObject_hasRequiredAttributes(const ParametricObject_t * po);




END_C_DECLS




LIBSBML_CPP_NAMESPACE_END




#endif /* !SWIG */




#endif /* !ParametricObject_H__ */


