/**
 * @file TransformationComponent.h
 * @brief Definition of the TransformationComponent 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 TransformationComponent
 * @sbmlbrief{spatial} The TransformationComponent element represents an affine
 * transformation that can be applied to a CSGNode. This element has the
 * following two attributes:
 */


#ifndef TransformationComponent_H__
#define TransformationComponent_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 TransformationComponent : public SBase
{
protected:

  /** @cond doxygenLibsbmlInternal */

  double* mComponents;
  int mComponentsLength;
  size_t mActualComponentsLength;
  bool mIsSetComponentsLength;
  std::string mElementName;

  /** @endcond */

public:

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


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


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


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


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


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


  /**
   * Returns the value of the "components" attribute of this
   * TransformationComponent.
   *
   * @param outArray double* array that will be used to return the value of the
   * "components" attribute of this TransformationComponent.
   *
   * @note the value of the "components" attribute of this
   * TransformationComponent is returned in the argument array.
   */
  void getComponents(double* outArray) const;


  /**
   * Returns the value of the "componentsLength" attribute of this
   * TransformationComponent.
   *
   * @return the value of the "componentsLength" attribute of this
   * TransformationComponent as a integer.
   */
  int getComponentsLength() const;


  /**
  * Returns the length of the "components" array of this
  * TransformationComponent.
  *
  * @return the legnth of the "components" array of this
  * TransformationComponent as a integer.
  */
  size_t getActualComponentsLength() const;


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


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


  /**
   * Sets the value of the "components" attribute of this
   * TransformationComponent.
   *
   * @param inArray double* array value of the "components" attribute to be
   * set.
   *
   * @param arrayLength int value for the length of the "components" 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 setComponents(double* inArray, size_t arrayLength);


  /**
   * Sets the value of the "componentsLength" attribute of this
   * TransformationComponent.
   *
   * @param componentsLength int value of the "componentsLength" 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 setComponentsLength(int componentsLength);


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


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


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



  /** @cond doxygenLibsbmlInternal */

  /**
   * Sets the XML name of this TransformationComponent object.
   */
  virtual void setElementName(const std::string& name);

  /** @endcond */


  /**
   * Returns the libSBML type code for this TransformationComponent object.
   *
   * @copydetails doc_what_are_typecodes
   *
   * @return the SBML type code for this object:
   * @sbmlconstant{SBML_SPATIAL_TRANSFORMATIONCOMPONENT,
   * 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
   * TransformationComponent object have been set.
   *
   * @return @c true to indicate that all the required attributes of this
   * TransformationComponent have been set, otherwise @c false is returned.
   *
   *
   * @note The required attributes for the TransformationComponent object are:
   * @li "components"
   * @li "componentsLength"
   */
  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;

  std::string getComponentsString() 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
   * TransformationComponent.
   *
   * @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
   * TransformationComponent.
   *
   * @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
   * TransformationComponent.
   *
   * @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
   * TransformationComponent.
   *
   * @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
   * TransformationComponent.
   *
   * @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 TransformationComponent's attribute
   * "attributeName" is set.
   *
   * @param attributeName, the name of the attribute to query.
   *
   * @return @c true if this TransformationComponent'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
   * TransformationComponent.
   *
   * @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
   * TransformationComponent.
   *
   * @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
   * TransformationComponent.
   *
   * @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
   * TransformationComponent.
   *
   * @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
   * TransformationComponent.
   *
   * @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
   * TransformationComponent.
   *
   * @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 */



private:
  bool parseTransformation(const std::string & transformationString);

  /** @endcond */


};



LIBSBML_CPP_NAMESPACE_END




#endif /* __cplusplus */




#ifndef SWIG




LIBSBML_CPP_NAMESPACE_BEGIN




BEGIN_C_DECLS


/**
 * Creates a new TransformationComponent_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
 * TransformationComponent_t.
 *
 * @param version an unsigned int, the SBML Version to assign to this
 * TransformationComponent_t.
 *
 * @param pkgVersion an unsigned int, the SBML Spatial Version to assign to
 * this TransformationComponent_t.
 *
 * @copydetails doc_note_setting_lv_pkg
 *
 * @copydetails doc_returned_owned_pointer
 *
 * @memberof TransformationComponent_t
 */
LIBSBML_EXTERN
TransformationComponent_t *
TransformationComponent_create(unsigned int level,
                               unsigned int version,
                               unsigned int pkgVersion);


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


/**
 * Frees this TransformationComponent_t object.
 *
 * @param tc the TransformationComponent_t structure.
 *
 * @memberof TransformationComponent_t
 */
LIBSBML_EXTERN
void
TransformationComponent_free(TransformationComponent_t* tc);


/**
 * Returns the value of the "componentsLength" attribute of this
 * TransformationComponent_t.
 *
 * @param tc the TransformationComponent_t structure whose componentsLength is
 * sought.
 *
 * @return the value of the "componentsLength" attribute of this
 * TransformationComponent_t as a integer.
 *
 * @memberof TransformationComponent_t
 */
LIBSBML_EXTERN
int
TransformationComponent_getComponentsLength(const TransformationComponent_t *
  tc);


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


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


/**
 * Sets the value of the "components" attribute of this
 * TransformationComponent_t.
 *
 * @param tc the TransformationComponent_t structure.
 *
 * @param components pointer value of the "components" attribute to be set.
 *
 * @param arrayLength int value for the length of the "components" 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 TransformationComponent_t
 */
LIBSBML_EXTERN
int
TransformationComponent_setComponents(TransformationComponent_t* tc,
                                      double* components,
                                      int arrayLength);


/**
 * Sets the value of the "componentsLength" attribute of this
 * TransformationComponent_t.
 *
 * @param tc the TransformationComponent_t structure.
 *
 * @param componentsLength int value of the "componentsLength" 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 TransformationComponent_t
 */
LIBSBML_EXTERN
int
TransformationComponent_setComponentsLength(TransformationComponent_t * tc,
                                            int componentsLength);


/**
 * Unsets the value of the "components" attribute of this
 * TransformationComponent_t.
 *
 * @param tc the TransformationComponent_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 TransformationComponent_t
 */
LIBSBML_EXTERN
int
TransformationComponent_unsetComponents(TransformationComponent_t * tc);


/**
 * Unsets the value of the "componentsLength" attribute of this
 * TransformationComponent_t.
 *
 * @param tc the TransformationComponent_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 TransformationComponent_t
 */
LIBSBML_EXTERN
int
TransformationComponent_unsetComponentsLength(TransformationComponent_t * tc);


/**
 * Predicate returning @c 1 (true) if all the required attributes for this
 * TransformationComponent_t object have been set.
 *
 * @param tc the TransformationComponent_t structure.
 *
 * @return @c 1 (true) to indicate that all the required attributes of this
 * TransformationComponent_t have been set, otherwise @c 0 (false) is returned.
 *
 *
 * @note The required attributes for the TransformationComponent_t object are:
 * @li "components"
 * @li "componentsLength"
 *
 * @memberof TransformationComponent_t
 */
LIBSBML_EXTERN
int
TransformationComponent_hasRequiredAttributes(const TransformationComponent_t *
  tc);




END_C_DECLS




LIBSBML_CPP_NAMESPACE_END




#endif /* !SWIG */




#endif /* !TransformationComponent_H__ */


