libNuML 1.1.1
Library for reading / writing NuML documents
Loading...
Searching...
No Matches
numlfwd.h File Reference
#include <sbml/common/libsbml-namespace.h>
#include <numl/common/libnuml-namespace.h>
#include <numl/common/libnuml-config.h>

Go to the source code of this file.

Macros

#define CLASS_OR_STRUCT   class
 Begin svn Header.

Typedefs

typedef CLASS_OR_STRUCT NMBase NMBase_t
 This is the base class for all numl objects.
typedef CLASS_OR_STRUCT NUMLDocument NUMLDocument_t
 This represents the numl document that contains all information.
typedef CLASS_OR_STRUCT OntologyTerm OntologyTerm_t
 ontology terms store information about what individual elements represents
typedef CLASS_OR_STRUCT Dimension Dimension_t
 this class stores the dimension information
typedef CLASS_OR_STRUCT CompositeValue CompositeValue_t
 This class stores the composite values.
typedef CLASS_OR_STRUCT Tuple Tuple_t
 stores tuple information
typedef CLASS_OR_STRUCT AtomicValue AtomicValue_t
 This class stores the atomic values.
typedef CLASS_OR_STRUCT ResultComponent ResultComponent_t
 stores the result component
typedef CLASS_OR_STRUCT DimensionDescription DimensionDescription_t
 This class stores the dimension description.
typedef CLASS_OR_STRUCT CompositeDescription CompositeDescription_t
 this class stores the component descriptions
typedef CLASS_OR_STRUCT TupleDescription TupleDescription_t
 stores the tuple description
typedef CLASS_OR_STRUCT AtomicDescription AtomicDescription_t
 This class stores the atomic description.
typedef CLASS_OR_STRUCT NUMLReader NUMLReader_t
 The reader class implementing reading NuML documents from file / string.
typedef CLASS_OR_STRUCT NUMLWriter NUMLWriter_t
 Methods for writing NUML to files and text strings.
typedef CLASS_OR_STRUCT NUMLError NUMLError_t
 contains all error information collected
typedef CLASS_OR_STRUCT NUMLNamespaces NUMLNamespaces_t
 namespace class
typedef CLASS_OR_STRUCT NUMLList NUMLList_t
 Parent class for the various NUML list classes e.g.
typedef CLASS_OR_STRUCT ASTNode ASTNode_t
typedef CLASS_OR_STRUCT List List_t
typedef CLASS_OR_STRUCT XMLError XMLError_t
typedef CLASS_OR_STRUCT XMLErrorLog XMLErrorLog_t
typedef CLASS_OR_STRUCT XMLNode XMLNode_t
typedef CLASS_OR_STRUCT XMLAttributes XMLAttributes_t
typedef CLASS_OR_STRUCT XMLNamespaces XMLNamespaces_t
typedef CLASS_OR_STRUCT XMLToken XMLToken_t
typedef CLASS_OR_STRUCT XMLInputStream XMLInputStream_t
typedef CLASS_OR_STRUCT XMLOutputStream XMLOutputStream_t
typedef CLASS_OR_STRUCT XMLTriple XMLTriple_t
typedef CLASS_OR_STRUCT Date Date_t
typedef CLASS_OR_STRUCT ModelCreator ModelCreator_t
typedef CLASS_OR_STRUCT CVTerm CVTerm_t
typedef CLASS_OR_STRUCT ModelHistory ModelHistory_t

Macro Definition Documentation

◆ CLASS_OR_STRUCT

#define CLASS_OR_STRUCT   class

Begin svn Header.

$Rev: 29 $: Revision of last commit

Author
josep.nosp@m.hoda.nosp@m.da@gm.nosp@m.ail..nosp@m.com

: Author of last commit

Date
2013-04-25 10:57:46 +0100 (Thu, 25 Apr 2013)

: Date of last commit $HeadURL: https://numl.googlecode.com/svn/trunk/libnuml/src/common/numlfwd.h $

Id
numlfwd.h 29 2013-04-25 09:57:46Z josep.nosp@m.hoda.nosp@m.da@gm.nosp@m.ail..nosp@m.com

End svn Header


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

The original code was initially developed by:

SBML Team
Control and Dynamical Systems, MC 107-81
California Institute of Technology
Pasadena, CA, 91125, USA

http://www.sbml.org
mailto:sbml-team@caltech.edu

Adapted for NUML by:

NUML Team
Computational Systems Biology Group
School of Computer Science
The University of Manchester
Manchester, M1 7DN UK
mailto:josephodada@gmail.com

Contributor(s): Joseph O. Dada, The University of Manchester - initial LIBNUML API and implementation


Declaring all types up-front avoids compilation errors of the form "Redefinition of type 'Foo'", and allows our combined C/C++ headers to depend minimally upon each other. Put another way, the type definitions below serve the same purpose as class Foo; forward declarations in C++ code. Defined as a class when compiling for C++ and as a C struct when compiling for C.

Typedef Documentation

◆ ASTNode_t

typedef CLASS_OR_STRUCT ASTNode ASTNode_t

◆ AtomicDescription_t

This class stores the atomic description.

◆ AtomicValue_t

This class stores the atomic values.

◆ CompositeDescription_t

this class stores the component descriptions

◆ CompositeValue_t

This class stores the composite values.

◆ CVTerm_t

typedef CLASS_OR_STRUCT CVTerm CVTerm_t

◆ Date_t

typedef CLASS_OR_STRUCT Date Date_t

◆ Dimension_t

this class stores the dimension information

◆ DimensionDescription_t

This class stores the dimension description.

◆ List_t

typedef CLASS_OR_STRUCT List List_t

◆ ModelCreator_t

typedef CLASS_OR_STRUCT ModelCreator ModelCreator_t

◆ ModelHistory_t

typedef CLASS_OR_STRUCT ModelHistory ModelHistory_t

◆ NMBase_t

This is the base class for all numl objects.

◆ NUMLDocument_t

This represents the numl document that contains all information.

◆ NUMLError_t

contains all error information collected

◆ NUMLList_t

Parent class for the various NUML list classes e.g.

Operations, Result, ResultComponent etc.

◆ NUMLNamespaces_t

◆ NUMLReader_t

The reader class implementing reading NuML documents from file / string.

◆ NUMLWriter_t

Methods for writing NUML to files and text strings.

The NUMLWriter class is the converse of NUMLReader, and provides the main interface for serializing NUML models into XML and writing the result to files and text strings. The methods for writing NUML all take an NUMLDocument object and a destination. They return a boolean value to indicate success or failure.

◆ OntologyTerm_t

ontology terms store information about what individual elements represents

◆ ResultComponent_t

stores the result component

◆ Tuple_t

stores tuple information

◆ TupleDescription_t

stores the tuple description

◆ XMLAttributes_t

typedef CLASS_OR_STRUCT XMLAttributes XMLAttributes_t

◆ XMLError_t

typedef CLASS_OR_STRUCT XMLError XMLError_t

◆ XMLErrorLog_t

typedef CLASS_OR_STRUCT XMLErrorLog XMLErrorLog_t

◆ XMLInputStream_t

typedef CLASS_OR_STRUCT XMLInputStream XMLInputStream_t

◆ XMLNamespaces_t

typedef CLASS_OR_STRUCT XMLNamespaces XMLNamespaces_t

◆ XMLNode_t

typedef CLASS_OR_STRUCT XMLNode XMLNode_t

◆ XMLOutputStream_t

typedef CLASS_OR_STRUCT XMLOutputStream XMLOutputStream_t

◆ XMLToken_t

typedef CLASS_OR_STRUCT XMLToken XMLToken_t

◆ XMLTriple_t

typedef CLASS_OR_STRUCT XMLTriple XMLTriple_t