TupleDescription.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 TUPLEDESCRIPTION_H_
#define TUPLEDESCRIPTION_H_
 
#include <numl/common/extern.h>
#include <numl/common/numlfwd.h>
 
 
 
#include <numl/NMBase.h>
#include <numl/NUMLList.h>
#include <numl/DimensionDescription.h>
#include <vector>
 
 
#ifdef __cplusplus
LIBNUML_CPP_NAMESPACE_BEGIN
 
class AtomicDescription;
class NUMLVisitor;
 
class LIBNUML_EXTERN TupleDescription : public DimensionDescription
{
 
public:
 
  TupleDescription();
  ~TupleDescription();

  TupleDescription (unsigned int level, unsigned int version);

  TupleDescription (NUMLNamespaces* numlns);

  virtual TupleDescription* clone () const;
 
  virtual const std::string& getId() const;
  virtual int setId(const std::string& id);
 

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

  virtual NUMLTypeCode_t getItemTypeCode () const;
 
  
  virtual int getElementPosition () const;

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

  virtual AtomicDescription * getAtomicDescription(unsigned int n);
 

  virtual const AtomicDescription * getAtomicDescription(unsigned int n) const;

  virtual AtomicDescription* removeAtomicDescription (unsigned int n);

  AtomicDescription* createAtomicDescription();
 
  virtual NMBase* createObject (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLInputStream& stream);
 
  //write to the output stream
  virtual void write(LIBSBML_CPP_NAMESPACE_QUALIFIER XMLOutputStream& stream) const;
 
protected:

  virtual void readAttributes(const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLAttributes & attributes);
  virtual void writeAttributes(LIBSBML_CPP_NAMESPACE_QUALIFIER XMLOutputStream & stream) const;
  //virtual NMBase* createObject (XMLInputStream& stream);
  //TupleDescription *mTupleDescription;
 
  std::string  mId;
  std::string  mName;
  std::string  mOntologyTerm;
 
};
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 /* TUPLEDESCRIPTION_H_ */