CompositeValue.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 COMPOSITEVALUES_H_
#define COMPOSITEVALUES_H_
 
#include <numl/common/extern.h>
#include <numl/common/numlfwd.h>
 
//#include <numl/Tuple.h>
//#include <numl/AtomicValue.h>
 
 
 
#include <numl/NMBase.h>
#include <numl/NUMLList.h>
#include <numl/Dimension.h>
 
#ifdef __cplusplus
LIBNUML_CPP_NAMESPACE_BEGIN
 
//class CompositeValue;
class NUMLDocument;
class Tuple;
class AtomicValue;
/*
 *
 */
class LIBNUML_EXTERN CompositeValue : public Dimension
{
public:
 
    CompositeValue();
    ~CompositeValue();
    CompositeValue (unsigned int level, unsigned int version);

    CompositeValue (NUMLNamespaces* numlns);

    virtual CompositeValue* clone () const;

    virtual bool accept (NUMLVisitor& v) const;

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

    const std::string& getIndexValue () const;

    const std::string& getDescription () const;

    int setIndexValue (const std::string& indexValue);

    int setDescription (const std::string& description);
 

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

    virtual NUMLTypeCode_t getItemTypeCode () const;

    bool isContentCompositeValue () const;

    bool isContentTuple () const;

    bool isContentAtomicValue () const;

 
    CompositeValue * getCompositeValue(unsigned int n);

 
    Tuple * getTuple();

 
    AtomicValue * getAtomicValue();

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

    virtual CompositeValue * get(unsigned int n);

    virtual CompositeValue* remove(unsigned int n);

  virtual void readAttributes (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLAttributes& attributes);
 

  virtual void writeAttributes (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLOutputStream& stream) const;

    int addCompositeValue(const CompositeValue* compValue);

    CompositeValue* createCompositeValue();

    Tuple* createTuple();

    AtomicValue* createAtomicValue();
 
//  void setAtomicValue(AtomicValue* atomicValue) ;
 
//  void setTuple(Tuple* tuple) ;

//  virtual void writeElements(XMLOutputStream& stream) const;
 
 
protected:
    
  virtual NMBase* createObject (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLInputStream& stream);
    std::string mIndexValue;
    std::string mDescription;
    NUMLTypeCode_t mContentType;
 
};
 
 
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 /* COMPOSITEVALUES_H_ */