DimensionDescription.h

Go to the documentation of this file.

/*
* ****************************************************************************
* This file is part of libNUML.  Please visit http://code.google.com/p/numl/for more
* information about NUML, and the latest version of libNUML. 
* Copyright (c) 2013 The University of Manchester.
* 
* 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://www.gnu.org/licenses/lgpl.html 
* 
* Contributors:
* Joseph O. Dada, The University of Manchester - initial API and implementation
* ****************************************************************************
*/

 
 
#ifndef DIMENSIONDESCRIPTION_H_
#define DIMENSIONDESCRIPTION_H_
 
#include <numl/common/extern.h>
#include <numl/common/numlfwd.h>
 
#include <sbml/xml/XMLNode.h>
#include <sbml/xml/XMLAttributes.h>
#include <sbml/xml/XMLInputStream.h>
#include <sbml/xml/XMLOutputStream.h>
 
 
//#include <numl/AtomicDescription.h>
//#include <numl/CompositeDescription.h>
//#include <numl/TupleDescription.h>
 
#include <numl/NUMLVisitor.h>
#include <numl/NUMLError.h>
#include <numl/NMBase.h>
#include <numl/NUMLList.h>
 
#include <string>
 
#ifdef __cplusplus
 
LIBNUML_CPP_NAMESPACE_BEGIN
 
class NUMLDocument;
class AtomicDescription;
class TupleDescription;
class CompositeDescription;
/*
 *
 */
class LIBNUML_EXTERN DimensionDescription : public NUMLList
{
public:
  DimensionDescription();
  DimensionDescription (unsigned int level, unsigned int version);

  DimensionDescription (NUMLNamespaces* numlns);
 

  virtual bool accept (NUMLVisitor& v) const;
 

  virtual DimensionDescription* clone () const;
 
 
  //TODO remove the following

  //    virtual XMLNamespaces* getNamespaces() const ;

//      virtual void setNUMLDocument (NUMLDocument* d);
 
 

  //    virtual void setParentNUMLObject (NMBase* sb);

  CompositeDescription* createCompositeDescription();

  TupleDescription* createTupleDescription();

  AtomicDescription* createAtomicDescription();
 

  virtual const std::string& getElementName () const;
 

  virtual NUMLTypeCode_t getTypeCode () const { return NUML_DIMENSIONDESCRIPTION; };
 

  virtual NUMLTypeCode_t getItemTypeCode () const;

//  virtual const std::string& getElementName () const;
 

  virtual DimensionDescription * get(unsigned int n);
 

  virtual const DimensionDescription * get(unsigned int n) const;

  virtual DimensionDescription* get (const std::string& sid);
 

  virtual const DimensionDescription* get (const std::string& sid) const;
 
  virtual const std::string& getId() const;
  virtual int setId(const std::string& id);
 
  virtual const std::string& getName() const;
  virtual int setName(const std::string& name);

  virtual DimensionDescription* remove (unsigned int n);
 

  virtual DimensionDescription* remove (const std::string& sid);
 

  virtual int getElementPosition () const;
 
 
  virtual ~DimensionDescription();
 
 
protected:
  
  virtual NMBase* createObject (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLInputStream& stream);

  virtual void writeXMLNS(LIBSBML_CPP_NAMESPACE_QUALIFIER XMLOutputStream& stream) const;
 
  std::string  mId;
  std::string  mName;
 
};
 
LIBNUML_CPP_NAMESPACE_END
 
#endif  /* __cplusplus */
 
#ifndef SWIG
 
LIBNUML_CPP_NAMESPACE_BEGIN
BEGIN_C_DECLS
 
//TODO
 
END_C_DECLS
LIBNUML_CPP_NAMESPACE_END
 
#endif  /* !SWIG   */
 
#endif /* DIMENSIONDESCRIPTION_H_ */