ResultComponent.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 RESULTCOMPONENT_H_
#define RESULTCOMPONENT_H_
 
#include <numl/common/extern.h>
#include <numl/common/numlfwd.h>
 
 
//#include <string>
//#include <algorithm>
//#include <vector>
 
 
#include <numl/Dimension.h>
#include <numl/DimensionDescription.h>
#include <numl/NMBase.h>
#include <string>
 
#include <numl/NUMLList.h>
 
 
#ifdef __cplusplus
LIBNUML_CPP_NAMESPACE_BEGIN
 
class ResultComponent;
class ResultComponents;
class Dimension;
class DimensionDescription;
class NUMLVisitor;
 
/*
 *
 */
 
class LIBNUML_EXTERN ResultComponent: public NMBase {
public:
 
//  ResultComponent();
    ResultComponent (unsigned int level, unsigned int version);
 

    virtual bool accept (NUMLVisitor& v) const;
 

    virtual ResultComponent* clone () const;

    const std::string& getId () const;
 
    /*
     *
     * Sets the value of the "id" attribute of this NUML object.
     *
     * The string @p id is copied.  Note that NUML has strict requirements
     * for the syntax of identifiers.  The following is summary of the
     * definition of the NUML identifier type @c SId (here expressed in an
     * extended form of BNF notation):
     * @code
     *   letter ::= 'a'..'z','A'..'Z'
     *   digit  ::= '0'..'9'
     *   idChar ::= letter | digit | '_'
     *   SId    ::= ( letter | '_' ) idChar*
     * @endcode
     * The equality of NUML identifiers is determined by an exact character
     * sequence match; i.e., comparisons must be performed in a
     * case-sensitive manner.  In addition, there are a few conditions for
     * the uniqueness of identifiers in an NUML model.  Please consult the
     * NUML specifications for the exact formulations.
     *
     * @param id the striclass ResultComponents;ng to use as the identifier of this object
     *
     * @return integer value indicating success/failure of the
     * function.  @if clike The value is drawn from the
     * enumeration #ResultComponentReturnValues_t. @endif The possible values
     * returned by this function are:
     * @li LIBNUML_OPERATION_SUCCESS
     * @li LIBNUML_INVALID_ATTRIBUTE_VALUE
     */
    int setId (const std::string& sid);
 
    //TODO remove the following

    //  virtual XMLNamespaces* getNamespaces() const ;

    virtual void setNUMLDocument (NUMLDocument* d);
 
 

    virtual void setParentNUMLObject (NMBase* sb);

    virtual NUMLTypeCode_t getTypeCode() const;

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

    ResultComponent (NUMLNamespaces* numlns);

    DimensionDescription* createDimensionDescription ();

    CompositeDescription* createCompositeDescription();

    CompositeValue* createCompositeValue ();

  TupleDescription* createTupleDescription();

  Tuple* createTuple();

  AtomicDescription* createAtomicDescription();

  AtomicValue* createAtomicValue();

    DimensionDescription* getDimensionDescription ();

    Dimension* getDimension ();

  void writeElements(LIBSBML_CPP_NAMESPACE_QUALIFIER XMLOutputStream& stream) const;
 
 
 
    virtual ~ResultComponent();
 
//protected:
  virtual NMBase* createObject (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLInputStream& stream);
 

  virtual void readAttributes (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLAttributes& attributes);
 

  virtual void writeAttributes (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLOutputStream& stream) const;
 
 
protected:
    ResultComponent();
 
    std::string  mId;
    DimensionDescription mDimensionDescription;
    Dimension mDimension;
 
};
 
class LIBNUML_EXTERN ResultComponents : public NUMLList
{
public:

    virtual ResultComponents* clone () const;
 

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

    virtual NUMLTypeCode_t getItemTypeCode () const;

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

    virtual ResultComponent * get(unsigned int n);
 

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

    virtual ResultComponents * getResultComponents();
 

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

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

    virtual ResultComponent* remove (unsigned int n);
 

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

    virtual int getElementPosition () const;
 
    
 
protected:

  virtual NMBase* createObject (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLInputStream& stream);
 
 
};
 
LIBNUML_CPP_NAMESPACE_END
 
#endif  /* __cplusplus */
 
//LIBNUML_EXTERN
//ResultComponent_t *
//ResultComponent_createDimensionDescription(void);
 
#ifndef SWIG
 
#include <stdio.h>
 
LIBNUML_CPP_NAMESPACE_BEGIN
BEGIN_C_DECLS
 
//TODO
LIBNUML_EXTERN
DimensionDescription_t *
ResultComponent_createDimensionDescription(ResultComponent_t *rComp);
 
LIBNUML_EXTERN
CompositeDescription_t *
ResultComponent_createCompositeDescription(ResultComponent_t *rComp);
 
END_C_DECLS
LIBNUML_CPP_NAMESPACE_END
 
#endif  /* !SWIG   */
 
#endif /* RESULTCOMPONENT_H_ */